/* Declarations having to do with GNU Emacs syntax tables.
-Copyright (C) 1985, 1993-1994, 1997-1998, 2001-2012
- Free Software Foundation, Inc.
+Copyright (C) 1985, 1993-1994, 1997-1998, 2001-2016 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 3 of the License, or
-(at your option) any later version.
+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
You should have received a copy of the GNU General Public License
along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
+#ifndef EMACS_SYNTAX_H
+#define EMACS_SYNTAX_H
-extern void update_syntax_table (EMACS_INT, EMACS_INT, int, Lisp_Object);
+#include "buffer.h"
+#include "lisp.h"
+
+INLINE_HEADER_BEGIN
+
+extern void update_syntax_table (ptrdiff_t, EMACS_INT, bool, Lisp_Object);
+extern void update_syntax_table_forward (ptrdiff_t, bool, Lisp_Object);
/* The standard syntax table is stored where it will automatically
be used in all new buffers. */
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 */
+ 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) \
- CHAR_TABLE_SET ((table), c, (val))
-/* Set the syntax entry VAL for char-range RANGE in table TABLE.
- RANGE is a cons (FROM . TO) specifying the range of characters. */
+struct gl_state_s
+{
+ Lisp_Object object; /* The object we are scanning. */
+ ptrdiff_t start; /* Where to stop. */
+ ptrdiff_t stop; /* Where to stop. */
+ bool 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. */
+ ptrdiff_t b_property; /* First index where c_s_t is valid. */
+ ptrdiff_t e_property; /* First index where c_s_t is
+ not valid. */
+ bool e_property_truncated; /* true if e_property if was truncated
+ by parse_sexp_propertize_done. */
+ 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. */
+ ptrdiff_t offset;
+};
-#define SET_RAW_SYNTAX_ENTRY_RANGE(table, range, val) \
- Fset_char_table_range ((table), (range), (val))
+extern struct gl_state_s gl_state;
-/* SYNTAX_ENTRY fetches the information from the entry for character C
- in syntax table TABLE, or from globally kept data (gl_state).
+/* Fetch the information from the entry for character C
+ in the current buffer's syntax table,
+ or (if VIA_PROPERTY) 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 BVAR (current_buffer, syntax_table)
-#endif
-#define SYNTAX_ENTRY_INT(c) CHAR_TABLE_REF (CURRENT_SYNTAX_TABLE, (c))
+INLINE Lisp_Object
+syntax_property_entry (int c, bool via_property)
+{
+ if (via_property)
+ return (gl_state.use_global
+ ? gl_state.global_code
+ : CHAR_TABLE_REF (gl_state.current_syntax_table, c));
+ return CHAR_TABLE_REF (BVAR (current_buffer, syntax_table), c);
+}
+INLINE Lisp_Object
+SYNTAX_ENTRY (int c)
+{
+ return syntax_property_entry (c, false);
+}
/* Extract the information from the entry for character C
in the current syntax table. */
-#ifdef __GNUC__
-#define SYNTAX(c) \
- ({ Lisp_Object _syntax_temp; \
- _syntax_temp = SYNTAX_ENTRY (c); \
- (CONSP (_syntax_temp) \
- ? (enum syntaxcode) (XINT (XCAR (_syntax_temp)) & 0xff) \
- : Swhitespace); })
-
-#define SYNTAX_WITH_FLAGS(c) \
- ({ Lisp_Object _syntax_temp; \
- _syntax_temp = SYNTAX_ENTRY (c); \
- (CONSP (_syntax_temp) \
- ? XINT (XCAR (_syntax_temp)) \
- : (int) Swhitespace); })
-
-#define SYNTAX_MATCH(c) \
- ({ Lisp_Object _syntax_temp; \
- _syntax_temp = SYNTAX_ENTRY (c); \
- (CONSP (_syntax_temp) \
- ? XCDR (_syntax_temp) \
- : Qnil); })
-#else
-extern Lisp_Object syntax_temp;
-#define SYNTAX(c) \
- (syntax_temp = SYNTAX_ENTRY ((c)), \
- (CONSP (syntax_temp) \
- ? (enum syntaxcode) (XINT (XCAR (syntax_temp)) & 0xff) \
- : Swhitespace))
-
-#define SYNTAX_WITH_FLAGS(c) \
- (syntax_temp = SYNTAX_ENTRY ((c)), \
- (CONSP (syntax_temp) \
- ? XINT (XCAR (syntax_temp)) \
- : (int) Swhitespace))
-
-#define SYNTAX_MATCH(c) \
- (syntax_temp = SYNTAX_ENTRY ((c)), \
- (CONSP (syntax_temp) \
- ? XCDR (syntax_temp) \
- : Qnil))
-#endif
+INLINE int
+syntax_property_with_flags (int c, bool via_property)
+{
+ Lisp_Object ent = syntax_property_entry (c, via_property);
+ return CONSP (ent) ? XINT (XCAR (ent)) : Swhitespace;
+}
+INLINE int
+SYNTAX_WITH_FLAGS (int c)
+{
+ return syntax_property_with_flags (c, false);
+}
+
+INLINE enum syntaxcode
+syntax_property (int c, bool via_property)
+{
+ return syntax_property_with_flags (c, via_property) & 0xff;
+}
+INLINE enum syntaxcode
+SYNTAX (int c)
+{
+ return syntax_property (c, false);
+}
/* Whether the syntax of the character C has the prefix flag set. */
-extern int syntax_prefix_flag_p (int c);
+extern bool syntax_prefix_flag_p (int c);
-/* 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. */
+/* This array, indexed by a character less than 256, contains the
+ syntax code which that character signifies (as an unsigned char).
+ For example, syntax_spec_code['w'] == Sword. */
-extern unsigned char syntax_spec_code[0400];
+extern unsigned char const syntax_spec_code[0400];
/* Indexed by syntax code, give the letter that describes it. */
-extern char syntax_code_spec[16];
+extern char const 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))
+ The value is meant for use in code that does nothing when
+ parse_sexp_lookup_properties is false, so return 0 in that case,
+ for speed. */
+
+INLINE ptrdiff_t
+SYNTAX_TABLE_BYTE_TO_CHAR (ptrdiff_t bytepos)
+{
+ return (! 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)
+INLINE void
+UPDATE_SYNTAX_TABLE_FORWARD (ptrdiff_t charpos)
+{ /* Performs just-in-time syntax-propertization. */
+ if (parse_sexp_lookup_properties && charpos >= gl_state.e_property)
+ update_syntax_table_forward (charpos + gl_state.offset,
+ false, gl_state.object);
+}
+
+INLINE void
+UPDATE_SYNTAX_TABLE_FORWARD_FAST (ptrdiff_t charpos)
+{
+ if (parse_sexp_lookup_properties && charpos >= gl_state.e_property)
+ update_syntax_table (charpos + gl_state.offset, 1, false, gl_state.object);
+}
/* 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)
+INLINE void
+UPDATE_SYNTAX_TABLE_BACKWARD (ptrdiff_t charpos)
+{
+ if (parse_sexp_lookup_properties && charpos < gl_state.b_property)
+ update_syntax_table (charpos + gl_state.offset, -1, false, gl_state.object);
+}
/* 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 sets up the buffer-global syntax table. */
-#define SETUP_BUFFER_SYNTAX_TABLE() \
-do \
- { \
- gl_state.use_global = 0; \
- gl_state.current_syntax_table = BVAR (current_buffer, syntax_table);\
- } while (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) \
-do \
- { \
- SETUP_BUFFER_SYNTAX_TABLE (); \
- gl_state.b_property = BEGV; \
- gl_state.e_property = ZV + 1; \
- gl_state.object = Qnil; \
- gl_state.offset = 0; \
- if (parse_sexp_lookup_properties) \
- if ((COUNT) > 0 || (FROM) > BEGV) \
- update_syntax_table ((COUNT) > 0 ? (FROM) : (FROM) - 1, (COUNT),\
- 1, Qnil); \
- } \
-while (0)
-
-/* Same as above, but in OBJECT. If OBJECT is nil, use current buffer.
- If it is t (which is only used in fast_c_string_match_ignore_case),
- 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) \
-do \
- { \
- SETUP_BUFFER_SYNTAX_TABLE (); \
- gl_state.object = (OBJECT); \
- if (BUFFERP (gl_state.object)) \
- { \
- struct buffer *buf = XBUFFER (gl_state.object); \
- gl_state.b_property = 1; \
- 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 = 1; \
- gl_state.e_property = ZV - BEGV + 1; \
- gl_state.offset = BEGV - 1; \
- } \
- else if (EQ (gl_state.object, Qt)) \
- { \
- gl_state.b_property = 0; \
- gl_state.e_property = MOST_POSITIVE_FIXNUM; \
- gl_state.offset = 0; \
- } \
- else \
- { \
- gl_state.b_property = 0; \
- gl_state.e_property = 1 + SCHARS (gl_state.object); \
- gl_state.offset = 0; \
- } \
- if (parse_sexp_lookup_properties) \
- update_syntax_table (((FROM) + gl_state.offset \
- + (COUNT > 0 ? 0 : -1)), \
- COUNT, 1, gl_state.object); \
- } \
-while (0)
+INLINE void
+UPDATE_SYNTAX_TABLE (ptrdiff_t charpos)
+{
+ UPDATE_SYNTAX_TABLE_BACKWARD (charpos);
+ UPDATE_SYNTAX_TABLE_FORWARD (charpos);
+}
-struct gl_state_s
+INLINE void
+UPDATE_SYNTAX_TABLE_FAST (ptrdiff_t charpos)
{
- Lisp_Object object; /* The object we are scanning. */
- EMACS_INT start; /* Where to stop. */
- EMACS_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. */
- EMACS_INT b_property; /* First index where c_s_t is valid. */
- EMACS_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. */
- EMACS_INT offset;
-};
+ UPDATE_SYNTAX_TABLE_BACKWARD (charpos);
+ UPDATE_SYNTAX_TABLE_FORWARD_FAST (charpos);
+}
-extern struct gl_state_s gl_state;
-extern EMACS_INT scan_words (EMACS_INT, EMACS_INT);
+/* Set up the buffer-global syntax table. */
+
+INLINE void
+SETUP_BUFFER_SYNTAX_TABLE (void)
+{
+ gl_state.use_global = false;
+ gl_state.e_property_truncated = false;
+ gl_state.current_syntax_table = BVAR (current_buffer, syntax_table);
+}
+
+extern ptrdiff_t scan_words (ptrdiff_t, EMACS_INT);
+extern void SETUP_SYNTAX_TABLE_FOR_OBJECT (Lisp_Object, ptrdiff_t, ptrdiff_t);
+
+INLINE_HEADER_END
+
+#endif /* EMACS_SYNTAX_H */