1 /* Declarations having to do with Mule char tables.
2 Copyright (C) 1992 Free Software Foundation, Inc.
3 Copyright (C) 1995 Sun Microsystems, Inc.
4 Copyright (C) 1999,2000,2001,2002,2003 MORIOKA Tomohiko
6 This file is part of XEmacs.
8 XEmacs is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by the
10 Free Software Foundation; either version 2, or (at your option) any
13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with XEmacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
23 /* Synched up with: Mule 2.3. Not synched with FSF.
25 This file was written independently of the FSF implementation,
26 and is not compatible. */
28 #ifndef INCLUDED_chartab_h_
29 #define INCLUDED_chartab_h_
37 # else /* HAVE_LIBCHISE */
38 # include "database.h"
39 # endif /* not HAVE_LIBCHISE */
42 EXFUN (Fmake_char, 3);
43 EXFUN (Fdecode_char, 3);
45 EXFUN (Fput_char_attribute, 3);
47 EXFUN (Ffind_char, 1);
49 extern Lisp_Object Qdowncase, Qflippedcase, Q_lowercase, Q_uppercase;
52 extern CHISE_DS *default_chise_data_source;
54 int open_chise_data_source_maybe (void);
57 /************************************************************************/
59 /************************************************************************/
61 struct Lisp_Uint8_Byte_Table
63 struct lcrecord_header header;
65 unsigned char property[256];
67 typedef struct Lisp_Uint8_Byte_Table Lisp_Uint8_Byte_Table;
69 DECLARE_LRECORD (uint8_byte_table, Lisp_Uint8_Byte_Table);
70 #define XUINT8_BYTE_TABLE(x) \
71 XRECORD (x, uint8_byte_table, Lisp_Uint8_Byte_Table)
72 #define XSETUINT8_BYTE_TABLE(x, p) XSETRECORD (x, p, uint8_byte_table)
73 #define UINT8_BYTE_TABLE_P(x) RECORDP (x, uint8_byte_table)
74 #define GC_UINT8_BYTE_TABLE_P(x) GC_RECORDP (x, uint8_byte_table)
75 /* #define CHECK_UINT8_BYTE_TABLE(x) CHECK_RECORD (x, uint8_byte_table)
76 char table entries should never escape to Lisp */
79 struct Lisp_Uint16_Byte_Table
81 struct lcrecord_header header;
83 unsigned short property[256];
85 typedef struct Lisp_Uint16_Byte_Table Lisp_Uint16_Byte_Table;
87 DECLARE_LRECORD (uint16_byte_table, Lisp_Uint16_Byte_Table);
88 #define XUINT16_BYTE_TABLE(x) \
89 XRECORD (x, uint16_byte_table, Lisp_Uint16_Byte_Table)
90 #define XSETUINT16_BYTE_TABLE(x, p) XSETRECORD (x, p, uint16_byte_table)
91 #define UINT16_BYTE_TABLE_P(x) RECORDP (x, uint16_byte_table)
92 #define GC_UINT16_BYTE_TABLE_P(x) GC_RECORDP (x, uint16_byte_table)
93 /* #define CHECK_UINT16_BYTE_TABLE(x) CHECK_RECORD (x, uint16_byte_table)
94 char table entries should never escape to Lisp */
97 struct Lisp_Byte_Table
99 struct lcrecord_header header;
101 Lisp_Object property[256];
103 typedef struct Lisp_Byte_Table Lisp_Byte_Table;
105 DECLARE_LRECORD (byte_table, Lisp_Byte_Table);
106 #define XBYTE_TABLE(x) XRECORD (x, byte_table, Lisp_Byte_Table)
107 #define XSETBYTE_TABLE(x, p) XSETRECORD (x, p, byte_table)
108 #define BYTE_TABLE_P(x) RECORDP (x, byte_table)
109 #define GC_BYTE_TABLE_P(x) GC_RECORDP (x, byte_table)
110 /* #define CHECK_BYTE_TABLE(x) CHECK_RECORD (x, byte_table)
111 char table entries should never escape to Lisp */
113 Lisp_Object get_byte_table (Lisp_Object table, unsigned char idx);
115 Lisp_Object put_byte_table (Lisp_Object table, unsigned char idx,
119 Lisp_Object make_char_id_table (Lisp_Object initval);
124 /************************************************************************/
126 /************************************************************************/
128 /* Under Mule, we use a complex representation (see below).
129 When not under Mule, there are only 256 possible characters
130 so we just represent them directly. */
132 #if defined(MULE)&&!defined(UTF2000)
134 struct Lisp_Char_Table_Entry
136 struct lcrecord_header header;
138 /* In the interests of simplicity, we just use a fixed 96-entry
139 table. If we felt like being smarter, we could make this
140 variable-size and add an offset value into this structure. */
141 Lisp_Object level2[96];
143 typedef struct Lisp_Char_Table_Entry Lisp_Char_Table_Entry;
145 DECLARE_LRECORD (char_table_entry, Lisp_Char_Table_Entry);
146 #define XCHAR_TABLE_ENTRY(x) \
147 XRECORD (x, char_table_entry, Lisp_Char_Table_Entry)
148 #define XSETCHAR_TABLE_ENTRY(x, p) XSETRECORD (x, p, char_table_entry)
149 #define CHAR_TABLE_ENTRYP(x) RECORDP (x, char_table_entry)
150 /* #define CHECK_CHAR_TABLE_ENTRY(x) CHECK_RECORD (x, char_table_entry)
151 char table entries should never escape to Lisp */
157 CHAR_TABLE_TYPE_GENERIC,
159 CHAR_TABLE_TYPE_CATEGORY,
161 CHAR_TABLE_TYPE_SYNTAX,
162 CHAR_TABLE_TYPE_DISPLAY,
168 #define NUM_ASCII_CHARS 160
170 #define NUM_ASCII_CHARS 256
174 struct Lisp_Char_Table
176 struct lcrecord_header header;
180 Lisp_Object default_value;
182 #ifndef HAVE_LIBCHISE
185 unsigned char unloaded;
187 Lisp_Object ascii[NUM_ASCII_CHARS];
190 /* We basically duplicate the Mule vectors-of-vectors implementation.
191 We can do this because we know a great deal about the sorts of
192 things we are going to be indexing.
194 The current implementation is as follows:
196 ascii[0-159] is used for ASCII and Control-1 characters.
198 level1[0 .. (NUM_LEADING_BYTES-1)] indexes charsets by leading
199 byte (subtract MIN_LEADING_BYTE from the leading byte). If the
200 value of this is not an opaque, then it specifies a value for all
201 characters in the charset. Otherwise, it will be a
202 96-Lisp-Object opaque that we created, specifying a value for
203 each row. If the value of this is not an opaque, then it
204 specifies a value for all characters in the row. Otherwise, it
205 will be a 96-Lisp-Object opaque that we created, specifying a
206 value for each character.
208 NOTE: 1) This will fail if some C routine passes an opaque to
209 Fput_char_table(). Currently this is not a problem
210 since all char tables that are created are Lisp-visible
211 and thus no one should ever be putting an opaque in
212 a char table. Another possibility is to consider
215 Lisp_Object level1[NUM_LEADING_BYTES];
218 #endif /* non UTF2000 */
220 enum char_table_type type;
223 /* stuff used for syntax tables */
224 Lisp_Object mirror_table;
226 Lisp_Object next_table; /* DO NOT mark through this. */
228 typedef struct Lisp_Char_Table Lisp_Char_Table;
230 DECLARE_LRECORD (char_table, Lisp_Char_Table);
231 #define XCHAR_TABLE(x) XRECORD (x, char_table, Lisp_Char_Table)
232 #define XSETCHAR_TABLE(x, p) XSETRECORD (x, p, char_table)
233 #define CHAR_TABLEP(x) RECORDP (x, char_table)
234 #define CHECK_CHAR_TABLE(x) CHECK_RECORD (x, char_table)
235 #define CONCHECK_CHAR_TABLE(x) CONCHECK_RECORD (x, char_table)
237 #define CHAR_TABLE_TYPE(ct) ((ct)->type)
238 #define XCHAR_TABLE_TYPE(ct) CHAR_TABLE_TYPE (XCHAR_TABLE (ct))
242 #define CHAR_TABLE_NAME(ct) ((ct)->name)
243 #define XCHAR_TABLE_NAME(ct) CHAR_TABLE_NAME (XCHAR_TABLE (ct))
245 #define CHAR_TABLE_UNLOADED(ct) ((ct)->unloaded)
246 #define XCHAR_TABLE_UNLOADED(ct) CHAR_TABLE_UNLOADED (XCHAR_TABLE (ct))
248 INLINE_HEADER Lisp_Object
249 CHAR_TABLE_VALUE_UNSAFE (Lisp_Char_Table *ct, Emchar ch);
250 INLINE_HEADER Lisp_Object
251 CHAR_TABLE_VALUE_UNSAFE (Lisp_Char_Table *ct, Emchar ch)
253 Lisp_Object val = get_byte_table (get_byte_table
257 (unsigned char)(ch >> 24)),
258 (unsigned char) (ch >> 16)),
259 (unsigned char) (ch >> 8)),
262 return ct->default_value;
269 Lisp_Object get_non_ascii_char_table_value (Lisp_Char_Table *ct,
270 Charset_ID leading_byte,
273 INLINE_HEADER Lisp_Object
274 CHAR_TABLE_NON_ASCII_VALUE_UNSAFE (Lisp_Char_Table *ct, Emchar ch);
275 INLINE_HEADER Lisp_Object
276 CHAR_TABLE_NON_ASCII_VALUE_UNSAFE (Lisp_Char_Table *ct, Emchar ch)
279 Charset_ID lb = CHAR_CHARSET_ID (ch);
281 Charset_ID lb = CHAR_LEADING_BYTE (ch);
283 if (!CHAR_TABLE_ENTRYP ((ct)->level1[lb - MIN_LEADING_BYTE]))
284 return (ct)->level1[lb - MIN_LEADING_BYTE];
286 return get_non_ascii_char_table_value (ct, lb, ch);
289 #define CHAR_TABLE_VALUE_UNSAFE(ct, ch) \
290 ((ch) < NUM_ASCII_CHARS \
292 : CHAR_TABLE_NON_ASCII_VALUE_UNSAFE (ct, ch))
296 #define CHAR_TABLE_VALUE_UNSAFE(ct, ch) ((ct)->ascii[(unsigned char) (ch)])
298 #endif /* not MULE */
300 #define XCHAR_TABLE_VALUE_UNSAFE(ct, ch) \
301 CHAR_TABLE_VALUE_UNSAFE (XCHAR_TABLE (ct), ch)
303 enum chartab_range_type
307 CHARTAB_RANGE_DEFAULT,
310 CHARTAB_RANGE_CHARSET,
318 enum chartab_range_type type;
324 void fill_char_table (Lisp_Char_Table *ct, Lisp_Object value);
325 void put_char_table (Lisp_Char_Table *ct, struct chartab_range *range,
327 Lisp_Object get_char_table (Emchar, Lisp_Char_Table *);
328 int map_char_table (Lisp_Char_Table *ct,
329 struct chartab_range *range,
330 int (*fn) (struct chartab_range *range,
331 Lisp_Object val, void *arg),
333 void prune_syntax_tables (void);
335 EXFUN (Fcopy_char_table, 1);
336 EXFUN (Fmake_char_table, 1);
337 EXFUN (Fput_char_table, 3);
338 EXFUN (Fget_char_table, 2);
340 extern Lisp_Object Vall_syntax_tables;
346 put_char_id_table_0 (Lisp_Char_Table* cit, Emchar code, Lisp_Object value);
348 put_char_id_table_0 (Lisp_Char_Table* cit, Emchar code, Lisp_Object value)
350 Lisp_Object table1, table2, table3, table4;
353 table2 = get_byte_table (table1, (unsigned char)(code >> 24));
354 table3 = get_byte_table (table2, (unsigned char)(code >> 16));
355 table4 = get_byte_table (table3, (unsigned char)(code >> 8));
357 table4 = put_byte_table (table4, (unsigned char) code, value);
358 table3 = put_byte_table (table3, (unsigned char)(code >> 8), table4);
359 table2 = put_byte_table (table2, (unsigned char)(code >> 16), table3);
360 cit->table = put_byte_table (table1, (unsigned char)(code >> 24), table2);
364 Lisp_Object load_char_attribute_maybe (Lisp_Char_Table* cit, Emchar ch);
366 #ifndef HAVE_LIBCHISE
367 extern Lisp_Object Qsystem_char_id;
370 char_attribute_system_db_file (Lisp_Object key_type, Lisp_Object attribute,
372 #endif /* not HAVE_LIBCHISE */
373 #endif /* HAVE_CHISE */
375 INLINE_HEADER Lisp_Object
376 get_char_id_table_0 (Lisp_Char_Table* cit, Emchar ch);
377 INLINE_HEADER Lisp_Object
378 get_char_id_table_0 (Lisp_Char_Table* cit, Emchar ch)
380 return get_byte_table (get_byte_table
384 (unsigned char)(ch >> 24)),
385 (unsigned char) (ch >> 16)),
386 (unsigned char) (ch >> 8)),
390 INLINE_HEADER Lisp_Object
391 get_char_id_table (Lisp_Char_Table* cit, Emchar ch);
392 INLINE_HEADER Lisp_Object
393 get_char_id_table (Lisp_Char_Table* cit, Emchar ch)
395 Lisp_Object val = get_char_id_table_0 (cit, ch);
398 if (EQ (val, Qunloaded))
400 val = load_char_attribute_maybe (cit, ch);
401 put_char_id_table_0 (cit, ch, val);
403 #endif /* HAVE_CHISE */
405 return cit->default_value;
411 decode_char_table_range (Lisp_Object range, struct chartab_range *outrange);
414 put_char_id_table (Lisp_Char_Table* table,
415 Lisp_Object character, Lisp_Object value);
417 put_char_id_table (Lisp_Char_Table* table,
418 Lisp_Object character, Lisp_Object value)
420 struct chartab_range range;
422 decode_char_table_range (character, &range);
423 put_char_table (table, &range, value);
427 EXFUN (Fget_char_attribute, 3);
433 int check_category_char(Emchar ch, Lisp_Object ctbl,
434 unsigned int designator, unsigned int not_p);
436 extern Lisp_Object Vstandard_category_table;
438 #define CATEGORY_DESIGNATORP(x) \
439 (CHARP (x) && XCHAR (x) >= 32 && XCHAR (x) <= 126)
441 #define CHECK_CATEGORY_DESIGNATOR(x) do { \
442 if (!CATEGORY_DESIGNATORP (x)) \
443 dead_wrong_type_argument (Qcategory_designator_p, x); \
446 #define CONCHECK_CATEGORY_DESIGNATOR(x) do { \
447 if (!CATEGORY_DESIGNATORP (x)) \
448 x = wrong_type_argument (Qcategory_designator_p, x); \
451 #define CATEGORY_TABLE_VALUEP(x) \
452 (NILP (x) || (BIT_VECTORP (x) && (bit_vector_length (XBIT_VECTOR (x)) == 95)))
454 #define CHECK_CATEGORY_TABLE_VALUE(x) do { \
455 if (!CATEGORY_TABLE_VALUEP (x)) \
456 dead_wrong_type_argument (Qcategory_table_value_p, x); \
459 #define CONCHECK_CATEGORY_TABLE_VALUE(x) do { \
460 if (!CATEGORY_TABLE_VALUEP (x)) \
461 x = wrong_type_argument (Qcategory_table_value_p, x); \
466 #endif /* INCLUDED_chartab_h_ */