category.c 17 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, 2010
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, 2010
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
static Lisp_Object hash_get_category_set (Lisp_Object, Lisp_Object);
63 64

static Lisp_Object
65
hash_get_category_set (Lisp_Object table, Lisp_Object category_set)
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
{
  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
87
DEFUN ("make-category-set", Fmake_category_set, Smake_category_set, 1, 1, 0,
88 89 90 91
       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
92
  (Lisp_Object categories)
Karl Heuer's avatar
Karl Heuer committed
93 94 95 96
{
  Lisp_Object val;
  int len;

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

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

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

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


/* Category staff.  */

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

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

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

/* If TABLE is nil, return the current category table.  If TABLE is
   not nil, check the validity of TABLE as a category table.  If
   valid, return TABLE itself, but if not valid, signal an error of
   wrong-type-argument.  */

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

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

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

Kenichi Handa's avatar
Kenichi Handa committed
218 219

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

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

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

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

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

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

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

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

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

Karl Heuer's avatar
Karl Heuer committed
280
DEFUN ("set-category-table", Fset_category_table, Sset_category_table, 1, 1, 0,
Kenichi Handa's avatar
Kenichi Handa committed
281 282
       doc: /* Specify TABLE as the category table for the current buffer.
Return TABLE.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
283
  (Lisp_Object table)
Karl Heuer's avatar
Karl Heuer committed
284
{
285
  int idx;
Karl Heuer's avatar
Karl Heuer committed
286 287 288
  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
289 290
  idx = PER_BUFFER_VAR_IDX (category_table);
  SET_PER_BUFFER_VALUE_P (current_buffer, idx, 1);
Karl Heuer's avatar
Karl Heuer committed
291 292 293 294
  return table;
}


Kenichi Handa's avatar
Kenichi Handa committed
295
Lisp_Object
296
char_category_set (int c)
Kenichi Handa's avatar
Kenichi Handa committed
297 298 299 300
{
  return CHAR_TABLE_REF (current_buffer->category_table, c);
}

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

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

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

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

  return build_string (str);
}

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

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

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

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

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

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

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


Andreas Schwab's avatar
Andreas Schwab committed
451
void
452
init_category_once (void)
Karl Heuer's avatar
Karl Heuer committed
453 454
{
  /* This has to be done here, before we call Fmake_char_table.  */
Dan Nicolaescu's avatar
Dan Nicolaescu committed
455
  Qcategory_table = intern_c_string ("category-table");
Karl Heuer's avatar
Karl Heuer committed
456 457 458 459 460
  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
461
  Qchar_table_extra_slots = intern_c_string ("char-table-extra-slots");
Karl Heuer's avatar
Karl Heuer committed
462 463 464 465 466 467

  /* Now we are ready to set up this property, so we can
     create category tables.  */
  Fput (Qcategory_table, Qchar_table_extra_slots, make_number (2));

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

Andreas Schwab's avatar
Andreas Schwab committed
474
void
475
syms_of_category (void)
Karl Heuer's avatar
Karl Heuer committed
476
{
Dan Nicolaescu's avatar
Dan Nicolaescu committed
477
  Qcategoryp = intern_c_string ("categoryp");
Karl Heuer's avatar
Karl Heuer committed
478
  staticpro (&Qcategoryp);
Dan Nicolaescu's avatar
Dan Nicolaescu committed
479
  Qcategorysetp = intern_c_string ("categorysetp");
Karl Heuer's avatar
Karl Heuer committed
480
  staticpro (&Qcategorysetp);
Dan Nicolaescu's avatar
Dan Nicolaescu committed
481
  Qcategory_table_p = intern_c_string ("category-table-p");
Karl Heuer's avatar
Karl Heuer committed
482 483 484
  staticpro (&Qcategory_table_p);

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

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

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

501 502 503
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.
504

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

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

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

516 517 518
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
519 520 521 522

  Vword_combining_categories = Qnil;

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

  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);
536
  defsubr (&Smake_category_table);
Karl Heuer's avatar
Karl Heuer committed
537 538 539 540 541 542 543
  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
544 545 546

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