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


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

#include <config.h>
32 33 34

#define CATEGORY_INLINE EXTERN_INLINE

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

/* 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;

53
static Lisp_Object Qcategory_table, Qcategoryp, Qcategorysetp, Qcategory_table_p;
Karl Heuer's avatar
Karl Heuer committed
54

55 56 57 58 59
/* 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
60 61 62

/* Category set staff.  */

63
static Lisp_Object hash_get_category_set (Lisp_Object, Lisp_Object);
64 65

static Lisp_Object
66
hash_get_category_set (Lisp_Object table, Lisp_Object category_set)
67 68
{
  struct Lisp_Hash_Table *h;
69
  ptrdiff_t i;
70
  EMACS_UINT hash;
71 72

  if (NILP (XCHAR_TABLE (table)->extras[1]))
73 74 75 76 77 78
    char_table_set_extras
      (table, 1,
       make_hash_table (Qequal, make_number (DEFAULT_HASH_SIZE),
			make_float (DEFAULT_REHASH_SIZE),
			make_float (DEFAULT_REHASH_THRESHOLD),
			Qnil, Qnil, Qnil));
79 80 81 82 83 84 85 86 87
  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
88
DEFUN ("make-category-set", Fmake_category_set, Smake_category_set, 1, 1, 0,
89 90 91 92
       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
93
  (Lisp_Object categories)
Karl Heuer's avatar
Karl Heuer committed
94 95 96 97
{
  Lisp_Object val;
  int len;

98
  CHECK_STRING (categories);
Karl Heuer's avatar
Karl Heuer committed
99 100
  val = MAKE_CATEGORY_SET;

101
  if (STRING_MULTIBYTE (categories))
102
    error ("Multibyte string in `make-category-set'");
103

104
  len = SCHARS (categories);
Karl Heuer's avatar
Karl Heuer committed
105 106
  while (--len >= 0)
    {
107
      Lisp_Object category;
Karl Heuer's avatar
Karl Heuer committed
108

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


/* Category staff.  */

119
static Lisp_Object check_category_table (Lisp_Object table);
Karl Heuer's avatar
Karl Heuer committed
120 121

DEFUN ("define-category", Fdefine_category, Sdefine_category, 2, 3, 0,
Kenichi Handa's avatar
Kenichi Handa committed
122 123
       doc: /* Define CATEGORY as a category which is described by DOCSTRING.
CATEGORY should be an ASCII printing character in the range ` ' to `~'.
124 125 126
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.
127
The category is defined only in category table TABLE, which defaults to
Kenichi Handa's avatar
Kenichi Handa committed
128
the current buffer's category table.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
129
  (Lisp_Object category, Lisp_Object docstring, Lisp_Object table)
Karl Heuer's avatar
Karl Heuer committed
130
{
131 132
  CHECK_CATEGORY (category);
  CHECK_STRING (docstring);
Karl Heuer's avatar
Karl Heuer committed
133 134 135
  table = check_category_table (table);

  if (!NILP (CATEGORY_DOCSTRING (table, XFASTINT (category))))
136
    error ("Category `%c' is already defined", (int) XFASTINT (category));
137 138
  if (!NILP (Vpurify_flag))
    docstring = Fpurecopy (docstring);
Karl Heuer's avatar
Karl Heuer committed
139 140 141 142 143 144
  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
145 146 147
       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
148
  (Lisp_Object category, Lisp_Object table)
Karl Heuer's avatar
Karl Heuer committed
149
{
150
  CHECK_CATEGORY (category);
Karl Heuer's avatar
Karl Heuer committed
151 152 153 154 155 156 157
  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
158
       doc: /* Return a category which is not yet defined in TABLE.
159
If no category remains available, return nil.
Kenichi Handa's avatar
Kenichi Handa committed
160
The optional argument TABLE specifies which category table to modify;
161
it defaults to the current buffer's category table.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
162
  (Lisp_Object table)
Karl Heuer's avatar
Karl Heuer committed
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
{
  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,
179
       doc: /* Return t if ARG is a category table.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
180
  (Lisp_Object arg)
Karl Heuer's avatar
Karl Heuer committed
181 182
{
  if (CHAR_TABLE_P (arg)
183
      && EQ (XCHAR_TABLE (arg)->purpose, Qcategory_table))
Karl Heuer's avatar
Karl Heuer committed
184 185 186 187 188 189 190 191 192
    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.  */

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

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

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

Kenichi Handa's avatar
Kenichi Handa committed
219 220

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

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

235
static Lisp_Object
236
copy_category_table (Lisp_Object table)
Karl Heuer's avatar
Karl Heuer committed
237
{
Kenichi Handa's avatar
Kenichi Handa committed
238
  table = copy_char_table (table);
Karl Heuer's avatar
Karl Heuer committed
239

Kenichi Handa's avatar
Kenichi Handa committed
240
  if (! NILP (XCHAR_TABLE (table)->defalt))
241 242 243 244
    CSET (XCHAR_TABLE (table), defalt,
	  Fcopy_sequence (XCHAR_TABLE (table)->defalt));
  char_table_set_extras
    (table, 0, Fcopy_sequence (XCHAR_TABLE (table)->extras[0]));
Kenichi Handa's avatar
Kenichi Handa committed
245
  map_char_table (copy_category_entry, Qnil, table, table);
246

Karl Heuer's avatar
Karl Heuer committed
247 248 249 250 251
  return table;
}

DEFUN ("copy-category-table", Fcopy_category_table, Scopy_category_table,
       0, 1, 0,
252 253
       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
254
  (Lisp_Object table)
Karl Heuer's avatar
Karl Heuer committed
255 256 257 258 259 260
{
  if (!NILP (table))
    check_category_table (table);
  else
    table = Vstandard_category_table;

261
  return copy_category_table (table);
Karl Heuer's avatar
Karl Heuer committed
262 263
}

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

  val = Fmake_char_table (Qcategory_table, Qnil);
273
  CSET (XCHAR_TABLE (val), defalt, MAKE_CATEGORY_SET);
Kenichi Handa's avatar
Kenichi Handa committed
274
  for (i = 0; i < (1 << CHARTAB_SIZE_BITS_0); i++)
275
    char_table_set_contents (val, i, MAKE_CATEGORY_SET);
276 277 278 279 280
  Fset_char_table_extra_slot (val, make_number (0),
			      Fmake_vector (make_number (95), Qnil));
  return val;
}

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

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

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

DEFUN ("category-set-mnemonics", Fcategory_set_mnemonics,
       Scategory_set_mnemonics, 1, 1, 0,
313 314
       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
315
that are indexes where t occurs in the bool-vector.
316
The return value is a string containing those same categories.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
317
  (Lisp_Object category_set)
Karl Heuer's avatar
Karl Heuer committed
318 319 320 321
{
  int i, j;
  char str[96];

322
  CHECK_CATEGORY_SET (category_set);
Karl Heuer's avatar
Karl Heuer committed
323 324 325 326 327 328 329 330 331 332

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

  return build_string (str);
}

333
static void
334
set_category_set (Lisp_Object category_set, Lisp_Object category, Lisp_Object val)
Karl Heuer's avatar
Karl Heuer committed
335 336 337 338 339 340 341 342 343 344 345 346 347 348
{
  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,
349 350
       doc: /* Modify the category set of CHARACTER by adding CATEGORY to it.
The category is changed only for table TABLE, which defaults to
351 352 353
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.
354 355
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
356
  (Lisp_Object character, Lisp_Object category, Lisp_Object table, Lisp_Object reset)
Karl Heuer's avatar
Karl Heuer committed
357 358
{
  Lisp_Object set_value;	/* Actual value to be set in category sets.  */
359
  Lisp_Object category_set;
Kenichi Handa's avatar
Kenichi Handa committed
360 361
  int start, end;
  int from, to;
Karl Heuer's avatar
Karl Heuer committed
362

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

377
  CHECK_CATEGORY (category);
Karl Heuer's avatar
Karl Heuer committed
378 379 380
  table = check_category_table (table);

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

  set_value = NILP (reset) ? Qt : Qnil;

Kenichi Handa's avatar
Kenichi Handa committed
385
  while (start <= end)
Karl Heuer's avatar
Karl Heuer committed
386
    {
387
      from = start, to = end;
Kenichi Handa's avatar
Kenichi Handa committed
388
      category_set = char_table_ref_and_range (table, start, &from, &to);
389
      if (CATEGORY_MEMBER (XFASTINT (category), category_set) != NILP (reset))
Kenichi Handa's avatar
Kenichi Handa committed
390
	{
391 392
	  category_set = Fcopy_sequence (category_set);
	  SET_CATEGORY_SET (category_set, category, set_value);
393 394
	  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
395 396
	}
      start = to + 1;
Karl Heuer's avatar
Karl Heuer committed
397 398 399 400 401 402 403 404 405 406 407
    }

  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
408
word_boundary_p (int c1, int c2)
Karl Heuer's avatar
Karl Heuer committed
409 410 411 412 413
{
  Lisp_Object category_set1, category_set2;
  Lisp_Object tail;
  int default_result;

414 415
  if (EQ (CHAR_TABLE_REF (Vchar_script_table, c1),
	  CHAR_TABLE_REF (Vchar_script_table, c2)))
Karl Heuer's avatar
Karl Heuer committed
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
    {
      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;

433
  for (; CONSP (tail); tail = XCDR (tail))
Karl Heuer's avatar
Karl Heuer committed
434
    {
435
      Lisp_Object elt = XCAR (tail);
Karl Heuer's avatar
Karl Heuer committed
436 437

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

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

  /* 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
461
  Qchar_table_extra_slots = intern_c_string ("char-table-extra-slots");
Karl Heuer's avatar
Karl Heuer committed
462 463 464 465 466 467

  /* 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);
468
  /* Set a category set which contains nothing to the default.  */
469
  CSET (XCHAR_TABLE (Vstandard_category_table), defalt, MAKE_CATEGORY_SET);
470
  Fset_char_table_extra_slot (Vstandard_category_table, make_number (0),
Karl Heuer's avatar
Karl Heuer committed
471 472 473
			      Fmake_vector (make_number (95), Qnil));
}

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

481
  DEFVAR_LISP ("word-combining-categories", Vword_combining_categories,
482 483 484
	       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
485
word (i.e. finds no word boundary between them) only if they belong to
486
the same script.  But, exceptions are allowed in the following cases.
487

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

491
Emacs finds no word boundary between characters of different scripts
492 493 494 495 496 497
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.

498 499 500
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.
501

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

505
Emacs finds a word boundary between characters of the same script
506 507 508
if they have categories matching some element of this list.

More precisely, if an element of this list is a cons of category CAT1
509 510 511
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.
512

513 514 515
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
516 517 518

  Vword_combining_categories = Qnil;

519
  DEFVAR_LISP ("word-separating-categories", Vword_separating_categories,
520 521
	       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
522 523 524 525 526 527 528 529 530 531 532

  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);
533
  defsubr (&Smake_category_table);
Karl Heuer's avatar
Karl Heuer committed
534 535 536 537 538 539 540
  defsubr (&Sset_category_table);
  defsubr (&Schar_category_set);
  defsubr (&Scategory_set_mnemonics);
  defsubr (&Smodify_category_entry);

  category_table_version = 0;
}