Merge from trunk.
[emacs.git] / src / category.h
blob737198cc9649682161ca1894107c2c04a5b25363
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, 2009, 2010, 2011
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 of the License, or
15 (at your option) 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. If not, see <http://www.gnu.org/licenses/>. */
26 /* We introduce here three types of object: category, category set,
27 and category table.
29 A category is like syntax but differs in the following points:
31 o A category is represented by a mnemonic character of the range
32 ` '(32)..`~'(126) (printable ASCII characters).
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.
38 o In addition to the predefined categories, a user can define new
39 categories. Total number of categories is limited to 95.
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).
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.
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.
53 The second extra slot is a version number of the category table.
54 But, for the moment, we are not using this slot. */
56 #define CATEGORYP(x) \
57 (INTEGERP ((x)) && XFASTINT ((x)) >= 0x20 && XFASTINT ((x)) <= 0x7E)
59 #define CHECK_CATEGORY(x) \
60 CHECK_TYPE (CATEGORYP (x), Qcategoryp, x)
62 #define XCATEGORY_SET XBOOL_VECTOR
64 #define CATEGORY_SET_P(x) \
65 (BOOL_VECTOR_P (x) && XBOOL_VECTOR (x)->size == 128)
67 /* Return a new empty category set. */
68 #define MAKE_CATEGORY_SET (Fmake_bool_vector (make_number (128), Qnil))
70 #define CHECK_CATEGORY_SET(x) \
71 CHECK_TYPE (CATEGORY_SET_P (x), Qcategorysetp, x)
73 /* Return 1 if CATEGORY_SET contains CATEGORY, else return 0.
74 The faster version of `!NILP (Faref (category_set, category))'. */
75 #define CATEGORY_MEMBER(category, category_set) \
76 (XCATEGORY_SET (category_set)->data[(category) / 8] \
77 & (1 << ((category) % 8)))
79 /* Temporary internal variable used in macro CHAR_HAS_CATEGORY. */
80 extern Lisp_Object _temp_category_set;
82 /* Return 1 if category set of CH contains CATEGORY, elt return 0. */
83 #define CHAR_HAS_CATEGORY(ch, category) \
84 (_temp_category_set = CATEGORY_SET (ch), \
85 CATEGORY_MEMBER (category, _temp_category_set))
87 /* The standard category table is stored where it will automatically
88 be used in all new buffers. */
89 #define Vstandard_category_table BVAR (&buffer_defaults, category_table)
91 /* Return the category set of character C in the current category table. */
92 #define CATEGORY_SET(c) char_category_set (c)
94 /* Return the doc string of CATEGORY in category table TABLE. */
95 #define CATEGORY_DOCSTRING(table, category) \
96 XVECTOR (Fchar_table_extra_slot (table, make_number (0)))->contents[(category) - ' ']
98 /* Return the version number of category table TABLE. Not used for
99 the moment. */
100 #define CATEGORY_TABLE_VERSION (table) \
101 Fchar_table_extra_slot (table, make_number (1))
103 /* Return 1 if there is a word boundary between two word-constituent
104 characters C1 and C2 if they appear in this order, else return 0.
105 There is no word boundary between two word-constituent ASCII and
106 Latin-1 characters. */
107 #define WORD_BOUNDARY_P(c1, c2) \
108 (!(SINGLE_BYTE_CHAR_P (c1) && SINGLE_BYTE_CHAR_P (c2)) \
109 && word_boundary_p (c1, c2))
111 extern int word_boundary_p (int, int);