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

/* Things for GLYPHS and glyph tables.
   Copyright (C) 1993 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 2, 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., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, 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) ((g) >= (len) || !STRINGP (base[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) ((g) < (len) && INTEGERP (base[g]))

/* Assuming that GLYPH_SIMPLE_P (BASE, LEN, G) is 1,
   return the alias for G.  */
#define GLYPH_ALIAS(base, g) XINT (base[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)))	\
      (g) = GLYPH_ALIAS ((base), (g));			\
    if (!GLYPH_CHAR_VALID_P (FAST_GLYPH_CHAR (g)))	\
      g = FAST_MAKE_GLYPH (' ', FAST_GLYPH_FACE (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)   XSTRING (base[g])->size
#define GLYPH_STRING(base,g)   XSTRING (base[g])->data

/* GLYPH for a space character.  */

#define SPACEGLYPH 040
#define NULL_GLYPH 00

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