* dispextern.h (struct face): Add cached_index member.
[bpt/emacs.git] / src / disptab.h
CommitLineData
d427b66a
JB
1/* Things for GLYPHS and glyph tables.
2 Copyright (C) 1990 Free Software Foundation, Inc.
3
4This file is part of GNU Emacs.
5
6GNU Emacs is free software; you can redistribute it and/or modify
7it under the terms of the GNU General Public License as published by
8the Free Software Foundation; either version 1, or (at your option)
9any later version.
10
11GNU Emacs is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with GNU Emacs; see the file COPYING. If not, write to
18the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
19
20/* Access the slots of a display-table, according to their purpose. */
21
22#define DISP_TABLE_SIZE 261
23#define DISP_TRUNC_GLYPH(dp) ((dp)->contents[256])
24#define DISP_CONTINUE_GLYPH(dp) ((dp)->contents[257])
25#define DISP_ESCAPE_GLYPH(dp) ((dp)->contents[258])
26#define DISP_CTRL_GLYPH(dp) ((dp)->contents[259])
82c51511
RS
27#define DISP_INVIS_VECTOR(dp) ((dp)->contents[260])
28#define DISP_CHAR_VECTOR(dp, c) ((dp)->contents[c])
d427b66a
JB
29
30extern struct Lisp_Vector *window_display_table ();
31
32/* Display table to use for vectors that don't specify their own. */
33extern Lisp_Object Vstandard_display_table;
34
35/* Vector of GLYPH definitions. Indexed by GLYPH number,
36 the contents are a string which is how to output the GLYPH. */
37extern Lisp_Object Vglyph_table;
38
39/* Return the current length of the GLYPH table,
40 or 0 if the table isn't currently valid. */
41#define GLYPH_TABLE_LENGTH \
42 ((XTYPE (Vglyph_table) == Lisp_Vector) \
43 ? XVECTOR (Vglyph_table)->size : 0)
44
45/* Return the current base (for indexing) of the GLYPH table,
46 or 0 if the table isn't currently valid. */
47#define GLYPH_TABLE_BASE \
48 ((XTYPE (Vglyph_table) == Lisp_Vector) \
49 ? XVECTOR (Vglyph_table)->contents : 0)
50
51/* Given BASE and LEN returned by the two previous macros,
52 return nonzero if the GLYPH code G should be output as a single
53 character with code G. Return zero if G has a string in the table. */
54#define GLYPH_SIMPLE_P(base,len,g) \
55 ((g) >= (len) || XTYPE (base[g]) != Lisp_String)
56
57/* Given BASE and LEN returned by the two previous macros,
58 return nonzero if GLYPH code G is aliased to a different code. */
59#define GLYPH_ALIAS_P(base,len,g) \
60 ((g) < (len) && XTYPE (base[g]) == Lisp_Int)
61
62/* Assuming that GLYPH_SIMPLE_P (BASE, LEN, G) is 1,
63 return the alias for G. */
64#define GLYPH_ALIAS(base, g) XINT (base[g])
65
66/* Assuming that GLYPH_SIMPLE_P (BASE, LEN, G) is 0,
67 return the length and the address of the character-sequence
68 used for outputting GLYPH G. */
69#define GLYPH_LENGTH(base,g) XSTRING (base[g])->size
70#define GLYPH_STRING(base,g) XSTRING (base[g])->data
71
72/* GLYPH for a space character. */
73
74#define SPACEGLYPH 040
75#define NULL_GLYPH 00
76
77#define GLYPH_FROM_CHAR(c) (c)
78
79extern int glyphlen ();
80extern void str_to_glyph_cpy ();
81extern void str_to_glyph_ncpy ();
82extern void glyph_to_str_cpy ();