Update years in copyright notice; nfc.
[bpt/emacs.git] / src / syntax.c
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, 2002,
3 2003, 2004, 2005 Free Software Foundation, Inc.
4
5 This file is part of GNU Emacs.
6
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
11
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
21
22
23 #include <config.h>
24 #include <ctype.h>
25 #include "lisp.h"
26 #include "commands.h"
27 #include "buffer.h"
28 #include "charset.h"
29 #include "keymap.h"
30 #include "regex.h"
31
32 /* Make syntax table lookup grant data in gl_state. */
33 #define SYNTAX_ENTRY_VIA_PROPERTY
34
35 #include "syntax.h"
36 #include "intervals.h"
37
38 /* We use these constants in place for comment-style and
39 string-ender-char to distinguish comments/strings started by
40 comment_fence and string_fence codes. */
41
42 #define ST_COMMENT_STYLE (256 + 1)
43 #define ST_STRING_STYLE (256 + 2)
44 #include "category.h"
45
46 Lisp_Object Qsyntax_table_p, Qsyntax_table, Qscan_error;
47
48 int words_include_escapes;
49 int parse_sexp_lookup_properties;
50
51 /* Nonzero means `scan-sexps' treat all multibyte characters as symbol. */
52 int multibyte_syntax_as_symbol;
53
54 /* Used as a temporary in SYNTAX_ENTRY and other macros in syntax.h,
55 if not compiled with GCC. No need to mark it, since it is used
56 only very temporarily. */
57 Lisp_Object syntax_temp;
58
59 /* Non-zero means an open parenthesis in column 0 is always considered
60 to be the start of a defun. Zero means an open parenthesis in
61 column 0 has no special meaning. */
62
63 int open_paren_in_column_0_is_defun_start;
64
65 /* This is the internal form of the parse state used in parse-partial-sexp. */
66
67 struct lisp_parse_state
68 {
69 int depth; /* Depth at end of parsing. */
70 int instring; /* -1 if not within string, else desired terminator. */
71 int incomment; /* -1 if in unnestable comment else comment nesting */
72 int comstyle; /* comment style a=0, or b=1, or ST_COMMENT_STYLE. */
73 int quoted; /* Nonzero if just after an escape char at end of parsing */
74 int thislevelstart; /* Char number of most recent start-of-expression at current level */
75 int prevlevelstart; /* Char number of start of containing expression */
76 int location; /* Char number at which parsing stopped. */
77 int mindepth; /* Minimum depth seen while scanning. */
78 int comstr_start; /* Position just after last comment/string starter. */
79 Lisp_Object levelstarts; /* Char numbers of starts-of-expression
80 of levels (starting from outermost). */
81 };
82 \f
83 /* These variables are a cache for finding the start of a defun.
84 find_start_pos is the place for which the defun start was found.
85 find_start_value is the defun start position found for it.
86 find_start_value_byte is the corresponding byte position.
87 find_start_buffer is the buffer it was found in.
88 find_start_begv is the BEGV value when it was found.
89 find_start_modiff is the value of MODIFF when it was found. */
90
91 static int find_start_pos;
92 static int find_start_value;
93 static int find_start_value_byte;
94 static struct buffer *find_start_buffer;
95 static int find_start_begv;
96 static int find_start_modiff;
97
98
99 static int find_defun_start P_ ((int, int));
100 static int back_comment P_ ((int, int, int, int, int, int *, int *));
101 static int char_quoted P_ ((int, int));
102 static Lisp_Object skip_chars P_ ((int, int, Lisp_Object, Lisp_Object, int));
103 static Lisp_Object scan_lists P_ ((int, int, int, int));
104 static void scan_sexps_forward P_ ((struct lisp_parse_state *,
105 int, int, int, int,
106 int, Lisp_Object, int));
107 static int in_classes P_ ((int, Lisp_Object));
108 \f
109
110 struct gl_state_s gl_state; /* Global state of syntax parser. */
111
112 INTERVAL interval_of ();
113 #define INTERVALS_AT_ONCE 10 /* 1 + max-number of intervals
114 to scan to property-change. */
115
116 /* Update gl_state to an appropriate interval which contains CHARPOS. The
117 sign of COUNT give the relative position of CHARPOS wrt the previously
118 valid interval. If INIT, only [be]_property fields of gl_state are
119 valid at start, the rest is filled basing on OBJECT.
120
121 `gl_state.*_i' are the intervals, and CHARPOS is further in the search
122 direction than the intervals - or in an interval. We update the
123 current syntax-table basing on the property of this interval, and
124 update the interval to start further than CHARPOS - or be
125 NULL_INTERVAL. We also update lim_property to be the next value of
126 charpos to call this subroutine again - or be before/after the
127 start/end of OBJECT. */
128
129 void
130 update_syntax_table (charpos, count, init, object)
131 int charpos, count, init;
132 Lisp_Object object;
133 {
134 Lisp_Object tmp_table;
135 int cnt = 0, invalidate = 1;
136 INTERVAL i, oldi;
137
138 if (init)
139 {
140 gl_state.old_prop = Qnil;
141 gl_state.start = gl_state.b_property;
142 gl_state.stop = gl_state.e_property;
143 i = interval_of (charpos, object);
144 gl_state.backward_i = gl_state.forward_i = i;
145 invalidate = 0;
146 if (NULL_INTERVAL_P (i))
147 return;
148 /* interval_of updates only ->position of the return value, so
149 update the parents manually to speed up update_interval. */
150 while (!NULL_PARENT (i))
151 {
152 if (AM_RIGHT_CHILD (i))
153 INTERVAL_PARENT (i)->position = i->position
154 - LEFT_TOTAL_LENGTH (i) + TOTAL_LENGTH (i) /* right end */
155 - TOTAL_LENGTH (INTERVAL_PARENT (i))
156 + LEFT_TOTAL_LENGTH (INTERVAL_PARENT (i));
157 else
158 INTERVAL_PARENT (i)->position = i->position - LEFT_TOTAL_LENGTH (i)
159 + TOTAL_LENGTH (i);
160 i = INTERVAL_PARENT (i);
161 }
162 i = gl_state.forward_i;
163 gl_state.b_property = i->position - gl_state.offset;
164 gl_state.e_property = INTERVAL_LAST_POS (i) - gl_state.offset;
165 goto update;
166 }
167 oldi = i = count > 0 ? gl_state.forward_i : gl_state.backward_i;
168
169 /* We are guaranteed to be called with CHARPOS either in i,
170 or further off. */
171 if (NULL_INTERVAL_P (i))
172 error ("Error in syntax_table logic for to-the-end intervals");
173 else if (charpos < i->position) /* Move left. */
174 {
175 if (count > 0)
176 error ("Error in syntax_table logic for intervals <-");
177 /* Update the interval. */
178 i = update_interval (i, charpos);
179 if (INTERVAL_LAST_POS (i) != gl_state.b_property)
180 {
181 invalidate = 0;
182 gl_state.forward_i = i;
183 gl_state.e_property = INTERVAL_LAST_POS (i) - gl_state.offset;
184 }
185 }
186 else if (charpos >= INTERVAL_LAST_POS (i)) /* Move right. */
187 {
188 if (count < 0)
189 error ("Error in syntax_table logic for intervals ->");
190 /* Update the interval. */
191 i = update_interval (i, charpos);
192 if (i->position != gl_state.e_property)
193 {
194 invalidate = 0;
195 gl_state.backward_i = i;
196 gl_state.b_property = i->position - gl_state.offset;
197 }
198 }
199
200 update:
201 tmp_table = textget (i->plist, Qsyntax_table);
202
203 if (invalidate)
204 invalidate = !EQ (tmp_table, gl_state.old_prop); /* Need to invalidate? */
205
206 if (invalidate) /* Did not get to adjacent interval. */
207 { /* with the same table => */
208 /* invalidate the old range. */
209 if (count > 0)
210 {
211 gl_state.backward_i = i;
212 gl_state.b_property = i->position - gl_state.offset;
213 }
214 else
215 {
216 gl_state.forward_i = i;
217 gl_state.e_property = INTERVAL_LAST_POS (i) - gl_state.offset;
218 }
219 }
220
221 if (!EQ (tmp_table, gl_state.old_prop))
222 {
223 gl_state.current_syntax_table = tmp_table;
224 gl_state.old_prop = tmp_table;
225 if (EQ (Fsyntax_table_p (tmp_table), Qt))
226 {
227 gl_state.use_global = 0;
228 }
229 else if (CONSP (tmp_table))
230 {
231 gl_state.use_global = 1;
232 gl_state.global_code = tmp_table;
233 }
234 else
235 {
236 gl_state.use_global = 0;
237 gl_state.current_syntax_table = current_buffer->syntax_table;
238 }
239 }
240
241 while (!NULL_INTERVAL_P (i))
242 {
243 if (cnt && !EQ (tmp_table, textget (i->plist, Qsyntax_table)))
244 {
245 if (count > 0)
246 {
247 gl_state.e_property = i->position - gl_state.offset;
248 gl_state.forward_i = i;
249 }
250 else
251 {
252 gl_state.b_property = i->position + LENGTH (i) - gl_state.offset;
253 gl_state.backward_i = i;
254 }
255 return;
256 }
257 else if (cnt == INTERVALS_AT_ONCE)
258 {
259 if (count > 0)
260 {
261 gl_state.e_property = i->position + LENGTH (i) - gl_state.offset;
262 gl_state.forward_i = i;
263 }
264 else
265 {
266 gl_state.b_property = i->position - gl_state.offset;
267 gl_state.backward_i = i;
268 }
269 return;
270 }
271 cnt++;
272 i = count > 0 ? next_interval (i) : previous_interval (i);
273 }
274 eassert (NULL_INTERVAL_P (i)); /* This property goes to the end. */
275 if (count > 0)
276 gl_state.e_property = gl_state.stop;
277 else
278 gl_state.b_property = gl_state.start;
279 }
280 \f
281 /* Returns TRUE if char at CHARPOS is quoted.
282 Global syntax-table data should be set up already to be good at CHARPOS
283 or after. On return global syntax data is good for lookup at CHARPOS. */
284
285 static int
286 char_quoted (charpos, bytepos)
287 register int charpos, bytepos;
288 {
289 register enum syntaxcode code;
290 register int beg = BEGV;
291 register int quoted = 0;
292 int orig = charpos;
293
294 DEC_BOTH (charpos, bytepos);
295
296 while (charpos >= beg)
297 {
298 int c;
299
300 UPDATE_SYNTAX_TABLE_BACKWARD (charpos);
301 c = FETCH_CHAR (bytepos);
302 code = SYNTAX (c);
303 if (! (code == Scharquote || code == Sescape))
304 break;
305
306 DEC_BOTH (charpos, bytepos);
307 quoted = !quoted;
308 }
309
310 UPDATE_SYNTAX_TABLE (orig);
311 return quoted;
312 }
313
314 /* Return the bytepos one character after BYTEPOS.
315 We assume that BYTEPOS is not at the end of the buffer. */
316
317 INLINE int
318 inc_bytepos (bytepos)
319 int bytepos;
320 {
321 if (NILP (current_buffer->enable_multibyte_characters))
322 return bytepos + 1;
323
324 INC_POS (bytepos);
325 return bytepos;
326 }
327
328 /* Return the bytepos one character before BYTEPOS.
329 We assume that BYTEPOS is not at the start of the buffer. */
330
331 INLINE int
332 dec_bytepos (bytepos)
333 int bytepos;
334 {
335 if (NILP (current_buffer->enable_multibyte_characters))
336 return bytepos - 1;
337
338 DEC_POS (bytepos);
339 return bytepos;
340 }
341 \f
342 /* Return a defun-start position before before POS and not too far before.
343 It should be the last one before POS, or nearly the last.
344
345 When open_paren_in_column_0_is_defun_start is nonzero,
346 only the beginning of the buffer is treated as a defun-start.
347
348 We record the information about where the scan started
349 and what its result was, so that another call in the same area
350 can return the same value very quickly.
351
352 There is no promise at which position the global syntax data is
353 valid on return from the subroutine, so the caller should explicitly
354 update the global data. */
355
356 static int
357 find_defun_start (pos, pos_byte)
358 int pos, pos_byte;
359 {
360 int opoint = PT, opoint_byte = PT_BYTE;
361
362 if (!open_paren_in_column_0_is_defun_start)
363 {
364 find_start_value_byte = BEGV_BYTE;
365 return BEGV;
366 }
367
368 /* Use previous finding, if it's valid and applies to this inquiry. */
369 if (current_buffer == find_start_buffer
370 /* Reuse the defun-start even if POS is a little farther on.
371 POS might be in the next defun, but that's ok.
372 Our value may not be the best possible, but will still be usable. */
373 && pos <= find_start_pos + 1000
374 && pos >= find_start_value
375 && BEGV == find_start_begv
376 && MODIFF == find_start_modiff)
377 return find_start_value;
378
379 /* Back up to start of line. */
380 scan_newline (pos, pos_byte, BEGV, BEGV_BYTE, -1, 1);
381
382 /* We optimize syntax-table lookup for rare updates. Thus we accept
383 only those `^\s(' which are good in global _and_ text-property
384 syntax-tables. */
385 gl_state.current_syntax_table = current_buffer->syntax_table;
386 gl_state.use_global = 0;
387 while (PT > BEGV)
388 {
389 int c;
390
391 /* Open-paren at start of line means we may have found our
392 defun-start. */
393 c = FETCH_CHAR (PT_BYTE);
394 if (SYNTAX (c) == Sopen)
395 {
396 SETUP_SYNTAX_TABLE (PT + 1, -1); /* Try again... */
397 c = FETCH_CHAR (PT_BYTE);
398 if (SYNTAX (c) == Sopen)
399 break;
400 /* Now fallback to the default value. */
401 gl_state.current_syntax_table = current_buffer->syntax_table;
402 gl_state.use_global = 0;
403 }
404 /* Move to beg of previous line. */
405 scan_newline (PT, PT_BYTE, BEGV, BEGV_BYTE, -2, 1);
406 }
407
408 /* Record what we found, for the next try. */
409 find_start_value = PT;
410 find_start_value_byte = PT_BYTE;
411 find_start_buffer = current_buffer;
412 find_start_modiff = MODIFF;
413 find_start_begv = BEGV;
414 find_start_pos = pos;
415
416 TEMP_SET_PT_BOTH (opoint, opoint_byte);
417
418 return find_start_value;
419 }
420 \f
421 /* Return the SYNTAX_COMEND_FIRST of the character before POS, POS_BYTE. */
422
423 static int
424 prev_char_comend_first (pos, pos_byte)
425 int pos, pos_byte;
426 {
427 int c, val;
428
429 DEC_BOTH (pos, pos_byte);
430 UPDATE_SYNTAX_TABLE_BACKWARD (pos);
431 c = FETCH_CHAR (pos_byte);
432 val = SYNTAX_COMEND_FIRST (c);
433 UPDATE_SYNTAX_TABLE_FORWARD (pos + 1);
434 return val;
435 }
436
437 /* Return the SYNTAX_COMSTART_FIRST of the character before POS, POS_BYTE. */
438
439 /* static int
440 * prev_char_comstart_first (pos, pos_byte)
441 * int pos, pos_byte;
442 * {
443 * int c, val;
444 *
445 * DEC_BOTH (pos, pos_byte);
446 * UPDATE_SYNTAX_TABLE_BACKWARD (pos);
447 * c = FETCH_CHAR (pos_byte);
448 * val = SYNTAX_COMSTART_FIRST (c);
449 * UPDATE_SYNTAX_TABLE_FORWARD (pos + 1);
450 * return val;
451 * } */
452
453 /* Checks whether charpos FROM is at the end of a comment.
454 FROM_BYTE is the bytepos corresponding to FROM.
455 Do not move back before STOP.
456
457 Return a positive value if we find a comment ending at FROM/FROM_BYTE;
458 return -1 otherwise.
459
460 If successful, store the charpos of the comment's beginning
461 into *CHARPOS_PTR, and the bytepos into *BYTEPOS_PTR.
462
463 Global syntax data remains valid for backward search starting at
464 the returned value (or at FROM, if the search was not successful). */
465
466 static int
467 back_comment (from, from_byte, stop, comnested, comstyle, charpos_ptr, bytepos_ptr)
468 int from, from_byte, stop;
469 int comnested, comstyle;
470 int *charpos_ptr, *bytepos_ptr;
471 {
472 /* Look back, counting the parity of string-quotes,
473 and recording the comment-starters seen.
474 When we reach a safe place, assume that's not in a string;
475 then step the main scan to the earliest comment-starter seen
476 an even number of string quotes away from the safe place.
477
478 OFROM[I] is position of the earliest comment-starter seen
479 which is I+2X quotes from the comment-end.
480 PARITY is current parity of quotes from the comment end. */
481 int string_style = -1; /* Presumed outside of any string. */
482 int string_lossage = 0;
483 /* Not a real lossage: indicates that we have passed a matching comment
484 starter plus a non-matching comment-ender, meaning that any matching
485 comment-starter we might see later could be a false positive (hidden
486 inside another comment).
487 Test case: { a (* b } c (* d *) */
488 int comment_lossage = 0;
489 int comment_end = from;
490 int comment_end_byte = from_byte;
491 int comstart_pos = 0;
492 int comstart_byte;
493 /* Place where the containing defun starts,
494 or 0 if we didn't come across it yet. */
495 int defun_start = 0;
496 int defun_start_byte = 0;
497 register enum syntaxcode code;
498 int nesting = 1; /* current comment nesting */
499 int c;
500 int syntax = 0;
501
502 /* FIXME: A }} comment-ender style leads to incorrect behavior
503 in the case of {{ c }}} because we ignore the last two chars which are
504 assumed to be comment-enders although they aren't. */
505
506 /* At beginning of range to scan, we're outside of strings;
507 that determines quote parity to the comment-end. */
508 while (from != stop)
509 {
510 int temp_byte, prev_syntax;
511 int com2start, com2end;
512
513 /* Move back and examine a character. */
514 DEC_BOTH (from, from_byte);
515 UPDATE_SYNTAX_TABLE_BACKWARD (from);
516
517 prev_syntax = syntax;
518 c = FETCH_CHAR (from_byte);
519 syntax = SYNTAX_WITH_FLAGS (c);
520 code = SYNTAX (c);
521
522 /* Check for 2-char comment markers. */
523 com2start = (SYNTAX_FLAGS_COMSTART_FIRST (syntax)
524 && SYNTAX_FLAGS_COMSTART_SECOND (prev_syntax)
525 && comstyle == SYNTAX_FLAGS_COMMENT_STYLE (prev_syntax)
526 && (SYNTAX_FLAGS_COMMENT_NESTED (prev_syntax)
527 || SYNTAX_FLAGS_COMMENT_NESTED (syntax)) == comnested);
528 com2end = (SYNTAX_FLAGS_COMEND_FIRST (syntax)
529 && SYNTAX_FLAGS_COMEND_SECOND (prev_syntax));
530
531 /* Nasty cases with overlapping 2-char comment markers:
532 - snmp-mode: -- c -- foo -- c --
533 --- c --
534 ------ c --
535 - c-mode: *||*
536 |* *|* *|
537 |*| |* |*|
538 /// */
539
540 /* If a 2-char comment sequence partly overlaps with another,
541 we don't try to be clever. */
542 if (from > stop && (com2end || com2start))
543 {
544 int next = from, next_byte = from_byte, next_c, next_syntax;
545 DEC_BOTH (next, next_byte);
546 UPDATE_SYNTAX_TABLE_BACKWARD (next);
547 next_c = FETCH_CHAR (next_byte);
548 next_syntax = SYNTAX_WITH_FLAGS (next_c);
549 if (((com2start || comnested)
550 && SYNTAX_FLAGS_COMEND_SECOND (syntax)
551 && SYNTAX_FLAGS_COMEND_FIRST (next_syntax))
552 || ((com2end || comnested)
553 && SYNTAX_FLAGS_COMSTART_SECOND (syntax)
554 && comstyle == SYNTAX_FLAGS_COMMENT_STYLE (syntax)
555 && SYNTAX_FLAGS_COMSTART_FIRST (next_syntax)))
556 goto lossage;
557 /* UPDATE_SYNTAX_TABLE_FORWARD (next + 1); */
558 }
559
560 if (com2start && comstart_pos == 0)
561 /* We're looking at a comment starter. But it might be a comment
562 ender as well (see snmp-mode). The first time we see one, we
563 need to consider it as a comment starter,
564 and the subsequent times as a comment ender. */
565 com2end = 0;
566
567 /* Turn a 2-char comment sequences into the appropriate syntax. */
568 if (com2end)
569 code = Sendcomment;
570 else if (com2start)
571 code = Scomment;
572 /* Ignore comment starters of a different style. */
573 else if (code == Scomment
574 && (comstyle != SYNTAX_FLAGS_COMMENT_STYLE (syntax)
575 || SYNTAX_FLAGS_COMMENT_NESTED (syntax) != comnested))
576 continue;
577
578 /* Ignore escaped characters, except comment-enders. */
579 if (code != Sendcomment && char_quoted (from, from_byte))
580 continue;
581
582 switch (code)
583 {
584 case Sstring_fence:
585 case Scomment_fence:
586 c = (code == Sstring_fence ? ST_STRING_STYLE : ST_COMMENT_STYLE);
587 case Sstring:
588 /* Track parity of quotes. */
589 if (string_style == -1)
590 /* Entering a string. */
591 string_style = c;
592 else if (string_style == c)
593 /* Leaving the string. */
594 string_style = -1;
595 else
596 /* If we have two kinds of string delimiters.
597 There's no way to grok this scanning backwards. */
598 string_lossage = 1;
599 break;
600
601 case Scomment:
602 /* We've already checked that it is the relevant comstyle. */
603 if (string_style != -1 || comment_lossage || string_lossage)
604 /* There are odd string quotes involved, so let's be careful.
605 Test case in Pascal: " { " a { " } */
606 goto lossage;
607
608 if (!comnested)
609 {
610 /* Record best comment-starter so far. */
611 comstart_pos = from;
612 comstart_byte = from_byte;
613 }
614 else if (--nesting <= 0)
615 /* nested comments have to be balanced, so we don't need to
616 keep looking for earlier ones. We use here the same (slightly
617 incorrect) reasoning as below: since it is followed by uniform
618 paired string quotes, this comment-start has to be outside of
619 strings, else the comment-end itself would be inside a string. */
620 goto done;
621 break;
622
623 case Sendcomment:
624 if (SYNTAX_FLAGS_COMMENT_STYLE (syntax) == comstyle
625 && ((com2end && SYNTAX_FLAGS_COMMENT_NESTED (prev_syntax))
626 || SYNTAX_FLAGS_COMMENT_NESTED (syntax)) == comnested)
627 /* This is the same style of comment ender as ours. */
628 {
629 if (comnested)
630 nesting++;
631 else
632 /* Anything before that can't count because it would match
633 this comment-ender rather than ours. */
634 from = stop; /* Break out of the loop. */
635 }
636 else if (comstart_pos != 0 || c != '\n')
637 /* We're mixing comment styles here, so we'd better be careful.
638 The (comstart_pos != 0 || c != '\n') check is not quite correct
639 (we should just always set comment_lossage), but removing it
640 would imply that any multiline comment in C would go through
641 lossage, which seems overkill.
642 The failure should only happen in the rare cases such as
643 { (* } *) */
644 comment_lossage = 1;
645 break;
646
647 case Sopen:
648 /* Assume a defun-start point is outside of strings. */
649 if (open_paren_in_column_0_is_defun_start
650 && (from == stop
651 || (temp_byte = dec_bytepos (from_byte),
652 FETCH_CHAR (temp_byte) == '\n')))
653 {
654 defun_start = from;
655 defun_start_byte = from_byte;
656 from = stop; /* Break out of the loop. */
657 }
658 break;
659
660 default:
661 break;
662 }
663 }
664
665 if (comstart_pos == 0)
666 {
667 from = comment_end;
668 from_byte = comment_end_byte;
669 UPDATE_SYNTAX_TABLE_FORWARD (comment_end - 1);
670 }
671 /* If comstart_pos is set and we get here (ie. didn't jump to `lossage'
672 or `done'), then we've found the beginning of the non-nested comment. */
673 else if (1) /* !comnested */
674 {
675 from = comstart_pos;
676 from_byte = comstart_byte;
677 UPDATE_SYNTAX_TABLE_FORWARD (from - 1);
678 }
679 else
680 {
681 struct lisp_parse_state state;
682 lossage:
683 /* We had two kinds of string delimiters mixed up
684 together. Decode this going forwards.
685 Scan fwd from a known safe place (beginning-of-defun)
686 to the one in question; this records where we
687 last passed a comment starter. */
688 /* If we did not already find the defun start, find it now. */
689 if (defun_start == 0)
690 {
691 defun_start = find_defun_start (comment_end, comment_end_byte);
692 defun_start_byte = find_start_value_byte;
693 }
694 do
695 {
696 scan_sexps_forward (&state,
697 defun_start, defun_start_byte,
698 comment_end, -10000, 0, Qnil, 0);
699 defun_start = comment_end;
700 if (state.incomment == (comnested ? 1 : -1)
701 && state.comstyle == comstyle)
702 from = state.comstr_start;
703 else
704 {
705 from = comment_end;
706 if (state.incomment)
707 /* If comment_end is inside some other comment, maybe ours
708 is nested, so we need to try again from within the
709 surrounding comment. Example: { a (* " *) */
710 {
711 /* FIXME: We should advance by one or two chars. */
712 defun_start = state.comstr_start + 2;
713 defun_start_byte = CHAR_TO_BYTE (defun_start);
714 }
715 }
716 } while (defun_start < comment_end);
717
718 from_byte = CHAR_TO_BYTE (from);
719 UPDATE_SYNTAX_TABLE_FORWARD (from - 1);
720 }
721
722 done:
723 *charpos_ptr = from;
724 *bytepos_ptr = from_byte;
725
726 return (from == comment_end) ? -1 : from;
727 }
728 \f
729 DEFUN ("syntax-table-p", Fsyntax_table_p, Ssyntax_table_p, 1, 1, 0,
730 doc: /* Return t if OBJECT is a syntax table.
731 Currently, any char-table counts as a syntax table. */)
732 (object)
733 Lisp_Object object;
734 {
735 if (CHAR_TABLE_P (object)
736 && EQ (XCHAR_TABLE (object)->purpose, Qsyntax_table))
737 return Qt;
738 return Qnil;
739 }
740
741 static void
742 check_syntax_table (obj)
743 Lisp_Object obj;
744 {
745 if (!(CHAR_TABLE_P (obj)
746 && EQ (XCHAR_TABLE (obj)->purpose, Qsyntax_table)))
747 wrong_type_argument (Qsyntax_table_p, obj);
748 }
749
750 DEFUN ("syntax-table", Fsyntax_table, Ssyntax_table, 0, 0, 0,
751 doc: /* Return the current syntax table.
752 This is the one specified by the current buffer. */)
753 ()
754 {
755 return current_buffer->syntax_table;
756 }
757
758 DEFUN ("standard-syntax-table", Fstandard_syntax_table,
759 Sstandard_syntax_table, 0, 0, 0,
760 doc: /* Return the standard syntax table.
761 This is the one used for new buffers. */)
762 ()
763 {
764 return Vstandard_syntax_table;
765 }
766
767 DEFUN ("copy-syntax-table", Fcopy_syntax_table, Scopy_syntax_table, 0, 1, 0,
768 doc: /* Construct a new syntax table and return it.
769 It is a copy of the TABLE, which defaults to the standard syntax table. */)
770 (table)
771 Lisp_Object table;
772 {
773 Lisp_Object copy;
774
775 if (!NILP (table))
776 check_syntax_table (table);
777 else
778 table = Vstandard_syntax_table;
779
780 copy = Fcopy_sequence (table);
781
782 /* Only the standard syntax table should have a default element.
783 Other syntax tables should inherit from parents instead. */
784 XCHAR_TABLE (copy)->defalt = Qnil;
785
786 /* Copied syntax tables should all have parents.
787 If we copied one with no parent, such as the standard syntax table,
788 use the standard syntax table as the copy's parent. */
789 if (NILP (XCHAR_TABLE (copy)->parent))
790 Fset_char_table_parent (copy, Vstandard_syntax_table);
791 return copy;
792 }
793
794 DEFUN ("set-syntax-table", Fset_syntax_table, Sset_syntax_table, 1, 1, 0,
795 doc: /* Select a new syntax table for the current buffer.
796 One argument, a syntax table. */)
797 (table)
798 Lisp_Object table;
799 {
800 int idx;
801 check_syntax_table (table);
802 current_buffer->syntax_table = table;
803 /* Indicate that this buffer now has a specified syntax table. */
804 idx = PER_BUFFER_VAR_IDX (syntax_table);
805 SET_PER_BUFFER_VALUE_P (current_buffer, idx, 1);
806 return table;
807 }
808 \f
809 /* Convert a letter which signifies a syntax code
810 into the code it signifies.
811 This is used by modify-syntax-entry, and other things. */
812
813 unsigned char syntax_spec_code[0400] =
814 { 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
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 (char) Swhitespace, (char) Scomment_fence, (char) Sstring, 0377,
819 (char) Smath, 0377, 0377, (char) Squote,
820 (char) Sopen, (char) Sclose, 0377, 0377,
821 0377, (char) Swhitespace, (char) Spunct, (char) Scharquote,
822 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
823 0377, 0377, 0377, 0377,
824 (char) Scomment, 0377, (char) Sendcomment, 0377,
825 (char) Sinherit, 0377, 0377, 0377, 0377, 0377, 0377, 0377, /* @, A ... */
826 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
827 0377, 0377, 0377, 0377, 0377, 0377, 0377, (char) Sword,
828 0377, 0377, 0377, 0377, (char) Sescape, 0377, 0377, (char) Ssymbol,
829 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377, /* `, a, ... */
830 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
831 0377, 0377, 0377, 0377, 0377, 0377, 0377, (char) Sword,
832 0377, 0377, 0377, 0377, (char) Sstring_fence, 0377, 0377, 0377
833 };
834
835 /* Indexed by syntax code, give the letter that describes it. */
836
837 char syntax_code_spec[16] =
838 {
839 ' ', '.', 'w', '_', '(', ')', '\'', '\"', '$', '\\', '/', '<', '>', '@',
840 '!', '|'
841 };
842
843 /* Indexed by syntax code, give the object (cons of syntax code and
844 nil) to be stored in syntax table. Since these objects can be
845 shared among syntax tables, we generate them in advance. By
846 sharing objects, the function `describe-syntax' can give a more
847 compact listing. */
848 static Lisp_Object Vsyntax_code_object;
849
850 \f
851 /* Look up the value for CHARACTER in syntax table TABLE's parent
852 and its parents. SYNTAX_ENTRY calls this, when TABLE itself has nil
853 for CHARACTER. It's actually used only when not compiled with GCC. */
854
855 Lisp_Object
856 syntax_parent_lookup (table, character)
857 Lisp_Object table;
858 int character;
859 {
860 Lisp_Object value;
861
862 while (1)
863 {
864 table = XCHAR_TABLE (table)->parent;
865 if (NILP (table))
866 return Qnil;
867
868 value = XCHAR_TABLE (table)->contents[character];
869 if (!NILP (value))
870 return value;
871 }
872 }
873
874 DEFUN ("char-syntax", Fchar_syntax, Schar_syntax, 1, 1, 0,
875 doc: /* Return the syntax code of CHARACTER, described by a character.
876 For example, if CHARACTER is a word constituent,
877 the character `w' is returned.
878 The characters that correspond to various syntax codes
879 are listed in the documentation of `modify-syntax-entry'. */)
880 (character)
881 Lisp_Object character;
882 {
883 int char_int;
884 gl_state.current_syntax_table = current_buffer->syntax_table;
885
886 gl_state.use_global = 0;
887 CHECK_NUMBER (character);
888 char_int = XINT (character);
889 return make_number (syntax_code_spec[(int) SYNTAX (char_int)]);
890 }
891
892 DEFUN ("matching-paren", Fmatching_paren, Smatching_paren, 1, 1, 0,
893 doc: /* Return the matching parenthesis of CHARACTER, or nil if none. */)
894 (character)
895 Lisp_Object character;
896 {
897 int char_int, code;
898 gl_state.current_syntax_table = current_buffer->syntax_table;
899 gl_state.use_global = 0;
900 CHECK_NUMBER (character);
901 char_int = XINT (character);
902 code = SYNTAX (char_int);
903 if (code == Sopen || code == Sclose)
904 return SYNTAX_MATCH (char_int);
905 return Qnil;
906 }
907
908 DEFUN ("string-to-syntax", Fstring_to_syntax, Sstring_to_syntax, 1, 1, 0,
909 doc: /* Convert a syntax specification STRING into syntax cell form.
910 STRING should be a string as it is allowed as argument of
911 `modify-syntax-entry'. Value is the equivalent cons cell
912 (CODE . MATCHING-CHAR) that can be used as value of a `syntax-table'
913 text property. */)
914 (string)
915 Lisp_Object string;
916 {
917 register const unsigned char *p;
918 register enum syntaxcode code;
919 int val;
920 Lisp_Object match;
921
922 CHECK_STRING (string);
923
924 p = SDATA (string);
925 code = (enum syntaxcode) syntax_spec_code[*p++];
926 if (((int) code & 0377) == 0377)
927 error ("Invalid syntax description letter: %c", p[-1]);
928
929 if (code == Sinherit)
930 return Qnil;
931
932 if (*p)
933 {
934 int len;
935 int character = (STRING_CHAR_AND_LENGTH
936 (p, SBYTES (string) - 1, len));
937 XSETINT (match, character);
938 if (XFASTINT (match) == ' ')
939 match = Qnil;
940 p += len;
941 }
942 else
943 match = Qnil;
944
945 val = (int) code;
946 while (*p)
947 switch (*p++)
948 {
949 case '1':
950 val |= 1 << 16;
951 break;
952
953 case '2':
954 val |= 1 << 17;
955 break;
956
957 case '3':
958 val |= 1 << 18;
959 break;
960
961 case '4':
962 val |= 1 << 19;
963 break;
964
965 case 'p':
966 val |= 1 << 20;
967 break;
968
969 case 'b':
970 val |= 1 << 21;
971 break;
972
973 case 'n':
974 val |= 1 << 22;
975 break;
976 }
977
978 if (val < XVECTOR (Vsyntax_code_object)->size && NILP (match))
979 return XVECTOR (Vsyntax_code_object)->contents[val];
980 else
981 /* Since we can't use a shared object, let's make a new one. */
982 return Fcons (make_number (val), match);
983 }
984
985 /* I really don't know why this is interactive
986 help-form should at least be made useful whilst reading the second arg. */
987 DEFUN ("modify-syntax-entry", Fmodify_syntax_entry, Smodify_syntax_entry, 2, 3,
988 "cSet syntax for character: \nsSet syntax for %s to: ",
989 doc: /* Set syntax for character CHAR according to string NEWENTRY.
990 The syntax is changed only for table SYNTAX-TABLE, which defaults to
991 the current buffer's syntax table.
992 The first character of NEWENTRY should be one of the following:
993 Space or - whitespace syntax. w word constituent.
994 _ symbol constituent. . punctuation.
995 ( open-parenthesis. ) close-parenthesis.
996 " string quote. \\ escape.
997 $ paired delimiter. ' expression quote or prefix operator.
998 < comment starter. > comment ender.
999 / character-quote. @ inherit from `standard-syntax-table'.
1000 | generic string fence. ! generic comment fence.
1001
1002 Only single-character comment start and end sequences are represented thus.
1003 Two-character sequences are represented as described below.
1004 The second character of NEWENTRY is the matching parenthesis,
1005 used only if the first character is `(' or `)'.
1006 Any additional characters are flags.
1007 Defined flags are the characters 1, 2, 3, 4, b, p, and n.
1008 1 means CHAR is the start of a two-char comment start sequence.
1009 2 means CHAR is the second character of such a sequence.
1010 3 means CHAR is the start of a two-char comment end sequence.
1011 4 means CHAR is the second character of such a sequence.
1012
1013 There can be up to two orthogonal comment sequences. This is to support
1014 language modes such as C++. By default, all comment sequences are of style
1015 a, but you can set the comment sequence style to b (on the second character
1016 of a comment-start, or the first character of a comment-end sequence) using
1017 this flag:
1018 b means CHAR is part of comment sequence b.
1019 n means CHAR is part of a nestable comment sequence.
1020
1021 p means CHAR is a prefix character for `backward-prefix-chars';
1022 such characters are treated as whitespace when they occur
1023 between expressions.
1024 usage: (modify-syntax-entry CHAR NEWENTRY &optional SYNTAX-TABLE) */)
1025 (c, newentry, syntax_table)
1026 Lisp_Object c, newentry, syntax_table;
1027 {
1028 CHECK_NUMBER (c);
1029
1030 if (NILP (syntax_table))
1031 syntax_table = current_buffer->syntax_table;
1032 else
1033 check_syntax_table (syntax_table);
1034
1035 SET_RAW_SYNTAX_ENTRY (syntax_table, XINT (c), Fstring_to_syntax (newentry));
1036 return Qnil;
1037 }
1038 \f
1039 /* Dump syntax table to buffer in human-readable format */
1040
1041 DEFUN ("internal-describe-syntax-value", Finternal_describe_syntax_value,
1042 Sinternal_describe_syntax_value, 1, 1, 0,
1043 doc: /* Insert a description of the internal syntax description SYNTAX at point. */)
1044 (syntax)
1045 Lisp_Object syntax;
1046 {
1047 register enum syntaxcode code;
1048 char desc, start1, start2, end1, end2, prefix, comstyle, comnested;
1049 char str[2];
1050 Lisp_Object first, match_lisp, value = syntax;
1051
1052 if (NILP (value))
1053 {
1054 insert_string ("default");
1055 return syntax;
1056 }
1057
1058 if (CHAR_TABLE_P (value))
1059 {
1060 insert_string ("deeper char-table ...");
1061 return syntax;
1062 }
1063
1064 if (!CONSP (value))
1065 {
1066 insert_string ("invalid");
1067 return syntax;
1068 }
1069
1070 first = XCAR (value);
1071 match_lisp = XCDR (value);
1072
1073 if (!INTEGERP (first) || !(NILP (match_lisp) || INTEGERP (match_lisp)))
1074 {
1075 insert_string ("invalid");
1076 return syntax;
1077 }
1078
1079 code = (enum syntaxcode) (XINT (first) & 0377);
1080 start1 = (XINT (first) >> 16) & 1;
1081 start2 = (XINT (first) >> 17) & 1;
1082 end1 = (XINT (first) >> 18) & 1;
1083 end2 = (XINT (first) >> 19) & 1;
1084 prefix = (XINT (first) >> 20) & 1;
1085 comstyle = (XINT (first) >> 21) & 1;
1086 comnested = (XINT (first) >> 22) & 1;
1087
1088 if ((int) code < 0 || (int) code >= (int) Smax)
1089 {
1090 insert_string ("invalid");
1091 return syntax;
1092 }
1093 desc = syntax_code_spec[(int) code];
1094
1095 str[0] = desc, str[1] = 0;
1096 insert (str, 1);
1097
1098 if (NILP (match_lisp))
1099 insert (" ", 1);
1100 else
1101 insert_char (XINT (match_lisp));
1102
1103 if (start1)
1104 insert ("1", 1);
1105 if (start2)
1106 insert ("2", 1);
1107
1108 if (end1)
1109 insert ("3", 1);
1110 if (end2)
1111 insert ("4", 1);
1112
1113 if (prefix)
1114 insert ("p", 1);
1115 if (comstyle)
1116 insert ("b", 1);
1117 if (comnested)
1118 insert ("n", 1);
1119
1120 insert_string ("\twhich means: ");
1121
1122 switch (SWITCH_ENUM_CAST (code))
1123 {
1124 case Swhitespace:
1125 insert_string ("whitespace"); break;
1126 case Spunct:
1127 insert_string ("punctuation"); break;
1128 case Sword:
1129 insert_string ("word"); break;
1130 case Ssymbol:
1131 insert_string ("symbol"); break;
1132 case Sopen:
1133 insert_string ("open"); break;
1134 case Sclose:
1135 insert_string ("close"); break;
1136 case Squote:
1137 insert_string ("prefix"); break;
1138 case Sstring:
1139 insert_string ("string"); break;
1140 case Smath:
1141 insert_string ("math"); break;
1142 case Sescape:
1143 insert_string ("escape"); break;
1144 case Scharquote:
1145 insert_string ("charquote"); break;
1146 case Scomment:
1147 insert_string ("comment"); break;
1148 case Sendcomment:
1149 insert_string ("endcomment"); break;
1150 case Sinherit:
1151 insert_string ("inherit"); break;
1152 case Scomment_fence:
1153 insert_string ("comment fence"); break;
1154 case Sstring_fence:
1155 insert_string ("string fence"); break;
1156 default:
1157 insert_string ("invalid");
1158 return syntax;
1159 }
1160
1161 if (!NILP (match_lisp))
1162 {
1163 insert_string (", matches ");
1164 insert_char (XINT (match_lisp));
1165 }
1166
1167 if (start1)
1168 insert_string (",\n\t is the first character of a comment-start sequence");
1169 if (start2)
1170 insert_string (",\n\t is the second character of a comment-start sequence");
1171
1172 if (end1)
1173 insert_string (",\n\t is the first character of a comment-end sequence");
1174 if (end2)
1175 insert_string (",\n\t is the second character of a comment-end sequence");
1176 if (comstyle)
1177 insert_string (" (comment style b)");
1178 if (comnested)
1179 insert_string (" (nestable)");
1180
1181 if (prefix)
1182 insert_string (",\n\t is a prefix character for `backward-prefix-chars'");
1183
1184 return syntax;
1185 }
1186 \f
1187 int parse_sexp_ignore_comments;
1188
1189 /* Return the position across COUNT words from FROM.
1190 If that many words cannot be found before the end of the buffer, return 0.
1191 COUNT negative means scan backward and stop at word beginning. */
1192
1193 int
1194 scan_words (from, count)
1195 register int from, count;
1196 {
1197 register int beg = BEGV;
1198 register int end = ZV;
1199 register int from_byte = CHAR_TO_BYTE (from);
1200 register enum syntaxcode code;
1201 int ch0, ch1;
1202
1203 immediate_quit = 1;
1204 QUIT;
1205
1206 SETUP_SYNTAX_TABLE (from, count);
1207
1208 while (count > 0)
1209 {
1210 while (1)
1211 {
1212 if (from == end)
1213 {
1214 immediate_quit = 0;
1215 return 0;
1216 }
1217 UPDATE_SYNTAX_TABLE_FORWARD (from);
1218 ch0 = FETCH_CHAR (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;
1226 }
1227 /* Now CH0 is a character which begins a word and FROM is the
1228 position of the next character. */
1229 while (1)
1230 {
1231 if (from == end) break;
1232 UPDATE_SYNTAX_TABLE_FORWARD (from);
1233 ch1 = FETCH_CHAR (from_byte);
1234 code = SYNTAX (ch1);
1235 if (!(words_include_escapes
1236 && (code == Sescape || code == Scharquote)))
1237 if (code != Sword || WORD_BOUNDARY_P (ch0, ch1))
1238 break;
1239 INC_BOTH (from, from_byte);
1240 ch0 = ch1;
1241 }
1242 count--;
1243 }
1244 while (count < 0)
1245 {
1246 while (1)
1247 {
1248 if (from == beg)
1249 {
1250 immediate_quit = 0;
1251 return 0;
1252 }
1253 DEC_BOTH (from, from_byte);
1254 UPDATE_SYNTAX_TABLE_BACKWARD (from);
1255 ch1 = FETCH_CHAR (from_byte);
1256 code = SYNTAX (ch1);
1257 if (words_include_escapes
1258 && (code == Sescape || code == Scharquote))
1259 break;
1260 if (code == Sword)
1261 break;
1262 }
1263 /* Now CH1 is a character which ends a word and FROM is the
1264 position of it. */
1265 while (1)
1266 {
1267 int temp_byte;
1268
1269 if (from == beg)
1270 break;
1271 temp_byte = dec_bytepos (from_byte);
1272 UPDATE_SYNTAX_TABLE_BACKWARD (from);
1273 ch0 = FETCH_CHAR (temp_byte);
1274 code = SYNTAX (ch0);
1275 if (!(words_include_escapes
1276 && (code == Sescape || code == Scharquote)))
1277 if (code != Sword || WORD_BOUNDARY_P (ch0, ch1))
1278 break;
1279 DEC_BOTH (from, from_byte);
1280 ch1 = ch0;
1281 }
1282 count++;
1283 }
1284
1285 immediate_quit = 0;
1286
1287 return from;
1288 }
1289
1290 DEFUN ("forward-word", Fforward_word, Sforward_word, 0, 1, "p",
1291 doc: /* Move point forward ARG words (backward if ARG is negative).
1292 Normally returns t.
1293 If an edge of the buffer or a field boundary is reached, point is left there
1294 and the function returns nil. Field boundaries are not noticed if
1295 `inhibit-field-text-motion' is non-nil. */)
1296 (arg)
1297 Lisp_Object arg;
1298 {
1299 Lisp_Object tmp;
1300 int orig_val, val;
1301
1302 if (NILP (arg))
1303 XSETFASTINT (arg, 1);
1304 else
1305 CHECK_NUMBER (arg);
1306
1307 val = orig_val = scan_words (PT, XINT (arg));
1308 if (! orig_val)
1309 val = XINT (arg) > 0 ? ZV : BEGV;
1310
1311 /* Avoid jumping out of an input field. */
1312 tmp = Fconstrain_to_field (make_number (val), make_number (PT),
1313 Qt, Qnil, Qnil);
1314 val = XFASTINT (tmp);
1315
1316 SET_PT (val);
1317 return val == orig_val ? Qt : Qnil;
1318 }
1319 \f
1320 Lisp_Object skip_chars ();
1321
1322 DEFUN ("skip-chars-forward", Fskip_chars_forward, Sskip_chars_forward, 1, 2, 0,
1323 doc: /* Move point forward, stopping before a char not in STRING, or at pos LIM.
1324 STRING is like the inside of a `[...]' in a regular expression
1325 except that `]' is never special and `\\' quotes `^', `-' or `\\'
1326 (but not as the end of a range; quoting is never needed there).
1327 Thus, with arg "a-zA-Z", this skips letters stopping before first nonletter.
1328 With arg "^a-zA-Z", skips nonletters stopping before first letter.
1329 Char classes, e.g. `[:alpha:]', are supported.
1330
1331 Returns the distance traveled, either zero or positive. */)
1332 (string, lim)
1333 Lisp_Object string, lim;
1334 {
1335 return skip_chars (1, 0, string, lim, 1);
1336 }
1337
1338 DEFUN ("skip-chars-backward", Fskip_chars_backward, Sskip_chars_backward, 1, 2, 0,
1339 doc: /* Move point backward, stopping after a char not in STRING, or at pos LIM.
1340 See `skip-chars-forward' for details.
1341 Returns the distance traveled, either zero or negative. */)
1342 (string, lim)
1343 Lisp_Object string, lim;
1344 {
1345 return skip_chars (0, 0, string, lim, 1);
1346 }
1347
1348 DEFUN ("skip-syntax-forward", Fskip_syntax_forward, Sskip_syntax_forward, 1, 2, 0,
1349 doc: /* Move point forward across chars in specified syntax classes.
1350 SYNTAX is a string of syntax code characters.
1351 Stop before a char whose syntax is not in SYNTAX, or at position LIM.
1352 If SYNTAX starts with ^, skip characters whose syntax is NOT in SYNTAX.
1353 This function returns the distance traveled, either zero or positive. */)
1354 (syntax, lim)
1355 Lisp_Object syntax, lim;
1356 {
1357 return skip_chars (1, 1, syntax, lim, 0);
1358 }
1359
1360 DEFUN ("skip-syntax-backward", Fskip_syntax_backward, Sskip_syntax_backward, 1, 2, 0,
1361 doc: /* Move point backward across chars in specified syntax classes.
1362 SYNTAX is a string of syntax code characters.
1363 Stop on reaching a char whose syntax is not in SYNTAX, or at position LIM.
1364 If SYNTAX starts with ^, skip characters whose syntax is NOT in SYNTAX.
1365 This function returns the distance traveled, either zero or negative. */)
1366 (syntax, lim)
1367 Lisp_Object syntax, lim;
1368 {
1369 return skip_chars (0, 1, syntax, lim, 0);
1370 }
1371
1372 static Lisp_Object
1373 skip_chars (forwardp, syntaxp, string, lim, handle_iso_classes)
1374 int forwardp, syntaxp;
1375 Lisp_Object string, lim;
1376 int handle_iso_classes;
1377 {
1378 register unsigned int c;
1379 unsigned char fastmap[0400];
1380 /* If SYNTAXP is 0, STRING may contain multi-byte form of characters
1381 of which codes don't fit in FASTMAP. In that case, set the
1382 ranges of characters in CHAR_RANGES. */
1383 int *char_ranges;
1384 int n_char_ranges = 0;
1385 int negate = 0;
1386 register int i, i_byte;
1387 int multibyte = !NILP (current_buffer->enable_multibyte_characters);
1388 int string_multibyte;
1389 int size_byte;
1390 const unsigned char *str;
1391 int len;
1392 Lisp_Object iso_classes;
1393
1394 CHECK_STRING (string);
1395 char_ranges = (int *) alloca (SCHARS (string) * (sizeof (int)) * 2);
1396 string_multibyte = STRING_MULTIBYTE (string);
1397 str = SDATA (string);
1398 size_byte = SBYTES (string);
1399 iso_classes = Qnil;
1400
1401 /* Adjust the multibyteness of the string to that of the buffer. */
1402 if (multibyte != string_multibyte)
1403 {
1404 int nbytes;
1405
1406 if (multibyte)
1407 nbytes = count_size_as_multibyte (SDATA (string),
1408 SCHARS (string));
1409 else
1410 nbytes = SCHARS (string);
1411 if (nbytes != size_byte)
1412 {
1413 unsigned char *tmp = (unsigned char *) alloca (nbytes);
1414 copy_text (SDATA (string), tmp, size_byte,
1415 string_multibyte, multibyte);
1416 size_byte = nbytes;
1417 str = tmp;
1418 }
1419 }
1420
1421 if (NILP (lim))
1422 XSETINT (lim, forwardp ? ZV : BEGV);
1423 else
1424 CHECK_NUMBER_COERCE_MARKER (lim);
1425
1426 /* In any case, don't allow scan outside bounds of buffer. */
1427 if (XINT (lim) > ZV)
1428 XSETFASTINT (lim, ZV);
1429 if (XINT (lim) < BEGV)
1430 XSETFASTINT (lim, BEGV);
1431
1432 bzero (fastmap, sizeof fastmap);
1433
1434 i_byte = 0;
1435
1436 if (i_byte < size_byte
1437 && SREF (string, 0) == '^')
1438 {
1439 negate = 1; i_byte++;
1440 }
1441
1442 /* Find the characters specified and set their elements of fastmap.
1443 If syntaxp, each character counts as itself.
1444 Otherwise, handle backslashes and ranges specially. */
1445
1446 while (i_byte < size_byte)
1447 {
1448 c = STRING_CHAR_AND_LENGTH (str + i_byte, size_byte - i_byte, len);
1449 i_byte += len;
1450
1451 if (syntaxp)
1452 fastmap[syntax_spec_code[c & 0377]] = 1;
1453 else
1454 {
1455 if (handle_iso_classes && c == '['
1456 && i_byte < size_byte
1457 && STRING_CHAR (str + i_byte, size_byte - i_byte) == ':')
1458 {
1459 const unsigned char *class_beg = str + i_byte + 1;
1460 const unsigned char *class_end = class_beg;
1461 const unsigned char *class_limit = str + size_byte - 2;
1462 /* Leave room for the null. */
1463 unsigned char class_name[CHAR_CLASS_MAX_LENGTH + 1];
1464 re_wctype_t cc;
1465
1466 if (class_limit - class_beg > CHAR_CLASS_MAX_LENGTH)
1467 class_limit = class_beg + CHAR_CLASS_MAX_LENGTH;
1468
1469 while (class_end < class_limit
1470 && *class_end >= 'a' && *class_end <= 'z')
1471 class_end++;
1472
1473 if (class_end == class_beg
1474 || *class_end != ':' || class_end[1] != ']')
1475 goto not_a_class_name;
1476
1477 bcopy (class_beg, class_name, class_end - class_beg);
1478 class_name[class_end - class_beg] = 0;
1479
1480 cc = re_wctype (class_name);
1481 if (cc == 0)
1482 error ("Invalid ISO C character class");
1483
1484 iso_classes = Fcons (make_number (cc), iso_classes);
1485
1486 i_byte = class_end + 2 - str;
1487 continue;
1488 }
1489
1490 not_a_class_name:
1491 if (c == '\\')
1492 {
1493 if (i_byte == size_byte)
1494 break;
1495
1496 c = STRING_CHAR_AND_LENGTH (str + i_byte,
1497 size_byte - i_byte, len);
1498 i_byte += len;
1499 }
1500 /* Treat `-' as range character only if another character
1501 follows. */
1502 if (i_byte + 1 < size_byte
1503 && str[i_byte] == '-')
1504 {
1505 unsigned int c2;
1506
1507 /* Skip over the dash. */
1508 i_byte++;
1509
1510 /* Get the end of the range. */
1511 c2 = STRING_CHAR_AND_LENGTH (str + i_byte,
1512 size_byte - i_byte, len);
1513 i_byte += len;
1514
1515 if (SINGLE_BYTE_CHAR_P (c))
1516 {
1517 if (! SINGLE_BYTE_CHAR_P (c2))
1518 {
1519 /* Handle a range starting with a character of
1520 less than 256, and ending with a character of
1521 not less than 256. Split that into two
1522 ranges, the low one ending at 0377, and the
1523 high one starting at the smallest character
1524 in the charset of C2 and ending at C2. */
1525 int charset = CHAR_CHARSET (c2);
1526 int c1 = MAKE_CHAR (charset, 0, 0);
1527
1528 char_ranges[n_char_ranges++] = c1;
1529 char_ranges[n_char_ranges++] = c2;
1530 c2 = 0377;
1531 }
1532 while (c <= c2)
1533 {
1534 fastmap[c] = 1;
1535 c++;
1536 }
1537 }
1538 else if (c <= c2) /* Both C and C2 are multibyte char. */
1539 {
1540 char_ranges[n_char_ranges++] = c;
1541 char_ranges[n_char_ranges++] = c2;
1542 }
1543 }
1544 else
1545 {
1546 if (SINGLE_BYTE_CHAR_P (c))
1547 fastmap[c] = 1;
1548 else
1549 {
1550 char_ranges[n_char_ranges++] = c;
1551 char_ranges[n_char_ranges++] = c;
1552 }
1553 }
1554 }
1555 }
1556
1557 /* If ^ was the first character, complement the fastmap. */
1558 if (negate)
1559 for (i = 0; i < sizeof fastmap; i++)
1560 fastmap[i] ^= 1;
1561
1562 {
1563 int start_point = PT;
1564 int pos = PT;
1565 int pos_byte = PT_BYTE;
1566 unsigned char *p = PT_ADDR, *endp, *stop;
1567
1568 if (forwardp)
1569 {
1570 endp = (XINT (lim) == GPT) ? GPT_ADDR : CHAR_POS_ADDR (XINT (lim));
1571 stop = (pos < GPT && GPT < XINT (lim)) ? GPT_ADDR : endp;
1572 }
1573 else
1574 {
1575 endp = CHAR_POS_ADDR (XINT (lim));
1576 stop = (pos >= GPT && GPT > XINT (lim)) ? GAP_END_ADDR : endp;
1577 }
1578
1579 immediate_quit = 1;
1580 if (syntaxp)
1581 {
1582 SETUP_SYNTAX_TABLE (pos, forwardp ? 1 : -1);
1583 if (forwardp)
1584 {
1585 if (multibyte)
1586 while (1)
1587 {
1588 int nbytes;
1589
1590 if (p >= stop)
1591 {
1592 if (p >= endp)
1593 break;
1594 p = GAP_END_ADDR;
1595 stop = endp;
1596 }
1597 c = STRING_CHAR_AND_LENGTH (p, MAX_MULTIBYTE_LENGTH, nbytes);
1598 if (! fastmap[(int) SYNTAX (c)])
1599 break;
1600 p += nbytes, pos++, pos_byte += nbytes;
1601 UPDATE_SYNTAX_TABLE_FORWARD (pos);
1602 }
1603 else
1604 while (1)
1605 {
1606 if (p >= stop)
1607 {
1608 if (p >= endp)
1609 break;
1610 p = GAP_END_ADDR;
1611 stop = endp;
1612 }
1613 if (! fastmap[(int) SYNTAX (*p)])
1614 break;
1615 p++, pos++;
1616 UPDATE_SYNTAX_TABLE_FORWARD (pos);
1617 }
1618 }
1619 else
1620 {
1621 if (multibyte)
1622 while (1)
1623 {
1624 unsigned char *prev_p;
1625 int nbytes;
1626
1627 if (p <= stop)
1628 {
1629 if (p <= endp)
1630 break;
1631 p = GPT_ADDR;
1632 stop = endp;
1633 }
1634 prev_p = p;
1635 while (--p >= stop && ! CHAR_HEAD_P (*p));
1636 PARSE_MULTIBYTE_SEQ (p, MAX_MULTIBYTE_LENGTH, nbytes);
1637 if (prev_p - p > nbytes)
1638 p = prev_p - 1, c = *p, nbytes = 1;
1639 else
1640 c = STRING_CHAR (p, MAX_MULTIBYTE_LENGTH);
1641 pos--, pos_byte -= nbytes;
1642 UPDATE_SYNTAX_TABLE_BACKWARD (pos);
1643 if (! fastmap[(int) SYNTAX (c)])
1644 {
1645 pos++;
1646 pos_byte += nbytes;
1647 break;
1648 }
1649 }
1650 else
1651 while (1)
1652 {
1653 if (p <= stop)
1654 {
1655 if (p <= endp)
1656 break;
1657 p = GPT_ADDR;
1658 stop = endp;
1659 }
1660 if (! fastmap[(int) SYNTAX (p[-1])])
1661 break;
1662 p--, pos--;
1663 UPDATE_SYNTAX_TABLE_BACKWARD (pos - 1);
1664 }
1665 }
1666 }
1667 else
1668 {
1669 if (forwardp)
1670 {
1671 if (multibyte)
1672 while (1)
1673 {
1674 int nbytes;
1675
1676 if (p >= stop)
1677 {
1678 if (p >= endp)
1679 break;
1680 p = GAP_END_ADDR;
1681 stop = endp;
1682 }
1683 c = STRING_CHAR_AND_LENGTH (p, MAX_MULTIBYTE_LENGTH, nbytes);
1684
1685 if (! NILP (iso_classes) && in_classes (c, iso_classes))
1686 {
1687 if (negate)
1688 break;
1689 else
1690 goto fwd_ok;
1691 }
1692
1693 if (SINGLE_BYTE_CHAR_P (c))
1694 {
1695 if (!fastmap[c])
1696 break;
1697 }
1698 else
1699 {
1700 /* If we are looking at a multibyte character,
1701 we must look up the character in the table
1702 CHAR_RANGES. If there's no data in the
1703 table, that character is not what we want to
1704 skip. */
1705
1706 /* The following code do the right thing even if
1707 n_char_ranges is zero (i.e. no data in
1708 CHAR_RANGES). */
1709 for (i = 0; i < n_char_ranges; i += 2)
1710 if (c >= char_ranges[i] && c <= char_ranges[i + 1])
1711 break;
1712 if (!(negate ^ (i < n_char_ranges)))
1713 break;
1714 }
1715 fwd_ok:
1716 p += nbytes, pos++, pos_byte += nbytes;
1717 }
1718 else
1719 while (1)
1720 {
1721 if (p >= stop)
1722 {
1723 if (p >= endp)
1724 break;
1725 p = GAP_END_ADDR;
1726 stop = endp;
1727 }
1728
1729 if (!NILP (iso_classes) && in_classes (*p, iso_classes))
1730 {
1731 if (negate)
1732 break;
1733 else
1734 goto fwd_unibyte_ok;
1735 }
1736
1737 if (!fastmap[*p])
1738 break;
1739 fwd_unibyte_ok:
1740 p++, pos++;
1741 }
1742 }
1743 else
1744 {
1745 if (multibyte)
1746 while (1)
1747 {
1748 unsigned char *prev_p;
1749 int nbytes;
1750
1751 if (p <= stop)
1752 {
1753 if (p <= endp)
1754 break;
1755 p = GPT_ADDR;
1756 stop = endp;
1757 }
1758 prev_p = p;
1759 while (--p >= stop && ! CHAR_HEAD_P (*p));
1760 PARSE_MULTIBYTE_SEQ (p, MAX_MULTIBYTE_LENGTH, nbytes);
1761 if (prev_p - p > nbytes)
1762 p = prev_p - 1, c = *p, nbytes = 1;
1763 else
1764 c = STRING_CHAR (p, MAX_MULTIBYTE_LENGTH);
1765
1766 if (! NILP (iso_classes) && in_classes (c, iso_classes))
1767 {
1768 if (negate)
1769 break;
1770 else
1771 goto back_ok;
1772 }
1773
1774 if (SINGLE_BYTE_CHAR_P (c))
1775 {
1776 if (!fastmap[c])
1777 break;
1778 }
1779 else
1780 {
1781 /* See the comment in the previous similar code. */
1782 for (i = 0; i < n_char_ranges; i += 2)
1783 if (c >= char_ranges[i] && c <= char_ranges[i + 1])
1784 break;
1785 if (!(negate ^ (i < n_char_ranges)))
1786 break;
1787 }
1788 back_ok:
1789 pos--, pos_byte -= nbytes;
1790 }
1791 else
1792 while (1)
1793 {
1794 if (p <= stop)
1795 {
1796 if (p <= endp)
1797 break;
1798 p = GPT_ADDR;
1799 stop = endp;
1800 }
1801
1802 if (! NILP (iso_classes) && in_classes (p[-1], iso_classes))
1803 {
1804 if (negate)
1805 break;
1806 else
1807 goto back_unibyte_ok;
1808 }
1809
1810 if (!fastmap[p[-1]])
1811 break;
1812 back_unibyte_ok:
1813 p--, pos--;
1814 }
1815 }
1816 }
1817
1818 #if 0 /* Not needed now that a position in mid-character
1819 cannot be specified in Lisp. */
1820 if (multibyte
1821 /* INC_POS or DEC_POS might have moved POS over LIM. */
1822 && (forwardp ? (pos > XINT (lim)) : (pos < XINT (lim))))
1823 pos = XINT (lim);
1824 #endif
1825
1826 if (! multibyte)
1827 pos_byte = pos;
1828
1829 SET_PT_BOTH (pos, pos_byte);
1830 immediate_quit = 0;
1831
1832 return make_number (PT - start_point);
1833 }
1834 }
1835
1836 /* Return 1 if character C belongs to one of the ISO classes
1837 in the list ISO_CLASSES. Each class is represented by an
1838 integer which is its type according to re_wctype. */
1839
1840 static int
1841 in_classes (c, iso_classes)
1842 int c;
1843 Lisp_Object iso_classes;
1844 {
1845 int fits_class = 0;
1846
1847 while (! NILP (iso_classes))
1848 {
1849 Lisp_Object elt;
1850 elt = XCAR (iso_classes);
1851 iso_classes = XCDR (iso_classes);
1852
1853 if (re_iswctype (c, XFASTINT (elt)))
1854 fits_class = 1;
1855 }
1856
1857 return fits_class;
1858 }
1859 \f
1860 /* Jump over a comment, assuming we are at the beginning of one.
1861 FROM is the current position.
1862 FROM_BYTE is the bytepos corresponding to FROM.
1863 Do not move past STOP (a charpos).
1864 The comment over which we have to jump is of style STYLE
1865 (either SYNTAX_COMMENT_STYLE(foo) or ST_COMMENT_STYLE).
1866 NESTING should be positive to indicate the nesting at the beginning
1867 for nested comments and should be zero or negative else.
1868 ST_COMMENT_STYLE cannot be nested.
1869 PREV_SYNTAX is the SYNTAX_WITH_FLAGS of the previous character
1870 (or 0 If the search cannot start in the middle of a two-character).
1871
1872 If successful, return 1 and store the charpos of the comment's end
1873 into *CHARPOS_PTR and the corresponding bytepos into *BYTEPOS_PTR.
1874 Else, return 0 and store the charpos STOP into *CHARPOS_PTR, the
1875 corresponding bytepos into *BYTEPOS_PTR and the current nesting
1876 (as defined for state.incomment) in *INCOMMENT_PTR.
1877
1878 The comment end is the last character of the comment rather than the
1879 character just after the comment.
1880
1881 Global syntax data is assumed to initially be valid for FROM and
1882 remains valid for forward search starting at the returned position. */
1883
1884 static int
1885 forw_comment (from, from_byte, stop, nesting, style, prev_syntax,
1886 charpos_ptr, bytepos_ptr, incomment_ptr)
1887 int from, from_byte, stop;
1888 int nesting, style, prev_syntax;
1889 int *charpos_ptr, *bytepos_ptr, *incomment_ptr;
1890 {
1891 register int c, c1;
1892 register enum syntaxcode code;
1893 register int syntax;
1894
1895 if (nesting <= 0) nesting = -1;
1896
1897 /* Enter the loop in the middle so that we find
1898 a 2-char comment ender if we start in the middle of it. */
1899 syntax = prev_syntax;
1900 if (syntax != 0) goto forw_incomment;
1901
1902 while (1)
1903 {
1904 if (from == stop)
1905 {
1906 *incomment_ptr = nesting;
1907 *charpos_ptr = from;
1908 *bytepos_ptr = from_byte;
1909 return 0;
1910 }
1911 c = FETCH_CHAR (from_byte);
1912 syntax = SYNTAX_WITH_FLAGS (c);
1913 code = syntax & 0xff;
1914 if (code == Sendcomment
1915 && SYNTAX_FLAGS_COMMENT_STYLE (syntax) == style
1916 && (SYNTAX_FLAGS_COMMENT_NESTED (syntax) ?
1917 (nesting > 0 && --nesting == 0) : nesting < 0))
1918 /* we have encountered a comment end of the same style
1919 as the comment sequence which began this comment
1920 section */
1921 break;
1922 if (code == Scomment_fence
1923 && style == ST_COMMENT_STYLE)
1924 /* we have encountered a comment end of the same style
1925 as the comment sequence which began this comment
1926 section. */
1927 break;
1928 if (nesting > 0
1929 && code == Scomment
1930 && SYNTAX_FLAGS_COMMENT_NESTED (syntax)
1931 && SYNTAX_FLAGS_COMMENT_STYLE (syntax) == style)
1932 /* we have encountered a nested comment of the same style
1933 as the comment sequence which began this comment section */
1934 nesting++;
1935 INC_BOTH (from, from_byte);
1936 UPDATE_SYNTAX_TABLE_FORWARD (from);
1937
1938 forw_incomment:
1939 if (from < stop && SYNTAX_FLAGS_COMEND_FIRST (syntax)
1940 && SYNTAX_FLAGS_COMMENT_STYLE (syntax) == style
1941 && (c1 = FETCH_CHAR (from_byte),
1942 SYNTAX_COMEND_SECOND (c1))
1943 && ((SYNTAX_FLAGS_COMMENT_NESTED (syntax) ||
1944 SYNTAX_COMMENT_NESTED (c1)) ? nesting > 0 : nesting < 0))
1945 {
1946 if (--nesting <= 0)
1947 /* we have encountered a comment end of the same style
1948 as the comment sequence which began this comment
1949 section */
1950 break;
1951 else
1952 {
1953 INC_BOTH (from, from_byte);
1954 UPDATE_SYNTAX_TABLE_FORWARD (from);
1955 }
1956 }
1957 if (nesting > 0
1958 && from < stop
1959 && SYNTAX_FLAGS_COMSTART_FIRST (syntax)
1960 && (c1 = FETCH_CHAR (from_byte),
1961 SYNTAX_COMMENT_STYLE (c1) == style
1962 && SYNTAX_COMSTART_SECOND (c1))
1963 && (SYNTAX_FLAGS_COMMENT_NESTED (syntax) ||
1964 SYNTAX_COMMENT_NESTED (c1)))
1965 /* we have encountered a nested comment of the same style
1966 as the comment sequence which began this comment
1967 section */
1968 {
1969 INC_BOTH (from, from_byte);
1970 UPDATE_SYNTAX_TABLE_FORWARD (from);
1971 nesting++;
1972 }
1973 }
1974 *charpos_ptr = from;
1975 *bytepos_ptr = from_byte;
1976 return 1;
1977 }
1978
1979 DEFUN ("forward-comment", Fforward_comment, Sforward_comment, 1, 1, 0,
1980 doc: /*
1981 Move forward across up to COUNT comments. If COUNT is negative, move backward.
1982 Stop scanning if we find something other than a comment or whitespace.
1983 Set point to where scanning stops.
1984 If COUNT comments are found as expected, with nothing except whitespace
1985 between them, return t; otherwise return nil. */)
1986 (count)
1987 Lisp_Object count;
1988 {
1989 register int from;
1990 int from_byte;
1991 register int stop;
1992 register int c, c1;
1993 register enum syntaxcode code;
1994 int comstyle = 0; /* style of comment encountered */
1995 int comnested = 0; /* whether the comment is nestable or not */
1996 int found;
1997 int count1;
1998 int out_charpos, out_bytepos;
1999 int dummy;
2000
2001 CHECK_NUMBER (count);
2002 count1 = XINT (count);
2003 stop = count1 > 0 ? ZV : BEGV;
2004
2005 immediate_quit = 1;
2006 QUIT;
2007
2008 from = PT;
2009 from_byte = PT_BYTE;
2010
2011 SETUP_SYNTAX_TABLE (from, count1);
2012 while (count1 > 0)
2013 {
2014 do
2015 {
2016 int comstart_first;
2017
2018 if (from == stop)
2019 {
2020 SET_PT_BOTH (from, from_byte);
2021 immediate_quit = 0;
2022 return Qnil;
2023 }
2024 c = FETCH_CHAR (from_byte);
2025 code = SYNTAX (c);
2026 comstart_first = SYNTAX_COMSTART_FIRST (c);
2027 comnested = SYNTAX_COMMENT_NESTED (c);
2028 comstyle = SYNTAX_COMMENT_STYLE (c);
2029 INC_BOTH (from, from_byte);
2030 UPDATE_SYNTAX_TABLE_FORWARD (from);
2031 if (from < stop && comstart_first
2032 && (c1 = FETCH_CHAR (from_byte),
2033 SYNTAX_COMSTART_SECOND (c1)))
2034 {
2035 /* We have encountered a comment start sequence and we
2036 are ignoring all text inside comments. We must record
2037 the comment style this sequence begins so that later,
2038 only a comment end of the same style actually ends
2039 the comment section. */
2040 code = Scomment;
2041 comstyle = SYNTAX_COMMENT_STYLE (c1);
2042 comnested = comnested || SYNTAX_COMMENT_NESTED (c1);
2043 INC_BOTH (from, from_byte);
2044 UPDATE_SYNTAX_TABLE_FORWARD (from);
2045 }
2046 }
2047 while (code == Swhitespace || (code == Sendcomment && c == '\n'));
2048
2049 if (code == Scomment_fence)
2050 comstyle = ST_COMMENT_STYLE;
2051 else if (code != Scomment)
2052 {
2053 immediate_quit = 0;
2054 DEC_BOTH (from, from_byte);
2055 SET_PT_BOTH (from, from_byte);
2056 return Qnil;
2057 }
2058 /* We're at the start of a comment. */
2059 found = forw_comment (from, from_byte, stop, comnested, comstyle, 0,
2060 &out_charpos, &out_bytepos, &dummy);
2061 from = out_charpos; from_byte = out_bytepos;
2062 if (!found)
2063 {
2064 immediate_quit = 0;
2065 SET_PT_BOTH (from, from_byte);
2066 return Qnil;
2067 }
2068 INC_BOTH (from, from_byte);
2069 UPDATE_SYNTAX_TABLE_FORWARD (from);
2070 /* We have skipped one comment. */
2071 count1--;
2072 }
2073
2074 while (count1 < 0)
2075 {
2076 while (1)
2077 {
2078 int quoted;
2079
2080 if (from <= stop)
2081 {
2082 SET_PT_BOTH (BEGV, BEGV_BYTE);
2083 immediate_quit = 0;
2084 return Qnil;
2085 }
2086
2087 DEC_BOTH (from, from_byte);
2088 /* char_quoted does UPDATE_SYNTAX_TABLE_BACKWARD (from). */
2089 quoted = char_quoted (from, from_byte);
2090 c = FETCH_CHAR (from_byte);
2091 code = SYNTAX (c);
2092 comstyle = 0;
2093 comnested = SYNTAX_COMMENT_NESTED (c);
2094 if (code == Sendcomment)
2095 comstyle = SYNTAX_COMMENT_STYLE (c);
2096 if (from > stop && SYNTAX_COMEND_SECOND (c)
2097 && prev_char_comend_first (from, from_byte)
2098 && !char_quoted (from - 1, dec_bytepos (from_byte)))
2099 {
2100 /* We must record the comment style encountered so that
2101 later, we can match only the proper comment begin
2102 sequence of the same style. */
2103 DEC_BOTH (from, from_byte);
2104 code = Sendcomment;
2105 /* Calling char_quoted, above, set up global syntax position
2106 at the new value of FROM. */
2107 c1 = FETCH_CHAR (from_byte);
2108 comstyle = SYNTAX_COMMENT_STYLE (c1);
2109 comnested = comnested || SYNTAX_COMMENT_NESTED (c1);
2110 }
2111
2112 if (code == Scomment_fence)
2113 {
2114 /* Skip until first preceding unquoted comment_fence. */
2115 int found = 0, ini = from, ini_byte = from_byte;
2116
2117 while (1)
2118 {
2119 DEC_BOTH (from, from_byte);
2120 if (from == stop)
2121 break;
2122 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2123 c = FETCH_CHAR (from_byte);
2124 if (SYNTAX (c) == Scomment_fence
2125 && !char_quoted (from, from_byte))
2126 {
2127 found = 1;
2128 break;
2129 }
2130 }
2131 if (found == 0)
2132 {
2133 from = ini; /* Set point to ini + 1. */
2134 from_byte = ini_byte;
2135 goto leave;
2136 }
2137 }
2138 else if (code == Sendcomment)
2139 {
2140 found = back_comment (from, from_byte, stop, comnested, comstyle,
2141 &out_charpos, &out_bytepos);
2142 if (found == -1)
2143 {
2144 if (c == '\n')
2145 /* This end-of-line is not an end-of-comment.
2146 Treat it like a whitespace.
2147 CC-mode (and maybe others) relies on this behavior. */
2148 ;
2149 else
2150 {
2151 /* Failure: we should go back to the end of this
2152 not-quite-endcomment. */
2153 if (SYNTAX(c) != code)
2154 /* It was a two-char Sendcomment. */
2155 INC_BOTH (from, from_byte);
2156 goto leave;
2157 }
2158 }
2159 else
2160 {
2161 /* We have skipped one comment. */
2162 from = out_charpos, from_byte = out_bytepos;
2163 break;
2164 }
2165 }
2166 else if (code != Swhitespace || quoted)
2167 {
2168 leave:
2169 immediate_quit = 0;
2170 INC_BOTH (from, from_byte);
2171 SET_PT_BOTH (from, from_byte);
2172 return Qnil;
2173 }
2174 }
2175
2176 count1++;
2177 }
2178
2179 SET_PT_BOTH (from, from_byte);
2180 immediate_quit = 0;
2181 return Qt;
2182 }
2183 \f
2184 /* Return syntax code of character C if C is a single byte character
2185 or `multibyte_symbol_p' is zero. Otherwise, return Ssymbol. */
2186
2187 #define SYNTAX_WITH_MULTIBYTE_CHECK(c) \
2188 ((SINGLE_BYTE_CHAR_P (c) || !multibyte_symbol_p) \
2189 ? SYNTAX (c) : Ssymbol)
2190
2191 static Lisp_Object
2192 scan_lists (from, count, depth, sexpflag)
2193 register int from;
2194 int count, depth, sexpflag;
2195 {
2196 Lisp_Object val;
2197 register int stop = count > 0 ? ZV : BEGV;
2198 register int c, c1;
2199 int stringterm;
2200 int quoted;
2201 int mathexit = 0;
2202 register enum syntaxcode code, temp_code;
2203 int min_depth = depth; /* Err out if depth gets less than this. */
2204 int comstyle = 0; /* style of comment encountered */
2205 int comnested = 0; /* whether the comment is nestable or not */
2206 int temp_pos;
2207 int last_good = from;
2208 int found;
2209 int from_byte;
2210 int out_bytepos, out_charpos;
2211 int temp, dummy;
2212 int multibyte_symbol_p = sexpflag && multibyte_syntax_as_symbol;
2213
2214 if (depth > 0) min_depth = 0;
2215
2216 if (from > ZV) from = ZV;
2217 if (from < BEGV) from = BEGV;
2218
2219 from_byte = CHAR_TO_BYTE (from);
2220
2221 immediate_quit = 1;
2222 QUIT;
2223
2224 SETUP_SYNTAX_TABLE (from, count);
2225 while (count > 0)
2226 {
2227 while (from < stop)
2228 {
2229 int comstart_first, prefix;
2230 UPDATE_SYNTAX_TABLE_FORWARD (from);
2231 c = FETCH_CHAR (from_byte);
2232 code = SYNTAX_WITH_MULTIBYTE_CHECK (c);
2233 comstart_first = SYNTAX_COMSTART_FIRST (c);
2234 comnested = SYNTAX_COMMENT_NESTED (c);
2235 comstyle = SYNTAX_COMMENT_STYLE (c);
2236 prefix = SYNTAX_PREFIX (c);
2237 if (depth == min_depth)
2238 last_good = from;
2239 INC_BOTH (from, from_byte);
2240 UPDATE_SYNTAX_TABLE_FORWARD (from);
2241 if (from < stop && comstart_first
2242 && (c = FETCH_CHAR (from_byte), SYNTAX_COMSTART_SECOND (c))
2243 && parse_sexp_ignore_comments)
2244 {
2245 /* we have encountered a comment start sequence and we
2246 are ignoring all text inside comments. We must record
2247 the comment style this sequence begins so that later,
2248 only a comment end of the same style actually ends
2249 the comment section */
2250 code = Scomment;
2251 c1 = FETCH_CHAR (from_byte);
2252 comstyle = SYNTAX_COMMENT_STYLE (c1);
2253 comnested = comnested || SYNTAX_COMMENT_NESTED (c1);
2254 INC_BOTH (from, from_byte);
2255 UPDATE_SYNTAX_TABLE_FORWARD (from);
2256 }
2257
2258 if (prefix)
2259 continue;
2260
2261 switch (SWITCH_ENUM_CAST (code))
2262 {
2263 case Sescape:
2264 case Scharquote:
2265 if (from == stop) goto lose;
2266 INC_BOTH (from, from_byte);
2267 /* treat following character as a word constituent */
2268 case Sword:
2269 case Ssymbol:
2270 if (depth || !sexpflag) break;
2271 /* This word counts as a sexp; return at end of it. */
2272 while (from < stop)
2273 {
2274 UPDATE_SYNTAX_TABLE_FORWARD (from);
2275
2276 /* Some compilers can't handle this inside the switch. */
2277 c = FETCH_CHAR (from_byte);
2278 temp = SYNTAX_WITH_MULTIBYTE_CHECK (c);
2279 switch (temp)
2280 {
2281 case Scharquote:
2282 case Sescape:
2283 INC_BOTH (from, from_byte);
2284 if (from == stop) goto lose;
2285 break;
2286 case Sword:
2287 case Ssymbol:
2288 case Squote:
2289 break;
2290 default:
2291 goto done;
2292 }
2293 INC_BOTH (from, from_byte);
2294 }
2295 goto done;
2296
2297 case Scomment_fence:
2298 comstyle = ST_COMMENT_STYLE;
2299 /* FALLTHROUGH */
2300 case Scomment:
2301 if (!parse_sexp_ignore_comments) break;
2302 UPDATE_SYNTAX_TABLE_FORWARD (from);
2303 found = forw_comment (from, from_byte, stop,
2304 comnested, comstyle, 0,
2305 &out_charpos, &out_bytepos, &dummy);
2306 from = out_charpos, from_byte = out_bytepos;
2307 if (!found)
2308 {
2309 if (depth == 0)
2310 goto done;
2311 goto lose;
2312 }
2313 INC_BOTH (from, from_byte);
2314 UPDATE_SYNTAX_TABLE_FORWARD (from);
2315 break;
2316
2317 case Smath:
2318 if (!sexpflag)
2319 break;
2320 if (from != stop && c == FETCH_CHAR (from_byte))
2321 {
2322 INC_BOTH (from, from_byte);
2323 }
2324 if (mathexit)
2325 {
2326 mathexit = 0;
2327 goto close1;
2328 }
2329 mathexit = 1;
2330
2331 case Sopen:
2332 if (!++depth) goto done;
2333 break;
2334
2335 case Sclose:
2336 close1:
2337 if (!--depth) goto done;
2338 if (depth < min_depth)
2339 Fsignal (Qscan_error,
2340 Fcons (build_string ("Containing expression ends prematurely"),
2341 Fcons (make_number (last_good),
2342 Fcons (make_number (from), Qnil))));
2343 break;
2344
2345 case Sstring:
2346 case Sstring_fence:
2347 temp_pos = dec_bytepos (from_byte);
2348 stringterm = FETCH_CHAR (temp_pos);
2349 while (1)
2350 {
2351 if (from >= stop) goto lose;
2352 UPDATE_SYNTAX_TABLE_FORWARD (from);
2353 c = FETCH_CHAR (from_byte);
2354 if (code == Sstring
2355 ? (c == stringterm
2356 && SYNTAX_WITH_MULTIBYTE_CHECK (c) == Sstring)
2357 : SYNTAX_WITH_MULTIBYTE_CHECK (c) == Sstring_fence)
2358 break;
2359
2360 /* Some compilers can't handle this inside the switch. */
2361 temp = SYNTAX_WITH_MULTIBYTE_CHECK (c);
2362 switch (temp)
2363 {
2364 case Scharquote:
2365 case Sescape:
2366 INC_BOTH (from, from_byte);
2367 }
2368 INC_BOTH (from, from_byte);
2369 }
2370 INC_BOTH (from, from_byte);
2371 if (!depth && sexpflag) goto done;
2372 break;
2373 default:
2374 /* Ignore whitespace, punctuation, quote, endcomment. */
2375 break;
2376 }
2377 }
2378
2379 /* Reached end of buffer. Error if within object, return nil if between */
2380 if (depth) goto lose;
2381
2382 immediate_quit = 0;
2383 return Qnil;
2384
2385 /* End of object reached */
2386 done:
2387 count--;
2388 }
2389
2390 while (count < 0)
2391 {
2392 while (from > stop)
2393 {
2394 DEC_BOTH (from, from_byte);
2395 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2396 c = FETCH_CHAR (from_byte);
2397 code = SYNTAX_WITH_MULTIBYTE_CHECK (c);
2398 if (depth == min_depth)
2399 last_good = from;
2400 comstyle = 0;
2401 comnested = SYNTAX_COMMENT_NESTED (c);
2402 if (code == Sendcomment)
2403 comstyle = SYNTAX_COMMENT_STYLE (c);
2404 if (from > stop && SYNTAX_COMEND_SECOND (c)
2405 && prev_char_comend_first (from, from_byte)
2406 && parse_sexp_ignore_comments)
2407 {
2408 /* We must record the comment style encountered so that
2409 later, we can match only the proper comment begin
2410 sequence of the same style. */
2411 DEC_BOTH (from, from_byte);
2412 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2413 code = Sendcomment;
2414 c1 = FETCH_CHAR (from_byte);
2415 comstyle = SYNTAX_COMMENT_STYLE (c1);
2416 comnested = comnested || SYNTAX_COMMENT_NESTED (c1);
2417 }
2418
2419 /* Quoting turns anything except a comment-ender
2420 into a word character. Note that this cannot be true
2421 if we decremented FROM in the if-statement above. */
2422 if (code != Sendcomment && char_quoted (from, from_byte))
2423 {
2424 DEC_BOTH (from, from_byte);
2425 code = Sword;
2426 }
2427 else if (SYNTAX_PREFIX (c))
2428 continue;
2429
2430 switch (SWITCH_ENUM_CAST (code))
2431 {
2432 case Sword:
2433 case Ssymbol:
2434 case Sescape:
2435 case Scharquote:
2436 if (depth || !sexpflag) break;
2437 /* This word counts as a sexp; count object finished
2438 after passing it. */
2439 while (from > stop)
2440 {
2441 temp_pos = from_byte;
2442 if (! NILP (current_buffer->enable_multibyte_characters))
2443 DEC_POS (temp_pos);
2444 else
2445 temp_pos--;
2446 UPDATE_SYNTAX_TABLE_BACKWARD (from - 1);
2447 c1 = FETCH_CHAR (temp_pos);
2448 temp_code = SYNTAX_WITH_MULTIBYTE_CHECK (c1);
2449 /* Don't allow comment-end to be quoted. */
2450 if (temp_code == Sendcomment)
2451 goto done2;
2452 quoted = char_quoted (from - 1, temp_pos);
2453 if (quoted)
2454 {
2455 DEC_BOTH (from, from_byte);
2456 temp_pos = dec_bytepos (temp_pos);
2457 UPDATE_SYNTAX_TABLE_BACKWARD (from - 1);
2458 }
2459 c1 = FETCH_CHAR (temp_pos);
2460 temp_code = SYNTAX_WITH_MULTIBYTE_CHECK (c1);
2461 if (! (quoted || temp_code == Sword
2462 || temp_code == Ssymbol
2463 || temp_code == Squote))
2464 goto done2;
2465 DEC_BOTH (from, from_byte);
2466 }
2467 goto done2;
2468
2469 case Smath:
2470 if (!sexpflag)
2471 break;
2472 temp_pos = dec_bytepos (from_byte);
2473 UPDATE_SYNTAX_TABLE_BACKWARD (from - 1);
2474 if (from != stop && c == FETCH_CHAR (temp_pos))
2475 DEC_BOTH (from, from_byte);
2476 if (mathexit)
2477 {
2478 mathexit = 0;
2479 goto open2;
2480 }
2481 mathexit = 1;
2482
2483 case Sclose:
2484 if (!++depth) goto done2;
2485 break;
2486
2487 case Sopen:
2488 open2:
2489 if (!--depth) goto done2;
2490 if (depth < min_depth)
2491 Fsignal (Qscan_error,
2492 Fcons (build_string ("Containing expression ends prematurely"),
2493 Fcons (make_number (last_good),
2494 Fcons (make_number (from), Qnil))));
2495 break;
2496
2497 case Sendcomment:
2498 if (!parse_sexp_ignore_comments)
2499 break;
2500 found = back_comment (from, from_byte, stop, comnested, comstyle,
2501 &out_charpos, &out_bytepos);
2502 /* FIXME: if found == -1, then it really wasn't a comment-end.
2503 For single-char Sendcomment, we can't do much about it apart
2504 from skipping the char.
2505 For 2-char endcomments, we could try again, taking both
2506 chars as separate entities, but it's a lot of trouble
2507 for very little gain, so we don't bother either. -sm */
2508 if (found != -1)
2509 from = out_charpos, from_byte = out_bytepos;
2510 break;
2511
2512 case Scomment_fence:
2513 case Sstring_fence:
2514 while (1)
2515 {
2516 if (from == stop) goto lose;
2517 DEC_BOTH (from, from_byte);
2518 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2519 if (!char_quoted (from, from_byte)
2520 && (c = FETCH_CHAR (from_byte),
2521 SYNTAX_WITH_MULTIBYTE_CHECK (c) == code))
2522 break;
2523 }
2524 if (code == Sstring_fence && !depth && sexpflag) goto done2;
2525 break;
2526
2527 case Sstring:
2528 stringterm = FETCH_CHAR (from_byte);
2529 while (1)
2530 {
2531 if (from == stop) goto lose;
2532 DEC_BOTH (from, from_byte);
2533 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2534 if (!char_quoted (from, from_byte)
2535 && stringterm == (c = FETCH_CHAR (from_byte))
2536 && SYNTAX_WITH_MULTIBYTE_CHECK (c) == Sstring)
2537 break;
2538 }
2539 if (!depth && sexpflag) goto done2;
2540 break;
2541 default:
2542 /* Ignore whitespace, punctuation, quote, endcomment. */
2543 break;
2544 }
2545 }
2546
2547 /* Reached start of buffer. Error if within object, return nil if between */
2548 if (depth) goto lose;
2549
2550 immediate_quit = 0;
2551 return Qnil;
2552
2553 done2:
2554 count++;
2555 }
2556
2557
2558 immediate_quit = 0;
2559 XSETFASTINT (val, from);
2560 return val;
2561
2562 lose:
2563 Fsignal (Qscan_error,
2564 Fcons (build_string ("Unbalanced parentheses"),
2565 Fcons (make_number (last_good),
2566 Fcons (make_number (from), Qnil))));
2567 abort ();
2568 /* NOTREACHED */
2569 }
2570
2571 DEFUN ("scan-lists", Fscan_lists, Sscan_lists, 3, 3, 0,
2572 doc: /* Scan from character number FROM by COUNT lists.
2573 Returns the character number of the position thus found.
2574
2575 If DEPTH is nonzero, paren depth begins counting from that value,
2576 only places where the depth in parentheses becomes zero
2577 are candidates for stopping; COUNT such places are counted.
2578 Thus, a positive value for DEPTH means go out levels.
2579
2580 Comments are ignored if `parse-sexp-ignore-comments' is non-nil.
2581
2582 If the beginning or end of (the accessible part of) the buffer is reached
2583 and the depth is wrong, an error is signaled.
2584 If the depth is right but the count is not used up, nil is returned. */)
2585 (from, count, depth)
2586 Lisp_Object from, count, depth;
2587 {
2588 CHECK_NUMBER (from);
2589 CHECK_NUMBER (count);
2590 CHECK_NUMBER (depth);
2591
2592 return scan_lists (XINT (from), XINT (count), XINT (depth), 0);
2593 }
2594
2595 DEFUN ("scan-sexps", Fscan_sexps, Sscan_sexps, 2, 2, 0,
2596 doc: /* Scan from character number FROM by COUNT balanced expressions.
2597 If COUNT is negative, scan backwards.
2598 Returns the character number of the position thus found.
2599
2600 Comments are ignored if `parse-sexp-ignore-comments' is non-nil.
2601
2602 If the beginning or end of (the accessible part of) the buffer is reached
2603 in the middle of a parenthetical grouping, an error is signaled.
2604 If the beginning or end is reached between groupings
2605 but before count is used up, nil is returned. */)
2606 (from, count)
2607 Lisp_Object from, count;
2608 {
2609 CHECK_NUMBER (from);
2610 CHECK_NUMBER (count);
2611
2612 return scan_lists (XINT (from), XINT (count), 0, 1);
2613 }
2614
2615 DEFUN ("backward-prefix-chars", Fbackward_prefix_chars, Sbackward_prefix_chars,
2616 0, 0, 0,
2617 doc: /* Move point backward over any number of chars with prefix syntax.
2618 This includes chars with "quote" or "prefix" syntax (' or p). */)
2619 ()
2620 {
2621 int beg = BEGV;
2622 int opoint = PT;
2623 int opoint_byte = PT_BYTE;
2624 int pos = PT;
2625 int pos_byte = PT_BYTE;
2626 int c;
2627
2628 if (pos <= beg)
2629 {
2630 SET_PT_BOTH (opoint, opoint_byte);
2631
2632 return Qnil;
2633 }
2634
2635 SETUP_SYNTAX_TABLE (pos, -1);
2636
2637 DEC_BOTH (pos, pos_byte);
2638
2639 while (!char_quoted (pos, pos_byte)
2640 /* Previous statement updates syntax table. */
2641 && ((c = FETCH_CHAR (pos_byte), SYNTAX (c) == Squote)
2642 || SYNTAX_PREFIX (c)))
2643 {
2644 opoint = pos;
2645 opoint_byte = pos_byte;
2646
2647 if (pos + 1 > beg)
2648 DEC_BOTH (pos, pos_byte);
2649 }
2650
2651 SET_PT_BOTH (opoint, opoint_byte);
2652
2653 return Qnil;
2654 }
2655 \f
2656 /* Parse forward from FROM / FROM_BYTE to END,
2657 assuming that FROM has state OLDSTATE (nil means FROM is start of function),
2658 and return a description of the state of the parse at END.
2659 If STOPBEFORE is nonzero, stop at the start of an atom.
2660 If COMMENTSTOP is 1, stop at the start of a comment.
2661 If COMMENTSTOP is -1, stop at the start or end of a comment,
2662 after the beginning of a string, or after the end of a string. */
2663
2664 static void
2665 scan_sexps_forward (stateptr, from, from_byte, end, targetdepth,
2666 stopbefore, oldstate, commentstop)
2667 struct lisp_parse_state *stateptr;
2668 register int from;
2669 int end, targetdepth, stopbefore, from_byte;
2670 Lisp_Object oldstate;
2671 int commentstop;
2672 {
2673 struct lisp_parse_state state;
2674
2675 register enum syntaxcode code;
2676 int c1;
2677 int comnested;
2678 struct level { int last, prev; };
2679 struct level levelstart[100];
2680 register struct level *curlevel = levelstart;
2681 struct level *endlevel = levelstart + 100;
2682 register int depth; /* Paren depth of current scanning location.
2683 level - levelstart equals this except
2684 when the depth becomes negative. */
2685 int mindepth; /* Lowest DEPTH value seen. */
2686 int start_quoted = 0; /* Nonzero means starting after a char quote */
2687 Lisp_Object tem;
2688 int prev_from; /* Keep one character before FROM. */
2689 int prev_from_byte;
2690 int prev_from_syntax;
2691 int boundary_stop = commentstop == -1;
2692 int nofence;
2693 int found;
2694 int out_bytepos, out_charpos;
2695 int temp;
2696
2697 prev_from = from;
2698 prev_from_byte = from_byte;
2699 if (from != BEGV)
2700 DEC_BOTH (prev_from, prev_from_byte);
2701
2702 /* Use this macro instead of `from++'. */
2703 #define INC_FROM \
2704 do { prev_from = from; \
2705 prev_from_byte = from_byte; \
2706 temp = FETCH_CHAR (prev_from_byte); \
2707 prev_from_syntax = SYNTAX_WITH_FLAGS (temp); \
2708 INC_BOTH (from, from_byte); \
2709 if (from < end) \
2710 UPDATE_SYNTAX_TABLE_FORWARD (from); \
2711 } while (0)
2712
2713 immediate_quit = 1;
2714 QUIT;
2715
2716 if (NILP (oldstate))
2717 {
2718 depth = 0;
2719 state.instring = -1;
2720 state.incomment = 0;
2721 state.comstyle = 0; /* comment style a by default. */
2722 state.comstr_start = -1; /* no comment/string seen. */
2723 }
2724 else
2725 {
2726 tem = Fcar (oldstate);
2727 if (!NILP (tem))
2728 depth = XINT (tem);
2729 else
2730 depth = 0;
2731
2732 oldstate = Fcdr (oldstate);
2733 oldstate = Fcdr (oldstate);
2734 oldstate = Fcdr (oldstate);
2735 tem = Fcar (oldstate);
2736 /* Check whether we are inside string_fence-style string: */
2737 state.instring = (!NILP (tem)
2738 ? (INTEGERP (tem) ? XINT (tem) : ST_STRING_STYLE)
2739 : -1);
2740
2741 oldstate = Fcdr (oldstate);
2742 tem = Fcar (oldstate);
2743 state.incomment = (!NILP (tem)
2744 ? (INTEGERP (tem) ? XINT (tem) : -1)
2745 : 0);
2746
2747 oldstate = Fcdr (oldstate);
2748 tem = Fcar (oldstate);
2749 start_quoted = !NILP (tem);
2750
2751 /* if the eighth element of the list is nil, we are in comment
2752 style a. If it is non-nil, we are in comment style b */
2753 oldstate = Fcdr (oldstate);
2754 oldstate = Fcdr (oldstate);
2755 tem = Fcar (oldstate);
2756 state.comstyle = NILP (tem) ? 0 : (EQ (tem, Qsyntax_table)
2757 ? ST_COMMENT_STYLE : 1);
2758
2759 oldstate = Fcdr (oldstate);
2760 tem = Fcar (oldstate);
2761 state.comstr_start = NILP (tem) ? -1 : XINT (tem) ;
2762 oldstate = Fcdr (oldstate);
2763 tem = Fcar (oldstate);
2764 while (!NILP (tem)) /* >= second enclosing sexps. */
2765 {
2766 /* curlevel++->last ran into compiler bug on Apollo */
2767 curlevel->last = XINT (Fcar (tem));
2768 if (++curlevel == endlevel)
2769 curlevel--; /* error ("Nesting too deep for parser"); */
2770 curlevel->prev = -1;
2771 curlevel->last = -1;
2772 tem = Fcdr (tem);
2773 }
2774 }
2775 state.quoted = 0;
2776 mindepth = depth;
2777
2778 curlevel->prev = -1;
2779 curlevel->last = -1;
2780
2781 SETUP_SYNTAX_TABLE (prev_from, 1);
2782 temp = FETCH_CHAR (prev_from_byte);
2783 prev_from_syntax = SYNTAX_WITH_FLAGS (temp);
2784 UPDATE_SYNTAX_TABLE_FORWARD (from);
2785
2786 /* Enter the loop at a place appropriate for initial state. */
2787
2788 if (state.incomment)
2789 goto startincomment;
2790 if (state.instring >= 0)
2791 {
2792 nofence = state.instring != ST_STRING_STYLE;
2793 if (start_quoted)
2794 goto startquotedinstring;
2795 goto startinstring;
2796 }
2797 else if (start_quoted)
2798 goto startquoted;
2799
2800 while (from < end)
2801 {
2802 INC_FROM;
2803 code = prev_from_syntax & 0xff;
2804
2805 if (from < end
2806 && SYNTAX_FLAGS_COMSTART_FIRST (prev_from_syntax)
2807 && (c1 = FETCH_CHAR (from_byte),
2808 SYNTAX_COMSTART_SECOND (c1)))
2809 /* Duplicate code to avoid a complex if-expression
2810 which causes trouble for the SGI compiler. */
2811 {
2812 /* Record the comment style we have entered so that only
2813 the comment-end sequence of the same style actually
2814 terminates the comment section. */
2815 state.comstyle = SYNTAX_COMMENT_STYLE (c1);
2816 comnested = SYNTAX_FLAGS_COMMENT_NESTED (prev_from_syntax);
2817 comnested = comnested || SYNTAX_COMMENT_NESTED (c1);
2818 state.incomment = comnested ? 1 : -1;
2819 state.comstr_start = prev_from;
2820 INC_FROM;
2821 code = Scomment;
2822 }
2823 else if (code == Scomment_fence)
2824 {
2825 /* Record the comment style we have entered so that only
2826 the comment-end sequence of the same style actually
2827 terminates the comment section. */
2828 state.comstyle = ST_COMMENT_STYLE;
2829 state.incomment = -1;
2830 state.comstr_start = prev_from;
2831 code = Scomment;
2832 }
2833 else if (code == Scomment)
2834 {
2835 state.comstyle = SYNTAX_FLAGS_COMMENT_STYLE (prev_from_syntax);
2836 state.incomment = (SYNTAX_FLAGS_COMMENT_NESTED (prev_from_syntax) ?
2837 1 : -1);
2838 state.comstr_start = prev_from;
2839 }
2840
2841 if (SYNTAX_FLAGS_PREFIX (prev_from_syntax))
2842 continue;
2843 switch (SWITCH_ENUM_CAST (code))
2844 {
2845 case Sescape:
2846 case Scharquote:
2847 if (stopbefore) goto stop; /* this arg means stop at sexp start */
2848 curlevel->last = prev_from;
2849 startquoted:
2850 if (from == end) goto endquoted;
2851 INC_FROM;
2852 goto symstarted;
2853 /* treat following character as a word constituent */
2854 case Sword:
2855 case Ssymbol:
2856 if (stopbefore) goto stop; /* this arg means stop at sexp start */
2857 curlevel->last = prev_from;
2858 symstarted:
2859 while (from < end)
2860 {
2861 /* Some compilers can't handle this inside the switch. */
2862 temp = FETCH_CHAR (from_byte);
2863 temp = SYNTAX (temp);
2864 switch (temp)
2865 {
2866 case Scharquote:
2867 case Sescape:
2868 INC_FROM;
2869 if (from == end) goto endquoted;
2870 break;
2871 case Sword:
2872 case Ssymbol:
2873 case Squote:
2874 break;
2875 default:
2876 goto symdone;
2877 }
2878 INC_FROM;
2879 }
2880 symdone:
2881 curlevel->prev = curlevel->last;
2882 break;
2883
2884 case Scomment_fence: /* Can't happen because it's handled above. */
2885 case Scomment:
2886 if (commentstop || boundary_stop) goto done;
2887 startincomment:
2888 /* The (from == BEGV) test was to enter the loop in the middle so
2889 that we find a 2-char comment ender even if we start in the
2890 middle of it. We don't want to do that if we're just at the
2891 beginning of the comment (think of (*) ... (*)). */
2892 found = forw_comment (from, from_byte, end,
2893 state.incomment, state.comstyle,
2894 (from == BEGV || from < state.comstr_start + 3)
2895 ? 0 : prev_from_syntax,
2896 &out_charpos, &out_bytepos, &state.incomment);
2897 from = out_charpos; from_byte = out_bytepos;
2898 /* Beware! prev_from and friends are invalid now.
2899 Luckily, the `done' doesn't use them and the INC_FROM
2900 sets them to a sane value without looking at them. */
2901 if (!found) goto done;
2902 INC_FROM;
2903 state.incomment = 0;
2904 state.comstyle = 0; /* reset the comment style */
2905 if (boundary_stop) goto done;
2906 break;
2907
2908 case Sopen:
2909 if (stopbefore) goto stop; /* this arg means stop at sexp start */
2910 depth++;
2911 /* curlevel++->last ran into compiler bug on Apollo */
2912 curlevel->last = prev_from;
2913 if (++curlevel == endlevel)
2914 curlevel--; /* error ("Nesting too deep for parser"); */
2915 curlevel->prev = -1;
2916 curlevel->last = -1;
2917 if (targetdepth == depth) goto done;
2918 break;
2919
2920 case Sclose:
2921 depth--;
2922 if (depth < mindepth)
2923 mindepth = depth;
2924 if (curlevel != levelstart)
2925 curlevel--;
2926 curlevel->prev = curlevel->last;
2927 if (targetdepth == depth) goto done;
2928 break;
2929
2930 case Sstring:
2931 case Sstring_fence:
2932 state.comstr_start = from - 1;
2933 if (stopbefore) goto stop; /* this arg means stop at sexp start */
2934 curlevel->last = prev_from;
2935 state.instring = (code == Sstring
2936 ? (FETCH_CHAR (prev_from_byte))
2937 : ST_STRING_STYLE);
2938 if (boundary_stop) goto done;
2939 startinstring:
2940 {
2941 nofence = state.instring != ST_STRING_STYLE;
2942
2943 while (1)
2944 {
2945 int c;
2946
2947 if (from >= end) goto done;
2948 c = FETCH_CHAR (from_byte);
2949 /* Some compilers can't handle this inside the switch. */
2950 temp = SYNTAX (c);
2951
2952 /* Check TEMP here so that if the char has
2953 a syntax-table property which says it is NOT
2954 a string character, it does not end the string. */
2955 if (nofence && c == state.instring && temp == Sstring)
2956 break;
2957
2958 switch (temp)
2959 {
2960 case Sstring_fence:
2961 if (!nofence) goto string_end;
2962 break;
2963 case Scharquote:
2964 case Sescape:
2965 INC_FROM;
2966 startquotedinstring:
2967 if (from >= end) goto endquoted;
2968 }
2969 INC_FROM;
2970 }
2971 }
2972 string_end:
2973 state.instring = -1;
2974 curlevel->prev = curlevel->last;
2975 INC_FROM;
2976 if (boundary_stop) goto done;
2977 break;
2978
2979 case Smath:
2980 /* FIXME: We should do something with it. */
2981 break;
2982 default:
2983 /* Ignore whitespace, punctuation, quote, endcomment. */
2984 break;
2985 }
2986 }
2987 goto done;
2988
2989 stop: /* Here if stopping before start of sexp. */
2990 from = prev_from; /* We have just fetched the char that starts it; */
2991 goto done; /* but return the position before it. */
2992
2993 endquoted:
2994 state.quoted = 1;
2995 done:
2996 state.depth = depth;
2997 state.mindepth = mindepth;
2998 state.thislevelstart = curlevel->prev;
2999 state.prevlevelstart
3000 = (curlevel == levelstart) ? -1 : (curlevel - 1)->last;
3001 state.location = from;
3002 state.levelstarts = Qnil;
3003 while (--curlevel >= levelstart)
3004 state.levelstarts = Fcons (make_number (curlevel->last),
3005 state.levelstarts);
3006 immediate_quit = 0;
3007
3008 *stateptr = state;
3009 }
3010
3011 DEFUN ("parse-partial-sexp", Fparse_partial_sexp, Sparse_partial_sexp, 2, 6, 0,
3012 doc: /* Parse Lisp syntax starting at FROM until TO; return status of parse at TO.
3013 Parsing stops at TO or when certain criteria are met;
3014 point is set to where parsing stops.
3015 If fifth arg OLDSTATE is omitted or nil,
3016 parsing assumes that FROM is the beginning of a function.
3017 Value is a list of ten elements describing final state of parsing:
3018 0. depth in parens.
3019 1. character address of start of innermost containing list; nil if none.
3020 2. character address of start of last complete sexp terminated.
3021 3. non-nil if inside a string.
3022 (it is the character that will terminate the string,
3023 or t if the string should be terminated by a generic string delimiter.)
3024 4. nil if outside a comment, t if inside a non-nestable comment,
3025 else an integer (the current comment nesting).
3026 5. t if following a quote character.
3027 6. the minimum paren-depth encountered during this scan.
3028 7. t if in a comment of style b; symbol `syntax-table' if the comment
3029 should be terminated by a generic comment delimiter.
3030 8. character address of start of comment or string; nil if not in one.
3031 9. Intermediate data for continuation of parsing (subject to change).
3032 If third arg TARGETDEPTH is non-nil, parsing stops if the depth
3033 in parentheses becomes equal to TARGETDEPTH.
3034 Fourth arg STOPBEFORE non-nil means stop when come to
3035 any character that starts a sexp.
3036 Fifth arg OLDSTATE is a nine-element list like what this function returns.
3037 It is used to initialize the state of the parse. Elements number 1, 2, 6
3038 and 8 are ignored; you can leave off element 8 (the last) entirely.
3039 Sixth arg COMMENTSTOP non-nil means stop at the start of a comment.
3040 If it is symbol `syntax-table', stop after the start of a comment or a
3041 string, or after end of a comment or a string. */)
3042 (from, to, targetdepth, stopbefore, oldstate, commentstop)
3043 Lisp_Object from, to, targetdepth, stopbefore, oldstate, commentstop;
3044 {
3045 struct lisp_parse_state state;
3046 int target;
3047
3048 if (!NILP (targetdepth))
3049 {
3050 CHECK_NUMBER (targetdepth);
3051 target = XINT (targetdepth);
3052 }
3053 else
3054 target = -100000; /* We won't reach this depth */
3055
3056 validate_region (&from, &to);
3057 scan_sexps_forward (&state, XINT (from), CHAR_TO_BYTE (XINT (from)),
3058 XINT (to),
3059 target, !NILP (stopbefore), oldstate,
3060 (NILP (commentstop)
3061 ? 0 : (EQ (commentstop, Qsyntax_table) ? -1 : 1)));
3062
3063 SET_PT (state.location);
3064
3065 return Fcons (make_number (state.depth),
3066 Fcons (state.prevlevelstart < 0 ? Qnil : make_number (state.prevlevelstart),
3067 Fcons (state.thislevelstart < 0 ? Qnil : make_number (state.thislevelstart),
3068 Fcons (state.instring >= 0
3069 ? (state.instring == ST_STRING_STYLE
3070 ? Qt : make_number (state.instring)) : Qnil,
3071 Fcons (state.incomment < 0 ? Qt :
3072 (state.incomment == 0 ? Qnil :
3073 make_number (state.incomment)),
3074 Fcons (state.quoted ? Qt : Qnil,
3075 Fcons (make_number (state.mindepth),
3076 Fcons ((state.comstyle
3077 ? (state.comstyle == ST_COMMENT_STYLE
3078 ? Qsyntax_table : Qt) :
3079 Qnil),
3080 Fcons (((state.incomment
3081 || (state.instring >= 0))
3082 ? make_number (state.comstr_start)
3083 : Qnil),
3084 Fcons (state.levelstarts, Qnil))))))))));
3085 }
3086 \f
3087 void
3088 init_syntax_once ()
3089 {
3090 register int i, c;
3091 Lisp_Object temp;
3092
3093 /* This has to be done here, before we call Fmake_char_table. */
3094 Qsyntax_table = intern ("syntax-table");
3095 staticpro (&Qsyntax_table);
3096
3097 /* Intern this now in case it isn't already done.
3098 Setting this variable twice is harmless.
3099 But don't staticpro it here--that is done in alloc.c. */
3100 Qchar_table_extra_slots = intern ("char-table-extra-slots");
3101
3102 /* Create objects which can be shared among syntax tables. */
3103 Vsyntax_code_object = Fmake_vector (make_number (Smax), Qnil);
3104 for (i = 0; i < XVECTOR (Vsyntax_code_object)->size; i++)
3105 XVECTOR (Vsyntax_code_object)->contents[i]
3106 = Fcons (make_number (i), Qnil);
3107
3108 /* Now we are ready to set up this property, so we can
3109 create syntax tables. */
3110 Fput (Qsyntax_table, Qchar_table_extra_slots, make_number (0));
3111
3112 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Swhitespace];
3113
3114 Vstandard_syntax_table = Fmake_char_table (Qsyntax_table, temp);
3115
3116 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Sword];
3117 for (i = 'a'; i <= 'z'; i++)
3118 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, i, temp);
3119 for (i = 'A'; i <= 'Z'; i++)
3120 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, i, temp);
3121 for (i = '0'; i <= '9'; i++)
3122 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, i, temp);
3123
3124 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '$', temp);
3125 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '%', temp);
3126
3127 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '(',
3128 Fcons (make_number (Sopen), make_number (')')));
3129 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, ')',
3130 Fcons (make_number (Sclose), make_number ('(')));
3131 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '[',
3132 Fcons (make_number (Sopen), make_number (']')));
3133 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, ']',
3134 Fcons (make_number (Sclose), make_number ('[')));
3135 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '{',
3136 Fcons (make_number (Sopen), make_number ('}')));
3137 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '}',
3138 Fcons (make_number (Sclose), make_number ('{')));
3139 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '"',
3140 Fcons (make_number ((int) Sstring), Qnil));
3141 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '\\',
3142 Fcons (make_number ((int) Sescape), Qnil));
3143
3144 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Ssymbol];
3145 for (i = 0; i < 10; i++)
3146 {
3147 c = "_-+*/&|<>="[i];
3148 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, c, temp);
3149 }
3150
3151 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Spunct];
3152 for (i = 0; i < 12; i++)
3153 {
3154 c = ".,;:?!#@~^'`"[i];
3155 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, c, temp);
3156 }
3157
3158 /* All multibyte characters have syntax `word' by default. */
3159 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Sword];
3160 for (i = CHAR_TABLE_SINGLE_BYTE_SLOTS; i < CHAR_TABLE_ORDINARY_SLOTS; i++)
3161 XCHAR_TABLE (Vstandard_syntax_table)->contents[i] = temp;
3162 }
3163
3164 void
3165 syms_of_syntax ()
3166 {
3167 Qsyntax_table_p = intern ("syntax-table-p");
3168 staticpro (&Qsyntax_table_p);
3169
3170 staticpro (&Vsyntax_code_object);
3171
3172 staticpro (&gl_state.object);
3173 staticpro (&gl_state.global_code);
3174 staticpro (&gl_state.current_syntax_table);
3175 staticpro (&gl_state.old_prop);
3176
3177 /* Defined in regex.c */
3178 staticpro (&re_match_object);
3179
3180 Qscan_error = intern ("scan-error");
3181 staticpro (&Qscan_error);
3182 Fput (Qscan_error, Qerror_conditions,
3183 Fcons (Qscan_error, Fcons (Qerror, Qnil)));
3184 Fput (Qscan_error, Qerror_message,
3185 build_string ("Scan error"));
3186
3187 DEFVAR_BOOL ("parse-sexp-ignore-comments", &parse_sexp_ignore_comments,
3188 doc: /* Non-nil means `forward-sexp', etc., should treat comments as whitespace. */);
3189
3190 DEFVAR_BOOL ("parse-sexp-lookup-properties", &parse_sexp_lookup_properties,
3191 doc: /* Non-nil means `forward-sexp', etc., obey `syntax-table' property.
3192 Otherwise, that text property is simply ignored.
3193 See the info node `(elisp)Syntax Properties' for a description of the
3194 `syntax-table' property. */);
3195
3196 words_include_escapes = 0;
3197 DEFVAR_BOOL ("words-include-escapes", &words_include_escapes,
3198 doc: /* Non-nil means `forward-word', etc., should treat escape chars part of words. */);
3199
3200 DEFVAR_BOOL ("multibyte-syntax-as-symbol", &multibyte_syntax_as_symbol,
3201 doc: /* Non-nil means `scan-sexps' treats all multibyte characters as symbol. */);
3202 multibyte_syntax_as_symbol = 0;
3203
3204 DEFVAR_BOOL ("open-paren-in-column-0-is-defun-start",
3205 &open_paren_in_column_0_is_defun_start,
3206 doc: /* *Non-nil means an open paren in column 0 denotes the start of a defun. */);
3207 open_paren_in_column_0_is_defun_start = 1;
3208
3209 defsubr (&Ssyntax_table_p);
3210 defsubr (&Ssyntax_table);
3211 defsubr (&Sstandard_syntax_table);
3212 defsubr (&Scopy_syntax_table);
3213 defsubr (&Sset_syntax_table);
3214 defsubr (&Schar_syntax);
3215 defsubr (&Smatching_paren);
3216 defsubr (&Sstring_to_syntax);
3217 defsubr (&Smodify_syntax_entry);
3218 defsubr (&Sinternal_describe_syntax_value);
3219
3220 defsubr (&Sforward_word);
3221
3222 defsubr (&Sskip_chars_forward);
3223 defsubr (&Sskip_chars_backward);
3224 defsubr (&Sskip_syntax_forward);
3225 defsubr (&Sskip_syntax_backward);
3226
3227 defsubr (&Sforward_comment);
3228 defsubr (&Sscan_lists);
3229 defsubr (&Sscan_sexps);
3230 defsubr (&Sbackward_prefix_chars);
3231 defsubr (&Sparse_partial_sexp);
3232 }
3233
3234 /* arch-tag: 3e297b9f-088e-4b64-8f4c-fb0b3443e412
3235 (do not change this comment) */