Mention archiving.
[emacs.git] / src / syntax.c
blobf50649e41e909ab930ef9a2bdb6aca353f306901
1 /* GNU Emacs routines to deal with syntax tables; also word and list parsing.
2 Copyright (C) 1985, 1987, 1993, 1994, 1995, 1997, 1998, 1999, 2001,
3 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
23 #include <ctype.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"
37 /* We use these constants in place for comment-style and
38 string-ender-char to distinguish comments/strings started by
39 comment_fence and string_fence codes. */
41 #define ST_COMMENT_STYLE (256 + 1)
42 #define ST_STRING_STYLE (256 + 2)
43 #include "category.h"
45 Lisp_Object Qsyntax_table_p, Qsyntax_table, Qscan_error;
47 int words_include_escapes;
48 int parse_sexp_lookup_properties;
50 /* Nonzero means `scan-sexps' treat all multibyte characters as symbol. */
51 int multibyte_syntax_as_symbol;
53 /* Used as a temporary in SYNTAX_ENTRY and other macros in syntax.h,
54 if not compiled with GCC. No need to mark it, since it is used
55 only very temporarily. */
56 Lisp_Object syntax_temp;
58 /* Non-zero means an open parenthesis in column 0 is always considered
59 to be the start of a defun. Zero means an open parenthesis in
60 column 0 has no special meaning. */
62 int open_paren_in_column_0_is_defun_start;
64 /* This is the internal form of the parse state used in parse-partial-sexp. */
66 struct lisp_parse_state
68 int depth; /* Depth at end of parsing. */
69 int instring; /* -1 if not within string, else desired terminator. */
70 int incomment; /* -1 if in unnestable comment else comment nesting */
71 int comstyle; /* comment style a=0, or b=1, or ST_COMMENT_STYLE. */
72 int quoted; /* Nonzero if just after an escape char at end of parsing */
73 int mindepth; /* Minimum depth seen while scanning. */
74 /* Char number of most recent start-of-expression at current level */
75 EMACS_INT thislevelstart;
76 /* Char number of start of containing expression */
77 EMACS_INT prevlevelstart;
78 EMACS_INT location; /* Char number at which parsing stopped. */
79 EMACS_INT comstr_start; /* Position of last comment/string starter. */
80 Lisp_Object levelstarts; /* Char numbers of starts-of-expression
81 of levels (starting from outermost). */
84 /* These variables are a cache for finding the start of a defun.
85 find_start_pos is the place for which the defun start was found.
86 find_start_value is the defun start position found for it.
87 find_start_value_byte is the corresponding byte position.
88 find_start_buffer is the buffer it was found in.
89 find_start_begv is the BEGV value when it was found.
90 find_start_modiff is the value of MODIFF when it was found. */
92 static EMACS_INT find_start_pos;
93 static EMACS_INT find_start_value;
94 static EMACS_INT find_start_value_byte;
95 static struct buffer *find_start_buffer;
96 static EMACS_INT find_start_begv;
97 static int find_start_modiff;
100 static Lisp_Object skip_chars P_ ((int, Lisp_Object, Lisp_Object, int));
101 static Lisp_Object skip_syntaxes P_ ((int, Lisp_Object, Lisp_Object));
102 static Lisp_Object scan_lists P_ ((EMACS_INT, EMACS_INT, EMACS_INT, int));
103 static void scan_sexps_forward P_ ((struct lisp_parse_state *,
104 EMACS_INT, EMACS_INT, EMACS_INT, int,
105 int, Lisp_Object, int));
106 static int in_classes P_ ((int, Lisp_Object));
109 struct gl_state_s gl_state; /* Global state of syntax parser. */
111 INTERVAL interval_of ();
112 #define INTERVALS_AT_ONCE 10 /* 1 + max-number of intervals
113 to scan to property-change. */
115 /* Update gl_state to an appropriate interval which contains CHARPOS. The
116 sign of COUNT give the relative position of CHARPOS wrt the previously
117 valid interval. If INIT, only [be]_property fields of gl_state are
118 valid at start, the rest is filled basing on OBJECT.
120 `gl_state.*_i' are the intervals, and CHARPOS is further in the search
121 direction than the intervals - or in an interval. We update the
122 current syntax-table basing on the property of this interval, and
123 update the interval to start further than CHARPOS - or be
124 NULL_INTERVAL. We also update lim_property to be the next value of
125 charpos to call this subroutine again - or be before/after the
126 start/end of OBJECT. */
128 void
129 update_syntax_table (charpos, count, init, object)
130 int charpos, count, init;
131 Lisp_Object object;
133 Lisp_Object tmp_table;
134 int cnt = 0, invalidate = 1;
135 INTERVAL i;
137 if (init)
139 gl_state.old_prop = Qnil;
140 gl_state.start = gl_state.b_property;
141 gl_state.stop = gl_state.e_property;
142 i = interval_of (charpos, object);
143 gl_state.backward_i = gl_state.forward_i = i;
144 invalidate = 0;
145 if (NULL_INTERVAL_P (i))
146 return;
147 /* interval_of updates only ->position of the return value, so
148 update the parents manually to speed up update_interval. */
149 while (!NULL_PARENT (i))
151 if (AM_RIGHT_CHILD (i))
152 INTERVAL_PARENT (i)->position = i->position
153 - LEFT_TOTAL_LENGTH (i) + TOTAL_LENGTH (i) /* right end */
154 - TOTAL_LENGTH (INTERVAL_PARENT (i))
155 + LEFT_TOTAL_LENGTH (INTERVAL_PARENT (i));
156 else
157 INTERVAL_PARENT (i)->position = i->position - LEFT_TOTAL_LENGTH (i)
158 + TOTAL_LENGTH (i);
159 i = INTERVAL_PARENT (i);
161 i = gl_state.forward_i;
162 gl_state.b_property = i->position - gl_state.offset;
163 gl_state.e_property = INTERVAL_LAST_POS (i) - gl_state.offset;
164 goto update;
166 i = count > 0 ? gl_state.forward_i : gl_state.backward_i;
168 /* We are guaranteed to be called with CHARPOS either in i,
169 or further off. */
170 if (NULL_INTERVAL_P (i))
171 error ("Error in syntax_table logic for to-the-end intervals");
172 else if (charpos < i->position) /* Move left. */
174 if (count > 0)
175 error ("Error in syntax_table logic for intervals <-");
176 /* Update the interval. */
177 i = update_interval (i, charpos);
178 if (INTERVAL_LAST_POS (i) != gl_state.b_property)
180 invalidate = 0;
181 gl_state.forward_i = i;
182 gl_state.e_property = INTERVAL_LAST_POS (i) - gl_state.offset;
185 else if (charpos >= INTERVAL_LAST_POS (i)) /* Move right. */
187 if (count < 0)
188 error ("Error in syntax_table logic for intervals ->");
189 /* Update the interval. */
190 i = update_interval (i, charpos);
191 if (i->position != gl_state.e_property)
193 invalidate = 0;
194 gl_state.backward_i = i;
195 gl_state.b_property = i->position - gl_state.offset;
199 update:
200 tmp_table = textget (i->plist, Qsyntax_table);
202 if (invalidate)
203 invalidate = !EQ (tmp_table, gl_state.old_prop); /* Need to invalidate? */
205 if (invalidate) /* Did not get to adjacent interval. */
206 { /* with the same table => */
207 /* invalidate the old range. */
208 if (count > 0)
210 gl_state.backward_i = i;
211 gl_state.b_property = i->position - gl_state.offset;
213 else
215 gl_state.forward_i = i;
216 gl_state.e_property = INTERVAL_LAST_POS (i) - gl_state.offset;
220 if (!EQ (tmp_table, gl_state.old_prop))
222 gl_state.current_syntax_table = tmp_table;
223 gl_state.old_prop = tmp_table;
224 if (EQ (Fsyntax_table_p (tmp_table), Qt))
226 gl_state.use_global = 0;
228 else if (CONSP (tmp_table))
230 gl_state.use_global = 1;
231 gl_state.global_code = tmp_table;
233 else
235 gl_state.use_global = 0;
236 gl_state.current_syntax_table = current_buffer->syntax_table;
240 while (!NULL_INTERVAL_P (i))
242 if (cnt && !EQ (tmp_table, textget (i->plist, Qsyntax_table)))
244 if (count > 0)
246 gl_state.e_property = i->position - gl_state.offset;
247 gl_state.forward_i = i;
249 else
251 gl_state.b_property
252 = i->position + LENGTH (i) - gl_state.offset;
253 gl_state.backward_i = i;
255 return;
257 else if (cnt == INTERVALS_AT_ONCE)
259 if (count > 0)
261 gl_state.e_property
262 = i->position + LENGTH (i) - gl_state.offset
263 /* e_property at EOB is not set to ZV but to ZV+1, so that
264 we can do INC(from);UPDATE_SYNTAX_TABLE_FORWARD without
265 having to check eob between the two. */
266 + (NULL_INTERVAL_P (next_interval (i)) ? 1 : 0);
267 gl_state.forward_i = i;
269 else
271 gl_state.b_property = i->position - gl_state.offset;
272 gl_state.backward_i = i;
274 return;
276 cnt++;
277 i = count > 0 ? next_interval (i) : previous_interval (i);
279 eassert (NULL_INTERVAL_P (i)); /* This property goes to the end. */
280 if (count > 0)
281 gl_state.e_property = gl_state.stop;
282 else
283 gl_state.b_property = gl_state.start;
286 /* Returns TRUE if char at CHARPOS is quoted.
287 Global syntax-table data should be set up already to be good at CHARPOS
288 or after. On return global syntax data is good for lookup at CHARPOS. */
290 static int
291 char_quoted (EMACS_INT charpos, EMACS_INT bytepos)
293 register enum syntaxcode code;
294 register EMACS_INT beg = BEGV;
295 register int quoted = 0;
296 EMACS_INT orig = charpos;
298 while (charpos > beg)
300 int c;
301 DEC_BOTH (charpos, bytepos);
303 UPDATE_SYNTAX_TABLE_BACKWARD (charpos);
304 c = FETCH_CHAR_AS_MULTIBYTE (bytepos);
305 code = SYNTAX (c);
306 if (! (code == Scharquote || code == Sescape))
307 break;
309 quoted = !quoted;
312 UPDATE_SYNTAX_TABLE (orig);
313 return quoted;
316 /* Return the bytepos one character after BYTEPOS.
317 We assume that BYTEPOS is not at the end of the buffer. */
319 INLINE EMACS_INT
320 inc_bytepos (bytepos)
321 EMACS_INT bytepos;
323 if (NILP (current_buffer->enable_multibyte_characters))
324 return bytepos + 1;
326 INC_POS (bytepos);
327 return bytepos;
330 /* Return the bytepos one character before BYTEPOS.
331 We assume that BYTEPOS is not at the start of the buffer. */
333 INLINE EMACS_INT
334 dec_bytepos (bytepos)
335 EMACS_INT bytepos;
337 if (NILP (current_buffer->enable_multibyte_characters))
338 return bytepos - 1;
340 DEC_POS (bytepos);
341 return bytepos;
344 /* Return a defun-start position before before POS and not too far before.
345 It should be the last one before POS, or nearly the last.
347 When open_paren_in_column_0_is_defun_start is nonzero,
348 only the beginning of the buffer is treated as a defun-start.
350 We record the information about where the scan started
351 and what its result was, so that another call in the same area
352 can return the same value very quickly.
354 There is no promise at which position the global syntax data is
355 valid on return from the subroutine, so the caller should explicitly
356 update the global data. */
358 static EMACS_INT
359 find_defun_start (pos, pos_byte)
360 EMACS_INT pos, pos_byte;
362 EMACS_INT opoint = PT, opoint_byte = PT_BYTE;
364 if (!open_paren_in_column_0_is_defun_start)
366 find_start_value_byte = BEGV_BYTE;
367 return BEGV;
370 /* Use previous finding, if it's valid and applies to this inquiry. */
371 if (current_buffer == find_start_buffer
372 /* Reuse the defun-start even if POS is a little farther on.
373 POS might be in the next defun, but that's ok.
374 Our value may not be the best possible, but will still be usable. */
375 && pos <= find_start_pos + 1000
376 && pos >= find_start_value
377 && BEGV == find_start_begv
378 && MODIFF == find_start_modiff)
379 return find_start_value;
381 /* Back up to start of line. */
382 scan_newline (pos, pos_byte, BEGV, BEGV_BYTE, -1, 1);
384 /* We optimize syntax-table lookup for rare updates. Thus we accept
385 only those `^\s(' which are good in global _and_ text-property
386 syntax-tables. */
387 gl_state.current_syntax_table = current_buffer->syntax_table;
388 gl_state.use_global = 0;
389 while (PT > BEGV)
391 int c;
393 /* Open-paren at start of line means we may have found our
394 defun-start. */
395 c = FETCH_CHAR_AS_MULTIBYTE (PT_BYTE);
396 if (SYNTAX (c) == Sopen)
398 SETUP_SYNTAX_TABLE (PT + 1, -1); /* Try again... */
399 c = FETCH_CHAR_AS_MULTIBYTE (PT_BYTE);
400 if (SYNTAX (c) == Sopen)
401 break;
402 /* Now fallback to the default value. */
403 gl_state.current_syntax_table = current_buffer->syntax_table;
404 gl_state.use_global = 0;
406 /* Move to beg of previous line. */
407 scan_newline (PT, PT_BYTE, BEGV, BEGV_BYTE, -2, 1);
410 /* Record what we found, for the next try. */
411 find_start_value = PT;
412 find_start_value_byte = PT_BYTE;
413 find_start_buffer = current_buffer;
414 find_start_modiff = MODIFF;
415 find_start_begv = BEGV;
416 find_start_pos = pos;
418 TEMP_SET_PT_BOTH (opoint, opoint_byte);
420 return find_start_value;
423 /* Return the SYNTAX_COMEND_FIRST of the character before POS, POS_BYTE. */
425 static int
426 prev_char_comend_first (pos, pos_byte)
427 int pos, pos_byte;
429 int c, val;
431 DEC_BOTH (pos, pos_byte);
432 UPDATE_SYNTAX_TABLE_BACKWARD (pos);
433 c = FETCH_CHAR (pos_byte);
434 val = SYNTAX_COMEND_FIRST (c);
435 UPDATE_SYNTAX_TABLE_FORWARD (pos + 1);
436 return val;
439 /* Return the SYNTAX_COMSTART_FIRST of the character before POS, POS_BYTE. */
441 /* static int
442 * prev_char_comstart_first (pos, pos_byte)
443 * int pos, pos_byte;
445 * int c, val;
447 * DEC_BOTH (pos, pos_byte);
448 * UPDATE_SYNTAX_TABLE_BACKWARD (pos);
449 * c = FETCH_CHAR (pos_byte);
450 * val = SYNTAX_COMSTART_FIRST (c);
451 * UPDATE_SYNTAX_TABLE_FORWARD (pos + 1);
452 * return val;
453 * } */
455 /* Checks whether charpos FROM is at the end of a comment.
456 FROM_BYTE is the bytepos corresponding to FROM.
457 Do not move back before STOP.
459 Return a positive value if we find a comment ending at FROM/FROM_BYTE;
460 return -1 otherwise.
462 If successful, store the charpos of the comment's beginning
463 into *CHARPOS_PTR, and the bytepos into *BYTEPOS_PTR.
465 Global syntax data remains valid for backward search starting at
466 the returned value (or at FROM, if the search was not successful). */
468 static int
469 back_comment (from, from_byte, stop, comnested, comstyle, charpos_ptr, bytepos_ptr)
470 EMACS_INT from, from_byte, stop;
471 int comnested, comstyle;
472 EMACS_INT *charpos_ptr, *bytepos_ptr;
474 /* Look back, counting the parity of string-quotes,
475 and recording the comment-starters seen.
476 When we reach a safe place, assume that's not in a string;
477 then step the main scan to the earliest comment-starter seen
478 an even number of string quotes away from the safe place.
480 OFROM[I] is position of the earliest comment-starter seen
481 which is I+2X quotes from the comment-end.
482 PARITY is current parity of quotes from the comment end. */
483 int string_style = -1; /* Presumed outside of any string. */
484 int string_lossage = 0;
485 /* Not a real lossage: indicates that we have passed a matching comment
486 starter plus a non-matching comment-ender, meaning that any matching
487 comment-starter we might see later could be a false positive (hidden
488 inside another comment).
489 Test case: { a (* b } c (* d *) */
490 int comment_lossage = 0;
491 EMACS_INT comment_end = from;
492 EMACS_INT comment_end_byte = from_byte;
493 EMACS_INT comstart_pos = 0;
494 EMACS_INT comstart_byte;
495 /* Place where the containing defun starts,
496 or 0 if we didn't come across it yet. */
497 EMACS_INT defun_start = 0;
498 EMACS_INT defun_start_byte = 0;
499 register enum syntaxcode code;
500 int nesting = 1; /* current comment nesting */
501 int c;
502 int syntax = 0;
504 /* FIXME: A }} comment-ender style leads to incorrect behavior
505 in the case of {{ c }}} because we ignore the last two chars which are
506 assumed to be comment-enders although they aren't. */
508 /* At beginning of range to scan, we're outside of strings;
509 that determines quote parity to the comment-end. */
510 while (from != stop)
512 int temp_byte, prev_syntax;
513 int com2start, com2end;
515 /* Move back and examine a character. */
516 DEC_BOTH (from, from_byte);
517 UPDATE_SYNTAX_TABLE_BACKWARD (from);
519 prev_syntax = syntax;
520 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
521 syntax = SYNTAX_WITH_FLAGS (c);
522 code = SYNTAX (c);
524 /* Check for 2-char comment markers. */
525 com2start = (SYNTAX_FLAGS_COMSTART_FIRST (syntax)
526 && SYNTAX_FLAGS_COMSTART_SECOND (prev_syntax)
527 && comstyle == SYNTAX_FLAGS_COMMENT_STYLE (prev_syntax)
528 && (SYNTAX_FLAGS_COMMENT_NESTED (prev_syntax)
529 || SYNTAX_FLAGS_COMMENT_NESTED (syntax)) == comnested);
530 com2end = (SYNTAX_FLAGS_COMEND_FIRST (syntax)
531 && SYNTAX_FLAGS_COMEND_SECOND (prev_syntax));
533 /* Nasty cases with overlapping 2-char comment markers:
534 - snmp-mode: -- c -- foo -- c --
535 --- c --
536 ------ c --
537 - c-mode: *||*
538 |* *|* *|
539 |*| |* |*|
540 /// */
542 /* If a 2-char comment sequence partly overlaps with another,
543 we don't try to be clever. */
544 if (from > stop && (com2end || com2start))
546 int next = from, next_byte = from_byte, next_c, next_syntax;
547 DEC_BOTH (next, next_byte);
548 UPDATE_SYNTAX_TABLE_BACKWARD (next);
549 next_c = FETCH_CHAR_AS_MULTIBYTE (next_byte);
550 next_syntax = SYNTAX_WITH_FLAGS (next_c);
551 if (((com2start || comnested)
552 && SYNTAX_FLAGS_COMEND_SECOND (syntax)
553 && SYNTAX_FLAGS_COMEND_FIRST (next_syntax))
554 || ((com2end || comnested)
555 && SYNTAX_FLAGS_COMSTART_SECOND (syntax)
556 && comstyle == SYNTAX_FLAGS_COMMENT_STYLE (syntax)
557 && SYNTAX_FLAGS_COMSTART_FIRST (next_syntax)))
558 goto lossage;
559 /* UPDATE_SYNTAX_TABLE_FORWARD (next + 1); */
562 if (com2start && comstart_pos == 0)
563 /* We're looking at a comment starter. But it might be a comment
564 ender as well (see snmp-mode). The first time we see one, we
565 need to consider it as a comment starter,
566 and the subsequent times as a comment ender. */
567 com2end = 0;
569 /* Turn a 2-char comment sequences into the appropriate syntax. */
570 if (com2end)
571 code = Sendcomment;
572 else if (com2start)
573 code = Scomment;
574 /* Ignore comment starters of a different style. */
575 else if (code == Scomment
576 && (comstyle != SYNTAX_FLAGS_COMMENT_STYLE (syntax)
577 || SYNTAX_FLAGS_COMMENT_NESTED (syntax) != comnested))
578 continue;
580 /* Ignore escaped characters, except comment-enders. */
581 if (code != Sendcomment && char_quoted (from, from_byte))
582 continue;
584 switch (code)
586 case Sstring_fence:
587 case Scomment_fence:
588 c = (code == Sstring_fence ? ST_STRING_STYLE : ST_COMMENT_STYLE);
589 case Sstring:
590 /* Track parity of quotes. */
591 if (string_style == -1)
592 /* Entering a string. */
593 string_style = c;
594 else if (string_style == c)
595 /* Leaving the string. */
596 string_style = -1;
597 else
598 /* If we have two kinds of string delimiters.
599 There's no way to grok this scanning backwards. */
600 string_lossage = 1;
601 break;
603 case Scomment:
604 /* We've already checked that it is the relevant comstyle. */
605 if (string_style != -1 || comment_lossage || string_lossage)
606 /* There are odd string quotes involved, so let's be careful.
607 Test case in Pascal: " { " a { " } */
608 goto lossage;
610 if (!comnested)
612 /* Record best comment-starter so far. */
613 comstart_pos = from;
614 comstart_byte = from_byte;
616 else if (--nesting <= 0)
617 /* nested comments have to be balanced, so we don't need to
618 keep looking for earlier ones. We use here the same (slightly
619 incorrect) reasoning as below: since it is followed by uniform
620 paired string quotes, this comment-start has to be outside of
621 strings, else the comment-end itself would be inside a string. */
622 goto done;
623 break;
625 case Sendcomment:
626 if (SYNTAX_FLAGS_COMMENT_STYLE (syntax) == comstyle
627 && ((com2end && SYNTAX_FLAGS_COMMENT_NESTED (prev_syntax))
628 || SYNTAX_FLAGS_COMMENT_NESTED (syntax)) == comnested)
629 /* This is the same style of comment ender as ours. */
631 if (comnested)
632 nesting++;
633 else
634 /* Anything before that can't count because it would match
635 this comment-ender rather than ours. */
636 from = stop; /* Break out of the loop. */
638 else if (comstart_pos != 0 || c != '\n')
639 /* We're mixing comment styles here, so we'd better be careful.
640 The (comstart_pos != 0 || c != '\n') check is not quite correct
641 (we should just always set comment_lossage), but removing it
642 would imply that any multiline comment in C would go through
643 lossage, which seems overkill.
644 The failure should only happen in the rare cases such as
645 { (* } *) */
646 comment_lossage = 1;
647 break;
649 case Sopen:
650 /* Assume a defun-start point is outside of strings. */
651 if (open_paren_in_column_0_is_defun_start
652 && (from == stop
653 || (temp_byte = dec_bytepos (from_byte),
654 FETCH_CHAR (temp_byte) == '\n')))
656 defun_start = from;
657 defun_start_byte = from_byte;
658 from = stop; /* Break out of the loop. */
660 break;
662 default:
663 break;
667 if (comstart_pos == 0)
669 from = comment_end;
670 from_byte = comment_end_byte;
671 UPDATE_SYNTAX_TABLE_FORWARD (comment_end - 1);
673 /* If comstart_pos is set and we get here (ie. didn't jump to `lossage'
674 or `done'), then we've found the beginning of the non-nested comment. */
675 else if (1) /* !comnested */
677 from = comstart_pos;
678 from_byte = comstart_byte;
679 UPDATE_SYNTAX_TABLE_FORWARD (from - 1);
681 else
683 struct lisp_parse_state state;
684 lossage:
685 /* We had two kinds of string delimiters mixed up
686 together. Decode this going forwards.
687 Scan fwd from a known safe place (beginning-of-defun)
688 to the one in question; this records where we
689 last passed a comment starter. */
690 /* If we did not already find the defun start, find it now. */
691 if (defun_start == 0)
693 defun_start = find_defun_start (comment_end, comment_end_byte);
694 defun_start_byte = find_start_value_byte;
698 scan_sexps_forward (&state,
699 defun_start, defun_start_byte,
700 comment_end, -10000, 0, Qnil, 0);
701 defun_start = comment_end;
702 if (state.incomment == (comnested ? 1 : -1)
703 && state.comstyle == comstyle)
704 from = state.comstr_start;
705 else
707 from = comment_end;
708 if (state.incomment)
709 /* If comment_end is inside some other comment, maybe ours
710 is nested, so we need to try again from within the
711 surrounding comment. Example: { a (* " *) */
713 /* FIXME: We should advance by one or two chars. */
714 defun_start = state.comstr_start + 2;
715 defun_start_byte = CHAR_TO_BYTE (defun_start);
718 } while (defun_start < comment_end);
720 from_byte = CHAR_TO_BYTE (from);
721 UPDATE_SYNTAX_TABLE_FORWARD (from - 1);
724 done:
725 *charpos_ptr = from;
726 *bytepos_ptr = from_byte;
728 return (from == comment_end) ? -1 : from;
731 DEFUN ("syntax-table-p", Fsyntax_table_p, Ssyntax_table_p, 1, 1, 0,
732 doc: /* Return t if OBJECT is a syntax table.
733 Currently, any char-table counts as a syntax table. */)
734 (object)
735 Lisp_Object object;
737 if (CHAR_TABLE_P (object)
738 && EQ (XCHAR_TABLE (object)->purpose, Qsyntax_table))
739 return Qt;
740 return Qnil;
743 static void
744 check_syntax_table (obj)
745 Lisp_Object obj;
747 CHECK_TYPE (CHAR_TABLE_P (obj) && EQ (XCHAR_TABLE (obj)->purpose, Qsyntax_table),
748 Qsyntax_table_p, obj);
751 DEFUN ("syntax-table", Fsyntax_table, Ssyntax_table, 0, 0, 0,
752 doc: /* Return the current syntax table.
753 This is the one specified by the current buffer. */)
756 return current_buffer->syntax_table;
759 DEFUN ("standard-syntax-table", Fstandard_syntax_table,
760 Sstandard_syntax_table, 0, 0, 0,
761 doc: /* Return the standard syntax table.
762 This is the one used for new buffers. */)
765 return Vstandard_syntax_table;
768 DEFUN ("copy-syntax-table", Fcopy_syntax_table, Scopy_syntax_table, 0, 1, 0,
769 doc: /* Construct a new syntax table and return it.
770 It is a copy of the TABLE, which defaults to the standard syntax table. */)
771 (table)
772 Lisp_Object table;
774 Lisp_Object copy;
776 if (!NILP (table))
777 check_syntax_table (table);
778 else
779 table = Vstandard_syntax_table;
781 copy = Fcopy_sequence (table);
783 /* Only the standard syntax table should have a default element.
784 Other syntax tables should inherit from parents instead. */
785 XCHAR_TABLE (copy)->defalt = Qnil;
787 /* Copied syntax tables should all have parents.
788 If we copied one with no parent, such as the standard syntax table,
789 use the standard syntax table as the copy's parent. */
790 if (NILP (XCHAR_TABLE (copy)->parent))
791 Fset_char_table_parent (copy, Vstandard_syntax_table);
792 return copy;
795 DEFUN ("set-syntax-table", Fset_syntax_table, Sset_syntax_table, 1, 1, 0,
796 doc: /* Select a new syntax table for the current buffer.
797 One argument, a syntax table. */)
798 (table)
799 Lisp_Object table;
801 int idx;
802 check_syntax_table (table);
803 current_buffer->syntax_table = table;
804 /* Indicate that this buffer now has a specified syntax table. */
805 idx = PER_BUFFER_VAR_IDX (syntax_table);
806 SET_PER_BUFFER_VALUE_P (current_buffer, idx, 1);
807 return table;
810 /* Convert a letter which signifies a syntax code
811 into the code it signifies.
812 This is used by modify-syntax-entry, and other things. */
814 unsigned char syntax_spec_code[0400] =
815 { 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
816 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
817 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
818 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
819 (char) Swhitespace, (char) Scomment_fence, (char) Sstring, 0377,
820 (char) Smath, 0377, 0377, (char) Squote,
821 (char) Sopen, (char) Sclose, 0377, 0377,
822 0377, (char) Swhitespace, (char) Spunct, (char) Scharquote,
823 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
824 0377, 0377, 0377, 0377,
825 (char) Scomment, 0377, (char) Sendcomment, 0377,
826 (char) Sinherit, 0377, 0377, 0377, 0377, 0377, 0377, 0377, /* @, A ... */
827 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
828 0377, 0377, 0377, 0377, 0377, 0377, 0377, (char) Sword,
829 0377, 0377, 0377, 0377, (char) Sescape, 0377, 0377, (char) Ssymbol,
830 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377, /* `, a, ... */
831 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
832 0377, 0377, 0377, 0377, 0377, 0377, 0377, (char) Sword,
833 0377, 0377, 0377, 0377, (char) Sstring_fence, 0377, 0377, 0377
836 /* Indexed by syntax code, give the letter that describes it. */
838 char syntax_code_spec[16] =
840 ' ', '.', 'w', '_', '(', ')', '\'', '\"', '$', '\\', '/', '<', '>', '@',
841 '!', '|'
844 /* Indexed by syntax code, give the object (cons of syntax code and
845 nil) to be stored in syntax table. Since these objects can be
846 shared among syntax tables, we generate them in advance. By
847 sharing objects, the function `describe-syntax' can give a more
848 compact listing. */
849 static Lisp_Object Vsyntax_code_object;
852 DEFUN ("char-syntax", Fchar_syntax, Schar_syntax, 1, 1, 0,
853 doc: /* Return the syntax code of CHARACTER, described by a character.
854 For example, if CHARACTER is a word constituent,
855 the character `w' is returned.
856 The characters that correspond to various syntax codes
857 are listed in the documentation of `modify-syntax-entry'. */)
858 (character)
859 Lisp_Object character;
861 int char_int;
862 gl_state.current_syntax_table = current_buffer->syntax_table;
864 gl_state.use_global = 0;
865 CHECK_NUMBER (character);
866 char_int = XINT (character);
867 return make_number (syntax_code_spec[(int) SYNTAX (char_int)]);
870 DEFUN ("matching-paren", Fmatching_paren, Smatching_paren, 1, 1, 0,
871 doc: /* Return the matching parenthesis of CHARACTER, or nil if none. */)
872 (character)
873 Lisp_Object character;
875 int char_int, code;
876 gl_state.current_syntax_table = current_buffer->syntax_table;
877 gl_state.use_global = 0;
878 CHECK_NUMBER (character);
879 char_int = XINT (character);
880 code = SYNTAX (char_int);
881 if (code == Sopen || code == Sclose)
882 return SYNTAX_MATCH (char_int);
883 return Qnil;
886 DEFUN ("string-to-syntax", Fstring_to_syntax, Sstring_to_syntax, 1, 1, 0,
887 doc: /* Convert a syntax specification STRING into syntax cell form.
888 STRING should be a string as it is allowed as argument of
889 `modify-syntax-entry'. Value is the equivalent cons cell
890 \(CODE . MATCHING-CHAR) that can be used as value of a `syntax-table'
891 text property. */)
892 (string)
893 Lisp_Object string;
895 register const unsigned char *p;
896 register enum syntaxcode code;
897 int val;
898 Lisp_Object match;
900 CHECK_STRING (string);
902 p = SDATA (string);
903 code = (enum syntaxcode) syntax_spec_code[*p++];
904 if (((int) code & 0377) == 0377)
905 error ("Invalid syntax description letter: %c", p[-1]);
907 if (code == Sinherit)
908 return Qnil;
910 if (*p)
912 int len;
913 int character = (STRING_CHAR_AND_LENGTH
914 (p, SBYTES (string) - 1, len));
915 XSETINT (match, character);
916 if (XFASTINT (match) == ' ')
917 match = Qnil;
918 p += len;
920 else
921 match = Qnil;
923 val = (int) code;
924 while (*p)
925 switch (*p++)
927 case '1':
928 val |= 1 << 16;
929 break;
931 case '2':
932 val |= 1 << 17;
933 break;
935 case '3':
936 val |= 1 << 18;
937 break;
939 case '4':
940 val |= 1 << 19;
941 break;
943 case 'p':
944 val |= 1 << 20;
945 break;
947 case 'b':
948 val |= 1 << 21;
949 break;
951 case 'n':
952 val |= 1 << 22;
953 break;
956 if (val < XVECTOR (Vsyntax_code_object)->size && NILP (match))
957 return XVECTOR (Vsyntax_code_object)->contents[val];
958 else
959 /* Since we can't use a shared object, let's make a new one. */
960 return Fcons (make_number (val), match);
963 /* I really don't know why this is interactive
964 help-form should at least be made useful whilst reading the second arg. */
965 DEFUN ("modify-syntax-entry", Fmodify_syntax_entry, Smodify_syntax_entry, 2, 3,
966 "cSet syntax for character: \nsSet syntax for %s to: ",
967 doc: /* Set syntax for character CHAR according to string NEWENTRY.
968 The syntax is changed only for table SYNTAX-TABLE, which defaults to
969 the current buffer's syntax table.
970 CHAR may be a cons (MIN . MAX), in which case, syntaxes of all characters
971 in the range MIN to MAX are changed.
972 The first character of NEWENTRY should be one of the following:
973 Space or - whitespace syntax. w word constituent.
974 _ symbol constituent. . punctuation.
975 ( open-parenthesis. ) close-parenthesis.
976 " string quote. \\ escape.
977 $ paired delimiter. ' expression quote or prefix operator.
978 < comment starter. > comment ender.
979 / character-quote. @ inherit from `standard-syntax-table'.
980 | generic string fence. ! generic comment fence.
982 Only single-character comment start and end sequences are represented thus.
983 Two-character sequences are represented as described below.
984 The second character of NEWENTRY is the matching parenthesis,
985 used only if the first character is `(' or `)'.
986 Any additional characters are flags.
987 Defined flags are the characters 1, 2, 3, 4, b, p, and n.
988 1 means CHAR is the start of a two-char comment start sequence.
989 2 means CHAR is the second character of such a sequence.
990 3 means CHAR is the start of a two-char comment end sequence.
991 4 means CHAR is the second character of such a sequence.
993 There can be up to two orthogonal comment sequences. This is to support
994 language modes such as C++. By default, all comment sequences are of style
995 a, but you can set the comment sequence style to b (on the second character
996 of a comment-start, or the first character of a comment-end sequence) using
997 this flag:
998 b means CHAR is part of comment sequence b.
999 n means CHAR is part of a nestable comment sequence.
1001 p means CHAR is a prefix character for `backward-prefix-chars';
1002 such characters are treated as whitespace when they occur
1003 between expressions.
1004 usage: (modify-syntax-entry CHAR NEWENTRY &optional SYNTAX-TABLE) */)
1005 (c, newentry, syntax_table)
1006 Lisp_Object c, newentry, syntax_table;
1008 if (CONSP (c))
1010 CHECK_CHARACTER_CAR (c);
1011 CHECK_CHARACTER_CDR (c);
1013 else
1014 CHECK_CHARACTER (c);
1016 if (NILP (syntax_table))
1017 syntax_table = current_buffer->syntax_table;
1018 else
1019 check_syntax_table (syntax_table);
1021 newentry = Fstring_to_syntax (newentry);
1022 if (CONSP (c))
1023 SET_RAW_SYNTAX_ENTRY_RANGE (syntax_table, c, newentry);
1024 else
1025 SET_RAW_SYNTAX_ENTRY (syntax_table, XINT (c), newentry);
1027 /* We clear the regexp cache, since character classes can now have
1028 different values from those in the compiled regexps.*/
1029 clear_regexp_cache ();
1031 return Qnil;
1034 /* Dump syntax table to buffer in human-readable format */
1036 DEFUN ("internal-describe-syntax-value", Finternal_describe_syntax_value,
1037 Sinternal_describe_syntax_value, 1, 1, 0,
1038 doc: /* Insert a description of the internal syntax description SYNTAX at point. */)
1039 (syntax)
1040 Lisp_Object syntax;
1042 register enum syntaxcode code;
1043 char desc, start1, start2, end1, end2, prefix, comstyle, comnested;
1044 char str[2];
1045 Lisp_Object first, match_lisp, value = syntax;
1047 if (NILP (value))
1049 insert_string ("default");
1050 return syntax;
1053 if (CHAR_TABLE_P (value))
1055 insert_string ("deeper char-table ...");
1056 return syntax;
1059 if (!CONSP (value))
1061 insert_string ("invalid");
1062 return syntax;
1065 first = XCAR (value);
1066 match_lisp = XCDR (value);
1068 if (!INTEGERP (first) || !(NILP (match_lisp) || INTEGERP (match_lisp)))
1070 insert_string ("invalid");
1071 return syntax;
1074 code = (enum syntaxcode) (XINT (first) & 0377);
1075 start1 = (XINT (first) >> 16) & 1;
1076 start2 = (XINT (first) >> 17) & 1;
1077 end1 = (XINT (first) >> 18) & 1;
1078 end2 = (XINT (first) >> 19) & 1;
1079 prefix = (XINT (first) >> 20) & 1;
1080 comstyle = (XINT (first) >> 21) & 1;
1081 comnested = (XINT (first) >> 22) & 1;
1083 if ((int) code < 0 || (int) code >= (int) Smax)
1085 insert_string ("invalid");
1086 return syntax;
1088 desc = syntax_code_spec[(int) code];
1090 str[0] = desc, str[1] = 0;
1091 insert (str, 1);
1093 if (NILP (match_lisp))
1094 insert (" ", 1);
1095 else
1096 insert_char (XINT (match_lisp));
1098 if (start1)
1099 insert ("1", 1);
1100 if (start2)
1101 insert ("2", 1);
1103 if (end1)
1104 insert ("3", 1);
1105 if (end2)
1106 insert ("4", 1);
1108 if (prefix)
1109 insert ("p", 1);
1110 if (comstyle)
1111 insert ("b", 1);
1112 if (comnested)
1113 insert ("n", 1);
1115 insert_string ("\twhich means: ");
1117 switch (SWITCH_ENUM_CAST (code))
1119 case Swhitespace:
1120 insert_string ("whitespace"); break;
1121 case Spunct:
1122 insert_string ("punctuation"); break;
1123 case Sword:
1124 insert_string ("word"); break;
1125 case Ssymbol:
1126 insert_string ("symbol"); break;
1127 case Sopen:
1128 insert_string ("open"); break;
1129 case Sclose:
1130 insert_string ("close"); break;
1131 case Squote:
1132 insert_string ("prefix"); break;
1133 case Sstring:
1134 insert_string ("string"); break;
1135 case Smath:
1136 insert_string ("math"); break;
1137 case Sescape:
1138 insert_string ("escape"); break;
1139 case Scharquote:
1140 insert_string ("charquote"); break;
1141 case Scomment:
1142 insert_string ("comment"); break;
1143 case Sendcomment:
1144 insert_string ("endcomment"); break;
1145 case Sinherit:
1146 insert_string ("inherit"); break;
1147 case Scomment_fence:
1148 insert_string ("comment fence"); break;
1149 case Sstring_fence:
1150 insert_string ("string fence"); break;
1151 default:
1152 insert_string ("invalid");
1153 return syntax;
1156 if (!NILP (match_lisp))
1158 insert_string (", matches ");
1159 insert_char (XINT (match_lisp));
1162 if (start1)
1163 insert_string (",\n\t is the first character of a comment-start sequence");
1164 if (start2)
1165 insert_string (",\n\t is the second character of a comment-start sequence");
1167 if (end1)
1168 insert_string (",\n\t is the first character of a comment-end sequence");
1169 if (end2)
1170 insert_string (",\n\t is the second character of a comment-end sequence");
1171 if (comstyle)
1172 insert_string (" (comment style b)");
1173 if (comnested)
1174 insert_string (" (nestable)");
1176 if (prefix)
1177 insert_string (",\n\t is a prefix character for `backward-prefix-chars'");
1179 return syntax;
1182 int parse_sexp_ignore_comments;
1184 /* Char-table of functions that find the next or previous word
1185 boundary. */
1186 Lisp_Object Vfind_word_boundary_function_table;
1188 /* Return the position across COUNT words from FROM.
1189 If that many words cannot be found before the end of the buffer, return 0.
1190 COUNT negative means scan backward and stop at word beginning. */
1193 scan_words (from, count)
1194 register int from, count;
1196 register int beg = BEGV;
1197 register int end = ZV;
1198 register int from_byte = CHAR_TO_BYTE (from);
1199 register enum syntaxcode code;
1200 int ch0, ch1;
1201 Lisp_Object func, script, pos;
1203 immediate_quit = 1;
1204 QUIT;
1206 SETUP_SYNTAX_TABLE (from, count);
1208 while (count > 0)
1210 while (1)
1212 if (from == end)
1214 immediate_quit = 0;
1215 return 0;
1217 UPDATE_SYNTAX_TABLE_FORWARD (from);
1218 ch0 = FETCH_CHAR_AS_MULTIBYTE (from_byte);
1219 code = SYNTAX (ch0);
1220 INC_BOTH (from, from_byte);
1221 if (words_include_escapes
1222 && (code == Sescape || code == Scharquote))
1223 break;
1224 if (code == Sword)
1225 break;
1227 /* Now CH0 is a character which begins a word and FROM is the
1228 position of the next character. */
1229 func = CHAR_TABLE_REF (Vfind_word_boundary_function_table, ch0);
1230 if (! NILP (Ffboundp (func)))
1232 pos = call2 (func, make_number (from - 1), make_number (end));
1233 if (INTEGERP (pos) && XINT (pos) > from)
1235 from = XINT (pos);
1236 from_byte = CHAR_TO_BYTE (from);
1239 else
1241 script = CHAR_TABLE_REF (Vchar_script_table, ch0);
1242 while (1)
1244 if (from == end) break;
1245 UPDATE_SYNTAX_TABLE_FORWARD (from);
1246 ch1 = FETCH_CHAR_AS_MULTIBYTE (from_byte);
1247 code = SYNTAX (ch1);
1248 if ((code != Sword
1249 && (! words_include_escapes
1250 || (code != Sescape && code != Scharquote)))
1251 || word_boundary_p (ch0, ch1))
1252 break;
1253 INC_BOTH (from, from_byte);
1254 ch0 = ch1;
1257 count--;
1259 while (count < 0)
1261 while (1)
1263 if (from == beg)
1265 immediate_quit = 0;
1266 return 0;
1268 DEC_BOTH (from, from_byte);
1269 UPDATE_SYNTAX_TABLE_BACKWARD (from);
1270 ch1 = FETCH_CHAR_AS_MULTIBYTE (from_byte);
1271 code = SYNTAX (ch1);
1272 if (words_include_escapes
1273 && (code == Sescape || code == Scharquote))
1274 break;
1275 if (code == Sword)
1276 break;
1278 /* Now CH1 is a character which ends a word and FROM is the
1279 position of it. */
1280 func = CHAR_TABLE_REF (Vfind_word_boundary_function_table, ch1);
1281 if (! NILP (Ffboundp (func)))
1283 pos = call2 (func, make_number (from), make_number (beg));
1284 if (INTEGERP (pos) && XINT (pos) < from)
1286 from = XINT (pos);
1287 from_byte = CHAR_TO_BYTE (from);
1290 else
1292 script = CHAR_TABLE_REF (Vchar_script_table, ch1);
1293 while (1)
1295 if (from == beg)
1296 break;
1297 DEC_BOTH (from, from_byte);
1298 UPDATE_SYNTAX_TABLE_BACKWARD (from);
1299 ch0 = FETCH_CHAR_AS_MULTIBYTE (from_byte);
1300 code = SYNTAX (ch0);
1301 if ((code != Sword
1302 && (! words_include_escapes
1303 || (code != Sescape && code != Scharquote)))
1304 || word_boundary_p (ch0, ch1))
1306 INC_BOTH (from, from_byte);
1307 break;
1309 ch1 = ch0;
1312 count++;
1315 immediate_quit = 0;
1317 return from;
1320 DEFUN ("forward-word", Fforward_word, Sforward_word, 0, 1, "^p",
1321 doc: /* Move point forward ARG words (backward if ARG is negative).
1322 Normally returns t.
1323 If an edge of the buffer or a field boundary is reached, point is left there
1324 and the function returns nil. Field boundaries are not noticed if
1325 `inhibit-field-text-motion' is non-nil. */)
1326 (arg)
1327 Lisp_Object arg;
1329 Lisp_Object tmp;
1330 int orig_val, val;
1332 if (NILP (arg))
1333 XSETFASTINT (arg, 1);
1334 else
1335 CHECK_NUMBER (arg);
1337 val = orig_val = scan_words (PT, XINT (arg));
1338 if (! orig_val)
1339 val = XINT (arg) > 0 ? ZV : BEGV;
1341 /* Avoid jumping out of an input field. */
1342 tmp = Fconstrain_to_field (make_number (val), make_number (PT),
1343 Qt, Qnil, Qnil);
1344 val = XFASTINT (tmp);
1346 SET_PT (val);
1347 return val == orig_val ? Qt : Qnil;
1350 Lisp_Object skip_chars ();
1352 DEFUN ("skip-chars-forward", Fskip_chars_forward, Sskip_chars_forward, 1, 2, 0,
1353 doc: /* Move point forward, stopping before a char not in STRING, or at pos LIM.
1354 STRING is like the inside of a `[...]' in a regular expression
1355 except that `]' is never special and `\\' quotes `^', `-' or `\\'
1356 (but not as the end of a range; quoting is never needed there).
1357 Thus, with arg "a-zA-Z", this skips letters stopping before first nonletter.
1358 With arg "^a-zA-Z", skips nonletters stopping before first letter.
1359 Char classes, e.g. `[:alpha:]', are supported.
1361 Returns the distance traveled, either zero or positive. */)
1362 (string, lim)
1363 Lisp_Object string, lim;
1365 return skip_chars (1, string, lim, 1);
1368 DEFUN ("skip-chars-backward", Fskip_chars_backward, Sskip_chars_backward, 1, 2, 0,
1369 doc: /* Move point backward, stopping after a char not in STRING, or at pos LIM.
1370 See `skip-chars-forward' for details.
1371 Returns the distance traveled, either zero or negative. */)
1372 (string, lim)
1373 Lisp_Object string, lim;
1375 return skip_chars (0, string, lim, 1);
1378 DEFUN ("skip-syntax-forward", Fskip_syntax_forward, Sskip_syntax_forward, 1, 2, 0,
1379 doc: /* Move point forward across chars in specified syntax classes.
1380 SYNTAX is a string of syntax code characters.
1381 Stop before a char whose syntax is not in SYNTAX, or at position LIM.
1382 If SYNTAX starts with ^, skip characters whose syntax is NOT in SYNTAX.
1383 This function returns the distance traveled, either zero or positive. */)
1384 (syntax, lim)
1385 Lisp_Object syntax, lim;
1387 return skip_syntaxes (1, syntax, lim);
1390 DEFUN ("skip-syntax-backward", Fskip_syntax_backward, Sskip_syntax_backward, 1, 2, 0,
1391 doc: /* Move point backward across chars in specified syntax classes.
1392 SYNTAX is a string of syntax code characters.
1393 Stop on reaching a char whose syntax is not in SYNTAX, or at position LIM.
1394 If SYNTAX starts with ^, skip characters whose syntax is NOT in SYNTAX.
1395 This function returns the distance traveled, either zero or negative. */)
1396 (syntax, lim)
1397 Lisp_Object syntax, lim;
1399 return skip_syntaxes (0, syntax, lim);
1402 static Lisp_Object
1403 skip_chars (forwardp, string, lim, handle_iso_classes)
1404 int forwardp;
1405 Lisp_Object string, lim;
1406 int handle_iso_classes;
1408 register unsigned int c;
1409 unsigned char fastmap[0400];
1410 /* Store the ranges of non-ASCII characters. */
1411 int *char_ranges;
1412 int n_char_ranges = 0;
1413 int negate = 0;
1414 register int i, i_byte;
1415 /* Set to 1 if the current buffer is multibyte and the region
1416 contains non-ASCII chars. */
1417 int multibyte;
1418 /* Set to 1 if STRING is multibyte and it contains non-ASCII
1419 chars. */
1420 int string_multibyte;
1421 int size_byte;
1422 const unsigned char *str;
1423 int len;
1424 Lisp_Object iso_classes;
1426 CHECK_STRING (string);
1427 iso_classes = Qnil;
1429 if (NILP (lim))
1430 XSETINT (lim, forwardp ? ZV : BEGV);
1431 else
1432 CHECK_NUMBER_COERCE_MARKER (lim);
1434 /* In any case, don't allow scan outside bounds of buffer. */
1435 if (XINT (lim) > ZV)
1436 XSETFASTINT (lim, ZV);
1437 if (XINT (lim) < BEGV)
1438 XSETFASTINT (lim, BEGV);
1440 multibyte = (!NILP (current_buffer->enable_multibyte_characters)
1441 && (XINT (lim) - PT != CHAR_TO_BYTE (XINT (lim)) - PT_BYTE));
1442 string_multibyte = SBYTES (string) > SCHARS (string);
1444 bzero (fastmap, sizeof fastmap);
1446 str = SDATA (string);
1447 size_byte = SBYTES (string);
1449 i_byte = 0;
1450 if (i_byte < size_byte
1451 && SREF (string, 0) == '^')
1453 negate = 1; i_byte++;
1456 /* Find the characters specified and set their elements of fastmap.
1457 Handle backslashes and ranges specially.
1459 If STRING contains non-ASCII characters, setup char_ranges for
1460 them and use fastmap only for their leading codes. */
1462 if (! string_multibyte)
1464 int string_has_eight_bit = 0;
1466 /* At first setup fastmap. */
1467 while (i_byte < size_byte)
1469 c = str[i_byte++];
1471 if (handle_iso_classes && c == '['
1472 && i_byte < size_byte
1473 && str[i_byte] == ':')
1475 const unsigned char *class_beg = str + i_byte + 1;
1476 const unsigned char *class_end = class_beg;
1477 const unsigned char *class_limit = str + size_byte - 2;
1478 /* Leave room for the null. */
1479 unsigned char class_name[CHAR_CLASS_MAX_LENGTH + 1];
1480 re_wctype_t cc;
1482 if (class_limit - class_beg > CHAR_CLASS_MAX_LENGTH)
1483 class_limit = class_beg + CHAR_CLASS_MAX_LENGTH;
1485 while (class_end < class_limit
1486 && *class_end >= 'a' && *class_end <= 'z')
1487 class_end++;
1489 if (class_end == class_beg
1490 || *class_end != ':' || class_end[1] != ']')
1491 goto not_a_class_name;
1493 bcopy (class_beg, class_name, class_end - class_beg);
1494 class_name[class_end - class_beg] = 0;
1496 cc = re_wctype (class_name);
1497 if (cc == 0)
1498 error ("Invalid ISO C character class");
1500 iso_classes = Fcons (make_number (cc), iso_classes);
1502 i_byte = class_end + 2 - str;
1503 continue;
1506 not_a_class_name:
1507 if (c == '\\')
1509 if (i_byte == size_byte)
1510 break;
1512 c = str[i_byte++];
1514 /* Treat `-' as range character only if another character
1515 follows. */
1516 if (i_byte + 1 < size_byte
1517 && str[i_byte] == '-')
1519 unsigned int c2;
1521 /* Skip over the dash. */
1522 i_byte++;
1524 /* Get the end of the range. */
1525 c2 = str[i_byte++];
1526 if (c2 == '\\'
1527 && i_byte < size_byte)
1528 c2 = str[i_byte++];
1530 if (c <= c2)
1532 while (c <= c2)
1533 fastmap[c++] = 1;
1534 if (! ASCII_CHAR_P (c2))
1535 string_has_eight_bit = 1;
1538 else
1540 fastmap[c] = 1;
1541 if (! ASCII_CHAR_P (c))
1542 string_has_eight_bit = 1;
1546 /* If the current range is multibyte and STRING contains
1547 eight-bit chars, arrange fastmap and setup char_ranges for
1548 the corresponding multibyte chars. */
1549 if (multibyte && string_has_eight_bit)
1551 unsigned char fastmap2[0400];
1552 int range_start_byte, range_start_char;
1554 bcopy (fastmap2 + 0200, fastmap + 0200, 0200);
1555 bzero (fastmap + 0200, 0200);
1556 /* We are sure that this loop stops. */
1557 for (i = 0200; ! fastmap2[i]; i++);
1558 c = unibyte_char_to_multibyte (i);
1559 fastmap[CHAR_LEADING_CODE (c)] = 1;
1560 range_start_byte = i;
1561 range_start_char = c;
1562 char_ranges = (int *) alloca (sizeof (int) * 128 * 2);
1563 for (i = 129; i < 0400; i++)
1565 c = unibyte_char_to_multibyte (i);
1566 fastmap[CHAR_LEADING_CODE (c)] = 1;
1567 if (i - range_start_byte != c - range_start_char)
1569 char_ranges[n_char_ranges++] = range_start_char;
1570 char_ranges[n_char_ranges++] = ((i - 1 - range_start_byte)
1571 + range_start_char);
1572 range_start_byte = i;
1573 range_start_char = c;
1576 char_ranges[n_char_ranges++] = range_start_char;
1577 char_ranges[n_char_ranges++] = ((i - 1 - range_start_byte)
1578 + range_start_char);
1581 else /* STRING is multibyte */
1583 char_ranges = (int *) alloca (sizeof (int) * SCHARS (string) * 2);
1585 while (i_byte < size_byte)
1587 unsigned char leading_code;
1589 leading_code = str[i_byte];
1590 c = STRING_CHAR_AND_LENGTH (str + i_byte, size_byte-i_byte, len);
1591 i_byte += len;
1593 if (handle_iso_classes && c == '['
1594 && i_byte < size_byte
1595 && STRING_CHAR (str + i_byte, size_byte - i_byte) == ':')
1597 const unsigned char *class_beg = str + i_byte + 1;
1598 const unsigned char *class_end = class_beg;
1599 const unsigned char *class_limit = str + size_byte - 2;
1600 /* Leave room for the null. */
1601 unsigned char class_name[CHAR_CLASS_MAX_LENGTH + 1];
1602 re_wctype_t cc;
1604 if (class_limit - class_beg > CHAR_CLASS_MAX_LENGTH)
1605 class_limit = class_beg + CHAR_CLASS_MAX_LENGTH;
1607 while (class_end < class_limit
1608 && *class_end >= 'a' && *class_end <= 'z')
1609 class_end++;
1611 if (class_end == class_beg
1612 || *class_end != ':' || class_end[1] != ']')
1613 goto not_a_class_name_multibyte;
1615 bcopy (class_beg, class_name, class_end - class_beg);
1616 class_name[class_end - class_beg] = 0;
1618 cc = re_wctype (class_name);
1619 if (cc == 0)
1620 error ("Invalid ISO C character class");
1622 iso_classes = Fcons (make_number (cc), iso_classes);
1624 i_byte = class_end + 2 - str;
1625 continue;
1628 not_a_class_name_multibyte:
1629 if (c == '\\')
1631 if (i_byte == size_byte)
1632 break;
1634 leading_code = str[i_byte];
1635 c = STRING_CHAR_AND_LENGTH (str + i_byte,
1636 size_byte - i_byte, len);
1637 i_byte += len;
1639 /* Treat `-' as range character only if another character
1640 follows. */
1641 if (i_byte + 1 < size_byte
1642 && str[i_byte] == '-')
1644 unsigned int c2;
1645 unsigned char leading_code2;
1647 /* Skip over the dash. */
1648 i_byte++;
1650 /* Get the end of the range. */
1651 leading_code2 = str[i_byte];
1652 c2 = STRING_CHAR_AND_LENGTH (str + i_byte,
1653 size_byte - i_byte, len);
1654 i_byte += len;
1656 if (c2 == '\\'
1657 && i_byte < size_byte)
1659 leading_code2 = str[i_byte];
1660 c2 =STRING_CHAR_AND_LENGTH (str + i_byte, size_byte-i_byte, len);
1661 i_byte += len;
1664 if (c > c2)
1665 continue;
1666 if (ASCII_CHAR_P (c))
1668 while (c <= c2 && c < 0x80)
1669 fastmap[c++] = 1;
1670 leading_code = CHAR_LEADING_CODE (c);
1672 if (! ASCII_CHAR_P (c))
1674 while (leading_code <= leading_code2)
1675 fastmap[leading_code++] = 1;
1676 if (c <= c2)
1678 char_ranges[n_char_ranges++] = c;
1679 char_ranges[n_char_ranges++] = c2;
1683 else
1685 if (ASCII_CHAR_P (c))
1686 fastmap[c] = 1;
1687 else
1689 fastmap[leading_code] = 1;
1690 char_ranges[n_char_ranges++] = c;
1691 char_ranges[n_char_ranges++] = c;
1696 /* If the current range is unibyte and STRING contains non-ASCII
1697 chars, arrange fastmap for the corresponding unibyte
1698 chars. */
1700 if (! multibyte && n_char_ranges > 0)
1702 bzero (fastmap + 0200, 0200);
1703 for (i = 0; i < n_char_ranges; i += 2)
1705 int c1 = char_ranges[i];
1706 int c2 = char_ranges[i + 1];
1708 for (; c1 <= c2; c1++)
1710 int b = CHAR_TO_BYTE_SAFE (c1);
1711 if (b >= 0)
1712 fastmap[b] = 1;
1718 /* If ^ was the first character, complement the fastmap. */
1719 if (negate)
1721 if (! multibyte)
1722 for (i = 0; i < sizeof fastmap; i++)
1723 fastmap[i] ^= 1;
1724 else
1726 for (i = 0; i < 0200; i++)
1727 fastmap[i] ^= 1;
1728 /* All non-ASCII chars possibly match. */
1729 for (; i < sizeof fastmap; i++)
1730 fastmap[i] = 1;
1735 int start_point = PT;
1736 int pos = PT;
1737 int pos_byte = PT_BYTE;
1738 unsigned char *p = PT_ADDR, *endp, *stop;
1740 if (forwardp)
1742 endp = (XINT (lim) == GPT) ? GPT_ADDR : CHAR_POS_ADDR (XINT (lim));
1743 stop = (pos < GPT && GPT < XINT (lim)) ? GPT_ADDR : endp;
1745 else
1747 endp = CHAR_POS_ADDR (XINT (lim));
1748 stop = (pos >= GPT && GPT > XINT (lim)) ? GAP_END_ADDR : endp;
1751 immediate_quit = 1;
1752 if (forwardp)
1754 if (multibyte)
1755 while (1)
1757 int nbytes;
1759 if (p >= stop)
1761 if (p >= endp)
1762 break;
1763 p = GAP_END_ADDR;
1764 stop = endp;
1766 c = STRING_CHAR_AND_LENGTH (p, MAX_MULTIBYTE_LENGTH, nbytes);
1767 if (! NILP (iso_classes) && in_classes (c, iso_classes))
1769 if (negate)
1770 break;
1771 else
1772 goto fwd_ok;
1775 if (! fastmap[*p])
1776 break;
1777 if (! ASCII_CHAR_P (c))
1779 /* As we are looking at a multibyte character, we
1780 must look up the character in the table
1781 CHAR_RANGES. If there's no data in the table,
1782 that character is not what we want to skip. */
1784 /* The following code do the right thing even if
1785 n_char_ranges is zero (i.e. no data in
1786 CHAR_RANGES). */
1787 for (i = 0; i < n_char_ranges; i += 2)
1788 if (c >= char_ranges[i] && c <= char_ranges[i + 1])
1789 break;
1790 if (!(negate ^ (i < n_char_ranges)))
1791 break;
1793 fwd_ok:
1794 p += nbytes, pos++, pos_byte += nbytes;
1796 else
1797 while (1)
1799 if (p >= stop)
1801 if (p >= endp)
1802 break;
1803 p = GAP_END_ADDR;
1804 stop = endp;
1807 if (!NILP (iso_classes) && in_classes (*p, iso_classes))
1809 if (negate)
1810 break;
1811 else
1812 goto fwd_unibyte_ok;
1815 if (!fastmap[*p])
1816 break;
1817 fwd_unibyte_ok:
1818 p++, pos++, pos_byte++;
1821 else
1823 if (multibyte)
1824 while (1)
1826 unsigned char *prev_p;
1828 if (p <= stop)
1830 if (p <= endp)
1831 break;
1832 p = GPT_ADDR;
1833 stop = endp;
1835 prev_p = p;
1836 while (--p >= stop && ! CHAR_HEAD_P (*p));
1837 c = STRING_CHAR (p, MAX_MULTIBYTE_LENGTH);
1839 if (! NILP (iso_classes) && in_classes (c, iso_classes))
1841 if (negate)
1842 break;
1843 else
1844 goto back_ok;
1847 if (! fastmap[*p])
1848 break;
1849 if (! ASCII_CHAR_P (c))
1851 /* See the comment in the previous similar code. */
1852 for (i = 0; i < n_char_ranges; i += 2)
1853 if (c >= char_ranges[i] && c <= char_ranges[i + 1])
1854 break;
1855 if (!(negate ^ (i < n_char_ranges)))
1856 break;
1858 back_ok:
1859 pos--, pos_byte -= prev_p - p;
1861 else
1862 while (1)
1864 if (p <= stop)
1866 if (p <= endp)
1867 break;
1868 p = GPT_ADDR;
1869 stop = endp;
1872 if (! NILP (iso_classes) && in_classes (p[-1], iso_classes))
1874 if (negate)
1875 break;
1876 else
1877 goto back_unibyte_ok;
1880 if (!fastmap[p[-1]])
1881 break;
1882 back_unibyte_ok:
1883 p--, pos--, pos_byte--;
1887 SET_PT_BOTH (pos, pos_byte);
1888 immediate_quit = 0;
1890 return make_number (PT - start_point);
1895 static Lisp_Object
1896 skip_syntaxes (forwardp, string, lim)
1897 int forwardp;
1898 Lisp_Object string, lim;
1900 register unsigned int c;
1901 unsigned char fastmap[0400];
1902 int negate = 0;
1903 register int i, i_byte;
1904 int multibyte;
1905 int size_byte;
1906 unsigned char *str;
1908 CHECK_STRING (string);
1910 if (NILP (lim))
1911 XSETINT (lim, forwardp ? ZV : BEGV);
1912 else
1913 CHECK_NUMBER_COERCE_MARKER (lim);
1915 /* In any case, don't allow scan outside bounds of buffer. */
1916 if (XINT (lim) > ZV)
1917 XSETFASTINT (lim, ZV);
1918 if (XINT (lim) < BEGV)
1919 XSETFASTINT (lim, BEGV);
1921 if (forwardp ? (PT >= XFASTINT (lim)) : (PT <= XFASTINT (lim)))
1922 return make_number (0);
1924 multibyte = (!NILP (current_buffer->enable_multibyte_characters)
1925 && (XINT (lim) - PT != CHAR_TO_BYTE (XINT (lim)) - PT_BYTE));
1927 bzero (fastmap, sizeof fastmap);
1929 if (SBYTES (string) > SCHARS (string))
1930 /* As this is very rare case (syntax spec is ASCII only), don't
1931 consider efficiency. */
1932 string = string_make_unibyte (string);
1934 str = SDATA (string);
1935 size_byte = SBYTES (string);
1937 i_byte = 0;
1938 if (i_byte < size_byte
1939 && SREF (string, 0) == '^')
1941 negate = 1; i_byte++;
1944 /* Find the syntaxes specified and set their elements of fastmap. */
1946 while (i_byte < size_byte)
1948 c = str[i_byte++];
1949 fastmap[syntax_spec_code[c]] = 1;
1952 /* If ^ was the first character, complement the fastmap. */
1953 if (negate)
1954 for (i = 0; i < sizeof fastmap; i++)
1955 fastmap[i] ^= 1;
1958 int start_point = PT;
1959 int pos = PT;
1960 int pos_byte = PT_BYTE;
1961 unsigned char *p = PT_ADDR, *endp, *stop;
1963 if (forwardp)
1965 endp = (XINT (lim) == GPT) ? GPT_ADDR : CHAR_POS_ADDR (XINT (lim));
1966 stop = (pos < GPT && GPT < XINT (lim)) ? GPT_ADDR : endp;
1968 else
1970 endp = CHAR_POS_ADDR (XINT (lim));
1971 stop = (pos >= GPT && GPT > XINT (lim)) ? GAP_END_ADDR : endp;
1974 immediate_quit = 1;
1975 SETUP_SYNTAX_TABLE (pos, forwardp ? 1 : -1);
1976 if (forwardp)
1978 if (multibyte)
1980 while (1)
1982 int nbytes;
1984 if (p >= stop)
1986 if (p >= endp)
1987 break;
1988 p = GAP_END_ADDR;
1989 stop = endp;
1991 c = STRING_CHAR_AND_LENGTH (p, MAX_MULTIBYTE_LENGTH, nbytes);
1992 if (! fastmap[(int) SYNTAX (c)])
1993 break;
1994 p += nbytes, pos++, pos_byte += nbytes;
1995 UPDATE_SYNTAX_TABLE_FORWARD (pos);
1998 else
2000 while (1)
2002 if (p >= stop)
2004 if (p >= endp)
2005 break;
2006 p = GAP_END_ADDR;
2007 stop = endp;
2009 if (! fastmap[(int) SYNTAX (*p)])
2010 break;
2011 p++, pos++, pos_byte++;
2012 UPDATE_SYNTAX_TABLE_FORWARD (pos);
2016 else
2018 if (multibyte)
2020 while (1)
2022 unsigned char *prev_p;
2024 if (p <= stop)
2026 if (p <= endp)
2027 break;
2028 p = GPT_ADDR;
2029 stop = endp;
2031 UPDATE_SYNTAX_TABLE_BACKWARD (pos - 1);
2032 prev_p = p;
2033 while (--p >= stop && ! CHAR_HEAD_P (*p));
2034 c = STRING_CHAR (p, MAX_MULTIBYTE_LENGTH);
2035 if (! fastmap[(int) SYNTAX (c)])
2036 break;
2037 pos--, pos_byte -= prev_p - p;
2040 else
2042 while (1)
2044 if (p <= stop)
2046 if (p <= endp)
2047 break;
2048 p = GPT_ADDR;
2049 stop = endp;
2051 UPDATE_SYNTAX_TABLE_BACKWARD (pos - 1);
2052 if (! fastmap[(int) SYNTAX (p[-1])])
2053 break;
2054 p--, pos--, pos_byte--;
2059 SET_PT_BOTH (pos, pos_byte);
2060 immediate_quit = 0;
2062 return make_number (PT - start_point);
2066 /* Return 1 if character C belongs to one of the ISO classes
2067 in the list ISO_CLASSES. Each class is represented by an
2068 integer which is its type according to re_wctype. */
2070 static int
2071 in_classes (c, iso_classes)
2072 int c;
2073 Lisp_Object iso_classes;
2075 int fits_class = 0;
2077 while (! NILP (iso_classes))
2079 Lisp_Object elt;
2080 elt = XCAR (iso_classes);
2081 iso_classes = XCDR (iso_classes);
2083 if (re_iswctype (c, XFASTINT (elt)))
2084 fits_class = 1;
2087 return fits_class;
2090 /* Jump over a comment, assuming we are at the beginning of one.
2091 FROM is the current position.
2092 FROM_BYTE is the bytepos corresponding to FROM.
2093 Do not move past STOP (a charpos).
2094 The comment over which we have to jump is of style STYLE
2095 (either SYNTAX_COMMENT_STYLE(foo) or ST_COMMENT_STYLE).
2096 NESTING should be positive to indicate the nesting at the beginning
2097 for nested comments and should be zero or negative else.
2098 ST_COMMENT_STYLE cannot be nested.
2099 PREV_SYNTAX is the SYNTAX_WITH_FLAGS of the previous character
2100 (or 0 If the search cannot start in the middle of a two-character).
2102 If successful, return 1 and store the charpos of the comment's end
2103 into *CHARPOS_PTR and the corresponding bytepos into *BYTEPOS_PTR.
2104 Else, return 0 and store the charpos STOP into *CHARPOS_PTR, the
2105 corresponding bytepos into *BYTEPOS_PTR and the current nesting
2106 (as defined for state.incomment) in *INCOMMENT_PTR.
2108 The comment end is the last character of the comment rather than the
2109 character just after the comment.
2111 Global syntax data is assumed to initially be valid for FROM and
2112 remains valid for forward search starting at the returned position. */
2114 static int
2115 forw_comment (from, from_byte, stop, nesting, style, prev_syntax,
2116 charpos_ptr, bytepos_ptr, incomment_ptr)
2117 EMACS_INT from, from_byte, stop;
2118 int nesting, style, prev_syntax;
2119 EMACS_INT *charpos_ptr, *bytepos_ptr;
2120 int *incomment_ptr;
2122 register int c, c1;
2123 register enum syntaxcode code;
2124 register int syntax;
2126 if (nesting <= 0) nesting = -1;
2128 /* Enter the loop in the middle so that we find
2129 a 2-char comment ender if we start in the middle of it. */
2130 syntax = prev_syntax;
2131 if (syntax != 0) goto forw_incomment;
2133 while (1)
2135 if (from == stop)
2137 *incomment_ptr = nesting;
2138 *charpos_ptr = from;
2139 *bytepos_ptr = from_byte;
2140 return 0;
2142 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2143 syntax = SYNTAX_WITH_FLAGS (c);
2144 code = syntax & 0xff;
2145 if (code == Sendcomment
2146 && SYNTAX_FLAGS_COMMENT_STYLE (syntax) == style
2147 && (SYNTAX_FLAGS_COMMENT_NESTED (syntax) ?
2148 (nesting > 0 && --nesting == 0) : nesting < 0))
2149 /* we have encountered a comment end of the same style
2150 as the comment sequence which began this comment
2151 section */
2152 break;
2153 if (code == Scomment_fence
2154 && style == ST_COMMENT_STYLE)
2155 /* we have encountered a comment end of the same style
2156 as the comment sequence which began this comment
2157 section. */
2158 break;
2159 if (nesting > 0
2160 && code == Scomment
2161 && SYNTAX_FLAGS_COMMENT_NESTED (syntax)
2162 && SYNTAX_FLAGS_COMMENT_STYLE (syntax) == style)
2163 /* we have encountered a nested comment of the same style
2164 as the comment sequence which began this comment section */
2165 nesting++;
2166 INC_BOTH (from, from_byte);
2167 UPDATE_SYNTAX_TABLE_FORWARD (from);
2169 forw_incomment:
2170 if (from < stop && SYNTAX_FLAGS_COMEND_FIRST (syntax)
2171 && SYNTAX_FLAGS_COMMENT_STYLE (syntax) == style
2172 && (c1 = FETCH_CHAR_AS_MULTIBYTE (from_byte),
2173 SYNTAX_COMEND_SECOND (c1))
2174 && ((SYNTAX_FLAGS_COMMENT_NESTED (syntax) ||
2175 SYNTAX_COMMENT_NESTED (c1)) ? nesting > 0 : nesting < 0))
2177 if (--nesting <= 0)
2178 /* we have encountered a comment end of the same style
2179 as the comment sequence which began this comment
2180 section */
2181 break;
2182 else
2184 INC_BOTH (from, from_byte);
2185 UPDATE_SYNTAX_TABLE_FORWARD (from);
2188 if (nesting > 0
2189 && from < stop
2190 && SYNTAX_FLAGS_COMSTART_FIRST (syntax)
2191 && (c1 = FETCH_CHAR_AS_MULTIBYTE (from_byte),
2192 SYNTAX_COMMENT_STYLE (c1) == style
2193 && SYNTAX_COMSTART_SECOND (c1))
2194 && (SYNTAX_FLAGS_COMMENT_NESTED (syntax) ||
2195 SYNTAX_COMMENT_NESTED (c1)))
2196 /* we have encountered a nested comment of the same style
2197 as the comment sequence which began this comment
2198 section */
2200 INC_BOTH (from, from_byte);
2201 UPDATE_SYNTAX_TABLE_FORWARD (from);
2202 nesting++;
2205 *charpos_ptr = from;
2206 *bytepos_ptr = from_byte;
2207 return 1;
2210 DEFUN ("forward-comment", Fforward_comment, Sforward_comment, 1, 1, 0,
2211 doc: /*
2212 Move forward across up to COUNT comments. If COUNT is negative, move backward.
2213 Stop scanning if we find something other than a comment or whitespace.
2214 Set point to where scanning stops.
2215 If COUNT comments are found as expected, with nothing except whitespace
2216 between them, return t; otherwise return nil. */)
2217 (count)
2218 Lisp_Object count;
2220 register EMACS_INT from;
2221 EMACS_INT from_byte;
2222 register EMACS_INT stop;
2223 register int c, c1;
2224 register enum syntaxcode code;
2225 int comstyle = 0; /* style of comment encountered */
2226 int comnested = 0; /* whether the comment is nestable or not */
2227 int found;
2228 EMACS_INT count1;
2229 EMACS_INT out_charpos, out_bytepos;
2230 int dummy;
2232 CHECK_NUMBER (count);
2233 count1 = XINT (count);
2234 stop = count1 > 0 ? ZV : BEGV;
2236 immediate_quit = 1;
2237 QUIT;
2239 from = PT;
2240 from_byte = PT_BYTE;
2242 SETUP_SYNTAX_TABLE (from, count1);
2243 while (count1 > 0)
2247 int comstart_first;
2249 if (from == stop)
2251 SET_PT_BOTH (from, from_byte);
2252 immediate_quit = 0;
2253 return Qnil;
2255 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2256 code = SYNTAX (c);
2257 comstart_first = SYNTAX_COMSTART_FIRST (c);
2258 comnested = SYNTAX_COMMENT_NESTED (c);
2259 comstyle = SYNTAX_COMMENT_STYLE (c);
2260 INC_BOTH (from, from_byte);
2261 UPDATE_SYNTAX_TABLE_FORWARD (from);
2262 if (from < stop && comstart_first
2263 && (c1 = FETCH_CHAR_AS_MULTIBYTE (from_byte),
2264 SYNTAX_COMSTART_SECOND (c1)))
2266 /* We have encountered a comment start sequence and we
2267 are ignoring all text inside comments. We must record
2268 the comment style this sequence begins so that later,
2269 only a comment end of the same style actually ends
2270 the comment section. */
2271 code = Scomment;
2272 comstyle = SYNTAX_COMMENT_STYLE (c1);
2273 comnested = comnested || SYNTAX_COMMENT_NESTED (c1);
2274 INC_BOTH (from, from_byte);
2275 UPDATE_SYNTAX_TABLE_FORWARD (from);
2278 while (code == Swhitespace || (code == Sendcomment && c == '\n'));
2280 if (code == Scomment_fence)
2281 comstyle = ST_COMMENT_STYLE;
2282 else if (code != Scomment)
2284 immediate_quit = 0;
2285 DEC_BOTH (from, from_byte);
2286 SET_PT_BOTH (from, from_byte);
2287 return Qnil;
2289 /* We're at the start of a comment. */
2290 found = forw_comment (from, from_byte, stop, comnested, comstyle, 0,
2291 &out_charpos, &out_bytepos, &dummy);
2292 from = out_charpos; from_byte = out_bytepos;
2293 if (!found)
2295 immediate_quit = 0;
2296 SET_PT_BOTH (from, from_byte);
2297 return Qnil;
2299 INC_BOTH (from, from_byte);
2300 UPDATE_SYNTAX_TABLE_FORWARD (from);
2301 /* We have skipped one comment. */
2302 count1--;
2305 while (count1 < 0)
2307 while (1)
2309 int quoted;
2311 if (from <= stop)
2313 SET_PT_BOTH (BEGV, BEGV_BYTE);
2314 immediate_quit = 0;
2315 return Qnil;
2318 DEC_BOTH (from, from_byte);
2319 /* char_quoted does UPDATE_SYNTAX_TABLE_BACKWARD (from). */
2320 quoted = char_quoted (from, from_byte);
2321 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2322 code = SYNTAX (c);
2323 comstyle = 0;
2324 comnested = SYNTAX_COMMENT_NESTED (c);
2325 if (code == Sendcomment)
2326 comstyle = SYNTAX_COMMENT_STYLE (c);
2327 if (from > stop && SYNTAX_COMEND_SECOND (c)
2328 && prev_char_comend_first (from, from_byte)
2329 && !char_quoted (from - 1, dec_bytepos (from_byte)))
2331 /* We must record the comment style encountered so that
2332 later, we can match only the proper comment begin
2333 sequence of the same style. */
2334 DEC_BOTH (from, from_byte);
2335 code = Sendcomment;
2336 /* Calling char_quoted, above, set up global syntax position
2337 at the new value of FROM. */
2338 c1 = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2339 comstyle = SYNTAX_COMMENT_STYLE (c1);
2340 comnested = comnested || SYNTAX_COMMENT_NESTED (c1);
2343 if (code == Scomment_fence)
2345 /* Skip until first preceding unquoted comment_fence. */
2346 int found = 0, ini = from, ini_byte = from_byte;
2348 while (1)
2350 DEC_BOTH (from, from_byte);
2351 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2352 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2353 if (SYNTAX (c) == Scomment_fence
2354 && !char_quoted (from, from_byte))
2356 found = 1;
2357 break;
2359 else if (from == stop)
2360 break;
2362 if (found == 0)
2364 from = ini; /* Set point to ini + 1. */
2365 from_byte = ini_byte;
2366 goto leave;
2368 else
2369 /* We have skipped one comment. */
2370 break;
2372 else if (code == Sendcomment)
2374 found = back_comment (from, from_byte, stop, comnested, comstyle,
2375 &out_charpos, &out_bytepos);
2376 if (found == -1)
2378 if (c == '\n')
2379 /* This end-of-line is not an end-of-comment.
2380 Treat it like a whitespace.
2381 CC-mode (and maybe others) relies on this behavior. */
2383 else
2385 /* Failure: we should go back to the end of this
2386 not-quite-endcomment. */
2387 if (SYNTAX(c) != code)
2388 /* It was a two-char Sendcomment. */
2389 INC_BOTH (from, from_byte);
2390 goto leave;
2393 else
2395 /* We have skipped one comment. */
2396 from = out_charpos, from_byte = out_bytepos;
2397 break;
2400 else if (code != Swhitespace || quoted)
2402 leave:
2403 immediate_quit = 0;
2404 INC_BOTH (from, from_byte);
2405 SET_PT_BOTH (from, from_byte);
2406 return Qnil;
2410 count1++;
2413 SET_PT_BOTH (from, from_byte);
2414 immediate_quit = 0;
2415 return Qt;
2418 /* Return syntax code of character C if C is an ASCII character
2419 or `multibyte_symbol_p' is zero. Otherwise, return Ssymbol. */
2421 #define SYNTAX_WITH_MULTIBYTE_CHECK(c) \
2422 ((ASCII_CHAR_P (c) || !multibyte_symbol_p) \
2423 ? SYNTAX (c) : Ssymbol)
2425 static Lisp_Object
2426 scan_lists (from, count, depth, sexpflag)
2427 register EMACS_INT from;
2428 EMACS_INT count, depth;
2429 int sexpflag;
2431 Lisp_Object val;
2432 register EMACS_INT stop = count > 0 ? ZV : BEGV;
2433 register int c, c1;
2434 int stringterm;
2435 int quoted;
2436 int mathexit = 0;
2437 register enum syntaxcode code, temp_code;
2438 int min_depth = depth; /* Err out if depth gets less than this. */
2439 int comstyle = 0; /* style of comment encountered */
2440 int comnested = 0; /* whether the comment is nestable or not */
2441 EMACS_INT temp_pos;
2442 EMACS_INT last_good = from;
2443 int found;
2444 EMACS_INT from_byte;
2445 EMACS_INT out_bytepos, out_charpos;
2446 int temp, dummy;
2447 int multibyte_symbol_p = sexpflag && multibyte_syntax_as_symbol;
2449 if (depth > 0) min_depth = 0;
2451 if (from > ZV) from = ZV;
2452 if (from < BEGV) from = BEGV;
2454 from_byte = CHAR_TO_BYTE (from);
2456 immediate_quit = 1;
2457 QUIT;
2459 SETUP_SYNTAX_TABLE (from, count);
2460 while (count > 0)
2462 while (from < stop)
2464 int comstart_first, prefix;
2465 UPDATE_SYNTAX_TABLE_FORWARD (from);
2466 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2467 code = SYNTAX_WITH_MULTIBYTE_CHECK (c);
2468 comstart_first = SYNTAX_COMSTART_FIRST (c);
2469 comnested = SYNTAX_COMMENT_NESTED (c);
2470 comstyle = SYNTAX_COMMENT_STYLE (c);
2471 prefix = SYNTAX_PREFIX (c);
2472 if (depth == min_depth)
2473 last_good = from;
2474 INC_BOTH (from, from_byte);
2475 UPDATE_SYNTAX_TABLE_FORWARD (from);
2476 if (from < stop && comstart_first
2477 && (c = FETCH_CHAR_AS_MULTIBYTE (from_byte),
2478 SYNTAX_COMSTART_SECOND (c))
2479 && parse_sexp_ignore_comments)
2481 /* we have encountered a comment start sequence and we
2482 are ignoring all text inside comments. We must record
2483 the comment style this sequence begins so that later,
2484 only a comment end of the same style actually ends
2485 the comment section */
2486 code = Scomment;
2487 c1 = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2488 comstyle = SYNTAX_COMMENT_STYLE (c1);
2489 comnested = comnested || SYNTAX_COMMENT_NESTED (c1);
2490 INC_BOTH (from, from_byte);
2491 UPDATE_SYNTAX_TABLE_FORWARD (from);
2494 if (prefix)
2495 continue;
2497 switch (SWITCH_ENUM_CAST (code))
2499 case Sescape:
2500 case Scharquote:
2501 if (from == stop)
2502 goto lose;
2503 INC_BOTH (from, from_byte);
2504 /* treat following character as a word constituent */
2505 case Sword:
2506 case Ssymbol:
2507 if (depth || !sexpflag) break;
2508 /* This word counts as a sexp; return at end of it. */
2509 while (from < stop)
2511 UPDATE_SYNTAX_TABLE_FORWARD (from);
2513 /* Some compilers can't handle this inside the switch. */
2514 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2515 temp = SYNTAX_WITH_MULTIBYTE_CHECK (c);
2516 switch (temp)
2518 case Scharquote:
2519 case Sescape:
2520 INC_BOTH (from, from_byte);
2521 if (from == stop)
2522 goto lose;
2523 break;
2524 case Sword:
2525 case Ssymbol:
2526 case Squote:
2527 break;
2528 default:
2529 goto done;
2531 INC_BOTH (from, from_byte);
2533 goto done;
2535 case Scomment_fence:
2536 comstyle = ST_COMMENT_STYLE;
2537 /* FALLTHROUGH */
2538 case Scomment:
2539 if (!parse_sexp_ignore_comments) break;
2540 UPDATE_SYNTAX_TABLE_FORWARD (from);
2541 found = forw_comment (from, from_byte, stop,
2542 comnested, comstyle, 0,
2543 &out_charpos, &out_bytepos, &dummy);
2544 from = out_charpos, from_byte = out_bytepos;
2545 if (!found)
2547 if (depth == 0)
2548 goto done;
2549 goto lose;
2551 INC_BOTH (from, from_byte);
2552 UPDATE_SYNTAX_TABLE_FORWARD (from);
2553 break;
2555 case Smath:
2556 if (!sexpflag)
2557 break;
2558 if (from != stop && c == FETCH_CHAR_AS_MULTIBYTE (from_byte))
2560 INC_BOTH (from, from_byte);
2562 if (mathexit)
2564 mathexit = 0;
2565 goto close1;
2567 mathexit = 1;
2569 case Sopen:
2570 if (!++depth) goto done;
2571 break;
2573 case Sclose:
2574 close1:
2575 if (!--depth) goto done;
2576 if (depth < min_depth)
2577 xsignal3 (Qscan_error,
2578 build_string ("Containing expression ends prematurely"),
2579 make_number (last_good), make_number (from));
2580 break;
2582 case Sstring:
2583 case Sstring_fence:
2584 temp_pos = dec_bytepos (from_byte);
2585 stringterm = FETCH_CHAR_AS_MULTIBYTE (temp_pos);
2586 while (1)
2588 if (from >= stop)
2589 goto lose;
2590 UPDATE_SYNTAX_TABLE_FORWARD (from);
2591 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2592 if (code == Sstring
2593 ? (c == stringterm
2594 && SYNTAX_WITH_MULTIBYTE_CHECK (c) == Sstring)
2595 : SYNTAX_WITH_MULTIBYTE_CHECK (c) == Sstring_fence)
2596 break;
2598 /* Some compilers can't handle this inside the switch. */
2599 temp = SYNTAX_WITH_MULTIBYTE_CHECK (c);
2600 switch (temp)
2602 case Scharquote:
2603 case Sescape:
2604 INC_BOTH (from, from_byte);
2606 INC_BOTH (from, from_byte);
2608 INC_BOTH (from, from_byte);
2609 if (!depth && sexpflag) goto done;
2610 break;
2611 default:
2612 /* Ignore whitespace, punctuation, quote, endcomment. */
2613 break;
2617 /* Reached end of buffer. Error if within object, return nil if between */
2618 if (depth)
2619 goto lose;
2621 immediate_quit = 0;
2622 return Qnil;
2624 /* End of object reached */
2625 done:
2626 count--;
2629 while (count < 0)
2631 while (from > stop)
2633 DEC_BOTH (from, from_byte);
2634 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2635 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2636 code = SYNTAX_WITH_MULTIBYTE_CHECK (c);
2637 if (depth == min_depth)
2638 last_good = from;
2639 comstyle = 0;
2640 comnested = SYNTAX_COMMENT_NESTED (c);
2641 if (code == Sendcomment)
2642 comstyle = SYNTAX_COMMENT_STYLE (c);
2643 if (from > stop && SYNTAX_COMEND_SECOND (c)
2644 && prev_char_comend_first (from, from_byte)
2645 && parse_sexp_ignore_comments)
2647 /* We must record the comment style encountered so that
2648 later, we can match only the proper comment begin
2649 sequence of the same style. */
2650 DEC_BOTH (from, from_byte);
2651 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2652 code = Sendcomment;
2653 c1 = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2654 comstyle = SYNTAX_COMMENT_STYLE (c1);
2655 comnested = comnested || SYNTAX_COMMENT_NESTED (c1);
2658 /* Quoting turns anything except a comment-ender
2659 into a word character. Note that this cannot be true
2660 if we decremented FROM in the if-statement above. */
2661 if (code != Sendcomment && char_quoted (from, from_byte))
2663 DEC_BOTH (from, from_byte);
2664 code = Sword;
2666 else if (SYNTAX_PREFIX (c))
2667 continue;
2669 switch (SWITCH_ENUM_CAST (code))
2671 case Sword:
2672 case Ssymbol:
2673 case Sescape:
2674 case Scharquote:
2675 if (depth || !sexpflag) break;
2676 /* This word counts as a sexp; count object finished
2677 after passing it. */
2678 while (from > stop)
2680 temp_pos = from_byte;
2681 if (! NILP (current_buffer->enable_multibyte_characters))
2682 DEC_POS (temp_pos);
2683 else
2684 temp_pos--;
2685 UPDATE_SYNTAX_TABLE_BACKWARD (from - 1);
2686 c1 = FETCH_CHAR_AS_MULTIBYTE (temp_pos);
2687 temp_code = SYNTAX_WITH_MULTIBYTE_CHECK (c1);
2688 /* Don't allow comment-end to be quoted. */
2689 if (temp_code == Sendcomment)
2690 goto done2;
2691 quoted = char_quoted (from - 1, temp_pos);
2692 if (quoted)
2694 DEC_BOTH (from, from_byte);
2695 temp_pos = dec_bytepos (temp_pos);
2696 UPDATE_SYNTAX_TABLE_BACKWARD (from - 1);
2698 c1 = FETCH_CHAR_AS_MULTIBYTE (temp_pos);
2699 temp_code = SYNTAX_WITH_MULTIBYTE_CHECK (c1);
2700 if (! (quoted || temp_code == Sword
2701 || temp_code == Ssymbol
2702 || temp_code == Squote))
2703 goto done2;
2704 DEC_BOTH (from, from_byte);
2706 goto done2;
2708 case Smath:
2709 if (!sexpflag)
2710 break;
2711 temp_pos = dec_bytepos (from_byte);
2712 UPDATE_SYNTAX_TABLE_BACKWARD (from - 1);
2713 if (from != stop && c == FETCH_CHAR_AS_MULTIBYTE (temp_pos))
2714 DEC_BOTH (from, from_byte);
2715 if (mathexit)
2717 mathexit = 0;
2718 goto open2;
2720 mathexit = 1;
2722 case Sclose:
2723 if (!++depth) goto done2;
2724 break;
2726 case Sopen:
2727 open2:
2728 if (!--depth) goto done2;
2729 if (depth < min_depth)
2730 xsignal3 (Qscan_error,
2731 build_string ("Containing expression ends prematurely"),
2732 make_number (last_good), make_number (from));
2733 break;
2735 case Sendcomment:
2736 if (!parse_sexp_ignore_comments)
2737 break;
2738 found = back_comment (from, from_byte, stop, comnested, comstyle,
2739 &out_charpos, &out_bytepos);
2740 /* FIXME: if found == -1, then it really wasn't a comment-end.
2741 For single-char Sendcomment, we can't do much about it apart
2742 from skipping the char.
2743 For 2-char endcomments, we could try again, taking both
2744 chars as separate entities, but it's a lot of trouble
2745 for very little gain, so we don't bother either. -sm */
2746 if (found != -1)
2747 from = out_charpos, from_byte = out_bytepos;
2748 break;
2750 case Scomment_fence:
2751 case Sstring_fence:
2752 while (1)
2754 if (from == stop)
2755 goto lose;
2756 DEC_BOTH (from, from_byte);
2757 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2758 if (!char_quoted (from, from_byte)
2759 && (c = FETCH_CHAR_AS_MULTIBYTE (from_byte),
2760 SYNTAX_WITH_MULTIBYTE_CHECK (c) == code))
2761 break;
2763 if (code == Sstring_fence && !depth && sexpflag) goto done2;
2764 break;
2766 case Sstring:
2767 stringterm = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2768 while (1)
2770 if (from == stop)
2771 goto lose;
2772 DEC_BOTH (from, from_byte);
2773 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2774 if (!char_quoted (from, from_byte)
2775 && (stringterm
2776 == (c = FETCH_CHAR_AS_MULTIBYTE (from_byte)))
2777 && SYNTAX_WITH_MULTIBYTE_CHECK (c) == Sstring)
2778 break;
2780 if (!depth && sexpflag) goto done2;
2781 break;
2782 default:
2783 /* Ignore whitespace, punctuation, quote, endcomment. */
2784 break;
2788 /* Reached start of buffer. Error if within object, return nil if between */
2789 if (depth)
2790 goto lose;
2792 immediate_quit = 0;
2793 return Qnil;
2795 done2:
2796 count++;
2800 immediate_quit = 0;
2801 XSETFASTINT (val, from);
2802 return val;
2804 lose:
2805 xsignal3 (Qscan_error,
2806 build_string ("Unbalanced parentheses"),
2807 make_number (last_good), make_number (from));
2810 DEFUN ("scan-lists", Fscan_lists, Sscan_lists, 3, 3, 0,
2811 doc: /* Scan from character number FROM by COUNT lists.
2812 Returns the character number of the position thus found.
2814 If DEPTH is nonzero, paren depth begins counting from that value,
2815 only places where the depth in parentheses becomes zero
2816 are candidates for stopping; COUNT such places are counted.
2817 Thus, a positive value for DEPTH means go out levels.
2819 Comments are ignored if `parse-sexp-ignore-comments' is non-nil.
2821 If the beginning or end of (the accessible part of) the buffer is reached
2822 and the depth is wrong, an error is signaled.
2823 If the depth is right but the count is not used up, nil is returned. */)
2824 (from, count, depth)
2825 Lisp_Object from, count, depth;
2827 CHECK_NUMBER (from);
2828 CHECK_NUMBER (count);
2829 CHECK_NUMBER (depth);
2831 return scan_lists (XINT (from), XINT (count), XINT (depth), 0);
2834 DEFUN ("scan-sexps", Fscan_sexps, Sscan_sexps, 2, 2, 0,
2835 doc: /* Scan from character number FROM by COUNT balanced expressions.
2836 If COUNT is negative, scan backwards.
2837 Returns the character number of the position thus found.
2839 Comments are ignored if `parse-sexp-ignore-comments' is non-nil.
2841 If the beginning or end of (the accessible part of) the buffer is reached
2842 in the middle of a parenthetical grouping, an error is signaled.
2843 If the beginning or end is reached between groupings
2844 but before count is used up, nil is returned. */)
2845 (from, count)
2846 Lisp_Object from, count;
2848 CHECK_NUMBER (from);
2849 CHECK_NUMBER (count);
2851 return scan_lists (XINT (from), XINT (count), 0, 1);
2854 DEFUN ("backward-prefix-chars", Fbackward_prefix_chars, Sbackward_prefix_chars,
2855 0, 0, 0,
2856 doc: /* Move point backward over any number of chars with prefix syntax.
2857 This includes chars with "quote" or "prefix" syntax (' or p). */)
2860 int beg = BEGV;
2861 int opoint = PT;
2862 int opoint_byte = PT_BYTE;
2863 int pos = PT;
2864 int pos_byte = PT_BYTE;
2865 int c;
2867 if (pos <= beg)
2869 SET_PT_BOTH (opoint, opoint_byte);
2871 return Qnil;
2874 SETUP_SYNTAX_TABLE (pos, -1);
2876 DEC_BOTH (pos, pos_byte);
2878 while (!char_quoted (pos, pos_byte)
2879 /* Previous statement updates syntax table. */
2880 && ((c = FETCH_CHAR_AS_MULTIBYTE (pos_byte), SYNTAX (c) == Squote)
2881 || SYNTAX_PREFIX (c)))
2883 opoint = pos;
2884 opoint_byte = pos_byte;
2886 if (pos + 1 > beg)
2887 DEC_BOTH (pos, pos_byte);
2890 SET_PT_BOTH (opoint, opoint_byte);
2892 return Qnil;
2895 /* Parse forward from FROM / FROM_BYTE to END,
2896 assuming that FROM has state OLDSTATE (nil means FROM is start of function),
2897 and return a description of the state of the parse at END.
2898 If STOPBEFORE is nonzero, stop at the start of an atom.
2899 If COMMENTSTOP is 1, stop at the start of a comment.
2900 If COMMENTSTOP is -1, stop at the start or end of a comment,
2901 after the beginning of a string, or after the end of a string. */
2903 static void
2904 scan_sexps_forward (stateptr, from, from_byte, end, targetdepth,
2905 stopbefore, oldstate, commentstop)
2906 struct lisp_parse_state *stateptr;
2907 register EMACS_INT from;
2908 EMACS_INT from_byte, end;
2909 int targetdepth, stopbefore;
2910 Lisp_Object oldstate;
2911 int commentstop;
2913 struct lisp_parse_state state;
2915 register enum syntaxcode code;
2916 int c1;
2917 int comnested;
2918 struct level { int last, prev; };
2919 struct level levelstart[100];
2920 register struct level *curlevel = levelstart;
2921 struct level *endlevel = levelstart + 100;
2922 register int depth; /* Paren depth of current scanning location.
2923 level - levelstart equals this except
2924 when the depth becomes negative. */
2925 int mindepth; /* Lowest DEPTH value seen. */
2926 int start_quoted = 0; /* Nonzero means starting after a char quote */
2927 Lisp_Object tem;
2928 EMACS_INT prev_from; /* Keep one character before FROM. */
2929 EMACS_INT prev_from_byte;
2930 int prev_from_syntax;
2931 int boundary_stop = commentstop == -1;
2932 int nofence;
2933 int found;
2934 EMACS_INT out_bytepos, out_charpos;
2935 int temp;
2937 prev_from = from;
2938 prev_from_byte = from_byte;
2939 if (from != BEGV)
2940 DEC_BOTH (prev_from, prev_from_byte);
2942 /* Use this macro instead of `from++'. */
2943 #define INC_FROM \
2944 do { prev_from = from; \
2945 prev_from_byte = from_byte; \
2946 temp = FETCH_CHAR_AS_MULTIBYTE (prev_from_byte); \
2947 prev_from_syntax = SYNTAX_WITH_FLAGS (temp); \
2948 INC_BOTH (from, from_byte); \
2949 if (from < end) \
2950 UPDATE_SYNTAX_TABLE_FORWARD (from); \
2951 } while (0)
2953 immediate_quit = 1;
2954 QUIT;
2956 if (NILP (oldstate))
2958 depth = 0;
2959 state.instring = -1;
2960 state.incomment = 0;
2961 state.comstyle = 0; /* comment style a by default. */
2962 state.comstr_start = -1; /* no comment/string seen. */
2964 else
2966 tem = Fcar (oldstate);
2967 if (!NILP (tem))
2968 depth = XINT (tem);
2969 else
2970 depth = 0;
2972 oldstate = Fcdr (oldstate);
2973 oldstate = Fcdr (oldstate);
2974 oldstate = Fcdr (oldstate);
2975 tem = Fcar (oldstate);
2976 /* Check whether we are inside string_fence-style string: */
2977 state.instring = (!NILP (tem)
2978 ? (INTEGERP (tem) ? XINT (tem) : ST_STRING_STYLE)
2979 : -1);
2981 oldstate = Fcdr (oldstate);
2982 tem = Fcar (oldstate);
2983 state.incomment = (!NILP (tem)
2984 ? (INTEGERP (tem) ? XINT (tem) : -1)
2985 : 0);
2987 oldstate = Fcdr (oldstate);
2988 tem = Fcar (oldstate);
2989 start_quoted = !NILP (tem);
2991 /* if the eighth element of the list is nil, we are in comment
2992 style a. If it is non-nil, we are in comment style b */
2993 oldstate = Fcdr (oldstate);
2994 oldstate = Fcdr (oldstate);
2995 tem = Fcar (oldstate);
2996 state.comstyle = NILP (tem) ? 0 : (EQ (tem, Qsyntax_table)
2997 ? ST_COMMENT_STYLE : 1);
2999 oldstate = Fcdr (oldstate);
3000 tem = Fcar (oldstate);
3001 state.comstr_start = NILP (tem) ? -1 : XINT (tem) ;
3002 oldstate = Fcdr (oldstate);
3003 tem = Fcar (oldstate);
3004 while (!NILP (tem)) /* >= second enclosing sexps. */
3006 /* curlevel++->last ran into compiler bug on Apollo */
3007 curlevel->last = XINT (Fcar (tem));
3008 if (++curlevel == endlevel)
3009 curlevel--; /* error ("Nesting too deep for parser"); */
3010 curlevel->prev = -1;
3011 curlevel->last = -1;
3012 tem = Fcdr (tem);
3015 state.quoted = 0;
3016 mindepth = depth;
3018 curlevel->prev = -1;
3019 curlevel->last = -1;
3021 SETUP_SYNTAX_TABLE (prev_from, 1);
3022 temp = FETCH_CHAR (prev_from_byte);
3023 prev_from_syntax = SYNTAX_WITH_FLAGS (temp);
3024 UPDATE_SYNTAX_TABLE_FORWARD (from);
3026 /* Enter the loop at a place appropriate for initial state. */
3028 if (state.incomment)
3029 goto startincomment;
3030 if (state.instring >= 0)
3032 nofence = state.instring != ST_STRING_STYLE;
3033 if (start_quoted)
3034 goto startquotedinstring;
3035 goto startinstring;
3037 else if (start_quoted)
3038 goto startquoted;
3040 while (from < end)
3042 INC_FROM;
3043 code = prev_from_syntax & 0xff;
3045 if (from < end
3046 && SYNTAX_FLAGS_COMSTART_FIRST (prev_from_syntax)
3047 && (c1 = FETCH_CHAR (from_byte),
3048 SYNTAX_COMSTART_SECOND (c1)))
3049 /* Duplicate code to avoid a complex if-expression
3050 which causes trouble for the SGI compiler. */
3052 /* Record the comment style we have entered so that only
3053 the comment-end sequence of the same style actually
3054 terminates the comment section. */
3055 state.comstyle = SYNTAX_COMMENT_STYLE (c1);
3056 comnested = SYNTAX_FLAGS_COMMENT_NESTED (prev_from_syntax);
3057 comnested = comnested || SYNTAX_COMMENT_NESTED (c1);
3058 state.incomment = comnested ? 1 : -1;
3059 state.comstr_start = prev_from;
3060 INC_FROM;
3061 code = Scomment;
3063 else if (code == Scomment_fence)
3065 /* Record the comment style we have entered so that only
3066 the comment-end sequence of the same style actually
3067 terminates the comment section. */
3068 state.comstyle = ST_COMMENT_STYLE;
3069 state.incomment = -1;
3070 state.comstr_start = prev_from;
3071 code = Scomment;
3073 else if (code == Scomment)
3075 state.comstyle = SYNTAX_FLAGS_COMMENT_STYLE (prev_from_syntax);
3076 state.incomment = (SYNTAX_FLAGS_COMMENT_NESTED (prev_from_syntax) ?
3077 1 : -1);
3078 state.comstr_start = prev_from;
3081 if (SYNTAX_FLAGS_PREFIX (prev_from_syntax))
3082 continue;
3083 switch (SWITCH_ENUM_CAST (code))
3085 case Sescape:
3086 case Scharquote:
3087 if (stopbefore) goto stop; /* this arg means stop at sexp start */
3088 curlevel->last = prev_from;
3089 startquoted:
3090 if (from == end) goto endquoted;
3091 INC_FROM;
3092 goto symstarted;
3093 /* treat following character as a word constituent */
3094 case Sword:
3095 case Ssymbol:
3096 if (stopbefore) goto stop; /* this arg means stop at sexp start */
3097 curlevel->last = prev_from;
3098 symstarted:
3099 while (from < end)
3101 /* Some compilers can't handle this inside the switch. */
3102 temp = FETCH_CHAR_AS_MULTIBYTE (from_byte);
3103 temp = SYNTAX (temp);
3104 switch (temp)
3106 case Scharquote:
3107 case Sescape:
3108 INC_FROM;
3109 if (from == end) goto endquoted;
3110 break;
3111 case Sword:
3112 case Ssymbol:
3113 case Squote:
3114 break;
3115 default:
3116 goto symdone;
3118 INC_FROM;
3120 symdone:
3121 curlevel->prev = curlevel->last;
3122 break;
3124 case Scomment_fence: /* Can't happen because it's handled above. */
3125 case Scomment:
3126 if (commentstop || boundary_stop) goto done;
3127 startincomment:
3128 /* The (from == BEGV) test was to enter the loop in the middle so
3129 that we find a 2-char comment ender even if we start in the
3130 middle of it. We don't want to do that if we're just at the
3131 beginning of the comment (think of (*) ... (*)). */
3132 found = forw_comment (from, from_byte, end,
3133 state.incomment, state.comstyle,
3134 (from == BEGV || from < state.comstr_start + 3)
3135 ? 0 : prev_from_syntax,
3136 &out_charpos, &out_bytepos, &state.incomment);
3137 from = out_charpos; from_byte = out_bytepos;
3138 /* Beware! prev_from and friends are invalid now.
3139 Luckily, the `done' doesn't use them and the INC_FROM
3140 sets them to a sane value without looking at them. */
3141 if (!found) goto done;
3142 INC_FROM;
3143 state.incomment = 0;
3144 state.comstyle = 0; /* reset the comment style */
3145 if (boundary_stop) goto done;
3146 break;
3148 case Sopen:
3149 if (stopbefore) goto stop; /* this arg means stop at sexp start */
3150 depth++;
3151 /* curlevel++->last ran into compiler bug on Apollo */
3152 curlevel->last = prev_from;
3153 if (++curlevel == endlevel)
3154 curlevel--; /* error ("Nesting too deep for parser"); */
3155 curlevel->prev = -1;
3156 curlevel->last = -1;
3157 if (targetdepth == depth) goto done;
3158 break;
3160 case Sclose:
3161 depth--;
3162 if (depth < mindepth)
3163 mindepth = depth;
3164 if (curlevel != levelstart)
3165 curlevel--;
3166 curlevel->prev = curlevel->last;
3167 if (targetdepth == depth) goto done;
3168 break;
3170 case Sstring:
3171 case Sstring_fence:
3172 state.comstr_start = from - 1;
3173 if (stopbefore) goto stop; /* this arg means stop at sexp start */
3174 curlevel->last = prev_from;
3175 state.instring = (code == Sstring
3176 ? (FETCH_CHAR_AS_MULTIBYTE (prev_from_byte))
3177 : ST_STRING_STYLE);
3178 if (boundary_stop) goto done;
3179 startinstring:
3181 nofence = state.instring != ST_STRING_STYLE;
3183 while (1)
3185 int c;
3187 if (from >= end) goto done;
3188 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
3189 /* Some compilers can't handle this inside the switch. */
3190 temp = SYNTAX (c);
3192 /* Check TEMP here so that if the char has
3193 a syntax-table property which says it is NOT
3194 a string character, it does not end the string. */
3195 if (nofence && c == state.instring && temp == Sstring)
3196 break;
3198 switch (temp)
3200 case Sstring_fence:
3201 if (!nofence) goto string_end;
3202 break;
3203 case Scharquote:
3204 case Sescape:
3205 INC_FROM;
3206 startquotedinstring:
3207 if (from >= end) goto endquoted;
3209 INC_FROM;
3212 string_end:
3213 state.instring = -1;
3214 curlevel->prev = curlevel->last;
3215 INC_FROM;
3216 if (boundary_stop) goto done;
3217 break;
3219 case Smath:
3220 /* FIXME: We should do something with it. */
3221 break;
3222 default:
3223 /* Ignore whitespace, punctuation, quote, endcomment. */
3224 break;
3227 goto done;
3229 stop: /* Here if stopping before start of sexp. */
3230 from = prev_from; /* We have just fetched the char that starts it; */
3231 goto done; /* but return the position before it. */
3233 endquoted:
3234 state.quoted = 1;
3235 done:
3236 state.depth = depth;
3237 state.mindepth = mindepth;
3238 state.thislevelstart = curlevel->prev;
3239 state.prevlevelstart
3240 = (curlevel == levelstart) ? -1 : (curlevel - 1)->last;
3241 state.location = from;
3242 state.levelstarts = Qnil;
3243 while (--curlevel >= levelstart)
3244 state.levelstarts = Fcons (make_number (curlevel->last),
3245 state.levelstarts);
3246 immediate_quit = 0;
3248 *stateptr = state;
3251 DEFUN ("parse-partial-sexp", Fparse_partial_sexp, Sparse_partial_sexp, 2, 6, 0,
3252 doc: /* Parse Lisp syntax starting at FROM until TO; return status of parse at TO.
3253 Parsing stops at TO or when certain criteria are met;
3254 point is set to where parsing stops.
3255 If fifth arg OLDSTATE is omitted or nil,
3256 parsing assumes that FROM is the beginning of a function.
3257 Value is a list of elements describing final state of parsing:
3258 0. depth in parens.
3259 1. character address of start of innermost containing list; nil if none.
3260 2. character address of start of last complete sexp terminated.
3261 3. non-nil if inside a string.
3262 (it is the character that will terminate the string,
3263 or t if the string should be terminated by a generic string delimiter.)
3264 4. nil if outside a comment, t if inside a non-nestable comment,
3265 else an integer (the current comment nesting).
3266 5. t if following a quote character.
3267 6. the minimum paren-depth encountered during this scan.
3268 7. t if in a comment of style b; symbol `syntax-table' if the comment
3269 should be terminated by a generic comment delimiter.
3270 8. character address of start of comment or string; nil if not in one.
3271 9. Intermediate data for continuation of parsing (subject to change).
3272 If third arg TARGETDEPTH is non-nil, parsing stops if the depth
3273 in parentheses becomes equal to TARGETDEPTH.
3274 Fourth arg STOPBEFORE non-nil means stop when come to
3275 any character that starts a sexp.
3276 Fifth arg OLDSTATE is a list like what this function returns.
3277 It is used to initialize the state of the parse. Elements number 1, 2, 6
3278 and 8 are ignored.
3279 Sixth arg COMMENTSTOP non-nil means stop at the start of a comment.
3280 If it is symbol `syntax-table', stop after the start of a comment or a
3281 string, or after end of a comment or a string. */)
3282 (from, to, targetdepth, stopbefore, oldstate, commentstop)
3283 Lisp_Object from, to, targetdepth, stopbefore, oldstate, commentstop;
3285 struct lisp_parse_state state;
3286 int target;
3288 if (!NILP (targetdepth))
3290 CHECK_NUMBER (targetdepth);
3291 target = XINT (targetdepth);
3293 else
3294 target = -100000; /* We won't reach this depth */
3296 validate_region (&from, &to);
3297 scan_sexps_forward (&state, XINT (from), CHAR_TO_BYTE (XINT (from)),
3298 XINT (to),
3299 target, !NILP (stopbefore), oldstate,
3300 (NILP (commentstop)
3301 ? 0 : (EQ (commentstop, Qsyntax_table) ? -1 : 1)));
3303 SET_PT (state.location);
3305 return Fcons (make_number (state.depth),
3306 Fcons (state.prevlevelstart < 0 ? Qnil : make_number (state.prevlevelstart),
3307 Fcons (state.thislevelstart < 0 ? Qnil : make_number (state.thislevelstart),
3308 Fcons (state.instring >= 0
3309 ? (state.instring == ST_STRING_STYLE
3310 ? Qt : make_number (state.instring)) : Qnil,
3311 Fcons (state.incomment < 0 ? Qt :
3312 (state.incomment == 0 ? Qnil :
3313 make_number (state.incomment)),
3314 Fcons (state.quoted ? Qt : Qnil,
3315 Fcons (make_number (state.mindepth),
3316 Fcons ((state.comstyle
3317 ? (state.comstyle == ST_COMMENT_STYLE
3318 ? Qsyntax_table : Qt) :
3319 Qnil),
3320 Fcons (((state.incomment
3321 || (state.instring >= 0))
3322 ? make_number (state.comstr_start)
3323 : Qnil),
3324 Fcons (state.levelstarts, Qnil))))))))));
3327 void
3328 init_syntax_once ()
3330 register int i, c;
3331 Lisp_Object temp;
3333 /* This has to be done here, before we call Fmake_char_table. */
3334 Qsyntax_table = intern ("syntax-table");
3335 staticpro (&Qsyntax_table);
3337 /* Intern this now in case it isn't already done.
3338 Setting this variable twice is harmless.
3339 But don't staticpro it here--that is done in alloc.c. */
3340 Qchar_table_extra_slots = intern ("char-table-extra-slots");
3342 /* Create objects which can be shared among syntax tables. */
3343 Vsyntax_code_object = Fmake_vector (make_number (Smax), Qnil);
3344 for (i = 0; i < XVECTOR (Vsyntax_code_object)->size; i++)
3345 XVECTOR (Vsyntax_code_object)->contents[i]
3346 = Fcons (make_number (i), Qnil);
3348 /* Now we are ready to set up this property, so we can
3349 create syntax tables. */
3350 Fput (Qsyntax_table, Qchar_table_extra_slots, make_number (0));
3352 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Swhitespace];
3354 Vstandard_syntax_table = Fmake_char_table (Qsyntax_table, temp);
3356 /* Control characters should not be whitespace. */
3357 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Spunct];
3358 for (i = 0; i <= ' ' - 1; i++)
3359 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, i, temp);
3360 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, 0177, temp);
3362 /* Except that a few really are whitespace. */
3363 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Swhitespace];
3364 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, ' ', temp);
3365 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '\t', temp);
3366 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '\n', temp);
3367 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, 015, temp);
3368 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, 014, temp);
3370 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Sword];
3371 for (i = 'a'; i <= 'z'; i++)
3372 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, i, temp);
3373 for (i = 'A'; i <= 'Z'; i++)
3374 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, i, temp);
3375 for (i = '0'; i <= '9'; i++)
3376 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, i, temp);
3378 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '$', temp);
3379 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '%', temp);
3381 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '(',
3382 Fcons (make_number (Sopen), make_number (')')));
3383 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, ')',
3384 Fcons (make_number (Sclose), make_number ('(')));
3385 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '[',
3386 Fcons (make_number (Sopen), make_number (']')));
3387 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, ']',
3388 Fcons (make_number (Sclose), make_number ('[')));
3389 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '{',
3390 Fcons (make_number (Sopen), make_number ('}')));
3391 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '}',
3392 Fcons (make_number (Sclose), make_number ('{')));
3393 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '"',
3394 Fcons (make_number ((int) Sstring), Qnil));
3395 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '\\',
3396 Fcons (make_number ((int) Sescape), Qnil));
3398 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Ssymbol];
3399 for (i = 0; i < 10; i++)
3401 c = "_-+*/&|<>="[i];
3402 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, c, temp);
3405 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Spunct];
3406 for (i = 0; i < 12; i++)
3408 c = ".,;:?!#@~^'`"[i];
3409 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, c, temp);
3412 /* All multibyte characters have syntax `word' by default. */
3413 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Sword];
3414 char_table_set_range (Vstandard_syntax_table, 0x80, MAX_CHAR, temp);
3417 void
3418 syms_of_syntax ()
3420 Qsyntax_table_p = intern ("syntax-table-p");
3421 staticpro (&Qsyntax_table_p);
3423 staticpro (&Vsyntax_code_object);
3425 staticpro (&gl_state.object);
3426 staticpro (&gl_state.global_code);
3427 staticpro (&gl_state.current_syntax_table);
3428 staticpro (&gl_state.old_prop);
3430 /* Defined in regex.c */
3431 staticpro (&re_match_object);
3433 Qscan_error = intern ("scan-error");
3434 staticpro (&Qscan_error);
3435 Fput (Qscan_error, Qerror_conditions,
3436 Fcons (Qscan_error, Fcons (Qerror, Qnil)));
3437 Fput (Qscan_error, Qerror_message,
3438 build_string ("Scan error"));
3440 DEFVAR_BOOL ("parse-sexp-ignore-comments", &parse_sexp_ignore_comments,
3441 doc: /* Non-nil means `forward-sexp', etc., should treat comments as whitespace. */);
3443 DEFVAR_BOOL ("parse-sexp-lookup-properties", &parse_sexp_lookup_properties,
3444 doc: /* Non-nil means `forward-sexp', etc., obey `syntax-table' property.
3445 Otherwise, that text property is simply ignored.
3446 See the info node `(elisp)Syntax Properties' for a description of the
3447 `syntax-table' property. */);
3449 words_include_escapes = 0;
3450 DEFVAR_BOOL ("words-include-escapes", &words_include_escapes,
3451 doc: /* Non-nil means `forward-word', etc., should treat escape chars part of words. */);
3453 DEFVAR_BOOL ("multibyte-syntax-as-symbol", &multibyte_syntax_as_symbol,
3454 doc: /* Non-nil means `scan-sexps' treats all multibyte characters as symbol. */);
3455 multibyte_syntax_as_symbol = 0;
3457 DEFVAR_BOOL ("open-paren-in-column-0-is-defun-start",
3458 &open_paren_in_column_0_is_defun_start,
3459 doc: /* *Non-nil means an open paren in column 0 denotes the start of a defun. */);
3460 open_paren_in_column_0_is_defun_start = 1;
3463 DEFVAR_LISP ("find-word-boundary-function-table",
3464 &Vfind_word_boundary_function_table,
3465 doc: /*
3466 Char table of functions to search for the word boundary.
3467 Each function is called with two arguments; POS and LIMIT.
3468 POS and LIMIT are character positions in the current buffer.
3470 If POS is less than LIMIT, POS is at the first character of a word,
3471 and the return value of a function is a position after the last
3472 character of that word.
3474 If POS is not less than LIMIT, POS is at the last character of a word,
3475 and the return value of a function is a position at the first
3476 character of that word.
3478 In both cases, LIMIT bounds the search. */);
3479 Vfind_word_boundary_function_table = Fmake_char_table (Qnil, Qnil);
3481 defsubr (&Ssyntax_table_p);
3482 defsubr (&Ssyntax_table);
3483 defsubr (&Sstandard_syntax_table);
3484 defsubr (&Scopy_syntax_table);
3485 defsubr (&Sset_syntax_table);
3486 defsubr (&Schar_syntax);
3487 defsubr (&Smatching_paren);
3488 defsubr (&Sstring_to_syntax);
3489 defsubr (&Smodify_syntax_entry);
3490 defsubr (&Sinternal_describe_syntax_value);
3492 defsubr (&Sforward_word);
3494 defsubr (&Sskip_chars_forward);
3495 defsubr (&Sskip_chars_backward);
3496 defsubr (&Sskip_syntax_forward);
3497 defsubr (&Sskip_syntax_backward);
3499 defsubr (&Sforward_comment);
3500 defsubr (&Sscan_lists);
3501 defsubr (&Sscan_sexps);
3502 defsubr (&Sbackward_prefix_chars);
3503 defsubr (&Sparse_partial_sexp);
3506 /* arch-tag: 3e297b9f-088e-4b64-8f4c-fb0b3443e412
3507 (do not change this comment) */