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