category.c 16.9 KB
Newer Older
Karl Heuer's avatar
Karl Heuer committed
1
/* GNU Emacs routines to deal with category tables.
Glenn Morris's avatar
Glenn Morris committed
2
   Copyright (C) 1998, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
3
     Free Software Foundation, Inc.
Kenichi Handa's avatar
Kenichi Handa committed
4
   Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
5
     2005, 2006, 2007, 2008, 2009
Kenichi Handa's avatar
Kenichi Handa committed
6 7
     National Institute of Advanced Industrial Science and Technology (AIST)
     Registration Number H14PRO021
Kenichi Handa's avatar
Kenichi Handa committed
8
   Copyright (C) 2003
Kenichi Handa's avatar
Kenichi Handa committed
9 10
     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 59 60 61

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

/* Variables to determine word boundary.  */
Lisp_Object Vword_combining_categories, Vword_separating_categories;

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


/* Category set staff.  */

62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
static Lisp_Object hash_get_category_set P_ ((Lisp_Object, Lisp_Object));

static Lisp_Object
hash_get_category_set (table, category_set)
     Lisp_Object table, category_set;
{
  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
88
DEFUN ("make-category-set", Fmake_category_set, Smake_category_set, 1, 1, 0,
89 90 91 92 93
       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.  */)
     (categories)
Karl Heuer's avatar
Karl Heuer committed
94 95 96 97 98
     Lisp_Object categories;
{
  Lisp_Object val;
  int len;

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

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

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

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


/* Category staff.  */

Lisp_Object check_category_table ();

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

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

DEFUN ("category-table", Fcategory_table, Scategory_table, 0, 0, 0,
209 210 211
       doc: /* Return the current category table.
This is the one specified by the current buffer.  */)
     ()
Karl Heuer's avatar
Karl Heuer committed
212 213 214 215 216 217
{
  return current_buffer->category_table;
}

DEFUN ("standard-category-table", Fstandard_category_table,
   Sstandard_category_table, 0, 0, 0,
218 219 220
       doc: /* Return the standard category table.
This is the one used for new buffers.  */)
     ()
Karl Heuer's avatar
Karl Heuer committed
221 222 223 224
{
  return Vstandard_category_table;
}

Kenichi Handa's avatar
Kenichi Handa committed
225 226

static void
Kenichi Handa's avatar
Kenichi Handa committed
227 228
copy_category_entry (table, c, val)
     Lisp_Object table, c, val;
Kenichi Handa's avatar
Kenichi Handa committed
229
{
230
  val = Fcopy_sequence (val);
Kenichi Handa's avatar
Kenichi Handa committed
231 232
  if (CONSP (c))
    char_table_set_range (table, XINT (XCAR (c)), XINT (XCDR (c)), val);
233
  else
Kenichi Handa's avatar
Kenichi Handa committed
234
    char_table_set (table, XINT (c), val);
Kenichi Handa's avatar
Kenichi Handa committed
235 236
}

Karl Heuer's avatar
Karl Heuer committed
237 238
/* Return a copy of category table TABLE.  We can't simply use the
   function copy-sequence because no contents should be shared between
239
   the original and the copy.  This function is called recursively by
240
   binding TABLE to a sub char table.  */
Karl Heuer's avatar
Karl Heuer committed
241 242

Lisp_Object
243
copy_category_table (table)
Karl Heuer's avatar
Karl Heuer committed
244 245
     Lisp_Object table;
{
Kenichi Handa's avatar
Kenichi Handa committed
246
  table = copy_char_table (table);
Karl Heuer's avatar
Karl Heuer committed
247

Kenichi Handa's avatar
Kenichi Handa committed
248 249 250 251 252
  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
253
  map_char_table (copy_category_entry, Qnil, table, table);
254

Karl Heuer's avatar
Karl Heuer committed
255 256 257 258 259
  return table;
}

DEFUN ("copy-category-table", Fcopy_category_table, Scopy_category_table,
       0, 1, 0,
260 261 262
       doc: /* Construct a new category table and return it.
It is a copy of the TABLE, which defaults to the standard category table.  */)
     (table)
Karl Heuer's avatar
Karl Heuer committed
263 264 265 266 267 268 269
     Lisp_Object table;
{
  if (!NILP (table))
    check_category_table (table);
  else
    table = Vstandard_category_table;

270
  return copy_category_table (table);
Karl Heuer's avatar
Karl Heuer committed
271 272
}

273 274
DEFUN ("make-category-table", Fmake_category_table, Smake_category_table,
       0, 0, 0,
275 276
       doc: /* Construct a new and empty category table and return it.  */)
     ()
277 278
{
  Lisp_Object val;
Kenichi Handa's avatar
Kenichi Handa committed
279
  int i;
280 281 282

  val = Fmake_char_table (Qcategory_table, Qnil);
  XCHAR_TABLE (val)->defalt = MAKE_CATEGORY_SET;
Kenichi Handa's avatar
Kenichi Handa committed
283
  for (i = 0; i < (1 << CHARTAB_SIZE_BITS_0); i++)
Kenichi Handa's avatar
Kenichi Handa committed
284
    XCHAR_TABLE (val)->contents[i] = MAKE_CATEGORY_SET;
285 286 287 288 289
  Fset_char_table_extra_slot (val, make_number (0),
			      Fmake_vector (make_number (95), Qnil));
  return val;
}

Karl Heuer's avatar
Karl Heuer committed
290
DEFUN ("set-category-table", Fset_category_table, Sset_category_table, 1, 1, 0,
Kenichi Handa's avatar
Kenichi Handa committed
291 292
       doc: /* Specify TABLE as the category table for the current buffer.
Return TABLE.  */)
293
     (table)
Karl Heuer's avatar
Karl Heuer committed
294 295
     Lisp_Object table;
{
296
  int idx;
Karl Heuer's avatar
Karl Heuer committed
297 298 299
  table = check_category_table (table);
  current_buffer->category_table = table;
  /* Indicate that this buffer now has a specified category table.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
300 301
  idx = PER_BUFFER_VAR_IDX (category_table);
  SET_PER_BUFFER_VALUE_P (current_buffer, idx, 1);
Karl Heuer's avatar
Karl Heuer committed
302 303 304 305
  return table;
}


Kenichi Handa's avatar
Kenichi Handa committed
306 307 308 309 310 311 312
Lisp_Object
char_category_set (c)
     int c;
{
  return CHAR_TABLE_REF (current_buffer->category_table, c);
}

Karl Heuer's avatar
Karl Heuer committed
313
DEFUN ("char-category-set", Fchar_category_set, Schar_category_set, 1, 1, 0,
314 315
       doc: /* Return the category set of CHAR.
usage: (char-category-set CHAR)  */)
316
     (ch)
Karl Heuer's avatar
Karl Heuer committed
317 318
     Lisp_Object ch;
{
319
  CHECK_NUMBER (ch);
Karl Heuer's avatar
Karl Heuer committed
320 321 322 323 324
  return CATEGORY_SET (XFASTINT (ch));
}

DEFUN ("category-set-mnemonics", Fcategory_set_mnemonics,
       Scategory_set_mnemonics, 1, 1, 0,
325 326
       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
327
that are indexes where t occurs in the bool-vector.
328 329
The return value is a string containing those same categories.  */)
     (category_set)
Karl Heuer's avatar
Karl Heuer committed
330 331 332 333 334
     Lisp_Object category_set;
{
  int i, j;
  char str[96];

335
  CHECK_CATEGORY_SET (category_set);
Karl Heuer's avatar
Karl Heuer committed
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362

  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
set_category_set (category_set, category, val)
     Lisp_Object category_set, category, val;
{
  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,
363 364
       doc: /* Modify the category set of CHARACTER by adding CATEGORY to it.
The category is changed only for table TABLE, which defaults to
365 366 367
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.
368 369 370
If optional fourth argument RESET is non-nil,
then delete CATEGORY from the category set instead of adding it.  */)
     (character, category, table, reset)
371
     Lisp_Object character, category, table, reset;
Karl Heuer's avatar
Karl Heuer committed
372 373
{
  Lisp_Object set_value;	/* Actual value to be set in category sets.  */
374
  Lisp_Object category_set;
Kenichi Handa's avatar
Kenichi Handa committed
375 376
  int start, end;
  int from, to;
Karl Heuer's avatar
Karl Heuer committed
377

Kenichi Handa's avatar
Kenichi Handa committed
378
  if (INTEGERP (character))
Karl Heuer's avatar
Karl Heuer committed
379
    {
Kenichi Handa's avatar
Kenichi Handa committed
380 381
      CHECK_CHARACTER (character);
      start = end = XFASTINT (character);
Karl Heuer's avatar
Karl Heuer committed
382
    }
Kenichi Handa's avatar
Kenichi Handa committed
383
  else
Karl Heuer's avatar
Karl Heuer committed
384
    {
Kenichi Handa's avatar
Kenichi Handa committed
385
      CHECK_CONS (character);
Kenichi Handa's avatar
Kenichi Handa committed
386 387
      CHECK_CHARACTER_CAR (character);
      CHECK_CHARACTER_CDR (character);
Kenichi Handa's avatar
Kenichi Handa committed
388 389
      start = XFASTINT (XCAR (character));
      end = XFASTINT (XCDR (character));
Karl Heuer's avatar
Karl Heuer committed
390 391
    }

392
  CHECK_CATEGORY (category);
Karl Heuer's avatar
Karl Heuer committed
393 394 395 396 397 398 399
  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
400
  while (start <= end)
Karl Heuer's avatar
Karl Heuer committed
401
    {
402
      from = start, to = end;
Kenichi Handa's avatar
Kenichi Handa committed
403
      category_set = char_table_ref_and_range (table, start, &from, &to);
404
      if (CATEGORY_MEMBER (XFASTINT (category), category_set) != NILP (reset))
Kenichi Handa's avatar
Kenichi Handa committed
405
	{
406 407
	  category_set = Fcopy_sequence (category_set);
	  SET_CATEGORY_SET (category_set, category, set_value);
408 409
	  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
410 411
	}
      start = to + 1;
Karl Heuer's avatar
Karl Heuer committed
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
    }

  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
word_boundary_p (c1, c2)
     int c1, c2;
{
  Lisp_Object category_set1, category_set2;
  Lisp_Object tail;
  int default_result;

430 431
  if (EQ (CHAR_TABLE_REF (Vchar_script_table, c1),
	  CHAR_TABLE_REF (Vchar_script_table, c2)))
Karl Heuer's avatar
Karl Heuer committed
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
    {
      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;

449
  for (; CONSP (tail); tail = XCDR (tail))
Karl Heuer's avatar
Karl Heuer committed
450
    {
451
      Lisp_Object elt = XCAR (tail);
Karl Heuer's avatar
Karl Heuer committed
452 453

      if (CONSP (elt)
454 455 456 457 458 459
	  && (NILP (XCAR (elt))
	      || (CATEGORYP (XCAR (elt))
		  && CATEGORY_MEMBER (XFASTINT (XCAR (elt)), category_set1)))
	  && (NILP (XCDR (elt))
	      || (CATEGORYP (XCDR (elt))
		  && CATEGORY_MEMBER (XFASTINT (XCDR (elt)), category_set2))))
Karl Heuer's avatar
Karl Heuer committed
460 461 462 463 464 465
	return !default_result;
    }
  return default_result;
}


Andreas Schwab's avatar
Andreas Schwab committed
466
void
Karl Heuer's avatar
Karl Heuer committed
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
init_category_once ()
{
  /* This has to be done here, before we call Fmake_char_table.  */
  Qcategory_table = intern ("category-table");
  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.  */
  Qchar_table_extra_slots = intern ("char-table-extra-slots");

  /* 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);
483
  /* Set a category set which contains nothing to the default.  */
Karl Heuer's avatar
Karl Heuer committed
484
  XCHAR_TABLE (Vstandard_category_table)->defalt = MAKE_CATEGORY_SET;
485
  Fset_char_table_extra_slot (Vstandard_category_table, make_number (0),
Karl Heuer's avatar
Karl Heuer committed
486 487 488
			      Fmake_vector (make_number (95), Qnil));
}

Andreas Schwab's avatar
Andreas Schwab committed
489
void
Karl Heuer's avatar
Karl Heuer committed
490 491 492 493 494 495 496 497 498 499
syms_of_category ()
{
  Qcategoryp = intern ("categoryp");
  staticpro (&Qcategoryp);
  Qcategorysetp = intern ("categorysetp");
  staticpro (&Qcategorysetp);
  Qcategory_table_p = intern ("category-table-p");
  staticpro (&Qcategory_table_p);

  DEFVAR_LISP ("word-combining-categories", &Vword_combining_categories,
500 501 502
	       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
503
word (i.e. finds no word boundary between them) only if they belong to
504
the same script.  But, exceptions are allowed in the following cases.
505

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

509
Emacs finds no word boundary between characters of different scripts
510 511 512 513 514 515
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.

516 517 518
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.
519

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

523
Emacs finds a word boundary between characters of the same script
524 525 526 527 528 529
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 a word boundary between C1 and C2.

530 531 532
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
533 534 535 536

  Vword_combining_categories = Qnil;

  DEFVAR_LISP ("word-separating-categories", &Vword_separating_categories,
537 538
	       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
539 540 541 542 543 544 545 546 547 548 549

  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);
550
  defsubr (&Smake_category_table);
Karl Heuer's avatar
Karl Heuer committed
551 552 553 554 555 556 557
  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
558 559 560

/* arch-tag: 74ebf524-121b-4d9c-bd68-07f8d708b211
   (do not change this comment) */