chartab.c 40.2 KB
Newer Older
1
/* chartab.c -- char-table support
2
   Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
3 4 5 6 7
     National Institute of Advanced Industrial Science and Technology (AIST)
     Registration Number H13PRO009

This file is part of GNU Emacs.

8
GNU Emacs is free software: you can redistribute it and/or modify
9
it under the terms of the GNU General Public License as published by
10 11
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
12 13 14 15 16 17 18

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
20 21

#include <config.h>
22
#include <setjmp.h>
23 24 25 26
#include "lisp.h"
#include "character.h"
#include "charset.h"
#include "ccl.h"
27 28 29 30 31 32 33 34 35 36 37 38

/* 64/16/32/128 */

/* Number of elements in Nth level char-table.  */
const int chartab_size[4] =
  { (1 << CHARTAB_SIZE_BITS_0),
    (1 << CHARTAB_SIZE_BITS_1),
    (1 << CHARTAB_SIZE_BITS_2),
    (1 << CHARTAB_SIZE_BITS_3) };

/* Number of characters each element of Nth level char-table
   covers.  */
39
static const int chartab_chars[4] =
40 41 42 43 44 45 46
  { (1 << (CHARTAB_SIZE_BITS_1 + CHARTAB_SIZE_BITS_2 + CHARTAB_SIZE_BITS_3)),
    (1 << (CHARTAB_SIZE_BITS_2 + CHARTAB_SIZE_BITS_3)),
    (1 << CHARTAB_SIZE_BITS_3),
    1 };

/* Number of characters (in bits) each element of Nth level char-table
   covers.  */
47
static const int chartab_bits[4] =
48 49 50 51 52 53 54 55
  { (CHARTAB_SIZE_BITS_1 + CHARTAB_SIZE_BITS_2 + CHARTAB_SIZE_BITS_3),
    (CHARTAB_SIZE_BITS_2 + CHARTAB_SIZE_BITS_3),
    CHARTAB_SIZE_BITS_3,
    0 };

#define CHARTAB_IDX(c, depth, min_char)		\
  (((c) - (min_char)) >> chartab_bits[(depth)])

56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77

/* Preamble for uniprop (Unicode character property) tables.  See the
   comment of "Unicode character property tables".  */

/* Purpose of uniprop tables. */
static Lisp_Object Qchar_code_property_table;

/* Types of decoder and encoder functions for uniprop values.  */
typedef Lisp_Object (*uniprop_decoder_t) (Lisp_Object, Lisp_Object);
typedef Lisp_Object (*uniprop_encoder_t) (Lisp_Object, Lisp_Object);

static Lisp_Object uniprop_table_uncompress (Lisp_Object, int);
static uniprop_decoder_t uniprop_get_decoder (Lisp_Object);

/* 1 iff TABLE is a uniprop table.  */
#define UNIPROP_TABLE_P(TABLE)					\
  (EQ (XCHAR_TABLE (TABLE)->purpose, Qchar_code_property_table)	\
   && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (TABLE)) == 5)

/* Return a decoder for values in the uniprop table TABLE.  */
#define UNIPROP_GET_DECODER(TABLE)	\
  (UNIPROP_TABLE_P (TABLE) ? uniprop_get_decoder (TABLE) : NULL)
78

79 80 81 82 83 84 85 86 87
/* Nonzero iff OBJ is a string representing uniprop values of 128
   succeeding characters (the bottom level of a char-table) by a
   compressed format.  We are sure that no property value has a string
   starting with '\001' nor '\002'.  */
#define UNIPROP_COMPRESSED_FORM_P(OBJ)	\
  (STRINGP (OBJ) && SCHARS (OBJ) > 0	\
   && ((SREF (OBJ, 0) == 1 || (SREF (OBJ, 0) == 2))))


Paul Eggert's avatar
Paul Eggert committed
88
DEFUN ("make-char-table", Fmake_char_table, Smake_char_table, 1, 2, 0,
89
       doc: /* Return a newly created char-table, with purpose PURPOSE.
90 91
Each element is initialized to INIT, which defaults to nil.

92 93 94 95
PURPOSE should be a symbol.  If it has a `char-table-extra-slots'
property, the property's value should be an integer between 0 and 10
that specifies how many extra slots the char-table has.  Otherwise,
the char-table has no extra slot.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
96
  (register Lisp_Object purpose, Lisp_Object init)
97 98 99
{
  Lisp_Object vector;
  Lisp_Object n;
100
  int n_extras;
101 102 103
  int size;

  CHECK_SYMBOL (purpose);
104 105 106 107
  n = Fget (purpose, Qchar_table_extra_slots);
  if (NILP (n))
    n_extras = 0;
  else
108
    {
109 110 111 112
      CHECK_NATNUM (n);
      n_extras = XINT (n);
      if (n_extras > 10)
	args_out_of_range (n, Qnil);
113 114 115 116
    }

  size = VECSIZE (struct Lisp_Char_Table) - 1 + n_extras;
  vector = Fmake_vector (make_number (size), init);
Miles Bader's avatar
Miles Bader committed
117
  XSETPVECTYPE (XVECTOR (vector), PVEC_CHAR_TABLE);
118 119 120 121 122 123 124
  XCHAR_TABLE (vector)->parent = Qnil;
  XCHAR_TABLE (vector)->purpose = purpose;
  XSETCHAR_TABLE (vector, XCHAR_TABLE (vector));
  return vector;
}

static Lisp_Object
125
make_sub_char_table (int depth, int min_char, Lisp_Object defalt)
126 127 128 129 130
{
  Lisp_Object table;
  int size = VECSIZE (struct Lisp_Sub_Char_Table) - 1 + chartab_size[depth];

  table = Fmake_vector (make_number (size), defalt);
Miles Bader's avatar
Miles Bader committed
131
  XSETPVECTYPE (XVECTOR (table), PVEC_SUB_CHAR_TABLE);
132 133 134 135 136 137 138
  XSUB_CHAR_TABLE (table)->depth = make_number (depth);
  XSUB_CHAR_TABLE (table)->min_char = make_number (min_char);

  return table;
}

static Lisp_Object
139
char_table_ascii (Lisp_Object table)
140
{
141
  Lisp_Object sub, val;
142 143

  sub = XCHAR_TABLE (table)->contents[0];
144 145
  if (! SUB_CHAR_TABLE_P (sub))
    return sub;
146
  sub = XSUB_CHAR_TABLE (sub)->contents[0];
147 148
  if (! SUB_CHAR_TABLE_P (sub))
    return sub;
149 150 151 152
  val = XSUB_CHAR_TABLE (sub)->contents[0];
  if (UNIPROP_TABLE_P (table) && UNIPROP_COMPRESSED_FORM_P (val))
    val = uniprop_table_uncompress (sub, 0);
  return val;
153 154
}

155
static Lisp_Object
156
copy_sub_char_table (Lisp_Object table)
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
{
  Lisp_Object copy;
  int depth = XINT (XSUB_CHAR_TABLE (table)->depth);
  int min_char = XINT (XSUB_CHAR_TABLE (table)->min_char);
  Lisp_Object val;
  int i;

  copy = make_sub_char_table (depth, min_char, Qnil);
  /* Recursively copy any sub char-tables.  */
  for (i = 0; i < chartab_size[depth]; i++)
    {
      val = XSUB_CHAR_TABLE (table)->contents[i];
      if (SUB_CHAR_TABLE_P (val))
	XSUB_CHAR_TABLE (copy)->contents[i] = copy_sub_char_table (val);
      else
	XSUB_CHAR_TABLE (copy)->contents[i] = val;
    }

  return copy;
}


Lisp_Object
180
copy_char_table (Lisp_Object table)
181 182
{
  Lisp_Object copy;
183
  int size = XCHAR_TABLE (table)->header.size & PSEUDOVECTOR_SIZE_MASK;
184 185 186
  int i;

  copy = Fmake_vector (make_number (size), Qnil);
Miles Bader's avatar
Miles Bader committed
187
  XSETPVECTYPE (XVECTOR (copy), PVEC_CHAR_TABLE);
188 189 190 191 192 193 194 195
  XCHAR_TABLE (copy)->defalt = XCHAR_TABLE (table)->defalt;
  XCHAR_TABLE (copy)->parent = XCHAR_TABLE (table)->parent;
  XCHAR_TABLE (copy)->purpose = XCHAR_TABLE (table)->purpose;
  for (i = 0; i < chartab_size[0]; i++)
    XCHAR_TABLE (copy)->contents[i]
      = (SUB_CHAR_TABLE_P (XCHAR_TABLE (table)->contents[i])
	 ? copy_sub_char_table (XCHAR_TABLE (table)->contents[i])
	 : XCHAR_TABLE (table)->contents[i]);
196
  XCHAR_TABLE (copy)->ascii = char_table_ascii (copy);
197 198 199 200 201 202 203 204
  size -= VECSIZE (struct Lisp_Char_Table) - 1;
  for (i = 0; i < size; i++)
    XCHAR_TABLE (copy)->extras[i] = XCHAR_TABLE (table)->extras[i];

  XSETCHAR_TABLE (copy, XCHAR_TABLE (copy));
  return copy;
}

Andreas Schwab's avatar
Andreas Schwab committed
205
static Lisp_Object
206
sub_char_table_ref (Lisp_Object table, int c, int is_uniprop)
207 208 209 210 211
{
  struct Lisp_Sub_Char_Table *tbl = XSUB_CHAR_TABLE (table);
  int depth = XINT (tbl->depth);
  int min_char = XINT (tbl->min_char);
  Lisp_Object val;
212
  int idx = CHARTAB_IDX (c, depth, min_char);
213

214 215 216
  val = tbl->contents[idx];
  if (is_uniprop && UNIPROP_COMPRESSED_FORM_P (val))
    val = uniprop_table_uncompress (table, idx);
217
  if (SUB_CHAR_TABLE_P (val))
218
    val = sub_char_table_ref (val, c, is_uniprop);
219 220 221 222
  return val;
}

Lisp_Object
223
char_table_ref (Lisp_Object table, int c)
224 225 226 227 228 229 230 231 232 233 234 235 236 237
{
  struct Lisp_Char_Table *tbl = XCHAR_TABLE (table);
  Lisp_Object val;

  if (ASCII_CHAR_P (c))
    {
      val = tbl->ascii;
      if (SUB_CHAR_TABLE_P (val))
	val = XSUB_CHAR_TABLE (val)->contents[c];
    }
  else
    {
      val = tbl->contents[CHARTAB_IDX (c, 0, 0)];
      if (SUB_CHAR_TABLE_P (val))
238
	val = sub_char_table_ref (val, c, UNIPROP_TABLE_P (table));
239 240 241 242 243 244 245 246
    }
  if (NILP (val))
    {
      val = tbl->defalt;
      if (NILP (val) && CHAR_TABLE_P (tbl->parent))
	val = char_table_ref (tbl->parent, c);
    }
  return val;
Kenichi Handa's avatar
Kenichi Handa committed
247
}
248 249

static Lisp_Object
250 251
sub_char_table_ref_and_range (Lisp_Object table, int c, int *from, int *to,
			      Lisp_Object defalt, int is_uniprop)
252 253 254 255
{
  struct Lisp_Sub_Char_Table *tbl = XSUB_CHAR_TABLE (table);
  int depth = XINT (tbl->depth);
  int min_char = XINT (tbl->min_char);
256
  int chartab_idx = CHARTAB_IDX (c, depth, min_char), idx;
257
  Lisp_Object val;
Kenichi Handa's avatar
Kenichi Handa committed
258

259
  val = tbl->contents[chartab_idx];
260 261
  if (is_uniprop && UNIPROP_COMPRESSED_FORM_P (val))
    val = uniprop_table_uncompress (table, chartab_idx);
262
  if (SUB_CHAR_TABLE_P (val))
263
    val = sub_char_table_ref_and_range (val, c, from, to, defalt, is_uniprop);
264 265 266
  else if (NILP (val))
    val = defalt;

267
  idx = chartab_idx;
268
  while (idx > 0 && *from < min_char + idx * chartab_chars[depth])
269
    {
270 271
      Lisp_Object this_val;

272 273 274
      c = min_char + idx * chartab_chars[depth] - 1;
      idx--;
      this_val = tbl->contents[idx];
275 276
      if (is_uniprop && UNIPROP_COMPRESSED_FORM_P (this_val))
	this_val = uniprop_table_uncompress (table, idx);
277
      if (SUB_CHAR_TABLE_P (this_val))
278 279
	this_val = sub_char_table_ref_and_range (this_val, c, from, to, defalt,
						 is_uniprop);
280 281 282 283
      else if (NILP (this_val))
	this_val = defalt;

      if (! EQ (this_val, val))
284 285 286 287
	{
	  *from = c + 1;
	  break;
	}
288
    }
289 290 291
  while (((c = (chartab_idx + 1) * chartab_chars[depth])
	  < chartab_chars[depth - 1])
	 && (c += min_char) <= *to)
292
    {
293 294
      Lisp_Object this_val;

295 296
      chartab_idx++;
      this_val = tbl->contents[chartab_idx];
297 298
      if (is_uniprop && UNIPROP_COMPRESSED_FORM_P (this_val))
	this_val = uniprop_table_uncompress (table, chartab_idx);
299
      if (SUB_CHAR_TABLE_P (this_val))
300 301
	this_val = sub_char_table_ref_and_range (this_val, c, from, to, defalt,
						 is_uniprop);
302 303 304
      else if (NILP (this_val))
	this_val = defalt;
      if (! EQ (this_val, val))
305 306 307 308
	{
	  *to = c - 1;
	  break;
	}
309
    }
310

311 312 313 314
  return val;
}


315 316 317 318
/* Return the value for C in char-table TABLE.  Shrink the range *FROM
   and *TO to cover characters (containing C) that have the same value
   as C.  It is not assured that the values of (*FROM - 1) and (*TO +
   1) are different from that of C.  */
319

320
Lisp_Object
321
char_table_ref_and_range (Lisp_Object table, int c, int *from, int *to)
322 323
{
  struct Lisp_Char_Table *tbl = XCHAR_TABLE (table);
324
  int chartab_idx = CHARTAB_IDX (c, 0, 0), idx;
325
  Lisp_Object val;
326
  int is_uniprop = UNIPROP_TABLE_P (table);
327

328
  val = tbl->contents[chartab_idx];
329 330 331 332
  if (*from < 0)
    *from = 0;
  if (*to < 0)
    *to = MAX_CHAR;
333 334
  if (is_uniprop && UNIPROP_COMPRESSED_FORM_P (val))
    val = uniprop_table_uncompress (table, chartab_idx);
335
  if (SUB_CHAR_TABLE_P (val))
336 337
    val = sub_char_table_ref_and_range (val, c, from, to, tbl->defalt,
					is_uniprop);
338 339
  else if (NILP (val))
    val = tbl->defalt;
340
  idx = chartab_idx;
341
  while (*from < idx * chartab_chars[0])
342
    {
343 344
      Lisp_Object this_val;

345 346 347
      c = idx * chartab_chars[0] - 1;
      idx--;
      this_val = tbl->contents[idx];
348 349
      if (is_uniprop && UNIPROP_COMPRESSED_FORM_P (this_val))
	this_val = uniprop_table_uncompress (table, idx);
350
      if (SUB_CHAR_TABLE_P (this_val))
351
	this_val = sub_char_table_ref_and_range (this_val, c, from, to,
352
						 tbl->defalt, is_uniprop);
353 354 355 356
      else if (NILP (this_val))
	this_val = tbl->defalt;

      if (! EQ (this_val, val))
357 358 359 360
	{
	  *from = c + 1;
	  break;
	}
361
    }
362
  while (*to >= (chartab_idx + 1) * chartab_chars[0])
363
    {
364 365
      Lisp_Object this_val;

366 367 368
      chartab_idx++;
      c = chartab_idx * chartab_chars[0];
      this_val = tbl->contents[chartab_idx];
369 370
      if (is_uniprop && UNIPROP_COMPRESSED_FORM_P (this_val))
	this_val = uniprop_table_uncompress (table, chartab_idx);
371
      if (SUB_CHAR_TABLE_P (this_val))
372
	this_val = sub_char_table_ref_and_range (this_val, c, from, to,
373
						 tbl->defalt, is_uniprop);
374 375 376
      else if (NILP (this_val))
	this_val = tbl->defalt;
      if (! EQ (this_val, val))
377 378 379 380
	{
	  *to = c - 1;
	  break;
	}
381 382 383
    }

  return val;
384
}
385 386 387


static void
388
sub_char_table_set (Lisp_Object table, int c, Lisp_Object val, int is_uniprop)
389 390 391 392 393 394
{
  struct Lisp_Sub_Char_Table *tbl = XSUB_CHAR_TABLE (table);
  int depth = XINT ((tbl)->depth);
  int min_char = XINT ((tbl)->min_char);
  int i = CHARTAB_IDX (c, depth, min_char);
  Lisp_Object sub;
Kenichi Handa's avatar
Kenichi Handa committed
395

396 397 398 399 400 401 402
  if (depth == 3)
    tbl->contents[i] = val;
  else
    {
      sub = tbl->contents[i];
      if (! SUB_CHAR_TABLE_P (sub))
	{
403 404 405 406 407 408 409 410 411
	  if (is_uniprop && UNIPROP_COMPRESSED_FORM_P (sub))
	    sub = uniprop_table_uncompress (table, i);
	  else
	    {
	      sub = make_sub_char_table (depth + 1,
					 min_char + i * chartab_chars[depth],
					 sub);
	      tbl->contents[i] = sub;
	    }
412
	}
413
      sub_char_table_set (sub, c, val, is_uniprop);
414 415 416 417
    }
}

Lisp_Object
418
char_table_set (Lisp_Object table, int c, Lisp_Object val)
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
{
  struct Lisp_Char_Table *tbl = XCHAR_TABLE (table);

  if (ASCII_CHAR_P (c)
      && SUB_CHAR_TABLE_P (tbl->ascii))
    {
      XSUB_CHAR_TABLE (tbl->ascii)->contents[c] = val;
    }
  else
    {
      int i = CHARTAB_IDX (c, 0, 0);
      Lisp_Object sub;

      sub = tbl->contents[i];
      if (! SUB_CHAR_TABLE_P (sub))
	{
	  sub = make_sub_char_table (1, i * chartab_chars[0], sub);
	  tbl->contents[i] = sub;
	}
438
      sub_char_table_set (sub, c, val, UNIPROP_TABLE_P (table));
439
      if (ASCII_CHAR_P (c))
440
	tbl->ascii = char_table_ascii (table);
441 442 443 444 445
    }
  return val;
}

static void
446 447
sub_char_table_set_range (Lisp_Object table, int from, int to, Lisp_Object val,
			  int is_uniprop)
448
{
449 450 451 452 453 454 455 456 457 458
  struct Lisp_Sub_Char_Table *tbl = XSUB_CHAR_TABLE (table);
  int depth = XINT ((tbl)->depth);
  int min_char = XINT ((tbl)->min_char);
  int chars_in_block = chartab_chars[depth];
  int i, c, lim = chartab_size[depth];

  if (from < min_char)
    from = min_char;
  i = CHARTAB_IDX (from, depth, min_char);
  c = min_char + chars_in_block * i;
459
  for (; i < lim; i++, c += chars_in_block)
460
    {
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
      if (c > to)
	break;
      if (from <= c && c + chars_in_block - 1 <= to)
	tbl->contents[i] = val;
      else
	{
	  Lisp_Object sub = tbl->contents[i];
	  if (! SUB_CHAR_TABLE_P (sub))
	    {
	      if (is_uniprop && UNIPROP_COMPRESSED_FORM_P (sub))
		sub = uniprop_table_uncompress (table, i);
	      else
		{
		  sub = make_sub_char_table (depth + 1, c, sub);
		  tbl->contents[i] = sub;
		}
	    }
	  sub_char_table_set_range (sub, from, to, val, is_uniprop);
	}
480 481 482 483 484
    }
}


Lisp_Object
485
char_table_set_range (Lisp_Object table, int from, int to, Lisp_Object val)
486 487 488 489 490 491 492
{
  struct Lisp_Char_Table *tbl = XCHAR_TABLE (table);

  if (from == to)
    char_table_set (table, from, val);
  else
    {
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
      int is_uniprop = UNIPROP_TABLE_P (table);
      int lim = CHARTAB_IDX (to, 0, 0);
      int i, c;

      for (i = CHARTAB_IDX (from, 0, 0), c = 0; i <= lim;
	   i++, c += chartab_chars[0])
	{
	  if (c > to)
	    break;
	  if (from <= c && c + chartab_chars[0] - 1 <= to)
	    tbl->contents[i] = val;
	  else
	    {
	      Lisp_Object sub = tbl->contents[i];
	      if (! SUB_CHAR_TABLE_P (sub))
		{
		  sub = make_sub_char_table (1, i * chartab_chars[0], sub);
		  tbl->contents[i] = sub;
		}
	      sub_char_table_set_range (sub, from, to, val, is_uniprop);
	    }
	}
515
      if (ASCII_CHAR_P (from))
516
	tbl->ascii = char_table_ascii (table);
517 518 519 520 521 522 523 524 525
    }
  return val;
}


DEFUN ("char-table-subtype", Fchar_table_subtype, Schar_table_subtype,
       1, 1, 0,
       doc: /*
Return the subtype of char-table CHAR-TABLE.  The value is a symbol.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
526
  (Lisp_Object char_table)
527 528 529 530 531 532 533 534 535 536 537 538 539
{
  CHECK_CHAR_TABLE (char_table);

  return XCHAR_TABLE (char_table)->purpose;
}

DEFUN ("char-table-parent", Fchar_table_parent, Schar_table_parent,
       1, 1, 0,
       doc: /* Return the parent char-table of CHAR-TABLE.
The value is either nil or another char-table.
If CHAR-TABLE holds nil for a given character,
then the actual applicable value is inherited from the parent char-table
\(or from its parents, if necessary).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
540
  (Lisp_Object char_table)
541 542 543 544 545 546
{
  CHECK_CHAR_TABLE (char_table);

  return XCHAR_TABLE (char_table)->parent;
}

Paul Eggert's avatar
Paul Eggert committed
547
DEFUN ("set-char-table-parent", Fset_char_table_parent, Sset_char_table_parent,
548 549
       2, 2, 0,
       doc: /* Set the parent char-table of CHAR-TABLE to PARENT.
Kenichi Handa's avatar
Kenichi Handa committed
550
Return PARENT.  PARENT must be either nil or another char-table.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
551
  (Lisp_Object char_table, Lisp_Object parent)
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
{
  Lisp_Object temp;

  CHECK_CHAR_TABLE (char_table);

  if (!NILP (parent))
    {
      CHECK_CHAR_TABLE (parent);

      for (temp = parent; !NILP (temp); temp = XCHAR_TABLE (temp)->parent)
	if (EQ (temp, char_table))
	  error ("Attempt to make a chartable be its own parent");
    }

  XCHAR_TABLE (char_table)->parent = parent;

  return parent;
}

Paul Eggert's avatar
Paul Eggert committed
571
DEFUN ("char-table-extra-slot", Fchar_table_extra_slot, Schar_table_extra_slot,
572 573
       2, 2, 0,
       doc: /* Return the value of CHAR-TABLE's extra-slot number N.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
574
  (Lisp_Object char_table, Lisp_Object n)
575 576 577 578 579 580 581 582 583 584
{
  CHECK_CHAR_TABLE (char_table);
  CHECK_NUMBER (n);
  if (XINT (n) < 0
      || XINT (n) >= CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (char_table)))
    args_out_of_range (char_table, n);

  return XCHAR_TABLE (char_table)->extras[XINT (n)];
}

Paul Eggert's avatar
Paul Eggert committed
585
DEFUN ("set-char-table-extra-slot", Fset_char_table_extra_slot,
586 587 588
       Sset_char_table_extra_slot,
       3, 3, 0,
       doc: /* Set CHAR-TABLE's extra-slot number N to VALUE.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
589
  (Lisp_Object char_table, Lisp_Object n, Lisp_Object value)
590 591
{
  CHECK_CHAR_TABLE (char_table);
592 593
  if (EQ (XCHAR_TABLE (char_table)->purpose, Qchar_code_property_table))
    error ("Can't change extra-slot of char-code-property-table");
594 595 596 597 598 599 600 601 602 603 604 605 606
  CHECK_NUMBER (n);
  if (XINT (n) < 0
      || XINT (n) >= CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (char_table)))
    args_out_of_range (char_table, n);

  return XCHAR_TABLE (char_table)->extras[XINT (n)] = value;
}

DEFUN ("char-table-range", Fchar_table_range, Schar_table_range,
       2, 2, 0,
       doc: /* Return the value in CHAR-TABLE for a range of characters RANGE.
RANGE should be nil (for the default value),
a cons of character codes (for characters in the range), or a character code.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
607
  (Lisp_Object char_table, Lisp_Object range)
608 609 610 611 612 613
{
  Lisp_Object val;
  CHECK_CHAR_TABLE (char_table);

  if (EQ (range, Qnil))
    val = XCHAR_TABLE (char_table)->defalt;
614 615
  else if (CHARACTERP (range))
    val = CHAR_TABLE_REF (char_table, XFASTINT (range));
616 617 618 619
  else if (CONSP (range))
    {
      int from, to;

Kenichi Handa's avatar
Kenichi Handa committed
620 621
      CHECK_CHARACTER_CAR (range);
      CHECK_CHARACTER_CDR (range);
622 623 624
      from = XFASTINT (XCAR (range));
      to = XFASTINT (XCDR (range));
      val = char_table_ref_and_range (char_table, from, &from, &to);
625 626 627 628 629 630 631
      /* Not yet implemented. */
    }
  else
    error ("Invalid RANGE argument to `char-table-range'");
  return val;
}

Paul Eggert's avatar
Paul Eggert committed
632
DEFUN ("set-char-table-range", Fset_char_table_range, Sset_char_table_range,
633
       3, 3, 0,
Kenichi Handa's avatar
Kenichi Handa committed
634
       doc: /* Set the value in CHAR-TABLE for a range of characters RANGE to VALUE.
635
RANGE should be t (for all characters), nil (for the default value),
Kenichi Handa's avatar
Kenichi Handa committed
636 637
a cons of character codes (for characters in the range),
or a character code.  Return VALUE.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
638
  (Lisp_Object char_table, Lisp_Object range, Lisp_Object value)
639 640 641 642 643 644
{
  CHECK_CHAR_TABLE (char_table);
  if (EQ (range, Qt))
    {
      int i;

645
      XCHAR_TABLE (char_table)->ascii = value;
646
      for (i = 0; i < chartab_size[0]; i++)
647
	XCHAR_TABLE (char_table)->contents[i] = value;
648 649 650 651 652 653 654
    }
  else if (EQ (range, Qnil))
    XCHAR_TABLE (char_table)->defalt = value;
  else if (INTEGERP (range))
    char_table_set (char_table, XINT (range), value);
  else if (CONSP (range))
    {
Kenichi Handa's avatar
Kenichi Handa committed
655 656
      CHECK_CHARACTER_CAR (range);
      CHECK_CHARACTER_CDR (range);
657 658 659 660 661 662 663 664 665 666 667 668
      char_table_set_range (char_table,
			    XINT (XCAR (range)), XINT (XCDR (range)), value);
    }
  else
    error ("Invalid RANGE argument to `set-char-table-range'");

  return value;
}

DEFUN ("set-char-table-default", Fset_char_table_default,
       Sset_char_table_default, 3, 3, 0,
       doc: /*
669
This function is obsolete and has no effect.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
670
  (Lisp_Object char_table, Lisp_Object ch, Lisp_Object value)
671 672 673 674 675
{
  return Qnil;
}

/* Look up the element in TABLE at index CH, and return it as an
676
   integer.  If the element is not a character, return CH itself.  */
677 678

int
679
char_table_translate (Lisp_Object table, int ch)
680 681 682
{
  Lisp_Object value;
  value = Faref (table, make_number (ch));
683
  if (! CHARACTERP (value))
684 685 686 687 688
    return ch;
  return XINT (value);
}

static Lisp_Object
689
optimize_sub_char_table (Lisp_Object table, Lisp_Object test)
690 691 692 693
{
  struct Lisp_Sub_Char_Table *tbl = XSUB_CHAR_TABLE (table);
  int depth = XINT (tbl->depth);
  Lisp_Object elt, this;
694
  int i, optimizable;
695 696 697

  elt = XSUB_CHAR_TABLE (table)->contents[0];
  if (SUB_CHAR_TABLE_P (elt))
698 699
    elt = XSUB_CHAR_TABLE (table)->contents[0]
      = optimize_sub_char_table (elt, test);
700
  optimizable = SUB_CHAR_TABLE_P (elt) ? 0 : 1;
701 702 703 704 705
  for (i = 1; i < chartab_size[depth]; i++)
    {
      this = XSUB_CHAR_TABLE (table)->contents[i];
      if (SUB_CHAR_TABLE_P (this))
	this = XSUB_CHAR_TABLE (table)->contents[i]
706
	  = optimize_sub_char_table (this, test);
707 708
      if (optimizable
	  && (NILP (test) ? NILP (Fequal (this, elt)) /* defaults to `equal'. */
709 710
	      : EQ (test, Qeq) ? !EQ (this, elt)      /* Optimize `eq' case.  */
	      : NILP (call2 (test, this, elt))))
711
	optimizable = 0;
712 713
    }

714
  return (optimizable ? elt : table);
715 716
}

Paul Eggert's avatar
Paul Eggert committed
717
DEFUN ("optimize-char-table", Foptimize_char_table, Soptimize_char_table,
718 719 720 721
       1, 2, 0,
       doc: /* Optimize CHAR-TABLE.
TEST is the comparison function used to decide whether two entries are
equivalent and can be merged.  It defaults to `equal'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
722
  (Lisp_Object char_table, Lisp_Object test)
723 724 725 726 727 728 729 730 731 732
{
  Lisp_Object elt;
  int i;

  CHECK_CHAR_TABLE (char_table);

  for (i = 0; i < chartab_size[0]; i++)
    {
      elt = XCHAR_TABLE (char_table)->contents[i];
      if (SUB_CHAR_TABLE_P (elt))
733 734
	XCHAR_TABLE (char_table)->contents[i]
	  = optimize_sub_char_table (elt, test);
735
    }
736 737 738
  /* Reset the `ascii' cache, in case it got optimized away.  */
  XCHAR_TABLE (char_table)->ascii = char_table_ascii (char_table);

739 740 741 742
  return Qnil;
}


743 744 745
/* Map C_FUNCTION or FUNCTION over TABLE (top or sub char-table),
   calling it for each character or group of characters that share a
   value.  RANGE is a cons (FROM . TO) specifying the range of target
746
   characters, VAL is a value of FROM in TABLE, TOP is the top
747 748 749 750 751 752 753 754 755
   char-table.

   ARG is passed to C_FUNCTION when that is called.

   It returns the value of last character covered by TABLE (not the
   value inheritted from the parent), and by side-effect, the car part
   of RANGE is updated to the minimum character C where C and all the
   following characters in TABLE have the same value.  */

756
static Lisp_Object
757 758
map_sub_char_table (void (*c_function) (Lisp_Object, Lisp_Object, Lisp_Object),
		    Lisp_Object function, Lisp_Object table, Lisp_Object arg, Lisp_Object val,
759
		    Lisp_Object range, Lisp_Object top)
760
{
761 762 763 764 765 766 767
  /* Depth of TABLE.  */
  int depth;
  /* Minimum and maxinum characters covered by TABLE. */
  int min_char, max_char;
  /* Number of characters covered by one element of TABLE.  */
  int chars_in_block;
  int from = XINT (XCAR (range)), to = XINT (XCDR (range));
768
  int i, c;
769 770
  int is_uniprop = UNIPROP_TABLE_P (top);
  uniprop_decoder_t decoder = UNIPROP_GET_DECODER (top);
771

772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
  if (SUB_CHAR_TABLE_P (table))
    {
      struct Lisp_Sub_Char_Table *tbl = XSUB_CHAR_TABLE (table);

      depth = XINT (tbl->depth);
      min_char = XINT (tbl->min_char);
      max_char = min_char + chartab_chars[depth - 1] - 1;
    }
  else
    {
      depth = 0;
      min_char = 0;
      max_char = MAX_CHAR;
    }
  chars_in_block = chartab_chars[depth];

  if (to < max_char)
    max_char = to;
  /* Set I to the index of the first element to check.  */
  if (from <= min_char)
    i = 0;
  else
    i = (from - min_char) / chars_in_block;
  for (c = min_char + chars_in_block * i; c <= max_char;
       i++, c += chars_in_block)
797
    {
798 799 800
      Lisp_Object this = (SUB_CHAR_TABLE_P (table)
			  ? XSUB_CHAR_TABLE (table)->contents[i]
			  : XCHAR_TABLE (table)->contents[i]);
801
      int nextc = c + chars_in_block;
802

803 804
      if (is_uniprop && UNIPROP_COMPRESSED_FORM_P (this))
	this = uniprop_table_uncompress (table, i);
805
      if (SUB_CHAR_TABLE_P (this))
806 807 808 809
	{
	  if (to >= nextc)
	    XSETCDR (range, make_number (nextc - 1));
	  val = map_sub_char_table (c_function, function, this, arg,
810
				    val, range, top);
811
	}
812
      else
813
	{
814
	  if (NILP (this))
815
	    this = XCHAR_TABLE (top)->defalt;
816
	  if (!EQ (val, this))
817
	    {
818 819 820 821
	      int different_value = 1;

	      if (NILP (val))
		{
822
		  if (! NILP (XCHAR_TABLE (top)->parent))
823
		    {
824
		      Lisp_Object parent = XCHAR_TABLE (top)->parent;
825 826 827 828 829 830 831 832 833 834
		      Lisp_Object temp = XCHAR_TABLE (parent)->parent;

		      /* This is to get a value of FROM in PARENT
			 without checking the parent of PARENT.  */
		      XCHAR_TABLE (parent)->parent = Qnil;
		      val = CHAR_TABLE_REF (parent, from);
		      XCHAR_TABLE (parent)->parent = temp;
		      XSETCDR (range, make_number (c - 1));
		      val = map_sub_char_table (c_function, function,
						parent, arg, val, range,
835
						parent);
836
		      if (EQ (val, this))
837 838 839 840
			different_value = 0;
		    }
		}
	      if (! NILP (val) && different_value)
841
		{
Kenichi Handa's avatar
Kenichi Handa committed
842
		  XSETCDR (range, make_number (c - 1));
843
		  if (EQ (XCAR (range), XCDR (range)))
844 845 846 847
		    {
		      if (c_function)
			(*c_function) (arg, XCAR (range), val);
		      else
848 849 850 851 852
			{
			  if (decoder)
			    val = decoder (top, val);
			  call2 (function, XCAR (range), val);
			}
853
		    }
854
		  else
855 856 857 858
		    {
		      if (c_function)
			(*c_function) (arg, range, val);
		      else
859 860 861 862 863
			{
			  if (decoder)
			    val = decoder (top, val);
			  call2 (function, range, val);
			}
864
		    }
865
		}
866
	      val = this;
867
	      from = c;
Kenichi Handa's avatar
Kenichi Handa committed
868
	      XSETCAR (range, make_number (c));
869 870
	    }
	}
871
      XSETCDR (range, make_number (to));
872 873 874 875 876 877 878 879
    }
  return val;
}


/* Map C_FUNCTION or FUNCTION over TABLE, calling it for each
   character or group of characters that share a value.

Kenichi Handa's avatar
Kenichi Handa committed
880
   ARG is passed to C_FUNCTION when that is called.  */
881 882

void
883 884
map_char_table (void (*c_function) (Lisp_Object, Lisp_Object, Lisp_Object),
		Lisp_Object function, Lisp_Object table, Lisp_Object arg)
885
{
886 887 888
  Lisp_Object range, val, parent;
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
  uniprop_decoder_t decoder = UNIPROP_GET_DECODER (table);
889

890
  range = Fcons (make_number (0), make_number (MAX_CHAR));
891 892 893
  parent = XCHAR_TABLE (table)->parent;

  GCPRO4 (table, arg, range, parent);
894 895 896
  val = XCHAR_TABLE (table)->ascii;
  if (SUB_CHAR_TABLE_P (val))
    val = XSUB_CHAR_TABLE (val)->contents[0];
897
  val = map_sub_char_table (c_function, function, table, arg, val, range,
898 899
			    table);

900 901 902
  /* If VAL is nil and TABLE has a parent, we must consult the parent
     recursively.  */
  while (NILP (val) && ! NILP (XCHAR_TABLE (table)->parent))
903
    {
904
      Lisp_Object temp;
905 906
      int from = XINT (XCAR (range));

907 908
      parent = XCHAR_TABLE (table)->parent;
      temp = XCHAR_TABLE (parent)->parent;
909 910 911 912 913 914
      /* This is to get a value of FROM in PARENT without checking the
	 parent of PARENT.  */
      XCHAR_TABLE (parent)->parent = Qnil;
      val = CHAR_TABLE_REF (parent, from);
      XCHAR_TABLE (parent)->parent = temp;
      val = map_sub_char_table (c_function, function, parent, arg, val, range,
915
				parent);
916
      table = parent;
917
    }
918 919 920

  if (! NILP (val))
    {
921 922 923 924 925
      if (EQ (XCAR (range), XCDR (range)))
	{
	  if (c_function)
	    (*c_function) (arg, XCAR (range), val);
	  else
926 927 928 929 930
	    {
	      if (decoder)
		val = decoder (table, val);
	      call2 (function, XCAR (range), val);
	    }
931
	}
932
      else
933 934 935 936
	{
	  if (c_function)
	    (*c_function) (arg, range, val);
	  else
937 938 939 940 941
	    {
	      if (decoder)
		val = decoder (table, val);
	      call2 (function, range, val);
	    }
942
	}
943
    }
944 945

  UNGCPRO;
946 947 948 949 950
}

DEFUN ("map-char-table", Fmap_char_table, Smap_char_table,
  2, 2, 0,
       doc: /*
Kenichi Handa's avatar
Kenichi Handa committed
951
Call FUNCTION for each character in CHAR-TABLE that has non-nil value.
952
FUNCTION is called with two arguments--a key and a value.
953 954
The key is a character code or a cons of character codes specifying a
range of characters that have the same value.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
955
  (Lisp_Object function, Lisp_Object char_table)
956 957 958
{
  CHECK_CHAR_TABLE (char_table);

Kenichi Handa's avatar
Kenichi Handa committed
959
  map_char_table (NULL, function, char_table, char_table);
960 961 962
  return Qnil;
}

963 964

static void
965 966 967 968
map_sub_char_table_for_charset (void (*c_function) (Lisp_Object, Lisp_Object),
				Lisp_Object function, Lisp_Object table, Lisp_Object arg,
				Lisp_Object range, struct charset *charset,
				unsigned from, unsigned to)
969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
{
  struct Lisp_Sub_Char_Table *tbl = XSUB_CHAR_TABLE (table);
  int depth = XINT (tbl->depth);
  int c, i;

  if (depth < 3)
    for (i = 0, c = XINT (tbl->min_char); i < chartab_size[depth];
	 i++, c += chartab_chars[depth])
      {
	Lisp_Object this;

	this = tbl->contents[i];
	if (SUB_CHAR_TABLE_P (this))
	  map_sub_char_table_for_charset (c_function, function, this, arg,
					  range, charset, from, to);
	else
	  {
	    if (! NILP (XCAR (range)))
	      {
		XSETCDR (range, make_number (c - 1));
		if (c_function)
		  (*c_function) (arg, range);
		else
		  call2 (function, range, arg);
	      }
	    XSETCAR (range, Qnil);
	  }
      }
  else
    for (i = 0, c = XINT (tbl->min_char); i < chartab_size[depth]; i++, c ++)
      {
	Lisp_Object this;
	unsigned code;

	this = tbl->contents[i];
	if (NILP (this)
	    || (charset
		&& (code = ENCODE_CHAR (charset, c),
		    (code < from || code > to))))
	  {
	    if (! NILP (XCAR (range)))
	      {
		XSETCDR (range, make_number (c - 1));
		if (c_function)
1013
		  (*c_function) (arg, range);
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
		else
		  call2 (function, range, arg);
		XSETCAR (range, Qnil);
	      }
	  }
	else
	  {
	    if (NILP (XCAR (range)))
	      XSETCAR (range, make_number (c));
	  }
      }
}


1028
/* Support function for `map-charset-chars'.  Map C_FUNCTION or
Juanma Barranquero's avatar
Juanma Barranquero committed
1029
   FUNCTION over TABLE, calling it for each character or a group of
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
   succeeding characters that have non-nil value in TABLE.  TABLE is a
   "mapping table" or a "deunifier table" of a certain charset.

   If CHARSET is not NULL (this is the case that `map-charset-chars'
   is called with non-nil FROM-CODE and TO-CODE), it is a charset who
   owns TABLE, and the function is called only on a character in the
   range FROM and TO.  FROM and TO are not character codes, but code
   points of a character in CHARSET.

   This function is called in these two cases:

   (1) A charset has a mapping file name in :map property.

   (2) A charset has an upper code space in :offset property and a
   mapping file name in :unify-map property.  In this case, this
   function is called only for characters in the Unicode code space.
   Characters in upper code space are handled directly in
   map_charset_chars.  */

1049
void
1050
map_char_table_for_charset (void (*c_function) (Lisp_Object, Lisp_Object),
1051 1052 1053
			    Lisp_Object function, Lisp_Object table, Lisp_Object arg,
			    struct charset *charset,
			    unsigned from, unsigned to)
1054 1055 1056
{
  Lisp_Object range;
  int c, i;
1057
  struct gcpro gcpro1;
1058

Kenichi Handa's avatar
Kenichi Handa committed
1059
  range = Fcons (Qnil, Qnil);
1060
  GCPRO1 (range);
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090

  for (i = 0, c = 0; i < chartab_size[0]; i++, c += chartab_chars[0])
    {
      Lisp_Object this;

      this = XCHAR_TABLE (table)->contents[i];
      if (SUB_CHAR_TABLE_P (this))
	map_sub_char_table_for_charset (c_function, function, this, arg,
					range, charset, from, to);
      else
	{
	  if (! NILP (XCAR (range)))
	    {
	      XSETCDR (range, make_number (c - 1));
	      if (c_function)
		(*c_function) (arg, range);
	      else
		call2 (function, range, arg);
	    }
	  XSETCAR (range, Qnil);
	}
    }
  if (! NILP (XCAR (range)))
    {
      XSETCDR (range, make_number (c - 1));
      if (c_function)
	(*c_function) (arg, range);
      else
	call2 (function, range, arg);
    }
1091 1092

  UNGCPRO;
1093 1094
}

1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229