Commit | Line | Data |
---|---|---|
4ed46869 | 1 | /* Declarations having to do with Emacs category tables. |
ce03bf76 KH |
2 | Copyright (C) 1995, 1998, 1999 |
3 | National Institute of Advanced Industrial Science and Technology (AIST) | |
4 | Registration Number H14PRO021 | |
4ed46869 KH |
5 | |
6 | This file is part of GNU Emacs. | |
7 | ||
8 | GNU Emacs is free software; you can redistribute it and/or modify | |
9 | it under the terms of the GNU General Public License as published by | |
10 | the Free Software Foundation; either version 2, or (at your option) | |
11 | any later version. | |
12 | ||
13 | GNU Emacs is distributed in the hope that it will be useful, | |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | GNU General Public License for more details. | |
17 | ||
18 | You should have received a copy of the GNU General Public License | |
19 | along with GNU Emacs; see the file COPYING. If not, write to | |
4fc5845f LK |
20 | the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
21 | Boston, MA 02110-1301, USA. */ | |
4ed46869 KH |
22 | |
23 | ||
24 | /* We introduce here three types of object: category, category set, | |
25 | and category table. | |
26 | ||
27 | A category is like syntax but differs in the following points: | |
28 | ||
29 | o A category is represented by a mnemonic character of the range | |
30 | ` '(32)..`~'(126) (printable ASCII characters). | |
31 | ||
32 | o A category is not exclusive, i.e. a character has multiple | |
33 | categories (category set). Of course, there's a case that a | |
34 | category set is empty, i.e. the character has no category. | |
35 | ||
36 | o In addition to the predefined categories, a user can define new | |
37 | categories. Total number of categories is limited to 95. | |
38 | ||
39 | A category set is a set of categories represented by Lisp | |
cecda314 | 40 | bool-vector of length 128 (only elements of 31th through 126th |
4ed46869 KH |
41 | are used). |
42 | ||
43 | A category table is like syntax-table, represented by a Lisp | |
44 | char-table. The contents are category sets or nil. It has two | |
cecda314 | 45 | extra slots, for a vector of doc string of each category and a |
4ed46869 KH |
46 | version number. |
47 | ||
48 | The first extra slot is a vector of doc strings of categories, the | |
49 | length is 95. The Nth element corresponding to the category N+32. | |
50 | ||
51 | The second extra slot is a version number of the category table. | |
52 | But, for the moment, we are not using this slot. */ | |
53 | ||
54 | #define CATEGORYP(x) \ | |
55 | (INTEGERP ((x)) && XFASTINT ((x)) >= 0x20 && XFASTINT ((x)) <= 0x7E) | |
56 | ||
f18d2738 | 57 | #define CHECK_CATEGORY(x) \ |
4ed46869 KH |
58 | do { \ |
59 | if (!CATEGORYP ((x))) x = wrong_type_argument (Qcategoryp, (x)); \ | |
60 | } while (0) | |
61 | ||
62 | #define XCATEGORY_SET XBOOL_VECTOR | |
63 | ||
64 | #define CATEGORY_SET_P(x) \ | |
65 | (BOOL_VECTOR_P ((x)) && (EMACS_INT) (XBOOL_VECTOR ((x))->size) == 128) | |
66 | ||
67 | /* Return a new empty category set. */ | |
68 | #define MAKE_CATEGORY_SET (Fmake_bool_vector (make_number (128), Qnil)) | |
69 | ||
70 | /* Make CATEGORY_SET includes (if VAL is t) or excludes (if VAL is | |
71 | nil) CATEGORY. */ | |
72 | #define SET_CATEGORY_SET(category_set, category, val) \ | |
73 | (Faset (category_set, category, val)) | |
74 | ||
f18d2738 | 75 | #define CHECK_CATEGORY_SET(x) \ |
4ed46869 KH |
76 | do { \ |
77 | if (!CATEGORY_SET_P ((x))) x = wrong_type_argument (Qcategorysetp, (x)); \ | |
78 | } while (0) | |
79 | ||
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) \ | |
2e34157c RS |
83 | (XCATEGORY_SET (category_set)->data[(category) / 8] \ |
84 | & (1 << ((category) % 8))) | |
4ed46869 KH |
85 | |
86 | /* Temporary internal variable used in macro CHAR_HAS_CATEGORY. */ | |
87 | extern Lisp_Object _temp_category_set; | |
88 | ||
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)) | |
93 | ||
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 | |
97 | ||
98 | /* Return the category set of character C in the current category table. */ | |
99 | #ifdef __GNUC__ | |
74d28e55 KH |
100 | #define CATEGORY_SET(c) \ |
101 | ({ Lisp_Object table = current_buffer->category_table; \ | |
102 | Lisp_Object temp; \ | |
cecda314 | 103 | if ((c) < CHAR_TABLE_SINGLE_BYTE_SLOTS) \ |
040df2c7 | 104 | while (NILP (temp = XCHAR_TABLE (table)->contents[(unsigned char) c]) \ |
74d28e55 KH |
105 | && NILP (temp = XCHAR_TABLE (table)->defalt)) \ |
106 | table = XCHAR_TABLE (table)->parent; \ | |
107 | else \ | |
759f9863 | 108 | temp = Faref (table, make_number (c)); \ |
4ed46869 KH |
109 | temp; }) |
110 | #else | |
759f9863 KH |
111 | #define CATEGORY_SET(c) \ |
112 | Faref (current_buffer->category_table, make_number (c)) | |
177c0ea7 | 113 | #endif |
4ed46869 KH |
114 | |
115 | /* Return the doc string of CATEGORY in category table TABLE. */ | |
116 | #define CATEGORY_DOCSTRING(table, category) \ | |
ea625b14 | 117 | XVECTOR (Fchar_table_extra_slot (table, make_number (0)))->contents[(category) - ' '] |
4ed46869 KH |
118 | |
119 | /* Return the version number of category table TABLE. Not used for | |
120 | the moment. */ | |
121 | #define CATEGORY_TABLE_VERSION (table) \ | |
ea625b14 | 122 | Fchar_table_extra_slot (table, make_number (1)) |
4ed46869 KH |
123 | |
124 | /* Return 1 if there is a word boundary between two word-constituent | |
125 | characters C1 and C2 if they appear in this order, else return 0. | |
126 | There is no word boundary between two word-constituent ASCII | |
127 | characters. */ | |
128 | #define WORD_BOUNDARY_P(c1, c2) \ | |
129 | (!(SINGLE_BYTE_CHAR_P (c1) && SINGLE_BYTE_CHAR_P (c2)) \ | |
130 | && word_boundary_p (c1, c2)) | |
f78433b6 AS |
131 | |
132 | extern int word_boundary_p P_ ((int, int)); | |
ab5796a9 MB |
133 | |
134 | /* arch-tag: 309dfe83-c3e2-4d22-8e81-faae5aece0ff | |
135 | (do not change this comment) */ |