category.c 18.4 KB
Newer Older
Karl Heuer's avatar
Karl Heuer committed
1
/* GNU Emacs routines to deal with category tables.
2 3
   Copyright (C) 1995, 1997 Electrotechnical Laboratory, JAPAN.
   Licensed to the Free Software Foundation.
Karl Heuer's avatar
Karl Heuer committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

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
along with GNU Emacs; see the file COPYING.  If not, write to
Karl Heuer's avatar
Karl Heuer committed
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Karl Heuer's avatar
Karl Heuer committed
21 22 23 24 25 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>
#include <ctype.h>
#include "lisp.h"
#include "buffer.h"
#include "charset.h"
#include "category.h"
Stefan Monnier's avatar
Stefan Monnier committed
32
#include "keymap.h"
Karl Heuer's avatar
Karl Heuer committed
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55

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

DEFUN ("make-category-set", Fmake_category_set, Smake_category_set, 1, 1, 0,
56 57 58 59 60
       doc: /* Return a newly created category-set which contains CATEGORIES.
CATEGORIES is a string of category mnemonics.
The value is a bool-vector which has t at the indices corresponding to
those categories.  */)
     (categories)
Karl Heuer's avatar
Karl Heuer committed
61 62 63 64 65
     Lisp_Object categories;
{
  Lisp_Object val;
  int len;

66
  CHECK_STRING (categories);
Karl Heuer's avatar
Karl Heuer committed
67 68
  val = MAKE_CATEGORY_SET;

69 70 71
  if (STRING_MULTIBYTE (categories))
    error ("Multibyte string in make-category-set");

72
  len = SCHARS (categories);
Karl Heuer's avatar
Karl Heuer committed
73 74
  while (--len >= 0)
    {
75
      Lisp_Object category;
Karl Heuer's avatar
Karl Heuer committed
76

77
      XSETFASTINT (category, SREF (categories, len));
78
      CHECK_CATEGORY (category);
Karl Heuer's avatar
Karl Heuer committed
79 80 81 82 83 84 85 86 87 88 89
      SET_CATEGORY_SET (val, category, Qt);
    }
  return val;
}


/* Category staff.  */

Lisp_Object check_category_table ();

DEFUN ("define-category", Fdefine_category, Sdefine_category, 2, 3, 0,
90 91 92 93 94 95
       doc: /* Define CHAR as a category which is described by DOCSTRING.
CHAR should be an ASCII printing character in the range ` ' to `~'.
DOCSTRING is a documentation string of the category.
The category is defined only in category table TABLE, which defaults to
 the current buffer's category table.  */)
     (category, docstring, table)
Karl Heuer's avatar
Karl Heuer committed
96 97
     Lisp_Object category, docstring, table;
{
98 99
  CHECK_CATEGORY (category);
  CHECK_STRING (docstring);
Karl Heuer's avatar
Karl Heuer committed
100 101 102 103 104 105 106 107 108 109
  table = check_category_table (table);

  if (!NILP (CATEGORY_DOCSTRING (table, XFASTINT (category))))
    error ("Category `%c' is already defined", XFASTINT (category));
  CATEGORY_DOCSTRING (table, XFASTINT (category)) = docstring;

  return Qnil;
}

DEFUN ("category-docstring", Fcategory_docstring, Scategory_docstring, 1, 2, 0,
110 111
       doc: /* Return the documentation string of CATEGORY, as defined in CATEGORY-TABLE.  */)
     (category, table)
Karl Heuer's avatar
Karl Heuer committed
112 113
     Lisp_Object category, table;
{
114
  CHECK_CATEGORY (category);
Karl Heuer's avatar
Karl Heuer committed
115 116 117 118 119 120 121
  table = check_category_table (table);

  return CATEGORY_DOCSTRING (table, XFASTINT (category));
}

DEFUN ("get-unused-category", Fget_unused_category, Sget_unused_category,
       0, 1, 0,
122 123 124 125 126
       doc: /* Return a category which is not yet defined in CATEGORY-TABLE.
If no category remains available, return nil.
The optional argument CATEGORY-TABLE
specifies which category table to modify;
it defaults to the current buffer's category table.  */)
127
     (table)
Karl Heuer's avatar
Karl Heuer committed
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
     Lisp_Object table;
{
  int i;

  table = check_category_table (table);

  for (i = ' '; i <= '~'; i++)
    if (NILP (CATEGORY_DOCSTRING (table, i)))
      return make_number (i);

  return Qnil;
}


/* Category-table staff.  */

DEFUN ("category-table-p", Fcategory_table_p, Scategory_table_p, 1, 1, 0,
145 146
       doc: /* Return t if ARG is a category table.  */)
     (arg)
Karl Heuer's avatar
Karl Heuer committed
147 148 149
     Lisp_Object arg;
{
  if (CHAR_TABLE_P (arg)
150
      && EQ (XCHAR_TABLE (arg)->purpose, Qcategory_table))
Karl Heuer's avatar
Karl Heuer committed
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
    return Qt;
  return Qnil;
}

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

Lisp_Object
check_category_table (table)
     Lisp_Object table;
{
  register Lisp_Object tem;
  if (NILP (table))
    return current_buffer->category_table;
  while (tem = Fcategory_table_p (table), NILP (tem))
    table = wrong_type_argument (Qcategory_table_p, table);
  return table;
170
}
Karl Heuer's avatar
Karl Heuer committed
171 172

DEFUN ("category-table", Fcategory_table, Scategory_table, 0, 0, 0,
173 174 175
       doc: /* Return the current category table.
This is the one specified by the current buffer.  */)
     ()
Karl Heuer's avatar
Karl Heuer committed
176 177 178 179 180 181
{
  return current_buffer->category_table;
}

DEFUN ("standard-category-table", Fstandard_category_table,
   Sstandard_category_table, 0, 0, 0,
182 183 184
       doc: /* Return the standard category table.
This is the one used for new buffers.  */)
     ()
Karl Heuer's avatar
Karl Heuer committed
185 186 187 188 189 190
{
  return Vstandard_category_table;
}

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

Lisp_Object
195
copy_category_table (table)
Karl Heuer's avatar
Karl Heuer committed
196 197
     Lisp_Object table;
{
198 199
  Lisp_Object tmp;
  int i, to;
Karl Heuer's avatar
Karl Heuer committed
200

201 202 203 204 205 206 207 208 209 210 211
  if (!NILP (XCHAR_TABLE (table)->top))
    {
      /* TABLE is a top level char table.
	 At first, make a copy of tree structure of the table.  */
      table = Fcopy_sequence (table);

      /* Then, copy elements for single byte characters one by one.  */
      for (i = 0; i < CHAR_TABLE_SINGLE_BYTE_SLOTS; i++)
	if (!NILP (tmp = XCHAR_TABLE (table)->contents[i]))
	  XCHAR_TABLE (table)->contents[i] = Fcopy_sequence (tmp);
      to = CHAR_TABLE_ORDINARY_SLOTS;
212 213 214 215 216 217

      /* Also copy the first (and sole) extra slot.  It is a vector
         containing docstring of each category.  */
      Fset_char_table_extra_slot
	(table, make_number (0),
	 Fcopy_sequence (Fchar_table_extra_slot (table, make_number (0))));
218 219
    }
  else
Karl Heuer's avatar
Karl Heuer committed
220
    {
221 222
      i  = 32;
      to = SUB_CHAR_TABLE_ORDINARY_SLOTS;
Karl Heuer's avatar
Karl Heuer committed
223 224
    }

225 226 227 228 229 230 231 232 233 234 235 236
  /* If the table has non-nil default value, copy it.  */
  if (!NILP (tmp = XCHAR_TABLE (table)->defalt))
    XCHAR_TABLE (table)->defalt = Fcopy_sequence (tmp);

  /* At last, copy the remaining elements while paying attention to a
     sub char table.  */
  for (; i < to; i++)
    if (!NILP (tmp = XCHAR_TABLE (table)->contents[i]))
      XCHAR_TABLE (table)->contents[i]
	= (SUB_CHAR_TABLE_P (tmp)
	   ? copy_category_table (tmp) : Fcopy_sequence (tmp));

Karl Heuer's avatar
Karl Heuer committed
237 238 239 240 241
  return table;
}

DEFUN ("copy-category-table", Fcopy_category_table, Scopy_category_table,
       0, 1, 0,
242 243 244
       doc: /* Construct a new category table and return it.
It is a copy of the TABLE, which defaults to the standard category table.  */)
     (table)
Karl Heuer's avatar
Karl Heuer committed
245 246 247 248 249 250 251
     Lisp_Object table;
{
  if (!NILP (table))
    check_category_table (table);
  else
    table = Vstandard_category_table;

252
  return copy_category_table (table);
Karl Heuer's avatar
Karl Heuer committed
253 254
}

255 256
DEFUN ("make-category-table", Fmake_category_table, Smake_category_table,
       0, 0, 0,
257 258
       doc: /* Construct a new and empty category table and return it.  */)
     ()
259 260 261 262 263 264 265 266 267 268
{
  Lisp_Object val;

  val = Fmake_char_table (Qcategory_table, Qnil);
  XCHAR_TABLE (val)->defalt = MAKE_CATEGORY_SET;
  Fset_char_table_extra_slot (val, make_number (0),
			      Fmake_vector (make_number (95), Qnil));
  return val;
}

Karl Heuer's avatar
Karl Heuer committed
269
DEFUN ("set-category-table", Fset_category_table, Sset_category_table, 1, 1, 0,
270 271
       doc: /* Specify TABLE as the category table for the current buffer.  */)
     (table)
Karl Heuer's avatar
Karl Heuer committed
272 273
     Lisp_Object table;
{
274
  int idx;
Karl Heuer's avatar
Karl Heuer committed
275 276 277
  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
278 279
  idx = PER_BUFFER_VAR_IDX (category_table);
  SET_PER_BUFFER_VALUE_P (current_buffer, idx, 1);
Karl Heuer's avatar
Karl Heuer committed
280 281 282 283 284
  return table;
}


DEFUN ("char-category-set", Fchar_category_set, Schar_category_set, 1, 1, 0,
285 286
       doc: /* Return the category set of CHAR.  */)
     (ch)
Karl Heuer's avatar
Karl Heuer committed
287 288
     Lisp_Object ch;
{
289
  CHECK_NUMBER (ch);
Karl Heuer's avatar
Karl Heuer committed
290 291 292 293 294
  return CATEGORY_SET (XFASTINT (ch));
}

DEFUN ("category-set-mnemonics", Fcategory_set_mnemonics,
       Scategory_set_mnemonics, 1, 1, 0,
295 296 297 298 299
       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
that are indexes where t occurs the bool-vector.
The return value is a string containing those same categories.  */)
     (category_set)
Karl Heuer's avatar
Karl Heuer committed
300 301 302 303 304
     Lisp_Object category_set;
{
  int i, j;
  char str[96];

305
  CHECK_CATEGORY_SET (category_set);
Karl Heuer's avatar
Karl Heuer committed
306 307 308 309 310 311 312 313 314 315

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

  return build_string (str);
}

316
/* Modify all category sets stored under sub char-table TABLE so that
Karl Heuer's avatar
Karl Heuer committed
317 318 319 320 321 322 323 324 325 326
   they contain (SET_VALUE is t) or don't contain (SET_VALUE is nil)
   CATEGORY.  */

void
modify_lower_category_set (table, category, set_value)
     Lisp_Object table, category, set_value;
{
  Lisp_Object val;
  int i;

327 328 329 330 331
  val = XCHAR_TABLE (table)->defalt;
  if (!CATEGORY_SET_P (val))
    val = MAKE_CATEGORY_SET;
  SET_CATEGORY_SET (val, category, set_value);
  XCHAR_TABLE (table)->defalt = val;
Karl Heuer's avatar
Karl Heuer committed
332

333
  for (i = 32; i < SUB_CHAR_TABLE_ORDINARY_SLOTS; i++)
Karl Heuer's avatar
Karl Heuer committed
334 335 336 337 338
    {
      val = XCHAR_TABLE (table)->contents[i];

      if (CATEGORY_SET_P (val))
	SET_CATEGORY_SET (val, category, set_value);
339
      else if (SUB_CHAR_TABLE_P (val))
Karl Heuer's avatar
Karl Heuer committed
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
	modify_lower_category_set (val, category, set_value);
    }
}

void
set_category_set (category_set, category, val)
     Lisp_Object category_set, category, val;
{
  do {
    int idx = XINT (category) / 8;
    unsigned char bits = 1 << (XINT (category) % 8);

    if (NILP (val))
      XCATEGORY_SET (category_set)->data[idx] &= ~bits;
    else
      XCATEGORY_SET (category_set)->data[idx] |= bits;
  } while (0);
}

DEFUN ("modify-category-entry", Fmodify_category_entry,
       Smodify_category_entry, 2, 4, 0,
361 362 363 364 365 366
       doc: /* Modify the category set of CHARACTER by adding CATEGORY to it.
The category is changed only for table TABLE, which defaults to
 the current buffer's category table.
If optional fourth argument RESET is non-nil,
then delete CATEGORY from the category set instead of adding it.  */)
     (character, category, table, reset)
367
     Lisp_Object character, category, table, reset;
Karl Heuer's avatar
Karl Heuer committed
368 369 370 371 372
{
  int c, charset, c1, c2;
  Lisp_Object set_value;	/* Actual value to be set in category sets.  */
  Lisp_Object val, category_set;

373
  CHECK_NUMBER (character);
374
  c = XINT (character);
375
  CHECK_CATEGORY (category);
Karl Heuer's avatar
Karl Heuer committed
376 377 378 379
  table = check_category_table (table);

  if (NILP (CATEGORY_DOCSTRING (table, XFASTINT (category))))
    error ("Undefined category: %c", XFASTINT (category));
380

Karl Heuer's avatar
Karl Heuer committed
381 382
  set_value = NILP (reset) ? Qt : Qnil;

383
  if (c < CHAR_TABLE_SINGLE_BYTE_SLOTS)
Karl Heuer's avatar
Karl Heuer committed
384 385 386 387 388 389 390 391
    {
      val = XCHAR_TABLE (table)->contents[c];
      if (!CATEGORY_SET_P (val))
	XCHAR_TABLE (table)->contents[c] = (val = MAKE_CATEGORY_SET);
      SET_CATEGORY_SET (val, category, set_value);
      return Qnil;
    }

392
  SPLIT_CHAR (c, charset, c1, c2);
Karl Heuer's avatar
Karl Heuer committed
393 394

  /* The top level table.  */
395
  val = XCHAR_TABLE (table)->contents[charset + 128];
396 397 398
  if (CATEGORY_SET_P (val))
    category_set = val;
  else if (!SUB_CHAR_TABLE_P (val))
Karl Heuer's avatar
Karl Heuer committed
399
    {
400
      category_set = val = MAKE_CATEGORY_SET;
401
      XCHAR_TABLE (table)->contents[charset + 128] = category_set;
Karl Heuer's avatar
Karl Heuer committed
402 403
    }

404
  if (c1 <= 0)
Karl Heuer's avatar
Karl Heuer committed
405 406
    {
      /* Only a charset is specified.  */
407 408 409
      if (SUB_CHAR_TABLE_P (val))
	/* All characters in CHARSET should be the same as for having
           CATEGORY or not.  */
Karl Heuer's avatar
Karl Heuer committed
410 411 412 413 414 415 416
	modify_lower_category_set (val, category, set_value);
      else
	SET_CATEGORY_SET (category_set, category, set_value);
      return Qnil;
    }

  /* The second level table.  */
417
  if (!SUB_CHAR_TABLE_P (val))
Karl Heuer's avatar
Karl Heuer committed
418
    {
419
      val = make_sub_char_table (Qnil);
420
      XCHAR_TABLE (table)->contents[charset + 128] = val;
Karl Heuer's avatar
Karl Heuer committed
421 422 423 424 425 426
      /* We must set default category set of CHARSET in `defalt' slot.  */
      XCHAR_TABLE (val)->defalt = category_set;
    }
  table = val;

  val = XCHAR_TABLE (table)->contents[c1];
427 428 429
  if (CATEGORY_SET_P (val))
    category_set = val;
  else if (!SUB_CHAR_TABLE_P (val))
Karl Heuer's avatar
Karl Heuer committed
430
    {
431
      category_set = val = Fcopy_sequence (XCHAR_TABLE (table)->defalt);
Karl Heuer's avatar
Karl Heuer committed
432 433 434
      XCHAR_TABLE (table)->contents[c1] = category_set;
    }

435
  if (c2 <= 0)
Karl Heuer's avatar
Karl Heuer committed
436
    {
437
      if (SUB_CHAR_TABLE_P (val))
Karl Heuer's avatar
Karl Heuer committed
438 439 440 441 442 443 444 445 446
	/* All characters in C1 group of CHARSET should be the same as
           for CATEGORY.  */
	modify_lower_category_set (val, category, set_value);
      else
	SET_CATEGORY_SET (category_set, category, set_value);
      return Qnil;
    }

  /* The third (bottom) level table.  */
447
  if (!SUB_CHAR_TABLE_P (val))
Karl Heuer's avatar
Karl Heuer committed
448
    {
449
      val = make_sub_char_table (Qnil);
Karl Heuer's avatar
Karl Heuer committed
450 451 452 453 454 455 456 457
      XCHAR_TABLE (table)->contents[c1] = val;
      /* We must set default category set of CHARSET and C1 in
         `defalt' slot.  */
      XCHAR_TABLE (val)->defalt = category_set;
    }
  table = val;

  val = XCHAR_TABLE (table)->contents[c2];
458 459 460
  if (CATEGORY_SET_P (val))
    category_set = val;
  else if (!SUB_CHAR_TABLE_P (val))
Karl Heuer's avatar
Karl Heuer committed
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
    {
      category_set = Fcopy_sequence (XCHAR_TABLE (table)->defalt);
      XCHAR_TABLE (table)->contents[c2] = category_set;
    }
  else
    /* This should never happen.  */
    error ("Invalid category table");

  SET_CATEGORY_SET (category_set, category, set_value);

  return Qnil;
}

/* Return 1 if there is a word boundary between two word-constituent
   characters C1 and C2 if they appear in this order, else return 0.
   Use the macro WORD_BOUNDARY_P instead of calling this function
   directly.  */

int
word_boundary_p (c1, c2)
     int c1, c2;
{
  Lisp_Object category_set1, category_set2;
  Lisp_Object tail;
  int default_result;

  if (CHAR_CHARSET (c1) == CHAR_CHARSET (c2))
    {
      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;

505
  for (; CONSP (tail); tail = XCDR (tail))
Karl Heuer's avatar
Karl Heuer committed
506
    {
507
      Lisp_Object elt = XCAR (tail);
Karl Heuer's avatar
Karl Heuer committed
508 509

      if (CONSP (elt)
510 511 512 513
	  && CATEGORYP (XCAR (elt))
	  && CATEGORYP (XCDR (elt))
	  && CATEGORY_MEMBER (XFASTINT (XCAR (elt)), category_set1)
	  && CATEGORY_MEMBER (XFASTINT (XCDR (elt)), category_set2))
Karl Heuer's avatar
Karl Heuer committed
514 515 516 517 518 519
	return !default_result;
    }
  return default_result;
}


Andreas Schwab's avatar
Andreas Schwab committed
520
void
Karl Heuer's avatar
Karl Heuer committed
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
init_category_once ()
{
  /* This has to be done here, before we call Fmake_char_table.  */
  Qcategory_table = intern ("category-table");
  staticpro (&Qcategory_table);

  /* Intern this now in case it isn't already done.
     Setting this variable twice is harmless.
     But don't staticpro it here--that is done in alloc.c.  */
  Qchar_table_extra_slots = intern ("char-table-extra-slots");

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

  Vstandard_category_table = Fmake_char_table (Qcategory_table, Qnil);
537
  /* Set a category set which contains nothing to the default.  */
Karl Heuer's avatar
Karl Heuer committed
538
  XCHAR_TABLE (Vstandard_category_table)->defalt = MAKE_CATEGORY_SET;
539
  Fset_char_table_extra_slot (Vstandard_category_table, make_number (0),
Karl Heuer's avatar
Karl Heuer committed
540 541 542
			      Fmake_vector (make_number (95), Qnil));
}

Andreas Schwab's avatar
Andreas Schwab committed
543
void
Karl Heuer's avatar
Karl Heuer committed
544 545 546 547 548 549 550 551 552 553
syms_of_category ()
{
  Qcategoryp = intern ("categoryp");
  staticpro (&Qcategoryp);
  Qcategorysetp = intern ("categorysetp");
  staticpro (&Qcategorysetp);
  Qcategory_table_p = intern ("category-table-p");
  staticpro (&Qcategory_table_p);

  DEFVAR_LISP ("word-combining-categories", &Vword_combining_categories,
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
	       doc: /* List of pair (cons) of categories to determine word boundary.

Emacs treats a sequence of word constituent characters as a single
word (i.e. finds no word boundary between them) iff they belongs to
the same charset.  But, exceptions are allowed in the following cases.

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

Emacs finds no word boundary between characters of different charsets
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.

For instance, to tell that ASCII characters and Latin-1 characters can
form a single word, the element `(?l . ?l)' should be in this list
because both characters have the category `l' (Latin characters).

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

Emacs find a word boundary between characters of the same charset
if they have categories matching some element of this list.

More precisely, if an element of this list is a cons of category CAT1
and CAT2, and a multibyte character C1 which has CAT1 is followed by
C2 which has CAT2, there's a word boundary between C1 and C2.

For instance, to tell that there's a word boundary between Japanese
Hiragana and Japanese Kanji (both are in the same charset), the
element `(?H . ?C) should be in this list.  */);
Karl Heuer's avatar
Karl Heuer committed
587 588 589 590

  Vword_combining_categories = Qnil;

  DEFVAR_LISP ("word-separating-categories", &Vword_separating_categories,
591 592
	       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
593 594 595 596 597 598 599 600 601 602 603

  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);
604
  defsubr (&Smake_category_table);
Karl Heuer's avatar
Karl Heuer committed
605 606 607 608 609 610 611
  defsubr (&Sset_category_table);
  defsubr (&Schar_category_set);
  defsubr (&Scategory_set_mnemonics);
  defsubr (&Smodify_category_entry);

  category_table_version = 0;
}