src/disptab.h

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