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

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

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

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

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

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

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

  if (NILP (XCHAR_TABLE (table)->extras[1]))
74 75 76 77 78 79
    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));
80 81 82 83 84 85 86 87 88
  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
89
DEFUN ("make-category-set", Fmake_category_set, Smake_category_set, 1, 1, 0,
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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
94
  (Lisp_Object categories)
Karl Heuer's avatar
Karl Heuer committed
95 96 97 98
{
  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
      SET_CATEGORY_SET (val, category, Qt);
    }
  return val;
}


/* Category staff.  */

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

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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
130
  (Lisp_Object category, Lisp_Object docstring, Lisp_Object table)
Karl Heuer's avatar
Karl Heuer committed
131
{
132 133
  CHECK_CATEGORY (category);
  CHECK_STRING (docstring);
Karl Heuer's avatar
Karl Heuer committed
134 135 136
  table = check_category_table (table);

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

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

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

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

Kenichi Handa's avatar
Kenichi Handa committed
220 221

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

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

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

Kenichi Handa's avatar
Kenichi Handa committed
241
  if (! NILP (XCHAR_TABLE (table)->defalt))
242 243 244 245
    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
246
  map_char_table (copy_category_entry, Qnil, table, table);
247

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

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

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

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

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

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

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

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

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

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

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

  return build_string (str);
}

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

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

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

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

  set_value = NILP (reset) ? Qt : Qnil;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  Vword_combining_categories = Qnil;

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

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

  category_table_version = 0;
}