* keyboard.c (parse_modifiers_uncached, parse_modifiers):
[emacs.git] / src / syntax.c
blob0a1525b54eac67be503f420de44e0f76a9997ecf
1 /* GNU Emacs routines to deal with syntax tables; also word and list parsing.
2 Copyright (C) 1985, 1987, 1993-1995, 1997-1999, 2001-2011
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <ctype.h>
23 #include <setjmp.h>
24 #include "lisp.h"
25 #include "commands.h"
26 #include "buffer.h"
27 #include "character.h"
28 #include "keymap.h"
29 #include "regex.h"
31 /* Make syntax table lookup grant data in gl_state. */
32 #define SYNTAX_ENTRY_VIA_PROPERTY
34 #include "syntax.h"
35 #include "intervals.h"
36 #include "category.h"
38 /* Then there are seven single-bit flags that have the following meanings:
39 1. This character is the first of a two-character comment-start sequence.
40 2. This character is the second of a two-character comment-start sequence.
41 3. This character is the first of a two-character comment-end sequence.
42 4. This character is the second of a two-character comment-end sequence.
43 5. This character is a prefix, for backward-prefix-chars.
44 6. The char is part of a delimiter for comments of style "b".
45 7. This character is part of a nestable comment sequence.
46 8. The char is part of a delimiter for comments of style "c".
47 Note that any two-character sequence whose first character has flag 1
48 and whose second character has flag 2 will be interpreted as a comment start.
50 bit 6 and 8 are used to discriminate between different comment styles.
51 Languages such as C++ allow two orthogonal syntax start/end pairs
52 and bit 6 is used to determine whether a comment-end or Scommentend
53 ends style a or b. Comment markers can start style a, b, c, or bc.
54 Style a is always the default.
55 For 2-char comment markers, the style b flag is only looked up on the second
56 char of the comment marker and on the first char of the comment ender.
57 For style c (like to for the nested flag), the flag can be placed on any
58 one of the chars.
61 /* These macros extract specific flags from an integer
62 that holds the syntax code and the flags. */
64 #define SYNTAX_FLAGS_COMSTART_FIRST(flags) (((flags) >> 16) & 1)
66 #define SYNTAX_FLAGS_COMSTART_SECOND(flags) (((flags) >> 17) & 1)
68 #define SYNTAX_FLAGS_COMEND_FIRST(flags) (((flags) >> 18) & 1)
70 #define SYNTAX_FLAGS_COMEND_SECOND(flags) (((flags) >> 19) & 1)
72 #define SYNTAX_FLAGS_PREFIX(flags) (((flags) >> 20) & 1)
74 #define SYNTAX_FLAGS_COMMENT_STYLEB(flags) (((flags) >> 21) & 1)
75 #define SYNTAX_FLAGS_COMMENT_STYLEC(flags) (((flags) >> 22) & 2)
76 /* FLAGS should be the flags of the main char of the comment marker, e.g.
77 the second for comstart and the first for comend. */
78 #define SYNTAX_FLAGS_COMMENT_STYLE(flags, other_flags) \
79 (SYNTAX_FLAGS_COMMENT_STYLEB (flags) \
80 | SYNTAX_FLAGS_COMMENT_STYLEC (flags) \
81 | SYNTAX_FLAGS_COMMENT_STYLEC (other_flags))
83 #define SYNTAX_FLAGS_COMMENT_NESTED(flags) (((flags) >> 22) & 1)
85 /* These macros extract a particular flag for a given character. */
87 #define SYNTAX_COMEND_FIRST(c) \
88 (SYNTAX_FLAGS_COMEND_FIRST (SYNTAX_WITH_FLAGS (c)))
89 #define SYNTAX_PREFIX(c) (SYNTAX_FLAGS_PREFIX (SYNTAX_WITH_FLAGS (c)))
91 /* We use these constants in place for comment-style and
92 string-ender-char to distinguish comments/strings started by
93 comment_fence and string_fence codes. */
95 #define ST_COMMENT_STYLE (256 + 1)
96 #define ST_STRING_STYLE (256 + 2)
98 Lisp_Object Qsyntax_table_p, Qsyntax_table, Qscan_error;
100 /* Used as a temporary in SYNTAX_ENTRY and other macros in syntax.h,
101 if not compiled with GCC. No need to mark it, since it is used
102 only very temporarily. */
103 Lisp_Object syntax_temp;
105 /* This is the internal form of the parse state used in parse-partial-sexp. */
107 struct lisp_parse_state
109 int depth; /* Depth at end of parsing. */
110 int instring; /* -1 if not within string, else desired terminator. */
111 int incomment; /* -1 if in unnestable comment else comment nesting */
112 int comstyle; /* comment style a=0, or b=1, or ST_COMMENT_STYLE. */
113 int quoted; /* Nonzero if just after an escape char at end of parsing */
114 int mindepth; /* Minimum depth seen while scanning. */
115 /* Char number of most recent start-of-expression at current level */
116 EMACS_INT thislevelstart;
117 /* Char number of start of containing expression */
118 EMACS_INT prevlevelstart;
119 EMACS_INT location; /* Char number at which parsing stopped. */
120 EMACS_INT comstr_start; /* Position of last comment/string starter. */
121 Lisp_Object levelstarts; /* Char numbers of starts-of-expression
122 of levels (starting from outermost). */
125 /* These variables are a cache for finding the start of a defun.
126 find_start_pos is the place for which the defun start was found.
127 find_start_value is the defun start position found for it.
128 find_start_value_byte is the corresponding byte position.
129 find_start_buffer is the buffer it was found in.
130 find_start_begv is the BEGV value when it was found.
131 find_start_modiff is the value of MODIFF when it was found. */
133 static EMACS_INT find_start_pos;
134 static EMACS_INT find_start_value;
135 static EMACS_INT find_start_value_byte;
136 static struct buffer *find_start_buffer;
137 static EMACS_INT find_start_begv;
138 static int find_start_modiff;
141 static Lisp_Object skip_chars (int, Lisp_Object, Lisp_Object, int);
142 static Lisp_Object skip_syntaxes (int, Lisp_Object, Lisp_Object);
143 static Lisp_Object scan_lists (EMACS_INT, EMACS_INT, EMACS_INT, int);
144 static void scan_sexps_forward (struct lisp_parse_state *,
145 EMACS_INT, EMACS_INT, EMACS_INT, int,
146 int, Lisp_Object, int);
147 static int in_classes (int, Lisp_Object);
149 /* Whether the syntax of the character C has the prefix flag set. */
150 int syntax_prefix_flag_p (int c)
152 return SYNTAX_PREFIX (c);
155 struct gl_state_s gl_state; /* Global state of syntax parser. */
157 #define INTERVALS_AT_ONCE 10 /* 1 + max-number of intervals
158 to scan to property-change. */
160 /* Update gl_state to an appropriate interval which contains CHARPOS. The
161 sign of COUNT give the relative position of CHARPOS wrt the previously
162 valid interval. If INIT, only [be]_property fields of gl_state are
163 valid at start, the rest is filled basing on OBJECT.
165 `gl_state.*_i' are the intervals, and CHARPOS is further in the search
166 direction than the intervals - or in an interval. We update the
167 current syntax-table basing on the property of this interval, and
168 update the interval to start further than CHARPOS - or be
169 NULL_INTERVAL. We also update lim_property to be the next value of
170 charpos to call this subroutine again - or be before/after the
171 start/end of OBJECT. */
173 void
174 update_syntax_table (EMACS_INT charpos, int count, int init,
175 Lisp_Object object)
177 Lisp_Object tmp_table;
178 int cnt = 0, invalidate = 1;
179 INTERVAL i;
181 if (init)
183 gl_state.old_prop = Qnil;
184 gl_state.start = gl_state.b_property;
185 gl_state.stop = gl_state.e_property;
186 i = interval_of (charpos, object);
187 gl_state.backward_i = gl_state.forward_i = i;
188 invalidate = 0;
189 if (NULL_INTERVAL_P (i))
190 return;
191 /* interval_of updates only ->position of the return value, so
192 update the parents manually to speed up update_interval. */
193 while (!NULL_PARENT (i))
195 if (AM_RIGHT_CHILD (i))
196 INTERVAL_PARENT (i)->position = i->position
197 - LEFT_TOTAL_LENGTH (i) + TOTAL_LENGTH (i) /* right end */
198 - TOTAL_LENGTH (INTERVAL_PARENT (i))
199 + LEFT_TOTAL_LENGTH (INTERVAL_PARENT (i));
200 else
201 INTERVAL_PARENT (i)->position = i->position - LEFT_TOTAL_LENGTH (i)
202 + TOTAL_LENGTH (i);
203 i = INTERVAL_PARENT (i);
205 i = gl_state.forward_i;
206 gl_state.b_property = i->position - gl_state.offset;
207 gl_state.e_property = INTERVAL_LAST_POS (i) - gl_state.offset;
208 goto update;
210 i = count > 0 ? gl_state.forward_i : gl_state.backward_i;
212 /* We are guaranteed to be called with CHARPOS either in i,
213 or further off. */
214 if (NULL_INTERVAL_P (i))
215 error ("Error in syntax_table logic for to-the-end intervals");
216 else if (charpos < i->position) /* Move left. */
218 if (count > 0)
219 error ("Error in syntax_table logic for intervals <-");
220 /* Update the interval. */
221 i = update_interval (i, charpos);
222 if (INTERVAL_LAST_POS (i) != gl_state.b_property)
224 invalidate = 0;
225 gl_state.forward_i = i;
226 gl_state.e_property = INTERVAL_LAST_POS (i) - gl_state.offset;
229 else if (charpos >= INTERVAL_LAST_POS (i)) /* Move right. */
231 if (count < 0)
232 error ("Error in syntax_table logic for intervals ->");
233 /* Update the interval. */
234 i = update_interval (i, charpos);
235 if (i->position != gl_state.e_property)
237 invalidate = 0;
238 gl_state.backward_i = i;
239 gl_state.b_property = i->position - gl_state.offset;
243 update:
244 tmp_table = textget (i->plist, Qsyntax_table);
246 if (invalidate)
247 invalidate = !EQ (tmp_table, gl_state.old_prop); /* Need to invalidate? */
249 if (invalidate) /* Did not get to adjacent interval. */
250 { /* with the same table => */
251 /* invalidate the old range. */
252 if (count > 0)
254 gl_state.backward_i = i;
255 gl_state.b_property = i->position - gl_state.offset;
257 else
259 gl_state.forward_i = i;
260 gl_state.e_property = INTERVAL_LAST_POS (i) - gl_state.offset;
264 if (!EQ (tmp_table, gl_state.old_prop))
266 gl_state.current_syntax_table = tmp_table;
267 gl_state.old_prop = tmp_table;
268 if (EQ (Fsyntax_table_p (tmp_table), Qt))
270 gl_state.use_global = 0;
272 else if (CONSP (tmp_table))
274 gl_state.use_global = 1;
275 gl_state.global_code = tmp_table;
277 else
279 gl_state.use_global = 0;
280 gl_state.current_syntax_table = BVAR (current_buffer, syntax_table);
284 while (!NULL_INTERVAL_P (i))
286 if (cnt && !EQ (tmp_table, textget (i->plist, Qsyntax_table)))
288 if (count > 0)
290 gl_state.e_property = i->position - gl_state.offset;
291 gl_state.forward_i = i;
293 else
295 gl_state.b_property
296 = i->position + LENGTH (i) - gl_state.offset;
297 gl_state.backward_i = i;
299 return;
301 else if (cnt == INTERVALS_AT_ONCE)
303 if (count > 0)
305 gl_state.e_property
306 = i->position + LENGTH (i) - gl_state.offset
307 /* e_property at EOB is not set to ZV but to ZV+1, so that
308 we can do INC(from);UPDATE_SYNTAX_TABLE_FORWARD without
309 having to check eob between the two. */
310 + (NULL_INTERVAL_P (next_interval (i)) ? 1 : 0);
311 gl_state.forward_i = i;
313 else
315 gl_state.b_property = i->position - gl_state.offset;
316 gl_state.backward_i = i;
318 return;
320 cnt++;
321 i = count > 0 ? next_interval (i) : previous_interval (i);
323 eassert (NULL_INTERVAL_P (i)); /* This property goes to the end. */
324 if (count > 0)
325 gl_state.e_property = gl_state.stop;
326 else
327 gl_state.b_property = gl_state.start;
330 /* Returns TRUE if char at CHARPOS is quoted.
331 Global syntax-table data should be set up already to be good at CHARPOS
332 or after. On return global syntax data is good for lookup at CHARPOS. */
334 static int
335 char_quoted (EMACS_INT charpos, EMACS_INT bytepos)
337 register enum syntaxcode code;
338 register EMACS_INT beg = BEGV;
339 register int quoted = 0;
340 EMACS_INT orig = charpos;
342 while (charpos > beg)
344 int c;
345 DEC_BOTH (charpos, bytepos);
347 UPDATE_SYNTAX_TABLE_BACKWARD (charpos);
348 c = FETCH_CHAR_AS_MULTIBYTE (bytepos);
349 code = SYNTAX (c);
350 if (! (code == Scharquote || code == Sescape))
351 break;
353 quoted = !quoted;
356 UPDATE_SYNTAX_TABLE (orig);
357 return quoted;
360 /* Return the bytepos one character before BYTEPOS.
361 We assume that BYTEPOS is not at the start of the buffer. */
363 static INLINE EMACS_INT
364 dec_bytepos (EMACS_INT bytepos)
366 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
367 return bytepos - 1;
369 DEC_POS (bytepos);
370 return bytepos;
373 /* Return a defun-start position before POS and not too far before.
374 It should be the last one before POS, or nearly the last.
376 When open_paren_in_column_0_is_defun_start is nonzero,
377 only the beginning of the buffer is treated as a defun-start.
379 We record the information about where the scan started
380 and what its result was, so that another call in the same area
381 can return the same value very quickly.
383 There is no promise at which position the global syntax data is
384 valid on return from the subroutine, so the caller should explicitly
385 update the global data. */
387 static EMACS_INT
388 find_defun_start (EMACS_INT pos, EMACS_INT pos_byte)
390 EMACS_INT opoint = PT, opoint_byte = PT_BYTE;
392 if (!open_paren_in_column_0_is_defun_start)
394 find_start_value_byte = BEGV_BYTE;
395 return BEGV;
398 /* Use previous finding, if it's valid and applies to this inquiry. */
399 if (current_buffer == find_start_buffer
400 /* Reuse the defun-start even if POS is a little farther on.
401 POS might be in the next defun, but that's ok.
402 Our value may not be the best possible, but will still be usable. */
403 && pos <= find_start_pos + 1000
404 && pos >= find_start_value
405 && BEGV == find_start_begv
406 && MODIFF == find_start_modiff)
407 return find_start_value;
409 /* Back up to start of line. */
410 scan_newline (pos, pos_byte, BEGV, BEGV_BYTE, -1, 1);
412 /* We optimize syntax-table lookup for rare updates. Thus we accept
413 only those `^\s(' which are good in global _and_ text-property
414 syntax-tables. */
415 SETUP_BUFFER_SYNTAX_TABLE ();
416 while (PT > BEGV)
418 int c;
420 /* Open-paren at start of line means we may have found our
421 defun-start. */
422 c = FETCH_CHAR_AS_MULTIBYTE (PT_BYTE);
423 if (SYNTAX (c) == Sopen)
425 SETUP_SYNTAX_TABLE (PT + 1, -1); /* Try again... */
426 c = FETCH_CHAR_AS_MULTIBYTE (PT_BYTE);
427 if (SYNTAX (c) == Sopen)
428 break;
429 /* Now fallback to the default value. */
430 SETUP_BUFFER_SYNTAX_TABLE ();
432 /* Move to beg of previous line. */
433 scan_newline (PT, PT_BYTE, BEGV, BEGV_BYTE, -2, 1);
436 /* Record what we found, for the next try. */
437 find_start_value = PT;
438 find_start_value_byte = PT_BYTE;
439 find_start_buffer = current_buffer;
440 find_start_modiff = MODIFF;
441 find_start_begv = BEGV;
442 find_start_pos = pos;
444 TEMP_SET_PT_BOTH (opoint, opoint_byte);
446 return find_start_value;
449 /* Return the SYNTAX_COMEND_FIRST of the character before POS, POS_BYTE. */
451 static int
452 prev_char_comend_first (EMACS_INT pos, EMACS_INT pos_byte)
454 int c, val;
456 DEC_BOTH (pos, pos_byte);
457 UPDATE_SYNTAX_TABLE_BACKWARD (pos);
458 c = FETCH_CHAR (pos_byte);
459 val = SYNTAX_COMEND_FIRST (c);
460 UPDATE_SYNTAX_TABLE_FORWARD (pos + 1);
461 return val;
464 /* Return the SYNTAX_COMSTART_FIRST of the character before POS, POS_BYTE. */
466 /* static int
467 * prev_char_comstart_first (pos, pos_byte)
468 * int pos, pos_byte;
470 * int c, val;
472 * DEC_BOTH (pos, pos_byte);
473 * UPDATE_SYNTAX_TABLE_BACKWARD (pos);
474 * c = FETCH_CHAR (pos_byte);
475 * val = SYNTAX_COMSTART_FIRST (c);
476 * UPDATE_SYNTAX_TABLE_FORWARD (pos + 1);
477 * return val;
478 * } */
480 /* Checks whether charpos FROM is at the end of a comment.
481 FROM_BYTE is the bytepos corresponding to FROM.
482 Do not move back before STOP.
484 Return a positive value if we find a comment ending at FROM/FROM_BYTE;
485 return -1 otherwise.
487 If successful, store the charpos of the comment's beginning
488 into *CHARPOS_PTR, and the bytepos into *BYTEPOS_PTR.
490 Global syntax data remains valid for backward search starting at
491 the returned value (or at FROM, if the search was not successful). */
493 static int
494 back_comment (EMACS_INT from, EMACS_INT from_byte, EMACS_INT stop, int comnested, int comstyle, EMACS_INT *charpos_ptr, EMACS_INT *bytepos_ptr)
496 /* Look back, counting the parity of string-quotes,
497 and recording the comment-starters seen.
498 When we reach a safe place, assume that's not in a string;
499 then step the main scan to the earliest comment-starter seen
500 an even number of string quotes away from the safe place.
502 OFROM[I] is position of the earliest comment-starter seen
503 which is I+2X quotes from the comment-end.
504 PARITY is current parity of quotes from the comment end. */
505 int string_style = -1; /* Presumed outside of any string. */
506 int string_lossage = 0;
507 /* Not a real lossage: indicates that we have passed a matching comment
508 starter plus a non-matching comment-ender, meaning that any matching
509 comment-starter we might see later could be a false positive (hidden
510 inside another comment).
511 Test case: { a (* b } c (* d *) */
512 int comment_lossage = 0;
513 EMACS_INT comment_end = from;
514 EMACS_INT comment_end_byte = from_byte;
515 EMACS_INT comstart_pos = 0;
516 EMACS_INT comstart_byte IF_LINT (= 0);
517 /* Place where the containing defun starts,
518 or 0 if we didn't come across it yet. */
519 EMACS_INT defun_start = 0;
520 EMACS_INT defun_start_byte = 0;
521 register enum syntaxcode code;
522 int nesting = 1; /* current comment nesting */
523 int c;
524 int syntax = 0;
526 /* FIXME: A }} comment-ender style leads to incorrect behavior
527 in the case of {{ c }}} because we ignore the last two chars which are
528 assumed to be comment-enders although they aren't. */
530 /* At beginning of range to scan, we're outside of strings;
531 that determines quote parity to the comment-end. */
532 while (from != stop)
534 EMACS_INT temp_byte;
535 int prev_syntax, com2start, com2end;
536 int comstart;
538 /* Move back and examine a character. */
539 DEC_BOTH (from, from_byte);
540 UPDATE_SYNTAX_TABLE_BACKWARD (from);
542 prev_syntax = syntax;
543 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
544 syntax = SYNTAX_WITH_FLAGS (c);
545 code = SYNTAX (c);
547 /* Check for 2-char comment markers. */
548 com2start = (SYNTAX_FLAGS_COMSTART_FIRST (syntax)
549 && SYNTAX_FLAGS_COMSTART_SECOND (prev_syntax)
550 && (comstyle
551 == SYNTAX_FLAGS_COMMENT_STYLE (prev_syntax, syntax))
552 && (SYNTAX_FLAGS_COMMENT_NESTED (prev_syntax)
553 || SYNTAX_FLAGS_COMMENT_NESTED (syntax)) == comnested);
554 com2end = (SYNTAX_FLAGS_COMEND_FIRST (syntax)
555 && SYNTAX_FLAGS_COMEND_SECOND (prev_syntax));
556 comstart = (com2start || code == Scomment);
558 /* Nasty cases with overlapping 2-char comment markers:
559 - snmp-mode: -- c -- foo -- c --
560 --- c --
561 ------ c --
562 - c-mode: *||*
563 |* *|* *|
564 |*| |* |*|
565 /// */
567 /* If a 2-char comment sequence partly overlaps with another,
568 we don't try to be clever. E.g. |*| in C, or }% in modes that
569 have %..\n and %{..}%. */
570 if (from > stop && (com2end || comstart))
572 EMACS_INT next = from, next_byte = from_byte;
573 int next_c, next_syntax;
574 DEC_BOTH (next, next_byte);
575 UPDATE_SYNTAX_TABLE_BACKWARD (next);
576 next_c = FETCH_CHAR_AS_MULTIBYTE (next_byte);
577 next_syntax = SYNTAX_WITH_FLAGS (next_c);
578 if (((comstart || comnested)
579 && SYNTAX_FLAGS_COMEND_SECOND (syntax)
580 && SYNTAX_FLAGS_COMEND_FIRST (next_syntax))
581 || ((com2end || comnested)
582 && SYNTAX_FLAGS_COMSTART_SECOND (syntax)
583 && (comstyle
584 == SYNTAX_FLAGS_COMMENT_STYLE (syntax, prev_syntax))
585 && SYNTAX_FLAGS_COMSTART_FIRST (next_syntax)))
586 goto lossage;
587 /* UPDATE_SYNTAX_TABLE_FORWARD (next + 1); */
590 if (com2start && comstart_pos == 0)
591 /* We're looking at a comment starter. But it might be a comment
592 ender as well (see snmp-mode). The first time we see one, we
593 need to consider it as a comment starter,
594 and the subsequent times as a comment ender. */
595 com2end = 0;
597 /* Turn a 2-char comment sequences into the appropriate syntax. */
598 if (com2end)
599 code = Sendcomment;
600 else if (com2start)
601 code = Scomment;
602 /* Ignore comment starters of a different style. */
603 else if (code == Scomment
604 && (comstyle != SYNTAX_FLAGS_COMMENT_STYLE (syntax, 0)
605 || SYNTAX_FLAGS_COMMENT_NESTED (syntax) != comnested))
606 continue;
608 /* Ignore escaped characters, except comment-enders. */
609 if (code != Sendcomment && char_quoted (from, from_byte))
610 continue;
612 switch (code)
614 case Sstring_fence:
615 case Scomment_fence:
616 c = (code == Sstring_fence ? ST_STRING_STYLE : ST_COMMENT_STYLE);
617 case Sstring:
618 /* Track parity of quotes. */
619 if (string_style == -1)
620 /* Entering a string. */
621 string_style = c;
622 else if (string_style == c)
623 /* Leaving the string. */
624 string_style = -1;
625 else
626 /* If we have two kinds of string delimiters.
627 There's no way to grok this scanning backwards. */
628 string_lossage = 1;
629 break;
631 case Scomment:
632 /* We've already checked that it is the relevant comstyle. */
633 if (string_style != -1 || comment_lossage || string_lossage)
634 /* There are odd string quotes involved, so let's be careful.
635 Test case in Pascal: " { " a { " } */
636 goto lossage;
638 if (!comnested)
640 /* Record best comment-starter so far. */
641 comstart_pos = from;
642 comstart_byte = from_byte;
644 else if (--nesting <= 0)
645 /* nested comments have to be balanced, so we don't need to
646 keep looking for earlier ones. We use here the same (slightly
647 incorrect) reasoning as below: since it is followed by uniform
648 paired string quotes, this comment-start has to be outside of
649 strings, else the comment-end itself would be inside a string. */
650 goto done;
651 break;
653 case Sendcomment:
654 if (SYNTAX_FLAGS_COMMENT_STYLE (syntax, 0) == comstyle
655 && ((com2end && SYNTAX_FLAGS_COMMENT_NESTED (prev_syntax))
656 || SYNTAX_FLAGS_COMMENT_NESTED (syntax)) == comnested)
657 /* This is the same style of comment ender as ours. */
659 if (comnested)
660 nesting++;
661 else
662 /* Anything before that can't count because it would match
663 this comment-ender rather than ours. */
664 from = stop; /* Break out of the loop. */
666 else if (comstart_pos != 0 || c != '\n')
667 /* We're mixing comment styles here, so we'd better be careful.
668 The (comstart_pos != 0 || c != '\n') check is not quite correct
669 (we should just always set comment_lossage), but removing it
670 would imply that any multiline comment in C would go through
671 lossage, which seems overkill.
672 The failure should only happen in the rare cases such as
673 { (* } *) */
674 comment_lossage = 1;
675 break;
677 case Sopen:
678 /* Assume a defun-start point is outside of strings. */
679 if (open_paren_in_column_0_is_defun_start
680 && (from == stop
681 || (temp_byte = dec_bytepos (from_byte),
682 FETCH_CHAR (temp_byte) == '\n')))
684 defun_start = from;
685 defun_start_byte = from_byte;
686 from = stop; /* Break out of the loop. */
688 break;
690 default:
691 break;
695 if (comstart_pos == 0)
697 from = comment_end;
698 from_byte = comment_end_byte;
699 UPDATE_SYNTAX_TABLE_FORWARD (comment_end - 1);
701 /* If comstart_pos is set and we get here (ie. didn't jump to `lossage'
702 or `done'), then we've found the beginning of the non-nested comment. */
703 else if (1) /* !comnested */
705 from = comstart_pos;
706 from_byte = comstart_byte;
707 UPDATE_SYNTAX_TABLE_FORWARD (from - 1);
709 else
711 struct lisp_parse_state state;
712 lossage:
713 /* We had two kinds of string delimiters mixed up
714 together. Decode this going forwards.
715 Scan fwd from a known safe place (beginning-of-defun)
716 to the one in question; this records where we
717 last passed a comment starter. */
718 /* If we did not already find the defun start, find it now. */
719 if (defun_start == 0)
721 defun_start = find_defun_start (comment_end, comment_end_byte);
722 defun_start_byte = find_start_value_byte;
726 scan_sexps_forward (&state,
727 defun_start, defun_start_byte,
728 comment_end, -10000, 0, Qnil, 0);
729 defun_start = comment_end;
730 if (state.incomment == (comnested ? 1 : -1)
731 && state.comstyle == comstyle)
732 from = state.comstr_start;
733 else
735 from = comment_end;
736 if (state.incomment)
737 /* If comment_end is inside some other comment, maybe ours
738 is nested, so we need to try again from within the
739 surrounding comment. Example: { a (* " *) */
741 /* FIXME: We should advance by one or two chars. */
742 defun_start = state.comstr_start + 2;
743 defun_start_byte = CHAR_TO_BYTE (defun_start);
746 } while (defun_start < comment_end);
748 from_byte = CHAR_TO_BYTE (from);
749 UPDATE_SYNTAX_TABLE_FORWARD (from - 1);
752 done:
753 *charpos_ptr = from;
754 *bytepos_ptr = from_byte;
756 return (from == comment_end) ? -1 : from;
759 DEFUN ("syntax-table-p", Fsyntax_table_p, Ssyntax_table_p, 1, 1, 0,
760 doc: /* Return t if OBJECT is a syntax table.
761 Currently, any char-table counts as a syntax table. */)
762 (Lisp_Object object)
764 if (CHAR_TABLE_P (object)
765 && EQ (XCHAR_TABLE (object)->purpose, Qsyntax_table))
766 return Qt;
767 return Qnil;
770 static void
771 check_syntax_table (Lisp_Object obj)
773 CHECK_TYPE (CHAR_TABLE_P (obj) && EQ (XCHAR_TABLE (obj)->purpose, Qsyntax_table),
774 Qsyntax_table_p, obj);
777 DEFUN ("syntax-table", Fsyntax_table, Ssyntax_table, 0, 0, 0,
778 doc: /* Return the current syntax table.
779 This is the one specified by the current buffer. */)
780 (void)
782 return BVAR (current_buffer, syntax_table);
785 DEFUN ("standard-syntax-table", Fstandard_syntax_table,
786 Sstandard_syntax_table, 0, 0, 0,
787 doc: /* Return the standard syntax table.
788 This is the one used for new buffers. */)
789 (void)
791 return Vstandard_syntax_table;
794 DEFUN ("copy-syntax-table", Fcopy_syntax_table, Scopy_syntax_table, 0, 1, 0,
795 doc: /* Construct a new syntax table and return it.
796 It is a copy of the TABLE, which defaults to the standard syntax table. */)
797 (Lisp_Object table)
799 Lisp_Object copy;
801 if (!NILP (table))
802 check_syntax_table (table);
803 else
804 table = Vstandard_syntax_table;
806 copy = Fcopy_sequence (table);
808 /* Only the standard syntax table should have a default element.
809 Other syntax tables should inherit from parents instead. */
810 XCHAR_TABLE (copy)->defalt = Qnil;
812 /* Copied syntax tables should all have parents.
813 If we copied one with no parent, such as the standard syntax table,
814 use the standard syntax table as the copy's parent. */
815 if (NILP (XCHAR_TABLE (copy)->parent))
816 Fset_char_table_parent (copy, Vstandard_syntax_table);
817 return copy;
820 DEFUN ("set-syntax-table", Fset_syntax_table, Sset_syntax_table, 1, 1, 0,
821 doc: /* Select a new syntax table for the current buffer.
822 One argument, a syntax table. */)
823 (Lisp_Object table)
825 int idx;
826 check_syntax_table (table);
827 BVAR (current_buffer, syntax_table) = table;
828 /* Indicate that this buffer now has a specified syntax table. */
829 idx = PER_BUFFER_VAR_IDX (syntax_table);
830 SET_PER_BUFFER_VALUE_P (current_buffer, idx, 1);
831 return table;
834 /* Convert a letter which signifies a syntax code
835 into the code it signifies.
836 This is used by modify-syntax-entry, and other things. */
838 unsigned char syntax_spec_code[0400] =
839 { 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
840 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
841 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
842 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
843 (char) Swhitespace, (char) Scomment_fence, (char) Sstring, 0377,
844 (char) Smath, 0377, 0377, (char) Squote,
845 (char) Sopen, (char) Sclose, 0377, 0377,
846 0377, (char) Swhitespace, (char) Spunct, (char) Scharquote,
847 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
848 0377, 0377, 0377, 0377,
849 (char) Scomment, 0377, (char) Sendcomment, 0377,
850 (char) Sinherit, 0377, 0377, 0377, 0377, 0377, 0377, 0377, /* @, A ... */
851 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
852 0377, 0377, 0377, 0377, 0377, 0377, 0377, (char) Sword,
853 0377, 0377, 0377, 0377, (char) Sescape, 0377, 0377, (char) Ssymbol,
854 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377, /* `, a, ... */
855 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
856 0377, 0377, 0377, 0377, 0377, 0377, 0377, (char) Sword,
857 0377, 0377, 0377, 0377, (char) Sstring_fence, 0377, 0377, 0377
860 /* Indexed by syntax code, give the letter that describes it. */
862 char syntax_code_spec[16] =
864 ' ', '.', 'w', '_', '(', ')', '\'', '\"', '$', '\\', '/', '<', '>', '@',
865 '!', '|'
868 /* Indexed by syntax code, give the object (cons of syntax code and
869 nil) to be stored in syntax table. Since these objects can be
870 shared among syntax tables, we generate them in advance. By
871 sharing objects, the function `describe-syntax' can give a more
872 compact listing. */
873 static Lisp_Object Vsyntax_code_object;
876 DEFUN ("char-syntax", Fchar_syntax, Schar_syntax, 1, 1, 0,
877 doc: /* Return the syntax code of CHARACTER, described by a character.
878 For example, if CHARACTER is a word constituent, the
879 character `w' (119) is returned.
880 The characters that correspond to various syntax codes
881 are listed in the documentation of `modify-syntax-entry'. */)
882 (Lisp_Object character)
884 int char_int;
885 CHECK_CHARACTER (character);
886 char_int = XINT (character);
887 SETUP_BUFFER_SYNTAX_TABLE ();
888 return make_number (syntax_code_spec[(int) SYNTAX (char_int)]);
891 DEFUN ("matching-paren", Fmatching_paren, Smatching_paren, 1, 1, 0,
892 doc: /* Return the matching parenthesis of CHARACTER, or nil if none. */)
893 (Lisp_Object character)
895 int char_int, code;
896 CHECK_NUMBER (character);
897 char_int = XINT (character);
898 SETUP_BUFFER_SYNTAX_TABLE ();
899 code = SYNTAX (char_int);
900 if (code == Sopen || code == Sclose)
901 return SYNTAX_MATCH (char_int);
902 return Qnil;
905 DEFUN ("string-to-syntax", Fstring_to_syntax, Sstring_to_syntax, 1, 1, 0,
906 doc: /* Convert a syntax specification STRING into syntax cell form.
907 STRING should be a string as it is allowed as argument of
908 `modify-syntax-entry'. Value is the equivalent cons cell
909 \(CODE . MATCHING-CHAR) that can be used as value of a `syntax-table'
910 text property. */)
911 (Lisp_Object string)
913 register const unsigned char *p;
914 register enum syntaxcode code;
915 int val;
916 Lisp_Object match;
918 CHECK_STRING (string);
920 p = SDATA (string);
921 code = (enum syntaxcode) syntax_spec_code[*p++];
922 if (((int) code & 0377) == 0377)
923 error ("Invalid syntax description letter: %c", p[-1]);
925 if (code == Sinherit)
926 return Qnil;
928 if (*p)
930 int len;
931 int character = STRING_CHAR_AND_LENGTH (p, len);
932 XSETINT (match, character);
933 if (XFASTINT (match) == ' ')
934 match = Qnil;
935 p += len;
937 else
938 match = Qnil;
940 val = (int) code;
941 while (*p)
942 switch (*p++)
944 case '1':
945 val |= 1 << 16;
946 break;
948 case '2':
949 val |= 1 << 17;
950 break;
952 case '3':
953 val |= 1 << 18;
954 break;
956 case '4':
957 val |= 1 << 19;
958 break;
960 case 'p':
961 val |= 1 << 20;
962 break;
964 case 'b':
965 val |= 1 << 21;
966 break;
968 case 'n':
969 val |= 1 << 22;
970 break;
972 case 'c':
973 val |= 1 << 23;
974 break;
977 if (val < XVECTOR (Vsyntax_code_object)->size && NILP (match))
978 return XVECTOR (Vsyntax_code_object)->contents[val];
979 else
980 /* Since we can't use a shared object, let's make a new one. */
981 return Fcons (make_number (val), match);
984 /* I really don't know why this is interactive
985 help-form should at least be made useful whilst reading the second arg. */
986 DEFUN ("modify-syntax-entry", Fmodify_syntax_entry, Smodify_syntax_entry, 2, 3,
987 "cSet syntax for character: \nsSet syntax for %s to: ",
988 doc: /* Set syntax for character CHAR according to string NEWENTRY.
989 The syntax is changed only for table SYNTAX-TABLE, which defaults to
990 the current buffer's syntax table.
991 CHAR may be a cons (MIN . MAX), in which case, syntaxes of all characters
992 in the range MIN to MAX are changed.
993 The first character of NEWENTRY should be one of the following:
994 Space or - whitespace syntax. w word constituent.
995 _ symbol constituent. . punctuation.
996 ( open-parenthesis. ) close-parenthesis.
997 " string quote. \\ escape.
998 $ paired delimiter. ' expression quote or prefix operator.
999 < comment starter. > comment ender.
1000 / character-quote. @ inherit from `standard-syntax-table'.
1001 | generic string fence. ! generic comment fence.
1003 Only single-character comment start and end sequences are represented thus.
1004 Two-character sequences are represented as described below.
1005 The second character of NEWENTRY is the matching parenthesis,
1006 used only if the first character is `(' or `)'.
1007 Any additional characters are flags.
1008 Defined flags are the characters 1, 2, 3, 4, b, p, and n.
1009 1 means CHAR is the start of a two-char comment start sequence.
1010 2 means CHAR is the second character of such a sequence.
1011 3 means CHAR is the start of a two-char comment end sequence.
1012 4 means CHAR is the second character of such a sequence.
1014 There can be several orthogonal comment sequences. This is to support
1015 language modes such as C++. By default, all comment sequences are of style
1016 a, but you can set the comment sequence style to b (on the second character
1017 of a comment-start, and the first character of a comment-end sequence) and/or
1018 c (on any of its chars) using this flag:
1019 b means CHAR is part of comment sequence b.
1020 c means CHAR is part of comment sequence c.
1021 n means CHAR is part of a nestable comment sequence.
1023 p means CHAR is a prefix character for `backward-prefix-chars';
1024 such characters are treated as whitespace when they occur
1025 between expressions.
1026 usage: (modify-syntax-entry CHAR NEWENTRY &optional SYNTAX-TABLE) */)
1027 (Lisp_Object c, Lisp_Object newentry, Lisp_Object syntax_table)
1029 if (CONSP (c))
1031 CHECK_CHARACTER_CAR (c);
1032 CHECK_CHARACTER_CDR (c);
1034 else
1035 CHECK_CHARACTER (c);
1037 if (NILP (syntax_table))
1038 syntax_table = BVAR (current_buffer, syntax_table);
1039 else
1040 check_syntax_table (syntax_table);
1042 newentry = Fstring_to_syntax (newentry);
1043 if (CONSP (c))
1044 SET_RAW_SYNTAX_ENTRY_RANGE (syntax_table, c, newentry);
1045 else
1046 SET_RAW_SYNTAX_ENTRY (syntax_table, XINT (c), newentry);
1048 /* We clear the regexp cache, since character classes can now have
1049 different values from those in the compiled regexps.*/
1050 clear_regexp_cache ();
1052 return Qnil;
1055 /* Dump syntax table to buffer in human-readable format */
1057 DEFUN ("internal-describe-syntax-value", Finternal_describe_syntax_value,
1058 Sinternal_describe_syntax_value, 1, 1, 0,
1059 doc: /* Insert a description of the internal syntax description SYNTAX at point. */)
1060 (Lisp_Object syntax)
1062 register enum syntaxcode code;
1063 int syntax_code;
1064 char desc, start1, start2, end1, end2, prefix,
1065 comstyleb, comstylec, comnested;
1066 char str[2];
1067 Lisp_Object first, match_lisp, value = syntax;
1069 if (NILP (value))
1071 insert_string ("default");
1072 return syntax;
1075 if (CHAR_TABLE_P (value))
1077 insert_string ("deeper char-table ...");
1078 return syntax;
1081 if (!CONSP (value))
1083 insert_string ("invalid");
1084 return syntax;
1087 first = XCAR (value);
1088 match_lisp = XCDR (value);
1090 if (!INTEGERP (first) || !(NILP (match_lisp) || INTEGERP (match_lisp)))
1092 insert_string ("invalid");
1093 return syntax;
1096 syntax_code = XINT (first);
1097 code = (enum syntaxcode) (syntax_code & 0377);
1098 start1 = SYNTAX_FLAGS_COMSTART_FIRST (syntax_code);
1099 start2 = SYNTAX_FLAGS_COMSTART_SECOND (syntax_code);;
1100 end1 = SYNTAX_FLAGS_COMEND_FIRST (syntax_code);
1101 end2 = SYNTAX_FLAGS_COMEND_SECOND (syntax_code);
1102 prefix = SYNTAX_FLAGS_PREFIX (syntax_code);
1103 comstyleb = SYNTAX_FLAGS_COMMENT_STYLEB (syntax_code);
1104 comstylec = SYNTAX_FLAGS_COMMENT_STYLEC (syntax_code);
1105 comnested = SYNTAX_FLAGS_COMMENT_NESTED (syntax_code);
1107 if ((int) code < 0 || (int) code >= (int) Smax)
1109 insert_string ("invalid");
1110 return syntax;
1112 desc = syntax_code_spec[(int) code];
1114 str[0] = desc, str[1] = 0;
1115 insert (str, 1);
1117 if (NILP (match_lisp))
1118 insert (" ", 1);
1119 else
1120 insert_char (XINT (match_lisp));
1122 if (start1)
1123 insert ("1", 1);
1124 if (start2)
1125 insert ("2", 1);
1127 if (end1)
1128 insert ("3", 1);
1129 if (end2)
1130 insert ("4", 1);
1132 if (prefix)
1133 insert ("p", 1);
1134 if (comstyleb)
1135 insert ("b", 1);
1136 if (comstylec)
1137 insert ("c", 1);
1138 if (comnested)
1139 insert ("n", 1);
1141 insert_string ("\twhich means: ");
1143 switch (SWITCH_ENUM_CAST (code))
1145 case Swhitespace:
1146 insert_string ("whitespace"); break;
1147 case Spunct:
1148 insert_string ("punctuation"); break;
1149 case Sword:
1150 insert_string ("word"); break;
1151 case Ssymbol:
1152 insert_string ("symbol"); break;
1153 case Sopen:
1154 insert_string ("open"); break;
1155 case Sclose:
1156 insert_string ("close"); break;
1157 case Squote:
1158 insert_string ("prefix"); break;
1159 case Sstring:
1160 insert_string ("string"); break;
1161 case Smath:
1162 insert_string ("math"); break;
1163 case Sescape:
1164 insert_string ("escape"); break;
1165 case Scharquote:
1166 insert_string ("charquote"); break;
1167 case Scomment:
1168 insert_string ("comment"); break;
1169 case Sendcomment:
1170 insert_string ("endcomment"); break;
1171 case Sinherit:
1172 insert_string ("inherit"); break;
1173 case Scomment_fence:
1174 insert_string ("comment fence"); break;
1175 case Sstring_fence:
1176 insert_string ("string fence"); break;
1177 default:
1178 insert_string ("invalid");
1179 return syntax;
1182 if (!NILP (match_lisp))
1184 insert_string (", matches ");
1185 insert_char (XINT (match_lisp));
1188 if (start1)
1189 insert_string (",\n\t is the first character of a comment-start sequence");
1190 if (start2)
1191 insert_string (",\n\t is the second character of a comment-start sequence");
1193 if (end1)
1194 insert_string (",\n\t is the first character of a comment-end sequence");
1195 if (end2)
1196 insert_string (",\n\t is the second character of a comment-end sequence");
1197 if (comstyleb)
1198 insert_string (" (comment style b)");
1199 if (comstylec)
1200 insert_string (" (comment style c)");
1201 if (comnested)
1202 insert_string (" (nestable)");
1204 if (prefix)
1205 insert_string (",\n\t is a prefix character for `backward-prefix-chars'");
1207 return syntax;
1210 /* Return the position across COUNT words from FROM.
1211 If that many words cannot be found before the end of the buffer, return 0.
1212 COUNT negative means scan backward and stop at word beginning. */
1214 EMACS_INT
1215 scan_words (register EMACS_INT from, register EMACS_INT count)
1217 register EMACS_INT beg = BEGV;
1218 register EMACS_INT end = ZV;
1219 register EMACS_INT from_byte = CHAR_TO_BYTE (from);
1220 register enum syntaxcode code;
1221 int ch0, ch1;
1222 Lisp_Object func, script, pos;
1224 immediate_quit = 1;
1225 QUIT;
1227 SETUP_SYNTAX_TABLE (from, count);
1229 while (count > 0)
1231 while (1)
1233 if (from == end)
1235 immediate_quit = 0;
1236 return 0;
1238 UPDATE_SYNTAX_TABLE_FORWARD (from);
1239 ch0 = FETCH_CHAR_AS_MULTIBYTE (from_byte);
1240 code = SYNTAX (ch0);
1241 INC_BOTH (from, from_byte);
1242 if (words_include_escapes
1243 && (code == Sescape || code == Scharquote))
1244 break;
1245 if (code == Sword)
1246 break;
1248 /* Now CH0 is a character which begins a word and FROM is the
1249 position of the next character. */
1250 func = CHAR_TABLE_REF (Vfind_word_boundary_function_table, ch0);
1251 if (! NILP (Ffboundp (func)))
1253 pos = call2 (func, make_number (from - 1), make_number (end));
1254 if (INTEGERP (pos) && XINT (pos) > from)
1256 from = XINT (pos);
1257 from_byte = CHAR_TO_BYTE (from);
1260 else
1262 script = CHAR_TABLE_REF (Vchar_script_table, ch0);
1263 while (1)
1265 if (from == end) break;
1266 UPDATE_SYNTAX_TABLE_FORWARD (from);
1267 ch1 = FETCH_CHAR_AS_MULTIBYTE (from_byte);
1268 code = SYNTAX (ch1);
1269 if ((code != Sword
1270 && (! words_include_escapes
1271 || (code != Sescape && code != Scharquote)))
1272 || word_boundary_p (ch0, ch1))
1273 break;
1274 INC_BOTH (from, from_byte);
1275 ch0 = ch1;
1278 count--;
1280 while (count < 0)
1282 while (1)
1284 if (from == beg)
1286 immediate_quit = 0;
1287 return 0;
1289 DEC_BOTH (from, from_byte);
1290 UPDATE_SYNTAX_TABLE_BACKWARD (from);
1291 ch1 = FETCH_CHAR_AS_MULTIBYTE (from_byte);
1292 code = SYNTAX (ch1);
1293 if (words_include_escapes
1294 && (code == Sescape || code == Scharquote))
1295 break;
1296 if (code == Sword)
1297 break;
1299 /* Now CH1 is a character which ends a word and FROM is the
1300 position of it. */
1301 func = CHAR_TABLE_REF (Vfind_word_boundary_function_table, ch1);
1302 if (! NILP (Ffboundp (func)))
1304 pos = call2 (func, make_number (from), make_number (beg));
1305 if (INTEGERP (pos) && XINT (pos) < from)
1307 from = XINT (pos);
1308 from_byte = CHAR_TO_BYTE (from);
1311 else
1313 script = CHAR_TABLE_REF (Vchar_script_table, ch1);
1314 while (1)
1316 if (from == beg)
1317 break;
1318 DEC_BOTH (from, from_byte);
1319 UPDATE_SYNTAX_TABLE_BACKWARD (from);
1320 ch0 = FETCH_CHAR_AS_MULTIBYTE (from_byte);
1321 code = SYNTAX (ch0);
1322 if ((code != Sword
1323 && (! words_include_escapes
1324 || (code != Sescape && code != Scharquote)))
1325 || word_boundary_p (ch0, ch1))
1327 INC_BOTH (from, from_byte);
1328 break;
1330 ch1 = ch0;
1333 count++;
1336 immediate_quit = 0;
1338 return from;
1341 DEFUN ("forward-word", Fforward_word, Sforward_word, 0, 1, "^p",
1342 doc: /* Move point forward ARG words (backward if ARG is negative).
1343 Normally returns t.
1344 If an edge of the buffer or a field boundary is reached, point is left there
1345 and the function returns nil. Field boundaries are not noticed if
1346 `inhibit-field-text-motion' is non-nil. */)
1347 (Lisp_Object arg)
1349 Lisp_Object tmp;
1350 int orig_val, val;
1352 if (NILP (arg))
1353 XSETFASTINT (arg, 1);
1354 else
1355 CHECK_NUMBER (arg);
1357 val = orig_val = scan_words (PT, XINT (arg));
1358 if (! orig_val)
1359 val = XINT (arg) > 0 ? ZV : BEGV;
1361 /* Avoid jumping out of an input field. */
1362 tmp = Fconstrain_to_field (make_number (val), make_number (PT),
1363 Qt, Qnil, Qnil);
1364 val = XFASTINT (tmp);
1366 SET_PT (val);
1367 return val == orig_val ? Qt : Qnil;
1370 Lisp_Object skip_chars (int, Lisp_Object, Lisp_Object, int);
1372 DEFUN ("skip-chars-forward", Fskip_chars_forward, Sskip_chars_forward, 1, 2, 0,
1373 doc: /* Move point forward, stopping before a char not in STRING, or at pos LIM.
1374 STRING is like the inside of a `[...]' in a regular expression
1375 except that `]' is never special and `\\' quotes `^', `-' or `\\'
1376 (but not at the end of a range; quoting is never needed there).
1377 Thus, with arg "a-zA-Z", this skips letters stopping before first nonletter.
1378 With arg "^a-zA-Z", skips nonletters stopping before first letter.
1379 Char classes, e.g. `[:alpha:]', are supported.
1381 Returns the distance traveled, either zero or positive. */)
1382 (Lisp_Object string, Lisp_Object lim)
1384 return skip_chars (1, string, lim, 1);
1387 DEFUN ("skip-chars-backward", Fskip_chars_backward, Sskip_chars_backward, 1, 2, 0,
1388 doc: /* Move point backward, stopping after a char not in STRING, or at pos LIM.
1389 See `skip-chars-forward' for details.
1390 Returns the distance traveled, either zero or negative. */)
1391 (Lisp_Object string, Lisp_Object lim)
1393 return skip_chars (0, string, lim, 1);
1396 DEFUN ("skip-syntax-forward", Fskip_syntax_forward, Sskip_syntax_forward, 1, 2, 0,
1397 doc: /* Move point forward across chars in specified syntax classes.
1398 SYNTAX is a string of syntax code characters.
1399 Stop before a char whose syntax is not in SYNTAX, or at position LIM.
1400 If SYNTAX starts with ^, skip characters whose syntax is NOT in SYNTAX.
1401 This function returns the distance traveled, either zero or positive. */)
1402 (Lisp_Object syntax, Lisp_Object lim)
1404 return skip_syntaxes (1, syntax, lim);
1407 DEFUN ("skip-syntax-backward", Fskip_syntax_backward, Sskip_syntax_backward, 1, 2, 0,
1408 doc: /* Move point backward across chars in specified syntax classes.
1409 SYNTAX is a string of syntax code characters.
1410 Stop on reaching a char whose syntax is not in SYNTAX, or at position LIM.
1411 If SYNTAX starts with ^, skip characters whose syntax is NOT in SYNTAX.
1412 This function returns the distance traveled, either zero or negative. */)
1413 (Lisp_Object syntax, Lisp_Object lim)
1415 return skip_syntaxes (0, syntax, lim);
1418 static Lisp_Object
1419 skip_chars (int forwardp, Lisp_Object string, Lisp_Object lim, int handle_iso_classes)
1421 register unsigned int c;
1422 unsigned char fastmap[0400];
1423 /* Store the ranges of non-ASCII characters. */
1424 int *char_ranges IF_LINT (= NULL);
1425 int n_char_ranges = 0;
1426 int negate = 0;
1427 register EMACS_INT i, i_byte;
1428 /* Set to 1 if the current buffer is multibyte and the region
1429 contains non-ASCII chars. */
1430 int multibyte;
1431 /* Set to 1 if STRING is multibyte and it contains non-ASCII
1432 chars. */
1433 int string_multibyte;
1434 EMACS_INT size_byte;
1435 const unsigned char *str;
1436 int len;
1437 Lisp_Object iso_classes;
1439 CHECK_STRING (string);
1440 iso_classes = Qnil;
1442 if (NILP (lim))
1443 XSETINT (lim, forwardp ? ZV : BEGV);
1444 else
1445 CHECK_NUMBER_COERCE_MARKER (lim);
1447 /* In any case, don't allow scan outside bounds of buffer. */
1448 if (XINT (lim) > ZV)
1449 XSETFASTINT (lim, ZV);
1450 if (XINT (lim) < BEGV)
1451 XSETFASTINT (lim, BEGV);
1453 multibyte = (!NILP (BVAR (current_buffer, enable_multibyte_characters))
1454 && (XINT (lim) - PT != CHAR_TO_BYTE (XINT (lim)) - PT_BYTE));
1455 string_multibyte = SBYTES (string) > SCHARS (string);
1457 memset (fastmap, 0, sizeof fastmap);
1459 str = SDATA (string);
1460 size_byte = SBYTES (string);
1462 i_byte = 0;
1463 if (i_byte < size_byte
1464 && SREF (string, 0) == '^')
1466 negate = 1; i_byte++;
1469 /* Find the characters specified and set their elements of fastmap.
1470 Handle backslashes and ranges specially.
1472 If STRING contains non-ASCII characters, setup char_ranges for
1473 them and use fastmap only for their leading codes. */
1475 if (! string_multibyte)
1477 int string_has_eight_bit = 0;
1479 /* At first setup fastmap. */
1480 while (i_byte < size_byte)
1482 c = str[i_byte++];
1484 if (handle_iso_classes && c == '['
1485 && i_byte < size_byte
1486 && str[i_byte] == ':')
1488 const unsigned char *class_beg = str + i_byte + 1;
1489 const unsigned char *class_end = class_beg;
1490 const unsigned char *class_limit = str + size_byte - 2;
1491 /* Leave room for the null. */
1492 unsigned char class_name[CHAR_CLASS_MAX_LENGTH + 1];
1493 re_wctype_t cc;
1495 if (class_limit - class_beg > CHAR_CLASS_MAX_LENGTH)
1496 class_limit = class_beg + CHAR_CLASS_MAX_LENGTH;
1498 while (class_end < class_limit
1499 && *class_end >= 'a' && *class_end <= 'z')
1500 class_end++;
1502 if (class_end == class_beg
1503 || *class_end != ':' || class_end[1] != ']')
1504 goto not_a_class_name;
1506 memcpy (class_name, class_beg, class_end - class_beg);
1507 class_name[class_end - class_beg] = 0;
1509 cc = re_wctype (class_name);
1510 if (cc == 0)
1511 error ("Invalid ISO C character class");
1513 iso_classes = Fcons (make_number (cc), iso_classes);
1515 i_byte = class_end + 2 - str;
1516 continue;
1519 not_a_class_name:
1520 if (c == '\\')
1522 if (i_byte == size_byte)
1523 break;
1525 c = str[i_byte++];
1527 /* Treat `-' as range character only if another character
1528 follows. */
1529 if (i_byte + 1 < size_byte
1530 && str[i_byte] == '-')
1532 unsigned int c2;
1534 /* Skip over the dash. */
1535 i_byte++;
1537 /* Get the end of the range. */
1538 c2 = str[i_byte++];
1539 if (c2 == '\\'
1540 && i_byte < size_byte)
1541 c2 = str[i_byte++];
1543 if (c <= c2)
1545 while (c <= c2)
1546 fastmap[c++] = 1;
1547 if (! ASCII_CHAR_P (c2))
1548 string_has_eight_bit = 1;
1551 else
1553 fastmap[c] = 1;
1554 if (! ASCII_CHAR_P (c))
1555 string_has_eight_bit = 1;
1559 /* If the current range is multibyte and STRING contains
1560 eight-bit chars, arrange fastmap and setup char_ranges for
1561 the corresponding multibyte chars. */
1562 if (multibyte && string_has_eight_bit)
1564 unsigned char fastmap2[0400];
1565 int range_start_byte, range_start_char;
1567 memcpy (fastmap + 0200, fastmap2 + 0200, 0200);
1568 memset (fastmap + 0200, 0, 0200);
1569 /* We are sure that this loop stops. */
1570 for (i = 0200; ! fastmap2[i]; i++);
1571 c = BYTE8_TO_CHAR (i);
1572 fastmap[CHAR_LEADING_CODE (c)] = 1;
1573 range_start_byte = i;
1574 range_start_char = c;
1575 char_ranges = (int *) alloca (sizeof (int) * 128 * 2);
1576 for (i = 129; i < 0400; i++)
1578 c = BYTE8_TO_CHAR (i);
1579 fastmap[CHAR_LEADING_CODE (c)] = 1;
1580 if (i - range_start_byte != c - range_start_char)
1582 char_ranges[n_char_ranges++] = range_start_char;
1583 char_ranges[n_char_ranges++] = ((i - 1 - range_start_byte)
1584 + range_start_char);
1585 range_start_byte = i;
1586 range_start_char = c;
1589 char_ranges[n_char_ranges++] = range_start_char;
1590 char_ranges[n_char_ranges++] = ((i - 1 - range_start_byte)
1591 + range_start_char);
1594 else /* STRING is multibyte */
1596 char_ranges = (int *) alloca (sizeof (int) * SCHARS (string) * 2);
1598 while (i_byte < size_byte)
1600 unsigned char leading_code;
1602 leading_code = str[i_byte];
1603 c = STRING_CHAR_AND_LENGTH (str + i_byte, len);
1604 i_byte += len;
1606 if (handle_iso_classes && c == '['
1607 && i_byte < size_byte
1608 && STRING_CHAR (str + i_byte) == ':')
1610 const unsigned char *class_beg = str + i_byte + 1;
1611 const unsigned char *class_end = class_beg;
1612 const unsigned char *class_limit = str + size_byte - 2;
1613 /* Leave room for the null. */
1614 unsigned char class_name[CHAR_CLASS_MAX_LENGTH + 1];
1615 re_wctype_t cc;
1617 if (class_limit - class_beg > CHAR_CLASS_MAX_LENGTH)
1618 class_limit = class_beg + CHAR_CLASS_MAX_LENGTH;
1620 while (class_end < class_limit
1621 && *class_end >= 'a' && *class_end <= 'z')
1622 class_end++;
1624 if (class_end == class_beg
1625 || *class_end != ':' || class_end[1] != ']')
1626 goto not_a_class_name_multibyte;
1628 memcpy (class_name, class_beg, class_end - class_beg);
1629 class_name[class_end - class_beg] = 0;
1631 cc = re_wctype (class_name);
1632 if (cc == 0)
1633 error ("Invalid ISO C character class");
1635 iso_classes = Fcons (make_number (cc), iso_classes);
1637 i_byte = class_end + 2 - str;
1638 continue;
1641 not_a_class_name_multibyte:
1642 if (c == '\\')
1644 if (i_byte == size_byte)
1645 break;
1647 leading_code = str[i_byte];
1648 c = STRING_CHAR_AND_LENGTH (str + i_byte, len);
1649 i_byte += len;
1651 /* Treat `-' as range character only if another character
1652 follows. */
1653 if (i_byte + 1 < size_byte
1654 && str[i_byte] == '-')
1656 unsigned int c2;
1657 unsigned char leading_code2;
1659 /* Skip over the dash. */
1660 i_byte++;
1662 /* Get the end of the range. */
1663 leading_code2 = str[i_byte];
1664 c2 = STRING_CHAR_AND_LENGTH (str + i_byte, len);
1665 i_byte += len;
1667 if (c2 == '\\'
1668 && i_byte < size_byte)
1670 leading_code2 = str[i_byte];
1671 c2 =STRING_CHAR_AND_LENGTH (str + i_byte, len);
1672 i_byte += len;
1675 if (c > c2)
1676 continue;
1677 if (ASCII_CHAR_P (c))
1679 while (c <= c2 && c < 0x80)
1680 fastmap[c++] = 1;
1681 leading_code = CHAR_LEADING_CODE (c);
1683 if (! ASCII_CHAR_P (c))
1685 while (leading_code <= leading_code2)
1686 fastmap[leading_code++] = 1;
1687 if (c <= c2)
1689 char_ranges[n_char_ranges++] = c;
1690 char_ranges[n_char_ranges++] = c2;
1694 else
1696 if (ASCII_CHAR_P (c))
1697 fastmap[c] = 1;
1698 else
1700 fastmap[leading_code] = 1;
1701 char_ranges[n_char_ranges++] = c;
1702 char_ranges[n_char_ranges++] = c;
1707 /* If the current range is unibyte and STRING contains non-ASCII
1708 chars, arrange fastmap for the corresponding unibyte
1709 chars. */
1711 if (! multibyte && n_char_ranges > 0)
1713 memset (fastmap + 0200, 0, 0200);
1714 for (i = 0; i < n_char_ranges; i += 2)
1716 int c1 = char_ranges[i];
1717 int c2 = char_ranges[i + 1];
1719 for (; c1 <= c2; c1++)
1721 int b = CHAR_TO_BYTE_SAFE (c1);
1722 if (b >= 0)
1723 fastmap[b] = 1;
1729 /* If ^ was the first character, complement the fastmap. */
1730 if (negate)
1732 if (! multibyte)
1733 for (i = 0; i < sizeof fastmap; i++)
1734 fastmap[i] ^= 1;
1735 else
1737 for (i = 0; i < 0200; i++)
1738 fastmap[i] ^= 1;
1739 /* All non-ASCII chars possibly match. */
1740 for (; i < sizeof fastmap; i++)
1741 fastmap[i] = 1;
1746 EMACS_INT start_point = PT;
1747 EMACS_INT pos = PT;
1748 EMACS_INT pos_byte = PT_BYTE;
1749 unsigned char *p = PT_ADDR, *endp, *stop;
1751 if (forwardp)
1753 endp = (XINT (lim) == GPT) ? GPT_ADDR : CHAR_POS_ADDR (XINT (lim));
1754 stop = (pos < GPT && GPT < XINT (lim)) ? GPT_ADDR : endp;
1756 else
1758 endp = CHAR_POS_ADDR (XINT (lim));
1759 stop = (pos >= GPT && GPT > XINT (lim)) ? GAP_END_ADDR : endp;
1762 immediate_quit = 1;
1763 /* This code may look up syntax tables using macros that rely on the
1764 gl_state object. To make sure this object is not out of date,
1765 let's initialize it manually.
1766 We ignore syntax-table text-properties for now, since that's
1767 what we've done in the past. */
1768 SETUP_BUFFER_SYNTAX_TABLE ();
1769 if (forwardp)
1771 if (multibyte)
1772 while (1)
1774 int nbytes;
1776 if (p >= stop)
1778 if (p >= endp)
1779 break;
1780 p = GAP_END_ADDR;
1781 stop = endp;
1783 c = STRING_CHAR_AND_LENGTH (p, nbytes);
1784 if (! NILP (iso_classes) && in_classes (c, iso_classes))
1786 if (negate)
1787 break;
1788 else
1789 goto fwd_ok;
1792 if (! fastmap[*p])
1793 break;
1794 if (! ASCII_CHAR_P (c))
1796 /* As we are looking at a multibyte character, we
1797 must look up the character in the table
1798 CHAR_RANGES. If there's no data in the table,
1799 that character is not what we want to skip. */
1801 /* The following code do the right thing even if
1802 n_char_ranges is zero (i.e. no data in
1803 CHAR_RANGES). */
1804 for (i = 0; i < n_char_ranges; i += 2)
1805 if (c >= char_ranges[i] && c <= char_ranges[i + 1])
1806 break;
1807 if (!(negate ^ (i < n_char_ranges)))
1808 break;
1810 fwd_ok:
1811 p += nbytes, pos++, pos_byte += nbytes;
1813 else
1814 while (1)
1816 if (p >= stop)
1818 if (p >= endp)
1819 break;
1820 p = GAP_END_ADDR;
1821 stop = endp;
1824 if (!NILP (iso_classes) && in_classes (*p, iso_classes))
1826 if (negate)
1827 break;
1828 else
1829 goto fwd_unibyte_ok;
1832 if (!fastmap[*p])
1833 break;
1834 fwd_unibyte_ok:
1835 p++, pos++, pos_byte++;
1838 else
1840 if (multibyte)
1841 while (1)
1843 unsigned char *prev_p;
1845 if (p <= stop)
1847 if (p <= endp)
1848 break;
1849 p = GPT_ADDR;
1850 stop = endp;
1852 prev_p = p;
1853 while (--p >= stop && ! CHAR_HEAD_P (*p));
1854 c = STRING_CHAR (p);
1856 if (! NILP (iso_classes) && in_classes (c, iso_classes))
1858 if (negate)
1859 break;
1860 else
1861 goto back_ok;
1864 if (! fastmap[*p])
1865 break;
1866 if (! ASCII_CHAR_P (c))
1868 /* See the comment in the previous similar code. */
1869 for (i = 0; i < n_char_ranges; i += 2)
1870 if (c >= char_ranges[i] && c <= char_ranges[i + 1])
1871 break;
1872 if (!(negate ^ (i < n_char_ranges)))
1873 break;
1875 back_ok:
1876 pos--, pos_byte -= prev_p - p;
1878 else
1879 while (1)
1881 if (p <= stop)
1883 if (p <= endp)
1884 break;
1885 p = GPT_ADDR;
1886 stop = endp;
1889 if (! NILP (iso_classes) && in_classes (p[-1], iso_classes))
1891 if (negate)
1892 break;
1893 else
1894 goto back_unibyte_ok;
1897 if (!fastmap[p[-1]])
1898 break;
1899 back_unibyte_ok:
1900 p--, pos--, pos_byte--;
1904 SET_PT_BOTH (pos, pos_byte);
1905 immediate_quit = 0;
1907 return make_number (PT - start_point);
1912 static Lisp_Object
1913 skip_syntaxes (int forwardp, Lisp_Object string, Lisp_Object lim)
1915 register unsigned int c;
1916 unsigned char fastmap[0400];
1917 int negate = 0;
1918 register EMACS_INT i, i_byte;
1919 int multibyte;
1920 EMACS_INT size_byte;
1921 unsigned char *str;
1923 CHECK_STRING (string);
1925 if (NILP (lim))
1926 XSETINT (lim, forwardp ? ZV : BEGV);
1927 else
1928 CHECK_NUMBER_COERCE_MARKER (lim);
1930 /* In any case, don't allow scan outside bounds of buffer. */
1931 if (XINT (lim) > ZV)
1932 XSETFASTINT (lim, ZV);
1933 if (XINT (lim) < BEGV)
1934 XSETFASTINT (lim, BEGV);
1936 if (forwardp ? (PT >= XFASTINT (lim)) : (PT <= XFASTINT (lim)))
1937 return make_number (0);
1939 multibyte = (!NILP (BVAR (current_buffer, enable_multibyte_characters))
1940 && (XINT (lim) - PT != CHAR_TO_BYTE (XINT (lim)) - PT_BYTE));
1942 memset (fastmap, 0, sizeof fastmap);
1944 if (SBYTES (string) > SCHARS (string))
1945 /* As this is very rare case (syntax spec is ASCII only), don't
1946 consider efficiency. */
1947 string = string_make_unibyte (string);
1949 str = SDATA (string);
1950 size_byte = SBYTES (string);
1952 i_byte = 0;
1953 if (i_byte < size_byte
1954 && SREF (string, 0) == '^')
1956 negate = 1; i_byte++;
1959 /* Find the syntaxes specified and set their elements of fastmap. */
1961 while (i_byte < size_byte)
1963 c = str[i_byte++];
1964 fastmap[syntax_spec_code[c]] = 1;
1967 /* If ^ was the first character, complement the fastmap. */
1968 if (negate)
1969 for (i = 0; i < sizeof fastmap; i++)
1970 fastmap[i] ^= 1;
1973 EMACS_INT start_point = PT;
1974 EMACS_INT pos = PT;
1975 EMACS_INT pos_byte = PT_BYTE;
1976 unsigned char *p = PT_ADDR, *endp, *stop;
1978 if (forwardp)
1980 endp = (XINT (lim) == GPT) ? GPT_ADDR : CHAR_POS_ADDR (XINT (lim));
1981 stop = (pos < GPT && GPT < XINT (lim)) ? GPT_ADDR : endp;
1983 else
1985 endp = CHAR_POS_ADDR (XINT (lim));
1986 stop = (pos >= GPT && GPT > XINT (lim)) ? GAP_END_ADDR : endp;
1989 immediate_quit = 1;
1990 SETUP_SYNTAX_TABLE (pos, forwardp ? 1 : -1);
1991 if (forwardp)
1993 if (multibyte)
1995 while (1)
1997 int nbytes;
1999 if (p >= stop)
2001 if (p >= endp)
2002 break;
2003 p = GAP_END_ADDR;
2004 stop = endp;
2006 c = STRING_CHAR_AND_LENGTH (p, nbytes);
2007 if (! fastmap[(int) SYNTAX (c)])
2008 break;
2009 p += nbytes, pos++, pos_byte += nbytes;
2010 UPDATE_SYNTAX_TABLE_FORWARD (pos);
2013 else
2015 while (1)
2017 if (p >= stop)
2019 if (p >= endp)
2020 break;
2021 p = GAP_END_ADDR;
2022 stop = endp;
2024 if (! fastmap[(int) SYNTAX (*p)])
2025 break;
2026 p++, pos++, pos_byte++;
2027 UPDATE_SYNTAX_TABLE_FORWARD (pos);
2031 else
2033 if (multibyte)
2035 while (1)
2037 unsigned char *prev_p;
2039 if (p <= stop)
2041 if (p <= endp)
2042 break;
2043 p = GPT_ADDR;
2044 stop = endp;
2046 UPDATE_SYNTAX_TABLE_BACKWARD (pos - 1);
2047 prev_p = p;
2048 while (--p >= stop && ! CHAR_HEAD_P (*p));
2049 c = STRING_CHAR (p);
2050 if (! fastmap[(int) SYNTAX (c)])
2051 break;
2052 pos--, pos_byte -= prev_p - p;
2055 else
2057 while (1)
2059 if (p <= stop)
2061 if (p <= endp)
2062 break;
2063 p = GPT_ADDR;
2064 stop = endp;
2066 UPDATE_SYNTAX_TABLE_BACKWARD (pos - 1);
2067 if (! fastmap[(int) SYNTAX (p[-1])])
2068 break;
2069 p--, pos--, pos_byte--;
2074 SET_PT_BOTH (pos, pos_byte);
2075 immediate_quit = 0;
2077 return make_number (PT - start_point);
2081 /* Return 1 if character C belongs to one of the ISO classes
2082 in the list ISO_CLASSES. Each class is represented by an
2083 integer which is its type according to re_wctype. */
2085 static int
2086 in_classes (int c, Lisp_Object iso_classes)
2088 int fits_class = 0;
2090 while (CONSP (iso_classes))
2092 Lisp_Object elt;
2093 elt = XCAR (iso_classes);
2094 iso_classes = XCDR (iso_classes);
2096 if (re_iswctype (c, XFASTINT (elt)))
2097 fits_class = 1;
2100 return fits_class;
2103 /* Jump over a comment, assuming we are at the beginning of one.
2104 FROM is the current position.
2105 FROM_BYTE is the bytepos corresponding to FROM.
2106 Do not move past STOP (a charpos).
2107 The comment over which we have to jump is of style STYLE
2108 (either SYNTAX_FLAGS_COMMENT_STYLE(foo) or ST_COMMENT_STYLE).
2109 NESTING should be positive to indicate the nesting at the beginning
2110 for nested comments and should be zero or negative else.
2111 ST_COMMENT_STYLE cannot be nested.
2112 PREV_SYNTAX is the SYNTAX_WITH_FLAGS of the previous character
2113 (or 0 If the search cannot start in the middle of a two-character).
2115 If successful, return 1 and store the charpos of the comment's end
2116 into *CHARPOS_PTR and the corresponding bytepos into *BYTEPOS_PTR.
2117 Else, return 0 and store the charpos STOP into *CHARPOS_PTR, the
2118 corresponding bytepos into *BYTEPOS_PTR and the current nesting
2119 (as defined for state.incomment) in *INCOMMENT_PTR.
2121 The comment end is the last character of the comment rather than the
2122 character just after the comment.
2124 Global syntax data is assumed to initially be valid for FROM and
2125 remains valid for forward search starting at the returned position. */
2127 static int
2128 forw_comment (EMACS_INT from, EMACS_INT from_byte, EMACS_INT stop,
2129 int nesting, int style, int prev_syntax,
2130 EMACS_INT *charpos_ptr, EMACS_INT *bytepos_ptr,
2131 int *incomment_ptr)
2133 register int c, c1;
2134 register enum syntaxcode code;
2135 register int syntax, other_syntax;
2137 if (nesting <= 0) nesting = -1;
2139 /* Enter the loop in the middle so that we find
2140 a 2-char comment ender if we start in the middle of it. */
2141 syntax = prev_syntax;
2142 if (syntax != 0) goto forw_incomment;
2144 while (1)
2146 if (from == stop)
2148 *incomment_ptr = nesting;
2149 *charpos_ptr = from;
2150 *bytepos_ptr = from_byte;
2151 return 0;
2153 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2154 syntax = SYNTAX_WITH_FLAGS (c);
2155 code = syntax & 0xff;
2156 if (code == Sendcomment
2157 && SYNTAX_FLAGS_COMMENT_STYLE (syntax, 0) == style
2158 && (SYNTAX_FLAGS_COMMENT_NESTED (syntax) ?
2159 (nesting > 0 && --nesting == 0) : nesting < 0))
2160 /* we have encountered a comment end of the same style
2161 as the comment sequence which began this comment
2162 section */
2163 break;
2164 if (code == Scomment_fence
2165 && style == ST_COMMENT_STYLE)
2166 /* we have encountered a comment end of the same style
2167 as the comment sequence which began this comment
2168 section. */
2169 break;
2170 if (nesting > 0
2171 && code == Scomment
2172 && SYNTAX_FLAGS_COMMENT_NESTED (syntax)
2173 && SYNTAX_FLAGS_COMMENT_STYLE (syntax, 0) == style)
2174 /* we have encountered a nested comment of the same style
2175 as the comment sequence which began this comment section */
2176 nesting++;
2177 INC_BOTH (from, from_byte);
2178 UPDATE_SYNTAX_TABLE_FORWARD (from);
2180 forw_incomment:
2181 if (from < stop && SYNTAX_FLAGS_COMEND_FIRST (syntax)
2182 && (c1 = FETCH_CHAR_AS_MULTIBYTE (from_byte),
2183 other_syntax = SYNTAX_WITH_FLAGS (c1),
2184 SYNTAX_FLAGS_COMEND_SECOND (other_syntax))
2185 && SYNTAX_FLAGS_COMMENT_STYLE (syntax, other_syntax) == style
2186 && ((SYNTAX_FLAGS_COMMENT_NESTED (syntax) ||
2187 SYNTAX_FLAGS_COMMENT_NESTED (other_syntax))
2188 ? nesting > 0 : nesting < 0))
2190 if (--nesting <= 0)
2191 /* we have encountered a comment end of the same style
2192 as the comment sequence which began this comment
2193 section */
2194 break;
2195 else
2197 INC_BOTH (from, from_byte);
2198 UPDATE_SYNTAX_TABLE_FORWARD (from);
2201 if (nesting > 0
2202 && from < stop
2203 && SYNTAX_FLAGS_COMSTART_FIRST (syntax)
2204 && (c1 = FETCH_CHAR_AS_MULTIBYTE (from_byte),
2205 other_syntax = SYNTAX_WITH_FLAGS (c1),
2206 SYNTAX_FLAGS_COMMENT_STYLE (other_syntax, syntax) == style
2207 && SYNTAX_FLAGS_COMSTART_SECOND (other_syntax))
2208 && (SYNTAX_FLAGS_COMMENT_NESTED (syntax) ||
2209 SYNTAX_FLAGS_COMMENT_NESTED (other_syntax)))
2210 /* we have encountered a nested comment of the same style
2211 as the comment sequence which began this comment
2212 section */
2214 INC_BOTH (from, from_byte);
2215 UPDATE_SYNTAX_TABLE_FORWARD (from);
2216 nesting++;
2219 *charpos_ptr = from;
2220 *bytepos_ptr = from_byte;
2221 return 1;
2224 DEFUN ("forward-comment", Fforward_comment, Sforward_comment, 1, 1, 0,
2225 doc: /*
2226 Move forward across up to COUNT comments. If COUNT is negative, move backward.
2227 Stop scanning if we find something other than a comment or whitespace.
2228 Set point to where scanning stops.
2229 If COUNT comments are found as expected, with nothing except whitespace
2230 between them, return t; otherwise return nil. */)
2231 (Lisp_Object count)
2233 register EMACS_INT from;
2234 EMACS_INT from_byte;
2235 register EMACS_INT stop;
2236 register int c, c1;
2237 register enum syntaxcode code;
2238 int comstyle = 0; /* style of comment encountered */
2239 int comnested = 0; /* whether the comment is nestable or not */
2240 int found;
2241 EMACS_INT count1;
2242 EMACS_INT out_charpos, out_bytepos;
2243 int dummy;
2245 CHECK_NUMBER (count);
2246 count1 = XINT (count);
2247 stop = count1 > 0 ? ZV : BEGV;
2249 immediate_quit = 1;
2250 QUIT;
2252 from = PT;
2253 from_byte = PT_BYTE;
2255 SETUP_SYNTAX_TABLE (from, count1);
2256 while (count1 > 0)
2260 int comstart_first, syntax, other_syntax;
2262 if (from == stop)
2264 SET_PT_BOTH (from, from_byte);
2265 immediate_quit = 0;
2266 return Qnil;
2268 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2269 syntax = SYNTAX_WITH_FLAGS (c);
2270 code = SYNTAX (c);
2271 comstart_first = SYNTAX_FLAGS_COMSTART_FIRST (syntax);
2272 comnested = SYNTAX_FLAGS_COMMENT_NESTED (syntax);
2273 comstyle = SYNTAX_FLAGS_COMMENT_STYLE (syntax, 0);
2274 INC_BOTH (from, from_byte);
2275 UPDATE_SYNTAX_TABLE_FORWARD (from);
2276 if (from < stop && comstart_first
2277 && (c1 = FETCH_CHAR_AS_MULTIBYTE (from_byte),
2278 other_syntax = SYNTAX_WITH_FLAGS (c1),
2279 SYNTAX_FLAGS_COMSTART_SECOND (other_syntax)))
2281 /* We have encountered a comment start sequence and we
2282 are ignoring all text inside comments. We must record
2283 the comment style this sequence begins so that later,
2284 only a comment end of the same style actually ends
2285 the comment section. */
2286 code = Scomment;
2287 comstyle = SYNTAX_FLAGS_COMMENT_STYLE (other_syntax, syntax);
2288 comnested
2289 = comnested || SYNTAX_FLAGS_COMMENT_NESTED (other_syntax);
2290 INC_BOTH (from, from_byte);
2291 UPDATE_SYNTAX_TABLE_FORWARD (from);
2294 while (code == Swhitespace || (code == Sendcomment && c == '\n'));
2296 if (code == Scomment_fence)
2297 comstyle = ST_COMMENT_STYLE;
2298 else if (code != Scomment)
2300 immediate_quit = 0;
2301 DEC_BOTH (from, from_byte);
2302 SET_PT_BOTH (from, from_byte);
2303 return Qnil;
2305 /* We're at the start of a comment. */
2306 found = forw_comment (from, from_byte, stop, comnested, comstyle, 0,
2307 &out_charpos, &out_bytepos, &dummy);
2308 from = out_charpos; from_byte = out_bytepos;
2309 if (!found)
2311 immediate_quit = 0;
2312 SET_PT_BOTH (from, from_byte);
2313 return Qnil;
2315 INC_BOTH (from, from_byte);
2316 UPDATE_SYNTAX_TABLE_FORWARD (from);
2317 /* We have skipped one comment. */
2318 count1--;
2321 while (count1 < 0)
2323 while (1)
2325 int quoted, syntax;
2327 if (from <= stop)
2329 SET_PT_BOTH (BEGV, BEGV_BYTE);
2330 immediate_quit = 0;
2331 return Qnil;
2334 DEC_BOTH (from, from_byte);
2335 /* char_quoted does UPDATE_SYNTAX_TABLE_BACKWARD (from). */
2336 quoted = char_quoted (from, from_byte);
2337 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2338 syntax = SYNTAX_WITH_FLAGS (c);
2339 code = SYNTAX (c);
2340 comstyle = 0;
2341 comnested = SYNTAX_FLAGS_COMMENT_NESTED (syntax);
2342 if (code == Sendcomment)
2343 comstyle = SYNTAX_FLAGS_COMMENT_STYLE (syntax, 0);
2344 if (from > stop && SYNTAX_FLAGS_COMEND_SECOND (syntax)
2345 && prev_char_comend_first (from, from_byte)
2346 && !char_quoted (from - 1, dec_bytepos (from_byte)))
2348 int other_syntax;
2349 /* We must record the comment style encountered so that
2350 later, we can match only the proper comment begin
2351 sequence of the same style. */
2352 DEC_BOTH (from, from_byte);
2353 code = Sendcomment;
2354 /* Calling char_quoted, above, set up global syntax position
2355 at the new value of FROM. */
2356 c1 = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2357 other_syntax = SYNTAX_WITH_FLAGS (c1);
2358 comstyle = SYNTAX_FLAGS_COMMENT_STYLE (other_syntax, syntax);
2359 comnested
2360 = comnested || SYNTAX_FLAGS_COMMENT_NESTED (other_syntax);
2363 if (code == Scomment_fence)
2365 /* Skip until first preceding unquoted comment_fence. */
2366 int fence_found = 0;
2367 EMACS_INT ini = from, ini_byte = from_byte;
2369 while (1)
2371 DEC_BOTH (from, from_byte);
2372 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2373 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2374 if (SYNTAX (c) == Scomment_fence
2375 && !char_quoted (from, from_byte))
2377 fence_found = 1;
2378 break;
2380 else if (from == stop)
2381 break;
2383 if (fence_found == 0)
2385 from = ini; /* Set point to ini + 1. */
2386 from_byte = ini_byte;
2387 goto leave;
2389 else
2390 /* We have skipped one comment. */
2391 break;
2393 else if (code == Sendcomment)
2395 found = back_comment (from, from_byte, stop, comnested, comstyle,
2396 &out_charpos, &out_bytepos);
2397 if (found == -1)
2399 if (c == '\n')
2400 /* This end-of-line is not an end-of-comment.
2401 Treat it like a whitespace.
2402 CC-mode (and maybe others) relies on this behavior. */
2404 else
2406 /* Failure: we should go back to the end of this
2407 not-quite-endcomment. */
2408 if (SYNTAX (c) != code)
2409 /* It was a two-char Sendcomment. */
2410 INC_BOTH (from, from_byte);
2411 goto leave;
2414 else
2416 /* We have skipped one comment. */
2417 from = out_charpos, from_byte = out_bytepos;
2418 break;
2421 else if (code != Swhitespace || quoted)
2423 leave:
2424 immediate_quit = 0;
2425 INC_BOTH (from, from_byte);
2426 SET_PT_BOTH (from, from_byte);
2427 return Qnil;
2431 count1++;
2434 SET_PT_BOTH (from, from_byte);
2435 immediate_quit = 0;
2436 return Qt;
2439 /* Return syntax code of character C if C is an ASCII character
2440 or `multibyte_symbol_p' is zero. Otherwise, return Ssymbol. */
2442 #define SYNTAX_WITH_MULTIBYTE_CHECK(c) \
2443 ((ASCII_CHAR_P (c) || !multibyte_symbol_p) \
2444 ? SYNTAX (c) : Ssymbol)
2446 static Lisp_Object
2447 scan_lists (register EMACS_INT from, EMACS_INT count, EMACS_INT depth, int sexpflag)
2449 Lisp_Object val;
2450 register EMACS_INT stop = count > 0 ? ZV : BEGV;
2451 register int c, c1;
2452 int stringterm;
2453 int quoted;
2454 int mathexit = 0;
2455 register enum syntaxcode code, temp_code;
2456 int min_depth = depth; /* Err out if depth gets less than this. */
2457 int comstyle = 0; /* style of comment encountered */
2458 int comnested = 0; /* whether the comment is nestable or not */
2459 EMACS_INT temp_pos;
2460 EMACS_INT last_good = from;
2461 int found;
2462 EMACS_INT from_byte;
2463 EMACS_INT out_bytepos, out_charpos;
2464 int temp, dummy;
2465 int multibyte_symbol_p = sexpflag && multibyte_syntax_as_symbol;
2467 if (depth > 0) min_depth = 0;
2469 if (from > ZV) from = ZV;
2470 if (from < BEGV) from = BEGV;
2472 from_byte = CHAR_TO_BYTE (from);
2474 immediate_quit = 1;
2475 QUIT;
2477 SETUP_SYNTAX_TABLE (from, count);
2478 while (count > 0)
2480 while (from < stop)
2482 int comstart_first, prefix, syntax, other_syntax;
2483 UPDATE_SYNTAX_TABLE_FORWARD (from);
2484 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2485 syntax = SYNTAX_WITH_FLAGS (c);
2486 code = SYNTAX_WITH_MULTIBYTE_CHECK (c);
2487 comstart_first = SYNTAX_FLAGS_COMSTART_FIRST (syntax);
2488 comnested = SYNTAX_FLAGS_COMMENT_NESTED (syntax);
2489 comstyle = SYNTAX_FLAGS_COMMENT_STYLE (syntax, 0);
2490 prefix = SYNTAX_FLAGS_PREFIX (syntax);
2491 if (depth == min_depth)
2492 last_good = from;
2493 INC_BOTH (from, from_byte);
2494 UPDATE_SYNTAX_TABLE_FORWARD (from);
2495 if (from < stop && comstart_first
2496 && (c = FETCH_CHAR_AS_MULTIBYTE (from_byte),
2497 other_syntax = SYNTAX_WITH_FLAGS (c),
2498 SYNTAX_FLAGS_COMSTART_SECOND (other_syntax))
2499 && parse_sexp_ignore_comments)
2501 /* we have encountered a comment start sequence and we
2502 are ignoring all text inside comments. We must record
2503 the comment style this sequence begins so that later,
2504 only a comment end of the same style actually ends
2505 the comment section */
2506 code = Scomment;
2507 comstyle = SYNTAX_FLAGS_COMMENT_STYLE (other_syntax, syntax);
2508 comnested
2509 = comnested || SYNTAX_FLAGS_COMMENT_NESTED (other_syntax);
2510 INC_BOTH (from, from_byte);
2511 UPDATE_SYNTAX_TABLE_FORWARD (from);
2514 if (prefix)
2515 continue;
2517 switch (SWITCH_ENUM_CAST (code))
2519 case Sescape:
2520 case Scharquote:
2521 if (from == stop)
2522 goto lose;
2523 INC_BOTH (from, from_byte);
2524 /* treat following character as a word constituent */
2525 case Sword:
2526 case Ssymbol:
2527 if (depth || !sexpflag) break;
2528 /* This word counts as a sexp; return at end of it. */
2529 while (from < stop)
2531 UPDATE_SYNTAX_TABLE_FORWARD (from);
2533 /* Some compilers can't handle this inside the switch. */
2534 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2535 temp = SYNTAX_WITH_MULTIBYTE_CHECK (c);
2536 switch (temp)
2538 case Scharquote:
2539 case Sescape:
2540 INC_BOTH (from, from_byte);
2541 if (from == stop)
2542 goto lose;
2543 break;
2544 case Sword:
2545 case Ssymbol:
2546 case Squote:
2547 break;
2548 default:
2549 goto done;
2551 INC_BOTH (from, from_byte);
2553 goto done;
2555 case Scomment_fence:
2556 comstyle = ST_COMMENT_STYLE;
2557 /* FALLTHROUGH */
2558 case Scomment:
2559 if (!parse_sexp_ignore_comments) break;
2560 UPDATE_SYNTAX_TABLE_FORWARD (from);
2561 found = forw_comment (from, from_byte, stop,
2562 comnested, comstyle, 0,
2563 &out_charpos, &out_bytepos, &dummy);
2564 from = out_charpos, from_byte = out_bytepos;
2565 if (!found)
2567 if (depth == 0)
2568 goto done;
2569 goto lose;
2571 INC_BOTH (from, from_byte);
2572 UPDATE_SYNTAX_TABLE_FORWARD (from);
2573 break;
2575 case Smath:
2576 if (!sexpflag)
2577 break;
2578 if (from != stop && c == FETCH_CHAR_AS_MULTIBYTE (from_byte))
2580 INC_BOTH (from, from_byte);
2582 if (mathexit)
2584 mathexit = 0;
2585 goto close1;
2587 mathexit = 1;
2589 case Sopen:
2590 if (!++depth) goto done;
2591 break;
2593 case Sclose:
2594 close1:
2595 if (!--depth) goto done;
2596 if (depth < min_depth)
2597 xsignal3 (Qscan_error,
2598 build_string ("Containing expression ends prematurely"),
2599 make_number (last_good), make_number (from));
2600 break;
2602 case Sstring:
2603 case Sstring_fence:
2604 temp_pos = dec_bytepos (from_byte);
2605 stringterm = FETCH_CHAR_AS_MULTIBYTE (temp_pos);
2606 while (1)
2608 if (from >= stop)
2609 goto lose;
2610 UPDATE_SYNTAX_TABLE_FORWARD (from);
2611 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2612 if (code == Sstring
2613 ? (c == stringterm
2614 && SYNTAX_WITH_MULTIBYTE_CHECK (c) == Sstring)
2615 : SYNTAX_WITH_MULTIBYTE_CHECK (c) == Sstring_fence)
2616 break;
2618 /* Some compilers can't handle this inside the switch. */
2619 temp = SYNTAX_WITH_MULTIBYTE_CHECK (c);
2620 switch (temp)
2622 case Scharquote:
2623 case Sescape:
2624 INC_BOTH (from, from_byte);
2626 INC_BOTH (from, from_byte);
2628 INC_BOTH (from, from_byte);
2629 if (!depth && sexpflag) goto done;
2630 break;
2631 default:
2632 /* Ignore whitespace, punctuation, quote, endcomment. */
2633 break;
2637 /* Reached end of buffer. Error if within object, return nil if between */
2638 if (depth)
2639 goto lose;
2641 immediate_quit = 0;
2642 return Qnil;
2644 /* End of object reached */
2645 done:
2646 count--;
2649 while (count < 0)
2651 while (from > stop)
2653 int syntax;
2654 DEC_BOTH (from, from_byte);
2655 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2656 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2657 syntax= SYNTAX_WITH_FLAGS (c);
2658 code = SYNTAX_WITH_MULTIBYTE_CHECK (c);
2659 if (depth == min_depth)
2660 last_good = from;
2661 comstyle = 0;
2662 comnested = SYNTAX_FLAGS_COMMENT_NESTED (syntax);
2663 if (code == Sendcomment)
2664 comstyle = SYNTAX_FLAGS_COMMENT_STYLE (syntax, 0);
2665 if (from > stop && SYNTAX_FLAGS_COMEND_SECOND (syntax)
2666 && prev_char_comend_first (from, from_byte)
2667 && parse_sexp_ignore_comments)
2669 /* We must record the comment style encountered so that
2670 later, we can match only the proper comment begin
2671 sequence of the same style. */
2672 int c2, other_syntax;
2673 DEC_BOTH (from, from_byte);
2674 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2675 code = Sendcomment;
2676 c2 = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2677 other_syntax = SYNTAX_WITH_FLAGS (c2);
2678 comstyle = SYNTAX_FLAGS_COMMENT_STYLE (other_syntax, syntax);
2679 comnested
2680 = comnested || SYNTAX_FLAGS_COMMENT_NESTED (other_syntax);
2683 /* Quoting turns anything except a comment-ender
2684 into a word character. Note that this cannot be true
2685 if we decremented FROM in the if-statement above. */
2686 if (code != Sendcomment && char_quoted (from, from_byte))
2688 DEC_BOTH (from, from_byte);
2689 code = Sword;
2691 else if (SYNTAX_FLAGS_PREFIX (syntax))
2692 continue;
2694 switch (SWITCH_ENUM_CAST (code))
2696 case Sword:
2697 case Ssymbol:
2698 case Sescape:
2699 case Scharquote:
2700 if (depth || !sexpflag) break;
2701 /* This word counts as a sexp; count object finished
2702 after passing it. */
2703 while (from > stop)
2705 temp_pos = from_byte;
2706 if (! NILP (BVAR (current_buffer, enable_multibyte_characters)))
2707 DEC_POS (temp_pos);
2708 else
2709 temp_pos--;
2710 UPDATE_SYNTAX_TABLE_BACKWARD (from - 1);
2711 c1 = FETCH_CHAR_AS_MULTIBYTE (temp_pos);
2712 temp_code = SYNTAX_WITH_MULTIBYTE_CHECK (c1);
2713 /* Don't allow comment-end to be quoted. */
2714 if (temp_code == Sendcomment)
2715 goto done2;
2716 quoted = char_quoted (from - 1, temp_pos);
2717 if (quoted)
2719 DEC_BOTH (from, from_byte);
2720 temp_pos = dec_bytepos (temp_pos);
2721 UPDATE_SYNTAX_TABLE_BACKWARD (from - 1);
2723 c1 = FETCH_CHAR_AS_MULTIBYTE (temp_pos);
2724 temp_code = SYNTAX_WITH_MULTIBYTE_CHECK (c1);
2725 if (! (quoted || temp_code == Sword
2726 || temp_code == Ssymbol
2727 || temp_code == Squote))
2728 goto done2;
2729 DEC_BOTH (from, from_byte);
2731 goto done2;
2733 case Smath:
2734 if (!sexpflag)
2735 break;
2736 temp_pos = dec_bytepos (from_byte);
2737 UPDATE_SYNTAX_TABLE_BACKWARD (from - 1);
2738 if (from != stop && c == FETCH_CHAR_AS_MULTIBYTE (temp_pos))
2739 DEC_BOTH (from, from_byte);
2740 if (mathexit)
2742 mathexit = 0;
2743 goto open2;
2745 mathexit = 1;
2747 case Sclose:
2748 if (!++depth) goto done2;
2749 break;
2751 case Sopen:
2752 open2:
2753 if (!--depth) goto done2;
2754 if (depth < min_depth)
2755 xsignal3 (Qscan_error,
2756 build_string ("Containing expression ends prematurely"),
2757 make_number (last_good), make_number (from));
2758 break;
2760 case Sendcomment:
2761 if (!parse_sexp_ignore_comments)
2762 break;
2763 found = back_comment (from, from_byte, stop, comnested, comstyle,
2764 &out_charpos, &out_bytepos);
2765 /* FIXME: if found == -1, then it really wasn't a comment-end.
2766 For single-char Sendcomment, we can't do much about it apart
2767 from skipping the char.
2768 For 2-char endcomments, we could try again, taking both
2769 chars as separate entities, but it's a lot of trouble
2770 for very little gain, so we don't bother either. -sm */
2771 if (found != -1)
2772 from = out_charpos, from_byte = out_bytepos;
2773 break;
2775 case Scomment_fence:
2776 case Sstring_fence:
2777 while (1)
2779 if (from == stop)
2780 goto lose;
2781 DEC_BOTH (from, from_byte);
2782 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2783 if (!char_quoted (from, from_byte)
2784 && (c = FETCH_CHAR_AS_MULTIBYTE (from_byte),
2785 SYNTAX_WITH_MULTIBYTE_CHECK (c) == code))
2786 break;
2788 if (code == Sstring_fence && !depth && sexpflag) goto done2;
2789 break;
2791 case Sstring:
2792 stringterm = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2793 while (1)
2795 if (from == stop)
2796 goto lose;
2797 DEC_BOTH (from, from_byte);
2798 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2799 if (!char_quoted (from, from_byte)
2800 && (stringterm
2801 == (c = FETCH_CHAR_AS_MULTIBYTE (from_byte)))
2802 && SYNTAX_WITH_MULTIBYTE_CHECK (c) == Sstring)
2803 break;
2805 if (!depth && sexpflag) goto done2;
2806 break;
2807 default:
2808 /* Ignore whitespace, punctuation, quote, endcomment. */
2809 break;
2813 /* Reached start of buffer. Error if within object, return nil if between */
2814 if (depth)
2815 goto lose;
2817 immediate_quit = 0;
2818 return Qnil;
2820 done2:
2821 count++;
2825 immediate_quit = 0;
2826 XSETFASTINT (val, from);
2827 return val;
2829 lose:
2830 xsignal3 (Qscan_error,
2831 build_string ("Unbalanced parentheses"),
2832 make_number (last_good), make_number (from));
2835 DEFUN ("scan-lists", Fscan_lists, Sscan_lists, 3, 3, 0,
2836 doc: /* Scan from character number FROM by COUNT lists.
2837 Returns the character number of the position thus found.
2839 If DEPTH is nonzero, paren depth begins counting from that value,
2840 only places where the depth in parentheses becomes zero
2841 are candidates for stopping; COUNT such places are counted.
2842 Thus, a positive value for DEPTH means go out levels.
2844 Comments are ignored if `parse-sexp-ignore-comments' is non-nil.
2846 If the beginning or end of (the accessible part of) the buffer is reached
2847 and the depth is wrong, an error is signaled.
2848 If the depth is right but the count is not used up, nil is returned. */)
2849 (Lisp_Object from, Lisp_Object count, Lisp_Object depth)
2851 CHECK_NUMBER (from);
2852 CHECK_NUMBER (count);
2853 CHECK_NUMBER (depth);
2855 return scan_lists (XINT (from), XINT (count), XINT (depth), 0);
2858 DEFUN ("scan-sexps", Fscan_sexps, Sscan_sexps, 2, 2, 0,
2859 doc: /* Scan from character number FROM by COUNT balanced expressions.
2860 If COUNT is negative, scan backwards.
2861 Returns the character number of the position thus found.
2863 Comments are ignored if `parse-sexp-ignore-comments' is non-nil.
2865 If the beginning or end of (the accessible part of) the buffer is reached
2866 in the middle of a parenthetical grouping, an error is signaled.
2867 If the beginning or end is reached between groupings
2868 but before count is used up, nil is returned. */)
2869 (Lisp_Object from, Lisp_Object count)
2871 CHECK_NUMBER (from);
2872 CHECK_NUMBER (count);
2874 return scan_lists (XINT (from), XINT (count), 0, 1);
2877 DEFUN ("backward-prefix-chars", Fbackward_prefix_chars, Sbackward_prefix_chars,
2878 0, 0, 0,
2879 doc: /* Move point backward over any number of chars with prefix syntax.
2880 This includes chars with "quote" or "prefix" syntax (' or p). */)
2881 (void)
2883 EMACS_INT beg = BEGV;
2884 EMACS_INT opoint = PT;
2885 EMACS_INT opoint_byte = PT_BYTE;
2886 EMACS_INT pos = PT;
2887 EMACS_INT pos_byte = PT_BYTE;
2888 int c;
2890 if (pos <= beg)
2892 SET_PT_BOTH (opoint, opoint_byte);
2894 return Qnil;
2897 SETUP_SYNTAX_TABLE (pos, -1);
2899 DEC_BOTH (pos, pos_byte);
2901 while (!char_quoted (pos, pos_byte)
2902 /* Previous statement updates syntax table. */
2903 && ((c = FETCH_CHAR_AS_MULTIBYTE (pos_byte), SYNTAX (c) == Squote)
2904 || SYNTAX_PREFIX (c)))
2906 opoint = pos;
2907 opoint_byte = pos_byte;
2909 if (pos + 1 > beg)
2910 DEC_BOTH (pos, pos_byte);
2913 SET_PT_BOTH (opoint, opoint_byte);
2915 return Qnil;
2918 /* Parse forward from FROM / FROM_BYTE to END,
2919 assuming that FROM has state OLDSTATE (nil means FROM is start of function),
2920 and return a description of the state of the parse at END.
2921 If STOPBEFORE is nonzero, stop at the start of an atom.
2922 If COMMENTSTOP is 1, stop at the start of a comment.
2923 If COMMENTSTOP is -1, stop at the start or end of a comment,
2924 after the beginning of a string, or after the end of a string. */
2926 static void
2927 scan_sexps_forward (struct lisp_parse_state *stateptr,
2928 EMACS_INT from, EMACS_INT from_byte, EMACS_INT end,
2929 int targetdepth, int stopbefore,
2930 Lisp_Object oldstate, int commentstop)
2932 struct lisp_parse_state state;
2934 register enum syntaxcode code;
2935 int c1;
2936 int comnested;
2937 struct level { int last, prev; };
2938 struct level levelstart[100];
2939 register struct level *curlevel = levelstart;
2940 struct level *endlevel = levelstart + 100;
2941 register int depth; /* Paren depth of current scanning location.
2942 level - levelstart equals this except
2943 when the depth becomes negative. */
2944 int mindepth; /* Lowest DEPTH value seen. */
2945 int start_quoted = 0; /* Nonzero means starting after a char quote */
2946 Lisp_Object tem;
2947 EMACS_INT prev_from; /* Keep one character before FROM. */
2948 EMACS_INT prev_from_byte;
2949 int prev_from_syntax;
2950 int boundary_stop = commentstop == -1;
2951 int nofence;
2952 int found;
2953 EMACS_INT out_bytepos, out_charpos;
2954 int temp;
2956 prev_from = from;
2957 prev_from_byte = from_byte;
2958 if (from != BEGV)
2959 DEC_BOTH (prev_from, prev_from_byte);
2961 /* Use this macro instead of `from++'. */
2962 #define INC_FROM \
2963 do { prev_from = from; \
2964 prev_from_byte = from_byte; \
2965 temp = FETCH_CHAR_AS_MULTIBYTE (prev_from_byte); \
2966 prev_from_syntax = SYNTAX_WITH_FLAGS (temp); \
2967 INC_BOTH (from, from_byte); \
2968 if (from < end) \
2969 UPDATE_SYNTAX_TABLE_FORWARD (from); \
2970 } while (0)
2972 immediate_quit = 1;
2973 QUIT;
2975 if (NILP (oldstate))
2977 depth = 0;
2978 state.instring = -1;
2979 state.incomment = 0;
2980 state.comstyle = 0; /* comment style a by default. */
2981 state.comstr_start = -1; /* no comment/string seen. */
2983 else
2985 tem = Fcar (oldstate);
2986 if (!NILP (tem))
2987 depth = XINT (tem);
2988 else
2989 depth = 0;
2991 oldstate = Fcdr (oldstate);
2992 oldstate = Fcdr (oldstate);
2993 oldstate = Fcdr (oldstate);
2994 tem = Fcar (oldstate);
2995 /* Check whether we are inside string_fence-style string: */
2996 state.instring = (!NILP (tem)
2997 ? (INTEGERP (tem) ? XINT (tem) : ST_STRING_STYLE)
2998 : -1);
3000 oldstate = Fcdr (oldstate);
3001 tem = Fcar (oldstate);
3002 state.incomment = (!NILP (tem)
3003 ? (INTEGERP (tem) ? XINT (tem) : -1)
3004 : 0);
3006 oldstate = Fcdr (oldstate);
3007 tem = Fcar (oldstate);
3008 start_quoted = !NILP (tem);
3010 /* if the eighth element of the list is nil, we are in comment
3011 style a. If it is non-nil, we are in comment style b */
3012 oldstate = Fcdr (oldstate);
3013 oldstate = Fcdr (oldstate);
3014 tem = Fcar (oldstate);
3015 state.comstyle = (NILP (tem)
3017 : (EQ (tem, Qsyntax_table)
3018 ? ST_COMMENT_STYLE
3019 : INTEGERP (tem) ? XINT (tem) : 1));
3021 oldstate = Fcdr (oldstate);
3022 tem = Fcar (oldstate);
3023 state.comstr_start = NILP (tem) ? -1 : XINT (tem) ;
3024 oldstate = Fcdr (oldstate);
3025 tem = Fcar (oldstate);
3026 while (!NILP (tem)) /* >= second enclosing sexps. */
3028 /* curlevel++->last ran into compiler bug on Apollo */
3029 curlevel->last = XINT (Fcar (tem));
3030 if (++curlevel == endlevel)
3031 curlevel--; /* error ("Nesting too deep for parser"); */
3032 curlevel->prev = -1;
3033 curlevel->last = -1;
3034 tem = Fcdr (tem);
3037 state.quoted = 0;
3038 mindepth = depth;
3040 curlevel->prev = -1;
3041 curlevel->last = -1;
3043 SETUP_SYNTAX_TABLE (prev_from, 1);
3044 temp = FETCH_CHAR (prev_from_byte);
3045 prev_from_syntax = SYNTAX_WITH_FLAGS (temp);
3046 UPDATE_SYNTAX_TABLE_FORWARD (from);
3048 /* Enter the loop at a place appropriate for initial state. */
3050 if (state.incomment)
3051 goto startincomment;
3052 if (state.instring >= 0)
3054 nofence = state.instring != ST_STRING_STYLE;
3055 if (start_quoted)
3056 goto startquotedinstring;
3057 goto startinstring;
3059 else if (start_quoted)
3060 goto startquoted;
3062 while (from < end)
3064 int syntax;
3065 INC_FROM;
3066 code = prev_from_syntax & 0xff;
3068 if (from < end
3069 && SYNTAX_FLAGS_COMSTART_FIRST (prev_from_syntax)
3070 && (c1 = FETCH_CHAR (from_byte),
3071 syntax = SYNTAX_WITH_FLAGS (c1),
3072 SYNTAX_FLAGS_COMSTART_SECOND (syntax)))
3073 /* Duplicate code to avoid a complex if-expression
3074 which causes trouble for the SGI compiler. */
3076 /* Record the comment style we have entered so that only
3077 the comment-end sequence of the same style actually
3078 terminates the comment section. */
3079 state.comstyle
3080 = SYNTAX_FLAGS_COMMENT_STYLE (syntax, prev_from_syntax);
3081 comnested = SYNTAX_FLAGS_COMMENT_NESTED (prev_from_syntax);
3082 comnested = comnested || SYNTAX_FLAGS_COMMENT_NESTED (syntax);
3083 state.incomment = comnested ? 1 : -1;
3084 state.comstr_start = prev_from;
3085 INC_FROM;
3086 code = Scomment;
3088 else if (code == Scomment_fence)
3090 /* Record the comment style we have entered so that only
3091 the comment-end sequence of the same style actually
3092 terminates the comment section. */
3093 state.comstyle = ST_COMMENT_STYLE;
3094 state.incomment = -1;
3095 state.comstr_start = prev_from;
3096 code = Scomment;
3098 else if (code == Scomment)
3100 state.comstyle = SYNTAX_FLAGS_COMMENT_STYLE (prev_from_syntax, 0);
3101 state.incomment = (SYNTAX_FLAGS_COMMENT_NESTED (prev_from_syntax) ?
3102 1 : -1);
3103 state.comstr_start = prev_from;
3106 if (SYNTAX_FLAGS_PREFIX (prev_from_syntax))
3107 continue;
3108 switch (SWITCH_ENUM_CAST (code))
3110 case Sescape:
3111 case Scharquote:
3112 if (stopbefore) goto stop; /* this arg means stop at sexp start */
3113 curlevel->last = prev_from;
3114 startquoted:
3115 if (from == end) goto endquoted;
3116 INC_FROM;
3117 goto symstarted;
3118 /* treat following character as a word constituent */
3119 case Sword:
3120 case Ssymbol:
3121 if (stopbefore) goto stop; /* this arg means stop at sexp start */
3122 curlevel->last = prev_from;
3123 symstarted:
3124 while (from < end)
3126 /* Some compilers can't handle this inside the switch. */
3127 temp = FETCH_CHAR_AS_MULTIBYTE (from_byte);
3128 temp = SYNTAX (temp);
3129 switch (temp)
3131 case Scharquote:
3132 case Sescape:
3133 INC_FROM;
3134 if (from == end) goto endquoted;
3135 break;
3136 case Sword:
3137 case Ssymbol:
3138 case Squote:
3139 break;
3140 default:
3141 goto symdone;
3143 INC_FROM;
3145 symdone:
3146 curlevel->prev = curlevel->last;
3147 break;
3149 case Scomment_fence: /* Can't happen because it's handled above. */
3150 case Scomment:
3151 if (commentstop || boundary_stop) goto done;
3152 startincomment:
3153 /* The (from == BEGV) test was to enter the loop in the middle so
3154 that we find a 2-char comment ender even if we start in the
3155 middle of it. We don't want to do that if we're just at the
3156 beginning of the comment (think of (*) ... (*)). */
3157 found = forw_comment (from, from_byte, end,
3158 state.incomment, state.comstyle,
3159 (from == BEGV || from < state.comstr_start + 3)
3160 ? 0 : prev_from_syntax,
3161 &out_charpos, &out_bytepos, &state.incomment);
3162 from = out_charpos; from_byte = out_bytepos;
3163 /* Beware! prev_from and friends are invalid now.
3164 Luckily, the `done' doesn't use them and the INC_FROM
3165 sets them to a sane value without looking at them. */
3166 if (!found) goto done;
3167 INC_FROM;
3168 state.incomment = 0;
3169 state.comstyle = 0; /* reset the comment style */
3170 if (boundary_stop) goto done;
3171 break;
3173 case Sopen:
3174 if (stopbefore) goto stop; /* this arg means stop at sexp start */
3175 depth++;
3176 /* curlevel++->last ran into compiler bug on Apollo */
3177 curlevel->last = prev_from;
3178 if (++curlevel == endlevel)
3179 curlevel--; /* error ("Nesting too deep for parser"); */
3180 curlevel->prev = -1;
3181 curlevel->last = -1;
3182 if (targetdepth == depth) goto done;
3183 break;
3185 case Sclose:
3186 depth--;
3187 if (depth < mindepth)
3188 mindepth = depth;
3189 if (curlevel != levelstart)
3190 curlevel--;
3191 curlevel->prev = curlevel->last;
3192 if (targetdepth == depth) goto done;
3193 break;
3195 case Sstring:
3196 case Sstring_fence:
3197 state.comstr_start = from - 1;
3198 if (stopbefore) goto stop; /* this arg means stop at sexp start */
3199 curlevel->last = prev_from;
3200 state.instring = (code == Sstring
3201 ? (FETCH_CHAR_AS_MULTIBYTE (prev_from_byte))
3202 : ST_STRING_STYLE);
3203 if (boundary_stop) goto done;
3204 startinstring:
3206 nofence = state.instring != ST_STRING_STYLE;
3208 while (1)
3210 int c;
3212 if (from >= end) goto done;
3213 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
3214 /* Some compilers can't handle this inside the switch. */
3215 temp = SYNTAX (c);
3217 /* Check TEMP here so that if the char has
3218 a syntax-table property which says it is NOT
3219 a string character, it does not end the string. */
3220 if (nofence && c == state.instring && temp == Sstring)
3221 break;
3223 switch (temp)
3225 case Sstring_fence:
3226 if (!nofence) goto string_end;
3227 break;
3228 case Scharquote:
3229 case Sescape:
3230 INC_FROM;
3231 startquotedinstring:
3232 if (from >= end) goto endquoted;
3234 INC_FROM;
3237 string_end:
3238 state.instring = -1;
3239 curlevel->prev = curlevel->last;
3240 INC_FROM;
3241 if (boundary_stop) goto done;
3242 break;
3244 case Smath:
3245 /* FIXME: We should do something with it. */
3246 break;
3247 default:
3248 /* Ignore whitespace, punctuation, quote, endcomment. */
3249 break;
3252 goto done;
3254 stop: /* Here if stopping before start of sexp. */
3255 from = prev_from; /* We have just fetched the char that starts it; */
3256 goto done; /* but return the position before it. */
3258 endquoted:
3259 state.quoted = 1;
3260 done:
3261 state.depth = depth;
3262 state.mindepth = mindepth;
3263 state.thislevelstart = curlevel->prev;
3264 state.prevlevelstart
3265 = (curlevel == levelstart) ? -1 : (curlevel - 1)->last;
3266 state.location = from;
3267 state.levelstarts = Qnil;
3268 while (curlevel > levelstart)
3269 state.levelstarts = Fcons (make_number ((--curlevel)->last),
3270 state.levelstarts);
3271 immediate_quit = 0;
3273 *stateptr = state;
3276 DEFUN ("parse-partial-sexp", Fparse_partial_sexp, Sparse_partial_sexp, 2, 6, 0,
3277 doc: /* Parse Lisp syntax starting at FROM until TO; return status of parse at TO.
3278 Parsing stops at TO or when certain criteria are met;
3279 point is set to where parsing stops.
3280 If fifth arg OLDSTATE is omitted or nil,
3281 parsing assumes that FROM is the beginning of a function.
3282 Value is a list of elements describing final state of parsing:
3283 0. depth in parens.
3284 1. character address of start of innermost containing list; nil if none.
3285 2. character address of start of last complete sexp terminated.
3286 3. non-nil if inside a string.
3287 (it is the character that will terminate the string,
3288 or t if the string should be terminated by a generic string delimiter.)
3289 4. nil if outside a comment, t if inside a non-nestable comment,
3290 else an integer (the current comment nesting).
3291 5. t if following a quote character.
3292 6. the minimum paren-depth encountered during this scan.
3293 7. style of comment, if any.
3294 8. character address of start of comment or string; nil if not in one.
3295 9. Intermediate data for continuation of parsing (subject to change).
3296 If third arg TARGETDEPTH is non-nil, parsing stops if the depth
3297 in parentheses becomes equal to TARGETDEPTH.
3298 Fourth arg STOPBEFORE non-nil means stop when come to
3299 any character that starts a sexp.
3300 Fifth arg OLDSTATE is a list like what this function returns.
3301 It is used to initialize the state of the parse. Elements number 1, 2, 6
3302 and 8 are ignored.
3303 Sixth arg COMMENTSTOP non-nil means stop at the start of a comment.
3304 If it is symbol `syntax-table', stop after the start of a comment or a
3305 string, or after end of a comment or a string. */)
3306 (Lisp_Object from, Lisp_Object to, Lisp_Object targetdepth, Lisp_Object stopbefore, Lisp_Object oldstate, Lisp_Object commentstop)
3308 struct lisp_parse_state state;
3309 int target;
3311 if (!NILP (targetdepth))
3313 CHECK_NUMBER (targetdepth);
3314 target = XINT (targetdepth);
3316 else
3317 target = -100000; /* We won't reach this depth */
3319 validate_region (&from, &to);
3320 scan_sexps_forward (&state, XINT (from), CHAR_TO_BYTE (XINT (from)),
3321 XINT (to),
3322 target, !NILP (stopbefore), oldstate,
3323 (NILP (commentstop)
3324 ? 0 : (EQ (commentstop, Qsyntax_table) ? -1 : 1)));
3326 SET_PT (state.location);
3328 return Fcons (make_number (state.depth),
3329 Fcons (state.prevlevelstart < 0
3330 ? Qnil : make_number (state.prevlevelstart),
3331 Fcons (state.thislevelstart < 0
3332 ? Qnil : make_number (state.thislevelstart),
3333 Fcons (state.instring >= 0
3334 ? (state.instring == ST_STRING_STYLE
3335 ? Qt : make_number (state.instring)) : Qnil,
3336 Fcons (state.incomment < 0 ? Qt :
3337 (state.incomment == 0 ? Qnil :
3338 make_number (state.incomment)),
3339 Fcons (state.quoted ? Qt : Qnil,
3340 Fcons (make_number (state.mindepth),
3341 Fcons ((state.comstyle
3342 ? (state.comstyle == ST_COMMENT_STYLE
3343 ? Qsyntax_table
3344 : make_number (state.comstyle))
3345 : Qnil),
3346 Fcons (((state.incomment
3347 || (state.instring >= 0))
3348 ? make_number (state.comstr_start)
3349 : Qnil),
3350 Fcons (state.levelstarts, Qnil))))))))));
3353 void
3354 init_syntax_once (void)
3356 register int i, c;
3357 Lisp_Object temp;
3359 /* This has to be done here, before we call Fmake_char_table. */
3360 Qsyntax_table = intern_c_string ("syntax-table");
3361 staticpro (&Qsyntax_table);
3363 /* Intern_C_String this now in case it isn't already done.
3364 Setting this variable twice is harmless.
3365 But don't staticpro it here--that is done in alloc.c. */
3366 Qchar_table_extra_slots = intern_c_string ("char-table-extra-slots");
3368 /* Create objects which can be shared among syntax tables. */
3369 Vsyntax_code_object = Fmake_vector (make_number (Smax), Qnil);
3370 for (i = 0; i < XVECTOR (Vsyntax_code_object)->size; i++)
3371 XVECTOR (Vsyntax_code_object)->contents[i]
3372 = Fcons (make_number (i), Qnil);
3374 /* Now we are ready to set up this property, so we can
3375 create syntax tables. */
3376 Fput (Qsyntax_table, Qchar_table_extra_slots, make_number (0));
3378 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Swhitespace];
3380 Vstandard_syntax_table = Fmake_char_table (Qsyntax_table, temp);
3382 /* Control characters should not be whitespace. */
3383 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Spunct];
3384 for (i = 0; i <= ' ' - 1; i++)
3385 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, i, temp);
3386 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, 0177, temp);
3388 /* Except that a few really are whitespace. */
3389 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Swhitespace];
3390 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, ' ', temp);
3391 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '\t', temp);
3392 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '\n', temp);
3393 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, 015, temp);
3394 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, 014, temp);
3396 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Sword];
3397 for (i = 'a'; i <= 'z'; i++)
3398 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, i, temp);
3399 for (i = 'A'; i <= 'Z'; i++)
3400 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, i, temp);
3401 for (i = '0'; i <= '9'; i++)
3402 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, i, temp);
3404 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '$', temp);
3405 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '%', temp);
3407 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '(',
3408 Fcons (make_number (Sopen), make_number (')')));
3409 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, ')',
3410 Fcons (make_number (Sclose), make_number ('(')));
3411 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '[',
3412 Fcons (make_number (Sopen), make_number (']')));
3413 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, ']',
3414 Fcons (make_number (Sclose), make_number ('[')));
3415 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '{',
3416 Fcons (make_number (Sopen), make_number ('}')));
3417 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '}',
3418 Fcons (make_number (Sclose), make_number ('{')));
3419 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '"',
3420 Fcons (make_number ((int) Sstring), Qnil));
3421 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '\\',
3422 Fcons (make_number ((int) Sescape), Qnil));
3424 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Ssymbol];
3425 for (i = 0; i < 10; i++)
3427 c = "_-+*/&|<>="[i];
3428 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, c, temp);
3431 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Spunct];
3432 for (i = 0; i < 12; i++)
3434 c = ".,;:?!#@~^'`"[i];
3435 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, c, temp);
3438 /* All multibyte characters have syntax `word' by default. */
3439 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Sword];
3440 char_table_set_range (Vstandard_syntax_table, 0x80, MAX_CHAR, temp);
3443 void
3444 syms_of_syntax (void)
3446 Qsyntax_table_p = intern_c_string ("syntax-table-p");
3447 staticpro (&Qsyntax_table_p);
3449 staticpro (&Vsyntax_code_object);
3451 staticpro (&gl_state.object);
3452 staticpro (&gl_state.global_code);
3453 staticpro (&gl_state.current_syntax_table);
3454 staticpro (&gl_state.old_prop);
3456 /* Defined in regex.c */
3457 staticpro (&re_match_object);
3459 Qscan_error = intern_c_string ("scan-error");
3460 staticpro (&Qscan_error);
3461 Fput (Qscan_error, Qerror_conditions,
3462 pure_cons (Qscan_error, pure_cons (Qerror, Qnil)));
3463 Fput (Qscan_error, Qerror_message,
3464 make_pure_c_string ("Scan error"));
3466 DEFVAR_BOOL ("parse-sexp-ignore-comments", parse_sexp_ignore_comments,
3467 doc: /* Non-nil means `forward-sexp', etc., should treat comments as whitespace. */);
3469 DEFVAR_BOOL ("parse-sexp-lookup-properties", parse_sexp_lookup_properties,
3470 doc: /* Non-nil means `forward-sexp', etc., obey `syntax-table' property.
3471 Otherwise, that text property is simply ignored.
3472 See the info node `(elisp)Syntax Properties' for a description of the
3473 `syntax-table' property. */);
3475 words_include_escapes = 0;
3476 DEFVAR_BOOL ("words-include-escapes", words_include_escapes,
3477 doc: /* Non-nil means `forward-word', etc., should treat escape chars part of words. */);
3479 DEFVAR_BOOL ("multibyte-syntax-as-symbol", multibyte_syntax_as_symbol,
3480 doc: /* Non-nil means `scan-sexps' treats all multibyte characters as symbol. */);
3481 multibyte_syntax_as_symbol = 0;
3483 DEFVAR_BOOL ("open-paren-in-column-0-is-defun-start",
3484 open_paren_in_column_0_is_defun_start,
3485 doc: /* *Non-nil means an open paren in column 0 denotes the start of a defun. */);
3486 open_paren_in_column_0_is_defun_start = 1;
3489 DEFVAR_LISP ("find-word-boundary-function-table",
3490 Vfind_word_boundary_function_table,
3491 doc: /*
3492 Char table of functions to search for the word boundary.
3493 Each function is called with two arguments; POS and LIMIT.
3494 POS and LIMIT are character positions in the current buffer.
3496 If POS is less than LIMIT, POS is at the first character of a word,
3497 and the return value of a function is a position after the last
3498 character of that word.
3500 If POS is not less than LIMIT, POS is at the last character of a word,
3501 and the return value of a function is a position at the first
3502 character of that word.
3504 In both cases, LIMIT bounds the search. */);
3505 Vfind_word_boundary_function_table = Fmake_char_table (Qnil, Qnil);
3507 defsubr (&Ssyntax_table_p);
3508 defsubr (&Ssyntax_table);
3509 defsubr (&Sstandard_syntax_table);
3510 defsubr (&Scopy_syntax_table);
3511 defsubr (&Sset_syntax_table);
3512 defsubr (&Schar_syntax);
3513 defsubr (&Smatching_paren);
3514 defsubr (&Sstring_to_syntax);
3515 defsubr (&Smodify_syntax_entry);
3516 defsubr (&Sinternal_describe_syntax_value);
3518 defsubr (&Sforward_word);
3520 defsubr (&Sskip_chars_forward);
3521 defsubr (&Sskip_chars_backward);
3522 defsubr (&Sskip_syntax_forward);
3523 defsubr (&Sskip_syntax_backward);
3525 defsubr (&Sforward_comment);
3526 defsubr (&Sscan_lists);
3527 defsubr (&Sscan_sexps);
3528 defsubr (&Sbackward_prefix_chars);
3529 defsubr (&Sparse_partial_sexp);