]> code.delx.au - gnu-emacs/blobdiff - src/syntax.h
(archive-l-e): New optional argument `float' means generate a float value.
[gnu-emacs] / src / syntax.h
index 6bd9757c3a8a03c2647219890d6f7db349b0406f..92d55967b338ed268aeada2f9d66e801d2eb2111 100644 (file)
@@ -1,11 +1,12 @@
 /* Declarations having to do with GNU Emacs syntax tables.
-   Copyright (C) 1985 Free Software Foundation, Inc.
+   Copyright (C) 1985, 1993, 1994, 1997, 1998, 2002, 2003, 2004,
+                 2005, 2006 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 1, or (at your option)
+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,
@@ -15,20 +16,22 @@ 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, 675 Mass Ave, Cambridge, MA 02139, USA.  */
+the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+Boston, MA 02110-1301, USA.  */
 
 
 extern Lisp_Object Qsyntax_table_p;
-extern Lisp_Object Fsyntax_table_p (), Fsyntax_table (), Fset_syntax_table ();
+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 Lisp vector of length 0400, whose elements are integers.
+/* 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 the integer is a code, as follows:
-*/
+   The low 8 bits of CODE+FLAGS is a code, as follows:  */
 
 enum syntaxcode
   {
@@ -40,53 +43,335 @@ enum syntaxcode
     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. */
+    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 */
   };
 
-#define SYNTAX(c) \
-  ((enum syntaxcode) (XINT (XVECTOR (current_buffer->syntax_table)->contents[c]) & 0377))
+/* Set the syntax entry VAL for char C in table TABLE.  */
 
-/* The next 8 bits of the number is a character,
- the matching delimiter in the case of Sopen or Sclose. */
+#define SET_RAW_SYNTAX_ENTRY(table, c, val)                            \
+  ((((c) & 0xFF) == (c))                                               \
+   ? (XCHAR_TABLE (table)->contents[(unsigned char) (c)] = (val))      \
+   : Faset ((table), make_number (c), (val)))
 
-#define SYNTAX_MATCH(c) \
-  ((XINT (XVECTOR (current_buffer->syntax_table)->contents[c]) >> 8) & 0377)
+/* 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.  */
 
-/* Then there are five single-bit flags that have the following meanings:
+#ifdef __GNUC__
+#define SYNTAX_ENTRY_FOLLOW_PARENT(table, c)                   \
+  ({ Lisp_Object _syntax_tbl = (table);                                \
+     Lisp_Object _syntax_temp = XCHAR_TABLE (_syntax_tbl)->contents[(c)]; \
+     while (NILP (_syntax_temp))                               \
+       {                                                       \
+        _syntax_tbl = XCHAR_TABLE (_syntax_tbl)->parent;       \
+        if (NILP (_syntax_tbl))                                \
+          break;                                               \
+        _syntax_temp = XCHAR_TABLE (_syntax_tbl)->contents[(c)]; \
+       }                                                       \
+     _syntax_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) & 0xFF) == (c))                               \
+   ? 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 _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
+#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
+
+/* Then there are seven 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. */
+  6. see below
+  7. This character is part of a nestable comment sequence.
+  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)
+
+#define SYNTAX_COMMENT_NESTED(c) ((SYNTAX_WITH_FLAGS (c) >> 22) & 1)
+
+/* These macros extract specific flags from an integer
+   that holds the syntax code and the flags.  */
 
-#define SYNTAX_COMSTART_FIRST(c) \
-  ((XINT (XVECTOR (current_buffer->syntax_table)->contents[c]) >> 16) & 1)
+#define SYNTAX_FLAGS_COMSTART_FIRST(flags) (((flags) >> 16) & 1)
 
-#define SYNTAX_COMSTART_SECOND(c) \
-  ((XINT (XVECTOR (current_buffer->syntax_table)->contents[c]) >> 17) & 1)
+#define SYNTAX_FLAGS_COMSTART_SECOND(flags) (((flags) >> 17) & 1)
 
-#define SYNTAX_COMEND_FIRST(c) \
-  ((XINT (XVECTOR (current_buffer->syntax_table)->contents[c]) >> 18) & 1)
+#define SYNTAX_FLAGS_COMEND_FIRST(flags) (((flags) >> 18) & 1)
 
-#define SYNTAX_COMEND_SECOND(c) \
-  ((XINT (XVECTOR (current_buffer->syntax_table)->contents[c]) >> 19) & 1)
+#define SYNTAX_FLAGS_COMEND_SECOND(flags) (((flags) >> 19) & 1)
 
-#define SYNTAX_PREFIX(c) \
-  ((XINT (XVECTOR (current_buffer->syntax_table)->contents[c]) >> 20) & 1)
+#define SYNTAX_FLAGS_PREFIX(flags) (((flags) >> 20) & 1)
+
+#define SYNTAX_FLAGS_COMMENT_STYLE(flags) (((flags) >> 21) & 1)
+
+#define SYNTAX_FLAGS_COMMENT_NESTED(flags) (((flags) >> 22) & 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. */
+ (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. */
+/* 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;                                                \
+    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 = 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 = 1500000000;                               \
+       gl_state.offset = 0;                                            \
+      }                                                                        \
+    else                                                               \
+      {                                                                        \
+       gl_state.b_property = 0;                                        \
+       gl_state.e_property = 1 + SCHARS (gl_state.object);             \
+       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;                      /* First index where c_s_t is 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;
+};
+
+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));
 
-extern char syntax_code_spec[13];
+/* arch-tag: 28833cca-cd73-4741-8c85-a3111166a0e0
+   (do not change this comment) */