src/disptab.h

   1 /* Things for GLYPHS and glyph tables.
   2    Copyright (C) 1993, 2001, 2002, 2003, 2004, 2005,
   3                  2006, 2007, 2008  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, or (at your option)
  10 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; see the file COPYING.  If not, write to
  19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20 Boston, MA 02110-1301, USA.  */
  21
  22 /* Access the slots of a display-table, according to their purpose.  */
  23
  24 #define DISP_TABLE_P(obj)                                                   \
  25   (CHAR_TABLE_P (obj)                                                       \
  26    && EQ (XCHAR_TABLE (obj)->purpose, Qdisplay_table)                       \
  27    && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (obj)) == DISP_TABLE_EXTRA_SLOTS)
  28
  29 #define DISP_TABLE_EXTRA_SLOTS 6
  30 #define DISP_TRUNC_GLYPH(dp) ((dp)->extras[0])
  31 #define DISP_CONTINUE_GLYPH(dp) ((dp)->extras[1])
  32 #define DISP_ESCAPE_GLYPH(dp) ((dp)->extras[2])
  33 #define DISP_CTRL_GLYPH(dp) ((dp)->extras[3])
  34 #define DISP_INVIS_VECTOR(dp) ((dp)->extras[4])
  35 #define DISP_BORDER_GLYPH(dp) ((dp)->extras[5])
  36
  37 extern Lisp_Object disp_char_vector P_ ((struct Lisp_Char_Table *, int));
  38
  39 #define DISP_CHAR_VECTOR(dp, c)                         \
  40   (ASCII_CHAR_P(c)                                      \
  41    ? (NILP ((dp)->ascii)                                \
  42       ? (dp)->defalt                                    \
  43       : (SUB_CHAR_TABLE_P ((dp)->ascii)                 \
  44          ? XSUB_CHAR_TABLE ((dp)->ascii)->contents[c]   \
  45          : (dp)->ascii))                                \
  46    : disp_char_vector ((dp), (c)))
  47
  48 /* Defined in window.c.  */
  49 extern struct Lisp_Char_Table *window_display_table P_ ((struct window *));
  50
  51 /* Defined in indent.c.  */
  52 extern struct Lisp_Char_Table *buffer_display_table P_ ((void));
  53
  54 /* Display table to use for vectors that don't specify their own.  */
  55 extern Lisp_Object Vstandard_display_table;
  56
  57 /* This is the `purpose' slot of a display table.  */
  58 extern Lisp_Object Qdisplay_table;
  59
  60 /* Vector of GLYPH definitions.  Indexed by GLYPH number,
  61    the contents are a string which is how to output the GLYPH.  */
  62 extern Lisp_Object Vglyph_table;
  63
  64 /* Return the current length of the GLYPH table,
  65    or 0 if the table isn't currently valid.  */
  66 #define GLYPH_TABLE_LENGTH  \
  67   ((VECTORP (Vglyph_table)) ? XVECTOR (Vglyph_table)->size : 0)
  68
  69 /* Return the current base (for indexing) of the GLYPH table,
  70    or 0 if the table isn't currently valid.  */
  71 #define GLYPH_TABLE_BASE  \
  72   ((VECTORP (Vglyph_table)) ? XVECTOR (Vglyph_table)->contents : 0)
  73
  74 /* Given BASE and LEN returned by the two previous macros,
  75    return nonzero if the GLYPH code G should be output as a single
  76    character with code G.  Return zero if G has a string in the table.  */
  77 #define GLYPH_SIMPLE_P(base,len,g) \
  78   (GLYPH_FACE (g) != DEFAULT_FACE_ID || GLYPH_CHAR (g) >= (len) || !STRINGP (base[GLYPH_CHAR (g)]))
  79
  80 /* Given BASE and LEN returned by the two previous macros,
  81    return nonzero if GLYPH code G is aliased to a different code.  */
  82 #define GLYPH_ALIAS_P(base,len,g) \
  83   (GLYPH_FACE (g) == DEFAULT_FACE_ID && GLYPH_CHAR (g) < (len) && INTEGERP (base[GLYPH_CHAR (g)]))
  84
  85 /* Follow all aliases for G in the glyph table given by (BASE,
  86    LENGTH), and set G to the final glyph.  */
  87 #define GLYPH_FOLLOW_ALIASES(base, length, g)                   \
  88   do {                                                          \
  89     while (GLYPH_ALIAS_P ((base), (length), (g)))               \
  90       SET_GLYPH_CHAR ((g), XINT ((base)[GLYPH_CHAR (g)]));      \
  91     if (!GLYPH_CHAR_VALID_P (g))                                \
  92       SET_GLYPH_CHAR (g, ' ');                                  \
  93   } while (0)
  94
  95 /* Assuming that GLYPH_SIMPLE_P (BASE, LEN, G) is 0,
  96    return the length and the address of the character-sequence
  97    used for outputting GLYPH G.  */
  98 #define GLYPH_LENGTH(base,g)   SCHARS (base[GLYPH_CHAR (g)])
  99 #define GLYPH_STRING(base,g)   SDATA (base[GLYPH_CHAR (g)])
 100
 101 /* GLYPH for a space character.  */
 102
 103 #define SPACEGLYPH 040
 104 #define NULL_GLYPH 00
 105
 106 #define SET_GLYPH_FROM_CHAR(glyph, c) \
 107   SET_GLYPH (glyph, c, DEFAULT_FACE_ID)
 108
 109 /* arch-tag: d7f792d2-f59c-4904-a91e-91522e3ab349
 110    (do not change this comment) */