annotate src/disptab.h @ 59615:c0ae409ee985

*** empty log message ***
author Jay Belanger <jay.p.belanger@gmail.com>
date Tue, 18 Jan 2005 05:13:23 +0000
parents 695cf19ef79e
children a8fa7c632ee4 375f2633d815
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
1 /* Things for GLYPHS and glyph tables.
2961
e94a593c3952 Updated copyright years.
Jim Blandy <jimb@redhat.com>
parents: 2725
diff changeset
2 Copyright (C) 1993 Free Software Foundation, Inc.
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
3
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
4 This file is part of GNU Emacs.
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
5
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
6 GNU Emacs is free software; you can redistribute it and/or modify
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
7 it under the terms of the GNU General Public License as published by
12244
ac7375e60931 Update GPL to version 2.
Karl Heuer <kwzh@gnu.org>
parents: 9406
diff changeset
8 the Free Software Foundation; either version 2, or (at your option)
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
9 any later version.
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
10
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
11 GNU Emacs is distributed in the hope that it will be useful,
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
14 GNU General Public License for more details.
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
15
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
17 along with GNU Emacs; see the file COPYING. If not, write to
14186
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 13183
diff changeset
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 13183
diff changeset
19 Boston, MA 02111-1307, USA. */
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
20
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
21 /* Access the slots of a display-table, according to their purpose. */
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
22
13183
6b79b1d9cddd (DISP_TABLE_P): Check the `purpose' slot.
Richard M. Stallman <rms@gnu.org>
parents: 12244
diff changeset
23 #define DISP_TABLE_P(obj) \
6b79b1d9cddd (DISP_TABLE_P): Check the `purpose' slot.
Richard M. Stallman <rms@gnu.org>
parents: 12244
diff changeset
24 (CHAR_TABLE_P (obj) \
17363
0fe9203c7a06 (DISP_TABLE_P): Don't use Lisp_Object as integer.
Karl Heuer <kwzh@gnu.org>
parents: 17332
diff changeset
25 && EQ (XCHAR_TABLE (obj)->purpose, Qdisplay_table) \
13183
6b79b1d9cddd (DISP_TABLE_P): Check the `purpose' slot.
Richard M. Stallman <rms@gnu.org>
parents: 12244
diff changeset
26 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (obj)) == DISP_TABLE_EXTRA_SLOTS)
6b79b1d9cddd (DISP_TABLE_P): Check the `purpose' slot.
Richard M. Stallman <rms@gnu.org>
parents: 12244
diff changeset
27
6b79b1d9cddd (DISP_TABLE_P): Check the `purpose' slot.
Richard M. Stallman <rms@gnu.org>
parents: 12244
diff changeset
28 #define DISP_TABLE_EXTRA_SLOTS 6
6b79b1d9cddd (DISP_TABLE_P): Check the `purpose' slot.
Richard M. Stallman <rms@gnu.org>
parents: 12244
diff changeset
29 #define DISP_TRUNC_GLYPH(dp) ((dp)->extras[0])
6b79b1d9cddd (DISP_TABLE_P): Check the `purpose' slot.
Richard M. Stallman <rms@gnu.org>
parents: 12244
diff changeset
30 #define DISP_CONTINUE_GLYPH(dp) ((dp)->extras[1])
6b79b1d9cddd (DISP_TABLE_P): Check the `purpose' slot.
Richard M. Stallman <rms@gnu.org>
parents: 12244
diff changeset
31 #define DISP_ESCAPE_GLYPH(dp) ((dp)->extras[2])
6b79b1d9cddd (DISP_TABLE_P): Check the `purpose' slot.
Richard M. Stallman <rms@gnu.org>
parents: 12244
diff changeset
32 #define DISP_CTRL_GLYPH(dp) ((dp)->extras[3])
6b79b1d9cddd (DISP_TABLE_P): Check the `purpose' slot.
Richard M. Stallman <rms@gnu.org>
parents: 12244
diff changeset
33 #define DISP_INVIS_VECTOR(dp) ((dp)->extras[4])
6b79b1d9cddd (DISP_TABLE_P): Check the `purpose' slot.
Richard M. Stallman <rms@gnu.org>
parents: 12244
diff changeset
34 #define DISP_BORDER_GLYPH(dp) ((dp)->extras[5])
6b79b1d9cddd (DISP_TABLE_P): Check the `purpose' slot.
Richard M. Stallman <rms@gnu.org>
parents: 12244
diff changeset
35
20309
51fb1f36e614 Add prototypes. Remove declaration of obsolete
Andreas Schwab <schwab@suse.de>
parents: 17363
diff changeset
36 extern Lisp_Object disp_char_vector P_ ((struct Lisp_Char_Table *, int));
17332
35269345d9ef (disp_char_vector): Extern it.
Kenichi Handa <handa@m17n.org>
parents: 17183
diff changeset
37
17116
321ebfc346eb (DISP_CHAR_VECTOR): Allow bare 8-bit in display-table.
Kenichi Handa <handa@m17n.org>
parents: 17029
diff changeset
38 #define DISP_CHAR_VECTOR(dp, c) \
17332
35269345d9ef (disp_char_vector): Extern it.
Kenichi Handa <handa@m17n.org>
parents: 17183
diff changeset
39 (SINGLE_BYTE_CHAR_P(c) ? (dp)->contents[c] : disp_char_vector ((dp), (c)))
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
40
9406
a549857b7a13 * disptab.h (window_display_table): Doc fix.
Jim Blandy <jimb@redhat.com>
parents: 9143
diff changeset
41 /* Defined in window.c. */
20309
51fb1f36e614 Add prototypes. Remove declaration of obsolete
Andreas Schwab <schwab@suse.de>
parents: 17363
diff changeset
42 extern struct Lisp_Char_Table *window_display_table P_ ((struct window *));
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
43
9406
a549857b7a13 * disptab.h (window_display_table): Doc fix.
Jim Blandy <jimb@redhat.com>
parents: 9143
diff changeset
44 /* Defined in indent.c. */
20309
51fb1f36e614 Add prototypes. Remove declaration of obsolete
Andreas Schwab <schwab@suse.de>
parents: 17363
diff changeset
45 extern struct Lisp_Char_Table *buffer_display_table P_ ((void));
9406
a549857b7a13 * disptab.h (window_display_table): Doc fix.
Jim Blandy <jimb@redhat.com>
parents: 9143
diff changeset
46
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
47 /* Display table to use for vectors that don't specify their own. */
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
48 extern Lisp_Object Vstandard_display_table;
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
49
13183
6b79b1d9cddd (DISP_TABLE_P): Check the `purpose' slot.
Richard M. Stallman <rms@gnu.org>
parents: 12244
diff changeset
50 /* This is the `purpose' slot of a display table. */
6b79b1d9cddd (DISP_TABLE_P): Check the `purpose' slot.
Richard M. Stallman <rms@gnu.org>
parents: 12244
diff changeset
51 extern Lisp_Object Qdisplay_table;
6b79b1d9cddd (DISP_TABLE_P): Check the `purpose' slot.
Richard M. Stallman <rms@gnu.org>
parents: 12244
diff changeset
52
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
53 /* Vector of GLYPH definitions. Indexed by GLYPH number,
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
54 the contents are a string which is how to output the GLYPH. */
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
55 extern Lisp_Object Vglyph_table;
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
56
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
57 /* Return the current length of the GLYPH table,
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
58 or 0 if the table isn't currently valid. */
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
59 #define GLYPH_TABLE_LENGTH \
9143
069f8b6cdfe6 (GLYPH_TABLE_LENGTH, GLYPH_TABLE_BASE, GLYPH_SIMPLE_P, GLYPH_ALIAS_P): Use
Karl Heuer <kwzh@gnu.org>
parents: 8919
diff changeset
60 ((VECTORP (Vglyph_table)) ? XVECTOR (Vglyph_table)->size : 0)
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
61
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
62 /* Return the current base (for indexing) of the GLYPH table,
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
63 or 0 if the table isn't currently valid. */
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
64 #define GLYPH_TABLE_BASE \
9143
069f8b6cdfe6 (GLYPH_TABLE_LENGTH, GLYPH_TABLE_BASE, GLYPH_SIMPLE_P, GLYPH_ALIAS_P): Use
Karl Heuer <kwzh@gnu.org>
parents: 8919
diff changeset
65 ((VECTORP (Vglyph_table)) ? XVECTOR (Vglyph_table)->contents : 0)
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
66
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
67 /* Given BASE and LEN returned by the two previous macros,
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
68 return nonzero if the GLYPH code G should be output as a single
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
69 character with code G. Return zero if G has a string in the table. */
9143
069f8b6cdfe6 (GLYPH_TABLE_LENGTH, GLYPH_TABLE_BASE, GLYPH_SIMPLE_P, GLYPH_ALIAS_P): Use
Karl Heuer <kwzh@gnu.org>
parents: 8919
diff changeset
70 #define GLYPH_SIMPLE_P(base,len,g) ((g) >= (len) || !STRINGP (base[g]))
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
71
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
72 /* Given BASE and LEN returned by the two previous macros,
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
73 return nonzero if GLYPH code G is aliased to a different code. */
9143
069f8b6cdfe6 (GLYPH_TABLE_LENGTH, GLYPH_TABLE_BASE, GLYPH_SIMPLE_P, GLYPH_ALIAS_P): Use
Karl Heuer <kwzh@gnu.org>
parents: 8919
diff changeset
74 #define GLYPH_ALIAS_P(base,len,g) ((g) < (len) && INTEGERP (base[g]))
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
75
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
76 /* Assuming that GLYPH_SIMPLE_P (BASE, LEN, G) is 1,
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
77 return the alias for G. */
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
78 #define GLYPH_ALIAS(base, g) XINT (base[g])
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
79
2725
507115aff66d * xdisp.c (display_text_line): Apply faces to characters according
Jim Blandy <jimb@redhat.com>
parents: 2012
diff changeset
80 /* Follow all aliases for G in the glyph table given by (BASE,
507115aff66d * xdisp.c (display_text_line): Apply faces to characters according
Jim Blandy <jimb@redhat.com>
parents: 2012
diff changeset
81 LENGTH), and set G to the final glyph. */
17183
00252a78ce4f (GLYPH_FOLLOW_ALIASES): Assure that the resulting G
Kenichi Handa <handa@m17n.org>
parents: 17116
diff changeset
82 #define GLYPH_FOLLOW_ALIASES(base, length, g) \
00252a78ce4f (GLYPH_FOLLOW_ALIASES): Assure that the resulting G
Kenichi Handa <handa@m17n.org>
parents: 17116
diff changeset
83 do { \
00252a78ce4f (GLYPH_FOLLOW_ALIASES): Assure that the resulting G
Kenichi Handa <handa@m17n.org>
parents: 17116
diff changeset
84 while (GLYPH_ALIAS_P ((base), (length), (g))) \
00252a78ce4f (GLYPH_FOLLOW_ALIASES): Assure that the resulting G
Kenichi Handa <handa@m17n.org>
parents: 17116
diff changeset
85 (g) = GLYPH_ALIAS ((base), (g)); \
00252a78ce4f (GLYPH_FOLLOW_ALIASES): Assure that the resulting G
Kenichi Handa <handa@m17n.org>
parents: 17116
diff changeset
86 if (!GLYPH_CHAR_VALID_P (FAST_GLYPH_CHAR (g))) \
00252a78ce4f (GLYPH_FOLLOW_ALIASES): Assure that the resulting G
Kenichi Handa <handa@m17n.org>
parents: 17116
diff changeset
87 g = FAST_MAKE_GLYPH (' ', FAST_GLYPH_FACE (g)); \
00252a78ce4f (GLYPH_FOLLOW_ALIASES): Assure that the resulting G
Kenichi Handa <handa@m17n.org>
parents: 17116
diff changeset
88 } while (0)
00252a78ce4f (GLYPH_FOLLOW_ALIASES): Assure that the resulting G
Kenichi Handa <handa@m17n.org>
parents: 17116
diff changeset
89
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
90 /* Assuming that GLYPH_SIMPLE_P (BASE, LEN, G) is 0,
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
91 return the length and the address of the character-sequence
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
92 used for outputting GLYPH G. */
46370
40db0673e6f0 Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents: 20309
diff changeset
93 #define GLYPH_LENGTH(base,g) SCHARS (base[g])
40db0673e6f0 Most uses of XSTRING combined with STRING_BYTES or indirection changed to
Ken Raeburn <raeburn@raeburn.org>
parents: 20309
diff changeset
94 #define GLYPH_STRING(base,g) SDATA (base[g])
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
95
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
96 /* GLYPH for a space character. */
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
97
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
98 #define SPACEGLYPH 040
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
99 #define NULL_GLYPH 00
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
100
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
101 #define GLYPH_FROM_CHAR(c) (c)
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 46370
diff changeset
102
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 46370
diff changeset
103 /* arch-tag: d7f792d2-f59c-4904-a91e-91522e3ab349
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 46370
diff changeset
104 (do not change this comment) */