src/category.h

   1 /* Declarations having to do with Emacs category tables.
   2    Copyright (C) 1995, 1998, 1999
   3      National Institute of Advanced Industrial Science and Technology (AIST)
   4      Registration Number H14PRO021
   5
   6 This file is part of GNU Emacs.
   7
   8 GNU Emacs is free software; you can redistribute it and/or modify
   9 it under the terms of the GNU General Public License as published by
  10 the Free Software Foundation; either version 2, or (at your option)
  11 any later version.
  12
  13 GNU Emacs is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 GNU General Public License for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GNU Emacs; see the file COPYING.  If not, write to
  20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  21 Boston, MA 02110-1301, USA.  */
  22
  23
  24 /* We introduce here three types of object: category, category set,
  25    and category table.
  26
  27    A category is like syntax but differs in the following points:
  28
  29    o A category is represented by a mnemonic character of the range
  30    ` '(32)..`~'(126) (printable ASCII characters).
  31
  32    o A category is not exclusive, i.e. a character has multiple
  33    categories (category set).  Of course, there's a case that a
  34    category set is empty, i.e. the character has no category.
  35
  36    o In addition to the predefined categories, a user can define new
  37    categories.  Total number of categories is limited to 95.
  38
  39    A category set is a set of categories represented by Lisp
  40    bool-vector of length 128 (only elements of 31th through 126th
  41    are used).
  42
  43    A category table is like syntax-table, represented by a Lisp
  44    char-table.  The contents are category sets or nil.  It has two
  45    extra slots, for a vector of doc string of each category and a
  46    version number.
  47
  48    The first extra slot is a vector of doc strings of categories, the
  49    length is 95.  The Nth element corresponding to the category N+32.
  50
  51    The second extra slot is a version number of the category table.
  52    But, for the moment, we are not using this slot.  */
  53
  54 #define CATEGORYP(x) \
  55   (INTEGERP ((x)) && XFASTINT ((x)) >= 0x20 && XFASTINT ((x)) <= 0x7E)
  56
  57 #define CHECK_CATEGORY(x) \
  58   CHECK_TYPE (CATEGORYP (x), Qcategoryp, x)
  59
  60 #define XCATEGORY_SET XBOOL_VECTOR
  61
  62 #define CATEGORY_SET_P(x) \
  63   (BOOL_VECTOR_P ((x)) && (EMACS_INT) (XBOOL_VECTOR ((x))->size) == 128)
  64
  65 /* Return a new empty category set.  */
  66 #define MAKE_CATEGORY_SET (Fmake_bool_vector (make_number (128), Qnil))
  67
  68 /* Make CATEGORY_SET includes (if VAL is t) or excludes (if VAL is
  69    nil) CATEGORY.  */
  70 #define SET_CATEGORY_SET(category_set, category, val) \
  71   (Faset (category_set, category, val))
  72
  73 #define CHECK_CATEGORY_SET(x) \
  74   CHECK_TYPE (CATEGORY_SET_P (x), Qcategorysetp, x)
  75
  76 /* Return 1 if CATEGORY_SET contains CATEGORY, else return 0.
  77    The faster version of `!NILP (Faref (category_set, category))'.  */
  78 #define CATEGORY_MEMBER(category, category_set)                         \
  79   (XCATEGORY_SET (category_set)->data[(category) / 8]                   \
  80    & (1 << ((category) % 8)))
  81
  82 /* Temporary internal variable used in macro CHAR_HAS_CATEGORY.  */
  83 extern Lisp_Object _temp_category_set;
  84
  85 /* Return 1 if category set of CH contains CATEGORY, elt return 0.  */
  86 #define CHAR_HAS_CATEGORY(ch, category) \
  87   (_temp_category_set = CATEGORY_SET (ch),      \
  88    CATEGORY_MEMBER (category, _temp_category_set))
  89
  90 /* The standard category table is stored where it will automatically
  91    be used in all new buffers.  */
  92 #define Vstandard_category_table buffer_defaults.category_table
  93
  94 /* Return the category set of character C in the current category table.  */
  95 #ifdef __GNUC__
  96 #define CATEGORY_SET(c)                                                      \
  97   ({ Lisp_Object table = current_buffer->category_table;                     \
  98      Lisp_Object temp;                                                       \
  99      if ((c) < CHAR_TABLE_SINGLE_BYTE_SLOTS)                                 \
 100        while (NILP (temp = XCHAR_TABLE (table)->contents[(unsigned char) c]) \
 101               && NILP (temp = XCHAR_TABLE (table)->defalt))                  \
 102          table = XCHAR_TABLE (table)->parent;                                \
 103      else                                                                    \
 104        temp = Faref (table, make_number (c));                                \
 105      temp; })
 106 #else
 107 #define CATEGORY_SET(c) \
 108   Faref (current_buffer->category_table, make_number (c))
 109 #endif
 110
 111 /* Return the doc string of CATEGORY in category table TABLE.  */
 112 #define CATEGORY_DOCSTRING(table, category) \
 113   XVECTOR (Fchar_table_extra_slot (table, make_number (0)))->contents[(category) - ' ']
 114
 115 /* Return the version number of category table TABLE.  Not used for
 116    the moment.  */
 117 #define CATEGORY_TABLE_VERSION (table) \
 118   Fchar_table_extra_slot (table, make_number (1))
 119
 120 /* Return 1 if there is a word boundary between two word-constituent
 121    characters C1 and C2 if they appear in this order, else return 0.
 122    There is no word boundary between two word-constituent ASCII
 123    characters.  */
 124 #define WORD_BOUNDARY_P(c1, c2)                                 \
 125   (!(SINGLE_BYTE_CHAR_P (c1) && SINGLE_BYTE_CHAR_P (c2))        \
 126    && word_boundary_p (c1, c2))
 127
 128 extern int word_boundary_p P_ ((int, int));
 129
 130 /* arch-tag: 309dfe83-c3e2-4d22-8e81-faae5aece0ff
 131    (do not change this comment) */