1 /* Things for GLYPHS and glyph tables.
2 Copyright (C) 1993, 2001-2023 Free Software Foundation, Inc.
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
8 the Free Software Foundation, either version 3 of the License, or (at
9 your option) 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. If not, see <https://www.gnu.org/licenses/>. */
18
19 /* Access the slots of a display-table, according to their purpose. */
20
21 #ifndef EMACS_DISPTAB_H
22 #define EMACS_DISPTAB_H
23
24 #include "lisp.h"
25
26 #define DISP_TABLE_P(obj) \
27 (CHAR_TABLE_P (obj) \
28 && EQ (XCHAR_TABLE (obj)->purpose, Qdisplay_table) \
29 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (obj)) == DISP_TABLE_EXTRA_SLOTS)
30
31 #define DISP_TABLE_EXTRA_SLOTS 6
32 #define DISP_TRUNC_GLYPH(dp) ((dp)->extras[0])
33 #define DISP_CONTINUE_GLYPH(dp) ((dp)->extras[1])
34 #define DISP_ESCAPE_GLYPH(dp) ((dp)->extras[2])
35 #define DISP_CTRL_GLYPH(dp) ((dp)->extras[3])
36 #define DISP_INVIS_VECTOR(dp) ((dp)->extras[4])
37 #define DISP_BORDER_GLYPH(dp) ((dp)->extras[5])
38
39 extern Lisp_Object disp_char_vector (struct Lisp_Char_Table *, int);
40
41 #define DISP_CHAR_VECTOR(dp, c) \
42 (ASCII_CHAR_P(c) \
43 ? (NILP ((dp)->ascii) \
44 ? (dp)->defalt \
45 : (SUB_CHAR_TABLE_P ((dp)->ascii) \
46 ? XSUB_CHAR_TABLE ((dp)->ascii)->contents[c] \
47 : (dp)->ascii)) \
48 : disp_char_vector ((dp), (c)))
49
50 /* Defined in window.c. */
51 extern struct Lisp_Char_Table *window_display_table (struct window *);
52
53 /* Defined in indent.c. */
54 extern struct Lisp_Char_Table *buffer_display_table (void);
55
56 /* Return the current length of the GLYPH table,
57 or 0 if the table isn't currently valid. */
58 #define GLYPH_TABLE_LENGTH \
59 ((VECTORP (Vglyph_table)) ? ASIZE (Vglyph_table) : 0)
60
61 /* Return the current base (for indexing) of the GLYPH table,
62 or 0 if the table isn't currently valid. */
63 #define GLYPH_TABLE_BASE \
64 ((VECTORP (Vglyph_table)) ? XVECTOR (Vglyph_table)->contents : 0)
65
66 /* Given BASE and LEN returned by the two previous macros,
67 return nonzero if the GLYPH code G should be output as a single
68 character with code G. Return zero if G has a string in the table. */
69 #define GLYPH_SIMPLE_P(base,len,g) \
70 (GLYPH_FACE (g) != DEFAULT_FACE_ID || GLYPH_CHAR (g) >= (len) || !STRINGP (base[GLYPH_CHAR (g)]))
71
72 /* Given BASE and LEN returned by the two previous macros,
73 return nonzero if GLYPH code G is aliased to a different code. */
74 #define GLYPH_ALIAS_P(base,len,g) \
75 (GLYPH_FACE (g) == DEFAULT_FACE_ID && GLYPH_CHAR (g) < (len) && FIXNUMP (base[GLYPH_CHAR (g)]))
76
77 /* Follow all aliases for G in the glyph table given by (BASE,
78 LENGTH), and set G to the final glyph. */
79 #define GLYPH_FOLLOW_ALIASES(base, length, g) \
80 do { \
81 while (GLYPH_ALIAS_P ((base), (length), (g))) \
82 SET_GLYPH_CHAR ((g), XFIXNUM ((base)[GLYPH_CHAR (g)])); \
83 if (!GLYPH_CHAR_VALID_P (g)) \
84 SET_GLYPH_CHAR (g, ' '); \
85 } while (false)
86
87 /* Assuming that GLYPH_SIMPLE_P (BASE, LEN, G) is 0,
88 return the length and the address of the character-sequence
89 used for outputting GLYPH G. */
90 #define GLYPH_LENGTH(base,g) SCHARS (base[GLYPH_CHAR (g)])
91 #define GLYPH_STRING(base,g) SDATA (base[GLYPH_CHAR (g)])
92
93 /* GLYPH for a space character. */
94
95 #define SPACEGLYPH 040
96 #define NULL_GLYPH 00
97
98 #define SET_GLYPH_FROM_CHAR(glyph, c) \
99 SET_GLYPH (glyph, c, DEFAULT_FACE_ID)
100
101 #endif /* EMACS_DISPTAB_H */