*** empty log message ***
[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? */
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;
225 }
226 else if (CONSP (tmp_table))
227 {
228 gl_state.use_global = 1;
229 gl_state.global_code = tmp_table;
230 }
231 else
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
RS
253 }
254 else if (cnt == INTERVALS_AT_ONCE)
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;
431 *
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
SM
470 /* Not a real lossage: indicates that we have passed a matching comment
471 starter plus an non-matching comment-ender, meaning that any matching
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
SM
586 break;
587
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 }
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);
8489eb67
RS
735}
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{
8ea151b2 904 register 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
c65adb44 911 p = XSTRING (string)->data;
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
c65adb44 923 (p, STRING_BYTES (XSTRING (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
RS
963 }
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. */
c65adb44 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}
1173
1174
1175static void
1176describe_syntax (value)
1177 Lisp_Object value;
1178{
1179 Findent_to (make_number (16), make_number (1));
1180 Finternal_describe_syntax_value (value);
8489eb67
RS
1181 insert_string ("\n");
1182}
1183
62abe9cb 1184
340f92b5 1185static Lisp_Object
8489eb67
RS
1186describe_syntax_1 (vector)
1187 Lisp_Object vector;
1188{
1189 struct buffer *old = current_buffer;
1190 set_buffer_internal (XBUFFER (Vstandard_output));
e41819d4 1191 describe_vector (vector, Qnil, describe_syntax, 0, Qnil, Qnil, (int *) 0, 0);
93da5fff
KH
1192 while (! NILP (XCHAR_TABLE (vector)->parent))
1193 {
1194 vector = XCHAR_TABLE (vector)->parent;
1195 insert_string ("\nThe parent syntax table is:");
e41819d4
RS
1196 describe_vector (vector, Qnil, describe_syntax, 0, Qnil, Qnil,
1197 (int *) 0, 0);
93da5fff
KH
1198 }
1199
36cd82fe 1200 call0 (intern ("help-mode"));
8489eb67
RS
1201 set_buffer_internal (old);
1202 return Qnil;
1203}
1204
1205DEFUN ("describe-syntax", Fdescribe_syntax, Sdescribe_syntax, 0, 0, "",
fdb82f93
PJ
1206 doc: /* Describe the syntax specifications in the syntax table.
1207The descriptions are inserted in a buffer, which is then displayed. */)
1208 ()
8489eb67
RS
1209{
1210 internal_with_output_to_temp_buffer
1211 ("*Help*", describe_syntax_1, current_buffer->syntax_table);
1212
1213 return Qnil;
1214}
1215\f
195d1361
RS
1216int parse_sexp_ignore_comments;
1217
8489eb67
RS
1218/* Return the position across COUNT words from FROM.
1219 If that many words cannot be found before the end of the buffer, return 0.
1220 COUNT negative means scan backward and stop at word beginning. */
1221
dfcf069d 1222int
8489eb67
RS
1223scan_words (from, count)
1224 register int from, count;
1225{
1226 register int beg = BEGV;
1227 register int end = ZV;
6a140a74 1228 register int from_byte = CHAR_TO_BYTE (from);
93da5fff
KH
1229 register enum syntaxcode code;
1230 int ch0, ch1;
8489eb67
RS
1231
1232 immediate_quit = 1;
1233 QUIT;
1234
195d1361
RS
1235 SETUP_SYNTAX_TABLE (from, count);
1236
8489eb67
RS
1237 while (count > 0)
1238 {
1239 while (1)
1240 {
1241 if (from == end)
1242 {
1243 immediate_quit = 0;
1244 return 0;
1245 }
195d1361 1246 UPDATE_SYNTAX_TABLE_FORWARD (from);
6a140a74 1247 ch0 = FETCH_CHAR (from_byte);
93da5fff 1248 code = SYNTAX (ch0);
6a140a74 1249 INC_BOTH (from, from_byte);
8489eb67
RS
1250 if (words_include_escapes
1251 && (code == Sescape || code == Scharquote))
1252 break;
1253 if (code == Sword)
1254 break;
8489eb67 1255 }
93da5fff
KH
1256 /* Now CH0 is a character which begins a word and FROM is the
1257 position of the next character. */
8489eb67
RS
1258 while (1)
1259 {
1260 if (from == end) break;
195d1361 1261 UPDATE_SYNTAX_TABLE_FORWARD (from);
6a140a74 1262 ch1 = FETCH_CHAR (from_byte);
93da5fff 1263 code = SYNTAX (ch1);
8489eb67
RS
1264 if (!(words_include_escapes
1265 && (code == Sescape || code == Scharquote)))
93da5fff 1266 if (code != Sword || WORD_BOUNDARY_P (ch0, ch1))
8489eb67 1267 break;
6a140a74 1268 INC_BOTH (from, from_byte);
93da5fff 1269 ch0 = ch1;
8489eb67
RS
1270 }
1271 count--;
1272 }
1273 while (count < 0)
1274 {
1275 while (1)
1276 {
1277 if (from == beg)
1278 {
1279 immediate_quit = 0;
1280 return 0;
1281 }
6a140a74 1282 DEC_BOTH (from, from_byte);
195d1361 1283 UPDATE_SYNTAX_TABLE_BACKWARD (from);
6a140a74 1284 ch1 = FETCH_CHAR (from_byte);
93da5fff 1285 code = SYNTAX (ch1);
8489eb67
RS
1286 if (words_include_escapes
1287 && (code == Sescape || code == Scharquote))
1288 break;
1289 if (code == Sword)
1290 break;
8489eb67 1291 }
93da5fff
KH
1292 /* Now CH1 is a character which ends a word and FROM is the
1293 position of it. */
8489eb67
RS
1294 while (1)
1295 {
6a140a74
RS
1296 int temp_byte;
1297
1298 if (from == beg)
1299 break;
1300 temp_byte = dec_bytepos (from_byte);
195d1361 1301 UPDATE_SYNTAX_TABLE_BACKWARD (from);
6a140a74 1302 ch0 = FETCH_CHAR (temp_byte);
93da5fff 1303 code = SYNTAX (ch0);
8489eb67
RS
1304 if (!(words_include_escapes
1305 && (code == Sescape || code == Scharquote)))
93da5fff 1306 if (code != Sword || WORD_BOUNDARY_P (ch0, ch1))
8489eb67 1307 break;
6a140a74 1308 DEC_BOTH (from, from_byte);
93da5fff 1309 ch1 = ch0;
8489eb67
RS
1310 }
1311 count++;
1312 }
1313
1314 immediate_quit = 0;
1315
1316 return from;
1317}
1318
1319DEFUN ("forward-word", Fforward_word, Sforward_word, 1, 1, "p",
fdb82f93
PJ
1320 doc: /* Move point forward ARG words (backward if ARG is negative).
1321Normally returns t.
1322If an edge of the buffer or a field boundary is reached, point is left there
1323and the function returns nil. Field boundaries are not noticed if
1324`inhibit-field-text-motion' is non-nil. */)
1325 (count)
8489eb67
RS
1326 Lisp_Object count;
1327{
2c6ea900 1328 int orig_val, val;
b7826503 1329 CHECK_NUMBER (count);
8489eb67 1330
2c6ea900
RS
1331 val = orig_val = scan_words (PT, XINT (count));
1332 if (! orig_val)
1333 val = XINT (count) > 0 ? ZV : BEGV;
5878ee6f 1334
b8855607 1335 /* Avoid jumping out of an input field. */
64aa4eb1 1336 val = XFASTINT (Fconstrain_to_field (make_number (val), make_number (PT),
070fe99c 1337 Qt, Qnil, Qnil));
64aa4eb1 1338
8489eb67 1339 SET_PT (val);
e6d8341f 1340 return val == orig_val ? Qt : Qnil;
8489eb67
RS
1341}
1342\f
195d1361
RS
1343Lisp_Object skip_chars ();
1344
1345DEFUN ("skip-chars-forward", Fskip_chars_forward, Sskip_chars_forward, 1, 2, 0,
fdb82f93
PJ
1346 doc: /* Move point forward, stopping before a char not in STRING, or at pos LIM.
1347STRING is like the inside of a `[...]' in a regular expression
1348except that `]' is never special and `\\' quotes `^', `-' or `\\'
1349 (but not as the end of a range; quoting is never needed there).
1350Thus, with arg "a-zA-Z", this skips letters stopping before first nonletter.
1351With arg "^a-zA-Z", skips nonletters stopping before first letter.
1352Returns the distance traveled, either zero or positive. */)
1353 (string, lim)
195d1361
RS
1354 Lisp_Object string, lim;
1355{
1356 return skip_chars (1, 0, string, lim);
1357}
1358
1359DEFUN ("skip-chars-backward", Fskip_chars_backward, Sskip_chars_backward, 1, 2, 0,
fdb82f93
PJ
1360 doc: /* Move point backward, stopping after a char not in STRING, or at pos LIM.
1361See `skip-chars-forward' for details.
1362Returns the distance traveled, either zero or negative. */)
1363 (string, lim)
195d1361
RS
1364 Lisp_Object string, lim;
1365{
1366 return skip_chars (0, 0, string, lim);
1367}
1368
1369DEFUN ("skip-syntax-forward", Fskip_syntax_forward, Sskip_syntax_forward, 1, 2, 0,
fdb82f93
PJ
1370 doc: /* Move point forward across chars in specified syntax classes.
1371SYNTAX is a string of syntax code characters.
1372Stop before a char whose syntax is not in SYNTAX, or at position LIM.
1373If SYNTAX starts with ^, skip characters whose syntax is NOT in SYNTAX.
1374This function returns the distance traveled, either zero or positive. */)
1375 (syntax, lim)
195d1361
RS
1376 Lisp_Object syntax, lim;
1377{
1378 return skip_chars (1, 1, syntax, lim);
1379}
1380
1381DEFUN ("skip-syntax-backward", Fskip_syntax_backward, Sskip_syntax_backward, 1, 2, 0,
fdb82f93
PJ
1382 doc: /* Move point backward across chars in specified syntax classes.
1383SYNTAX is a string of syntax code characters.
1384Stop on reaching a char whose syntax is not in SYNTAX, or at position LIM.
1385If SYNTAX starts with ^, skip characters whose syntax is NOT in SYNTAX.
1386This function returns the distance traveled, either zero or negative. */)
1387 (syntax, lim)
195d1361
RS
1388 Lisp_Object syntax, lim;
1389{
1390 return skip_chars (0, 1, syntax, lim);
1391}
1392
6a140a74 1393static Lisp_Object
195d1361
RS
1394skip_chars (forwardp, syntaxp, string, lim)
1395 int forwardp, syntaxp;
1396 Lisp_Object string, lim;
1397{
195d1361
RS
1398 register unsigned int c;
1399 unsigned char fastmap[0400];
7e68b0ea 1400 /* If SYNTAXP is 0, STRING may contain multi-byte form of characters
9690d026
KH
1401 of which codes don't fit in FASTMAP. In that case, set the
1402 ranges of characters in CHAR_RANGES. */
5df4982e 1403 int *char_ranges;
7e68b0ea 1404 int n_char_ranges = 0;
195d1361 1405 int negate = 0;
4101e6fe 1406 register int i, i_byte;
7e68b0ea 1407 int multibyte = !NILP (current_buffer->enable_multibyte_characters);
1674d9a2
RS
1408 int string_multibyte;
1409 int size_byte;
82d497fc
KH
1410 unsigned char *str;
1411 int len;
195d1361 1412
b7826503 1413 CHECK_STRING (string);
5df4982e 1414 char_ranges = (int *) alloca (XSTRING (string)->size * (sizeof (int)) * 2);
1674d9a2 1415 string_multibyte = STRING_MULTIBYTE (string);
82d497fc 1416 str = XSTRING (string)->data;
1674d9a2 1417 size_byte = STRING_BYTES (XSTRING (string));
195d1361 1418
82d497fc
KH
1419 /* Adjust the multibyteness of the string to that of the buffer. */
1420 if (multibyte != string_multibyte)
1421 {
1422 int nbytes;
1423
1424 if (multibyte)
1425 nbytes = count_size_as_multibyte (XSTRING (string)->data,
1426 XSTRING (string)->size);
1427 else
1428 nbytes = XSTRING (string)->size;
1429 if (nbytes != size_byte)
1430 {
1431 str = (unsigned char *) alloca (nbytes);
e39091b6 1432 copy_text (XSTRING (string)->data, str, size_byte,
82d497fc
KH
1433 string_multibyte, multibyte);
1434 size_byte = nbytes;
1435 }
1436 }
1437
195d1361
RS
1438 if (NILP (lim))
1439 XSETINT (lim, forwardp ? ZV : BEGV);
1440 else
b7826503 1441 CHECK_NUMBER_COERCE_MARKER (lim);
195d1361
RS
1442
1443 /* In any case, don't allow scan outside bounds of buffer. */
195d1361
RS
1444 if (XINT (lim) > ZV)
1445 XSETFASTINT (lim, ZV);
1446 if (XINT (lim) < BEGV)
1447 XSETFASTINT (lim, BEGV);
1448
195d1361
RS
1449 bzero (fastmap, sizeof fastmap);
1450
82d497fc 1451 i_byte = 0;
4101e6fe 1452
13090112 1453 if (i_byte < size_byte
4101e6fe 1454 && XSTRING (string)->data[0] == '^')
195d1361 1455 {
82d497fc 1456 negate = 1; i_byte++;
195d1361
RS
1457 }
1458
1459 /* Find the characters specified and set their elements of fastmap.
1460 If syntaxp, each character counts as itself.
1461 Otherwise, handle backslashes and ranges specially. */
1462
13090112 1463 while (i_byte < size_byte)
195d1361 1464 {
82d497fc
KH
1465 c = STRING_CHAR_AND_LENGTH (str + i_byte, size_byte - i_byte, len);
1466 i_byte += len;
4101e6fe 1467
195d1361 1468 if (syntaxp)
4101e6fe 1469 fastmap[syntax_spec_code[c & 0377]] = 1;
195d1361
RS
1470 else
1471 {
1472 if (c == '\\')
1473 {
13090112 1474 if (i_byte == size_byte)
4101e6fe
RS
1475 break;
1476
82d497fc
KH
1477 c = STRING_CHAR_AND_LENGTH (str+i_byte, size_byte-i_byte, len);
1478 i_byte += len;
195d1361 1479 }
13090112 1480 if (i_byte < size_byte
82d497fc 1481 && str[i_byte] == '-')
195d1361 1482 {
9690d026 1483 unsigned int c2;
4101e6fe
RS
1484
1485 /* Skip over the dash. */
82d497fc 1486 i_byte++;
4101e6fe 1487
13090112 1488 if (i_byte == size_byte)
4101e6fe
RS
1489 break;
1490
1491 /* Get the end of the range. */
82d497fc
KH
1492 c2 =STRING_CHAR_AND_LENGTH (str+i_byte, size_byte-i_byte, len);
1493 i_byte += len;
7e68b0ea 1494
4101e6fe 1495 if (SINGLE_BYTE_CHAR_P (c))
06274af5
KH
1496 {
1497 if (! SINGLE_BYTE_CHAR_P (c2))
e39091b6 1498 {
7ae339a7
KH
1499 /* Handle a range starting with a character of
1500 less than 256, and ending with a character of
1501 not less than 256. Split that into two
1502 ranges, the low one ending at 0377, and the
1503 high one starting at the smallest character
1504 in the charset of C2 and ending at C2. */
e39091b6
KH
1505 int charset = CHAR_CHARSET (c2);
1506 int c1 = MAKE_CHAR (charset, 0, 0);
1507
e39091b6
KH
1508 char_ranges[n_char_ranges++] = c1;
1509 char_ranges[n_char_ranges++] = c2;
465cf84c 1510 c2 = 0377;
e39091b6 1511 }
06274af5
KH
1512 while (c <= c2)
1513 {
1514 fastmap[c] = 1;
1515 c++;
1516 }
1517 }
9690d026 1518 else if (c <= c2) /* Both C and C2 are multibyte char. */
195d1361 1519 {
9690d026
KH
1520 char_ranges[n_char_ranges++] = c;
1521 char_ranges[n_char_ranges++] = c2;
195d1361 1522 }
195d1361
RS
1523 }
1524 else
7e68b0ea 1525 {
e39091b6
KH
1526 if (SINGLE_BYTE_CHAR_P (c))
1527 fastmap[c] = 1;
1528 else
7e68b0ea 1529 {
4101e6fe
RS
1530 char_ranges[n_char_ranges++] = c;
1531 char_ranges[n_char_ranges++] = c;
7e68b0ea
RS
1532 }
1533 }
195d1361
RS
1534 }
1535 }
1536
9690d026 1537 /* If ^ was the first character, complement the fastmap. */
195d1361
RS
1538 if (negate)
1539 for (i = 0; i < sizeof fastmap; i++)
9690d026 1540 fastmap[i] ^= 1;
195d1361
RS
1541
1542 {
1543 int start_point = PT;
1544 int pos = PT;
6a140a74 1545 int pos_byte = PT_BYTE;
195d1361
RS
1546
1547 immediate_quit = 1;
1548 if (syntaxp)
1549 {
1550 SETUP_SYNTAX_TABLE (pos, forwardp ? 1 : -1);
1551 if (forwardp)
1552 {
7e68b0ea 1553 if (multibyte)
195d1361 1554 {
ee0cdb48
KH
1555 if (pos < XINT (lim))
1556 while (fastmap[(int) SYNTAX (FETCH_CHAR (pos_byte))])
1557 {
1558 /* Since we already checked for multibyteness,
1559 avoid using INC_BOTH which checks again. */
1560 INC_POS (pos_byte);
1561 pos++;
1562 if (pos >= XINT (lim))
1563 break;
1564 UPDATE_SYNTAX_TABLE_FORWARD (pos);
1565 }
7e68b0ea
RS
1566 }
1567 else
1568 {
1569 while (pos < XINT (lim)
1570 && fastmap[(int) SYNTAX (FETCH_BYTE (pos))])
1571 {
1572 pos++;
1573 UPDATE_SYNTAX_TABLE_FORWARD (pos);
1574 }
195d1361
RS
1575 }
1576 }
1577 else
1578 {
7e68b0ea 1579 if (multibyte)
195d1361 1580 {
7e68b0ea
RS
1581 while (pos > XINT (lim))
1582 {
6a140a74 1583 int savepos = pos_byte;
ef316cf0
RS
1584 /* Since we already checked for multibyteness,
1585 avoid using DEC_BOTH which checks again. */
1586 pos--;
1587 DEC_POS (pos_byte);
4c8535eb 1588 UPDATE_SYNTAX_TABLE_BACKWARD (pos);
6a140a74 1589 if (!fastmap[(int) SYNTAX (FETCH_CHAR (pos_byte))])
7e68b0ea 1590 {
6a140a74
RS
1591 pos++;
1592 pos_byte = savepos;
7e68b0ea
RS
1593 break;
1594 }
7e68b0ea
RS
1595 }
1596 }
1597 else
1598 {
ee0cdb48
KH
1599 if (pos > XINT (lim))
1600 while (fastmap[(int) SYNTAX (FETCH_BYTE (pos - 1))])
1601 {
1602 pos--;
1603 if (pos <= XINT (lim))
4c8535eb 1604 break;
ee0cdb48
KH
1605 UPDATE_SYNTAX_TABLE_BACKWARD (pos - 1);
1606 }
195d1361
RS
1607 }
1608 }
1609 }
1610 else
1611 {
1612 if (forwardp)
1613 {
7e68b0ea 1614 if (multibyte)
9690d026 1615 while (pos < XINT (lim))
7e68b0ea 1616 {
9690d026
KH
1617 c = FETCH_MULTIBYTE_CHAR (pos_byte);
1618 if (SINGLE_BYTE_CHAR_P (c))
7e68b0ea 1619 {
9690d026
KH
1620 if (!fastmap[c])
1621 break;
1622 }
1623 else
1624 {
1625 /* If we are looking at a multibyte character,
1626 we must look up the character in the table
1627 CHAR_RANGES. If there's no data in the
1628 table, that character is not what we want to
1629 skip. */
1630
e39091b6
KH
1631 /* The following code do the right thing even if
1632 n_char_ranges is zero (i.e. no data in
1633 CHAR_RANGES). */
7e68b0ea 1634 for (i = 0; i < n_char_ranges; i += 2)
e39091b6 1635 if (c >= char_ranges[i] && c <= char_ranges[i + 1])
7e68b0ea
RS
1636 break;
1637 if (!(negate ^ (i < n_char_ranges)))
1638 break;
7e68b0ea 1639 }
e39091b6 1640 INC_BOTH (pos, pos_byte);
7e68b0ea
RS
1641 }
1642 else
1643 while (pos < XINT (lim) && fastmap[FETCH_BYTE (pos)])
1644 pos++;
195d1361
RS
1645 }
1646 else
1647 {
7e68b0ea
RS
1648 if (multibyte)
1649 while (pos > XINT (lim))
1650 {
e39091b6
KH
1651 int prev_pos_byte = pos_byte;
1652
1653 DEC_POS (prev_pos_byte);
9690d026
KH
1654 c = FETCH_MULTIBYTE_CHAR (prev_pos_byte);
1655 if (SINGLE_BYTE_CHAR_P (c))
1656 {
1657 if (!fastmap[c])
1658 break;
1659 }
1660 else
7e68b0ea 1661 {
9690d026 1662 /* See the comment in the previous similar code. */
e39091b6
KH
1663 for (i = 0; i < n_char_ranges; i += 2)
1664 if (c >= char_ranges[i] && c <= char_ranges[i + 1])
1665 break;
1666 if (!(negate ^ (i < n_char_ranges)))
1667 break;
7e68b0ea 1668 }
e39091b6
KH
1669 pos--;
1670 pos_byte = prev_pos_byte;
7e68b0ea
RS
1671 }
1672 else
1673 while (pos > XINT (lim) && fastmap[FETCH_BYTE (pos - 1)])
1674 pos--;
195d1361
RS
1675 }
1676 }
7e68b0ea 1677
6a140a74
RS
1678#if 0 /* Not needed now that a position in mid-character
1679 cannot be specified in Lisp. */
7e68b0ea
RS
1680 if (multibyte
1681 /* INC_POS or DEC_POS might have moved POS over LIM. */
1682 && (forwardp ? (pos > XINT (lim)) : (pos < XINT (lim))))
1683 pos = XINT (lim);
6a140a74 1684#endif
7e68b0ea 1685
6a140a74
RS
1686 if (! multibyte)
1687 pos_byte = pos;
1688
1689 SET_PT_BOTH (pos, pos_byte);
195d1361
RS
1690 immediate_quit = 0;
1691
1692 return make_number (PT - start_point);
1693 }
1694}
1695\f
95ff8dfc
RS
1696/* Jump over a comment, assuming we are at the beginning of one.
1697 FROM is the current position.
1698 FROM_BYTE is the bytepos corresponding to FROM.
1699 Do not move past STOP (a charpos).
1700 The comment over which we have to jump is of style STYLE
1701 (either SYNTAX_COMMENT_STYLE(foo) or ST_COMMENT_STYLE).
1702 NESTING should be positive to indicate the nesting at the beginning
1703 for nested comments and should be zero or negative else.
1704 ST_COMMENT_STYLE cannot be nested.
1705 PREV_SYNTAX is the SYNTAX_WITH_FLAGS of the previous character
1706 (or 0 If the search cannot start in the middle of a two-character).
1707
1708 If successful, return 1 and store the charpos of the comment's end
1709 into *CHARPOS_PTR and the corresponding bytepos into *BYTEPOS_PTR.
1710 Else, return 0 and store the charpos STOP into *CHARPOS_PTR, the
1711 corresponding bytepos into *BYTEPOS_PTR and the current nesting
1712 (as defined for state.incomment) in *INCOMMENT_PTR.
1713
1714 The comment end is the last character of the comment rather than the
1715 character just after the comment.
1716
1717 Global syntax data is assumed to initially be valid for FROM and
1718 remains valid for forward search starting at the returned position. */
1719
1720static int
1721forw_comment (from, from_byte, stop, nesting, style, prev_syntax,
1722 charpos_ptr, bytepos_ptr, incomment_ptr)
1723 int from, from_byte, stop;
1724 int nesting, style, prev_syntax;
1725 int *charpos_ptr, *bytepos_ptr, *incomment_ptr;
1726{
1727 register int c, c1;
1728 register enum syntaxcode code;
1729 register int syntax;
1730
1731 if (nesting <= 0) nesting = -1;
1732
1733 /* Enter the loop in the middle so that we find
1734 a 2-char comment ender if we start in the middle of it. */
1735 syntax = prev_syntax;
1736 if (syntax != 0) goto forw_incomment;
1737
1738 while (1)
1739 {
1740 if (from == stop)
1741 {
1742 *incomment_ptr = nesting;
1743 *charpos_ptr = from;
1744 *bytepos_ptr = from_byte;
1745 return 0;
1746 }
1747 c = FETCH_CHAR (from_byte);
1748 syntax = SYNTAX_WITH_FLAGS (c);
1749 code = syntax & 0xff;
1750 if (code == Sendcomment
1751 && SYNTAX_FLAGS_COMMENT_STYLE (syntax) == style
abf8a9ff
SM
1752 && (SYNTAX_FLAGS_COMMENT_NESTED (syntax) ?
1753 (nesting > 0 && --nesting == 0) : nesting < 0))
95ff8dfc
RS
1754 /* we have encountered a comment end of the same style
1755 as the comment sequence which began this comment
1756 section */
1757 break;
1758 if (code == Scomment_fence
1759 && style == ST_COMMENT_STYLE)
1760 /* we have encountered a comment end of the same style
1761 as the comment sequence which began this comment
1762 section. */
1763 break;
1764 if (nesting > 0
1765 && code == Scomment
abf8a9ff 1766 && SYNTAX_FLAGS_COMMENT_NESTED (syntax)
95ff8dfc
RS
1767 && SYNTAX_FLAGS_COMMENT_STYLE (syntax) == style)
1768 /* we have encountered a nested comment of the same style
1769 as the comment sequence which began this comment section */
1770 nesting++;
1771 INC_BOTH (from, from_byte);
1772 UPDATE_SYNTAX_TABLE_FORWARD (from);
1773
1774 forw_incomment:
1775 if (from < stop && SYNTAX_FLAGS_COMEND_FIRST (syntax)
1776 && SYNTAX_FLAGS_COMMENT_STYLE (syntax) == style
1777 && (c1 = FETCH_CHAR (from_byte),
abf8a9ff
SM
1778 SYNTAX_COMEND_SECOND (c1))
1779 && ((SYNTAX_FLAGS_COMMENT_NESTED (syntax) ||
1780 SYNTAX_COMMENT_NESTED (c1)) ? nesting > 0 : nesting < 0))
4ffe723b
GM
1781 {
1782 if (--nesting <= 0)
1783 /* we have encountered a comment end of the same style
1784 as the comment sequence which began this comment
1785 section */
1786 break;
1787 else
1788 {
1789 INC_BOTH (from, from_byte);
1790 UPDATE_SYNTAX_TABLE_FORWARD (from);
1791 }
1792 }
95ff8dfc
RS
1793 if (nesting > 0
1794 && from < stop
1795 && SYNTAX_FLAGS_COMSTART_FIRST (syntax)
1796 && (c1 = FETCH_CHAR (from_byte),
1797 SYNTAX_COMMENT_STYLE (c1) == style
abf8a9ff
SM
1798 && SYNTAX_COMSTART_SECOND (c1))
1799 && (SYNTAX_FLAGS_COMMENT_NESTED (syntax) ||
1800 SYNTAX_COMMENT_NESTED (c1)))
95ff8dfc
RS
1801 /* we have encountered a nested comment of the same style
1802 as the comment sequence which began this comment
1803 section */
1804 {
1805 INC_BOTH (from, from_byte);
1806 UPDATE_SYNTAX_TABLE_FORWARD (from);
1807 nesting++;
1808 }
1809 }
1810 *charpos_ptr = from;
1811 *bytepos_ptr = from_byte;
1812 return 1;
1813}
1814
b3cfe0c8 1815DEFUN ("forward-comment", Fforward_comment, Sforward_comment, 1, 1, 0,
fdb82f93
PJ
1816 doc: /* Move forward across up to N comments. If N is negative, move backward.
1817Stop scanning if we find something other than a comment or whitespace.
1818Set point to where scanning stops.
1819If N comments are found as expected, with nothing except whitespace
1820between them, return t; otherwise return nil. */)
1821 (count)
840f481c 1822 Lisp_Object count;
b3cfe0c8
RS
1823{
1824 register int from;
6a140a74 1825 int from_byte;
b3cfe0c8 1826 register int stop;
8ea151b2 1827 register int c, c1;
b3cfe0c8
RS
1828 register enum syntaxcode code;
1829 int comstyle = 0; /* style of comment encountered */
95ff8dfc 1830 int comnested = 0; /* whether the comment is nestable or not */
be720845 1831 int found;
840f481c 1832 int count1;
6a140a74 1833 int out_charpos, out_bytepos;
95ff8dfc 1834 int dummy;
840f481c 1835
b7826503 1836 CHECK_NUMBER (count);
840f481c 1837 count1 = XINT (count);
195d1361 1838 stop = count1 > 0 ? ZV : BEGV;
b3cfe0c8
RS
1839
1840 immediate_quit = 1;
1841 QUIT;
1842
1843 from = PT;
6a140a74 1844 from_byte = PT_BYTE;
b3cfe0c8 1845
195d1361 1846 SETUP_SYNTAX_TABLE (from, count1);
840f481c 1847 while (count1 > 0)
b3cfe0c8 1848 {
04882296 1849 do
b3cfe0c8 1850 {
f902a008
RS
1851 int comstart_first;
1852
04882296
KH
1853 if (from == stop)
1854 {
ef316cf0 1855 SET_PT_BOTH (from, from_byte);
b7e6e612 1856 immediate_quit = 0;
04882296
KH
1857 return Qnil;
1858 }
6a140a74 1859 c = FETCH_CHAR (from_byte);
b3cfe0c8 1860 code = SYNTAX (c);
f902a008 1861 comstart_first = SYNTAX_COMSTART_FIRST (c);
95ff8dfc 1862 comnested = SYNTAX_COMMENT_NESTED (c);
e6365855 1863 comstyle = SYNTAX_COMMENT_STYLE (c);
6a140a74 1864 INC_BOTH (from, from_byte);
f902a008 1865 UPDATE_SYNTAX_TABLE_FORWARD (from);
f902a008 1866 if (from < stop && comstart_first
6a140a74 1867 && (c1 = FETCH_CHAR (from_byte),
8ea151b2 1868 SYNTAX_COMSTART_SECOND (c1)))
b3cfe0c8 1869 {
7fc8191e
RS
1870 /* We have encountered a comment start sequence and we
1871 are ignoring all text inside comments. We must record
b3cfe0c8
RS
1872 the comment style this sequence begins so that later,
1873 only a comment end of the same style actually ends
7fc8191e 1874 the comment section. */
b3cfe0c8 1875 code = Scomment;
8ea151b2 1876 comstyle = SYNTAX_COMMENT_STYLE (c1);
95ff8dfc 1877 comnested = comnested || SYNTAX_COMMENT_NESTED (c1);
6a140a74 1878 INC_BOTH (from, from_byte);
95ff8dfc 1879 UPDATE_SYNTAX_TABLE_FORWARD (from);
b3cfe0c8 1880 }
04882296 1881 }
abf8a9ff 1882 while (code == Swhitespace || (code == Sendcomment && c == '\n'));
6a140a74 1883
da71ab91
KH
1884 if (code == Scomment_fence)
1885 comstyle = ST_COMMENT_STYLE;
1886 else if (code != Scomment)
04882296
KH
1887 {
1888 immediate_quit = 0;
6a140a74 1889 DEC_BOTH (from, from_byte);
ef316cf0 1890 SET_PT_BOTH (from, from_byte);
04882296
KH
1891 return Qnil;
1892 }
1893 /* We're at the start of a comment. */
95ff8dfc
RS
1894 found = forw_comment (from, from_byte, stop, comnested, comstyle, 0,
1895 &out_charpos, &out_bytepos, &dummy);
1896 from = out_charpos; from_byte = out_bytepos;
1897 if (!found)
04882296 1898 {
95ff8dfc
RS
1899 immediate_quit = 0;
1900 SET_PT_BOTH (from, from_byte);
1901 return Qnil;
b3cfe0c8 1902 }
95ff8dfc
RS
1903 INC_BOTH (from, from_byte);
1904 UPDATE_SYNTAX_TABLE_FORWARD (from);
04882296 1905 /* We have skipped one comment. */
840f481c 1906 count1--;
b3cfe0c8
RS
1907 }
1908
840f481c 1909 while (count1 < 0)
b3cfe0c8 1910 {
b9145dbb 1911 while (1)
b3cfe0c8 1912 {
c65adb44 1913 int quoted;
f902a008 1914
b9145dbb
RS
1915 if (from <= stop)
1916 {
6a140a74 1917 SET_PT_BOTH (BEGV, BEGV_BYTE);
b9145dbb
RS
1918 immediate_quit = 0;
1919 return Qnil;
1920 }
b3cfe0c8 1921
6a140a74 1922 DEC_BOTH (from, from_byte);
f902a008 1923 /* char_quoted does UPDATE_SYNTAX_TABLE_BACKWARD (from). */
6a140a74 1924 quoted = char_quoted (from, from_byte);
6a140a74 1925 c = FETCH_CHAR (from_byte);
b3cfe0c8
RS
1926 code = SYNTAX (c);
1927 comstyle = 0;
95ff8dfc 1928 comnested = SYNTAX_COMMENT_NESTED (c);
7fc8191e
RS
1929 if (code == Sendcomment)
1930 comstyle = SYNTAX_COMMENT_STYLE (c);
b3cfe0c8 1931 if (from > stop && SYNTAX_COMEND_SECOND (c)
f902a008 1932 && prev_char_comend_first (from, from_byte)
89c6809a 1933 && !char_quoted (from - 1, dec_bytepos (from_byte)))
b3cfe0c8 1934 {
7fc8191e 1935 /* We must record the comment style encountered so that
b3cfe0c8 1936 later, we can match only the proper comment begin
7fc8191e 1937 sequence of the same style. */
6a140a74 1938 DEC_BOTH (from, from_byte);
f902a008
RS
1939 code = Sendcomment;
1940 /* Calling char_quoted, above, set up global syntax position
1941 at the new value of FROM. */
95ff8dfc
RS
1942 c1 = FETCH_CHAR (from_byte);
1943 comstyle = SYNTAX_COMMENT_STYLE (c1);
1944 comnested = comnested || SYNTAX_COMMENT_NESTED (c1);
b3cfe0c8
RS
1945 }
1946
195d1361
RS
1947 if (code == Scomment_fence)
1948 {
1949 /* Skip until first preceding unquoted comment_fence. */
6a140a74 1950 int found = 0, ini = from, ini_byte = from_byte;
195d1361 1951
6a140a74 1952 while (1)
195d1361 1953 {
6a140a74
RS
1954 DEC_BOTH (from, from_byte);
1955 if (from == stop)
1956 break;
195d1361 1957 UPDATE_SYNTAX_TABLE_BACKWARD (from);
6a140a74
RS
1958 c = FETCH_CHAR (from_byte);
1959 if (SYNTAX (c) == Scomment_fence
1960 && !char_quoted (from, from_byte))
195d1361
RS
1961 {
1962 found = 1;
1963 break;
1964 }
1965 }
1966 if (found == 0)
1967 {
1968 from = ini; /* Set point to ini + 1. */
6a140a74 1969 from_byte = ini_byte;
195d1361
RS
1970 goto leave;
1971 }
1972 }
1973 else if (code == Sendcomment)
b3cfe0c8 1974 {
95ff8dfc 1975 found = back_comment (from, from_byte, stop, comnested, comstyle,
6a140a74 1976 &out_charpos, &out_bytepos);
1aa963c8
SM
1977 if (found == -1)
1978 {
abf8a9ff
SM
1979 if (c == '\n')
1980 /* This end-of-line is not an end-of-comment.
1981 Treat it like a whitespace.
1982 CC-mode (and maybe others) relies on this behavior. */
1983 ;
1984 else
1985 {
1986 /* Failure: we should go back to the end of this
1987 not-quite-endcomment. */
1988 if (SYNTAX(c) != code)
1989 /* It was a two-char Sendcomment. */
1990 INC_BOTH (from, from_byte);
1991 goto leave;
1992 }
1aa963c8 1993 }
2b927d02 1994 else
abf8a9ff
SM
1995 {
1996 /* We have skipped one comment. */
1997 from = out_charpos, from_byte = out_bytepos;
1998 break;
1999 }
b3cfe0c8 2000 }
bb0de084 2001 else if (code != Swhitespace || quoted)
b3cfe0c8 2002 {
195d1361 2003 leave:
b3cfe0c8 2004 immediate_quit = 0;
6a140a74 2005 INC_BOTH (from, from_byte);
ef316cf0 2006 SET_PT_BOTH (from, from_byte);
b3cfe0c8
RS
2007 return Qnil;
2008 }
2009 }
2010
840f481c 2011 count1++;
b3cfe0c8
RS
2012 }
2013
ef316cf0 2014 SET_PT_BOTH (from, from_byte);
b3cfe0c8
RS
2015 immediate_quit = 0;
2016 return Qt;
2017}
2018\f
bd25db08 2019/* Return syntax code of character C if C is a single byte character
db9f48c3 2020 or `multibyte_symbol_p' is zero. Otherwise, return Ssymbol. */
bd25db08
KH
2021
2022#define SYNTAX_WITH_MULTIBYTE_CHECK(c) \
2023 ((SINGLE_BYTE_CHAR_P (c) || !multibyte_symbol_p) \
2024 ? SYNTAX (c) : Ssymbol)
2025
6a140a74 2026static Lisp_Object
8489eb67
RS
2027scan_lists (from, count, depth, sexpflag)
2028 register int from;
2029 int count, depth, sexpflag;
2030{
2031 Lisp_Object val;
195d1361 2032 register int stop = count > 0 ? ZV : BEGV;
93da5fff
KH
2033 register int c, c1;
2034 int stringterm;
8489eb67
RS
2035 int quoted;
2036 int mathexit = 0;
93da5fff 2037 register enum syntaxcode code, temp_code;
195d1361 2038 int min_depth = depth; /* Err out if depth gets less than this. */
e5d4f4dc 2039 int comstyle = 0; /* style of comment encountered */
95ff8dfc 2040 int comnested = 0; /* whether the comment is nestable or not */
93da5fff 2041 int temp_pos;
7bf5e9e4 2042 int last_good = from;
195d1361 2043 int found;
c3907a7e 2044 int from_byte;
6a140a74 2045 int out_bytepos, out_charpos;
95ff8dfc 2046 int temp, dummy;
bd25db08 2047 int multibyte_symbol_p = sexpflag && multibyte_syntax_as_symbol;
8489eb67
RS
2048
2049 if (depth > 0) min_depth = 0;
2050
c3907a7e
RS
2051 if (from > ZV) from = ZV;
2052 if (from < BEGV) from = BEGV;
2053
2054 from_byte = CHAR_TO_BYTE (from);
2055
8489eb67
RS
2056 immediate_quit = 1;
2057 QUIT;
2058
195d1361 2059 SETUP_SYNTAX_TABLE (from, count);
8489eb67
RS
2060 while (count > 0)
2061 {
8489eb67
RS
2062 while (from < stop)
2063 {
f902a008 2064 int comstart_first, prefix;
195d1361 2065 UPDATE_SYNTAX_TABLE_FORWARD (from);
6a140a74 2066 c = FETCH_CHAR (from_byte);
bd25db08 2067 code = SYNTAX_WITH_MULTIBYTE_CHECK (c);
f902a008 2068 comstart_first = SYNTAX_COMSTART_FIRST (c);
95ff8dfc 2069 comnested = SYNTAX_COMMENT_NESTED (c);
e6365855 2070 comstyle = SYNTAX_COMMENT_STYLE (c);
f902a008 2071 prefix = SYNTAX_PREFIX (c);
7bf5e9e4
RS
2072 if (depth == min_depth)
2073 last_good = from;
6a140a74 2074 INC_BOTH (from, from_byte);
195d1361 2075 UPDATE_SYNTAX_TABLE_FORWARD (from);
f902a008 2076 if (from < stop && comstart_first
6a140a74 2077 && SYNTAX_COMSTART_SECOND (FETCH_CHAR (from_byte))
8489eb67 2078 && parse_sexp_ignore_comments)
e5d4f4dc
RS
2079 {
2080 /* we have encountered a comment start sequence and we
195d1361 2081 are ignoring all text inside comments. We must record
e5d4f4dc
RS
2082 the comment style this sequence begins so that later,
2083 only a comment end of the same style actually ends
2084 the comment section */
2085 code = Scomment;
95ff8dfc
RS
2086 c1 = FETCH_CHAR (from_byte);
2087 comstyle = SYNTAX_COMMENT_STYLE (c1);
2088 comnested = comnested || SYNTAX_COMMENT_NESTED (c1);
6a140a74 2089 INC_BOTH (from, from_byte);
f902a008 2090 UPDATE_SYNTAX_TABLE_FORWARD (from);
e5d4f4dc
RS
2091 }
2092
f902a008 2093 if (prefix)
8489eb67
RS
2094 continue;
2095
0220c518 2096 switch (SWITCH_ENUM_CAST (code))
8489eb67
RS
2097 {
2098 case Sescape:
2099 case Scharquote:
2100 if (from == stop) goto lose;
6a140a74 2101 INC_BOTH (from, from_byte);
8489eb67
RS
2102 /* treat following character as a word constituent */
2103 case Sword:
2104 case Ssymbol:
2105 if (depth || !sexpflag) break;
195d1361 2106 /* This word counts as a sexp; return at end of it. */
8489eb67
RS
2107 while (from < stop)
2108 {
195d1361 2109 UPDATE_SYNTAX_TABLE_FORWARD (from);
7c7ca3d2
RS
2110
2111 /* Some compilers can't handle this inside the switch. */
bd25db08
KH
2112 c = FETCH_CHAR (from_byte);
2113 temp = SYNTAX_WITH_MULTIBYTE_CHECK (c);
7c7ca3d2 2114 switch (temp)
8489eb67
RS
2115 {
2116 case Scharquote:
2117 case Sescape:
6a140a74 2118 INC_BOTH (from, from_byte);
8489eb67
RS
2119 if (from == stop) goto lose;
2120 break;
2121 case Sword:
2122 case Ssymbol:
2123 case Squote:
2124 break;
2125 default:
2126 goto done;
2127 }
6a140a74 2128 INC_BOTH (from, from_byte);
8489eb67
RS
2129 }
2130 goto done;
2131
195d1361 2132 case Scomment_fence:
95ff8dfc
RS
2133 comstyle = ST_COMMENT_STYLE;
2134 /* FALLTHROUGH */
2135 case Scomment:
8489eb67 2136 if (!parse_sexp_ignore_comments) break;
95ff8dfc
RS
2137 UPDATE_SYNTAX_TABLE_FORWARD (from);
2138 found = forw_comment (from, from_byte, stop,
2139 comnested, comstyle, 0,
2140 &out_charpos, &out_bytepos, &dummy);
2141 from = out_charpos, from_byte = out_bytepos;
2142 if (!found)
8489eb67 2143 {
95ff8dfc
RS
2144 if (depth == 0)
2145 goto done;
2146 goto lose;
8489eb67 2147 }
95ff8dfc
RS
2148 INC_BOTH (from, from_byte);
2149 UPDATE_SYNTAX_TABLE_FORWARD (from);
8489eb67
RS
2150 break;
2151
2152 case Smath:
2153 if (!sexpflag)
2154 break;
6a140a74
RS
2155 if (from != stop && c == FETCH_CHAR (from_byte))
2156 {
2157 INC_BOTH (from, from_byte);
2158 }
8489eb67
RS
2159 if (mathexit)
2160 {
2161 mathexit = 0;
2162 goto close1;
2163 }
2164 mathexit = 1;
2165
2166 case Sopen:
2167 if (!++depth) goto done;
2168 break;
2169
2170 case Sclose:
2171 close1:
2172 if (!--depth) goto done;
2173 if (depth < min_depth)
7bf5e9e4
RS
2174 Fsignal (Qscan_error,
2175 Fcons (build_string ("Containing expression ends prematurely"),
2176 Fcons (make_number (last_good),
2177 Fcons (make_number (from), Qnil))));
8489eb67
RS
2178 break;
2179
2180 case Sstring:
195d1361 2181 case Sstring_fence:
ef316cf0 2182 temp_pos = dec_bytepos (from_byte);
93da5fff 2183 stringterm = FETCH_CHAR (temp_pos);
8489eb67
RS
2184 while (1)
2185 {
2186 if (from >= stop) goto lose;
195d1361 2187 UPDATE_SYNTAX_TABLE_FORWARD (from);
bd25db08 2188 c = FETCH_CHAR (from_byte);
42ebfa31
SM
2189 if (code == Sstring
2190 ? (c == stringterm
2191 && SYNTAX_WITH_MULTIBYTE_CHECK (c) == Sstring)
bd25db08 2192 : SYNTAX_WITH_MULTIBYTE_CHECK (c) == Sstring_fence)
195d1361 2193 break;
7c7ca3d2
RS
2194
2195 /* Some compilers can't handle this inside the switch. */
bd25db08 2196 temp = SYNTAX_WITH_MULTIBYTE_CHECK (c);
7c7ca3d2 2197 switch (temp)
8489eb67
RS
2198 {
2199 case Scharquote:
2200 case Sescape:
6a140a74 2201 INC_BOTH (from, from_byte);
8489eb67 2202 }
6a140a74 2203 INC_BOTH (from, from_byte);
8489eb67 2204 }
6a140a74 2205 INC_BOTH (from, from_byte);
8489eb67
RS
2206 if (!depth && sexpflag) goto done;
2207 break;
2208 }
2209 }
2210
2211 /* Reached end of buffer. Error if within object, return nil if between */
2212 if (depth) goto lose;
2213
2214 immediate_quit = 0;
2215 return Qnil;
2216
2217 /* End of object reached */
2218 done:
2219 count--;
2220 }
2221
2222 while (count < 0)
2223 {
8489eb67
RS
2224 while (from > stop)
2225 {
6a140a74 2226 DEC_BOTH (from, from_byte);
195d1361 2227 UPDATE_SYNTAX_TABLE_BACKWARD (from);
6a140a74 2228 c = FETCH_CHAR (from_byte);
bd25db08 2229 code = SYNTAX_WITH_MULTIBYTE_CHECK (c);
7bf5e9e4
RS
2230 if (depth == min_depth)
2231 last_good = from;
7fc8191e 2232 comstyle = 0;
95ff8dfc 2233 comnested = SYNTAX_COMMENT_NESTED (c);
7fc8191e
RS
2234 if (code == Sendcomment)
2235 comstyle = SYNTAX_COMMENT_STYLE (c);
8489eb67 2236 if (from > stop && SYNTAX_COMEND_SECOND (c)
1674d9a2 2237 && prev_char_comend_first (from, from_byte)
8489eb67 2238 && parse_sexp_ignore_comments)
e5d4f4dc 2239 {
f902a008 2240 /* We must record the comment style encountered so that
e5d4f4dc 2241 later, we can match only the proper comment begin
f902a008 2242 sequence of the same style. */
6a140a74 2243 DEC_BOTH (from, from_byte);
f902a008
RS
2244 UPDATE_SYNTAX_TABLE_BACKWARD (from);
2245 code = Sendcomment;
95ff8dfc
RS
2246 c1 = FETCH_CHAR (from_byte);
2247 comstyle = SYNTAX_COMMENT_STYLE (c1);
2248 comnested = comnested || SYNTAX_COMMENT_NESTED (c1);
e5d4f4dc
RS
2249 }
2250
9828a477 2251 /* Quoting turns anything except a comment-ender
e6365855 2252 into a word character. Note that this cannot be true
f902a008 2253 if we decremented FROM in the if-statement above. */
9828a477
KH
2254 if (code != Sendcomment && char_quoted (from, from_byte))
2255 code = Sword;
2256 else if (SYNTAX_PREFIX (c))
8489eb67
RS
2257 continue;
2258
9828a477 2259 switch (SWITCH_ENUM_CAST (code))
8489eb67
RS
2260 {
2261 case Sword:
2262 case Ssymbol:
9828a477
KH
2263 case Sescape:
2264 case Scharquote:
8489eb67 2265 if (depth || !sexpflag) break;
195d1361
RS
2266 /* This word counts as a sexp; count object finished
2267 after passing it. */
8489eb67
RS
2268 while (from > stop)
2269 {
6a140a74 2270 temp_pos = from_byte;
ef316cf0
RS
2271 if (! NILP (current_buffer->enable_multibyte_characters))
2272 DEC_POS (temp_pos);
2273 else
2274 temp_pos--;
6a140a74 2275 UPDATE_SYNTAX_TABLE_BACKWARD (from - 1);
9828a477 2276 c1 = FETCH_CHAR (temp_pos);
bd25db08 2277 temp_code = SYNTAX_WITH_MULTIBYTE_CHECK (c1);
9828a477
KH
2278 /* Don't allow comment-end to be quoted. */
2279 if (temp_code == Sendcomment)
2280 goto done2;
6a140a74 2281 quoted = char_quoted (from - 1, temp_pos);
8489eb67 2282 if (quoted)
93da5fff 2283 {
6a140a74 2284 DEC_BOTH (from, from_byte);
ef316cf0 2285 temp_pos = dec_bytepos (temp_pos);
6a140a74 2286 UPDATE_SYNTAX_TABLE_BACKWARD (from - 1);
93da5fff
KH
2287 }
2288 c1 = FETCH_CHAR (temp_pos);
bd25db08 2289 temp_code = SYNTAX_WITH_MULTIBYTE_CHECK (c1);
93da5fff
KH
2290 if (! (quoted || temp_code == Sword
2291 || temp_code == Ssymbol
2292 || temp_code == Squote))
8489eb67 2293 goto done2;
6a140a74 2294 DEC_BOTH (from, from_byte);
8489eb67
RS
2295 }
2296 goto done2;
2297
2298 case Smath:
2299 if (!sexpflag)
2300 break;
ef316cf0 2301 temp_pos = dec_bytepos (from_byte);
6a140a74 2302 UPDATE_SYNTAX_TABLE_BACKWARD (from - 1);
93da5fff 2303 if (from != stop && c == FETCH_CHAR (temp_pos))
6a140a74 2304 DEC_BOTH (from, from_byte);
8489eb67
RS
2305 if (mathexit)
2306 {
2307 mathexit = 0;
2308 goto open2;
2309 }
2310 mathexit = 1;
2311
2312 case Sclose:
2313 if (!++depth) goto done2;
2314 break;
2315
2316 case Sopen:
2317 open2:
2318 if (!--depth) goto done2;
2319 if (depth < min_depth)
7bf5e9e4
RS
2320 Fsignal (Qscan_error,
2321 Fcons (build_string ("Containing expression ends prematurely"),
2322 Fcons (make_number (last_good),
2323 Fcons (make_number (from), Qnil))));
8489eb67
RS
2324 break;
2325
2326 case Sendcomment:
2327 if (!parse_sexp_ignore_comments)
2328 break;
95ff8dfc 2329 found = back_comment (from, from_byte, stop, comnested, comstyle,
6a140a74 2330 &out_charpos, &out_bytepos);
1aa963c8
SM
2331 /* FIXME: if found == -1, then it really wasn't a comment-end.
2332 For single-char Sendcomment, we can't do much about it apart
2333 from skipping the char.
2334 For 2-char endcomments, we could try again, taking both
2335 chars as separate entities, but it's a lot of trouble
2336 for very little gain, so we don't bother either. -sm */
6a140a74
RS
2337 if (found != -1)
2338 from = out_charpos, from_byte = out_bytepos;
8489eb67
RS
2339 break;
2340
195d1361
RS
2341 case Scomment_fence:
2342 case Sstring_fence:
2343 while (1)
2344 {
6a140a74 2345 DEC_BOTH (from, from_byte);
195d1361
RS
2346 if (from == stop) goto lose;
2347 UPDATE_SYNTAX_TABLE_BACKWARD (from);
6a140a74 2348 if (!char_quoted (from, from_byte)
bd25db08
KH
2349 && (c = FETCH_CHAR (from_byte),
2350 SYNTAX_WITH_MULTIBYTE_CHECK (c) == code))
195d1361
RS
2351 break;
2352 }
2353 if (code == Sstring_fence && !depth && sexpflag) goto done2;
2354 break;
2355
8489eb67 2356 case Sstring:
6a140a74 2357 stringterm = FETCH_CHAR (from_byte);
8489eb67
RS
2358 while (1)
2359 {
2360 if (from == stop) goto lose;
6a140a74 2361 temp_pos = from_byte;
ef316cf0
RS
2362 if (! NILP (current_buffer->enable_multibyte_characters))
2363 DEC_POS (temp_pos);
2364 else
2365 temp_pos--;
6a140a74
RS
2366 UPDATE_SYNTAX_TABLE_BACKWARD (from - 1);
2367 if (!char_quoted (from - 1, temp_pos)
42ebfa31
SM
2368 && stringterm == (c = FETCH_CHAR (temp_pos))
2369 && SYNTAX_WITH_MULTIBYTE_CHECK (c) == Sstring)
8489eb67 2370 break;
6a140a74 2371 DEC_BOTH (from, from_byte);
8489eb67 2372 }
6a140a74 2373 DEC_BOTH (from, from_byte);
8489eb67
RS
2374 if (!depth && sexpflag) goto done2;
2375 break;
2376 }
2377 }
2378
2379 /* Reached start of buffer. Error if within object, return nil if between */
2380 if (depth) goto lose;
2381
2382 immediate_quit = 0;
2383 return Qnil;
2384
2385 done2:
2386 count++;
2387 }
2388
2389
2390 immediate_quit = 0;
1e142fb7 2391 XSETFASTINT (val, from);
8489eb67
RS
2392 return val;
2393
2394 lose:
7bf5e9e4
RS
2395 Fsignal (Qscan_error,
2396 Fcons (build_string ("Unbalanced parentheses"),
2397 Fcons (make_number (last_good),
2398 Fcons (make_number (from), Qnil))));
2399
8489eb67
RS
2400 /* NOTREACHED */
2401}
2402
8489eb67 2403DEFUN ("scan-lists", Fscan_lists, Sscan_lists, 3, 3, 0,
fdb82f93
PJ
2404 doc: /* Scan from character number FROM by COUNT lists.
2405Returns the character number of the position thus found.
2406
2407If DEPTH is nonzero, paren depth begins counting from that value,
2408only places where the depth in parentheses becomes zero
2409are candidates for stopping; COUNT such places are counted.
2410Thus, a positive value for DEPTH means go out levels.
2411
2412Comments are ignored if `parse-sexp-ignore-comments' is non-nil.
2413
2414If the beginning or end of (the accessible part of) the buffer is reached
2415and the depth is wrong, an error is signaled.
2416If the depth is right but the count is not used up, nil is returned. */)
2417 (from, count, depth)
8489eb67
RS
2418 Lisp_Object from, count, depth;
2419{
b7826503
PJ
2420 CHECK_NUMBER (from);
2421 CHECK_NUMBER (count);
2422 CHECK_NUMBER (depth);
8489eb67
RS
2423
2424 return scan_lists (XINT (from), XINT (count), XINT (depth), 0);
2425}
2426
2427DEFUN ("scan-sexps", Fscan_sexps, Sscan_sexps, 2, 2, 0,
fdb82f93
PJ
2428 doc: /* Scan from character number FROM by COUNT balanced expressions.
2429If COUNT is negative, scan backwards.
2430Returns the character number of the position thus found.
2431
2432Comments are ignored if `parse-sexp-ignore-comments' is non-nil.
2433
2434If the beginning or end of (the accessible part of) the buffer is reached
2435in the middle of a parenthetical grouping, an error is signaled.
2436If the beginning or end is reached between groupings
2437but before count is used up, nil is returned. */)
2438 (from, count)
8489eb67
RS
2439 Lisp_Object from, count;
2440{
b7826503
PJ
2441 CHECK_NUMBER (from);
2442 CHECK_NUMBER (count);
8489eb67
RS
2443
2444 return scan_lists (XINT (from), XINT (count), 0, 1);
2445}
2446
2447DEFUN ("backward-prefix-chars", Fbackward_prefix_chars, Sbackward_prefix_chars,
fdb82f93
PJ
2448 0, 0, 0,
2449 doc: /* Move point backward over any number of chars with prefix syntax.
2450This includes chars with "quote" or "prefix" syntax (' or p). */)
2451 ()
8489eb67
RS
2452{
2453 int beg = BEGV;
6a140a74
RS
2454 int opoint = PT;
2455 int opoint_byte = PT_BYTE;
6ec8bbd2 2456 int pos = PT;
6a140a74 2457 int pos_byte = PT_BYTE;
93da5fff 2458 int c;
93da5fff 2459
f902a008 2460 if (pos <= beg)
195d1361 2461 {
f902a008
RS
2462 SET_PT_BOTH (opoint, opoint_byte);
2463
2464 return Qnil;
195d1361 2465 }
8489eb67 2466
f902a008
RS
2467 SETUP_SYNTAX_TABLE (pos, -1);
2468
6a140a74
RS
2469 DEC_BOTH (pos, pos_byte);
2470
1fd3172d 2471 while (!char_quoted (pos, pos_byte)
195d1361 2472 /* Previous statement updates syntax table. */
6a140a74 2473 && ((c = FETCH_CHAR (pos_byte), SYNTAX (c) == Squote)
93da5fff
KH
2474 || SYNTAX_PREFIX (c)))
2475 {
1fd3172d
RS
2476 opoint = pos;
2477 opoint_byte = pos_byte;
2478
2479 if (pos + 1 > beg)
2480 DEC_BOTH (pos, pos_byte);
93da5fff 2481 }
8489eb67 2482
6a140a74 2483 SET_PT_BOTH (opoint, opoint_byte);
8489eb67
RS
2484
2485 return Qnil;
2486}
2487\f
6a140a74 2488/* Parse forward from FROM / FROM_BYTE to END,
e5d4f4dc
RS
2489 assuming that FROM has state OLDSTATE (nil means FROM is start of function),
2490 and return a description of the state of the parse at END.
c81a3712 2491 If STOPBEFORE is nonzero, stop at the start of an atom.
644ea4df
RS
2492 If COMMENTSTOP is 1, stop at the start of a comment.
2493 If COMMENTSTOP is -1, stop at the start or end of a comment,
2494 after the beginning of a string, or after the end of a string. */
8489eb67 2495
340f92b5 2496static void
6a140a74 2497scan_sexps_forward (stateptr, from, from_byte, end, targetdepth,
c81a3712 2498 stopbefore, oldstate, commentstop)
e5d4f4dc 2499 struct lisp_parse_state *stateptr;
8489eb67
RS
2500 register int from;
2501 int end, targetdepth, stopbefore;
2502 Lisp_Object oldstate;
c81a3712 2503 int commentstop;
8489eb67
RS
2504{
2505 struct lisp_parse_state state;
2506
2507 register enum syntaxcode code;
95ff8dfc
RS
2508 int c1;
2509 int comnested;
8489eb67
RS
2510 struct level { int last, prev; };
2511 struct level levelstart[100];
2512 register struct level *curlevel = levelstart;
2513 struct level *endlevel = levelstart + 100;
8489eb67
RS
2514 register int depth; /* Paren depth of current scanning location.
2515 level - levelstart equals this except
2516 when the depth becomes negative. */
2517 int mindepth; /* Lowest DEPTH value seen. */
2518 int start_quoted = 0; /* Nonzero means starting after a char quote */
2519 Lisp_Object tem;
93da5fff 2520 int prev_from; /* Keep one character before FROM. */
6a140a74 2521 int prev_from_byte;
1fd3172d 2522 int prev_from_syntax;
195d1361
RS
2523 int boundary_stop = commentstop == -1;
2524 int nofence;
95ff8dfc
RS
2525 int found;
2526 int out_bytepos, out_charpos;
7c7ca3d2 2527 int temp;
93da5fff
KH
2528
2529 prev_from = from;
6a140a74
RS
2530 prev_from_byte = from_byte;
2531 if (from != BEGV)
2532 DEC_BOTH (prev_from, prev_from_byte);
93da5fff
KH
2533
2534 /* Use this macro instead of `from++'. */
6a140a74
RS
2535#define INC_FROM \
2536do { prev_from = from; \
2537 prev_from_byte = from_byte; \
1fd3172d
RS
2538 prev_from_syntax \
2539 = SYNTAX_WITH_FLAGS (FETCH_CHAR (prev_from_byte)); \
ef316cf0 2540 INC_BOTH (from, from_byte); \
1fd3172d 2541 UPDATE_SYNTAX_TABLE_FORWARD (from); \
6a140a74 2542 } while (0)
8489eb67
RS
2543
2544 immediate_quit = 1;
2545 QUIT;
2546
265a9e55 2547 if (NILP (oldstate))
8489eb67
RS
2548 {
2549 depth = 0;
2550 state.instring = -1;
2551 state.incomment = 0;
195d1361
RS
2552 state.comstyle = 0; /* comment style a by default. */
2553 state.comstr_start = -1; /* no comment/string seen. */
8489eb67
RS
2554 }
2555 else
2556 {
2557 tem = Fcar (oldstate);
265a9e55 2558 if (!NILP (tem))
8489eb67
RS
2559 depth = XINT (tem);
2560 else
2561 depth = 0;
2562
2563 oldstate = Fcdr (oldstate);
2564 oldstate = Fcdr (oldstate);
2565 oldstate = Fcdr (oldstate);
2566 tem = Fcar (oldstate);
195d1361 2567 /* Check whether we are inside string_fence-style string: */
e76f1c44
GM
2568 state.instring = (!NILP (tem)
2569 ? (INTEGERP (tem) ? XINT (tem) : ST_STRING_STYLE)
2570 : -1);
8489eb67
RS
2571
2572 oldstate = Fcdr (oldstate);
2573 tem = Fcar (oldstate);
e76f1c44
GM
2574 state.incomment = (!NILP (tem)
2575 ? (INTEGERP (tem) ? XINT (tem) : -1)
95ff8dfc 2576 : 0);
8489eb67
RS
2577
2578 oldstate = Fcdr (oldstate);
2579 tem = Fcar (oldstate);
265a9e55 2580 start_quoted = !NILP (tem);
e5d4f4dc 2581
95ff8dfc 2582 /* if the eighth element of the list is nil, we are in comment
195d1361
RS
2583 style a. If it is non-nil, we are in comment style b */
2584 oldstate = Fcdr (oldstate);
e5d4f4dc 2585 oldstate = Fcdr (oldstate);
195d1361 2586 tem = Fcar (oldstate);
e76f1c44
GM
2587 state.comstyle = NILP (tem) ? 0 : (EQ (tem, Qsyntax_table)
2588 ? ST_COMMENT_STYLE : 1);
195d1361 2589
e5d4f4dc 2590 oldstate = Fcdr (oldstate);
e5d4f4dc 2591 tem = Fcar (oldstate);
195d1361 2592 state.comstr_start = NILP (tem) ? -1 : XINT (tem) ;
1a102a58
RS
2593 oldstate = Fcdr (oldstate);
2594 tem = Fcar (oldstate);
2595 while (!NILP (tem)) /* >= second enclosing sexps. */
2596 {
2597 /* curlevel++->last ran into compiler bug on Apollo */
2598 curlevel->last = XINT (Fcar (tem));
2599 if (++curlevel == endlevel)
02010917 2600 curlevel--; /* error ("Nesting too deep for parser"); */
1a102a58
RS
2601 curlevel->prev = -1;
2602 curlevel->last = -1;
2603 tem = Fcdr (tem);
2604 }
8489eb67
RS
2605 }
2606 state.quoted = 0;
2607 mindepth = depth;
2608
2609 curlevel->prev = -1;
2610 curlevel->last = -1;
2611
326b283b
RS
2612 SETUP_SYNTAX_TABLE (prev_from, 1);
2613 prev_from_syntax = SYNTAX_WITH_FLAGS (FETCH_CHAR (prev_from_byte));
2614 UPDATE_SYNTAX_TABLE_FORWARD (from);
2615
195d1361 2616 /* Enter the loop at a place appropriate for initial state. */
8489eb67 2617
326b283b
RS
2618 if (state.incomment)
2619 goto startincomment;
8489eb67
RS
2620 if (state.instring >= 0)
2621 {
195d1361 2622 nofence = state.instring != ST_STRING_STYLE;
326b283b
RS
2623 if (start_quoted)
2624 goto startquotedinstring;
8489eb67
RS
2625 goto startinstring;
2626 }
326b283b
RS
2627 else if (start_quoted)
2628 goto startquoted;
1fd3172d 2629
ccf89641 2630#if 0 /* This seems to be redundant with the identical code above. */
1fd3172d
RS
2631 SETUP_SYNTAX_TABLE (prev_from, 1);
2632 prev_from_syntax = SYNTAX_WITH_FLAGS (FETCH_CHAR (prev_from_byte));
2633 UPDATE_SYNTAX_TABLE_FORWARD (from);
ccf89641 2634#endif
1fd3172d 2635
8489eb67
RS
2636 while (from < end)
2637 {
93da5fff 2638 INC_FROM;
1fd3172d 2639 code = prev_from_syntax & 0xff;
4c920633 2640
8f9dc2ed 2641 if (code == Scomment)
95ff8dfc 2642 {
d355bd8a 2643 state.comstyle = SYNTAX_FLAGS_COMMENT_STYLE (prev_from_syntax);
95ff8dfc
RS
2644 state.incomment = (SYNTAX_FLAGS_COMMENT_NESTED (prev_from_syntax) ?
2645 1 : -1);
2646 state.comstr_start = prev_from;
2647 }
4c920633 2648 else if (code == Scomment_fence)
e5d4f4dc
RS
2649 {
2650 /* Record the comment style we have entered so that only
2651 the comment-end sequence of the same style actually
2652 terminates the comment section. */
95ff8dfc
RS
2653 state.comstyle = ST_COMMENT_STYLE;
2654 state.incomment = -1;
195d1361 2655 state.comstr_start = prev_from;
e5d4f4dc 2656 code = Scomment;
e5d4f4dc 2657 }
4c920633 2658 else if (from < end)
1fd3172d 2659 if (SYNTAX_FLAGS_COMSTART_FIRST (prev_from_syntax))
95ff8dfc
RS
2660 if (c1 = FETCH_CHAR (from_byte),
2661 SYNTAX_COMSTART_SECOND (c1))
1fd3172d 2662 /* Duplicate code to avoid a complex if-expression
4c920633
RS
2663 which causes trouble for the SGI compiler. */
2664 {
2665 /* Record the comment style we have entered so that only
2666 the comment-end sequence of the same style actually
2667 terminates the comment section. */
95ff8dfc
RS
2668 state.comstyle = SYNTAX_COMMENT_STYLE (FETCH_CHAR (from_byte));
2669 comnested = SYNTAX_FLAGS_COMMENT_NESTED (prev_from_syntax);
2670 comnested = comnested || SYNTAX_COMMENT_NESTED (c1);
2671 state.incomment = comnested ? 1 : -1;
4c920633 2672 state.comstr_start = prev_from;
95ff8dfc 2673 INC_FROM;
4c920633
RS
2674 code = Scomment;
2675 }
e5d4f4dc 2676
1fd3172d 2677 if (SYNTAX_FLAGS_PREFIX (prev_from_syntax))
8489eb67 2678 continue;
0220c518 2679 switch (SWITCH_ENUM_CAST (code))
8489eb67
RS
2680 {
2681 case Sescape:
2682 case Scharquote:
2683 if (stopbefore) goto stop; /* this arg means stop at sexp start */
93da5fff 2684 curlevel->last = prev_from;
8489eb67
RS
2685 startquoted:
2686 if (from == end) goto endquoted;
93da5fff 2687 INC_FROM;
8489eb67
RS
2688 goto symstarted;
2689 /* treat following character as a word constituent */
2690 case Sword:
2691 case Ssymbol:
2692 if (stopbefore) goto stop; /* this arg means stop at sexp start */
93da5fff 2693 curlevel->last = prev_from;
8489eb67
RS
2694 symstarted:
2695 while (from < end)
2696 {
7c7ca3d2
RS
2697 /* Some compilers can't handle this inside the switch. */
2698 temp = SYNTAX (FETCH_CHAR (from_byte));
2699 switch (temp)
8489eb67
RS
2700 {
2701 case Scharquote:
2702 case Sescape:
93da5fff 2703 INC_FROM;
8489eb67
RS
2704 if (from == end) goto endquoted;
2705 break;
2706 case Sword:
2707 case Ssymbol:
2708 case Squote:
2709 break;
2710 default:
2711 goto symdone;
2712 }
93da5fff 2713 INC_FROM;
8489eb67
RS
2714 }
2715 symdone:
2716 curlevel->prev = curlevel->last;
2717 break;
2718
2719 case Scomment:
195d1361 2720 if (commentstop || boundary_stop) goto done;
d355bd8a
SM
2721 startincomment:
2722 /* The (from == BEGV) test was to enter the loop in the middle so
95ff8dfc 2723 that we find a 2-char comment ender even if we start in the
e6365855 2724 middle of it. We don't want to do that if we're just at the
d355bd8a 2725 beginning of the comment (think of (*) ... (*)). */
95ff8dfc
RS
2726 found = forw_comment (from, from_byte, end,
2727 state.incomment, state.comstyle,
e6365855
SM
2728 (from == BEGV || from < state.comstr_start + 3)
2729 ? 0 : prev_from_syntax,
95ff8dfc
RS
2730 &out_charpos, &out_bytepos, &state.incomment);
2731 from = out_charpos; from_byte = out_bytepos;
2732 /* Beware! prev_from and friends are invalid now.
2733 Luckily, the `done' doesn't use them and the INC_FROM
2734 sets them to a sane value without looking at them. */
2735 if (!found) goto done;
d355bd8a 2736 INC_FROM;
8489eb67 2737 state.incomment = 0;
e5d4f4dc 2738 state.comstyle = 0; /* reset the comment style */
195d1361 2739 if (boundary_stop) goto done;
8489eb67
RS
2740 break;
2741
2742 case Sopen:
2743 if (stopbefore) goto stop; /* this arg means stop at sexp start */
2744 depth++;
2745 /* curlevel++->last ran into compiler bug on Apollo */
93da5fff 2746 curlevel->last = prev_from;
8489eb67 2747 if (++curlevel == endlevel)
02010917 2748 curlevel--; /* error ("Nesting too deep for parser"); */
8489eb67
RS
2749 curlevel->prev = -1;
2750 curlevel->last = -1;
30844415 2751 if (targetdepth == depth) goto done;
8489eb67
RS
2752 break;
2753
2754 case Sclose:
2755 depth--;
2756 if (depth < mindepth)
2757 mindepth = depth;
2758 if (curlevel != levelstart)
2759 curlevel--;
2760 curlevel->prev = curlevel->last;
30844415 2761 if (targetdepth == depth) goto done;
8489eb67
RS
2762 break;
2763
2764 case Sstring:
195d1361
RS
2765 case Sstring_fence:
2766 state.comstr_start = from - 1;
8489eb67 2767 if (stopbefore) goto stop; /* this arg means stop at sexp start */
93da5fff 2768 curlevel->last = prev_from;
195d1361 2769 state.instring = (code == Sstring
6a140a74 2770 ? (FETCH_CHAR (prev_from_byte))
195d1361
RS
2771 : ST_STRING_STYLE);
2772 if (boundary_stop) goto done;
8489eb67 2773 startinstring:
195d1361 2774 {
644ea4df 2775 nofence = state.instring != ST_STRING_STYLE;
195d1361 2776
644ea4df
RS
2777 while (1)
2778 {
2779 int c;
195d1361 2780
644ea4df 2781 if (from >= end) goto done;
6a140a74 2782 c = FETCH_CHAR (from_byte);
7c7ca3d2
RS
2783 /* Some compilers can't handle this inside the switch. */
2784 temp = SYNTAX (c);
ccf89641
KH
2785
2786 /* Check TEMP here so that if the char has
2787 a syntax-table property which says it is NOT
2788 a string character, it does not end the string. */
2789 if (nofence && c == state.instring && temp == Sstring)
2790 break;
2791
7c7ca3d2 2792 switch (temp)
644ea4df
RS
2793 {
2794 case Sstring_fence:
2795 if (!nofence) goto string_end;
2796 break;
2797 case Scharquote:
2798 case Sescape:
2799 INC_FROM;
2800 startquotedinstring:
2801 if (from >= end) goto endquoted;
195d1361 2802 }
644ea4df
RS
2803 INC_FROM;
2804 }
195d1361
RS
2805 }
2806 string_end:
8489eb67
RS
2807 state.instring = -1;
2808 curlevel->prev = curlevel->last;
93da5fff 2809 INC_FROM;
195d1361 2810 if (boundary_stop) goto done;
8489eb67
RS
2811 break;
2812
2813 case Smath:
2814 break;
2815 }
2816 }
2817 goto done;
2818
2819 stop: /* Here if stopping before start of sexp. */
93da5fff 2820 from = prev_from; /* We have just fetched the char that starts it; */
8489eb67
RS
2821 goto done; /* but return the position before it. */
2822
2823 endquoted:
2824 state.quoted = 1;
2825 done:
2826 state.depth = depth;
2827 state.mindepth = mindepth;
2828 state.thislevelstart = curlevel->prev;
2829 state.prevlevelstart
2830 = (curlevel == levelstart) ? -1 : (curlevel - 1)->last;
2831 state.location = from;
1a102a58
RS
2832 state.levelstarts = Qnil;
2833 while (--curlevel >= levelstart)
2834 state.levelstarts = Fcons (make_number (curlevel->last),
2835 state.levelstarts);
8489eb67
RS
2836 immediate_quit = 0;
2837
e5d4f4dc 2838 *stateptr = state;
8489eb67
RS
2839}
2840
c81a3712 2841DEFUN ("parse-partial-sexp", Fparse_partial_sexp, Sparse_partial_sexp, 2, 6, 0,
fdb82f93
PJ
2842 doc: /* Parse Lisp syntax starting at FROM until TO; return status of parse at TO.
2843Parsing stops at TO or when certain criteria are met;
2844 point is set to where parsing stops.
2845If fifth arg OLDSTATE is omitted or nil,
2846 parsing assumes that FROM is the beginning of a function.
2847Value is a list of ten elements describing final state of parsing:
2848 0. depth in parens.
2849 1. character address of start of innermost containing list; nil if none.
2850 2. character address of start of last complete sexp terminated.
2851 3. non-nil if inside a string.
2852 (it is the character that will terminate the string,
2853 or t if the string should be terminated by a generic string delimiter.)
2854 4. nil if outside a comment, t if inside a non-nestable comment,
2855 else an integer (the current comment nesting).
2856 5. t if following a quote character.
2857 6. the minimum paren-depth encountered during this scan.
2858 7. t if in a comment of style b; symbol `syntax-table' if the comment
2859 should be terminated by a generic comment delimiter.
2860 8. character address of start of comment or string; nil if not in one.
2861 9. Intermediate data for continuation of parsing (subject to change).
2862If third arg TARGETDEPTH is non-nil, parsing stops if the depth
2863in parentheses becomes equal to TARGETDEPTH.
2864Fourth arg STOPBEFORE non-nil means stop when come to
2865 any character that starts a sexp.
2866Fifth arg OLDSTATE is a nine-element list like what this function returns.
2867 It is used to initialize the state of the parse. Elements number 1, 2, 6
2868 and 8 are ignored; you can leave off element 8 (the last) entirely.
2869Sixth arg COMMENTSTOP non-nil means stop at the start of a comment.
2870 If it is symbol `syntax-table', stop after the start of a comment or a
2871 string, or after end of a comment or a string. */)
2872 (from, to, targetdepth, stopbefore, oldstate, commentstop)
c81a3712 2873 Lisp_Object from, to, targetdepth, stopbefore, oldstate, commentstop;
8489eb67
RS
2874{
2875 struct lisp_parse_state state;
2876 int target;
2877
265a9e55 2878 if (!NILP (targetdepth))
8489eb67 2879 {
b7826503 2880 CHECK_NUMBER (targetdepth);
8489eb67
RS
2881 target = XINT (targetdepth);
2882 }
2883 else
2884 target = -100000; /* We won't reach this depth */
2885
2886 validate_region (&from, &to);
6a140a74
RS
2887 scan_sexps_forward (&state, XINT (from), CHAR_TO_BYTE (XINT (from)),
2888 XINT (to),
c81a3712 2889 target, !NILP (stopbefore), oldstate,
195d1361
RS
2890 (NILP (commentstop)
2891 ? 0 : (EQ (commentstop, Qsyntax_table) ? -1 : 1)));
8489eb67
RS
2892
2893 SET_PT (state.location);
2894
2895 return Fcons (make_number (state.depth),
2896 Fcons (state.prevlevelstart < 0 ? Qnil : make_number (state.prevlevelstart),
2897 Fcons (state.thislevelstart < 0 ? Qnil : make_number (state.thislevelstart),
195d1361
RS
2898 Fcons (state.instring >= 0
2899 ? (state.instring == ST_STRING_STYLE
2900 ? Qt : make_number (state.instring)) : Qnil,
95ff8dfc
RS
2901 Fcons (state.incomment < 0 ? Qt :
2902 (state.incomment == 0 ? Qnil :
2903 make_number (state.incomment)),
8489eb67 2904 Fcons (state.quoted ? Qt : Qnil,
bff37d2a
RS
2905 Fcons (make_number (state.mindepth),
2906 Fcons ((state.comstyle
2907 ? (state.comstyle == ST_COMMENT_STYLE
2908 ? Qsyntax_table : Qt) :
2909 Qnil),
0beaf54f
DL
2910 Fcons (((state.incomment
2911 || (state.instring >= 0))
bff37d2a
RS
2912 ? make_number (state.comstr_start)
2913 : Qnil),
1a102a58 2914 Fcons (state.levelstarts, Qnil))))))))));
8489eb67
RS
2915}
2916\f
dfcf069d 2917void
8489eb67
RS
2918init_syntax_once ()
2919{
78f9a1f7 2920 register int i, c;
8ea151b2 2921 Lisp_Object temp;
8489eb67 2922
5ebaddf5
RS
2923 /* This has to be done here, before we call Fmake_char_table. */
2924 Qsyntax_table = intern ("syntax-table");
2925 staticpro (&Qsyntax_table);
2926
2927 /* Intern this now in case it isn't already done.
2928 Setting this variable twice is harmless.
2929 But don't staticpro it here--that is done in alloc.c. */
2930 Qchar_table_extra_slots = intern ("char-table-extra-slots");
2931
93da5fff 2932 /* Create objects which can be shared among syntax tables. */
42ebfa31 2933 Vsyntax_code_object = Fmake_vector (make_number (Smax), Qnil);
93da5fff
KH
2934 for (i = 0; i < XVECTOR (Vsyntax_code_object)->size; i++)
2935 XVECTOR (Vsyntax_code_object)->contents[i]
2936 = Fcons (make_number (i), Qnil);
2937
5ebaddf5
RS
2938 /* Now we are ready to set up this property, so we can
2939 create syntax tables. */
2940 Fput (Qsyntax_table, Qchar_table_extra_slots, make_number (0));
2941
93da5fff 2942 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Swhitespace];
8489eb67 2943
5ebaddf5 2944 Vstandard_syntax_table = Fmake_char_table (Qsyntax_table, temp);
8489eb67 2945
93da5fff 2946 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Sword];
8489eb67 2947 for (i = 'a'; i <= 'z'; i++)
8ea151b2 2948 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, i, temp);
8489eb67 2949 for (i = 'A'; i <= 'Z'; i++)
8ea151b2 2950 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, i, temp);
8489eb67 2951 for (i = '0'; i <= '9'; i++)
8ea151b2
RS
2952 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, i, temp);
2953
2954 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '$', temp);
2955 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '%', temp);
2956
2957 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '(',
2958 Fcons (make_number (Sopen), make_number (')')));
2959 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, ')',
2960 Fcons (make_number (Sclose), make_number ('(')));
2961 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '[',
2962 Fcons (make_number (Sopen), make_number (']')));
2963 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, ']',
2964 Fcons (make_number (Sclose), make_number ('[')));
2965 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '{',
2966 Fcons (make_number (Sopen), make_number ('}')));
2967 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '}',
2968 Fcons (make_number (Sclose), make_number ('{')));
2969 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '"',
2970 Fcons (make_number ((int) Sstring), Qnil));
2971 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, '\\',
2972 Fcons (make_number ((int) Sescape), Qnil));
2973
93da5fff 2974 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Ssymbol];
8489eb67 2975 for (i = 0; i < 10; i++)
78f9a1f7
KH
2976 {
2977 c = "_-+*/&|<>="[i];
2978 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, c, temp);
2979 }
8489eb67 2980
93da5fff 2981 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Spunct];
8489eb67 2982 for (i = 0; i < 12; i++)
78f9a1f7
KH
2983 {
2984 c = ".,;:?!#@~^'`"[i];
2985 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table, c, temp);
2986 }
bd25db08
KH
2987
2988 /* All multibyte characters have syntax `word' by default. */
2989 temp = XVECTOR (Vsyntax_code_object)->contents[(int) Sword];
2990 for (i = CHAR_TABLE_SINGLE_BYTE_SLOTS; i < CHAR_TABLE_ORDINARY_SLOTS; i++)
2991 XCHAR_TABLE (Vstandard_syntax_table)->contents[i] = temp;
8489eb67
RS
2992}
2993
dfcf069d 2994void
8489eb67
RS
2995syms_of_syntax ()
2996{
2997 Qsyntax_table_p = intern ("syntax-table-p");
2998 staticpro (&Qsyntax_table_p);
2999
93da5fff
KH
3000 staticpro (&Vsyntax_code_object);
3001
7bf5e9e4
RS
3002 Qscan_error = intern ("scan-error");
3003 staticpro (&Qscan_error);
3004 Fput (Qscan_error, Qerror_conditions,
f3be100f 3005 Fcons (Qscan_error, Fcons (Qerror, Qnil)));
7bf5e9e4
RS
3006 Fput (Qscan_error, Qerror_message,
3007 build_string ("Scan error"));
3008
8489eb67 3009 DEFVAR_BOOL ("parse-sexp-ignore-comments", &parse_sexp_ignore_comments,
fdb82f93 3010 doc: /* Non-nil means `forward-sexp', etc., should treat comments as whitespace. */);
8489eb67 3011
195d1361 3012 DEFVAR_BOOL ("parse-sexp-lookup-properties", &parse_sexp_lookup_properties,
fdb82f93
PJ
3013 doc: /* Non-nil means `forward-sexp', etc., obey `syntax-table' property.
3014Otherwise, that text property is simply ignored.
3015See the info node `(elisp)Syntax Properties' for a description of the
3016`syntax-table' property. */);
195d1361 3017
8489eb67
RS
3018 words_include_escapes = 0;
3019 DEFVAR_BOOL ("words-include-escapes", &words_include_escapes,
fdb82f93 3020 doc: /* Non-nil means `forward-word', etc., should treat escape chars part of words. */);
8489eb67 3021
bd25db08 3022 DEFVAR_BOOL ("multibyte-syntax-as-symbol", &multibyte_syntax_as_symbol,
fdb82f93 3023 doc: /* Non-nil means `scan-sexps' treats all multibyte characters as symbol. */);
bd25db08
KH
3024 multibyte_syntax_as_symbol = 0;
3025
f4ed767f
GM
3026 DEFVAR_BOOL ("open-paren-in-column-0-is-defun-start",
3027 &open_paren_in_column_0_is_defun_start,
fdb82f93 3028 doc: /* Non-nil means an open paren in column 0 denotes the start of a defun. */);
f4ed767f
GM
3029 open_paren_in_column_0_is_defun_start = 1;
3030
8489eb67
RS
3031 defsubr (&Ssyntax_table_p);
3032 defsubr (&Ssyntax_table);
3033 defsubr (&Sstandard_syntax_table);
3034 defsubr (&Scopy_syntax_table);
3035 defsubr (&Sset_syntax_table);
3036 defsubr (&Schar_syntax);
beefa22e 3037 defsubr (&Smatching_paren);
c65adb44 3038 defsubr (&Sstring_to_syntax);
8489eb67
RS
3039 defsubr (&Smodify_syntax_entry);
3040 defsubr (&Sdescribe_syntax);
62abe9cb 3041 defsubr (&Sinternal_describe_syntax_value);
8489eb67
RS
3042
3043 defsubr (&Sforward_word);
3044
195d1361
RS
3045 defsubr (&Sskip_chars_forward);
3046 defsubr (&Sskip_chars_backward);
3047 defsubr (&Sskip_syntax_forward);
3048 defsubr (&Sskip_syntax_backward);
3049
b3cfe0c8 3050 defsubr (&Sforward_comment);
8489eb67
RS
3051 defsubr (&Sscan_lists);
3052 defsubr (&Sscan_sexps);
3053 defsubr (&Sbackward_prefix_chars);
3054 defsubr (&Sparse_partial_sexp);
3055}