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