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