Commit | Line | Data |
---|---|---|
4ed46869 KH |
1 | /* Declarations having to do with Emacs category tables. |
2 | Ver.1.0 | |
3 | ||
4 | Copyright (C) 1995 Free Software Foundation, Inc. | |
5 | Copyright (C) 1995 Electrotechnical Laboratory, JAPAN. | |
6 | ||
7 | This file is part of GNU Emacs. | |
8 | ||
9 | GNU Emacs is free software; you can redistribute it and/or modify | |
10 | it under the terms of the GNU General Public License as published by | |
11 | the Free Software Foundation; either version 2, or (at your option) | |
12 | any later version. | |
13 | ||
14 | GNU Emacs is distributed in the hope that it will be useful, | |
15 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | GNU General Public License for more details. | |
18 | ||
19 | You should have received a copy of the GNU General Public License | |
20 | along with GNU Emacs; see the file COPYING. If not, write to | |
21 | the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */ | |
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 | |
40 | bool-vector of length 128 (only elements of 31th through 125th | |
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 | |
45 | extra slots. for a vector of doc string of each category and a | |
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 | ||
57 | #define CHECK_CATEGORY(x, i) \ | |
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 | ||
75 | #define CHECK_CATEGORY_SET(x, i) \ | |
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) \ | |
83 | (!NILP (category_set) \ | |
84 | && (XCATEGORY_SET (category_set)->data[XFASTINT (category) / 8] \ | |
85 | & (1 << (XFASTINT (category) % 8)))) | |
86 | ||
87 | /* Temporary internal variable used in macro CHAR_HAS_CATEGORY. */ | |
88 | extern Lisp_Object _temp_category_set; | |
89 | ||
90 | /* Return 1 if category set of CH contains CATEGORY, elt return 0. */ | |
91 | #define CHAR_HAS_CATEGORY(ch, category) \ | |
92 | (_temp_category_set = CATEGORY_SET (ch), \ | |
93 | CATEGORY_MEMBER (category, _temp_category_set)) | |
94 | ||
95 | /* The standard category table is stored where it will automatically | |
96 | be used in all new buffers. */ | |
97 | #define Vstandard_category_table buffer_defaults.category_table | |
98 | ||
99 | /* Return the category set of character C in the current category table. */ | |
100 | #ifdef __GNUC__ | |
101 | #define CATEGORY_SET(c) \ | |
102 | ({ Lisp_Object table = current_buffer->category_table; \ | |
103 | Lisp_Object temp; \ | |
104 | if (c < CHAR_TABLE_ORDINARY_SLOTS) \ | |
105 | while (NILP (temp = XCHAR_TABLE (table)->contents[c]) \ | |
106 | && NILP (temp = XCHAR_TABLE (table)->defalt)) \ | |
107 | table = XCHAR_TABLE (table)->parent; \ | |
108 | else \ | |
109 | temp = Faref (table, c); \ | |
110 | temp; }) | |
111 | #else | |
112 | #define CATEGORY_SET(c) Faref (current_buffer->category_table, c) | |
113 | #endif | |
114 | ||
115 | /* Return the doc string of CATEGORY in category table TABLE. */ | |
116 | #define CATEGORY_DOCSTRING(table, category) \ | |
117 | XVECTOR (Fchar_table_extra_slot (table, 0))->contents[(category) - ' '] | |
118 | ||
119 | /* Return the version number of category table TABLE. Not used for | |
120 | the moment. */ | |
121 | #define CATEGORY_TABLE_VERSION (table) \ | |
122 | Fchar_table_extra_slot (table, 1) | |
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)) |