category.c 17 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

35
#include <setjmp.h>
Karl Heuer's avatar
Karl Heuer committed
36
#include "lisp.h"
Kenichi Handa's avatar
Kenichi Handa committed
37
#include "character.h"
38
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
39 40
#include "charset.h"
#include "category.h"
Stefan Monnier's avatar
Stefan Monnier committed
41
#include "keymap.h"
Karl Heuer's avatar
Karl Heuer committed
42

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

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

60
static Lisp_Object Qcategory_table, Qcategoryp, Qcategorysetp, Qcategory_table_p;
Karl Heuer's avatar
Karl Heuer committed
61

62 63 64 65 66
/* 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
67 68 69

/* Category set staff.  */

70
static Lisp_Object hash_get_category_set (Lisp_Object, Lisp_Object);
71 72

static Lisp_Object
73
hash_get_category_set (Lisp_Object table, Lisp_Object category_set)
74 75
{
  struct Lisp_Hash_Table *h;
76
  ptrdiff_t i;
77
  EMACS_UINT hash;
78 79

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

105
  CHECK_STRING (categories);
Karl Heuer's avatar
Karl Heuer committed
106 107
  val = MAKE_CATEGORY_SET;

108
  if (STRING_MULTIBYTE (categories))
109
    error ("Multibyte string in `make-category-set'");
110

111
  len = SCHARS (categories);
Karl Heuer's avatar
Karl Heuer committed
112 113
  while (--len >= 0)
    {
114
      Lisp_Object category;
Karl Heuer's avatar
Karl Heuer committed
115

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


/* Category staff.  */

126
static Lisp_Object check_category_table (Lisp_Object table);
Karl Heuer's avatar
Karl Heuer committed
127 128

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

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

  return Qnil;
}

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

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

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

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

Kenichi Handa's avatar
Kenichi Handa committed
226 227

static void
228
copy_category_entry (Lisp_Object table, Lisp_Object c, Lisp_Object 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
static Lisp_Object
243
copy_category_table (Lisp_Object table)
Karl Heuer's avatar
Karl Heuer committed
244
{
Kenichi Handa's avatar
Kenichi Handa committed
245
  table = copy_char_table (table);
Karl Heuer's avatar
Karl Heuer committed
246

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

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

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

268
  return copy_category_table (table);
Karl Heuer's avatar
Karl Heuer committed
269 270
}

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

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

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

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

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

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

329
  CHECK_CATEGORY_SET (category_set);
Karl Heuer's avatar
Karl Heuer committed
330 331 332 333 334 335 336 337 338 339

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

  return build_string (str);
}

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

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

384
  CHECK_CATEGORY (category);
Karl Heuer's avatar
Karl Heuer committed
385 386 387
  table = check_category_table (table);

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

  set_value = NILP (reset) ? Qt : Qnil;

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

  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
415
word_boundary_p (int c1, int c2)
Karl Heuer's avatar
Karl Heuer committed
416 417 418 419 420
{
  Lisp_Object category_set1, category_set2;
  Lisp_Object tail;
  int default_result;

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

440
  for (; CONSP (tail); tail = XCDR (tail))
Karl Heuer's avatar
Karl Heuer committed
441
    {
442
      Lisp_Object elt = XCAR (tail);
Karl Heuer's avatar
Karl Heuer committed
443 444

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


Andreas Schwab's avatar
Andreas Schwab committed
459
void
460
init_category_once (void)
Karl Heuer's avatar
Karl Heuer committed
461 462
{
  /* This has to be done here, before we call Fmake_char_table.  */
463
  DEFSYM (Qcategory_table, "category-table");
Karl Heuer's avatar
Karl Heuer committed
464 465 466 467

  /* 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
468
  Qchar_table_extra_slots = intern_c_string ("char-table-extra-slots");
Karl Heuer's avatar
Karl Heuer committed
469 470 471 472 473 474

  /* 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);
475
  /* Set a category set which contains nothing to the default.  */
Paul Eggert's avatar
Paul Eggert committed
476
  set_char_table_defalt (Vstandard_category_table, MAKE_CATEGORY_SET);
477
  Fset_char_table_extra_slot (Vstandard_category_table, make_number (0),
Karl Heuer's avatar
Karl Heuer committed
478 479 480
			      Fmake_vector (make_number (95), Qnil));
}

Andreas Schwab's avatar
Andreas Schwab committed
481
void
482
syms_of_category (void)
Karl Heuer's avatar
Karl Heuer committed
483
{
484 485 486
  DEFSYM (Qcategoryp, "categoryp");
  DEFSYM (Qcategorysetp, "categorysetp");
  DEFSYM (Qcategory_table_p, "category-table-p");
Karl Heuer's avatar
Karl Heuer committed
487

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

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

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

505 506 507
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.
508

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

512
Emacs finds a word boundary between characters of the same script
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
516 517 518
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.
519

520 521 522
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
523 524 525

  Vword_combining_categories = Qnil;

526
  DEFVAR_LISP ("word-separating-categories", Vword_separating_categories,
527 528
	       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
529 530 531 532 533 534 535 536 537 538 539

  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);
540
  defsubr (&Smake_category_table);
Karl Heuer's avatar
Karl Heuer committed
541 542 543 544 545 546 547
  defsubr (&Sset_category_table);
  defsubr (&Schar_category_set);
  defsubr (&Scategory_set_mnemonics);
  defsubr (&Smodify_category_entry);

  category_table_version = 0;
}