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