Mercurial > emacs
annotate lispref/syntax.texi @ 27114:4efa5e54e9a9
(Qunspecified_fg, Qunspecified_bg): Remove.
(syms_of_xfaces): Remove their staticpro's.
(tty_color_name): Return Lisp strings for unspecified fore- and
back-ground colors.
(Finternal_set_lisp_face_attribute): Remove the special treatment
for Qunspecified_{f,b}g.
(realize_default_face): Replace Qunspecified_{f,b}g with a Lisp
string.
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Mon, 03 Jan 2000 16:52:52 +0000 |
parents | 10e4f3f125da |
children | f6b52258db6a |
rev | line source |
---|---|
6552 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998 Free Software Foundation, Inc. |
6552 | 4 @c See the file elisp.texi for copying conditions. |
5 @setfilename ../info/syntax | |
6 @node Syntax Tables, Abbrevs, Searching and Matching, Top | |
7 @chapter Syntax Tables | |
8 @cindex parsing | |
9 @cindex syntax table | |
10 @cindex text parsing | |
11 | |
12 A @dfn{syntax table} specifies the syntactic textual function of each | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
13 character. This information is used by the @dfn{parsing functions}, the |
6552 | 14 complex movement commands, and others to determine where words, symbols, |
15 and other syntactic constructs begin and end. The current syntax table | |
16 controls the meaning of the word motion functions (@pxref{Word Motion}) | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
17 and the list motion functions (@pxref{List Motion}), as well as the |
6552 | 18 functions in this chapter. |
19 | |
20 @menu | |
21 * Basics: Syntax Basics. Basic concepts of syntax tables. | |
22 * Desc: Syntax Descriptors. How characters are classified. | |
23 * Syntax Table Functions:: How to create, examine and alter syntax tables. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
24 * Syntax Properties:: Overriding syntax with text properties. |
6552 | 25 * Motion and Syntax:: Moving over characters with certain syntaxes. |
26 * Parsing Expressions:: Parsing balanced expressions | |
27 using the syntax table. | |
28 * Standard Syntax Tables:: Syntax tables used by various major modes. | |
29 * Syntax Table Internals:: How syntax table information is stored. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
30 * Categories:: Another way of classifying character syntax. |
6552 | 31 @end menu |
32 | |
33 @node Syntax Basics | |
34 @section Syntax Table Concepts | |
35 | |
36 @ifinfo | |
37 A @dfn{syntax table} provides Emacs with the information that | |
38 determines the syntactic use of each character in a buffer. This | |
39 information is used by the parsing commands, the complex movement | |
40 commands, and others to determine where words, symbols, and other | |
41 syntactic constructs begin and end. The current syntax table controls | |
42 the meaning of the word motion functions (@pxref{Word Motion}) and the | |
43 list motion functions (@pxref{List Motion}) as well as the functions in | |
44 this chapter. | |
45 @end ifinfo | |
46 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
47 A syntax table is a char-table (@pxref{Char-Tables}). The element at |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
48 index @var{c} describes the character with code @var{c}. The element's |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
49 value should be a list that encodes the syntax of the character in |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
50 question. |
6552 | 51 |
52 Syntax tables are used only for moving across text, not for the Emacs | |
53 Lisp reader. Emacs Lisp uses built-in syntactic rules when reading Lisp | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
54 expressions, and these rules cannot be changed. (Some Lisp systems |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
55 provide ways to redefine the read syntax, but we decided to leave this |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
56 feature out of Emacs Lisp for simplicity.) |
6552 | 57 |
58 Each buffer has its own major mode, and each major mode has its own | |
59 idea of the syntactic class of various characters. For example, in Lisp | |
60 mode, the character @samp{;} begins a comment, but in C mode, it | |
61 terminates a statement. To support these variations, Emacs makes the | |
62 choice of syntax table local to each buffer. Typically, each major | |
63 mode has its own syntax table and installs that table in each buffer | |
8469 | 64 that uses that mode. Changing this table alters the syntax in all |
6552 | 65 those buffers as well as in any buffers subsequently put in that mode. |
66 Occasionally several similar modes share one syntax table. | |
67 @xref{Example Major Modes}, for an example of how to set up a syntax | |
68 table. | |
69 | |
70 A syntax table can inherit the data for some characters from the | |
71 standard syntax table, while specifying other characters itself. The | |
72 ``inherit'' syntax class means ``inherit this character's syntax from | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
73 the standard syntax table.'' Just changing the standard syntax for a |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
74 character affects all syntax tables that inherit from it. |
6552 | 75 |
76 @defun syntax-table-p object | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
77 This function returns @code{t} if @var{object} is a syntax table. |
6552 | 78 @end defun |
79 | |
80 @node Syntax Descriptors | |
81 @section Syntax Descriptors | |
82 @cindex syntax classes | |
83 | |
84 This section describes the syntax classes and flags that denote the | |
85 syntax of a character, and how they are represented as a @dfn{syntax | |
86 descriptor}, which is a Lisp string that you pass to | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
87 @code{modify-syntax-entry} to specify the syntax you want. |
6552 | 88 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
89 The syntax table specifies a syntax class for each character. There |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
90 is no necessary relationship between the class of a character in one |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
91 syntax table and its class in any other table. |
6552 | 92 |
8469 | 93 Each class is designated by a mnemonic character, which serves as the |
6552 | 94 name of the class when you need to specify a class. Usually the |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
95 designator character is one that is often assigned that class; however, |
8469 | 96 its meaning as a designator is unvarying and independent of what syntax |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
97 that character currently has. Thus, @samp{\} as a designator character |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
98 always gives ``escape character'' syntax, regardless of what syntax |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
99 @samp{\} currently has. |
6552 | 100 |
101 @cindex syntax descriptor | |
8469 | 102 A syntax descriptor is a Lisp string that specifies a syntax class, a |
6552 | 103 matching character (used only for the parenthesis classes) and flags. |
104 The first character is the designator for a syntax class. The second | |
105 character is the character to match; if it is unused, put a space there. | |
106 Then come the characters for any desired flags. If no matching | |
107 character or flags are needed, one character is sufficient. | |
108 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
109 For example, the syntax descriptor for the character @samp{*} in C |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
110 mode is @samp{@w{. 23}} (i.e., punctuation, matching character slot |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
111 unused, second character of a comment-starter, first character of a |
6552 | 112 comment-ender), and the entry for @samp{/} is @samp{@w{. 14}} (i.e., |
113 punctuation, matching character slot unused, first character of a | |
114 comment-starter, second character of a comment-ender). | |
115 | |
116 @menu | |
117 * Syntax Class Table:: Table of syntax classes. | |
118 * Syntax Flags:: Additional flags each character can have. | |
119 @end menu | |
120 | |
121 @node Syntax Class Table | |
122 @subsection Table of Syntax Classes | |
123 | |
8469 | 124 Here is a table of syntax classes, the characters that stand for them, |
6552 | 125 their meanings, and examples of their use. |
126 | |
127 @deffn {Syntax class} @w{whitespace character} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
128 @dfn{Whitespace characters} (designated by @w{@samp{@ }} or @samp{-}) |
6552 | 129 separate symbols and words from each other. Typically, whitespace |
130 characters have no other syntactic significance, and multiple whitespace | |
131 characters are syntactically equivalent to a single one. Space, tab, | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
132 newline and formfeed are classified as whitespace in almost all major |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
133 modes. |
6552 | 134 @end deffn |
135 | |
136 @deffn {Syntax class} @w{word constituent} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
137 @dfn{Word constituents} (designated by @samp{w}) are parts of normal |
6552 | 138 English words and are typically used in variable and command names in |
8469 | 139 programs. All upper- and lower-case letters, and the digits, are typically |
6552 | 140 word constituents. |
141 @end deffn | |
142 | |
143 @deffn {Syntax class} @w{symbol constituent} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
144 @dfn{Symbol constituents} (designated by @samp{_}) are the extra |
6552 | 145 characters that are used in variable and command names along with word |
146 constituents. For example, the symbol constituents class is used in | |
147 Lisp mode to indicate that certain characters may be part of symbol | |
148 names even though they are not part of English words. These characters | |
149 are @samp{$&*+-_<>}. In standard C, the only non-word-constituent | |
150 character that is valid in symbols is underscore (@samp{_}). | |
151 @end deffn | |
152 | |
153 @deffn {Syntax class} @w{punctuation character} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
154 @dfn{Punctuation characters} (designated by @samp{.}) are those |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
155 characters that are used as punctuation in English, or are used in some |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
156 way in a programming language to separate symbols from one another. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
157 Most programming language modes, including Emacs Lisp mode, have no |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
158 characters in this class since the few characters that are not symbol or |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
159 word constituents all have other uses. |
6552 | 160 @end deffn |
161 | |
162 @deffn {Syntax class} @w{open parenthesis character} | |
163 @deffnx {Syntax class} @w{close parenthesis character} | |
164 @cindex parenthesis syntax | |
165 Open and close @dfn{parenthesis characters} are characters used in | |
166 dissimilar pairs to surround sentences or expressions. Such a grouping | |
167 is begun with an open parenthesis character and terminated with a close. | |
168 Each open parenthesis character matches a particular close parenthesis | |
169 character, and vice versa. Normally, Emacs indicates momentarily the | |
170 matching open parenthesis when you insert a close parenthesis. | |
171 @xref{Blinking}. | |
172 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
173 The class of open parentheses is designated by @samp{(}, and that of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
174 close parentheses by @samp{)}. |
6552 | 175 |
176 In English text, and in C code, the parenthesis pairs are @samp{()}, | |
177 @samp{[]}, and @samp{@{@}}. In Emacs Lisp, the delimiters for lists and | |
178 vectors (@samp{()} and @samp{[]}) are classified as parenthesis | |
179 characters. | |
180 @end deffn | |
181 | |
182 @deffn {Syntax class} @w{string quote} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
183 @dfn{String quote characters} (designated by @samp{"}) are used in |
6552 | 184 many languages, including Lisp and C, to delimit string constants. The |
185 same string quote character appears at the beginning and the end of a | |
186 string. Such quoted strings do not nest. | |
187 | |
188 The parsing facilities of Emacs consider a string as a single token. | |
189 The usual syntactic meanings of the characters in the string are | |
190 suppressed. | |
191 | |
192 The Lisp modes have two string quote characters: double-quote (@samp{"}) | |
193 and vertical bar (@samp{|}). @samp{|} is not used in Emacs Lisp, but it | |
194 is used in Common Lisp. C also has two string quote characters: | |
195 double-quote for strings, and single-quote (@samp{'}) for character | |
196 constants. | |
197 | |
198 English text has no string quote characters because English is not a | |
199 programming language. Although quotation marks are used in English, | |
200 we do not want them to turn off the usual syntactic properties of | |
201 other characters in the quotation. | |
202 @end deffn | |
203 | |
204 @deffn {Syntax class} @w{escape} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
205 An @dfn{escape character} (designated by @samp{\}) starts an escape |
6552 | 206 sequence such as is used in C string and character constants. The |
207 character @samp{\} belongs to this class in both C and Lisp. (In C, it | |
208 is used thus only inside strings, but it turns out to cause no trouble | |
209 to treat it this way throughout C code.) | |
210 | |
211 Characters in this class count as part of words if | |
212 @code{words-include-escapes} is non-@code{nil}. @xref{Word Motion}. | |
213 @end deffn | |
214 | |
215 @deffn {Syntax class} @w{character quote} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
216 A @dfn{character quote character} (designated by @samp{/}) quotes the |
6552 | 217 following character so that it loses its normal syntactic meaning. This |
218 differs from an escape character in that only the character immediately | |
219 following is ever affected. | |
220 | |
221 Characters in this class count as part of words if | |
222 @code{words-include-escapes} is non-@code{nil}. @xref{Word Motion}. | |
223 | |
11136
043aedff8710
Fix usage note for character quote syntax class.
Richard M. Stallman <rms@gnu.org>
parents:
8469
diff
changeset
|
224 This class is used for backslash in @TeX{} mode. |
6552 | 225 @end deffn |
226 | |
227 @deffn {Syntax class} @w{paired delimiter} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
228 @dfn{Paired delimiter characters} (designated by @samp{$}) are like |
6552 | 229 string quote characters except that the syntactic properties of the |
230 characters between the delimiters are not suppressed. Only @TeX{} mode | |
8469 | 231 uses a paired delimiter presently---the @samp{$} that both enters and |
232 leaves math mode. | |
6552 | 233 @end deffn |
234 | |
235 @deffn {Syntax class} @w{expression prefix} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
236 An @dfn{expression prefix operator} (designated by @samp{'}) is used for |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
237 syntactic operators that are considered as part of an expression if they |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
238 appear next to one. In Lisp modes, these characters include the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
239 apostrophe, @samp{'} (used for quoting), the comma, @samp{,} (used in |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
240 macros), and @samp{#} (used in the read syntax for certain data types). |
6552 | 241 @end deffn |
242 | |
243 @deffn {Syntax class} @w{comment starter} | |
244 @deffnx {Syntax class} @w{comment ender} | |
245 @cindex comment syntax | |
246 The @dfn{comment starter} and @dfn{comment ender} characters are used in | |
247 various languages to delimit comments. These classes are designated | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
248 by @samp{<} and @samp{>}, respectively. |
6552 | 249 |
250 English text has no comment characters. In Lisp, the semicolon | |
251 (@samp{;}) starts a comment and a newline or formfeed ends one. | |
252 @end deffn | |
253 | |
254 @deffn {Syntax class} @w{inherit} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
255 This syntax class does not specify a particular syntax. It says to look |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
256 in the standard syntax table to find the syntax of this character. The |
6552 | 257 designator for this syntax code is @samp{@@}. |
258 @end deffn | |
259 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
260 @deffn {Syntax class} @w{generic comment delimiter} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
261 A @dfn{generic comment delimiter} character starts or ends a special |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
262 kind of comment. @emph{Any} generic comment delimiter matches |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
263 @emph{any} generic comment delimiter, but they cannot match a comment |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
264 starter or comment ender; generic comment delimiters can only match each |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
265 other. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
266 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
267 This syntax class is primarily meant for use with the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
268 @code{syntax-table} text property (@pxref{Syntax Properties}). You can |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
269 mark any range of characters as forming a comment, by giving the first |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
270 and last characters of the range @code{syntax-table} properties |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
271 identifying them as generic comment delimiters. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
272 @end deffn |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
273 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
274 @deffn {Syntax class} @w{generic string delimiter} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
275 A @dfn{generic string delimiter} character starts or ends a string. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
276 This class differs from the string quote class in that @emph{any} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
277 generic string delimiter can match any other generic string delimiter; |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
278 but they do not match ordinary string quote characters. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
279 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
280 This syntax class is primarily meant for use with the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
281 @code{syntax-table} text property (@pxref{Syntax Properties}). You can |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
282 mark any range of characters as forming a string constant, by giving the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
283 first and last characters of the range @code{syntax-table} properties |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
284 identifying them as generic string delimiters. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
285 @end deffn |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
286 |
6552 | 287 @node Syntax Flags |
288 @subsection Syntax Flags | |
289 @cindex syntax flags | |
290 | |
291 In addition to the classes, entries for characters in a syntax table | |
26288 | 292 can specify flags. There are seven possible flags, represented by the |
293 characters @samp{1}, @samp{2}, @samp{3}, @samp{4}, @samp{b}, @samp{n}, | |
294 and @samp{p}. | |
6552 | 295 |
26288 | 296 All the flags except @samp{n} and @samp{p} are used to describe |
297 multi-character comment delimiters. The digit flags indicate that a | |
298 character can @emph{also} be part of a comment sequence, in addition to | |
299 the syntactic properties associated with its character class. The flags | |
300 are independent of the class and each other for the sake of characters | |
301 such as @samp{*} in C mode, which is a punctuation character, @emph{and} | |
302 the second character of a start-of-comment sequence (@samp{/*}), | |
303 @emph{and} the first character of an end-of-comment sequence | |
304 (@samp{*/}). | |
6552 | 305 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
306 Here is a table of the possible flags for a character @var{c}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
307 and what they mean: |
6552 | 308 |
309 @itemize @bullet | |
310 @item | |
8469 | 311 @samp{1} means @var{c} is the start of a two-character comment-start |
6552 | 312 sequence. |
313 | |
314 @item | |
315 @samp{2} means @var{c} is the second character of such a sequence. | |
316 | |
317 @item | |
8469 | 318 @samp{3} means @var{c} is the start of a two-character comment-end |
6552 | 319 sequence. |
320 | |
321 @item | |
322 @samp{4} means @var{c} is the second character of such a sequence. | |
323 | |
324 @item | |
325 @c Emacs 19 feature | |
326 @samp{b} means that @var{c} as a comment delimiter belongs to the | |
327 alternative ``b'' comment style. | |
328 | |
329 Emacs supports two comment styles simultaneously in any one syntax | |
330 table. This is for the sake of C++. Each style of comment syntax has | |
331 its own comment-start sequence and its own comment-end sequence. Each | |
332 comment must stick to one style or the other; thus, if it starts with | |
333 the comment-start sequence of style ``b'', it must also end with the | |
334 comment-end sequence of style ``b''. | |
335 | |
336 The two comment-start sequences must begin with the same character; only | |
337 the second character may differ. Mark the second character of the | |
8469 | 338 ``b''-style comment-start sequence with the @samp{b} flag. |
6552 | 339 |
340 A comment-end sequence (one or two characters) applies to the ``b'' | |
341 style if its first character has the @samp{b} flag set; otherwise, it | |
342 applies to the ``a'' style. | |
343 | |
344 The appropriate comment syntax settings for C++ are as follows: | |
345 | |
346 @table @asis | |
347 @item @samp{/} | |
348 @samp{124b} | |
349 @item @samp{*} | |
350 @samp{23} | |
351 @item newline | |
352 @samp{>b} | |
353 @end table | |
354 | |
8469 | 355 This defines four comment-delimiting sequences: |
356 | |
357 @table @asis | |
358 @item @samp{/*} | |
359 This is a comment-start sequence for ``a'' style because the | |
360 second character, @samp{*}, does not have the @samp{b} flag. | |
361 | |
362 @item @samp{//} | |
363 This is a comment-start sequence for ``b'' style because the second | |
364 character, @samp{/}, does have the @samp{b} flag. | |
365 | |
366 @item @samp{*/} | |
367 This is a comment-end sequence for ``a'' style because the first | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
368 character, @samp{*}, does not have the @samp{b} flag. |
8469 | 369 |
370 @item newline | |
371 This is a comment-end sequence for ``b'' style, because the newline | |
372 character has the @samp{b} flag. | |
373 @end table | |
6552 | 374 |
375 @item | |
26288 | 376 @samp{n} on a comment delimiter character specifies |
377 that this kind of comment can be nested. For a two-character | |
378 comment delimiter, @samp{n} on either character makes it | |
379 nestable. | |
380 | |
381 @item | |
6552 | 382 @c Emacs 19 feature |
383 @samp{p} identifies an additional ``prefix character'' for Lisp syntax. | |
384 These characters are treated as whitespace when they appear between | |
385 expressions. When they appear within an expression, they are handled | |
386 according to their usual syntax codes. | |
387 | |
388 The function @code{backward-prefix-chars} moves back over these | |
389 characters, as well as over characters whose primary syntax class is | |
390 prefix (@samp{'}). @xref{Motion and Syntax}. | |
391 @end itemize | |
392 | |
393 @node Syntax Table Functions | |
394 @section Syntax Table Functions | |
395 | |
396 In this section we describe functions for creating, accessing and | |
397 altering syntax tables. | |
398 | |
399 @defun make-syntax-table | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
400 This function creates a new syntax table. It inherits the syntax for |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
401 letters and control characters from the standard syntax table. For |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
402 other characters, the syntax is copied from the standard syntax table. |
6552 | 403 |
404 Most major mode syntax tables are created in this way. | |
405 @end defun | |
406 | |
407 @defun copy-syntax-table &optional table | |
408 This function constructs a copy of @var{table} and returns it. If | |
409 @var{table} is not supplied (or is @code{nil}), it returns a copy of the | |
410 current syntax table. Otherwise, an error is signaled if @var{table} is | |
411 not a syntax table. | |
412 @end defun | |
413 | |
414 @deffn Command modify-syntax-entry char syntax-descriptor &optional table | |
415 This function sets the syntax entry for @var{char} according to | |
416 @var{syntax-descriptor}. The syntax is changed only for @var{table}, | |
417 which defaults to the current buffer's syntax table, and not in any | |
418 other syntax table. The argument @var{syntax-descriptor} specifies the | |
419 desired syntax; this is a string beginning with a class designator | |
420 character, and optionally containing a matching character and flags as | |
421 well. @xref{Syntax Descriptors}. | |
422 | |
423 This function always returns @code{nil}. The old syntax information in | |
424 the table for this character is discarded. | |
425 | |
426 An error is signaled if the first character of the syntax descriptor is not | |
427 one of the twelve syntax class designator characters. An error is also | |
428 signaled if @var{char} is not a character. | |
429 | |
430 @example | |
431 @group | |
432 @exdent @r{Examples:} | |
433 | |
434 ;; @r{Put the space character in class whitespace.} | |
435 (modify-syntax-entry ?\ " ") | |
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.} | |
8469 | 458 (modify-syntax-entry ?/ ". 14") |
6552 | 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 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
466 by its mnemonic designator character. This returns @emph{only} the |
6552 | 467 class, not any matching parenthesis or flags. |
468 | |
469 An error is signaled if @var{char} is not a character. | |
470 | |
471 The following examples apply to C mode. The first example shows that | |
472 the syntax class of space is whitespace (represented by a space). The | |
473 second example shows that the syntax of @samp{/} is punctuation. This | |
8469 | 474 does not show the fact that it is also part of comment-start and -end |
475 sequences. The third example shows that open parenthesis is in the class | |
6552 | 476 of open parentheses. This does not show the fact that it has a matching |
477 character, @samp{)}. | |
478 | |
479 @example | |
480 @group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
481 (string (char-syntax ?\ )) |
6552 | 482 @result{} " " |
483 @end group | |
484 | |
485 @group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
486 (string (char-syntax ?/)) |
6552 | 487 @result{} "." |
488 @end group | |
489 | |
490 @group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
491 (string (char-syntax ?\()) |
6552 | 492 @result{} "(" |
493 @end group | |
494 @end example | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
495 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
496 We use @code{string} to make it easier to see the character returned by |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
497 @code{char-syntax}. |
6552 | 498 @end defun |
499 | |
500 @defun set-syntax-table table | |
501 This function makes @var{table} the syntax table for the current buffer. | |
502 It returns @var{table}. | |
503 @end defun | |
504 | |
505 @defun syntax-table | |
506 This function returns the current syntax table, which is the table for | |
507 the current buffer. | |
508 @end defun | |
509 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
510 @defmac with-syntax-table @var{table} @var{body}... |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
511 @tindex with-syntax-table |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
512 This macro executes @var{body} using @var{table} as the current syntax |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
513 table. It returns the value of the last form in @var{body}, after |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
514 restoring the old current syntax table. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
515 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
516 Since each buffer has its own current syntax table, we should make that |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
517 more precise: @code{with-syntax-table} temporarily alters the current |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
518 syntax table of whichever buffer is current at the time the macro |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
519 execution starts. Other buffers are not affected. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
520 @end defmac |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
521 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
522 @node Syntax Properties |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
523 @section Syntax Properties |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
524 @kindex syntax-table @r{(text property)} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
525 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
526 When the syntax table is not flexible enough to specify the syntax of a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
527 language, you can use @code{syntax-table} text properties to override |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
528 the syntax table for specific character occurrences in the buffer. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
529 @xref{Text Properties}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
530 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
531 The valid values of @code{syntax-table} text property are: |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
532 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
533 @table @asis |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
534 @item @var{syntax-table} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
535 If the property value is a syntax table, that table is used instead of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
536 the current buffer's syntax table to determine the syntax for this |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
537 occurrence of the character. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
538 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
539 @item @code{(@var{syntax-code} . @var{matching-char})} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
540 A cons cell of this format specifies the syntax for this |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
541 occurrence of the character. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
542 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
543 @item @code{nil} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
544 If the property is @code{nil}, the character's syntax is determined from |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
545 the current syntax table in the usual way. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
546 @end table |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
547 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
548 @defvar parse-sexp-lookup-properties |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
549 @tindex parse-sexp-lookup-properties |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
550 If this is non-@code{nil}, the syntax scanning functions pay attention |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
551 to syntax text properties. Otherwise they use only the current syntax |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
552 table. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
553 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
554 |
6552 | 555 @node Motion and Syntax |
556 @section Motion and Syntax | |
557 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
558 This section describes functions for moving across characters that |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
559 have certain syntax classes. |
6552 | 560 |
561 @defun skip-syntax-forward syntaxes &optional limit | |
562 This function moves point forward across characters having syntax classes | |
563 mentioned in @var{syntaxes}. It stops when it encounters the end of | |
8469 | 564 the buffer, or position @var{limit} (if specified), or a character it is |
6552 | 565 not supposed to skip. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
566 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
567 If @var{syntaxes} starts with @samp{^}, then the function skips |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
568 characters whose syntax is @emph{not} in @var{syntaxes}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
569 |
6552 | 570 The return value is the distance traveled, which is a nonnegative |
571 integer. | |
572 @end defun | |
573 | |
574 @defun skip-syntax-backward syntaxes &optional limit | |
575 This function moves point backward across characters whose syntax | |
576 classes are mentioned in @var{syntaxes}. It stops when it encounters | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
577 the beginning of the buffer, or position @var{limit} (if specified), or |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
578 a character it is not supposed to skip. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
579 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
580 If @var{syntaxes} starts with @samp{^}, then the function skips |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
581 characters whose syntax is @emph{not} in @var{syntaxes}. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
582 |
6552 | 583 The return value indicates the distance traveled. It is an integer that |
584 is zero or less. | |
585 @end defun | |
586 | |
587 @defun backward-prefix-chars | |
588 This function moves point backward over any number of characters with | |
589 expression prefix syntax. This includes both characters in the | |
590 expression prefix syntax class, and characters with the @samp{p} flag. | |
591 @end defun | |
592 | |
593 @node Parsing Expressions | |
594 @section Parsing Balanced Expressions | |
595 | |
596 Here are several functions for parsing and scanning balanced | |
597 expressions, also known as @dfn{sexps}, in which parentheses match in | |
598 pairs. The syntax table controls the interpretation of characters, so | |
599 these functions can be used for Lisp expressions when in Lisp mode and | |
600 for C expressions when in C mode. @xref{List Motion}, for convenient | |
601 higher-level functions for moving over balanced expressions. | |
602 | |
603 @defun parse-partial-sexp start limit &optional target-depth stop-before state stop-comment | |
604 This function parses a sexp in the current buffer starting at | |
8469 | 605 @var{start}, not scanning past @var{limit}. It stops at position |
606 @var{limit} or when certain criteria described below are met, and sets | |
607 point to the location where parsing stops. It returns a value | |
608 describing the status of the parse at the point where it stops. | |
6552 | 609 |
610 If @var{state} is @code{nil}, @var{start} is assumed to be at the top | |
611 level of parenthesis structure, such as the beginning of a function | |
612 definition. Alternatively, you might wish to resume parsing in the | |
613 middle of the structure. To do this, you must provide a @var{state} | |
614 argument that describes the initial status of parsing. | |
615 | |
616 @cindex parenthesis depth | |
617 If the third argument @var{target-depth} is non-@code{nil}, parsing | |
618 stops if the depth in parentheses becomes equal to @var{target-depth}. | |
619 The depth starts at 0, or at whatever is given in @var{state}. | |
620 | |
621 If the fourth argument @var{stop-before} is non-@code{nil}, parsing | |
622 stops when it comes to any character that starts a sexp. If | |
623 @var{stop-comment} is non-@code{nil}, parsing stops when it comes to the | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
624 start of a comment. If @var{stop-comment} is the symbol |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
625 @code{syntax-table}, parsing stops after the start of a comment or a |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
626 string, or the end of a comment or a string, whichever comes first. |
6552 | 627 |
628 @cindex parse state | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
629 The fifth argument @var{state} is a nine-element list of the same form |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
630 as the value of this function, described below. (It is OK to omit the |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
631 last element of the nine.) The return value of one call may be used to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
632 initialize the state of the parse on another call to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
633 @code{parse-partial-sexp}. |
6552 | 634 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
635 The result is a list of nine elements describing the final state of |
6552 | 636 the parse: |
637 | |
638 @enumerate 0 | |
639 @item | |
640 The depth in parentheses, counting from 0. | |
641 | |
642 @item | |
643 @cindex innermost containing parentheses | |
8469 | 644 The character position of the start of the innermost parenthetical |
645 grouping containing the stopping point; @code{nil} if none. | |
6552 | 646 |
647 @item | |
648 @cindex previous complete subexpression | |
649 The character position of the start of the last complete subexpression | |
650 terminated; @code{nil} if none. | |
651 | |
652 @item | |
653 @cindex inside string | |
654 Non-@code{nil} if inside a string. More precisely, this is the | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
655 character that will terminate the string, or @code{t} if a generic |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
656 string delimiter character should terminate it. |
6552 | 657 |
658 @item | |
659 @cindex inside comment | |
26288 | 660 @code{t} if inside a comment (of either style), |
661 or the comment nesting level if inside a kind of comment | |
662 that can be nested. | |
6552 | 663 |
664 @item | |
665 @cindex quote character | |
666 @code{t} if point is just after a quote character. | |
667 | |
668 @item | |
669 The minimum parenthesis depth encountered during this scan. | |
670 | |
671 @item | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
672 What kind of comment is active: @code{nil} for a comment of style ``a'', |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
673 @code{t} for a comment of style ``b'', and @code{syntax-table} for |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
674 a comment that should be ended by a generic comment delimiter character. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
675 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
676 @item |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
677 The string or comment start position. While inside a comment, this is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
678 the position where the comment began; while inside a string, this is the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
679 position where the string began. When outside of strings and comments, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
680 this element is @code{nil}. |
6552 | 681 @end enumerate |
682 | |
683 Elements 0, 3, 4, 5 and 7 are significant in the argument @var{state}. | |
684 | |
685 @cindex indenting with parentheses | |
686 This function is most often used to compute indentation for languages | |
687 that have nested parentheses. | |
688 @end defun | |
689 | |
690 @defun scan-lists from count depth | |
691 This function scans forward @var{count} balanced parenthetical groupings | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
692 from position @var{from}. It returns the position where the scan stops. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
693 If @var{count} is negative, the scan moves backwards. |
6552 | 694 |
695 If @var{depth} is nonzero, parenthesis depth counting begins from that | |
696 value. The only candidates for stopping are places where the depth in | |
697 parentheses becomes zero; @code{scan-lists} counts @var{count} such | |
698 places and then stops. Thus, a positive value for @var{depth} means go | |
8469 | 699 out @var{depth} levels of parenthesis. |
6552 | 700 |
701 Scanning ignores comments if @code{parse-sexp-ignore-comments} is | |
702 non-@code{nil}. | |
703 | |
8469 | 704 If the scan reaches the beginning or end of the buffer (or its |
705 accessible portion), and the depth is not zero, an error is signaled. | |
706 If the depth is zero but the count is not used up, @code{nil} is | |
707 returned. | |
6552 | 708 @end defun |
709 | |
710 @defun scan-sexps from count | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
711 This function scans forward @var{count} sexps from position @var{from}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
712 It returns the position where the scan stops. If @var{count} is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
713 negative, the scan moves backwards. |
6552 | 714 |
715 Scanning ignores comments if @code{parse-sexp-ignore-comments} is | |
716 non-@code{nil}. | |
717 | |
8469 | 718 If the scan reaches the beginning or end of (the accessible part of) the |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
719 buffer while in the middle of a parenthetical grouping, an error is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
720 signaled. If it reaches the beginning or end between groupings but |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
721 before count is used up, @code{nil} is returned. |
6552 | 722 @end defun |
723 | |
724 @defvar parse-sexp-ignore-comments | |
725 @cindex skipping comments | |
726 If the value is non-@code{nil}, then comments are treated as | |
727 whitespace by the functions in this section and by @code{forward-sexp}. | |
728 | |
729 In older Emacs versions, this feature worked only when the comment | |
730 terminator is something like @samp{*/}, and appears only to end a | |
731 comment. In languages where newlines terminate comments, it was | |
732 necessary make this variable @code{nil}, since not every newline is the | |
733 end of a comment. This limitation no longer exists. | |
734 @end defvar | |
735 | |
736 You can use @code{forward-comment} to move forward or backward over | |
737 one comment or several comments. | |
738 | |
739 @defun forward-comment count | |
740 This function moves point forward across @var{count} comments (backward, | |
741 if @var{count} is negative). If it finds anything other than a comment | |
742 or whitespace, it stops, leaving point at the place where it stopped. | |
743 It also stops after satisfying @var{count}. | |
744 @end defun | |
745 | |
746 To move forward over all comments and whitespace following point, use | |
747 @code{(forward-comment (buffer-size))}. @code{(buffer-size)} is a good | |
8469 | 748 argument to use, because the number of comments in the buffer cannot |
6552 | 749 exceed that many. |
750 | |
751 @node Standard Syntax Tables | |
752 @section Some Standard Syntax Tables | |
753 | |
12098 | 754 Most of the major modes in Emacs have their own syntax tables. Here |
755 are several of them: | |
6552 | 756 |
757 @defun standard-syntax-table | |
758 This function returns the standard syntax table, which is the syntax | |
759 table used in Fundamental mode. | |
760 @end defun | |
761 | |
762 @defvar text-mode-syntax-table | |
763 The value of this variable is the syntax table used in Text mode. | |
764 @end defvar | |
765 | |
766 @defvar c-mode-syntax-table | |
767 The value of this variable is the syntax table for C-mode buffers. | |
768 @end defvar | |
769 | |
770 @defvar emacs-lisp-mode-syntax-table | |
771 The value of this variable is the syntax table used in Emacs Lisp mode | |
772 by editing commands. (It has no effect on the Lisp @code{read} | |
773 function.) | |
774 @end defvar | |
775 | |
776 @node Syntax Table Internals | |
777 @section Syntax Table Internals | |
778 @cindex syntax table internals | |
779 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
780 Lisp programs don't usually work with the elements directly; the |
6552 | 781 Lisp-level syntax table functions usually work with syntax descriptors |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
782 (@pxref{Syntax Descriptors}). Nonetheless, here we document the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
783 internal format. |
6552 | 784 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
785 Each element of a syntax table is a cons cell of the form |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
786 @code{(@var{syntax-code} . @var{matching-char})}. The @sc{car}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
787 @var{syntax-code}, is an integer that encodes the syntax class, and any |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
788 flags. The @sc{cdr}, @var{matching-char}, is non-@code{nil} if |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
789 a character to match was specified. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
790 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
791 This table gives the value of @var{syntax-code} which corresponds |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
792 to each syntactic type. |
6552 | 793 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
794 @multitable @columnfractions .05 .3 .3 .3 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
795 @item |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
796 @tab |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
797 @i{Integer} @i{Class} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
798 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
799 @i{Integer} @i{Class} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
800 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
801 @i{Integer} @i{Class} |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
802 @item |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
803 @tab |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
804 0 @ @ whitespace |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
805 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
806 5 @ @ close parenthesis |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
807 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
808 10 @ @ character quote |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
809 @item |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
810 @tab |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
811 1 @ @ punctuation |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
812 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
813 6 @ @ expression prefix |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
814 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
815 11 @ @ comment-start |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
816 @item |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
817 @tab |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
818 2 @ @ word |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
819 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
820 7 @ @ string quote |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
821 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
822 12 @ @ comment-end |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
823 @item |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
824 @tab |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
825 3 @ @ symbol |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
826 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
827 8 @ @ paired delimiter |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
828 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
829 13 @ @ inherit |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
830 @item |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
831 @tab |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
832 4 @ @ open parenthesis |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
833 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
834 9 @ @ escape |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
835 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
836 14 @ @ comment-fence |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
837 @item |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
838 @tab |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
839 15 @ string-fence |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
840 @end multitable |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
841 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
842 For example, the usual syntax value for @samp{(} is @code{(4 . 41)}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
843 (41 is the character code for @samp{)}.) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
844 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
845 The flags are encoded in higher order bits, starting 16 bits from the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
846 least significant bit. This table gives the power of two which |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
847 corresponds to each syntax flag. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
848 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
849 @multitable @columnfractions .05 .3 .3 .3 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
850 @item |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
851 @tab |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
852 @i{Prefix} @i{Flag} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
853 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
854 @i{Prefix} @i{Flag} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
855 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
856 @i{Prefix} @i{Flag} |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
857 @item |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
858 @tab |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
859 @samp{1} @ @ @code{(lsh 1 16)} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
860 @tab |
26288 | 861 @samp{4} @ @ @code{(lsh 1 19)} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
862 @tab |
26288 | 863 @samp{b} @ @ @code{(lsh 1 21)} |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
864 @item |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
865 @tab |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
866 @samp{2} @ @ @code{(lsh 1 17)} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
867 @tab |
26288 | 868 @samp{p} @ @ @code{(lsh 1 20)} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
869 @tab |
26288 | 870 @samp{n} @ @ @code{(lsh 1 22)} |
871 @item | |
872 @tab | |
873 @samp{3} @ @ @code{(lsh 1 18)} | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
874 @end multitable |
6552 | 875 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
876 @node Categories |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
877 @section Categories |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
878 @cindex categories of characters |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
879 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
880 @dfn{Categories} provide an alternate way of classifying characters |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
881 syntactically. You can define several categories as needed, then |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
882 independently assign each character to one or more categories. Unlike |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
883 syntax classes, categories are not mutually exclusive; it is normal for |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
884 one character to belong to several categories. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
885 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
886 Each buffer has a @dfn{category table} which records which categories |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
887 are defined and also which characters belong to each category. Each |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
888 category table defines its own categories, but normally these are |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
889 initialized by copying from the standard categories table, so that the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
890 standard categories are available in all modes. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
891 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
892 Each category has a name, which is an @sc{ascii} printing character in |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
893 the range @w{@samp{ }} to @samp{~}. You specify the name of a category |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
894 when you define it with @code{define-category}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
895 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
896 The category table is actually a char-table (@pxref{Char-Tables}). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
897 The element of the category table at index @var{c} is a @dfn{category |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
898 set}---a bool-vector---that indicates which categories character @var{c} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
899 belongs to. In this category set, if the element at index @var{cat} is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
900 @code{t}, that means category @var{cat} is a member of the set, and that |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
901 character @var{c} belongs to category @var{cat}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
902 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
903 @defun define-category char docstring &optional table |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
904 This function defines a new category, with name @var{char} and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
905 documentation @var{docstring}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
906 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
907 The new category is defined for category table @var{table}, which |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
908 defaults to the current buffer's category table. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
909 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
910 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
911 @defun category-docstring category &optional table |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
912 This function returns the documentation string of category @var{category} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
913 in category table @var{table}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
914 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
915 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
916 (category-docstring ?a) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
917 @result{} "ASCII" |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
918 (category-docstring ?l) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
919 @result{} "Latin" |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
920 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
921 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
922 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
923 @defun get-unused-category table |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
924 This function returns a category name (a character) which is not |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
925 currently defined in @var{table}. If all possible categories are in use |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
926 in @var{table}, it returns @code{nil}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
927 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
928 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
929 @defun category-table |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
930 This function returns the current buffer's category table. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
931 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
932 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
933 @defun category-table-p object |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
934 This function returns @code{t} if @var{object} is a category table, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
935 otherwise @code{nil}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
936 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
937 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
938 @defun standard-category-table |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
939 This function returns the standard category table. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
940 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
941 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
942 @defun copy-category-table &optional table |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
943 This function constructs a copy of @var{table} and returns it. If |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
944 @var{table} is not supplied (or is @code{nil}), it returns a copy of the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
945 current category table. Otherwise, an error is signaled if @var{table} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
946 is not a category table. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
947 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
948 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
949 @defun set-category-table table |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
950 This function makes @var{table} the category table for the current |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
951 buffer. It returns @var{table}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
952 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
953 |
26722 | 954 @defun make-category-table |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
955 @tindex make-category-table |
26722 | 956 This creates and returns an empty category table. In an empty category |
957 table, no categories have been allocated, and no characters belong to | |
958 any categories. | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
959 @end defun |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
960 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
961 @defun make-category-set categories |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
962 This function returns a new category set---a bool-vector---whose initial |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
963 contents are the categories listed in the string @var{categories}. The |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
964 elements of @var{categories} should be category names; the new category |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
965 set has @code{t} for each of those categories, and @code{nil} for all |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
966 other categories. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
967 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
968 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
969 (make-category-set "al") |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
970 @result{} #&128"\0\0\0\0\0\0\0\0\0\0\0\0\2\20\0\0" |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
971 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
972 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
973 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
974 @defun char-category-set char |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
975 This function returns the category set for character @var{char}. This |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
976 is the bool-vector which records which categories the character |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
977 @var{char} belongs to. The function @code{char-category-set} does not |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
978 allocate storage, because it returns the same bool-vector that exists in |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
979 the category table. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
980 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
981 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
982 (char-category-set ?a) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
983 @result{} #&128"\0\0\0\0\0\0\0\0\0\0\0\0\2\20\0\0" |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
984 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
985 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
986 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
987 @defun category-set-mnemonics category-set |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
988 This function converts the category set @var{category-set} into a string |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
989 containing the characters that designate the categories that are members |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
990 of the set. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
991 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
992 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
993 (category-set-mnemonics (char-category-set ?a)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
994 @result{} "al" |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
995 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
996 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
997 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
998 @defun modify-category-entry character category &optional table reset |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
999 This function modifies the category set of @var{character} in category |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
1000 table @var{table} (which defaults to the current buffer's category |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
1001 table). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
1002 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
1003 Normally, it modifies the category set by adding @var{category} to it. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
1004 But if @var{reset} is non-@code{nil}, then it deletes @var{category} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
1005 instead. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
1006 @end defun |