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