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_
30 /************************************************************************/
32 /************************************************************************/
34 /* Under Mule, we use a complex representation (see below).
35 When not under Mule, there are only 256 possible characters
36 so we just represent them directly. */
40 struct Lisp_Char_Table_Entry
42 struct lcrecord_header header;
44 /* In the interests of simplicity, we just use a fixed 96-entry
45 table. If we felt like being smarter, we could make this
46 variable-size and add an offset value into this structure. */
47 Lisp_Object level2[96];
49 typedef struct Lisp_Char_Table_Entry Lisp_Char_Table_Entry;
51 DECLARE_LRECORD (char_table_entry, Lisp_Char_Table_Entry);
52 #define XCHAR_TABLE_ENTRY(x) \
53 XRECORD (x, char_table_entry, Lisp_Char_Table_Entry)
54 #define XSETCHAR_TABLE_ENTRY(x, p) XSETRECORD (x, p, char_table_entry)
55 #define CHAR_TABLE_ENTRYP(x) RECORDP (x, char_table_entry)
56 /* #define CHECK_CHAR_TABLE_ENTRY(x) CHECK_RECORD (x, char_table_entry)
57 char table entries should never escape to Lisp */
63 CHAR_TABLE_TYPE_GENERIC,
65 CHAR_TABLE_TYPE_CATEGORY,
67 CHAR_TABLE_TYPE_SYNTAX,
68 CHAR_TABLE_TYPE_DISPLAY,
73 #define NUM_ASCII_CHARS 160
75 #define NUM_ASCII_CHARS 256
78 struct Lisp_Char_Table
80 struct lcrecord_header header;
82 Lisp_Object ascii[NUM_ASCII_CHARS];
85 /* We basically duplicate the Mule vectors-of-vectors implementation.
86 We can do this because we know a great deal about the sorts of
87 things we are going to be indexing.
89 The current implementation is as follows:
91 ascii[0-159] is used for ASCII and Control-1 characters.
93 level1[0 .. (NUM_LEADING_BYTES-1)] indexes charsets by leading
94 byte (subtract MIN_LEADING_BYTE from the leading byte). If the
95 value of this is not an opaque, then it specifies a value for all
96 characters in the charset. Otherwise, it will be a
97 96-Lisp-Object opaque that we created, specifying a value for
98 each row. If the value of this is not an opaque, then it
99 specifies a value for all characters in the row. Otherwise, it
100 will be a 96-Lisp-Object opaque that we created, specifying a
101 value for each character.
103 NOTE: 1) This will fail if some C routine passes an opaque to
104 Fput_char_table(). Currently this is not a problem
105 since all char tables that are created are Lisp-visible
106 and thus no one should ever be putting an opaque in
107 a char table. Another possibility is to consider
110 Lisp_Object level1[NUM_LEADING_BYTES];
114 enum char_table_type type;
116 /* stuff used for syntax tables */
117 Lisp_Object mirror_table;
118 Lisp_Object next_table; /* DO NOT mark through this. */
120 typedef struct Lisp_Char_Table Lisp_Char_Table;
122 DECLARE_LRECORD (char_table, Lisp_Char_Table);
123 #define XCHAR_TABLE(x) XRECORD (x, char_table, Lisp_Char_Table)
124 #define XSETCHAR_TABLE(x, p) XSETRECORD (x, p, char_table)
125 #define CHAR_TABLEP(x) RECORDP (x, char_table)
126 #define CHECK_CHAR_TABLE(x) CHECK_RECORD (x, char_table)
127 #define CONCHECK_CHAR_TABLE(x) CONCHECK_RECORD (x, char_table)
129 #define CHAR_TABLE_TYPE(ct) ((ct)->type)
130 #define XCHAR_TABLE_TYPE(ct) CHAR_TABLE_TYPE (XCHAR_TABLE (ct))
134 Lisp_Object get_non_ascii_char_table_value (Lisp_Char_Table *ct,
135 Charset_ID leading_byte,
138 INLINE_HEADER Lisp_Object
139 CHAR_TABLE_NON_ASCII_VALUE_UNSAFE (Lisp_Char_Table *ct, Emchar ch);
140 INLINE_HEADER Lisp_Object
141 CHAR_TABLE_NON_ASCII_VALUE_UNSAFE (Lisp_Char_Table *ct, Emchar ch)
144 Charset_ID lb = CHAR_CHARSET_ID (ch);
146 Charset_ID lb = CHAR_LEADING_BYTE (ch);
148 if (!CHAR_TABLE_ENTRYP ((ct)->level1[lb - MIN_LEADING_BYTE]))
149 return (ct)->level1[lb - MIN_LEADING_BYTE];
151 return get_non_ascii_char_table_value (ct, lb, ch);
154 #define CHAR_TABLE_VALUE_UNSAFE(ct, ch) \
155 ((ch) < NUM_ASCII_CHARS \
157 : CHAR_TABLE_NON_ASCII_VALUE_UNSAFE (ct, ch))
161 #define CHAR_TABLE_VALUE_UNSAFE(ct, ch) ((ct)->ascii[(unsigned char) (ch)])
163 #endif /* not MULE */
165 #define XCHAR_TABLE_VALUE_UNSAFE(ct, ch) \
166 CHAR_TABLE_VALUE_UNSAFE (XCHAR_TABLE (ct), ch)
168 enum chartab_range_type
172 CHARTAB_RANGE_CHARSET,
180 enum chartab_range_type type;
186 void fill_char_table (Lisp_Char_Table *ct, Lisp_Object value);
187 void put_char_table (Lisp_Char_Table *ct, struct chartab_range *range,
189 Lisp_Object get_char_table (Emchar, Lisp_Char_Table *);
190 int map_char_table (Lisp_Char_Table *ct,
191 struct chartab_range *range,
192 int (*fn) (struct chartab_range *range,
193 Lisp_Object val, void *arg),
195 void prune_syntax_tables (void);
197 EXFUN (Fcopy_char_table, 1);
198 EXFUN (Fmake_char_table, 1);
199 EXFUN (Fput_char_table, 3);
200 EXFUN (Fget_char_table, 2);
202 extern Lisp_Object Vall_syntax_tables;
207 int check_category_char(Emchar ch, Lisp_Object ctbl,
208 unsigned int designator, unsigned int not);
210 extern Lisp_Object Vstandard_category_table;
212 #define CATEGORY_DESIGNATORP(x) \
213 (CHARP (x) && XCHAR (x) >= 32 && XCHAR (x) <= 126)
215 #define CHECK_CATEGORY_DESIGNATOR(x) do { \
216 if (!CATEGORY_DESIGNATORP (x)) \
217 dead_wrong_type_argument (Qcategory_designator_p, x); \
220 #define CONCHECK_CATEGORY_DESIGNATOR(x) do { \
221 if (!CATEGORY_DESIGNATORP (x)) \
222 x = wrong_type_argument (Qcategory_designator_p, x); \
225 #define CATEGORY_TABLE_VALUEP(x) \
226 (NILP (x) || (BIT_VECTORP (x) && (bit_vector_length (XBIT_VECTOR (x)) == 95)))
228 #define CHECK_CATEGORY_TABLE_VALUE(x) do { \
229 if (!CATEGORY_TABLE_VALUEP (x)) \
230 dead_wrong_type_argument (Qcategory_table_value_p, x); \
233 #define CONCHECK_CATEGORY_TABLE_VALUE(x) do { \
234 if (!CATEGORY_TABLE_VALUEP (x)) \
235 x = wrong_type_argument (Qcategory_table_value_p, x); \
240 #endif /* INCLUDED_chartab_h_ */