category.c 16.8 KB
Newer Older
Karl Heuer's avatar
Karl Heuer committed
1
/* GNU Emacs routines to deal with category tables.
2

3
Copyright (C) 1998, 2001-2012  Free Software Foundation, Inc.
4 5 6 7 8 9 10
Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
  2005, 2006, 2007, 2008, 2009, 2010, 2011
  National Institute of Advanced Industrial Science and Technology (AIST)
  Registration Number H14PRO021
Copyright (C) 2003
  National Institute of Advanced Industrial Science and Technology (AIST)
  Registration Number H13PRO009
Karl Heuer's avatar
Karl Heuer committed
11 12 13

This file is part of GNU Emacs.

14
GNU Emacs is free software: you can redistribute it and/or modify
Karl Heuer's avatar
Karl Heuer committed
15
it under the terms of the GNU General Public License as published by
16 17
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Karl Heuer's avatar
Karl Heuer committed
18 19 20 21 22 23 24

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
25
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Karl Heuer's avatar
Karl Heuer committed
26 27 28 29 30 31 32


/* Here we handle three objects: category, category set, and category
   table.  Read comments in the file category.h to understand them.  */

#include <config.h>
#include <ctype.h>
33
#include <setjmp.h>
Karl Heuer's avatar
Karl Heuer committed
34 35
#include "lisp.h"
#include "buffer.h"
Kenichi Handa's avatar
Kenichi Handa committed
36
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
37 38
#include "charset.h"
#include "category.h"
Stefan Monnier's avatar
Stefan Monnier committed
39
#include "keymap.h"
Karl Heuer's avatar
Karl Heuer committed
40 41 42 43 44 45 46 47 48 49 50

/* The version number of the latest category table.  Each category
   table has a unique version number.  It is assigned a new number
   also when it is modified.  When a regular expression is compiled
   into the struct re_pattern_buffer, the version number of the
   category table (of the current buffer) at that moment is also
   embedded in the structure.

   For the moment, we are not using this feature.  */
static int category_table_version;

51
static Lisp_Object Qcategory_table, Qcategoryp, Qcategorysetp, Qcategory_table_p;
Karl Heuer's avatar
Karl Heuer committed
52

53 54 55 56 57
/* Make CATEGORY_SET includes (if VAL is t) or excludes (if VAL is
   nil) CATEGORY.  */
#define SET_CATEGORY_SET(category_set, category, val) \
  set_category_set (category_set, category, val)
static void set_category_set (Lisp_Object, Lisp_Object, Lisp_Object);
Karl Heuer's avatar
Karl Heuer committed
58 59 60

/* Category set staff.  */

61
static Lisp_Object hash_get_category_set (Lisp_Object, Lisp_Object);
62 63

static Lisp_Object
64
hash_get_category_set (Lisp_Object table, Lisp_Object category_set)
65 66
{
  struct Lisp_Hash_Table *h;
67
  ptrdiff_t i;
68
  EMACS_UINT hash;
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84

  if (NILP (XCHAR_TABLE (table)->extras[1]))
    XCHAR_TABLE (table)->extras[1]
      = make_hash_table (Qequal, make_number (DEFAULT_HASH_SIZE),
			 make_float (DEFAULT_REHASH_SIZE),
			 make_float (DEFAULT_REHASH_THRESHOLD),
			 Qnil, Qnil, Qnil);
  h = XHASH_TABLE (XCHAR_TABLE (table)->extras[1]);
  i = hash_lookup (h, category_set, &hash);
  if (i >= 0)
    return HASH_KEY (h, i);
  hash_put (h, category_set, Qnil, hash);
  return category_set;
}


Karl Heuer's avatar
Karl Heuer committed
85
DEFUN ("make-category-set", Fmake_category_set, Smake_category_set, 1, 1, 0,
86 87 88 89
       doc: /* Return a newly created category-set which contains CATEGORIES.
CATEGORIES is a string of category mnemonics.
The value is a bool-vector which has t at the indices corresponding to
those categories.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
90
  (Lisp_Object categories)
Karl Heuer's avatar
Karl Heuer committed
91 92 93 94
{
  Lisp_Object val;
  int len;

95
  CHECK_STRING (categories);
Karl Heuer's avatar
Karl Heuer committed
96 97
  val = MAKE_CATEGORY_SET;

98
  if (STRING_MULTIBYTE (categories))
99
    error ("Multibyte string in `make-category-set'");
100

101
  len = SCHARS (categories);
Karl Heuer's avatar
Karl Heuer committed
102 103
  while (--len >= 0)
    {
104
      Lisp_Object category;
Karl Heuer's avatar
Karl Heuer committed
105

106
      XSETFASTINT (category, SREF (categories, len));
107
      CHECK_CATEGORY (category);
Karl Heuer's avatar
Karl Heuer committed
108 109 110 111 112 113 114 115
      SET_CATEGORY_SET (val, category, Qt);
    }
  return val;
}


/* Category staff.  */

116
static Lisp_Object check_category_table (Lisp_Object table);
Karl Heuer's avatar
Karl Heuer committed
117 118

DEFUN ("define-category", Fdefine_category, Sdefine_category, 2, 3, 0,
Kenichi Handa's avatar
Kenichi Handa committed
119 120
       doc: /* Define CATEGORY as a category which is described by DOCSTRING.
CATEGORY should be an ASCII printing character in the range ` ' to `~'.
121 122 123
DOCSTRING is the documentation string of the category.  The first line
should be a terse text (preferably less than 16 characters),
and the rest lines should be the full description.
124
The category is defined only in category table TABLE, which defaults to
Kenichi Handa's avatar
Kenichi Handa committed
125
the current buffer's category table.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
126
  (Lisp_Object category, Lisp_Object docstring, Lisp_Object table)
Karl Heuer's avatar
Karl Heuer committed
127
{
128 129
  CHECK_CATEGORY (category);
  CHECK_STRING (docstring);
Karl Heuer's avatar
Karl Heuer committed
130 131 132
  table = check_category_table (table);

  if (!NILP (CATEGORY_DOCSTRING (table, XFASTINT (category))))
133
    error ("Category `%c' is already defined", (int) XFASTINT (category));
134 135
  if (!NILP (Vpurify_flag))
    docstring = Fpurecopy (docstring);
Karl Heuer's avatar
Karl Heuer committed
136 137 138 139 140 141
  CATEGORY_DOCSTRING (table, XFASTINT (category)) = docstring;

  return Qnil;
}

DEFUN ("category-docstring", Fcategory_docstring, Scategory_docstring, 1, 2, 0,
Kenichi Handa's avatar
Kenichi Handa committed
142 143 144
       doc: /* Return the documentation string of CATEGORY, as defined in TABLE.
TABLE should be a category table and defaults to the current buffer's
category table.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
145
  (Lisp_Object category, Lisp_Object table)
Karl Heuer's avatar
Karl Heuer committed
146
{
147
  CHECK_CATEGORY (category);
Karl Heuer's avatar
Karl Heuer committed
148 149 150 151 152 153 154
  table = check_category_table (table);

  return CATEGORY_DOCSTRING (table, XFASTINT (category));
}

DEFUN ("get-unused-category", Fget_unused_category, Sget_unused_category,
       0, 1, 0,
Kenichi Handa's avatar
Kenichi Handa committed
155
       doc: /* Return a category which is not yet defined in TABLE.
156
If no category remains available, return nil.
Kenichi Handa's avatar
Kenichi Handa committed
157
The optional argument TABLE specifies which category table to modify;
158
it defaults to the current buffer's category table.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
159
  (Lisp_Object table)
Karl Heuer's avatar
Karl Heuer committed
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
{
  int i;

  table = check_category_table (table);

  for (i = ' '; i <= '~'; i++)
    if (NILP (CATEGORY_DOCSTRING (table, i)))
      return make_number (i);

  return Qnil;
}


/* Category-table staff.  */

DEFUN ("category-table-p", Fcategory_table_p, Scategory_table_p, 1, 1, 0,
176
       doc: /* Return t if ARG is a category table.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
177
  (Lisp_Object arg)
Karl Heuer's avatar
Karl Heuer committed
178 179
{
  if (CHAR_TABLE_P (arg)
180
      && EQ (XCHAR_TABLE (arg)->purpose, Qcategory_table))
Karl Heuer's avatar
Karl Heuer committed
181 182 183 184 185 186 187 188 189
    return Qt;
  return Qnil;
}

/* If TABLE is nil, return the current category table.  If TABLE is
   not nil, check the validity of TABLE as a category table.  If
   valid, return TABLE itself, but if not valid, signal an error of
   wrong-type-argument.  */

190
static Lisp_Object
191
check_category_table (Lisp_Object table)
Karl Heuer's avatar
Karl Heuer committed
192 193
{
  if (NILP (table))
Tom Tromey's avatar
Tom Tromey committed
194
    return BVAR (current_buffer, category_table);
195
  CHECK_TYPE (!NILP (Fcategory_table_p (table)), Qcategory_table_p, table);
Karl Heuer's avatar
Karl Heuer committed
196
  return table;
197
}
Karl Heuer's avatar
Karl Heuer committed
198 199

DEFUN ("category-table", Fcategory_table, Scategory_table, 0, 0, 0,
200 201
       doc: /* Return the current category table.
This is the one specified by the current buffer.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
202
  (void)
Karl Heuer's avatar
Karl Heuer committed
203
{
Tom Tromey's avatar
Tom Tromey committed
204
  return BVAR (current_buffer, category_table);
Karl Heuer's avatar
Karl Heuer committed
205 206 207 208
}

DEFUN ("standard-category-table", Fstandard_category_table,
   Sstandard_category_table, 0, 0, 0,
209 210
       doc: /* Return the standard category table.
This is the one used for new buffers.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
211
  (void)
Karl Heuer's avatar
Karl Heuer committed
212 213 214 215
{
  return Vstandard_category_table;
}

Kenichi Handa's avatar
Kenichi Handa committed
216 217

static void
218
copy_category_entry (Lisp_Object table, Lisp_Object c, Lisp_Object val)
Kenichi Handa's avatar
Kenichi Handa committed
219
{
220
  val = Fcopy_sequence (val);
Kenichi Handa's avatar
Kenichi Handa committed
221 222
  if (CONSP (c))
    char_table_set_range (table, XINT (XCAR (c)), XINT (XCDR (c)), val);
223
  else
Kenichi Handa's avatar
Kenichi Handa committed
224
    char_table_set (table, XINT (c), val);
Kenichi Handa's avatar
Kenichi Handa committed
225 226
}

Karl Heuer's avatar
Karl Heuer committed
227 228
/* Return a copy of category table TABLE.  We can't simply use the
   function copy-sequence because no contents should be shared between
229
   the original and the copy.  This function is called recursively by
230
   binding TABLE to a sub char table.  */
Karl Heuer's avatar
Karl Heuer committed
231

232
static Lisp_Object
233
copy_category_table (Lisp_Object table)
Karl Heuer's avatar
Karl Heuer committed
234
{
Kenichi Handa's avatar
Kenichi Handa committed
235
  table = copy_char_table (table);
Karl Heuer's avatar
Karl Heuer committed
236

Kenichi Handa's avatar
Kenichi Handa committed
237 238 239 240 241
  if (! NILP (XCHAR_TABLE (table)->defalt))
    XCHAR_TABLE (table)->defalt
      = Fcopy_sequence (XCHAR_TABLE (table)->defalt);
  XCHAR_TABLE (table)->extras[0]
    = Fcopy_sequence (XCHAR_TABLE (table)->extras[0]);
Kenichi Handa's avatar
Kenichi Handa committed
242
  map_char_table (copy_category_entry, Qnil, table, table);
243

Karl Heuer's avatar
Karl Heuer committed
244 245 246 247 248
  return table;
}

DEFUN ("copy-category-table", Fcopy_category_table, Scopy_category_table,
       0, 1, 0,
249 250
       doc: /* Construct a new category table and return it.
It is a copy of the TABLE, which defaults to the standard category table.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
251
  (Lisp_Object table)
Karl Heuer's avatar
Karl Heuer committed
252 253 254 255 256 257
{
  if (!NILP (table))
    check_category_table (table);
  else
    table = Vstandard_category_table;

258
  return copy_category_table (table);
Karl Heuer's avatar
Karl Heuer committed
259 260
}

261 262
DEFUN ("make-category-table", Fmake_category_table, Smake_category_table,
       0, 0, 0,
263
       doc: /* Construct a new and empty category table and return it.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
264
  (void)
265 266
{
  Lisp_Object val;
Kenichi Handa's avatar
Kenichi Handa committed
267
  int i;
268 269 270

  val = Fmake_char_table (Qcategory_table, Qnil);
  XCHAR_TABLE (val)->defalt = MAKE_CATEGORY_SET;
Kenichi Handa's avatar
Kenichi Handa committed
271
  for (i = 0; i < (1 << CHARTAB_SIZE_BITS_0); i++)
Kenichi Handa's avatar
Kenichi Handa committed
272
    XCHAR_TABLE (val)->contents[i] = MAKE_CATEGORY_SET;
273 274 275 276 277
  Fset_char_table_extra_slot (val, make_number (0),
			      Fmake_vector (make_number (95), Qnil));
  return val;
}

Karl Heuer's avatar
Karl Heuer committed
278
DEFUN ("set-category-table", Fset_category_table, Sset_category_table, 1, 1, 0,
Kenichi Handa's avatar
Kenichi Handa committed
279 280
       doc: /* Specify TABLE as the category table for the current buffer.
Return TABLE.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
281
  (Lisp_Object table)
Karl Heuer's avatar
Karl Heuer committed
282
{
283
  int idx;
Karl Heuer's avatar
Karl Heuer committed
284
  table = check_category_table (table);
Tom Tromey's avatar
Tom Tromey committed
285
  BVAR (current_buffer, category_table) = table;
Karl Heuer's avatar
Karl Heuer committed
286
  /* Indicate that this buffer now has a specified category table.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
287 288
  idx = PER_BUFFER_VAR_IDX (category_table);
  SET_PER_BUFFER_VALUE_P (current_buffer, idx, 1);
Karl Heuer's avatar
Karl Heuer committed
289 290 291 292
  return table;
}


Kenichi Handa's avatar
Kenichi Handa committed
293
Lisp_Object
294
char_category_set (int c)
Kenichi Handa's avatar
Kenichi Handa committed
295
{
Tom Tromey's avatar
Tom Tromey committed
296
  return CHAR_TABLE_REF (BVAR (current_buffer, category_table), c);
Kenichi Handa's avatar
Kenichi Handa committed
297 298
}

Karl Heuer's avatar
Karl Heuer committed
299
DEFUN ("char-category-set", Fchar_category_set, Schar_category_set, 1, 1, 0,
300 301
       doc: /* Return the category set of CHAR.
usage: (char-category-set CHAR)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
302
  (Lisp_Object ch)
Karl Heuer's avatar
Karl Heuer committed
303
{
304
  CHECK_CHARACTER (ch);
Karl Heuer's avatar
Karl Heuer committed
305 306 307 308 309
  return CATEGORY_SET (XFASTINT (ch));
}

DEFUN ("category-set-mnemonics", Fcategory_set_mnemonics,
       Scategory_set_mnemonics, 1, 1, 0,
310 311
       doc: /* Return a string containing mnemonics of the categories in CATEGORY-SET.
CATEGORY-SET is a bool-vector, and the categories \"in\" it are those
Kenichi Handa's avatar
Kenichi Handa committed
312
that are indexes where t occurs in the bool-vector.
313
The return value is a string containing those same categories.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
314
  (Lisp_Object category_set)
Karl Heuer's avatar
Karl Heuer committed
315 316 317 318
{
  int i, j;
  char str[96];

319
  CHECK_CATEGORY_SET (category_set);
Karl Heuer's avatar
Karl Heuer committed
320 321 322 323 324 325 326 327 328 329

  j = 0;
  for (i = 32; i < 127; i++)
    if (CATEGORY_MEMBER (i, category_set))
      str[j++] = i;
  str[j] = '\0';

  return build_string (str);
}

330
static void
331
set_category_set (Lisp_Object category_set, Lisp_Object category, Lisp_Object val)
Karl Heuer's avatar
Karl Heuer committed
332 333 334 335 336 337 338 339 340 341 342 343 344 345
{
  do {
    int idx = XINT (category) / 8;
    unsigned char bits = 1 << (XINT (category) % 8);

    if (NILP (val))
      XCATEGORY_SET (category_set)->data[idx] &= ~bits;
    else
      XCATEGORY_SET (category_set)->data[idx] |= bits;
  } while (0);
}

DEFUN ("modify-category-entry", Fmodify_category_entry,
       Smodify_category_entry, 2, 4, 0,
346 347
       doc: /* Modify the category set of CHARACTER by adding CATEGORY to it.
The category is changed only for table TABLE, which defaults to
348 349 350
the current buffer's category table.
CHARACTER can be either a single character or a cons representing the
lower and upper ends of an inclusive character range to modify.
351 352
If optional fourth argument RESET is non-nil,
then delete CATEGORY from the category set instead of adding it.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
353
  (Lisp_Object character, Lisp_Object category, Lisp_Object table, Lisp_Object reset)
Karl Heuer's avatar
Karl Heuer committed
354 355
{
  Lisp_Object set_value;	/* Actual value to be set in category sets.  */
356
  Lisp_Object category_set;
Kenichi Handa's avatar
Kenichi Handa committed
357 358
  int start, end;
  int from, to;
Karl Heuer's avatar
Karl Heuer committed
359

Kenichi Handa's avatar
Kenichi Handa committed
360
  if (INTEGERP (character))
Karl Heuer's avatar
Karl Heuer committed
361
    {
Kenichi Handa's avatar
Kenichi Handa committed
362 363
      CHECK_CHARACTER (character);
      start = end = XFASTINT (character);
Karl Heuer's avatar
Karl Heuer committed
364
    }
Kenichi Handa's avatar
Kenichi Handa committed
365
  else
Karl Heuer's avatar
Karl Heuer committed
366
    {
Kenichi Handa's avatar
Kenichi Handa committed
367
      CHECK_CONS (character);
Kenichi Handa's avatar
Kenichi Handa committed
368 369
      CHECK_CHARACTER_CAR (character);
      CHECK_CHARACTER_CDR (character);
Kenichi Handa's avatar
Kenichi Handa committed
370 371
      start = XFASTINT (XCAR (character));
      end = XFASTINT (XCDR (character));
Karl Heuer's avatar
Karl Heuer committed
372 373
    }

374
  CHECK_CATEGORY (category);
Karl Heuer's avatar
Karl Heuer committed
375 376 377
  table = check_category_table (table);

  if (NILP (CATEGORY_DOCSTRING (table, XFASTINT (category))))
378
    error ("Undefined category: %c", (int) XFASTINT (category));
Karl Heuer's avatar
Karl Heuer committed
379 380 381

  set_value = NILP (reset) ? Qt : Qnil;

Kenichi Handa's avatar
Kenichi Handa committed
382
  while (start <= end)
Karl Heuer's avatar
Karl Heuer committed
383
    {
384
      from = start, to = end;
Kenichi Handa's avatar
Kenichi Handa committed
385
      category_set = char_table_ref_and_range (table, start, &from, &to);
386
      if (CATEGORY_MEMBER (XFASTINT (category), category_set) != NILP (reset))
Kenichi Handa's avatar
Kenichi Handa committed
387
	{
388 389
	  category_set = Fcopy_sequence (category_set);
	  SET_CATEGORY_SET (category_set, category, set_value);
390 391
	  category_set = hash_get_category_set (table, category_set);
	  char_table_set_range (table, start, to, category_set);
Kenichi Handa's avatar
Kenichi Handa committed
392 393
	}
      start = to + 1;
Karl Heuer's avatar
Karl Heuer committed
394 395 396 397 398 399 400 401 402 403 404
    }

  return Qnil;
}

/* Return 1 if there is a word boundary between two word-constituent
   characters C1 and C2 if they appear in this order, else return 0.
   Use the macro WORD_BOUNDARY_P instead of calling this function
   directly.  */

int
405
word_boundary_p (int c1, int c2)
Karl Heuer's avatar
Karl Heuer committed
406 407 408 409 410
{
  Lisp_Object category_set1, category_set2;
  Lisp_Object tail;
  int default_result;

411 412
  if (EQ (CHAR_TABLE_REF (Vchar_script_table, c1),
	  CHAR_TABLE_REF (Vchar_script_table, c2)))
Karl Heuer's avatar
Karl Heuer committed
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
    {
      tail = Vword_separating_categories;
      default_result = 0;
    }
  else
    {
      tail = Vword_combining_categories;
      default_result = 1;
    }

  category_set1 = CATEGORY_SET (c1);
  if (NILP (category_set1))
    return default_result;
  category_set2 = CATEGORY_SET (c2);
  if (NILP (category_set2))
    return default_result;

430
  for (; CONSP (tail); tail = XCDR (tail))
Karl Heuer's avatar
Karl Heuer committed
431
    {
432
      Lisp_Object elt = XCAR (tail);
Karl Heuer's avatar
Karl Heuer committed
433 434

      if (CONSP (elt)
435 436
	  && (NILP (XCAR (elt))
	      || (CATEGORYP (XCAR (elt))
437 438
		  && CATEGORY_MEMBER (XFASTINT (XCAR (elt)), category_set1)
		  && ! CATEGORY_MEMBER (XFASTINT (XCAR (elt)), category_set2)))
439 440
	  && (NILP (XCDR (elt))
	      || (CATEGORYP (XCDR (elt))
441
		  && ! CATEGORY_MEMBER (XFASTINT (XCDR (elt)), category_set1)
442
		  && CATEGORY_MEMBER (XFASTINT (XCDR (elt)), category_set2))))
Karl Heuer's avatar
Karl Heuer committed
443 444 445 446 447 448
	return !default_result;
    }
  return default_result;
}


Andreas Schwab's avatar
Andreas Schwab committed
449
void
450
init_category_once (void)
Karl Heuer's avatar
Karl Heuer committed
451 452
{
  /* This has to be done here, before we call Fmake_char_table.  */
453
  DEFSYM (Qcategory_table, "category-table");
Karl Heuer's avatar
Karl Heuer committed
454 455 456 457

  /* Intern this now in case it isn't already done.
     Setting this variable twice is harmless.
     But don't staticpro it here--that is done in alloc.c.  */
Dan Nicolaescu's avatar
Dan Nicolaescu committed
458
  Qchar_table_extra_slots = intern_c_string ("char-table-extra-slots");
Karl Heuer's avatar
Karl Heuer committed
459 460 461 462 463 464

  /* Now we are ready to set up this property, so we can
     create category tables.  */
  Fput (Qcategory_table, Qchar_table_extra_slots, make_number (2));

  Vstandard_category_table = Fmake_char_table (Qcategory_table, Qnil);
465
  /* Set a category set which contains nothing to the default.  */
Karl Heuer's avatar
Karl Heuer committed
466
  XCHAR_TABLE (Vstandard_category_table)->defalt = MAKE_CATEGORY_SET;
467
  Fset_char_table_extra_slot (Vstandard_category_table, make_number (0),
Karl Heuer's avatar
Karl Heuer committed
468 469 470
			      Fmake_vector (make_number (95), Qnil));
}

Andreas Schwab's avatar
Andreas Schwab committed
471
void
472
syms_of_category (void)
Karl Heuer's avatar
Karl Heuer committed
473
{
474 475 476
  DEFSYM (Qcategoryp, "categoryp");
  DEFSYM (Qcategorysetp, "categorysetp");
  DEFSYM (Qcategory_table_p, "category-table-p");
Karl Heuer's avatar
Karl Heuer committed
477

478
  DEFVAR_LISP ("word-combining-categories", Vword_combining_categories,
479 480 481
	       doc: /* List of pair (cons) of categories to determine word boundary.

Emacs treats a sequence of word constituent characters as a single
Glenn Morris's avatar
Glenn Morris committed
482
word (i.e. finds no word boundary between them) only if they belong to
483
the same script.  But, exceptions are allowed in the following cases.
484

485
\(1) The case that characters are in different scripts is controlled
486 487
by the variable `word-combining-categories'.

488
Emacs finds no word boundary between characters of different scripts
489 490 491 492 493 494
if they have categories matching some element of this list.

More precisely, if an element of this list is a cons of category CAT1
and CAT2, and a multibyte character C1 which has CAT1 is followed by
C2 which has CAT2, there's no word boundary between C1 and C2.

495 496 497
For instance, to tell that Han characters followed by Hiragana
characters can form a single word, the element `(?C . ?H)' should be
in this list.
498

499
\(2) The case that character are in the same script is controlled by
500 501
the variable `word-separating-categories'.

502
Emacs finds a word boundary between characters of the same script
503 504 505
if they have categories matching some element of this list.

More precisely, if an element of this list is a cons of category CAT1
506 507 508
and CAT2, and a multibyte character C1 which has CAT1 but not CAT2 is
followed by C2 which has CAT2 but not CAT1, there's a word boundary
between C1 and C2.
509

510 511 512
For instance, to tell that there's a word boundary between Hiragana
and Katakana (both are in the same script `kana'),
the element `(?H . ?K) should be in this list.  */);
Karl Heuer's avatar
Karl Heuer committed
513 514 515

  Vword_combining_categories = Qnil;

516
  DEFVAR_LISP ("word-separating-categories", Vword_separating_categories,
517 518
	       doc: /* List of pair (cons) of categories to determine word boundary.
See the documentation of the variable `word-combining-categories'.  */);
Karl Heuer's avatar
Karl Heuer committed
519 520 521 522 523 524 525 526 527 528 529

  Vword_separating_categories = Qnil;

  defsubr (&Smake_category_set);
  defsubr (&Sdefine_category);
  defsubr (&Scategory_docstring);
  defsubr (&Sget_unused_category);
  defsubr (&Scategory_table_p);
  defsubr (&Scategory_table);
  defsubr (&Sstandard_category_table);
  defsubr (&Scopy_category_table);
530
  defsubr (&Smake_category_table);
Karl Heuer's avatar
Karl Heuer committed
531 532 533 534 535 536 537
  defsubr (&Sset_category_table);
  defsubr (&Schar_category_set);
  defsubr (&Scategory_set_mnemonics);
  defsubr (&Smodify_category_entry);

  category_table_version = 0;
}