]> code.delx.au - gnu-emacs/blob - src/syntax.c
Fix regex abort when it tries to reenter itself
[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-2015 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
10 (at 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, 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, true, Qnil);
506 }
507 }
508
509 void
510 update_syntax_table_forward (ptrdiff_t charpos, bool init, bool propertize,
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 }
518 else
519 {
520 update_syntax_table (charpos, 1, init, object);
521 propertize &= (NILP (object)
522 && gl_state.e_property > syntax_propertize__done);
523 }
524
525 if (propertize)
526 parse_sexp_propertize (charpos);
527 }
528 \f
529 /* Returns true if char at CHARPOS is quoted.
530 Global syntax-table data should be set up already to be good at CHARPOS
531 or after. On return global syntax data is good for lookup at CHARPOS. */
532
533 static bool
534 char_quoted (ptrdiff_t charpos, ptrdiff_t bytepos)
535 {
536 enum syntaxcode code;
537 ptrdiff_t beg = BEGV;
538 bool quoted = 0;
539 ptrdiff_t orig = charpos;
540
541 while (charpos > beg)
542 {
543 int c;
544 DEC_BOTH (charpos, bytepos);
545
546 UPDATE_SYNTAX_TABLE_BACKWARD (charpos);
547 c = FETCH_CHAR_AS_MULTIBYTE (bytepos);
548 code = SYNTAX (c);
549 if (! (code == Scharquote || code == Sescape))
550 break;
551
552 quoted = !quoted;
553 }
554
555 UPDATE_SYNTAX_TABLE (orig);
556 return quoted;
557 }
558
559 /* Return the bytepos one character before BYTEPOS.
560 We assume that BYTEPOS is not at the start of the buffer. */
561
562 static ptrdiff_t
563 dec_bytepos (ptrdiff_t bytepos)
564 {
565 if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
566 return bytepos - 1;
567
568 DEC_POS (bytepos);
569 return bytepos;
570 }
571 \f
572 /* Return a defun-start position before POS and not too far before.
573 It should be the last one before POS, or nearly the last.
574
575 When open_paren_in_column_0_is_defun_start is nonzero,
576 only the beginning of the buffer is treated as a defun-start.
577
578 We record the information about where the scan started
579 and what its result was, so that another call in the same area
580 can return the same value very quickly.
581
582 There is no promise at which position the global syntax data is
583 valid on return from the subroutine, so the caller should explicitly
584 update the global data. */
585
586 static ptrdiff_t
587 find_defun_start (ptrdiff_t pos, ptrdiff_t pos_byte)
588 {
589 ptrdiff_t opoint = PT, opoint_byte = PT_BYTE;
590
591 /* Use previous finding, if it's valid and applies to this inquiry. */
592 if (current_buffer == find_start_buffer
593 /* Reuse the defun-start even if POS is a little farther on.
594 POS might be in the next defun, but that's ok.
595 Our value may not be the best possible, but will still be usable. */
596 && pos <= find_start_pos + 1000
597 && pos >= find_start_value
598 && BEGV == find_start_begv
599 && MODIFF == find_start_modiff)
600 return find_start_value;
601
602 if (!open_paren_in_column_0_is_defun_start)
603 {
604 find_start_value = BEGV;
605 find_start_value_byte = BEGV_BYTE;
606 goto found;
607 }
608
609 /* Back up to start of line. */
610 scan_newline (pos, pos_byte, BEGV, BEGV_BYTE, -1, 1);
611
612 /* We optimize syntax-table lookup for rare updates. Thus we accept
613 only those `^\s(' which are good in global _and_ text-property
614 syntax-tables. */
615 SETUP_BUFFER_SYNTAX_TABLE ();
616 while (PT > BEGV)
617 {
618 int c;
619
620 /* Open-paren at start of line means we may have found our
621 defun-start. */
622 c = FETCH_CHAR_AS_MULTIBYTE (PT_BYTE);
623 if (SYNTAX (c) == Sopen)
624 {
625 SETUP_SYNTAX_TABLE (PT + 1, -1); /* Try again... */
626 c = FETCH_CHAR_AS_MULTIBYTE (PT_BYTE);
627 if (SYNTAX (c) == Sopen)
628 break;
629 /* Now fallback to the default value. */
630 SETUP_BUFFER_SYNTAX_TABLE ();
631 }
632 /* Move to beg of previous line. */
633 scan_newline (PT, PT_BYTE, BEGV, BEGV_BYTE, -2, 1);
634 }
635
636 /* Record what we found, for the next try. */
637 find_start_value = PT;
638 find_start_value_byte = PT_BYTE;
639 TEMP_SET_PT_BOTH (opoint, opoint_byte);
640
641 found:
642 find_start_buffer = current_buffer;
643 find_start_modiff = MODIFF;
644 find_start_begv = BEGV;
645 find_start_pos = pos;
646
647 return find_start_value;
648 }
649 \f
650 /* Return the SYNTAX_COMEND_FIRST of the character before POS, POS_BYTE. */
651
652 static bool
653 prev_char_comend_first (ptrdiff_t pos, ptrdiff_t pos_byte)
654 {
655 int c;
656 bool val;
657
658 DEC_BOTH (pos, pos_byte);
659 UPDATE_SYNTAX_TABLE_BACKWARD (pos);
660 c = FETCH_CHAR (pos_byte);
661 val = SYNTAX_COMEND_FIRST (c);
662 UPDATE_SYNTAX_TABLE_FORWARD (pos + 1);
663 return val;
664 }
665
666 /* Check whether charpos FROM is at the end of a comment.
667 FROM_BYTE is the bytepos corresponding to FROM.
668 Do not move back before STOP.
669
670 Return true if we find a comment ending at FROM/FROM_BYTE.
671
672 If successful, store the charpos of the comment's beginning
673 into *CHARPOS_PTR, and the bytepos into *BYTEPOS_PTR.
674
675 Global syntax data remains valid for backward search starting at
676 the returned value (or at FROM, if the search was not successful). */
677
678 static bool
679 back_comment (ptrdiff_t from, ptrdiff_t from_byte, ptrdiff_t stop,
680 bool comnested, int comstyle, ptrdiff_t *charpos_ptr,
681 ptrdiff_t *bytepos_ptr)
682 {
683 /* Look back, counting the parity of string-quotes,
684 and recording the comment-starters seen.
685 When we reach a safe place, assume that's not in a string;
686 then step the main scan to the earliest comment-starter seen
687 an even number of string quotes away from the safe place.
688
689 OFROM[I] is position of the earliest comment-starter seen
690 which is I+2X quotes from the comment-end.
691 PARITY is current parity of quotes from the comment end. */
692 int string_style = -1; /* Presumed outside of any string. */
693 bool string_lossage = 0;
694 /* Not a real lossage: indicates that we have passed a matching comment
695 starter plus a non-matching comment-ender, meaning that any matching
696 comment-starter we might see later could be a false positive (hidden
697 inside another comment).
698 Test case: { a (* b } c (* d *) */
699 bool comment_lossage = 0;
700 ptrdiff_t comment_end = from;
701 ptrdiff_t comment_end_byte = from_byte;
702 ptrdiff_t comstart_pos = 0;
703 ptrdiff_t comstart_byte IF_LINT (= 0);
704 /* Place where the containing defun starts,
705 or 0 if we didn't come across it yet. */
706 ptrdiff_t defun_start = 0;
707 ptrdiff_t defun_start_byte = 0;
708 enum syntaxcode code;
709 ptrdiff_t nesting = 1; /* Current comment nesting. */
710 int c;
711 int syntax = 0;
712
713 /* FIXME: A }} comment-ender style leads to incorrect behavior
714 in the case of {{ c }}} because we ignore the last two chars which are
715 assumed to be comment-enders although they aren't. */
716
717 /* At beginning of range to scan, we're outside of strings;
718 that determines quote parity to the comment-end. */
719 while (from != stop)
720 {
721 ptrdiff_t temp_byte;
722 int prev_syntax;
723 bool com2start, com2end, comstart;
724
725 /* Move back and examine a character. */
726 DEC_BOTH (from, from_byte);
727 UPDATE_SYNTAX_TABLE_BACKWARD (from);
728
729 prev_syntax = syntax;
730 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
731 syntax = SYNTAX_WITH_FLAGS (c);
732 code = SYNTAX (c);
733
734 /* Check for 2-char comment markers. */
735 com2start = (SYNTAX_FLAGS_COMSTART_FIRST (syntax)
736 && SYNTAX_FLAGS_COMSTART_SECOND (prev_syntax)
737 && (comstyle
738 == SYNTAX_FLAGS_COMMENT_STYLE (prev_syntax, syntax))
739 && (SYNTAX_FLAGS_COMMENT_NESTED (prev_syntax)
740 || SYNTAX_FLAGS_COMMENT_NESTED (syntax)) == comnested);
741 com2end = (SYNTAX_FLAGS_COMEND_FIRST (syntax)
742 && SYNTAX_FLAGS_COMEND_SECOND (prev_syntax));
743 comstart = (com2start || code == Scomment);
744
745 /* Nasty cases with overlapping 2-char comment markers:
746 - snmp-mode: -- c -- foo -- c --
747 --- c --
748 ------ c --
749 - c-mode: *||*
750 |* *|* *|
751 |*| |* |*|
752 /// */
753
754 /* If a 2-char comment sequence partly overlaps with another,
755 we don't try to be clever. E.g. |*| in C, or }% in modes that
756 have %..\n and %{..}%. */
757 if (from > stop && (com2end || comstart))
758 {
759 ptrdiff_t next = from, next_byte = from_byte;
760 int next_c, next_syntax;
761 DEC_BOTH (next, next_byte);
762 UPDATE_SYNTAX_TABLE_BACKWARD (next);
763 next_c = FETCH_CHAR_AS_MULTIBYTE (next_byte);
764 next_syntax = SYNTAX_WITH_FLAGS (next_c);
765 if (((comstart || comnested)
766 && SYNTAX_FLAGS_COMEND_SECOND (syntax)
767 && SYNTAX_FLAGS_COMEND_FIRST (next_syntax))
768 || ((com2end || comnested)
769 && SYNTAX_FLAGS_COMSTART_SECOND (syntax)
770 && (comstyle
771 == SYNTAX_FLAGS_COMMENT_STYLE (syntax, prev_syntax))
772 && SYNTAX_FLAGS_COMSTART_FIRST (next_syntax)))
773 goto lossage;
774 /* UPDATE_SYNTAX_TABLE_FORWARD (next + 1); */
775 }
776
777 if (com2start && comstart_pos == 0)
778 /* We're looking at a comment starter. But it might be a comment
779 ender as well (see snmp-mode). The first time we see one, we
780 need to consider it as a comment starter,
781 and the subsequent times as a comment ender. */
782 com2end = 0;
783
784 /* Turn a 2-char comment sequences into the appropriate syntax. */
785 if (com2end)
786 code = Sendcomment;
787 else if (com2start)
788 code = Scomment;
789 /* Ignore comment starters of a different style. */
790 else if (code == Scomment
791 && (comstyle != SYNTAX_FLAGS_COMMENT_STYLE (syntax, 0)
792 || SYNTAX_FLAGS_COMMENT_NESTED (syntax) != comnested))
793 continue;
794
795 /* Ignore escaped characters, except comment-enders. */
796 if (code != Sendcomment && 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 left there
1540 and the function returns nil. Field boundaries are not noticed if
1541 `inhibit-field-text-motion' is non-nil. */)
1542 (Lisp_Object arg)
1543 {
1544 Lisp_Object tmp;
1545 ptrdiff_t orig_val, val;
1546
1547 if (NILP (arg))
1548 XSETFASTINT (arg, 1);
1549 else
1550 CHECK_NUMBER (arg);
1551
1552 val = orig_val = scan_words (PT, XINT (arg));
1553 if (! orig_val)
1554 val = XINT (arg) > 0 ? ZV : BEGV;
1555
1556 /* Avoid jumping out of an input field. */
1557 tmp = Fconstrain_to_field (make_number (val), make_number (PT),
1558 Qnil, Qnil, Qnil);
1559 val = XFASTINT (tmp);
1560
1561 SET_PT (val);
1562 return val == orig_val ? Qt : Qnil;
1563 }
1564 \f
1565 DEFUN ("skip-chars-forward", Fskip_chars_forward, Sskip_chars_forward, 1, 2, 0,
1566 doc: /* Move point forward, stopping before a char not in STRING, or at pos LIM.
1567 STRING is like the inside of a `[...]' in a regular expression
1568 except that `]' is never special and `\\' quotes `^', `-' or `\\'
1569 (but not at the end of a range; quoting is never needed there).
1570 Thus, with arg "a-zA-Z", this skips letters stopping before first nonletter.
1571 With arg "^a-zA-Z", skips nonletters stopping before first letter.
1572 Char classes, e.g. `[:alpha:]', are supported.
1573
1574 Returns the distance traveled, either zero or positive. */)
1575 (Lisp_Object string, Lisp_Object lim)
1576 {
1577 return skip_chars (1, string, lim, 1);
1578 }
1579
1580 DEFUN ("skip-chars-backward", Fskip_chars_backward, Sskip_chars_backward, 1, 2, 0,
1581 doc: /* Move point backward, stopping after a char not in STRING, or at pos LIM.
1582 See `skip-chars-forward' for details.
1583 Returns the distance traveled, either zero or negative. */)
1584 (Lisp_Object string, Lisp_Object lim)
1585 {
1586 return skip_chars (0, string, lim, 1);
1587 }
1588
1589 DEFUN ("skip-syntax-forward", Fskip_syntax_forward, Sskip_syntax_forward, 1, 2, 0,
1590 doc: /* Move point forward across chars in specified syntax classes.
1591 SYNTAX is a string of syntax code characters.
1592 Stop before a char whose syntax is not in SYNTAX, or at position LIM.
1593 If SYNTAX starts with ^, skip characters whose syntax is NOT in SYNTAX.
1594 This function returns the distance traveled, either zero or positive. */)
1595 (Lisp_Object syntax, Lisp_Object lim)
1596 {
1597 return skip_syntaxes (1, syntax, lim);
1598 }
1599
1600 DEFUN ("skip-syntax-backward", Fskip_syntax_backward, Sskip_syntax_backward, 1, 2, 0,
1601 doc: /* Move point backward across chars in specified syntax classes.
1602 SYNTAX is a string of syntax code characters.
1603 Stop on reaching a char whose syntax is not in SYNTAX, or at position LIM.
1604 If SYNTAX starts with ^, skip characters whose syntax is NOT in SYNTAX.
1605 This function returns either zero or a negative number, and the absolute value
1606 of this is the distance traveled. */)
1607 (Lisp_Object syntax, Lisp_Object lim)
1608 {
1609 return skip_syntaxes (0, syntax, lim);
1610 }
1611
1612 static Lisp_Object
1613 skip_chars (bool forwardp, Lisp_Object string, Lisp_Object lim,
1614 bool handle_iso_classes)
1615 {
1616 int c;
1617 char fastmap[0400];
1618 /* Store the ranges of non-ASCII characters. */
1619 int *char_ranges IF_LINT (= NULL);
1620 int n_char_ranges = 0;
1621 bool negate = 0;
1622 ptrdiff_t i, i_byte;
1623 /* True if the current buffer is multibyte and the region contains
1624 non-ASCII chars. */
1625 bool multibyte;
1626 /* True if STRING is multibyte and it contains non-ASCII chars. */
1627 bool string_multibyte;
1628 ptrdiff_t size_byte;
1629 const unsigned char *str;
1630 int len;
1631 Lisp_Object iso_classes;
1632 USE_SAFE_ALLOCA;
1633
1634 CHECK_STRING (string);
1635 iso_classes = Qnil;
1636
1637 if (NILP (lim))
1638 XSETINT (lim, forwardp ? ZV : BEGV);
1639 else
1640 CHECK_NUMBER_COERCE_MARKER (lim);
1641
1642 /* In any case, don't allow scan outside bounds of buffer. */
1643 if (XINT (lim) > ZV)
1644 XSETFASTINT (lim, ZV);
1645 if (XINT (lim) < BEGV)
1646 XSETFASTINT (lim, BEGV);
1647
1648 multibyte = (!NILP (BVAR (current_buffer, enable_multibyte_characters))
1649 && (XINT (lim) - PT != CHAR_TO_BYTE (XINT (lim)) - PT_BYTE));
1650 string_multibyte = SBYTES (string) > SCHARS (string);
1651
1652 memset (fastmap, 0, sizeof fastmap);
1653
1654 str = SDATA (string);
1655 size_byte = SBYTES (string);
1656
1657 i_byte = 0;
1658 if (i_byte < size_byte
1659 && SREF (string, 0) == '^')
1660 {
1661 negate = 1; i_byte++;
1662 }
1663
1664 /* Find the characters specified and set their elements of fastmap.
1665 Handle backslashes and ranges specially.
1666
1667 If STRING contains non-ASCII characters, setup char_ranges for
1668 them and use fastmap only for their leading codes. */
1669
1670 if (! string_multibyte)
1671 {
1672 bool string_has_eight_bit = 0;
1673
1674 /* At first setup fastmap. */
1675 while (i_byte < size_byte)
1676 {
1677 c = str[i_byte++];
1678
1679 if (handle_iso_classes && c == '['
1680 && i_byte < size_byte
1681 && str[i_byte] == ':')
1682 {
1683 const unsigned char *class_beg = str + i_byte + 1;
1684 const unsigned char *class_end = class_beg;
1685 const unsigned char *class_limit = str + size_byte - 2;
1686 /* Leave room for the null. */
1687 unsigned char class_name[CHAR_CLASS_MAX_LENGTH + 1];
1688 re_wctype_t cc;
1689
1690 if (class_limit - class_beg > CHAR_CLASS_MAX_LENGTH)
1691 class_limit = class_beg + CHAR_CLASS_MAX_LENGTH;
1692
1693 while (class_end < class_limit
1694 && *class_end >= 'a' && *class_end <= 'z')
1695 class_end++;
1696
1697 if (class_end == class_beg
1698 || *class_end != ':' || class_end[1] != ']')
1699 goto not_a_class_name;
1700
1701 memcpy (class_name, class_beg, class_end - class_beg);
1702 class_name[class_end - class_beg] = 0;
1703
1704 cc = re_wctype (class_name);
1705 if (cc == 0)
1706 error ("Invalid ISO C character class");
1707
1708 iso_classes = Fcons (make_number (cc), iso_classes);
1709
1710 i_byte = class_end + 2 - str;
1711 continue;
1712 }
1713
1714 not_a_class_name:
1715 if (c == '\\')
1716 {
1717 if (i_byte == size_byte)
1718 break;
1719
1720 c = str[i_byte++];
1721 }
1722 /* Treat `-' as range character only if another character
1723 follows. */
1724 if (i_byte + 1 < size_byte
1725 && str[i_byte] == '-')
1726 {
1727 int c2;
1728
1729 /* Skip over the dash. */
1730 i_byte++;
1731
1732 /* Get the end of the range. */
1733 c2 = str[i_byte++];
1734 if (c2 == '\\'
1735 && i_byte < size_byte)
1736 c2 = str[i_byte++];
1737
1738 if (c <= c2)
1739 {
1740 int lim2 = c2 + 1;
1741 while (c < lim2)
1742 fastmap[c++] = 1;
1743 if (! ASCII_CHAR_P (c2))
1744 string_has_eight_bit = 1;
1745 }
1746 }
1747 else
1748 {
1749 fastmap[c] = 1;
1750 if (! ASCII_CHAR_P (c))
1751 string_has_eight_bit = 1;
1752 }
1753 }
1754
1755 /* If the current range is multibyte and STRING contains
1756 eight-bit chars, arrange fastmap and setup char_ranges for
1757 the corresponding multibyte chars. */
1758 if (multibyte && string_has_eight_bit)
1759 {
1760 char *p1;
1761 char himap[0200 + 1];
1762 memcpy (himap, fastmap + 0200, 0200);
1763 himap[0200] = 0;
1764 memset (fastmap + 0200, 0, 0200);
1765 SAFE_NALLOCA (char_ranges, 2, 128);
1766 i = 0;
1767
1768 while ((p1 = memchr (himap + i, 1, 0200 - i)))
1769 {
1770 /* Deduce the next range C..C2 from the next clump of 1s
1771 in HIMAP starting with &HIMAP[I]. HIMAP is the high
1772 order half of the old FASTMAP. */
1773 int c2, leading_code;
1774 i = p1 - himap;
1775 c = BYTE8_TO_CHAR (i + 0200);
1776 i += strlen (p1);
1777 c2 = BYTE8_TO_CHAR (i + 0200 - 1);
1778
1779 char_ranges[n_char_ranges++] = c;
1780 char_ranges[n_char_ranges++] = c2;
1781 leading_code = CHAR_LEADING_CODE (c);
1782 memset (fastmap + leading_code, 1,
1783 CHAR_LEADING_CODE (c2) - leading_code + 1);
1784 }
1785 }
1786 }
1787 else /* STRING is multibyte */
1788 {
1789 SAFE_NALLOCA (char_ranges, 2, SCHARS (string));
1790
1791 while (i_byte < size_byte)
1792 {
1793 int leading_code = str[i_byte];
1794 c = STRING_CHAR_AND_LENGTH (str + i_byte, len);
1795 i_byte += len;
1796
1797 if (handle_iso_classes && c == '['
1798 && i_byte < size_byte
1799 && STRING_CHAR (str + i_byte) == ':')
1800 {
1801 const unsigned char *class_beg = str + i_byte + 1;
1802 const unsigned char *class_end = class_beg;
1803 const unsigned char *class_limit = str + size_byte - 2;
1804 /* Leave room for the null. */
1805 unsigned char class_name[CHAR_CLASS_MAX_LENGTH + 1];
1806 re_wctype_t cc;
1807
1808 if (class_limit - class_beg > CHAR_CLASS_MAX_LENGTH)
1809 class_limit = class_beg + CHAR_CLASS_MAX_LENGTH;
1810
1811 while (class_end < class_limit
1812 && *class_end >= 'a' && *class_end <= 'z')
1813 class_end++;
1814
1815 if (class_end == class_beg
1816 || *class_end != ':' || class_end[1] != ']')
1817 goto not_a_class_name_multibyte;
1818
1819 memcpy (class_name, class_beg, class_end - class_beg);
1820 class_name[class_end - class_beg] = 0;
1821
1822 cc = re_wctype (class_name);
1823 if (cc == 0)
1824 error ("Invalid ISO C character class");
1825
1826 iso_classes = Fcons (make_number (cc), iso_classes);
1827
1828 i_byte = class_end + 2 - str;
1829 continue;
1830 }
1831
1832 not_a_class_name_multibyte:
1833 if (c == '\\')
1834 {
1835 if (i_byte == size_byte)
1836 break;
1837
1838 leading_code = str[i_byte];
1839 c = STRING_CHAR_AND_LENGTH (str + i_byte, len);
1840 i_byte += len;
1841 }
1842 /* Treat `-' as range character only if another character
1843 follows. */
1844 if (i_byte + 1 < size_byte
1845 && str[i_byte] == '-')
1846 {
1847 int c2, leading_code2;
1848
1849 /* Skip over the dash. */
1850 i_byte++;
1851
1852 /* Get the end of the range. */
1853 leading_code2 = str[i_byte];
1854 c2 = STRING_CHAR_AND_LENGTH (str + i_byte, len);
1855 i_byte += len;
1856
1857 if (c2 == '\\'
1858 && i_byte < size_byte)
1859 {
1860 leading_code2 = str[i_byte];
1861 c2 = STRING_CHAR_AND_LENGTH (str + i_byte, len);
1862 i_byte += len;
1863 }
1864
1865 if (c > c2)
1866 continue;
1867 if (ASCII_CHAR_P (c))
1868 {
1869 while (c <= c2 && c < 0x80)
1870 fastmap[c++] = 1;
1871 leading_code = CHAR_LEADING_CODE (c);
1872 }
1873 if (! ASCII_CHAR_P (c))
1874 {
1875 int lim2 = leading_code2 + 1;
1876 while (leading_code < lim2)
1877 fastmap[leading_code++] = 1;
1878 if (c <= c2)
1879 {
1880 char_ranges[n_char_ranges++] = c;
1881 char_ranges[n_char_ranges++] = c2;
1882 }
1883 }
1884 }
1885 else
1886 {
1887 if (ASCII_CHAR_P (c))
1888 fastmap[c] = 1;
1889 else
1890 {
1891 fastmap[leading_code] = 1;
1892 char_ranges[n_char_ranges++] = c;
1893 char_ranges[n_char_ranges++] = c;
1894 }
1895 }
1896 }
1897
1898 /* If the current range is unibyte and STRING contains non-ASCII
1899 chars, arrange fastmap for the corresponding unibyte
1900 chars. */
1901
1902 if (! multibyte && n_char_ranges > 0)
1903 {
1904 memset (fastmap + 0200, 0, 0200);
1905 for (i = 0; i < n_char_ranges; i += 2)
1906 {
1907 int c1 = char_ranges[i];
1908 int lim2 = char_ranges[i + 1] + 1;
1909
1910 for (; c1 < lim2; c1++)
1911 {
1912 int b = CHAR_TO_BYTE_SAFE (c1);
1913 if (b >= 0)
1914 fastmap[b] = 1;
1915 }
1916 }
1917 }
1918 }
1919
1920 /* If ^ was the first character, complement the fastmap. */
1921 if (negate)
1922 {
1923 if (! multibyte)
1924 for (i = 0; i < sizeof fastmap; i++)
1925 fastmap[i] ^= 1;
1926 else
1927 {
1928 for (i = 0; i < 0200; i++)
1929 fastmap[i] ^= 1;
1930 /* All non-ASCII chars possibly match. */
1931 for (; i < sizeof fastmap; i++)
1932 fastmap[i] = 1;
1933 }
1934 }
1935
1936 {
1937 ptrdiff_t start_point = PT;
1938 ptrdiff_t pos = PT;
1939 ptrdiff_t pos_byte = PT_BYTE;
1940 unsigned char *p = PT_ADDR, *endp, *stop;
1941
1942 if (forwardp)
1943 {
1944 endp = (XINT (lim) == GPT) ? GPT_ADDR : CHAR_POS_ADDR (XINT (lim));
1945 stop = (pos < GPT && GPT < XINT (lim)) ? GPT_ADDR : endp;
1946 }
1947 else
1948 {
1949 endp = CHAR_POS_ADDR (XINT (lim));
1950 stop = (pos >= GPT && GPT > XINT (lim)) ? GAP_END_ADDR : endp;
1951 }
1952
1953 immediate_quit = 1;
1954 /* This code may look up syntax tables using functions that rely on the
1955 gl_state object. To make sure this object is not out of date,
1956 let's initialize it manually.
1957 We ignore syntax-table text-properties for now, since that's
1958 what we've done in the past. */
1959 SETUP_BUFFER_SYNTAX_TABLE ();
1960 if (forwardp)
1961 {
1962 if (multibyte)
1963 while (1)
1964 {
1965 int nbytes;
1966
1967 if (p >= stop)
1968 {
1969 if (p >= endp)
1970 break;
1971 p = GAP_END_ADDR;
1972 stop = endp;
1973 }
1974 c = STRING_CHAR_AND_LENGTH (p, nbytes);
1975 if (! NILP (iso_classes) && in_classes (c, iso_classes))
1976 {
1977 if (negate)
1978 break;
1979 else
1980 goto fwd_ok;
1981 }
1982
1983 if (! fastmap[*p])
1984 break;
1985 if (! ASCII_CHAR_P (c))
1986 {
1987 /* As we are looking at a multibyte character, we
1988 must look up the character in the table
1989 CHAR_RANGES. If there's no data in the table,
1990 that character is not what we want to skip. */
1991
1992 /* The following code do the right thing even if
1993 n_char_ranges is zero (i.e. no data in
1994 CHAR_RANGES). */
1995 for (i = 0; i < n_char_ranges; i += 2)
1996 if (c >= char_ranges[i] && c <= char_ranges[i + 1])
1997 break;
1998 if (!(negate ^ (i < n_char_ranges)))
1999 break;
2000 }
2001 fwd_ok:
2002 p += nbytes, pos++, pos_byte += nbytes;
2003 }
2004 else
2005 while (1)
2006 {
2007 if (p >= stop)
2008 {
2009 if (p >= endp)
2010 break;
2011 p = GAP_END_ADDR;
2012 stop = endp;
2013 }
2014
2015 if (!NILP (iso_classes) && in_classes (*p, iso_classes))
2016 {
2017 if (negate)
2018 break;
2019 else
2020 goto fwd_unibyte_ok;
2021 }
2022
2023 if (!fastmap[*p])
2024 break;
2025 fwd_unibyte_ok:
2026 p++, pos++, pos_byte++;
2027 }
2028 }
2029 else
2030 {
2031 if (multibyte)
2032 while (1)
2033 {
2034 unsigned char *prev_p;
2035
2036 if (p <= stop)
2037 {
2038 if (p <= endp)
2039 break;
2040 p = GPT_ADDR;
2041 stop = endp;
2042 }
2043 prev_p = p;
2044 while (--p >= stop && ! CHAR_HEAD_P (*p));
2045 c = STRING_CHAR (p);
2046
2047 if (! NILP (iso_classes) && in_classes (c, iso_classes))
2048 {
2049 if (negate)
2050 break;
2051 else
2052 goto back_ok;
2053 }
2054
2055 if (! fastmap[*p])
2056 break;
2057 if (! ASCII_CHAR_P (c))
2058 {
2059 /* See the comment in the previous similar code. */
2060 for (i = 0; i < n_char_ranges; i += 2)
2061 if (c >= char_ranges[i] && c <= char_ranges[i + 1])
2062 break;
2063 if (!(negate ^ (i < n_char_ranges)))
2064 break;
2065 }
2066 back_ok:
2067 pos--, pos_byte -= prev_p - p;
2068 }
2069 else
2070 while (1)
2071 {
2072 if (p <= stop)
2073 {
2074 if (p <= endp)
2075 break;
2076 p = GPT_ADDR;
2077 stop = endp;
2078 }
2079
2080 if (! NILP (iso_classes) && in_classes (p[-1], iso_classes))
2081 {
2082 if (negate)
2083 break;
2084 else
2085 goto back_unibyte_ok;
2086 }
2087
2088 if (!fastmap[p[-1]])
2089 break;
2090 back_unibyte_ok:
2091 p--, pos--, pos_byte--;
2092 }
2093 }
2094
2095 SET_PT_BOTH (pos, pos_byte);
2096 immediate_quit = 0;
2097
2098 SAFE_FREE ();
2099 return make_number (PT - start_point);
2100 }
2101 }
2102
2103
2104 static Lisp_Object
2105 skip_syntaxes (bool forwardp, Lisp_Object string, Lisp_Object lim)
2106 {
2107 int c;
2108 unsigned char fastmap[0400];
2109 bool negate = 0;
2110 ptrdiff_t i, i_byte;
2111 bool multibyte;
2112 ptrdiff_t size_byte;
2113 unsigned char *str;
2114
2115 CHECK_STRING (string);
2116
2117 if (NILP (lim))
2118 XSETINT (lim, forwardp ? ZV : BEGV);
2119 else
2120 CHECK_NUMBER_COERCE_MARKER (lim);
2121
2122 /* In any case, don't allow scan outside bounds of buffer. */
2123 if (XINT (lim) > ZV)
2124 XSETFASTINT (lim, ZV);
2125 if (XINT (lim) < BEGV)
2126 XSETFASTINT (lim, BEGV);
2127
2128 if (forwardp ? (PT >= XFASTINT (lim)) : (PT <= XFASTINT (lim)))
2129 return make_number (0);
2130
2131 multibyte = (!NILP (BVAR (current_buffer, enable_multibyte_characters))
2132 && (XINT (lim) - PT != CHAR_TO_BYTE (XINT (lim)) - PT_BYTE));
2133
2134 memset (fastmap, 0, sizeof fastmap);
2135
2136 if (SBYTES (string) > SCHARS (string))
2137 /* As this is very rare case (syntax spec is ASCII only), don't
2138 consider efficiency. */
2139 string = string_make_unibyte (string);
2140
2141 str = SDATA (string);
2142 size_byte = SBYTES (string);
2143
2144 i_byte = 0;
2145 if (i_byte < size_byte
2146 && SREF (string, 0) == '^')
2147 {
2148 negate = 1; i_byte++;
2149 }
2150
2151 /* Find the syntaxes specified and set their elements of fastmap. */
2152
2153 while (i_byte < size_byte)
2154 {
2155 c = str[i_byte++];
2156 fastmap[syntax_spec_code[c]] = 1;
2157 }
2158
2159 /* If ^ was the first character, complement the fastmap. */
2160 if (negate)
2161 for (i = 0; i < sizeof fastmap; i++)
2162 fastmap[i] ^= 1;
2163
2164 {
2165 ptrdiff_t start_point = PT;
2166 ptrdiff_t pos = PT;
2167 ptrdiff_t pos_byte = PT_BYTE;
2168 unsigned char *p = PT_ADDR, *endp, *stop;
2169
2170 if (forwardp)
2171 {
2172 endp = (XINT (lim) == GPT) ? GPT_ADDR : CHAR_POS_ADDR (XINT (lim));
2173 stop = (pos < GPT && GPT < XINT (lim)) ? GPT_ADDR : endp;
2174 }
2175 else
2176 {
2177 endp = CHAR_POS_ADDR (XINT (lim));
2178 stop = (pos >= GPT && GPT > XINT (lim)) ? GAP_END_ADDR : endp;
2179 }
2180
2181 immediate_quit = 1;
2182 SETUP_SYNTAX_TABLE (pos, forwardp ? 1 : -1);
2183 if (forwardp)
2184 {
2185 if (multibyte)
2186 {
2187 while (1)
2188 {
2189 int nbytes;
2190
2191 if (p >= stop)
2192 {
2193 if (p >= endp)
2194 break;
2195 p = GAP_END_ADDR;
2196 stop = endp;
2197 }
2198 c = STRING_CHAR_AND_LENGTH (p, nbytes);
2199 if (! fastmap[SYNTAX (c)])
2200 break;
2201 p += nbytes, pos++, pos_byte += nbytes;
2202 UPDATE_SYNTAX_TABLE_FORWARD (pos);
2203 }
2204 }
2205 else
2206 {
2207 while (1)
2208 {
2209 if (p >= stop)
2210 {
2211 if (p >= endp)
2212 break;
2213 p = GAP_END_ADDR;
2214 stop = endp;
2215 }
2216 if (! fastmap[SYNTAX (*p)])
2217 break;
2218 p++, pos++, pos_byte++;
2219 UPDATE_SYNTAX_TABLE_FORWARD (pos);
2220 }
2221 }
2222 }
2223 else
2224 {
2225 if (multibyte)
2226 {
2227 while (1)
2228 {
2229 unsigned char *prev_p;
2230
2231 if (p <= stop)
2232 {
2233 if (p <= endp)
2234 break;
2235 p = GPT_ADDR;
2236 stop = endp;
2237 }
2238 UPDATE_SYNTAX_TABLE_BACKWARD (pos - 1);
2239 prev_p = p;
2240 while (--p >= stop && ! CHAR_HEAD_P (*p));
2241 c = STRING_CHAR (p);
2242 if (! fastmap[SYNTAX (c)])
2243 break;
2244 pos--, pos_byte -= prev_p - p;
2245 }
2246 }
2247 else
2248 {
2249 while (1)
2250 {
2251 if (p <= stop)
2252 {
2253 if (p <= endp)
2254 break;
2255 p = GPT_ADDR;
2256 stop = endp;
2257 }
2258 UPDATE_SYNTAX_TABLE_BACKWARD (pos - 1);
2259 if (! fastmap[SYNTAX (p[-1])])
2260 break;
2261 p--, pos--, pos_byte--;
2262 }
2263 }
2264 }
2265
2266 SET_PT_BOTH (pos, pos_byte);
2267 immediate_quit = 0;
2268
2269 return make_number (PT - start_point);
2270 }
2271 }
2272
2273 /* Return true if character C belongs to one of the ISO classes
2274 in the list ISO_CLASSES. Each class is represented by an
2275 integer which is its type according to re_wctype. */
2276
2277 static bool
2278 in_classes (int c, Lisp_Object iso_classes)
2279 {
2280 bool fits_class = 0;
2281
2282 while (CONSP (iso_classes))
2283 {
2284 Lisp_Object elt;
2285 elt = XCAR (iso_classes);
2286 iso_classes = XCDR (iso_classes);
2287
2288 if (re_iswctype (c, XFASTINT (elt)))
2289 fits_class = 1;
2290 }
2291
2292 return fits_class;
2293 }
2294 \f
2295 /* Jump over a comment, assuming we are at the beginning of one.
2296 FROM is the current position.
2297 FROM_BYTE is the bytepos corresponding to FROM.
2298 Do not move past STOP (a charpos).
2299 The comment over which we have to jump is of style STYLE
2300 (either SYNTAX_FLAGS_COMMENT_STYLE (foo) or ST_COMMENT_STYLE).
2301 NESTING should be positive to indicate the nesting at the beginning
2302 for nested comments and should be zero or negative else.
2303 ST_COMMENT_STYLE cannot be nested.
2304 PREV_SYNTAX is the SYNTAX_WITH_FLAGS of the previous character
2305 (or 0 If the search cannot start in the middle of a two-character).
2306
2307 If successful, return true and store the charpos of the comment's end
2308 into *CHARPOS_PTR and the corresponding bytepos into *BYTEPOS_PTR.
2309 Else, return false and store the charpos STOP into *CHARPOS_PTR, the
2310 corresponding bytepos into *BYTEPOS_PTR and the current nesting
2311 (as defined for state.incomment) in *INCOMMENT_PTR.
2312
2313 The comment end is the last character of the comment rather than the
2314 character just after the comment.
2315
2316 Global syntax data is assumed to initially be valid for FROM and
2317 remains valid for forward search starting at the returned position. */
2318
2319 static bool
2320 forw_comment (ptrdiff_t from, ptrdiff_t from_byte, ptrdiff_t stop,
2321 EMACS_INT nesting, int style, int prev_syntax,
2322 ptrdiff_t *charpos_ptr, ptrdiff_t *bytepos_ptr,
2323 EMACS_INT *incomment_ptr)
2324 {
2325 register int c, c1;
2326 register enum syntaxcode code;
2327 register int syntax, other_syntax;
2328
2329 if (nesting <= 0) nesting = -1;
2330
2331 /* Enter the loop in the middle so that we find
2332 a 2-char comment ender if we start in the middle of it. */
2333 syntax = prev_syntax;
2334 if (syntax != 0) goto forw_incomment;
2335
2336 while (1)
2337 {
2338 if (from == stop)
2339 {
2340 *incomment_ptr = nesting;
2341 *charpos_ptr = from;
2342 *bytepos_ptr = from_byte;
2343 return 0;
2344 }
2345 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2346 syntax = SYNTAX_WITH_FLAGS (c);
2347 code = syntax & 0xff;
2348 if (code == Sendcomment
2349 && SYNTAX_FLAGS_COMMENT_STYLE (syntax, 0) == style
2350 && (SYNTAX_FLAGS_COMMENT_NESTED (syntax) ?
2351 (nesting > 0 && --nesting == 0) : nesting < 0))
2352 /* We have encountered a comment end of the same style
2353 as the comment sequence which began this comment
2354 section. */
2355 break;
2356 if (code == Scomment_fence
2357 && style == ST_COMMENT_STYLE)
2358 /* We have encountered a comment end of the same style
2359 as the comment sequence which began this comment
2360 section. */
2361 break;
2362 if (nesting > 0
2363 && code == Scomment
2364 && SYNTAX_FLAGS_COMMENT_NESTED (syntax)
2365 && SYNTAX_FLAGS_COMMENT_STYLE (syntax, 0) == style)
2366 /* We have encountered a nested comment of the same style
2367 as the comment sequence which began this comment section. */
2368 nesting++;
2369 INC_BOTH (from, from_byte);
2370 UPDATE_SYNTAX_TABLE_FORWARD (from);
2371
2372 forw_incomment:
2373 if (from < stop && SYNTAX_FLAGS_COMEND_FIRST (syntax)
2374 && (c1 = FETCH_CHAR_AS_MULTIBYTE (from_byte),
2375 other_syntax = SYNTAX_WITH_FLAGS (c1),
2376 SYNTAX_FLAGS_COMEND_SECOND (other_syntax))
2377 && SYNTAX_FLAGS_COMMENT_STYLE (syntax, other_syntax) == style
2378 && ((SYNTAX_FLAGS_COMMENT_NESTED (syntax) ||
2379 SYNTAX_FLAGS_COMMENT_NESTED (other_syntax))
2380 ? nesting > 0 : nesting < 0))
2381 {
2382 if (--nesting <= 0)
2383 /* We have encountered a comment end of the same style
2384 as the comment sequence which began this comment section. */
2385 break;
2386 else
2387 {
2388 INC_BOTH (from, from_byte);
2389 UPDATE_SYNTAX_TABLE_FORWARD (from);
2390 }
2391 }
2392 if (nesting > 0
2393 && from < stop
2394 && SYNTAX_FLAGS_COMSTART_FIRST (syntax)
2395 && (c1 = FETCH_CHAR_AS_MULTIBYTE (from_byte),
2396 other_syntax = SYNTAX_WITH_FLAGS (c1),
2397 SYNTAX_FLAGS_COMMENT_STYLE (other_syntax, syntax) == style
2398 && SYNTAX_FLAGS_COMSTART_SECOND (other_syntax))
2399 && (SYNTAX_FLAGS_COMMENT_NESTED (syntax) ||
2400 SYNTAX_FLAGS_COMMENT_NESTED (other_syntax)))
2401 /* We have encountered a nested comment of the same style
2402 as the comment sequence which began this comment section. */
2403 {
2404 INC_BOTH (from, from_byte);
2405 UPDATE_SYNTAX_TABLE_FORWARD (from);
2406 nesting++;
2407 }
2408 }
2409 *charpos_ptr = from;
2410 *bytepos_ptr = from_byte;
2411 return 1;
2412 }
2413
2414 DEFUN ("forward-comment", Fforward_comment, Sforward_comment, 1, 1, 0,
2415 doc: /*
2416 Move forward across up to COUNT comments. If COUNT is negative, move backward.
2417 Stop scanning if we find something other than a comment or whitespace.
2418 Set point to where scanning stops.
2419 If COUNT comments are found as expected, with nothing except whitespace
2420 between them, return t; otherwise return nil. */)
2421 (Lisp_Object count)
2422 {
2423 ptrdiff_t from, from_byte, stop;
2424 int c, c1;
2425 enum syntaxcode code;
2426 int comstyle = 0; /* style of comment encountered */
2427 bool comnested = 0; /* whether the comment is nestable or not */
2428 bool found;
2429 EMACS_INT count1;
2430 ptrdiff_t out_charpos, out_bytepos;
2431 EMACS_INT dummy;
2432
2433 CHECK_NUMBER (count);
2434 count1 = XINT (count);
2435 stop = count1 > 0 ? ZV : BEGV;
2436
2437 immediate_quit = 1;
2438 QUIT;
2439
2440 from = PT;
2441 from_byte = PT_BYTE;
2442
2443 SETUP_SYNTAX_TABLE (from, count1);
2444 while (count1 > 0)
2445 {
2446 do
2447 {
2448 bool comstart_first;
2449 int syntax, other_syntax;
2450
2451 if (from == stop)
2452 {
2453 SET_PT_BOTH (from, from_byte);
2454 immediate_quit = 0;
2455 return Qnil;
2456 }
2457 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2458 syntax = SYNTAX_WITH_FLAGS (c);
2459 code = SYNTAX (c);
2460 comstart_first = SYNTAX_FLAGS_COMSTART_FIRST (syntax);
2461 comnested = SYNTAX_FLAGS_COMMENT_NESTED (syntax);
2462 comstyle = SYNTAX_FLAGS_COMMENT_STYLE (syntax, 0);
2463 INC_BOTH (from, from_byte);
2464 UPDATE_SYNTAX_TABLE_FORWARD (from);
2465 if (from < stop && comstart_first
2466 && (c1 = FETCH_CHAR_AS_MULTIBYTE (from_byte),
2467 other_syntax = SYNTAX_WITH_FLAGS (c1),
2468 SYNTAX_FLAGS_COMSTART_SECOND (other_syntax)))
2469 {
2470 /* We have encountered a comment start sequence and we
2471 are ignoring all text inside comments. We must record
2472 the comment style this sequence begins so that later,
2473 only a comment end of the same style actually ends
2474 the comment section. */
2475 code = Scomment;
2476 comstyle = SYNTAX_FLAGS_COMMENT_STYLE (other_syntax, syntax);
2477 comnested |= SYNTAX_FLAGS_COMMENT_NESTED (other_syntax);
2478 INC_BOTH (from, from_byte);
2479 UPDATE_SYNTAX_TABLE_FORWARD (from);
2480 }
2481 }
2482 while (code == Swhitespace || (code == Sendcomment && c == '\n'));
2483
2484 if (code == Scomment_fence)
2485 comstyle = ST_COMMENT_STYLE;
2486 else if (code != Scomment)
2487 {
2488 immediate_quit = 0;
2489 DEC_BOTH (from, from_byte);
2490 SET_PT_BOTH (from, from_byte);
2491 return Qnil;
2492 }
2493 /* We're at the start of a comment. */
2494 found = forw_comment (from, from_byte, stop, comnested, comstyle, 0,
2495 &out_charpos, &out_bytepos, &dummy);
2496 from = out_charpos; from_byte = out_bytepos;
2497 if (!found)
2498 {
2499 immediate_quit = 0;
2500 SET_PT_BOTH (from, from_byte);
2501 return Qnil;
2502 }
2503 INC_BOTH (from, from_byte);
2504 UPDATE_SYNTAX_TABLE_FORWARD (from);
2505 /* We have skipped one comment. */
2506 count1--;
2507 }
2508
2509 while (count1 < 0)
2510 {
2511 while (1)
2512 {
2513 bool quoted;
2514 int syntax;
2515
2516 if (from <= stop)
2517 {
2518 SET_PT_BOTH (BEGV, BEGV_BYTE);
2519 immediate_quit = 0;
2520 return Qnil;
2521 }
2522
2523 DEC_BOTH (from, from_byte);
2524 /* char_quoted does UPDATE_SYNTAX_TABLE_BACKWARD (from). */
2525 quoted = char_quoted (from, from_byte);
2526 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2527 syntax = SYNTAX_WITH_FLAGS (c);
2528 code = SYNTAX (c);
2529 comstyle = 0;
2530 comnested = SYNTAX_FLAGS_COMMENT_NESTED (syntax);
2531 if (code == Sendcomment)
2532 comstyle = SYNTAX_FLAGS_COMMENT_STYLE (syntax, 0);
2533 if (from > stop && SYNTAX_FLAGS_COMEND_SECOND (syntax)
2534 && prev_char_comend_first (from, from_byte)
2535 && !char_quoted (from - 1, dec_bytepos (from_byte)))
2536 {
2537 int other_syntax;
2538 /* We must record the comment style encountered so that
2539 later, we can match only the proper comment begin
2540 sequence of the same style. */
2541 DEC_BOTH (from, from_byte);
2542 code = Sendcomment;
2543 /* Calling char_quoted, above, set up global syntax position
2544 at the new value of FROM. */
2545 c1 = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2546 other_syntax = SYNTAX_WITH_FLAGS (c1);
2547 comstyle = SYNTAX_FLAGS_COMMENT_STYLE (other_syntax, syntax);
2548 comnested |= SYNTAX_FLAGS_COMMENT_NESTED (other_syntax);
2549 }
2550
2551 if (code == Scomment_fence)
2552 {
2553 /* Skip until first preceding unquoted comment_fence. */
2554 bool fence_found = 0;
2555 ptrdiff_t ini = from, ini_byte = from_byte;
2556
2557 while (1)
2558 {
2559 DEC_BOTH (from, from_byte);
2560 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2561 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2562 if (SYNTAX (c) == Scomment_fence
2563 && !char_quoted (from, from_byte))
2564 {
2565 fence_found = 1;
2566 break;
2567 }
2568 else if (from == stop)
2569 break;
2570 }
2571 if (fence_found == 0)
2572 {
2573 from = ini; /* Set point to ini + 1. */
2574 from_byte = ini_byte;
2575 goto leave;
2576 }
2577 else
2578 /* We have skipped one comment. */
2579 break;
2580 }
2581 else if (code == Sendcomment)
2582 {
2583 found = back_comment (from, from_byte, stop, comnested, comstyle,
2584 &out_charpos, &out_bytepos);
2585 if (!found)
2586 {
2587 if (c == '\n')
2588 /* This end-of-line is not an end-of-comment.
2589 Treat it like a whitespace.
2590 CC-mode (and maybe others) relies on this behavior. */
2591 ;
2592 else
2593 {
2594 /* Failure: we should go back to the end of this
2595 not-quite-endcomment. */
2596 if (SYNTAX (c) != code)
2597 /* It was a two-char Sendcomment. */
2598 INC_BOTH (from, from_byte);
2599 goto leave;
2600 }
2601 }
2602 else
2603 {
2604 /* We have skipped one comment. */
2605 from = out_charpos, from_byte = out_bytepos;
2606 break;
2607 }
2608 }
2609 else if (code != Swhitespace || quoted)
2610 {
2611 leave:
2612 immediate_quit = 0;
2613 INC_BOTH (from, from_byte);
2614 SET_PT_BOTH (from, from_byte);
2615 return Qnil;
2616 }
2617 }
2618
2619 count1++;
2620 }
2621
2622 SET_PT_BOTH (from, from_byte);
2623 immediate_quit = 0;
2624 return Qt;
2625 }
2626 \f
2627 /* Return syntax code of character C if C is an ASCII character
2628 or if MULTIBYTE_SYMBOL_P is false. Otherwise, return Ssymbol. */
2629
2630 static enum syntaxcode
2631 syntax_multibyte (int c, bool multibyte_symbol_p)
2632 {
2633 return ASCII_CHAR_P (c) || !multibyte_symbol_p ? SYNTAX (c) : Ssymbol;
2634 }
2635
2636 static Lisp_Object
2637 scan_lists (EMACS_INT from, EMACS_INT count, EMACS_INT depth, bool sexpflag)
2638 {
2639 Lisp_Object val;
2640 ptrdiff_t stop = count > 0 ? ZV : BEGV;
2641 int c, c1;
2642 int stringterm;
2643 bool quoted;
2644 bool mathexit = 0;
2645 enum syntaxcode code;
2646 EMACS_INT min_depth = depth; /* Err out if depth gets less than this. */
2647 int comstyle = 0; /* Style of comment encountered. */
2648 bool comnested = 0; /* Whether the comment is nestable or not. */
2649 ptrdiff_t temp_pos;
2650 EMACS_INT last_good = from;
2651 bool found;
2652 ptrdiff_t from_byte;
2653 ptrdiff_t out_bytepos, out_charpos;
2654 EMACS_INT dummy;
2655 bool multibyte_symbol_p = sexpflag && multibyte_syntax_as_symbol;
2656
2657 if (depth > 0) min_depth = 0;
2658
2659 if (from > ZV) from = ZV;
2660 if (from < BEGV) from = BEGV;
2661
2662 from_byte = CHAR_TO_BYTE (from);
2663
2664 immediate_quit = 1;
2665 QUIT;
2666
2667 SETUP_SYNTAX_TABLE (from, count);
2668 while (count > 0)
2669 {
2670 while (from < stop)
2671 {
2672 bool comstart_first, prefix;
2673 int syntax, other_syntax;
2674 UPDATE_SYNTAX_TABLE_FORWARD (from);
2675 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2676 syntax = SYNTAX_WITH_FLAGS (c);
2677 code = syntax_multibyte (c, multibyte_symbol_p);
2678 comstart_first = SYNTAX_FLAGS_COMSTART_FIRST (syntax);
2679 comnested = SYNTAX_FLAGS_COMMENT_NESTED (syntax);
2680 comstyle = SYNTAX_FLAGS_COMMENT_STYLE (syntax, 0);
2681 prefix = SYNTAX_FLAGS_PREFIX (syntax);
2682 if (depth == min_depth)
2683 last_good = from;
2684 INC_BOTH (from, from_byte);
2685 UPDATE_SYNTAX_TABLE_FORWARD (from);
2686 if (from < stop && comstart_first
2687 && (c = FETCH_CHAR_AS_MULTIBYTE (from_byte),
2688 other_syntax = SYNTAX_WITH_FLAGS (c),
2689 SYNTAX_FLAGS_COMSTART_SECOND (other_syntax))
2690 && parse_sexp_ignore_comments)
2691 {
2692 /* We have encountered a comment start sequence and we
2693 are ignoring all text inside comments. We must record
2694 the comment style this sequence begins so that later,
2695 only a comment end of the same style actually ends
2696 the comment section. */
2697 code = Scomment;
2698 comstyle = SYNTAX_FLAGS_COMMENT_STYLE (other_syntax, syntax);
2699 comnested |= SYNTAX_FLAGS_COMMENT_NESTED (other_syntax);
2700 INC_BOTH (from, from_byte);
2701 UPDATE_SYNTAX_TABLE_FORWARD (from);
2702 }
2703
2704 if (prefix)
2705 continue;
2706
2707 switch (code)
2708 {
2709 case Sescape:
2710 case Scharquote:
2711 if (from == stop)
2712 goto lose;
2713 INC_BOTH (from, from_byte);
2714 /* Treat following character as a word constituent. */
2715 case Sword:
2716 case Ssymbol:
2717 if (depth || !sexpflag) break;
2718 /* This word counts as a sexp; return at end of it. */
2719 while (from < stop)
2720 {
2721 UPDATE_SYNTAX_TABLE_FORWARD (from);
2722
2723 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2724 switch (syntax_multibyte (c, multibyte_symbol_p))
2725 {
2726 case Scharquote:
2727 case Sescape:
2728 INC_BOTH (from, from_byte);
2729 if (from == stop)
2730 goto lose;
2731 break;
2732 case Sword:
2733 case Ssymbol:
2734 case Squote:
2735 break;
2736 default:
2737 goto done;
2738 }
2739 INC_BOTH (from, from_byte);
2740 }
2741 goto done;
2742
2743 case Scomment_fence:
2744 comstyle = ST_COMMENT_STYLE;
2745 /* FALLTHROUGH */
2746 case Scomment:
2747 if (!parse_sexp_ignore_comments) break;
2748 UPDATE_SYNTAX_TABLE_FORWARD (from);
2749 found = forw_comment (from, from_byte, stop,
2750 comnested, comstyle, 0,
2751 &out_charpos, &out_bytepos, &dummy);
2752 from = out_charpos, from_byte = out_bytepos;
2753 if (!found)
2754 {
2755 if (depth == 0)
2756 goto done;
2757 goto lose;
2758 }
2759 INC_BOTH (from, from_byte);
2760 UPDATE_SYNTAX_TABLE_FORWARD (from);
2761 break;
2762
2763 case Smath:
2764 if (!sexpflag)
2765 break;
2766 if (from != stop && c == FETCH_CHAR_AS_MULTIBYTE (from_byte))
2767 {
2768 INC_BOTH (from, from_byte);
2769 }
2770 if (mathexit)
2771 {
2772 mathexit = 0;
2773 goto close1;
2774 }
2775 mathexit = 1;
2776
2777 case Sopen:
2778 if (!++depth) goto done;
2779 break;
2780
2781 case Sclose:
2782 close1:
2783 if (!--depth) goto done;
2784 if (depth < min_depth)
2785 xsignal3 (Qscan_error,
2786 build_string ("Containing expression ends prematurely"),
2787 make_number (last_good), make_number (from));
2788 break;
2789
2790 case Sstring:
2791 case Sstring_fence:
2792 temp_pos = dec_bytepos (from_byte);
2793 stringterm = FETCH_CHAR_AS_MULTIBYTE (temp_pos);
2794 while (1)
2795 {
2796 enum syntaxcode c_code;
2797 if (from >= stop)
2798 goto lose;
2799 UPDATE_SYNTAX_TABLE_FORWARD (from);
2800 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2801 c_code = syntax_multibyte (c, multibyte_symbol_p);
2802 if (code == Sstring
2803 ? c == stringterm && c_code == Sstring
2804 : c_code == Sstring_fence)
2805 break;
2806
2807 if (c_code == Scharquote || c_code == Sescape)
2808 INC_BOTH (from, from_byte);
2809 INC_BOTH (from, from_byte);
2810 }
2811 INC_BOTH (from, from_byte);
2812 if (!depth && sexpflag) goto done;
2813 break;
2814 default:
2815 /* Ignore whitespace, punctuation, quote, endcomment. */
2816 break;
2817 }
2818 }
2819
2820 /* Reached end of buffer. Error if within object, return nil if between */
2821 if (depth)
2822 goto lose;
2823
2824 immediate_quit = 0;
2825 return Qnil;
2826
2827 /* End of object reached */
2828 done:
2829 count--;
2830 }
2831
2832 while (count < 0)
2833 {
2834 while (from > stop)
2835 {
2836 int syntax;
2837 DEC_BOTH (from, from_byte);
2838 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2839 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2840 syntax= SYNTAX_WITH_FLAGS (c);
2841 code = syntax_multibyte (c, multibyte_symbol_p);
2842 if (depth == min_depth)
2843 last_good = from;
2844 comstyle = 0;
2845 comnested = SYNTAX_FLAGS_COMMENT_NESTED (syntax);
2846 if (code == Sendcomment)
2847 comstyle = SYNTAX_FLAGS_COMMENT_STYLE (syntax, 0);
2848 if (from > stop && SYNTAX_FLAGS_COMEND_SECOND (syntax)
2849 && prev_char_comend_first (from, from_byte)
2850 && parse_sexp_ignore_comments)
2851 {
2852 /* We must record the comment style encountered so that
2853 later, we can match only the proper comment begin
2854 sequence of the same style. */
2855 int c2, other_syntax;
2856 DEC_BOTH (from, from_byte);
2857 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2858 code = Sendcomment;
2859 c2 = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2860 other_syntax = SYNTAX_WITH_FLAGS (c2);
2861 comstyle = SYNTAX_FLAGS_COMMENT_STYLE (other_syntax, syntax);
2862 comnested |= SYNTAX_FLAGS_COMMENT_NESTED (other_syntax);
2863 }
2864
2865 /* Quoting turns anything except a comment-ender
2866 into a word character. Note that this cannot be true
2867 if we decremented FROM in the if-statement above. */
2868 if (code != Sendcomment && char_quoted (from, from_byte))
2869 {
2870 DEC_BOTH (from, from_byte);
2871 code = Sword;
2872 }
2873 else if (SYNTAX_FLAGS_PREFIX (syntax))
2874 continue;
2875
2876 switch (code)
2877 {
2878 case Sword:
2879 case Ssymbol:
2880 case Sescape:
2881 case Scharquote:
2882 if (depth || !sexpflag) break;
2883 /* This word counts as a sexp; count object finished
2884 after passing it. */
2885 while (from > stop)
2886 {
2887 temp_pos = from_byte;
2888 if (! NILP (BVAR (current_buffer, enable_multibyte_characters)))
2889 DEC_POS (temp_pos);
2890 else
2891 temp_pos--;
2892 UPDATE_SYNTAX_TABLE_BACKWARD (from - 1);
2893 c1 = FETCH_CHAR_AS_MULTIBYTE (temp_pos);
2894 /* Don't allow comment-end to be quoted. */
2895 if (syntax_multibyte (c1, multibyte_symbol_p) == Sendcomment)
2896 goto done2;
2897 quoted = char_quoted (from - 1, temp_pos);
2898 if (quoted)
2899 {
2900 DEC_BOTH (from, from_byte);
2901 temp_pos = dec_bytepos (temp_pos);
2902 UPDATE_SYNTAX_TABLE_BACKWARD (from - 1);
2903 }
2904 c1 = FETCH_CHAR_AS_MULTIBYTE (temp_pos);
2905 if (! quoted)
2906 switch (syntax_multibyte (c1, multibyte_symbol_p))
2907 {
2908 case Sword: case Ssymbol: case Squote: break;
2909 default: goto done2;
2910 }
2911 DEC_BOTH (from, from_byte);
2912 }
2913 goto done2;
2914
2915 case Smath:
2916 if (!sexpflag)
2917 break;
2918 if (from > BEGV)
2919 {
2920 temp_pos = dec_bytepos (from_byte);
2921 UPDATE_SYNTAX_TABLE_BACKWARD (from - 1);
2922 if (from != stop && c == FETCH_CHAR_AS_MULTIBYTE (temp_pos))
2923 DEC_BOTH (from, from_byte);
2924 }
2925 if (mathexit)
2926 {
2927 mathexit = 0;
2928 goto open2;
2929 }
2930 mathexit = 1;
2931
2932 case Sclose:
2933 if (!++depth) goto done2;
2934 break;
2935
2936 case Sopen:
2937 open2:
2938 if (!--depth) goto done2;
2939 if (depth < min_depth)
2940 xsignal3 (Qscan_error,
2941 build_string ("Containing expression ends prematurely"),
2942 make_number (last_good), make_number (from));
2943 break;
2944
2945 case Sendcomment:
2946 if (!parse_sexp_ignore_comments)
2947 break;
2948 found = back_comment (from, from_byte, stop, comnested, comstyle,
2949 &out_charpos, &out_bytepos);
2950 /* FIXME: if !found, it really wasn't a comment-end.
2951 For single-char Sendcomment, we can't do much about it apart
2952 from skipping the char.
2953 For 2-char endcomments, we could try again, taking both
2954 chars as separate entities, but it's a lot of trouble
2955 for very little gain, so we don't bother either. -sm */
2956 if (found)
2957 from = out_charpos, from_byte = out_bytepos;
2958 break;
2959
2960 case Scomment_fence:
2961 case Sstring_fence:
2962 while (1)
2963 {
2964 if (from == stop)
2965 goto lose;
2966 DEC_BOTH (from, from_byte);
2967 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2968 if (!char_quoted (from, from_byte))
2969 {
2970 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2971 if (syntax_multibyte (c, multibyte_symbol_p) == code)
2972 break;
2973 }
2974 }
2975 if (code == Sstring_fence && !depth && sexpflag) goto done2;
2976 break;
2977
2978 case Sstring:
2979 stringterm = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2980 while (1)
2981 {
2982 if (from == stop)
2983 goto lose;
2984 DEC_BOTH (from, from_byte);
2985 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2986 if (!char_quoted (from, from_byte))
2987 {
2988 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
2989 if (c == stringterm
2990 && (syntax_multibyte (c, multibyte_symbol_p)
2991 == Sstring))
2992 break;
2993 }
2994 }
2995 if (!depth && sexpflag) goto done2;
2996 break;
2997 default:
2998 /* Ignore whitespace, punctuation, quote, endcomment. */
2999 break;
3000 }
3001 }
3002
3003 /* Reached start of buffer. Error if within object, return nil if between */
3004 if (depth)
3005 goto lose;
3006
3007 immediate_quit = 0;
3008 return Qnil;
3009
3010 done2:
3011 count++;
3012 }
3013
3014
3015 immediate_quit = 0;
3016 XSETFASTINT (val, from);
3017 return val;
3018
3019 lose:
3020 xsignal3 (Qscan_error,
3021 build_string ("Unbalanced parentheses"),
3022 make_number (last_good), make_number (from));
3023 }
3024
3025 DEFUN ("scan-lists", Fscan_lists, Sscan_lists, 3, 3, 0,
3026 doc: /* Scan from character number FROM by COUNT lists.
3027 Scan forward if COUNT is positive, backward if COUNT is negative.
3028 Return the character number of the position thus found.
3029
3030 A \"list", in this context, refers to a balanced parenthetical
3031 grouping, as determined by the syntax table.
3032
3033 If DEPTH is nonzero, treat that as the nesting depth of the starting
3034 point (i.e. the starting point is DEPTH parentheses deep). This
3035 function scans over parentheses until the depth goes to zero COUNT
3036 times. Hence, positive DEPTH moves out that number of levels of
3037 parentheses, while negative DEPTH moves to a deeper level.
3038
3039 Comments are ignored if `parse-sexp-ignore-comments' is non-nil.
3040
3041 If we reach the beginning or end of the accessible part of the buffer
3042 before we have scanned over COUNT lists, return nil if the depth at
3043 that point is zero, and signal a error if the depth is nonzero. */)
3044 (Lisp_Object from, Lisp_Object count, Lisp_Object depth)
3045 {
3046 CHECK_NUMBER (from);
3047 CHECK_NUMBER (count);
3048 CHECK_NUMBER (depth);
3049
3050 return scan_lists (XINT (from), XINT (count), XINT (depth), 0);
3051 }
3052
3053 DEFUN ("scan-sexps", Fscan_sexps, Sscan_sexps, 2, 2, 0,
3054 doc: /* Scan from character number FROM by COUNT balanced expressions.
3055 If COUNT is negative, scan backwards.
3056 Returns the character number of the position thus found.
3057
3058 Comments are ignored if `parse-sexp-ignore-comments' is non-nil.
3059
3060 If the beginning or end of (the accessible part of) the buffer is reached
3061 in the middle of a parenthetical grouping, an error is signaled.
3062 If the beginning or end is reached between groupings
3063 but before count is used up, nil is returned. */)
3064 (Lisp_Object from, Lisp_Object count)
3065 {
3066 CHECK_NUMBER (from);
3067 CHECK_NUMBER (count);
3068
3069 return scan_lists (XINT (from), XINT (count), 0, 1);
3070 }
3071
3072 DEFUN ("backward-prefix-chars", Fbackward_prefix_chars, Sbackward_prefix_chars,
3073 0, 0, 0,
3074 doc: /* Move point backward over any number of chars with prefix syntax.
3075 This includes chars with expression prefix syntax class (') and those with
3076 the prefix syntax flag (p). */)
3077 (void)
3078 {
3079 ptrdiff_t beg = BEGV;
3080 ptrdiff_t opoint = PT;
3081 ptrdiff_t opoint_byte = PT_BYTE;
3082 ptrdiff_t pos = PT;
3083 ptrdiff_t pos_byte = PT_BYTE;
3084 int c;
3085
3086 if (pos <= beg)
3087 {
3088 SET_PT_BOTH (opoint, opoint_byte);
3089
3090 return Qnil;
3091 }
3092
3093 SETUP_SYNTAX_TABLE (pos, -1);
3094
3095 DEC_BOTH (pos, pos_byte);
3096
3097 while (!char_quoted (pos, pos_byte)
3098 /* Previous statement updates syntax table. */
3099 && ((c = FETCH_CHAR_AS_MULTIBYTE (pos_byte), SYNTAX (c) == Squote)
3100 || syntax_prefix_flag_p (c)))
3101 {
3102 opoint = pos;
3103 opoint_byte = pos_byte;
3104
3105 if (pos + 1 > beg)
3106 DEC_BOTH (pos, pos_byte);
3107 }
3108
3109 SET_PT_BOTH (opoint, opoint_byte);
3110
3111 return Qnil;
3112 }
3113 \f
3114 /* Parse forward from FROM / FROM_BYTE to END,
3115 assuming that FROM has state OLDSTATE (nil means FROM is start of function),
3116 and return a description of the state of the parse at END.
3117 If STOPBEFORE, stop at the start of an atom.
3118 If COMMENTSTOP is 1, stop at the start of a comment.
3119 If COMMENTSTOP is -1, stop at the start or end of a comment,
3120 after the beginning of a string, or after the end of a string. */
3121
3122 static void
3123 scan_sexps_forward (struct lisp_parse_state *stateptr,
3124 ptrdiff_t from, ptrdiff_t from_byte, ptrdiff_t end,
3125 EMACS_INT targetdepth, bool stopbefore,
3126 Lisp_Object oldstate, int commentstop)
3127 {
3128 struct lisp_parse_state state;
3129 enum syntaxcode code;
3130 int c1;
3131 bool comnested;
3132 struct level { ptrdiff_t last, prev; };
3133 struct level levelstart[100];
3134 struct level *curlevel = levelstart;
3135 struct level *endlevel = levelstart + 100;
3136 EMACS_INT depth; /* Paren depth of current scanning location.
3137 level - levelstart equals this except
3138 when the depth becomes negative. */
3139 EMACS_INT mindepth; /* Lowest DEPTH value seen. */
3140 bool start_quoted = 0; /* True means starting after a char quote. */
3141 Lisp_Object tem;
3142 ptrdiff_t prev_from; /* Keep one character before FROM. */
3143 ptrdiff_t prev_from_byte;
3144 int prev_from_syntax;
3145 bool boundary_stop = commentstop == -1;
3146 bool nofence;
3147 bool found;
3148 ptrdiff_t out_bytepos, out_charpos;
3149 int temp;
3150
3151 prev_from = from;
3152 prev_from_byte = from_byte;
3153 if (from != BEGV)
3154 DEC_BOTH (prev_from, prev_from_byte);
3155
3156 /* Use this macro instead of `from++'. */
3157 #define INC_FROM \
3158 do { prev_from = from; \
3159 prev_from_byte = from_byte; \
3160 temp = FETCH_CHAR_AS_MULTIBYTE (prev_from_byte); \
3161 prev_from_syntax = SYNTAX_WITH_FLAGS (temp); \
3162 INC_BOTH (from, from_byte); \
3163 if (from < end) \
3164 UPDATE_SYNTAX_TABLE_FORWARD (from); \
3165 } while (0)
3166
3167 immediate_quit = 1;
3168 QUIT;
3169
3170 if (NILP (oldstate))
3171 {
3172 depth = 0;
3173 state.instring = -1;
3174 state.incomment = 0;
3175 state.comstyle = 0; /* comment style a by default. */
3176 state.comstr_start = -1; /* no comment/string seen. */
3177 }
3178 else
3179 {
3180 tem = Fcar (oldstate);
3181 if (!NILP (tem))
3182 depth = XINT (tem);
3183 else
3184 depth = 0;
3185
3186 oldstate = Fcdr (oldstate);
3187 oldstate = Fcdr (oldstate);
3188 oldstate = Fcdr (oldstate);
3189 tem = Fcar (oldstate);
3190 /* Check whether we are inside string_fence-style string: */
3191 state.instring = (!NILP (tem)
3192 ? (CHARACTERP (tem) ? XFASTINT (tem) : ST_STRING_STYLE)
3193 : -1);
3194
3195 oldstate = Fcdr (oldstate);
3196 tem = Fcar (oldstate);
3197 state.incomment = (!NILP (tem)
3198 ? (INTEGERP (tem) ? XINT (tem) : -1)
3199 : 0);
3200
3201 oldstate = Fcdr (oldstate);
3202 tem = Fcar (oldstate);
3203 start_quoted = !NILP (tem);
3204
3205 /* if the eighth element of the list is nil, we are in comment
3206 style a. If it is non-nil, we are in comment style b */
3207 oldstate = Fcdr (oldstate);
3208 oldstate = Fcdr (oldstate);
3209 tem = Fcar (oldstate);
3210 state.comstyle = (NILP (tem)
3211 ? 0
3212 : (RANGED_INTEGERP (0, tem, ST_COMMENT_STYLE)
3213 ? XINT (tem)
3214 : ST_COMMENT_STYLE));
3215
3216 oldstate = Fcdr (oldstate);
3217 tem = Fcar (oldstate);
3218 state.comstr_start =
3219 RANGED_INTEGERP (PTRDIFF_MIN, tem, PTRDIFF_MAX) ? XINT (tem) : -1;
3220 oldstate = Fcdr (oldstate);
3221 tem = Fcar (oldstate);
3222 while (!NILP (tem)) /* >= second enclosing sexps. */
3223 {
3224 Lisp_Object temhd = Fcar (tem);
3225 if (RANGED_INTEGERP (PTRDIFF_MIN, temhd, PTRDIFF_MAX))
3226 curlevel->last = XINT (temhd);
3227 if (++curlevel == endlevel)
3228 curlevel--; /* error ("Nesting too deep for parser"); */
3229 curlevel->prev = -1;
3230 curlevel->last = -1;
3231 tem = Fcdr (tem);
3232 }
3233 }
3234 state.quoted = 0;
3235 mindepth = depth;
3236
3237 curlevel->prev = -1;
3238 curlevel->last = -1;
3239
3240 SETUP_SYNTAX_TABLE (prev_from, 1);
3241 temp = FETCH_CHAR (prev_from_byte);
3242 prev_from_syntax = SYNTAX_WITH_FLAGS (temp);
3243 UPDATE_SYNTAX_TABLE_FORWARD (from);
3244
3245 /* Enter the loop at a place appropriate for initial state. */
3246
3247 if (state.incomment)
3248 goto startincomment;
3249 if (state.instring >= 0)
3250 {
3251 nofence = state.instring != ST_STRING_STYLE;
3252 if (start_quoted)
3253 goto startquotedinstring;
3254 goto startinstring;
3255 }
3256 else if (start_quoted)
3257 goto startquoted;
3258
3259 while (from < end)
3260 {
3261 int syntax;
3262 INC_FROM;
3263 code = prev_from_syntax & 0xff;
3264
3265 if (from < end
3266 && SYNTAX_FLAGS_COMSTART_FIRST (prev_from_syntax)
3267 && (c1 = FETCH_CHAR (from_byte),
3268 syntax = SYNTAX_WITH_FLAGS (c1),
3269 SYNTAX_FLAGS_COMSTART_SECOND (syntax)))
3270 /* Duplicate code to avoid a complex if-expression
3271 which causes trouble for the SGI compiler. */
3272 {
3273 /* Record the comment style we have entered so that only
3274 the comment-end sequence of the same style actually
3275 terminates the comment section. */
3276 state.comstyle
3277 = SYNTAX_FLAGS_COMMENT_STYLE (syntax, prev_from_syntax);
3278 comnested = (SYNTAX_FLAGS_COMMENT_NESTED (prev_from_syntax)
3279 | SYNTAX_FLAGS_COMMENT_NESTED (syntax));
3280 state.incomment = comnested ? 1 : -1;
3281 state.comstr_start = prev_from;
3282 INC_FROM;
3283 code = Scomment;
3284 }
3285 else if (code == Scomment_fence)
3286 {
3287 /* Record the comment style we have entered so that only
3288 the comment-end sequence of the same style actually
3289 terminates the comment section. */
3290 state.comstyle = ST_COMMENT_STYLE;
3291 state.incomment = -1;
3292 state.comstr_start = prev_from;
3293 code = Scomment;
3294 }
3295 else if (code == Scomment)
3296 {
3297 state.comstyle = SYNTAX_FLAGS_COMMENT_STYLE (prev_from_syntax, 0);
3298 state.incomment = (SYNTAX_FLAGS_COMMENT_NESTED (prev_from_syntax) ?
3299 1 : -1);
3300 state.comstr_start = prev_from;
3301 }
3302
3303 if (SYNTAX_FLAGS_PREFIX (prev_from_syntax))
3304 continue;
3305 switch (code)
3306 {
3307 case Sescape:
3308 case Scharquote:
3309 if (stopbefore) goto stop; /* this arg means stop at sexp start */
3310 curlevel->last = prev_from;
3311 startquoted:
3312 if (from == end) goto endquoted;
3313 INC_FROM;
3314 goto symstarted;
3315 /* treat following character as a word constituent */
3316 case Sword:
3317 case Ssymbol:
3318 if (stopbefore) goto stop; /* this arg means stop at sexp start */
3319 curlevel->last = prev_from;
3320 symstarted:
3321 while (from < end)
3322 {
3323 int symchar = FETCH_CHAR_AS_MULTIBYTE (from_byte);
3324 switch (SYNTAX (symchar))
3325 {
3326 case Scharquote:
3327 case Sescape:
3328 INC_FROM;
3329 if (from == end) goto endquoted;
3330 break;
3331 case Sword:
3332 case Ssymbol:
3333 case Squote:
3334 break;
3335 default:
3336 goto symdone;
3337 }
3338 INC_FROM;
3339 }
3340 symdone:
3341 curlevel->prev = curlevel->last;
3342 break;
3343
3344 case Scomment_fence: /* Can't happen because it's handled above. */
3345 case Scomment:
3346 if (commentstop || boundary_stop) goto done;
3347 startincomment:
3348 /* The (from == BEGV) test was to enter the loop in the middle so
3349 that we find a 2-char comment ender even if we start in the
3350 middle of it. We don't want to do that if we're just at the
3351 beginning of the comment (think of (*) ... (*)). */
3352 found = forw_comment (from, from_byte, end,
3353 state.incomment, state.comstyle,
3354 (from == BEGV || from < state.comstr_start + 3)
3355 ? 0 : prev_from_syntax,
3356 &out_charpos, &out_bytepos, &state.incomment);
3357 from = out_charpos; from_byte = out_bytepos;
3358 /* Beware! prev_from and friends are invalid now.
3359 Luckily, the `done' doesn't use them and the INC_FROM
3360 sets them to a sane value without looking at them. */
3361 if (!found) goto done;
3362 INC_FROM;
3363 state.incomment = 0;
3364 state.comstyle = 0; /* reset the comment style */
3365 if (boundary_stop) goto done;
3366 break;
3367
3368 case Sopen:
3369 if (stopbefore) goto stop; /* this arg means stop at sexp start */
3370 depth++;
3371 /* curlevel++->last ran into compiler bug on Apollo */
3372 curlevel->last = prev_from;
3373 if (++curlevel == endlevel)
3374 curlevel--; /* error ("Nesting too deep for parser"); */
3375 curlevel->prev = -1;
3376 curlevel->last = -1;
3377 if (targetdepth == depth) goto done;
3378 break;
3379
3380 case Sclose:
3381 depth--;
3382 if (depth < mindepth)
3383 mindepth = depth;
3384 if (curlevel != levelstart)
3385 curlevel--;
3386 curlevel->prev = curlevel->last;
3387 if (targetdepth == depth) goto done;
3388 break;
3389
3390 case Sstring:
3391 case Sstring_fence:
3392 state.comstr_start = from - 1;
3393 if (stopbefore) goto stop; /* this arg means stop at sexp start */
3394 curlevel->last = prev_from;
3395 state.instring = (code == Sstring
3396 ? (FETCH_CHAR_AS_MULTIBYTE (prev_from_byte))
3397 : ST_STRING_STYLE);
3398 if (boundary_stop) goto done;
3399 startinstring:
3400 {
3401 nofence = state.instring != ST_STRING_STYLE;
3402
3403 while (1)
3404 {
3405 int c;
3406 enum syntaxcode c_code;
3407
3408 if (from >= end) goto done;
3409 c = FETCH_CHAR_AS_MULTIBYTE (from_byte);
3410 c_code = SYNTAX (c);
3411
3412 /* Check C_CODE here so that if the char has
3413 a syntax-table property which says it is NOT
3414 a string character, it does not end the string. */
3415 if (nofence && c == state.instring && c_code == Sstring)
3416 break;
3417
3418 switch (c_code)
3419 {
3420 case Sstring_fence:
3421 if (!nofence) goto string_end;
3422 break;
3423
3424 case Scharquote:
3425 case Sescape:
3426 INC_FROM;
3427 startquotedinstring:
3428 if (from >= end) goto endquoted;
3429 break;
3430
3431 default:
3432 break;
3433 }
3434 INC_FROM;
3435 }
3436 }
3437 string_end:
3438 state.instring = -1;
3439 curlevel->prev = curlevel->last;
3440 INC_FROM;
3441 if (boundary_stop) goto done;
3442 break;
3443
3444 case Smath:
3445 /* FIXME: We should do something with it. */
3446 break;
3447 default:
3448 /* Ignore whitespace, punctuation, quote, endcomment. */
3449 break;
3450 }
3451 }
3452 goto done;
3453
3454 stop: /* Here if stopping before start of sexp. */
3455 from = prev_from; /* We have just fetched the char that starts it; */
3456 from_byte = prev_from_byte;
3457 goto done; /* but return the position before it. */
3458
3459 endquoted:
3460 state.quoted = 1;
3461 done:
3462 state.depth = depth;
3463 state.mindepth = mindepth;
3464 state.thislevelstart = curlevel->prev;
3465 state.prevlevelstart
3466 = (curlevel == levelstart) ? -1 : (curlevel - 1)->last;
3467 state.location = from;
3468 state.location_byte = from_byte;
3469 state.levelstarts = Qnil;
3470 while (curlevel > levelstart)
3471 state.levelstarts = Fcons (make_number ((--curlevel)->last),
3472 state.levelstarts);
3473 immediate_quit = 0;
3474
3475 *stateptr = state;
3476 }
3477
3478 DEFUN ("parse-partial-sexp", Fparse_partial_sexp, Sparse_partial_sexp, 2, 6, 0,
3479 doc: /* Parse Lisp syntax starting at FROM until TO; return status of parse at TO.
3480 Parsing stops at TO or when certain criteria are met;
3481 point is set to where parsing stops.
3482 If fifth arg OLDSTATE is omitted or nil,
3483 parsing assumes that FROM is the beginning of a function.
3484 Value is a list of elements describing final state of parsing:
3485 0. depth in parens.
3486 1. character address of start of innermost containing list; nil if none.
3487 2. character address of start of last complete sexp terminated.
3488 3. non-nil if inside a string.
3489 (it is the character that will terminate the string,
3490 or t if the string should be terminated by a generic string delimiter.)
3491 4. nil if outside a comment, t if inside a non-nestable comment,
3492 else an integer (the current comment nesting).
3493 5. t if following a quote character.
3494 6. the minimum paren-depth encountered during this scan.
3495 7. style of comment, if any.
3496 8. character address of start of comment or string; nil if not in one.
3497 9. Intermediate data for continuation of parsing (subject to change).
3498 If third arg TARGETDEPTH is non-nil, parsing stops if the depth
3499 in parentheses becomes equal to TARGETDEPTH.
3500 Fourth arg STOPBEFORE non-nil means stop when come to
3501 any character that starts a sexp.
3502 Fifth arg OLDSTATE is a list like what this function returns.
3503 It is used to initialize the state of the parse. Elements number 1, 2, 6
3504 are ignored.
3505 Sixth arg COMMENTSTOP non-nil means stop at the start of a comment.
3506 If it is symbol `syntax-table', stop after the start of a comment or a
3507 string, or after end of a comment or a string. */)
3508 (Lisp_Object from, Lisp_Object to, Lisp_Object targetdepth,
3509 Lisp_Object stopbefore, Lisp_Object oldstate, Lisp_Object commentstop)
3510 {
3511 struct lisp_parse_state state;
3512 EMACS_INT target;
3513
3514 if (!NILP (targetdepth))
3515 {
3516 CHECK_NUMBER (targetdepth);
3517 target = XINT (targetdepth);
3518 }
3519 else
3520 target = TYPE_MINIMUM (EMACS_INT); /* We won't reach this depth. */
3521
3522 validate_region (&from, &to);
3523 scan_sexps_forward (&state, XINT (from), CHAR_TO_BYTE (XINT (from)),
3524 XINT (to),
3525 target, !NILP (stopbefore), oldstate,
3526 (NILP (commentstop)
3527 ? 0 : (EQ (commentstop, Qsyntax_table) ? -1 : 1)));
3528
3529 SET_PT_BOTH (state.location, state.location_byte);
3530
3531 return Fcons (make_number (state.depth),
3532 Fcons (state.prevlevelstart < 0
3533 ? Qnil : make_number (state.prevlevelstart),
3534 Fcons (state.thislevelstart < 0
3535 ? Qnil : make_number (state.thislevelstart),
3536 Fcons (state.instring >= 0
3537 ? (state.instring == ST_STRING_STYLE
3538 ? Qt : make_number (state.instring)) : Qnil,
3539 Fcons (state.incomment < 0 ? Qt :
3540 (state.incomment == 0 ? Qnil :
3541 make_number (state.incomment)),
3542 Fcons (state.quoted ? Qt : Qnil,
3543 Fcons (make_number (state.mindepth),
3544 Fcons ((state.comstyle
3545 ? (state.comstyle == ST_COMMENT_STYLE
3546 ? Qsyntax_table
3547 : make_number (state.comstyle))
3548 : Qnil),
3549 Fcons (((state.incomment
3550 || (state.instring >= 0))
3551 ? make_number (state.comstr_start)
3552 : Qnil),
3553 Fcons (state.levelstarts, Qnil))))))))));
3554 }
3555 \f
3556 void
3557 init_syntax_once (void)
3558 {
3559 register int i, c;
3560 Lisp_Object temp;
3561
3562 /* This has to be done here, before we call Fmake_char_table. */
3563 DEFSYM (Qsyntax_table, "syntax-table");
3564
3565 /* Create objects which can be shared among syntax tables. */
3566 Vsyntax_code_object = make_uninit_vector (Smax);
3567 for (i = 0; i < Smax; i++)
3568 ASET (Vsyntax_code_object, i, Fcons (make_number (i), Qnil));
3569
3570 /* Now we are ready to set up this property, so we can
3571 create syntax tables. */
3572 Fput (Qsyntax_table, Qchar_table_extra_slots, make_number (0));
3573
3574 temp = AREF (Vsyntax_code_object, Swhitespace);
3575
3576 Vstandard_syntax_table = Fmake_char_table (Qsyntax_table, temp);
3577
3578 /* Control characters should not be whitespace. */
3579 temp = AREF (Vsyntax_code_object, Spunct);
3580 for (i = 0; i <= ' ' - 1; i++)
3581 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, i, temp);
3582 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, 0177, temp);
3583
3584 /* Except that a few really are whitespace. */
3585 temp = AREF (Vsyntax_code_object, Swhitespace);
3586 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, ' ', temp);
3587 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '\t', temp);
3588 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '\n', temp);
3589 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, 015, temp);
3590 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, 014, temp);
3591
3592 temp = AREF (Vsyntax_code_object, Sword);
3593 for (i = 'a'; i <= 'z'; i++)
3594 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, i, temp);
3595 for (i = 'A'; i <= 'Z'; i++)
3596 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, i, temp);
3597 for (i = '0'; i <= '9'; i++)
3598 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, i, temp);
3599
3600 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '$', temp);
3601 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '%', temp);
3602
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 (Sopen), make_number ('}')));
3613 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '}',
3614 Fcons (make_number (Sclose), make_number ('{')));
3615 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '"',
3616 Fcons (make_number (Sstring), Qnil));
3617 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '\\',
3618 Fcons (make_number (Sescape), Qnil));
3619
3620 temp = AREF (Vsyntax_code_object, Ssymbol);
3621 for (i = 0; i < 10; i++)
3622 {
3623 c = "_-+*/&|<>="[i];
3624 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, c, temp);
3625 }
3626
3627 temp = AREF (Vsyntax_code_object, Spunct);
3628 for (i = 0; i < 12; i++)
3629 {
3630 c = ".,;:?!#@~^'`"[i];
3631 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, c, temp);
3632 }
3633
3634 /* All multibyte characters have syntax `word' by default. */
3635 temp = AREF (Vsyntax_code_object, Sword);
3636 char_table_set_range (Vstandard_syntax_table, 0x80, MAX_CHAR, temp);
3637 }
3638
3639 void
3640 syms_of_syntax (void)
3641 {
3642 DEFSYM (Qsyntax_table_p, "syntax-table-p");
3643
3644 staticpro (&Vsyntax_code_object);
3645
3646 staticpro (&gl_state.object);
3647 staticpro (&gl_state.global_code);
3648 staticpro (&gl_state.current_syntax_table);
3649 staticpro (&gl_state.old_prop);
3650
3651 /* Defined in regex.c. */
3652 staticpro (&re_match_object);
3653
3654 DEFSYM (Qscan_error, "scan-error");
3655 Fput (Qscan_error, Qerror_conditions,
3656 listn (CONSTYPE_PURE, 2, Qscan_error, Qerror));
3657 Fput (Qscan_error, Qerror_message,
3658 build_pure_c_string ("Scan error"));
3659
3660 DEFVAR_BOOL ("parse-sexp-ignore-comments", parse_sexp_ignore_comments,
3661 doc: /* Non-nil means `forward-sexp', etc., should treat comments as whitespace. */);
3662
3663 DEFVAR_BOOL ("parse-sexp-lookup-properties", parse_sexp_lookup_properties,
3664 doc: /* Non-nil means `forward-sexp', etc., obey `syntax-table' property.
3665 Otherwise, that text property is simply ignored.
3666 See the info node `(elisp)Syntax Properties' for a description of the
3667 `syntax-table' property. */);
3668
3669 DEFVAR_INT ("syntax-propertize--done", syntax_propertize__done,
3670 doc: /* Position up to which syntax-table properties have been set. */);
3671 syntax_propertize__done = -1;
3672 DEFSYM (Qinternal__syntax_propertize, "internal--syntax-propertize");
3673 Fmake_variable_buffer_local (intern ("syntax-propertize--done"));
3674
3675 words_include_escapes = 0;
3676 DEFVAR_BOOL ("words-include-escapes", words_include_escapes,
3677 doc: /* Non-nil means `forward-word', etc., should treat escape chars part of words. */);
3678
3679 DEFVAR_BOOL ("multibyte-syntax-as-symbol", multibyte_syntax_as_symbol,
3680 doc: /* Non-nil means `scan-sexps' treats all multibyte characters as symbol. */);
3681 multibyte_syntax_as_symbol = 0;
3682
3683 DEFVAR_BOOL ("open-paren-in-column-0-is-defun-start",
3684 open_paren_in_column_0_is_defun_start,
3685 doc: /* Non-nil means an open paren in column 0 denotes the start of a defun. */);
3686 open_paren_in_column_0_is_defun_start = 1;
3687
3688
3689 DEFVAR_LISP ("find-word-boundary-function-table",
3690 Vfind_word_boundary_function_table,
3691 doc: /*
3692 Char table of functions to search for the word boundary.
3693 Each function is called with two arguments; POS and LIMIT.
3694 POS and LIMIT are character positions in the current buffer.
3695
3696 If POS is less than LIMIT, POS is at the first character of a word,
3697 and the return value of a function is a position after the last
3698 character of that word.
3699
3700 If POS is not less than LIMIT, POS is at the last character of a word,
3701 and the return value of a function is a position at the first
3702 character of that word.
3703
3704 In both cases, LIMIT bounds the search. */);
3705 Vfind_word_boundary_function_table = Fmake_char_table (Qnil, Qnil);
3706
3707 defsubr (&Ssyntax_table_p);
3708 defsubr (&Ssyntax_table);
3709 defsubr (&Sstandard_syntax_table);
3710 defsubr (&Scopy_syntax_table);
3711 defsubr (&Sset_syntax_table);
3712 defsubr (&Schar_syntax);
3713 defsubr (&Smatching_paren);
3714 defsubr (&Sstring_to_syntax);
3715 defsubr (&Smodify_syntax_entry);
3716 defsubr (&Sinternal_describe_syntax_value);
3717
3718 defsubr (&Sforward_word);
3719
3720 defsubr (&Sskip_chars_forward);
3721 defsubr (&Sskip_chars_backward);
3722 defsubr (&Sskip_syntax_forward);
3723 defsubr (&Sskip_syntax_backward);
3724
3725 defsubr (&Sforward_comment);
3726 defsubr (&Sscan_lists);
3727 defsubr (&Sscan_sexps);
3728 defsubr (&Sbackward_prefix_chars);
3729 defsubr (&Sparse_partial_sexp);
3730 }