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

/* Declarations having to do with Emacs category tables.
   Copyright (C) 1995 Electrotechnical Laboratory, JAPAN.
     Licensed to the Free Software Foundation.

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., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, 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, i)						\
  do {									\
    if (!CATEGORYP ((x))) x = wrong_type_argument (Qcategoryp, (x));	\
  } while (0)

#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, i)					   \
  do {									   \
    if (!CATEGORY_SET_P ((x))) x = wrong_type_argument (Qcategorysetp, (x)); \
  } while (0)

/* 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 (COMPOSITE_CHAR_P (c)			     \
				  ? cmpchar_component (c, 0) : (c)));	     \
     temp; })
#else
#define CATEGORY_SET(c)							     \
  ((c) < CHAR_TABLE_SINGLE_BYTE_SLOTS					     \
   ? Faref (current_buffer->category_table, make_number ((unsigned char) c)) \
   : Faref (current_buffer->category_table,				     \
	    make_number (COMPOSITE_CHAR_P (c)				     \
			 ? cmpchar_component ((c), 0) : (c))))
#endif   

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