category.c 16.7 KB
Newer Older
Karl Heuer's avatar
Karl Heuer committed
1
/* GNU Emacs routines to deal with category tables.
2 3 4 5 6 7 8 9 10

Copyright (C) 1998, 2001-2011  Free Software Foundation, Inc.
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 51 52 53 54 55 56 57 58

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

Lisp_Object Qcategory_table, Qcategoryp, Qcategorysetp, Qcategory_table_p;

/* Temporary internal variable used in macro CHAR_HAS_CATEGORY.  */
Lisp_Object _temp_category_set;


/* Category set staff.  */

59
static Lisp_Object hash_get_category_set (Lisp_Object, Lisp_Object);
60 61

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

  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
84
DEFUN ("make-category-set", Fmake_category_set, Smake_category_set, 1, 1, 0,
85 86 87 88
       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
89
  (Lisp_Object categories)
Karl Heuer's avatar
Karl Heuer committed
90 91 92 93
{
  Lisp_Object val;
  int len;

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

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

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

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


/* Category staff.  */

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

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

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

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

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

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

Kenichi Handa's avatar
Kenichi Handa committed
215 216

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

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

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

Kenichi Handa's avatar
Kenichi Handa committed
236 237 238 239 240
  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
241
  map_char_table (copy_category_entry, Qnil, table, table);
242

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

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

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

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

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

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

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

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

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

318
  CHECK_CATEGORY_SET (category_set);
Karl Heuer's avatar
Karl Heuer committed
319 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);
}

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

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

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

  if (NILP (CATEGORY_DOCSTRING (table, XFASTINT (category))))
    error ("Undefined category: %c", XFASTINT (category));

  set_value = NILP (reset) ? Qt : Qnil;

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

  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
404
word_boundary_p (int c1, int c2)
Karl Heuer's avatar
Karl Heuer committed
405 406 407 408 409
{
  Lisp_Object category_set1, category_set2;
  Lisp_Object tail;
  int default_result;

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

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

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

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

  /* 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
{
Dan Nicolaescu's avatar
Dan Nicolaescu committed
474
  Qcategoryp = intern_c_string ("categoryp");
Karl Heuer's avatar
Karl Heuer committed
475
  staticpro (&Qcategoryp);
Dan Nicolaescu's avatar
Dan Nicolaescu committed
476
  Qcategorysetp = intern_c_string ("categorysetp");
Karl Heuer's avatar
Karl Heuer committed
477
  staticpro (&Qcategorysetp);
Dan Nicolaescu's avatar
Dan Nicolaescu committed
478
  Qcategory_table_p = intern_c_string ("category-table-p");
Karl Heuer's avatar
Karl Heuer committed
479 480
  staticpro (&Qcategory_table_p);

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;
}
Kenichi Handa's avatar
Kenichi Handa committed
541