Mercurial > emacs
annotate lispref/abbrevs.texi @ 25619:f25a14690a18
(Fmakehash): Accept just one optional argument TEST.
author | Gerd Moellmann <gerd@gnu.org> |
---|---|
date | Thu, 09 Sep 1999 14:54:28 +0000 |
parents | 90da2489c498 |
children | 467b88fab665 |
rev | line source |
---|---|
6552 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc. | |
4 @c See the file elisp.texi for copying conditions. | |
5 @setfilename ../info/abbrevs | |
6 @node Abbrevs, Processes, Syntax Tables, Top | |
7 @chapter Abbrevs And Abbrev Expansion | |
8 @cindex abbrev | |
9 @cindex abbrev table | |
10 | |
11 An abbreviation or @dfn{abbrev} is a string of characters that may be | |
12 expanded to a longer string. The user can insert the abbrev string and | |
13 find it replaced automatically with the expansion of the abbrev. This | |
14 saves typing. | |
15 | |
16 The set of abbrevs currently in effect is recorded in an @dfn{abbrev | |
17 table}. Each buffer has a local abbrev table, but normally all buffers | |
18 in the same major mode share one abbrev table. There is also a global | |
19 abbrev table. Normally both are used. | |
20 | |
21 An abbrev table is represented as an obarray containing a symbol for | |
7688 | 22 each abbreviation. The symbol's name is the abbreviation; its value is |
6552 | 23 the expansion; its function definition is the hook function to do the |
7688 | 24 expansion (@pxref{Defining Abbrevs}); its property list cell contains |
25 the use count, the number of times the abbreviation has been expanded. | |
26 Because these symbols are not interned in the usual obarray, they will | |
27 never appear as the result of reading a Lisp expression; in fact, | |
28 normally they are never used except by the code that handles abbrevs. | |
29 Therefore, it is safe to use them in an extremely nonstandard way. | |
30 @xref{Creating Symbols}. | |
6552 | 31 |
32 For the user-level commands for abbrevs, see @ref{Abbrevs,, Abbrev | |
33 Mode, emacs, The GNU Emacs Manual}. | |
34 | |
35 @menu | |
36 * Abbrev Mode:: Setting up Emacs for abbreviation. | |
37 * Tables: Abbrev Tables. Creating and working with abbrev tables. | |
38 * Defining Abbrevs:: Specifying abbreviations and their expansions. | |
39 * Files: Abbrev Files. Saving abbrevs in files. | |
40 * Expansion: Abbrev Expansion. Controlling expansion; expansion subroutines. | |
41 * Standard Abbrev Tables:: Abbrev tables used by various major modes. | |
42 @end menu | |
43 | |
44 @node Abbrev Mode, Abbrev Tables, Abbrevs, Abbrevs | |
45 @comment node-name, next, previous, up | |
46 @section Setting Up Abbrev Mode | |
47 | |
48 Abbrev mode is a minor mode controlled by the value of the variable | |
49 @code{abbrev-mode}. | |
50 | |
51 @defvar abbrev-mode | |
52 A non-@code{nil} value of this variable turns on the automatic expansion | |
53 of abbrevs when their abbreviations are inserted into a buffer. | |
54 If the value is @code{nil}, abbrevs may be defined, but they are not | |
55 expanded automatically. | |
56 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
57 This variable automatically becomes buffer-local when set in any fashion. |
6552 | 58 @end defvar |
59 | |
60 @defvar default-abbrev-mode | |
7688 | 61 This is the value of @code{abbrev-mode} for buffers that do not override it. |
6552 | 62 This is the same as @code{(default-value 'abbrev-mode)}. |
63 @end defvar | |
64 | |
65 @node Abbrev Tables, Defining Abbrevs, Abbrev Mode, Abbrevs | |
66 @section Abbrev Tables | |
67 | |
68 This section describes how to create and manipulate abbrev tables. | |
69 | |
70 @defun make-abbrev-table | |
71 This function creates and returns a new, empty abbrev table---an obarray | |
72 containing no symbols. It is a vector filled with zeros. | |
73 @end defun | |
74 | |
75 @defun clear-abbrev-table table | |
76 This function undefines all the abbrevs in abbrev table @var{table}, | |
77 leaving it empty. The function returns @code{nil}. | |
78 @end defun | |
79 | |
80 @defun define-abbrev-table tabname definitions | |
81 This function defines @var{tabname} (a symbol) as an abbrev table name, | |
82 i.e., as a variable whose value is an abbrev table. It defines abbrevs | |
83 in the table according to @var{definitions}, a list of elements of the | |
84 form @code{(@var{abbrevname} @var{expansion} @var{hook} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7688
diff
changeset
|
85 @var{usecount})}. The return value is always @code{nil}. |
6552 | 86 @end defun |
87 | |
88 @defvar abbrev-table-name-list | |
89 This is a list of symbols whose values are abbrev tables. | |
90 @code{define-abbrev-table} adds the new abbrev table name to this list. | |
91 @end defvar | |
92 | |
93 @defun insert-abbrev-table-description name &optional human | |
94 This function inserts before point a description of the abbrev table | |
95 named @var{name}. The argument @var{name} is a symbol whose value is an | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7688
diff
changeset
|
96 abbrev table. The return value is always @code{nil}. |
6552 | 97 |
98 If @var{human} is non-@code{nil}, the description is human-oriented. | |
99 Otherwise the description is a Lisp expression---a call to | |
7688 | 100 @code{define-abbrev-table} that would define @var{name} exactly as it |
6552 | 101 is currently defined. |
102 @end defun | |
103 | |
104 @node Defining Abbrevs, Abbrev Files, Abbrev Tables, Abbrevs | |
105 @comment node-name, next, previous, up | |
106 @section Defining Abbrevs | |
107 | |
108 These functions define an abbrev in a specified abbrev table. | |
109 @code{define-abbrev} is the low-level basic function, while | |
110 @code{add-abbrev} is used by commands that ask for information from the | |
111 user. | |
112 | |
113 @defun add-abbrev table type arg | |
7688 | 114 This function adds an abbreviation to abbrev table @var{table} based on |
115 information from the user. The argument @var{type} is a string | |
116 describing in English the kind of abbrev this will be (typically, | |
117 @code{"global"} or @code{"mode-specific"}); this is used in prompting | |
118 the user. The argument @var{arg} is the number of words in the | |
119 expansion. | |
6552 | 120 |
7688 | 121 The return value is the symbol that internally represents the new |
6552 | 122 abbrev, or @code{nil} if the user declines to confirm redefining an |
123 existing abbrev. | |
124 @end defun | |
125 | |
126 @defun define-abbrev table name expansion hook | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7688
diff
changeset
|
127 This function defines an abbrev named @var{name}, in @var{table}, to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7688
diff
changeset
|
128 expand to @var{expansion} and call @var{hook}. The return value is a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7688
diff
changeset
|
129 symbol that represents the abbrev inside Emacs; its name is @var{name}. |
6552 | 130 |
131 The argument @var{name} should be a string. The argument | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7688
diff
changeset
|
132 @var{expansion} is normally the desired expansion (a string), or |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7688
diff
changeset
|
133 @code{nil} to undefine the abbrev. If it is anything but a string or |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7688
diff
changeset
|
134 @code{nil}, then the abbreviation ``expands'' solely by running |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7688
diff
changeset
|
135 @var{hook}. |
6552 | 136 |
137 The argument @var{hook} is a function or @code{nil}. If @var{hook} is | |
138 non-@code{nil}, then it is called with no arguments after the abbrev is | |
139 replaced with @var{expansion}; point is located at the end of | |
7688 | 140 @var{expansion} when @var{hook} is called. |
6552 | 141 |
142 The use count of the abbrev is initialized to zero. | |
143 @end defun | |
144 | |
145 @defopt only-global-abbrevs | |
146 If this variable is non-@code{nil}, it means that the user plans to use | |
147 global abbrevs only. This tells the commands that define mode-specific | |
148 abbrevs to define global ones instead. This variable does not alter the | |
7688 | 149 behavior of the functions in this section; it is examined by their |
6552 | 150 callers. |
151 @end defopt | |
152 | |
153 @node Abbrev Files, Abbrev Expansion, Defining Abbrevs, Abbrevs | |
154 @section Saving Abbrevs in Files | |
155 | |
156 A file of saved abbrev definitions is actually a file of Lisp code. | |
157 The abbrevs are saved in the form of a Lisp program to define the same | |
158 abbrev tables with the same contents. Therefore, you can load the file | |
159 with @code{load} (@pxref{How Programs Do Loading}). However, the | |
160 function @code{quietly-read-abbrev-file} is provided as a more | |
161 convenient interface. | |
162 | |
163 User-level facilities such as @code{save-some-buffers} can save | |
164 abbrevs in a file automatically, under the control of variables | |
165 described here. | |
166 | |
167 @defopt abbrev-file-name | |
168 This is the default file name for reading and saving abbrevs. | |
169 @end defopt | |
170 | |
171 @defun quietly-read-abbrev-file filename | |
172 This function reads abbrev definitions from a file named @var{filename}, | |
173 previously written with @code{write-abbrev-file}. If @var{filename} is | |
174 @code{nil}, the file specified in @code{abbrev-file-name} is used. | |
175 @code{save-abbrevs} is set to @code{t} so that changes will be saved. | |
176 | |
177 This function does not display any messages. It returns @code{nil}. | |
178 @end defun | |
179 | |
180 @defopt save-abbrevs | |
181 A non-@code{nil} value for @code{save-abbrev} means that Emacs should | |
182 save abbrevs when files are saved. @code{abbrev-file-name} specifies | |
183 the file to save the abbrevs in. | |
184 @end defopt | |
185 | |
186 @defvar abbrevs-changed | |
187 This variable is set non-@code{nil} by defining or altering any | |
188 abbrevs. This serves as a flag for various Emacs commands to offer to | |
189 save your abbrevs. | |
190 @end defvar | |
191 | |
192 @deffn Command write-abbrev-file filename | |
193 Save all abbrev definitions, in all abbrev tables, in the file | |
7688 | 194 @var{filename}, in the form of a Lisp program that when loaded will |
6552 | 195 define the same abbrevs. This function returns @code{nil}. |
196 @end deffn | |
197 | |
198 @node Abbrev Expansion, Standard Abbrev Tables, Abbrev Files, Abbrevs | |
199 @comment node-name, next, previous, up | |
200 @section Looking Up and Expanding Abbreviations | |
201 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7688
diff
changeset
|
202 Abbrevs are usually expanded by certain interactive commands, |
6552 | 203 including @code{self-insert-command}. This section describes the |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7688
diff
changeset
|
204 subroutines used in writing such commands, as well as the variables they |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7688
diff
changeset
|
205 use for communication. |
6552 | 206 |
207 @defun abbrev-symbol abbrev &optional table | |
208 This function returns the symbol representing the abbrev named | |
209 @var{abbrev}. The value returned is @code{nil} if that abbrev is not | |
210 defined. The optional second argument @var{table} is the abbrev table | |
211 to look it up in. If @var{table} is @code{nil}, this function tries | |
212 first the current buffer's local abbrev table, and second the global | |
213 abbrev table. | |
214 @end defun | |
215 | |
7688 | 216 @defun abbrev-expansion abbrev &optional table |
217 This function returns the string that @var{abbrev} would expand into (as | |
218 defined by the abbrev tables used for the current buffer). The optional | |
219 argument @var{table} specifies the abbrev table to use, as in | |
220 @code{abbrev-symbol}. | |
221 @end defun | |
222 | |
223 @deffn Command expand-abbrev | |
224 This command expands the abbrev before point, if any. | |
225 If point does not follow an abbrev, this command does nothing. | |
226 The command returns @code{t} if it did expansion, @code{nil} otherwise. | |
227 @end deffn | |
228 | |
229 @deffn Command abbrev-prefix-mark &optional arg | |
230 Mark current point as the beginning of an abbrev. The next call to | |
231 @code{expand-abbrev} will use the text from here to point (where it is | |
232 then) as the abbrev to expand, rather than using the previous word as | |
233 usual. | |
234 @end deffn | |
235 | |
6552 | 236 @defopt abbrev-all-caps |
237 When this is set non-@code{nil}, an abbrev entered entirely in upper | |
238 case is expanded using all upper case. Otherwise, an abbrev entered | |
239 entirely in upper case is expanded by capitalizing each word of the | |
240 expansion. | |
241 @end defopt | |
242 | |
243 @defvar abbrev-start-location | |
244 This is the buffer position for @code{expand-abbrev} to use as the start | |
245 of the next abbrev to be expanded. (@code{nil} means use the word | |
246 before point instead.) @code{abbrev-start-location} is set to | |
247 @code{nil} each time @code{expand-abbrev} is called. This variable is | |
248 also set by @code{abbrev-prefix-mark}. | |
249 @end defvar | |
250 | |
251 @defvar abbrev-start-location-buffer | |
252 The value of this variable is the buffer for which | |
253 @code{abbrev-start-location} has been set. Trying to expand an abbrev | |
254 in any other buffer clears @code{abbrev-start-location}. This variable | |
255 is set by @code{abbrev-prefix-mark}. | |
256 @end defvar | |
257 | |
258 @defvar last-abbrev | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7688
diff
changeset
|
259 This is the @code{abbrev-symbol} of the most recent abbrev expanded. This |
6552 | 260 information is left by @code{expand-abbrev} for the sake of the |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7688
diff
changeset
|
261 @code{unexpand-abbrev} command (@pxref{Expanding Abbrevs,, Expanding |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7688
diff
changeset
|
262 Abbrevs, emacs, The GNU Emacs Manual}). |
6552 | 263 @end defvar |
264 | |
265 @defvar last-abbrev-location | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7688
diff
changeset
|
266 This is the location of the most recent abbrev expanded. This contains |
6552 | 267 information left by @code{expand-abbrev} for the sake of the |
268 @code{unexpand-abbrev} command. | |
269 @end defvar | |
270 | |
271 @defvar last-abbrev-text | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7688
diff
changeset
|
272 This is the exact expansion text of the most recent abbrev expanded, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7688
diff
changeset
|
273 after case conversion (if any). Its value is @code{nil} if the abbrev |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7688
diff
changeset
|
274 has already been unexpanded. This contains information left by |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7688
diff
changeset
|
275 @code{expand-abbrev} for the sake of the @code{unexpand-abbrev} command. |
6552 | 276 @end defvar |
277 | |
278 @c Emacs 19 feature | |
279 @defvar pre-abbrev-expand-hook | |
280 This is a normal hook whose functions are executed, in sequence, just | |
281 before any expansion of an abbrev. @xref{Hooks}. Since it is a normal | |
282 hook, the hook functions receive no arguments. However, they can find | |
283 the abbrev to be expanded by looking in the buffer before point. | |
284 @end defvar | |
285 | |
286 The following sample code shows a simple use of | |
287 @code{pre-abbrev-expand-hook}. If the user terminates an abbrev with a | |
288 punctuation character, the hook function asks for confirmation. Thus, | |
289 this hook allows the user to decide whether to expand the abbrev, and | |
290 aborts expansion if it is not confirmed. | |
291 | |
292 @smallexample | |
293 (add-hook 'pre-abbrev-expand-hook 'query-if-not-space) | |
294 | |
295 ;; @r{This is the function invoked by @code{pre-abbrev-expand-hook}.} | |
296 | |
297 ;; @r{If the user terminated the abbrev with a space, the function does} | |
298 ;; @r{nothing (that is, it returns so that the abbrev can expand). If the} | |
299 ;; @r{user entered some other character, this function asks whether} | |
300 ;; @r{expansion should continue.} | |
301 | |
7688 | 302 ;; @r{If the user answers the prompt with @kbd{y}, the function returns} |
6552 | 303 ;; @r{@code{nil} (because of the @code{not} function), but that is} |
304 ;; @r{acceptable; the return value has no effect on expansion.} | |
305 | |
306 (defun query-if-not-space () | |
307 (if (/= ?\ (preceding-char)) | |
308 (if (not (y-or-n-p "Do you want to expand this abbrev? ")) | |
309 (error "Not expanding this abbrev")))) | |
310 @end smallexample | |
311 | |
312 @node Standard Abbrev Tables, , Abbrev Expansion, Abbrevs | |
313 @comment node-name, next, previous, up | |
314 @section Standard Abbrev Tables | |
315 | |
316 Here we list the variables that hold the abbrev tables for the | |
317 preloaded major modes of Emacs. | |
318 | |
319 @defvar global-abbrev-table | |
320 This is the abbrev table for mode-independent abbrevs. The abbrevs | |
321 defined in it apply to all buffers. Each buffer may also have a local | |
322 abbrev table, whose abbrev definitions take precedence over those in the | |
323 global table. | |
324 @end defvar | |
325 | |
326 @defvar local-abbrev-table | |
327 The value of this buffer-local variable is the (mode-specific) | |
328 abbreviation table of the current buffer. | |
329 @end defvar | |
330 | |
331 @defvar fundamental-mode-abbrev-table | |
7688 | 332 This is the local abbrev table used in Fundamental mode; in other words, |
333 it is the local abbrev table in all buffers in Fundamental mode. | |
6552 | 334 @end defvar |
335 | |
336 @defvar text-mode-abbrev-table | |
337 This is the local abbrev table used in Text mode. | |
338 @end defvar | |
339 | |
340 @defvar lisp-mode-abbrev-table | |
341 This is the local abbrev table used in Lisp mode and Emacs Lisp mode. | |
342 @end defvar |