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,2004,2006,2010 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, 4);
45 EXFUN (Fput_char_attribute, 3);
47 EXFUN (Fdefine_char, 1);
49 EXFUN (Ffind_char, 1);
51 extern Lisp_Object Qdowncase, Qflippedcase, Q_lowercase, Q_uppercase;
54 extern CHISE_DS *default_chise_data_source;
56 int open_chise_data_source_maybe (void);
59 #if defined(UTF2000) || defined(HAVE_CONCORD)
60 extern Lisp_Object Q_denotational;
61 extern Lisp_Object Q_denotational_from;
62 extern Lisp_Object Q_subsumptive;
63 extern Lisp_Object Q_subsumptive_from;
67 extern Lisp_Object Vchise_system_db_directory;
70 /************************************************************************/
72 /************************************************************************/
74 struct Lisp_Uint8_Byte_Table
76 struct lcrecord_header header;
78 unsigned char property[256];
80 typedef struct Lisp_Uint8_Byte_Table Lisp_Uint8_Byte_Table;
82 DECLARE_LRECORD (uint8_byte_table, Lisp_Uint8_Byte_Table);
83 #define XUINT8_BYTE_TABLE(x) \
84 XRECORD (x, uint8_byte_table, Lisp_Uint8_Byte_Table)
85 #define XSETUINT8_BYTE_TABLE(x, p) XSETRECORD (x, p, uint8_byte_table)
86 #define UINT8_BYTE_TABLE_P(x) RECORDP (x, uint8_byte_table)
87 #define GC_UINT8_BYTE_TABLE_P(x) GC_RECORDP (x, uint8_byte_table)
88 /* #define CHECK_UINT8_BYTE_TABLE(x) CHECK_RECORD (x, uint8_byte_table)
89 char table entries should never escape to Lisp */
92 struct Lisp_Uint16_Byte_Table
94 struct lcrecord_header header;
96 unsigned short property[256];
98 typedef struct Lisp_Uint16_Byte_Table Lisp_Uint16_Byte_Table;
100 DECLARE_LRECORD (uint16_byte_table, Lisp_Uint16_Byte_Table);
101 #define XUINT16_BYTE_TABLE(x) \
102 XRECORD (x, uint16_byte_table, Lisp_Uint16_Byte_Table)
103 #define XSETUINT16_BYTE_TABLE(x, p) XSETRECORD (x, p, uint16_byte_table)
104 #define UINT16_BYTE_TABLE_P(x) RECORDP (x, uint16_byte_table)
105 #define GC_UINT16_BYTE_TABLE_P(x) GC_RECORDP (x, uint16_byte_table)
106 /* #define CHECK_UINT16_BYTE_TABLE(x) CHECK_RECORD (x, uint16_byte_table)
107 char table entries should never escape to Lisp */
110 struct Lisp_Byte_Table
112 struct lcrecord_header header;
114 Lisp_Object property[256];
116 typedef struct Lisp_Byte_Table Lisp_Byte_Table;
118 DECLARE_LRECORD (byte_table, Lisp_Byte_Table);
119 #define XBYTE_TABLE(x) XRECORD (x, byte_table, Lisp_Byte_Table)
120 #define XSETBYTE_TABLE(x, p) XSETRECORD (x, p, byte_table)
121 #define BYTE_TABLE_P(x) RECORDP (x, byte_table)
122 #define GC_BYTE_TABLE_P(x) GC_RECORDP (x, byte_table)
123 /* #define CHECK_BYTE_TABLE(x) CHECK_RECORD (x, byte_table)
124 char table entries should never escape to Lisp */
126 Lisp_Object get_byte_table (Lisp_Object table, unsigned char idx);
128 Lisp_Object put_byte_table (Lisp_Object table, unsigned char idx,
132 Lisp_Object make_char_id_table (Lisp_Object initval);
137 /************************************************************************/
139 /************************************************************************/
141 /* Under Mule, we use a complex representation (see below).
142 When not under Mule, there are only 256 possible characters
143 so we just represent them directly. */
145 #if defined(MULE)&&!defined(UTF2000)
147 struct Lisp_Char_Table_Entry
149 struct lcrecord_header header;
151 /* In the interests of simplicity, we just use a fixed 96-entry
152 table. If we felt like being smarter, we could make this
153 variable-size and add an offset value into this structure. */
154 Lisp_Object level2[96];
156 typedef struct Lisp_Char_Table_Entry Lisp_Char_Table_Entry;
158 DECLARE_LRECORD (char_table_entry, Lisp_Char_Table_Entry);
159 #define XCHAR_TABLE_ENTRY(x) \
160 XRECORD (x, char_table_entry, Lisp_Char_Table_Entry)
161 #define XSETCHAR_TABLE_ENTRY(x, p) XSETRECORD (x, p, char_table_entry)
162 #define CHAR_TABLE_ENTRYP(x) RECORDP (x, char_table_entry)
163 /* #define CHECK_CHAR_TABLE_ENTRY(x) CHECK_RECORD (x, char_table_entry)
164 char table entries should never escape to Lisp */
170 CHAR_TABLE_TYPE_GENERIC,
172 CHAR_TABLE_TYPE_CATEGORY,
174 CHAR_TABLE_TYPE_SYNTAX,
175 CHAR_TABLE_TYPE_DISPLAY,
181 #define NUM_ASCII_CHARS 160
183 #define NUM_ASCII_CHARS 256
187 struct Lisp_Char_Table
189 struct lcrecord_header header;
193 Lisp_Object default_value;
195 #ifndef HAVE_LIBCHISE
198 unsigned char unloaded;
200 Lisp_Object ascii[NUM_ASCII_CHARS];
203 /* We basically duplicate the Mule vectors-of-vectors implementation.
204 We can do this because we know a great deal about the sorts of
205 things we are going to be indexing.
207 The current implementation is as follows:
209 ascii[0-159] is used for ASCII and Control-1 characters.
211 level1[0 .. (NUM_LEADING_BYTES-1)] indexes charsets by leading
212 byte (subtract MIN_LEADING_BYTE from the leading byte). If the
213 value of this is not an opaque, then it specifies a value for all
214 characters in the charset. Otherwise, it will be a
215 96-Lisp-Object opaque that we created, specifying a value for
216 each row. If the value of this is not an opaque, then it
217 specifies a value for all characters in the row. Otherwise, it
218 will be a 96-Lisp-Object opaque that we created, specifying a
219 value for each character.
221 NOTE: 1) This will fail if some C routine passes an opaque to
222 Fput_char_table(). Currently this is not a problem
223 since all char tables that are created are Lisp-visible
224 and thus no one should ever be putting an opaque in
225 a char table. Another possibility is to consider
228 Lisp_Object level1[NUM_LEADING_BYTES];
231 #endif /* non UTF2000 */
233 enum char_table_type type;
236 /* stuff used for syntax tables */
237 Lisp_Object mirror_table;
239 Lisp_Object next_table; /* DO NOT mark through this. */
241 typedef struct Lisp_Char_Table Lisp_Char_Table;
243 DECLARE_LRECORD (char_table, Lisp_Char_Table);
244 #define XCHAR_TABLE(x) XRECORD (x, char_table, Lisp_Char_Table)
245 #define XSETCHAR_TABLE(x, p) XSETRECORD (x, p, char_table)
246 #define CHAR_TABLEP(x) RECORDP (x, char_table)
247 #define CHECK_CHAR_TABLE(x) CHECK_RECORD (x, char_table)
248 #define CONCHECK_CHAR_TABLE(x) CONCHECK_RECORD (x, char_table)
250 #define CHAR_TABLE_TYPE(ct) ((ct)->type)
251 #define XCHAR_TABLE_TYPE(ct) CHAR_TABLE_TYPE (XCHAR_TABLE (ct))
255 #define CHAR_TABLE_NAME(ct) ((ct)->name)
256 #define XCHAR_TABLE_NAME(ct) CHAR_TABLE_NAME (XCHAR_TABLE (ct))
258 #define CHAR_TABLE_UNLOADED(ct) ((ct)->unloaded)
259 #define XCHAR_TABLE_UNLOADED(ct) CHAR_TABLE_UNLOADED (XCHAR_TABLE (ct))
261 INLINE_HEADER Lisp_Object
262 CHAR_TABLE_VALUE_UNSAFE (Lisp_Char_Table *ct, Emchar ch);
263 INLINE_HEADER Lisp_Object
264 CHAR_TABLE_VALUE_UNSAFE (Lisp_Char_Table *ct, Emchar ch)
266 Lisp_Object val = get_byte_table (get_byte_table
270 (unsigned char)(ch >> 24)),
271 (unsigned char) (ch >> 16)),
272 (unsigned char) (ch >> 8)),
275 return ct->default_value;
282 Lisp_Object get_non_ascii_char_table_value (Lisp_Char_Table *ct,
283 Charset_ID leading_byte,
286 INLINE_HEADER Lisp_Object
287 CHAR_TABLE_NON_ASCII_VALUE_UNSAFE (Lisp_Char_Table *ct, Emchar ch);
288 INLINE_HEADER Lisp_Object
289 CHAR_TABLE_NON_ASCII_VALUE_UNSAFE (Lisp_Char_Table *ct, Emchar ch)
292 Charset_ID lb = CHAR_CHARSET_ID (ch);
294 Charset_ID lb = CHAR_LEADING_BYTE (ch);
296 if (!CHAR_TABLE_ENTRYP ((ct)->level1[lb - MIN_LEADING_BYTE]))
297 return (ct)->level1[lb - MIN_LEADING_BYTE];
299 return get_non_ascii_char_table_value (ct, lb, ch);
302 #define CHAR_TABLE_VALUE_UNSAFE(ct, ch) \
303 ((ch) < NUM_ASCII_CHARS \
305 : CHAR_TABLE_NON_ASCII_VALUE_UNSAFE (ct, ch))
309 #define CHAR_TABLE_VALUE_UNSAFE(ct, ch) ((ct)->ascii[(unsigned char) (ch)])
311 #endif /* not MULE */
313 #define XCHAR_TABLE_VALUE_UNSAFE(ct, ch) \
314 CHAR_TABLE_VALUE_UNSAFE (XCHAR_TABLE (ct), ch)
316 enum chartab_range_type
320 CHARTAB_RANGE_DEFAULT,
323 CHARTAB_RANGE_CHARSET,
331 enum chartab_range_type type;
337 void fill_char_table (Lisp_Char_Table *ct, Lisp_Object value);
338 void put_char_table (Lisp_Char_Table *ct, struct chartab_range *range,
340 Lisp_Object get_char_table (Emchar, Lisp_Char_Table *);
341 int map_char_table (Lisp_Char_Table *ct,
342 struct chartab_range *range,
343 int (*fn) (struct chartab_range *range,
344 Lisp_Object val, void *arg),
346 void prune_syntax_tables (void);
348 EXFUN (Fcopy_char_table, 1);
349 EXFUN (Fmake_char_table, 1);
350 EXFUN (Fput_char_table, 3);
351 EXFUN (Fget_char_table, 2);
353 extern Lisp_Object Vall_syntax_tables;
359 put_char_id_table_0 (Lisp_Char_Table* cit, Emchar code, Lisp_Object value);
361 put_char_id_table_0 (Lisp_Char_Table* cit, Emchar code, Lisp_Object value)
363 Lisp_Object table1, table2, table3, table4;
366 table2 = get_byte_table (table1, (unsigned char)(code >> 24));
367 table3 = get_byte_table (table2, (unsigned char)(code >> 16));
368 table4 = get_byte_table (table3, (unsigned char)(code >> 8));
370 table4 = put_byte_table (table4, (unsigned char) code, value);
371 table3 = put_byte_table (table3, (unsigned char)(code >> 8), table4);
372 table2 = put_byte_table (table2, (unsigned char)(code >> 16), table3);
373 cit->table = put_byte_table (table1, (unsigned char)(code >> 24), table2);
377 Lisp_Object load_char_attribute_maybe (Lisp_Char_Table* cit, Emchar ch);
379 #ifndef HAVE_LIBCHISE
380 extern Lisp_Object Qsystem_char_id;
383 char_attribute_system_db_file (Lisp_Object key_type, Lisp_Object attribute,
385 #endif /* not HAVE_LIBCHISE */
386 #endif /* HAVE_CHISE */
388 INLINE_HEADER Lisp_Object
389 get_char_id_table_0 (Lisp_Char_Table* cit, Emchar ch);
390 INLINE_HEADER Lisp_Object
391 get_char_id_table_0 (Lisp_Char_Table* cit, Emchar ch)
393 return get_byte_table (get_byte_table
397 (unsigned char)(ch >> 24)),
398 (unsigned char) (ch >> 16)),
399 (unsigned char) (ch >> 8)),
403 INLINE_HEADER Lisp_Object
404 get_char_id_table (Lisp_Char_Table* cit, Emchar ch);
405 INLINE_HEADER Lisp_Object
406 get_char_id_table (Lisp_Char_Table* cit, Emchar ch)
408 Lisp_Object val = get_char_id_table_0 (cit, ch);
411 if (EQ (val, Qunloaded))
413 val = load_char_attribute_maybe (cit, ch);
414 put_char_id_table_0 (cit, ch, val);
416 #endif /* HAVE_CHISE */
418 return cit->default_value;
424 decode_char_table_range (Lisp_Object range, struct chartab_range *outrange);
427 put_char_id_table (Lisp_Char_Table* table,
428 Lisp_Object character, Lisp_Object value);
430 put_char_id_table (Lisp_Char_Table* table,
431 Lisp_Object character, Lisp_Object value)
433 struct chartab_range range;
435 decode_char_table_range (character, &range);
436 put_char_table (table, &range, value);
440 EXFUN (Fget_char_attribute, 3);
441 EXFUN (Fchar_feature, 5);
447 int check_category_char(Emchar ch, Lisp_Object ctbl,
448 unsigned int designator, unsigned int not_p);
450 extern Lisp_Object Vstandard_category_table;
452 #define CATEGORY_DESIGNATORP(x) \
453 (CHARP (x) && XCHAR (x) >= 32 && XCHAR (x) <= 126)
455 #define CHECK_CATEGORY_DESIGNATOR(x) do { \
456 if (!CATEGORY_DESIGNATORP (x)) \
457 dead_wrong_type_argument (Qcategory_designator_p, x); \
460 #define CONCHECK_CATEGORY_DESIGNATOR(x) do { \
461 if (!CATEGORY_DESIGNATORP (x)) \
462 x = wrong_type_argument (Qcategory_designator_p, x); \
465 #define CATEGORY_TABLE_VALUEP(x) \
466 (NILP (x) || (BIT_VECTORP (x) && (bit_vector_length (XBIT_VECTOR (x)) == 95)))
468 #define CHECK_CATEGORY_TABLE_VALUE(x) do { \
469 if (!CATEGORY_TABLE_VALUEP (x)) \
470 dead_wrong_type_argument (Qcategory_table_value_p, x); \
473 #define CONCHECK_CATEGORY_TABLE_VALUE(x) do { \
474 if (!CATEGORY_TABLE_VALUEP (x)) \
475 x = wrong_type_argument (Qcategory_table_value_p, x); \
480 #endif /* INCLUDED_chartab_h_ */