[bpt/emacs.git] / src / category.h

/* Declarations having to do with Emacs category tables.
   Copyright (C) 1995, 1998, 1999
     National Institute of Advanced Industrial Science and Technology (AIST)
     Registration Number H14PRO021

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
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */


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

#define CATEGORYP(x) \
  (INTEGERP ((x)) && XFASTINT ((x)) >= 0x20 && XFASTINT ((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)) && (EMACS_INT) (XBOOL_VECTOR ((x))->size) == 128)

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

/* Make CATEGORY_SET includes (if VAL is t) or excludes (if VAL is
   nil) CATEGORY.  */
#define SET_CATEGORY_SET(category_set, category, val) \
  (Faset (category_set, category, val))

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

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

/* Temporary internal variable used in macro CHAR_HAS_CATEGORY.  */
extern Lisp_Object _temp_category_set;

/* Return 1 if category set of CH contains CATEGORY, elt return 0.  */
#define CHAR_HAS_CATEGORY(ch, category)	\
  (_temp_category_set = CATEGORY_SET (ch),	\
   CATEGORY_MEMBER (category, _temp_category_set))

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

/* Return the category set of character C in the current category table.  */
#ifdef __GNUC__
#define CATEGORY_SET(c)							     \
  ({ Lisp_Object table = current_buffer->category_table;		     \
     Lisp_Object temp;							     \
     if ((c) < CHAR_TABLE_SINGLE_BYTE_SLOTS)				     \
       while (NILP (temp = XCHAR_TABLE (table)->contents[(unsigned char) c]) \
	      && NILP (temp = XCHAR_TABLE (table)->defalt))		     \
	 table = XCHAR_TABLE (table)->parent;				     \
     else								     \
       temp = Faref (table, make_number (c));				     \
     temp; })
#else
#define CATEGORY_SET(c) \
  Faref (current_buffer->category_table, make_number (c))
#endif

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

/* 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 1 if there is a word boundary between two word-constituent
   characters C1 and C2 if they appear in this order, else return 0.
   There is no word boundary between two word-constituent ASCII
   characters.  */
#define WORD_BOUNDARY_P(c1, c2)					\
  (!(SINGLE_BYTE_CHAR_P (c1) && SINGLE_BYTE_CHAR_P (c2))	\
   && word_boundary_p (c1, c2))

extern int word_boundary_p P_ ((int, int));

/* arch-tag: 309dfe83-c3e2-4d22-8e81-faae5aece0ff
   (do not change this comment) */
Commit	Line	Data
4ed46869	1	/* Declarations having to do with Emacs category tables.
ce03bf76 KH	2	Copyright (C) 1995, 1998, 1999
	3	National Institute of Advanced Industrial Science and Technology (AIST)
	4	Registration Number H14PRO021
4ed46869 KH	5
	6	This file is part of GNU Emacs.
	7
	8	GNU Emacs is free software; you can redistribute it and/or modify
	9	it under the terms of the GNU General Public License as published by
	10	the Free Software Foundation; either version 2, or (at your option)
	11	any later version.
	12
	13	GNU Emacs is distributed in the hope that it will be useful,
	14	but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	GNU General Public License for more details.
	17
	18	You should have received a copy of the GNU General Public License
	19	along with GNU Emacs; see the file COPYING. If not, write to
4fc5845f LK	20	the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
4fc5845f LK	21	Boston, MA 02110-1301, USA. */
4ed46869 KH	22
	23
	24	/* We introduce here three types of object: category, category set,
	25	and category table.
	26
	27	A category is like syntax but differs in the following points:
	28
	29	o A category is represented by a mnemonic character of the range
	30	` '(32)..`~'(126) (printable ASCII characters).
	31
	32	o A category is not exclusive, i.e. a character has multiple
	33	categories (category set). Of course, there's a case that a
	34	category set is empty, i.e. the character has no category.
	35
	36	o In addition to the predefined categories, a user can define new
	37	categories. Total number of categories is limited to 95.
	38
	39	A category set is a set of categories represented by Lisp
cecda314	40	bool-vector of length 128 (only elements of 31th through 126th
4ed46869 KH	41	are used).
	42
	43	A category table is like syntax-table, represented by a Lisp
	44	char-table. The contents are category sets or nil. It has two
cecda314	45	extra slots, for a vector of doc string of each category and a
4ed46869 KH	46	version number.
	47
	48	The first extra slot is a vector of doc strings of categories, the
	49	length is 95. The Nth element corresponding to the category N+32.
	50
	51	The second extra slot is a version number of the category table.
	52	But, for the moment, we are not using this slot. */
	53
	54	#define CATEGORYP(x) \
	55	(INTEGERP ((x)) && XFASTINT ((x)) >= 0x20 && XFASTINT ((x)) <= 0x7E)
	56
7e9d10c3 KS	57	#define CHECK_CATEGORY(x) \
7e9d10c3 KS	58	CHECK_TYPE (CATEGORYP (x), Qcategoryp, x)
4ed46869 KH	59
	60	#define XCATEGORY_SET XBOOL_VECTOR
	61
	62	#define CATEGORY_SET_P(x) \
	63	(BOOL_VECTOR_P ((x)) && (EMACS_INT) (XBOOL_VECTOR ((x))->size) == 128)
	64
	65	/* Return a new empty category set. */
	66	#define MAKE_CATEGORY_SET (Fmake_bool_vector (make_number (128), Qnil))
	67
	68	/* Make CATEGORY_SET includes (if VAL is t) or excludes (if VAL is
	69	nil) CATEGORY. */
	70	#define SET_CATEGORY_SET(category_set, category, val) \
	71	(Faset (category_set, category, val))
	72
7e9d10c3 KS	73	#define CHECK_CATEGORY_SET(x) \
7e9d10c3 KS	74	CHECK_TYPE (CATEGORY_SET_P (x), Qcategorysetp, x)
4ed46869 KH	75
	76	/* Return 1 if CATEGORY_SET contains CATEGORY, else return 0.
	77	The faster version of `!NILP (Faref (category_set, category))'. */
	78	#define CATEGORY_MEMBER(category, category_set) \
2e34157c RS	79	(XCATEGORY_SET (category_set)->data[(category) / 8] \
2e34157c RS	80	& (1 << ((category) % 8)))
4ed46869 KH	81
	82	/* Temporary internal variable used in macro CHAR_HAS_CATEGORY. */
	83	extern Lisp_Object _temp_category_set;
	84
	85	/* Return 1 if category set of CH contains CATEGORY, elt return 0. */
	86	#define CHAR_HAS_CATEGORY(ch, category) \
	87	(_temp_category_set = CATEGORY_SET (ch), \
	88	CATEGORY_MEMBER (category, _temp_category_set))
	89
	90	/* The standard category table is stored where it will automatically
	91	be used in all new buffers. */
	92	#define Vstandard_category_table buffer_defaults.category_table
	93
	94	/* Return the category set of character C in the current category table. */
	95	#ifdef __GNUC__
74d28e55 KH	96	#define CATEGORY_SET(c) \
	97	({ Lisp_Object table = current_buffer->category_table; \
	98	Lisp_Object temp; \
cecda314	99	if ((c) < CHAR_TABLE_SINGLE_BYTE_SLOTS) \
040df2c7	100	while (NILP (temp = XCHAR_TABLE (table)->contents[(unsigned char) c]) \
74d28e55 KH	101	&& NILP (temp = XCHAR_TABLE (table)->defalt)) \
	102	table = XCHAR_TABLE (table)->parent; \
	103	else \
759f9863	104	temp = Faref (table, make_number (c)); \
4ed46869 KH	105	temp; })
4ed46869 KH	106	#else
759f9863 KH	107	#define CATEGORY_SET(c) \
759f9863 KH	108	Faref (current_buffer->category_table, make_number (c))
177c0ea7	109	#endif
4ed46869 KH	110
	111	/* Return the doc string of CATEGORY in category table TABLE. */
	112	#define CATEGORY_DOCSTRING(table, category) \
ea625b14	113	XVECTOR (Fchar_table_extra_slot (table, make_number (0)))->contents[(category) - ' ']
4ed46869 KH	114
	115	/* Return the version number of category table TABLE. Not used for
	116	the moment. */
	117	#define CATEGORY_TABLE_VERSION (table) \
ea625b14	118	Fchar_table_extra_slot (table, make_number (1))
4ed46869 KH	119
	120	/* Return 1 if there is a word boundary between two word-constituent
	121	characters C1 and C2 if they appear in this order, else return 0.
	122	There is no word boundary between two word-constituent ASCII
	123	characters. */
	124	#define WORD_BOUNDARY_P(c1, c2) \
	125	(!(SINGLE_BYTE_CHAR_P (c1) && SINGLE_BYTE_CHAR_P (c2)) \
	126	&& word_boundary_p (c1, c2))
f78433b6 AS	127
f78433b6 AS	128	extern int word_boundary_p P_ ((int, int));
ab5796a9 MB	129
	130	/* arch-tag: 309dfe83-c3e2-4d22-8e81-faae5aece0ff
	131	(do not change this comment) */