category.c 15.7 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.
Kenichi Handa's avatar
Kenichi Handa committed
4 5 6
   Copyright (C) 2001, 2002
     National Institute of Advanced Industrial Science and Technology (AIST)
     Registration Number H13PRO009
Karl Heuer's avatar
Karl Heuer committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21

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
22 23
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Karl Heuer's avatar
Karl Heuer committed
24 25 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>
#include "lisp.h"
#include "buffer.h"
Kenichi Handa's avatar
Kenichi Handa committed
33
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
34 35
#include "charset.h"
#include "category.h"
Stefan Monnier's avatar
Stefan Monnier committed
36
#include "keymap.h"
Karl Heuer's avatar
Karl Heuer committed
37 38 39 40 41 42 43 44 45 46 47 48 49 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;

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,
60 61 62 63 64
       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
65 66 67 68 69
     Lisp_Object categories;
{
  Lisp_Object val;
  int len;

70
  CHECK_STRING (categories);
Karl Heuer's avatar
Karl Heuer committed
71 72
  val = MAKE_CATEGORY_SET;

73 74 75
  if (STRING_MULTIBYTE (categories))
    error ("Multibyte string in make-category-set");

Karl Heuer's avatar
Karl Heuer committed
76 77 78
  len = XSTRING (categories)->size;
  while (--len >= 0)
    {
79
      Lisp_Object category;
Karl Heuer's avatar
Karl Heuer committed
80

81
      XSETFASTINT (category, XSTRING (categories)->data[len]);
82
      CHECK_CATEGORY (category);
Karl Heuer's avatar
Karl Heuer committed
83 84 85 86 87 88 89 90 91 92 93
      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,
94 95 96 97 98 99
       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
100 101
     Lisp_Object category, docstring, table;
{
102 103
  CHECK_CATEGORY (category);
  CHECK_STRING (docstring);
Karl Heuer's avatar
Karl Heuer committed
104 105 106 107 108 109 110 111 112 113
  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,
114 115
       doc: /* Return the documentation string of CATEGORY, as defined in CATEGORY-TABLE.  */)
     (category, table)
Karl Heuer's avatar
Karl Heuer committed
116 117
     Lisp_Object category, table;
{
118
  CHECK_CATEGORY (category);
Karl Heuer's avatar
Karl Heuer committed
119 120 121 122 123 124 125
  table = check_category_table (table);

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

DEFUN ("get-unused-category", Fget_unused_category, Sget_unused_category,
       0, 1, 0,
126 127 128 129 130
       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.  */)
131
     (table)
Karl Heuer's avatar
Karl Heuer committed
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
     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,
149 150
       doc: /* Return t if ARG is a category table.  */)
     (arg)
Karl Heuer's avatar
Karl Heuer committed
151 152 153
     Lisp_Object arg;
{
  if (CHAR_TABLE_P (arg)
154
      && EQ (XCHAR_TABLE (arg)->purpose, Qcategory_table))
Karl Heuer's avatar
Karl Heuer committed
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
    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;
}   

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

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

Kenichi Handa's avatar
Kenichi Handa committed
193 194 195 196 197 198 199 200 201

static void
copy_category_entry (table, range, val)
     Lisp_Object table, range, val;
{
  char_table_set_range (table, XINT (XCAR (range)), XINT (XCDR (range)),
			Fcopy_sequence (val));
}

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

Lisp_Object
208
copy_category_table (table)
Karl Heuer's avatar
Karl Heuer committed
209 210
     Lisp_Object table;
{
Kenichi Handa's avatar
Kenichi Handa committed
211
  table = copy_char_table (table);
Karl Heuer's avatar
Karl Heuer committed
212

Kenichi Handa's avatar
Kenichi Handa committed
213 214 215 216 217
  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]);
218

Kenichi Handa's avatar
Kenichi Handa committed
219
  map_char_table (copy_category_entry, Qnil, table, table, 0, NULL);
220

Karl Heuer's avatar
Karl Heuer committed
221 222 223 224 225
  return table;
}

DEFUN ("copy-category-table", Fcopy_category_table, Scopy_category_table,
       0, 1, 0,
226 227 228
       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
229 230 231 232 233 234 235
     Lisp_Object table;
{
  if (!NILP (table))
    check_category_table (table);
  else
    table = Vstandard_category_table;

236
  return copy_category_table (table);
Karl Heuer's avatar
Karl Heuer committed
237 238
}

239 240
DEFUN ("make-category-table", Fmake_category_table, Smake_category_table,
       0, 0, 0,
241 242
       doc: /* Construct a new and empty category table and return it.  */)
     ()
243 244
{
  Lisp_Object val;
Kenichi Handa's avatar
Kenichi Handa committed
245
  int i;
246 247 248

  val = Fmake_char_table (Qcategory_table, Qnil);
  XCHAR_TABLE (val)->defalt = MAKE_CATEGORY_SET;
Kenichi Handa's avatar
Kenichi Handa committed
249 250
  for (i = 0; i < (1 << CHARTAB_SIZE_BITS_0); i++)  
    XCHAR_TABLE (val)->contents[i] = MAKE_CATEGORY_SET;
251 252 253 254 255
  Fset_char_table_extra_slot (val, make_number (0),
			      Fmake_vector (make_number (95), Qnil));
  return val;
}

Karl Heuer's avatar
Karl Heuer committed
256
DEFUN ("set-category-table", Fset_category_table, Sset_category_table, 1, 1, 0,
257 258
       doc: /* Specify TABLE as the category table for the current buffer.  */)
     (table)
Karl Heuer's avatar
Karl Heuer committed
259 260
     Lisp_Object table;
{
261
  int idx;
Karl Heuer's avatar
Karl Heuer committed
262 263 264
  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
265 266
  idx = PER_BUFFER_VAR_IDX (category_table);
  SET_PER_BUFFER_VALUE_P (current_buffer, idx, 1);
Karl Heuer's avatar
Karl Heuer committed
267 268 269 270
  return table;
}


Kenichi Handa's avatar
Kenichi Handa committed
271 272 273 274 275 276 277
Lisp_Object
char_category_set (c)
     int c;
{
  return CHAR_TABLE_REF (current_buffer->category_table, c);
}

Karl Heuer's avatar
Karl Heuer committed
278
DEFUN ("char-category-set", Fchar_category_set, Schar_category_set, 1, 1, 0,
279 280
       doc: /* Return the category set of CHAR.  */)
     (ch)
Karl Heuer's avatar
Karl Heuer committed
281 282
     Lisp_Object ch;
{
283
  CHECK_NUMBER (ch);
Karl Heuer's avatar
Karl Heuer committed
284 285 286 287 288
  return CATEGORY_SET (XFASTINT (ch));
}

DEFUN ("category-set-mnemonics", Fcategory_set_mnemonics,
       Scategory_set_mnemonics, 1, 1, 0,
289 290 291 292 293
       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
294 295 296 297 298
     Lisp_Object category_set;
{
  int i, j;
  char str[96];

299
  CHECK_CATEGORY_SET (category_set);
Karl Heuer's avatar
Karl Heuer committed
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326

  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
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,
327 328
       doc: /* Modify the category set of CHARACTER by adding CATEGORY to it.
The category is changed only for table TABLE, which defaults to
329 330 331
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.
332 333 334
If optional fourth argument RESET is non-nil,
then delete CATEGORY from the category set instead of adding it.  */)
     (character, category, table, reset)
335
     Lisp_Object character, category, table, reset;
Karl Heuer's avatar
Karl Heuer committed
336 337
{
  Lisp_Object set_value;	/* Actual value to be set in category sets.  */
338
  Lisp_Object category_set;
Kenichi Handa's avatar
Kenichi Handa committed
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
  int start, end;
  int from, to;

  if (INTEGERP (character))
    {
      CHECK_CHARACTER (character);
      start = end = XFASTINT (character);
    }
  else
    {
      CHECK_CONS (character);
      CHECK_CHARACTER (XCAR (character));
      CHECK_CHARACTER (XCDR (character));
      start = XFASTINT (XCAR (character));
      end = XFASTINT (XCDR (character));
    }
Karl Heuer's avatar
Karl Heuer committed
355

356
  CHECK_CATEGORY (category);
Karl Heuer's avatar
Karl Heuer committed
357 358 359 360 361 362 363
  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
364
  while (start <= end)
Karl Heuer's avatar
Karl Heuer committed
365
    {
Kenichi Handa's avatar
Kenichi Handa committed
366
      category_set = char_table_ref_and_range (table, start, &from, &to);
367
      if (CATEGORY_MEMBER (category, category_set) != NILP (reset))
Kenichi Handa's avatar
Kenichi Handa committed
368
	{
369 370
	  category_set = Fcopy_sequence (category_set);
	  SET_CATEGORY_SET (category_set, category, set_value);
Kenichi Handa's avatar
Kenichi Handa committed
371 372 373 374 375 376
	  if (to > end)
	    char_table_set_range (table, start, end, category_set);
	  else
	    char_table_set_range (table, start, to, category_set);
	}
      start = to + 1;
Karl Heuer's avatar
Karl Heuer committed
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
    }
  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;

412
  for (; CONSP (tail); tail = XCDR (tail))
Karl Heuer's avatar
Karl Heuer committed
413
    {
414
      Lisp_Object elt = XCAR (tail);
Karl Heuer's avatar
Karl Heuer committed
415 416

      if (CONSP (elt)
417 418 419 420
	  && 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
421 422 423 424 425 426
	return !default_result;
    }
  return default_result;
}


Andreas Schwab's avatar
Andreas Schwab committed
427
void
Karl Heuer's avatar
Karl Heuer committed
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
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);
  /* Set a category set which contains nothing to the default.  */ 
  XCHAR_TABLE (Vstandard_category_table)->defalt = MAKE_CATEGORY_SET;
446
  Fset_char_table_extra_slot (Vstandard_category_table, make_number (0),
Karl Heuer's avatar
Karl Heuer committed
447 448 449
			      Fmake_vector (make_number (95), Qnil));
}

Andreas Schwab's avatar
Andreas Schwab committed
450
void
Karl Heuer's avatar
Karl Heuer committed
451 452 453 454 455 456 457 458 459 460
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,
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
	       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
494 495 496 497

  Vword_combining_categories = Qnil;

  DEFVAR_LISP ("word-separating-categories", &Vword_separating_categories,
498 499
	       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
500 501 502 503 504 505 506 507 508 509 510

  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);
511
  defsubr (&Smake_category_table);
Karl Heuer's avatar
Karl Heuer committed
512 513 514 515 516 517 518
  defsubr (&Sset_category_table);
  defsubr (&Schar_category_set);
  defsubr (&Scategory_set_mnemonics);
  defsubr (&Smodify_category_entry);

  category_table_version = 0;
}