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

/* Declarations having to do with GNU Emacs syntax tables.
   Copyright (C) 1985, 1993, 1994 Free Software Foundation, Inc.

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


extern Lisp_Object Qsyntax_table_p;
extern Lisp_Object Fsyntax_table_p (), Fsyntax_table (), Fset_syntax_table ();

/* The standard syntax table is stored where it will automatically
   be used in all new buffers.  */
#define Vstandard_syntax_table buffer_defaults.syntax_table

/* A syntax table is a chartable whose elements are cons cells
   (CODE+FLAGS . MATCHING-CHAR).  MATCHING-CHAR can be nil if the char
   is not a kind of parenthesis.

   The low 8 bits of CODE+FLAGS is a code, as follows:  */

enum syntaxcode
  {
    Swhitespace, /* for a whitespace character */
    Spunct,	 /* for random punctuation characters */
    Sword,	 /* for a word constituent */
    Ssymbol,	 /* symbol constituent but not word constituent */
    Sopen,	 /* for a beginning delimiter */
    Sclose,      /* for an ending delimiter */
    Squote,	 /* for a prefix character like Lisp ' */
    Sstring,	 /* for a string-grouping character like Lisp " */
    Smath,	 /* for delimiters like $ in Tex. */
    Sescape,	 /* for a character that begins a C-style escape */
    Scharquote,  /* for a character that quotes the following character */
    Scomment,    /* for a comment-starting character */
    Sendcomment, /* for a comment-ending character */
    Sinherit,    /* use the standard syntax table for this character */
    Smax	 /* Upper bound on codes that are meaningful */
  };

/* Set the syntax entry VAL for char C in table TABLE.  */

#define SET_RAW_SYNTAX_ENTRY(table, c, val)				\
  ((c) < CHAR_TABLE_SINGLE_BYTE_SLOTS					\
   ? (XCHAR_TABLE (table)->contents[(unsigned char) (c)] = (val))	\
   : Faset ((table), make_number (c), (val)))

/* Fetch the syntax entry for char C in syntax table TABLE.
   This macro is called only when C is less than CHAR_TABLE_ORDINARY_SLOTS.
   Do inheritance.  */

#ifdef __GNUC__
#define SYNTAX_ENTRY_FOLLOW_PARENT(table, c)			\
  ({ Lisp_Object tbl = table;					\
     Lisp_Object temp = XCHAR_TABLE (tbl)->contents[(c)];	\
     while (NILP (temp))					\
       {							\
	 tbl = XCHAR_TABLE (tbl)->parent;			\
	 if (NILP (tbl))					\
	   break;						\
	 temp = XCHAR_TABLE (tbl)->contents[(c)];		\
       }							\
     temp; })
#else
extern Lisp_Object syntax_temp;
extern Lisp_Object syntax_parent_lookup ();

#define SYNTAX_ENTRY_FOLLOW_PARENT(table, c)	    	\
  (syntax_temp = XCHAR_TABLE (table)->contents[(c)],	\
   (NILP (syntax_temp)				    	\
    ? syntax_parent_lookup (table, (c))		    	\
    : syntax_temp))
#endif

/* Fetch the syntax entry for char C in the current syntax table.
   This returns the whole entry (normally a cons cell).
   Do Inheritance.  */

#define SYNTAX_ENTRY(c)						\
  ((c) < CHAR_TABLE_SINGLE_BYTE_SLOTS				\
   ? SYNTAX_ENTRY_FOLLOW_PARENT (current_buffer->syntax_table,	\
				 (unsigned char) (c))		\
   : Faref (current_buffer->syntax_table, make_number ((c))))


/* Extract the information from the entry for character C
   in the current syntax table.  */

#ifdef __GNUC__
#define SYNTAX(c)							\
  ({ Lisp_Object temp;							\
     temp = SYNTAX_ENTRY (c);						\
     (CONSP (temp)							\
      ? (enum syntaxcode) (XINT (XCONS (temp)->car) & 0xff)		\
      : Swhitespace); })

#define SYNTAX_WITH_FLAGS(c)						\
  ({ Lisp_Object temp;							\
     temp = SYNTAX_ENTRY (c);						\
     (CONSP (temp)							\
      ? XINT (XCONS (temp)->car)					\
      : (int) Swhitespace); })

#define SYNTAX_MATCH(c)							\
  ({ Lisp_Object temp;							\
     temp = SYNTAX_ENTRY (c);						\
     (CONSP (temp)							\
      ? XINT (XCONS (temp)->cdr)					\
      : Qnil); })
#else
#define SYNTAX(c)							\
  (syntax_temp = SYNTAX_ENTRY ((c)),					\
   (CONSP (syntax_temp)							\
    ? (enum syntaxcode) (XINT (XCONS (syntax_temp)->car) & 0xff)	\
    : Swhitespace))

#define SYNTAX_WITH_FLAGS(c)						\
  (syntax_temp = SYNTAX_ENTRY ((c)),					\
   (CONSP (syntax_temp)							\
    ? XINT (XCONS (syntax_temp)->car)					\
    : (int) Swhitespace))

#define SYNTAX_MATCH(c)							\
  (syntax_temp = SYNTAX_ENTRY ((c)),					\
   (CONSP (syntax_temp)							\
    ? XINT (XCONS (syntax_temp)->cdr)					\
    : Qnil))
#endif

/* Then there are six single-bit flags that have the following meanings:
  1. This character is the first of a two-character comment-start sequence.
  2. This character is the second of a two-character comment-start sequence.
  3. This character is the first of a two-character comment-end sequence.
  4. This character is the second of a two-character comment-end sequence.
  5. This character is a prefix, for backward-prefix-chars.
  Note that any two-character sequence whose first character has flag 1
  and whose second character has flag 2 will be interpreted as a comment start.

  bit 6 is used to discriminate between two different comment styles.
  Languages such as C++ allow two orthogonal syntax start/end pairs
  and bit 6 is used to determine whether a comment-end or Scommentend
  ends style a or b. Comment start sequences can start style a or b.
  Style a is always the default.
  */

#define SYNTAX_COMSTART_FIRST(c) ((SYNTAX_WITH_FLAGS (c) >> 16) & 1)

#define SYNTAX_COMSTART_SECOND(c) ((SYNTAX_WITH_FLAGS (c) >> 17) & 1)

#define SYNTAX_COMEND_FIRST(c) ((SYNTAX_WITH_FLAGS (c) >> 18) & 1)

#define SYNTAX_COMEND_SECOND(c) ((SYNTAX_WITH_FLAGS (c) >> 19) & 1)

#define SYNTAX_PREFIX(c) ((SYNTAX_WITH_FLAGS (c) >> 20) & 1)

/* extract the comment style bit from the syntax table entry */
#define SYNTAX_COMMENT_STYLE(c) ((SYNTAX_WITH_FLAGS (c) >> 21) & 1)

/* This array, indexed by a character, contains the syntax code which that
 character signifies (as a char).  For example,
 (enum syntaxcode) syntax_spec_code['w'] is Sword. */

extern unsigned char syntax_spec_code[0400];

/* Indexed by syntax code, give the letter that describes it. */

extern char syntax_code_spec[14];
Commit	Line	Data
9889c728	1	/* Declarations having to do with GNU Emacs syntax tables.
3a22ee35	2	Copyright (C) 1985, 1993, 1994 Free Software Foundation, Inc.
9889c728 JB	3
	4	This file is part of GNU Emacs.
	5
	6	GNU Emacs is free software; you can redistribute it and/or modify
	7	it under the terms of the GNU General Public License as published by
7c938215	8	the Free Software Foundation; either version 2, or (at your option)
9889c728 JB	9	any later version.
	10
	11	GNU Emacs is distributed in the hope that it will be useful,
	12	but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	GNU General Public License for more details.
	15
	16	You should have received a copy of the GNU General Public License
	17	along with GNU Emacs; see the file COPYING. If not, write to
3b7ad313 EN	18	the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
3b7ad313 EN	19	Boston, MA 02111-1307, USA. */
9889c728 JB	20
	21
	22	extern Lisp_Object Qsyntax_table_p;
	23	extern Lisp_Object Fsyntax_table_p (), Fsyntax_table (), Fset_syntax_table ();
	24
	25	/* The standard syntax table is stored where it will automatically
	26	be used in all new buffers. */
	27	#define Vstandard_syntax_table buffer_defaults.syntax_table
	28
e46c910e RS	29	/* A syntax table is a chartable whose elements are cons cells
	30	(CODE+FLAGS . MATCHING-CHAR). MATCHING-CHAR can be nil if the char
	31	is not a kind of parenthesis.
9889c728	32
e46c910e	33	The low 8 bits of CODE+FLAGS is a code, as follows: */
9889c728 JB	34
	35	enum syntaxcode
	36	{
	37	Swhitespace, /* for a whitespace character */
	38	Spunct, /* for random punctuation characters */
	39	Sword, /* for a word constituent */
	40	Ssymbol, /* symbol constituent but not word constituent */
	41	Sopen, /* for a beginning delimiter */
	42	Sclose, /* for an ending delimiter */
	43	Squote, /* for a prefix character like Lisp ' */
	44	Sstring, /* for a string-grouping character like Lisp " */
	45	Smath, /* for delimiters like $ in Tex. */
	46	Sescape, /* for a character that begins a C-style escape */
	47	Scharquote, /* for a character that quotes the following character */
	48	Scomment, /* for a comment-starting character */
	49	Sendcomment, /* for a comment-ending character */
c8cdcb16	50	Sinherit, /* use the standard syntax table for this character */
9889c728 JB	51	Smax /* Upper bound on codes that are meaningful */
	52	};
	53
e0b8ff93	54	/* Set the syntax entry VAL for char C in table TABLE. */
e46c910e	55
0e35bfd8	56	#define SET_RAW_SYNTAX_ENTRY(table, c, val) \
9ca6ab7d	57	((c) < CHAR_TABLE_SINGLE_BYTE_SLOTS \
0e35bfd8 KH	58	? (XCHAR_TABLE (table)->contents[(unsigned char) (c)] = (val)) \
0e35bfd8 KH	59	: Faset ((table), make_number (c), (val)))
e0b8ff93 KH	60
	61	/* Fetch the syntax entry for char C in syntax table TABLE.
	62	This macro is called only when C is less than CHAR_TABLE_ORDINARY_SLOTS.
	63	Do inheritance. */
	64
	65	#ifdef __GNUC__
	66	#define SYNTAX_ENTRY_FOLLOW_PARENT(table, c) \
	67	({ Lisp_Object tbl = table; \
	68	Lisp_Object temp = XCHAR_TABLE (tbl)->contents[(c)]; \
	69	while (NILP (temp)) \
	70	{ \
	71	tbl = XCHAR_TABLE (tbl)->parent; \
	72	if (NILP (tbl)) \
	73	break; \
	74	temp = XCHAR_TABLE (tbl)->contents[(c)]; \
	75	} \
	76	temp; })
c8cdcb16	77	#else
e0b8ff93 KH	78	extern Lisp_Object syntax_temp;
e0b8ff93 KH	79	extern Lisp_Object syntax_parent_lookup ();
e46c910e	80
e0b8ff93 KH	81	#define SYNTAX_ENTRY_FOLLOW_PARENT(table, c) \
	82	(syntax_temp = XCHAR_TABLE (table)->contents[(c)], \
	83	(NILP (syntax_temp) \
	84	? syntax_parent_lookup (table, (c)) \
	85	: syntax_temp))
c8cdcb16	86	#endif
9889c728	87
e0b8ff93 KH	88	/* Fetch the syntax entry for char C in the current syntax table.
	89	This returns the whole entry (normally a cons cell).
	90	Do Inheritance. */
	91
0e35bfd8	92	#define SYNTAX_ENTRY(c) \
9ca6ab7d	93	((c) < CHAR_TABLE_SINGLE_BYTE_SLOTS \
0e35bfd8 KH	94	? SYNTAX_ENTRY_FOLLOW_PARENT (current_buffer->syntax_table, \
	95	(unsigned char) (c)) \
	96	: Faref (current_buffer->syntax_table, make_number ((c))))
	97
e0b8ff93	98
e46c910e	99	/* Extract the information from the entry for character C
e0b8ff93	100	in the current syntax table. */
c8cdcb16 RS	101
c8cdcb16 RS	102	#ifdef __GNUC__
e46c910e RS	103	#define SYNTAX(c) \
	104	({ Lisp_Object temp; \
	105	temp = SYNTAX_ENTRY (c); \
	106	(CONSP (temp) \
	107	? (enum syntaxcode) (XINT (XCONS (temp)->car) & 0xff) \
e0b8ff93	108	: Swhitespace); })
e46c910e RS	109
	110	#define SYNTAX_WITH_FLAGS(c) \
	111	({ Lisp_Object temp; \
	112	temp = SYNTAX_ENTRY (c); \
	113	(CONSP (temp) \
	114	? XINT (XCONS (temp)->car) \
e0b8ff93	115	: (int) Swhitespace); })
e46c910e RS	116
	117	#define SYNTAX_MATCH(c) \
	118	({ Lisp_Object temp; \
	119	temp = SYNTAX_ENTRY (c); \
	120	(CONSP (temp) \
	121	? XINT (XCONS (temp)->cdr) \
e0b8ff93	122	: Qnil); })
c8cdcb16	123	#else
e46c910e	124	#define SYNTAX(c) \
9d40ebd2	125	(syntax_temp = SYNTAX_ENTRY ((c)), \
e46c910e RS	126	(CONSP (syntax_temp) \
e46c910e RS	127	? (enum syntaxcode) (XINT (XCONS (syntax_temp)->car) & 0xff) \
e0b8ff93	128	: Swhitespace))
e46c910e RS	129
e46c910e RS	130	#define SYNTAX_WITH_FLAGS(c) \
9d40ebd2	131	(syntax_temp = SYNTAX_ENTRY ((c)), \
e46c910e RS	132	(CONSP (syntax_temp) \
e46c910e RS	133	? XINT (XCONS (syntax_temp)->car) \
e0b8ff93	134	: (int) Swhitespace))
e46c910e RS	135
e46c910e RS	136	#define SYNTAX_MATCH(c) \
9d40ebd2	137	(syntax_temp = SYNTAX_ENTRY ((c)), \
e46c910e RS	138	(CONSP (syntax_temp) \
e46c910e RS	139	? XINT (XCONS (syntax_temp)->cdr) \
e0b8ff93	140	: Qnil))
c8cdcb16	141	#endif
9889c728	142
a306d6f1	143	/* Then there are six single-bit flags that have the following meanings:
9889c728 JB	144	1. This character is the first of a two-character comment-start sequence.
	145	2. This character is the second of a two-character comment-start sequence.
	146	3. This character is the first of a two-character comment-end sequence.
	147	4. This character is the second of a two-character comment-end sequence.
	148	5. This character is a prefix, for backward-prefix-chars.
a306d6f1 RS	149	Note that any two-character sequence whose first character has flag 1
	150	and whose second character has flag 2 will be interpreted as a comment start.
	151
	152	bit 6 is used to discriminate between two different comment styles.
	153	Languages such as C++ allow two orthogonal syntax start/end pairs
	154	and bit 6 is used to determine whether a comment-end or Scommentend
	155	ends style a or b. Comment start sequences can start style a or b.
	156	Style a is always the default.
	157	*/
9889c728	158
e46c910e	159	#define SYNTAX_COMSTART_FIRST(c) ((SYNTAX_WITH_FLAGS (c) >> 16) & 1)
c8cdcb16	160
e46c910e	161	#define SYNTAX_COMSTART_SECOND(c) ((SYNTAX_WITH_FLAGS (c) >> 17) & 1)
c8cdcb16	162
e46c910e	163	#define SYNTAX_COMEND_FIRST(c) ((SYNTAX_WITH_FLAGS (c) >> 18) & 1)
c8cdcb16	164
e46c910e	165	#define SYNTAX_COMEND_SECOND(c) ((SYNTAX_WITH_FLAGS (c) >> 19) & 1)
c8cdcb16	166
e46c910e	167	#define SYNTAX_PREFIX(c) ((SYNTAX_WITH_FLAGS (c) >> 20) & 1)
9889c728	168
a306d6f1	169	/* extract the comment style bit from the syntax table entry */
e46c910e	170	#define SYNTAX_COMMENT_STYLE(c) ((SYNTAX_WITH_FLAGS (c) >> 21) & 1)
a306d6f1	171
9889c728 JB	172	/* This array, indexed by a character, contains the syntax code which that
	173	character signifies (as a char). For example,
	174	(enum syntaxcode) syntax_spec_code['w'] is Sword. */
	175
	176	extern unsigned char syntax_spec_code[0400];
	177
	178	/* Indexed by syntax code, give the letter that describes it. */
	179
c8cdcb16	180	extern char syntax_code_spec[14];