Update copyright year.
[bpt/emacs.git] / src / syntax.h
index ee6466a..e70fd71 100644 (file)
@@ -1,5 +1,5 @@
 /* Declarations having to do with GNU Emacs syntax tables.
-   Copyright (C) 1985, 1993, 1994 Free Software Foundation, Inc.
+   Copyright (C) 1985, 93, 94, 97, 1998 Free Software Foundation, Inc.
 
 This file is part of GNU Emacs.
 
@@ -20,7 +20,7 @@ Boston, MA 02111-1307, 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.  */
@@ -42,19 +42,23 @@ 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 */
   };
 
 /* Set the syntax entry VAL for char C in table TABLE.  */
 
 #define SET_RAW_SYNTAX_ENTRY(table, c, val)                            \
-  ((c) < CHAR_TABLE_ORDINARY_SLOTS                                     \
+  ((c) < CHAR_TABLE_SINGLE_BYTE_SLOTS                                  \
    ? (XCHAR_TABLE (table)->contents[(unsigned char) (c)] = (val))      \
    : Faset ((table), make_number (c), (val)))
 
@@ -76,7 +80,7 @@ enum syntaxcode
      temp; })
 #else
 extern Lisp_Object syntax_temp;
-extern Lisp_Object syntax_parent_lookup ();
+extern Lisp_Object syntax_parent_lookup P_ ((Lisp_Object, int));
 
 #define SYNTAX_ENTRY_FOLLOW_PARENT(table, c)           \
   (syntax_temp = XCHAR_TABLE (table)->contents[(c)],   \
@@ -85,16 +89,27 @@ extern Lisp_Object syntax_parent_lookup ();
     : 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.  */
+/* 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(c)                                                \
-  ((c) < CHAR_TABLE_ORDINARY_SLOTS                             \
-   ? SYNTAX_ENTRY_FOLLOW_PARENT (current_buffer->syntax_table, \
+#define SYNTAX_ENTRY_INT(c)                                            \
+  ((c) < CHAR_TABLE_SINGLE_BYTE_SLOTS                          \
+   ? SYNTAX_ENTRY_FOLLOW_PARENT (CURRENT_SYNTAX_TABLE, \
                                 (unsigned char) (c))           \
-   : Faref (current_buffer->syntax_table, make_number ((c))))
-
+   : Faref (CURRENT_SYNTAX_TABLE, make_number ((c))))
 
 /* Extract the information from the entry for character C
    in the current syntax table.  */
@@ -118,7 +133,7 @@ extern Lisp_Object syntax_parent_lookup ();
   ({ Lisp_Object temp;                                                 \
      temp = SYNTAX_ENTRY (c);                                          \
      (CONSP (temp)                                                     \
-      ? XINT (XCONS (temp)->cdr)                                       \
+      ? XCONS (temp)->cdr                                              \
       : Qnil); })
 #else
 #define SYNTAX(c)                                                      \
@@ -136,7 +151,7 @@ extern Lisp_Object syntax_parent_lookup ();
 #define SYNTAX_MATCH(c)                                                        \
   (syntax_temp = SYNTAX_ENTRY ((c)),                                   \
    (CONSP (syntax_temp)                                                        \
-    ? XINT (XCONS (syntax_temp)->cdr)                                  \
+    ? XCONS (syntax_temp)->cdr                                         \
     : Qnil))
 #endif
 
@@ -152,7 +167,7 @@ extern Lisp_Object syntax_parent_lookup ();
   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.
+  ends style a or b.  Comment start sequences can start style a or b.
   Style a is always the default.
   */
 
@@ -171,10 +186,152 @@ extern Lisp_Object syntax_parent_lookup ();
 
 /* 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. */
-
-extern char syntax_code_spec[14];
+/* 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.  */
+
+#define SYNTAX_TABLE_BYTE_TO_CHAR(bytepos)                             \
+  (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))     \
+   : NILP (gl_state.object)                                            \
+   ? BYTE_TO_CHAR ((bytepos))                                          \
+   : (bytepos))
+
+/* Make syntax table state (gl_state) good for POS, assuming it is
+   currently good for a position before POS.  */
+
+#define UPDATE_SYNTAX_TABLE_FORWARD(pos)                       \
+  ((pos) >= gl_state.e_property - gl_state.offset              \
+   ? (update_syntax_table ((pos) + gl_state.offset, 1, 0,      \
+                          gl_state.object),                    \
+      1)                                                       \
+   : 0)
+
+/* Make syntax table state (gl_state) good for POS, assuming it is
+   currently good for a position after POS.  */
+
+#define UPDATE_SYNTAX_TABLE_BACKWARD(pos)                      \
+  ((pos) <= gl_state.b_property - gl_state.offset              \
+   ? (update_syntax_table ((pos) + gl_state.offset, -1, 0,     \
+                          gl_state.object),                    \
+      1)                                                       \
+   : 0)
+
+/* Make syntax table good for POS.  */
+
+#define UPDATE_SYNTAX_TABLE(pos)                               \
+  ((pos) <= gl_state.b_property - gl_state.offset              \
+   ? (update_syntax_table ((pos) + gl_state.offset, -1, 0,     \
+                          gl_state.object),                    \
+      1)                                                       \
+   : ((pos) >= gl_state.e_property - gl_state.offset           \
+      ? (update_syntax_table ((pos) + 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)                                        \
+  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)                                    \
+    update_syntax_table ((COUNT) > 0 ? (FROM) : (FROM) - 1, (COUNT),   \
+                        1, Qnil);
+
+/* 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 = BUF_BEGV (buf) - 1;                       \
+       gl_state.e_property = BUF_ZV (buf);                             \
+       gl_state.offset = BUF_BEGV (buf) - 1;                           \
+      }                                                                        \
+    else if (NILP (gl_state.object))                                   \
+      {                                                                        \
+       gl_state.b_property = BEGV - 1;                                 \
+       gl_state.e_property = ZV;                                       \
+       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 ((BYTE_TO_CHAR ((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));