src/chartab.h

   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
   5 This file is part of XEmacs.
   6
   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
  10 later version.
  11
  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
  15 for more details.
  16
  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.  */
  21
  22 /* Synched up with: Mule 2.3.  Not synched with FSF.
  23
  24    This file was written independently of the FSF implementation,
  25    and is not compatible. */
  26
  27 #ifndef INCLUDED_chartab_h_
  28 #define INCLUDED_chartab_h_
  29
  30
  31 #ifdef UTF2000
  32
  33 #include "char-ucs.h"
  34
  35 Lisp_Object make_char_id_table (Lisp_Object initval);
  36
  37 void put_char_id_table (Emchar ch, Lisp_Object value, Lisp_Object table);
  38
  39 EXFUN (Fget_char_attribute, 3);
  40
  41 #endif
  42
  43
  44 /************************************************************************/
  45 /*                               Char Tables                            */
  46 /************************************************************************/
  47
  48 /* Under Mule, we use a complex representation (see below).
  49    When not under Mule, there are only 256 possible characters
  50    so we just represent them directly. */
  51
  52 #ifdef MULE
  53
  54 struct Lisp_Char_Table_Entry
  55 {
  56   struct lcrecord_header header;
  57
  58   /* In the interests of simplicity, we just use a fixed 96-entry
  59      table.  If we felt like being smarter, we could make this
  60      variable-size and add an offset value into this structure. */
  61   Lisp_Object level2[96];
  62 };
  63 typedef struct Lisp_Char_Table_Entry Lisp_Char_Table_Entry;
  64
  65 DECLARE_LRECORD (char_table_entry, Lisp_Char_Table_Entry);
  66 #define XCHAR_TABLE_ENTRY(x) \
  67   XRECORD (x, char_table_entry, Lisp_Char_Table_Entry)
  68 #define XSETCHAR_TABLE_ENTRY(x, p) XSETRECORD (x, p, char_table_entry)
  69 #define CHAR_TABLE_ENTRYP(x) RECORDP (x, char_table_entry)
  70 /* #define CHECK_CHAR_TABLE_ENTRY(x) CHECK_RECORD (x, char_table_entry)
  71    char table entries should never escape to Lisp */
  72
  73 #endif /* MULE */
  74
  75 enum char_table_type
  76 {
  77   CHAR_TABLE_TYPE_GENERIC,
  78 #ifdef MULE
  79   CHAR_TABLE_TYPE_CATEGORY,
  80 #endif
  81   CHAR_TABLE_TYPE_SYNTAX,
  82   CHAR_TABLE_TYPE_DISPLAY,
  83   CHAR_TABLE_TYPE_CHAR
  84 };
  85
  86 #ifdef MULE
  87 #define NUM_ASCII_CHARS 160
  88 #else
  89 #define NUM_ASCII_CHARS 256
  90 #endif
  91
  92 struct Lisp_Char_Table
  93 {
  94   struct lcrecord_header header;
  95
  96   Lisp_Object ascii[NUM_ASCII_CHARS];
  97
  98 #ifdef MULE
  99   /* We basically duplicate the Mule vectors-of-vectors implementation.
 100      We can do this because we know a great deal about the sorts of
 101      things we are going to be indexing.
 102
 103      The current implementation is as follows:
 104
 105      ascii[0-159] is used for ASCII and Control-1 characters.
 106
 107      level1[0 .. (NUM_LEADING_BYTES-1)] indexes charsets by leading
 108      byte (subtract MIN_LEADING_BYTE from the leading byte).  If the
 109      value of this is not an opaque, then it specifies a value for all
 110      characters in the charset.  Otherwise, it will be a
 111      96-Lisp-Object opaque that we created, specifying a value for
 112      each row.  If the value of this is not an opaque, then it
 113      specifies a value for all characters in the row.  Otherwise, it
 114      will be a 96-Lisp-Object opaque that we created, specifying a
 115      value for each character.
 116
 117      NOTE: 1) This will fail if some C routine passes an opaque to
 118               Fput_char_table().  Currently this is not a problem
 119               since all char tables that are created are Lisp-visible
 120               and thus no one should ever be putting an opaque in
 121               a char table.  Another possibility is to consider
 122               adding a type to */
 123
 124   Lisp_Object level1[NUM_LEADING_BYTES];
 125
 126 #endif /* MULE */
 127
 128   enum char_table_type type;
 129
 130   /* stuff used for syntax tables */
 131   Lisp_Object mirror_table;
 132   Lisp_Object next_table; /* DO NOT mark through this. */
 133 };
 134 typedef struct Lisp_Char_Table Lisp_Char_Table;
 135
 136 DECLARE_LRECORD (char_table, Lisp_Char_Table);
 137 #define XCHAR_TABLE(x) XRECORD (x, char_table, Lisp_Char_Table)
 138 #define XSETCHAR_TABLE(x, p) XSETRECORD (x, p, char_table)
 139 #define CHAR_TABLEP(x) RECORDP (x, char_table)
 140 #define CHECK_CHAR_TABLE(x) CHECK_RECORD (x, char_table)
 141 #define CONCHECK_CHAR_TABLE(x) CONCHECK_RECORD (x, char_table)
 142
 143 #define CHAR_TABLE_TYPE(ct) ((ct)->type)
 144 #define XCHAR_TABLE_TYPE(ct) CHAR_TABLE_TYPE (XCHAR_TABLE (ct))
 145
 146 #ifdef MULE
 147
 148 Lisp_Object get_non_ascii_char_table_value (Lisp_Char_Table *ct,
 149                                             Charset_ID leading_byte,
 150                                             Emchar c);
 151
 152 INLINE_HEADER Lisp_Object
 153 CHAR_TABLE_NON_ASCII_VALUE_UNSAFE (Lisp_Char_Table *ct, Emchar ch);
 154 INLINE_HEADER Lisp_Object
 155 CHAR_TABLE_NON_ASCII_VALUE_UNSAFE (Lisp_Char_Table *ct, Emchar ch)
 156 {
 157 #ifdef UTF2000
 158   Charset_ID lb = CHAR_CHARSET_ID (ch);
 159 #else
 160   Charset_ID lb = CHAR_LEADING_BYTE (ch);
 161 #endif
 162   if (!CHAR_TABLE_ENTRYP ((ct)->level1[lb - MIN_LEADING_BYTE]))
 163     return (ct)->level1[lb - MIN_LEADING_BYTE];
 164   else
 165     return get_non_ascii_char_table_value (ct, lb, ch);
 166 }
 167
 168 #define CHAR_TABLE_VALUE_UNSAFE(ct, ch)         \
 169   ((ch) < NUM_ASCII_CHARS                       \
 170    ? (ct)->ascii[ch]                            \
 171    : CHAR_TABLE_NON_ASCII_VALUE_UNSAFE (ct, ch))
 172
 173 #else /* not MULE */
 174
 175 #define CHAR_TABLE_VALUE_UNSAFE(ct, ch) ((ct)->ascii[(unsigned char) (ch)])
 176
 177 #endif /* not MULE */
 178
 179 #define XCHAR_TABLE_VALUE_UNSAFE(ct, ch) \
 180   CHAR_TABLE_VALUE_UNSAFE (XCHAR_TABLE (ct), ch)
 181
 182 enum chartab_range_type
 183 {
 184   CHARTAB_RANGE_ALL,
 185 #ifdef MULE
 186   CHARTAB_RANGE_CHARSET,
 187   CHARTAB_RANGE_ROW,
 188 #endif
 189   CHARTAB_RANGE_CHAR
 190 };
 191
 192 struct chartab_range
 193 {
 194   enum chartab_range_type type;
 195   Emchar ch;
 196   Lisp_Object charset;
 197   int row;
 198 };
 199
 200 void fill_char_table (Lisp_Char_Table *ct, Lisp_Object value);
 201 void put_char_table (Lisp_Char_Table *ct, struct chartab_range *range,
 202                      Lisp_Object val);
 203 Lisp_Object get_char_table (Emchar, Lisp_Char_Table *);
 204 int map_char_table (Lisp_Char_Table *ct,
 205                     struct chartab_range *range,
 206                     int (*fn) (struct chartab_range *range,
 207                                Lisp_Object val, void *arg),
 208                     void *arg);
 209 void prune_syntax_tables (void);
 210
 211 EXFUN (Fcopy_char_table, 1);
 212 EXFUN (Fmake_char_table, 1);
 213 EXFUN (Fput_char_table, 3);
 214 EXFUN (Fget_char_table, 2);
 215
 216 extern Lisp_Object Vall_syntax_tables;
 217
 218 \f
 219
 220 #ifdef MULE
 221 int check_category_char(Emchar ch, Lisp_Object ctbl,
 222                         unsigned int designator, unsigned int not);
 223
 224 extern Lisp_Object Vstandard_category_table;
 225
 226 #define CATEGORY_DESIGNATORP(x) \
 227  (CHARP (x) && XCHAR (x) >= 32 && XCHAR (x) <= 126)
 228
 229 #define CHECK_CATEGORY_DESIGNATOR(x) do {                       \
 230   if (!CATEGORY_DESIGNATORP (x))                                \
 231     dead_wrong_type_argument (Qcategory_designator_p, x);       \
 232 } while (0)
 233
 234 #define CONCHECK_CATEGORY_DESIGNATOR(x) do {                    \
 235   if (!CATEGORY_DESIGNATORP (x))                                \
 236     x = wrong_type_argument (Qcategory_designator_p, x);        \
 237 } while (0)
 238
 239 #define CATEGORY_TABLE_VALUEP(x) \
 240  (NILP (x) || (BIT_VECTORP (x) && (bit_vector_length (XBIT_VECTOR (x)) == 95)))
 241
 242 #define CHECK_CATEGORY_TABLE_VALUE(x) do {                      \
 243   if (!CATEGORY_TABLE_VALUEP (x))                               \
 244     dead_wrong_type_argument (Qcategory_table_value_p, x);      \
 245 } while (0)
 246
 247 #define CONCHECK_CATEGORY_TABLE_VALUE(x) do {                   \
 248   if (!CATEGORY_TABLE_VALUEP (x))                               \
 249     x = wrong_type_argument (Qcategory_table_value_p, x);       \
 250 } while (0)
 251
 252 #endif /* MULE */
 253
 254 #endif /* INCLUDED_chartab_h_ */