Commit | Line | Data |
---|---|---|
4ed46869 | 1 | /* Declarations having to do with Emacs category tables. |
7976eda0 | 2 | Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, |
29b83cec | 3 | 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012 |
ce03bf76 KH |
4 | National Institute of Advanced Industrial Science and Technology (AIST) |
5 | Registration Number H14PRO021 | |
8f924df7 | 6 | Copyright (C) 2003 |
2eca16e6 KH |
7 | National Institute of Advanced Industrial Science and Technology (AIST) |
8 | Registration Number H13PRO009 | |
4ed46869 KH |
9 | |
10 | This file is part of GNU Emacs. | |
11 | ||
b9b1cc14 | 12 | GNU Emacs is free software: you can redistribute it and/or modify |
4ed46869 | 13 | it under the terms of the GNU General Public License as published by |
b9b1cc14 GM |
14 | the Free Software Foundation, either version 3 of the License, or |
15 | (at your option) any later version. | |
4ed46869 KH |
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 | |
b9b1cc14 | 23 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
4ed46869 KH |
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 | |
cecda314 | 42 | bool-vector of length 128 (only elements of 31th through 126th |
4ed46869 KH |
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 | |
cecda314 | 47 | extra slots, for a vector of doc string of each category and a |
4ed46869 KH |
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 | ||
f162bcc3 | 56 | INLINE_HEADER_BEGIN |
f162bcc3 | 57 | |
d311d28c | 58 | #define CATEGORYP(x) RANGED_INTEGERP (0x20, x, 0x7E) |
4ed46869 | 59 | |
7e9d10c3 KS |
60 | #define CHECK_CATEGORY(x) \ |
61 | CHECK_TYPE (CATEGORYP (x), Qcategoryp, x) | |
4ed46869 | 62 | |
4ed46869 | 63 | #define CATEGORY_SET_P(x) \ |
1c0a7493 | 64 | (BOOL_VECTOR_P (x) && bool_vector_size (x) == 128) |
4ed46869 KH |
65 | |
66 | /* Return a new empty category set. */ | |
67 | #define MAKE_CATEGORY_SET (Fmake_bool_vector (make_number (128), Qnil)) | |
68 | ||
7e9d10c3 KS |
69 | #define CHECK_CATEGORY_SET(x) \ |
70 | CHECK_TYPE (CATEGORY_SET_P (x), Qcategorysetp, x) | |
4ed46869 | 71 | |
29b83cec AS |
72 | /* Return the category set of character C in the current category table. */ |
73 | #define CATEGORY_SET(c) char_category_set (c) | |
74 | ||
17c05d74 | 75 | /* Return true if CATEGORY_SET contains CATEGORY. |
df5b4930 PE |
76 | Faster than '!NILP (Faref (category_set, make_number (category)))'. */ |
77 | INLINE bool | |
78 | CATEGORY_MEMBER (EMACS_INT category, Lisp_Object category_set) | |
79 | { | |
80 | return bool_vector_bitref (category_set, category); | |
81 | } | |
4ed46869 | 82 | |
17c05d74 | 83 | /* Return true if category set of CH contains CATEGORY. */ |
00382e8b | 84 | INLINE bool |
29b83cec AS |
85 | CHAR_HAS_CATEGORY (int ch, int category) |
86 | { | |
87 | Lisp_Object category_set = CATEGORY_SET (ch); | |
88 | return CATEGORY_MEMBER (category, category_set); | |
89 | } | |
4ed46869 KH |
90 | |
91 | /* The standard category table is stored where it will automatically | |
92 | be used in all new buffers. */ | |
4b4deea2 | 93 | #define Vstandard_category_table BVAR (&buffer_defaults, category_table) |
4ed46869 | 94 | |
4ed46869 | 95 | /* Return the doc string of CATEGORY in category table TABLE. */ |
f1a95992 DA |
96 | #define CATEGORY_DOCSTRING(table, category) \ |
97 | AREF (Fchar_table_extra_slot (table, make_number (0)), ((category) - ' ')) | |
98 | ||
99 | /* Set the doc string of CATEGORY to VALUE in category table TABLE. */ | |
100 | #define SET_CATEGORY_DOCSTRING(table, category, value) \ | |
101 | ASET (Fchar_table_extra_slot (table, make_number (0)), ((category) - ' '), value) | |
4ed46869 KH |
102 | |
103 | /* Return the version number of category table TABLE. Not used for | |
104 | the moment. */ | |
105 | #define CATEGORY_TABLE_VERSION (table) \ | |
ea625b14 | 106 | Fchar_table_extra_slot (table, make_number (1)) |
4ed46869 | 107 | |
17c05d74 PE |
108 | /* Return true if there is a word boundary between two |
109 | word-constituent characters C1 and C2 if they appear in this order. | |
7f04a736 KH |
110 | There is no word boundary between two word-constituent ASCII and |
111 | Latin-1 characters. */ | |
4ed46869 KH |
112 | #define WORD_BOUNDARY_P(c1, c2) \ |
113 | (!(SINGLE_BYTE_CHAR_P (c1) && SINGLE_BYTE_CHAR_P (c2)) \ | |
114 | && word_boundary_p (c1, c2)) | |
f78433b6 | 115 | |
17c05d74 | 116 | extern bool word_boundary_p (int, int); |
f162bcc3 PE |
117 | |
118 | INLINE_HEADER_END |