Commit | Line | Data |
---|---|---|
b8d4c8d0 GM |
1 | @c -*-texinfo-*- |
2 | @c This is part of the GNU Emacs Lisp Reference Manual. | |
acaf905b | 3 | @c Copyright (C) 1990-1995, 1998-1999, 2001-2012 |
d24880de | 4 | @c Free Software Foundation, Inc. |
b8d4c8d0 | 5 | @c See the file elisp.texi for copying conditions. |
ecc6530d | 6 | @node Syntax Tables |
b8d4c8d0 GM |
7 | @chapter Syntax Tables |
8 | @cindex parsing buffer text | |
9 | @cindex syntax table | |
10 | @cindex text parsing | |
11 | ||
4230351b CY |
12 | A @dfn{syntax table} specifies the syntactic role of each character |
13 | in a buffer. It can be used to determine where words, symbols, and | |
14 | other syntactic constructs begin and end. This information is used by | |
15 | many Emacs facilities, including Font Lock mode (@pxref{Font Lock | |
16 | Mode}) and the various complex movement commands (@pxref{Motion}). | |
b8d4c8d0 GM |
17 | |
18 | @menu | |
19 | * Basics: Syntax Basics. Basic concepts of syntax tables. | |
4230351b | 20 | * Syntax Descriptors:: How characters are classified. |
b8d4c8d0 GM |
21 | * Syntax Table Functions:: How to create, examine and alter syntax tables. |
22 | * Syntax Properties:: Overriding syntax with text properties. | |
d24880de | 23 | * Motion and Syntax:: Moving over characters with certain syntaxes. |
b8d4c8d0 GM |
24 | * Parsing Expressions:: Parsing balanced expressions |
25 | using the syntax table. | |
b8d4c8d0 GM |
26 | * Syntax Table Internals:: How syntax table information is stored. |
27 | * Categories:: Another way of classifying character syntax. | |
28 | @end menu | |
29 | ||
30 | @node Syntax Basics | |
31 | @section Syntax Table Concepts | |
32 | ||
02676e5d CY |
33 | A syntax table is a data structure which can be used to look up the |
34 | @dfn{syntax class} and other syntactic properties of each character. | |
35 | Syntax tables are used by Lisp programs for scanning and moving across | |
36 | text. | |
b8d4c8d0 | 37 | |
02676e5d CY |
38 | Internally, a syntax table is a char-table (@pxref{Char-Tables}). |
39 | The element at index @var{c} describes the character with code | |
40 | @var{c}; its value is a cons cell which specifies the syntax of the | |
41 | character in question. @xref{Syntax Table Internals}, for details. | |
42 | However, instead of using @code{aset} and @code{aref} to modify and | |
43 | inspect syntax table contents, you should usually use the higher-level | |
44 | functions @code{char-syntax} and @code{modify-syntax-entry}, which are | |
45 | described in @ref{Syntax Table Functions}. | |
b8d4c8d0 GM |
46 | |
47 | @defun syntax-table-p object | |
48 | This function returns @code{t} if @var{object} is a syntax table. | |
49 | @end defun | |
50 | ||
02676e5d CY |
51 | Each buffer has its own major mode, and each major mode has its own |
52 | idea of the syntax class of various characters. For example, in Lisp | |
53 | mode, the character @samp{;} begins a comment, but in C mode, it | |
54 | terminates a statement. To support these variations, the syntax table | |
55 | is local to each buffer. Typically, each major mode has its own | |
56 | syntax table, which it installs in all buffers that use that mode. | |
57 | For example, the variable @code{emacs-lisp-mode-syntax-table} holds | |
58 | the syntax table used by Emacs Lisp mode, and | |
59 | @code{c-mode-syntax-table} holds the syntax table used by C mode. | |
60 | Changing a major mode's syntax table alters the syntax in all of that | |
61 | mode's buffers, as well as in any buffers subsequently put in that | |
62 | mode. Occasionally, several similar modes share one syntax table. | |
63 | @xref{Example Major Modes}, for an example of how to set up a syntax | |
64 | table. | |
65 | ||
66 | @cindex standard syntax table | |
67 | @cindex inheritance, syntax table | |
68 | A syntax table can @dfn{inherit} from another syntax table, which is | |
69 | called its @dfn{parent syntax table}. A syntax table can leave the | |
70 | syntax class of some characters unspecified, by giving them the | |
71 | ``inherit'' syntax class; such a character then acquires the syntax | |
72 | class specified by the parent syntax table (@pxref{Syntax Class | |
73 | Table}). Emacs defines a @dfn{standard syntax table}, which is the | |
74 | default parent syntax table, and is also the syntax table used by | |
75 | Fundamental mode. | |
76 | ||
77 | @defun standard-syntax-table | |
78 | This function returns the standard syntax table, which is the syntax | |
79 | table used in Fundamental mode. | |
80 | @end defun | |
81 | ||
82 | Syntax tables are not used by the Emacs Lisp reader, which has its | |
83 | own built-in syntactic rules which cannot be changed. (Some Lisp | |
84 | systems provide ways to redefine the read syntax, but we decided to | |
85 | leave this feature out of Emacs Lisp for simplicity.) | |
86 | ||
b8d4c8d0 GM |
87 | @node Syntax Descriptors |
88 | @section Syntax Descriptors | |
89 | @cindex syntax class | |
90 | ||
02676e5d | 91 | The @dfn{syntax class} of a character describes its syntactic role. |
4230351b | 92 | Each syntax table specifies the syntax class of each character. There |
b8d4c8d0 GM |
93 | is no necessary relationship between the class of a character in one |
94 | syntax table and its class in any other table. | |
95 | ||
4230351b CY |
96 | Each syntax class is designated by a mnemonic character, which |
97 | serves as the name of the class when you need to specify a class. | |
98 | Usually, this designator character is one that is often assigned that | |
99 | class; however, its meaning as a designator is unvarying and | |
100 | independent of what syntax that character currently has. Thus, | |
101 | @samp{\} as a designator character always means ``escape character'' | |
102 | syntax, regardless of whether the @samp{\} character actually has that | |
103 | syntax in the current syntax table. | |
104 | @ifnottex | |
02676e5d CY |
105 | @xref{Syntax Class Table}, for a list of syntax classes and their |
106 | designator characters. | |
4230351b | 107 | @end ifnottex |
b8d4c8d0 GM |
108 | |
109 | @cindex syntax descriptor | |
4230351b | 110 | A @dfn{syntax descriptor} is a Lisp string that describes the syntax |
02676e5d CY |
111 | class and other syntactic properties of a character. When you want to |
112 | modify the syntax of a character, that is done by calling the function | |
113 | @code{modify-syntax-entry} and passing a syntax descriptor as one of | |
114 | its arguments (@pxref{Syntax Table Functions}). | |
115 | ||
116 | The first character in a syntax descriptor must be a syntax class | |
117 | designator character. The second character, if present, specifies a | |
118 | matching character (e.g.@: in Lisp, the matching character for | |
119 | @samp{(} is @samp{)}); a space specifies that there is no matching | |
120 | character. Then come characters specifying additional syntax | |
121 | properties (@pxref{Syntax Flags}). | |
4230351b CY |
122 | |
123 | If no matching character or flags are needed, only one character | |
124 | (specifying the syntax class) is sufficient. | |
b8d4c8d0 GM |
125 | |
126 | For example, the syntax descriptor for the character @samp{*} in C | |
ad21a12a | 127 | mode is @code{". 23"} (i.e., punctuation, matching character slot |
b8d4c8d0 GM |
128 | unused, second character of a comment-starter, first character of a |
129 | comment-ender), and the entry for @samp{/} is @samp{@w{. 14}} (i.e., | |
130 | punctuation, matching character slot unused, first character of a | |
131 | comment-starter, second character of a comment-ender). | |
132 | ||
6dcef6ec CY |
133 | Emacs also defines @dfn{raw syntax descriptors}, which are used to |
134 | describe syntax classes at a lower level. @xref{Syntax Table | |
135 | Internals}. | |
136 | ||
b8d4c8d0 GM |
137 | @menu |
138 | * Syntax Class Table:: Table of syntax classes. | |
139 | * Syntax Flags:: Additional flags each character can have. | |
140 | @end menu | |
141 | ||
142 | @node Syntax Class Table | |
143 | @subsection Table of Syntax Classes | |
144 | ||
4230351b CY |
145 | Here is a table of syntax classes, the characters that designate |
146 | them, their meanings, and examples of their use. | |
b8d4c8d0 | 147 | |
4230351b CY |
148 | @table @asis |
149 | @item Whitespace characters: @samp{@ } or @samp{-} | |
150 | Characters that separate symbols and words from each other. | |
151 | Typically, whitespace characters have no other syntactic significance, | |
152 | and multiple whitespace characters are syntactically equivalent to a | |
153 | single one. Space, tab, and formfeed are classified as whitespace in | |
154 | almost all major modes. | |
155 | ||
156 | This syntax class can be designated by either @w{@samp{@ }} or | |
157 | @samp{-}. Both designators are equivalent. | |
158 | ||
159 | @item Word constituents: @samp{w} | |
160 | Parts of words in human languages. These are typically used in | |
161 | variable and command names in programs. All upper- and lower-case | |
162 | letters, and the digits, are typically word constituents. | |
163 | ||
164 | @item Symbol constituents: @samp{_} | |
165 | Extra characters used in variable and command names along with word | |
166 | constituents. Examples include the characters @samp{$&*+-_<>} in Lisp | |
167 | mode, which may be part of a symbol name even though they are not part | |
168 | of English words. In standard C, the only non-word-constituent | |
b8d4c8d0 | 169 | character that is valid in symbols is underscore (@samp{_}). |
b8d4c8d0 | 170 | |
4230351b CY |
171 | @item Punctuation characters: @samp{.} |
172 | Characters used as punctuation in a human language, or used in a | |
173 | programming language to separate symbols from one another. Some | |
174 | programming language modes, such as Emacs Lisp mode, have no | |
175 | characters in this class since the few characters that are not symbol | |
176 | or word constituents all have other uses. Other programming language | |
177 | modes, such as C mode, use punctuation syntax for operators. | |
178 | ||
179 | @item Open parenthesis characters: @samp{(} | |
180 | @itemx Close parenthesis characters: @samp{)} | |
181 | Characters used in dissimilar pairs to surround sentences or | |
182 | expressions. Such a grouping is begun with an open parenthesis | |
183 | character and terminated with a close. Each open parenthesis | |
184 | character matches a particular close parenthesis character, and vice | |
185 | versa. Normally, Emacs indicates momentarily the matching open | |
186 | parenthesis when you insert a close parenthesis. @xref{Blinking}. | |
187 | ||
188 | In human languages, and in C code, the parenthesis pairs are | |
189 | @samp{()}, @samp{[]}, and @samp{@{@}}. In Emacs Lisp, the delimiters | |
190 | for lists and vectors (@samp{()} and @samp{[]}) are classified as | |
191 | parenthesis characters. | |
192 | ||
193 | @item String quotes: @samp{"} | |
194 | Characters used to delimit string constants. The same string quote | |
195 | character appears at the beginning and the end of a string. Such | |
196 | quoted strings do not nest. | |
b8d4c8d0 GM |
197 | |
198 | The parsing facilities of Emacs consider a string as a single token. | |
199 | The usual syntactic meanings of the characters in the string are | |
200 | suppressed. | |
201 | ||
202 | The Lisp modes have two string quote characters: double-quote (@samp{"}) | |
203 | and vertical bar (@samp{|}). @samp{|} is not used in Emacs Lisp, but it | |
204 | is used in Common Lisp. C also has two string quote characters: | |
205 | double-quote for strings, and single-quote (@samp{'}) for character | |
206 | constants. | |
207 | ||
4230351b CY |
208 | Human text has no string quote characters. We do not want quotation |
209 | marks to turn off the usual syntactic properties of other characters | |
210 | in the quotation. | |
b8d4c8d0 | 211 | |
4230351b CY |
212 | @item Escape-syntax characters: @samp{\} |
213 | Characters that start an escape sequence, such as is used in string | |
214 | and character constants. The character @samp{\} belongs to this class | |
215 | in both C and Lisp. (In C, it is used thus only inside strings, but | |
216 | it turns out to cause no trouble to treat it this way throughout C | |
217 | code.) | |
b8d4c8d0 GM |
218 | |
219 | Characters in this class count as part of words if | |
220 | @code{words-include-escapes} is non-@code{nil}. @xref{Word Motion}. | |
b8d4c8d0 | 221 | |
4230351b CY |
222 | @item Character quotes: @samp{/} |
223 | Characters used to quote the following character so that it loses its | |
224 | normal syntactic meaning. This differs from an escape character in | |
225 | that only the character immediately following is ever affected. | |
b8d4c8d0 GM |
226 | |
227 | Characters in this class count as part of words if | |
228 | @code{words-include-escapes} is non-@code{nil}. @xref{Word Motion}. | |
229 | ||
230 | This class is used for backslash in @TeX{} mode. | |
b8d4c8d0 | 231 | |
4230351b CY |
232 | @item Paired delimiters: @samp{$} |
233 | Similar to string quote characters, except that the syntactic | |
234 | properties of the characters between the delimiters are not | |
235 | suppressed. Only @TeX{} mode uses a paired delimiter presently---the | |
236 | @samp{$} that both enters and leaves math mode. | |
237 | ||
238 | @item Expression prefixes: @samp{'} | |
239 | Characters used for syntactic operators that are considered as part of | |
240 | an expression if they appear next to one. In Lisp modes, these | |
241 | characters include the apostrophe, @samp{'} (used for quoting), the | |
242 | comma, @samp{,} (used in macros), and @samp{#} (used in the read | |
243 | syntax for certain data types). | |
244 | ||
245 | @item Comment starters: @samp{<} | |
246 | @itemx Comment enders: @samp{>} | |
b8d4c8d0 | 247 | @cindex comment syntax |
4230351b CY |
248 | Characters used in various languages to delimit comments. Human text |
249 | has no comment characters. In Lisp, the semicolon (@samp{;}) starts a | |
250 | comment and a newline or formfeed ends one. | |
b8d4c8d0 | 251 | |
4230351b CY |
252 | @item Inherit standard syntax: @samp{@@} |
253 | This syntax class does not specify a particular syntax. It says to | |
254 | look in the standard syntax table to find the syntax of this | |
255 | character. | |
b8d4c8d0 | 256 | |
4230351b CY |
257 | @item Generic comment delimiters: @samp{!} |
258 | Characters that start or end a special kind of comment. @emph{Any} | |
259 | generic comment delimiter matches @emph{any} generic comment | |
260 | delimiter, but they cannot match a comment starter or comment ender; | |
261 | generic comment delimiters can only match each other. | |
b8d4c8d0 GM |
262 | |
263 | This syntax class is primarily meant for use with the | |
4230351b CY |
264 | @code{syntax-table} text property (@pxref{Syntax Properties}). You |
265 | can mark any range of characters as forming a comment, by giving the | |
266 | first and last characters of the range @code{syntax-table} properties | |
b8d4c8d0 | 267 | identifying them as generic comment delimiters. |
b8d4c8d0 | 268 | |
4230351b CY |
269 | @item Generic string delimiters: @samp{|} |
270 | Characters that start or end a string. This class differs from the | |
271 | string quote class in that @emph{any} generic string delimiter can | |
272 | match any other generic string delimiter; but they do not match | |
273 | ordinary string quote characters. | |
b8d4c8d0 GM |
274 | |
275 | This syntax class is primarily meant for use with the | |
4230351b CY |
276 | @code{syntax-table} text property (@pxref{Syntax Properties}). You |
277 | can mark any range of characters as forming a string constant, by | |
278 | giving the first and last characters of the range @code{syntax-table} | |
279 | properties identifying them as generic string delimiters. | |
280 | @end table | |
b8d4c8d0 GM |
281 | |
282 | @node Syntax Flags | |
283 | @subsection Syntax Flags | |
284 | @cindex syntax flags | |
285 | ||
286 | In addition to the classes, entries for characters in a syntax table | |
7cf78aac SM |
287 | can specify flags. There are eight possible flags, represented by the |
288 | characters @samp{1}, @samp{2}, @samp{3}, @samp{4}, @samp{b}, @samp{c}, | |
289 | @samp{n}, and @samp{p}. | |
290 | ||
291 | All the flags except @samp{p} are used to describe comment | |
292 | delimiters. The digit flags are used for comment delimiters made up | |
293 | of 2 characters. They indicate that a character can @emph{also} be | |
294 | part of a comment sequence, in addition to the syntactic properties | |
295 | associated with its character class. The flags are independent of the | |
296 | class and each other for the sake of characters such as @samp{*} in | |
297 | C mode, which is a punctuation character, @emph{and} the second | |
298 | character of a start-of-comment sequence (@samp{/*}), @emph{and} the | |
299 | first character of an end-of-comment sequence (@samp{*/}). The flags | |
300 | @samp{b}, @samp{c}, and @samp{n} are used to qualify the corresponding | |
301 | comment delimiter. | |
b8d4c8d0 GM |
302 | |
303 | Here is a table of the possible flags for a character @var{c}, | |
304 | and what they mean: | |
305 | ||
306 | @itemize @bullet | |
307 | @item | |
308 | @samp{1} means @var{c} is the start of a two-character comment-start | |
309 | sequence. | |
310 | ||
311 | @item | |
312 | @samp{2} means @var{c} is the second character of such a sequence. | |
313 | ||
314 | @item | |
315 | @samp{3} means @var{c} is the start of a two-character comment-end | |
316 | sequence. | |
317 | ||
318 | @item | |
319 | @samp{4} means @var{c} is the second character of such a sequence. | |
320 | ||
321 | @item | |
b8d4c8d0 | 322 | @samp{b} means that @var{c} as a comment delimiter belongs to the |
7cf78aac SM |
323 | alternative ``b'' comment style. For a two-character comment starter, |
324 | this flag is only significant on the second char, and for a 2-character | |
325 | comment ender it is only significant on the first char. | |
b8d4c8d0 | 326 | |
7cf78aac SM |
327 | @item |
328 | @samp{c} means that @var{c} as a comment delimiter belongs to the | |
329 | alternative ``c'' comment style. For a two-character comment | |
330 | delimiter, @samp{c} on either character makes it of style ``c''. | |
b8d4c8d0 | 331 | |
7cf78aac SM |
332 | @item |
333 | @samp{n} on a comment delimiter character specifies | |
334 | that this kind of comment can be nested. For a two-character | |
335 | comment delimiter, @samp{n} on either character makes it | |
336 | nestable. | |
b8d4c8d0 | 337 | |
7cf78aac SM |
338 | Emacs supports several comment styles simultaneously in any one syntax |
339 | table. A comment style is a set of flags @samp{b}, @samp{c}, and | |
340 | @samp{n}, so there can be up to 8 different comment styles. | |
341 | Each comment delimiter has a style and only matches comment delimiters | |
342 | of the same style. Thus if a comment starts with the comment-start | |
343 | sequence of style ``bn'', it will extend until the next matching | |
344 | comment-end sequence of style ``bn''. | |
b8d4c8d0 | 345 | |
7cf78aac | 346 | The appropriate comment syntax settings for C++ can be as follows: |
b8d4c8d0 GM |
347 | |
348 | @table @asis | |
349 | @item @samp{/} | |
7cf78aac | 350 | @samp{124} |
b8d4c8d0 | 351 | @item @samp{*} |
7cf78aac | 352 | @samp{23b} |
b8d4c8d0 | 353 | @item newline |
7cf78aac | 354 | @samp{>} |
b8d4c8d0 GM |
355 | @end table |
356 | ||
357 | This defines four comment-delimiting sequences: | |
358 | ||
359 | @table @asis | |
360 | @item @samp{/*} | |
7cf78aac SM |
361 | This is a comment-start sequence for ``b'' style because the |
362 | second character, @samp{*}, has the @samp{b} flag. | |
b8d4c8d0 GM |
363 | |
364 | @item @samp{//} | |
7cf78aac SM |
365 | This is a comment-start sequence for ``a'' style because the second |
366 | character, @samp{/}, does not have the @samp{b} flag. | |
b8d4c8d0 GM |
367 | |
368 | @item @samp{*/} | |
7cf78aac | 369 | This is a comment-end sequence for ``b'' style because the first |
35a30759 | 370 | character, @samp{*}, has the @samp{b} flag. |
b8d4c8d0 GM |
371 | |
372 | @item newline | |
7cf78aac SM |
373 | This is a comment-end sequence for ``a'' style, because the newline |
374 | character does not have the @samp{b} flag. | |
b8d4c8d0 GM |
375 | @end table |
376 | ||
b8d4c8d0 | 377 | @item |
b8d4c8d0 GM |
378 | @samp{p} identifies an additional ``prefix character'' for Lisp syntax. |
379 | These characters are treated as whitespace when they appear between | |
380 | expressions. When they appear within an expression, they are handled | |
381 | according to their usual syntax classes. | |
382 | ||
383 | The function @code{backward-prefix-chars} moves back over these | |
384 | characters, as well as over characters whose primary syntax class is | |
385 | prefix (@samp{'}). @xref{Motion and Syntax}. | |
386 | @end itemize | |
387 | ||
388 | @node Syntax Table Functions | |
389 | @section Syntax Table Functions | |
390 | ||
391 | In this section we describe functions for creating, accessing and | |
392 | altering syntax tables. | |
393 | ||
394 | @defun make-syntax-table &optional table | |
02676e5d CY |
395 | This function creates a new syntax table. If @var{table} is |
396 | non-@code{nil}, the parent of the new syntax table is @var{table}; | |
397 | otherwise, the parent is the standard syntax table. | |
398 | ||
399 | In the new syntax table, all characters are initially given the | |
400 | ``inherit'' (@samp{@@}) syntax class, i.e.@: their syntax is inherited | |
401 | from the parent table (@pxref{Syntax Class Table}). | |
b8d4c8d0 GM |
402 | @end defun |
403 | ||
404 | @defun copy-syntax-table &optional table | |
405 | This function constructs a copy of @var{table} and returns it. If | |
02676e5d CY |
406 | @var{table} is omitted or @code{nil}, it returns a copy of the |
407 | standard syntax table. Otherwise, an error is signaled if @var{table} | |
408 | is not a syntax table. | |
b8d4c8d0 GM |
409 | @end defun |
410 | ||
411 | @deffn Command modify-syntax-entry char syntax-descriptor &optional table | |
412 | This function sets the syntax entry for @var{char} according to | |
4230351b | 413 | @var{syntax-descriptor}. @var{char} must be a character, or a cons |
f147ff75 CY |
414 | cell of the form @code{(@var{min} . @var{max})}; in the latter case, |
415 | the function sets the syntax entries for all characters in the range | |
416 | between @var{min} and @var{max}, inclusive. | |
417 | ||
418 | The syntax is changed only for @var{table}, which defaults to the | |
4230351b CY |
419 | current buffer's syntax table, and not in any other syntax table. |
420 | ||
02676e5d CY |
421 | The argument @var{syntax-descriptor} is a syntax descriptor, i.e.@: a |
422 | string whose first character is a syntax class designator and whose | |
423 | second and subsequent characters optionally specify a matching | |
424 | character and syntax flags. @xref{Syntax Descriptors}. An error is | |
425 | signaled if @var{syntax-descriptor} is not a valid syntax descriptor. | |
b8d4c8d0 GM |
426 | |
427 | This function always returns @code{nil}. The old syntax information in | |
428 | the table for this character is discarded. | |
429 | ||
b8d4c8d0 GM |
430 | @example |
431 | @group | |
432 | @exdent @r{Examples:} | |
433 | ||
434 | ;; @r{Put the space character in class whitespace.} | |
435 | (modify-syntax-entry ?\s " ") | |
436 | @result{} nil | |
437 | @end group | |
438 | ||
439 | @group | |
440 | ;; @r{Make @samp{$} an open parenthesis character,} | |
441 | ;; @r{with @samp{^} as its matching close.} | |
442 | (modify-syntax-entry ?$ "(^") | |
443 | @result{} nil | |
444 | @end group | |
445 | ||
446 | @group | |
447 | ;; @r{Make @samp{^} a close parenthesis character,} | |
448 | ;; @r{with @samp{$} as its matching open.} | |
449 | (modify-syntax-entry ?^ ")$") | |
450 | @result{} nil | |
451 | @end group | |
452 | ||
453 | @group | |
454 | ;; @r{Make @samp{/} a punctuation character,} | |
455 | ;; @r{the first character of a start-comment sequence,} | |
456 | ;; @r{and the second character of an end-comment sequence.} | |
457 | ;; @r{This is used in C mode.} | |
458 | (modify-syntax-entry ?/ ". 14") | |
459 | @result{} nil | |
460 | @end group | |
461 | @end example | |
462 | @end deffn | |
463 | ||
464 | @defun char-syntax character | |
465 | This function returns the syntax class of @var{character}, represented | |
02676e5d CY |
466 | by its designator character (@pxref{Syntax Class Table}). This |
467 | returns @emph{only} the class, not its matching character or syntax | |
468 | flags. | |
b8d4c8d0 | 469 | |
02676e5d CY |
470 | The following examples apply to C mode. (We use @code{string} to make |
471 | it easier to see the character returned by @code{char-syntax}.) | |
b8d4c8d0 GM |
472 | |
473 | @example | |
474 | @group | |
02676e5d | 475 | ;; Space characters have whitespace syntax class. |
b8d4c8d0 GM |
476 | (string (char-syntax ?\s)) |
477 | @result{} " " | |
478 | @end group | |
479 | ||
480 | @group | |
02676e5d CY |
481 | ;; Forward slash characters have punctuation syntax. Note that this |
482 | ;; @code{char-syntax} call does not reveal that it is also part of | |
483 | ;; comment-start and -end sequences. | |
b8d4c8d0 GM |
484 | (string (char-syntax ?/)) |
485 | @result{} "." | |
486 | @end group | |
487 | ||
488 | @group | |
02676e5d CY |
489 | ;; Open parenthesis characters have open parenthesis syntax. Note |
490 | ;; that this @code{char-syntax} call does not reveal that it has a | |
491 | ;; matching character, @samp{)}. | |
b8d4c8d0 GM |
492 | (string (char-syntax ?\()) |
493 | @result{} "(" | |
494 | @end group | |
495 | @end example | |
496 | ||
b8d4c8d0 GM |
497 | @end defun |
498 | ||
499 | @defun set-syntax-table table | |
500 | This function makes @var{table} the syntax table for the current buffer. | |
501 | It returns @var{table}. | |
502 | @end defun | |
503 | ||
504 | @defun syntax-table | |
505 | This function returns the current syntax table, which is the table for | |
506 | the current buffer. | |
507 | @end defun | |
508 | ||
509 | @defmac with-syntax-table @var{table} @var{body}@dots{} | |
510 | This macro executes @var{body} using @var{table} as the current syntax | |
511 | table. It returns the value of the last form in @var{body}, after | |
512 | restoring the old current syntax table. | |
513 | ||
514 | Since each buffer has its own current syntax table, we should make that | |
515 | more precise: @code{with-syntax-table} temporarily alters the current | |
516 | syntax table of whichever buffer is current at the time the macro | |
517 | execution starts. Other buffers are not affected. | |
518 | @end defmac | |
519 | ||
520 | @node Syntax Properties | |
521 | @section Syntax Properties | |
522 | @kindex syntax-table @r{(text property)} | |
523 | ||
524 | When the syntax table is not flexible enough to specify the syntax of | |
4230351b CY |
525 | a language, you can override the syntax table for specific character |
526 | occurrences in the buffer, by applying a @code{syntax-table} text | |
527 | property. @xref{Text Properties}, for how to apply text properties. | |
b8d4c8d0 | 528 | |
4230351b | 529 | The valid values of @code{syntax-table} text property are: |
b8d4c8d0 GM |
530 | |
531 | @table @asis | |
532 | @item @var{syntax-table} | |
533 | If the property value is a syntax table, that table is used instead of | |
4230351b CY |
534 | the current buffer's syntax table to determine the syntax for the |
535 | underlying text character. | |
b8d4c8d0 GM |
536 | |
537 | @item @code{(@var{syntax-code} . @var{matching-char})} | |
6dcef6ec CY |
538 | A cons cell of this format is a raw syntax descriptor (@pxref{Syntax |
539 | Table Internals}), which directly specifies a syntax class for the | |
540 | underlying text character. | |
b8d4c8d0 GM |
541 | |
542 | @item @code{nil} | |
543 | If the property is @code{nil}, the character's syntax is determined from | |
544 | the current syntax table in the usual way. | |
545 | @end table | |
546 | ||
547 | @defvar parse-sexp-lookup-properties | |
4230351b CY |
548 | If this is non-@code{nil}, the syntax scanning functions, like |
549 | @code{forward-sexp}, pay attention to syntax text properties. | |
550 | Otherwise they use only the current syntax table. | |
551 | @end defvar | |
552 | ||
553 | @defvar syntax-propertize-function | |
554 | This variable, if non-@code{nil}, should store a function for applying | |
555 | @code{syntax-table} properties to a specified stretch of text. It is | |
556 | intended to be used by major modes to install a function which applies | |
557 | @code{syntax-table} properties in some mode-appropriate way. | |
558 | ||
559 | The function is called by @code{syntax-ppss} (@pxref{Position Parse}), | |
560 | and by Font Lock mode during syntactic fontification (@pxref{Syntactic | |
561 | Font Lock}). It is called with two arguments, @var{start} and | |
562 | @var{end}, which are the starting and ending positions of the text on | |
563 | which it should act. It is allowed to call @code{syntax-ppss} on any | |
564 | position before @var{end}. However, it should not call | |
565 | @code{syntax-ppss-flush-cache}; so, it is not allowed to call | |
566 | @code{syntax-ppss} on some position and later modify the buffer at an | |
567 | earlier position. | |
568 | @end defvar | |
569 | ||
570 | @defvar syntax-propertize-extend-region-functions | |
571 | This abnormal hook is run by the syntax parsing code prior to calling | |
572 | @code{syntax-propertize-function}. Its role is to help locate safe | |
573 | starting and ending buffer positions for passing to | |
574 | @code{syntax-propertize-function}. For example, a major mode can add | |
575 | a function to this hook to identify multi-line syntactic constructs, | |
576 | and ensure that the boundaries do not fall in the middle of one. | |
577 | ||
578 | Each function in this hook should accept two arguments, @var{start} | |
579 | and @var{end}. It should return either a cons cell of two adjusted | |
580 | buffer positions, @code{(@var{new-start} . @var{new-end})}, or | |
581 | @code{nil} if no adjustment is necessary. The hook functions are run | |
582 | in turn, repeatedly, until they all return @code{nil}. | |
b8d4c8d0 GM |
583 | @end defvar |
584 | ||
585 | @node Motion and Syntax | |
586 | @section Motion and Syntax | |
587 | ||
588 | This section describes functions for moving across characters that | |
589 | have certain syntax classes. | |
590 | ||
591 | @defun skip-syntax-forward syntaxes &optional limit | |
592 | This function moves point forward across characters having syntax | |
593 | classes mentioned in @var{syntaxes} (a string of syntax class | |
594 | characters). It stops when it encounters the end of the buffer, or | |
595 | position @var{limit} (if specified), or a character it is not supposed | |
596 | to skip. | |
597 | ||
598 | If @var{syntaxes} starts with @samp{^}, then the function skips | |
599 | characters whose syntax is @emph{not} in @var{syntaxes}. | |
600 | ||
601 | The return value is the distance traveled, which is a nonnegative | |
602 | integer. | |
603 | @end defun | |
604 | ||
605 | @defun skip-syntax-backward syntaxes &optional limit | |
606 | This function moves point backward across characters whose syntax | |
607 | classes are mentioned in @var{syntaxes}. It stops when it encounters | |
608 | the beginning of the buffer, or position @var{limit} (if specified), or | |
609 | a character it is not supposed to skip. | |
610 | ||
611 | If @var{syntaxes} starts with @samp{^}, then the function skips | |
612 | characters whose syntax is @emph{not} in @var{syntaxes}. | |
613 | ||
614 | The return value indicates the distance traveled. It is an integer that | |
615 | is zero or less. | |
616 | @end defun | |
617 | ||
618 | @defun backward-prefix-chars | |
619 | This function moves point backward over any number of characters with | |
620 | expression prefix syntax. This includes both characters in the | |
621 | expression prefix syntax class, and characters with the @samp{p} flag. | |
622 | @end defun | |
623 | ||
624 | @node Parsing Expressions | |
625 | @section Parsing Expressions | |
626 | ||
627 | This section describes functions for parsing and scanning balanced | |
a037c171 CY |
628 | expressions. We will refer to such expressions as @dfn{sexps}, |
629 | following the terminology of Lisp, even though these functions can act | |
630 | on languages other than Lisp. Basically, a sexp is either a balanced | |
631 | parenthetical grouping, a string, or a ``symbol'' (i.e.@: a sequence | |
632 | of characters whose syntax is either word constituent or symbol | |
4230351b CY |
633 | constituent). However, characters in the expression prefix syntax |
634 | class (@pxref{Syntax Class Table}) are treated as part of the sexp if | |
635 | they appear next to it. | |
b8d4c8d0 GM |
636 | |
637 | The syntax table controls the interpretation of characters, so these | |
638 | functions can be used for Lisp expressions when in Lisp mode and for C | |
639 | expressions when in C mode. @xref{List Motion}, for convenient | |
640 | higher-level functions for moving over balanced expressions. | |
641 | ||
642 | A character's syntax controls how it changes the state of the | |
643 | parser, rather than describing the state itself. For example, a | |
644 | string delimiter character toggles the parser state between | |
16152b76 | 645 | ``in-string'' and ``in-code'', but the syntax of characters does not |
b8d4c8d0 GM |
646 | directly say whether they are inside a string. For example (note that |
647 | 15 is the syntax code for generic string delimiters), | |
648 | ||
649 | @example | |
650 | (put-text-property 1 9 'syntax-table '(15 . nil)) | |
651 | @end example | |
652 | ||
653 | @noindent | |
654 | does not tell Emacs that the first eight chars of the current buffer | |
655 | are a string, but rather that they are all string delimiters. As a | |
656 | result, Emacs treats them as four consecutive empty string constants. | |
657 | ||
658 | @menu | |
659 | * Motion via Parsing:: Motion functions that work by parsing. | |
660 | * Position Parse:: Determining the syntactic state of a position. | |
661 | * Parser State:: How Emacs represents a syntactic state. | |
662 | * Low-Level Parsing:: Parsing across a specified region. | |
663 | * Control Parsing:: Parameters that affect parsing. | |
664 | @end menu | |
665 | ||
666 | @node Motion via Parsing | |
667 | @subsection Motion Commands Based on Parsing | |
668 | ||
669 | This section describes simple point-motion functions that operate | |
670 | based on parsing expressions. | |
671 | ||
672 | @defun scan-lists from count depth | |
7b926f3f CY |
673 | This function scans forward @var{count} balanced parenthetical |
674 | groupings from position @var{from}. It returns the position where the | |
675 | scan stops. If @var{count} is negative, the scan moves backwards. | |
676 | ||
677 | If @var{depth} is nonzero, treat the starting position as being | |
678 | @var{depth} parentheses deep. The scanner moves forward or backward | |
679 | through the buffer until the depth changes to zero @var{count} times. | |
680 | Hence, a positive value for @var{depth} has the effect of moving out | |
681 | @var{depth} levels of parenthesis from the starting position, while a | |
682 | negative @var{depth} has the effect of moving deeper by @var{-depth} | |
683 | levels of parenthesis. | |
b8d4c8d0 GM |
684 | |
685 | Scanning ignores comments if @code{parse-sexp-ignore-comments} is | |
686 | non-@code{nil}. | |
687 | ||
7b926f3f CY |
688 | If the scan reaches the beginning or end of the accessible part of the |
689 | buffer before it has scanned over @var{count} parenthetical groupings, | |
690 | the return value is @code{nil} if the depth at that point is zero; if | |
691 | the depth is non-zero, a @code{scan-error} error is signaled. | |
b8d4c8d0 GM |
692 | @end defun |
693 | ||
694 | @defun scan-sexps from count | |
695 | This function scans forward @var{count} sexps from position @var{from}. | |
696 | It returns the position where the scan stops. If @var{count} is | |
697 | negative, the scan moves backwards. | |
698 | ||
699 | Scanning ignores comments if @code{parse-sexp-ignore-comments} is | |
700 | non-@code{nil}. | |
701 | ||
702 | If the scan reaches the beginning or end of (the accessible part of) the | |
703 | buffer while in the middle of a parenthetical grouping, an error is | |
704 | signaled. If it reaches the beginning or end between groupings but | |
705 | before count is used up, @code{nil} is returned. | |
706 | @end defun | |
707 | ||
708 | @defun forward-comment count | |
709 | This function moves point forward across @var{count} complete comments | |
710 | (that is, including the starting delimiter and the terminating | |
711 | delimiter if any), plus any whitespace encountered on the way. It | |
712 | moves backward if @var{count} is negative. If it encounters anything | |
713 | other than a comment or whitespace, it stops, leaving point at the | |
714 | place where it stopped. This includes (for instance) finding the end | |
715 | of a comment when moving forward and expecting the beginning of one. | |
716 | The function also stops immediately after moving over the specified | |
717 | number of complete comments. If @var{count} comments are found as | |
718 | expected, with nothing except whitespace between them, it returns | |
719 | @code{t}; otherwise it returns @code{nil}. | |
720 | ||
721 | This function cannot tell whether the ``comments'' it traverses are | |
722 | embedded within a string. If they look like comments, it treats them | |
723 | as comments. | |
b8d4c8d0 GM |
724 | |
725 | To move forward over all comments and whitespace following point, use | |
4230351b CY |
726 | @code{(forward-comment (buffer-size))}. @code{(buffer-size)} is a |
727 | good argument to use, because the number of comments in the buffer | |
728 | cannot exceed that many. | |
729 | @end defun | |
b8d4c8d0 GM |
730 | |
731 | @node Position Parse | |
732 | @subsection Finding the Parse State for a Position | |
733 | ||
734 | For syntactic analysis, such as in indentation, often the useful | |
735 | thing is to compute the syntactic state corresponding to a given buffer | |
736 | position. This function does that conveniently. | |
737 | ||
738 | @defun syntax-ppss &optional pos | |
4230351b CY |
739 | This function returns the parser state that the parser would reach at |
740 | position @var{pos} starting from the beginning of the buffer. | |
741 | @iftex | |
742 | See the next section for | |
743 | @end iftex | |
744 | @ifnottex | |
745 | @xref{Parser State}, | |
746 | @end ifnottex | |
747 | for a description of the parser state. | |
748 | ||
749 | The return value is the same as if you call the low-level parsing | |
750 | function @code{parse-partial-sexp} to parse from the beginning of the | |
751 | buffer to @var{pos} (@pxref{Low-Level Parsing}). However, | |
752 | @code{syntax-ppss} uses a cache to speed up the computation. Due to | |
753 | this optimization, the second value (previous complete subexpression) | |
754 | and sixth value (minimum parenthesis depth) in the returned parser | |
755 | state are not meaningful. | |
756 | ||
757 | This function has a side effect: it adds a buffer-local entry to | |
758 | @code{before-change-functions} (@pxref{Change Hooks}) for | |
759 | @code{syntax-ppss-flush-cache} (see below). This entry keeps the | |
760 | cache consistent as the buffer is modified. However, the cache might | |
761 | not be updated if @code{syntax-ppss} is called while | |
b8d4c8d0 | 762 | @code{before-change-functions} is temporarily let-bound, or if the |
4230351b CY |
763 | buffer is modified without running the hook, such as when using |
764 | @code{inhibit-modification-hooks}. In those cases, it is necessary to | |
765 | call @code{syntax-ppss-flush-cache} explicitly. | |
766 | @end defun | |
b8d4c8d0 | 767 | |
106e6894 CY |
768 | @defun syntax-ppss-flush-cache beg &rest ignored-args |
769 | This function flushes the cache used by @code{syntax-ppss}, starting | |
770 | at position @var{beg}. The remaining arguments, @var{ignored-args}, | |
771 | are ignored; this function accepts them so that it can be directly | |
772 | used on hooks such as @code{before-change-functions} (@pxref{Change | |
773 | Hooks}). | |
b8d4c8d0 GM |
774 | @end defun |
775 | ||
776 | Major modes can make @code{syntax-ppss} run faster by specifying | |
777 | where it needs to start parsing. | |
778 | ||
779 | @defvar syntax-begin-function | |
780 | If this is non-@code{nil}, it should be a function that moves to an | |
781 | earlier buffer position where the parser state is equivalent to | |
782 | @code{nil}---in other words, a position outside of any comment, | |
783 | string, or parenthesis. @code{syntax-ppss} uses it to further | |
784 | optimize its computations, when the cache gives no help. | |
785 | @end defvar | |
786 | ||
787 | @node Parser State | |
788 | @subsection Parser State | |
789 | @cindex parser state | |
790 | ||
4230351b CY |
791 | A @dfn{parser state} is a list of ten elements describing the state |
792 | of the syntactic parser, after it parses the text between a specified | |
793 | starting point and a specified end point in the buffer. Parsing | |
794 | functions such as @code{syntax-ppss} | |
795 | @ifnottex | |
796 | (@pxref{Position Parse}) | |
797 | @end ifnottex | |
798 | return a parser state as the value. Some parsing functions accept a | |
799 | parser state as an argument, for resuming parsing. | |
800 | ||
801 | Here are the meanings of the elements of the parser state: | |
b8d4c8d0 GM |
802 | |
803 | @enumerate 0 | |
804 | @item | |
805 | The depth in parentheses, counting from 0. @strong{Warning:} this can | |
806 | be negative if there are more close parens than open parens between | |
4230351b | 807 | the parser's starting point and end point. |
b8d4c8d0 GM |
808 | |
809 | @item | |
810 | @cindex innermost containing parentheses | |
811 | The character position of the start of the innermost parenthetical | |
812 | grouping containing the stopping point; @code{nil} if none. | |
813 | ||
814 | @item | |
815 | @cindex previous complete subexpression | |
816 | The character position of the start of the last complete subexpression | |
817 | terminated; @code{nil} if none. | |
818 | ||
819 | @item | |
820 | @cindex inside string | |
821 | Non-@code{nil} if inside a string. More precisely, this is the | |
822 | character that will terminate the string, or @code{t} if a generic | |
823 | string delimiter character should terminate it. | |
824 | ||
825 | @item | |
826 | @cindex inside comment | |
4230351b CY |
827 | @code{t} if inside a non-nestable comment (of any comment style; |
828 | @pxref{Syntax Flags}); or the comment nesting level if inside a | |
829 | comment that can be nested. | |
b8d4c8d0 GM |
830 | |
831 | @item | |
832 | @cindex quote character | |
4230351b | 833 | @code{t} if the end point is just after a quote character. |
b8d4c8d0 GM |
834 | |
835 | @item | |
836 | The minimum parenthesis depth encountered during this scan. | |
837 | ||
838 | @item | |
4230351b CY |
839 | What kind of comment is active: @code{nil} if not in a comment or in a |
840 | comment of style @samp{a}; 1 for a comment of style @samp{b}; 2 for a | |
841 | comment of style @samp{c}; and @code{syntax-table} for a comment that | |
842 | should be ended by a generic comment delimiter character. | |
b8d4c8d0 GM |
843 | |
844 | @item | |
845 | The string or comment start position. While inside a comment, this is | |
846 | the position where the comment began; while inside a string, this is the | |
847 | position where the string began. When outside of strings and comments, | |
848 | this element is @code{nil}. | |
849 | ||
850 | @item | |
851 | Internal data for continuing the parsing. The meaning of this | |
852 | data is subject to change; it is used if you pass this list | |
853 | as the @var{state} argument to another call. | |
854 | @end enumerate | |
855 | ||
856 | Elements 1, 2, and 6 are ignored in a state which you pass as an | |
857 | argument to continue parsing, and elements 8 and 9 are used only in | |
4230351b CY |
858 | trivial cases. Those elements are mainly used internally by the |
859 | parser code. | |
b8d4c8d0 GM |
860 | |
861 | One additional piece of useful information is available from a | |
862 | parser state using this function: | |
863 | ||
864 | @defun syntax-ppss-toplevel-pos state | |
865 | This function extracts, from parser state @var{state}, the last | |
866 | position scanned in the parse which was at top level in grammatical | |
867 | structure. ``At top level'' means outside of any parentheses, | |
868 | comments, or strings. | |
869 | ||
870 | The value is @code{nil} if @var{state} represents a parse which has | |
871 | arrived at a top level position. | |
872 | @end defun | |
873 | ||
b8d4c8d0 GM |
874 | @node Low-Level Parsing |
875 | @subsection Low-Level Parsing | |
876 | ||
877 | The most basic way to use the expression parser is to tell it | |
878 | to start at a given position with a certain state, and parse up to | |
879 | a specified end position. | |
880 | ||
881 | @defun parse-partial-sexp start limit &optional target-depth stop-before state stop-comment | |
882 | This function parses a sexp in the current buffer starting at | |
883 | @var{start}, not scanning past @var{limit}. It stops at position | |
884 | @var{limit} or when certain criteria described below are met, and sets | |
885 | point to the location where parsing stops. It returns a parser state | |
52404181 CY |
886 | @ifinfo |
887 | (@pxref{Parser State}) | |
888 | @end ifinfo | |
b8d4c8d0 GM |
889 | describing the status of the parse at the point where it stops. |
890 | ||
891 | @cindex parenthesis depth | |
892 | If the third argument @var{target-depth} is non-@code{nil}, parsing | |
893 | stops if the depth in parentheses becomes equal to @var{target-depth}. | |
894 | The depth starts at 0, or at whatever is given in @var{state}. | |
895 | ||
896 | If the fourth argument @var{stop-before} is non-@code{nil}, parsing | |
897 | stops when it comes to any character that starts a sexp. If | |
898 | @var{stop-comment} is non-@code{nil}, parsing stops when it comes to the | |
899 | start of a comment. If @var{stop-comment} is the symbol | |
900 | @code{syntax-table}, parsing stops after the start of a comment or a | |
901 | string, or the end of a comment or a string, whichever comes first. | |
902 | ||
903 | If @var{state} is @code{nil}, @var{start} is assumed to be at the top | |
904 | level of parenthesis structure, such as the beginning of a function | |
905 | definition. Alternatively, you might wish to resume parsing in the | |
906 | middle of the structure. To do this, you must provide a @var{state} | |
907 | argument that describes the initial status of parsing. The value | |
908 | returned by a previous call to @code{parse-partial-sexp} will do | |
909 | nicely. | |
910 | @end defun | |
911 | ||
912 | @node Control Parsing | |
913 | @subsection Parameters to Control Parsing | |
914 | ||
915 | @defvar multibyte-syntax-as-symbol | |
916 | If this variable is non-@code{nil}, @code{scan-sexps} treats all | |
917 | non-@acronym{ASCII} characters as symbol constituents regardless | |
918 | of what the syntax table says about them. (However, text properties | |
919 | can still override the syntax.) | |
920 | @end defvar | |
921 | ||
922 | @defopt parse-sexp-ignore-comments | |
923 | @cindex skipping comments | |
924 | If the value is non-@code{nil}, then comments are treated as | |
925 | whitespace by the functions in this section and by @code{forward-sexp}, | |
926 | @code{scan-lists} and @code{scan-sexps}. | |
927 | @end defopt | |
928 | ||
929 | @vindex parse-sexp-lookup-properties | |
930 | The behavior of @code{parse-partial-sexp} is also affected by | |
931 | @code{parse-sexp-lookup-properties} (@pxref{Syntax Properties}). | |
932 | ||
933 | You can use @code{forward-comment} to move forward or backward over | |
934 | one comment or several comments. | |
935 | ||
b8d4c8d0 GM |
936 | @node Syntax Table Internals |
937 | @section Syntax Table Internals | |
938 | @cindex syntax table internals | |
939 | ||
02676e5d CY |
940 | Syntax tables are implemented as char-tables (@pxref{Char-Tables}), |
941 | but most Lisp programs don't work directly with their elements. | |
942 | Syntax tables do not store syntax data as syntax descriptors | |
943 | (@pxref{Syntax Descriptors}); they use an internal format, which is | |
944 | documented in this section. This internal format can also be assigned | |
945 | as syntax properties (@pxref{Syntax Properties}). | |
946 | ||
947 | @cindex syntax code | |
6dcef6ec CY |
948 | @cindex raw syntax descriptor |
949 | Each entry in a syntax table is a @dfn{raw syntax descriptor}: a | |
950 | cons cell of the form @code{(@var{syntax-code} | |
951 | . @var{matching-char})}. @var{syntax-code} is an integer which | |
952 | encodes the syntax class and syntax flags, according to the table | |
953 | below. @var{matching-char}, if non-@code{nil}, specifies a matching | |
954 | character (similar to the second character in a syntax descriptor). | |
955 | ||
956 | Here are the syntax codes corresponding to the various syntax | |
957 | classes: | |
02676e5d CY |
958 | |
959 | @multitable @columnfractions .2 .3 .2 .3 | |
b8d4c8d0 | 960 | @item |
6dcef6ec | 961 | @i{Code} @tab @i{Class} @tab @i{Code} @tab @i{Class} |
b8d4c8d0 | 962 | @item |
02676e5d | 963 | 0 @tab whitespace @tab 8 @tab paired delimiter |
b8d4c8d0 | 964 | @item |
02676e5d | 965 | 1 @tab punctuation @tab 9 @tab escape |
b8d4c8d0 | 966 | @item |
02676e5d | 967 | 2 @tab word @tab 10 @tab character quote |
b8d4c8d0 | 968 | @item |
02676e5d | 969 | 3 @tab symbol @tab 11 @tab comment-start |
b8d4c8d0 | 970 | @item |
02676e5d | 971 | 4 @tab open parenthesis @tab 12 @tab comment-end |
b8d4c8d0 | 972 | @item |
02676e5d CY |
973 | 5 @tab close parenthesis @tab 13 @tab inherit |
974 | @item | |
975 | 6 @tab expression prefix @tab 14 @tab generic comment | |
976 | @item | |
977 | 7 @tab string quote @tab 15 @tab generic string | |
b8d4c8d0 GM |
978 | @end multitable |
979 | ||
02676e5d CY |
980 | @noindent |
981 | For example, in the standard syntax table, the entry for @samp{(} is | |
6dcef6ec | 982 | @code{(4 . 41)}. 41 is the character code for @samp{)}. |
b8d4c8d0 | 983 | |
02676e5d CY |
984 | Syntax flags are encoded in higher order bits, starting 16 bits from |
985 | the least significant bit. This table gives the power of two which | |
b8d4c8d0 GM |
986 | corresponds to each syntax flag. |
987 | ||
02676e5d CY |
988 | @multitable @columnfractions .15 .3 .15 .3 |
989 | @item | |
990 | @i{Prefix} @tab @i{Flag} @tab @i{Prefix} @tab @i{Flag} | |
b8d4c8d0 | 991 | @item |
02676e5d | 992 | @samp{1} @tab @code{(lsh 1 16)} @tab @samp{p} @tab @code{(lsh 1 20)} |
b8d4c8d0 | 993 | @item |
02676e5d | 994 | @samp{2} @tab @code{(lsh 1 17)} @tab @samp{b} @tab @code{(lsh 1 21)} |
b8d4c8d0 | 995 | @item |
02676e5d | 996 | @samp{3} @tab @code{(lsh 1 18)} @tab @samp{n} @tab @code{(lsh 1 22)} |
b8d4c8d0 | 997 | @item |
02676e5d | 998 | @samp{4} @tab @code{(lsh 1 19)} |
b8d4c8d0 GM |
999 | @end multitable |
1000 | ||
1001 | @defun string-to-syntax @var{desc} | |
6dcef6ec CY |
1002 | Given a syntax descriptor @var{desc} (a string), this function returns |
1003 | the corresponding raw syntax descriptor. | |
b8d4c8d0 GM |
1004 | @end defun |
1005 | ||
1006 | @defun syntax-after pos | |
6dcef6ec CY |
1007 | This function returns the raw syntax descriptor for the character in |
1008 | the buffer after position @var{pos}, taking account of syntax | |
1009 | properties as well as the syntax table. If @var{pos} is outside the | |
1010 | buffer's accessible portion (@pxref{Narrowing, accessible portion}), | |
1011 | the return value is @code{nil}. | |
b8d4c8d0 GM |
1012 | @end defun |
1013 | ||
1014 | @defun syntax-class syntax | |
6dcef6ec CY |
1015 | This function returns the syntax code for the raw syntax descriptor |
1016 | @var{syntax}. More precisely, it takes the raw syntax descriptor's | |
1017 | @var{syntax-code} component, masks off the high 16 bits which record | |
1018 | the syntax flags, and returns the resulting integer. | |
1019 | ||
1020 | If @var{syntax} is @code{nil}, the return value is returns @code{nil}. | |
1021 | This is so that the expression | |
b8d4c8d0 GM |
1022 | |
1023 | @example | |
1024 | (syntax-class (syntax-after pos)) | |
1025 | @end example | |
1026 | ||
1027 | @noindent | |
6dcef6ec CY |
1028 | evaluates to @code{nil} if @code{pos} is outside the buffer's |
1029 | accessible portion, without throwing errors or returning an incorrect | |
1030 | code. | |
b8d4c8d0 GM |
1031 | @end defun |
1032 | ||
1033 | @node Categories | |
1034 | @section Categories | |
1035 | @cindex categories of characters | |
1036 | @cindex character categories | |
1037 | ||
1038 | @dfn{Categories} provide an alternate way of classifying characters | |
1039 | syntactically. You can define several categories as needed, then | |
1040 | independently assign each character to one or more categories. Unlike | |
1041 | syntax classes, categories are not mutually exclusive; it is normal for | |
1042 | one character to belong to several categories. | |
1043 | ||
1044 | @cindex category table | |
1045 | Each buffer has a @dfn{category table} which records which categories | |
1046 | are defined and also which characters belong to each category. Each | |
1047 | category table defines its own categories, but normally these are | |
1048 | initialized by copying from the standard categories table, so that the | |
1049 | standard categories are available in all modes. | |
1050 | ||
1051 | Each category has a name, which is an @acronym{ASCII} printing character in | |
1052 | the range @w{@samp{ }} to @samp{~}. You specify the name of a category | |
1053 | when you define it with @code{define-category}. | |
1054 | ||
1055 | The category table is actually a char-table (@pxref{Char-Tables}). | |
1056 | The element of the category table at index @var{c} is a @dfn{category | |
1057 | set}---a bool-vector---that indicates which categories character @var{c} | |
1058 | belongs to. In this category set, if the element at index @var{cat} is | |
1059 | @code{t}, that means category @var{cat} is a member of the set, and that | |
1060 | character @var{c} belongs to category @var{cat}. | |
1061 | ||
1062 | For the next three functions, the optional argument @var{table} | |
1063 | defaults to the current buffer's category table. | |
1064 | ||
1065 | @defun define-category char docstring &optional table | |
1066 | This function defines a new category, with name @var{char} and | |
1067 | documentation @var{docstring}, for the category table @var{table}. | |
1ea897d5 EZ |
1068 | |
1069 | Here's an example of defining a new category for characters that have | |
1070 | strong right-to-left directionality (@pxref{Bidirectional Display}) | |
1071 | and using it in a special category table: | |
1072 | ||
1073 | @example | |
1074 | (defvar special-category-table-for-bidi | |
1075 | (let ((category-table (make-category-table)) | |
1076 | (uniprop-table (unicode-property-table-internal 'bidi-class))) | |
1077 | (define-category ?R "Characters of bidi-class R, AL, or RLO" | |
1078 | category-table) | |
1079 | (map-char-table | |
1080 | #'(lambda (key val) | |
1081 | (if (memq val '(R AL RLO)) | |
1082 | (modify-category-entry key ?R category-table))) | |
1083 | uniprop-table) | |
1084 | category-table)) | |
1085 | @end example | |
b8d4c8d0 GM |
1086 | @end defun |
1087 | ||
1088 | @defun category-docstring category &optional table | |
1089 | This function returns the documentation string of category @var{category} | |
1090 | in category table @var{table}. | |
1091 | ||
1092 | @example | |
1093 | (category-docstring ?a) | |
1094 | @result{} "ASCII" | |
1095 | (category-docstring ?l) | |
1096 | @result{} "Latin" | |
1097 | @end example | |
1098 | @end defun | |
1099 | ||
1100 | @defun get-unused-category &optional table | |
1101 | This function returns a category name (a character) which is not | |
1102 | currently defined in @var{table}. If all possible categories are in use | |
1103 | in @var{table}, it returns @code{nil}. | |
1104 | @end defun | |
1105 | ||
1106 | @defun category-table | |
1107 | This function returns the current buffer's category table. | |
1108 | @end defun | |
1109 | ||
1110 | @defun category-table-p object | |
1111 | This function returns @code{t} if @var{object} is a category table, | |
1112 | otherwise @code{nil}. | |
1113 | @end defun | |
1114 | ||
1115 | @defun standard-category-table | |
1116 | This function returns the standard category table. | |
1117 | @end defun | |
1118 | ||
1119 | @defun copy-category-table &optional table | |
1120 | This function constructs a copy of @var{table} and returns it. If | |
1121 | @var{table} is not supplied (or is @code{nil}), it returns a copy of the | |
1122 | standard category table. Otherwise, an error is signaled if @var{table} | |
1123 | is not a category table. | |
1124 | @end defun | |
1125 | ||
1126 | @defun set-category-table table | |
1127 | This function makes @var{table} the category table for the current | |
1128 | buffer. It returns @var{table}. | |
1129 | @end defun | |
1130 | ||
1131 | @defun make-category-table | |
1132 | This creates and returns an empty category table. In an empty category | |
1133 | table, no categories have been allocated, and no characters belong to | |
1134 | any categories. | |
1135 | @end defun | |
1136 | ||
1137 | @defun make-category-set categories | |
1138 | This function returns a new category set---a bool-vector---whose initial | |
1139 | contents are the categories listed in the string @var{categories}. The | |
1140 | elements of @var{categories} should be category names; the new category | |
1141 | set has @code{t} for each of those categories, and @code{nil} for all | |
1142 | other categories. | |
1143 | ||
1144 | @example | |
1145 | (make-category-set "al") | |
1146 | @result{} #&128"\0\0\0\0\0\0\0\0\0\0\0\0\2\20\0\0" | |
1147 | @end example | |
1148 | @end defun | |
1149 | ||
1150 | @defun char-category-set char | |
1151 | This function returns the category set for character @var{char} in the | |
1152 | current buffer's category table. This is the bool-vector which | |
1153 | records which categories the character @var{char} belongs to. The | |
1154 | function @code{char-category-set} does not allocate storage, because | |
1155 | it returns the same bool-vector that exists in the category table. | |
1156 | ||
1157 | @example | |
1158 | (char-category-set ?a) | |
1159 | @result{} #&128"\0\0\0\0\0\0\0\0\0\0\0\0\2\20\0\0" | |
1160 | @end example | |
1161 | @end defun | |
1162 | ||
1163 | @defun category-set-mnemonics category-set | |
1164 | This function converts the category set @var{category-set} into a string | |
1165 | containing the characters that designate the categories that are members | |
1166 | of the set. | |
1167 | ||
1168 | @example | |
1169 | (category-set-mnemonics (char-category-set ?a)) | |
1170 | @result{} "al" | |
1171 | @end example | |
1172 | @end defun | |
1173 | ||
f147ff75 CY |
1174 | @defun modify-category-entry char category &optional table reset |
1175 | This function modifies the category set of @var{char} in category | |
b8d4c8d0 | 1176 | table @var{table} (which defaults to the current buffer's category |
f147ff75 CY |
1177 | table). @var{char} can be a character, or a cons cell of the form |
1178 | @code{(@var{min} . @var{max})}; in the latter case, the function | |
1179 | modifies the category sets of all characters in the range between | |
1180 | @var{min} and @var{max}, inclusive. | |
b8d4c8d0 | 1181 | |
f147ff75 | 1182 | Normally, it modifies a category set by adding @var{category} to it. |
b8d4c8d0 GM |
1183 | But if @var{reset} is non-@code{nil}, then it deletes @var{category} |
1184 | instead. | |
1185 | @end defun | |
1186 | ||
1187 | @deffn Command describe-categories &optional buffer-or-name | |
1188 | This function describes the category specifications in the current | |
1189 | category table. It inserts the descriptions in a buffer, and then | |
1190 | displays that buffer. If @var{buffer-or-name} is non-@code{nil}, it | |
1191 | describes the category table of that buffer instead. | |
1192 | @end deffn |