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

/* Declarations having to do with GNU Emacs syntax tables.
   Copyright (C) 1985, 93, 94, 97, 1998 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 void update_syntax_table P_ ((int, int, int, Lisp_Object));

/* 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 */
    Scomment_fence, /* Starts/ends comment which is delimited on the
		       other side by any char with the same syntaxcode.  */
    Sstring_fence,  /* Starts/ends string which is delimited on the
		       other side by any char with the same syntaxcode.  */
    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 P_ ((Lisp_Object, int));

#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

/* SYNTAX_ENTRY fetches the information from the entry for character C
   in syntax table TABLE, or from globally kept data (gl_state).  
   Does inheritance.  */
/* CURRENT_SYNTAX_TABLE gives the syntax table valid for current
   position, it is either the buffer's syntax table, or syntax table
   found in text properties.  */

#ifdef SYNTAX_ENTRY_VIA_PROPERTY
#  define SYNTAX_ENTRY(c)                                             \
    (gl_state.use_global ? gl_state.global_code : SYNTAX_ENTRY_INT (c))
#  define CURRENT_SYNTAX_TABLE gl_state.current_syntax_table
#else
#  define SYNTAX_ENTRY SYNTAX_ENTRY_INT
#  define CURRENT_SYNTAX_TABLE current_buffer->syntax_table
#endif

#define SYNTAX_ENTRY_INT(c)						\
  ((c) < CHAR_TABLE_SINGLE_BYTE_SLOTS				\
   ? SYNTAX_ENTRY_FOLLOW_PARENT (CURRENT_SYNTAX_TABLE,	\
				 (unsigned char) (c))		\
   : Faref (CURRENT_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)							\
      ? 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)							\
    ? 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.
  */

/* These macros extract a particular flag for a given character.  */

#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)

#define SYNTAX_COMMENT_STYLE(c) ((SYNTAX_WITH_FLAGS (c) >> 21) & 1)

/* These macros extract specific flags from an integer
   that holds the syntax code and the flags.  */

#define SYNTAX_FLAGS_COMSTART_FIRST(flags) (((flags) >> 16) & 1)

#define SYNTAX_FLAGS_COMSTART_SECOND(flags) (((flags) >> 17) & 1)

#define SYNTAX_FLAGS_COMEND_FIRST(flags) (((flags) >> 18) & 1)

#define SYNTAX_FLAGS_COMEND_SECOND(flags) (((flags) >> 19) & 1)

#define SYNTAX_FLAGS_PREFIX(flags) (((flags) >> 20) & 1)

#define SYNTAX_FLAGS_COMMENT_STYLE(flags) (((flags) >> 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[16];

/* Convert the byte offset BYTEPOS into a character position,
   for the object recorded in gl_state with SETUP_SYNTAX_TABLE_FOR_OBJECT.

   The value is meant for use in the UPDATE_SYNTAX_TABLE... macros.
   These macros do nothing when parse_sexp_lookup_properties is 0,
   so we return 0 in that case, for speed.  */

#define SYNTAX_TABLE_BYTE_TO_CHAR(bytepos)				\
  (! parse_sexp_lookup_properties					\
   ? 0									\
   : STRINGP (gl_state.object)						\
   ? string_byte_to_char (gl_state.object, (bytepos))			\
   : BUFFERP (gl_state.object)						\
   ? buf_bytepos_to_charpos (XBUFFER (gl_state.object),			\
			     (bytepos) + BUF_BEGV_BYTE (XBUFFER (gl_state.object)) - 1) - BUF_BEGV (XBUFFER (gl_state.object)) + 1	\
   : NILP (gl_state.object)						\
   ? BYTE_TO_CHAR ((bytepos) + BEGV_BYTE - 1) - BEGV + 1		\
   : (bytepos))

/* Make syntax table state (gl_state) good for CHARPOS, assuming it is
   currently good for a position before CHARPOS.  */

#define UPDATE_SYNTAX_TABLE_FORWARD(charpos)			\
  (parse_sexp_lookup_properties					\
   && (charpos) >= gl_state.e_property				\
   ? (update_syntax_table ((charpos) + gl_state.offset, 1, 0,	\
			   gl_state.object),			\
      1)							\
   : 0)

/* Make syntax table state (gl_state) good for CHARPOS, assuming it is
   currently good for a position after CHARPOS.  */

#define UPDATE_SYNTAX_TABLE_BACKWARD(charpos)			\
  (parse_sexp_lookup_properties					\
   && (charpos) <= gl_state.b_property				\
   ? (update_syntax_table ((charpos) + gl_state.offset, -1, 0,	\
			   gl_state.object),			\
      1)							\
   : 0)

/* Make syntax table good for CHARPOS.  */

#define UPDATE_SYNTAX_TABLE(charpos)				\
  (parse_sexp_lookup_properties					\
   && (charpos) <= gl_state.b_property				\
   ? (update_syntax_table ((charpos) + gl_state.offset, -1, 0,	\
			   gl_state.object),			\
      1)							\
   : (parse_sexp_lookup_properties				\
      && (charpos) >= gl_state.e_property			\
      ? (update_syntax_table ((charpos) + gl_state.offset, 1, 0,\
			      gl_state.object),			\
	 1)							\
      : 0))

/* This macro should be called with FROM at the start of forward
   search, or after the last position of the backward search.  It
   makes sure that the first char is picked up with correct table, so
   one does not need to call UPDATE_SYNTAX_TABLE immediately after the
   call. 
   Sign of COUNT gives the direction of the search.
 */

#define SETUP_SYNTAX_TABLE(FROM, COUNT)					\
if (1)									\
  {									\
    gl_state.b_property = BEGV - 1;					\
    gl_state.e_property = ZV + 1;					\
    gl_state.object = Qnil;						\
    gl_state.use_global = 0;						\
    gl_state.offset = 0;						\
    gl_state.current_syntax_table = current_buffer->syntax_table;	\
    if (parse_sexp_lookup_properties)					\
      if ((COUNT) > 0 || (FROM) > BEGV)					\
        update_syntax_table ((COUNT) > 0 ? (FROM) : (FROM) - 1, (COUNT),\
			     1, Qnil);					\
  }									\
else

/* Same as above, but in OBJECT.  If OBJECT is nil, use current buffer.
   If it is t, ignore properties altogether.

   This is meant for regex.c to use.  For buffers, regex.c passes arguments
   to the UPDATE_SYNTAX_TABLE macros which are relative to BEGV.
   So if it is a buffer, we set the offset field to BEGV.  */

#define SETUP_SYNTAX_TABLE_FOR_OBJECT(OBJECT, FROM, COUNT)		\
if (1)									\
  {									\
    gl_state.object = (OBJECT);						\
    if (BUFFERP (gl_state.object))					\
      {									\
	struct buffer *buf = XBUFFER (gl_state.object);			\
	gl_state.b_property = 0;					\
	gl_state.e_property = BUF_ZV (buf) - BUF_BEGV (buf) + 1;	\
	gl_state.offset = BUF_BEGV (buf) - 1;				\
      }									\
    else if (NILP (gl_state.object))					\
      {									\
	gl_state.b_property = 0;					\
	gl_state.e_property = ZV - BEGV + 1;				\
	gl_state.offset = BEGV - 1;					\
      }									\
    else if (EQ (gl_state.object, Qt))					\
      {									\
	gl_state.b_property = - 1;					\
	gl_state.e_property = 1500000000;				\
	gl_state.offset = 0;						\
      }									\
    else								\
      {									\
	gl_state.b_property = -1;					\
	gl_state.e_property = 1 + XSTRING (gl_state.object)->size;	\
	gl_state.offset = 0;						\
      }									\
    gl_state.use_global = 0;						\
    gl_state.current_syntax_table = current_buffer->syntax_table;	\
    if (parse_sexp_lookup_properties)					\
      update_syntax_table (((FROM) + gl_state.offset			\
			    + (COUNT > 0 ? 0 :  -1)),			\
			   COUNT, 1, gl_state.object);			\
  }									\
else

struct gl_state_s
{
  Lisp_Object object;			/* The object we are scanning. */
  int start;				/* Where to stop. */
  int stop;				/* Where to stop. */
  int use_global;			/* Whether to use global_code
					   or c_s_t. */
  Lisp_Object global_code;		/* Syntax code of current char. */
  Lisp_Object current_syntax_table;	/* Syntax table for current pos. */
  Lisp_Object old_prop;			/* Syntax-table prop at prev pos. */
  int b_property;			/* Last index where c_s_t is 
					   not valid. */
  int e_property;			/* First index where c_s_t is
					   not valid. */
  INTERVAL forward_i;			/* Where to start lookup on forward */
  INTERVAL backward_i;			/* or backward movement.  The
					   data in c_s_t is valid
					   between these intervals,
					   and possibly at the
					   intervals too, depending
					   on: */
  /* Offset for positions specified to UPDATE_SYNTAX_TABLE.  */
  int offset;
  char left_ok;
  char right_ok;
};

extern struct gl_state_s gl_state;
extern int parse_sexp_lookup_properties;
extern INTERVAL interval_of P_ ((int, Lisp_Object));

extern int scan_words P_ ((int, int));
Commit	Line	Data
9889c728	1	/* Declarations having to do with GNU Emacs syntax tables.
4a2f9c6a	2	Copyright (C) 1985, 93, 94, 97, 1998 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;
4c571d09	23	extern void update_syntax_table P_ ((int, int, int, Lisp_Object));
9889c728 JB	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 " */
5eea1c5a	45	Smath, /* for delimiters like $ in Tex. */
9889c728 JB	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 */
5eea1c5a	51	Scomment_fence, /* Starts/ends comment which is delimited on the
47ab3db5	52	other side by any char with the same syntaxcode. */
5eea1c5a	53	Sstring_fence, /* Starts/ends string which is delimited on the
47ab3db5	54	other side by any char with the same syntaxcode. */
9889c728 JB	55	Smax /* Upper bound on codes that are meaningful */
	56	};
	57
e0b8ff93	58	/* Set the syntax entry VAL for char C in table TABLE. */
e46c910e	59
0e35bfd8	60	#define SET_RAW_SYNTAX_ENTRY(table, c, val) \
9ca6ab7d	61	((c) < CHAR_TABLE_SINGLE_BYTE_SLOTS \
0e35bfd8 KH	62	? (XCHAR_TABLE (table)->contents[(unsigned char) (c)] = (val)) \
0e35bfd8 KH	63	: Faset ((table), make_number (c), (val)))
e0b8ff93 KH	64
	65	/* Fetch the syntax entry for char C in syntax table TABLE.
	66	This macro is called only when C is less than CHAR_TABLE_ORDINARY_SLOTS.
	67	Do inheritance. */
	68
	69	#ifdef __GNUC__
	70	#define SYNTAX_ENTRY_FOLLOW_PARENT(table, c) \
	71	({ Lisp_Object tbl = table; \
	72	Lisp_Object temp = XCHAR_TABLE (tbl)->contents[(c)]; \
	73	while (NILP (temp)) \
	74	{ \
	75	tbl = XCHAR_TABLE (tbl)->parent; \
	76	if (NILP (tbl)) \
	77	break; \
	78	temp = XCHAR_TABLE (tbl)->contents[(c)]; \
	79	} \
	80	temp; })
c8cdcb16	81	#else
e0b8ff93	82	extern Lisp_Object syntax_temp;
4c571d09	83	extern Lisp_Object syntax_parent_lookup P_ ((Lisp_Object, int));
e46c910e	84
e0b8ff93 KH	85	#define SYNTAX_ENTRY_FOLLOW_PARENT(table, c) \
	86	(syntax_temp = XCHAR_TABLE (table)->contents[(c)], \
	87	(NILP (syntax_temp) \
	88	? syntax_parent_lookup (table, (c)) \
	89	: syntax_temp))
c8cdcb16	90	#endif
9889c728	91
5eea1c5a RS	92	/* SYNTAX_ENTRY fetches the information from the entry for character C
	93	in syntax table TABLE, or from globally kept data (gl_state).
	94	Does inheritance. */
	95	/* CURRENT_SYNTAX_TABLE gives the syntax table valid for current
	96	position, it is either the buffer's syntax table, or syntax table
	97	found in text properties. */
	98
	99	#ifdef SYNTAX_ENTRY_VIA_PROPERTY
	100	# define SYNTAX_ENTRY(c) \
	101	(gl_state.use_global ? gl_state.global_code : SYNTAX_ENTRY_INT (c))
	102	# define CURRENT_SYNTAX_TABLE gl_state.current_syntax_table
	103	#else
	104	# define SYNTAX_ENTRY SYNTAX_ENTRY_INT
	105	# define CURRENT_SYNTAX_TABLE current_buffer->syntax_table
	106	#endif
e0b8ff93	107
5eea1c5a	108	#define SYNTAX_ENTRY_INT(c) \
9ca6ab7d	109	((c) < CHAR_TABLE_SINGLE_BYTE_SLOTS \
5eea1c5a	110	? SYNTAX_ENTRY_FOLLOW_PARENT (CURRENT_SYNTAX_TABLE, \
0e35bfd8	111	(unsigned char) (c)) \
5eea1c5a	112	: Faref (CURRENT_SYNTAX_TABLE, make_number ((c))))
e0b8ff93	113
e46c910e	114	/* Extract the information from the entry for character C
e0b8ff93	115	in the current syntax table. */
c8cdcb16 RS	116
c8cdcb16 RS	117	#ifdef __GNUC__
e46c910e RS	118	#define SYNTAX(c) \
	119	({ Lisp_Object temp; \
	120	temp = SYNTAX_ENTRY (c); \
	121	(CONSP (temp) \
	122	? (enum syntaxcode) (XINT (XCONS (temp)->car) & 0xff) \
e0b8ff93	123	: Swhitespace); })
e46c910e RS	124
	125	#define SYNTAX_WITH_FLAGS(c) \
	126	({ Lisp_Object temp; \
	127	temp = SYNTAX_ENTRY (c); \
	128	(CONSP (temp) \
	129	? XINT (XCONS (temp)->car) \
e0b8ff93	130	: (int) Swhitespace); })
e46c910e RS	131
	132	#define SYNTAX_MATCH(c) \
	133	({ Lisp_Object temp; \
	134	temp = SYNTAX_ENTRY (c); \
	135	(CONSP (temp) \
2e34157c	136	? XCONS (temp)->cdr \
e0b8ff93	137	: Qnil); })
c8cdcb16	138	#else
e46c910e	139	#define SYNTAX(c) \
9d40ebd2	140	(syntax_temp = SYNTAX_ENTRY ((c)), \
e46c910e RS	141	(CONSP (syntax_temp) \
e46c910e RS	142	? (enum syntaxcode) (XINT (XCONS (syntax_temp)->car) & 0xff) \
e0b8ff93	143	: Swhitespace))
e46c910e RS	144
e46c910e RS	145	#define SYNTAX_WITH_FLAGS(c) \
9d40ebd2	146	(syntax_temp = SYNTAX_ENTRY ((c)), \
e46c910e RS	147	(CONSP (syntax_temp) \
e46c910e RS	148	? XINT (XCONS (syntax_temp)->car) \
e0b8ff93	149	: (int) Swhitespace))
e46c910e RS	150
e46c910e RS	151	#define SYNTAX_MATCH(c) \
9d40ebd2	152	(syntax_temp = SYNTAX_ENTRY ((c)), \
e46c910e	153	(CONSP (syntax_temp) \
2e34157c	154	? XCONS (syntax_temp)->cdr \
e0b8ff93	155	: Qnil))
c8cdcb16	156	#endif
9889c728	157
a306d6f1	158	/* Then there are six single-bit flags that have the following meanings:
9889c728 JB	159	1. This character is the first of a two-character comment-start sequence.
	160	2. This character is the second of a two-character comment-start sequence.
	161	3. This character is the first of a two-character comment-end sequence.
	162	4. This character is the second of a two-character comment-end sequence.
	163	5. This character is a prefix, for backward-prefix-chars.
a306d6f1 RS	164	Note that any two-character sequence whose first character has flag 1
	165	and whose second character has flag 2 will be interpreted as a comment start.
	166
	167	bit 6 is used to discriminate between two different comment styles.
	168	Languages such as C++ allow two orthogonal syntax start/end pairs
	169	and bit 6 is used to determine whether a comment-end or Scommentend
5eea1c5a	170	ends style a or b. Comment start sequences can start style a or b.
a306d6f1 RS	171	Style a is always the default.
a306d6f1 RS	172	*/
9889c728	173
98bcfee8 RS	174	/* These macros extract a particular flag for a given character. */
98bcfee8 RS	175
e46c910e	176	#define SYNTAX_COMSTART_FIRST(c) ((SYNTAX_WITH_FLAGS (c) >> 16) & 1)
c8cdcb16	177
e46c910e	178	#define SYNTAX_COMSTART_SECOND(c) ((SYNTAX_WITH_FLAGS (c) >> 17) & 1)
c8cdcb16	179
e46c910e	180	#define SYNTAX_COMEND_FIRST(c) ((SYNTAX_WITH_FLAGS (c) >> 18) & 1)
c8cdcb16	181
e46c910e	182	#define SYNTAX_COMEND_SECOND(c) ((SYNTAX_WITH_FLAGS (c) >> 19) & 1)
c8cdcb16	183
e46c910e	184	#define SYNTAX_PREFIX(c) ((SYNTAX_WITH_FLAGS (c) >> 20) & 1)
9889c728	185
e46c910e	186	#define SYNTAX_COMMENT_STYLE(c) ((SYNTAX_WITH_FLAGS (c) >> 21) & 1)
a306d6f1	187
98bcfee8 RS	188	/* These macros extract specific flags from an integer
	189	that holds the syntax code and the flags. */
	190
	191	#define SYNTAX_FLAGS_COMSTART_FIRST(flags) (((flags) >> 16) & 1)
	192
	193	#define SYNTAX_FLAGS_COMSTART_SECOND(flags) (((flags) >> 17) & 1)
	194
	195	#define SYNTAX_FLAGS_COMEND_FIRST(flags) (((flags) >> 18) & 1)
	196
	197	#define SYNTAX_FLAGS_COMEND_SECOND(flags) (((flags) >> 19) & 1)
	198
	199	#define SYNTAX_FLAGS_PREFIX(flags) (((flags) >> 20) & 1)
	200
	201	#define SYNTAX_FLAGS_COMMENT_STYLE(flags) (((flags) >> 21) & 1)
	202
9889c728 JB	203	/* This array, indexed by a character, contains the syntax code which that
9889c728 JB	204	character signifies (as a char). For example,
5eea1c5a	205	(enum syntaxcode) syntax_spec_code['w'] is Sword. */
9889c728 JB	206
	207	extern unsigned char syntax_spec_code[0400];
	208
5eea1c5a RS	209	/* Indexed by syntax code, give the letter that describes it. */
	210
	211	extern char syntax_code_spec[16];
	212
c292db29	213	/* Convert the byte offset BYTEPOS into a character position,
2f16e7fd RS	214	for the object recorded in gl_state with SETUP_SYNTAX_TABLE_FOR_OBJECT.
	215
	216	The value is meant for use in the UPDATE_SYNTAX_TABLE... macros.
	217	These macros do nothing when parse_sexp_lookup_properties is 0,
	218	so we return 0 in that case, for speed. */
c292db29 RS	219
c292db29 RS	220	#define SYNTAX_TABLE_BYTE_TO_CHAR(bytepos) \
2f16e7fd RS	221	(! parse_sexp_lookup_properties \
	222	? 0 \
	223	: STRINGP (gl_state.object) \
c292db29 RS	224	? string_byte_to_char (gl_state.object, (bytepos)) \
c292db29 RS	225	: BUFFERP (gl_state.object) \
f79b4b7e KH	226	? buf_bytepos_to_charpos (XBUFFER (gl_state.object), \
f79b4b7e KH	227	(bytepos) + BUF_BEGV_BYTE (XBUFFER (gl_state.object)) - 1) - BUF_BEGV (XBUFFER (gl_state.object)) + 1 \
c292db29	228	: NILP (gl_state.object) \
f79b4b7e	229	? BYTE_TO_CHAR ((bytepos) + BEGV_BYTE - 1) - BEGV + 1 \
c292db29 RS	230	: (bytepos))
c292db29 RS	231
f79b4b7e KH	232	/* Make syntax table state (gl_state) good for CHARPOS, assuming it is
f79b4b7e KH	233	currently good for a position before CHARPOS. */
5eea1c5a	234
f79b4b7e	235	#define UPDATE_SYNTAX_TABLE_FORWARD(charpos) \
2f16e7fd	236	(parse_sexp_lookup_properties \
f79b4b7e KH	237	&& (charpos) >= gl_state.e_property \
f79b4b7e KH	238	? (update_syntax_table ((charpos) + gl_state.offset, 1, 0, \
c292db29 RS	239	gl_state.object), \
	240	1) \
	241	: 0)
5eea1c5a	242
f79b4b7e KH	243	/* Make syntax table state (gl_state) good for CHARPOS, assuming it is
f79b4b7e KH	244	currently good for a position after CHARPOS. */
5eea1c5a	245
f79b4b7e	246	#define UPDATE_SYNTAX_TABLE_BACKWARD(charpos) \
2f16e7fd	247	(parse_sexp_lookup_properties \
f79b4b7e KH	248	&& (charpos) <= gl_state.b_property \
f79b4b7e KH	249	? (update_syntax_table ((charpos) + gl_state.offset, -1, 0, \
c292db29 RS	250	gl_state.object), \
	251	1) \
	252	: 0)
e2d8d746	253
f79b4b7e	254	/* Make syntax table good for CHARPOS. */
e2d8d746	255
f79b4b7e	256	#define UPDATE_SYNTAX_TABLE(charpos) \
2f16e7fd	257	(parse_sexp_lookup_properties \
f79b4b7e KH	258	&& (charpos) <= gl_state.b_property \
f79b4b7e KH	259	? (update_syntax_table ((charpos) + gl_state.offset, -1, 0, \
c292db29 RS	260	gl_state.object), \
c292db29 RS	261	1) \
2f16e7fd	262	: (parse_sexp_lookup_properties \
f79b4b7e KH	263	&& (charpos) >= gl_state.e_property \
f79b4b7e KH	264	? (update_syntax_table ((charpos) + gl_state.offset, 1, 0,\
c292db29 RS	265	gl_state.object), \
	266	1) \
	267	: 0))
5eea1c5a RS	268
	269	/* This macro should be called with FROM at the start of forward
	270	search, or after the last position of the backward search. It
	271	makes sure that the first char is picked up with correct table, so
	272	one does not need to call UPDATE_SYNTAX_TABLE immediately after the
	273	call.
	274	Sign of COUNT gives the direction of the search.
	275	*/
	276
c292db29	277	#define SETUP_SYNTAX_TABLE(FROM, COUNT) \
2f16e7fd RS	278	if (1) \
	279	{ \
	280	gl_state.b_property = BEGV - 1; \
	281	gl_state.e_property = ZV + 1; \
	282	gl_state.object = Qnil; \
	283	gl_state.use_global = 0; \
	284	gl_state.offset = 0; \
	285	gl_state.current_syntax_table = current_buffer->syntax_table; \
	286	if (parse_sexp_lookup_properties) \
9b9794f0 RS	287	if ((COUNT) > 0 \|\| (FROM) > BEGV) \
	288	update_syntax_table ((COUNT) > 0 ? (FROM) : (FROM) - 1, (COUNT),\
	289	1, Qnil); \
2f16e7fd RS	290	} \
2f16e7fd RS	291	else
5eea1c5a RS	292
5eea1c5a RS	293	/* Same as above, but in OBJECT. If OBJECT is nil, use current buffer.
e2d8d746 RS	294	If it is t, ignore properties altogether.
	295
	296	This is meant for regex.c to use. For buffers, regex.c passes arguments
	297	to the UPDATE_SYNTAX_TABLE macros which are relative to BEGV.
4bbd5bc3	298	So if it is a buffer, we set the offset field to BEGV. */
5eea1c5a	299
c292db29	300	#define SETUP_SYNTAX_TABLE_FOR_OBJECT(OBJECT, FROM, COUNT) \
4bbd5bc3 RS	301	if (1) \
4bbd5bc3 RS	302	{ \
c292db29 RS	303	gl_state.object = (OBJECT); \
	304	if (BUFFERP (gl_state.object)) \
	305	{ \
	306	struct buffer *buf = XBUFFER (gl_state.object); \
1d1293dd KH	307	gl_state.b_property = 0; \
1d1293dd KH	308	gl_state.e_property = BUF_ZV (buf) - BUF_BEGV (buf) + 1; \
c292db29 RS	309	gl_state.offset = BUF_BEGV (buf) - 1; \
	310	} \
	311	else if (NILP (gl_state.object)) \
4bbd5bc3	312	{ \
1d1293dd KH	313	gl_state.b_property = 0; \
1d1293dd KH	314	gl_state.e_property = ZV - BEGV + 1; \
4bbd5bc3 RS	315	gl_state.offset = BEGV - 1; \
4bbd5bc3 RS	316	} \
c292db29	317	else if (EQ (gl_state.object, Qt)) \
4bbd5bc3 RS	318	{ \
	319	gl_state.b_property = - 1; \
	320	gl_state.e_property = 1500000000; \
	321	gl_state.offset = 0; \
	322	} \
	323	else \
	324	{ \
	325	gl_state.b_property = -1; \
c292db29	326	gl_state.e_property = 1 + XSTRING (gl_state.object)->size; \
4bbd5bc3 RS	327	gl_state.offset = 0; \
	328	} \
	329	gl_state.use_global = 0; \
	330	gl_state.current_syntax_table = current_buffer->syntax_table; \
	331	if (parse_sexp_lookup_properties) \
f79b4b7e	332	update_syntax_table (((FROM) + gl_state.offset \
c292db29 RS	333	+ (COUNT > 0 ? 0 : -1)), \
c292db29 RS	334	COUNT, 1, gl_state.object); \
4bbd5bc3 RS	335	} \
4bbd5bc3 RS	336	else
5eea1c5a RS	337
	338	struct gl_state_s
	339	{
c292db29	340	Lisp_Object object; /* The object we are scanning. */
5eea1c5a RS	341	int start; /* Where to stop. */
	342	int stop; /* Where to stop. */
	343	int use_global; /* Whether to use global_code
	344	or c_s_t. */
	345	Lisp_Object global_code; /* Syntax code of current char. */
	346	Lisp_Object current_syntax_table; /* Syntax table for current pos. */
	347	Lisp_Object old_prop; /* Syntax-table prop at prev pos. */
	348	int b_property; /* Last index where c_s_t is
	349	not valid. */
	350	int e_property; /* First index where c_s_t is
	351	not valid. */
	352	INTERVAL forward_i; /* Where to start lookup on forward */
	353	INTERVAL backward_i; /* or backward movement. The
	354	data in c_s_t is valid
	355	between these intervals,
	356	and possibly at the
	357	intervals too, depending
	358	on: */
e2d8d746 RS	359	/* Offset for positions specified to UPDATE_SYNTAX_TABLE. */
e2d8d746 RS	360	int offset;
5eea1c5a RS	361	char left_ok;
	362	char right_ok;
	363	};
	364
	365	extern struct gl_state_s gl_state;
	366	extern int parse_sexp_lookup_properties;
4c571d09 AS	367	extern INTERVAL interval_of P_ ((int, Lisp_Object));
	368
	369	extern int scan_words P_ ((int, int));