1 /* GNU Emacs routines to deal with syntax tables; also word and list parsing.
2 Copyright (C) 1985, 1987, 1993, 1994, 1995, 1997, 1998, 1999, 2002,
3 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
32 /* Make syntax table lookup grant data in gl_state. */
33 #define SYNTAX_ENTRY_VIA_PROPERTY
36 #include "intervals.h"
38 /* We use these constants in place for comment-style and
39 string-ender-char to distinguish comments/strings started by
40 comment_fence and string_fence codes. */
42 #define ST_COMMENT_STYLE (256 + 1)
43 #define ST_STRING_STYLE (256 + 2)
46 Lisp_Object Qsyntax_table_p
, Qsyntax_table
, Qscan_error
;
48 int words_include_escapes
;
49 int parse_sexp_lookup_properties
;
51 /* Nonzero means `scan-sexps' treat all multibyte characters as symbol. */
52 int multibyte_syntax_as_symbol
;
54 /* Used as a temporary in SYNTAX_ENTRY and other macros in syntax.h,
55 if not compiled with GCC. No need to mark it, since it is used
56 only very temporarily. */
57 Lisp_Object syntax_temp
;
59 /* Non-zero means an open parenthesis in column 0 is always considered
60 to be the start of a defun. Zero means an open parenthesis in
61 column 0 has no special meaning. */
63 int open_paren_in_column_0_is_defun_start
;
65 /* This is the internal form of the parse state used in parse-partial-sexp. */
67 struct lisp_parse_state
69 int depth
; /* Depth at end of parsing. */
70 int instring
; /* -1 if not within string, else desired terminator. */
71 int incomment
; /* -1 if in unnestable comment else comment nesting */
72 int comstyle
; /* comment style a=0, or b=1, or ST_COMMENT_STYLE. */
73 int quoted
; /* Nonzero if just after an escape char at end of parsing */
74 int thislevelstart
; /* Char number of most recent start-of-expression at current level */
75 int prevlevelstart
; /* Char number of start of containing expression */
76 int location
; /* Char number at which parsing stopped. */
77 int mindepth
; /* Minimum depth seen while scanning. */
78 int comstr_start
; /* Position just after last comment/string starter. */
79 Lisp_Object levelstarts
; /* Char numbers of starts-of-expression
80 of levels (starting from outermost). */
83 /* These variables are a cache for finding the start of a defun.
84 find_start_pos is the place for which the defun start was found.
85 find_start_value is the defun start position found for it.
86 find_start_value_byte is the corresponding byte position.
87 find_start_buffer is the buffer it was found in.
88 find_start_begv is the BEGV value when it was found.
89 find_start_modiff is the value of MODIFF when it was found. */
91 static int find_start_pos
;
92 static int find_start_value
;
93 static int find_start_value_byte
;
94 static struct buffer
*find_start_buffer
;
95 static int find_start_begv
;
96 static int find_start_modiff
;
99 static int find_defun_start
P_ ((int, int));
100 static int back_comment
P_ ((int, int, int, int, int, int *, int *));
101 static int char_quoted
P_ ((int, int));
102 static Lisp_Object skip_chars
P_ ((int, int, Lisp_Object
, Lisp_Object
, int));
103 static Lisp_Object scan_lists
P_ ((int, int, int, int));
104 static void scan_sexps_forward
P_ ((struct lisp_parse_state
*,
106 int, Lisp_Object
, int));
107 static int in_classes
P_ ((int, Lisp_Object
));
110 struct gl_state_s gl_state
; /* Global state of syntax parser. */
112 INTERVAL
interval_of ();
113 #define INTERVALS_AT_ONCE 10 /* 1 + max-number of intervals
114 to scan to property-change. */
116 /* Update gl_state to an appropriate interval which contains CHARPOS. The
117 sign of COUNT give the relative position of CHARPOS wrt the previously
118 valid interval. If INIT, only [be]_property fields of gl_state are
119 valid at start, the rest is filled basing on OBJECT.
121 `gl_state.*_i' are the intervals, and CHARPOS is further in the search
122 direction than the intervals - or in an interval. We update the
123 current syntax-table basing on the property of this interval, and
124 update the interval to start further than CHARPOS - or be
125 NULL_INTERVAL. We also update lim_property to be the next value of
126 charpos to call this subroutine again - or be before/after the
127 start/end of OBJECT. */
130 update_syntax_table (charpos
, count
, init
, object
)
131 int charpos
, count
, init
;
134 Lisp_Object tmp_table
;
135 int cnt
= 0, invalidate
= 1;
140 gl_state
.old_prop
= Qnil
;
141 gl_state
.start
= gl_state
.b_property
;
142 gl_state
.stop
= gl_state
.e_property
;
143 i
= interval_of (charpos
, object
);
144 gl_state
.backward_i
= gl_state
.forward_i
= i
;
146 if (NULL_INTERVAL_P (i
))
148 /* interval_of updates only ->position of the return value, so
149 update the parents manually to speed up update_interval. */
150 while (!NULL_PARENT (i
))
152 if (AM_RIGHT_CHILD (i
))
153 INTERVAL_PARENT (i
)->position
= i
->position
154 - LEFT_TOTAL_LENGTH (i
) + TOTAL_LENGTH (i
) /* right end */
155 - TOTAL_LENGTH (INTERVAL_PARENT (i
))
156 + LEFT_TOTAL_LENGTH (INTERVAL_PARENT (i
));
158 INTERVAL_PARENT (i
)->position
= i
->position
- LEFT_TOTAL_LENGTH (i
)
160 i
= INTERVAL_PARENT (i
);
162 i
= gl_state
.forward_i
;
163 gl_state
.b_property
= i
->position
- gl_state
.offset
;
164 gl_state
.e_property
= INTERVAL_LAST_POS (i
) - gl_state
.offset
;
167 i
= count
> 0 ? gl_state
.forward_i
: gl_state
.backward_i
;
169 /* We are guaranteed to be called with CHARPOS either in i,
171 if (NULL_INTERVAL_P (i
))
172 error ("Error in syntax_table logic for to-the-end intervals");
173 else if (charpos
< i
->position
) /* Move left. */
176 error ("Error in syntax_table logic for intervals <-");
177 /* Update the interval. */
178 i
= update_interval (i
, charpos
);
179 if (INTERVAL_LAST_POS (i
) != gl_state
.b_property
)
182 gl_state
.forward_i
= i
;
183 gl_state
.e_property
= INTERVAL_LAST_POS (i
) - gl_state
.offset
;
186 else if (charpos
>= INTERVAL_LAST_POS (i
)) /* Move right. */
189 error ("Error in syntax_table logic for intervals ->");
190 /* Update the interval. */
191 i
= update_interval (i
, charpos
);
192 if (i
->position
!= gl_state
.e_property
)
195 gl_state
.backward_i
= i
;
196 gl_state
.b_property
= i
->position
- gl_state
.offset
;
201 tmp_table
= textget (i
->plist
, Qsyntax_table
);
204 invalidate
= !EQ (tmp_table
, gl_state
.old_prop
); /* Need to invalidate? */
206 if (invalidate
) /* Did not get to adjacent interval. */
207 { /* with the same table => */
208 /* invalidate the old range. */
211 gl_state
.backward_i
= i
;
212 gl_state
.b_property
= i
->position
- gl_state
.offset
;
216 gl_state
.forward_i
= i
;
217 gl_state
.e_property
= INTERVAL_LAST_POS (i
) - gl_state
.offset
;
221 if (!EQ (tmp_table
, gl_state
.old_prop
))
223 gl_state
.current_syntax_table
= tmp_table
;
224 gl_state
.old_prop
= tmp_table
;
225 if (EQ (Fsyntax_table_p (tmp_table
), Qt
))
227 gl_state
.use_global
= 0;
229 else if (CONSP (tmp_table
))
231 gl_state
.use_global
= 1;
232 gl_state
.global_code
= tmp_table
;
236 gl_state
.use_global
= 0;
237 gl_state
.current_syntax_table
= current_buffer
->syntax_table
;
241 while (!NULL_INTERVAL_P (i
))
243 if (cnt
&& !EQ (tmp_table
, textget (i
->plist
, Qsyntax_table
)))
247 gl_state
.e_property
= i
->position
- gl_state
.offset
;
248 gl_state
.forward_i
= i
;
253 = i
->position
+ LENGTH (i
) - gl_state
.offset
;
254 gl_state
.backward_i
= i
;
258 else if (cnt
== INTERVALS_AT_ONCE
)
263 = i
->position
+ LENGTH (i
) - gl_state
.offset
264 /* e_property at EOB is not set to ZV but to ZV+1, so that
265 we can do INC(from);UPDATE_SYNTAX_TABLE_FORWARD without
266 having to check eob between the two. */
267 + (NULL_INTERVAL_P (next_interval (i
)) ? 1 : 0);
268 gl_state
.forward_i
= i
;
272 gl_state
.b_property
= i
->position
- gl_state
.offset
;
273 gl_state
.backward_i
= i
;
278 i
= count
> 0 ? next_interval (i
) : previous_interval (i
);
280 eassert (NULL_INTERVAL_P (i
)); /* This property goes to the end. */
282 gl_state
.e_property
= gl_state
.stop
;
284 gl_state
.b_property
= gl_state
.start
;
287 /* Returns TRUE if char at CHARPOS is quoted.
288 Global syntax-table data should be set up already to be good at CHARPOS
289 or after. On return global syntax data is good for lookup at CHARPOS. */
292 char_quoted (charpos
, bytepos
)
293 register int charpos
, bytepos
;
295 register enum syntaxcode code
;
296 register int beg
= BEGV
;
297 register int quoted
= 0;
300 DEC_BOTH (charpos
, bytepos
);
302 while (charpos
>= beg
)
306 UPDATE_SYNTAX_TABLE_BACKWARD (charpos
);
307 c
= FETCH_CHAR (bytepos
);
309 if (! (code
== Scharquote
|| code
== Sescape
))
312 DEC_BOTH (charpos
, bytepos
);
316 UPDATE_SYNTAX_TABLE (orig
);
320 /* Return the bytepos one character after BYTEPOS.
321 We assume that BYTEPOS is not at the end of the buffer. */
324 inc_bytepos (bytepos
)
327 if (NILP (current_buffer
->enable_multibyte_characters
))
334 /* Return the bytepos one character before BYTEPOS.
335 We assume that BYTEPOS is not at the start of the buffer. */
338 dec_bytepos (bytepos
)
341 if (NILP (current_buffer
->enable_multibyte_characters
))
348 /* Return a defun-start position before before POS and not too far before.
349 It should be the last one before POS, or nearly the last.
351 When open_paren_in_column_0_is_defun_start is nonzero,
352 only the beginning of the buffer is treated as a defun-start.
354 We record the information about where the scan started
355 and what its result was, so that another call in the same area
356 can return the same value very quickly.
358 There is no promise at which position the global syntax data is
359 valid on return from the subroutine, so the caller should explicitly
360 update the global data. */
363 find_defun_start (pos
, pos_byte
)
366 int opoint
= PT
, opoint_byte
= PT_BYTE
;
368 if (!open_paren_in_column_0_is_defun_start
)
370 find_start_value_byte
= BEGV_BYTE
;
374 /* Use previous finding, if it's valid and applies to this inquiry. */
375 if (current_buffer
== find_start_buffer
376 /* Reuse the defun-start even if POS is a little farther on.
377 POS might be in the next defun, but that's ok.
378 Our value may not be the best possible, but will still be usable. */
379 && pos
<= find_start_pos
+ 1000
380 && pos
>= find_start_value
381 && BEGV
== find_start_begv
382 && MODIFF
== find_start_modiff
)
383 return find_start_value
;
385 /* Back up to start of line. */
386 scan_newline (pos
, pos_byte
, BEGV
, BEGV_BYTE
, -1, 1);
388 /* We optimize syntax-table lookup for rare updates. Thus we accept
389 only those `^\s(' which are good in global _and_ text-property
391 gl_state
.current_syntax_table
= current_buffer
->syntax_table
;
392 gl_state
.use_global
= 0;
397 /* Open-paren at start of line means we may have found our
399 c
= FETCH_CHAR (PT_BYTE
);
400 if (SYNTAX (c
) == Sopen
)
402 SETUP_SYNTAX_TABLE (PT
+ 1, -1); /* Try again... */
403 c
= FETCH_CHAR (PT_BYTE
);
404 if (SYNTAX (c
) == Sopen
)
406 /* Now fallback to the default value. */
407 gl_state
.current_syntax_table
= current_buffer
->syntax_table
;
408 gl_state
.use_global
= 0;
410 /* Move to beg of previous line. */
411 scan_newline (PT
, PT_BYTE
, BEGV
, BEGV_BYTE
, -2, 1);
414 /* Record what we found, for the next try. */
415 find_start_value
= PT
;
416 find_start_value_byte
= PT_BYTE
;
417 find_start_buffer
= current_buffer
;
418 find_start_modiff
= MODIFF
;
419 find_start_begv
= BEGV
;
420 find_start_pos
= pos
;
422 TEMP_SET_PT_BOTH (opoint
, opoint_byte
);
424 return find_start_value
;
427 /* Return the SYNTAX_COMEND_FIRST of the character before POS, POS_BYTE. */
430 prev_char_comend_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_COMEND_FIRST (c
);
439 UPDATE_SYNTAX_TABLE_FORWARD (pos
+ 1);
443 /* Return the SYNTAX_COMSTART_FIRST of the character before POS, POS_BYTE. */
446 * prev_char_comstart_first (pos, pos_byte)
451 * DEC_BOTH (pos, pos_byte);
452 * UPDATE_SYNTAX_TABLE_BACKWARD (pos);
453 * c = FETCH_CHAR (pos_byte);
454 * val = SYNTAX_COMSTART_FIRST (c);
455 * UPDATE_SYNTAX_TABLE_FORWARD (pos + 1);
459 /* Checks whether charpos FROM is at the end of a comment.
460 FROM_BYTE is the bytepos corresponding to FROM.
461 Do not move back before STOP.
463 Return a positive value if we find a comment ending at FROM/FROM_BYTE;
466 If successful, store the charpos of the comment's beginning
467 into *CHARPOS_PTR, and the bytepos into *BYTEPOS_PTR.
469 Global syntax data remains valid for backward search starting at
470 the returned value (or at FROM, if the search was not successful). */
473 back_comment (from
, from_byte
, stop
, comnested
, comstyle
, charpos_ptr
, bytepos_ptr
)
474 int from
, from_byte
, stop
;
475 int comnested
, comstyle
;
476 int *charpos_ptr
, *bytepos_ptr
;
478 /* Look back, counting the parity of string-quotes,
479 and recording the comment-starters seen.
480 When we reach a safe place, assume that's not in a string;
481 then step the main scan to the earliest comment-starter seen
482 an even number of string quotes away from the safe place.
484 OFROM[I] is position of the earliest comment-starter seen
485 which is I+2X quotes from the comment-end.
486 PARITY is current parity of quotes from the comment end. */
487 int string_style
= -1; /* Presumed outside of any string. */
488 int string_lossage
= 0;
489 /* Not a real lossage: indicates that we have passed a matching comment
490 starter plus a non-matching comment-ender, meaning that any matching
491 comment-starter we might see later could be a false positive (hidden
492 inside another comment).
493 Test case: { a (* b } c (* d *) */
494 int comment_lossage
= 0;
495 int comment_end
= from
;
496 int comment_end_byte
= from_byte
;
497 int comstart_pos
= 0;
499 /* Place where the containing defun starts,
500 or 0 if we didn't come across it yet. */
502 int defun_start_byte
= 0;
503 register enum syntaxcode code
;
504 int nesting
= 1; /* current comment nesting */
508 /* FIXME: A }} comment-ender style leads to incorrect behavior
509 in the case of {{ c }}} because we ignore the last two chars which are
510 assumed to be comment-enders although they aren't. */
512 /* At beginning of range to scan, we're outside of strings;
513 that determines quote parity to the comment-end. */
516 int temp_byte
, prev_syntax
;
517 int com2start
, com2end
;
519 /* Move back and examine a character. */
520 DEC_BOTH (from
, from_byte
);
521 UPDATE_SYNTAX_TABLE_BACKWARD (from
);
523 prev_syntax
= syntax
;
524 c
= FETCH_CHAR (from_byte
);
525 syntax
= SYNTAX_WITH_FLAGS (c
);
528 /* Check for 2-char comment markers. */
529 com2start
= (SYNTAX_FLAGS_COMSTART_FIRST (syntax
)
530 && SYNTAX_FLAGS_COMSTART_SECOND (prev_syntax
)
531 && comstyle
== SYNTAX_FLAGS_COMMENT_STYLE (prev_syntax
)
532 && (SYNTAX_FLAGS_COMMENT_NESTED (prev_syntax
)
533 || SYNTAX_FLAGS_COMMENT_NESTED (syntax
)) == comnested
);
534 com2end
= (SYNTAX_FLAGS_COMEND_FIRST (syntax
)
535 && SYNTAX_FLAGS_COMEND_SECOND (prev_syntax
));
537 /* Nasty cases with overlapping 2-char comment markers:
538 - snmp-mode: -- c -- foo -- c --
546 /* If a 2-char comment sequence partly overlaps with another,
547 we don't try to be clever. */
548 if (from
> stop
&& (com2end
|| com2start
))
550 int next
= from
, next_byte
= from_byte
, next_c
, next_syntax
;
551 DEC_BOTH (next
, next_byte
);
552 UPDATE_SYNTAX_TABLE_BACKWARD (next
);
553 next_c
= FETCH_CHAR (next_byte
);
554 next_syntax
= SYNTAX_WITH_FLAGS (next_c
);
555 if (((com2start
|| comnested
)
556 && SYNTAX_FLAGS_COMEND_SECOND (syntax
)
557 && SYNTAX_FLAGS_COMEND_FIRST (next_syntax
))
558 || ((com2end
|| comnested
)
559 && SYNTAX_FLAGS_COMSTART_SECOND (syntax
)
560 && comstyle
== SYNTAX_FLAGS_COMMENT_STYLE (syntax
)
561 && SYNTAX_FLAGS_COMSTART_FIRST (next_syntax
)))
563 /* UPDATE_SYNTAX_TABLE_FORWARD (next + 1); */
566 if (com2start
&& comstart_pos
== 0)
567 /* We're looking at a comment starter. But it might be a comment
568 ender as well (see snmp-mode). The first time we see one, we
569 need to consider it as a comment starter,
570 and the subsequent times as a comment ender. */
573 /* Turn a 2-char comment sequences into the appropriate syntax. */
578 /* Ignore comment starters of a different style. */
579 else if (code
== Scomment
580 && (comstyle
!= SYNTAX_FLAGS_COMMENT_STYLE (syntax
)
581 || SYNTAX_FLAGS_COMMENT_NESTED (syntax
) != comnested
))
584 /* Ignore escaped characters, except comment-enders. */
585 if (code
!= Sendcomment
&& char_quoted (from
, from_byte
))
592 c
= (code
== Sstring_fence
? ST_STRING_STYLE
: ST_COMMENT_STYLE
);
594 /* Track parity of quotes. */
595 if (string_style
== -1)
596 /* Entering a string. */
598 else if (string_style
== c
)
599 /* Leaving the string. */
602 /* If we have two kinds of string delimiters.
603 There's no way to grok this scanning backwards. */
608 /* We've already checked that it is the relevant comstyle. */
609 if (string_style
!= -1 || comment_lossage
|| string_lossage
)
610 /* There are odd string quotes involved, so let's be careful.
611 Test case in Pascal: " { " a { " } */
616 /* Record best comment-starter so far. */
618 comstart_byte
= from_byte
;
620 else if (--nesting
<= 0)
621 /* nested comments have to be balanced, so we don't need to
622 keep looking for earlier ones. We use here the same (slightly
623 incorrect) reasoning as below: since it is followed by uniform
624 paired string quotes, this comment-start has to be outside of
625 strings, else the comment-end itself would be inside a string. */
630 if (SYNTAX_FLAGS_COMMENT_STYLE (syntax
) == comstyle
631 && ((com2end
&& SYNTAX_FLAGS_COMMENT_NESTED (prev_syntax
))
632 || SYNTAX_FLAGS_COMMENT_NESTED (syntax
)) == comnested
)
633 /* This is the same style of comment ender as ours. */
638 /* Anything before that can't count because it would match
639 this comment-ender rather than ours. */
640 from
= stop
; /* Break out of the loop. */
642 else if (comstart_pos
!= 0 || c
!= '\n')
643 /* We're mixing comment styles here, so we'd better be careful.
644 The (comstart_pos != 0 || c != '\n') check is not quite correct
645 (we should just always set comment_lossage), but removing it
646 would imply that any multiline comment in C would go through
647 lossage, which seems overkill.
648 The failure should only happen in the rare cases such as
654 /* Assume a defun-start point is outside of strings. */
655 if (open_paren_in_column_0_is_defun_start
657 || (temp_byte
= dec_bytepos (from_byte
),
658 FETCH_CHAR (temp_byte
) == '\n')))
661 defun_start_byte
= from_byte
;
662 from
= stop
; /* Break out of the loop. */
671 if (comstart_pos
== 0)
674 from_byte
= comment_end_byte
;
675 UPDATE_SYNTAX_TABLE_FORWARD (comment_end
- 1);
677 /* If comstart_pos is set and we get here (ie. didn't jump to `lossage'
678 or `done'), then we've found the beginning of the non-nested comment. */
679 else if (1) /* !comnested */
682 from_byte
= comstart_byte
;
683 UPDATE_SYNTAX_TABLE_FORWARD (from
- 1);
687 struct lisp_parse_state state
;
689 /* We had two kinds of string delimiters mixed up
690 together. Decode this going forwards.
691 Scan fwd from a known safe place (beginning-of-defun)
692 to the one in question; this records where we
693 last passed a comment starter. */
694 /* If we did not already find the defun start, find it now. */
695 if (defun_start
== 0)
697 defun_start
= find_defun_start (comment_end
, comment_end_byte
);
698 defun_start_byte
= find_start_value_byte
;
702 scan_sexps_forward (&state
,
703 defun_start
, defun_start_byte
,
704 comment_end
, -10000, 0, Qnil
, 0);
705 defun_start
= comment_end
;
706 if (state
.incomment
== (comnested
? 1 : -1)
707 && state
.comstyle
== comstyle
)
708 from
= state
.comstr_start
;
713 /* If comment_end is inside some other comment, maybe ours
714 is nested, so we need to try again from within the
715 surrounding comment. Example: { a (* " *) */
717 /* FIXME: We should advance by one or two chars. */
718 defun_start
= state
.comstr_start
+ 2;
719 defun_start_byte
= CHAR_TO_BYTE (defun_start
);
722 } while (defun_start
< comment_end
);
724 from_byte
= CHAR_TO_BYTE (from
);
725 UPDATE_SYNTAX_TABLE_FORWARD (from
- 1);
730 *bytepos_ptr
= from_byte
;
732 return (from
== comment_end
) ? -1 : from
;
735 DEFUN ("syntax-table-p", Fsyntax_table_p
, Ssyntax_table_p
, 1, 1, 0,
736 doc
: /* Return t if OBJECT is a syntax table.
737 Currently, any char-table counts as a syntax table. */)
741 if (CHAR_TABLE_P (object
)
742 && EQ (XCHAR_TABLE (object
)->purpose
, Qsyntax_table
))
748 check_syntax_table (obj
)
751 if (!(CHAR_TABLE_P (obj
)
752 && EQ (XCHAR_TABLE (obj
)->purpose
, Qsyntax_table
)))
753 wrong_type_argument (Qsyntax_table_p
, obj
);
756 DEFUN ("syntax-table", Fsyntax_table
, Ssyntax_table
, 0, 0, 0,
757 doc
: /* Return the current syntax table.
758 This is the one specified by the current buffer. */)
761 return current_buffer
->syntax_table
;
764 DEFUN ("standard-syntax-table", Fstandard_syntax_table
,
765 Sstandard_syntax_table
, 0, 0, 0,
766 doc
: /* Return the standard syntax table.
767 This is the one used for new buffers. */)
770 return Vstandard_syntax_table
;
773 DEFUN ("copy-syntax-table", Fcopy_syntax_table
, Scopy_syntax_table
, 0, 1, 0,
774 doc
: /* Construct a new syntax table and return it.
775 It is a copy of the TABLE, which defaults to the standard syntax table. */)
782 check_syntax_table (table
);
784 table
= Vstandard_syntax_table
;
786 copy
= Fcopy_sequence (table
);
788 /* Only the standard syntax table should have a default element.
789 Other syntax tables should inherit from parents instead. */
790 XCHAR_TABLE (copy
)->defalt
= Qnil
;
792 /* Copied syntax tables should all have parents.
793 If we copied one with no parent, such as the standard syntax table,
794 use the standard syntax table as the copy's parent. */
795 if (NILP (XCHAR_TABLE (copy
)->parent
))
796 Fset_char_table_parent (copy
, Vstandard_syntax_table
);
800 DEFUN ("set-syntax-table", Fset_syntax_table
, Sset_syntax_table
, 1, 1, 0,
801 doc
: /* Select a new syntax table for the current buffer.
802 One argument, a syntax table. */)
807 check_syntax_table (table
);
808 current_buffer
->syntax_table
= table
;
809 /* Indicate that this buffer now has a specified syntax table. */
810 idx
= PER_BUFFER_VAR_IDX (syntax_table
);
811 SET_PER_BUFFER_VALUE_P (current_buffer
, idx
, 1);
815 /* Convert a letter which signifies a syntax code
816 into the code it signifies.
817 This is used by modify-syntax-entry, and other things. */
819 unsigned char syntax_spec_code
[0400] =
820 { 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
821 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
822 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
823 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
824 (char) Swhitespace
, (char) Scomment_fence
, (char) Sstring
, 0377,
825 (char) Smath
, 0377, 0377, (char) Squote
,
826 (char) Sopen
, (char) Sclose
, 0377, 0377,
827 0377, (char) Swhitespace
, (char) Spunct
, (char) Scharquote
,
828 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
829 0377, 0377, 0377, 0377,
830 (char) Scomment
, 0377, (char) Sendcomment
, 0377,
831 (char) Sinherit
, 0377, 0377, 0377, 0377, 0377, 0377, 0377, /* @, A ... */
832 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
833 0377, 0377, 0377, 0377, 0377, 0377, 0377, (char) Sword
,
834 0377, 0377, 0377, 0377, (char) Sescape
, 0377, 0377, (char) Ssymbol
,
835 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377, /* `, a, ... */
836 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
837 0377, 0377, 0377, 0377, 0377, 0377, 0377, (char) Sword
,
838 0377, 0377, 0377, 0377, (char) Sstring_fence
, 0377, 0377, 0377
841 /* Indexed by syntax code, give the letter that describes it. */
843 char syntax_code_spec
[16] =
845 ' ', '.', 'w', '_', '(', ')', '\'', '\"', '$', '\\', '/', '<', '>', '@',
849 /* Indexed by syntax code, give the object (cons of syntax code and
850 nil) to be stored in syntax table. Since these objects can be
851 shared among syntax tables, we generate them in advance. By
852 sharing objects, the function `describe-syntax' can give a more
854 static Lisp_Object Vsyntax_code_object
;
857 /* Look up the value for CHARACTER in syntax table TABLE's parent
858 and its parents. SYNTAX_ENTRY calls this, when TABLE itself has nil
859 for CHARACTER. It's actually used only when not compiled with GCC. */
862 syntax_parent_lookup (table
, character
)
870 table
= XCHAR_TABLE (table
)->parent
;
874 value
= XCHAR_TABLE (table
)->contents
[character
];
880 DEFUN ("char-syntax", Fchar_syntax
, Schar_syntax
, 1, 1, 0,
881 doc
: /* Return the syntax code of CHARACTER, described by a character.
882 For example, if CHARACTER is a word constituent,
883 the character `w' is returned.
884 The characters that correspond to various syntax codes
885 are listed in the documentation of `modify-syntax-entry'. */)
887 Lisp_Object character
;
890 gl_state
.current_syntax_table
= current_buffer
->syntax_table
;
892 gl_state
.use_global
= 0;
893 CHECK_NUMBER (character
);
894 char_int
= XINT (character
);
895 return make_number (syntax_code_spec
[(int) SYNTAX (char_int
)]);
898 DEFUN ("matching-paren", Fmatching_paren
, Smatching_paren
, 1, 1, 0,
899 doc
: /* Return the matching parenthesis of CHARACTER, or nil if none. */)
901 Lisp_Object character
;
904 gl_state
.current_syntax_table
= current_buffer
->syntax_table
;
905 gl_state
.use_global
= 0;
906 CHECK_NUMBER (character
);
907 char_int
= XINT (character
);
908 code
= SYNTAX (char_int
);
909 if (code
== Sopen
|| code
== Sclose
)
910 return SYNTAX_MATCH (char_int
);
914 DEFUN ("string-to-syntax", Fstring_to_syntax
, Sstring_to_syntax
, 1, 1, 0,
915 doc
: /* Convert a syntax specification STRING into syntax cell form.
916 STRING should be a string as it is allowed as argument of
917 `modify-syntax-entry'. Value is the equivalent cons cell
918 (CODE . MATCHING-CHAR) that can be used as value of a `syntax-table'
923 register const unsigned char *p
;
924 register enum syntaxcode code
;
928 CHECK_STRING (string
);
931 code
= (enum syntaxcode
) syntax_spec_code
[*p
++];
932 if (((int) code
& 0377) == 0377)
933 error ("Invalid syntax description letter: %c", p
[-1]);
935 if (code
== Sinherit
)
941 int character
= (STRING_CHAR_AND_LENGTH
942 (p
, SBYTES (string
) - 1, len
));
943 XSETINT (match
, character
);
944 if (XFASTINT (match
) == ' ')
984 if (val
< XVECTOR (Vsyntax_code_object
)->size
&& NILP (match
))
985 return XVECTOR (Vsyntax_code_object
)->contents
[val
];
987 /* Since we can't use a shared object, let's make a new one. */
988 return Fcons (make_number (val
), match
);
991 /* I really don't know why this is interactive
992 help-form should at least be made useful whilst reading the second arg. */
993 DEFUN ("modify-syntax-entry", Fmodify_syntax_entry
, Smodify_syntax_entry
, 2, 3,
994 "cSet syntax for character: \nsSet syntax for %s to: ",
995 doc
: /* Set syntax for character CHAR according to string NEWENTRY.
996 The syntax is changed only for table SYNTAX-TABLE, which defaults to
997 the current buffer's syntax table.
998 The first character of NEWENTRY should be one of the following:
999 Space or - whitespace syntax. w word constituent.
1000 _ symbol constituent. . punctuation.
1001 ( open-parenthesis. ) close-parenthesis.
1002 " string quote. \\ escape.
1003 $ paired delimiter. ' expression quote or prefix operator.
1004 < comment starter. > comment ender.
1005 / character-quote. @ inherit from `standard-syntax-table'.
1006 | generic string fence. ! generic comment fence.
1008 Only single-character comment start and end sequences are represented thus.
1009 Two-character sequences are represented as described below.
1010 The second character of NEWENTRY is the matching parenthesis,
1011 used only if the first character is `(' or `)'.
1012 Any additional characters are flags.
1013 Defined flags are the characters 1, 2, 3, 4, b, p, and n.
1014 1 means CHAR is the start of a two-char comment start sequence.
1015 2 means CHAR is the second character of such a sequence.
1016 3 means CHAR is the start of a two-char comment end sequence.
1017 4 means CHAR is the second character of such a sequence.
1019 There can be up to two orthogonal comment sequences. This is to support
1020 language modes such as C++. By default, all comment sequences are of style
1021 a, but you can set the comment sequence style to b (on the second character
1022 of a comment-start, or the first character of a comment-end sequence) using
1024 b means CHAR is part of comment sequence b.
1025 n means CHAR is part of a nestable comment sequence.
1027 p means CHAR is a prefix character for `backward-prefix-chars';
1028 such characters are treated as whitespace when they occur
1029 between expressions.
1030 usage: (modify-syntax-entry CHAR NEWENTRY &optional SYNTAX-TABLE) */)
1031 (c
, newentry
, syntax_table
)
1032 Lisp_Object c
, newentry
, syntax_table
;
1036 if (NILP (syntax_table
))
1037 syntax_table
= current_buffer
->syntax_table
;
1039 check_syntax_table (syntax_table
);
1041 SET_RAW_SYNTAX_ENTRY (syntax_table
, XINT (c
), Fstring_to_syntax (newentry
));
1045 /* Dump syntax table to buffer in human-readable format */
1047 DEFUN ("internal-describe-syntax-value", Finternal_describe_syntax_value
,
1048 Sinternal_describe_syntax_value
, 1, 1, 0,
1049 doc
: /* Insert a description of the internal syntax description SYNTAX at point. */)
1053 register enum syntaxcode code
;
1054 char desc
, start1
, start2
, end1
, end2
, prefix
, comstyle
, comnested
;
1056 Lisp_Object first
, match_lisp
, value
= syntax
;
1060 insert_string ("default");
1064 if (CHAR_TABLE_P (value
))
1066 insert_string ("deeper char-table ...");
1072 insert_string ("invalid");
1076 first
= XCAR (value
);
1077 match_lisp
= XCDR (value
);
1079 if (!INTEGERP (first
) || !(NILP (match_lisp
) || INTEGERP (match_lisp
)))
1081 insert_string ("invalid");
1085 code
= (enum syntaxcode
) (XINT (first
) & 0377);
1086 start1
= (XINT (first
) >> 16) & 1;
1087 start2
= (XINT (first
) >> 17) & 1;
1088 end1
= (XINT (first
) >> 18) & 1;
1089 end2
= (XINT (first
) >> 19) & 1;
1090 prefix
= (XINT (first
) >> 20) & 1;
1091 comstyle
= (XINT (first
) >> 21) & 1;
1092 comnested
= (XINT (first
) >> 22) & 1;
1094 if ((int) code
< 0 || (int) code
>= (int) Smax
)
1096 insert_string ("invalid");
1099 desc
= syntax_code_spec
[(int) code
];
1101 str
[0] = desc
, str
[1] = 0;
1104 if (NILP (match_lisp
))
1107 insert_char (XINT (match_lisp
));
1126 insert_string ("\twhich means: ");
1128 switch (SWITCH_ENUM_CAST (code
))
1131 insert_string ("whitespace"); break;
1133 insert_string ("punctuation"); break;
1135 insert_string ("word"); break;
1137 insert_string ("symbol"); break;
1139 insert_string ("open"); break;
1141 insert_string ("close"); break;
1143 insert_string ("prefix"); break;
1145 insert_string ("string"); break;
1147 insert_string ("math"); break;
1149 insert_string ("escape"); break;
1151 insert_string ("charquote"); break;
1153 insert_string ("comment"); break;
1155 insert_string ("endcomment"); break;
1157 insert_string ("inherit"); break;
1158 case Scomment_fence
:
1159 insert_string ("comment fence"); break;
1161 insert_string ("string fence"); break;
1163 insert_string ("invalid");
1167 if (!NILP (match_lisp
))
1169 insert_string (", matches ");
1170 insert_char (XINT (match_lisp
));
1174 insert_string (",\n\t is the first character of a comment-start sequence");
1176 insert_string (",\n\t is the second character of a comment-start sequence");
1179 insert_string (",\n\t is the first character of a comment-end sequence");
1181 insert_string (",\n\t is the second character of a comment-end sequence");
1183 insert_string (" (comment style b)");
1185 insert_string (" (nestable)");
1188 insert_string (",\n\t is a prefix character for `backward-prefix-chars'");
1193 int parse_sexp_ignore_comments
;
1195 /* Return the position across COUNT words from FROM.
1196 If that many words cannot be found before the end of the buffer, return 0.
1197 COUNT negative means scan backward and stop at word beginning. */
1200 scan_words (from
, count
)
1201 register int from
, count
;
1203 register int beg
= BEGV
;
1204 register int end
= ZV
;
1205 register int from_byte
= CHAR_TO_BYTE (from
);
1206 register enum syntaxcode code
;
1212 SETUP_SYNTAX_TABLE (from
, count
);
1223 UPDATE_SYNTAX_TABLE_FORWARD (from
);
1224 ch0
= FETCH_CHAR (from_byte
);
1225 code
= SYNTAX (ch0
);
1226 INC_BOTH (from
, from_byte
);
1227 if (words_include_escapes
1228 && (code
== Sescape
|| code
== Scharquote
))
1233 /* Now CH0 is a character which begins a word and FROM is the
1234 position of the next character. */
1237 if (from
== end
) break;
1238 UPDATE_SYNTAX_TABLE_FORWARD (from
);
1239 ch1
= FETCH_CHAR (from_byte
);
1240 code
= SYNTAX (ch1
);
1241 if (!(words_include_escapes
1242 && (code
== Sescape
|| code
== Scharquote
)))
1243 if (code
!= Sword
|| WORD_BOUNDARY_P (ch0
, ch1
))
1245 INC_BOTH (from
, from_byte
);
1259 DEC_BOTH (from
, from_byte
);
1260 UPDATE_SYNTAX_TABLE_BACKWARD (from
);
1261 ch1
= FETCH_CHAR (from_byte
);
1262 code
= SYNTAX (ch1
);
1263 if (words_include_escapes
1264 && (code
== Sescape
|| code
== Scharquote
))
1269 /* Now CH1 is a character which ends a word and FROM is the
1277 temp_byte
= dec_bytepos (from_byte
);
1278 UPDATE_SYNTAX_TABLE_BACKWARD (from
);
1279 ch0
= FETCH_CHAR (temp_byte
);
1280 code
= SYNTAX (ch0
);
1281 if (!(words_include_escapes
1282 && (code
== Sescape
|| code
== Scharquote
)))
1283 if (code
!= Sword
|| WORD_BOUNDARY_P (ch0
, ch1
))
1285 DEC_BOTH (from
, from_byte
);
1296 DEFUN ("forward-word", Fforward_word
, Sforward_word
, 0, 1, "p",
1297 doc
: /* Move point forward ARG words (backward if ARG is negative).
1299 If an edge of the buffer or a field boundary is reached, point is left there
1300 and the function returns nil. Field boundaries are not noticed if
1301 `inhibit-field-text-motion' is non-nil. */)
1309 XSETFASTINT (arg
, 1);
1313 val
= orig_val
= scan_words (PT
, XINT (arg
));
1315 val
= XINT (arg
) > 0 ? ZV
: BEGV
;
1317 /* Avoid jumping out of an input field. */
1318 tmp
= Fconstrain_to_field (make_number (val
), make_number (PT
),
1320 val
= XFASTINT (tmp
);
1323 return val
== orig_val
? Qt
: Qnil
;
1326 Lisp_Object
skip_chars ();
1328 DEFUN ("skip-chars-forward", Fskip_chars_forward
, Sskip_chars_forward
, 1, 2, 0,
1329 doc
: /* Move point forward, stopping before a char not in STRING, or at pos LIM.
1330 STRING is like the inside of a `[...]' in a regular expression
1331 except that `]' is never special and `\\' quotes `^', `-' or `\\'
1332 (but not as the end of a range; quoting is never needed there).
1333 Thus, with arg "a-zA-Z", this skips letters stopping before first nonletter.
1334 With arg "^a-zA-Z", skips nonletters stopping before first letter.
1335 Char classes, e.g. `[:alpha:]', are supported.
1337 Returns the distance traveled, either zero or positive. */)
1339 Lisp_Object string
, lim
;
1341 return skip_chars (1, 0, string
, lim
, 1);
1344 DEFUN ("skip-chars-backward", Fskip_chars_backward
, Sskip_chars_backward
, 1, 2, 0,
1345 doc
: /* Move point backward, stopping after a char not in STRING, or at pos LIM.
1346 See `skip-chars-forward' for details.
1347 Returns the distance traveled, either zero or negative. */)
1349 Lisp_Object string
, lim
;
1351 return skip_chars (0, 0, string
, lim
, 1);
1354 DEFUN ("skip-syntax-forward", Fskip_syntax_forward
, Sskip_syntax_forward
, 1, 2, 0,
1355 doc
: /* Move point forward across chars in specified syntax classes.
1356 SYNTAX is a string of syntax code characters.
1357 Stop before a char whose syntax is not in SYNTAX, or at position LIM.
1358 If SYNTAX starts with ^, skip characters whose syntax is NOT in SYNTAX.
1359 This function returns the distance traveled, either zero or positive. */)
1361 Lisp_Object syntax
, lim
;
1363 return skip_chars (1, 1, syntax
, lim
, 0);
1366 DEFUN ("skip-syntax-backward", Fskip_syntax_backward
, Sskip_syntax_backward
, 1, 2, 0,
1367 doc
: /* Move point backward across chars in specified syntax classes.
1368 SYNTAX is a string of syntax code characters.
1369 Stop on reaching a char whose syntax is not in SYNTAX, or at position LIM.
1370 If SYNTAX starts with ^, skip characters whose syntax is NOT in SYNTAX.
1371 This function returns the distance traveled, either zero or negative. */)
1373 Lisp_Object syntax
, lim
;
1375 return skip_chars (0, 1, syntax
, lim
, 0);
1379 skip_chars (forwardp
, syntaxp
, string
, lim
, handle_iso_classes
)
1380 int forwardp
, syntaxp
;
1381 Lisp_Object string
, lim
;
1382 int handle_iso_classes
;
1384 register unsigned int c
;
1385 unsigned char fastmap
[0400];
1386 /* If SYNTAXP is 0, STRING may contain multi-byte form of characters
1387 of which codes don't fit in FASTMAP. In that case, set the
1388 ranges of characters in CHAR_RANGES. */
1390 int n_char_ranges
= 0;
1392 register int i
, i_byte
;
1393 int multibyte
= !NILP (current_buffer
->enable_multibyte_characters
);
1394 int string_multibyte
;
1396 const unsigned char *str
;
1398 Lisp_Object iso_classes
;
1400 CHECK_STRING (string
);
1401 char_ranges
= (int *) alloca (SCHARS (string
) * (sizeof (int)) * 2);
1402 string_multibyte
= STRING_MULTIBYTE (string
);
1403 str
= SDATA (string
);
1404 size_byte
= SBYTES (string
);
1407 /* Adjust the multibyteness of the string to that of the buffer. */
1408 if (multibyte
!= string_multibyte
)
1413 nbytes
= count_size_as_multibyte (SDATA (string
),
1416 nbytes
= SCHARS (string
);
1417 if (nbytes
!= size_byte
)
1419 unsigned char *tmp
= (unsigned char *) alloca (nbytes
);
1420 copy_text (SDATA (string
), tmp
, size_byte
,
1421 string_multibyte
, multibyte
);
1428 XSETINT (lim
, forwardp
? ZV
: BEGV
);
1430 CHECK_NUMBER_COERCE_MARKER (lim
);
1432 /* In any case, don't allow scan outside bounds of buffer. */
1433 if (XINT (lim
) > ZV
)
1434 XSETFASTINT (lim
, ZV
);
1435 if (XINT (lim
) < BEGV
)
1436 XSETFASTINT (lim
, BEGV
);
1438 bzero (fastmap
, sizeof fastmap
);
1442 if (i_byte
< size_byte
1443 && SREF (string
, 0) == '^')
1445 negate
= 1; i_byte
++;
1448 /* Find the characters specified and set their elements of fastmap.
1449 If syntaxp, each character counts as itself.
1450 Otherwise, handle backslashes and ranges specially. */
1452 while (i_byte
< size_byte
)
1454 c
= STRING_CHAR_AND_LENGTH (str
+ i_byte
, size_byte
- i_byte
, len
);
1458 fastmap
[syntax_spec_code
[c
& 0377]] = 1;
1461 if (handle_iso_classes
&& c
== '['
1462 && i_byte
< size_byte
1463 && STRING_CHAR (str
+ i_byte
, size_byte
- i_byte
) == ':')
1465 const unsigned char *class_beg
= str
+ i_byte
+ 1;
1466 const unsigned char *class_end
= class_beg
;
1467 const unsigned char *class_limit
= str
+ size_byte
- 2;
1468 /* Leave room for the null. */
1469 unsigned char class_name
[CHAR_CLASS_MAX_LENGTH
+ 1];
1472 if (class_limit
- class_beg
> CHAR_CLASS_MAX_LENGTH
)
1473 class_limit
= class_beg
+ CHAR_CLASS_MAX_LENGTH
;
1475 while (class_end
< class_limit
1476 && *class_end
>= 'a' && *class_end
<= 'z')
1479 if (class_end
== class_beg
1480 || *class_end
!= ':' || class_end
[1] != ']')
1481 goto not_a_class_name
;
1483 bcopy (class_beg
, class_name
, class_end
- class_beg
);
1484 class_name
[class_end
- class_beg
] = 0;
1486 cc
= re_wctype (class_name
);
1488 error ("Invalid ISO C character class");
1490 iso_classes
= Fcons (make_number (cc
), iso_classes
);
1492 i_byte
= class_end
+ 2 - str
;
1499 if (i_byte
== size_byte
)
1502 c
= STRING_CHAR_AND_LENGTH (str
+ i_byte
,
1503 size_byte
- i_byte
, len
);
1506 /* Treat `-' as range character only if another character
1508 if (i_byte
+ 1 < size_byte
1509 && str
[i_byte
] == '-')
1513 /* Skip over the dash. */
1516 /* Get the end of the range. */
1517 c2
= STRING_CHAR_AND_LENGTH (str
+ i_byte
,
1518 size_byte
- i_byte
, len
);
1521 if (SINGLE_BYTE_CHAR_P (c
))
1523 if (! SINGLE_BYTE_CHAR_P (c2
))
1525 /* Handle a range starting with a character of
1526 less than 256, and ending with a character of
1527 not less than 256. Split that into two
1528 ranges, the low one ending at 0377, and the
1529 high one starting at the smallest character
1530 in the charset of C2 and ending at C2. */
1531 int charset
= CHAR_CHARSET (c2
);
1532 int c1
= MAKE_CHAR (charset
, 0, 0);
1534 char_ranges
[n_char_ranges
++] = c1
;
1535 char_ranges
[n_char_ranges
++] = c2
;
1544 else if (c
<= c2
) /* Both C and C2 are multibyte char. */
1546 char_ranges
[n_char_ranges
++] = c
;
1547 char_ranges
[n_char_ranges
++] = c2
;
1552 if (SINGLE_BYTE_CHAR_P (c
))
1556 char_ranges
[n_char_ranges
++] = c
;
1557 char_ranges
[n_char_ranges
++] = c
;
1563 /* If ^ was the first character, complement the fastmap. */
1565 for (i
= 0; i
< sizeof fastmap
; i
++)
1569 int start_point
= PT
;
1571 int pos_byte
= PT_BYTE
;
1572 unsigned char *p
= PT_ADDR
, *endp
, *stop
;
1576 endp
= (XINT (lim
) == GPT
) ? GPT_ADDR
: CHAR_POS_ADDR (XINT (lim
));
1577 stop
= (pos
< GPT
&& GPT
< XINT (lim
)) ? GPT_ADDR
: endp
;
1581 endp
= CHAR_POS_ADDR (XINT (lim
));
1582 stop
= (pos
>= GPT
&& GPT
> XINT (lim
)) ? GAP_END_ADDR
: endp
;
1588 SETUP_SYNTAX_TABLE (pos
, forwardp
? 1 : -1);
1603 c
= STRING_CHAR_AND_LENGTH (p
, MAX_MULTIBYTE_LENGTH
, nbytes
);
1604 if (! fastmap
[(int) SYNTAX (c
)])
1606 p
+= nbytes
, pos
++, pos_byte
+= nbytes
;
1607 UPDATE_SYNTAX_TABLE_FORWARD (pos
);
1619 if (! fastmap
[(int) SYNTAX (*p
)])
1622 UPDATE_SYNTAX_TABLE_FORWARD (pos
);
1630 unsigned char *prev_p
;
1641 while (--p
>= stop
&& ! CHAR_HEAD_P (*p
));
1642 PARSE_MULTIBYTE_SEQ (p
, MAX_MULTIBYTE_LENGTH
, nbytes
);
1643 if (prev_p
- p
> nbytes
)
1644 p
= prev_p
- 1, c
= *p
, nbytes
= 1;
1646 c
= STRING_CHAR (p
, MAX_MULTIBYTE_LENGTH
);
1647 pos
--, pos_byte
-= nbytes
;
1648 UPDATE_SYNTAX_TABLE_BACKWARD (pos
);
1649 if (! fastmap
[(int) SYNTAX (c
)])
1666 if (! fastmap
[(int) SYNTAX (p
[-1])])
1669 UPDATE_SYNTAX_TABLE_BACKWARD (pos
- 1);
1689 c
= STRING_CHAR_AND_LENGTH (p
, MAX_MULTIBYTE_LENGTH
, nbytes
);
1691 if (! NILP (iso_classes
) && in_classes (c
, iso_classes
))
1699 if (SINGLE_BYTE_CHAR_P (c
))
1706 /* If we are looking at a multibyte character,
1707 we must look up the character in the table
1708 CHAR_RANGES. If there's no data in the
1709 table, that character is not what we want to
1712 /* The following code do the right thing even if
1713 n_char_ranges is zero (i.e. no data in
1715 for (i
= 0; i
< n_char_ranges
; i
+= 2)
1716 if (c
>= char_ranges
[i
] && c
<= char_ranges
[i
+ 1])
1718 if (!(negate
^ (i
< n_char_ranges
)))
1722 p
+= nbytes
, pos
++, pos_byte
+= nbytes
;
1735 if (!NILP (iso_classes
) && in_classes (*p
, iso_classes
))
1740 goto fwd_unibyte_ok
;
1754 unsigned char *prev_p
;
1765 while (--p
>= stop
&& ! CHAR_HEAD_P (*p
));
1766 PARSE_MULTIBYTE_SEQ (p
, MAX_MULTIBYTE_LENGTH
, nbytes
);
1767 if (prev_p
- p
> nbytes
)
1768 p
= prev_p
- 1, c
= *p
, nbytes
= 1;
1770 c
= STRING_CHAR (p
, MAX_MULTIBYTE_LENGTH
);
1772 if (! NILP (iso_classes
) && in_classes (c
, iso_classes
))
1780 if (SINGLE_BYTE_CHAR_P (c
))
1787 /* See the comment in the previous similar code. */
1788 for (i
= 0; i
< n_char_ranges
; i
+= 2)
1789 if (c
>= char_ranges
[i
] && c
<= char_ranges
[i
+ 1])
1791 if (!(negate
^ (i
< n_char_ranges
)))
1795 pos
--, pos_byte
-= nbytes
;
1808 if (! NILP (iso_classes
) && in_classes (p
[-1], iso_classes
))
1813 goto back_unibyte_ok
;
1816 if (!fastmap
[p
[-1]])
1824 #if 0 /* Not needed now that a position in mid-character
1825 cannot be specified in Lisp. */
1827 /* INC_POS or DEC_POS might have moved POS over LIM. */
1828 && (forwardp
? (pos
> XINT (lim
)) : (pos
< XINT (lim
))))
1835 SET_PT_BOTH (pos
, pos_byte
);
1838 return make_number (PT
- start_point
);
1842 /* Return 1 if character C belongs to one of the ISO classes
1843 in the list ISO_CLASSES. Each class is represented by an
1844 integer which is its type according to re_wctype. */
1847 in_classes (c
, iso_classes
)
1849 Lisp_Object iso_classes
;
1853 while (! NILP (iso_classes
))
1856 elt
= XCAR (iso_classes
);
1857 iso_classes
= XCDR (iso_classes
);
1859 if (re_iswctype (c
, XFASTINT (elt
)))
1866 /* Jump over a comment, assuming we are at the beginning of one.
1867 FROM is the current position.
1868 FROM_BYTE is the bytepos corresponding to FROM.
1869 Do not move past STOP (a charpos).
1870 The comment over which we have to jump is of style STYLE
1871 (either SYNTAX_COMMENT_STYLE(foo) or ST_COMMENT_STYLE).
1872 NESTING should be positive to indicate the nesting at the beginning
1873 for nested comments and should be zero or negative else.
1874 ST_COMMENT_STYLE cannot be nested.
1875 PREV_SYNTAX is the SYNTAX_WITH_FLAGS of the previous character
1876 (or 0 If the search cannot start in the middle of a two-character).
1878 If successful, return 1 and store the charpos of the comment's end
1879 into *CHARPOS_PTR and the corresponding bytepos into *BYTEPOS_PTR.
1880 Else, return 0 and store the charpos STOP into *CHARPOS_PTR, the
1881 corresponding bytepos into *BYTEPOS_PTR and the current nesting
1882 (as defined for state.incomment) in *INCOMMENT_PTR.
1884 The comment end is the last character of the comment rather than the
1885 character just after the comment.
1887 Global syntax data is assumed to initially be valid for FROM and
1888 remains valid for forward search starting at the returned position. */
1891 forw_comment (from
, from_byte
, stop
, nesting
, style
, prev_syntax
,
1892 charpos_ptr
, bytepos_ptr
, incomment_ptr
)
1893 int from
, from_byte
, stop
;
1894 int nesting
, style
, prev_syntax
;
1895 int *charpos_ptr
, *bytepos_ptr
, *incomment_ptr
;
1898 register enum syntaxcode code
;
1899 register int syntax
;
1901 if (nesting
<= 0) nesting
= -1;
1903 /* Enter the loop in the middle so that we find
1904 a 2-char comment ender if we start in the middle of it. */
1905 syntax
= prev_syntax
;
1906 if (syntax
!= 0) goto forw_incomment
;
1912 *incomment_ptr
= nesting
;
1913 *charpos_ptr
= from
;
1914 *bytepos_ptr
= from_byte
;
1917 c
= FETCH_CHAR (from_byte
);
1918 syntax
= SYNTAX_WITH_FLAGS (c
);
1919 code
= syntax
& 0xff;
1920 if (code
== Sendcomment
1921 && SYNTAX_FLAGS_COMMENT_STYLE (syntax
) == style
1922 && (SYNTAX_FLAGS_COMMENT_NESTED (syntax
) ?
1923 (nesting
> 0 && --nesting
== 0) : nesting
< 0))
1924 /* we have encountered a comment end of the same style
1925 as the comment sequence which began this comment
1928 if (code
== Scomment_fence
1929 && style
== ST_COMMENT_STYLE
)
1930 /* we have encountered a comment end of the same style
1931 as the comment sequence which began this comment
1936 && SYNTAX_FLAGS_COMMENT_NESTED (syntax
)
1937 && SYNTAX_FLAGS_COMMENT_STYLE (syntax
) == style
)
1938 /* we have encountered a nested comment of the same style
1939 as the comment sequence which began this comment section */
1941 INC_BOTH (from
, from_byte
);
1942 UPDATE_SYNTAX_TABLE_FORWARD (from
);
1945 if (from
< stop
&& SYNTAX_FLAGS_COMEND_FIRST (syntax
)
1946 && SYNTAX_FLAGS_COMMENT_STYLE (syntax
) == style
1947 && (c1
= FETCH_CHAR (from_byte
),
1948 SYNTAX_COMEND_SECOND (c1
))
1949 && ((SYNTAX_FLAGS_COMMENT_NESTED (syntax
) ||
1950 SYNTAX_COMMENT_NESTED (c1
)) ? nesting
> 0 : nesting
< 0))
1953 /* we have encountered a comment end of the same style
1954 as the comment sequence which began this comment
1959 INC_BOTH (from
, from_byte
);
1960 UPDATE_SYNTAX_TABLE_FORWARD (from
);
1965 && SYNTAX_FLAGS_COMSTART_FIRST (syntax
)
1966 && (c1
= FETCH_CHAR (from_byte
),
1967 SYNTAX_COMMENT_STYLE (c1
) == style
1968 && SYNTAX_COMSTART_SECOND (c1
))
1969 && (SYNTAX_FLAGS_COMMENT_NESTED (syntax
) ||
1970 SYNTAX_COMMENT_NESTED (c1
)))
1971 /* we have encountered a nested comment of the same style
1972 as the comment sequence which began this comment
1975 INC_BOTH (from
, from_byte
);
1976 UPDATE_SYNTAX_TABLE_FORWARD (from
);
1980 *charpos_ptr
= from
;
1981 *bytepos_ptr
= from_byte
;
1985 DEFUN ("forward-comment", Fforward_comment
, Sforward_comment
, 1, 1, 0,
1987 Move forward across up to COUNT comments. If COUNT is negative, move backward.
1988 Stop scanning if we find something other than a comment or whitespace.
1989 Set point to where scanning stops.
1990 If COUNT comments are found as expected, with nothing except whitespace
1991 between them, return t; otherwise return nil. */)
1999 register enum syntaxcode code
;
2000 int comstyle
= 0; /* style of comment encountered */
2001 int comnested
= 0; /* whether the comment is nestable or not */
2004 int out_charpos
, out_bytepos
;
2007 CHECK_NUMBER (count
);
2008 count1
= XINT (count
);
2009 stop
= count1
> 0 ? ZV
: BEGV
;
2015 from_byte
= PT_BYTE
;
2017 SETUP_SYNTAX_TABLE (from
, count1
);
2026 SET_PT_BOTH (from
, from_byte
);
2030 c
= FETCH_CHAR (from_byte
);
2032 comstart_first
= SYNTAX_COMSTART_FIRST (c
);
2033 comnested
= SYNTAX_COMMENT_NESTED (c
);
2034 comstyle
= SYNTAX_COMMENT_STYLE (c
);
2035 INC_BOTH (from
, from_byte
);
2036 UPDATE_SYNTAX_TABLE_FORWARD (from
);
2037 if (from
< stop
&& comstart_first
2038 && (c1
= FETCH_CHAR (from_byte
),
2039 SYNTAX_COMSTART_SECOND (c1
)))
2041 /* We have encountered a comment start sequence and we
2042 are ignoring all text inside comments. We must record
2043 the comment style this sequence begins so that later,
2044 only a comment end of the same style actually ends
2045 the comment section. */
2047 comstyle
= SYNTAX_COMMENT_STYLE (c1
);
2048 comnested
= comnested
|| SYNTAX_COMMENT_NESTED (c1
);
2049 INC_BOTH (from
, from_byte
);
2050 UPDATE_SYNTAX_TABLE_FORWARD (from
);
2053 while (code
== Swhitespace
|| (code
== Sendcomment
&& c
== '\n'));
2055 if (code
== Scomment_fence
)
2056 comstyle
= ST_COMMENT_STYLE
;
2057 else if (code
!= Scomment
)
2060 DEC_BOTH (from
, from_byte
);
2061 SET_PT_BOTH (from
, from_byte
);
2064 /* We're at the start of a comment. */
2065 found
= forw_comment (from
, from_byte
, stop
, comnested
, comstyle
, 0,
2066 &out_charpos
, &out_bytepos
, &dummy
);
2067 from
= out_charpos
; from_byte
= out_bytepos
;
2071 SET_PT_BOTH (from
, from_byte
);
2074 INC_BOTH (from
, from_byte
);
2075 UPDATE_SYNTAX_TABLE_FORWARD (from
);
2076 /* We have skipped one comment. */
2088 SET_PT_BOTH (BEGV
, BEGV_BYTE
);
2093 DEC_BOTH (from
, from_byte
);
2094 /* char_quoted does UPDATE_SYNTAX_TABLE_BACKWARD (from). */
2095 quoted
= char_quoted (from
, from_byte
);
2096 c
= FETCH_CHAR (from_byte
);
2099 comnested
= SYNTAX_COMMENT_NESTED (c
);
2100 if (code
== Sendcomment
)
2101 comstyle
= SYNTAX_COMMENT_STYLE (c
);
2102 if (from
> stop
&& SYNTAX_COMEND_SECOND (c
)
2103 && prev_char_comend_first (from
, from_byte
)
2104 && !char_quoted (from
- 1, dec_bytepos (from_byte
)))
2106 /* We must record the comment style encountered so that
2107 later, we can match only the proper comment begin
2108 sequence of the same style. */
2109 DEC_BOTH (from
, from_byte
);
2111 /* Calling char_quoted, above, set up global syntax position
2112 at the new value of FROM. */
2113 c1
= FETCH_CHAR (from_byte
);
2114 comstyle
= SYNTAX_COMMENT_STYLE (c1
);
2115 comnested
= comnested
|| SYNTAX_COMMENT_NESTED (c1
);
2118 if (code
== Scomment_fence
)
2120 /* Skip until first preceding unquoted comment_fence. */
2121 int found
= 0, ini
= from
, ini_byte
= from_byte
;
2125 DEC_BOTH (from
, from_byte
);
2126 UPDATE_SYNTAX_TABLE_BACKWARD (from
);
2127 c
= FETCH_CHAR (from_byte
);
2128 if (SYNTAX (c
) == Scomment_fence
2129 && !char_quoted (from
, from_byte
))
2134 else if (from
== stop
)
2139 from
= ini
; /* Set point to ini + 1. */
2140 from_byte
= ini_byte
;
2144 /* We have skipped one comment. */
2147 else if (code
== Sendcomment
)
2149 found
= back_comment (from
, from_byte
, stop
, comnested
, comstyle
,
2150 &out_charpos
, &out_bytepos
);
2154 /* This end-of-line is not an end-of-comment.
2155 Treat it like a whitespace.
2156 CC-mode (and maybe others) relies on this behavior. */
2160 /* Failure: we should go back to the end of this
2161 not-quite-endcomment. */
2162 if (SYNTAX(c
) != code
)
2163 /* It was a two-char Sendcomment. */
2164 INC_BOTH (from
, from_byte
);
2170 /* We have skipped one comment. */
2171 from
= out_charpos
, from_byte
= out_bytepos
;
2175 else if (code
!= Swhitespace
|| quoted
)
2179 INC_BOTH (from
, from_byte
);
2180 SET_PT_BOTH (from
, from_byte
);
2188 SET_PT_BOTH (from
, from_byte
);
2193 /* Return syntax code of character C if C is a single byte character
2194 or `multibyte_symbol_p' is zero. Otherwise, return Ssymbol. */
2196 #define SYNTAX_WITH_MULTIBYTE_CHECK(c) \
2197 ((SINGLE_BYTE_CHAR_P (c) || !multibyte_symbol_p) \
2198 ? SYNTAX (c) : Ssymbol)
2201 scan_lists (from
, count
, depth
, sexpflag
)
2203 int count
, depth
, sexpflag
;
2206 register int stop
= count
> 0 ? ZV
: BEGV
;
2211 register enum syntaxcode code
, temp_code
;
2212 int min_depth
= depth
; /* Err out if depth gets less than this. */
2213 int comstyle
= 0; /* style of comment encountered */
2214 int comnested
= 0; /* whether the comment is nestable or not */
2216 int last_good
= from
;
2219 int out_bytepos
, out_charpos
;
2221 int multibyte_symbol_p
= sexpflag
&& multibyte_syntax_as_symbol
;
2223 if (depth
> 0) min_depth
= 0;
2225 if (from
> ZV
) from
= ZV
;
2226 if (from
< BEGV
) from
= BEGV
;
2228 from_byte
= CHAR_TO_BYTE (from
);
2233 SETUP_SYNTAX_TABLE (from
, count
);
2238 int comstart_first
, prefix
;
2239 UPDATE_SYNTAX_TABLE_FORWARD (from
);
2240 c
= FETCH_CHAR (from_byte
);
2241 code
= SYNTAX_WITH_MULTIBYTE_CHECK (c
);
2242 comstart_first
= SYNTAX_COMSTART_FIRST (c
);
2243 comnested
= SYNTAX_COMMENT_NESTED (c
);
2244 comstyle
= SYNTAX_COMMENT_STYLE (c
);
2245 prefix
= SYNTAX_PREFIX (c
);
2246 if (depth
== min_depth
)
2248 INC_BOTH (from
, from_byte
);
2249 UPDATE_SYNTAX_TABLE_FORWARD (from
);
2250 if (from
< stop
&& comstart_first
2251 && (c
= FETCH_CHAR (from_byte
), SYNTAX_COMSTART_SECOND (c
))
2252 && parse_sexp_ignore_comments
)
2254 /* we have encountered a comment start sequence and we
2255 are ignoring all text inside comments. We must record
2256 the comment style this sequence begins so that later,
2257 only a comment end of the same style actually ends
2258 the comment section */
2260 c1
= FETCH_CHAR (from_byte
);
2261 comstyle
= SYNTAX_COMMENT_STYLE (c1
);
2262 comnested
= comnested
|| SYNTAX_COMMENT_NESTED (c1
);
2263 INC_BOTH (from
, from_byte
);
2264 UPDATE_SYNTAX_TABLE_FORWARD (from
);
2270 switch (SWITCH_ENUM_CAST (code
))
2274 if (from
== stop
) goto lose
;
2275 INC_BOTH (from
, from_byte
);
2276 /* treat following character as a word constituent */
2279 if (depth
|| !sexpflag
) break;
2280 /* This word counts as a sexp; return at end of it. */
2283 UPDATE_SYNTAX_TABLE_FORWARD (from
);
2285 /* Some compilers can't handle this inside the switch. */
2286 c
= FETCH_CHAR (from_byte
);
2287 temp
= SYNTAX_WITH_MULTIBYTE_CHECK (c
);
2292 INC_BOTH (from
, from_byte
);
2293 if (from
== stop
) goto lose
;
2302 INC_BOTH (from
, from_byte
);
2306 case Scomment_fence
:
2307 comstyle
= ST_COMMENT_STYLE
;
2310 if (!parse_sexp_ignore_comments
) break;
2311 UPDATE_SYNTAX_TABLE_FORWARD (from
);
2312 found
= forw_comment (from
, from_byte
, stop
,
2313 comnested
, comstyle
, 0,
2314 &out_charpos
, &out_bytepos
, &dummy
);
2315 from
= out_charpos
, from_byte
= out_bytepos
;
2322 INC_BOTH (from
, from_byte
);
2323 UPDATE_SYNTAX_TABLE_FORWARD (from
);
2329 if (from
!= stop
&& c
== FETCH_CHAR (from_byte
))
2331 INC_BOTH (from
, from_byte
);
2341 if (!++depth
) goto done
;
2346 if (!--depth
) goto done
;
2347 if (depth
< min_depth
)
2348 Fsignal (Qscan_error
,
2349 Fcons (build_string ("Containing expression ends prematurely"),
2350 Fcons (make_number (last_good
),
2351 Fcons (make_number (from
), Qnil
))));
2356 temp_pos
= dec_bytepos (from_byte
);
2357 stringterm
= FETCH_CHAR (temp_pos
);
2360 if (from
>= stop
) goto lose
;
2361 UPDATE_SYNTAX_TABLE_FORWARD (from
);
2362 c
= FETCH_CHAR (from_byte
);
2365 && SYNTAX_WITH_MULTIBYTE_CHECK (c
) == Sstring
)
2366 : SYNTAX_WITH_MULTIBYTE_CHECK (c
) == Sstring_fence
)
2369 /* Some compilers can't handle this inside the switch. */
2370 temp
= SYNTAX_WITH_MULTIBYTE_CHECK (c
);
2375 INC_BOTH (from
, from_byte
);
2377 INC_BOTH (from
, from_byte
);
2379 INC_BOTH (from
, from_byte
);
2380 if (!depth
&& sexpflag
) goto done
;
2383 /* Ignore whitespace, punctuation, quote, endcomment. */
2388 /* Reached end of buffer. Error if within object, return nil if between */
2389 if (depth
) goto lose
;
2394 /* End of object reached */
2403 DEC_BOTH (from
, from_byte
);
2404 UPDATE_SYNTAX_TABLE_BACKWARD (from
);
2405 c
= FETCH_CHAR (from_byte
);
2406 code
= SYNTAX_WITH_MULTIBYTE_CHECK (c
);
2407 if (depth
== min_depth
)
2410 comnested
= SYNTAX_COMMENT_NESTED (c
);
2411 if (code
== Sendcomment
)
2412 comstyle
= SYNTAX_COMMENT_STYLE (c
);
2413 if (from
> stop
&& SYNTAX_COMEND_SECOND (c
)
2414 && prev_char_comend_first (from
, from_byte
)
2415 && parse_sexp_ignore_comments
)
2417 /* We must record the comment style encountered so that
2418 later, we can match only the proper comment begin
2419 sequence of the same style. */
2420 DEC_BOTH (from
, from_byte
);
2421 UPDATE_SYNTAX_TABLE_BACKWARD (from
);
2423 c1
= FETCH_CHAR (from_byte
);
2424 comstyle
= SYNTAX_COMMENT_STYLE (c1
);
2425 comnested
= comnested
|| SYNTAX_COMMENT_NESTED (c1
);
2428 /* Quoting turns anything except a comment-ender
2429 into a word character. Note that this cannot be true
2430 if we decremented FROM in the if-statement above. */
2431 if (code
!= Sendcomment
&& char_quoted (from
, from_byte
))
2433 DEC_BOTH (from
, from_byte
);
2436 else if (SYNTAX_PREFIX (c
))
2439 switch (SWITCH_ENUM_CAST (code
))
2445 if (depth
|| !sexpflag
) break;
2446 /* This word counts as a sexp; count object finished
2447 after passing it. */
2450 temp_pos
= from_byte
;
2451 if (! NILP (current_buffer
->enable_multibyte_characters
))
2455 UPDATE_SYNTAX_TABLE_BACKWARD (from
- 1);
2456 c1
= FETCH_CHAR (temp_pos
);
2457 temp_code
= SYNTAX_WITH_MULTIBYTE_CHECK (c1
);
2458 /* Don't allow comment-end to be quoted. */
2459 if (temp_code
== Sendcomment
)
2461 quoted
= char_quoted (from
- 1, temp_pos
);
2464 DEC_BOTH (from
, from_byte
);
2465 temp_pos
= dec_bytepos (temp_pos
);
2466 UPDATE_SYNTAX_TABLE_BACKWARD (from
- 1);
2468 c1
= FETCH_CHAR (temp_pos
);
2469 temp_code
= SYNTAX_WITH_MULTIBYTE_CHECK (c1
);
2470 if (! (quoted
|| temp_code
== Sword
2471 || temp_code
== Ssymbol
2472 || temp_code
== Squote
))
2474 DEC_BOTH (from
, from_byte
);
2481 temp_pos
= dec_bytepos (from_byte
);
2482 UPDATE_SYNTAX_TABLE_BACKWARD (from
- 1);
2483 if (from
!= stop
&& c
== FETCH_CHAR (temp_pos
))
2484 DEC_BOTH (from
, from_byte
);
2493 if (!++depth
) goto done2
;
2498 if (!--depth
) goto done2
;
2499 if (depth
< min_depth
)
2500 Fsignal (Qscan_error
,
2501 Fcons (build_string ("Containing expression ends prematurely"),
2502 Fcons (make_number (last_good
),
2503 Fcons (make_number (from
), Qnil
))));
2507 if (!parse_sexp_ignore_comments
)
2509 found
= back_comment (from
, from_byte
, stop
, comnested
, comstyle
,
2510 &out_charpos
, &out_bytepos
);
2511 /* FIXME: if found == -1, then it really wasn't a comment-end.
2512 For single-char Sendcomment, we can't do much about it apart
2513 from skipping the char.
2514 For 2-char endcomments, we could try again, taking both
2515 chars as separate entities, but it's a lot of trouble
2516 for very little gain, so we don't bother either. -sm */
2518 from
= out_charpos
, from_byte
= out_bytepos
;
2521 case Scomment_fence
:
2525 if (from
== stop
) goto lose
;
2526 DEC_BOTH (from
, from_byte
);
2527 UPDATE_SYNTAX_TABLE_BACKWARD (from
);
2528 if (!char_quoted (from
, from_byte
)
2529 && (c
= FETCH_CHAR (from_byte
),
2530 SYNTAX_WITH_MULTIBYTE_CHECK (c
) == code
))
2533 if (code
== Sstring_fence
&& !depth
&& sexpflag
) goto done2
;
2537 stringterm
= FETCH_CHAR (from_byte
);
2540 if (from
== stop
) goto lose
;
2541 DEC_BOTH (from
, from_byte
);
2542 UPDATE_SYNTAX_TABLE_BACKWARD (from
);
2543 if (!char_quoted (from
, from_byte
)
2544 && stringterm
== (c
= FETCH_CHAR (from_byte
))
2545 && SYNTAX_WITH_MULTIBYTE_CHECK (c
) == Sstring
)
2548 if (!depth
&& sexpflag
) goto done2
;
2551 /* Ignore whitespace, punctuation, quote, endcomment. */
2556 /* Reached start of buffer. Error if within object, return nil if between */
2557 if (depth
) goto lose
;
2568 XSETFASTINT (val
, from
);
2572 Fsignal (Qscan_error
,
2573 Fcons (build_string ("Unbalanced parentheses"),
2574 Fcons (make_number (last_good
),
2575 Fcons (make_number (from
), Qnil
))));
2580 DEFUN ("scan-lists", Fscan_lists
, Sscan_lists
, 3, 3, 0,
2581 doc
: /* Scan from character number FROM by COUNT lists.
2582 Returns the character number of the position thus found.
2584 If DEPTH is nonzero, paren depth begins counting from that value,
2585 only places where the depth in parentheses becomes zero
2586 are candidates for stopping; COUNT such places are counted.
2587 Thus, a positive value for DEPTH means go out levels.
2589 Comments are ignored if `parse-sexp-ignore-comments' is non-nil.
2591 If the beginning or end of (the accessible part of) the buffer is reached
2592 and the depth is wrong, an error is signaled.
2593 If the depth is right but the count is not used up, nil is returned. */)
2594 (from
, count
, depth
)
2595 Lisp_Object from
, count
, depth
;
2597 CHECK_NUMBER (from
);
2598 CHECK_NUMBER (count
);
2599 CHECK_NUMBER (depth
);
2601 return scan_lists (XINT (from
), XINT (count
), XINT (depth
), 0);
2604 DEFUN ("scan-sexps", Fscan_sexps
, Sscan_sexps
, 2, 2, 0,
2605 doc
: /* Scan from character number FROM by COUNT balanced expressions.
2606 If COUNT is negative, scan backwards.
2607 Returns the character number of the position thus found.
2609 Comments are ignored if `parse-sexp-ignore-comments' is non-nil.
2611 If the beginning or end of (the accessible part of) the buffer is reached
2612 in the middle of a parenthetical grouping, an error is signaled.
2613 If the beginning or end is reached between groupings
2614 but before count is used up, nil is returned. */)
2616 Lisp_Object from
, count
;
2618 CHECK_NUMBER (from
);
2619 CHECK_NUMBER (count
);
2621 return scan_lists (XINT (from
), XINT (count
), 0, 1);
2624 DEFUN ("backward-prefix-chars", Fbackward_prefix_chars
, Sbackward_prefix_chars
,
2626 doc
: /* Move point backward over any number of chars with prefix syntax.
2627 This includes chars with "quote" or "prefix" syntax (' or p). */)
2632 int opoint_byte
= PT_BYTE
;
2634 int pos_byte
= PT_BYTE
;
2639 SET_PT_BOTH (opoint
, opoint_byte
);
2644 SETUP_SYNTAX_TABLE (pos
, -1);
2646 DEC_BOTH (pos
, pos_byte
);
2648 while (!char_quoted (pos
, pos_byte
)
2649 /* Previous statement updates syntax table. */
2650 && ((c
= FETCH_CHAR (pos_byte
), SYNTAX (c
) == Squote
)
2651 || SYNTAX_PREFIX (c
)))
2654 opoint_byte
= pos_byte
;
2657 DEC_BOTH (pos
, pos_byte
);
2660 SET_PT_BOTH (opoint
, opoint_byte
);
2665 /* Parse forward from FROM / FROM_BYTE to END,
2666 assuming that FROM has state OLDSTATE (nil means FROM is start of function),
2667 and return a description of the state of the parse at END.
2668 If STOPBEFORE is nonzero, stop at the start of an atom.
2669 If COMMENTSTOP is 1, stop at the start of a comment.
2670 If COMMENTSTOP is -1, stop at the start or end of a comment,
2671 after the beginning of a string, or after the end of a string. */
2674 scan_sexps_forward (stateptr
, from
, from_byte
, end
, targetdepth
,
2675 stopbefore
, oldstate
, commentstop
)
2676 struct lisp_parse_state
*stateptr
;
2678 int end
, targetdepth
, stopbefore
, from_byte
;
2679 Lisp_Object oldstate
;
2682 struct lisp_parse_state state
;
2684 register enum syntaxcode code
;
2687 struct level
{ int last
, prev
; };
2688 struct level levelstart
[100];
2689 register struct level
*curlevel
= levelstart
;
2690 struct level
*endlevel
= levelstart
+ 100;
2691 register int depth
; /* Paren depth of current scanning location.
2692 level - levelstart equals this except
2693 when the depth becomes negative. */
2694 int mindepth
; /* Lowest DEPTH value seen. */
2695 int start_quoted
= 0; /* Nonzero means starting after a char quote */
2697 int prev_from
; /* Keep one character before FROM. */
2699 int prev_from_syntax
;
2700 int boundary_stop
= commentstop
== -1;
2703 int out_bytepos
, out_charpos
;
2707 prev_from_byte
= from_byte
;
2709 DEC_BOTH (prev_from
, prev_from_byte
);
2711 /* Use this macro instead of `from++'. */
2713 do { prev_from = from; \
2714 prev_from_byte = from_byte; \
2715 temp = FETCH_CHAR (prev_from_byte); \
2716 prev_from_syntax = SYNTAX_WITH_FLAGS (temp); \
2717 INC_BOTH (from, from_byte); \
2719 UPDATE_SYNTAX_TABLE_FORWARD (from); \
2725 if (NILP (oldstate
))
2728 state
.instring
= -1;
2729 state
.incomment
= 0;
2730 state
.comstyle
= 0; /* comment style a by default. */
2731 state
.comstr_start
= -1; /* no comment/string seen. */
2735 tem
= Fcar (oldstate
);
2741 oldstate
= Fcdr (oldstate
);
2742 oldstate
= Fcdr (oldstate
);
2743 oldstate
= Fcdr (oldstate
);
2744 tem
= Fcar (oldstate
);
2745 /* Check whether we are inside string_fence-style string: */
2746 state
.instring
= (!NILP (tem
)
2747 ? (INTEGERP (tem
) ? XINT (tem
) : ST_STRING_STYLE
)
2750 oldstate
= Fcdr (oldstate
);
2751 tem
= Fcar (oldstate
);
2752 state
.incomment
= (!NILP (tem
)
2753 ? (INTEGERP (tem
) ? XINT (tem
) : -1)
2756 oldstate
= Fcdr (oldstate
);
2757 tem
= Fcar (oldstate
);
2758 start_quoted
= !NILP (tem
);
2760 /* if the eighth element of the list is nil, we are in comment
2761 style a. If it is non-nil, we are in comment style b */
2762 oldstate
= Fcdr (oldstate
);
2763 oldstate
= Fcdr (oldstate
);
2764 tem
= Fcar (oldstate
);
2765 state
.comstyle
= NILP (tem
) ? 0 : (EQ (tem
, Qsyntax_table
)
2766 ? ST_COMMENT_STYLE
: 1);
2768 oldstate
= Fcdr (oldstate
);
2769 tem
= Fcar (oldstate
);
2770 state
.comstr_start
= NILP (tem
) ? -1 : XINT (tem
) ;
2771 oldstate
= Fcdr (oldstate
);
2772 tem
= Fcar (oldstate
);
2773 while (!NILP (tem
)) /* >= second enclosing sexps. */
2775 /* curlevel++->last ran into compiler bug on Apollo */
2776 curlevel
->last
= XINT (Fcar (tem
));
2777 if (++curlevel
== endlevel
)
2778 curlevel
--; /* error ("Nesting too deep for parser"); */
2779 curlevel
->prev
= -1;
2780 curlevel
->last
= -1;
2787 curlevel
->prev
= -1;
2788 curlevel
->last
= -1;
2790 SETUP_SYNTAX_TABLE (prev_from
, 1);
2791 temp
= FETCH_CHAR (prev_from_byte
);
2792 prev_from_syntax
= SYNTAX_WITH_FLAGS (temp
);
2793 UPDATE_SYNTAX_TABLE_FORWARD (from
);
2795 /* Enter the loop at a place appropriate for initial state. */
2797 if (state
.incomment
)
2798 goto startincomment
;
2799 if (state
.instring
>= 0)
2801 nofence
= state
.instring
!= ST_STRING_STYLE
;
2803 goto startquotedinstring
;
2806 else if (start_quoted
)
2812 code
= prev_from_syntax
& 0xff;
2815 && SYNTAX_FLAGS_COMSTART_FIRST (prev_from_syntax
)
2816 && (c1
= FETCH_CHAR (from_byte
),
2817 SYNTAX_COMSTART_SECOND (c1
)))
2818 /* Duplicate code to avoid a complex if-expression
2819 which causes trouble for the SGI compiler. */
2821 /* Record the comment style we have entered so that only
2822 the comment-end sequence of the same style actually
2823 terminates the comment section. */
2824 state
.comstyle
= SYNTAX_COMMENT_STYLE (c1
);
2825 comnested
= SYNTAX_FLAGS_COMMENT_NESTED (prev_from_syntax
);
2826 comnested
= comnested
|| SYNTAX_COMMENT_NESTED (c1
);
2827 state
.incomment
= comnested
? 1 : -1;
2828 state
.comstr_start
= prev_from
;
2832 else if (code
== Scomment_fence
)
2834 /* Record the comment style we have entered so that only
2835 the comment-end sequence of the same style actually
2836 terminates the comment section. */
2837 state
.comstyle
= ST_COMMENT_STYLE
;
2838 state
.incomment
= -1;
2839 state
.comstr_start
= prev_from
;
2842 else if (code
== Scomment
)
2844 state
.comstyle
= SYNTAX_FLAGS_COMMENT_STYLE (prev_from_syntax
);
2845 state
.incomment
= (SYNTAX_FLAGS_COMMENT_NESTED (prev_from_syntax
) ?
2847 state
.comstr_start
= prev_from
;
2850 if (SYNTAX_FLAGS_PREFIX (prev_from_syntax
))
2852 switch (SWITCH_ENUM_CAST (code
))
2856 if (stopbefore
) goto stop
; /* this arg means stop at sexp start */
2857 curlevel
->last
= prev_from
;
2859 if (from
== end
) goto endquoted
;
2862 /* treat following character as a word constituent */
2865 if (stopbefore
) goto stop
; /* this arg means stop at sexp start */
2866 curlevel
->last
= prev_from
;
2870 /* Some compilers can't handle this inside the switch. */
2871 temp
= FETCH_CHAR (from_byte
);
2872 temp
= SYNTAX (temp
);
2878 if (from
== end
) goto endquoted
;
2890 curlevel
->prev
= curlevel
->last
;
2893 case Scomment_fence
: /* Can't happen because it's handled above. */
2895 if (commentstop
|| boundary_stop
) goto done
;
2897 /* The (from == BEGV) test was to enter the loop in the middle so
2898 that we find a 2-char comment ender even if we start in the
2899 middle of it. We don't want to do that if we're just at the
2900 beginning of the comment (think of (*) ... (*)). */
2901 found
= forw_comment (from
, from_byte
, end
,
2902 state
.incomment
, state
.comstyle
,
2903 (from
== BEGV
|| from
< state
.comstr_start
+ 3)
2904 ? 0 : prev_from_syntax
,
2905 &out_charpos
, &out_bytepos
, &state
.incomment
);
2906 from
= out_charpos
; from_byte
= out_bytepos
;
2907 /* Beware! prev_from and friends are invalid now.
2908 Luckily, the `done' doesn't use them and the INC_FROM
2909 sets them to a sane value without looking at them. */
2910 if (!found
) goto done
;
2912 state
.incomment
= 0;
2913 state
.comstyle
= 0; /* reset the comment style */
2914 if (boundary_stop
) goto done
;
2918 if (stopbefore
) goto stop
; /* this arg means stop at sexp start */
2920 /* curlevel++->last ran into compiler bug on Apollo */
2921 curlevel
->last
= prev_from
;
2922 if (++curlevel
== endlevel
)
2923 curlevel
--; /* error ("Nesting too deep for parser"); */
2924 curlevel
->prev
= -1;
2925 curlevel
->last
= -1;
2926 if (targetdepth
== depth
) goto done
;
2931 if (depth
< mindepth
)
2933 if (curlevel
!= levelstart
)
2935 curlevel
->prev
= curlevel
->last
;
2936 if (targetdepth
== depth
) goto done
;
2941 state
.comstr_start
= from
- 1;
2942 if (stopbefore
) goto stop
; /* this arg means stop at sexp start */
2943 curlevel
->last
= prev_from
;
2944 state
.instring
= (code
== Sstring
2945 ? (FETCH_CHAR (prev_from_byte
))
2947 if (boundary_stop
) goto done
;
2950 nofence
= state
.instring
!= ST_STRING_STYLE
;
2956 if (from
>= end
) goto done
;
2957 c
= FETCH_CHAR (from_byte
);
2958 /* Some compilers can't handle this inside the switch. */
2961 /* Check TEMP here so that if the char has
2962 a syntax-table property which says it is NOT
2963 a string character, it does not end the string. */
2964 if (nofence
&& c
== state
.instring
&& temp
== Sstring
)
2970 if (!nofence
) goto string_end
;
2975 startquotedinstring
:
2976 if (from
>= end
) goto endquoted
;
2982 state
.instring
= -1;
2983 curlevel
->prev
= curlevel
->last
;
2985 if (boundary_stop
) goto done
;
2989 /* FIXME: We should do something with it. */
2992 /* Ignore whitespace, punctuation, quote, endcomment. */
2998 stop
: /* Here if stopping before start of sexp. */
2999 from
= prev_from
; /* We have just fetched the char that starts it; */
3000 goto done
; /* but return the position before it. */
3005 state
.depth
= depth
;
3006 state
.mindepth
= mindepth
;
3007 state
.thislevelstart
= curlevel
->prev
;
3008 state
.prevlevelstart
3009 = (curlevel
== levelstart
) ? -1 : (curlevel
- 1)->last
;
3010 state
.location
= from
;
3011 state
.levelstarts
= Qnil
;
3012 while (--curlevel
>= levelstart
)
3013 state
.levelstarts
= Fcons (make_number (curlevel
->last
),
3020 DEFUN ("parse-partial-sexp", Fparse_partial_sexp
, Sparse_partial_sexp
, 2, 6, 0,
3021 doc
: /* Parse Lisp syntax starting at FROM until TO; return status of parse at TO.
3022 Parsing stops at TO or when certain criteria are met;
3023 point is set to where parsing stops.
3024 If fifth arg OLDSTATE is omitted or nil,
3025 parsing assumes that FROM is the beginning of a function.
3026 Value is a list of elements describing final state of parsing:
3028 1. character address of start of innermost containing list; nil if none.
3029 2. character address of start of last complete sexp terminated.
3030 3. non-nil if inside a string.
3031 (it is the character that will terminate the string,
3032 or t if the string should be terminated by a generic string delimiter.)
3033 4. nil if outside a comment, t if inside a non-nestable comment,
3034 else an integer (the current comment nesting).
3035 5. t if following a quote character.
3036 6. the minimum paren-depth encountered during this scan.
3037 7. t if in a comment of style b; symbol `syntax-table' if the comment
3038 should be terminated by a generic comment delimiter.
3039 8. character address of start of comment or string; nil if not in one.
3040 9. Intermediate data for continuation of parsing (subject to change).
3041 If third arg TARGETDEPTH is non-nil, parsing stops if the depth
3042 in parentheses becomes equal to TARGETDEPTH.
3043 Fourth arg STOPBEFORE non-nil means stop when come to
3044 any character that starts a sexp.
3045 Fifth arg OLDSTATE is a list like what this function returns.
3046 It is used to initialize the state of the parse. Elements number 1, 2, 6
3047 and 8 are ignored; you can leave off element 8 (the last) entirely.
3048 Sixth arg COMMENTSTOP non-nil means stop at the start of a comment.
3049 If it is symbol `syntax-table', stop after the start of a comment or a
3050 string, or after end of a comment or a string. */)
3051 (from
, to
, targetdepth
, stopbefore
, oldstate
, commentstop
)
3052 Lisp_Object from
, to
, targetdepth
, stopbefore
, oldstate
, commentstop
;
3054 struct lisp_parse_state state
;
3057 if (!NILP (targetdepth
))
3059 CHECK_NUMBER (targetdepth
);
3060 target
= XINT (targetdepth
);
3063 target
= -100000; /* We won't reach this depth */
3065 validate_region (&from
, &to
);
3066 scan_sexps_forward (&state
, XINT (from
), CHAR_TO_BYTE (XINT (from
)),
3068 target
, !NILP (stopbefore
), oldstate
,
3070 ? 0 : (EQ (commentstop
, Qsyntax_table
) ? -1 : 1)));
3072 SET_PT (state
.location
);
3074 return Fcons (make_number (state
.depth
),
3075 Fcons (state
.prevlevelstart
< 0 ? Qnil
: make_number (state
.prevlevelstart
),
3076 Fcons (state
.thislevelstart
< 0 ? Qnil
: make_number (state
.thislevelstart
),
3077 Fcons (state
.instring
>= 0
3078 ? (state
.instring
== ST_STRING_STYLE
3079 ? Qt
: make_number (state
.instring
)) : Qnil
,
3080 Fcons (state
.incomment
< 0 ? Qt
:
3081 (state
.incomment
== 0 ? Qnil
:
3082 make_number (state
.incomment
)),
3083 Fcons (state
.quoted
? Qt
: Qnil
,
3084 Fcons (make_number (state
.mindepth
),
3085 Fcons ((state
.comstyle
3086 ? (state
.comstyle
== ST_COMMENT_STYLE
3087 ? Qsyntax_table
: Qt
) :
3089 Fcons (((state
.incomment
3090 || (state
.instring
>= 0))
3091 ? make_number (state
.comstr_start
)
3093 Fcons (state
.levelstarts
, Qnil
))))))))));
3102 /* This has to be done here, before we call Fmake_char_table. */
3103 Qsyntax_table
= intern ("syntax-table");
3104 staticpro (&Qsyntax_table
);
3106 /* Intern this now in case it isn't already done.
3107 Setting this variable twice is harmless.
3108 But don't staticpro it here--that is done in alloc.c. */
3109 Qchar_table_extra_slots
= intern ("char-table-extra-slots");
3111 /* Create objects which can be shared among syntax tables. */
3112 Vsyntax_code_object
= Fmake_vector (make_number (Smax
), Qnil
);
3113 for (i
= 0; i
< XVECTOR (Vsyntax_code_object
)->size
; i
++)
3114 XVECTOR (Vsyntax_code_object
)->contents
[i
]
3115 = Fcons (make_number (i
), Qnil
);
3117 /* Now we are ready to set up this property, so we can
3118 create syntax tables. */
3119 Fput (Qsyntax_table
, Qchar_table_extra_slots
, make_number (0));
3121 temp
= XVECTOR (Vsyntax_code_object
)->contents
[(int) Swhitespace
];
3123 Vstandard_syntax_table
= Fmake_char_table (Qsyntax_table
, temp
);
3125 temp
= XVECTOR (Vsyntax_code_object
)->contents
[(int) Sword
];
3126 for (i
= 'a'; i
<= 'z'; i
++)
3127 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, i
, temp
);
3128 for (i
= 'A'; i
<= 'Z'; i
++)
3129 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, i
, temp
);
3130 for (i
= '0'; i
<= '9'; i
++)
3131 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, i
, temp
);
3133 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, '$', temp
);
3134 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, '%', temp
);
3136 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, '(',
3137 Fcons (make_number (Sopen
), make_number (')')));
3138 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, ')',
3139 Fcons (make_number (Sclose
), make_number ('(')));
3140 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, '[',
3141 Fcons (make_number (Sopen
), make_number (']')));
3142 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, ']',
3143 Fcons (make_number (Sclose
), make_number ('[')));
3144 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, '{',
3145 Fcons (make_number (Sopen
), make_number ('}')));
3146 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, '}',
3147 Fcons (make_number (Sclose
), make_number ('{')));
3148 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, '"',
3149 Fcons (make_number ((int) Sstring
), Qnil
));
3150 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, '\\',
3151 Fcons (make_number ((int) Sescape
), Qnil
));
3153 temp
= XVECTOR (Vsyntax_code_object
)->contents
[(int) Ssymbol
];
3154 for (i
= 0; i
< 10; i
++)
3156 c
= "_-+*/&|<>="[i
];
3157 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, c
, temp
);
3160 temp
= XVECTOR (Vsyntax_code_object
)->contents
[(int) Spunct
];
3161 for (i
= 0; i
< 12; i
++)
3163 c
= ".,;:?!#@~^'`"[i
];
3164 SET_RAW_SYNTAX_ENTRY (Vstandard_syntax_table
, c
, temp
);
3167 /* All multibyte characters have syntax `word' by default. */
3168 temp
= XVECTOR (Vsyntax_code_object
)->contents
[(int) Sword
];
3169 for (i
= CHAR_TABLE_SINGLE_BYTE_SLOTS
; i
< CHAR_TABLE_ORDINARY_SLOTS
; i
++)
3170 XCHAR_TABLE (Vstandard_syntax_table
)->contents
[i
] = temp
;
3176 Qsyntax_table_p
= intern ("syntax-table-p");
3177 staticpro (&Qsyntax_table_p
);
3179 staticpro (&Vsyntax_code_object
);
3181 staticpro (&gl_state
.object
);
3182 staticpro (&gl_state
.global_code
);
3183 staticpro (&gl_state
.current_syntax_table
);
3184 staticpro (&gl_state
.old_prop
);
3186 /* Defined in regex.c */
3187 staticpro (&re_match_object
);
3189 Qscan_error
= intern ("scan-error");
3190 staticpro (&Qscan_error
);
3191 Fput (Qscan_error
, Qerror_conditions
,
3192 Fcons (Qscan_error
, Fcons (Qerror
, Qnil
)));
3193 Fput (Qscan_error
, Qerror_message
,
3194 build_string ("Scan error"));
3196 DEFVAR_BOOL ("parse-sexp-ignore-comments", &parse_sexp_ignore_comments
,
3197 doc
: /* Non-nil means `forward-sexp', etc., should treat comments as whitespace. */);
3199 DEFVAR_BOOL ("parse-sexp-lookup-properties", &parse_sexp_lookup_properties
,
3200 doc
: /* Non-nil means `forward-sexp', etc., obey `syntax-table' property.
3201 Otherwise, that text property is simply ignored.
3202 See the info node `(elisp)Syntax Properties' for a description of the
3203 `syntax-table' property. */);
3205 words_include_escapes
= 0;
3206 DEFVAR_BOOL ("words-include-escapes", &words_include_escapes
,
3207 doc
: /* Non-nil means `forward-word', etc., should treat escape chars part of words. */);
3209 DEFVAR_BOOL ("multibyte-syntax-as-symbol", &multibyte_syntax_as_symbol
,
3210 doc
: /* Non-nil means `scan-sexps' treats all multibyte characters as symbol. */);
3211 multibyte_syntax_as_symbol
= 0;
3213 DEFVAR_BOOL ("open-paren-in-column-0-is-defun-start",
3214 &open_paren_in_column_0_is_defun_start
,
3215 doc
: /* *Non-nil means an open paren in column 0 denotes the start of a defun. */);
3216 open_paren_in_column_0_is_defun_start
= 1;
3218 defsubr (&Ssyntax_table_p
);
3219 defsubr (&Ssyntax_table
);
3220 defsubr (&Sstandard_syntax_table
);
3221 defsubr (&Scopy_syntax_table
);
3222 defsubr (&Sset_syntax_table
);
3223 defsubr (&Schar_syntax
);
3224 defsubr (&Smatching_paren
);
3225 defsubr (&Sstring_to_syntax
);
3226 defsubr (&Smodify_syntax_entry
);
3227 defsubr (&Sinternal_describe_syntax_value
);
3229 defsubr (&Sforward_word
);
3231 defsubr (&Sskip_chars_forward
);
3232 defsubr (&Sskip_chars_backward
);
3233 defsubr (&Sskip_syntax_forward
);
3234 defsubr (&Sskip_syntax_backward
);
3236 defsubr (&Sforward_comment
);
3237 defsubr (&Sscan_lists
);
3238 defsubr (&Sscan_sexps
);
3239 defsubr (&Sbackward_prefix_chars
);
3240 defsubr (&Sparse_partial_sexp
);
3243 /* arch-tag: 3e297b9f-088e-4b64-8f4c-fb0b3443e412
3244 (do not change this comment) */