[bpt/emacs.git] / src / disptab.h

/* Things for GLYPHS and glyph tables.
   Copyright (C) 1993, 2001, 2002, 2003, 2004, 2005,
                 2006, 2007, 2008  Free Software Foundation, Inc.

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3, or (at your option)
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */

/* Access the slots of a display-table, according to their purpose.  */

#define DISP_TABLE_P(obj)						    \
  (CHAR_TABLE_P (obj)							    \
   && EQ (XCHAR_TABLE (obj)->purpose, Qdisplay_table)			    \
   && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (obj)) == DISP_TABLE_EXTRA_SLOTS)

#define DISP_TABLE_EXTRA_SLOTS 6
#define DISP_TRUNC_GLYPH(dp) ((dp)->extras[0])
#define DISP_CONTINUE_GLYPH(dp) ((dp)->extras[1])
#define DISP_ESCAPE_GLYPH(dp) ((dp)->extras[2])
#define DISP_CTRL_GLYPH(dp) ((dp)->extras[3])
#define DISP_INVIS_VECTOR(dp) ((dp)->extras[4])
#define DISP_BORDER_GLYPH(dp) ((dp)->extras[5])

extern Lisp_Object disp_char_vector P_ ((struct Lisp_Char_Table *, int));

#define DISP_CHAR_VECTOR(dp, c)				\
  (ASCII_CHAR_P(c)					\
   ? (NILP ((dp)->ascii)				\
      ? (dp)->defalt					\
      : (SUB_CHAR_TABLE_P ((dp)->ascii)			\
	 ? XSUB_CHAR_TABLE ((dp)->ascii)->contents[c]	\
	 : (dp)->ascii))				\
   : disp_char_vector ((dp), (c)))

/* Defined in window.c.  */
extern struct Lisp_Char_Table *window_display_table P_ ((struct window *));

/* Defined in indent.c.  */
extern struct Lisp_Char_Table *buffer_display_table P_ ((void));

/* Display table to use for vectors that don't specify their own.  */
extern Lisp_Object Vstandard_display_table;

/* This is the `purpose' slot of a display table.  */
extern Lisp_Object Qdisplay_table;

/* Vector of GLYPH definitions.  Indexed by GLYPH number,
   the contents are a string which is how to output the GLYPH.  */
extern Lisp_Object Vglyph_table;

/* Return the current length of the GLYPH table,
   or 0 if the table isn't currently valid.  */
#define GLYPH_TABLE_LENGTH  \
  ((VECTORP (Vglyph_table)) ? XVECTOR (Vglyph_table)->size : 0)

/* Return the current base (for indexing) of the GLYPH table,
   or 0 if the table isn't currently valid.  */
#define GLYPH_TABLE_BASE  \
  ((VECTORP (Vglyph_table)) ? XVECTOR (Vglyph_table)->contents : 0)

/* Given BASE and LEN returned by the two previous macros,
   return nonzero if the GLYPH code G should be output as a single
   character with code G.  Return zero if G has a string in the table.  */
#define GLYPH_SIMPLE_P(base,len,g) \
  (GLYPH_FACE (g) != DEFAULT_FACE_ID || GLYPH_CHAR (g) >= (len) || !STRINGP (base[GLYPH_CHAR (g)]))

/* Given BASE and LEN returned by the two previous macros,
   return nonzero if GLYPH code G is aliased to a different code.  */
#define GLYPH_ALIAS_P(base,len,g) \
  (GLYPH_FACE (g) == DEFAULT_FACE_ID && GLYPH_CHAR (g) < (len) && INTEGERP (base[GLYPH_CHAR (g)]))

/* Follow all aliases for G in the glyph table given by (BASE,
   LENGTH), and set G to the final glyph.  */
#define GLYPH_FOLLOW_ALIASES(base, length, g)			\
  do {								\
    while (GLYPH_ALIAS_P ((base), (length), (g)))		\
      SET_GLYPH_CHAR ((g), XINT ((base)[GLYPH_CHAR (g)]));	\
    if (!GLYPH_CHAR_VALID_P (g))				\
      SET_GLYPH_CHAR (g, ' ');					\
  } while (0)

/* Assuming that GLYPH_SIMPLE_P (BASE, LEN, G) is 0,
   return the length and the address of the character-sequence
   used for outputting GLYPH G.  */
#define GLYPH_LENGTH(base,g)   SCHARS (base[GLYPH_CHAR (g)])
#define GLYPH_STRING(base,g)   SDATA (base[GLYPH_CHAR (g)])

/* GLYPH for a space character.  */

#define SPACEGLYPH 040
#define NULL_GLYPH 00

#define SET_GLYPH_FROM_CHAR(glyph, c) \
  SET_GLYPH (glyph, c, DEFAULT_FACE_ID)

/* arch-tag: d7f792d2-f59c-4904-a91e-91522e3ab349
   (do not change this comment) */
Commit	Line	Data
d427b66a	1	/* Things for GLYPHS and glyph tables.
429ab54e	2	Copyright (C) 1993, 2001, 2002, 2003, 2004, 2005,
8cabe764	3	2006, 2007, 2008 Free Software Foundation, Inc.
d427b66a JB	4
	5	This file is part of GNU Emacs.
	6
	7	GNU Emacs is free software; you can redistribute it and/or modify
	8	it under the terms of the GNU General Public License as published by
684d6f5b	9	the Free Software Foundation; either version 3, or (at your option)
d427b66a JB	10	any later version.
	11
	12	GNU Emacs is distributed in the hope that it will be useful,
	13	but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	GNU General Public License for more details.
	16
	17	You should have received a copy of the GNU General Public License
	18	along with GNU Emacs; see the file COPYING. If not, write to
4fc5845f LK	19	the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
4fc5845f LK	20	Boston, MA 02110-1301, USA. */
d427b66a JB	21
	22	/* Access the slots of a display-table, according to their purpose. */
	23
80af4e50 RS	24	#define DISP_TABLE_P(obj) \
80af4e50 RS	25	(CHAR_TABLE_P (obj) \
10ffbb91	26	&& EQ (XCHAR_TABLE (obj)->purpose, Qdisplay_table) \
80af4e50 RS	27	&& CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (obj)) == DISP_TABLE_EXTRA_SLOTS)
	28
	29	#define DISP_TABLE_EXTRA_SLOTS 6
	30	#define DISP_TRUNC_GLYPH(dp) ((dp)->extras[0])
	31	#define DISP_CONTINUE_GLYPH(dp) ((dp)->extras[1])
	32	#define DISP_ESCAPE_GLYPH(dp) ((dp)->extras[2])
	33	#define DISP_CTRL_GLYPH(dp) ((dp)->extras[3])
	34	#define DISP_INVIS_VECTOR(dp) ((dp)->extras[4])
	35	#define DISP_BORDER_GLYPH(dp) ((dp)->extras[5])
	36
9b854db0	37	extern Lisp_Object disp_char_vector P_ ((struct Lisp_Char_Table *, int));
1e05cf1d	38
f35dca99 KH	39	#define DISP_CHAR_VECTOR(dp, c) \
	40	(ASCII_CHAR_P(c) \
	41	? (NILP ((dp)->ascii) \
	42	? (dp)->defalt \
	43	: (SUB_CHAR_TABLE_P ((dp)->ascii) \
	44	? XSUB_CHAR_TABLE ((dp)->ascii)->contents[c] \
	45	: (dp)->ascii)) \
	46	: disp_char_vector ((dp), (c)))
d427b66a	47
ef5623ef	48	/* Defined in window.c. */
9b854db0	49	extern struct Lisp_Char_Table window_display_table P_ ((struct window ));
ef5623ef JB	50
ef5623ef JB	51	/* Defined in indent.c. */
9b854db0	52	extern struct Lisp_Char_Table *buffer_display_table P_ ((void));
d427b66a JB	53
	54	/* Display table to use for vectors that don't specify their own. */
	55	extern Lisp_Object Vstandard_display_table;
	56
80af4e50 RS	57	/* This is the `purpose' slot of a display table. */
	58	extern Lisp_Object Qdisplay_table;
	59
d427b66a JB	60	/* Vector of GLYPH definitions. Indexed by GLYPH number,
	61	the contents are a string which is how to output the GLYPH. */
	62	extern Lisp_Object Vglyph_table;
	63
	64	/* Return the current length of the GLYPH table,
	65	or 0 if the table isn't currently valid. */
	66	#define GLYPH_TABLE_LENGTH \
40de0d7b	67	((VECTORP (Vglyph_table)) ? XVECTOR (Vglyph_table)->size : 0)
d427b66a JB	68
	69	/* Return the current base (for indexing) of the GLYPH table,
	70	or 0 if the table isn't currently valid. */
	71	#define GLYPH_TABLE_BASE \
40de0d7b	72	((VECTORP (Vglyph_table)) ? XVECTOR (Vglyph_table)->contents : 0)
d427b66a JB	73
	74	/* Given BASE and LEN returned by the two previous macros,
	75	return nonzero if the GLYPH code G should be output as a single
	76	character with code G. Return zero if G has a string in the table. */
ea92fc1a KS	77	#define GLYPH_SIMPLE_P(base,len,g) \
ea92fc1a KS	78	(GLYPH_FACE (g) != DEFAULT_FACE_ID \|\| GLYPH_CHAR (g) >= (len) \|\| !STRINGP (base[GLYPH_CHAR (g)]))
d427b66a JB	79
	80	/* Given BASE and LEN returned by the two previous macros,
	81	return nonzero if GLYPH code G is aliased to a different code. */
ea92fc1a KS	82	#define GLYPH_ALIAS_P(base,len,g) \
ea92fc1a KS	83	(GLYPH_FACE (g) == DEFAULT_FACE_ID && GLYPH_CHAR (g) < (len) && INTEGERP (base[GLYPH_CHAR (g)]))
d427b66a	84
be269961 JB	85	/* Follow all aliases for G in the glyph table given by (BASE,
be269961 JB	86	LENGTH), and set G to the final glyph. */
ea92fc1a KS	87	#define GLYPH_FOLLOW_ALIASES(base, length, g) \
	88	do { \
	89	while (GLYPH_ALIAS_P ((base), (length), (g))) \
	90	SET_GLYPH_CHAR ((g), XINT ((base)[GLYPH_CHAR (g)])); \
	91	if (!GLYPH_CHAR_VALID_P (g)) \
	92	SET_GLYPH_CHAR (g, ' '); \
cd49fad3 KH	93	} while (0)
cd49fad3 KH	94
d427b66a JB	95	/* Assuming that GLYPH_SIMPLE_P (BASE, LEN, G) is 0,
	96	return the length and the address of the character-sequence
	97	used for outputting GLYPH G. */
ea92fc1a KS	98	#define GLYPH_LENGTH(base,g) SCHARS (base[GLYPH_CHAR (g)])
ea92fc1a KS	99	#define GLYPH_STRING(base,g) SDATA (base[GLYPH_CHAR (g)])
d427b66a JB	100
	101	/* GLYPH for a space character. */
	102
	103	#define SPACEGLYPH 040
	104	#define NULL_GLYPH 00
	105
ea92fc1a KS	106	#define SET_GLYPH_FROM_CHAR(glyph, c) \
ea92fc1a KS	107	SET_GLYPH (glyph, c, DEFAULT_FACE_ID)
6b61353c KH	108
	109	/* arch-tag: d7f792d2-f59c-4904-a91e-91522e3ab349
	110	(do not change this comment) */