Mercurial > emacs
annotate lispref/syntax.texi @ 22249:9a8adf8f1efa
(make-autoload): Doc fix.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Tue, 26 May 1998 05:17:02 +0000 |
parents | d4ac295a98b3 |
children | 40089afa2b1d |
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 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
74 characters affects all syntax tables which 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 |
8469 | 95 designator character is one that is frequently in that class; however, |
96 its meaning as a designator is unvarying and independent of what syntax | |
97 that character currently has. | |
6552 | 98 |
99 @cindex syntax descriptor | |
8469 | 100 A syntax descriptor is a Lisp string that specifies a syntax class, a |
6552 | 101 matching character (used only for the parenthesis classes) and flags. |
102 The first character is the designator for a syntax class. The second | |
103 character is the character to match; if it is unused, put a space there. | |
104 Then come the characters for any desired flags. If no matching | |
105 character or flags are needed, one character is sufficient. | |
106 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
107 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
|
108 mode is @samp{@w{. 23}} (i.e., punctuation, matching character slot |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
109 unused, second character of a comment-starter, first character of an |
6552 | 110 comment-ender), and the entry for @samp{/} is @samp{@w{. 14}} (i.e., |
111 punctuation, matching character slot unused, first character of a | |
112 comment-starter, second character of a comment-ender). | |
113 | |
114 @menu | |
115 * Syntax Class Table:: Table of syntax classes. | |
116 * Syntax Flags:: Additional flags each character can have. | |
117 @end menu | |
118 | |
119 @node Syntax Class Table | |
120 @subsection Table of Syntax Classes | |
121 | |
8469 | 122 Here is a table of syntax classes, the characters that stand for them, |
6552 | 123 their meanings, and examples of their use. |
124 | |
125 @deffn {Syntax class} @w{whitespace character} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
126 @dfn{Whitespace characters} (designated by @w{@samp{@ }} or @samp{-}) |
6552 | 127 separate symbols and words from each other. Typically, whitespace |
128 characters have no other syntactic significance, and multiple whitespace | |
129 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
|
130 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
|
131 modes. |
6552 | 132 @end deffn |
133 | |
134 @deffn {Syntax class} @w{word constituent} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
135 @dfn{Word constituents} (designated by @samp{w}) are parts of normal |
6552 | 136 English words and are typically used in variable and command names in |
8469 | 137 programs. All upper- and lower-case letters, and the digits, are typically |
6552 | 138 word constituents. |
139 @end deffn | |
140 | |
141 @deffn {Syntax class} @w{symbol constituent} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
142 @dfn{Symbol constituents} (designated by @samp{_}) are the extra |
6552 | 143 characters that are used in variable and command names along with word |
144 constituents. For example, the symbol constituents class is used in | |
145 Lisp mode to indicate that certain characters may be part of symbol | |
146 names even though they are not part of English words. These characters | |
147 are @samp{$&*+-_<>}. In standard C, the only non-word-constituent | |
148 character that is valid in symbols is underscore (@samp{_}). | |
149 @end deffn | |
150 | |
151 @deffn {Syntax class} @w{punctuation character} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
152 @dfn{Punctuation characters} (designated by @samp{.}) are those |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
153 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
|
154 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
|
155 Most programming language modes, including Emacs Lisp mode, have no |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
156 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
|
157 word constituents all have other uses. |
6552 | 158 @end deffn |
159 | |
160 @deffn {Syntax class} @w{open parenthesis character} | |
161 @deffnx {Syntax class} @w{close parenthesis character} | |
162 @cindex parenthesis syntax | |
163 Open and close @dfn{parenthesis characters} are characters used in | |
164 dissimilar pairs to surround sentences or expressions. Such a grouping | |
165 is begun with an open parenthesis character and terminated with a close. | |
166 Each open parenthesis character matches a particular close parenthesis | |
167 character, and vice versa. Normally, Emacs indicates momentarily the | |
168 matching open parenthesis when you insert a close parenthesis. | |
169 @xref{Blinking}. | |
170 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
171 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
|
172 close parentheses by @samp{)}. |
6552 | 173 |
174 In English text, and in C code, the parenthesis pairs are @samp{()}, | |
175 @samp{[]}, and @samp{@{@}}. In Emacs Lisp, the delimiters for lists and | |
176 vectors (@samp{()} and @samp{[]}) are classified as parenthesis | |
177 characters. | |
178 @end deffn | |
179 | |
180 @deffn {Syntax class} @w{string quote} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
181 @dfn{String quote characters} (designated by @samp{"}) are used in |
6552 | 182 many languages, including Lisp and C, to delimit string constants. The |
183 same string quote character appears at the beginning and the end of a | |
184 string. Such quoted strings do not nest. | |
185 | |
186 The parsing facilities of Emacs consider a string as a single token. | |
187 The usual syntactic meanings of the characters in the string are | |
188 suppressed. | |
189 | |
190 The Lisp modes have two string quote characters: double-quote (@samp{"}) | |
191 and vertical bar (@samp{|}). @samp{|} is not used in Emacs Lisp, but it | |
192 is used in Common Lisp. C also has two string quote characters: | |
193 double-quote for strings, and single-quote (@samp{'}) for character | |
194 constants. | |
195 | |
196 English text has no string quote characters because English is not a | |
197 programming language. Although quotation marks are used in English, | |
198 we do not want them to turn off the usual syntactic properties of | |
199 other characters in the quotation. | |
200 @end deffn | |
201 | |
202 @deffn {Syntax class} @w{escape} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
203 An @dfn{escape character} (designated by @samp{\}) starts an escape |
6552 | 204 sequence such as is used in C string and character constants. The |
205 character @samp{\} belongs to this class in both C and Lisp. (In C, it | |
206 is used thus only inside strings, but it turns out to cause no trouble | |
207 to treat it this way throughout C code.) | |
208 | |
209 Characters in this class count as part of words if | |
210 @code{words-include-escapes} is non-@code{nil}. @xref{Word Motion}. | |
211 @end deffn | |
212 | |
213 @deffn {Syntax class} @w{character quote} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
214 A @dfn{character quote character} (designated by @samp{/}) quotes the |
6552 | 215 following character so that it loses its normal syntactic meaning. This |
216 differs from an escape character in that only the character immediately | |
217 following is ever affected. | |
218 | |
219 Characters in this class count as part of words if | |
220 @code{words-include-escapes} is non-@code{nil}. @xref{Word Motion}. | |
221 | |
11136
043aedff8710
Fix usage note for character quote syntax class.
Richard M. Stallman <rms@gnu.org>
parents:
8469
diff
changeset
|
222 This class is used for backslash in @TeX{} mode. |
6552 | 223 @end deffn |
224 | |
225 @deffn {Syntax class} @w{paired delimiter} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
226 @dfn{Paired delimiter characters} (designated by @samp{$}) are like |
6552 | 227 string quote characters except that the syntactic properties of the |
228 characters between the delimiters are not suppressed. Only @TeX{} mode | |
8469 | 229 uses a paired delimiter presently---the @samp{$} that both enters and |
230 leaves math mode. | |
6552 | 231 @end deffn |
232 | |
233 @deffn {Syntax class} @w{expression prefix} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
234 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
|
235 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
|
236 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
|
237 apostrophe, @samp{'} (used for quoting), the comma, @samp{,} (used in |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
238 macros), and @samp{#} (used in the read syntax for certain data types). |
6552 | 239 @end deffn |
240 | |
241 @deffn {Syntax class} @w{comment starter} | |
242 @deffnx {Syntax class} @w{comment ender} | |
243 @cindex comment syntax | |
244 The @dfn{comment starter} and @dfn{comment ender} characters are used in | |
245 various languages to delimit comments. These classes are designated | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
246 by @samp{<} and @samp{>}, respectively. |
6552 | 247 |
248 English text has no comment characters. In Lisp, the semicolon | |
249 (@samp{;}) starts a comment and a newline or formfeed ends one. | |
250 @end deffn | |
251 | |
252 @deffn {Syntax class} @w{inherit} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
253 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
|
254 in the standard syntax table to find the syntax of this character. The |
6552 | 255 designator for this syntax code is @samp{@@}. |
256 @end deffn | |
257 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
258 @deffn {Syntax class} @w{generic comment delimiter} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
259 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
|
260 kind of comment. @emph{Any} generic comment delimiter matches |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
261 @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
|
262 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
|
263 other. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
264 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
265 This syntax class is primarily meant for use with the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
266 @code{syntax-table} text property (@pxref{Syntax Properties}). You can |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
267 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
|
268 and last characters of the range @code{syntax-table} properties |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
269 identifying them as generic comment delimiters. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
270 @end deffn |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
271 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
272 @deffn {Syntax class} @w{generic string delimiter} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
273 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
|
274 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
|
275 generic string delimiter can match any other generic string delimiter; |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
276 but they do not match ordinary string quote characters. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
277 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
278 This syntax class is primarily meant for use with the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
279 @code{syntax-table} text property (@pxref{Syntax Properties}). You can |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
280 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
|
281 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
|
282 identifying them as generic string delimiters. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
283 @end deffn |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
284 |
6552 | 285 @node Syntax Flags |
286 @subsection Syntax Flags | |
287 @cindex syntax flags | |
288 | |
289 In addition to the classes, entries for characters in a syntax table | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
290 can specify flags. There are six possible flags, represented by the |
6552 | 291 characters @samp{1}, @samp{2}, @samp{3}, @samp{4}, @samp{b} and |
292 @samp{p}. | |
293 | |
294 All the flags except @samp{p} are used to describe multi-character | |
295 comment delimiters. The digit flags indicate that a character can | |
296 @emph{also} be part of a comment sequence, in addition to the syntactic | |
297 properties associated with its character class. The flags are | |
298 independent of the class and each other for the sake of characters such | |
299 as @samp{*} in C mode, which is a punctuation character, @emph{and} the | |
300 second character of a start-of-comment sequence (@samp{/*}), @emph{and} | |
301 the first character of an end-of-comment sequence (@samp{*/}). | |
302 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
303 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
|
304 and what they mean: |
6552 | 305 |
306 @itemize @bullet | |
307 @item | |
8469 | 308 @samp{1} means @var{c} is the start of a two-character comment-start |
6552 | 309 sequence. |
310 | |
311 @item | |
312 @samp{2} means @var{c} is the second character of such a sequence. | |
313 | |
314 @item | |
8469 | 315 @samp{3} means @var{c} is the start of a two-character comment-end |
6552 | 316 sequence. |
317 | |
318 @item | |
319 @samp{4} means @var{c} is the second character of such a sequence. | |
320 | |
321 @item | |
322 @c Emacs 19 feature | |
323 @samp{b} means that @var{c} as a comment delimiter belongs to the | |
324 alternative ``b'' comment style. | |
325 | |
326 Emacs supports two comment styles simultaneously in any one syntax | |
327 table. This is for the sake of C++. Each style of comment syntax has | |
328 its own comment-start sequence and its own comment-end sequence. Each | |
329 comment must stick to one style or the other; thus, if it starts with | |
330 the comment-start sequence of style ``b'', it must also end with the | |
331 comment-end sequence of style ``b''. | |
332 | |
333 The two comment-start sequences must begin with the same character; only | |
334 the second character may differ. Mark the second character of the | |
8469 | 335 ``b''-style comment-start sequence with the @samp{b} flag. |
6552 | 336 |
337 A comment-end sequence (one or two characters) applies to the ``b'' | |
338 style if its first character has the @samp{b} flag set; otherwise, it | |
339 applies to the ``a'' style. | |
340 | |
341 The appropriate comment syntax settings for C++ are as follows: | |
342 | |
343 @table @asis | |
344 @item @samp{/} | |
345 @samp{124b} | |
346 @item @samp{*} | |
347 @samp{23} | |
348 @item newline | |
349 @samp{>b} | |
350 @end table | |
351 | |
8469 | 352 This defines four comment-delimiting sequences: |
353 | |
354 @table @asis | |
355 @item @samp{/*} | |
356 This is a comment-start sequence for ``a'' style because the | |
357 second character, @samp{*}, does not have the @samp{b} flag. | |
358 | |
359 @item @samp{//} | |
360 This is a comment-start sequence for ``b'' style because the second | |
361 character, @samp{/}, does have the @samp{b} flag. | |
362 | |
363 @item @samp{*/} | |
364 This is a comment-end sequence for ``a'' style because the first | |
365 character, @samp{*}, does not have the @samp{b} flag | |
366 | |
367 @item newline | |
368 This is a comment-end sequence for ``b'' style, because the newline | |
369 character has the @samp{b} flag. | |
370 @end table | |
6552 | 371 |
372 @item | |
373 @c Emacs 19 feature | |
374 @samp{p} identifies an additional ``prefix character'' for Lisp syntax. | |
375 These characters are treated as whitespace when they appear between | |
376 expressions. When they appear within an expression, they are handled | |
377 according to their usual syntax codes. | |
378 | |
379 The function @code{backward-prefix-chars} moves back over these | |
380 characters, as well as over characters whose primary syntax class is | |
381 prefix (@samp{'}). @xref{Motion and Syntax}. | |
382 @end itemize | |
383 | |
384 @node Syntax Table Functions | |
385 @section Syntax Table Functions | |
386 | |
387 In this section we describe functions for creating, accessing and | |
388 altering syntax tables. | |
389 | |
390 @defun make-syntax-table | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
391 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
|
392 letters and control characters from the standard syntax table. For |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
393 other characters, the syntax is copied from the standard syntax table. |
6552 | 394 |
395 Most major mode syntax tables are created in this way. | |
396 @end defun | |
397 | |
398 @defun copy-syntax-table &optional table | |
399 This function constructs a copy of @var{table} and returns it. If | |
400 @var{table} is not supplied (or is @code{nil}), it returns a copy of the | |
401 current syntax table. Otherwise, an error is signaled if @var{table} is | |
402 not a syntax table. | |
403 @end defun | |
404 | |
405 @deffn Command modify-syntax-entry char syntax-descriptor &optional table | |
406 This function sets the syntax entry for @var{char} according to | |
407 @var{syntax-descriptor}. The syntax is changed only for @var{table}, | |
408 which defaults to the current buffer's syntax table, and not in any | |
409 other syntax table. The argument @var{syntax-descriptor} specifies the | |
410 desired syntax; this is a string beginning with a class designator | |
411 character, and optionally containing a matching character and flags as | |
412 well. @xref{Syntax Descriptors}. | |
413 | |
414 This function always returns @code{nil}. The old syntax information in | |
415 the table for this character is discarded. | |
416 | |
417 An error is signaled if the first character of the syntax descriptor is not | |
418 one of the twelve syntax class designator characters. An error is also | |
419 signaled if @var{char} is not a character. | |
420 | |
421 @example | |
422 @group | |
423 @exdent @r{Examples:} | |
424 | |
425 ;; @r{Put the space character in class whitespace.} | |
426 (modify-syntax-entry ?\ " ") | |
427 @result{} nil | |
428 @end group | |
429 | |
430 @group | |
431 ;; @r{Make @samp{$} an open parenthesis character,} | |
432 ;; @r{with @samp{^} as its matching close.} | |
433 (modify-syntax-entry ?$ "(^") | |
434 @result{} nil | |
435 @end group | |
436 | |
437 @group | |
438 ;; @r{Make @samp{^} a close parenthesis character,} | |
439 ;; @r{with @samp{$} as its matching open.} | |
440 (modify-syntax-entry ?^ ")$") | |
441 @result{} nil | |
442 @end group | |
443 | |
444 @group | |
445 ;; @r{Make @samp{/} a punctuation character,} | |
446 ;; @r{the first character of a start-comment sequence,} | |
447 ;; @r{and the second character of an end-comment sequence.} | |
448 ;; @r{This is used in C mode.} | |
8469 | 449 (modify-syntax-entry ?/ ". 14") |
6552 | 450 @result{} nil |
451 @end group | |
452 @end example | |
453 @end deffn | |
454 | |
455 @defun char-syntax character | |
456 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
|
457 by its mnemonic designator character. This returns @emph{only} the |
6552 | 458 class, not any matching parenthesis or flags. |
459 | |
460 An error is signaled if @var{char} is not a character. | |
461 | |
462 The following examples apply to C mode. The first example shows that | |
463 the syntax class of space is whitespace (represented by a space). The | |
464 second example shows that the syntax of @samp{/} is punctuation. This | |
8469 | 465 does not show the fact that it is also part of comment-start and -end |
466 sequences. The third example shows that open parenthesis is in the class | |
6552 | 467 of open parentheses. This does not show the fact that it has a matching |
468 character, @samp{)}. | |
469 | |
470 @example | |
471 @group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
472 (string (char-syntax ?\ )) |
6552 | 473 @result{} " " |
474 @end group | |
475 | |
476 @group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
477 (string (char-syntax ?/)) |
6552 | 478 @result{} "." |
479 @end group | |
480 | |
481 @group | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
482 (string (char-syntax ?\()) |
6552 | 483 @result{} "(" |
484 @end group | |
485 @end example | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
486 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
487 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
|
488 @code{char-syntax}. |
6552 | 489 @end defun |
490 | |
491 @defun set-syntax-table table | |
492 This function makes @var{table} the syntax table for the current buffer. | |
493 It returns @var{table}. | |
494 @end defun | |
495 | |
496 @defun syntax-table | |
497 This function returns the current syntax table, which is the table for | |
498 the current buffer. | |
499 @end defun | |
500 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
501 @node Syntax Properties |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
502 @section Syntax Properties |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
503 @kindex syntax-table @r{(text property)} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
504 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
505 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
|
506 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
|
507 the syntax table for specific character occurrences in the buffer. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
508 @xref{Text Properties}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
509 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
510 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
|
511 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
512 @table @asis |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
513 @item @var{syntax-table} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
514 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
|
515 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
|
516 occurrence of the character. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
517 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
518 @item @code{(@var{syntax-code} . @var{matching-char})} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
519 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
|
520 occurrence of the character. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
521 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
522 @item @code{nil} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
523 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
|
524 the current syntax table in the usual way. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
525 @end table |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
526 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
527 @defvar parse-sexp-lookup-properties |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
528 @tindex parse-sexp-lookup-properties |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
529 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
|
530 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
|
531 table. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
532 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
533 |
6552 | 534 @node Motion and Syntax |
535 @section Motion and Syntax | |
536 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
537 This section describes functions for moving across characters that |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
538 have certain syntax classes. |
6552 | 539 |
540 @defun skip-syntax-forward syntaxes &optional limit | |
541 This function moves point forward across characters having syntax classes | |
542 mentioned in @var{syntaxes}. It stops when it encounters the end of | |
8469 | 543 the buffer, or position @var{limit} (if specified), or a character it is |
6552 | 544 not supposed to skip. |
545 @ignore @c may want to change this. | |
546 The return value is the distance traveled, which is a nonnegative | |
547 integer. | |
548 @end ignore | |
549 @end defun | |
550 | |
551 @defun skip-syntax-backward syntaxes &optional limit | |
552 This function moves point backward across characters whose syntax | |
553 classes are mentioned in @var{syntaxes}. It stops when it encounters | |
8469 | 554 the beginning of the buffer, or position @var{limit} (if specified), or a |
6552 | 555 character it is not supposed to skip. |
556 @ignore @c may want to change this. | |
557 The return value indicates the distance traveled. It is an integer that | |
558 is zero or less. | |
559 @end ignore | |
560 @end defun | |
561 | |
562 @defun backward-prefix-chars | |
563 This function moves point backward over any number of characters with | |
564 expression prefix syntax. This includes both characters in the | |
565 expression prefix syntax class, and characters with the @samp{p} flag. | |
566 @end defun | |
567 | |
568 @node Parsing Expressions | |
569 @section Parsing Balanced Expressions | |
570 | |
571 Here are several functions for parsing and scanning balanced | |
572 expressions, also known as @dfn{sexps}, in which parentheses match in | |
573 pairs. The syntax table controls the interpretation of characters, so | |
574 these functions can be used for Lisp expressions when in Lisp mode and | |
575 for C expressions when in C mode. @xref{List Motion}, for convenient | |
576 higher-level functions for moving over balanced expressions. | |
577 | |
578 @defun parse-partial-sexp start limit &optional target-depth stop-before state stop-comment | |
579 This function parses a sexp in the current buffer starting at | |
8469 | 580 @var{start}, not scanning past @var{limit}. It stops at position |
581 @var{limit} or when certain criteria described below are met, and sets | |
582 point to the location where parsing stops. It returns a value | |
583 describing the status of the parse at the point where it stops. | |
6552 | 584 |
585 If @var{state} is @code{nil}, @var{start} is assumed to be at the top | |
586 level of parenthesis structure, such as the beginning of a function | |
587 definition. Alternatively, you might wish to resume parsing in the | |
588 middle of the structure. To do this, you must provide a @var{state} | |
589 argument that describes the initial status of parsing. | |
590 | |
591 @cindex parenthesis depth | |
592 If the third argument @var{target-depth} is non-@code{nil}, parsing | |
593 stops if the depth in parentheses becomes equal to @var{target-depth}. | |
594 The depth starts at 0, or at whatever is given in @var{state}. | |
595 | |
596 If the fourth argument @var{stop-before} is non-@code{nil}, parsing | |
597 stops when it comes to any character that starts a sexp. If | |
598 @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
|
599 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
|
600 @code{syntax-table}, parsing stops after the start of a comment or a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
601 string, or the of a comment or a string, whichever comes first. |
6552 | 602 |
603 @cindex parse state | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
604 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
|
605 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
|
606 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
|
607 initialize the state of the parse on another call to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
608 @code{parse-partial-sexp}. |
6552 | 609 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
610 The result is a list of nine elements describing the final state of |
6552 | 611 the parse: |
612 | |
613 @enumerate 0 | |
614 @item | |
615 The depth in parentheses, counting from 0. | |
616 | |
617 @item | |
618 @cindex innermost containing parentheses | |
8469 | 619 The character position of the start of the innermost parenthetical |
620 grouping containing the stopping point; @code{nil} if none. | |
6552 | 621 |
622 @item | |
623 @cindex previous complete subexpression | |
624 The character position of the start of the last complete subexpression | |
625 terminated; @code{nil} if none. | |
626 | |
627 @item | |
628 @cindex inside string | |
629 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
|
630 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
|
631 string delimiter character should terminate it. |
6552 | 632 |
633 @item | |
634 @cindex inside comment | |
8469 | 635 @code{t} if inside a comment (of either style). |
6552 | 636 |
637 @item | |
638 @cindex quote character | |
639 @code{t} if point is just after a quote character. | |
640 | |
641 @item | |
642 The minimum parenthesis depth encountered during this scan. | |
643 | |
644 @item | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
645 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
|
646 @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
|
647 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
|
648 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
649 @item |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
650 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
|
651 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
|
652 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
|
653 this element is @code{nil}. |
6552 | 654 @end enumerate |
655 | |
656 Elements 0, 3, 4, 5 and 7 are significant in the argument @var{state}. | |
657 | |
658 @cindex indenting with parentheses | |
659 This function is most often used to compute indentation for languages | |
660 that have nested parentheses. | |
661 @end defun | |
662 | |
663 @defun scan-lists from count depth | |
664 This function scans forward @var{count} balanced parenthetical groupings | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
665 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
|
666 If @var{count} is negative, the scan moves backwards. |
6552 | 667 |
668 If @var{depth} is nonzero, parenthesis depth counting begins from that | |
669 value. The only candidates for stopping are places where the depth in | |
670 parentheses becomes zero; @code{scan-lists} counts @var{count} such | |
671 places and then stops. Thus, a positive value for @var{depth} means go | |
8469 | 672 out @var{depth} levels of parenthesis. |
6552 | 673 |
674 Scanning ignores comments if @code{parse-sexp-ignore-comments} is | |
675 non-@code{nil}. | |
676 | |
8469 | 677 If the scan reaches the beginning or end of the buffer (or its |
678 accessible portion), and the depth is not zero, an error is signaled. | |
679 If the depth is zero but the count is not used up, @code{nil} is | |
680 returned. | |
6552 | 681 @end defun |
682 | |
683 @defun scan-sexps from count | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
684 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
|
685 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
|
686 negative, the scan moves backwards. |
6552 | 687 |
688 Scanning ignores comments if @code{parse-sexp-ignore-comments} is | |
689 non-@code{nil}. | |
690 | |
8469 | 691 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
|
692 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
|
693 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
|
694 before count is used up, @code{nil} is returned. |
6552 | 695 @end defun |
696 | |
697 @defvar parse-sexp-ignore-comments | |
698 @cindex skipping comments | |
699 If the value is non-@code{nil}, then comments are treated as | |
700 whitespace by the functions in this section and by @code{forward-sexp}. | |
701 | |
702 In older Emacs versions, this feature worked only when the comment | |
703 terminator is something like @samp{*/}, and appears only to end a | |
704 comment. In languages where newlines terminate comments, it was | |
705 necessary make this variable @code{nil}, since not every newline is the | |
706 end of a comment. This limitation no longer exists. | |
707 @end defvar | |
708 | |
709 You can use @code{forward-comment} to move forward or backward over | |
710 one comment or several comments. | |
711 | |
712 @defun forward-comment count | |
713 This function moves point forward across @var{count} comments (backward, | |
714 if @var{count} is negative). If it finds anything other than a comment | |
715 or whitespace, it stops, leaving point at the place where it stopped. | |
716 It also stops after satisfying @var{count}. | |
717 @end defun | |
718 | |
719 To move forward over all comments and whitespace following point, use | |
720 @code{(forward-comment (buffer-size))}. @code{(buffer-size)} is a good | |
8469 | 721 argument to use, because the number of comments in the buffer cannot |
6552 | 722 exceed that many. |
723 | |
724 @node Standard Syntax Tables | |
725 @section Some Standard Syntax Tables | |
726 | |
12098 | 727 Most of the major modes in Emacs have their own syntax tables. Here |
728 are several of them: | |
6552 | 729 |
730 @defun standard-syntax-table | |
731 This function returns the standard syntax table, which is the syntax | |
732 table used in Fundamental mode. | |
733 @end defun | |
734 | |
735 @defvar text-mode-syntax-table | |
736 The value of this variable is the syntax table used in Text mode. | |
737 @end defvar | |
738 | |
739 @defvar c-mode-syntax-table | |
740 The value of this variable is the syntax table for C-mode buffers. | |
741 @end defvar | |
742 | |
743 @defvar emacs-lisp-mode-syntax-table | |
744 The value of this variable is the syntax table used in Emacs Lisp mode | |
745 by editing commands. (It has no effect on the Lisp @code{read} | |
746 function.) | |
747 @end defvar | |
748 | |
749 @node Syntax Table Internals | |
750 @section Syntax Table Internals | |
751 @cindex syntax table internals | |
752 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
753 Lisp programs don't usually work with the elements directly; the |
6552 | 754 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
|
755 (@pxref{Syntax Descriptors}). Nonetheless, here we document the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
756 internal format. |
6552 | 757 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
758 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
|
759 @code{(@var{syntax-code} . @var{matching-char})}. The @sc{car}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
760 @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
|
761 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
|
762 a character to match was specified. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
763 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
764 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
|
765 to each syntactic type. |
6552 | 766 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
767 @multitable @columnfractions .05 .3 .3 .3 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
768 @item |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
769 @tab |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
770 @i{Integer} @i{Class} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
771 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
772 @i{Integer} @i{Class} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
773 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
774 @i{Integer} @i{Class} |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
775 @item |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
776 @tab |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
777 0 @ @ whitespace |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
778 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
779 5 @ @ close parenthesis |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
780 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
781 10 @ @ character quote |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
782 @item |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
783 @tab |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
784 1 @ @ punctuation |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
785 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
786 6 @ @ expression prefix |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
787 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
788 11 @ @ comment-start |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
789 @item |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
790 @tab |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
791 2 @ @ word |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
792 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
793 7 @ @ string quote |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
794 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
795 12 @ @ comment-end |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
796 @item |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
797 @tab |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
798 3 @ @ symbol |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
799 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
800 8 @ @ paired delimiter |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
801 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
802 13 @ @ inherit |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
803 @item |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
804 @tab |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
805 4 @ @ open parenthesis |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
806 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
807 9 @ @ escape |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
808 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
809 14 @ @ comment-fence |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
810 @item |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
811 @tab |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
812 15 @ string-fence |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
813 @end multitable |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
814 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
815 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
|
816 (41 is the character code for @samp{)}.) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
817 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
818 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
|
819 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
|
820 corresponds to each syntax flag. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
821 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
822 @multitable @columnfractions .05 .3 .3 .3 |
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 @i{Prefix} @i{Flag} |
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 @i{Prefix} @i{Flag} |
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 @i{Prefix} @i{Flag} |
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 @samp{1} @ @ @code{(lsh 1 16)} |
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 @samp{3} @ @ @code{(lsh 1 18)} |
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 @samp{p} @ @ @code{(lsh 1 20)} |
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 @samp{2} @ @ @code{(lsh 1 17)} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
840 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
841 @samp{4} @ @ @code{(lsh 1 19)} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
842 @tab |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
843 @samp{b} @ @ @code{(lsh 1 21)} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
844 @end multitable |
6552 | 845 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
846 @node Categories |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
847 @section Categories |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
848 @cindex categories of characters |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
849 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
850 @dfn{Categories} provide an alternate way of classifying characters |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
851 syntactically. You can define several categories as needed, then |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
852 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
|
853 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
|
854 one character to belong to several categories. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
855 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
856 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
|
857 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
|
858 category table defines its own categories, but normally these are |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
859 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
|
860 standard categories are available in all modes. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
861 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
862 Each category has a name, which is an @sc{ASCII} printing character in |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
863 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
|
864 when you define it with @code{define-category}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
865 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
866 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
|
867 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
|
868 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
|
869 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
|
870 @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
|
871 character @var{c} belongs to category @var{cat}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
872 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
873 @defun define-category char docstring &optional table |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
874 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
|
875 documentation @var{docstring}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
876 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
877 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
|
878 defaults to the current buffer's category table. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
879 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
880 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
881 @defun category-docstring category &optional table |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
882 This function returns the documentation string of category @var{category} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
883 in category table @var{table}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
884 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
885 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
886 (category-docstring ?a) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
887 @result{} "ASCII" |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
888 (category-docstring ?l) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
889 @result{} "Latin" |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
890 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
891 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
892 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
893 @defun get-unused-category table |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
894 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
|
895 currently defined in @var{table}. If all possible categories are in use |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
896 in @var{table}, it returns @code{nil}, |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
897 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
898 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
899 @defun category-table |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
900 This function returns the current buffer's category table. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
901 @end defun |
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 category-table-p object |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
904 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
|
905 otherwise @code{nil}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
906 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
907 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
908 @defun standard-category-table |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
909 This function returns the standard category table. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
910 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
911 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
912 @defun copy-category-table &optional table |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
913 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
|
914 @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
|
915 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
|
916 is not a category table. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
917 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
918 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
919 @defun set-category-table table |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
920 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
|
921 buffer. It returns @var{table}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
922 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
923 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
924 @defun make-category-set categories |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
925 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
|
926 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
|
927 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
|
928 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
|
929 other categories. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
930 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
931 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
932 (make-category-set "al") |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
933 @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
|
934 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
935 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
936 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
937 @defun char-category-set char |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
938 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
|
939 is the bool-vector which records which categories the character |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
940 @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
|
941 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
|
942 the category table. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
943 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
944 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
945 (char-category-set ?a) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
946 @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
|
947 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
948 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
949 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
950 @defun category-set-mnemonics category-set |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
951 This function converts the category set @var{category-set} into a string |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
952 containing the names of all the categories that are members of the set. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
953 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
954 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
955 (category-set-mnemonics (char-category-set ?a)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
956 @result{} "al" |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
957 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
958 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
959 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
960 @defun modify-category-entry character category &optional table reset |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
961 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
|
962 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
|
963 table). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
964 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
965 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
|
966 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
|
967 instead. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
968 @end defun |