emacs/src/disptab.h

102 lines
3.7 KiB
C

/* Things for GLYPHS and glyph tables.
Copyright (C) 1993, 2001-2024 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 of the License, 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. If not, see <https://www.gnu.org/licenses/>. */
/* Access the slots of a display-table, according to their purpose. */
#ifndef EMACS_DISPTAB_H
#define EMACS_DISPTAB_H
#include "lisp.h"
#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 (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 (struct window *);
/* Defined in indent.c. */
extern struct Lisp_Char_Table *buffer_display_table (void);
/* Return the current length of the GLYPH table,
or 0 if the table isn't currently valid. */
#define GLYPH_TABLE_LENGTH \
((VECTORP (Vglyph_table)) ? ASIZE (Vglyph_table) : 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) && FIXNUMP (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, XFIXNUM ((base)[GLYPH_CHAR (g)])); \
if (!GLYPH_CHAR_VALID_P (g)) \
SET_GLYPH_CHAR (g, ' '); \
} while (false)
/* 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)
#endif /* EMACS_DISPTAB_H */