1 /* GNU Emacs routines to deal with syntax tables; also word and list parsing.
2 Copyright (C) 1985, 1987, 1992 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 int words_include_escapes
;
32 /* This is the internal form of the parse state used in parse-partial-sexp. */
34 struct lisp_parse_state
36 int depth
; /* Depth at end of parsing */
37 int instring
; /* -1 if not within string, else desired terminator. */
38 int incomment
; /* Nonzero if within a comment at end of parsing */
39 int comstyle
; /* comment style a=0, or b=1 */
40 int quoted
; /* Nonzero if just after an escape char at end of parsing */
41 int thislevelstart
; /* Char number of most recent start-of-expression at current level */
42 int prevlevelstart
; /* Char number of start of containing expression */
43 int location
; /* Char number at which parsing stopped. */
44 int mindepth
; /* Minimum depth seen while scanning. */
45 int comstart
; /* Position just after last comment starter. */
48 /* These variables are a cache for finding the start of a defun.
49 find_start_pos is the place for which the defun start was found.
50 find_start_value is the defun start position found for it.
51 find_start_buffer is the buffer it was found in.
52 find_start_begv is the BEGV value when it was found.
53 find_start_modiff is the value of MODIFF when it was found. */
55 static int find_start_pos
;
56 static int find_start_value
;
57 static struct buffer
*find_start_buffer
;
58 static int find_start_begv
;
59 static int find_start_modiff
;
61 /* Find a defun-start that is the last one before POS (or nearly the last).
62 We record what we find, so that another call in the same area
63 can return the same value right away. */
66 find_defun_start (pos
)
72 /* Use previous finding, if it's valid and applies to this inquiry. */
73 if (current_buffer
== find_start_buffer
74 /* Reuse the defun-start even if POS is a little farther on.
75 POS might be in the next defun, but that's ok.
76 Our value may not be the best possible, but will still be usable. */
77 && pos
<= find_start_pos
+ 1000
78 && pos
>= find_start_value
79 && BEGV
== find_start_begv
80 && MODIFF
== find_start_modiff
)
81 return find_start_value
;
83 /* Back up to start of line. */
84 tem
= scan_buffer ('\n', pos
, -1, &shortage
);
88 /* Open-paren at start of line means we found our defun-start. */
89 if (SYNTAX (FETCH_CHAR (tem
)) == Sopen
)
91 /* Move to beg of previous line. */
92 tem
= scan_buffer ('\n', tem
, -2, &shortage
);
95 /* Record what we found, for the next try. */
96 find_start_value
= tem
;
97 find_start_buffer
= current_buffer
;
98 find_start_modiff
= MODIFF
;
99 find_start_begv
= BEGV
;
100 find_start_pos
= pos
;
102 return find_start_value
;
105 DEFUN ("syntax-table-p", Fsyntax_table_p
, Ssyntax_table_p
, 1, 1, 0,
106 "Return t if ARG is a syntax table.\n\
107 Any vector of 256 elements will do.")
111 if (XTYPE (obj
) == Lisp_Vector
&& XVECTOR (obj
)->size
== 0400)
117 check_syntax_table (obj
)
120 register Lisp_Object tem
;
121 while (tem
= Fsyntax_table_p (obj
),
123 obj
= wrong_type_argument (Qsyntax_table_p
, obj
);
128 DEFUN ("syntax-table", Fsyntax_table
, Ssyntax_table
, 0, 0, 0,
129 "Return the current syntax table.\n\
130 This is the one specified by the current buffer.")
133 return current_buffer
->syntax_table
;
136 DEFUN ("standard-syntax-table", Fstandard_syntax_table
,
137 Sstandard_syntax_table
, 0, 0, 0,
138 "Return the standard syntax table.\n\
139 This is the one used for new buffers.")
142 return Vstandard_syntax_table
;
145 DEFUN ("copy-syntax-table", Fcopy_syntax_table
, Scopy_syntax_table
, 0, 1, 0,
146 "Construct a new syntax table and return it.\n\
147 It is a copy of the TABLE, which defaults to the standard syntax table.")
151 Lisp_Object size
, val
;
152 XFASTINT (size
) = 0400;
154 val
= Fmake_vector (size
, val
);
156 table
= check_syntax_table (table
);
157 else if (NILP (Vstandard_syntax_table
))
158 /* Can only be null during initialization */
160 else table
= Vstandard_syntax_table
;
162 bcopy (XVECTOR (table
)->contents
,
163 XVECTOR (val
)->contents
, 0400 * sizeof (Lisp_Object
));
167 DEFUN ("set-syntax-table", Fset_syntax_table
, Sset_syntax_table
, 1, 1, 0,
168 "Select a new syntax table for the current buffer.\n\
169 One argument, a syntax table.")
173 table
= check_syntax_table (table
);
174 current_buffer
->syntax_table
= table
;
175 /* Indicate that this buffer now has a specified syntax table. */
176 current_buffer
->local_var_flags
|= buffer_local_flags
.syntax_table
;
180 /* Convert a letter which signifies a syntax code
181 into the code it signifies.
182 This is used by modify-syntax-entry, and other things. */
184 unsigned char syntax_spec_code
[0400] =
185 { 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
186 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
187 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
188 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
189 (char) Swhitespace
, 0377, (char) Sstring
, 0377,
190 (char) Smath
, 0377, 0377, (char) Squote
,
191 (char) Sopen
, (char) Sclose
, 0377, 0377,
192 0377, (char) Swhitespace
, (char) Spunct
, (char) Scharquote
,
193 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
194 0377, 0377, 0377, 0377,
195 (char) Scomment
, 0377, (char) Sendcomment
, 0377,
196 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377, /* @, A, ... */
197 0377, 0377, 0377, 0377, 0377, 0377, 0377, 0377,
198 0377, 0377, 0377, 0377, 0377, 0377, 0377, (char) Sword
,
199 0377, 0377, 0377, 0377, (char) Sescape
, 0377, 0377, (char) Ssymbol
,
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, 0377, 0377, 0377, 0377
206 /* Indexed by syntax code, give the letter that describes it. */
208 char syntax_code_spec
[13] =
210 ' ', '.', 'w', '_', '(', ')', '\'', '\"', '$', '\\', '/', '<', '>'
213 DEFUN ("char-syntax", Fchar_syntax
, Schar_syntax
, 1, 1, 0,
214 "Return the syntax code of CHAR, described by a character.\n\
215 For example, if CHAR is a word constituent, the character `?w' is returned.\n\
216 The characters that correspond to various syntax codes\n\
217 are listed in the documentation of `modify-syntax-entry'.")
221 CHECK_NUMBER (ch
, 0);
222 return make_number (syntax_code_spec
[(int) SYNTAX (0xFF & XINT (ch
))]);
225 /* This comment supplies the doc string for modify-syntax-entry,
226 for make-docfile to see. We cannot put this in the real DEFUN
227 due to limits in the Unix cpp.
229 DEFUN ("modify-syntax-entry", foo, bar, 0, 0, 0,
230 "Set syntax for character CHAR according to string S.\n\
231 The syntax is changed only for table TABLE, which defaults to\n\
232 the current buffer's syntax table.\n\
233 The first character of S should be one of the following:\n\
234 Space or - whitespace syntax. w word constituent.\n\
235 _ symbol constituent. . punctuation.\n\
236 ( open-parenthesis. ) close-parenthesis.\n\
237 \" string quote. \\ escape.\n\
238 $ paired delimiter. ' expression quote or prefix operator.\n\
239 < comment starter. > comment ender.\n\
240 / character-quote.\n\
241 Only single-character comment start and end sequences are represented thus.\n\
242 Two-character sequences are represented as described below.\n\
243 The second character of S is the matching parenthesis,\n\
244 used only if the first character is `(' or `)'.\n\
245 Any additional characters are flags.\n\
246 Defined flags are the characters 1, 2, 3, 4, b, and p.\n\
247 1 means C is the start of a two-char comment start sequence.\n\
248 2 means C is the second character of such a sequence.\n\
249 3 means C is the start of a two-char comment end sequence.\n\
250 4 means C is the second character of such a sequence.\n\
252 There can be up to two orthogonal comment sequences. This is to support\n\
253 language modes such as C++. By default, all comment sequences are of style\n\
254 a, but you can set the comment sequence style to b (on the second character of a\n\
255 comment-start, or the first character of a comment-end sequence) by using\n\
257 b means C is part of comment sequence b.\n\
259 p means C is a prefix character for `backward-prefix-chars';\n\
260 such characters are treated as whitespace when they occur\n\
261 between expressions.")
265 DEFUN ("modify-syntax-entry", Fmodify_syntax_entry
, Smodify_syntax_entry
, 2, 3,
266 /* I really don't know why this is interactive
267 help-form should at least be made useful whilst reading the second arg
269 "cSet syntax for character: \nsSet syntax for %s to: ",
270 0 /* See immediately above */)
271 (c
, newentry
, syntax_table
)
272 Lisp_Object c
, newentry
, syntax_table
;
274 register unsigned char *p
, match
;
275 register enum syntaxcode code
;
279 CHECK_STRING (newentry
, 1);
280 if (NILP (syntax_table
))
281 syntax_table
= current_buffer
->syntax_table
;
283 syntax_table
= check_syntax_table (syntax_table
);
285 p
= XSTRING (newentry
)->data
;
286 code
= (enum syntaxcode
) syntax_spec_code
[*p
++];
287 if (((int) code
& 0377) == 0377)
288 error ("invalid syntax description letter: %c", c
);
292 if (match
== ' ') match
= 0;
294 XFASTINT (val
) = (match
<< 8) + (int) code
;
299 XFASTINT (val
) |= 1 << 16;
303 XFASTINT (val
) |= 1 << 17;
307 XFASTINT (val
) |= 1 << 18;
311 XFASTINT (val
) |= 1 << 19;
315 XFASTINT (val
) |= 1 << 20;
319 XFASTINT (val
) |= 1 << 21;
323 XVECTOR (syntax_table
)->contents
[0xFF & XINT (c
)] = val
;
328 /* Dump syntax table to buffer in human-readable format */
330 describe_syntax (value
)
333 register enum syntaxcode code
;
334 char desc
, match
, start1
, start2
, end1
, end2
, prefix
, comstyle
;
337 Findent_to (make_number (16), make_number (1));
339 if (XTYPE (value
) != Lisp_Int
)
341 insert_string ("invalid");
345 code
= (enum syntaxcode
) (XINT (value
) & 0377);
346 match
= (XINT (value
) >> 8) & 0377;
347 start1
= (XINT (value
) >> 16) & 1;
348 start2
= (XINT (value
) >> 17) & 1;
349 end1
= (XINT (value
) >> 18) & 1;
350 end2
= (XINT (value
) >> 19) & 1;
351 prefix
= (XINT (value
) >> 20) & 1;
352 comstyle
= (XINT (value
) >> 21) & 1;
354 if ((int) code
< 0 || (int) code
>= (int) Smax
)
356 insert_string ("invalid");
359 desc
= syntax_code_spec
[(int) code
];
361 str
[0] = desc
, str
[1] = 0;
364 str
[0] = match
? match
: ' ';
383 insert_string ("\twhich means: ");
385 #ifdef SWITCH_ENUM_BUG
392 insert_string ("whitespace"); break;
394 insert_string ("punctuation"); break;
396 insert_string ("word"); break;
398 insert_string ("symbol"); break;
400 insert_string ("open"); break;
402 insert_string ("close"); break;
404 insert_string ("quote"); break;
406 insert_string ("string"); break;
408 insert_string ("math"); break;
410 insert_string ("escape"); break;
412 insert_string ("charquote"); break;
414 insert_string ("comment"); break;
416 insert_string ("endcomment"); break;
418 insert_string ("invalid");
424 insert_string (", matches ");
429 insert_string (",\n\t is the first character of a comment-start sequence");
431 insert_string (",\n\t is the second character of a comment-start sequence");
434 insert_string (",\n\t is the first character of a comment-end sequence");
436 insert_string (",\n\t is the second character of a comment-end sequence");
438 insert_string (" (comment style b)");
441 insert_string (",\n\t is a prefix character for `backward-prefix-chars'");
443 insert_string ("\n");
447 describe_syntax_1 (vector
)
450 struct buffer
*old
= current_buffer
;
451 set_buffer_internal (XBUFFER (Vstandard_output
));
452 describe_vector (vector
, Qnil
, describe_syntax
, 0, Qnil
);
453 set_buffer_internal (old
);
457 DEFUN ("describe-syntax", Fdescribe_syntax
, Sdescribe_syntax
, 0, 0, "",
458 "Describe the syntax specifications in the syntax table.\n\
459 The descriptions are inserted in a buffer, which is then displayed.")
462 internal_with_output_to_temp_buffer
463 ("*Help*", describe_syntax_1
, current_buffer
->syntax_table
);
468 /* Return the position across COUNT words from FROM.
469 If that many words cannot be found before the end of the buffer, return 0.
470 COUNT negative means scan backward and stop at word beginning. */
472 scan_words (from
, count
)
473 register int from
, count
;
475 register int beg
= BEGV
;
476 register int end
= ZV
;
491 code
= SYNTAX (FETCH_CHAR (from
));
492 if (words_include_escapes
493 && (code
== Sescape
|| code
== Scharquote
))
501 if (from
== end
) break;
502 code
= SYNTAX (FETCH_CHAR (from
));
503 if (!(words_include_escapes
504 && (code
== Sescape
|| code
== Scharquote
)))
520 code
= SYNTAX (FETCH_CHAR (from
- 1));
521 if (words_include_escapes
522 && (code
== Sescape
|| code
== Scharquote
))
530 if (from
== beg
) break;
531 code
= SYNTAX (FETCH_CHAR (from
- 1));
532 if (!(words_include_escapes
533 && (code
== Sescape
|| code
== Scharquote
)))
546 DEFUN ("forward-word", Fforward_word
, Sforward_word
, 1, 1, "p",
547 "Move point forward ARG words (backward if ARG is negative).\n\
548 Normally returns t.\n\
549 If an edge of the buffer is reached, point is left there\n\
550 and nil is returned.")
555 CHECK_NUMBER (count
, 0);
557 if (!(val
= scan_words (point
, XINT (count
))))
559 SET_PT (XINT (count
) > 0 ? ZV
: BEGV
);
566 DEFUN ("forward-comment", Fforward_comment
, Sforward_comment
, 1, 1, 0,
567 "Move forward across up to N comments. If N is negative, move backward.\n\
568 Set point to the far end of the last comment found.\n\
569 Stop scanning if we find something other than a comment or whitespace.\n\
570 If N comments are found as expected, with nothing except whitespace\n\
571 between them, return t; otherwise return nil.")
578 register enum syntaxcode code
;
579 int comstyle
= 0; /* style of comment encountered */
591 c
= FETCH_CHAR (from
);
595 if (from
< stop
&& SYNTAX_COMSTART_FIRST (c
)
596 && SYNTAX_COMSTART_SECOND (FETCH_CHAR (from
)))
598 /* we have encountered a comment start sequence and we
599 are ignoring all text inside comments. we must record
600 the comment style this sequence begins so that later,
601 only a comment end of the same style actually ends
602 the comment section */
604 comstyle
= SYNTAX_COMMENT_STYLE (FETCH_CHAR (from
));
608 if (code
== Scomment
)
617 c
= FETCH_CHAR (from
);
618 if (SYNTAX (c
) == Sendcomment
619 && SYNTAX_COMMENT_STYLE (c
) == comstyle
)
620 /* we have encountered a comment end of the same style
621 as the comment sequence which began this comment
625 if (from
< stop
&& SYNTAX_COMEND_FIRST (c
)
626 && SYNTAX_COMEND_SECOND (FETCH_CHAR (from
))
627 && SYNTAX_COMMENT_STYLE (c
) == comstyle
)
628 /* we have encountered a comment end of the same style
629 as the comment sequence which began this comment
633 /* We have skipped one comment. */
636 else if (code
!= Swhitespace
)
643 /* End of comment reached */
655 quoted
= char_quoted (from
);
658 c
= FETCH_CHAR (from
);
661 if (from
> stop
&& SYNTAX_COMEND_SECOND (c
)
662 && SYNTAX_COMEND_FIRST (FETCH_CHAR (from
- 1))
663 && !char_quoted (from
- 1))
665 /* we must record the comment style encountered so that
666 later, we can match only the proper comment begin
667 sequence of the same style */
669 comstyle
= SYNTAX_COMMENT_STYLE (FETCH_CHAR (from
- 1));
673 if (code
== Sendcomment
&& !quoted
)
675 if (code
!= SYNTAX (c
))
676 /* For a two-char comment ender, we can assume
677 it does end a comment. So scan back in a simple way. */
679 if (from
!= stop
) from
--;
682 if (SYNTAX (c
= FETCH_CHAR (from
)) == Scomment
683 && SYNTAX_COMMENT_STYLE (c
) == comstyle
)
691 if (SYNTAX_COMSTART_SECOND (c
)
692 && SYNTAX_COMSTART_FIRST (FETCH_CHAR (from
))
693 && SYNTAX_COMMENT_STYLE (c
) == comstyle
694 && !char_quoted (from
))
700 /* Look back, counting the parity of string-quotes,
701 and recording the comment-starters seen.
702 When we reach a safe place, assume that's not in a string;
703 then step the main scan to the earliest comment-starter seen
704 an even number of string quotes away from the safe place.
706 OFROM[I] is position of the earliest comment-starter seen
707 which is I+2X quotes from the comment-end.
708 PARITY is current parity of quotes from the comment end. */
711 char my_stringend
= 0;
712 int string_lossage
= 0;
713 int comment_end
= from
;
714 int comstart_pos
= 0;
715 int comstart_parity
= 0;
717 /* At beginning of range to scan, we're outside of strings;
718 that determines quote parity to the comment-end. */
721 /* Move back and examine a character. */
724 c
= FETCH_CHAR (from
);
727 /* If this char is the second of a 2-char comment sequence,
728 back up and give the pair the appropriate syntax. */
729 if (from
> stop
&& SYNTAX_COMEND_SECOND (c
)
730 && SYNTAX_COMEND_FIRST (FETCH_CHAR (from
- 1)))
736 else if (from
> stop
&& SYNTAX_COMSTART_SECOND (c
)
737 && SYNTAX_COMSTART_FIRST (FETCH_CHAR (from
- 1))
738 && comstyle
== SYNTAX_COMMENT_STYLE (c
))
744 /* Ignore escaped characters. */
745 if (char_quoted (from
))
748 /* Track parity of quotes. */
752 if (my_stringend
== 0)
754 /* If we have two kinds of string delimiters.
755 There's no way to grok this scanning backwards. */
756 else if (my_stringend
!= c
)
760 /* Record comment-starters according to that
761 quote-parity to the comment-end. */
762 if (code
== Scomment
)
764 comstart_parity
= parity
;
768 /* If we find another earlier comment-ender,
769 any comment-starts earier than that don't count
770 (because they go with the earlier comment-ender). */
771 if (code
== Sendcomment
772 && SYNTAX_COMMENT_STYLE (FETCH_CHAR (from
)) == comstyle
)
775 /* Assume a defun-start point is outside of strings. */
777 && (from
== stop
|| FETCH_CHAR (from
- 1) == '\n'))
781 if (comstart_pos
== 0)
783 /* If the earliest comment starter
784 is followed by uniform paired string quotes or none,
785 we know it can't be inside a string
786 since if it were then the comment ender would be inside one.
787 So it does start a comment. Skip back to it. */
788 else if (comstart_parity
== 0 && !string_lossage
)
792 /* We had two kinds of string delimiters mixed up
793 together. Decode this going forwards.
794 Scan fwd from the previous comment ender
795 to the one in question; this records where we
796 last passed a comment starter. */
797 struct lisp_parse_state state
;
798 scan_sexps_forward (&state
, find_defun_start (comment_end
),
799 comment_end
- 1, -10000, 0, Qnil
);
801 from
= state
.comstart
;
803 /* We can't grok this as a comment; scan it normally. */
808 else if (code
!= Swhitespace
|| quoted
)
823 int parse_sexp_ignore_comments
;
826 scan_lists (from
, count
, depth
, sexpflag
)
828 int count
, depth
, sexpflag
;
836 register enum syntaxcode code
;
837 int min_depth
= depth
; /* Err out if depth gets less than this. */
838 int comstyle
= 0; /* style of comment encountered */
840 if (depth
> 0) min_depth
= 0;
850 c
= FETCH_CHAR (from
);
853 if (from
< stop
&& SYNTAX_COMSTART_FIRST (c
)
854 && SYNTAX_COMSTART_SECOND (FETCH_CHAR (from
))
855 && parse_sexp_ignore_comments
)
857 /* we have encountered a comment start sequence and we
858 are ignoring all text inside comments. we must record
859 the comment style this sequence begins so that later,
860 only a comment end of the same style actually ends
861 the comment section */
863 comstyle
= SYNTAX_COMMENT_STYLE (FETCH_CHAR (from
));
867 if (SYNTAX_PREFIX (c
))
870 #ifdef SWITCH_ENUM_BUG
878 if (from
== stop
) goto lose
;
880 /* treat following character as a word constituent */
883 if (depth
|| !sexpflag
) break;
884 /* This word counts as a sexp; return at end of it. */
887 #ifdef SWITCH_ENUM_BUG
888 switch ((int) SYNTAX (FETCH_CHAR (from
)))
890 switch (SYNTAX (FETCH_CHAR (from
)))
896 if (from
== stop
) goto lose
;
910 if (!parse_sexp_ignore_comments
) break;
913 if (from
== stop
) goto done
;
914 c
= FETCH_CHAR (from
);
915 if (SYNTAX (c
) == Sendcomment
916 && SYNTAX_COMMENT_STYLE (c
) == comstyle
)
917 /* we have encountered a comment end of the same style
918 as the comment sequence which began this comment
922 if (from
< stop
&& SYNTAX_COMEND_FIRST (c
)
923 && SYNTAX_COMEND_SECOND (FETCH_CHAR (from
))
924 && SYNTAX_COMMENT_STYLE (c
) == comstyle
)
925 /* we have encountered a comment end of the same style
926 as the comment sequence which began this comment
935 if (from
!= stop
&& c
== FETCH_CHAR (from
))
945 if (!++depth
) goto done
;
950 if (!--depth
) goto done
;
951 if (depth
< min_depth
)
952 error ("Containing expression ends prematurely");
956 stringterm
= FETCH_CHAR (from
- 1);
959 if (from
>= stop
) goto lose
;
960 if (FETCH_CHAR (from
) == stringterm
) break;
961 #ifdef SWITCH_ENUM_BUG
962 switch ((int) SYNTAX (FETCH_CHAR (from
)))
964 switch (SYNTAX (FETCH_CHAR (from
)))
974 if (!depth
&& sexpflag
) goto done
;
979 /* Reached end of buffer. Error if within object, return nil if between */
980 if (depth
) goto lose
;
985 /* End of object reached */
996 if (quoted
= char_quoted (from
))
998 c
= FETCH_CHAR (from
);
1000 if (from
> stop
&& SYNTAX_COMEND_SECOND (c
)
1001 && SYNTAX_COMEND_FIRST (FETCH_CHAR (from
- 1))
1002 && !char_quoted (from
- 1)
1003 && parse_sexp_ignore_comments
)
1005 /* we must record the comment style encountered so that
1006 later, we can match only the proper comment begin
1007 sequence of the same style */
1009 comstyle
= SYNTAX_COMMENT_STYLE (FETCH_CHAR (from
- 1));
1013 if (SYNTAX_PREFIX (c
))
1016 #ifdef SWITCH_ENUM_BUG
1017 switch ((int) (quoted
? Sword
: code
))
1019 switch (quoted
? Sword
: code
)
1024 if (depth
|| !sexpflag
) break;
1025 /* This word counts as a sexp; count object finished after passing it. */
1028 quoted
= char_quoted (from
- 1);
1031 if (! (quoted
|| SYNTAX (FETCH_CHAR (from
- 1)) == Sword
1032 || SYNTAX (FETCH_CHAR (from
- 1)) == Ssymbol
1033 || SYNTAX (FETCH_CHAR (from
- 1)) == Squote
))
1042 if (from
!= stop
&& c
== FETCH_CHAR (from
- 1))
1052 if (!++depth
) goto done2
;
1057 if (!--depth
) goto done2
;
1058 if (depth
< min_depth
)
1059 error ("Containing expression ends prematurely");
1063 if (!parse_sexp_ignore_comments
)
1065 if (code
!= SYNTAX (c
))
1066 /* For a two-char comment ender, we can assume
1067 it does end a comment. So scan back in a simple way. */
1069 if (from
!= stop
) from
--;
1072 if (SYNTAX (c
= FETCH_CHAR (from
)) == Scomment
1073 && SYNTAX_COMMENT_STYLE (c
) == comstyle
)
1075 if (from
== stop
) goto done
;
1077 if (SYNTAX_COMSTART_SECOND (c
)
1078 && SYNTAX_COMSTART_FIRST (FETCH_CHAR (from
))
1079 && SYNTAX_COMMENT_STYLE (c
) == comstyle
1080 && !char_quoted (from
))
1086 /* Look back, counting the parity of string-quotes,
1087 and recording the comment-starters seen.
1088 When we reach a safe place, assume that's not in a string;
1089 then step the main scan to the earliest comment-starter seen
1090 an even number of string quotes away from the safe place.
1092 OFROM[I] is position of the earliest comment-starter seen
1093 which is I+2X quotes from the comment-end.
1094 PARITY is current parity of quotes from the comment end. */
1097 char my_stringend
= 0;
1098 int string_lossage
= 0;
1099 int comment_end
= from
;
1100 int comstart_pos
= 0;
1101 int comstart_parity
= 0;
1103 /* At beginning of range to scan, we're outside of strings;
1104 that determines quote parity to the comment-end. */
1105 while (from
!= stop
)
1107 /* Move back and examine a character. */
1110 c
= FETCH_CHAR (from
);
1113 /* If this char is the second of a 2-char comment sequence,
1114 back up and give the pair the appropriate syntax. */
1115 if (from
> stop
&& SYNTAX_COMEND_SECOND (c
)
1116 && SYNTAX_COMEND_FIRST (FETCH_CHAR (from
- 1)))
1122 else if (from
> stop
&& SYNTAX_COMSTART_SECOND (c
)
1123 && SYNTAX_COMSTART_FIRST (FETCH_CHAR (from
- 1))
1124 && comstyle
== SYNTAX_COMMENT_STYLE (c
))
1130 /* Ignore escaped characters. */
1131 if (char_quoted (from
))
1134 /* Track parity of quotes. */
1135 if (code
== Sstring
)
1138 if (my_stringend
== 0)
1140 /* If we have two kinds of string delimiters.
1141 There's no way to grok this scanning backwards. */
1142 else if (my_stringend
!= c
)
1146 /* Record comment-starters according to that
1147 quote-parity to the comment-end. */
1148 if (code
== Scomment
)
1150 comstart_parity
= parity
;
1151 comstart_pos
= from
;
1154 /* If we find another earlier comment-ender,
1155 any comment-starts earier than that don't count
1156 (because they go with the earlier comment-ender). */
1157 if (code
== Sendcomment
1158 && SYNTAX_COMMENT_STYLE (FETCH_CHAR (from
)) == comstyle
)
1161 /* Assume a defun-start point is outside of strings. */
1163 && (from
== stop
|| FETCH_CHAR (from
- 1) == '\n'))
1167 if (comstart_pos
== 0)
1169 /* If the earliest comment starter
1170 is followed by uniform paired string quotes or none,
1171 we know it can't be inside a string
1172 since if it were then the comment ender would be inside one.
1173 So it does start a comment. Skip back to it. */
1174 else if (comstart_parity
== 0 && !string_lossage
)
1175 from
= comstart_pos
;
1178 /* We had two kinds of string delimiters mixed up
1179 together. Decode this going forwards.
1180 Scan fwd from the previous comment ender
1181 to the one in question; this records where we
1182 last passed a comment starter. */
1183 struct lisp_parse_state state
;
1184 scan_sexps_forward (&state
, find_defun_start (comment_end
),
1185 comment_end
- 1, -10000, 0, Qnil
);
1186 if (state
.incomment
)
1187 from
= state
.comstart
;
1189 /* We can't grok this as a comment; scan it normally. */
1196 stringterm
= FETCH_CHAR (from
);
1199 if (from
== stop
) goto lose
;
1200 if (!char_quoted (from
- 1)
1201 && stringterm
== FETCH_CHAR (from
- 1))
1206 if (!depth
&& sexpflag
) goto done2
;
1211 /* Reached start of buffer. Error if within object, return nil if between */
1212 if (depth
) goto lose
;
1223 XFASTINT (val
) = from
;
1227 error ("Unbalanced parentheses");
1234 register enum syntaxcode code
;
1235 register int beg
= BEGV
;
1236 register int quoted
= 0;
1239 && ((code
= SYNTAX (FETCH_CHAR (pos
- 1))) == Scharquote
1240 || code
== Sescape
))
1241 pos
--, quoted
= !quoted
;
1245 DEFUN ("scan-lists", Fscan_lists
, Sscan_lists
, 3, 3, 0,
1246 "Scan from character number FROM by COUNT lists.\n\
1247 Returns the character number of the position thus found.\n\
1249 If DEPTH is nonzero, paren depth begins counting from that value,\n\
1250 only places where the depth in parentheses becomes zero\n\
1251 are candidates for stopping; COUNT such places are counted.\n\
1252 Thus, a positive value for DEPTH means go out levels.\n\
1254 Comments are ignored if `parse-sexp-ignore-comments' is non-nil.\n\
1256 If the beginning or end of (the accessible part of) the buffer is reached\n\
1257 and the depth is wrong, an error is signaled.\n\
1258 If the depth is right but the count is not used up, nil is returned.")
1259 (from
, count
, depth
)
1260 Lisp_Object from
, count
, depth
;
1262 CHECK_NUMBER (from
, 0);
1263 CHECK_NUMBER (count
, 1);
1264 CHECK_NUMBER (depth
, 2);
1266 return scan_lists (XINT (from
), XINT (count
), XINT (depth
), 0);
1269 DEFUN ("scan-sexps", Fscan_sexps
, Sscan_sexps
, 2, 2, 0,
1270 "Scan from character number FROM by COUNT balanced expressions.\n\
1271 If COUNT is negative, scan backwards.\n\
1272 Returns the character number of the position thus found.\n\
1274 Comments are ignored if `parse-sexp-ignore-comments' is non-nil.\n\
1276 If the beginning or end of (the accessible part of) the buffer is reached\n\
1277 in the middle of a parenthetical grouping, an error is signaled.\n\
1278 If the beginning or end is reached between groupings\n\
1279 but before count is used up, nil is returned.")
1281 Lisp_Object from
, count
;
1283 CHECK_NUMBER (from
, 0);
1284 CHECK_NUMBER (count
, 1);
1286 return scan_lists (XINT (from
), XINT (count
), 0, 1);
1289 DEFUN ("backward-prefix-chars", Fbackward_prefix_chars
, Sbackward_prefix_chars
,
1291 "Move point backward over any number of chars with prefix syntax.\n\
1292 This includes chars with \"quote\" or \"prefix\" syntax (' or p).")
1298 while (pos
> beg
&& !char_quoted (pos
- 1)
1299 && (SYNTAX (FETCH_CHAR (pos
- 1)) == Squote
1300 || SYNTAX_PREFIX (FETCH_CHAR (pos
- 1))))
1308 /* Parse forward from FROM to END,
1309 assuming that FROM has state OLDSTATE (nil means FROM is start of function),
1310 and return a description of the state of the parse at END.
1311 If STOPBEFORE is nonzero, stop at the start of an atom. */
1313 scan_sexps_forward (stateptr
, from
, end
, targetdepth
, stopbefore
, oldstate
)
1314 struct lisp_parse_state
*stateptr
;
1316 int end
, targetdepth
, stopbefore
;
1317 Lisp_Object oldstate
;
1319 struct lisp_parse_state state
;
1321 register enum syntaxcode code
;
1322 struct level
{ int last
, prev
; };
1323 struct level levelstart
[100];
1324 register struct level
*curlevel
= levelstart
;
1325 struct level
*endlevel
= levelstart
+ 100;
1327 register int depth
; /* Paren depth of current scanning location.
1328 level - levelstart equals this except
1329 when the depth becomes negative. */
1330 int mindepth
; /* Lowest DEPTH value seen. */
1331 int start_quoted
= 0; /* Nonzero means starting after a char quote */
1337 if (NILP (oldstate
))
1340 state
.instring
= -1;
1341 state
.incomment
= 0;
1342 state
.comstyle
= 0; /* comment style a by default */
1346 tem
= Fcar (oldstate
);
1352 oldstate
= Fcdr (oldstate
);
1353 oldstate
= Fcdr (oldstate
);
1354 oldstate
= Fcdr (oldstate
);
1355 tem
= Fcar (oldstate
);
1356 state
.instring
= !NILP (tem
) ? XINT (tem
) : -1;
1358 oldstate
= Fcdr (oldstate
);
1359 tem
= Fcar (oldstate
);
1360 state
.incomment
= !NILP (tem
);
1362 oldstate
= Fcdr (oldstate
);
1363 tem
= Fcar (oldstate
);
1364 start_quoted
= !NILP (tem
);
1366 /* if the eight element of the list is nil, we are in comment
1367 style a. if it is non-nil, we are in comment style b */
1368 oldstate
= Fcdr (oldstate
);
1369 oldstate
= Fcdr (oldstate
);
1370 oldstate
= Fcdr (oldstate
);
1371 tem
= Fcar (oldstate
);
1372 state
.comstyle
= !NILP (tem
);
1377 curlevel
->prev
= -1;
1378 curlevel
->last
= -1;
1380 /* Enter the loop at a place appropriate for initial state. */
1382 if (state
.incomment
) goto startincomment
;
1383 if (state
.instring
>= 0)
1385 if (start_quoted
) goto startquotedinstring
;
1388 if (start_quoted
) goto startquoted
;
1392 code
= SYNTAX (FETCH_CHAR (from
));
1394 if (from
< end
&& SYNTAX_COMSTART_FIRST (FETCH_CHAR (from
- 1))
1395 && SYNTAX_COMSTART_SECOND (FETCH_CHAR (from
)))
1397 /* Record the comment style we have entered so that only
1398 the comment-end sequence of the same style actually
1399 terminates the comment section. */
1401 state
.comstyle
= SYNTAX_COMMENT_STYLE (FETCH_CHAR (from
));
1405 if (SYNTAX_PREFIX (FETCH_CHAR (from
- 1)))
1407 #ifdef SWITCH_ENUM_BUG
1415 if (stopbefore
) goto stop
; /* this arg means stop at sexp start */
1416 curlevel
->last
= from
- 1;
1418 if (from
== end
) goto endquoted
;
1421 /* treat following character as a word constituent */
1424 if (stopbefore
) goto stop
; /* this arg means stop at sexp start */
1425 curlevel
->last
= from
- 1;
1429 #ifdef SWITCH_ENUM_BUG
1430 switch ((int) SYNTAX (FETCH_CHAR (from
)))
1432 switch (SYNTAX (FETCH_CHAR (from
)))
1438 if (from
== end
) goto endquoted
;
1450 curlevel
->prev
= curlevel
->last
;
1454 state
.incomment
= 1;
1455 state
.comstart
= from
;
1459 if (from
== end
) goto done
;
1460 prev
= FETCH_CHAR (from
);
1461 if (SYNTAX (prev
) == Sendcomment
1462 && SYNTAX_COMMENT_STYLE (prev
) == state
.comstyle
)
1463 /* Only terminate the comment section if the endcomment
1464 of the same style as the start sequence has been
1468 if (from
< end
&& SYNTAX_COMEND_FIRST (prev
)
1469 && SYNTAX_COMEND_SECOND (FETCH_CHAR (from
))
1470 && SYNTAX_COMMENT_STYLE (prev
) == state
.comstyle
)
1471 /* Only terminate the comment section if the end-comment
1472 sequence of the same style as the start sequence has
1473 been encountered. */
1476 state
.incomment
= 0;
1477 state
.comstyle
= 0; /* reset the comment style */
1481 if (stopbefore
) goto stop
; /* this arg means stop at sexp start */
1483 /* curlevel++->last ran into compiler bug on Apollo */
1484 curlevel
->last
= from
- 1;
1485 if (++curlevel
== endlevel
)
1486 error ("Nesting too deep for parser");
1487 curlevel
->prev
= -1;
1488 curlevel
->last
= -1;
1489 if (!--targetdepth
) goto done
;
1494 if (depth
< mindepth
)
1496 if (curlevel
!= levelstart
)
1498 curlevel
->prev
= curlevel
->last
;
1499 if (!++targetdepth
) goto done
;
1503 if (stopbefore
) goto stop
; /* this arg means stop at sexp start */
1504 curlevel
->last
= from
- 1;
1505 state
.instring
= FETCH_CHAR (from
- 1);
1509 if (from
>= end
) goto done
;
1510 if (FETCH_CHAR (from
) == state
.instring
) break;
1511 #ifdef SWITCH_ENUM_BUG
1512 switch ((int) SYNTAX (FETCH_CHAR (from
)))
1514 switch (SYNTAX (FETCH_CHAR (from
)))
1520 startquotedinstring
:
1521 if (from
>= end
) goto endquoted
;
1525 state
.instring
= -1;
1526 curlevel
->prev
= curlevel
->last
;
1536 stop
: /* Here if stopping before start of sexp. */
1537 from
--; /* We have just fetched the char that starts it; */
1538 goto done
; /* but return the position before it. */
1543 state
.depth
= depth
;
1544 state
.mindepth
= mindepth
;
1545 state
.thislevelstart
= curlevel
->prev
;
1546 state
.prevlevelstart
1547 = (curlevel
== levelstart
) ? -1 : (curlevel
- 1)->last
;
1548 state
.location
= from
;
1554 /* This comment supplies the doc string for parse-partial-sexp,
1555 for make-docfile to see. We cannot put this in the real DEFUN
1556 due to limits in the Unix cpp.
1558 DEFUN ("parse-partial-sexp", Ffoo, Sfoo, 2, 5, 0,
1559 "Parse Lisp syntax starting at FROM until TO; return status of parse at TO.\n\
1560 Parsing stops at TO or when certain criteria are met;\n\
1561 point is set to where parsing stops.\n\
1562 If fifth arg STATE is omitted or nil,\n\
1563 parsing assumes that FROM is the beginning of a function.\n\
1564 Value is a list of eight elements describing final state of parsing:\n\
1565 1. depth in parens.\n\
1566 2. character address of start of innermost containing list; nil if none.\n\
1567 3. character address of start of last complete sexp terminated.\n\
1568 4. non-nil if inside a string.\n\
1569 (it is the character that will terminate the string.)\n\
1570 5. t if inside a comment.\n\
1571 6. t if following a quote character.\n\
1572 7. the minimum paren-depth encountered during this scan.\n\
1573 8. t if in a comment of style `b'.\n\
1574 If third arg TARGETDEPTH is non-nil, parsing stops if the depth\n\
1575 in parentheses becomes equal to TARGETDEPTH.\n\
1576 Fourth arg STOPBEFORE non-nil means stop when come to\n\
1577 any character that starts a sexp.\n\
1578 Fifth arg STATE is a seven-list like what this function returns.\n\
1579 It is used to initialize the state of the parse. Its second and third
1580 elements are ignored.")
1581 (from, to, targetdepth, stopbefore, state)
1584 DEFUN ("parse-partial-sexp", Fparse_partial_sexp
, Sparse_partial_sexp
, 2, 5, 0,
1585 0 /* See immediately above */)
1586 (from
, to
, targetdepth
, stopbefore
, oldstate
)
1587 Lisp_Object from
, to
, targetdepth
, stopbefore
, oldstate
;
1589 struct lisp_parse_state state
;
1592 if (!NILP (targetdepth
))
1594 CHECK_NUMBER (targetdepth
, 3);
1595 target
= XINT (targetdepth
);
1598 target
= -100000; /* We won't reach this depth */
1600 validate_region (&from
, &to
);
1601 scan_sexps_forward (&state
, XINT (from
), XINT (to
),
1602 target
, !NILP (stopbefore
), oldstate
);
1604 SET_PT (state
.location
);
1606 return Fcons (make_number (state
.depth
),
1607 Fcons (state
.prevlevelstart
< 0 ? Qnil
: make_number (state
.prevlevelstart
),
1608 Fcons (state
.thislevelstart
< 0 ? Qnil
: make_number (state
.thislevelstart
),
1609 Fcons (state
.instring
>= 0 ? make_number (state
.instring
) : Qnil
,
1610 Fcons (state
.incomment
? Qt
: Qnil
,
1611 Fcons (state
.quoted
? Qt
: Qnil
,
1612 Fcons (make_number (state
.mindepth
),
1613 Fcons (state
.comstyle
? Qt
: Qnil
,
1620 register struct Lisp_Vector
*v
;
1622 /* Set this now, so first buffer creation can refer to it. */
1623 /* Make it nil before calling copy-syntax-table
1624 so that copy-syntax-table will know not to try to copy from garbage */
1625 Vstandard_syntax_table
= Qnil
;
1626 Vstandard_syntax_table
= Fcopy_syntax_table (Qnil
);
1628 v
= XVECTOR (Vstandard_syntax_table
);
1630 for (i
= 'a'; i
<= 'z'; i
++)
1631 XFASTINT (v
->contents
[i
]) = (int) Sword
;
1632 for (i
= 'A'; i
<= 'Z'; i
++)
1633 XFASTINT (v
->contents
[i
]) = (int) Sword
;
1634 for (i
= '0'; i
<= '9'; i
++)
1635 XFASTINT (v
->contents
[i
]) = (int) Sword
;
1636 XFASTINT (v
->contents
['$']) = (int) Sword
;
1637 XFASTINT (v
->contents
['%']) = (int) Sword
;
1639 XFASTINT (v
->contents
['(']) = (int) Sopen
+ (')' << 8);
1640 XFASTINT (v
->contents
[')']) = (int) Sclose
+ ('(' << 8);
1641 XFASTINT (v
->contents
['[']) = (int) Sopen
+ (']' << 8);
1642 XFASTINT (v
->contents
[']']) = (int) Sclose
+ ('[' << 8);
1643 XFASTINT (v
->contents
['{']) = (int) Sopen
+ ('}' << 8);
1644 XFASTINT (v
->contents
['}']) = (int) Sclose
+ ('{' << 8);
1645 XFASTINT (v
->contents
['"']) = (int) Sstring
;
1646 XFASTINT (v
->contents
['\\']) = (int) Sescape
;
1648 for (i
= 0; i
< 10; i
++)
1649 XFASTINT (v
->contents
["_-+*/&|<>="[i
]]) = (int) Ssymbol
;
1651 for (i
= 0; i
< 12; i
++)
1652 XFASTINT (v
->contents
[".,;:?!#@~^'`"[i
]]) = (int) Spunct
;
1657 Qsyntax_table_p
= intern ("syntax-table-p");
1658 staticpro (&Qsyntax_table_p
);
1660 DEFVAR_BOOL ("parse-sexp-ignore-comments", &parse_sexp_ignore_comments
,
1661 "Non-nil means `forward-sexp', etc., should treat comments as whitespace.");
1663 words_include_escapes
= 0;
1664 DEFVAR_BOOL ("words-include-escapes", &words_include_escapes
,
1665 "Non-nil means `forward-word', etc., should treat escape chars part of words.");
1667 defsubr (&Ssyntax_table_p
);
1668 defsubr (&Ssyntax_table
);
1669 defsubr (&Sstandard_syntax_table
);
1670 defsubr (&Scopy_syntax_table
);
1671 defsubr (&Sset_syntax_table
);
1672 defsubr (&Schar_syntax
);
1673 defsubr (&Smodify_syntax_entry
);
1674 defsubr (&Sdescribe_syntax
);
1676 defsubr (&Sforward_word
);
1678 defsubr (&Sforward_comment
);
1679 defsubr (&Sscan_lists
);
1680 defsubr (&Sscan_sexps
);
1681 defsubr (&Sbackward_prefix_chars
);
1682 defsubr (&Sparse_partial_sexp
);