src/category.h

/* Declarations having to do with Emacs category tables.
   Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
     2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
     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

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 3 of the License, 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.  If not, see <http://www.gnu.org/licenses/>.  */


/* We introduce here three types of object: category, category set,
   and category table.

   A category is like syntax but differs in the following points:

   o A category is represented by a mnemonic character of the range
   ` '(32)..`~'(126) (printable ASCII characters).

   o A category is not exclusive, i.e. a character has multiple
   categories (category set).  Of course, there's a case that a
   category set is empty, i.e. the character has no category.

   o In addition to the predefined categories, a user can define new
   categories.  Total number of categories is limited to 95.

   A category set is a set of categories represented by Lisp
   bool-vector of length 128 (only elements of 31th through 126th
   are used).

   A category table is like syntax-table, represented by a Lisp
   char-table.  The contents are category sets or nil.  It has two
   extra slots, for a vector of doc string of each category and a
   version number.

   The first extra slot is a vector of doc strings of categories, the
   length is 95.  The Nth element corresponding to the category N+32.

   The second extra slot is a version number of the category table.
   But, for the moment, we are not using this slot.  */

INLINE_HEADER_BEGIN
#ifndef CATEGORY_INLINE
# define CATEGORY_INLINE INLINE
#endif

#define CATEGORYP(x) RANGED_INTEGERP (0x20, x, 0x7E)

#define CHECK_CATEGORY(x) \
  CHECK_TYPE (CATEGORYP (x), Qcategoryp, x)

#define XCATEGORY_SET XBOOL_VECTOR

#define CATEGORY_SET_P(x) \
  (BOOL_VECTOR_P (x) && XBOOL_VECTOR (x)->size == 128)

/* Return a new empty category set.  */
#define MAKE_CATEGORY_SET (Fmake_bool_vector (make_number (128), Qnil))

#define CHECK_CATEGORY_SET(x) \
  CHECK_TYPE (CATEGORY_SET_P (x), Qcategorysetp, x)

/* Return the category set of character C in the current category table.  */
#define CATEGORY_SET(c) char_category_set (c)

/* Return true if CATEGORY_SET contains CATEGORY.
   The faster version of `!NILP (Faref (category_set, category))'.  */
#define CATEGORY_MEMBER(category, category_set)		 		\
  ((XCATEGORY_SET (category_set)->data[(category) / 8]			\
    >> ((category) % 8)) & 1)

/* Return true if category set of CH contains CATEGORY.  */
CATEGORY_INLINE bool
CHAR_HAS_CATEGORY (int ch, int category)
{
  Lisp_Object category_set = CATEGORY_SET (ch);
  return CATEGORY_MEMBER (category, category_set);
}

/* The standard category table is stored where it will automatically
   be used in all new buffers.  */
#define Vstandard_category_table BVAR (&buffer_defaults, category_table)

/* Return the doc string of CATEGORY in category table TABLE.  */
#define CATEGORY_DOCSTRING(table, category)				\
  AREF (Fchar_table_extra_slot (table, make_number (0)), ((category) - ' '))

/* Set the doc string of CATEGORY to VALUE in category table TABLE.  */
#define SET_CATEGORY_DOCSTRING(table, category, value)			\
  ASET (Fchar_table_extra_slot (table, make_number (0)), ((category) - ' '), value)

/* Return the version number of category table TABLE.  Not used for
   the moment.  */
#define CATEGORY_TABLE_VERSION (table) \
  Fchar_table_extra_slot (table, make_number (1))

/* Return true if there is a word boundary between two
   word-constituent characters C1 and C2 if they appear in this order.
   There is no word boundary between two word-constituent ASCII and
   Latin-1 characters.  */
#define WORD_BOUNDARY_P(c1, c2)					\
  (!(SINGLE_BYTE_CHAR_P (c1) && SINGLE_BYTE_CHAR_P (c2))	\
   && word_boundary_p (c1, c2))

extern bool word_boundary_p (int, int);

INLINE_HEADER_END
Commit	Line	Data
	1	/* Declarations having to do with Emacs category tables.
	2	Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
	3	2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
	4	National Institute of Advanced Industrial Science and Technology (AIST)
	5	Registration Number H14PRO021
	6	Copyright (C) 2003
	7	National Institute of Advanced Industrial Science and Technology (AIST)
	8	Registration Number H13PRO009
	9
	10	This file is part of GNU Emacs.
	11
	12	GNU Emacs is free software: you can redistribute it and/or modify
	13	it under the terms of the GNU General Public License as published by
	14	the Free Software Foundation, either version 3 of the License, or
	15	(at your option) any later version.
	16
	17	GNU Emacs is distributed in the hope that it will be useful,
	18	but WITHOUT ANY WARRANTY; without even the implied warranty of
	19	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	20	GNU General Public License for more details.
	21
	22	You should have received a copy of the GNU General Public License
	23	along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
	24
	25
	26	/* We introduce here three types of object: category, category set,
	27	and category table.
	28
	29	A category is like syntax but differs in the following points:
	30
	31	o A category is represented by a mnemonic character of the range
	32	` '(32)..`~'(126) (printable ASCII characters).
	33
	34	o A category is not exclusive, i.e. a character has multiple
	35	categories (category set). Of course, there's a case that a
	36	category set is empty, i.e. the character has no category.
	37
	38	o In addition to the predefined categories, a user can define new
	39	categories. Total number of categories is limited to 95.
	40
	41	A category set is a set of categories represented by Lisp
	42	bool-vector of length 128 (only elements of 31th through 126th
	43	are used).
	44
	45	A category table is like syntax-table, represented by a Lisp
	46	char-table. The contents are category sets or nil. It has two
	47	extra slots, for a vector of doc string of each category and a
	48	version number.
	49
	50	The first extra slot is a vector of doc strings of categories, the
	51	length is 95. The Nth element corresponding to the category N+32.
	52
	53	The second extra slot is a version number of the category table.
	54	But, for the moment, we are not using this slot. */
	55
	56	INLINE_HEADER_BEGIN
	57	#ifndef CATEGORY_INLINE
	58	# define CATEGORY_INLINE INLINE
	59	#endif
	60
	61	#define CATEGORYP(x) RANGED_INTEGERP (0x20, x, 0x7E)
	62
	63	#define CHECK_CATEGORY(x) \
	64	CHECK_TYPE (CATEGORYP (x), Qcategoryp, x)
	65
	66	#define XCATEGORY_SET XBOOL_VECTOR
	67
	68	#define CATEGORY_SET_P(x) \
	69	(BOOL_VECTOR_P (x) && XBOOL_VECTOR (x)->size == 128)
	70
	71	/* Return a new empty category set. */
	72	#define MAKE_CATEGORY_SET (Fmake_bool_vector (make_number (128), Qnil))
	73
	74	#define CHECK_CATEGORY_SET(x) \
	75	CHECK_TYPE (CATEGORY_SET_P (x), Qcategorysetp, x)
	76
	77	/* Return the category set of character C in the current category table. */
	78	#define CATEGORY_SET(c) char_category_set (c)
	79
	80	/* Return true if CATEGORY_SET contains CATEGORY.
	81	The faster version of `!NILP (Faref (category_set, category))'. */
	82	#define CATEGORY_MEMBER(category, category_set) \
	83	((XCATEGORY_SET (category_set)->data[(category) / 8] \
	84	>> ((category) % 8)) & 1)
	85
	86	/* Return true if category set of CH contains CATEGORY. */
	87	CATEGORY_INLINE bool
	88	CHAR_HAS_CATEGORY (int ch, int category)
	89	{
	90	Lisp_Object category_set = CATEGORY_SET (ch);
	91	return CATEGORY_MEMBER (category, category_set);
	92	}
	93
	94	/* The standard category table is stored where it will automatically
	95	be used in all new buffers. */
	96	#define Vstandard_category_table BVAR (&buffer_defaults, category_table)
	97
	98	/* Return the doc string of CATEGORY in category table TABLE. */
	99	#define CATEGORY_DOCSTRING(table, category) \
	100	AREF (Fchar_table_extra_slot (table, make_number (0)), ((category) - ' '))
	101
	102	/* Set the doc string of CATEGORY to VALUE in category table TABLE. */
	103	#define SET_CATEGORY_DOCSTRING(table, category, value) \
	104	ASET (Fchar_table_extra_slot (table, make_number (0)), ((category) - ' '), value)
	105
	106	/* Return the version number of category table TABLE. Not used for
	107	the moment. */
	108	#define CATEGORY_TABLE_VERSION (table) \
	109	Fchar_table_extra_slot (table, make_number (1))
	110
	111	/* Return true if there is a word boundary between two
	112	word-constituent characters C1 and C2 if they appear in this order.
	113	There is no word boundary between two word-constituent ASCII and
	114	Latin-1 characters. */
	115	#define WORD_BOUNDARY_P(c1, c2) \
	116	(!(SINGLE_BYTE_CHAR_P (c1) && SINGLE_BYTE_CHAR_P (c2)) \
	117	&& word_boundary_p (c1, c2))
	118
	119	extern bool word_boundary_p (int, int);
	120
	121	INLINE_HEADER_END