src/category.h

   1 /* Declarations having to do with Emacs category tables.
   2    Copyright (C) 1995 Electrotechnical Laboratory, JAPAN.
   3      Licensed to the Free Software Foundation.
   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 2, 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., 59 Temple Place - Suite 330,
  20 Boston, MA 02111-1307, USA.  */
  21
  22
  23 /* We introduce here three types of object: category, category set,
  24    and category table.
  25
  26    A category is like syntax but differs in the following points:
  27
  28    o A category is represented by a mnemonic character of the range
  29    ` '(32)..`~'(126) (printable ASCII characters).
  30
  31    o A category is not exclusive, i.e. a character has multiple
  32    categories (category set).  Of course, there's a case that a
  33    category set is empty, i.e. the character has no category.
  34
  35    o In addition to the predefined categories, a user can define new
  36    categories.  Total number of categories is limited to 95.
  37
  38    A category set is a set of categories represented by Lisp
  39    bool-vector of length 128 (only elements of 31th through 126th
  40    are used).
  41
  42    A category table is like syntax-table, represented by a Lisp
  43    char-table.  The contents are category sets or nil.  It has two
  44    extra slots, for a vector of doc string of each category and a
  45    version number.
  46
  47    The first extra slot is a vector of doc strings of categories, the
  48    length is 95.  The Nth element corresponding to the category N+32.
  49
  50    The second extra slot is a version number of the category table.
  51    But, for the moment, we are not using this slot.  */
  52
  53 #define CATEGORYP(x) \
  54   (INTEGERP ((x)) && XFASTINT ((x)) >= 0x20 && XFASTINT ((x)) <= 0x7E)
  55
  56 #define CHECK_CATEGORY(x, i)                                            \
  57   do {                                                                  \
  58     if (!CATEGORYP ((x))) x = wrong_type_argument (Qcategoryp, (x));    \
  59   } while (0)
  60
  61 #define XCATEGORY_SET XBOOL_VECTOR
  62
  63 #define CATEGORY_SET_P(x) \
  64   (BOOL_VECTOR_P ((x)) && (EMACS_INT) (XBOOL_VECTOR ((x))->size) == 128)
  65
  66 /* Return a new empty category set.  */
  67 #define MAKE_CATEGORY_SET (Fmake_bool_vector (make_number (128), Qnil))
  68
  69 /* Make CATEGORY_SET includes (if VAL is t) or excludes (if VAL is
  70    nil) CATEGORY.  */
  71 #define SET_CATEGORY_SET(category_set, category, val) \
  72   (Faset (category_set, category, val))
  73
  74 #define CHECK_CATEGORY_SET(x, i)                                           \
  75   do {                                                                     \
  76     if (!CATEGORY_SET_P ((x))) x = wrong_type_argument (Qcategorysetp, (x)); \
  77   } while (0)
  78
  79 /* Return 1 if CATEGORY_SET contains CATEGORY, else return 0.
  80    The faster version of `!NILP (Faref (category_set, category))'.  */
  81 #define CATEGORY_MEMBER(category, category_set)                         \
  82   (XCATEGORY_SET (category_set)->data[(category) / 8]                   \
  83    & (1 << ((category) % 8)))
  84
  85 /* Temporary internal variable used in macro CHAR_HAS_CATEGORY.  */
  86 extern Lisp_Object _temp_category_set;
  87
  88 /* Return 1 if category set of CH contains CATEGORY, elt return 0.  */
  89 #define CHAR_HAS_CATEGORY(ch, category) \
  90   (_temp_category_set = CATEGORY_SET (ch),      \
  91    CATEGORY_MEMBER (category, _temp_category_set))
  92
  93 /* The standard category table is stored where it will automatically
  94    be used in all new buffers.  */
  95 #define Vstandard_category_table buffer_defaults.category_table
  96
  97 /* Return the category set of character C in the current category table.  */
  98 #ifdef __GNUC__
  99 #define CATEGORY_SET(c)                                                      \
 100   ({ Lisp_Object table = current_buffer->category_table;                     \
 101      Lisp_Object temp;                                                       \
 102      if ((c) < CHAR_TABLE_SINGLE_BYTE_SLOTS)                                 \
 103        while (NILP (temp = XCHAR_TABLE (table)->contents[(unsigned char) c]) \
 104               && NILP (temp = XCHAR_TABLE (table)->defalt))                  \
 105          table = XCHAR_TABLE (table)->parent;                                \
 106      else                                                                    \
 107        temp = Faref (table,                                                  \
 108                      make_number (COMPOSITE_CHAR_P (c)                       \
 109                                   ? cmpchar_component (c, 0) : (c)));        \
 110      temp; })
 111 #else
 112 #define CATEGORY_SET(c)                                                      \
 113   ((c) < CHAR_TABLE_SINGLE_BYTE_SLOTS                                        \
 114    ? Faref (current_buffer->category_table, make_number ((unsigned char) c)) \
 115    : Faref (current_buffer->category_table,                                  \
 116             make_number (COMPOSITE_CHAR_P (c)                                \
 117                          ? cmpchar_component ((c), 0) : (c))))
 118 #endif
 119
 120 /* Return the doc string of CATEGORY in category table TABLE.  */
 121 #define CATEGORY_DOCSTRING(table, category) \
 122   XVECTOR (Fchar_table_extra_slot (table, make_number (0)))->contents[(category) - ' ']
 123
 124 /* Return the version number of category table TABLE.  Not used for
 125    the moment.  */
 126 #define CATEGORY_TABLE_VERSION (table) \
 127   Fchar_table_extra_slot (table, make_number (1))
 128
 129 /* Return 1 if there is a word boundary between two word-constituent
 130    characters C1 and C2 if they appear in this order, else return 0.
 131    There is no word boundary between two word-constituent ASCII
 132    characters.  */
 133 #define WORD_BOUNDARY_P(c1, c2)                                 \
 134   (!(SINGLE_BYTE_CHAR_P (c1) && SINGLE_BYTE_CHAR_P (c2))        \
 135    && word_boundary_p (c1, c2))