1 /* GNU Emacs routines to deal with syntax tables; also word and list parsing.
2 Copyright (C) 1985, 87, 93, 94, 95, 97, 1998, 1999 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
30 /* Make syntax table lookup grant data in gl_state. */
31 #define SYNTAX_ENTRY_VIA_PROPERTY
34 #include "intervals.h"
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. */
40 #define ST_COMMENT_STYLE (256 + 1)
41 #define ST_STRING_STYLE (256 + 2)
44 Lisp_Object Qsyntax_table_p
, Qsyntax_table
, Qscan_error
;
46 int words_include_escapes
;
47 int parse_sexp_lookup_properties
;
49 /* Nonzero means `scan-sexps' treat all multibyte characters as symbol. */
50 int multibyte_syntax_as_symbol
;
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. */
55 Lisp_Object syntax_temp
;
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. */
61 int open_paren_in_column_0_is_defun_start
;
63 /* This is the internal form of the parse state used in parse-partial-sexp. */
65 struct lisp_parse_state
67 int depth
; /* Depth at end of parsing. */
68 int instring
; /* -1 if not within string, else desired terminator. */
69 int incomment
; /* -1 if in unnestable comment else comment nesting */
70 int comstyle
; /* comment style a=0, or b=1, or ST_COMMENT_STYLE. */
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 */
74 int location
; /* Char number at which parsing stopped. */
75 int mindepth
; /* Minimum depth seen while scanning. */
76 int comstr_start
; /* Position just after last comment/string starter. */
77 Lisp_Object levelstarts
; /* Char numbers of starts-of-expression
78 of levels (starting from outermost). */
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.
84 find_start_value_byte is the corresponding byte position.
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. */
89 static int find_start_pos
;
90 static int find_start_value
;
91 static int find_start_value_byte
;
92 static struct buffer
*find_start_buffer
;
93 static int find_start_begv
;
94 static int find_start_modiff
;
97 static int find_defun_start
P_ ((int, int));
98 static int back_comment
P_ ((int, int, int, int, int, int *, int *));
99 static int char_quoted
P_ ((int, int));
100 static Lisp_Object skip_chars
P_ ((int, int, Lisp_Object
, Lisp_Object
));
101 static Lisp_Object scan_lists
P_ ((int, int, int, int));
102 static void scan_sexps_forward
P_ ((struct lisp_parse_state
*,
104 int, Lisp_Object
, int));
107 struct gl_state_s gl_state
; /* Global state of syntax parser. */
109 INTERVAL
interval_of ();
110 #define INTERVALS_AT_ONCE 10 /* 1 + max-number of intervals
111 to scan to property-change. */
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
115 valid interval. If INIT, only [be]_property fields of gl_state are
116 valid at start, the rest is filled basing on OBJECT.
118 `gl_state.*_i' are the intervals, and CHARPOS is further in the search
119 direction than the intervals - or in an interval. We update the
120 current syntax-table basing on the property of this interval, and
121 update the interval to start further than CHARPOS - or be
122 NULL_INTERVAL. We also update lim_property to be the next value of
123 charpos to call this subroutine again - or be before/after the
124 start/end of OBJECT. */
127 update_syntax_table (charpos
, count
, init
, object
)
128 int charpos
, count
, init
;
131 Lisp_Object tmp_table
;
132 int cnt
= 0, invalidate
= 1;
137 gl_state
.old_prop
= Qnil
;
138 gl_state
.start
= gl_state
.b_property
;
139 gl_state
.stop
= gl_state
.e_property
;
140 i
= interval_of (charpos
, object
);
141 gl_state
.backward_i
= gl_state
.forward_i
= i
;
143 if (NULL_INTERVAL_P (i
))
145 /* interval_of updates only ->position of the return value, so
146 update the parents manually to speed up update_interval. */
147 while (!NULL_PARENT (i
))
149 if (AM_RIGHT_CHILD (i
))
150 INTERVAL_PARENT (i
)->position
= i
->position
151 - LEFT_TOTAL_LENGTH (i
) + TOTAL_LENGTH (i
) /* right end */
152 - TOTAL_LENGTH (INTERVAL_PARENT (i
))
153 + LEFT_TOTAL_LENGTH (INTERVAL_PARENT (i
));
155 INTERVAL_PARENT (i
)->position
= i
->position
- LEFT_TOTAL_LENGTH (i
)
157 i
= INTERVAL_PARENT (i
);
159 i
= gl_state
.forward_i
;
160 gl_state
.b_property
= i
->position
- gl_state
.offset
;
161 gl_state
.e_property
= INTERVAL_LAST_POS (i
) - gl_state
.offset
;
164 oldi
= i
= count
> 0 ? gl_state
.forward_i
: gl_state
.backward_i
;
166 /* We are guaranteed to be called with CHARPOS either in i,
168 if (NULL_INTERVAL_P (i
))
169 error ("Error in syntax_table logic for to-the-end intervals");
170 else if (charpos
< i
->position
) /* Move left. */
173 error ("Error in syntax_table logic for intervals <-");
174 /* Update the interval. */
175 i
= update_interval (i
, charpos
);
176 if (INTERVAL_LAST_POS (i
) != gl_state
.b_property
)
179 gl_state
.forward_i
= i
;
180 gl_state
.e_property
= INTERVAL_LAST_POS (i
) - gl_state
.offset
;
183 else if (charpos
>= INTERVAL_LAST_POS (i
)) /* Move right. */
186 error ("Error in syntax_table logic for intervals ->");
187 /* Update the interval. */
188 i
= update_interval (i
, charpos
);
189 if (i
->position
!= gl_state
.e_property
)
192 gl_state
.backward_i
= i
;
193 gl_state
.b_property
= i
->position
- gl_state
.offset
;
198 tmp_table
= textget (i
->plist
, Qsyntax_table
);
201 invalidate
= !EQ (tmp_table
, gl_state
.old_prop
); /* Need to invalidate? */
203 if (invalidate
) /* Did not get to adjacent interval. */
204 { /* with the same table => */
205 /* invalidate the old range. */
208 gl_state
.backward_i
= i
;
209 gl_state
.b_property
= i
->position
- gl_state
.offset
;
213 gl_state
.forward_i
= i
;
214 gl_state
.e_property
= INTERVAL_LAST_POS (i
) - gl_state
.offset
;
218 if (!EQ (tmp_table
, gl_state
.old_prop
))
220 gl_state
.current_syntax_table
= tmp_table
;
221 gl_state
.old_prop
= tmp_table
;
222 if (EQ (Fsyntax_table_p (tmp_table
), Qt
))
224 gl_state
.use_global
= 0;
226 else if (CONSP (tmp_table
))
228 gl_state
.use_global
= 1;
229 gl_state
.global_code
= tmp_table
;
233 gl_state
.use_global
= 0;
234 gl_state
.current_syntax_table
= current_buffer
->syntax_table
;
238 while (!NULL_INTERVAL_P (i
))
240 if (cnt
&& !EQ (tmp_table
, textget (i
->plist
, Qsyntax_table
)))
244 gl_state
.e_property
= i
->position
- gl_state
.offset
;
245 gl_state
.forward_i
= i
;
249 gl_state
.b_property
= i
->position
+ LENGTH (i
) - gl_state
.offset
;
250 gl_state
.backward_i
= i
;
254 else if (cnt
== INTERVALS_AT_ONCE
)
258 gl_state
.e_property
= i
->position
+ LENGTH (i
) - gl_state
.offset
;
259 gl_state
.forward_i
= i
;
263 gl_state
.b_property
= i
->position
- gl_state
.offset
;
264 gl_state
.backward_i
= i
;
269 i
= count
> 0 ? next_interval (i
) : previous_interval (i
);
271 eassert (NULL_INTERVAL_P (i
)); /* This property goes to the end. */
273 gl_state
.e_property
= gl_state
.stop
;
275 gl_state
.b_property
= gl_state
.start
;
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. */
283 char_quoted (charpos
, bytepos
)
284 register int charpos
, bytepos
;
286 register enum syntaxcode code
;
287 register int beg
= BEGV
;
288 register int quoted
= 0;
291 DEC_BOTH (charpos
, bytepos
);
293 while (bytepos
>= beg
)
295 UPDATE_SYNTAX_TABLE_BACKWARD (charpos
);
296 code
= SYNTAX (FETCH_CHAR (bytepos
));
297 if (! (code
== Scharquote
|| code
== Sescape
))
300 DEC_BOTH (charpos
, bytepos
);
304 UPDATE_SYNTAX_TABLE (orig
);
308 /* Return the bytepos one character after BYTEPOS.
309 We assume that BYTEPOS is not at the end of the buffer. */
312 inc_bytepos (bytepos
)
315 if (NILP (current_buffer
->enable_multibyte_characters
))
322 /* Return the bytepos one character before BYTEPOS.
323 We assume that BYTEPOS is not at the start of the buffer. */
326 dec_bytepos (bytepos
)
329 if (NILP (current_buffer
->enable_multibyte_characters
))
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.
339 When open_paren_in_column_0_is_defun_start is nonzero,
340 only the beginning of the buffer is treated as a defun-start.
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.
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. */
351 find_defun_start (pos
, pos_byte
)
354 int opoint
= PT
, opoint_byte
= PT_BYTE
;
356 if (!open_paren_in_column_0_is_defun_start
)
358 find_start_value_byte
= BEGV_BYTE
;
362 /* Use previous finding, if it's valid and applies to this inquiry. */
363 if (current_buffer
== find_start_buffer
364 /* Reuse the defun-start even if POS is a little farther on.
365 POS might be in the next defun, but that's ok.
366 Our value may not be the best possible, but will still be usable. */
367 && pos
<= find_start_pos
+ 1000
368 && pos
>= find_start_value
369 && BEGV
== find_start_begv
370 && MODIFF
== find_start_modiff
)
371 return find_start_value
;
373 /* Back up to start of line. */
374 scan_newline (pos
, pos_byte
, BEGV
, BEGV_BYTE
, -1, 1);
376 /* We optimize syntax-table lookup for rare updates. Thus we accept
377 only those `^\s(' which are good in global _and_ text-property
379 gl_state
.current_syntax_table
= current_buffer
->syntax_table
;
380 gl_state
.use_global
= 0;
383 /* Open-paren at start of line means we may have found our
385 if (SYNTAX (FETCH_CHAR (PT_BYTE
)) == Sopen
)
387 SETUP_SYNTAX_TABLE (PT
+ 1, -1); /* Try again... */
388 if (SYNTAX (FETCH_CHAR (PT_BYTE
)) == Sopen
)
390 /* Now fallback to the default value. */
391 gl_state
.current_syntax_table
= current_buffer
->syntax_table
;
392 gl_state
.use_global
= 0;
394 /* Move to beg of previous line. */
395 scan_newline (PT
, PT_BYTE
, BEGV
, BEGV_BYTE
, -2, 1);
398 /* Record what we found, for the next try. */
399 find_start_value
= PT
;
400 find_start_value_byte
= PT_BYTE
;
401 find_start_buffer
= current_buffer
;
402 find_start_modiff
= MODIFF
;
403 find_start_begv
= BEGV
;
404 find_start_pos
= pos
;
406 TEMP_SET_PT_BOTH (opoint
, opoint_byte
);
408 return find_start_value
;
411 /* Return the SYNTAX_COMEND_FIRST of the character before POS, POS_BYTE. */
414 prev_char_comend_first (pos
, pos_byte
)
419 DEC_BOTH (pos
, pos_byte
);
420 UPDATE_SYNTAX_TABLE_BACKWARD (pos
);
421 c
= FETCH_CHAR (pos_byte
);
422 val
= SYNTAX_COMEND_FIRST (c
);
423 UPDATE_SYNTAX_TABLE_FORWARD (pos
+ 1);
427 /* Return the SYNTAX_COMSTART_FIRST of the character before POS, POS_BYTE. */
430 * prev_char_comstart_first (pos, pos_byte)
435 * DEC_BOTH (pos, pos_byte);
436 * UPDATE_SYNTAX_TABLE_BACKWARD (pos);
437 * c = FETCH_CHAR (pos_byte);
438 * val = SYNTAX_COMSTART_FIRST (c);
439 * UPDATE_SYNTAX_TABLE_FORWARD (pos + 1);
443 /* Checks whether charpos FROM is at the end of a comment.
444 FROM_BYTE is the bytepos corresponding to FROM.
445 Do not move back before STOP.
447 Return a positive value if we find a comment ending at FROM/FROM_BYTE;
450 If successful, store the charpos of the comment's beginning
451 into *CHARPOS_PTR, and the bytepos into *BYTEPOS_PTR.
453 Global syntax data remains valid for backward search starting at
454 the returned value (or at FROM, if the search was not successful). */
457 back_comment (from
, from_byte
, stop
, comnested
, comstyle
, charpos_ptr
, bytepos_ptr
)
458 int from
, from_byte
, stop
;
459 int comnested
, comstyle
;
460 int *charpos_ptr
, *bytepos_ptr
;
462 /* Look back, counting the parity of string-quotes,
463 and recording the comment-starters seen.
464 When we reach a safe place, assume that's not in a string;
465 then step the main scan to the earliest comment-starter seen
466 an even number of string quotes away from the safe place.
468 OFROM[I] is position of the earliest comment-starter seen
469 which is I+2X quotes from the comment-end.
470 PARITY is current parity of quotes from the comment end. */
471 int string_style
= -1; /* Presumed outside of any string. */
472 int string_lossage
= 0;
473 /* Not a real lossage: indicates that we have passed a matching comment
474 starter plus a non-matching comment-ender, meaning that any matching
475 comment-starter we might see later could be a false positive (hidden
476 inside another comment).
477 Test case: { a (* b } c (* d *) */
478 int comment_lossage
= 0;
479 int comment_end
= from
;
480 int comment_end_byte
= from_byte
;
481 int comstart_pos
= 0;
483 /* Place where the containing defun starts,
484 or 0 if we didn't come across it yet. */
486 int defun_start_byte
= 0;
487 register enum syntaxcode code
;
488 int nesting
= 1; /* current comment nesting */
492 /* FIXME: A }} comment-ender style leads to incorrect behavior
493 in the case of {{ c }}} because we ignore the last two chars which are
494 assumed to be comment-enders although they aren't. */
496 /* At beginning of range to scan, we're outside of strings;
497 that determines quote parity to the comment-end. */
500 int temp_byte
, prev_syntax
;
501 int com2start
, com2end
;
503 /* Move back and examine a character. */
504 DEC_BOTH (from
, from_byte
);
505 UPDATE_SYNTAX_TABLE_BACKWARD (from
);
507 prev_syntax
= syntax
;
508 c
= FETCH_CHAR (from_byte
);
509 syntax
= SYNTAX_WITH_FLAGS (c
);
512 /* Check for 2-char comment markers. */
513 com2start
= (SYNTAX_FLAGS_COMSTART_FIRST (syntax
)
514 && SYNTAX_FLAGS_COMSTART_SECOND (prev_syntax
)
515 && comstyle
== SYNTAX_FLAGS_COMMENT_STYLE (prev_syntax
)
516 && (SYNTAX_FLAGS_COMMENT_NESTED (prev_syntax
)
517 || SYNTAX_FLAGS_COMMENT_NESTED (syntax
)) == comnested
);
518 com2end
= (SYNTAX_FLAGS_COMEND_FIRST (syntax
)
519 && SYNTAX_FLAGS_COMEND_SECOND (prev_syntax
));
521 /* Nasty cases with overlapping 2-char comment markers:
522 - snmp-mode: -- c -- foo -- c --
530 /* If a 2-char comment sequence partly overlaps with another,
531 we don't try to be clever. */
532 if (from
> stop
&& (com2end
|| com2start
))
534 int next
= from
, next_byte
= from_byte
, next_c
, next_syntax
;
535 DEC_BOTH (next
, next_byte
);
536 UPDATE_SYNTAX_TABLE_BACKWARD (next
);
537 next_c
= FETCH_CHAR (next_byte
);
538 next_syntax
= SYNTAX_WITH_FLAGS (next_c
);
539 if (((com2start
|| comnested
)
540 && SYNTAX_FLAGS_COMEND_SECOND (syntax
)
541 && SYNTAX_FLAGS_COMEND_FIRST (next_syntax
))
542 || ((com2end
|| comnested
)
543 && SYNTAX_FLAGS_COMSTART_SECOND (syntax
)
544 && comstyle
== SYNTAX_FLAGS_COMMENT_STYLE (syntax
)
545 && SYNTAX_FLAGS_COMSTART_FIRST (next_syntax
)))
547 /* UPDATE_SYNTAX_TABLE_FORWARD (next + 1); */
550 if (com2start
&& comstart_pos
== 0)
551 /* We're looking at a comment starter. But it might be a comment
552 ender as well (see snmp-mode). The first time we see one, we
553 need to consider it as a comment starter,
554 and the subsequent times as a comment ender. */
557 /* Turn a 2-char comment sequences into the appropriate syntax. */
562 /* Ignore comment starters of a different style. */
563 else if (code
== Scomment
564 && (comstyle
!= SYNTAX_FLAGS_COMMENT_STYLE (syntax
)
565 || SYNTAX_FLAGS_COMMENT_NESTED (syntax
) != comnested
))
568 /* Ignore escaped characters, except comment-enders. */
569 if (code
!= Sendcomment
&& char_quoted (from
, from_byte
))
576 c
= (code
== Sstring_fence
? ST_STRING_STYLE
: ST_COMMENT_STYLE
);
578 /* Track parity of quotes. */
579 if (string_style
== -1)
580 /* Entering a string. */
582 else if (string_style
== c
)
583 /* Leaving the string. */
586 /* If we have two kinds of string delimiters.
587 There's no way to grok this scanning backwards. */
592 /* We've already checked that it is the relevant comstyle. */
593 if (string_style
!= -1 || comment_lossage
|| string_lossage
)
594 /* There are odd string quotes involved, so let's be careful.
595 Test case in Pascal: " { " a { " } */
600 /* Record best comment-starter so far. */
602 comstart_byte
= from_byte
;
604 else if (--nesting
<= 0)
605 /* nested comments have to be balanced, so we don't need to
606 keep looking for earlier ones. We use here the same (slightly
607 incorrect) reasoning as below: since it is followed by uniform
608 paired string quotes, this comment-start has to be outside of
609 strings, else the comment-end itself would be inside a string. */
614 if (SYNTAX_FLAGS_COMMENT_STYLE (syntax
) == comstyle
615 && ((com2end
&& SYNTAX_FLAGS_COMMENT_NESTED (prev_syntax
))
616 || SYNTAX_FLAGS_COMMENT_NESTED (syntax
)) == comnested
)
617 /* This is the same style of comment ender as ours. */
622 /* Anything before that can't count because it would match
623 this comment-ender rather than ours. */
624 from
= stop
; /* Break out of the loop. */
626 else if (comstart_pos
!= 0 || c
!= '\n')
627 /* We're mixing comment styles here, so we'd better be careful.
628 The (comstart_pos != 0 || c != '\n') check is not quite correct
629 (we should just always set comment_lossage), but removing it
630 would imply that any multiline comment in C would go through
631 lossage, which seems overkill.
632 The failure should only happen in the rare cases such as
638 /* Assume a defun-start point is outside of strings. */
639 if (open_paren_in_column_0_is_defun_start
641 || (temp_byte
= dec_bytepos (from_byte
),
642 FETCH_CHAR (temp_byte
) == '\n')))
645 defun_start_byte
= from_byte
;
646 from
= stop
; /* Break out of the loop. */
655 if (comstart_pos
== 0)
658 from_byte
= comment_end_byte
;
659 UPDATE_SYNTAX_TABLE_FORWARD (comment_end
- 1);
661 /* If comstart_pos is set and we get here (ie. didn't jump to `lossage'
662 or `done'), then we've found the beginning of the non-nested comment. */
663 else if (1) /* !comnested */
666 from_byte
= comstart_byte
;
667 /* Globals are correct now. */
671 struct lisp_parse_state state
;
673 /* We had two kinds of string delimiters mixed up
674 together. Decode this going forwards.
675 Scan fwd from a known safe place (beginning-of-defun)
676 to the one in question; this records where we
677 last passed a comment starter. */
678 /* If we did not already find the defun start, find it now. */
679 if (defun_start
== 0)
681 defun_start
= find_defun_start (comment_end
, comment_end_byte
);
682 defun_start_byte
= find_start_value_byte
;
686 scan_sexps_forward (&state
,
687 defun_start
, defun_start_byte
,
688 comment_end
, -10000, 0, Qnil
, 0);
689 defun_start
= comment_end
;
690 if (state
.incomment
== (comnested
? 1 : -1)
691 && state
.comstyle
== comstyle
)
692 from
= state
.comstr_start
;
697 /* If comment_end is inside some other comment, maybe ours
698 is nested, so we need to try again from within the
699 surrounding comment. Example: { a (* " *) */
701 /* FIXME: We should advance by one or two chars. */
702 defun_start
= state
.comstr_start
+ 2;
703 defun_start_byte
= CHAR_TO_BYTE (defun_start
);
706 } while (defun_start
< comment_end
);
708 from_byte
= CHAR_TO_BYTE (from
);
709 UPDATE_SYNTAX_TABLE_FORWARD (from
- 1);
714 *bytepos_ptr
= from_byte
;
716 return (from
== comment_end
) ? -1 : from
;
719 DEFUN ("syntax-table-p", Fsyntax_table_p
, Ssyntax_table_p
, 1, 1, 0,
720 doc
: /* Return t if OBJECT is a syntax table.
721 Currently, any char-table counts as a syntax table. */)
725 if (CHAR_TABLE_P (object
)
726 && EQ (XCHAR_TABLE (object
)->purpose
, Qsyntax_table
))
732 check_syntax_table (obj
)
735 if (!(CHAR_TABLE_P (obj
)
736 && EQ (XCHAR_TABLE (obj
)->purpose
, Qsyntax_table
)))
737 wrong_type_argument (Qsyntax_table_p
, obj
);
740 DEFUN ("syntax-table", Fsyntax_table
, Ssyntax_table
, 0, 0, 0,
741 doc
: /* Return the current syntax table.
742 This is the one specified by the current buffer. */)
745 return current_buffer
->syntax_table
;
748 DEFUN ("standard-syntax-table", Fstandard_syntax_table
,
749 Sstandard_syntax_table
, 0, 0, 0,
750 doc
: /* Return the standard syntax table.
751 This is the one used for new buffers. */)
754 return Vstandard_syntax_table
;
757 DEFUN ("copy-syntax-table", Fcopy_syntax_table
, Scopy_syntax_table
, 0, 1, 0,
758 doc
: /* Construct a new syntax table and return it.
759 It is a copy of the TABLE, which defaults to the standard syntax table. */)
766 check_syntax_table (table
);
768 table
= Vstandard_syntax_table
;
770 copy
= Fcopy_sequence (table
);
772 /* Only the standard syntax table should have a default element.
773 Other syntax tables should inherit from parents instead. */
774 XCHAR_TABLE (copy
)->defalt
= Qnil
;
776 /* Copied syntax tables should all have parents.
777 If we copied one with no parent, such as the standard syntax table,
778 use the standard syntax table as the copy's parent. */
779 if (NILP (XCHAR_TABLE (copy
)->parent
))
780 Fset_char_table_parent (copy
, Vstandard_syntax_table
);
784 DEFUN ("set-syntax-table", Fset_syntax_table
, Sset_syntax_table
, 1, 1, 0,
785 doc
: /* Select a new syntax table for the current buffer.
786 One argument, a syntax table. */)
791 check_syntax_table (table
);
792 current_buffer
->syntax_table
= table
;
793 /* Indicate that this buffer now has a specified syntax table. */
794 idx
= PER_BUFFER_VAR_IDX (syntax_table
);
795 SET_PER_BUFFER_VALUE_P (current_buffer
, idx
, 1);
799 /* Convert a letter which signifies a syntax code
800 into the code it signifies.
801 This is used by modify-syntax-entry, and other things. */
803 unsigned char syntax_spec_code
[0400] =
804 { 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
805 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
806 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
807 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
808 (char) Swhitespace
, (char) Scomment_fence
, (char) Sstring
, 0377,
809 (char) Smath
, 0377, 0377, (char) Squote
,
810 (char) Sopen
, (char) Sclose
, 0377, 0377,
811 0377, (char) Swhitespace
, (char) Spunct
, (char) Scharquote
,
812 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
813 0377, 0377, 0377, 0377,
814 (char) Scomment
, 0377, (char) Sendcomment
, 0377,
815 (char) Sinherit
, 0377, 0377, 0377, 0377, 0377, 0377, 0377, /* @, A ... */
816 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
817 0377, 0377, 0377, 0377, 0377, 0377, 0377, (char) Sword
,
818 0377, 0377, 0377, 0377, (char) Sescape
, 0377, 0377, (char) Ssymbol
,
819 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377, /* `, a, ... */
820 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
821 0377, 0377, 0377, 0377, 0377, 0377, 0377, (char) Sword
,
822 0377, 0377, 0377, 0377, (char) Sstring_fence
, 0377, 0377, 0377
825 /* Indexed by syntax code, give the letter that describes it. */
827 char syntax_code_spec
[16] =
829 ' ', '.', 'w', '_', '(', ')', '\'', '\"', '$', '\\', '/', '<', '>', '@',
833 /* Indexed by syntax code, give the object (cons of syntax code and
834 nil) to be stored in syntax table. Since these objects can be
835 shared among syntax tables, we generate them in advance. By
836 sharing objects, the function `describe-syntax' can give a more
838 static Lisp_Object Vsyntax_code_object
;
841 /* Look up the value for CHARACTER in syntax table TABLE's parent
842 and its parents. SYNTAX_ENTRY calls this, when TABLE itself has nil
843 for CHARACTER. It's actually used only when not compiled with GCC. */
846 syntax_parent_lookup (table
, character
)
854 table
= XCHAR_TABLE (table
)->parent
;
858 value
= XCHAR_TABLE (table
)->contents
[character
];
864 DEFUN ("char-syntax", Fchar_syntax
, Schar_syntax
, 1, 1, 0,
865 doc
: /* Return the syntax code of CHARACTER, described by a character.
866 For example, if CHARACTER is a word constituent,
867 the character `w' is returned.
868 The characters that correspond to various syntax codes
869 are listed in the documentation of `modify-syntax-entry'. */)
871 Lisp_Object character
;
874 gl_state
.current_syntax_table
= current_buffer
->syntax_table
;
876 gl_state
.use_global
= 0;
877 CHECK_NUMBER (character
);
878 char_int
= XINT (character
);
879 return make_number (syntax_code_spec
[(int) SYNTAX (char_int
)]);
882 DEFUN ("matching-paren", Fmatching_paren
, Smatching_paren
, 1, 1, 0,
883 doc
: /* Return the matching parenthesis of CHARACTER, or nil if none. */)
885 Lisp_Object character
;
888 gl_state
.current_syntax_table
= current_buffer
->syntax_table
;
889 gl_state
.use_global
= 0;
890 CHECK_NUMBER (character
);
891 char_int
= XINT (character
);
892 code
= SYNTAX (char_int
);
893 if (code
== Sopen
|| code
== Sclose
)
894 return SYNTAX_MATCH (char_int
);
898 DEFUN ("string-to-syntax", Fstring_to_syntax
, Sstring_to_syntax
, 1, 1, 0,
899 doc
: /* Convert a syntax specification STRING into syntax cell form.
900 STRING should be a string as it is allowed as argument of
901 `modify-syntax-entry'. Value is the equivalent cons cell
902 (CODE . MATCHING-CHAR) that can be used as value of a `syntax-table'
907 register const unsigned char *p
;
908 register enum syntaxcode code
;
912 CHECK_STRING (string
);
915 code
= (enum syntaxcode
) syntax_spec_code
[*p
++];
916 if (((int) code
& 0377) == 0377)
917 error ("invalid syntax description letter: %c", p
[-1]);
919 if (code
== Sinherit
)
925 int character
= (STRING_CHAR_AND_LENGTH
926 (p
, SBYTES (string
) - 1, len
));
927 XSETINT (match
, character
);
928 if (XFASTINT (match
) == ' ')
968 if (val
< XVECTOR (Vsyntax_code_object
)->size
&& NILP (match
))
969 return XVECTOR (Vsyntax_code_object
)->contents
[val
];
971 /* Since we can't use a shared object, let's make a new one. */
972 return Fcons (make_number (val
), match
);
975 /* I really don't know why this is interactive
976 help-form should at least be made useful whilst reading the second arg. */
977 DEFUN ("modify-syntax-entry", Fmodify_syntax_entry
, Smodify_syntax_entry
, 2, 3,
978 "cSet syntax for character: \nsSet syntax for %s to: ",
979 doc
: /* Set syntax for character CHAR according to string NEWENTRY.
980 The syntax is changed only for table SYNTAX_TABLE, which defaults to
981 the current buffer's syntax table.
982 The first character of NEWENTRY should be one of the following:
983 Space or - whitespace syntax. w word constituent.
984 _ symbol constituent. . punctuation.
985 ( open-parenthesis. ) close-parenthesis.
986 " string quote. \\ escape.
987 $ paired delimiter. ' expression quote or prefix operator.
988 < comment starter. > comment ender.
989 / character-quote. @ inherit from `standard-syntax-table'.
990 | generic string fence. ! generic comment fence.
992 Only single-character comment start and end sequences are represented thus.
993 Two-character sequences are represented as described below.
994 The second character of NEWENTRY is the matching parenthesis,
995 used only if the first character is `(' or `)'.
996 Any additional characters are flags.
997 Defined flags are the characters 1, 2, 3, 4, b, p, and n.
998 1 means CHAR is the start of a two-char comment start sequence.
999 2 means CHAR is the second character of such a sequence.
1000 3 means CHAR is the start of a two-char comment end sequence.
1001 4 means CHAR is the second character of such a sequence.
1003 There can be up to two orthogonal comment sequences. This is to support
1004 language modes such as C++. By default, all comment sequences are of style
1005 a, but you can set the comment sequence style to b (on the second character
1006 of a comment-start, or the first character of a comment-end sequence) using
1008 b means CHAR is part of comment sequence b.
1009 n means CHAR is part of a nestable comment sequence.
1011 p means CHAR is a prefix character for `backward-prefix-chars';
1012 such characters are treated as whitespace when they occur
1013 between expressions.
1014 usage: (modify-syntax-entry CHAR NEWENTRY &optional SYNTAX-TABLE) */)
1015 (c
, newentry
, syntax_table
)
1016 Lisp_Object c
, newentry
, syntax_table
;
1020 if (NILP (syntax_table
))
1021 syntax_table
= current_buffer
->syntax_table
;
1023 check_syntax_table (syntax_table
);
1025 SET_RAW_SYNTAX_ENTRY (syntax_table
, XINT (c
), Fstring_to_syntax (newentry
));
1029 /* Dump syntax table to buffer in human-readable format */
1031 DEFUN ("internal-describe-syntax-value", Finternal_describe_syntax_value
,
1032 Sinternal_describe_syntax_value
, 1, 1, 0,
1033 doc
: /* Insert a description of the internal syntax description SYNTAX at point. */)
1037 register enum syntaxcode code
;
1038 char desc
, start1
, start2
, end1
, end2
, prefix
, comstyle
, comnested
;
1040 Lisp_Object first
, match_lisp
, value
= syntax
;
1044 insert_string ("default");
1048 if (CHAR_TABLE_P (value
))
1050 insert_string ("deeper char-table ...");
1056 insert_string ("invalid");
1060 first
= XCAR (value
);
1061 match_lisp
= XCDR (value
);
1063 if (!INTEGERP (first
) || !(NILP (match_lisp
) || INTEGERP (match_lisp
)))
1065 insert_string ("invalid");
1069 code
= (enum syntaxcode
) (XINT (first
) & 0377);
1070 start1
= (XINT (first
) >> 16) & 1;
1071 start2
= (XINT (first
) >> 17) & 1;
1072 end1
= (XINT (first
) >> 18) & 1;
1073 end2
= (XINT (first
) >> 19) & 1;
1074 prefix
= (XINT (first
) >> 20) & 1;
1075 comstyle
= (XINT (first
) >> 21) & 1;
1076 comnested
= (XINT (first
) >> 22) & 1;
1078 if ((int) code
< 0 || (int) code
>= (int) Smax
)
1080 insert_string ("invalid");
1083 desc
= syntax_code_spec
[(int) code
];
1085 str
[0] = desc
, str
[1] = 0;
1088 if (NILP (match_lisp
))
1091 insert_char (XINT (match_lisp
));
1110 insert_string ("\twhich means: ");
1112 switch (SWITCH_ENUM_CAST (code
))
1115 insert_string ("whitespace"); break;
1117 insert_string ("punctuation"); break;
1119 insert_string ("word"); break;
1121 insert_string ("symbol"); break;
1123 insert_string ("open"); break;
1125 insert_string ("close"); break;
1127 insert_string ("prefix"); break;
1129 insert_string ("string"); break;
1131 insert_string ("math"); break;
1133 insert_string ("escape"); break;
1135 insert_string ("charquote"); break;
1137 insert_string ("comment"); break;
1139 insert_string ("endcomment"); break;
1141 insert_string ("inherit"); break;
1142 case Scomment_fence
:
1143 insert_string ("comment fence"); break;
1145 insert_string ("string fence"); break;
1147 insert_string ("invalid");
1151 if (!NILP (match_lisp
))
1153 insert_string (", matches ");
1154 insert_char (XINT (match_lisp
));
1158 insert_string (",\n\t is the first character of a comment-start sequence");
1160 insert_string (",\n\t is the second character of a comment-start sequence");
1163 insert_string (",\n\t is the first character of a comment-end sequence");
1165 insert_string (",\n\t is the second character of a comment-end sequence");
1167 insert_string (" (comment style b)");
1169 insert_string (" (nestable)");
1172 insert_string (",\n\t is a prefix character for `backward-prefix-chars'");
1177 int parse_sexp_ignore_comments
;
1179 /* Return the position across COUNT words from FROM.
1180 If that many words cannot be found before the end of the buffer, return 0.
1181 COUNT negative means scan backward and stop at word beginning. */
1184 scan_words (from
, count
)
1185 register int from
, count
;
1187 register int beg
= BEGV
;
1188 register int end
= ZV
;
1189 register int from_byte
= CHAR_TO_BYTE (from
);
1190 register enum syntaxcode code
;
1196 SETUP_SYNTAX_TABLE (from
, count
);
1207 UPDATE_SYNTAX_TABLE_FORWARD (from
);
1208 ch0
= FETCH_CHAR (from_byte
);
1209 code
= SYNTAX (ch0
);
1210 INC_BOTH (from
, from_byte
);
1211 if (words_include_escapes
1212 && (code
== Sescape
|| code
== Scharquote
))
1217 /* Now CH0 is a character which begins a word and FROM is the
1218 position of the next character. */
1221 if (from
== end
) break;
1222 UPDATE_SYNTAX_TABLE_FORWARD (from
);
1223 ch1
= FETCH_CHAR (from_byte
);
1224 code
= SYNTAX (ch1
);
1225 if (!(words_include_escapes
1226 && (code
== Sescape
|| code
== Scharquote
)))
1227 if (code
!= Sword
|| WORD_BOUNDARY_P (ch0
, ch1
))
1229 INC_BOTH (from
, from_byte
);
1243 DEC_BOTH (from
, from_byte
);
1244 UPDATE_SYNTAX_TABLE_BACKWARD (from
);
1245 ch1
= FETCH_CHAR (from_byte
);
1246 code
= SYNTAX (ch1
);
1247 if (words_include_escapes
1248 && (code
== Sescape
|| code
== Scharquote
))
1253 /* Now CH1 is a character which ends a word and FROM is the
1261 temp_byte
= dec_bytepos (from_byte
);
1262 UPDATE_SYNTAX_TABLE_BACKWARD (from
);
1263 ch0
= FETCH_CHAR (temp_byte
);
1264 code
= SYNTAX (ch0
);
1265 if (!(words_include_escapes
1266 && (code
== Sescape
|| code
== Scharquote
)))
1267 if (code
!= Sword
|| WORD_BOUNDARY_P (ch0
, ch1
))
1269 DEC_BOTH (from
, from_byte
);
1280 DEFUN ("forward-word", Fforward_word
, Sforward_word
, 1, 1, "p",
1281 doc
: /* Move point forward ARG words (backward if ARG is negative).
1283 If an edge of the buffer or a field boundary is reached, point is left there
1284 and the function returns nil. Field boundaries are not noticed if
1285 `inhibit-field-text-motion' is non-nil. */)
1290 CHECK_NUMBER (count
);
1292 val
= orig_val
= scan_words (PT
, XINT (count
));
1294 val
= XINT (count
) > 0 ? ZV
: BEGV
;
1296 /* Avoid jumping out of an input field. */
1297 val
= XFASTINT (Fconstrain_to_field (make_number (val
), make_number (PT
),
1301 return val
== orig_val
? Qt
: Qnil
;
1304 Lisp_Object
skip_chars ();
1306 DEFUN ("skip-chars-forward", Fskip_chars_forward
, Sskip_chars_forward
, 1, 2, 0,
1307 doc
: /* Move point forward, stopping before a char not in STRING, or at pos LIM.
1308 STRING is like the inside of a `[...]' in a regular expression
1309 except that `]' is never special and `\\' quotes `^', `-' or `\\'
1310 (but not as the end of a range; quoting is never needed there).
1311 Thus, with arg "a-zA-Z", this skips letters stopping before first nonletter.
1312 With arg "^a-zA-Z", skips nonletters stopping before first letter.
1313 Returns the distance traveled, either zero or positive.
1314 Note that char classes, e.g. `[:alpha:]', are not currently supported;
1315 they will be treated as literals. */)
1317 Lisp_Object string
, lim
;
1319 return skip_chars (1, 0, string
, lim
);
1322 DEFUN ("skip-chars-backward", Fskip_chars_backward
, Sskip_chars_backward
, 1, 2, 0,
1323 doc
: /* Move point backward, stopping after a char not in STRING, or at pos LIM.
1324 See `skip-chars-forward' for details.
1325 Returns the distance traveled, either zero or negative. */)
1327 Lisp_Object string
, lim
;
1329 return skip_chars (0, 0, string
, lim
);
1332 DEFUN ("skip-syntax-forward", Fskip_syntax_forward
, Sskip_syntax_forward
, 1, 2, 0,
1333 doc
: /* Move point forward across chars in specified syntax classes.
1334 SYNTAX is a string of syntax code characters.
1335 Stop before a char whose syntax is not in SYNTAX, or at position LIM.
1336 If SYNTAX starts with ^, skip characters whose syntax is NOT in SYNTAX.
1337 This function returns the distance traveled, either zero or positive. */)
1339 Lisp_Object syntax
, lim
;
1341 return skip_chars (1, 1, syntax
, lim
);
1344 DEFUN ("skip-syntax-backward", Fskip_syntax_backward
, Sskip_syntax_backward
, 1, 2, 0,
1345 doc
: /* Move point backward across chars in specified syntax classes.
1346 SYNTAX is a string of syntax code characters.
1347 Stop on reaching a char whose syntax is not in SYNTAX, or at position LIM.
1348 If SYNTAX starts with ^, skip characters whose syntax is NOT in SYNTAX.
1349 This function returns the distance traveled, either zero or negative. */)
1351 Lisp_Object syntax
, lim
;
1353 return skip_chars (0, 1, syntax
, lim
);
1357 skip_chars (forwardp
, syntaxp
, string
, lim
)
1358 int forwardp
, syntaxp
;
1359 Lisp_Object string
, lim
;
1361 register unsigned int c
;
1362 unsigned char fastmap
[0400];
1363 /* If SYNTAXP is 0, STRING may contain multi-byte form of characters
1364 of which codes don't fit in FASTMAP. In that case, set the
1365 ranges of characters in CHAR_RANGES. */
1367 int n_char_ranges
= 0;
1369 register int i
, i_byte
;
1370 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
1371 int string_multibyte
;
1373 const unsigned char *str
;
1376 CHECK_STRING (string
);
1377 char_ranges
= (int *) alloca (SCHARS (string
) * (sizeof (int)) * 2);
1378 string_multibyte
= STRING_MULTIBYTE (string
);
1379 str
= SDATA (string
);
1380 size_byte
= SBYTES (string
);
1382 /* Adjust the multibyteness of the string to that of the buffer. */
1383 if (multibyte
!= string_multibyte
)
1388 nbytes
= count_size_as_multibyte (SDATA (string
),
1391 nbytes
= SCHARS (string
);
1392 if (nbytes
!= size_byte
)
1394 unsigned char *tmp
= (unsigned char *) alloca (nbytes
);
1395 copy_text (SDATA (string
), tmp
, size_byte
,
1396 string_multibyte
, multibyte
);
1403 XSETINT (lim
, forwardp
? ZV
: BEGV
);
1405 CHECK_NUMBER_COERCE_MARKER (lim
);
1407 /* In any case, don't allow scan outside bounds of buffer. */
1408 if (XINT (lim
) > ZV
)
1409 XSETFASTINT (lim
, ZV
);
1410 if (XINT (lim
) < BEGV
)
1411 XSETFASTINT (lim
, BEGV
);
1413 bzero (fastmap
, sizeof fastmap
);
1417 if (i_byte
< size_byte
1418 && SREF (string
, 0) == '^')
1420 negate
= 1; i_byte
++;
1423 /* Find the characters specified and set their elements of fastmap.
1424 If syntaxp, each character counts as itself.
1425 Otherwise, handle backslashes and ranges specially. */
1427 while (i_byte
< size_byte
)
1429 c
= STRING_CHAR_AND_LENGTH (str
+ i_byte
, size_byte
- i_byte
, len
);
1433 fastmap
[syntax_spec_code
[c
& 0377]] = 1;
1438 if (i_byte
== size_byte
)
1441 c
= STRING_CHAR_AND_LENGTH (str
+i_byte
, size_byte
-i_byte
, len
);
1444 if (i_byte
< size_byte
1445 && str
[i_byte
] == '-')
1449 /* Skip over the dash. */
1452 if (i_byte
== size_byte
)
1455 /* Get the end of the range. */
1456 c2
=STRING_CHAR_AND_LENGTH (str
+i_byte
, size_byte
-i_byte
, len
);
1459 if (SINGLE_BYTE_CHAR_P (c
))
1461 if (! SINGLE_BYTE_CHAR_P (c2
))
1463 /* Handle a range starting with a character of
1464 less than 256, and ending with a character of
1465 not less than 256. Split that into two
1466 ranges, the low one ending at 0377, and the
1467 high one starting at the smallest character
1468 in the charset of C2 and ending at C2. */
1469 int charset
= CHAR_CHARSET (c2
);
1470 int c1
= MAKE_CHAR (charset
, 0, 0);
1472 char_ranges
[n_char_ranges
++] = c1
;
1473 char_ranges
[n_char_ranges
++] = c2
;
1482 else if (c
<= c2
) /* Both C and C2 are multibyte char. */
1484 char_ranges
[n_char_ranges
++] = c
;
1485 char_ranges
[n_char_ranges
++] = c2
;
1490 if (SINGLE_BYTE_CHAR_P (c
))
1494 char_ranges
[n_char_ranges
++] = c
;
1495 char_ranges
[n_char_ranges
++] = c
;
1501 /* If ^ was the first character, complement the fastmap. */
1503 for (i
= 0; i
< sizeof fastmap
; i
++)
1507 int start_point
= PT
;
1509 int pos_byte
= PT_BYTE
;
1510 unsigned char *p
= PT_ADDR
, *endp
, *stop
;
1514 endp
= (XINT (lim
) == GPT
) ? GPT_ADDR
: CHAR_POS_ADDR (XINT (lim
));
1515 stop
= (pos
< GPT
&& GPT
< XINT (lim
)) ? GPT_ADDR
: endp
;
1519 endp
= CHAR_POS_ADDR (XINT (lim
));
1520 stop
= (pos
>= GPT
&& GPT
> XINT (lim
)) ? GAP_END_ADDR
: endp
;
1526 SETUP_SYNTAX_TABLE (pos
, forwardp
? 1 : -1);
1541 c
= STRING_CHAR_AND_LENGTH (p
, MAX_MULTIBYTE_LENGTH
, nbytes
);
1542 if (! fastmap
[(int) SYNTAX (c
)])
1544 p
+= nbytes
, pos
++, pos_byte
+= nbytes
;
1545 UPDATE_SYNTAX_TABLE_FORWARD (pos
);
1557 if (! fastmap
[(int) SYNTAX (*p
)])
1560 UPDATE_SYNTAX_TABLE_FORWARD (pos
);
1568 unsigned char *prev_p
;
1579 while (--p
>= stop
&& ! CHAR_HEAD_P (*p
));
1580 PARSE_MULTIBYTE_SEQ (p
, MAX_MULTIBYTE_LENGTH
, nbytes
);
1581 if (prev_p
- p
> nbytes
)
1582 p
= prev_p
- 1, c
= *p
, nbytes
= 1;
1584 c
= STRING_CHAR (p
, MAX_MULTIBYTE_LENGTH
);
1585 pos
--, pos_byte
-= nbytes
;
1586 UPDATE_SYNTAX_TABLE_BACKWARD (pos
);
1587 if (! fastmap
[(int) SYNTAX (c
)])
1604 if (! fastmap
[(int) SYNTAX (p
[-1])])
1607 UPDATE_SYNTAX_TABLE_BACKWARD (pos
- 1);
1627 c
= STRING_CHAR_AND_LENGTH (p
, MAX_MULTIBYTE_LENGTH
, nbytes
);
1628 if (SINGLE_BYTE_CHAR_P (c
))
1635 /* If we are looking at a multibyte character,
1636 we must look up the character in the table
1637 CHAR_RANGES. If there's no data in the
1638 table, that character is not what we want to
1641 /* The following code do the right thing even if
1642 n_char_ranges is zero (i.e. no data in
1644 for (i
= 0; i
< n_char_ranges
; i
+= 2)
1645 if (c
>= char_ranges
[i
] && c
<= char_ranges
[i
+ 1])
1647 if (!(negate
^ (i
< n_char_ranges
)))
1650 p
+= nbytes
, pos
++, pos_byte
+= nbytes
;
1672 unsigned char *prev_p
;
1683 while (--p
>= stop
&& ! CHAR_HEAD_P (*p
));
1684 PARSE_MULTIBYTE_SEQ (p
, MAX_MULTIBYTE_LENGTH
, nbytes
);
1685 if (prev_p
- p
> nbytes
)
1686 p
= prev_p
- 1, c
= *p
, nbytes
= 1;
1688 c
= STRING_CHAR (p
, MAX_MULTIBYTE_LENGTH
);
1689 if (SINGLE_BYTE_CHAR_P (c
))
1696 /* See the comment in the previous similar code. */
1697 for (i
= 0; i
< n_char_ranges
; i
+= 2)
1698 if (c
>= char_ranges
[i
] && c
<= char_ranges
[i
+ 1])
1700 if (!(negate
^ (i
< n_char_ranges
)))
1703 pos
--, pos_byte
-= nbytes
;
1715 if (!fastmap
[p
[-1]])
1722 #if 0 /* Not needed now that a position in mid-character
1723 cannot be specified in Lisp. */
1725 /* INC_POS or DEC_POS might have moved POS over LIM. */
1726 && (forwardp
? (pos
> XINT (lim
)) : (pos
< XINT (lim
))))
1733 SET_PT_BOTH (pos
, pos_byte
);
1736 return make_number (PT
- start_point
);
1740 /* Jump over a comment, assuming we are at the beginning of one.
1741 FROM is the current position.
1742 FROM_BYTE is the bytepos corresponding to FROM.
1743 Do not move past STOP (a charpos).
1744 The comment over which we have to jump is of style STYLE
1745 (either SYNTAX_COMMENT_STYLE(foo) or ST_COMMENT_STYLE).
1746 NESTING should be positive to indicate the nesting at the beginning
1747 for nested comments and should be zero or negative else.
1748 ST_COMMENT_STYLE cannot be nested.
1749 PREV_SYNTAX is the SYNTAX_WITH_FLAGS of the previous character
1750 (or 0 If the search cannot start in the middle of a two-character).
1752 If successful, return 1 and store the charpos of the comment's end
1753 into *CHARPOS_PTR and the corresponding bytepos into *BYTEPOS_PTR.
1754 Else, return 0 and store the charpos STOP into *CHARPOS_PTR, the
1755 corresponding bytepos into *BYTEPOS_PTR and the current nesting
1756 (as defined for state.incomment) in *INCOMMENT_PTR.
1758 The comment end is the last character of the comment rather than the
1759 character just after the comment.
1761 Global syntax data is assumed to initially be valid for FROM and
1762 remains valid for forward search starting at the returned position. */
1765 forw_comment (from
, from_byte
, stop
, nesting
, style
, prev_syntax
,
1766 charpos_ptr
, bytepos_ptr
, incomment_ptr
)
1767 int from
, from_byte
, stop
;
1768 int nesting
, style
, prev_syntax
;
1769 int *charpos_ptr
, *bytepos_ptr
, *incomment_ptr
;
1772 register enum syntaxcode code
;
1773 register int syntax
;
1775 if (nesting
<= 0) nesting
= -1;
1777 /* Enter the loop in the middle so that we find
1778 a 2-char comment ender if we start in the middle of it. */
1779 syntax
= prev_syntax
;
1780 if (syntax
!= 0) goto forw_incomment
;
1786 *incomment_ptr
= nesting
;
1787 *charpos_ptr
= from
;
1788 *bytepos_ptr
= from_byte
;
1791 c
= FETCH_CHAR (from_byte
);
1792 syntax
= SYNTAX_WITH_FLAGS (c
);
1793 code
= syntax
& 0xff;
1794 if (code
== Sendcomment
1795 && SYNTAX_FLAGS_COMMENT_STYLE (syntax
) == style
1796 && (SYNTAX_FLAGS_COMMENT_NESTED (syntax
) ?
1797 (nesting
> 0 && --nesting
== 0) : nesting
< 0))
1798 /* we have encountered a comment end of the same style
1799 as the comment sequence which began this comment
1802 if (code
== Scomment_fence
1803 && style
== ST_COMMENT_STYLE
)
1804 /* we have encountered a comment end of the same style
1805 as the comment sequence which began this comment
1810 && SYNTAX_FLAGS_COMMENT_NESTED (syntax
)
1811 && SYNTAX_FLAGS_COMMENT_STYLE (syntax
) == style
)
1812 /* we have encountered a nested comment of the same style
1813 as the comment sequence which began this comment section */
1815 INC_BOTH (from
, from_byte
);
1816 UPDATE_SYNTAX_TABLE_FORWARD (from
);
1819 if (from
< stop
&& SYNTAX_FLAGS_COMEND_FIRST (syntax
)
1820 && SYNTAX_FLAGS_COMMENT_STYLE (syntax
) == style
1821 && (c1
= FETCH_CHAR (from_byte
),
1822 SYNTAX_COMEND_SECOND (c1
))
1823 && ((SYNTAX_FLAGS_COMMENT_NESTED (syntax
) ||
1824 SYNTAX_COMMENT_NESTED (c1
)) ? nesting
> 0 : nesting
< 0))
1827 /* we have encountered a comment end of the same style
1828 as the comment sequence which began this comment
1833 INC_BOTH (from
, from_byte
);
1834 UPDATE_SYNTAX_TABLE_FORWARD (from
);
1839 && SYNTAX_FLAGS_COMSTART_FIRST (syntax
)
1840 && (c1
= FETCH_CHAR (from_byte
),
1841 SYNTAX_COMMENT_STYLE (c1
) == style
1842 && SYNTAX_COMSTART_SECOND (c1
))
1843 && (SYNTAX_FLAGS_COMMENT_NESTED (syntax
) ||
1844 SYNTAX_COMMENT_NESTED (c1
)))
1845 /* we have encountered a nested comment of the same style
1846 as the comment sequence which began this comment
1849 INC_BOTH (from
, from_byte
);
1850 UPDATE_SYNTAX_TABLE_FORWARD (from
);
1854 *charpos_ptr
= from
;
1855 *bytepos_ptr
= from_byte
;
1859 DEFUN ("forward-comment", Fforward_comment
, Sforward_comment
, 1, 1, 0,
1861 Move forward across up to COUNT comments. If COUNT is negative, move backward.
1862 Stop scanning if we find something other than a comment or whitespace.
1863 Set point to where scanning stops.
1864 If COUNT comments are found as expected, with nothing except whitespace
1865 between them, return t; otherwise return nil. */)
1873 register enum syntaxcode code
;
1874 int comstyle
= 0; /* style of comment encountered */
1875 int comnested
= 0; /* whether the comment is nestable or not */
1878 int out_charpos
, out_bytepos
;
1881 CHECK_NUMBER (count
);
1882 count1
= XINT (count
);
1883 stop
= count1
> 0 ? ZV
: BEGV
;
1889 from_byte
= PT_BYTE
;
1891 SETUP_SYNTAX_TABLE (from
, count1
);
1900 SET_PT_BOTH (from
, from_byte
);
1904 c
= FETCH_CHAR (from_byte
);
1906 comstart_first
= SYNTAX_COMSTART_FIRST (c
);
1907 comnested
= SYNTAX_COMMENT_NESTED (c
);
1908 comstyle
= SYNTAX_COMMENT_STYLE (c
);
1909 INC_BOTH (from
, from_byte
);
1910 UPDATE_SYNTAX_TABLE_FORWARD (from
);
1911 if (from
< stop
&& comstart_first
1912 && (c1
= FETCH_CHAR (from_byte
),
1913 SYNTAX_COMSTART_SECOND (c1
)))
1915 /* We have encountered a comment start sequence and we
1916 are ignoring all text inside comments. We must record
1917 the comment style this sequence begins so that later,
1918 only a comment end of the same style actually ends
1919 the comment section. */
1921 comstyle
= SYNTAX_COMMENT_STYLE (c1
);
1922 comnested
= comnested
|| SYNTAX_COMMENT_NESTED (c1
);
1923 INC_BOTH (from
, from_byte
);
1924 UPDATE_SYNTAX_TABLE_FORWARD (from
);
1927 while (code
== Swhitespace
|| (code
== Sendcomment
&& c
== '\n'));
1929 if (code
== Scomment_fence
)
1930 comstyle
= ST_COMMENT_STYLE
;
1931 else if (code
!= Scomment
)
1934 DEC_BOTH (from
, from_byte
);
1935 SET_PT_BOTH (from
, from_byte
);
1938 /* We're at the start of a comment. */
1939 found
= forw_comment (from
, from_byte
, stop
, comnested
, comstyle
, 0,
1940 &out_charpos
, &out_bytepos
, &dummy
);
1941 from
= out_charpos
; from_byte
= out_bytepos
;
1945 SET_PT_BOTH (from
, from_byte
);
1948 INC_BOTH (from
, from_byte
);
1949 UPDATE_SYNTAX_TABLE_FORWARD (from
);
1950 /* We have skipped one comment. */
1962 SET_PT_BOTH (BEGV
, BEGV_BYTE
);
1967 DEC_BOTH (from
, from_byte
);
1968 /* char_quoted does UPDATE_SYNTAX_TABLE_BACKWARD (from). */
1969 quoted
= char_quoted (from
, from_byte
);
1970 c
= FETCH_CHAR (from_byte
);
1973 comnested
= SYNTAX_COMMENT_NESTED (c
);
1974 if (code
== Sendcomment
)
1975 comstyle
= SYNTAX_COMMENT_STYLE (c
);
1976 if (from
> stop
&& SYNTAX_COMEND_SECOND (c
)
1977 && prev_char_comend_first (from
, from_byte
)
1978 && !char_quoted (from
- 1, dec_bytepos (from_byte
)))
1980 /* We must record the comment style encountered so that
1981 later, we can match only the proper comment begin
1982 sequence of the same style. */
1983 DEC_BOTH (from
, from_byte
);
1985 /* Calling char_quoted, above, set up global syntax position
1986 at the new value of FROM. */
1987 c1
= FETCH_CHAR (from_byte
);
1988 comstyle
= SYNTAX_COMMENT_STYLE (c1
);
1989 comnested
= comnested
|| SYNTAX_COMMENT_NESTED (c1
);
1992 if (code
== Scomment_fence
)
1994 /* Skip until first preceding unquoted comment_fence. */
1995 int found
= 0, ini
= from
, ini_byte
= from_byte
;
1999 DEC_BOTH (from
, from_byte
);
2002 UPDATE_SYNTAX_TABLE_BACKWARD (from
);
2003 c
= FETCH_CHAR (from_byte
);
2004 if (SYNTAX (c
) == Scomment_fence
2005 && !char_quoted (from
, from_byte
))
2013 from
= ini
; /* Set point to ini + 1. */
2014 from_byte
= ini_byte
;
2018 else if (code
== Sendcomment
)
2020 found
= back_comment (from
, from_byte
, stop
, comnested
, comstyle
,
2021 &out_charpos
, &out_bytepos
);
2025 /* This end-of-line is not an end-of-comment.
2026 Treat it like a whitespace.
2027 CC-mode (and maybe others) relies on this behavior. */
2031 /* Failure: we should go back to the end of this
2032 not-quite-endcomment. */
2033 if (SYNTAX(c
) != code
)
2034 /* It was a two-char Sendcomment. */
2035 INC_BOTH (from
, from_byte
);
2041 /* We have skipped one comment. */
2042 from
= out_charpos
, from_byte
= out_bytepos
;
2046 else if (code
!= Swhitespace
|| quoted
)
2050 INC_BOTH (from
, from_byte
);
2051 SET_PT_BOTH (from
, from_byte
);
2059 SET_PT_BOTH (from
, from_byte
);
2064 /* Return syntax code of character C if C is a single byte character
2065 or `multibyte_symbol_p' is zero. Otherwise, return Ssymbol. */
2067 #define SYNTAX_WITH_MULTIBYTE_CHECK(c) \
2068 ((SINGLE_BYTE_CHAR_P (c) || !multibyte_symbol_p) \
2069 ? SYNTAX (c) : Ssymbol)
2072 scan_lists (from
, count
, depth
, sexpflag
)
2074 int count
, depth
, sexpflag
;
2077 register int stop
= count
> 0 ? ZV
: BEGV
;
2082 register enum syntaxcode code
, temp_code
;
2083 int min_depth
= depth
; /* Err out if depth gets less than this. */
2084 int comstyle
= 0; /* style of comment encountered */
2085 int comnested
= 0; /* whether the comment is nestable or not */
2087 int last_good
= from
;
2090 int out_bytepos
, out_charpos
;
2092 int multibyte_symbol_p
= sexpflag
&& multibyte_syntax_as_symbol
;
2094 if (depth
> 0) min_depth
= 0;
2096 if (from
> ZV
) from
= ZV
;
2097 if (from
< BEGV
) from
= BEGV
;
2099 from_byte
= CHAR_TO_BYTE (from
);
2104 SETUP_SYNTAX_TABLE (from
, count
);
2109 int comstart_first
, prefix
;
2110 UPDATE_SYNTAX_TABLE_FORWARD (from
);
2111 c
= FETCH_CHAR (from_byte
);
2112 code
= SYNTAX_WITH_MULTIBYTE_CHECK (c
);
2113 comstart_first
= SYNTAX_COMSTART_FIRST (c
);
2114 comnested
= SYNTAX_COMMENT_NESTED (c
);
2115 comstyle
= SYNTAX_COMMENT_STYLE (c
);
2116 prefix
= SYNTAX_PREFIX (c
);
2117 if (depth
== min_depth
)
2119 INC_BOTH (from
, from_byte
);
2120 UPDATE_SYNTAX_TABLE_FORWARD (from
);
2121 if (from
< stop
&& comstart_first
2122 && SYNTAX_COMSTART_SECOND (FETCH_CHAR (from_byte
))
2123 && parse_sexp_ignore_comments
)
2125 /* we have encountered a comment start sequence and we
2126 are ignoring all text inside comments. We must record
2127 the comment style this sequence begins so that later,
2128 only a comment end of the same style actually ends
2129 the comment section */
2131 c1
= FETCH_CHAR (from_byte
);
2132 comstyle
= SYNTAX_COMMENT_STYLE (c1
);
2133 comnested
= comnested
|| SYNTAX_COMMENT_NESTED (c1
);
2134 INC_BOTH (from
, from_byte
);
2135 UPDATE_SYNTAX_TABLE_FORWARD (from
);
2141 switch (SWITCH_ENUM_CAST (code
))
2145 if (from
== stop
) goto lose
;
2146 INC_BOTH (from
, from_byte
);
2147 /* treat following character as a word constituent */
2150 if (depth
|| !sexpflag
) break;
2151 /* This word counts as a sexp; return at end of it. */
2154 UPDATE_SYNTAX_TABLE_FORWARD (from
);
2156 /* Some compilers can't handle this inside the switch. */
2157 c
= FETCH_CHAR (from_byte
);
2158 temp
= SYNTAX_WITH_MULTIBYTE_CHECK (c
);
2163 INC_BOTH (from
, from_byte
);
2164 if (from
== stop
) goto lose
;
2173 INC_BOTH (from
, from_byte
);
2177 case Scomment_fence
:
2178 comstyle
= ST_COMMENT_STYLE
;
2181 if (!parse_sexp_ignore_comments
) break;
2182 UPDATE_SYNTAX_TABLE_FORWARD (from
);
2183 found
= forw_comment (from
, from_byte
, stop
,
2184 comnested
, comstyle
, 0,
2185 &out_charpos
, &out_bytepos
, &dummy
);
2186 from
= out_charpos
, from_byte
= out_bytepos
;
2193 INC_BOTH (from
, from_byte
);
2194 UPDATE_SYNTAX_TABLE_FORWARD (from
);
2200 if (from
!= stop
&& c
== FETCH_CHAR (from_byte
))
2202 INC_BOTH (from
, from_byte
);
2212 if (!++depth
) goto done
;
2217 if (!--depth
) goto done
;
2218 if (depth
< min_depth
)
2219 Fsignal (Qscan_error
,
2220 Fcons (build_string ("Containing expression ends prematurely"),
2221 Fcons (make_number (last_good
),
2222 Fcons (make_number (from
), Qnil
))));
2227 temp_pos
= dec_bytepos (from_byte
);
2228 stringterm
= FETCH_CHAR (temp_pos
);
2231 if (from
>= stop
) goto lose
;
2232 UPDATE_SYNTAX_TABLE_FORWARD (from
);
2233 c
= FETCH_CHAR (from_byte
);
2236 && SYNTAX_WITH_MULTIBYTE_CHECK (c
) == Sstring
)
2237 : SYNTAX_WITH_MULTIBYTE_CHECK (c
) == Sstring_fence
)
2240 /* Some compilers can't handle this inside the switch. */
2241 temp
= SYNTAX_WITH_MULTIBYTE_CHECK (c
);
2246 INC_BOTH (from
, from_byte
);
2248 INC_BOTH (from
, from_byte
);
2250 INC_BOTH (from
, from_byte
);
2251 if (!depth
&& sexpflag
) goto done
;
2254 /* Ignore whitespace, punctuation, quote, endcomment. */
2259 /* Reached end of buffer. Error if within object, return nil if between */
2260 if (depth
) goto lose
;
2265 /* End of object reached */
2274 DEC_BOTH (from
, from_byte
);
2275 UPDATE_SYNTAX_TABLE_BACKWARD (from
);
2276 c
= FETCH_CHAR (from_byte
);
2277 code
= SYNTAX_WITH_MULTIBYTE_CHECK (c
);
2278 if (depth
== min_depth
)
2281 comnested
= SYNTAX_COMMENT_NESTED (c
);
2282 if (code
== Sendcomment
)
2283 comstyle
= SYNTAX_COMMENT_STYLE (c
);
2284 if (from
> stop
&& SYNTAX_COMEND_SECOND (c
)
2285 && prev_char_comend_first (from
, from_byte
)
2286 && parse_sexp_ignore_comments
)
2288 /* We must record the comment style encountered so that
2289 later, we can match only the proper comment begin
2290 sequence of the same style. */
2291 DEC_BOTH (from
, from_byte
);
2292 UPDATE_SYNTAX_TABLE_BACKWARD (from
);
2294 c1
= FETCH_CHAR (from_byte
);
2295 comstyle
= SYNTAX_COMMENT_STYLE (c1
);
2296 comnested
= comnested
|| SYNTAX_COMMENT_NESTED (c1
);
2299 /* Quoting turns anything except a comment-ender
2300 into a word character. Note that this cannot be true
2301 if we decremented FROM in the if-statement above. */
2302 if (code
!= Sendcomment
&& char_quoted (from
, from_byte
))
2304 DEC_BOTH (from
, from_byte
);
2307 else if (SYNTAX_PREFIX (c
))
2310 switch (SWITCH_ENUM_CAST (code
))
2316 if (depth
|| !sexpflag
) break;
2317 /* This word counts as a sexp; count object finished
2318 after passing it. */
2321 temp_pos
= from_byte
;
2322 if (! NILP (current_buffer
->enable_multibyte_characters
))
2326 UPDATE_SYNTAX_TABLE_BACKWARD (from
- 1);
2327 c1
= FETCH_CHAR (temp_pos
);
2328 temp_code
= SYNTAX_WITH_MULTIBYTE_CHECK (c1
);
2329 /* Don't allow comment-end to be quoted. */
2330 if (temp_code
== Sendcomment
)
2332 quoted
= char_quoted (from
- 1, temp_pos
);
2335 DEC_BOTH (from
, from_byte
);
2336 temp_pos
= dec_bytepos (temp_pos
);
2337 UPDATE_SYNTAX_TABLE_BACKWARD (from
- 1);
2339 c1
= FETCH_CHAR (temp_pos
);
2340 temp_code
= SYNTAX_WITH_MULTIBYTE_CHECK (c1
);
2341 if (! (quoted
|| temp_code
== Sword
2342 || temp_code
== Ssymbol
2343 || temp_code
== Squote
))
2345 DEC_BOTH (from
, from_byte
);
2352 temp_pos
= dec_bytepos (from_byte
);
2353 UPDATE_SYNTAX_TABLE_BACKWARD (from
- 1);
2354 if (from
!= stop
&& c
== FETCH_CHAR (temp_pos
))
2355 DEC_BOTH (from
, from_byte
);
2364 if (!++depth
) goto done2
;
2369 if (!--depth
) goto done2
;
2370 if (depth
< min_depth
)
2371 Fsignal (Qscan_error
,
2372 Fcons (build_string ("Containing expression ends prematurely"),
2373 Fcons (make_number (last_good
),
2374 Fcons (make_number (from
), Qnil
))));
2378 if (!parse_sexp_ignore_comments
)
2380 found
= back_comment (from
, from_byte
, stop
, comnested
, comstyle
,
2381 &out_charpos
, &out_bytepos
);
2382 /* FIXME: if found == -1, then it really wasn't a comment-end.
2383 For single-char Sendcomment, we can't do much about it apart
2384 from skipping the char.
2385 For 2-char endcomments, we could try again, taking both
2386 chars as separate entities, but it's a lot of trouble
2387 for very little gain, so we don't bother either. -sm */
2389 from
= out_charpos
, from_byte
= out_bytepos
;
2392 case Scomment_fence
:
2396 DEC_BOTH (from
, from_byte
);
2397 if (from
== stop
) goto lose
;
2398 UPDATE_SYNTAX_TABLE_BACKWARD (from
);
2399 if (!char_quoted (from
, from_byte
)
2400 && (c
= FETCH_CHAR (from_byte
),
2401 SYNTAX_WITH_MULTIBYTE_CHECK (c
) == code
))
2404 if (code
== Sstring_fence
&& !depth
&& sexpflag
) goto done2
;
2408 stringterm
= FETCH_CHAR (from_byte
);
2411 if (from
== stop
) goto lose
;
2412 temp_pos
= from_byte
;
2413 if (! NILP (current_buffer
->enable_multibyte_characters
))
2417 UPDATE_SYNTAX_TABLE_BACKWARD (from
- 1);
2418 if (!char_quoted (from
- 1, temp_pos
)
2419 && stringterm
== (c
= FETCH_CHAR (temp_pos
))
2420 && SYNTAX_WITH_MULTIBYTE_CHECK (c
) == Sstring
)
2422 DEC_BOTH (from
, from_byte
);
2424 DEC_BOTH (from
, from_byte
);
2425 if (!depth
&& sexpflag
) goto done2
;
2428 /* Ignore whitespace, punctuation, quote, endcomment. */
2433 /* Reached start of buffer. Error if within object, return nil if between */
2434 if (depth
) goto lose
;
2445 XSETFASTINT (val
, from
);
2449 Fsignal (Qscan_error
,
2450 Fcons (build_string ("Unbalanced parentheses"),
2451 Fcons (make_number (last_good
),
2452 Fcons (make_number (from
), Qnil
))));
2457 DEFUN ("scan-lists", Fscan_lists
, Sscan_lists
, 3, 3, 0,
2458 doc
: /* Scan from character number FROM by COUNT lists.
2459 Returns the character number of the position thus found.
2461 If DEPTH is nonzero, paren depth begins counting from that value,
2462 only places where the depth in parentheses becomes zero
2463 are candidates for stopping; COUNT such places are counted.
2464 Thus, a positive value for DEPTH means go out levels.
2466 Comments are ignored if `parse-sexp-ignore-comments' is non-nil.
2468 If the beginning or end of (the accessible part of) the buffer is reached
2469 and the depth is wrong, an error is signaled.
2470 If the depth is right but the count is not used up, nil is returned. */)
2471 (from
, count
, depth
)
2472 Lisp_Object from
, count
, depth
;
2474 CHECK_NUMBER (from
);
2475 CHECK_NUMBER (count
);
2476 CHECK_NUMBER (depth
);
2478 return scan_lists (XINT (from
), XINT (count
), XINT (depth
), 0);
2481 DEFUN ("scan-sexps", Fscan_sexps
, Sscan_sexps
, 2, 2, 0,
2482 doc
: /* Scan from character number FROM by COUNT balanced expressions.
2483 If COUNT is negative, scan backwards.
2484 Returns the character number of the position thus found.
2486 Comments are ignored if `parse-sexp-ignore-comments' is non-nil.
2488 If the beginning or end of (the accessible part of) the buffer is reached
2489 in the middle of a parenthetical grouping, an error is signaled.
2490 If the beginning or end is reached between groupings
2491 but before count is used up, nil is returned. */)
2493 Lisp_Object from
, count
;
2495 CHECK_NUMBER (from
);
2496 CHECK_NUMBER (count
);
2498 return scan_lists (XINT (from
), XINT (count
), 0, 1);
2501 DEFUN ("backward-prefix-chars", Fbackward_prefix_chars
, Sbackward_prefix_chars
,
2503 doc
: /* Move point backward over any number of chars with prefix syntax.
2504 This includes chars with "quote" or "prefix" syntax (' or p). */)
2509 int opoint_byte
= PT_BYTE
;
2511 int pos_byte
= PT_BYTE
;
2516 SET_PT_BOTH (opoint
, opoint_byte
);
2521 SETUP_SYNTAX_TABLE (pos
, -1);
2523 DEC_BOTH (pos
, pos_byte
);
2525 while (!char_quoted (pos
, pos_byte
)
2526 /* Previous statement updates syntax table. */
2527 && ((c
= FETCH_CHAR (pos_byte
), SYNTAX (c
) == Squote
)
2528 || SYNTAX_PREFIX (c
)))
2531 opoint_byte
= pos_byte
;
2534 DEC_BOTH (pos
, pos_byte
);
2537 SET_PT_BOTH (opoint
, opoint_byte
);
2542 /* Parse forward from FROM / FROM_BYTE to END,
2543 assuming that FROM has state OLDSTATE (nil means FROM is start of function),
2544 and return a description of the state of the parse at END.
2545 If STOPBEFORE is nonzero, stop at the start of an atom.
2546 If COMMENTSTOP is 1, stop at the start of a comment.
2547 If COMMENTSTOP is -1, stop at the start or end of a comment,
2548 after the beginning of a string, or after the end of a string. */
2551 scan_sexps_forward (stateptr
, from
, from_byte
, end
, targetdepth
,
2552 stopbefore
, oldstate
, commentstop
)
2553 struct lisp_parse_state
*stateptr
;
2555 int end
, targetdepth
, stopbefore
, from_byte
;
2556 Lisp_Object oldstate
;
2559 struct lisp_parse_state state
;
2561 register enum syntaxcode code
;
2564 struct level
{ int last
, prev
; };
2565 struct level levelstart
[100];
2566 register struct level
*curlevel
= levelstart
;
2567 struct level
*endlevel
= levelstart
+ 100;
2568 register int depth
; /* Paren depth of current scanning location.
2569 level - levelstart equals this except
2570 when the depth becomes negative. */
2571 int mindepth
; /* Lowest DEPTH value seen. */
2572 int start_quoted
= 0; /* Nonzero means starting after a char quote */
2574 int prev_from
; /* Keep one character before FROM. */
2576 int prev_from_syntax
;
2577 int boundary_stop
= commentstop
== -1;
2580 int out_bytepos
, out_charpos
;
2584 prev_from_byte
= from_byte
;
2586 DEC_BOTH (prev_from
, prev_from_byte
);
2588 /* Use this macro instead of `from++'. */
2590 do { prev_from = from; \
2591 prev_from_byte = from_byte; \
2593 = SYNTAX_WITH_FLAGS (FETCH_CHAR (prev_from_byte)); \
2594 INC_BOTH (from, from_byte); \
2596 UPDATE_SYNTAX_TABLE_FORWARD (from); \
2602 if (NILP (oldstate
))
2605 state
.instring
= -1;
2606 state
.incomment
= 0;
2607 state
.comstyle
= 0; /* comment style a by default. */
2608 state
.comstr_start
= -1; /* no comment/string seen. */
2612 tem
= Fcar (oldstate
);
2618 oldstate
= Fcdr (oldstate
);
2619 oldstate
= Fcdr (oldstate
);
2620 oldstate
= Fcdr (oldstate
);
2621 tem
= Fcar (oldstate
);
2622 /* Check whether we are inside string_fence-style string: */
2623 state
.instring
= (!NILP (tem
)
2624 ? (INTEGERP (tem
) ? XINT (tem
) : ST_STRING_STYLE
)
2627 oldstate
= Fcdr (oldstate
);
2628 tem
= Fcar (oldstate
);
2629 state
.incomment
= (!NILP (tem
)
2630 ? (INTEGERP (tem
) ? XINT (tem
) : -1)
2633 oldstate
= Fcdr (oldstate
);
2634 tem
= Fcar (oldstate
);
2635 start_quoted
= !NILP (tem
);
2637 /* if the eighth element of the list is nil, we are in comment
2638 style a. If it is non-nil, we are in comment style b */
2639 oldstate
= Fcdr (oldstate
);
2640 oldstate
= Fcdr (oldstate
);
2641 tem
= Fcar (oldstate
);
2642 state
.comstyle
= NILP (tem
) ? 0 : (EQ (tem
, Qsyntax_table
)
2643 ? ST_COMMENT_STYLE
: 1);
2645 oldstate
= Fcdr (oldstate
);
2646 tem
= Fcar (oldstate
);
2647 state
.comstr_start
= NILP (tem
) ? -1 : XINT (tem
) ;
2648 oldstate
= Fcdr (oldstate
);
2649 tem
= Fcar (oldstate
);
2650 while (!NILP (tem
)) /* >= second enclosing sexps. */
2652 /* curlevel++->last ran into compiler bug on Apollo */
2653 curlevel
->last
= XINT (Fcar (tem
));
2654 if (++curlevel
== endlevel
)
2655 curlevel
--; /* error ("Nesting too deep for parser"); */
2656 curlevel
->prev
= -1;
2657 curlevel
->last
= -1;
2664 curlevel
->prev
= -1;
2665 curlevel
->last
= -1;
2667 SETUP_SYNTAX_TABLE (prev_from
, 1);
2668 prev_from_syntax
= SYNTAX_WITH_FLAGS (FETCH_CHAR (prev_from_byte
));
2669 UPDATE_SYNTAX_TABLE_FORWARD (from
);
2671 /* Enter the loop at a place appropriate for initial state. */
2673 if (state
.incomment
)
2674 goto startincomment
;
2675 if (state
.instring
>= 0)
2677 nofence
= state
.instring
!= ST_STRING_STYLE
;
2679 goto startquotedinstring
;
2682 else if (start_quoted
)
2688 code
= prev_from_syntax
& 0xff;
2690 if (code
== Scomment
)
2692 state
.comstyle
= SYNTAX_FLAGS_COMMENT_STYLE (prev_from_syntax
);
2693 state
.incomment
= (SYNTAX_FLAGS_COMMENT_NESTED (prev_from_syntax
) ?
2695 state
.comstr_start
= prev_from
;
2697 else if (code
== Scomment_fence
)
2699 /* Record the comment style we have entered so that only
2700 the comment-end sequence of the same style actually
2701 terminates the comment section. */
2702 state
.comstyle
= ST_COMMENT_STYLE
;
2703 state
.incomment
= -1;
2704 state
.comstr_start
= prev_from
;
2707 else if (from
< end
)
2708 if (SYNTAX_FLAGS_COMSTART_FIRST (prev_from_syntax
))
2709 if (c1
= FETCH_CHAR (from_byte
),
2710 SYNTAX_COMSTART_SECOND (c1
))
2711 /* Duplicate code to avoid a complex if-expression
2712 which causes trouble for the SGI compiler. */
2714 /* Record the comment style we have entered so that only
2715 the comment-end sequence of the same style actually
2716 terminates the comment section. */
2717 state
.comstyle
= SYNTAX_COMMENT_STYLE (c1
);
2718 comnested
= SYNTAX_FLAGS_COMMENT_NESTED (prev_from_syntax
);
2719 comnested
= comnested
|| SYNTAX_COMMENT_NESTED (c1
);
2720 state
.incomment
= comnested
? 1 : -1;
2721 state
.comstr_start
= prev_from
;
2726 if (SYNTAX_FLAGS_PREFIX (prev_from_syntax
))
2728 switch (SWITCH_ENUM_CAST (code
))
2732 if (stopbefore
) goto stop
; /* this arg means stop at sexp start */
2733 curlevel
->last
= prev_from
;
2735 if (from
== end
) goto endquoted
;
2738 /* treat following character as a word constituent */
2741 if (stopbefore
) goto stop
; /* this arg means stop at sexp start */
2742 curlevel
->last
= prev_from
;
2746 /* Some compilers can't handle this inside the switch. */
2747 temp
= SYNTAX (FETCH_CHAR (from_byte
));
2753 if (from
== end
) goto endquoted
;
2765 curlevel
->prev
= curlevel
->last
;
2768 case Scomment_fence
: /* Can't happen because it's handled above. */
2770 if (commentstop
|| boundary_stop
) goto done
;
2772 /* The (from == BEGV) test was to enter the loop in the middle so
2773 that we find a 2-char comment ender even if we start in the
2774 middle of it. We don't want to do that if we're just at the
2775 beginning of the comment (think of (*) ... (*)). */
2776 found
= forw_comment (from
, from_byte
, end
,
2777 state
.incomment
, state
.comstyle
,
2778 (from
== BEGV
|| from
< state
.comstr_start
+ 3)
2779 ? 0 : prev_from_syntax
,
2780 &out_charpos
, &out_bytepos
, &state
.incomment
);
2781 from
= out_charpos
; from_byte
= out_bytepos
;
2782 /* Beware! prev_from and friends are invalid now.
2783 Luckily, the `done' doesn't use them and the INC_FROM
2784 sets them to a sane value without looking at them. */
2785 if (!found
) goto done
;
2787 state
.incomment
= 0;
2788 state
.comstyle
= 0; /* reset the comment style */
2789 if (boundary_stop
) goto done
;
2793 if (stopbefore
) goto stop
; /* this arg means stop at sexp start */
2795 /* curlevel++->last ran into compiler bug on Apollo */
2796 curlevel
->last
= prev_from
;
2797 if (++curlevel
== endlevel
)
2798 curlevel
--; /* error ("Nesting too deep for parser"); */
2799 curlevel
->prev
= -1;
2800 curlevel
->last
= -1;
2801 if (targetdepth
== depth
) goto done
;
2806 if (depth
< mindepth
)
2808 if (curlevel
!= levelstart
)
2810 curlevel
->prev
= curlevel
->last
;
2811 if (targetdepth
== depth
) goto done
;
2816 state
.comstr_start
= from
- 1;
2817 if (stopbefore
) goto stop
; /* this arg means stop at sexp start */
2818 curlevel
->last
= prev_from
;
2819 state
.instring
= (code
== Sstring
2820 ? (FETCH_CHAR (prev_from_byte
))
2822 if (boundary_stop
) goto done
;
2825 nofence
= state
.instring
!= ST_STRING_STYLE
;
2831 if (from
>= end
) goto done
;
2832 c
= FETCH_CHAR (from_byte
);
2833 /* Some compilers can't handle this inside the switch. */
2836 /* Check TEMP here so that if the char has
2837 a syntax-table property which says it is NOT
2838 a string character, it does not end the string. */
2839 if (nofence
&& c
== state
.instring
&& temp
== Sstring
)
2845 if (!nofence
) goto string_end
;
2850 startquotedinstring
:
2851 if (from
>= end
) goto endquoted
;
2857 state
.instring
= -1;
2858 curlevel
->prev
= curlevel
->last
;
2860 if (boundary_stop
) goto done
;
2864 /* FIXME: We should do something with it. */
2867 /* Ignore whitespace, punctuation, quote, endcomment. */
2873 stop
: /* Here if stopping before start of sexp. */
2874 from
= prev_from
; /* We have just fetched the char that starts it; */
2875 goto done
; /* but return the position before it. */
2880 state
.depth
= depth
;
2881 state
.mindepth
= mindepth
;
2882 state
.thislevelstart
= curlevel
->prev
;
2883 state
.prevlevelstart
2884 = (curlevel
== levelstart
) ? -1 : (curlevel
- 1)->last
;
2885 state
.location
= from
;
2886 state
.levelstarts
= Qnil
;
2887 while (--curlevel
>= levelstart
)
2888 state
.levelstarts
= Fcons (make_number (curlevel
->last
),
2895 DEFUN ("parse-partial-sexp", Fparse_partial_sexp
, Sparse_partial_sexp
, 2, 6, 0,
2896 doc
: /* Parse Lisp syntax starting at FROM until TO; return status of parse at TO.
2897 Parsing stops at TO or when certain criteria are met;
2898 point is set to where parsing stops.
2899 If fifth arg OLDSTATE is omitted or nil,
2900 parsing assumes that FROM is the beginning of a function.
2901 Value is a list of ten elements describing final state of parsing:
2903 1. character address of start of innermost containing list; nil if none.
2904 2. character address of start of last complete sexp terminated.
2905 3. non-nil if inside a string.
2906 (it is the character that will terminate the string,
2907 or t if the string should be terminated by a generic string delimiter.)
2908 4. nil if outside a comment, t if inside a non-nestable comment,
2909 else an integer (the current comment nesting).
2910 5. t if following a quote character.
2911 6. the minimum paren-depth encountered during this scan.
2912 7. t if in a comment of style b; symbol `syntax-table' if the comment
2913 should be terminated by a generic comment delimiter.
2914 8. character address of start of comment or string; nil if not in one.
2915 9. Intermediate data for continuation of parsing (subject to change).
2916 If third arg TARGETDEPTH is non-nil, parsing stops if the depth
2917 in parentheses becomes equal to TARGETDEPTH.
2918 Fourth arg STOPBEFORE non-nil means stop when come to
2919 any character that starts a sexp.
2920 Fifth arg OLDSTATE is a nine-element list like what this function returns.
2921 It is used to initialize the state of the parse. Elements number 1, 2, 6
2922 and 8 are ignored; you can leave off element 8 (the last) entirely.
2923 Sixth arg COMMENTSTOP non-nil means stop at the start of a comment.
2924 If it is symbol `syntax-table', stop after the start of a comment or a
2925 string, or after end of a comment or a string. */)
2926 (from
, to
, targetdepth
, stopbefore
, oldstate
, commentstop
)
2927 Lisp_Object from
, to
, targetdepth
, stopbefore
, oldstate
, commentstop
;
2929 struct lisp_parse_state state
;
2932 if (!NILP (targetdepth
))
2934 CHECK_NUMBER (targetdepth
);
2935 target
= XINT (targetdepth
);
2938 target
= -100000; /* We won't reach this depth */
2940 validate_region (&from
, &to
);
2941 scan_sexps_forward (&state
, XINT (from
), CHAR_TO_BYTE (XINT (from
)),
2943 target
, !NILP (stopbefore
), oldstate
,
2945 ? 0 : (EQ (commentstop
, Qsyntax_table
) ? -1 : 1)));
2947 SET_PT (state
.location
);
2949 return Fcons (make_number (state
.depth
),
2950 Fcons (state
.prevlevelstart
< 0 ? Qnil
: make_number (state
.prevlevelstart
),
2951 Fcons (state
.thislevelstart
< 0 ? Qnil
: make_number (state
.thislevelstart
),
2952 Fcons (state
.instring
>= 0
2953 ? (state
.instring
== ST_STRING_STYLE
2954 ? Qt
: make_number (state
.instring
)) : Qnil
,
2955 Fcons (state
.incomment
< 0 ? Qt
:
2956 (state
.incomment
== 0 ? Qnil
:
2957 make_number (state
.incomment
)),
2958 Fcons (state
.quoted
? Qt
: Qnil
,
2959 Fcons (make_number (state
.mindepth
),
2960 Fcons ((state
.comstyle
2961 ? (state
.comstyle
== ST_COMMENT_STYLE
2962 ? Qsyntax_table
: Qt
) :
2964 Fcons (((state
.incomment
2965 || (state
.instring
>= 0))
2966 ? make_number (state
.comstr_start
)
2968 Fcons (state
.levelstarts
, Qnil
))))))))));
2977 /* This has to be done here, before we call Fmake_char_table. */
2978 Qsyntax_table
= intern ("syntax-table");
2979 staticpro (&Qsyntax_table
);
2981 /* Intern this now in case it isn't already done.
2982 Setting this variable twice is harmless.
2983 But don't staticpro it here--that is done in alloc.c. */
2984 Qchar_table_extra_slots
= intern ("char-table-extra-slots");
2986 /* Create objects which can be shared among syntax tables. */
2987 Vsyntax_code_object
= Fmake_vector (make_number (Smax
), Qnil
);
2988 for (i
= 0; i
< XVECTOR (Vsyntax_code_object
)->size
; i
++)
2989 XVECTOR (Vsyntax_code_object
)->contents
[i
]
2990 = Fcons (make_number (i
), Qnil
);
2992 /* Now we are ready to set up this property, so we can
2993 create syntax tables. */
2994 Fput (Qsyntax_table
, Qchar_table_extra_slots
, make_number (0));
2996 temp
= XVECTOR (Vsyntax_code_object
)->contents
[(int) Swhitespace
];
2998 Vstandard_syntax_table
= Fmake_char_table (Qsyntax_table
, temp
);
3000 temp
= XVECTOR (Vsyntax_code_object
)->contents
[(int) Sword
];
3001 for (i
= 'a'; i
<= 'z'; i
++)
3002 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, i
, temp
);
3003 for (i
= 'A'; i
<= 'Z'; i
++)
3004 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, i
, temp
);
3005 for (i
= '0'; i
<= '9'; i
++)
3006 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, i
, temp
);
3008 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, '$', temp
);
3009 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, '%', temp
);
3011 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, '(',
3012 Fcons (make_number (Sopen
), make_number (')')));
3013 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, ')',
3014 Fcons (make_number (Sclose
), make_number ('(')));
3015 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, '[',
3016 Fcons (make_number (Sopen
), make_number (']')));
3017 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, ']',
3018 Fcons (make_number (Sclose
), make_number ('[')));
3019 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, '{',
3020 Fcons (make_number (Sopen
), make_number ('}')));
3021 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, '}',
3022 Fcons (make_number (Sclose
), make_number ('{')));
3023 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, '"',
3024 Fcons (make_number ((int) Sstring
), Qnil
));
3025 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, '\\',
3026 Fcons (make_number ((int) Sescape
), Qnil
));
3028 temp
= XVECTOR (Vsyntax_code_object
)->contents
[(int) Ssymbol
];
3029 for (i
= 0; i
< 10; i
++)
3031 c
= "_-+*/&|<>="[i
];
3032 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, c
, temp
);
3035 temp
= XVECTOR (Vsyntax_code_object
)->contents
[(int) Spunct
];
3036 for (i
= 0; i
< 12; i
++)
3038 c
= ".,;:?!#@~^'`"[i
];
3039 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, c
, temp
);
3042 /* All multibyte characters have syntax `word' by default. */
3043 temp
= XVECTOR (Vsyntax_code_object
)->contents
[(int) Sword
];
3044 for (i
= CHAR_TABLE_SINGLE_BYTE_SLOTS
; i
< CHAR_TABLE_ORDINARY_SLOTS
; i
++)
3045 XCHAR_TABLE (Vstandard_syntax_table
)->contents
[i
] = temp
;
3051 Qsyntax_table_p
= intern ("syntax-table-p");
3052 staticpro (&Qsyntax_table_p
);
3054 staticpro (&Vsyntax_code_object
);
3056 Qscan_error
= intern ("scan-error");
3057 staticpro (&Qscan_error
);
3058 Fput (Qscan_error
, Qerror_conditions
,
3059 Fcons (Qscan_error
, Fcons (Qerror
, Qnil
)));
3060 Fput (Qscan_error
, Qerror_message
,
3061 build_string ("Scan error"));
3063 DEFVAR_BOOL ("parse-sexp-ignore-comments", &parse_sexp_ignore_comments
,
3064 doc
: /* Non-nil means `forward-sexp', etc., should treat comments as whitespace. */);
3066 DEFVAR_BOOL ("parse-sexp-lookup-properties", &parse_sexp_lookup_properties
,
3067 doc
: /* Non-nil means `forward-sexp', etc., obey `syntax-table' property.
3068 Otherwise, that text property is simply ignored.
3069 See the info node `(elisp)Syntax Properties' for a description of the
3070 `syntax-table' property. */);
3072 words_include_escapes
= 0;
3073 DEFVAR_BOOL ("words-include-escapes", &words_include_escapes
,
3074 doc
: /* Non-nil means `forward-word', etc., should treat escape chars part of words. */);
3076 DEFVAR_BOOL ("multibyte-syntax-as-symbol", &multibyte_syntax_as_symbol
,
3077 doc
: /* Non-nil means `scan-sexps' treats all multibyte characters as symbol. */);
3078 multibyte_syntax_as_symbol
= 0;
3080 DEFVAR_BOOL ("open-paren-in-column-0-is-defun-start",
3081 &open_paren_in_column_0_is_defun_start
,
3082 doc
: /* *Non-nil means an open paren in column 0 denotes the start of a defun. */);
3083 open_paren_in_column_0_is_defun_start
= 1;
3085 defsubr (&Ssyntax_table_p
);
3086 defsubr (&Ssyntax_table
);
3087 defsubr (&Sstandard_syntax_table
);
3088 defsubr (&Scopy_syntax_table
);
3089 defsubr (&Sset_syntax_table
);
3090 defsubr (&Schar_syntax
);
3091 defsubr (&Smatching_paren
);
3092 defsubr (&Sstring_to_syntax
);
3093 defsubr (&Smodify_syntax_entry
);
3094 defsubr (&Sinternal_describe_syntax_value
);
3096 defsubr (&Sforward_word
);
3098 defsubr (&Sskip_chars_forward
);
3099 defsubr (&Sskip_chars_backward
);
3100 defsubr (&Sskip_syntax_forward
);
3101 defsubr (&Sskip_syntax_backward
);
3103 defsubr (&Sforward_comment
);
3104 defsubr (&Sscan_lists
);
3105 defsubr (&Sscan_sexps
);
3106 defsubr (&Sbackward_prefix_chars
);
3107 defsubr (&Sparse_partial_sexp
);