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