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