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