1 /* XEmacs routines to deal with syntax tables; also word and list parsing.
2 Copyright (C) 1985-1994 Free Software Foundation, Inc.
3 Copyright (C) 1995 Sun Microsystems, Inc.
4 Copyright (C) 2001 MORIOKA Tomohiko
6 This file is part of XEmacs.
8 XEmacs is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by the
10 Free Software Foundation; either version 2, or (at your option) any
13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with XEmacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
23 /* Synched up with: FSF 19.28. */
25 /* This file has been Mule-ized. */
34 /* Here is a comment from Ken'ichi HANDA <handa@etl.go.jp>
35 explaining the purpose of the Sextword syntax category:
37 Japanese words are not separated by spaces, which makes finding word
38 boundaries very difficult. Theoretically it's impossible without
39 using natural language processing techniques. But, by defining
40 pseudo-words as below (much simplified for letting you understand it
41 easily) for Japanese, we can have a convenient forward-word function
44 A Japanese word is a sequence of characters that consists of
45 zero or more Kanji characters followed by zero or more
48 Then, the problem is that now we can't say that a sequence of
49 word-constituents makes up a WORD. For instance, both Hiragana "A"
50 and Kanji "KAN" are word-constituents but the sequence of these two
51 letters can't be a single word.
53 So, we introduced Sextword for Japanese letters. A character of
54 Sextword is a word-constituent but a word boundary may exist between
55 two such characters. */
57 /* Mule 2.4 doesn't seem to have Sextword - I'm removing it -- mrb */
58 /* Recovered by tomo */
60 #define ST_COMMENT_STYLE 0x101
61 #define ST_STRING_STYLE 0x102
63 Lisp_Object Qsyntax_table;
64 int lookup_syntax_properties;
66 Lisp_Object Qsyntax_table_p;
68 int words_include_escapes;
70 int parse_sexp_ignore_comments;
72 /* The following two variables are provided to tell additional information
73 to the regex routines. We do it this way rather than change the
74 arguments to re_search_2() in an attempt to maintain some call
75 compatibility with other versions of the regex code. */
77 /* Tell the regex routines not to QUIT. Normally there is a QUIT
78 each iteration in re_search_2(). */
79 int no_quit_in_re_search;
81 /* Tell the regex routines which buffer to access for SYNTAX() lookups
83 struct buffer *regex_emacs_buffer;
85 /* In Emacs, this is the string or buffer in which we
86 are matching. It is used for looking up syntax properties. */
87 Lisp_Object regex_match_object;
89 Lisp_Object Vstandard_syntax_table;
91 Lisp_Object Vsyntax_designator_chars_string;
93 /* This is the internal form of the parse state used in parse-partial-sexp. */
95 struct lisp_parse_state
97 int depth; /* Depth at end of parsing */
98 Emchar instring; /* -1 if not within string, else desired terminator */
99 int incomment; /* Nonzero if within a comment at end of parsing */
100 int comstyle; /* comment style a=0, or b=1, or ST_COMMENT_STYLE */
101 int quoted; /* Nonzero if just after an escape char at end of
103 Bufpos thislevelstart;/* Char number of most recent start-of-expression
105 Bufpos prevlevelstart;/* Char number of start of containing expression */
106 Bufpos location; /* Char number at which parsing stopped */
107 int mindepth; /* Minimum depth seen while scanning */
108 Bufpos comstr_start; /* Position just after last comment/string starter */
109 Lisp_Object levelstarts; /* Char numbers of starts-of-expression
110 of levels (starting from outermost). */
113 /* These variables are a cache for finding the start of a defun.
114 find_start_pos is the place for which the defun start was found.
115 find_start_value is the defun start position found for it.
116 find_start_buffer is the buffer it was found in.
117 find_start_begv is the BEGV value when it was found.
118 find_start_modiff is the value of MODIFF when it was found. */
120 static Bufpos find_start_pos;
121 static Bufpos find_start_value;
122 static struct buffer *find_start_buffer;
123 static Bufpos find_start_begv;
124 static int find_start_modiff;
126 /* Find a defun-start that is the last one before POS (or nearly the last).
127 We record what we find, so that another call in the same area
128 can return the same value right away. */
131 find_defun_start (struct buffer *buf, Bufpos pos)
135 /* Use previous finding, if it's valid and applies to this inquiry. */
136 if (buf == find_start_buffer
137 /* Reuse the defun-start even if POS is a little farther on.
138 POS might be in the next defun, but that's ok.
139 Our value may not be the best possible, but will still be usable. */
140 && pos <= find_start_pos + 1000
141 && pos >= find_start_value
142 && BUF_BEGV (buf) == find_start_begv
143 && BUF_MODIFF (buf) == find_start_modiff)
144 return find_start_value;
146 /* Back up to start of line. */
147 tem = find_next_newline (buf, pos, -1);
149 SETUP_SYNTAX_CACHE (tem, 1);
150 while (tem > BUF_BEGV (buf))
152 UPDATE_SYNTAX_CACHE_BACKWARD(tem);
154 /* Open-paren at start of line means we found our defun-start. */
155 if (SYNTAX_FROM_CACHE (mirrortab, BUF_FETCH_CHAR (buf, tem)) == Sopen)
157 /* Move to beg of previous line. */
158 tem = find_next_newline (buf, tem, -2);
161 /* Record what we found, for the next try. */
162 find_start_value = tem;
163 find_start_buffer = buf;
164 find_start_modiff = BUF_MODIFF (buf);
165 find_start_begv = BUF_BEGV (buf);
166 find_start_pos = pos;
168 return find_start_value;
171 DEFUN ("syntax-table-p", Fsyntax_table_p, 1, 1, 0, /*
172 Return t if OBJECT is a syntax table.
173 Any vector of 256 elements will do.
177 return (CHAR_TABLEP (object)
178 && XCHAR_TABLE_TYPE (object) == CHAR_TABLE_TYPE_SYNTAX)
183 check_syntax_table (Lisp_Object obj, Lisp_Object default_)
187 while (NILP (Fsyntax_table_p (obj)))
188 obj = wrong_type_argument (Qsyntax_table_p, obj);
192 DEFUN ("syntax-table", Fsyntax_table, 0, 1, 0, /*
193 Return the current syntax table.
194 This is the one specified by the current buffer, or by BUFFER if it
199 return decode_buffer (buffer, 0)->syntax_table;
202 DEFUN ("standard-syntax-table", Fstandard_syntax_table, 0, 0, 0, /*
203 Return the standard syntax table.
204 This is the one used for new buffers.
208 return Vstandard_syntax_table;
211 DEFUN ("copy-syntax-table", Fcopy_syntax_table, 0, 1, 0, /*
212 Return a new syntax table which is a copy of SYNTAX-TABLE.
213 SYNTAX-TABLE defaults to the standard syntax table.
217 if (NILP (Vstandard_syntax_table))
218 return Fmake_char_table (Qsyntax);
220 syntax_table = check_syntax_table (syntax_table, Vstandard_syntax_table);
221 return Fcopy_char_table (syntax_table);
224 DEFUN ("set-syntax-table", Fset_syntax_table, 1, 2, 0, /*
225 Select SYNTAX-TABLE as the new syntax table for BUFFER.
226 BUFFER defaults to the current buffer if omitted.
228 (syntax_table, buffer))
230 struct buffer *buf = decode_buffer (buffer, 0);
231 syntax_table = check_syntax_table (syntax_table, Qnil);
232 buf->syntax_table = syntax_table;
234 buf->mirror_syntax_table = XCHAR_TABLE (syntax_table)->mirror_table;
236 /* Indicate that this buffer now has a specified syntax table. */
237 buf->local_var_flags |= XINT (buffer_local_flags.syntax_table);
241 /* The current syntax state */
242 struct syntax_cache syntax_cache;
246 Update syntax_cache to an appropriate setting for position POS
248 The sign of COUNT gives the relative position of POS wrt the
249 previously valid interval. (not currently used)
251 `syntax_cache.*_change' are the next and previous positions at
252 which syntax_code and c_s_t will need to be recalculated.
254 #### Currently this code uses 'get-char-property', which will
255 return the "last smallest" extent at a given position. In cases
256 where overlapping extents are defined, this code will simply use
257 whatever is returned by get-char-property.
259 It might be worth it at some point to merge provided syntax tables
260 outward to the current buffer. */
263 update_syntax_cache (int pos, int count, int init)
265 Lisp_Object tmp_table;
269 syntax_cache.prev_change = -1;
270 syntax_cache.next_change = -1;
273 if (pos > syntax_cache.prev_change &&
274 pos < syntax_cache.next_change)
280 if (NILP (syntax_cache.object) || EQ (syntax_cache.object, Qt))
282 int get_change_before = pos + 1;
284 tmp_table = Fget_char_property (make_int(pos), Qsyntax_table,
285 make_buffer (syntax_cache.buffer), Qnil);
286 syntax_cache.next_change =
287 XINT (Fnext_extent_change (make_int (pos > 0 ? pos : 1),
288 make_buffer (syntax_cache.buffer)));
290 if (get_change_before < 1)
291 get_change_before = 1;
292 else if (get_change_before > BUF_ZV (syntax_cache.buffer))
293 get_change_before = BUF_ZV (syntax_cache.buffer);
295 syntax_cache.prev_change =
296 XINT (Fprevious_extent_change (make_int (get_change_before),
297 make_buffer (syntax_cache.buffer)));
301 int get_change_before = pos + 1;
303 tmp_table = Fget_char_property (make_int(pos), Qsyntax_table,
304 syntax_cache.object, Qnil);
305 syntax_cache.next_change =
306 XINT (Fnext_extent_change (make_int (pos >= 0 ? pos : 0),
307 syntax_cache.object));
309 if (get_change_before < 0)
310 get_change_before = 0;
311 else if (get_change_before > XSTRING_LENGTH(syntax_cache.object))
312 get_change_before = XSTRING_LENGTH(syntax_cache.object);
314 syntax_cache.prev_change =
315 XINT (Fprevious_extent_change (make_int (pos >= 0 ? pos : 0),
316 syntax_cache.object));
319 if (EQ (Fsyntax_table_p (tmp_table), Qt))
321 syntax_cache.use_code = 0;
323 syntax_cache.current_syntax_table = tmp_table;
325 syntax_cache.current_syntax_table =
326 XCHAR_TABLE (tmp_table)->mirror_table;
329 else if (CONSP (tmp_table) && INTP (XCAR (tmp_table)))
331 syntax_cache.use_code = 1;
332 syntax_cache.syntax_code = XINT (XCAR(tmp_table));
336 syntax_cache.use_code = 0;
338 syntax_cache.current_syntax_table =
339 syntax_cache.buffer->syntax_table;
341 syntax_cache.current_syntax_table =
342 syntax_cache.buffer->mirror_syntax_table;
348 /* Convert a letter which signifies a syntax code
349 into the code it signifies.
350 This is used by modify-syntax-entry, and other things. */
352 const unsigned char syntax_spec_code[0400] =
353 { 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
354 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
355 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
356 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
357 (char) Swhitespace, 0377, (char) Sstring, 0377,
358 (char) Smath, 0377, 0377, (char) Squote,
359 (char) Sopen, (char) Sclose, 0377, 0377,
360 0377, (char) Swhitespace, (char) Spunct, (char) Scharquote,
361 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
362 0377, 0377, 0377, 0377,
363 (char) Scomment, 0377, (char) Sendcomment, 0377,
364 (char) Sinherit, 0377, 0377, 0377, 0377, 0377, 0377, 0377, /* @, A ... */
365 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
366 0377, 0377, 0377, 0377, 0377, 0377, 0377, (char) Sword,
367 0377, 0377, 0377, 0377, (char) Sescape, 0377, 0377, (char) Ssymbol,
368 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377, /* `, a, ... */
369 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
370 0377, 0377, 0377, 0377, 0377, 0377, 0377, (char) Sword,
371 0377, 0377, 0377, 0377, (char) Sstring_fence, 0377, 0377, 0377
374 const unsigned char syntax_code_spec[] = " .w_()'\"$\\/<>@!|";
376 DEFUN ("syntax-designator-chars", Fsyntax_designator_chars, 0, 0, 0, /*
377 Return a string of the recognized syntax designator chars.
378 The chars are ordered by their internal syntax codes, which are
379 numbered starting at 0.
383 return Vsyntax_designator_chars_string;
386 DEFUN ("char-syntax", Fchar_syntax, 1, 2, 0, /*
387 Return the syntax code of CHARACTER, described by a character.
388 For example, if CHARACTER is a word constituent,
389 the character `?w' is returned.
390 The characters that correspond to various syntax codes
391 are listed in the documentation of `modify-syntax-entry'.
392 Optional second argument SYNTAX-TABLE defaults to the current buffer's
395 (character, syntax_table))
398 Lisp_Char_Table *mirrortab;
401 if (NILP (character))
403 character = make_char ('\000');
405 CHECK_CHAR_COERCE_INT (character);
406 syntax_table = check_syntax_table (syntax_table, current_buffer->syntax_table);
408 return make_char (syntax_code_spec[(int) SYNTAX (XCHAR_TABLE(syntax_table),
409 XCHAR (character))]);
411 mirrortab = XCHAR_TABLE (XCHAR_TABLE (syntax_table)->mirror_table);
412 return make_char (syntax_code_spec[(int) SYNTAX (mirrortab, XCHAR (character))]);
419 charset_syntax (struct buffer *buf, Lisp_Object charset, int *multi_p_out)
422 /* #### get this right */
429 syntax_match (Lisp_Object syntax_table, Emchar ch)
431 Lisp_Object code = XCHAR_TABLE_VALUE_UNSAFE (syntax_table, ch);
432 Lisp_Object code2 = code;
436 if (SYNTAX_FROM_CODE (XINT (code2)) == Sinherit)
437 code = XCHAR_TABLE_VALUE_UNSAFE (Vstandard_syntax_table, ch);
439 return CONSP (code) ? XCDR (code) : Qnil;
442 DEFUN ("matching-paren", Fmatching_paren, 1, 2, 0, /*
443 Return the matching parenthesis of CHARACTER, or nil if none.
444 Optional second argument SYNTAX-TABLE defaults to the current buffer's
447 (character, syntax_table))
450 Lisp_Char_Table *mirrortab;
454 CHECK_CHAR_COERCE_INT (character);
455 syntax_table = check_syntax_table (syntax_table, current_buffer->syntax_table);
457 code = SYNTAX (XCHAR_TABLE (syntax_table), XCHAR (character));
459 mirrortab = XCHAR_TABLE (XCHAR_TABLE (syntax_table)->mirror_table);
460 code = SYNTAX (mirrortab, XCHAR (character));
462 if (code == Sopen || code == Sclose || code == Sstring)
463 return syntax_match (syntax_table, XCHAR (character));
470 /* Return 1 if there is a word boundary between two word-constituent
471 characters C1 and C2 if they appear in this order, else return 0.
472 There is no word boundary between two word-constituent ASCII
474 #define WORD_BOUNDARY_P(c1, c2) \
475 (!(CHAR_ASCII_P (c1) && CHAR_ASCII_P (c2)) \
476 && word_boundary_p (c1, c2))
478 extern int word_boundary_p (Emchar c1, Emchar c2);
481 /* Return the position across COUNT words from FROM.
482 If that many words cannot be found before the end of the buffer, return 0.
483 COUNT negative means scan backward and stop at word beginning. */
486 scan_words (struct buffer *buf, Bufpos from, int count)
488 Bufpos limit = count > 0 ? BUF_ZV (buf) : BUF_BEGV (buf);
490 enum syntaxcode code;
492 SETUP_SYNTAX_CACHE_FOR_BUFFER (buf, from, count);
494 /* #### is it really worth it to hand expand both cases? JV */
504 UPDATE_SYNTAX_CACHE_FORWARD (from);
505 ch0 = BUF_FETCH_CHAR (buf, from);
506 code = SYNTAX_FROM_CACHE (mirrortab, ch0);
509 if (words_include_escapes
510 && (code == Sescape || code == Scharquote))
518 while (from != limit)
520 UPDATE_SYNTAX_CACHE_FORWARD (from);
521 ch1 = BUF_FETCH_CHAR (buf, from);
522 code = SYNTAX_FROM_CACHE (mirrortab, ch1);
523 if (!(words_include_escapes
524 && (code == Sescape || code == Scharquote)))
527 || WORD_BOUNDARY_P (ch0, ch1)
548 UPDATE_SYNTAX_CACHE_BACKWARD (from - 1);
549 ch1 = BUF_FETCH_CHAR (buf, from - 1);
550 code = SYNTAX_FROM_CACHE (mirrortab, ch1);
553 if (words_include_escapes
554 && (code == Sescape || code == Scharquote))
562 while (from != limit)
564 UPDATE_SYNTAX_CACHE_BACKWARD (from - 1);
565 ch0 = BUF_FETCH_CHAR (buf, from - 1);
566 code = SYNTAX_FROM_CACHE (mirrortab, ch0);
568 if (!(words_include_escapes
569 && (code == Sescape || code == Scharquote)))
572 || WORD_BOUNDARY_P (ch0, ch1)
587 DEFUN ("forward-word", Fforward_word, 0, 2, "_p", /*
588 Move point forward COUNT words (backward if COUNT is negative).
589 Normally t is returned, but if an edge of the buffer is reached,
590 point is left there and nil is returned.
592 The characters that are moved over may be added to the current selection
593 \(i.e. active region) if the Shift key is held down, a motion key is used
594 to invoke this command, and `shifted-motion-keys-select-region' is t; see
595 the documentation for this variable for more details.
597 COUNT defaults to 1, and BUFFER defaults to the current buffer.
602 struct buffer *buf = decode_buffer (buffer, 0);
613 val = scan_words (buf, BUF_PT (buf), n);
616 BUF_SET_PT (buf, val);
621 BUF_SET_PT (buf, n > 0 ? BUF_ZV (buf) : BUF_BEGV (buf));
626 static void scan_sexps_forward (struct buffer *buf,
627 struct lisp_parse_state *,
628 Bufpos from, Bufpos end,
629 int targetdepth, int stopbefore,
630 Lisp_Object oldstate,
634 find_start_of_comment (struct buffer *buf, Bufpos from, Bufpos stop,
638 enum syntaxcode code;
640 /* Look back, counting the parity of string-quotes,
641 and recording the comment-starters seen.
642 When we reach a safe place, assume that's not in a string;
643 then step the main scan to the earliest comment-starter seen
644 an even number of string quotes away from the safe place.
646 OFROM[I] is position of the earliest comment-starter seen
647 which is I+2X quotes from the comment-end.
648 PARITY is current parity of quotes from the comment end. */
650 Emchar my_stringend = 0;
651 int string_lossage = 0;
652 Bufpos comment_end = from;
653 Bufpos comstart_pos = 0;
654 int comstart_parity = 0;
655 int styles_match_p = 0;
656 /* mask to match comment styles against; for ST_COMMENT_STYLE, this
657 will get set to SYNTAX_COMMENT_STYLE_B, but never get checked */
658 int mask = comstyle ? SYNTAX_COMMENT_STYLE_B : SYNTAX_COMMENT_STYLE_A;
660 /* At beginning of range to scan, we're outside of strings;
661 that determines quote parity to the comment-end. */
666 /* Move back and examine a character. */
668 UPDATE_SYNTAX_CACHE_BACKWARD (from);
670 c = BUF_FETCH_CHAR (buf, from);
671 code = SYNTAX_FROM_CACHE (mirrortab, c);
672 syncode = SYNTAX_CODE_FROM_CACHE (mirrortab, c);
674 /* is this a 1-char comment end sequence? if so, try
675 to see if style matches previously extracted mask */
676 if (code == Sendcomment)
679 SYNTAX_CODE_COMMENT_1CHAR_MASK (syncode) & mask;
682 /* or are we looking at a 1-char comment start sequence
683 of the style matching mask? */
684 else if (code == Scomment)
687 SYNTAX_CODE_COMMENT_1CHAR_MASK (syncode) & mask;
690 /* otherwise, is this a 2-char comment end or start sequence? */
691 else if (from > stop)
694 /* 2-char comment end sequence? */
695 if (SYNTAX_CODE_END_SECOND_P (syncode))
698 UPDATE_SYNTAX_CACHE_BACKWARD (from - 1);
700 SYNTAX_CODE_FROM_CACHE (mirrortab, BUF_FETCH_CHAR (buf, from - 1));
702 if (SYNTAX_CODES_END_P (prev_syncode, syncode))
706 SYNTAX_CODES_COMMENT_MASK_END (prev_syncode, syncode)
709 UPDATE_SYNTAX_CACHE_BACKWARD (from);
710 c = BUF_FETCH_CHAR (buf, from);
712 /* Found a comment-end sequence, so skip past the
713 check for a comment-start */
718 /* 2-char comment start sequence? */
719 if (SYNTAX_CODE_START_SECOND_P (syncode))
722 UPDATE_SYNTAX_CACHE_BACKWARD (from - 1);
724 SYNTAX_CODE_FROM_CACHE (mirrortab, BUF_FETCH_CHAR (buf, from - 1));
726 if (SYNTAX_CODES_START_P (prev_syncode, syncode))
730 SYNTAX_CODES_COMMENT_MASK_START (prev_syncode, syncode)
733 UPDATE_SYNTAX_CACHE_BACKWARD (from);
734 c = BUF_FETCH_CHAR (buf, from);
739 /* Ignore escaped characters. */
740 if (char_quoted (buf, from))
743 /* Track parity of quotes. */
747 if (my_stringend == 0)
749 /* If we have two kinds of string delimiters.
750 There's no way to grok this scanning backwards. */
751 else if (my_stringend != c)
755 if (code == Sstring_fence || code == Scomment_fence)
758 if (my_stringend == 0)
760 code == Sstring_fence ? ST_STRING_STYLE : ST_COMMENT_STYLE;
761 /* If we have two kinds of string delimiters.
762 There's no way to grok this scanning backwards. */
763 else if (my_stringend != (code == Sstring_fence
764 ? ST_STRING_STYLE : ST_COMMENT_STYLE))
768 /* Record comment-starters according to that
769 quote-parity to the comment-end. */
770 if (code == Scomment && styles_match_p)
772 comstart_parity = parity;
776 /* If we find another earlier comment-ender,
777 any comment-starts earlier than that don't count
778 (because they go with the earlier comment-ender). */
779 if (code == Sendcomment && styles_match_p)
782 /* Assume a defun-start point is outside of strings. */
784 && (from == stop || BUF_FETCH_CHAR (buf, from - 1) == '\n'))
788 if (comstart_pos == 0)
790 /* If the earliest comment starter
791 is followed by uniform paired string quotes or none,
792 we know it can't be inside a string
793 since if it were then the comment ender would be inside one.
794 So it does start a comment. Skip back to it. */
795 else if (comstart_parity == 0 && !string_lossage)
799 /* We had two kinds of string delimiters mixed up
800 together. Decode this going forwards.
801 Scan fwd from the previous comment ender
802 to the one in question; this records where we
803 last passed a comment starter. */
805 struct lisp_parse_state state;
806 scan_sexps_forward (buf, &state, find_defun_start (buf, comment_end),
807 comment_end - 1, -10000, 0, Qnil, 0);
809 from = state.comstr_start;
811 /* We can't grok this as a comment; scan it normally. */
813 UPDATE_SYNTAX_CACHE_FORWARD (from - 1);
819 find_end_of_comment (struct buffer *buf, Bufpos from, Bufpos stop, int comstyle)
823 /* mask to match comment styles against; for ST_COMMENT_STYLE, this
824 will get set to SYNTAX_COMMENT_STYLE_B, but never get checked */
825 int mask = comstyle ? SYNTAX_COMMENT_STYLE_B : SYNTAX_COMMENT_STYLE_A;
827 /* This is only called by functions which have already set up the
828 syntax_cache and are keeping it up-to-date */
836 UPDATE_SYNTAX_CACHE_FORWARD (from);
837 c = BUF_FETCH_CHAR (buf, from);
839 /* Test for generic comments */
840 if (comstyle == ST_COMMENT_STYLE)
842 if (SYNTAX_FROM_CACHE (mirrortab, c) == Scomment_fence)
845 UPDATE_SYNTAX_CACHE_FORWARD (from);
849 continue; /* No need to test other comment styles in a
854 if (SYNTAX_FROM_CACHE (mirrortab, c) == Sendcomment
855 && SYNTAX_CODE_MATCHES_1CHAR_P
856 (SYNTAX_CODE_FROM_CACHE (mirrortab, c), mask))
857 /* we have encountered a comment end of the same style
858 as the comment sequence which began this comment
862 UPDATE_SYNTAX_CACHE_FORWARD (from);
866 prev_code = SYNTAX_CODE_FROM_CACHE (mirrortab, c);
868 UPDATE_SYNTAX_CACHE_FORWARD (from);
870 && SYNTAX_CODES_MATCH_END_P
872 SYNTAX_CODE_FROM_CACHE (mirrortab, BUF_FETCH_CHAR (buf, from)),
876 /* we have encountered a comment end of the same style
877 as the comment sequence which began this comment
881 UPDATE_SYNTAX_CACHE_FORWARD (from);
889 /* #### between FSF 19.23 and 19.28 there are some changes to the logic
890 in this function (and minor changes to find_start_of_comment(),
891 above, which is part of Fforward_comment() in FSF). Attempts to port
892 that logic made this function break, so I'm leaving it out. If anyone
893 ever complains about this function not working properly, take a look
894 at those changes. --ben */
896 DEFUN ("forward-comment", Fforward_comment, 0, 2, 0, /*
897 Move forward across up to COUNT comments, or backwards if COUNT is negative.
898 Stop scanning if we find something other than a comment or whitespace.
899 Set point to where scanning stops.
900 If COUNT comments are found as expected, with nothing except whitespace
901 between them, return t; otherwise return nil.
902 Point is set in either case.
903 COUNT defaults to 1, and BUFFER defaults to the current buffer.
910 enum syntaxcode code;
913 struct buffer *buf = decode_buffer (buffer, 0);
925 SETUP_SYNTAX_CACHE (from, n);
933 int comstyle = 0; /* mask for finding matching comment style */
935 if (char_quoted (buf, from))
941 UPDATE_SYNTAX_CACHE_FORWARD (from);
942 c = BUF_FETCH_CHAR (buf, from);
943 code = SYNTAX_FROM_CACHE (mirrortab, c);
944 syncode = SYNTAX_CODE_FROM_CACHE (mirrortab, c);
946 if (code == Scomment)
948 /* we have encountered a single character comment start
949 sequence, and we are ignoring all text inside comments.
950 we must record the comment style this character begins
951 so that later, only a comment end of the same style actually
952 ends the comment section */
953 comstyle = SYNTAX_CODE_COMMENT_1CHAR_MASK (syncode)
954 == SYNTAX_COMMENT_STYLE_A ? 0 : 1;
957 else if (code == Scomment_fence)
961 comstyle = ST_COMMENT_STYLE;
965 && SYNTAX_CODE_START_FIRST_P (syncode))
968 UPDATE_SYNTAX_CACHE_FORWARD (from + 1);
970 SYNTAX_CODE_FROM_CACHE (mirrortab,
971 BUF_FETCH_CHAR (buf, from + 1));
973 if (SYNTAX_CODES_START_P (syncode, next_syncode))
975 /* we have encountered a 2char comment start sequence and we
976 are ignoring all text inside comments. we must record
977 the comment style this sequence begins so that later,
978 only a comment end of the same style actually ends
979 the comment section */
982 SYNTAX_CODES_COMMENT_MASK_START (syncode, next_syncode)
983 == SYNTAX_COMMENT_STYLE_A ? 0 : 1;
988 if (code == Scomment)
990 Bufpos newfrom = find_end_of_comment (buf, from, stop, comstyle);
993 /* we stopped because from==stop */
994 BUF_SET_PT (buf, stop);
999 /* We have skipped one comment. */
1002 else if (code != Swhitespace
1003 && code != Sendcomment
1004 && code != Scomment )
1006 BUF_SET_PT (buf, from);
1012 /* End of comment reached */
1020 stop = BUF_BEGV (buf);
1023 int comstyle = 0; /* mask for finding matching comment style */
1026 if (char_quoted (buf, from))
1032 c = BUF_FETCH_CHAR (buf, from);
1033 code = SYNTAX_FROM_CACHE (mirrortab, c);
1034 syncode = SYNTAX_CODE_FROM_CACHE (mirrortab, c);
1036 if (code == Sendcomment)
1038 /* we have found a single char end comment. we must record
1039 the comment style encountered so that later, we can match
1040 only the proper comment begin sequence of the same style */
1041 comstyle = SYNTAX_CODE_COMMENT_1CHAR_MASK (syncode)
1042 == SYNTAX_COMMENT_STYLE_A ? 0 : 1;
1045 else if (code == Scomment_fence)
1048 comstyle = ST_COMMENT_STYLE;
1051 else if (from > stop
1052 && SYNTAX_CODE_END_SECOND_P (syncode))
1055 UPDATE_SYNTAX_CACHE_BACKWARD (from - 1);
1057 SYNTAX_CODE_FROM_CACHE (mirrortab,
1058 BUF_FETCH_CHAR (buf, from - 1));
1059 if (SYNTAX_CODES_END_P (prev_syncode, syncode))
1061 /* We must record the comment style encountered so that
1062 later, we can match only the proper comment begin
1063 sequence of the same style. */
1065 comstyle = SYNTAX_CODES_COMMENT_MASK_END
1066 (prev_syncode, syncode) == SYNTAX_COMMENT_STYLE_A ? 0 : 1;
1071 if (code == Sendcomment)
1073 from = find_start_of_comment (buf, from, stop, comstyle);
1077 else if (code != Swhitespace
1079 && code != Sendcomment)
1081 BUF_SET_PT (buf, from + 1);
1089 BUF_SET_PT (buf, from);
1095 scan_lists (struct buffer *buf, Bufpos from, int count, int depth,
1096 int sexpflag, int noerror)
1102 enum syntaxcode code;
1104 int min_depth = depth; /* Err out if depth gets less than this. */
1106 if (depth > 0) min_depth = 0;
1108 SETUP_SYNTAX_CACHE_FOR_BUFFER (buf, from, count);
1113 stop = BUF_ZV (buf);
1116 int comstyle = 0; /* mask for finding matching comment style */
1118 UPDATE_SYNTAX_CACHE_FORWARD (from);
1119 c = BUF_FETCH_CHAR (buf, from);
1120 code = SYNTAX_FROM_CACHE (mirrortab, c);
1121 syncode = SYNTAX_CODE_FROM_CACHE (mirrortab, c);
1124 /* a 1-char comment start sequence */
1125 if (code == Scomment && parse_sexp_ignore_comments)
1127 comstyle = SYNTAX_CODE_COMMENT_1CHAR_MASK (syncode) ==
1128 SYNTAX_COMMENT_STYLE_A ? 0 : 1;
1131 /* else, a 2-char comment start sequence? */
1132 else if (from < stop
1133 && SYNTAX_CODE_START_FIRST_P (syncode)
1134 && parse_sexp_ignore_comments)
1137 UPDATE_SYNTAX_CACHE_FORWARD (from);
1139 SYNTAX_CODE_FROM_CACHE (mirrortab, BUF_FETCH_CHAR (buf, from));
1141 if (SYNTAX_CODES_START_P (syncode, next_syncode))
1143 /* we have encountered a comment start sequence and we
1144 are ignoring all text inside comments. we must record
1145 the comment style this sequence begins so that later,
1146 only a comment end of the same style actually ends
1147 the comment section */
1149 comstyle = SYNTAX_CODES_COMMENT_MASK_START
1150 (syncode, next_syncode) == SYNTAX_COMMENT_STYLE_A ? 0 : 1;
1154 UPDATE_SYNTAX_CACHE_FORWARD (from);
1156 if (SYNTAX_CODE_PREFIX (syncode))
1163 if (from == stop) goto lose;
1165 /* treat following character as a word constituent */
1168 if (depth || !sexpflag) break;
1169 /* This word counts as a sexp; return at end of it. */
1172 UPDATE_SYNTAX_CACHE_FORWARD (from);
1173 switch (SYNTAX_FROM_CACHE (mirrortab,
1174 BUF_FETCH_CHAR (buf, from)))
1179 if (from == stop) goto lose;
1192 case Scomment_fence:
1193 comstyle = ST_COMMENT_STYLE;
1195 if (!parse_sexp_ignore_comments)
1197 UPDATE_SYNTAX_CACHE_FORWARD (from);
1200 find_end_of_comment (buf, from, stop, comstyle);
1203 /* we stopped because from == stop in search forward */
1216 if (from != stop && c == BUF_FETCH_CHAR (buf, from))
1226 if (!++depth) goto done;
1231 if (!--depth) goto done;
1232 if (depth < min_depth)
1236 error ("Containing expression ends prematurely");
1245 if (code != Sstring_fence)
1247 /* XEmacs change: call syntax_match on character */
1248 Emchar ch = BUF_FETCH_CHAR (buf, from - 1);
1249 Lisp_Object stermobj =
1250 syntax_match (syntax_cache.current_syntax_table, ch);
1252 if (CHARP (stermobj))
1253 stringterm = XCHAR (stermobj);
1258 stringterm = '\0'; /* avoid compiler warnings */
1264 UPDATE_SYNTAX_CACHE_FORWARD (from);
1265 c = BUF_FETCH_CHAR (buf, from);
1268 : SYNTAX_FROM_CACHE (mirrortab, c) == Sstring_fence)
1271 switch (SYNTAX_FROM_CACHE (mirrortab, c))
1283 if (!depth && sexpflag) goto done;
1292 /* Reached end of buffer. Error if within object,
1293 return nil if between */
1294 if (depth) goto lose;
1298 /* End of object reached */
1307 stop = BUF_BEGV (buf);
1310 int comstyle = 0; /* mask for finding matching comment style */
1313 UPDATE_SYNTAX_CACHE_BACKWARD (from);
1314 quoted = char_quoted (buf, from);
1318 UPDATE_SYNTAX_CACHE_BACKWARD (from);
1321 c = BUF_FETCH_CHAR (buf, from);
1322 code = SYNTAX_FROM_CACHE (mirrortab, c);
1323 syncode = SYNTAX_CODE_FROM_CACHE (mirrortab, c);
1325 if (code == Sendcomment && parse_sexp_ignore_comments)
1327 /* we have found a single char end comment. we must record
1328 the comment style encountered so that later, we can match
1329 only the proper comment begin sequence of the same style */
1330 comstyle = SYNTAX_CODE_COMMENT_1CHAR_MASK (syncode)
1331 == SYNTAX_COMMENT_STYLE_A ? 0 : 1;
1334 else if (from > stop
1335 && SYNTAX_CODE_END_SECOND_P (syncode)
1336 && !char_quoted (buf, from - 1)
1337 && parse_sexp_ignore_comments)
1340 UPDATE_SYNTAX_CACHE_BACKWARD (from - 1);
1341 prev_syncode = SYNTAX_CODE_FROM_CACHE
1342 (mirrortab, BUF_FETCH_CHAR (buf, from - 1));
1344 if (SYNTAX_CODES_END_P (prev_syncode, syncode))
1346 /* we must record the comment style encountered so that
1347 later, we can match only the proper comment begin
1348 sequence of the same style */
1350 comstyle = SYNTAX_CODES_COMMENT_MASK_END
1351 (prev_syncode, syncode) == SYNTAX_COMMENT_STYLE_A ? 0 : 1;
1356 if (SYNTAX_CODE_PREFIX (syncode))
1359 switch (quoted ? Sword : code)
1363 if (depth || !sexpflag) break;
1364 /* This word counts as a sexp; count object finished after
1368 UPDATE_SYNTAX_CACHE_BACKWARD (from);
1369 quoted = char_quoted (buf, from - 1);
1375 SYNTAX_FROM_CACHE (mirrortab,
1376 BUF_FETCH_CHAR (buf, from - 1)))
1378 || syncode == Ssymbol
1379 || syncode == Squote))
1388 if (from != stop && c == BUF_FETCH_CHAR (buf, from - 1))
1398 if (!++depth) goto done2;
1403 if (!--depth) goto done2;
1404 if (depth < min_depth)
1408 error ("Containing expression ends prematurely");
1412 case Scomment_fence:
1413 comstyle = ST_COMMENT_STYLE;
1415 if (parse_sexp_ignore_comments)
1416 from = find_start_of_comment (buf, from, stop, comstyle);
1424 if (code != Sstring_fence)
1426 /* XEmacs change: call syntax_match() on character */
1427 Emchar ch = BUF_FETCH_CHAR (buf, from);
1428 Lisp_Object stermobj =
1429 syntax_match (syntax_cache.current_syntax_table, ch);
1431 if (CHARP (stermobj))
1432 stringterm = XCHAR (stermobj);
1437 stringterm = '\0'; /* avoid compiler warnings */
1441 if (from == stop) goto lose;
1443 UPDATE_SYNTAX_CACHE_BACKWARD (from - 1);
1444 c = BUF_FETCH_CHAR (buf, from - 1);
1446 if ((code == Sstring
1448 : SYNTAX_FROM_CACHE (mirrortab, c) == Sstring_fence)
1449 && !char_quoted (buf, from - 1))
1457 if (!depth && sexpflag) goto done2;
1463 /* Reached start of buffer. Error if within object,
1464 return nil if between */
1465 if (depth) goto lose;
1474 return (make_int (from));
1478 error ("Unbalanced parentheses");
1483 char_quoted (struct buffer *buf, Bufpos pos)
1485 enum syntaxcode code;
1486 Bufpos beg = BUF_BEGV (buf);
1488 Bufpos startpos = pos;
1492 UPDATE_SYNTAX_CACHE_BACKWARD (pos - 1);
1493 code = SYNTAX_FROM_CACHE (mirrortab, BUF_FETCH_CHAR (buf, pos - 1));
1495 if (code != Scharquote && code != Sescape)
1501 UPDATE_SYNTAX_CACHE (startpos);
1505 DEFUN ("scan-lists", Fscan_lists, 3, 5, 0, /*
1506 Scan from character number FROM by COUNT lists.
1507 Returns the character number of the position thus found.
1509 If DEPTH is nonzero, paren depth begins counting from that value,
1510 only places where the depth in parentheses becomes zero
1511 are candidates for stopping; COUNT such places are counted.
1512 Thus, a positive value for DEPTH means go out levels.
1514 Comments are ignored if `parse-sexp-ignore-comments' is non-nil.
1516 If the beginning or end of (the accessible part of) the buffer is reached
1517 and the depth is wrong, an error is signaled.
1518 If the depth is right but the count is not used up, nil is returned.
1520 If optional arg BUFFER is non-nil, scanning occurs in that buffer instead
1521 of in the current buffer.
1523 If optional arg NOERROR is non-nil, scan-lists will return nil instead of
1524 signalling an error.
1526 (from, count, depth, buffer, noerror))
1533 buf = decode_buffer (buffer, 0);
1535 return scan_lists (buf, XINT (from), XINT (count), XINT (depth), 0,
1539 DEFUN ("scan-sexps", Fscan_sexps, 2, 4, 0, /*
1540 Scan from character number FROM by COUNT balanced expressions.
1541 If COUNT is negative, scan backwards.
1542 Returns the character number of the position thus found.
1544 Comments are ignored if `parse-sexp-ignore-comments' is non-nil.
1546 If the beginning or end of (the accessible part of) the buffer is reached
1547 in the middle of a parenthetical grouping, an error is signaled.
1548 If the beginning or end is reached between groupings
1549 but before count is used up, nil is returned.
1551 If optional arg BUFFER is non-nil, scanning occurs in that buffer instead
1552 of in the current buffer.
1554 If optional arg NOERROR is non-nil, scan-sexps will return nil instead of
1555 signalling an error.
1557 (from, count, buffer, noerror))
1559 struct buffer *buf = decode_buffer (buffer, 0);
1563 return scan_lists (buf, XINT (from), XINT (count), 0, 1, !NILP (noerror));
1566 DEFUN ("backward-prefix-chars", Fbackward_prefix_chars, 0, 1, 0, /*
1567 Move point backward over any number of chars with prefix syntax.
1568 This includes chars with "quote" or "prefix" syntax (' or p).
1570 Optional arg BUFFER defaults to the current buffer.
1574 struct buffer *buf = decode_buffer (buffer, 0);
1575 Bufpos beg = BUF_BEGV (buf);
1576 Bufpos pos = BUF_PT (buf);
1579 Lisp_Char_Table *mirrortab = XCHAR_TABLE (buf->syntax_table);
1581 Lisp_Char_Table *mirrortab = XCHAR_TABLE (buf->mirror_syntax_table);
1584 Emchar c = '\0'; /* initialize to avoid compiler warnings */
1587 SETUP_SYNTAX_CACHE_FOR_BUFFER (buf, pos, -1);
1589 while (pos > beg && !char_quoted (buf, pos - 1)
1590 /* Previous statement updates syntax table. */
1591 && (SYNTAX_FROM_CACHE (mirrortab, c = BUF_FETCH_CHAR (buf, pos - 1)) == Squote
1592 || SYNTAX_CODE_PREFIX (SYNTAX_CODE_FROM_CACHE (mirrortab, c))))
1595 BUF_SET_PT (buf, pos);
1600 /* Parse forward from FROM to END,
1601 assuming that FROM has state OLDSTATE (nil means FROM is start of function),
1602 and return a description of the state of the parse at END.
1603 If STOPBEFORE is nonzero, stop at the start of an atom.
1604 If COMMENTSTOP is nonzero, stop at the start of a comment. */
1607 scan_sexps_forward (struct buffer *buf, struct lisp_parse_state *stateptr,
1608 Bufpos from, Bufpos end,
1609 int targetdepth, int stopbefore,
1610 Lisp_Object oldstate,
1613 struct lisp_parse_state state;
1615 enum syntaxcode code;
1616 struct level { int last, prev; };
1617 struct level levelstart[100];
1618 struct level *curlevel = levelstart;
1619 struct level *endlevel = levelstart + 100;
1620 int depth; /* Paren depth of current scanning location.
1621 level - levelstart equals this except
1622 when the depth becomes negative. */
1623 int mindepth; /* Lowest DEPTH value seen. */
1624 int start_quoted = 0; /* Nonzero means starting after a char quote */
1625 int boundary_stop = commentstop == -1;
1628 SETUP_SYNTAX_CACHE (from, 1);
1629 if (NILP (oldstate))
1632 state.instring = -1;
1633 state.incomment = 0;
1634 state.comstyle = 0; /* comment style a by default */
1635 state.comstr_start = -1; /* no comment/string seen. */
1639 tem = Fcar (oldstate); /* elt 0, depth */
1645 oldstate = Fcdr (oldstate);
1646 oldstate = Fcdr (oldstate);
1647 oldstate = Fcdr (oldstate);
1648 tem = Fcar (oldstate); /* elt 3, instring */
1649 state.instring = ( !NILP (tem)
1650 ? ( INTP (tem) ? XINT (tem) : ST_STRING_STYLE)
1653 oldstate = Fcdr (oldstate);
1654 tem = Fcar (oldstate); /* elt 4, incomment */
1655 state.incomment = !NILP (tem);
1657 oldstate = Fcdr (oldstate);
1658 tem = Fcar (oldstate); /* elt 5, follows-quote */
1659 start_quoted = !NILP (tem);
1661 /* if the eighth element of the list is nil, we are in comment style
1662 a; if it is t, we are in comment style b; if it is 'syntax-table,
1663 we are in a generic comment */
1664 oldstate = Fcdr (oldstate);
1665 oldstate = Fcdr (oldstate);
1666 tem = Fcar (oldstate); /* elt 7, comment style a/b/fence */
1667 state.comstyle = NILP (tem) ? 0 : ( EQ (tem, Qsyntax_table)
1668 ? ST_COMMENT_STYLE : 1 );
1670 oldstate = Fcdr (oldstate); /* elt 8, start of last comment/string */
1671 tem = Fcar (oldstate);
1672 state.comstr_start = NILP (tem) ? -1 : XINT (tem);
1674 /* elt 9, char numbers of starts-of-expression of levels
1675 (starting from outermost). */
1676 oldstate = Fcdr (oldstate);
1677 tem = Fcar (oldstate); /* elt 9, intermediate data for
1678 continuation of parsing (subject
1680 while (!NILP (tem)) /* >= second enclosing sexps. */
1682 curlevel->last = XINT (Fcar (tem));
1683 if (++curlevel == endlevel)
1684 error ("Nesting too deep for parser");
1685 curlevel->prev = -1;
1686 curlevel->last = -1;
1693 curlevel->prev = -1;
1694 curlevel->last = -1;
1696 /* Enter the loop at a place appropriate for initial state. */
1698 if (state.incomment) goto startincomment;
1699 if (state.instring >= 0)
1701 if (start_quoted) goto startquotedinstring;
1704 if (start_quoted) goto startquoted;
1713 UPDATE_SYNTAX_CACHE_FORWARD (from);
1714 c = BUF_FETCH_CHAR (buf, from);
1715 code = SYNTAX_FROM_CACHE (mirrortab, c);
1716 syncode = SYNTAX_CODE_FROM_CACHE (mirrortab, c);
1719 /* record the comment style we have entered so that only the
1720 comment-ender sequence (or single char) of the same style
1721 actually terminates the comment section. */
1722 if (code == Scomment)
1725 SYNTAX_CODE_COMMENT_1CHAR_MASK (syncode)
1726 == SYNTAX_COMMENT_STYLE_A ? 0 : 1;
1727 state.comstr_start = from - 1;
1730 /* a generic comment delimiter? */
1731 else if (code == Scomment_fence)
1733 state.comstyle = ST_COMMENT_STYLE;
1734 state.comstr_start = from - 1;
1738 else if (from < end &&
1739 SYNTAX_CODE_START_FIRST_P (syncode))
1742 UPDATE_SYNTAX_CACHE_FORWARD (from);
1744 SYNTAX_CODE_FROM_CACHE (mirrortab, BUF_FETCH_CHAR (buf, from));
1746 if (SYNTAX_CODES_START_P (syncode, next_syncode))
1749 state.comstyle = SYNTAX_CODES_COMMENT_MASK_START
1750 (syncode, next_syncode) == SYNTAX_COMMENT_STYLE_A ? 0 : 1;
1751 state.comstr_start = from - 1;
1753 UPDATE_SYNTAX_CACHE_FORWARD (from);
1757 if (SYNTAX_CODE_PREFIX (syncode))
1763 if (stopbefore) goto stop; /* this arg means stop at sexp start */
1764 curlevel->last = from - 1;
1766 if (from == end) goto endquoted;
1769 /* treat following character as a word constituent */
1772 if (stopbefore) goto stop; /* this arg means stop at sexp start */
1773 curlevel->last = from - 1;
1777 UPDATE_SYNTAX_CACHE_FORWARD (from);
1778 switch (SYNTAX_FROM_CACHE (mirrortab, BUF_FETCH_CHAR (buf, from)))
1783 if (from == end) goto endquoted;
1795 curlevel->prev = curlevel->last;
1799 state.incomment = 1;
1800 if (commentstop || boundary_stop) goto done;
1802 if (commentstop == 1)
1804 UPDATE_SYNTAX_CACHE_FORWARD (from);
1806 Bufpos newfrom = find_end_of_comment (buf, from, end, state.comstyle);
1809 /* we terminated search because from == end */
1815 state.incomment = 0;
1816 state.comstyle = 0; /* reset the comment style */
1817 if (boundary_stop) goto done;
1821 if (stopbefore) goto stop; /* this arg means stop at sexp start */
1823 /* curlevel++->last ran into compiler bug on Apollo */
1824 curlevel->last = from - 1;
1825 if (++curlevel == endlevel)
1826 error ("Nesting too deep for parser");
1827 curlevel->prev = -1;
1828 curlevel->last = -1;
1829 if (targetdepth == depth) goto done;
1834 if (depth < mindepth)
1836 if (curlevel != levelstart)
1838 curlevel->prev = curlevel->last;
1839 if (targetdepth == depth) goto done;
1844 state.comstr_start = from - 1;
1845 if (stopbefore) goto stop; /* this arg means stop at sexp start */
1846 curlevel->last = from - 1;
1847 if (code == Sstring_fence)
1849 state.instring = ST_STRING_STYLE;
1853 /* XEmacs change: call syntax_match() on character */
1854 Emchar ch = BUF_FETCH_CHAR (buf, from - 1);
1855 Lisp_Object stermobj =
1856 syntax_match (syntax_cache.current_syntax_table, ch);
1858 if (CHARP (stermobj))
1859 state.instring = XCHAR (stermobj);
1861 state.instring = ch;
1863 if (boundary_stop) goto done;
1867 enum syntaxcode temp_code;
1869 if (from >= end) goto done;
1871 UPDATE_SYNTAX_CACHE_FORWARD (from);
1872 c = BUF_FETCH_CHAR (buf, from);
1873 temp_code = SYNTAX_FROM_CACHE (mirrortab, c);
1876 state.instring != ST_STRING_STYLE &&
1877 temp_code == Sstring &&
1878 c == state.instring) break;
1883 if (state.instring == ST_STRING_STYLE)
1890 startquotedinstring:
1891 if (from >= end) goto endquoted;
1900 state.instring = -1;
1901 curlevel->prev = curlevel->last;
1903 if (boundary_stop) goto done;
1913 case Scomment_fence:
1921 stop: /* Here if stopping before start of sexp. */
1922 from--; /* We have just fetched the char that starts it; */
1923 goto done; /* but return the position before it. */
1928 state.depth = depth;
1929 state.mindepth = mindepth;
1930 state.thislevelstart = curlevel->prev;
1931 state.prevlevelstart
1932 = (curlevel == levelstart) ? -1 : (curlevel - 1)->last;
1933 state.location = from;
1934 state.levelstarts = Qnil;
1935 while (--curlevel >= levelstart)
1936 state.levelstarts = Fcons (make_int (curlevel->last),
1942 DEFUN ("parse-partial-sexp", Fparse_partial_sexp, 2, 7, 0, /*
1943 Parse Lisp syntax starting at FROM until TO; return status of parse at TO.
1944 Parsing stops at TO or when certain criteria are met;
1945 point is set to where parsing stops.
1946 If fifth arg OLDSTATE is omitted or nil,
1947 parsing assumes that FROM is the beginning of a function.
1948 Value is a list of nine elements describing final state of parsing:
1950 1. character address of start of innermost containing list; nil if none.
1951 2. character address of start of last complete sexp terminated.
1952 3. non-nil if inside a string.
1953 (It is the character that will terminate the string,
1954 or t if the string should be terminated by an explicit
1955 `syntax-table' property.)
1956 4. t if inside a comment.
1957 5. t if following a quote character.
1958 6. the minimum paren-depth encountered during this scan.
1959 7. nil if in comment style a, or not in a comment; t if in comment style b;
1960 `syntax-table' if given by an explicit `syntax-table' property.
1961 8. character address of start of last comment or string; nil if none.
1962 9. Intermediate data for continuation of parsing (subject to change).
1963 If third arg TARGETDEPTH is non-nil, parsing stops if the depth
1964 in parentheses becomes equal to TARGETDEPTH.
1965 Fourth arg STOPBEFORE non-nil means stop when come to
1966 any character that starts a sexp.
1967 Fifth arg OLDSTATE is a nine-element list like what this function returns.
1968 It is used to initialize the state of the parse. Its second and third
1969 elements are ignored.
1970 Sixth arg COMMENTSTOP non-nil means stop at the start of a comment. If it
1971 is `syntax-table', stop after the start of a comment or a string, or after
1972 the end of a comment or string.
1974 (from, to, targetdepth, stopbefore, oldstate, commentstop, buffer))
1976 struct lisp_parse_state state;
1979 struct buffer *buf = decode_buffer (buffer, 0);
1982 if (!NILP (targetdepth))
1984 CHECK_INT (targetdepth);
1985 target = XINT (targetdepth);
1988 target = -100000; /* We won't reach this depth */
1990 get_buffer_range_char (buf, from, to, &start, &end, 0);
1991 scan_sexps_forward (buf, &state, start, end,
1992 target, !NILP (stopbefore), oldstate,
1994 ? 0 : (EQ (commentstop, Qsyntax_table) ? -1 : 1)));
1995 BUF_SET_PT (buf, state.location);
1999 val = Fcons (state.levelstarts, val);
2000 val = Fcons ((state.incomment || (state.instring >= 0))
2001 ? make_int (state.comstr_start) : Qnil, val);
2002 val = Fcons (state.comstyle ? (state.comstyle == ST_COMMENT_STYLE
2003 ? Qsyntax_table : Qt) : Qnil, val);
2004 val = Fcons (make_int (state.mindepth), val);
2005 val = Fcons (state.quoted ? Qt : Qnil, val);
2006 val = Fcons (state.incomment ? Qt : Qnil, val);
2007 val = Fcons (state.instring < 0
2009 : (state.instring == ST_STRING_STYLE
2010 ? Qt : make_int (state.instring)), val);
2011 val = Fcons (state.thislevelstart < 0 ? Qnil : make_int (state.thislevelstart), val);
2012 val = Fcons (state.prevlevelstart < 0 ? Qnil : make_int (state.prevlevelstart), val);
2013 val = Fcons (make_int (state.depth), val);
2019 /* Updating of the mirror syntax table.
2021 Each syntax table has a corresponding mirror table in it.
2022 Whenever we make a change to a syntax table, we call
2023 update_syntax_table() on it.
2025 #### We really only need to map over the changed range.
2027 If we change the standard syntax table, we need to map over
2028 all tables because any of them could be inheriting from the
2029 standard syntax table.
2031 When `set-syntax-table' is called, we set the buffer's mirror
2032 syntax table as well.
2037 Lisp_Object mirrortab;
2042 cmst_mapfun (struct chartab_range *range, Lisp_Object val, void *arg)
2044 struct cmst_arg *closure = (struct cmst_arg *) arg;
2048 if (SYNTAX_FROM_CODE (XINT (val)) == Sinherit
2049 && closure->check_inherit)
2051 struct cmst_arg recursive;
2053 recursive.mirrortab = closure->mirrortab;
2054 recursive.check_inherit = 0;
2055 map_char_table (XCHAR_TABLE (Vstandard_syntax_table), range,
2056 cmst_mapfun, &recursive);
2059 put_char_table (XCHAR_TABLE (closure->mirrortab), range, val);
2065 update_just_this_syntax_table (Lisp_Char_Table *ct)
2067 struct chartab_range range;
2068 struct cmst_arg arg;
2070 arg.mirrortab = ct->mirror_table;
2071 arg.check_inherit = (CHAR_TABLEP (Vstandard_syntax_table)
2072 && ct != XCHAR_TABLE (Vstandard_syntax_table));
2073 range.type = CHARTAB_RANGE_ALL;
2074 map_char_table (ct, &range, cmst_mapfun, &arg);
2077 /* Called from chartab.c when a change is made to a syntax table.
2078 If this is the standard syntax table, we need to recompute
2079 *all* syntax tables (yuck). Otherwise we just recompute this
2083 update_syntax_table (Lisp_Char_Table *ct)
2085 /* Don't be stymied at startup. */
2086 if (CHAR_TABLEP (Vstandard_syntax_table)
2087 && ct == XCHAR_TABLE (Vstandard_syntax_table))
2091 for (syntab = Vall_syntax_tables; !NILP (syntab);
2092 syntab = XCHAR_TABLE (syntab)->next_table)
2093 update_just_this_syntax_table (XCHAR_TABLE (syntab));
2096 update_just_this_syntax_table (ct);
2101 /************************************************************************/
2102 /* initialization */
2103 /************************************************************************/
2106 syms_of_syntax (void)
2108 defsymbol (&Qsyntax_table_p, "syntax-table-p");
2109 defsymbol (&Qsyntax_table, "syntax-table");
2111 DEFSUBR (Fsyntax_table_p);
2112 DEFSUBR (Fsyntax_table);
2113 DEFSUBR (Fstandard_syntax_table);
2114 DEFSUBR (Fcopy_syntax_table);
2115 DEFSUBR (Fset_syntax_table);
2116 DEFSUBR (Fsyntax_designator_chars);
2117 DEFSUBR (Fchar_syntax);
2118 DEFSUBR (Fmatching_paren);
2119 /* DEFSUBR (Fmodify_syntax_entry); now in Lisp. */
2120 /* DEFSUBR (Fdescribe_syntax); now in Lisp. */
2122 DEFSUBR (Fforward_word);
2124 DEFSUBR (Fforward_comment);
2125 DEFSUBR (Fscan_lists);
2126 DEFSUBR (Fscan_sexps);
2127 DEFSUBR (Fbackward_prefix_chars);
2128 DEFSUBR (Fparse_partial_sexp);
2132 vars_of_syntax (void)
2134 DEFVAR_BOOL ("parse-sexp-ignore-comments", &parse_sexp_ignore_comments /*
2135 Non-nil means `forward-sexp', etc., should treat comments as whitespace.
2137 parse_sexp_ignore_comments = 0;
2139 DEFVAR_BOOL ("lookup-syntax-properties", &lookup_syntax_properties /*
2140 Non-nil means `forward-sexp', etc., grant `syntax-table' property.
2141 The value of this property should be either a syntax table, or a cons
2142 of the form (SYNTAXCODE . MATCHCHAR), SYNTAXCODE being the numeric
2143 syntax code, MATCHCHAR being nil or the character to match (which is
2144 relevant only for open/close type.
2146 lookup_syntax_properties = 1;
2148 DEFVAR_BOOL ("words-include-escapes", &words_include_escapes /*
2149 Non-nil means `forward-word', etc., should treat escape chars part of words.
2151 words_include_escapes = 0;
2153 no_quit_in_re_search = 0;
2157 define_standard_syntax (const char *p, enum syntaxcode syn)
2160 Fput_char_table (make_char (*p), make_int (syn), Vstandard_syntax_table);
2164 complex_vars_of_syntax (void)
2168 /* Set this now, so first buffer creation can refer to it. */
2169 /* Make it nil before calling copy-syntax-table
2170 so that copy-syntax-table will know not to try to copy from garbage */
2171 Vstandard_syntax_table = Qnil;
2172 Vstandard_syntax_table = Fcopy_syntax_table (Qnil);
2173 staticpro (&Vstandard_syntax_table);
2175 Vsyntax_designator_chars_string = make_string_nocopy (syntax_code_spec,
2177 staticpro (&Vsyntax_designator_chars_string);
2179 fill_char_table (XCHAR_TABLE (Vstandard_syntax_table), make_int (Spunct));
2181 for (i = 0; i <= 32; i++) /* Control 0 plus SPACE */
2182 Fput_char_table (make_char (i), make_int (Swhitespace),
2183 Vstandard_syntax_table);
2184 for (i = 127; i <= 159; i++) /* DEL plus Control 1 */
2185 Fput_char_table (make_char (i), make_int (Swhitespace),
2186 Vstandard_syntax_table);
2188 define_standard_syntax ("abcdefghijklmnopqrstuvwxyz"
2189 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
2192 define_standard_syntax ("\"", Sstring);
2193 define_standard_syntax ("\\", Sescape);
2194 define_standard_syntax ("_-+*/&|<>=", Ssymbol);
2195 define_standard_syntax (".,;:?!#@~^'`", Spunct);
2197 for (p = "()[]{}"; *p; p+=2)
2199 Fput_char_table (make_char (p[0]),
2200 Fcons (make_int (Sopen), make_char (p[1])),
2201 Vstandard_syntax_table);
2202 Fput_char_table (make_char (p[1]),
2203 Fcons (make_int (Sclose), make_char (p[0])),
2204 Vstandard_syntax_table);