(mh-restore-desktop-buffer): Move from desktop.el. Add Parameters.
[emacs.git] / src / syntax.c
blob72f7a5c5209db2cac3a383ee817158146ec539bd
1 /* GNU Emacs routines to deal with syntax tables; also word and list parsing.
2 Copyright (C) 1985, 87, 93, 94, 95, 97, 1998, 1999, 2004 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
22 #include <config.h>
23 #include <ctype.h>
24 #include "lisp.h"
25 #include "commands.h"
26 #include "buffer.h"
27 #include "charset.h"
28 #include "keymap.h"
30 /* Make syntax table lookup grant data in gl_state. */
31 #define SYNTAX_ENTRY_VIA_PROPERTY
33 #include "syntax.h"
34 #include "intervals.h"
36 /* We use these constants in place for comment-style and
37 string-ender-char to distinguish comments/strings started by
38 comment_fence and string_fence codes. */
40 #define ST_COMMENT_STYLE (256 + 1)
41 #define ST_STRING_STYLE (256 + 2)
42 #include "category.h"
44 Lisp_Object Qsyntax_table_p, Qsyntax_table, Qscan_error;
46 int words_include_escapes;
47 int parse_sexp_lookup_properties;
49 /* Nonzero means `scan-sexps' treat all multibyte characters as symbol. */
50 int multibyte_syntax_as_symbol;
52 /* Used as a temporary in SYNTAX_ENTRY and other macros in syntax.h,
53 if not compiled with GCC. No need to mark it, since it is used
54 only very temporarily. */
55 Lisp_Object syntax_temp;
57 /* Non-zero means an open parenthesis in column 0 is always considered
58 to be the start of a defun. Zero means an open parenthesis in
59 column 0 has no special meaning. */
61 int open_paren_in_column_0_is_defun_start;
63 /* This is the internal form of the parse state used in parse-partial-sexp. */
65 struct lisp_parse_state
67 int depth; /* Depth at end of parsing. */
68 int instring; /* -1 if not within string, else desired terminator. */
69 int incomment; /* -1 if in unnestable comment else comment nesting */
70 int comstyle; /* comment style a=0, or b=1, or ST_COMMENT_STYLE. */
71 int quoted; /* Nonzero if just after an escape char at end of parsing */
72 int thislevelstart; /* Char number of most recent start-of-expression at current level */
73 int prevlevelstart; /* Char number of start of containing expression */
74 int location; /* Char number at which parsing stopped. */
75 int mindepth; /* Minimum depth seen while scanning. */
76 int comstr_start; /* Position just after last comment/string starter. */
77 Lisp_Object levelstarts; /* Char numbers of starts-of-expression
78 of levels (starting from outermost). */
81 /* These variables are a cache for finding the start of a defun.
82 find_start_pos is the place for which the defun start was found.
83 find_start_value is the defun start position found for it.
84 find_start_value_byte is the corresponding byte position.
85 find_start_buffer is the buffer it was found in.
86 find_start_begv is the BEGV value when it was found.
87 find_start_modiff is the value of MODIFF when it was found. */
89 static int find_start_pos;
90 static int find_start_value;
91 static int find_start_value_byte;
92 static struct buffer *find_start_buffer;
93 static int find_start_begv;
94 static int find_start_modiff;
97 static int find_defun_start P_ ((int, int));
98 static int back_comment P_ ((int, int, int, int, int, int *, int *));
99 static int char_quoted P_ ((int, int));
100 static Lisp_Object skip_chars P_ ((int, int, Lisp_Object, Lisp_Object));
101 static Lisp_Object scan_lists P_ ((int, int, int, int));
102 static void scan_sexps_forward P_ ((struct lisp_parse_state *,
103 int, int, int, int,
104 int, Lisp_Object, int));
107 struct gl_state_s gl_state; /* Global state of syntax parser. */
109 INTERVAL interval_of ();
110 #define INTERVALS_AT_ONCE 10 /* 1 + max-number of intervals
111 to scan to property-change. */
113 /* Update gl_state to an appropriate interval which contains CHARPOS. The
114 sign of COUNT give the relative position of CHARPOS wrt the previously
115 valid interval. If INIT, only [be]_property fields of gl_state are
116 valid at start, the rest is filled basing on OBJECT.
118 `gl_state.*_i' are the intervals, and CHARPOS is further in the search
119 direction than the intervals - or in an interval. We update the
120 current syntax-table basing on the property of this interval, and
121 update the interval to start further than CHARPOS - or be
122 NULL_INTERVAL. We also update lim_property to be the next value of
123 charpos to call this subroutine again - or be before/after the
124 start/end of OBJECT. */
126 void
127 update_syntax_table (charpos, count, init, object)
128 int charpos, count, init;
129 Lisp_Object object;
131 Lisp_Object tmp_table;
132 int cnt = 0, invalidate = 1;
133 INTERVAL i, oldi;
135 if (init)
137 gl_state.old_prop = Qnil;
138 gl_state.start = gl_state.b_property;
139 gl_state.stop = gl_state.e_property;
140 i = interval_of (charpos, object);
141 gl_state.backward_i = gl_state.forward_i = i;
142 invalidate = 0;
143 if (NULL_INTERVAL_P (i))
144 return;
145 /* interval_of updates only ->position of the return value, so
146 update the parents manually to speed up update_interval. */
147 while (!NULL_PARENT (i))
149 if (AM_RIGHT_CHILD (i))
150 INTERVAL_PARENT (i)->position = i->position
151 - LEFT_TOTAL_LENGTH (i) + TOTAL_LENGTH (i) /* right end */
152 - TOTAL_LENGTH (INTERVAL_PARENT (i))
153 + LEFT_TOTAL_LENGTH (INTERVAL_PARENT (i));
154 else
155 INTERVAL_PARENT (i)->position = i->position - LEFT_TOTAL_LENGTH (i)
156 + TOTAL_LENGTH (i);
157 i = INTERVAL_PARENT (i);
159 i = gl_state.forward_i;
160 gl_state.b_property = i->position - gl_state.offset;
161 gl_state.e_property = INTERVAL_LAST_POS (i) - gl_state.offset;
162 goto update;
164 oldi = i = count > 0 ? gl_state.forward_i : gl_state.backward_i;
166 /* We are guaranteed to be called with CHARPOS either in i,
167 or further off. */
168 if (NULL_INTERVAL_P (i))
169 error ("Error in syntax_table logic for to-the-end intervals");
170 else if (charpos < i->position) /* Move left. */
172 if (count > 0)
173 error ("Error in syntax_table logic for intervals <-");
174 /* Update the interval. */
175 i = update_interval (i, charpos);
176 if (INTERVAL_LAST_POS (i) != gl_state.b_property)
178 invalidate = 0;
179 gl_state.forward_i = i;
180 gl_state.e_property = INTERVAL_LAST_POS (i) - gl_state.offset;
183 else if (charpos >= INTERVAL_LAST_POS (i)) /* Move right. */
185 if (count < 0)
186 error ("Error in syntax_table logic for intervals ->");
187 /* Update the interval. */
188 i = update_interval (i, charpos);
189 if (i->position != gl_state.e_property)
191 invalidate = 0;
192 gl_state.backward_i = i;
193 gl_state.b_property = i->position - gl_state.offset;
197 update:
198 tmp_table = textget (i->plist, Qsyntax_table);
200 if (invalidate)
201 invalidate = !EQ (tmp_table, gl_state.old_prop); /* Need to invalidate? */
203 if (invalidate) /* Did not get to adjacent interval. */
204 { /* with the same table => */
205 /* invalidate the old range. */
206 if (count > 0)
208 gl_state.backward_i = i;
209 gl_state.b_property = i->position - gl_state.offset;
211 else
213 gl_state.forward_i = i;
214 gl_state.e_property = INTERVAL_LAST_POS (i) - gl_state.offset;
218 if (!EQ (tmp_table, gl_state.old_prop))
220 gl_state.current_syntax_table = tmp_table;
221 gl_state.old_prop = tmp_table;
222 if (EQ (Fsyntax_table_p (tmp_table), Qt))
224 gl_state.use_global = 0;
226 else if (CONSP (tmp_table))
228 gl_state.use_global = 1;
229 gl_state.global_code = tmp_table;
231 else
233 gl_state.use_global = 0;
234 gl_state.current_syntax_table = current_buffer->syntax_table;
238 while (!NULL_INTERVAL_P (i))
240 if (cnt && !EQ (tmp_table, textget (i->plist, Qsyntax_table)))
242 if (count > 0)
244 gl_state.e_property = i->position - gl_state.offset;
245 gl_state.forward_i = i;
247 else
249 gl_state.b_property = i->position + LENGTH (i) - gl_state.offset;
250 gl_state.backward_i = i;
252 return;
254 else if (cnt == INTERVALS_AT_ONCE)
256 if (count > 0)
258 gl_state.e_property = i->position + LENGTH (i) - gl_state.offset;
259 gl_state.forward_i = i;
261 else
263 gl_state.b_property = i->position - gl_state.offset;
264 gl_state.backward_i = i;
266 return;
268 cnt++;
269 i = count > 0 ? next_interval (i) : previous_interval (i);
271 eassert (NULL_INTERVAL_P (i)); /* This property goes to the end. */
272 if (count > 0)
273 gl_state.e_property = gl_state.stop;
274 else
275 gl_state.b_property = gl_state.start;
278 /* Returns TRUE if char at CHARPOS is quoted.
279 Global syntax-table data should be set up already to be good at CHARPOS
280 or after. On return global syntax data is good for lookup at CHARPOS. */
282 static int
283 char_quoted (charpos, bytepos)
284 register int charpos, bytepos;
286 register enum syntaxcode code;
287 register int beg = BEGV;
288 register int quoted = 0;
289 int orig = charpos;
291 DEC_BOTH (charpos, bytepos);
293 while (bytepos >= beg)
295 UPDATE_SYNTAX_TABLE_BACKWARD (charpos);
296 code = SYNTAX (FETCH_CHAR (bytepos));
297 if (! (code == Scharquote || code == Sescape))
298 break;
300 DEC_BOTH (charpos, bytepos);
301 quoted = !quoted;
304 UPDATE_SYNTAX_TABLE (orig);
305 return quoted;
308 /* Return the bytepos one character after BYTEPOS.
309 We assume that BYTEPOS is not at the end of the buffer. */
311 INLINE int
312 inc_bytepos (bytepos)
313 int bytepos;
315 if (NILP (current_buffer->enable_multibyte_characters))
316 return bytepos + 1;
318 INC_POS (bytepos);
319 return bytepos;
322 /* Return the bytepos one character before BYTEPOS.
323 We assume that BYTEPOS is not at the start of the buffer. */
325 INLINE int
326 dec_bytepos (bytepos)
327 int bytepos;
329 if (NILP (current_buffer->enable_multibyte_characters))
330 return bytepos - 1;
332 DEC_POS (bytepos);
333 return bytepos;
336 /* Return a defun-start position before before POS and not too far before.
337 It should be the last one before POS, or nearly the last.
339 When open_paren_in_column_0_is_defun_start is nonzero,
340 only the beginning of the buffer is treated as a defun-start.
342 We record the information about where the scan started
343 and what its result was, so that another call in the same area
344 can return the same value very quickly.
346 There is no promise at which position the global syntax data is
347 valid on return from the subroutine, so the caller should explicitly
348 update the global data. */
350 static int
351 find_defun_start (pos, pos_byte)
352 int pos, pos_byte;
354 int opoint = PT, opoint_byte = PT_BYTE;
356 if (!open_paren_in_column_0_is_defun_start)
358 find_start_value_byte = BEGV_BYTE;
359 return BEGV;
362 /* Use previous finding, if it's valid and applies to this inquiry. */
363 if (current_buffer == find_start_buffer
364 /* Reuse the defun-start even if POS is a little farther on.
365 POS might be in the next defun, but that's ok.
366 Our value may not be the best possible, but will still be usable. */
367 && pos <= find_start_pos + 1000
368 && pos >= find_start_value
369 && BEGV == find_start_begv
370 && MODIFF == find_start_modiff)
371 return find_start_value;
373 /* Back up to start of line. */
374 scan_newline (pos, pos_byte, BEGV, BEGV_BYTE, -1, 1);
376 /* We optimize syntax-table lookup for rare updates. Thus we accept
377 only those `^\s(' which are good in global _and_ text-property
378 syntax-tables. */
379 gl_state.current_syntax_table = current_buffer->syntax_table;
380 gl_state.use_global = 0;
381 while (PT > BEGV)
383 /* Open-paren at start of line means we may have found our
384 defun-start. */
385 if (SYNTAX (FETCH_CHAR (PT_BYTE)) == Sopen)
387 SETUP_SYNTAX_TABLE (PT + 1, -1); /* Try again... */
388 if (SYNTAX (FETCH_CHAR (PT_BYTE)) == Sopen)
389 break;
390 /* Now fallback to the default value. */
391 gl_state.current_syntax_table = current_buffer->syntax_table;
392 gl_state.use_global = 0;
394 /* Move to beg of previous line. */
395 scan_newline (PT, PT_BYTE, BEGV, BEGV_BYTE, -2, 1);
398 /* Record what we found, for the next try. */
399 find_start_value = PT;
400 find_start_value_byte = PT_BYTE;
401 find_start_buffer = current_buffer;
402 find_start_modiff = MODIFF;
403 find_start_begv = BEGV;
404 find_start_pos = pos;
406 TEMP_SET_PT_BOTH (opoint, opoint_byte);
408 return find_start_value;
411 /* Return the SYNTAX_COMEND_FIRST of the character before POS, POS_BYTE. */
413 static int
414 prev_char_comend_first (pos, pos_byte)
415 int pos, pos_byte;
417 int c, val;
419 DEC_BOTH (pos, pos_byte);
420 UPDATE_SYNTAX_TABLE_BACKWARD (pos);
421 c = FETCH_CHAR (pos_byte);
422 val = SYNTAX_COMEND_FIRST (c);
423 UPDATE_SYNTAX_TABLE_FORWARD (pos + 1);
424 return val;
427 /* Return the SYNTAX_COMSTART_FIRST of the character before POS, POS_BYTE. */
429 /* static int
430 * prev_char_comstart_first (pos, pos_byte)
431 * int pos, pos_byte;
433 * int c, val;
435 * DEC_BOTH (pos, pos_byte);
436 * UPDATE_SYNTAX_TABLE_BACKWARD (pos);
437 * c = FETCH_CHAR (pos_byte);
438 * val = SYNTAX_COMSTART_FIRST (c);
439 * UPDATE_SYNTAX_TABLE_FORWARD (pos + 1);
440 * return val;
441 * } */
443 /* Checks whether charpos FROM is at the end of a comment.
444 FROM_BYTE is the bytepos corresponding to FROM.
445 Do not move back before STOP.
447 Return a positive value if we find a comment ending at FROM/FROM_BYTE;
448 return -1 otherwise.
450 If successful, store the charpos of the comment's beginning
451 into *CHARPOS_PTR, and the bytepos into *BYTEPOS_PTR.
453 Global syntax data remains valid for backward search starting at
454 the returned value (or at FROM, if the search was not successful). */
456 static int
457 back_comment (from, from_byte, stop, comnested, comstyle, charpos_ptr, bytepos_ptr)
458 int from, from_byte, stop;
459 int comnested, comstyle;
460 int *charpos_ptr, *bytepos_ptr;
462 /* Look back, counting the parity of string-quotes,
463 and recording the comment-starters seen.
464 When we reach a safe place, assume that's not in a string;
465 then step the main scan to the earliest comment-starter seen
466 an even number of string quotes away from the safe place.
468 OFROM[I] is position of the earliest comment-starter seen
469 which is I+2X quotes from the comment-end.
470 PARITY is current parity of quotes from the comment end. */
471 int string_style = -1; /* Presumed outside of any string. */
472 int string_lossage = 0;
473 /* Not a real lossage: indicates that we have passed a matching comment
474 starter plus a non-matching comment-ender, meaning that any matching
475 comment-starter we might see later could be a false positive (hidden
476 inside another comment).
477 Test case: { a (* b } c (* d *) */
478 int comment_lossage = 0;
479 int comment_end = from;
480 int comment_end_byte = from_byte;
481 int comstart_pos = 0;
482 int comstart_byte;
483 /* Place where the containing defun starts,
484 or 0 if we didn't come across it yet. */
485 int defun_start = 0;
486 int defun_start_byte = 0;
487 register enum syntaxcode code;
488 int nesting = 1; /* current comment nesting */
489 int c;
490 int syntax = 0;
492 /* FIXME: A }} comment-ender style leads to incorrect behavior
493 in the case of {{ c }}} because we ignore the last two chars which are
494 assumed to be comment-enders although they aren't. */
496 /* At beginning of range to scan, we're outside of strings;
497 that determines quote parity to the comment-end. */
498 while (from != stop)
500 int temp_byte, prev_syntax;
501 int com2start, com2end;
503 /* Move back and examine a character. */
504 DEC_BOTH (from, from_byte);
505 UPDATE_SYNTAX_TABLE_BACKWARD (from);
507 prev_syntax = syntax;
508 c = FETCH_CHAR (from_byte);
509 syntax = SYNTAX_WITH_FLAGS (c);
510 code = SYNTAX (c);
512 /* Check for 2-char comment markers. */
513 com2start = (SYNTAX_FLAGS_COMSTART_FIRST (syntax)
514 && SYNTAX_FLAGS_COMSTART_SECOND (prev_syntax)
515 && comstyle == SYNTAX_FLAGS_COMMENT_STYLE (prev_syntax)
516 && (SYNTAX_FLAGS_COMMENT_NESTED (prev_syntax)
517 || SYNTAX_FLAGS_COMMENT_NESTED (syntax)) == comnested);
518 com2end = (SYNTAX_FLAGS_COMEND_FIRST (syntax)
519 && SYNTAX_FLAGS_COMEND_SECOND (prev_syntax));
521 /* Nasty cases with overlapping 2-char comment markers:
522 - snmp-mode: -- c -- foo -- c --
523 --- c --
524 ------ c --
525 - c-mode: *||*
526 |* *|* *|
527 |*| |* |*|
528 /// */
530 /* If a 2-char comment sequence partly overlaps with another,
531 we don't try to be clever. */
532 if (from > stop && (com2end || com2start))
534 int next = from, next_byte = from_byte, next_c, next_syntax;
535 DEC_BOTH (next, next_byte);
536 UPDATE_SYNTAX_TABLE_BACKWARD (next);
537 next_c = FETCH_CHAR (next_byte);
538 next_syntax = SYNTAX_WITH_FLAGS (next_c);
539 if (((com2start || comnested)
540 && SYNTAX_FLAGS_COMEND_SECOND (syntax)
541 && SYNTAX_FLAGS_COMEND_FIRST (next_syntax))
542 || ((com2end || comnested)
543 && SYNTAX_FLAGS_COMSTART_SECOND (syntax)
544 && comstyle == SYNTAX_FLAGS_COMMENT_STYLE (syntax)
545 && SYNTAX_FLAGS_COMSTART_FIRST (next_syntax)))
546 goto lossage;
547 /* UPDATE_SYNTAX_TABLE_FORWARD (next + 1); */
550 if (com2start && comstart_pos == 0)
551 /* We're looking at a comment starter. But it might be a comment
552 ender as well (see snmp-mode). The first time we see one, we
553 need to consider it as a comment starter,
554 and the subsequent times as a comment ender. */
555 com2end = 0;
557 /* Turn a 2-char comment sequences into the appropriate syntax. */
558 if (com2end)
559 code = Sendcomment;
560 else if (com2start)
561 code = Scomment;
562 /* Ignore comment starters of a different style. */
563 else if (code == Scomment
564 && (comstyle != SYNTAX_FLAGS_COMMENT_STYLE (syntax)
565 || SYNTAX_FLAGS_COMMENT_NESTED (syntax) != comnested))
566 continue;
568 /* Ignore escaped characters, except comment-enders. */
569 if (code != Sendcomment && char_quoted (from, from_byte))
570 continue;
572 switch (code)
574 case Sstring_fence:
575 case Scomment_fence:
576 c = (code == Sstring_fence ? ST_STRING_STYLE : ST_COMMENT_STYLE);
577 case Sstring:
578 /* Track parity of quotes. */
579 if (string_style == -1)
580 /* Entering a string. */
581 string_style = c;
582 else if (string_style == c)
583 /* Leaving the string. */
584 string_style = -1;
585 else
586 /* If we have two kinds of string delimiters.
587 There's no way to grok this scanning backwards. */
588 string_lossage = 1;
589 break;
591 case Scomment:
592 /* We've already checked that it is the relevant comstyle. */
593 if (string_style != -1 || comment_lossage || string_lossage)
594 /* There are odd string quotes involved, so let's be careful.
595 Test case in Pascal: " { " a { " } */
596 goto lossage;
598 if (!comnested)
600 /* Record best comment-starter so far. */
601 comstart_pos = from;
602 comstart_byte = from_byte;
604 else if (--nesting <= 0)
605 /* nested comments have to be balanced, so we don't need to
606 keep looking for earlier ones. We use here the same (slightly
607 incorrect) reasoning as below: since it is followed by uniform
608 paired string quotes, this comment-start has to be outside of
609 strings, else the comment-end itself would be inside a string. */
610 goto done;
611 break;
613 case Sendcomment:
614 if (SYNTAX_FLAGS_COMMENT_STYLE (syntax) == comstyle
615 && ((com2end && SYNTAX_FLAGS_COMMENT_NESTED (prev_syntax))
616 || SYNTAX_FLAGS_COMMENT_NESTED (syntax)) == comnested)
617 /* This is the same style of comment ender as ours. */
619 if (comnested)
620 nesting++;
621 else
622 /* Anything before that can't count because it would match
623 this comment-ender rather than ours. */
624 from = stop; /* Break out of the loop. */
626 else if (comstart_pos != 0 || c != '\n')
627 /* We're mixing comment styles here, so we'd better be careful.
628 The (comstart_pos != 0 || c != '\n') check is not quite correct
629 (we should just always set comment_lossage), but removing it
630 would imply that any multiline comment in C would go through
631 lossage, which seems overkill.
632 The failure should only happen in the rare cases such as
633 { (* } *) */
634 comment_lossage = 1;
635 break;
637 case Sopen:
638 /* Assume a defun-start point is outside of strings. */
639 if (open_paren_in_column_0_is_defun_start
640 && (from == stop
641 || (temp_byte = dec_bytepos (from_byte),
642 FETCH_CHAR (temp_byte) == '\n')))
644 defun_start = from;
645 defun_start_byte = from_byte;
646 from = stop; /* Break out of the loop. */
648 break;
650 default:
651 break;
655 if (comstart_pos == 0)
657 from = comment_end;
658 from_byte = comment_end_byte;
659 UPDATE_SYNTAX_TABLE_FORWARD (comment_end - 1);
661 /* If comstart_pos is set and we get here (ie. didn't jump to `lossage'
662 or `done'), then we've found the beginning of the non-nested comment. */
663 else if (1) /* !comnested */
665 from = comstart_pos;
666 from_byte = comstart_byte;
667 /* Globals are correct now. */
669 else
671 struct lisp_parse_state state;
672 lossage:
673 /* We had two kinds of string delimiters mixed up
674 together. Decode this going forwards.
675 Scan fwd from a known safe place (beginning-of-defun)
676 to the one in question; this records where we
677 last passed a comment starter. */
678 /* If we did not already find the defun start, find it now. */
679 if (defun_start == 0)
681 defun_start = find_defun_start (comment_end, comment_end_byte);
682 defun_start_byte = find_start_value_byte;
686 scan_sexps_forward (&state,
687 defun_start, defun_start_byte,
688 comment_end, -10000, 0, Qnil, 0);
689 defun_start = comment_end;
690 if (state.incomment == (comnested ? 1 : -1)
691 && state.comstyle == comstyle)
692 from = state.comstr_start;
693 else
695 from = comment_end;
696 if (state.incomment)
697 /* If comment_end is inside some other comment, maybe ours
698 is nested, so we need to try again from within the
699 surrounding comment. Example: { a (* " *) */
701 /* FIXME: We should advance by one or two chars. */
702 defun_start = state.comstr_start + 2;
703 defun_start_byte = CHAR_TO_BYTE (defun_start);
706 } while (defun_start < comment_end);
708 from_byte = CHAR_TO_BYTE (from);
709 UPDATE_SYNTAX_TABLE_FORWARD (from - 1);
712 done:
713 *charpos_ptr = from;
714 *bytepos_ptr = from_byte;
716 return (from == comment_end) ? -1 : from;
719 DEFUN ("syntax-table-p", Fsyntax_table_p, Ssyntax_table_p, 1, 1, 0,
720 doc: /* Return t if OBJECT is a syntax table.
721 Currently, any char-table counts as a syntax table. */)
722 (object)
723 Lisp_Object object;
725 if (CHAR_TABLE_P (object)
726 && EQ (XCHAR_TABLE (object)->purpose, Qsyntax_table))
727 return Qt;
728 return Qnil;
731 static void
732 check_syntax_table (obj)
733 Lisp_Object obj;
735 if (!(CHAR_TABLE_P (obj)
736 && EQ (XCHAR_TABLE (obj)->purpose, Qsyntax_table)))
737 wrong_type_argument (Qsyntax_table_p, obj);
740 DEFUN ("syntax-table", Fsyntax_table, Ssyntax_table, 0, 0, 0,
741 doc: /* Return the current syntax table.
742 This is the one specified by the current buffer. */)
745 return current_buffer->syntax_table;
748 DEFUN ("standard-syntax-table", Fstandard_syntax_table,
749 Sstandard_syntax_table, 0, 0, 0,
750 doc: /* Return the standard syntax table.
751 This is the one used for new buffers. */)
754 return Vstandard_syntax_table;
757 DEFUN ("copy-syntax-table", Fcopy_syntax_table, Scopy_syntax_table, 0, 1, 0,
758 doc: /* Construct a new syntax table and return it.
759 It is a copy of the TABLE, which defaults to the standard syntax table. */)
760 (table)
761 Lisp_Object table;
763 Lisp_Object copy;
765 if (!NILP (table))
766 check_syntax_table (table);
767 else
768 table = Vstandard_syntax_table;
770 copy = Fcopy_sequence (table);
772 /* Only the standard syntax table should have a default element.
773 Other syntax tables should inherit from parents instead. */
774 XCHAR_TABLE (copy)->defalt = Qnil;
776 /* Copied syntax tables should all have parents.
777 If we copied one with no parent, such as the standard syntax table,
778 use the standard syntax table as the copy's parent. */
779 if (NILP (XCHAR_TABLE (copy)->parent))
780 Fset_char_table_parent (copy, Vstandard_syntax_table);
781 return copy;
784 DEFUN ("set-syntax-table", Fset_syntax_table, Sset_syntax_table, 1, 1, 0,
785 doc: /* Select a new syntax table for the current buffer.
786 One argument, a syntax table. */)
787 (table)
788 Lisp_Object table;
790 int idx;
791 check_syntax_table (table);
792 current_buffer->syntax_table = table;
793 /* Indicate that this buffer now has a specified syntax table. */
794 idx = PER_BUFFER_VAR_IDX (syntax_table);
795 SET_PER_BUFFER_VALUE_P (current_buffer, idx, 1);
796 return table;
799 /* Convert a letter which signifies a syntax code
800 into the code it signifies.
801 This is used by modify-syntax-entry, and other things. */
803 unsigned char syntax_spec_code[0400] =
804 { 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
805 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
806 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
807 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
808 (char) Swhitespace, (char) Scomment_fence, (char) Sstring, 0377,
809 (char) Smath, 0377, 0377, (char) Squote,
810 (char) Sopen, (char) Sclose, 0377, 0377,
811 0377, (char) Swhitespace, (char) Spunct, (char) Scharquote,
812 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
813 0377, 0377, 0377, 0377,
814 (char) Scomment, 0377, (char) Sendcomment, 0377,
815 (char) Sinherit, 0377, 0377, 0377, 0377, 0377, 0377, 0377, /* @, A ... */
816 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
817 0377, 0377, 0377, 0377, 0377, 0377, 0377, (char) Sword,
818 0377, 0377, 0377, 0377, (char) Sescape, 0377, 0377, (char) Ssymbol,
819 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377, /* `, a, ... */
820 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
821 0377, 0377, 0377, 0377, 0377, 0377, 0377, (char) Sword,
822 0377, 0377, 0377, 0377, (char) Sstring_fence, 0377, 0377, 0377
825 /* Indexed by syntax code, give the letter that describes it. */
827 char syntax_code_spec[16] =
829 ' ', '.', 'w', '_', '(', ')', '\'', '\"', '$', '\\', '/', '<', '>', '@',
830 '!', '|'
833 /* Indexed by syntax code, give the object (cons of syntax code and
834 nil) to be stored in syntax table. Since these objects can be
835 shared among syntax tables, we generate them in advance. By
836 sharing objects, the function `describe-syntax' can give a more
837 compact listing. */
838 static Lisp_Object Vsyntax_code_object;
841 /* Look up the value for CHARACTER in syntax table TABLE's parent
842 and its parents. SYNTAX_ENTRY calls this, when TABLE itself has nil
843 for CHARACTER. It's actually used only when not compiled with GCC. */
845 Lisp_Object
846 syntax_parent_lookup (table, character)
847 Lisp_Object table;
848 int character;
850 Lisp_Object value;
852 while (1)
854 table = XCHAR_TABLE (table)->parent;
855 if (NILP (table))
856 return Qnil;
858 value = XCHAR_TABLE (table)->contents[character];
859 if (!NILP (value))
860 return value;
864 DEFUN ("char-syntax", Fchar_syntax, Schar_syntax, 1, 1, 0,
865 doc: /* Return the syntax code of CHARACTER, described by a character.
866 For example, if CHARACTER is a word constituent,
867 the character `w' is returned.
868 The characters that correspond to various syntax codes
869 are listed in the documentation of `modify-syntax-entry'. */)
870 (character)
871 Lisp_Object character;
873 int char_int;
874 gl_state.current_syntax_table = current_buffer->syntax_table;
876 gl_state.use_global = 0;
877 CHECK_NUMBER (character);
878 char_int = XINT (character);
879 return make_number (syntax_code_spec[(int) SYNTAX (char_int)]);
882 DEFUN ("matching-paren", Fmatching_paren, Smatching_paren, 1, 1, 0,
883 doc: /* Return the matching parenthesis of CHARACTER, or nil if none. */)
884 (character)
885 Lisp_Object character;
887 int char_int, code;
888 gl_state.current_syntax_table = current_buffer->syntax_table;
889 gl_state.use_global = 0;
890 CHECK_NUMBER (character);
891 char_int = XINT (character);
892 code = SYNTAX (char_int);
893 if (code == Sopen || code == Sclose)
894 return SYNTAX_MATCH (char_int);
895 return Qnil;
898 DEFUN ("string-to-syntax", Fstring_to_syntax, Sstring_to_syntax, 1, 1, 0,
899 doc: /* Convert a syntax specification STRING into syntax cell form.
900 STRING should be a string as it is allowed as argument of
901 `modify-syntax-entry'. Value is the equivalent cons cell
902 (CODE . MATCHING-CHAR) that can be used as value of a `syntax-table'
903 text property. */)
904 (string)
905 Lisp_Object string;
907 register const unsigned char *p;
908 register enum syntaxcode code;
909 int val;
910 Lisp_Object match;
912 CHECK_STRING (string);
914 p = SDATA (string);
915 code = (enum syntaxcode) syntax_spec_code[*p++];
916 if (((int) code & 0377) == 0377)
917 error ("invalid syntax description letter: %c", p[-1]);
919 if (code == Sinherit)
920 return Qnil;
922 if (*p)
924 int len;
925 int character = (STRING_CHAR_AND_LENGTH
926 (p, SBYTES (string) - 1, len));
927 XSETINT (match, character);
928 if (XFASTINT (match) == ' ')
929 match = Qnil;
930 p += len;
932 else
933 match = Qnil;
935 val = (int) code;
936 while (*p)
937 switch (*p++)
939 case '1':
940 val |= 1 << 16;
941 break;
943 case '2':
944 val |= 1 << 17;
945 break;
947 case '3':
948 val |= 1 << 18;
949 break;
951 case '4':
952 val |= 1 << 19;
953 break;
955 case 'p':
956 val |= 1 << 20;
957 break;
959 case 'b':
960 val |= 1 << 21;
961 break;
963 case 'n':
964 val |= 1 << 22;
965 break;
968 if (val < XVECTOR (Vsyntax_code_object)->size && NILP (match))
969 return XVECTOR (Vsyntax_code_object)->contents[val];
970 else
971 /* Since we can't use a shared object, let's make a new one. */
972 return Fcons (make_number (val), match);
975 /* I really don't know why this is interactive
976 help-form should at least be made useful whilst reading the second arg. */
977 DEFUN ("modify-syntax-entry", Fmodify_syntax_entry, Smodify_syntax_entry, 2, 3,
978 "cSet syntax for character: \nsSet syntax for %s to: ",
979 doc: /* Set syntax for character CHAR according to string NEWENTRY.
980 The syntax is changed only for table SYNTAX_TABLE, which defaults to
981 the current buffer's syntax table.
982 The first character of NEWENTRY should be one of the following:
983 Space or - whitespace syntax. w word constituent.
984 _ symbol constituent. . punctuation.
985 ( open-parenthesis. ) close-parenthesis.
986 " string quote. \\ escape.
987 $ paired delimiter. ' expression quote or prefix operator.
988 < comment starter. > comment ender.
989 / character-quote. @ inherit from `standard-syntax-table'.
990 | generic string fence. ! generic comment fence.
992 Only single-character comment start and end sequences are represented thus.
993 Two-character sequences are represented as described below.
994 The second character of NEWENTRY is the matching parenthesis,
995 used only if the first character is `(' or `)'.
996 Any additional characters are flags.
997 Defined flags are the characters 1, 2, 3, 4, b, p, and n.
998 1 means CHAR is the start of a two-char comment start sequence.
999 2 means CHAR is the second character of such a sequence.
1000 3 means CHAR is the start of a two-char comment end sequence.
1001 4 means CHAR is the second character of such a sequence.
1003 There can be up to two orthogonal comment sequences. This is to support
1004 language modes such as C++. By default, all comment sequences are of style
1005 a, but you can set the comment sequence style to b (on the second character
1006 of a comment-start, or the first character of a comment-end sequence) using
1007 this flag:
1008 b means CHAR is part of comment sequence b.
1009 n means CHAR is part of a nestable comment sequence.
1011 p means CHAR is a prefix character for `backward-prefix-chars';
1012 such characters are treated as whitespace when they occur
1013 between expressions.
1014 usage: (modify-syntax-entry CHAR NEWENTRY &optional SYNTAX-TABLE) */)
1015 (c, newentry, syntax_table)
1016 Lisp_Object c, newentry, syntax_table;
1018 CHECK_NUMBER (c);
1020 if (NILP (syntax_table))
1021 syntax_table = current_buffer->syntax_table;
1022 else
1023 check_syntax_table (syntax_table);
1025 SET_RAW_SYNTAX_ENTRY (syntax_table, XINT (c), Fstring_to_syntax (newentry));
1026 return Qnil;
1029 /* Dump syntax table to buffer in human-readable format */
1031 DEFUN ("internal-describe-syntax-value", Finternal_describe_syntax_value,
1032 Sinternal_describe_syntax_value, 1, 1, 0,
1033 doc: /* Insert a description of the internal syntax description SYNTAX at point. */)
1034 (syntax)
1035 Lisp_Object syntax;
1037 register enum syntaxcode code;
1038 char desc, start1, start2, end1, end2, prefix, comstyle, comnested;
1039 char str[2];
1040 Lisp_Object first, match_lisp, value = syntax;
1042 if (NILP (value))
1044 insert_string ("default");
1045 return syntax;
1048 if (CHAR_TABLE_P (value))
1050 insert_string ("deeper char-table ...");
1051 return syntax;
1054 if (!CONSP (value))
1056 insert_string ("invalid");
1057 return syntax;
1060 first = XCAR (value);
1061 match_lisp = XCDR (value);
1063 if (!INTEGERP (first) || !(NILP (match_lisp) || INTEGERP (match_lisp)))
1065 insert_string ("invalid");
1066 return syntax;
1069 code = (enum syntaxcode) (XINT (first) & 0377);
1070 start1 = (XINT (first) >> 16) & 1;
1071 start2 = (XINT (first) >> 17) & 1;
1072 end1 = (XINT (first) >> 18) & 1;
1073 end2 = (XINT (first) >> 19) & 1;
1074 prefix = (XINT (first) >> 20) & 1;
1075 comstyle = (XINT (first) >> 21) & 1;
1076 comnested = (XINT (first) >> 22) & 1;
1078 if ((int) code < 0 || (int) code >= (int) Smax)
1080 insert_string ("invalid");
1081 return syntax;
1083 desc = syntax_code_spec[(int) code];
1085 str[0] = desc, str[1] = 0;
1086 insert (str, 1);
1088 if (NILP (match_lisp))
1089 insert (" ", 1);
1090 else
1091 insert_char (XINT (match_lisp));
1093 if (start1)
1094 insert ("1", 1);
1095 if (start2)
1096 insert ("2", 1);
1098 if (end1)
1099 insert ("3", 1);
1100 if (end2)
1101 insert ("4", 1);
1103 if (prefix)
1104 insert ("p", 1);
1105 if (comstyle)
1106 insert ("b", 1);
1107 if (comnested)
1108 insert ("n", 1);
1110 insert_string ("\twhich means: ");
1112 switch (SWITCH_ENUM_CAST (code))
1114 case Swhitespace:
1115 insert_string ("whitespace"); break;
1116 case Spunct:
1117 insert_string ("punctuation"); break;
1118 case Sword:
1119 insert_string ("word"); break;
1120 case Ssymbol:
1121 insert_string ("symbol"); break;
1122 case Sopen:
1123 insert_string ("open"); break;
1124 case Sclose:
1125 insert_string ("close"); break;
1126 case Squote:
1127 insert_string ("prefix"); break;
1128 case Sstring:
1129 insert_string ("string"); break;
1130 case Smath:
1131 insert_string ("math"); break;
1132 case Sescape:
1133 insert_string ("escape"); break;
1134 case Scharquote:
1135 insert_string ("charquote"); break;
1136 case Scomment:
1137 insert_string ("comment"); break;
1138 case Sendcomment:
1139 insert_string ("endcomment"); break;
1140 case Sinherit:
1141 insert_string ("inherit"); break;
1142 case Scomment_fence:
1143 insert_string ("comment fence"); break;
1144 case Sstring_fence:
1145 insert_string ("string fence"); break;
1146 default:
1147 insert_string ("invalid");
1148 return syntax;
1151 if (!NILP (match_lisp))
1153 insert_string (", matches ");
1154 insert_char (XINT (match_lisp));
1157 if (start1)
1158 insert_string (",\n\t is the first character of a comment-start sequence");
1159 if (start2)
1160 insert_string (",\n\t is the second character of a comment-start sequence");
1162 if (end1)
1163 insert_string (",\n\t is the first character of a comment-end sequence");
1164 if (end2)
1165 insert_string (",\n\t is the second character of a comment-end sequence");
1166 if (comstyle)
1167 insert_string (" (comment style b)");
1168 if (comnested)
1169 insert_string (" (nestable)");
1171 if (prefix)
1172 insert_string (",\n\t is a prefix character for `backward-prefix-chars'");
1174 return syntax;
1177 int parse_sexp_ignore_comments;
1179 /* Return the position across COUNT words from FROM.
1180 If that many words cannot be found before the end of the buffer, return 0.
1181 COUNT negative means scan backward and stop at word beginning. */
1184 scan_words (from, count)
1185 register int from, count;
1187 register int beg = BEGV;
1188 register int end = ZV;
1189 register int from_byte = CHAR_TO_BYTE (from);
1190 register enum syntaxcode code;
1191 int ch0, ch1;
1193 immediate_quit = 1;
1194 QUIT;
1196 SETUP_SYNTAX_TABLE (from, count);
1198 while (count > 0)
1200 while (1)
1202 if (from == end)
1204 immediate_quit = 0;
1205 return 0;
1207 UPDATE_SYNTAX_TABLE_FORWARD (from);
1208 ch0 = FETCH_CHAR (from_byte);
1209 code = SYNTAX (ch0);
1210 INC_BOTH (from, from_byte);
1211 if (words_include_escapes
1212 && (code == Sescape || code == Scharquote))
1213 break;
1214 if (code == Sword)
1215 break;
1217 /* Now CH0 is a character which begins a word and FROM is the
1218 position of the next character. */
1219 while (1)
1221 if (from == end) break;
1222 UPDATE_SYNTAX_TABLE_FORWARD (from);
1223 ch1 = FETCH_CHAR (from_byte);
1224 code = SYNTAX (ch1);
1225 if (!(words_include_escapes
1226 && (code == Sescape || code == Scharquote)))
1227 if (code != Sword || WORD_BOUNDARY_P (ch0, ch1))
1228 break;
1229 INC_BOTH (from, from_byte);
1230 ch0 = ch1;
1232 count--;
1234 while (count < 0)
1236 while (1)
1238 if (from == beg)
1240 immediate_quit = 0;
1241 return 0;
1243 DEC_BOTH (from, from_byte);
1244 UPDATE_SYNTAX_TABLE_BACKWARD (from);
1245 ch1 = FETCH_CHAR (from_byte);
1246 code = SYNTAX (ch1);
1247 if (words_include_escapes
1248 && (code == Sescape || code == Scharquote))
1249 break;
1250 if (code == Sword)
1251 break;
1253 /* Now CH1 is a character which ends a word and FROM is the
1254 position of it. */
1255 while (1)
1257 int temp_byte;
1259 if (from == beg)
1260 break;
1261 temp_byte = dec_bytepos (from_byte);
1262 UPDATE_SYNTAX_TABLE_BACKWARD (from);
1263 ch0 = FETCH_CHAR (temp_byte);
1264 code = SYNTAX (ch0);
1265 if (!(words_include_escapes
1266 && (code == Sescape || code == Scharquote)))
1267 if (code != Sword || WORD_BOUNDARY_P (ch0, ch1))
1268 break;
1269 DEC_BOTH (from, from_byte);
1270 ch1 = ch0;
1272 count++;
1275 immediate_quit = 0;
1277 return from;
1280 DEFUN ("forward-word", Fforward_word, Sforward_word, 0, 1, "p",
1281 doc: /* Move point forward ARG words (backward if ARG is negative).
1282 Normally returns t.
1283 If an edge of the buffer or a field boundary is reached, point is left there
1284 and the function returns nil. Field boundaries are not noticed if
1285 `inhibit-field-text-motion' is non-nil. */)
1286 (arg)
1287 Lisp_Object arg;
1289 int orig_val, val;
1291 if (NILP (arg))
1292 XSETFASTINT (arg, 1);
1293 else
1294 CHECK_NUMBER (arg);
1296 val = orig_val = scan_words (PT, XINT (arg));
1297 if (! orig_val)
1298 val = XINT (arg) > 0 ? ZV : BEGV;
1300 /* Avoid jumping out of an input field. */
1301 val = XFASTINT (Fconstrain_to_field (make_number (val), make_number (PT),
1302 Qt, Qnil, Qnil));
1304 SET_PT (val);
1305 return val == orig_val ? Qt : Qnil;
1308 Lisp_Object skip_chars ();
1310 DEFUN ("skip-chars-forward", Fskip_chars_forward, Sskip_chars_forward, 1, 2, 0,
1311 doc: /* Move point forward, stopping before a char not in STRING, or at pos LIM.
1312 STRING is like the inside of a `[...]' in a regular expression
1313 except that `]' is never special and `\\' quotes `^', `-' or `\\'
1314 (but not as the end of a range; quoting is never needed there).
1315 Thus, with arg "a-zA-Z", this skips letters stopping before first nonletter.
1316 With arg "^a-zA-Z", skips nonletters stopping before first letter.
1317 Returns the distance traveled, either zero or positive.
1318 Note that char classes, e.g. `[:alpha:]', are not currently supported;
1319 they will be treated as literals. */)
1320 (string, lim)
1321 Lisp_Object string, lim;
1323 return skip_chars (1, 0, string, lim);
1326 DEFUN ("skip-chars-backward", Fskip_chars_backward, Sskip_chars_backward, 1, 2, 0,
1327 doc: /* Move point backward, stopping after a char not in STRING, or at pos LIM.
1328 See `skip-chars-forward' for details.
1329 Returns the distance traveled, either zero or negative. */)
1330 (string, lim)
1331 Lisp_Object string, lim;
1333 return skip_chars (0, 0, string, lim);
1336 DEFUN ("skip-syntax-forward", Fskip_syntax_forward, Sskip_syntax_forward, 1, 2, 0,
1337 doc: /* Move point forward across chars in specified syntax classes.
1338 SYNTAX is a string of syntax code characters.
1339 Stop before a char whose syntax is not in SYNTAX, or at position LIM.
1340 If SYNTAX starts with ^, skip characters whose syntax is NOT in SYNTAX.
1341 This function returns the distance traveled, either zero or positive. */)
1342 (syntax, lim)
1343 Lisp_Object syntax, lim;
1345 return skip_chars (1, 1, syntax, lim);
1348 DEFUN ("skip-syntax-backward", Fskip_syntax_backward, Sskip_syntax_backward, 1, 2, 0,
1349 doc: /* Move point backward across chars in specified syntax classes.
1350 SYNTAX is a string of syntax code characters.
1351 Stop on reaching a char whose syntax is not in SYNTAX, or at position LIM.
1352 If SYNTAX starts with ^, skip characters whose syntax is NOT in SYNTAX.
1353 This function returns the distance traveled, either zero or negative. */)
1354 (syntax, lim)
1355 Lisp_Object syntax, lim;
1357 return skip_chars (0, 1, syntax, lim);
1360 static Lisp_Object
1361 skip_chars (forwardp, syntaxp, string, lim)
1362 int forwardp, syntaxp;
1363 Lisp_Object string, lim;
1365 register unsigned int c;
1366 unsigned char fastmap[0400];
1367 /* If SYNTAXP is 0, STRING may contain multi-byte form of characters
1368 of which codes don't fit in FASTMAP. In that case, set the
1369 ranges of characters in CHAR_RANGES. */
1370 int *char_ranges;
1371 int n_char_ranges = 0;
1372 int negate = 0;
1373 register int i, i_byte;
1374 int multibyte = !NILP (current_buffer->enable_multibyte_characters);
1375 int string_multibyte;
1376 int size_byte;
1377 const unsigned char *str;
1378 int len;
1380 CHECK_STRING (string);
1381 char_ranges = (int *) alloca (SCHARS (string) * (sizeof (int)) * 2);
1382 string_multibyte = STRING_MULTIBYTE (string);
1383 str = SDATA (string);
1384 size_byte = SBYTES (string);
1386 /* Adjust the multibyteness of the string to that of the buffer. */
1387 if (multibyte != string_multibyte)
1389 int nbytes;
1391 if (multibyte)
1392 nbytes = count_size_as_multibyte (SDATA (string),
1393 SCHARS (string));
1394 else
1395 nbytes = SCHARS (string);
1396 if (nbytes != size_byte)
1398 unsigned char *tmp = (unsigned char *) alloca (nbytes);
1399 copy_text (SDATA (string), tmp, size_byte,
1400 string_multibyte, multibyte);
1401 size_byte = nbytes;
1402 str = tmp;
1406 if (NILP (lim))
1407 XSETINT (lim, forwardp ? ZV : BEGV);
1408 else
1409 CHECK_NUMBER_COERCE_MARKER (lim);
1411 /* In any case, don't allow scan outside bounds of buffer. */
1412 if (XINT (lim) > ZV)
1413 XSETFASTINT (lim, ZV);
1414 if (XINT (lim) < BEGV)
1415 XSETFASTINT (lim, BEGV);
1417 bzero (fastmap, sizeof fastmap);
1419 i_byte = 0;
1421 if (i_byte < size_byte
1422 && SREF (string, 0) == '^')
1424 negate = 1; i_byte++;
1427 /* Find the characters specified and set their elements of fastmap.
1428 If syntaxp, each character counts as itself.
1429 Otherwise, handle backslashes and ranges specially. */
1431 while (i_byte < size_byte)
1433 c = STRING_CHAR_AND_LENGTH (str + i_byte, size_byte - i_byte, len);
1434 i_byte += len;
1436 if (syntaxp)
1437 fastmap[syntax_spec_code[c & 0377]] = 1;
1438 else
1440 if (c == '\\')
1442 if (i_byte == size_byte)
1443 break;
1445 c = STRING_CHAR_AND_LENGTH (str + i_byte,
1446 size_byte - i_byte, len);
1447 i_byte += len;
1449 /* Treat `-' as range character only if another character
1450 follows. */
1451 if (i_byte + 1 < size_byte
1452 && str[i_byte] == '-')
1454 unsigned int c2;
1456 /* Skip over the dash. */
1457 i_byte++;
1459 /* Get the end of the range. */
1460 c2 = STRING_CHAR_AND_LENGTH (str + i_byte,
1461 size_byte - i_byte, len);
1462 i_byte += len;
1464 if (SINGLE_BYTE_CHAR_P (c))
1466 if (! SINGLE_BYTE_CHAR_P (c2))
1468 /* Handle a range starting with a character of
1469 less than 256, and ending with a character of
1470 not less than 256. Split that into two
1471 ranges, the low one ending at 0377, and the
1472 high one starting at the smallest character
1473 in the charset of C2 and ending at C2. */
1474 int charset = CHAR_CHARSET (c2);
1475 int c1 = MAKE_CHAR (charset, 0, 0);
1477 char_ranges[n_char_ranges++] = c1;
1478 char_ranges[n_char_ranges++] = c2;
1479 c2 = 0377;
1481 while (c <= c2)
1483 fastmap[c] = 1;
1484 c++;
1487 else if (c <= c2) /* Both C and C2 are multibyte char. */
1489 char_ranges[n_char_ranges++] = c;
1490 char_ranges[n_char_ranges++] = c2;
1493 else
1495 if (SINGLE_BYTE_CHAR_P (c))
1496 fastmap[c] = 1;
1497 else
1499 char_ranges[n_char_ranges++] = c;
1500 char_ranges[n_char_ranges++] = c;
1506 /* If ^ was the first character, complement the fastmap. */
1507 if (negate)
1508 for (i = 0; i < sizeof fastmap; i++)
1509 fastmap[i] ^= 1;
1512 int start_point = PT;
1513 int pos = PT;
1514 int pos_byte = PT_BYTE;
1515 unsigned char *p = PT_ADDR, *endp, *stop;
1517 if (forwardp)
1519 endp = (XINT (lim) == GPT) ? GPT_ADDR : CHAR_POS_ADDR (XINT (lim));
1520 stop = (pos < GPT && GPT < XINT (lim)) ? GPT_ADDR : endp;
1522 else
1524 endp = CHAR_POS_ADDR (XINT (lim));
1525 stop = (pos >= GPT && GPT > XINT (lim)) ? GAP_END_ADDR : endp;
1528 immediate_quit = 1;
1529 if (syntaxp)
1531 SETUP_SYNTAX_TABLE (pos, forwardp ? 1 : -1);
1532 if (forwardp)
1534 if (multibyte)
1535 while (1)
1537 int nbytes;
1539 if (p >= stop)
1541 if (p >= endp)
1542 break;
1543 p = GAP_END_ADDR;
1544 stop = endp;
1546 c = STRING_CHAR_AND_LENGTH (p, MAX_MULTIBYTE_LENGTH, nbytes);
1547 if (! fastmap[(int) SYNTAX (c)])
1548 break;
1549 p += nbytes, pos++, pos_byte += nbytes;
1550 UPDATE_SYNTAX_TABLE_FORWARD (pos);
1552 else
1553 while (1)
1555 if (p >= stop)
1557 if (p >= endp)
1558 break;
1559 p = GAP_END_ADDR;
1560 stop = endp;
1562 if (! fastmap[(int) SYNTAX (*p)])
1563 break;
1564 p++, pos++;
1565 UPDATE_SYNTAX_TABLE_FORWARD (pos);
1568 else
1570 if (multibyte)
1571 while (1)
1573 unsigned char *prev_p;
1574 int nbytes;
1576 if (p <= stop)
1578 if (p <= endp)
1579 break;
1580 p = GPT_ADDR;
1581 stop = endp;
1583 prev_p = p;
1584 while (--p >= stop && ! CHAR_HEAD_P (*p));
1585 PARSE_MULTIBYTE_SEQ (p, MAX_MULTIBYTE_LENGTH, nbytes);
1586 if (prev_p - p > nbytes)
1587 p = prev_p - 1, c = *p, nbytes = 1;
1588 else
1589 c = STRING_CHAR (p, MAX_MULTIBYTE_LENGTH);
1590 pos--, pos_byte -= nbytes;
1591 UPDATE_SYNTAX_TABLE_BACKWARD (pos);
1592 if (! fastmap[(int) SYNTAX (c)])
1594 pos++;
1595 pos_byte += nbytes;
1596 break;
1599 else
1600 while (1)
1602 if (p <= stop)
1604 if (p <= endp)
1605 break;
1606 p = GPT_ADDR;
1607 stop = endp;
1609 if (! fastmap[(int) SYNTAX (p[-1])])
1610 break;
1611 p--, pos--;
1612 UPDATE_SYNTAX_TABLE_BACKWARD (pos - 1);
1616 else
1618 if (forwardp)
1620 if (multibyte)
1621 while (1)
1623 int nbytes;
1625 if (p >= stop)
1627 if (p >= endp)
1628 break;
1629 p = GAP_END_ADDR;
1630 stop = endp;
1632 c = STRING_CHAR_AND_LENGTH (p, MAX_MULTIBYTE_LENGTH, nbytes);
1633 if (SINGLE_BYTE_CHAR_P (c))
1635 if (!fastmap[c])
1636 break;
1638 else
1640 /* If we are looking at a multibyte character,
1641 we must look up the character in the table
1642 CHAR_RANGES. If there's no data in the
1643 table, that character is not what we want to
1644 skip. */
1646 /* The following code do the right thing even if
1647 n_char_ranges is zero (i.e. no data in
1648 CHAR_RANGES). */
1649 for (i = 0; i < n_char_ranges; i += 2)
1650 if (c >= char_ranges[i] && c <= char_ranges[i + 1])
1651 break;
1652 if (!(negate ^ (i < n_char_ranges)))
1653 break;
1655 p += nbytes, pos++, pos_byte += nbytes;
1657 else
1658 while (1)
1660 if (p >= stop)
1662 if (p >= endp)
1663 break;
1664 p = GAP_END_ADDR;
1665 stop = endp;
1667 if (!fastmap[*p])
1668 break;
1669 p++, pos++;
1672 else
1674 if (multibyte)
1675 while (1)
1677 unsigned char *prev_p;
1678 int nbytes;
1680 if (p <= stop)
1682 if (p <= endp)
1683 break;
1684 p = GPT_ADDR;
1685 stop = endp;
1687 prev_p = p;
1688 while (--p >= stop && ! CHAR_HEAD_P (*p));
1689 PARSE_MULTIBYTE_SEQ (p, MAX_MULTIBYTE_LENGTH, nbytes);
1690 if (prev_p - p > nbytes)
1691 p = prev_p - 1, c = *p, nbytes = 1;
1692 else
1693 c = STRING_CHAR (p, MAX_MULTIBYTE_LENGTH);
1694 if (SINGLE_BYTE_CHAR_P (c))
1696 if (!fastmap[c])
1697 break;
1699 else
1701 /* See the comment in the previous similar code. */
1702 for (i = 0; i < n_char_ranges; i += 2)
1703 if (c >= char_ranges[i] && c <= char_ranges[i + 1])
1704 break;
1705 if (!(negate ^ (i < n_char_ranges)))
1706 break;
1708 pos--, pos_byte -= nbytes;
1710 else
1711 while (1)
1713 if (p <= stop)
1715 if (p <= endp)
1716 break;
1717 p = GPT_ADDR;
1718 stop = endp;
1720 if (!fastmap[p[-1]])
1721 break;
1722 p--, pos--;
1727 #if 0 /* Not needed now that a position in mid-character
1728 cannot be specified in Lisp. */
1729 if (multibyte
1730 /* INC_POS or DEC_POS might have moved POS over LIM. */
1731 && (forwardp ? (pos > XINT (lim)) : (pos < XINT (lim))))
1732 pos = XINT (lim);
1733 #endif
1735 if (! multibyte)
1736 pos_byte = pos;
1738 SET_PT_BOTH (pos, pos_byte);
1739 immediate_quit = 0;
1741 return make_number (PT - start_point);
1745 /* Jump over a comment, assuming we are at the beginning of one.
1746 FROM is the current position.
1747 FROM_BYTE is the bytepos corresponding to FROM.
1748 Do not move past STOP (a charpos).
1749 The comment over which we have to jump is of style STYLE
1750 (either SYNTAX_COMMENT_STYLE(foo) or ST_COMMENT_STYLE).
1751 NESTING should be positive to indicate the nesting at the beginning
1752 for nested comments and should be zero or negative else.
1753 ST_COMMENT_STYLE cannot be nested.
1754 PREV_SYNTAX is the SYNTAX_WITH_FLAGS of the previous character
1755 (or 0 If the search cannot start in the middle of a two-character).
1757 If successful, return 1 and store the charpos of the comment's end
1758 into *CHARPOS_PTR and the corresponding bytepos into *BYTEPOS_PTR.
1759 Else, return 0 and store the charpos STOP into *CHARPOS_PTR, the
1760 corresponding bytepos into *BYTEPOS_PTR and the current nesting
1761 (as defined for state.incomment) in *INCOMMENT_PTR.
1763 The comment end is the last character of the comment rather than the
1764 character just after the comment.
1766 Global syntax data is assumed to initially be valid for FROM and
1767 remains valid for forward search starting at the returned position. */
1769 static int
1770 forw_comment (from, from_byte, stop, nesting, style, prev_syntax,
1771 charpos_ptr, bytepos_ptr, incomment_ptr)
1772 int from, from_byte, stop;
1773 int nesting, style, prev_syntax;
1774 int *charpos_ptr, *bytepos_ptr, *incomment_ptr;
1776 register int c, c1;
1777 register enum syntaxcode code;
1778 register int syntax;
1780 if (nesting <= 0) nesting = -1;
1782 /* Enter the loop in the middle so that we find
1783 a 2-char comment ender if we start in the middle of it. */
1784 syntax = prev_syntax;
1785 if (syntax != 0) goto forw_incomment;
1787 while (1)
1789 if (from == stop)
1791 *incomment_ptr = nesting;
1792 *charpos_ptr = from;
1793 *bytepos_ptr = from_byte;
1794 return 0;
1796 c = FETCH_CHAR (from_byte);
1797 syntax = SYNTAX_WITH_FLAGS (c);
1798 code = syntax & 0xff;
1799 if (code == Sendcomment
1800 && SYNTAX_FLAGS_COMMENT_STYLE (syntax) == style
1801 && (SYNTAX_FLAGS_COMMENT_NESTED (syntax) ?
1802 (nesting > 0 && --nesting == 0) : nesting < 0))
1803 /* we have encountered a comment end of the same style
1804 as the comment sequence which began this comment
1805 section */
1806 break;
1807 if (code == Scomment_fence
1808 && style == ST_COMMENT_STYLE)
1809 /* we have encountered a comment end of the same style
1810 as the comment sequence which began this comment
1811 section. */
1812 break;
1813 if (nesting > 0
1814 && code == Scomment
1815 && SYNTAX_FLAGS_COMMENT_NESTED (syntax)
1816 && SYNTAX_FLAGS_COMMENT_STYLE (syntax) == style)
1817 /* we have encountered a nested comment of the same style
1818 as the comment sequence which began this comment section */
1819 nesting++;
1820 INC_BOTH (from, from_byte);
1821 UPDATE_SYNTAX_TABLE_FORWARD (from);
1823 forw_incomment:
1824 if (from < stop && SYNTAX_FLAGS_COMEND_FIRST (syntax)
1825 && SYNTAX_FLAGS_COMMENT_STYLE (syntax) == style
1826 && (c1 = FETCH_CHAR (from_byte),
1827 SYNTAX_COMEND_SECOND (c1))
1828 && ((SYNTAX_FLAGS_COMMENT_NESTED (syntax) ||
1829 SYNTAX_COMMENT_NESTED (c1)) ? nesting > 0 : nesting < 0))
1831 if (--nesting <= 0)
1832 /* we have encountered a comment end of the same style
1833 as the comment sequence which began this comment
1834 section */
1835 break;
1836 else
1838 INC_BOTH (from, from_byte);
1839 UPDATE_SYNTAX_TABLE_FORWARD (from);
1842 if (nesting > 0
1843 && from < stop
1844 && SYNTAX_FLAGS_COMSTART_FIRST (syntax)
1845 && (c1 = FETCH_CHAR (from_byte),
1846 SYNTAX_COMMENT_STYLE (c1) == style
1847 && SYNTAX_COMSTART_SECOND (c1))
1848 && (SYNTAX_FLAGS_COMMENT_NESTED (syntax) ||
1849 SYNTAX_COMMENT_NESTED (c1)))
1850 /* we have encountered a nested comment of the same style
1851 as the comment sequence which began this comment
1852 section */
1854 INC_BOTH (from, from_byte);
1855 UPDATE_SYNTAX_TABLE_FORWARD (from);
1856 nesting++;
1859 *charpos_ptr = from;
1860 *bytepos_ptr = from_byte;
1861 return 1;
1864 DEFUN ("forward-comment", Fforward_comment, Sforward_comment, 1, 1, 0,
1865 doc: /*
1866 Move forward across up to COUNT comments. If COUNT is negative, move backward.
1867 Stop scanning if we find something other than a comment or whitespace.
1868 Set point to where scanning stops.
1869 If COUNT comments are found as expected, with nothing except whitespace
1870 between them, return t; otherwise return nil. */)
1871 (count)
1872 Lisp_Object count;
1874 register int from;
1875 int from_byte;
1876 register int stop;
1877 register int c, c1;
1878 register enum syntaxcode code;
1879 int comstyle = 0; /* style of comment encountered */
1880 int comnested = 0; /* whether the comment is nestable or not */
1881 int found;
1882 int count1;
1883 int out_charpos, out_bytepos;
1884 int dummy;
1886 CHECK_NUMBER (count);
1887 count1 = XINT (count);
1888 stop = count1 > 0 ? ZV : BEGV;
1890 immediate_quit = 1;
1891 QUIT;
1893 from = PT;
1894 from_byte = PT_BYTE;
1896 SETUP_SYNTAX_TABLE (from, count1);
1897 while (count1 > 0)
1901 int comstart_first;
1903 if (from == stop)
1905 SET_PT_BOTH (from, from_byte);
1906 immediate_quit = 0;
1907 return Qnil;
1909 c = FETCH_CHAR (from_byte);
1910 code = SYNTAX (c);
1911 comstart_first = SYNTAX_COMSTART_FIRST (c);
1912 comnested = SYNTAX_COMMENT_NESTED (c);
1913 comstyle = SYNTAX_COMMENT_STYLE (c);
1914 INC_BOTH (from, from_byte);
1915 UPDATE_SYNTAX_TABLE_FORWARD (from);
1916 if (from < stop && comstart_first
1917 && (c1 = FETCH_CHAR (from_byte),
1918 SYNTAX_COMSTART_SECOND (c1)))
1920 /* We have encountered a comment start sequence and we
1921 are ignoring all text inside comments. We must record
1922 the comment style this sequence begins so that later,
1923 only a comment end of the same style actually ends
1924 the comment section. */
1925 code = Scomment;
1926 comstyle = SYNTAX_COMMENT_STYLE (c1);
1927 comnested = comnested || SYNTAX_COMMENT_NESTED (c1);
1928 INC_BOTH (from, from_byte);
1929 UPDATE_SYNTAX_TABLE_FORWARD (from);
1932 while (code == Swhitespace || (code == Sendcomment && c == '\n'));
1934 if (code == Scomment_fence)
1935 comstyle = ST_COMMENT_STYLE;
1936 else if (code != Scomment)
1938 immediate_quit = 0;
1939 DEC_BOTH (from, from_byte);
1940 SET_PT_BOTH (from, from_byte);
1941 return Qnil;
1943 /* We're at the start of a comment. */
1944 found = forw_comment (from, from_byte, stop, comnested, comstyle, 0,
1945 &out_charpos, &out_bytepos, &dummy);
1946 from = out_charpos; from_byte = out_bytepos;
1947 if (!found)
1949 immediate_quit = 0;
1950 SET_PT_BOTH (from, from_byte);
1951 return Qnil;
1953 INC_BOTH (from, from_byte);
1954 UPDATE_SYNTAX_TABLE_FORWARD (from);
1955 /* We have skipped one comment. */
1956 count1--;
1959 while (count1 < 0)
1961 while (1)
1963 int quoted;
1965 if (from <= stop)
1967 SET_PT_BOTH (BEGV, BEGV_BYTE);
1968 immediate_quit = 0;
1969 return Qnil;
1972 DEC_BOTH (from, from_byte);
1973 /* char_quoted does UPDATE_SYNTAX_TABLE_BACKWARD (from). */
1974 quoted = char_quoted (from, from_byte);
1975 c = FETCH_CHAR (from_byte);
1976 code = SYNTAX (c);
1977 comstyle = 0;
1978 comnested = SYNTAX_COMMENT_NESTED (c);
1979 if (code == Sendcomment)
1980 comstyle = SYNTAX_COMMENT_STYLE (c);
1981 if (from > stop && SYNTAX_COMEND_SECOND (c)
1982 && prev_char_comend_first (from, from_byte)
1983 && !char_quoted (from - 1, dec_bytepos (from_byte)))
1985 /* We must record the comment style encountered so that
1986 later, we can match only the proper comment begin
1987 sequence of the same style. */
1988 DEC_BOTH (from, from_byte);
1989 code = Sendcomment;
1990 /* Calling char_quoted, above, set up global syntax position
1991 at the new value of FROM. */
1992 c1 = FETCH_CHAR (from_byte);
1993 comstyle = SYNTAX_COMMENT_STYLE (c1);
1994 comnested = comnested || SYNTAX_COMMENT_NESTED (c1);
1997 if (code == Scomment_fence)
1999 /* Skip until first preceding unquoted comment_fence. */
2000 int found = 0, ini = from, ini_byte = from_byte;
2002 while (1)
2004 DEC_BOTH (from, from_byte);
2005 if (from == stop)
2006 break;
2007 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2008 c = FETCH_CHAR (from_byte);
2009 if (SYNTAX (c) == Scomment_fence
2010 && !char_quoted (from, from_byte))
2012 found = 1;
2013 break;
2016 if (found == 0)
2018 from = ini; /* Set point to ini + 1. */
2019 from_byte = ini_byte;
2020 goto leave;
2023 else if (code == Sendcomment)
2025 found = back_comment (from, from_byte, stop, comnested, comstyle,
2026 &out_charpos, &out_bytepos);
2027 if (found == -1)
2029 if (c == '\n')
2030 /* This end-of-line is not an end-of-comment.
2031 Treat it like a whitespace.
2032 CC-mode (and maybe others) relies on this behavior. */
2034 else
2036 /* Failure: we should go back to the end of this
2037 not-quite-endcomment. */
2038 if (SYNTAX(c) != code)
2039 /* It was a two-char Sendcomment. */
2040 INC_BOTH (from, from_byte);
2041 goto leave;
2044 else
2046 /* We have skipped one comment. */
2047 from = out_charpos, from_byte = out_bytepos;
2048 break;
2051 else if (code != Swhitespace || quoted)
2053 leave:
2054 immediate_quit = 0;
2055 INC_BOTH (from, from_byte);
2056 SET_PT_BOTH (from, from_byte);
2057 return Qnil;
2061 count1++;
2064 SET_PT_BOTH (from, from_byte);
2065 immediate_quit = 0;
2066 return Qt;
2069 /* Return syntax code of character C if C is a single byte character
2070 or `multibyte_symbol_p' is zero. Otherwise, return Ssymbol. */
2072 #define SYNTAX_WITH_MULTIBYTE_CHECK(c) \
2073 ((SINGLE_BYTE_CHAR_P (c) || !multibyte_symbol_p) \
2074 ? SYNTAX (c) : Ssymbol)
2076 static Lisp_Object
2077 scan_lists (from, count, depth, sexpflag)
2078 register int from;
2079 int count, depth, sexpflag;
2081 Lisp_Object val;
2082 register int stop = count > 0 ? ZV : BEGV;
2083 register int c, c1;
2084 int stringterm;
2085 int quoted;
2086 int mathexit = 0;
2087 register enum syntaxcode code, temp_code;
2088 int min_depth = depth; /* Err out if depth gets less than this. */
2089 int comstyle = 0; /* style of comment encountered */
2090 int comnested = 0; /* whether the comment is nestable or not */
2091 int temp_pos;
2092 int last_good = from;
2093 int found;
2094 int from_byte;
2095 int out_bytepos, out_charpos;
2096 int temp, dummy;
2097 int multibyte_symbol_p = sexpflag && multibyte_syntax_as_symbol;
2099 if (depth > 0) min_depth = 0;
2101 if (from > ZV) from = ZV;
2102 if (from < BEGV) from = BEGV;
2104 from_byte = CHAR_TO_BYTE (from);
2106 immediate_quit = 1;
2107 QUIT;
2109 SETUP_SYNTAX_TABLE (from, count);
2110 while (count > 0)
2112 while (from < stop)
2114 int comstart_first, prefix;
2115 UPDATE_SYNTAX_TABLE_FORWARD (from);
2116 c = FETCH_CHAR (from_byte);
2117 code = SYNTAX_WITH_MULTIBYTE_CHECK (c);
2118 comstart_first = SYNTAX_COMSTART_FIRST (c);
2119 comnested = SYNTAX_COMMENT_NESTED (c);
2120 comstyle = SYNTAX_COMMENT_STYLE (c);
2121 prefix = SYNTAX_PREFIX (c);
2122 if (depth == min_depth)
2123 last_good = from;
2124 INC_BOTH (from, from_byte);
2125 UPDATE_SYNTAX_TABLE_FORWARD (from);
2126 if (from < stop && comstart_first
2127 && SYNTAX_COMSTART_SECOND (FETCH_CHAR (from_byte))
2128 && parse_sexp_ignore_comments)
2130 /* we have encountered a comment start sequence and we
2131 are ignoring all text inside comments. We must record
2132 the comment style this sequence begins so that later,
2133 only a comment end of the same style actually ends
2134 the comment section */
2135 code = Scomment;
2136 c1 = FETCH_CHAR (from_byte);
2137 comstyle = SYNTAX_COMMENT_STYLE (c1);
2138 comnested = comnested || SYNTAX_COMMENT_NESTED (c1);
2139 INC_BOTH (from, from_byte);
2140 UPDATE_SYNTAX_TABLE_FORWARD (from);
2143 if (prefix)
2144 continue;
2146 switch (SWITCH_ENUM_CAST (code))
2148 case Sescape:
2149 case Scharquote:
2150 if (from == stop) goto lose;
2151 INC_BOTH (from, from_byte);
2152 /* treat following character as a word constituent */
2153 case Sword:
2154 case Ssymbol:
2155 if (depth || !sexpflag) break;
2156 /* This word counts as a sexp; return at end of it. */
2157 while (from < stop)
2159 UPDATE_SYNTAX_TABLE_FORWARD (from);
2161 /* Some compilers can't handle this inside the switch. */
2162 c = FETCH_CHAR (from_byte);
2163 temp = SYNTAX_WITH_MULTIBYTE_CHECK (c);
2164 switch (temp)
2166 case Scharquote:
2167 case Sescape:
2168 INC_BOTH (from, from_byte);
2169 if (from == stop) goto lose;
2170 break;
2171 case Sword:
2172 case Ssymbol:
2173 case Squote:
2174 break;
2175 default:
2176 goto done;
2178 INC_BOTH (from, from_byte);
2180 goto done;
2182 case Scomment_fence:
2183 comstyle = ST_COMMENT_STYLE;
2184 /* FALLTHROUGH */
2185 case Scomment:
2186 if (!parse_sexp_ignore_comments) break;
2187 UPDATE_SYNTAX_TABLE_FORWARD (from);
2188 found = forw_comment (from, from_byte, stop,
2189 comnested, comstyle, 0,
2190 &out_charpos, &out_bytepos, &dummy);
2191 from = out_charpos, from_byte = out_bytepos;
2192 if (!found)
2194 if (depth == 0)
2195 goto done;
2196 goto lose;
2198 INC_BOTH (from, from_byte);
2199 UPDATE_SYNTAX_TABLE_FORWARD (from);
2200 break;
2202 case Smath:
2203 if (!sexpflag)
2204 break;
2205 if (from != stop && c == FETCH_CHAR (from_byte))
2207 INC_BOTH (from, from_byte);
2209 if (mathexit)
2211 mathexit = 0;
2212 goto close1;
2214 mathexit = 1;
2216 case Sopen:
2217 if (!++depth) goto done;
2218 break;
2220 case Sclose:
2221 close1:
2222 if (!--depth) goto done;
2223 if (depth < min_depth)
2224 Fsignal (Qscan_error,
2225 Fcons (build_string ("Containing expression ends prematurely"),
2226 Fcons (make_number (last_good),
2227 Fcons (make_number (from), Qnil))));
2228 break;
2230 case Sstring:
2231 case Sstring_fence:
2232 temp_pos = dec_bytepos (from_byte);
2233 stringterm = FETCH_CHAR (temp_pos);
2234 while (1)
2236 if (from >= stop) goto lose;
2237 UPDATE_SYNTAX_TABLE_FORWARD (from);
2238 c = FETCH_CHAR (from_byte);
2239 if (code == Sstring
2240 ? (c == stringterm
2241 && SYNTAX_WITH_MULTIBYTE_CHECK (c) == Sstring)
2242 : SYNTAX_WITH_MULTIBYTE_CHECK (c) == Sstring_fence)
2243 break;
2245 /* Some compilers can't handle this inside the switch. */
2246 temp = SYNTAX_WITH_MULTIBYTE_CHECK (c);
2247 switch (temp)
2249 case Scharquote:
2250 case Sescape:
2251 INC_BOTH (from, from_byte);
2253 INC_BOTH (from, from_byte);
2255 INC_BOTH (from, from_byte);
2256 if (!depth && sexpflag) goto done;
2257 break;
2258 default:
2259 /* Ignore whitespace, punctuation, quote, endcomment. */
2260 break;
2264 /* Reached end of buffer. Error if within object, return nil if between */
2265 if (depth) goto lose;
2267 immediate_quit = 0;
2268 return Qnil;
2270 /* End of object reached */
2271 done:
2272 count--;
2275 while (count < 0)
2277 while (from > stop)
2279 DEC_BOTH (from, from_byte);
2280 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2281 c = FETCH_CHAR (from_byte);
2282 code = SYNTAX_WITH_MULTIBYTE_CHECK (c);
2283 if (depth == min_depth)
2284 last_good = from;
2285 comstyle = 0;
2286 comnested = SYNTAX_COMMENT_NESTED (c);
2287 if (code == Sendcomment)
2288 comstyle = SYNTAX_COMMENT_STYLE (c);
2289 if (from > stop && SYNTAX_COMEND_SECOND (c)
2290 && prev_char_comend_first (from, from_byte)
2291 && parse_sexp_ignore_comments)
2293 /* We must record the comment style encountered so that
2294 later, we can match only the proper comment begin
2295 sequence of the same style. */
2296 DEC_BOTH (from, from_byte);
2297 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2298 code = Sendcomment;
2299 c1 = FETCH_CHAR (from_byte);
2300 comstyle = SYNTAX_COMMENT_STYLE (c1);
2301 comnested = comnested || SYNTAX_COMMENT_NESTED (c1);
2304 /* Quoting turns anything except a comment-ender
2305 into a word character. Note that this cannot be true
2306 if we decremented FROM in the if-statement above. */
2307 if (code != Sendcomment && char_quoted (from, from_byte))
2309 DEC_BOTH (from, from_byte);
2310 code = Sword;
2312 else if (SYNTAX_PREFIX (c))
2313 continue;
2315 switch (SWITCH_ENUM_CAST (code))
2317 case Sword:
2318 case Ssymbol:
2319 case Sescape:
2320 case Scharquote:
2321 if (depth || !sexpflag) break;
2322 /* This word counts as a sexp; count object finished
2323 after passing it. */
2324 while (from > stop)
2326 temp_pos = from_byte;
2327 if (! NILP (current_buffer->enable_multibyte_characters))
2328 DEC_POS (temp_pos);
2329 else
2330 temp_pos--;
2331 UPDATE_SYNTAX_TABLE_BACKWARD (from - 1);
2332 c1 = FETCH_CHAR (temp_pos);
2333 temp_code = SYNTAX_WITH_MULTIBYTE_CHECK (c1);
2334 /* Don't allow comment-end to be quoted. */
2335 if (temp_code == Sendcomment)
2336 goto done2;
2337 quoted = char_quoted (from - 1, temp_pos);
2338 if (quoted)
2340 DEC_BOTH (from, from_byte);
2341 temp_pos = dec_bytepos (temp_pos);
2342 UPDATE_SYNTAX_TABLE_BACKWARD (from - 1);
2344 c1 = FETCH_CHAR (temp_pos);
2345 temp_code = SYNTAX_WITH_MULTIBYTE_CHECK (c1);
2346 if (! (quoted || temp_code == Sword
2347 || temp_code == Ssymbol
2348 || temp_code == Squote))
2349 goto done2;
2350 DEC_BOTH (from, from_byte);
2352 goto done2;
2354 case Smath:
2355 if (!sexpflag)
2356 break;
2357 temp_pos = dec_bytepos (from_byte);
2358 UPDATE_SYNTAX_TABLE_BACKWARD (from - 1);
2359 if (from != stop && c == FETCH_CHAR (temp_pos))
2360 DEC_BOTH (from, from_byte);
2361 if (mathexit)
2363 mathexit = 0;
2364 goto open2;
2366 mathexit = 1;
2368 case Sclose:
2369 if (!++depth) goto done2;
2370 break;
2372 case Sopen:
2373 open2:
2374 if (!--depth) goto done2;
2375 if (depth < min_depth)
2376 Fsignal (Qscan_error,
2377 Fcons (build_string ("Containing expression ends prematurely"),
2378 Fcons (make_number (last_good),
2379 Fcons (make_number (from), Qnil))));
2380 break;
2382 case Sendcomment:
2383 if (!parse_sexp_ignore_comments)
2384 break;
2385 found = back_comment (from, from_byte, stop, comnested, comstyle,
2386 &out_charpos, &out_bytepos);
2387 /* FIXME: if found == -1, then it really wasn't a comment-end.
2388 For single-char Sendcomment, we can't do much about it apart
2389 from skipping the char.
2390 For 2-char endcomments, we could try again, taking both
2391 chars as separate entities, but it's a lot of trouble
2392 for very little gain, so we don't bother either. -sm */
2393 if (found != -1)
2394 from = out_charpos, from_byte = out_bytepos;
2395 break;
2397 case Scomment_fence:
2398 case Sstring_fence:
2399 while (1)
2401 if (from == stop) goto lose;
2402 DEC_BOTH (from, from_byte);
2403 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2404 if (!char_quoted (from, from_byte)
2405 && (c = FETCH_CHAR (from_byte),
2406 SYNTAX_WITH_MULTIBYTE_CHECK (c) == code))
2407 break;
2409 if (code == Sstring_fence && !depth && sexpflag) goto done2;
2410 break;
2412 case Sstring:
2413 stringterm = FETCH_CHAR (from_byte);
2414 while (1)
2416 if (from == stop) goto lose;
2417 DEC_BOTH (from, from_byte);
2418 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2419 if (!char_quoted (from, from_byte)
2420 && stringterm == (c = FETCH_CHAR (from_byte))
2421 && SYNTAX_WITH_MULTIBYTE_CHECK (c) == Sstring)
2422 break;
2424 if (!depth && sexpflag) goto done2;
2425 break;
2426 default:
2427 /* Ignore whitespace, punctuation, quote, endcomment. */
2428 break;
2432 /* Reached start of buffer. Error if within object, return nil if between */
2433 if (depth) goto lose;
2435 immediate_quit = 0;
2436 return Qnil;
2438 done2:
2439 count++;
2443 immediate_quit = 0;
2444 XSETFASTINT (val, from);
2445 return val;
2447 lose:
2448 Fsignal (Qscan_error,
2449 Fcons (build_string ("Unbalanced parentheses"),
2450 Fcons (make_number (last_good),
2451 Fcons (make_number (from), Qnil))));
2453 /* NOTREACHED */
2456 DEFUN ("scan-lists", Fscan_lists, Sscan_lists, 3, 3, 0,
2457 doc: /* Scan from character number FROM by COUNT lists.
2458 Returns the character number of the position thus found.
2460 If DEPTH is nonzero, paren depth begins counting from that value,
2461 only places where the depth in parentheses becomes zero
2462 are candidates for stopping; COUNT such places are counted.
2463 Thus, a positive value for DEPTH means go out levels.
2465 Comments are ignored if `parse-sexp-ignore-comments' is non-nil.
2467 If the beginning or end of (the accessible part of) the buffer is reached
2468 and the depth is wrong, an error is signaled.
2469 If the depth is right but the count is not used up, nil is returned. */)
2470 (from, count, depth)
2471 Lisp_Object from, count, depth;
2473 CHECK_NUMBER (from);
2474 CHECK_NUMBER (count);
2475 CHECK_NUMBER (depth);
2477 return scan_lists (XINT (from), XINT (count), XINT (depth), 0);
2480 DEFUN ("scan-sexps", Fscan_sexps, Sscan_sexps, 2, 2, 0,
2481 doc: /* Scan from character number FROM by COUNT balanced expressions.
2482 If COUNT is negative, scan backwards.
2483 Returns the character number of the position thus found.
2485 Comments are ignored if `parse-sexp-ignore-comments' is non-nil.
2487 If the beginning or end of (the accessible part of) the buffer is reached
2488 in the middle of a parenthetical grouping, an error is signaled.
2489 If the beginning or end is reached between groupings
2490 but before count is used up, nil is returned. */)
2491 (from, count)
2492 Lisp_Object from, count;
2494 CHECK_NUMBER (from);
2495 CHECK_NUMBER (count);
2497 return scan_lists (XINT (from), XINT (count), 0, 1);
2500 DEFUN ("backward-prefix-chars", Fbackward_prefix_chars, Sbackward_prefix_chars,
2501 0, 0, 0,
2502 doc: /* Move point backward over any number of chars with prefix syntax.
2503 This includes chars with "quote" or "prefix" syntax (' or p). */)
2506 int beg = BEGV;
2507 int opoint = PT;
2508 int opoint_byte = PT_BYTE;
2509 int pos = PT;
2510 int pos_byte = PT_BYTE;
2511 int c;
2513 if (pos <= beg)
2515 SET_PT_BOTH (opoint, opoint_byte);
2517 return Qnil;
2520 SETUP_SYNTAX_TABLE (pos, -1);
2522 DEC_BOTH (pos, pos_byte);
2524 while (!char_quoted (pos, pos_byte)
2525 /* Previous statement updates syntax table. */
2526 && ((c = FETCH_CHAR (pos_byte), SYNTAX (c) == Squote)
2527 || SYNTAX_PREFIX (c)))
2529 opoint = pos;
2530 opoint_byte = pos_byte;
2532 if (pos + 1 > beg)
2533 DEC_BOTH (pos, pos_byte);
2536 SET_PT_BOTH (opoint, opoint_byte);
2538 return Qnil;
2541 /* Parse forward from FROM / FROM_BYTE to END,
2542 assuming that FROM has state OLDSTATE (nil means FROM is start of function),
2543 and return a description of the state of the parse at END.
2544 If STOPBEFORE is nonzero, stop at the start of an atom.
2545 If COMMENTSTOP is 1, stop at the start of a comment.
2546 If COMMENTSTOP is -1, stop at the start or end of a comment,
2547 after the beginning of a string, or after the end of a string. */
2549 static void
2550 scan_sexps_forward (stateptr, from, from_byte, end, targetdepth,
2551 stopbefore, oldstate, commentstop)
2552 struct lisp_parse_state *stateptr;
2553 register int from;
2554 int end, targetdepth, stopbefore, from_byte;
2555 Lisp_Object oldstate;
2556 int commentstop;
2558 struct lisp_parse_state state;
2560 register enum syntaxcode code;
2561 int c1;
2562 int comnested;
2563 struct level { int last, prev; };
2564 struct level levelstart[100];
2565 register struct level *curlevel = levelstart;
2566 struct level *endlevel = levelstart + 100;
2567 register int depth; /* Paren depth of current scanning location.
2568 level - levelstart equals this except
2569 when the depth becomes negative. */
2570 int mindepth; /* Lowest DEPTH value seen. */
2571 int start_quoted = 0; /* Nonzero means starting after a char quote */
2572 Lisp_Object tem;
2573 int prev_from; /* Keep one character before FROM. */
2574 int prev_from_byte;
2575 int prev_from_syntax;
2576 int boundary_stop = commentstop == -1;
2577 int nofence;
2578 int found;
2579 int out_bytepos, out_charpos;
2580 int temp;
2582 prev_from = from;
2583 prev_from_byte = from_byte;
2584 if (from != BEGV)
2585 DEC_BOTH (prev_from, prev_from_byte);
2587 /* Use this macro instead of `from++'. */
2588 #define INC_FROM \
2589 do { prev_from = from; \
2590 prev_from_byte = from_byte; \
2591 prev_from_syntax \
2592 = SYNTAX_WITH_FLAGS (FETCH_CHAR (prev_from_byte)); \
2593 INC_BOTH (from, from_byte); \
2594 if (from < end) \
2595 UPDATE_SYNTAX_TABLE_FORWARD (from); \
2596 } while (0)
2598 immediate_quit = 1;
2599 QUIT;
2601 if (NILP (oldstate))
2603 depth = 0;
2604 state.instring = -1;
2605 state.incomment = 0;
2606 state.comstyle = 0; /* comment style a by default. */
2607 state.comstr_start = -1; /* no comment/string seen. */
2609 else
2611 tem = Fcar (oldstate);
2612 if (!NILP (tem))
2613 depth = XINT (tem);
2614 else
2615 depth = 0;
2617 oldstate = Fcdr (oldstate);
2618 oldstate = Fcdr (oldstate);
2619 oldstate = Fcdr (oldstate);
2620 tem = Fcar (oldstate);
2621 /* Check whether we are inside string_fence-style string: */
2622 state.instring = (!NILP (tem)
2623 ? (INTEGERP (tem) ? XINT (tem) : ST_STRING_STYLE)
2624 : -1);
2626 oldstate = Fcdr (oldstate);
2627 tem = Fcar (oldstate);
2628 state.incomment = (!NILP (tem)
2629 ? (INTEGERP (tem) ? XINT (tem) : -1)
2630 : 0);
2632 oldstate = Fcdr (oldstate);
2633 tem = Fcar (oldstate);
2634 start_quoted = !NILP (tem);
2636 /* if the eighth element of the list is nil, we are in comment
2637 style a. If it is non-nil, we are in comment style b */
2638 oldstate = Fcdr (oldstate);
2639 oldstate = Fcdr (oldstate);
2640 tem = Fcar (oldstate);
2641 state.comstyle = NILP (tem) ? 0 : (EQ (tem, Qsyntax_table)
2642 ? ST_COMMENT_STYLE : 1);
2644 oldstate = Fcdr (oldstate);
2645 tem = Fcar (oldstate);
2646 state.comstr_start = NILP (tem) ? -1 : XINT (tem) ;
2647 oldstate = Fcdr (oldstate);
2648 tem = Fcar (oldstate);
2649 while (!NILP (tem)) /* >= second enclosing sexps. */
2651 /* curlevel++->last ran into compiler bug on Apollo */
2652 curlevel->last = XINT (Fcar (tem));
2653 if (++curlevel == endlevel)
2654 curlevel--; /* error ("Nesting too deep for parser"); */
2655 curlevel->prev = -1;
2656 curlevel->last = -1;
2657 tem = Fcdr (tem);
2660 state.quoted = 0;
2661 mindepth = depth;
2663 curlevel->prev = -1;
2664 curlevel->last = -1;
2666 SETUP_SYNTAX_TABLE (prev_from, 1);
2667 prev_from_syntax = SYNTAX_WITH_FLAGS (FETCH_CHAR (prev_from_byte));
2668 UPDATE_SYNTAX_TABLE_FORWARD (from);
2670 /* Enter the loop at a place appropriate for initial state. */
2672 if (state.incomment)
2673 goto startincomment;
2674 if (state.instring >= 0)
2676 nofence = state.instring != ST_STRING_STYLE;
2677 if (start_quoted)
2678 goto startquotedinstring;
2679 goto startinstring;
2681 else if (start_quoted)
2682 goto startquoted;
2684 while (from < end)
2686 INC_FROM;
2687 code = prev_from_syntax & 0xff;
2689 if (code == Scomment)
2691 state.comstyle = SYNTAX_FLAGS_COMMENT_STYLE (prev_from_syntax);
2692 state.incomment = (SYNTAX_FLAGS_COMMENT_NESTED (prev_from_syntax) ?
2693 1 : -1);
2694 state.comstr_start = prev_from;
2696 else if (code == Scomment_fence)
2698 /* Record the comment style we have entered so that only
2699 the comment-end sequence of the same style actually
2700 terminates the comment section. */
2701 state.comstyle = ST_COMMENT_STYLE;
2702 state.incomment = -1;
2703 state.comstr_start = prev_from;
2704 code = Scomment;
2706 else if (from < end)
2707 if (SYNTAX_FLAGS_COMSTART_FIRST (prev_from_syntax))
2708 if (c1 = FETCH_CHAR (from_byte),
2709 SYNTAX_COMSTART_SECOND (c1))
2710 /* Duplicate code to avoid a complex if-expression
2711 which causes trouble for the SGI compiler. */
2713 /* Record the comment style we have entered so that only
2714 the comment-end sequence of the same style actually
2715 terminates the comment section. */
2716 state.comstyle = SYNTAX_COMMENT_STYLE (c1);
2717 comnested = SYNTAX_FLAGS_COMMENT_NESTED (prev_from_syntax);
2718 comnested = comnested || SYNTAX_COMMENT_NESTED (c1);
2719 state.incomment = comnested ? 1 : -1;
2720 state.comstr_start = prev_from;
2721 INC_FROM;
2722 code = Scomment;
2725 if (SYNTAX_FLAGS_PREFIX (prev_from_syntax))
2726 continue;
2727 switch (SWITCH_ENUM_CAST (code))
2729 case Sescape:
2730 case Scharquote:
2731 if (stopbefore) goto stop; /* this arg means stop at sexp start */
2732 curlevel->last = prev_from;
2733 startquoted:
2734 if (from == end) goto endquoted;
2735 INC_FROM;
2736 goto symstarted;
2737 /* treat following character as a word constituent */
2738 case Sword:
2739 case Ssymbol:
2740 if (stopbefore) goto stop; /* this arg means stop at sexp start */
2741 curlevel->last = prev_from;
2742 symstarted:
2743 while (from < end)
2745 /* Some compilers can't handle this inside the switch. */
2746 temp = SYNTAX (FETCH_CHAR (from_byte));
2747 switch (temp)
2749 case Scharquote:
2750 case Sescape:
2751 INC_FROM;
2752 if (from == end) goto endquoted;
2753 break;
2754 case Sword:
2755 case Ssymbol:
2756 case Squote:
2757 break;
2758 default:
2759 goto symdone;
2761 INC_FROM;
2763 symdone:
2764 curlevel->prev = curlevel->last;
2765 break;
2767 case Scomment_fence: /* Can't happen because it's handled above. */
2768 case Scomment:
2769 if (commentstop || boundary_stop) goto done;
2770 startincomment:
2771 /* The (from == BEGV) test was to enter the loop in the middle so
2772 that we find a 2-char comment ender even if we start in the
2773 middle of it. We don't want to do that if we're just at the
2774 beginning of the comment (think of (*) ... (*)). */
2775 found = forw_comment (from, from_byte, end,
2776 state.incomment, state.comstyle,
2777 (from == BEGV || from < state.comstr_start + 3)
2778 ? 0 : prev_from_syntax,
2779 &out_charpos, &out_bytepos, &state.incomment);
2780 from = out_charpos; from_byte = out_bytepos;
2781 /* Beware! prev_from and friends are invalid now.
2782 Luckily, the `done' doesn't use them and the INC_FROM
2783 sets them to a sane value without looking at them. */
2784 if (!found) goto done;
2785 INC_FROM;
2786 state.incomment = 0;
2787 state.comstyle = 0; /* reset the comment style */
2788 if (boundary_stop) goto done;
2789 break;
2791 case Sopen:
2792 if (stopbefore) goto stop; /* this arg means stop at sexp start */
2793 depth++;
2794 /* curlevel++->last ran into compiler bug on Apollo */
2795 curlevel->last = prev_from;
2796 if (++curlevel == endlevel)
2797 curlevel--; /* error ("Nesting too deep for parser"); */
2798 curlevel->prev = -1;
2799 curlevel->last = -1;
2800 if (targetdepth == depth) goto done;
2801 break;
2803 case Sclose:
2804 depth--;
2805 if (depth < mindepth)
2806 mindepth = depth;
2807 if (curlevel != levelstart)
2808 curlevel--;
2809 curlevel->prev = curlevel->last;
2810 if (targetdepth == depth) goto done;
2811 break;
2813 case Sstring:
2814 case Sstring_fence:
2815 state.comstr_start = from - 1;
2816 if (stopbefore) goto stop; /* this arg means stop at sexp start */
2817 curlevel->last = prev_from;
2818 state.instring = (code == Sstring
2819 ? (FETCH_CHAR (prev_from_byte))
2820 : ST_STRING_STYLE);
2821 if (boundary_stop) goto done;
2822 startinstring:
2824 nofence = state.instring != ST_STRING_STYLE;
2826 while (1)
2828 int c;
2830 if (from >= end) goto done;
2831 c = FETCH_CHAR (from_byte);
2832 /* Some compilers can't handle this inside the switch. */
2833 temp = SYNTAX (c);
2835 /* Check TEMP here so that if the char has
2836 a syntax-table property which says it is NOT
2837 a string character, it does not end the string. */
2838 if (nofence && c == state.instring && temp == Sstring)
2839 break;
2841 switch (temp)
2843 case Sstring_fence:
2844 if (!nofence) goto string_end;
2845 break;
2846 case Scharquote:
2847 case Sescape:
2848 INC_FROM;
2849 startquotedinstring:
2850 if (from >= end) goto endquoted;
2852 INC_FROM;
2855 string_end:
2856 state.instring = -1;
2857 curlevel->prev = curlevel->last;
2858 INC_FROM;
2859 if (boundary_stop) goto done;
2860 break;
2862 case Smath:
2863 /* FIXME: We should do something with it. */
2864 break;
2865 default:
2866 /* Ignore whitespace, punctuation, quote, endcomment. */
2867 break;
2870 goto done;
2872 stop: /* Here if stopping before start of sexp. */
2873 from = prev_from; /* We have just fetched the char that starts it; */
2874 goto done; /* but return the position before it. */
2876 endquoted:
2877 state.quoted = 1;
2878 done:
2879 state.depth = depth;
2880 state.mindepth = mindepth;
2881 state.thislevelstart = curlevel->prev;
2882 state.prevlevelstart
2883 = (curlevel == levelstart) ? -1 : (curlevel - 1)->last;
2884 state.location = from;
2885 state.levelstarts = Qnil;
2886 while (--curlevel >= levelstart)
2887 state.levelstarts = Fcons (make_number (curlevel->last),
2888 state.levelstarts);
2889 immediate_quit = 0;
2891 *stateptr = state;
2894 DEFUN ("parse-partial-sexp", Fparse_partial_sexp, Sparse_partial_sexp, 2, 6, 0,
2895 doc: /* Parse Lisp syntax starting at FROM until TO; return status of parse at TO.
2896 Parsing stops at TO or when certain criteria are met;
2897 point is set to where parsing stops.
2898 If fifth arg OLDSTATE is omitted or nil,
2899 parsing assumes that FROM is the beginning of a function.
2900 Value is a list of ten elements describing final state of parsing:
2901 0. depth in parens.
2902 1. character address of start of innermost containing list; nil if none.
2903 2. character address of start of last complete sexp terminated.
2904 3. non-nil if inside a string.
2905 (it is the character that will terminate the string,
2906 or t if the string should be terminated by a generic string delimiter.)
2907 4. nil if outside a comment, t if inside a non-nestable comment,
2908 else an integer (the current comment nesting).
2909 5. t if following a quote character.
2910 6. the minimum paren-depth encountered during this scan.
2911 7. t if in a comment of style b; symbol `syntax-table' if the comment
2912 should be terminated by a generic comment delimiter.
2913 8. character address of start of comment or string; nil if not in one.
2914 9. Intermediate data for continuation of parsing (subject to change).
2915 If third arg TARGETDEPTH is non-nil, parsing stops if the depth
2916 in parentheses becomes equal to TARGETDEPTH.
2917 Fourth arg STOPBEFORE non-nil means stop when come to
2918 any character that starts a sexp.
2919 Fifth arg OLDSTATE is a nine-element list like what this function returns.
2920 It is used to initialize the state of the parse. Elements number 1, 2, 6
2921 and 8 are ignored; you can leave off element 8 (the last) entirely.
2922 Sixth arg COMMENTSTOP non-nil means stop at the start of a comment.
2923 If it is symbol `syntax-table', stop after the start of a comment or a
2924 string, or after end of a comment or a string. */)
2925 (from, to, targetdepth, stopbefore, oldstate, commentstop)
2926 Lisp_Object from, to, targetdepth, stopbefore, oldstate, commentstop;
2928 struct lisp_parse_state state;
2929 int target;
2931 if (!NILP (targetdepth))
2933 CHECK_NUMBER (targetdepth);
2934 target = XINT (targetdepth);
2936 else
2937 target = -100000; /* We won't reach this depth */
2939 validate_region (&from, &to);
2940 scan_sexps_forward (&state, XINT (from), CHAR_TO_BYTE (XINT (from)),
2941 XINT (to),
2942 target, !NILP (stopbefore), oldstate,
2943 (NILP (commentstop)
2944 ? 0 : (EQ (commentstop, Qsyntax_table) ? -1 : 1)));
2946 SET_PT (state.location);
2948 return Fcons (make_number (state.depth),
2949 Fcons (state.prevlevelstart < 0 ? Qnil : make_number (state.prevlevelstart),
2950 Fcons (state.thislevelstart < 0 ? Qnil : make_number (state.thislevelstart),
2951 Fcons (state.instring >= 0
2952 ? (state.instring == ST_STRING_STYLE
2953 ? Qt : make_number (state.instring)) : Qnil,
2954 Fcons (state.incomment < 0 ? Qt :
2955 (state.incomment == 0 ? Qnil :
2956 make_number (state.incomment)),
2957 Fcons (state.quoted ? Qt : Qnil,
2958 Fcons (make_number (state.mindepth),
2959 Fcons ((state.comstyle
2960 ? (state.comstyle == ST_COMMENT_STYLE
2961 ? Qsyntax_table : Qt) :
2962 Qnil),
2963 Fcons (((state.incomment
2964 || (state.instring >= 0))
2965 ? make_number (state.comstr_start)
2966 : Qnil),
2967 Fcons (state.levelstarts, Qnil))))))))));
2970 void
2971 init_syntax_once ()
2973 register int i, c;
2974 Lisp_Object temp;
2976 /* This has to be done here, before we call Fmake_char_table. */
2977 Qsyntax_table = intern ("syntax-table");
2978 staticpro (&Qsyntax_table);
2980 /* Intern this now in case it isn't already done.
2981 Setting this variable twice is harmless.
2982 But don't staticpro it here--that is done in alloc.c. */
2983 Qchar_table_extra_slots = intern ("char-table-extra-slots");
2985 /* Create objects which can be shared among syntax tables. */
2986 Vsyntax_code_object = Fmake_vector (make_number (Smax), Qnil);
2987 for (i = 0; i < XVECTOR (Vsyntax_code_object)->size; i++)
2988 XVECTOR (Vsyntax_code_object)->contents[i]
2989 = Fcons (make_number (i), Qnil);
2991 /* Now we are ready to set up this property, so we can
2992 create syntax tables. */
2993 Fput (Qsyntax_table, Qchar_table_extra_slots, make_number (0));
2995 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Swhitespace];
2997 Vstandard_syntax_table = Fmake_char_table (Qsyntax_table, temp);
2999 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Sword];
3000 for (i = 'a'; i <= 'z'; i++)
3001 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, i, temp);
3002 for (i = 'A'; i <= 'Z'; i++)
3003 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, i, temp);
3004 for (i = '0'; i <= '9'; i++)
3005 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, i, temp);
3007 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '$', temp);
3008 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '%', temp);
3010 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '(',
3011 Fcons (make_number (Sopen), make_number (')')));
3012 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, ')',
3013 Fcons (make_number (Sclose), make_number ('(')));
3014 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '[',
3015 Fcons (make_number (Sopen), make_number (']')));
3016 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, ']',
3017 Fcons (make_number (Sclose), make_number ('[')));
3018 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '{',
3019 Fcons (make_number (Sopen), make_number ('}')));
3020 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '}',
3021 Fcons (make_number (Sclose), make_number ('{')));
3022 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '"',
3023 Fcons (make_number ((int) Sstring), Qnil));
3024 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '\\',
3025 Fcons (make_number ((int) Sescape), Qnil));
3027 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Ssymbol];
3028 for (i = 0; i < 10; i++)
3030 c = "_-+*/&|<>="[i];
3031 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, c, temp);
3034 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Spunct];
3035 for (i = 0; i < 12; i++)
3037 c = ".,;:?!#@~^'`"[i];
3038 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, c, temp);
3041 /* All multibyte characters have syntax `word' by default. */
3042 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Sword];
3043 for (i = CHAR_TABLE_SINGLE_BYTE_SLOTS; i < CHAR_TABLE_ORDINARY_SLOTS; i++)
3044 XCHAR_TABLE (Vstandard_syntax_table)->contents[i] = temp;
3047 void
3048 syms_of_syntax ()
3050 Qsyntax_table_p = intern ("syntax-table-p");
3051 staticpro (&Qsyntax_table_p);
3053 staticpro (&Vsyntax_code_object);
3055 Qscan_error = intern ("scan-error");
3056 staticpro (&Qscan_error);
3057 Fput (Qscan_error, Qerror_conditions,
3058 Fcons (Qscan_error, Fcons (Qerror, Qnil)));
3059 Fput (Qscan_error, Qerror_message,
3060 build_string ("Scan error"));
3062 DEFVAR_BOOL ("parse-sexp-ignore-comments", &parse_sexp_ignore_comments,
3063 doc: /* Non-nil means `forward-sexp', etc., should treat comments as whitespace. */);
3065 DEFVAR_BOOL ("parse-sexp-lookup-properties", &parse_sexp_lookup_properties,
3066 doc: /* Non-nil means `forward-sexp', etc., obey `syntax-table' property.
3067 Otherwise, that text property is simply ignored.
3068 See the info node `(elisp)Syntax Properties' for a description of the
3069 `syntax-table' property. */);
3071 words_include_escapes = 0;
3072 DEFVAR_BOOL ("words-include-escapes", &words_include_escapes,
3073 doc: /* Non-nil means `forward-word', etc., should treat escape chars part of words. */);
3075 DEFVAR_BOOL ("multibyte-syntax-as-symbol", &multibyte_syntax_as_symbol,
3076 doc: /* Non-nil means `scan-sexps' treats all multibyte characters as symbol. */);
3077 multibyte_syntax_as_symbol = 0;
3079 DEFVAR_BOOL ("open-paren-in-column-0-is-defun-start",
3080 &open_paren_in_column_0_is_defun_start,
3081 doc: /* *Non-nil means an open paren in column 0 denotes the start of a defun. */);
3082 open_paren_in_column_0_is_defun_start = 1;
3084 defsubr (&Ssyntax_table_p);
3085 defsubr (&Ssyntax_table);
3086 defsubr (&Sstandard_syntax_table);
3087 defsubr (&Scopy_syntax_table);
3088 defsubr (&Sset_syntax_table);
3089 defsubr (&Schar_syntax);
3090 defsubr (&Smatching_paren);
3091 defsubr (&Sstring_to_syntax);
3092 defsubr (&Smodify_syntax_entry);
3093 defsubr (&Sinternal_describe_syntax_value);
3095 defsubr (&Sforward_word);
3097 defsubr (&Sskip_chars_forward);
3098 defsubr (&Sskip_chars_backward);
3099 defsubr (&Sskip_syntax_forward);
3100 defsubr (&Sskip_syntax_backward);
3102 defsubr (&Sforward_comment);
3103 defsubr (&Sscan_lists);
3104 defsubr (&Sscan_sexps);
3105 defsubr (&Sbackward_prefix_chars);
3106 defsubr (&Sparse_partial_sexp);
3109 /* arch-tag: 3e297b9f-088e-4b64-8f4c-fb0b3443e412
3110 (do not change this comment) */