git.chise.org Git - chise/xemacs-chise.git.1/blob - src/syntax.h

   1 /* Declarations having to do with XEmacs syntax tables.
   2    Copyright (C) 1985, 1992, 1993 Free Software Foundation, Inc.
   3
   4 This file is part of XEmacs.
   5
   6 XEmacs is free software; you can redistribute it and/or modify it
   7 under the terms of the GNU General Public License as published by the
   8 Free Software Foundation; either version 2, or (at your option) any
   9 later version.
  10
  11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
  12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with XEmacs; see the file COPYING.  If not, write to
  18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19 Boston, MA 02111-1307, USA.  */
  20
  21 /* Synched up with: FSF 19.28. */
  22
  23 #ifndef _XEMACS_SYNTAX_H_
  24 #define _XEMACS_SYNTAX_H_
  25
  26 #include "chartab.h"
  27
  28 /* A syntax table is a type of char table.
  29
  30 The low 7 bits of the integer is a code, as follows. The 8th bit is
  31 used as the prefix bit flag (see below).
  32
  33 The values in a syntax table are either integers or conses of
  34 integers and chars.  The lowest 7 bits of the integer are the syntax
  35 class.  If this is Sinherit, then the actual syntax value needs to
  36 be retrieved from the standard syntax table.
  37
  38 Since the logic involved in finding the actual integer isn't very
  39 complex, you'd think the time required to retrieve it is not a
  40 factor.  If you thought that, however, you'd be wrong, due to the
  41 high number of times (many per character) that the syntax value is
  42 accessed in functions such as scan_lists().  To speed this up,
  43 we maintain a mirror syntax table that contains the actual
  44 integers.  We can do this successfully because syntax tables are
  45 now an abstract type, where we control all access.
  46 */
  47
  48 enum syntaxcode
  49 {
  50   Swhitespace,  /* whitespace character */
  51   Spunct,       /* random punctuation character */
  52   Sword,        /* word constituent */
  53   Ssymbol,      /* symbol constituent but not word constituent */
  54   Sopen,        /* a beginning delimiter */
  55   Sclose,       /* an ending delimiter */
  56   Squote,       /* a prefix character like Lisp ' */
  57   Sstring,      /* a string-grouping character like Lisp " */
  58   Smath,        /* delimiters like $ in TeX. */
  59   Sescape,      /* a character that begins a C-style escape */
  60   Scharquote,   /* a character that quotes the following character */
  61   Scomment,     /* a comment-starting character */
  62   Sendcomment,  /* a comment-ending character */
  63   Sinherit,     /* use the standard syntax table for this character */
  64   Smax   /* Upper bound on codes that are meaningful */
  65 };
  66
  67 enum syntaxcode charset_syntax (struct buffer *buf, Lisp_Object charset,
  68                                 int *multi_p_out);
  69
  70 /* Return the syntax code for a particular character and mirror table. */
  71
  72 #define SYNTAX_CODE_UNSAFE(table, c) \
  73    XINT (CHAR_TABLE_VALUE_UNSAFE (table, c))
  74
  75 INLINE int SYNTAX_CODE (struct Lisp_Char_Table *table, Emchar c);
  76 INLINE int
  77 SYNTAX_CODE (struct Lisp_Char_Table *table, Emchar c)
  78 {
  79   return SYNTAX_CODE_UNSAFE (table, c);
  80 }
  81
  82 #define SYNTAX_UNSAFE(table, c) \
  83   ((enum syntaxcode) (SYNTAX_CODE_UNSAFE (table, c) & 0177))
  84
  85 #define SYNTAX_FROM_CODE(code) ((enum syntaxcode) ((code) & 0177))
  86 #define SYNTAX(table, c) SYNTAX_FROM_CODE (SYNTAX_CODE (table, c))
  87
  88 INLINE int WORD_SYNTAX_P (struct Lisp_Char_Table *table, Emchar c);
  89 INLINE int
  90 WORD_SYNTAX_P (struct Lisp_Char_Table *table, Emchar c)
  91 {
  92   int syncode = SYNTAX (table, c);
  93   return syncode == Sword;
  94 }
  95
  96 /* OK, here's a graphic diagram of the format of the syntax values:
  97
  98    Bit number:
  99
 100  [ 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1 0 0 0 0 0 0 0 0 0 0 ]
 101  [ 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 ]
 102
 103    <-----> <-----> <-------------> <-------------> ^  <----------->
 104     ELisp  unused  |comment bits |     unused      |   syntax code
 105      tag           | | | | | | | |                 |
 106     stuff          | | | | | | | |                 |
 107                    | | | | | | | |                 |
 108                    | | | | | | | |                 `--> prefix flag
 109                    | | | | | | | |
 110                    | | | | | | | `--> comment end style B, second char
 111                    | | | | | | `----> comment end style A, second char
 112                    | | | | | `------> comment end style B, first char
 113                    | | | | `--------> comment end style A, first char
 114                    | | | `----------> comment start style B, second char
 115                    | | `------------> comment start style A, second char
 116                    | `--------------> comment start style B, first char
 117                    `----------------> comment start style A, first char
 118
 119   In a 64-bit integer, there would be 32 more unused bits between
 120   the tag and the comment bits.
 121
 122   Clearly, such a scheme will not work for Mule, because the matching
 123   paren could be any character and as such requires 19 bits, which
 124   we don't got.
 125
 126   Remember that under Mule we use char tables instead of vectors.
 127   So what we do is use another char table for the matching paren
 128   and store a pointer to it in the first char table. (This frees
 129   code from having to worry about passing two tables around.)
 130 */
 131
 132
 133 /* The prefix flag bit for backward-prefix-chars is now put into bit 7. */
 134
 135 #define SYNTAX_PREFIX_UNSAFE(table, c) \
 136   ((SYNTAX_CODE_UNSAFE (table, c) >> 7) & 1)
 137 #define SYNTAX_PREFIX(table, c) \
 138   ((SYNTAX_CODE (table, c) >> 7) & 1)
 139
 140 /* Bits 23-16 are used to implement up to two comment styles
 141    in a single buffer. They have the following meanings:
 142
 143   1. first of a one or two character comment-start sequence of style a.
 144   2. first of a one or two character comment-start sequence of style b.
 145   3. second of a two-character comment-start sequence of style a.
 146   4. second of a two-character comment-start sequence of style b.
 147   5. first of a one or two character comment-end sequence of style a.
 148   6. first of a one or two character comment-end sequence of style b.
 149   7. second of a two-character comment-end sequence of style a.
 150   8. second of a two-character comment-end sequence of style b.
 151  */
 152
 153 #define SYNTAX_COMMENT_BITS(table, c) \
 154   ((SYNTAX_CODE (table, c) >> 16) &0xff)
 155
 156 #define SYNTAX_FIRST_OF_START_A  0x80
 157 #define SYNTAX_FIRST_OF_START_B  0x40
 158 #define SYNTAX_SECOND_OF_START_A 0x20
 159 #define SYNTAX_SECOND_OF_START_B 0x10
 160 #define SYNTAX_FIRST_OF_END_A    0x08
 161 #define SYNTAX_FIRST_OF_END_B    0x04
 162 #define SYNTAX_SECOND_OF_END_A   0x02
 163 #define SYNTAX_SECOND_OF_END_B   0x01
 164
 165 #define SYNTAX_COMMENT_STYLE_A   0xaa
 166 #define SYNTAX_COMMENT_STYLE_B   0x55
 167 #define SYNTAX_FIRST_CHAR_START  0xc0
 168 #define SYNTAX_FIRST_CHAR_END    0x0c
 169 #define SYNTAX_FIRST_CHAR        0xcc
 170 #define SYNTAX_SECOND_CHAR_START 0x30
 171 #define SYNTAX_SECOND_CHAR_END   0x03
 172 #define SYNTAX_SECOND_CHAR       0x33
 173
 174 #define SYNTAX_START_P(table, a, b)                                     \
 175   ((SYNTAX_COMMENT_BITS (table, a) & SYNTAX_FIRST_CHAR_START)           \
 176    && (SYNTAX_COMMENT_BITS (table, b) & SYNTAX_SECOND_CHAR_START))
 177
 178 #define SYNTAX_END_P(table, a, b)                                       \
 179   ((SYNTAX_COMMENT_BITS (table, a) & SYNTAX_FIRST_CHAR_END)             \
 180    && (SYNTAX_COMMENT_BITS (table, b) & SYNTAX_SECOND_CHAR_END))
 181
 182 #define SYNTAX_STYLES_MATCH_START_P(table, a, b, mask)                      \
 183   ((SYNTAX_COMMENT_BITS (table, a) & SYNTAX_FIRST_CHAR_START & (mask))      \
 184    && (SYNTAX_COMMENT_BITS (table, b) & SYNTAX_SECOND_CHAR_START & (mask)))
 185
 186 #define SYNTAX_STYLES_MATCH_END_P(table, a, b, mask)                      \
 187   ((SYNTAX_COMMENT_BITS (table, a) & SYNTAX_FIRST_CHAR_END & (mask))      \
 188    && (SYNTAX_COMMENT_BITS (table, b) & SYNTAX_SECOND_CHAR_END & (mask)))
 189
 190 #define SYNTAX_STYLES_MATCH_1CHAR_P(table, a, mask)     \
 191   ((SYNTAX_COMMENT_BITS (table, a) & (mask)))
 192
 193 #define STYLE_FOUND_P(table, a, b, startp, style)       \
 194   ((SYNTAX_COMMENT_BITS (table, a) &                    \
 195     ((startp) ? SYNTAX_FIRST_CHAR_START :               \
 196      SYNTAX_FIRST_CHAR_END) & (style))                  \
 197    && (SYNTAX_COMMENT_BITS (table, b) &                 \
 198     ((startp) ? SYNTAX_SECOND_CHAR_START :              \
 199      SYNTAX_SECOND_CHAR_END) & (style)))
 200
 201 #define SYNTAX_COMMENT_MASK_START(table, a, b)                  \
 202   ((STYLE_FOUND_P (table, a, b, 1, SYNTAX_COMMENT_STYLE_A)      \
 203     ? SYNTAX_COMMENT_STYLE_A                                    \
 204     : (STYLE_FOUND_P (table, a, b, 1, SYNTAX_COMMENT_STYLE_B)   \
 205          ? SYNTAX_COMMENT_STYLE_B                               \
 206          : 0)))
 207
 208 #define SYNTAX_COMMENT_MASK_END(table, a, b)                    \
 209   ((STYLE_FOUND_P (table, a, b, 0, SYNTAX_COMMENT_STYLE_A)      \
 210    ? SYNTAX_COMMENT_STYLE_A                                     \
 211    : (STYLE_FOUND_P (table, a, b, 0, SYNTAX_COMMENT_STYLE_B)    \
 212       ? SYNTAX_COMMENT_STYLE_B                                  \
 213       : 0)))
 214
 215 #define STYLE_FOUND_1CHAR_P(table, a, style)    \
 216   ((SYNTAX_COMMENT_BITS (table, a) & (style)))
 217
 218 #define SYNTAX_COMMENT_1CHAR_MASK(table, a)                     \
 219   ((STYLE_FOUND_1CHAR_P (table, a, SYNTAX_COMMENT_STYLE_A)      \
 220    ? SYNTAX_COMMENT_STYLE_A                                     \
 221    : (STYLE_FOUND_1CHAR_P (table, a, SYNTAX_COMMENT_STYLE_B)    \
 222       ? SYNTAX_COMMENT_STYLE_B                                  \
 223          : 0)))
 224
 225 EXFUN (Fchar_syntax, 2);
 226 EXFUN (Fforward_word, 2);
 227
 228 /* The standard syntax table is stored where it will automatically
 229    be used in all new buffers.  */
 230 extern Lisp_Object Vstandard_syntax_table;
 231
 232 /* This array, indexed by a character, contains the syntax code which
 233    that character signifies (as a char).
 234    For example, (enum syntaxcode) syntax_spec_code['w'] is Sword. */
 235
 236 extern CONST unsigned char syntax_spec_code[0400];
 237
 238 /* Indexed by syntax code, give the letter that describes it. */
 239
 240 extern CONST unsigned char syntax_code_spec[];
 241
 242 Lisp_Object scan_lists (struct buffer *buf, int from, int count,
 243                         int depth, int sexpflag, int no_error);
 244 int char_quoted (struct buffer *buf, int pos);
 245
 246 /* NOTE: This does not refer to the mirror table, but to the
 247    syntax table itself. */
 248 Lisp_Object syntax_match (Lisp_Object table, Emchar ch);
 249
 250 extern int no_quit_in_re_search;
 251 extern struct buffer *regex_emacs_buffer;
 252
 253 void update_syntax_table (struct Lisp_Char_Table *ct);
 254
 255 #endif /* _XEMACS_SYNTAX_H_ */