category.c 16.6 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-2013 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

Karl Heuer's avatar
Karl Heuer committed
33
#include "lisp.h"
Kenichi Handa's avatar
Kenichi Handa committed
34
#include "character.h"
35
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
36 37
#include "charset.h"
#include "category.h"
Stefan Monnier's avatar
Stefan Monnier committed
38
#include "keymap.h"
Karl Heuer's avatar
Karl Heuer committed
39

Paul Eggert's avatar
Paul Eggert committed
40
/* This setter is used only in this file, so it can be private.  */
41
static void
Paul Eggert's avatar
Paul Eggert committed
42 43 44 45 46
bset_category_table (struct buffer *b, Lisp_Object val)
{
  b->INTERNAL_FIELD (category_table) = val;
}

Karl Heuer's avatar
Karl Heuer committed
47 48 49 50 51 52 53 54 55 56
/* 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;

57
static Lisp_Object Qcategory_table, Qcategoryp, Qcategorysetp, Qcategory_table_p;
Karl Heuer's avatar
Karl Heuer committed
58

59 60 61 62 63
/* 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
64 65 66

/* Category set staff.  */

67
static Lisp_Object hash_get_category_set (Lisp_Object, Lisp_Object);
68 69

static Lisp_Object
70
hash_get_category_set (Lisp_Object table, Lisp_Object category_set)
71 72
{
  struct Lisp_Hash_Table *h;
73
  ptrdiff_t i;
74
  EMACS_UINT hash;
75 76

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

102
  CHECK_STRING (categories);
Karl Heuer's avatar
Karl Heuer committed
103 104
  val = MAKE_CATEGORY_SET;

105
  if (STRING_MULTIBYTE (categories))
106
    error ("Multibyte string in `make-category-set'");
107

108
  len = SCHARS (categories);
Karl Heuer's avatar
Karl Heuer committed
109 110
  while (--len >= 0)
    {
111
      Lisp_Object category;
Karl Heuer's avatar
Karl Heuer committed
112

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


/* Category staff.  */

123
static Lisp_Object check_category_table (Lisp_Object table);
Karl Heuer's avatar
Karl Heuer committed
124 125

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

  if (!NILP (CATEGORY_DOCSTRING (table, XFASTINT (category))))
140
    error ("Category `%c' is already defined", (int) XFASTINT (category));
141 142
  if (!NILP (Vpurify_flag))
    docstring = Fpurecopy (docstring);
143
  SET_CATEGORY_DOCSTRING (table, XFASTINT (category), docstring);
Karl Heuer's avatar
Karl Heuer committed
144 145 146 147 148

  return Qnil;
}

DEFUN ("category-docstring", Fcategory_docstring, Scategory_docstring, 1, 2, 0,
Kenichi Handa's avatar
Kenichi Handa committed
149 150 151
       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
152
  (Lisp_Object category, Lisp_Object table)
Karl Heuer's avatar
Karl Heuer committed
153
{
154
  CHECK_CATEGORY (category);
Karl Heuer's avatar
Karl Heuer committed
155 156 157 158 159 160 161
  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
162
       doc: /* Return a category which is not yet defined in TABLE.
163
If no category remains available, return nil.
Kenichi Handa's avatar
Kenichi Handa committed
164
The optional argument TABLE specifies which category table to modify;
165
it defaults to the current buffer's category table.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
166
  (Lisp_Object table)
Karl Heuer's avatar
Karl Heuer committed
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
{
  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
       doc: /* Return t if ARG is a category table.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
184
  (Lisp_Object arg)
Karl Heuer's avatar
Karl Heuer committed
185 186
{
  if (CHAR_TABLE_P (arg)
187
      && EQ (XCHAR_TABLE (arg)->purpose, Qcategory_table))
Karl Heuer's avatar
Karl Heuer committed
188 189 190 191 192 193 194 195 196
    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.  */

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

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

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

Kenichi Handa's avatar
Kenichi Handa committed
223 224

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

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

239
static Lisp_Object
240
copy_category_table (Lisp_Object table)
Karl Heuer's avatar
Karl Heuer committed
241
{
Kenichi Handa's avatar
Kenichi Handa committed
242
  table = copy_char_table (table);
Karl Heuer's avatar
Karl Heuer committed
243

Kenichi Handa's avatar
Kenichi Handa committed
244
  if (! NILP (XCHAR_TABLE (table)->defalt))
Paul Eggert's avatar
Paul Eggert committed
245 246
    set_char_table_defalt (table,
			   Fcopy_sequence (XCHAR_TABLE (table)->defalt));
247
  set_char_table_extras
248
    (table, 0, Fcopy_sequence (XCHAR_TABLE (table)->extras[0]));
Kenichi Handa's avatar
Kenichi Handa committed
249
  map_char_table (copy_category_entry, Qnil, table, table);
250

Karl Heuer's avatar
Karl Heuer committed
251 252 253 254 255
  return table;
}

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

265
  return copy_category_table (table);
Karl Heuer's avatar
Karl Heuer committed
266 267
}

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

  val = Fmake_char_table (Qcategory_table, Qnil);
Paul Eggert's avatar
Paul Eggert committed
277
  set_char_table_defalt (val, MAKE_CATEGORY_SET);
Kenichi Handa's avatar
Kenichi Handa committed
278
  for (i = 0; i < (1 << CHARTAB_SIZE_BITS_0); i++)
279
    set_char_table_contents (val, i, MAKE_CATEGORY_SET);
280 281 282 283 284
  Fset_char_table_extra_slot (val, make_number (0),
			      Fmake_vector (make_number (95), Qnil));
  return val;
}

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


Kenichi Handa's avatar
Kenichi Handa committed
300
Lisp_Object
301
char_category_set (int c)
Kenichi Handa's avatar
Kenichi Handa committed
302
{
Tom Tromey's avatar
Tom Tromey committed
303
  return CHAR_TABLE_REF (BVAR (current_buffer, category_table), c);
Kenichi Handa's avatar
Kenichi Handa committed
304 305
}

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

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

326
  CHECK_CATEGORY_SET (category_set);
Karl Heuer's avatar
Karl Heuer committed
327 328 329 330 331 332 333 334 335 336

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

  return build_string (str);
}

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

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

381
  CHECK_CATEGORY (category);
Karl Heuer's avatar
Karl Heuer committed
382 383 384
  table = check_category_table (table);

  if (NILP (CATEGORY_DOCSTRING (table, XFASTINT (category))))
385
    error ("Undefined category: %c", (int) XFASTINT (category));
Karl Heuer's avatar
Karl Heuer committed
386 387 388

  set_value = NILP (reset) ? Qt : Qnil;

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

  return Qnil;
}

406 407
/* Return true if there is a word boundary between two word-constituent
   characters C1 and C2 if they appear in this order.
Karl Heuer's avatar
Karl Heuer committed
408 409 410
   Use the macro WORD_BOUNDARY_P instead of calling this function
   directly.  */

411
bool
412
word_boundary_p (int c1, int c2)
Karl Heuer's avatar
Karl Heuer committed
413 414 415
{
  Lisp_Object category_set1, category_set2;
  Lisp_Object tail;
416
  bool default_result;
Karl Heuer's avatar
Karl Heuer committed
417

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

437
  for (; CONSP (tail); tail = XCDR (tail))
Karl Heuer's avatar
Karl Heuer committed
438
    {
439
      Lisp_Object elt = XCAR (tail);
Karl Heuer's avatar
Karl Heuer committed
440 441

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


Andreas Schwab's avatar
Andreas Schwab committed
456
void
457
init_category_once (void)
Karl Heuer's avatar
Karl Heuer committed
458 459
{
  /* This has to be done here, before we call Fmake_char_table.  */
460
  DEFSYM (Qcategory_table, "category-table");
Karl Heuer's avatar
Karl Heuer committed
461 462 463
  Fput (Qcategory_table, Qchar_table_extra_slots, make_number (2));

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

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

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

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

487
Emacs finds no word boundary between characters of different scripts
488 489 490 491 492 493
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.

494 495 496
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.
497

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

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

More precisely, if an element of this list is a cons of category CAT1
505 506 507
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.
508

509 510 511
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
512 513 514

  Vword_combining_categories = Qnil;

515
  DEFVAR_LISP ("word-separating-categories", Vword_separating_categories,
516 517
	       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
518 519 520 521 522 523 524 525 526 527 528

  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);
529
  defsubr (&Smake_category_table);
Karl Heuer's avatar
Karl Heuer committed
530 531 532 533 534 535 536
  defsubr (&Sset_category_table);
  defsubr (&Schar_category_set);
  defsubr (&Scategory_set_mnemonics);
  defsubr (&Smodify_category_entry);

  category_table_version = 0;
}