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, 2012
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
9
10 This file is part of GNU Emacs.
11
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 (at
15 your option) any later version.
16
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.
21
22 You should have received a copy of the GNU General Public License
23 along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. */
24
25 #ifndef EMACS_CATEGORY_H
26 #define EMACS_CATEGORY_H
27
28 /* We introduce here three types of object: category, category set,
29 and category table.
30
31 A category is like syntax but differs in the following points:
32
33 o A category is represented by a mnemonic character of the range
34 ` '(32)..`~'(126) (printable ASCII characters).
35
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.
39
40 o In addition to the predefined categories, a user can define new
41 categories. Total number of categories is limited to 95.
42
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).
46
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.
51
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.
54
55 The second extra slot is a version number of the category table.
56 But, for the moment, we are not using this slot. */
57
58 #include "lisp.h"
59
60 INLINE_HEADER_BEGIN
61
62 #define CATEGORYP(x) RANGED_FIXNUMP (0x20, x, 0x7E)
63
64 #define CHECK_CATEGORY(x) \
65 CHECK_TYPE (CATEGORYP (x), Qcategoryp, x)
66
67 #define CATEGORY_SET_P(x) \
68 (BOOL_VECTOR_P (x) && bool_vector_size (x) == 128)
69
70 /* Return a new empty category set. */
71 #define MAKE_CATEGORY_SET (Fmake_bool_vector (make_fixnum (128), Qnil))
72
73 #define CHECK_CATEGORY_SET(x) \
74 CHECK_TYPE (CATEGORY_SET_P (x), Qcategorysetp, x)
75
76 /* Return the category set of character C in the current category table. */
77 #define CATEGORY_SET(c) char_category_set (c)
78
79 /* Return true if CATEGORY_SET contains CATEGORY.
80 Faster than '!NILP (Faref (category_set, make_fixnum (category)))'. */
81 INLINE bool
82 CATEGORY_MEMBER (EMACS_INT category, Lisp_Object category_set)
83 {
84 return bool_vector_bitref (category_set, category);
85 }
86
87 /* Return true if category set of CH contains CATEGORY. */
88 INLINE bool
89 CHAR_HAS_CATEGORY (int ch, int category)
90 {
91 Lisp_Object category_set = CATEGORY_SET (ch);
92 return CATEGORY_MEMBER (category, category_set);
93 }
94
95 /* The standard category table is stored where it will automatically
96 be used in all new buffers. */
97 #define Vstandard_category_table BVAR (&buffer_defaults, category_table)
98
99 /* Return the doc string of CATEGORY in category table TABLE. */
100 #define CATEGORY_DOCSTRING(table, category) \
101 AREF (Fchar_table_extra_slot (table, make_fixnum (0)), ((category) - ' '))
102
103 /* Set the doc string of CATEGORY to VALUE in category table TABLE. */
104 #define SET_CATEGORY_DOCSTRING(table, category, value) \
105 ASET (Fchar_table_extra_slot (table, make_fixnum (0)), ((category) - ' '), value)
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_fixnum (1))
111
112 /* Return true if there is a word boundary between two
113 word-constituent characters C1 and C2 if they appear in this order.
114 There is no word boundary between two word-constituent ASCII and
115 Latin-1 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 bool word_boundary_p (int, int);
121
122 INLINE_HEADER_END
123
124 #endif /* EMACS_CATEGORY_H */