1 /* GNU Emacs routines to deal with syntax tables; also word and list parsing.
2 Copyright (C) 1985, 1987, 1993 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, 675 Mass Ave, Cambridge, MA 02139, USA. */
28 Lisp_Object Qsyntax_table_p
;
30 static void scan_sexps_forward ();
31 static int char_quoted ();
33 int words_include_escapes
;
35 /* This is the internal form of the parse state used in parse-partial-sexp. */
37 struct lisp_parse_state
39 int depth
; /* Depth at end of parsing */
40 int instring
; /* -1 if not within string, else desired terminator. */
41 int incomment
; /* Nonzero if within a comment at end of parsing */
42 int comstyle
; /* comment style a=0, or b=1 */
43 int quoted
; /* Nonzero if just after an escape char at end of parsing */
44 int thislevelstart
; /* Char number of most recent start-of-expression at current level */
45 int prevlevelstart
; /* Char number of start of containing expression */
46 int location
; /* Char number at which parsing stopped. */
47 int mindepth
; /* Minimum depth seen while scanning. */
48 int comstart
; /* Position just after last comment starter. */
51 /* These variables are a cache for finding the start of a defun.
52 find_start_pos is the place for which the defun start was found.
53 find_start_value is the defun start position found for it.
54 find_start_buffer is the buffer it was found in.
55 find_start_begv is the BEGV value when it was found.
56 find_start_modiff is the value of MODIFF when it was found. */
58 static int find_start_pos
;
59 static int find_start_value
;
60 static struct buffer
*find_start_buffer
;
61 static int find_start_begv
;
62 static int find_start_modiff
;
64 /* Find a defun-start that is the last one before POS (or nearly the last).
65 We record what we find, so that another call in the same area
66 can return the same value right away. */
69 find_defun_start (pos
)
75 /* Use previous finding, if it's valid and applies to this inquiry. */
76 if (current_buffer
== find_start_buffer
77 /* Reuse the defun-start even if POS is a little farther on.
78 POS might be in the next defun, but that's ok.
79 Our value may not be the best possible, but will still be usable. */
80 && pos
<= find_start_pos
+ 1000
81 && pos
>= find_start_value
82 && BEGV
== find_start_begv
83 && MODIFF
== find_start_modiff
)
84 return find_start_value
;
86 /* Back up to start of line. */
87 tem
= scan_buffer ('\n', pos
, -1, &shortage
);
91 /* Open-paren at start of line means we found our defun-start. */
92 if (SYNTAX (FETCH_CHAR (tem
)) == Sopen
)
94 /* Move to beg of previous line. */
95 tem
= scan_buffer ('\n', tem
, -2, &shortage
);
98 /* Record what we found, for the next try. */
99 find_start_value
= tem
;
100 find_start_buffer
= current_buffer
;
101 find_start_modiff
= MODIFF
;
102 find_start_begv
= BEGV
;
103 find_start_pos
= pos
;
105 return find_start_value
;
108 DEFUN ("syntax-table-p", Fsyntax_table_p
, Ssyntax_table_p
, 1, 1, 0,
109 "Return t if ARG is a syntax table.\n\
110 Any vector of 256 elements will do.")
114 if (XTYPE (obj
) == Lisp_Vector
&& XVECTOR (obj
)->size
== 0400)
120 check_syntax_table (obj
)
123 register Lisp_Object tem
;
124 while (tem
= Fsyntax_table_p (obj
),
126 obj
= wrong_type_argument (Qsyntax_table_p
, obj
);
131 DEFUN ("syntax-table", Fsyntax_table
, Ssyntax_table
, 0, 0, 0,
132 "Return the current syntax table.\n\
133 This is the one specified by the current buffer.")
136 return current_buffer
->syntax_table
;
139 DEFUN ("standard-syntax-table", Fstandard_syntax_table
,
140 Sstandard_syntax_table
, 0, 0, 0,
141 "Return the standard syntax table.\n\
142 This is the one used for new buffers.")
145 return Vstandard_syntax_table
;
148 DEFUN ("copy-syntax-table", Fcopy_syntax_table
, Scopy_syntax_table
, 0, 1, 0,
149 "Construct a new syntax table and return it.\n\
150 It is a copy of the TABLE, which defaults to the standard syntax table.")
154 Lisp_Object size
, val
;
155 XFASTINT (size
) = 0400;
157 val
= Fmake_vector (size
, val
);
159 table
= check_syntax_table (table
);
160 else if (NILP (Vstandard_syntax_table
))
161 /* Can only be null during initialization */
163 else table
= Vstandard_syntax_table
;
165 bcopy (XVECTOR (table
)->contents
,
166 XVECTOR (val
)->contents
, 0400 * sizeof (Lisp_Object
));
170 DEFUN ("set-syntax-table", Fset_syntax_table
, Sset_syntax_table
, 1, 1, 0,
171 "Select a new syntax table for the current buffer.\n\
172 One argument, a syntax table.")
176 table
= check_syntax_table (table
);
177 current_buffer
->syntax_table
= table
;
178 /* Indicate that this buffer now has a specified syntax table. */
179 current_buffer
->local_var_flags
180 |= XFASTINT (buffer_local_flags
.syntax_table
);
184 /* Convert a letter which signifies a syntax code
185 into the code it signifies.
186 This is used by modify-syntax-entry, and other things. */
188 unsigned char syntax_spec_code
[0400] =
189 { 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
190 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
191 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
192 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
193 (char) Swhitespace
, 0377, (char) Sstring
, 0377,
194 (char) Smath
, 0377, 0377, (char) Squote
,
195 (char) Sopen
, (char) Sclose
, 0377, 0377,
196 0377, (char) Swhitespace
, (char) Spunct
, (char) Scharquote
,
197 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
198 0377, 0377, 0377, 0377,
199 (char) Scomment
, 0377, (char) Sendcomment
, 0377,
200 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377, /* @, A, ... */
201 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
202 0377, 0377, 0377, 0377, 0377, 0377, 0377, (char) Sword
,
203 0377, 0377, 0377, 0377, (char) Sescape
, 0377, 0377, (char) Ssymbol
,
204 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377, /* `, a, ... */
205 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
206 0377, 0377, 0377, 0377, 0377, 0377, 0377, (char) Sword
,
207 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377
210 /* Indexed by syntax code, give the letter that describes it. */
212 char syntax_code_spec
[13] =
214 ' ', '.', 'w', '_', '(', ')', '\'', '\"', '$', '\\', '/', '<', '>'
217 DEFUN ("char-syntax", Fchar_syntax
, Schar_syntax
, 1, 1, 0,
218 "Return the syntax code of CHAR, described by a character.\n\
219 For example, if CHAR is a word constituent, the character `?w' is returned.\n\
220 The characters that correspond to various syntax codes\n\
221 are listed in the documentation of `modify-syntax-entry'.")
225 CHECK_NUMBER (ch
, 0);
226 return make_number (syntax_code_spec
[(int) SYNTAX (0xFF & XINT (ch
))]);
229 /* This comment supplies the doc string for modify-syntax-entry,
230 for make-docfile to see. We cannot put this in the real DEFUN
231 due to limits in the Unix cpp.
233 DEFUN ("modify-syntax-entry", foo, bar, 0, 0, 0,
234 "Set syntax for character CHAR according to string S.\n\
235 The syntax is changed only for table TABLE, which defaults to\n\
236 the current buffer's syntax table.\n\
237 The first character of S should be one of the following:\n\
238 Space or - whitespace syntax. w word constituent.\n\
239 _ symbol constituent. . punctuation.\n\
240 ( open-parenthesis. ) close-parenthesis.\n\
241 \" string quote. \\ escape.\n\
242 $ paired delimiter. ' expression quote or prefix operator.\n\
243 < comment starter. > comment ender.\n\
244 / character-quote.\n\
245 Only single-character comment start and end sequences are represented thus.\n\
246 Two-character sequences are represented as described below.\n\
247 The second character of S is the matching parenthesis,\n\
248 used only if the first character is `(' or `)'.\n\
249 Any additional characters are flags.\n\
250 Defined flags are the characters 1, 2, 3, 4, b, and p.\n\
251 1 means C is the start of a two-char comment start sequence.\n\
252 2 means C is the second character of such a sequence.\n\
253 3 means C is the start of a two-char comment end sequence.\n\
254 4 means C is the second character of such a sequence.\n\
256 There can be up to two orthogonal comment sequences. This is to support\n\
257 language modes such as C++. By default, all comment sequences are of style\n\
258 a, but you can set the comment sequence style to b (on the second character of a\n\
259 comment-start, or the first character of a comment-end sequence) by using\n\
261 b means C is part of comment sequence b.\n\
263 p means C is a prefix character for `backward-prefix-chars';\n\
264 such characters are treated as whitespace when they occur\n\
265 between expressions.")
269 DEFUN ("modify-syntax-entry", Fmodify_syntax_entry
, Smodify_syntax_entry
, 2, 3,
270 /* I really don't know why this is interactive
271 help-form should at least be made useful whilst reading the second arg
273 "cSet syntax for character: \nsSet syntax for %s to: ",
274 0 /* See immediately above */)
275 (c
, newentry
, syntax_table
)
276 Lisp_Object c
, newentry
, syntax_table
;
278 register unsigned char *p
, match
;
279 register enum syntaxcode code
;
283 CHECK_STRING (newentry
, 1);
284 if (NILP (syntax_table
))
285 syntax_table
= current_buffer
->syntax_table
;
287 syntax_table
= check_syntax_table (syntax_table
);
289 p
= XSTRING (newentry
)->data
;
290 code
= (enum syntaxcode
) syntax_spec_code
[*p
++];
291 if (((int) code
& 0377) == 0377)
292 error ("invalid syntax description letter: %c", c
);
296 if (match
== ' ') match
= 0;
298 XFASTINT (val
) = (match
<< 8) + (int) code
;
303 XFASTINT (val
) |= 1 << 16;
307 XFASTINT (val
) |= 1 << 17;
311 XFASTINT (val
) |= 1 << 18;
315 XFASTINT (val
) |= 1 << 19;
319 XFASTINT (val
) |= 1 << 20;
323 XFASTINT (val
) |= 1 << 21;
327 XVECTOR (syntax_table
)->contents
[0xFF & XINT (c
)] = val
;
332 /* Dump syntax table to buffer in human-readable format */
335 describe_syntax (value
)
338 register enum syntaxcode code
;
339 char desc
, match
, start1
, start2
, end1
, end2
, prefix
, comstyle
;
342 Findent_to (make_number (16), make_number (1));
344 if (XTYPE (value
) != Lisp_Int
)
346 insert_string ("invalid");
350 code
= (enum syntaxcode
) (XINT (value
) & 0377);
351 match
= (XINT (value
) >> 8) & 0377;
352 start1
= (XINT (value
) >> 16) & 1;
353 start2
= (XINT (value
) >> 17) & 1;
354 end1
= (XINT (value
) >> 18) & 1;
355 end2
= (XINT (value
) >> 19) & 1;
356 prefix
= (XINT (value
) >> 20) & 1;
357 comstyle
= (XINT (value
) >> 21) & 1;
359 if ((int) code
< 0 || (int) code
>= (int) Smax
)
361 insert_string ("invalid");
364 desc
= syntax_code_spec
[(int) code
];
366 str
[0] = desc
, str
[1] = 0;
369 str
[0] = match
? match
: ' ';
388 insert_string ("\twhich means: ");
390 #ifdef SWITCH_ENUM_BUG
397 insert_string ("whitespace"); break;
399 insert_string ("punctuation"); break;
401 insert_string ("word"); break;
403 insert_string ("symbol"); break;
405 insert_string ("open"); break;
407 insert_string ("close"); break;
409 insert_string ("quote"); break;
411 insert_string ("string"); break;
413 insert_string ("math"); break;
415 insert_string ("escape"); break;
417 insert_string ("charquote"); break;
419 insert_string ("comment"); break;
421 insert_string ("endcomment"); break;
423 insert_string ("invalid");
429 insert_string (", matches ");
434 insert_string (",\n\t is the first character of a comment-start sequence");
436 insert_string (",\n\t is the second character of a comment-start sequence");
439 insert_string (",\n\t is the first character of a comment-end sequence");
441 insert_string (",\n\t is the second character of a comment-end sequence");
443 insert_string (" (comment style b)");
446 insert_string (",\n\t is a prefix character for `backward-prefix-chars'");
448 insert_string ("\n");
452 describe_syntax_1 (vector
)
455 struct buffer
*old
= current_buffer
;
456 set_buffer_internal (XBUFFER (Vstandard_output
));
457 describe_vector (vector
, Qnil
, describe_syntax
, 0, Qnil
);
458 set_buffer_internal (old
);
462 DEFUN ("describe-syntax", Fdescribe_syntax
, Sdescribe_syntax
, 0, 0, "",
463 "Describe the syntax specifications in the syntax table.\n\
464 The descriptions are inserted in a buffer, which is then displayed.")
467 internal_with_output_to_temp_buffer
468 ("*Help*", describe_syntax_1
, current_buffer
->syntax_table
);
473 /* Return the position across COUNT words from FROM.
474 If that many words cannot be found before the end of the buffer, return 0.
475 COUNT negative means scan backward and stop at word beginning. */
477 scan_words (from
, count
)
478 register int from
, count
;
480 register int beg
= BEGV
;
481 register int end
= ZV
;
496 code
= SYNTAX (FETCH_CHAR (from
));
497 if (words_include_escapes
498 && (code
== Sescape
|| code
== Scharquote
))
506 if (from
== end
) break;
507 code
= SYNTAX (FETCH_CHAR (from
));
508 if (!(words_include_escapes
509 && (code
== Sescape
|| code
== Scharquote
)))
525 code
= SYNTAX (FETCH_CHAR (from
- 1));
526 if (words_include_escapes
527 && (code
== Sescape
|| code
== Scharquote
))
535 if (from
== beg
) break;
536 code
= SYNTAX (FETCH_CHAR (from
- 1));
537 if (!(words_include_escapes
538 && (code
== Sescape
|| code
== Scharquote
)))
551 DEFUN ("forward-word", Fforward_word
, Sforward_word
, 1, 1, "p",
552 "Move point forward ARG words (backward if ARG is negative).\n\
553 Normally returns t.\n\
554 If an edge of the buffer is reached, point is left there\n\
555 and nil is returned.")
560 CHECK_NUMBER (count
, 0);
562 if (!(val
= scan_words (point
, XINT (count
))))
564 SET_PT (XINT (count
) > 0 ? ZV
: BEGV
);
571 DEFUN ("forward-comment", Fforward_comment
, Sforward_comment
, 1, 1, 0,
572 "Move forward across up to N comments. If N is negative, move backward.\n\
573 Stop scanning if we find something other than a comment or whitespace.\n\
574 Set point to where scanning stops.\n\
575 If N comments are found as expected, with nothing except whitespace\n\
576 between them, return t; otherwise return nil.")
583 register enum syntaxcode code
;
584 int comstyle
= 0; /* style of comment encountered */
588 CHECK_NUMBER (count
, 0);
589 count1
= XINT (count
);
601 c
= FETCH_CHAR (from
);
605 if (from
< stop
&& SYNTAX_COMSTART_FIRST (c
)
606 && SYNTAX_COMSTART_SECOND (FETCH_CHAR (from
)))
608 /* we have encountered a comment start sequence and we
609 are ignoring all text inside comments. we must record
610 the comment style this sequence begins so that later,
611 only a comment end of the same style actually ends
612 the comment section */
614 comstyle
= SYNTAX_COMMENT_STYLE (FETCH_CHAR (from
));
618 if (code
== Scomment
)
628 c
= FETCH_CHAR (from
);
629 if (SYNTAX (c
) == Sendcomment
630 && SYNTAX_COMMENT_STYLE (c
) == comstyle
)
631 /* we have encountered a comment end of the same style
632 as the comment sequence which began this comment
636 if (from
< stop
&& SYNTAX_COMEND_FIRST (c
)
637 && SYNTAX_COMEND_SECOND (FETCH_CHAR (from
))
638 && SYNTAX_COMMENT_STYLE (c
) == comstyle
)
639 /* we have encountered a comment end of the same style
640 as the comment sequence which began this comment
644 /* We have skipped one comment. */
647 else if (code
!= Swhitespace
&& code
!= Sendcomment
)
655 /* End of comment reached */
667 quoted
= char_quoted (from
);
670 c
= FETCH_CHAR (from
);
673 if (from
> stop
&& SYNTAX_COMEND_SECOND (c
)
674 && SYNTAX_COMEND_FIRST (FETCH_CHAR (from
- 1))
675 && !char_quoted (from
- 1))
677 /* we must record the comment style encountered so that
678 later, we can match only the proper comment begin
679 sequence of the same style */
681 comstyle
= SYNTAX_COMMENT_STYLE (FETCH_CHAR (from
- 1));
685 if (code
== Sendcomment
&& !quoted
)
688 if (code
!= SYNTAX (c
))
689 /* For a two-char comment ender, we can assume
690 it does end a comment. So scan back in a simple way. */
692 if (from
!= stop
) from
--;
695 if (SYNTAX (c
= FETCH_CHAR (from
)) == Scomment
696 && SYNTAX_COMMENT_STYLE (c
) == comstyle
)
705 if (SYNTAX_COMSTART_SECOND (c
)
706 && SYNTAX_COMSTART_FIRST (FETCH_CHAR (from
))
707 && SYNTAX_COMMENT_STYLE (c
) == comstyle
708 && !char_quoted (from
))
715 /* Look back, counting the parity of string-quotes,
716 and recording the comment-starters seen.
717 When we reach a safe place, assume that's not in a string;
718 then step the main scan to the earliest comment-starter seen
719 an even number of string quotes away from the safe place.
721 OFROM[I] is position of the earliest comment-starter seen
722 which is I+2X quotes from the comment-end.
723 PARITY is current parity of quotes from the comment end. */
726 char my_stringend
= 0;
727 int string_lossage
= 0;
728 int comment_end
= from
;
729 int comstart_pos
= 0;
730 int comstart_parity
= 0;
732 /* At beginning of range to scan, we're outside of strings;
733 that determines quote parity to the comment-end. */
736 /* Move back and examine a character. */
739 c
= FETCH_CHAR (from
);
742 /* If this char is the second of a 2-char comment sequence,
743 back up and give the pair the appropriate syntax. */
744 if (from
> stop
&& SYNTAX_COMEND_SECOND (c
)
745 && SYNTAX_COMEND_FIRST (FETCH_CHAR (from
- 1)))
751 else if (from
> stop
&& SYNTAX_COMSTART_SECOND (c
)
752 && SYNTAX_COMSTART_FIRST (FETCH_CHAR (from
- 1))
753 && comstyle
== SYNTAX_COMMENT_STYLE (c
))
759 /* Ignore escaped characters. */
760 if (char_quoted (from
))
763 /* Track parity of quotes. */
767 if (my_stringend
== 0)
769 /* If we have two kinds of string delimiters.
770 There's no way to grok this scanning backwards. */
771 else if (my_stringend
!= c
)
775 /* Record comment-starters according to that
776 quote-parity to the comment-end. */
777 if (code
== Scomment
)
779 comstart_parity
= parity
;
783 /* If we find another earlier comment-ender,
784 any comment-starts earlier than that don't count
785 (because they go with the earlier comment-ender). */
786 if (code
== Sendcomment
787 && SYNTAX_COMMENT_STYLE (FETCH_CHAR (from
)) == comstyle
)
790 /* Assume a defun-start point is outside of strings. */
792 && (from
== stop
|| FETCH_CHAR (from
- 1) == '\n'))
796 if (comstart_pos
== 0)
798 /* If the earliest comment starter
799 is followed by uniform paired string quotes or none,
800 we know it can't be inside a string
801 since if it were then the comment ender would be inside one.
802 So it does start a comment. Skip back to it. */
803 else if (comstart_parity
== 0 && !string_lossage
)
807 /* We had two kinds of string delimiters mixed up
808 together. Decode this going forwards.
809 Scan fwd from the previous comment ender
810 to the one in question; this records where we
811 last passed a comment starter. */
812 struct lisp_parse_state state
;
813 scan_sexps_forward (&state
, find_defun_start (comment_end
),
814 comment_end
- 1, -10000, 0, Qnil
, 0);
816 from
= state
.comstart
;
818 /* We can't grok this as a comment; scan it normally. */
823 else if ((code
!= Swhitespace
&& code
!= Scomment
) || quoted
)
839 int parse_sexp_ignore_comments
;
842 scan_lists (from
, count
, depth
, sexpflag
)
844 int count
, depth
, sexpflag
;
852 register enum syntaxcode code
;
853 int min_depth
= depth
; /* Err out if depth gets less than this. */
854 int comstyle
= 0; /* style of comment encountered */
856 if (depth
> 0) min_depth
= 0;
866 c
= FETCH_CHAR (from
);
869 if (from
< stop
&& SYNTAX_COMSTART_FIRST (c
)
870 && SYNTAX_COMSTART_SECOND (FETCH_CHAR (from
))
871 && parse_sexp_ignore_comments
)
873 /* we have encountered a comment start sequence and we
874 are ignoring all text inside comments. we must record
875 the comment style this sequence begins so that later,
876 only a comment end of the same style actually ends
877 the comment section */
879 comstyle
= SYNTAX_COMMENT_STYLE (FETCH_CHAR (from
));
883 if (SYNTAX_PREFIX (c
))
886 #ifdef SWITCH_ENUM_BUG
894 if (from
== stop
) goto lose
;
896 /* treat following character as a word constituent */
899 if (depth
|| !sexpflag
) break;
900 /* This word counts as a sexp; return at end of it. */
903 #ifdef SWITCH_ENUM_BUG
904 switch ((int) SYNTAX (FETCH_CHAR (from
)))
906 switch (SYNTAX (FETCH_CHAR (from
)))
912 if (from
== stop
) goto lose
;
926 if (!parse_sexp_ignore_comments
) break;
929 if (from
== stop
) goto done
;
930 c
= FETCH_CHAR (from
);
931 if (SYNTAX (c
) == Sendcomment
932 && SYNTAX_COMMENT_STYLE (c
) == comstyle
)
933 /* we have encountered a comment end of the same style
934 as the comment sequence which began this comment
938 if (from
< stop
&& SYNTAX_COMEND_FIRST (c
)
939 && SYNTAX_COMEND_SECOND (FETCH_CHAR (from
))
940 && SYNTAX_COMMENT_STYLE (c
) == comstyle
)
941 /* we have encountered a comment end of the same style
942 as the comment sequence which began this comment
951 if (from
!= stop
&& c
== FETCH_CHAR (from
))
961 if (!++depth
) goto done
;
966 if (!--depth
) goto done
;
967 if (depth
< min_depth
)
968 error ("Containing expression ends prematurely");
972 stringterm
= FETCH_CHAR (from
- 1);
975 if (from
>= stop
) goto lose
;
976 if (FETCH_CHAR (from
) == stringterm
) break;
977 #ifdef SWITCH_ENUM_BUG
978 switch ((int) SYNTAX (FETCH_CHAR (from
)))
980 switch (SYNTAX (FETCH_CHAR (from
)))
990 if (!depth
&& sexpflag
) goto done
;
995 /* Reached end of buffer. Error if within object, return nil if between */
996 if (depth
) goto lose
;
1001 /* End of object reached */
1012 if (quoted
= char_quoted (from
))
1014 c
= FETCH_CHAR (from
);
1016 if (from
> stop
&& SYNTAX_COMEND_SECOND (c
)
1017 && SYNTAX_COMEND_FIRST (FETCH_CHAR (from
- 1))
1018 && !char_quoted (from
- 1)
1019 && parse_sexp_ignore_comments
)
1021 /* we must record the comment style encountered so that
1022 later, we can match only the proper comment begin
1023 sequence of the same style */
1025 comstyle
= SYNTAX_COMMENT_STYLE (FETCH_CHAR (from
- 1));
1029 if (SYNTAX_PREFIX (c
))
1032 #ifdef SWITCH_ENUM_BUG
1033 switch ((int) (quoted
? Sword
: code
))
1035 switch (quoted
? Sword
: code
)
1040 if (depth
|| !sexpflag
) break;
1041 /* This word counts as a sexp; count object finished after passing it. */
1044 quoted
= char_quoted (from
- 1);
1047 if (! (quoted
|| SYNTAX (FETCH_CHAR (from
- 1)) == Sword
1048 || SYNTAX (FETCH_CHAR (from
- 1)) == Ssymbol
1049 || SYNTAX (FETCH_CHAR (from
- 1)) == Squote
))
1058 if (from
!= stop
&& c
== FETCH_CHAR (from
- 1))
1068 if (!++depth
) goto done2
;
1073 if (!--depth
) goto done2
;
1074 if (depth
< min_depth
)
1075 error ("Containing expression ends prematurely");
1079 if (!parse_sexp_ignore_comments
)
1082 if (code
!= SYNTAX (c
))
1083 /* For a two-char comment ender, we can assume
1084 it does end a comment. So scan back in a simple way. */
1086 if (from
!= stop
) from
--;
1089 if (SYNTAX (c
= FETCH_CHAR (from
)) == Scomment
1090 && SYNTAX_COMMENT_STYLE (c
) == comstyle
)
1092 if (from
== stop
) goto done
;
1094 if (SYNTAX_COMSTART_SECOND (c
)
1095 && SYNTAX_COMSTART_FIRST (FETCH_CHAR (from
))
1096 && SYNTAX_COMMENT_STYLE (c
) == comstyle
1097 && !char_quoted (from
))
1104 /* Look back, counting the parity of string-quotes,
1105 and recording the comment-starters seen.
1106 When we reach a safe place, assume that's not in a string;
1107 then step the main scan to the earliest comment-starter seen
1108 an even number of string quotes away from the safe place.
1110 OFROM[I] is position of the earliest comment-starter seen
1111 which is I+2X quotes from the comment-end.
1112 PARITY is current parity of quotes from the comment end. */
1115 char my_stringend
= 0;
1116 int string_lossage
= 0;
1117 int comment_end
= from
;
1118 int comstart_pos
= 0;
1119 int comstart_parity
= 0;
1121 /* At beginning of range to scan, we're outside of strings;
1122 that determines quote parity to the comment-end. */
1123 while (from
!= stop
)
1125 /* Move back and examine a character. */
1128 c
= FETCH_CHAR (from
);
1131 /* If this char is the second of a 2-char comment sequence,
1132 back up and give the pair the appropriate syntax. */
1133 if (from
> stop
&& SYNTAX_COMEND_SECOND (c
)
1134 && SYNTAX_COMEND_FIRST (FETCH_CHAR (from
- 1)))
1140 else if (from
> stop
&& SYNTAX_COMSTART_SECOND (c
)
1141 && SYNTAX_COMSTART_FIRST (FETCH_CHAR (from
- 1))
1142 && comstyle
== SYNTAX_COMMENT_STYLE (c
))
1148 /* Ignore escaped characters. */
1149 if (char_quoted (from
))
1152 /* Track parity of quotes. */
1153 if (code
== Sstring
)
1156 if (my_stringend
== 0)
1158 /* If we have two kinds of string delimiters.
1159 There's no way to grok this scanning backwards. */
1160 else if (my_stringend
!= c
)
1164 /* Record comment-starters according to that
1165 quote-parity to the comment-end. */
1166 if (code
== Scomment
)
1168 comstart_parity
= parity
;
1169 comstart_pos
= from
;
1172 /* If we find another earlier comment-ender,
1173 any comment-starts earlier than that don't count
1174 (because they go with the earlier comment-ender). */
1175 if (code
== Sendcomment
1176 && SYNTAX_COMMENT_STYLE (FETCH_CHAR (from
)) == comstyle
)
1179 /* Assume a defun-start point is outside of strings. */
1181 && (from
== stop
|| FETCH_CHAR (from
- 1) == '\n'))
1185 if (comstart_pos
== 0)
1187 /* If the earliest comment starter
1188 is followed by uniform paired string quotes or none,
1189 we know it can't be inside a string
1190 since if it were then the comment ender would be inside one.
1191 So it does start a comment. Skip back to it. */
1192 else if (comstart_parity
== 0 && !string_lossage
)
1193 from
= comstart_pos
;
1196 /* We had two kinds of string delimiters mixed up
1197 together. Decode this going forwards.
1198 Scan fwd from the previous comment ender
1199 to the one in question; this records where we
1200 last passed a comment starter. */
1201 struct lisp_parse_state state
;
1202 scan_sexps_forward (&state
, find_defun_start (comment_end
),
1203 comment_end
- 1, -10000, 0, Qnil
, 0);
1204 if (state
.incomment
)
1205 from
= state
.comstart
;
1207 /* We can't grok this as a comment; scan it normally. */
1214 stringterm
= FETCH_CHAR (from
);
1217 if (from
== stop
) goto lose
;
1218 if (!char_quoted (from
- 1)
1219 && stringterm
== FETCH_CHAR (from
- 1))
1224 if (!depth
&& sexpflag
) goto done2
;
1229 /* Reached start of buffer. Error if within object, return nil if between */
1230 if (depth
) goto lose
;
1241 XFASTINT (val
) = from
;
1245 error ("Unbalanced parentheses");
1253 register enum syntaxcode code
;
1254 register int beg
= BEGV
;
1255 register int quoted
= 0;
1258 && ((code
= SYNTAX (FETCH_CHAR (pos
- 1))) == Scharquote
1259 || code
== Sescape
))
1260 pos
--, quoted
= !quoted
;
1264 DEFUN ("scan-lists", Fscan_lists
, Sscan_lists
, 3, 3, 0,
1265 "Scan from character number FROM by COUNT lists.\n\
1266 Returns the character number of the position thus found.\n\
1268 If DEPTH is nonzero, paren depth begins counting from that value,\n\
1269 only places where the depth in parentheses becomes zero\n\
1270 are candidates for stopping; COUNT such places are counted.\n\
1271 Thus, a positive value for DEPTH means go out levels.\n\
1273 Comments are ignored if `parse-sexp-ignore-comments' is non-nil.\n\
1275 If the beginning or end of (the accessible part of) the buffer is reached\n\
1276 and the depth is wrong, an error is signaled.\n\
1277 If the depth is right but the count is not used up, nil is returned.")
1278 (from
, count
, depth
)
1279 Lisp_Object from
, count
, depth
;
1281 CHECK_NUMBER (from
, 0);
1282 CHECK_NUMBER (count
, 1);
1283 CHECK_NUMBER (depth
, 2);
1285 return scan_lists (XINT (from
), XINT (count
), XINT (depth
), 0);
1288 DEFUN ("scan-sexps", Fscan_sexps
, Sscan_sexps
, 2, 2, 0,
1289 "Scan from character number FROM by COUNT balanced expressions.\n\
1290 If COUNT is negative, scan backwards.\n\
1291 Returns the character number of the position thus found.\n\
1293 Comments are ignored if `parse-sexp-ignore-comments' is non-nil.\n\
1295 If the beginning or end of (the accessible part of) the buffer is reached\n\
1296 in the middle of a parenthetical grouping, an error is signaled.\n\
1297 If the beginning or end is reached between groupings\n\
1298 but before count is used up, nil is returned.")
1300 Lisp_Object from
, count
;
1302 CHECK_NUMBER (from
, 0);
1303 CHECK_NUMBER (count
, 1);
1305 return scan_lists (XINT (from
), XINT (count
), 0, 1);
1308 DEFUN ("backward-prefix-chars", Fbackward_prefix_chars
, Sbackward_prefix_chars
,
1310 "Move point backward over any number of chars with prefix syntax.\n\
1311 This includes chars with \"quote\" or \"prefix\" syntax (' or p).")
1317 while (pos
> beg
&& !char_quoted (pos
- 1)
1318 && (SYNTAX (FETCH_CHAR (pos
- 1)) == Squote
1319 || SYNTAX_PREFIX (FETCH_CHAR (pos
- 1))))
1327 /* Parse forward from FROM to END,
1328 assuming that FROM has state OLDSTATE (nil means FROM is start of function),
1329 and return a description of the state of the parse at END.
1330 If STOPBEFORE is nonzero, stop at the start of an atom.
1331 If COMMENTSTOP is nonzero, stop at the start of a comment. */
1334 scan_sexps_forward (stateptr
, from
, end
, targetdepth
,
1335 stopbefore
, oldstate
, commentstop
)
1336 struct lisp_parse_state
*stateptr
;
1338 int end
, targetdepth
, stopbefore
;
1339 Lisp_Object oldstate
;
1342 struct lisp_parse_state state
;
1344 register enum syntaxcode code
;
1345 struct level
{ int last
, prev
; };
1346 struct level levelstart
[100];
1347 register struct level
*curlevel
= levelstart
;
1348 struct level
*endlevel
= levelstart
+ 100;
1350 register int depth
; /* Paren depth of current scanning location.
1351 level - levelstart equals this except
1352 when the depth becomes negative. */
1353 int mindepth
; /* Lowest DEPTH value seen. */
1354 int start_quoted
= 0; /* Nonzero means starting after a char quote */
1360 if (NILP (oldstate
))
1363 state
.instring
= -1;
1364 state
.incomment
= 0;
1365 state
.comstyle
= 0; /* comment style a by default */
1369 tem
= Fcar (oldstate
);
1375 oldstate
= Fcdr (oldstate
);
1376 oldstate
= Fcdr (oldstate
);
1377 oldstate
= Fcdr (oldstate
);
1378 tem
= Fcar (oldstate
);
1379 state
.instring
= !NILP (tem
) ? XINT (tem
) : -1;
1381 oldstate
= Fcdr (oldstate
);
1382 tem
= Fcar (oldstate
);
1383 state
.incomment
= !NILP (tem
);
1385 oldstate
= Fcdr (oldstate
);
1386 tem
= Fcar (oldstate
);
1387 start_quoted
= !NILP (tem
);
1389 /* if the eight element of the list is nil, we are in comment
1390 style a. if it is non-nil, we are in comment style b */
1391 oldstate
= Fcdr (oldstate
);
1392 oldstate
= Fcdr (oldstate
);
1393 oldstate
= Fcdr (oldstate
);
1394 tem
= Fcar (oldstate
);
1395 state
.comstyle
= !NILP (tem
);
1400 curlevel
->prev
= -1;
1401 curlevel
->last
= -1;
1403 /* Enter the loop at a place appropriate for initial state. */
1405 if (state
.incomment
) goto startincomment
;
1406 if (state
.instring
>= 0)
1408 if (start_quoted
) goto startquotedinstring
;
1411 if (start_quoted
) goto startquoted
;
1415 code
= SYNTAX (FETCH_CHAR (from
));
1417 if (code
== Scomment
)
1418 state
.comstart
= from
-1;
1420 else if (from
< end
&& SYNTAX_COMSTART_FIRST (FETCH_CHAR (from
- 1))
1421 && SYNTAX_COMSTART_SECOND (FETCH_CHAR (from
)))
1423 /* Record the comment style we have entered so that only
1424 the comment-end sequence of the same style actually
1425 terminates the comment section. */
1427 state
.comstyle
= SYNTAX_COMMENT_STYLE (FETCH_CHAR (from
));
1428 state
.comstart
= from
-1;
1432 if (SYNTAX_PREFIX (FETCH_CHAR (from
- 1)))
1434 #ifdef SWITCH_ENUM_BUG
1442 if (stopbefore
) goto stop
; /* this arg means stop at sexp start */
1443 curlevel
->last
= from
- 1;
1445 if (from
== end
) goto endquoted
;
1448 /* treat following character as a word constituent */
1451 if (stopbefore
) goto stop
; /* this arg means stop at sexp start */
1452 curlevel
->last
= from
- 1;
1456 #ifdef SWITCH_ENUM_BUG
1457 switch ((int) SYNTAX (FETCH_CHAR (from
)))
1459 switch (SYNTAX (FETCH_CHAR (from
)))
1465 if (from
== end
) goto endquoted
;
1477 curlevel
->prev
= curlevel
->last
;
1481 state
.incomment
= 1;
1487 if (from
== end
) goto done
;
1488 prev
= FETCH_CHAR (from
);
1489 if (SYNTAX (prev
) == Sendcomment
1490 && SYNTAX_COMMENT_STYLE (prev
) == state
.comstyle
)
1491 /* Only terminate the comment section if the endcomment
1492 of the same style as the start sequence has been
1496 if (from
< end
&& SYNTAX_COMEND_FIRST (prev
)
1497 && SYNTAX_COMEND_SECOND (FETCH_CHAR (from
))
1498 && SYNTAX_COMMENT_STYLE (prev
) == state
.comstyle
)
1499 /* Only terminate the comment section if the end-comment
1500 sequence of the same style as the start sequence has
1501 been encountered. */
1504 state
.incomment
= 0;
1505 state
.comstyle
= 0; /* reset the comment style */
1509 if (stopbefore
) goto stop
; /* this arg means stop at sexp start */
1511 /* curlevel++->last ran into compiler bug on Apollo */
1512 curlevel
->last
= from
- 1;
1513 if (++curlevel
== endlevel
)
1514 error ("Nesting too deep for parser");
1515 curlevel
->prev
= -1;
1516 curlevel
->last
= -1;
1517 if (!--targetdepth
) goto done
;
1522 if (depth
< mindepth
)
1524 if (curlevel
!= levelstart
)
1526 curlevel
->prev
= curlevel
->last
;
1527 if (!++targetdepth
) goto done
;
1531 if (stopbefore
) goto stop
; /* this arg means stop at sexp start */
1532 curlevel
->last
= from
- 1;
1533 state
.instring
= FETCH_CHAR (from
- 1);
1537 if (from
>= end
) goto done
;
1538 if (FETCH_CHAR (from
) == state
.instring
) break;
1539 #ifdef SWITCH_ENUM_BUG
1540 switch ((int) SYNTAX (FETCH_CHAR (from
)))
1542 switch (SYNTAX (FETCH_CHAR (from
)))
1548 startquotedinstring
:
1549 if (from
>= end
) goto endquoted
;
1553 state
.instring
= -1;
1554 curlevel
->prev
= curlevel
->last
;
1564 stop
: /* Here if stopping before start of sexp. */
1565 from
--; /* We have just fetched the char that starts it; */
1566 goto done
; /* but return the position before it. */
1571 state
.depth
= depth
;
1572 state
.mindepth
= mindepth
;
1573 state
.thislevelstart
= curlevel
->prev
;
1574 state
.prevlevelstart
1575 = (curlevel
== levelstart
) ? -1 : (curlevel
- 1)->last
;
1576 state
.location
= from
;
1582 /* This comment supplies the doc string for parse-partial-sexp,
1583 for make-docfile to see. We cannot put this in the real DEFUN
1584 due to limits in the Unix cpp.
1586 DEFUN ("parse-partial-sexp", Ffoo, Sfoo, 2, 6, 0,
1587 "Parse Lisp syntax starting at FROM until TO; return status of parse at TO.\n\
1588 Parsing stops at TO or when certain criteria are met;\n\
1589 point is set to where parsing stops.\n\
1590 If fifth arg STATE is omitted or nil,\n\
1591 parsing assumes that FROM is the beginning of a function.\n\
1592 Value is a list of eight elements describing final state of parsing:\n\
1593 1. depth in parens.\n\
1594 2. character address of start of innermost containing list; nil if none.\n\
1595 3. character address of start of last complete sexp terminated.\n\
1596 4. non-nil if inside a string.\n\
1597 (it is the character that will terminate the string.)\n\
1598 5. t if inside a comment.\n\
1599 6. t if following a quote character.\n\
1600 7. the minimum paren-depth encountered during this scan.\n\
1601 8. t if in a comment of style `b'.\n\
1602 If third arg TARGETDEPTH is non-nil, parsing stops if the depth\n\
1603 in parentheses becomes equal to TARGETDEPTH.\n\
1604 Fourth arg STOPBEFORE non-nil means stop when come to\n\
1605 any character that starts a sexp.\n\
1606 Fifth arg STATE is a seven-list like what this function returns.\n\
1607 It is used to initialize the state of the parse. Its second and third
1608 elements are ignored.
1609 Sixth args COMMENTSTOP non-nil means stop at the start of a comment.")
1610 (from, to, targetdepth, stopbefore, state, commentstop)
1613 DEFUN ("parse-partial-sexp", Fparse_partial_sexp
, Sparse_partial_sexp
, 2, 6, 0,
1614 0 /* See immediately above */)
1615 (from
, to
, targetdepth
, stopbefore
, oldstate
, commentstop
)
1616 Lisp_Object from
, to
, targetdepth
, stopbefore
, oldstate
, commentstop
;
1618 struct lisp_parse_state state
;
1621 if (!NILP (targetdepth
))
1623 CHECK_NUMBER (targetdepth
, 3);
1624 target
= XINT (targetdepth
);
1627 target
= -100000; /* We won't reach this depth */
1629 validate_region (&from
, &to
);
1630 scan_sexps_forward (&state
, XINT (from
), XINT (to
),
1631 target
, !NILP (stopbefore
), oldstate
,
1632 !NILP (commentstop
));
1634 SET_PT (state
.location
);
1636 return Fcons (make_number (state
.depth
),
1637 Fcons (state
.prevlevelstart
< 0 ? Qnil
: make_number (state
.prevlevelstart
),
1638 Fcons (state
.thislevelstart
< 0 ? Qnil
: make_number (state
.thislevelstart
),
1639 Fcons (state
.instring
>= 0 ? make_number (state
.instring
) : Qnil
,
1640 Fcons (state
.incomment
? Qt
: Qnil
,
1641 Fcons (state
.quoted
? Qt
: Qnil
,
1642 Fcons (make_number (state
.mindepth
),
1643 Fcons (state
.comstyle
? Qt
: Qnil
,
1650 register struct Lisp_Vector
*v
;
1652 /* Set this now, so first buffer creation can refer to it. */
1653 /* Make it nil before calling copy-syntax-table
1654 so that copy-syntax-table will know not to try to copy from garbage */
1655 Vstandard_syntax_table
= Qnil
;
1656 Vstandard_syntax_table
= Fcopy_syntax_table (Qnil
);
1658 v
= XVECTOR (Vstandard_syntax_table
);
1660 for (i
= 'a'; i
<= 'z'; i
++)
1661 XFASTINT (v
->contents
[i
]) = (int) Sword
;
1662 for (i
= 'A'; i
<= 'Z'; i
++)
1663 XFASTINT (v
->contents
[i
]) = (int) Sword
;
1664 for (i
= '0'; i
<= '9'; i
++)
1665 XFASTINT (v
->contents
[i
]) = (int) Sword
;
1666 XFASTINT (v
->contents
['$']) = (int) Sword
;
1667 XFASTINT (v
->contents
['%']) = (int) Sword
;
1669 XFASTINT (v
->contents
['(']) = (int) Sopen
+ (')' << 8);
1670 XFASTINT (v
->contents
[')']) = (int) Sclose
+ ('(' << 8);
1671 XFASTINT (v
->contents
['[']) = (int) Sopen
+ (']' << 8);
1672 XFASTINT (v
->contents
[']']) = (int) Sclose
+ ('[' << 8);
1673 XFASTINT (v
->contents
['{']) = (int) Sopen
+ ('}' << 8);
1674 XFASTINT (v
->contents
['}']) = (int) Sclose
+ ('{' << 8);
1675 XFASTINT (v
->contents
['"']) = (int) Sstring
;
1676 XFASTINT (v
->contents
['\\']) = (int) Sescape
;
1678 for (i
= 0; i
< 10; i
++)
1679 XFASTINT (v
->contents
["_-+*/&|<>="[i
]]) = (int) Ssymbol
;
1681 for (i
= 0; i
< 12; i
++)
1682 XFASTINT (v
->contents
[".,;:?!#@~^'`"[i
]]) = (int) Spunct
;
1687 Qsyntax_table_p
= intern ("syntax-table-p");
1688 staticpro (&Qsyntax_table_p
);
1690 DEFVAR_BOOL ("parse-sexp-ignore-comments", &parse_sexp_ignore_comments
,
1691 "Non-nil means `forward-sexp', etc., should treat comments as whitespace.");
1693 words_include_escapes
= 0;
1694 DEFVAR_BOOL ("words-include-escapes", &words_include_escapes
,
1695 "Non-nil means `forward-word', etc., should treat escape chars part of words.");
1697 defsubr (&Ssyntax_table_p
);
1698 defsubr (&Ssyntax_table
);
1699 defsubr (&Sstandard_syntax_table
);
1700 defsubr (&Scopy_syntax_table
);
1701 defsubr (&Sset_syntax_table
);
1702 defsubr (&Schar_syntax
);
1703 defsubr (&Smodify_syntax_entry
);
1704 defsubr (&Sdescribe_syntax
);
1706 defsubr (&Sforward_word
);
1708 defsubr (&Sforward_comment
);
1709 defsubr (&Sscan_lists
);
1710 defsubr (&Sscan_sexps
);
1711 defsubr (&Sbackward_prefix_chars
);
1712 defsubr (&Sparse_partial_sexp
);