1 /* Declarations having to do with Mule char tables.
2 Copyright (C) 1992 Free Software Foundation, Inc.
3 Copyright (C) 1995 Sun Microsystems, Inc.
5 This file is part of XEmacs.
7 XEmacs is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 2, or (at your option) any
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with XEmacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 /* Synched up with: Mule 2.3. Not synched with FSF.
24 This file was written independently of the FSF implementation,
25 and is not compatible. */
27 #ifndef INCLUDED_chartab_h_
28 #define INCLUDED_chartab_h_
35 Lisp_Object make_char_id_table (Lisp_Object initval);
37 void put_char_id_table (Lisp_Char_ID_Table* table,
38 Lisp_Object character, Lisp_Object value);
40 EXFUN (Fget_char_attribute, 3);
45 /************************************************************************/
47 /************************************************************************/
49 /* Under Mule, we use a complex representation (see below).
50 When not under Mule, there are only 256 possible characters
51 so we just represent them directly. */
55 struct Lisp_Char_Table_Entry
57 struct lcrecord_header header;
59 /* In the interests of simplicity, we just use a fixed 96-entry
60 table. If we felt like being smarter, we could make this
61 variable-size and add an offset value into this structure. */
62 Lisp_Object level2[96];
64 typedef struct Lisp_Char_Table_Entry Lisp_Char_Table_Entry;
66 DECLARE_LRECORD (char_table_entry, Lisp_Char_Table_Entry);
67 #define XCHAR_TABLE_ENTRY(x) \
68 XRECORD (x, char_table_entry, Lisp_Char_Table_Entry)
69 #define XSETCHAR_TABLE_ENTRY(x, p) XSETRECORD (x, p, char_table_entry)
70 #define CHAR_TABLE_ENTRYP(x) RECORDP (x, char_table_entry)
71 /* #define CHECK_CHAR_TABLE_ENTRY(x) CHECK_RECORD (x, char_table_entry)
72 char table entries should never escape to Lisp */
78 CHAR_TABLE_TYPE_GENERIC,
80 CHAR_TABLE_TYPE_CATEGORY,
82 CHAR_TABLE_TYPE_SYNTAX,
83 CHAR_TABLE_TYPE_DISPLAY,
88 #define NUM_ASCII_CHARS 160
90 #define NUM_ASCII_CHARS 256
93 struct Lisp_Char_Table
95 struct lcrecord_header header;
97 Lisp_Object ascii[NUM_ASCII_CHARS];
100 /* We basically duplicate the Mule vectors-of-vectors implementation.
101 We can do this because we know a great deal about the sorts of
102 things we are going to be indexing.
104 The current implementation is as follows:
106 ascii[0-159] is used for ASCII and Control-1 characters.
108 level1[0 .. (NUM_LEADING_BYTES-1)] indexes charsets by leading
109 byte (subtract MIN_LEADING_BYTE from the leading byte). If the
110 value of this is not an opaque, then it specifies a value for all
111 characters in the charset. Otherwise, it will be a
112 96-Lisp-Object opaque that we created, specifying a value for
113 each row. If the value of this is not an opaque, then it
114 specifies a value for all characters in the row. Otherwise, it
115 will be a 96-Lisp-Object opaque that we created, specifying a
116 value for each character.
118 NOTE: 1) This will fail if some C routine passes an opaque to
119 Fput_char_table(). Currently this is not a problem
120 since all char tables that are created are Lisp-visible
121 and thus no one should ever be putting an opaque in
122 a char table. Another possibility is to consider
125 Lisp_Object level1[NUM_LEADING_BYTES];
129 enum char_table_type type;
131 /* stuff used for syntax tables */
132 Lisp_Object mirror_table;
133 Lisp_Object next_table; /* DO NOT mark through this. */
135 typedef struct Lisp_Char_Table Lisp_Char_Table;
137 DECLARE_LRECORD (char_table, Lisp_Char_Table);
138 #define XCHAR_TABLE(x) XRECORD (x, char_table, Lisp_Char_Table)
139 #define XSETCHAR_TABLE(x, p) XSETRECORD (x, p, char_table)
140 #define CHAR_TABLEP(x) RECORDP (x, char_table)
141 #define CHECK_CHAR_TABLE(x) CHECK_RECORD (x, char_table)
142 #define CONCHECK_CHAR_TABLE(x) CONCHECK_RECORD (x, char_table)
144 #define CHAR_TABLE_TYPE(ct) ((ct)->type)
145 #define XCHAR_TABLE_TYPE(ct) CHAR_TABLE_TYPE (XCHAR_TABLE (ct))
149 Lisp_Object get_non_ascii_char_table_value (Lisp_Char_Table *ct,
150 Charset_ID leading_byte,
153 INLINE_HEADER Lisp_Object
154 CHAR_TABLE_NON_ASCII_VALUE_UNSAFE (Lisp_Char_Table *ct, Emchar ch);
155 INLINE_HEADER Lisp_Object
156 CHAR_TABLE_NON_ASCII_VALUE_UNSAFE (Lisp_Char_Table *ct, Emchar ch)
159 Charset_ID lb = CHAR_CHARSET_ID (ch);
161 Charset_ID lb = CHAR_LEADING_BYTE (ch);
163 if (!CHAR_TABLE_ENTRYP ((ct)->level1[lb - MIN_LEADING_BYTE]))
164 return (ct)->level1[lb - MIN_LEADING_BYTE];
166 return get_non_ascii_char_table_value (ct, lb, ch);
169 #define CHAR_TABLE_VALUE_UNSAFE(ct, ch) \
170 ((ch) < NUM_ASCII_CHARS \
172 : CHAR_TABLE_NON_ASCII_VALUE_UNSAFE (ct, ch))
176 #define CHAR_TABLE_VALUE_UNSAFE(ct, ch) ((ct)->ascii[(unsigned char) (ch)])
178 #endif /* not MULE */
180 #define XCHAR_TABLE_VALUE_UNSAFE(ct, ch) \
181 CHAR_TABLE_VALUE_UNSAFE (XCHAR_TABLE (ct), ch)
183 enum chartab_range_type
187 CHARTAB_RANGE_CHARSET,
195 enum chartab_range_type type;
201 void fill_char_table (Lisp_Char_Table *ct, Lisp_Object value);
202 void put_char_table (Lisp_Char_Table *ct, struct chartab_range *range,
204 Lisp_Object get_char_table (Emchar, Lisp_Char_Table *);
205 int map_char_table (Lisp_Char_Table *ct,
206 struct chartab_range *range,
207 int (*fn) (struct chartab_range *range,
208 Lisp_Object val, void *arg),
210 void prune_syntax_tables (void);
212 EXFUN (Fcopy_char_table, 1);
213 EXFUN (Fmake_char_table, 1);
214 EXFUN (Fput_char_table, 3);
215 EXFUN (Fget_char_table, 2);
217 extern Lisp_Object Vall_syntax_tables;
222 int check_category_char(Emchar ch, Lisp_Object ctbl,
223 unsigned int designator, unsigned int not);
225 extern Lisp_Object Vstandard_category_table;
227 #define CATEGORY_DESIGNATORP(x) \
228 (CHARP (x) && XCHAR (x) >= 32 && XCHAR (x) <= 126)
230 #define CHECK_CATEGORY_DESIGNATOR(x) do { \
231 if (!CATEGORY_DESIGNATORP (x)) \
232 dead_wrong_type_argument (Qcategory_designator_p, x); \
235 #define CONCHECK_CATEGORY_DESIGNATOR(x) do { \
236 if (!CATEGORY_DESIGNATORP (x)) \
237 x = wrong_type_argument (Qcategory_designator_p, x); \
240 #define CATEGORY_TABLE_VALUEP(x) \
241 (NILP (x) || (BIT_VECTORP (x) && (bit_vector_length (XBIT_VECTOR (x)) == 95)))
243 #define CHECK_CATEGORY_TABLE_VALUE(x) do { \
244 if (!CATEGORY_TABLE_VALUEP (x)) \
245 dead_wrong_type_argument (Qcategory_table_value_p, x); \
248 #define CONCHECK_CATEGORY_TABLE_VALUE(x) do { \
249 if (!CATEGORY_TABLE_VALUEP (x)) \
250 x = wrong_type_argument (Qcategory_table_value_p, x); \
255 #endif /* INCLUDED_chartab_h_ */