Mercurial > emacs
annotate lispref/macros.texi @ 83023:6ce586a7243e
Set the keyboard of the initial frame correctly.
src/dispnew.c (init_display)[MULTI_KBOARD]: Change the kboard of the
initial frame to that of the tty. (Fixes --eval bug reported by
Romain Francoise.)
git-archimport-id: lorentey@elte.hu--2004/emacs--multi-tty--0--patch-63
author | Karoly Lorentey <lorentey@elte.hu> |
---|---|
date | Sat, 24 Jan 2004 19:32:29 +0000 |
parents | fe9a11a8e417 |
children | 47d3a293c8ae |
rev | line source |
---|---|
6558 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
38163
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998 Free Software Foundation, Inc. |
6558 | 4 @c See the file elisp.texi for copying conditions. |
5 @setfilename ../info/macros | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
6 @node Macros, Customization, Functions, Top |
6558 | 7 @chapter Macros |
8 @cindex macros | |
9 | |
10 @dfn{Macros} enable you to define new control constructs and other | |
11 language features. A macro is defined much like a function, but instead | |
12 of telling how to compute a value, it tells how to compute another Lisp | |
13 expression which will in turn compute the value. We call this | |
14 expression the @dfn{expansion} of the macro. | |
15 | |
16 Macros can do this because they operate on the unevaluated expressions | |
17 for the arguments, not on the argument values as functions do. They can | |
18 therefore construct an expansion containing these argument expressions | |
19 or parts of them. | |
20 | |
21 If you are using a macro to do something an ordinary function could | |
22 do, just for the sake of speed, consider using an inline function | |
23 instead. @xref{Inline Functions}. | |
24 | |
25 @menu | |
26 * Simple Macro:: A basic example. | |
27 * Expansion:: How, when and why macros are expanded. | |
28 * Compiling Macros:: How macros are expanded by the compiler. | |
29 * Defining Macros:: How to write a macro definition. | |
30 * Backquote:: Easier construction of list structure. | |
31 * Problems with Macros:: Don't evaluate the macro arguments too many times. | |
32 Don't hide the user's variables. | |
52145
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
33 * Indenting Macros:: Specifying how to indent macro calls. |
6558 | 34 @end menu |
35 | |
36 @node Simple Macro | |
37 @section A Simple Example of a Macro | |
38 | |
39 Suppose we would like to define a Lisp construct to increment a | |
40 variable value, much like the @code{++} operator in C. We would like to | |
41 write @code{(inc x)} and have the effect of @code{(setq x (1+ x))}. | |
42 Here's a macro definition that does the job: | |
43 | |
44 @findex inc | |
45 @example | |
46 @group | |
47 (defmacro inc (var) | |
48 (list 'setq var (list '1+ var))) | |
49 @end group | |
50 @end example | |
51 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
52 When this is called with @code{(inc x)}, the argument @var{var} is the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
53 symbol @code{x}---@emph{not} the @emph{value} of @code{x}, as it would |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
54 be in a function. The body of the macro uses this to construct the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
55 expansion, which is @code{(setq x (1+ x))}. Once the macro definition |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
56 returns this expansion, Lisp proceeds to evaluate it, thus incrementing |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
57 @code{x}. |
6558 | 58 |
59 @node Expansion | |
60 @section Expansion of a Macro Call | |
61 @cindex expansion of macros | |
62 @cindex macro call | |
63 | |
64 A macro call looks just like a function call in that it is a list which | |
65 starts with the name of the macro. The rest of the elements of the list | |
66 are the arguments of the macro. | |
67 | |
68 Evaluation of the macro call begins like evaluation of a function call | |
69 except for one crucial difference: the macro arguments are the actual | |
70 expressions appearing in the macro call. They are not evaluated before | |
71 they are given to the macro definition. By contrast, the arguments of a | |
72 function are results of evaluating the elements of the function call | |
73 list. | |
74 | |
75 Having obtained the arguments, Lisp invokes the macro definition just | |
76 as a function is invoked. The argument variables of the macro are bound | |
77 to the argument values from the macro call, or to a list of them in the | |
78 case of a @code{&rest} argument. And the macro body executes and | |
79 returns its value just as a function body does. | |
80 | |
81 The second crucial difference between macros and functions is that the | |
82 value returned by the macro body is not the value of the macro call. | |
83 Instead, it is an alternate expression for computing that value, also | |
84 known as the @dfn{expansion} of the macro. The Lisp interpreter | |
85 proceeds to evaluate the expansion as soon as it comes back from the | |
86 macro. | |
87 | |
88 Since the expansion is evaluated in the normal manner, it may contain | |
89 calls to other macros. It may even be a call to the same macro, though | |
90 this is unusual. | |
91 | |
92 You can see the expansion of a given macro call by calling | |
93 @code{macroexpand}. | |
94 | |
95 @defun macroexpand form &optional environment | |
96 @cindex macro expansion | |
97 This function expands @var{form}, if it is a macro call. If the result | |
98 is another macro call, it is expanded in turn, until something which is | |
99 not a macro call results. That is the value returned by | |
100 @code{macroexpand}. If @var{form} is not a macro call to begin with, it | |
101 is returned as given. | |
102 | |
103 Note that @code{macroexpand} does not look at the subexpressions of | |
104 @var{form} (although some macro definitions may do so). Even if they | |
105 are macro calls themselves, @code{macroexpand} does not expand them. | |
106 | |
107 The function @code{macroexpand} does not expand calls to inline functions. | |
108 Normally there is no need for that, since a call to an inline function is | |
109 no harder to understand than a call to an ordinary function. | |
110 | |
111 If @var{environment} is provided, it specifies an alist of macro | |
112 definitions that shadow the currently defined macros. Byte compilation | |
113 uses this feature. | |
114 | |
115 @smallexample | |
116 @group | |
117 (defmacro inc (var) | |
118 (list 'setq var (list '1+ var))) | |
119 @result{} inc | |
120 @end group | |
121 | |
122 @group | |
123 (macroexpand '(inc r)) | |
124 @result{} (setq r (1+ r)) | |
125 @end group | |
126 | |
127 @group | |
128 (defmacro inc2 (var1 var2) | |
129 (list 'progn (list 'inc var1) (list 'inc var2))) | |
130 @result{} inc2 | |
131 @end group | |
132 | |
133 @group | |
134 (macroexpand '(inc2 r s)) | |
135 @result{} (progn (inc r) (inc s)) ; @r{@code{inc} not expanded here.} | |
136 @end group | |
137 @end smallexample | |
138 @end defun | |
139 | |
140 @node Compiling Macros | |
141 @section Macros and Byte Compilation | |
142 @cindex byte-compiling macros | |
143 | |
144 You might ask why we take the trouble to compute an expansion for a | |
145 macro and then evaluate the expansion. Why not have the macro body | |
146 produce the desired results directly? The reason has to do with | |
147 compilation. | |
148 | |
149 When a macro call appears in a Lisp program being compiled, the Lisp | |
150 compiler calls the macro definition just as the interpreter would, and | |
151 receives an expansion. But instead of evaluating this expansion, it | |
152 compiles the expansion as if it had appeared directly in the program. | |
153 As a result, the compiled code produces the value and side effects | |
154 intended for the macro, but executes at full compiled speed. This would | |
155 not work if the macro body computed the value and side effects | |
156 itself---they would be computed at compile time, which is not useful. | |
157 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
158 In order for compilation of macro calls to work, the macros must |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
159 already be defined in Lisp when the calls to them are compiled. The |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
160 compiler has a special feature to help you do this: if a file being |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
161 compiled contains a @code{defmacro} form, the macro is defined |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
162 temporarily for the rest of the compilation of that file. To make this |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
163 feature work, you must put the @code{defmacro} in the same file where it |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
164 is used, and before its first use. |
6558 | 165 |
166 Byte-compiling a file executes any @code{require} calls at top-level | |
167 in the file. This is in case the file needs the required packages for | |
168 proper compilation. One way to ensure that necessary macro definitions | |
12098 | 169 are available during compilation is to require the files that define |
170 them (@pxref{Named Features}). To avoid loading the macro definition files | |
171 when someone @emph{runs} the compiled program, write | |
172 @code{eval-when-compile} around the @code{require} calls (@pxref{Eval | |
173 During Compile}). | |
6558 | 174 |
175 @node Defining Macros | |
176 @section Defining Macros | |
177 | |
178 A Lisp macro is a list whose @sc{car} is @code{macro}. Its @sc{cdr} should | |
179 be a function; expansion of the macro works by applying the function | |
180 (with @code{apply}) to the list of unevaluated argument-expressions | |
181 from the macro call. | |
182 | |
183 It is possible to use an anonymous Lisp macro just like an anonymous | |
184 function, but this is never done, because it does not make sense to pass | |
12098 | 185 an anonymous macro to functionals such as @code{mapcar}. In practice, |
186 all Lisp macros have names, and they are usually defined with the | |
187 special form @code{defmacro}. | |
6558 | 188 |
189 @defspec defmacro name argument-list body-forms@dots{} | |
190 @code{defmacro} defines the symbol @var{name} as a macro that looks | |
191 like this: | |
192 | |
193 @example | |
194 (macro lambda @var{argument-list} . @var{body-forms}) | |
195 @end example | |
196 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
197 (Note that the @sc{cdr} of this list is a function---a lambda expression.) |
6558 | 198 This macro object is stored in the function cell of @var{name}. The |
199 value returned by evaluating the @code{defmacro} form is @var{name}, but | |
200 usually we ignore this value. | |
201 | |
202 The shape and meaning of @var{argument-list} is the same as in a | |
203 function, and the keywords @code{&rest} and @code{&optional} may be used | |
204 (@pxref{Argument List}). Macros may have a documentation string, but | |
205 any @code{interactive} declaration is ignored since macros cannot be | |
206 called interactively. | |
207 @end defspec | |
208 | |
52145
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
209 The body of the macro definition can include a @code{declare} form, |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
210 which can specify how @key{TAB} should indent macro calls, and how to |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
211 step through them for Edebug. |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
212 |
53591
fe9a11a8e417
(Defining Macros): Update description of `declare', which now is a macro.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
213 @anchor{Definition of declare} |
fe9a11a8e417
(Defining Macros): Update description of `declare', which now is a macro.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
214 @defmac declare @var{specs}@dots{} |
fe9a11a8e417
(Defining Macros): Update description of `declare', which now is a macro.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
215 A @code{declare} form is used in a macro definition to specify various |
fe9a11a8e417
(Defining Macros): Update description of `declare', which now is a macro.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
216 additional information about it. Two kinds of specification are |
fe9a11a8e417
(Defining Macros): Update description of `declare', which now is a macro.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
217 currently supported: |
52145
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
218 |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
219 @table @code |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
220 @item (edebug @var{edebug-form-spec}) |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
221 Specify how to step through macro calls for Edebug. |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
222 @xref{Instrumenting Macro Calls}, for more details. |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
223 |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
224 @item (indent @var{indent-spec}) |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
225 Specify how to indent calls to this macro. @xref{Indenting Macros}, |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
226 for more details. |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
227 @end table |
53591
fe9a11a8e417
(Defining Macros): Update description of `declare', which now is a macro.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
228 |
fe9a11a8e417
(Defining Macros): Update description of `declare', which now is a macro.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
229 A @code{declare} form only has its special effect in the body of a |
fe9a11a8e417
(Defining Macros): Update description of `declare', which now is a macro.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
230 @code{defmacro} form if it immediately follows the documentation |
fe9a11a8e417
(Defining Macros): Update description of `declare', which now is a macro.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
231 string, if present, or the argument list otherwise. (Strictly |
fe9a11a8e417
(Defining Macros): Update description of `declare', which now is a macro.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
232 speaking, @emph{several} @code{declare} forms can follow the |
fe9a11a8e417
(Defining Macros): Update description of `declare', which now is a macro.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
233 documentation string or argument list, but since a @code{declare} form |
fe9a11a8e417
(Defining Macros): Update description of `declare', which now is a macro.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
234 can have several @var{specs}, they can always be combined into a |
fe9a11a8e417
(Defining Macros): Update description of `declare', which now is a macro.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
235 single form.) When used at other places in a @code{defmacro} form, or |
fe9a11a8e417
(Defining Macros): Update description of `declare', which now is a macro.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
236 outside a @code{defmacro} form, @code{declare} just returns @code{nil} |
fe9a11a8e417
(Defining Macros): Update description of `declare', which now is a macro.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
237 without evaluating any @var{specs}. |
fe9a11a8e417
(Defining Macros): Update description of `declare', which now is a macro.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
238 @end defmac |
52145
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
239 |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
240 No macro absolutely needs a @code{declare} form, because that form |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
241 has no effect on how the macro expands, on what the macro means in the |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
242 program. It only affects secondary features: indentation and Edebug. |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
243 |
6558 | 244 @node Backquote |
245 @section Backquote | |
246 @cindex backquote (list substitution) | |
247 @cindex ` (list substitution) | |
12067 | 248 @findex ` |
6558 | 249 |
250 Macros often need to construct large list structures from a mixture of | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
251 constants and nonconstant parts. To make this easier, use the @samp{`} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
252 syntax (usually called @dfn{backquote}). |
6558 | 253 |
254 Backquote allows you to quote a list, but selectively evaluate | |
255 elements of that list. In the simplest case, it is identical to the | |
256 special form @code{quote} (@pxref{Quoting}). For example, these | |
257 two forms yield identical results: | |
258 | |
259 @example | |
260 @group | |
12067 | 261 `(a list of (+ 2 3) elements) |
6558 | 262 @result{} (a list of (+ 2 3) elements) |
263 @end group | |
264 @group | |
12067 | 265 '(a list of (+ 2 3) elements) |
6558 | 266 @result{} (a list of (+ 2 3) elements) |
267 @end group | |
268 @end example | |
269 | |
7194
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
270 @findex , @r{(with Backquote)} |
12098 | 271 The special marker @samp{,} inside of the argument to backquote |
6558 | 272 indicates a value that isn't constant. Backquote evaluates the |
12098 | 273 argument of @samp{,} and puts the value in the list structure: |
6558 | 274 |
275 @example | |
276 @group | |
277 (list 'a 'list 'of (+ 2 3) 'elements) | |
278 @result{} (a list of 5 elements) | |
279 @end group | |
280 @group | |
12067 | 281 `(a list of ,(+ 2 3) elements) |
6558 | 282 @result{} (a list of 5 elements) |
283 @end group | |
284 @end example | |
285 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
286 Substitution with @samp{,} is allowed at deeper levels of the list |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
287 structure also. For example: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
288 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
289 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
290 @group |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
291 (defmacro t-becomes-nil (variable) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
292 `(if (eq ,variable t) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
293 (setq ,variable nil))) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
294 @end group |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
295 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
296 @group |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
297 (t-becomes-nil foo) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
298 @equiv{} (if (eq foo t) (setq foo nil)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
299 @end group |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
300 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
301 |
7194
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
302 @findex ,@@ @r{(with Backquote)} |
6558 | 303 @cindex splicing (with backquote) |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
304 You can also @dfn{splice} an evaluated value into the resulting list, |
12098 | 305 using the special marker @samp{,@@}. The elements of the spliced list |
6558 | 306 become elements at the same level as the other elements of the resulting |
12098 | 307 list. The equivalent code without using @samp{`} is often unreadable. |
6558 | 308 Here are some examples: |
309 | |
310 @example | |
311 @group | |
312 (setq some-list '(2 3)) | |
313 @result{} (2 3) | |
314 @end group | |
315 @group | |
316 (cons 1 (append some-list '(4) some-list)) | |
317 @result{} (1 2 3 4 2 3) | |
318 @end group | |
319 @group | |
12067 | 320 `(1 ,@@some-list 4 ,@@some-list) |
6558 | 321 @result{} (1 2 3 4 2 3) |
322 @end group | |
323 | |
324 @group | |
325 (setq list '(hack foo bar)) | |
326 @result{} (hack foo bar) | |
327 @end group | |
328 @group | |
329 (cons 'use | |
330 (cons 'the | |
331 (cons 'words (append (cdr list) '(as elements))))) | |
332 @result{} (use the words foo bar as elements) | |
333 @end group | |
334 @group | |
12067 | 335 `(use the words ,@@(cdr list) as elements) |
6558 | 336 @result{} (use the words foo bar as elements) |
337 @end group | |
338 @end example | |
339 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
340 In old Emacs versions, before version 19.29, @samp{`} used a different |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
341 syntax which required an extra level of parentheses around the entire |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
342 backquote construct. Likewise, each @samp{,} or @samp{,@@} substitution |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
343 required an extra level of parentheses surrounding both the @samp{,} or |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
344 @samp{,@@} and the following expression. The old syntax required |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
345 whitespace between the @samp{`}, @samp{,} or @samp{,@@} and the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
346 following expression. |
6558 | 347 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
348 This syntax is still accepted, for compatibility with old Emacs |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
349 versions, but we recommend not using it in new programs. |
6558 | 350 |
351 @node Problems with Macros | |
352 @section Common Problems Using Macros | |
353 | |
354 The basic facts of macro expansion have counterintuitive consequences. | |
355 This section describes some important consequences that can lead to | |
356 trouble, and rules to follow to avoid trouble. | |
357 | |
358 @menu | |
38163
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
359 * Wrong Time:: Do the work in the expansion, not in the macro. |
6558 | 360 * Argument Evaluation:: The expansion should evaluate each macro arg once. |
361 * Surprising Local Vars:: Local variable bindings in the expansion | |
362 require special care. | |
363 * Eval During Expansion:: Don't evaluate them; put them in the expansion. | |
364 * Repeated Expansion:: Avoid depending on how many times expansion is done. | |
365 @end menu | |
366 | |
38163
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
367 @node Wrong Time |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
368 @subsection Wrong Time |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
369 |
53591
fe9a11a8e417
(Defining Macros): Update description of `declare', which now is a macro.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
370 The most common problem in writing macros is doing some of the |
38163
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
371 real work prematurely---while expanding the macro, rather than in the |
53591
fe9a11a8e417
(Defining Macros): Update description of `declare', which now is a macro.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
372 expansion itself. For instance, one real package had this macro |
38163
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
373 definition: |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
374 |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
375 @example |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
376 (defmacro my-set-buffer-multibyte (arg) |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
377 (if (fboundp 'set-buffer-multibyte) |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
378 (set-buffer-multibyte arg))) |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
379 @end example |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
380 |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
381 With this erroneous macro definition, the program worked fine when |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
382 interpreted but failed when compiled. This macro definition called |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
383 @code{set-buffer-multibyte} during compilation, which was wrong, and |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
384 then did nothing when the compiled package was run. The definition |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
385 that the programmer really wanted was this: |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
386 |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
387 @example |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
388 (defmacro my-set-buffer-multibyte (arg) |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
389 (if (fboundp 'set-buffer-multibyte) |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
390 `(set-buffer-multibyte ,arg))) |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
391 @end example |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
392 |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
393 @noindent |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
394 This macro expands, if appropriate, into a call to |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
395 @code{set-buffer-multibyte} that will be executed when the compiled |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
396 program is actually run. |
79e758f8571a
(Wrong Time): New node.
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
397 |
6558 | 398 @node Argument Evaluation |
399 @subsection Evaluating Macro Arguments Repeatedly | |
400 | |
401 When defining a macro you must pay attention to the number of times | |
402 the arguments will be evaluated when the expansion is executed. The | |
403 following macro (used to facilitate iteration) illustrates the problem. | |
404 This macro allows us to write a simple ``for'' loop such as one might | |
405 find in Pascal. | |
406 | |
407 @findex for | |
408 @smallexample | |
409 @group | |
410 (defmacro for (var from init to final do &rest body) | |
411 "Execute a simple \"for\" loop. | |
412 For example, (for i from 1 to 10 do (print i))." | |
413 (list 'let (list (list var init)) | |
414 (cons 'while (cons (list '<= var final) | |
415 (append body (list (list 'inc var))))))) | |
416 @end group | |
417 @result{} for | |
418 | |
419 @group | |
420 (for i from 1 to 3 do | |
421 (setq square (* i i)) | |
422 (princ (format "\n%d %d" i square))) | |
423 @expansion{} | |
424 @end group | |
425 @group | |
426 (let ((i 1)) | |
427 (while (<= i 3) | |
428 (setq square (* i i)) | |
429 (princ (format "%d %d" i square)) | |
430 (inc i))) | |
431 @end group | |
432 @group | |
433 | |
434 @print{}1 1 | |
435 @print{}2 4 | |
436 @print{}3 9 | |
437 @result{} nil | |
438 @end group | |
439 @end smallexample | |
440 | |
441 @noindent | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
442 The arguments @code{from}, @code{to}, and @code{do} in this macro are |
6558 | 443 ``syntactic sugar''; they are entirely ignored. The idea is that you |
444 will write noise words (such as @code{from}, @code{to}, and @code{do}) | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
445 in those positions in the macro call. |
6558 | 446 |
7194
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
447 Here's an equivalent definition simplified through use of backquote: |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
448 |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
449 @smallexample |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
450 @group |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
451 (defmacro for (var from init to final do &rest body) |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
452 "Execute a simple \"for\" loop. |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
453 For example, (for i from 1 to 10 do (print i))." |
12098 | 454 `(let ((,var ,init)) |
455 (while (<= ,var ,final) | |
456 ,@@body | |
457 (inc ,var)))) | |
7194
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
458 @end group |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
459 @end smallexample |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
460 |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
461 Both forms of this definition (with backquote and without) suffer from |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
462 the defect that @var{final} is evaluated on every iteration. If |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
463 @var{final} is a constant, this is not a problem. If it is a more |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
464 complex form, say @code{(long-complex-calculation x)}, this can slow |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
465 down the execution significantly. If @var{final} has side effects, |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
466 executing it more than once is probably incorrect. |
6558 | 467 |
468 @cindex macro argument evaluation | |
469 A well-designed macro definition takes steps to avoid this problem by | |
470 producing an expansion that evaluates the argument expressions exactly | |
471 once unless repeated evaluation is part of the intended purpose of the | |
472 macro. Here is a correct expansion for the @code{for} macro: | |
473 | |
474 @smallexample | |
475 @group | |
476 (let ((i 1) | |
477 (max 3)) | |
478 (while (<= i max) | |
479 (setq square (* i i)) | |
480 (princ (format "%d %d" i square)) | |
481 (inc i))) | |
482 @end group | |
483 @end smallexample | |
484 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
38163
diff
changeset
|
485 Here is a macro definition that creates this expansion: |
6558 | 486 |
487 @smallexample | |
488 @group | |
489 (defmacro for (var from init to final do &rest body) | |
490 "Execute a simple for loop: (for i from 1 to 10 do (print i))." | |
12098 | 491 `(let ((,var ,init) |
492 (max ,final)) | |
493 (while (<= ,var max) | |
494 ,@@body | |
495 (inc ,var)))) | |
6558 | 496 @end group |
497 @end smallexample | |
498 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
499 Unfortunately, this fix introduces another problem, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
500 described in the following section. |
6558 | 501 |
502 @node Surprising Local Vars | |
503 @subsection Local Variables in Macro Expansions | |
504 | |
27193 | 505 @ifnottex |
6558 | 506 In the previous section, the definition of @code{for} was fixed as |
507 follows to make the expansion evaluate the macro arguments the proper | |
508 number of times: | |
509 | |
510 @smallexample | |
511 @group | |
512 (defmacro for (var from init to final do &rest body) | |
513 "Execute a simple for loop: (for i from 1 to 10 do (print i))." | |
514 @end group | |
515 @group | |
12098 | 516 `(let ((,var ,init) |
517 (max ,final)) | |
518 (while (<= ,var max) | |
519 ,@@body | |
520 (inc ,var)))) | |
6558 | 521 @end group |
522 @end smallexample | |
27193 | 523 @end ifnottex |
6558 | 524 |
525 The new definition of @code{for} has a new problem: it introduces a | |
526 local variable named @code{max} which the user does not expect. This | |
527 causes trouble in examples such as the following: | |
528 | |
7734 | 529 @smallexample |
6558 | 530 @group |
531 (let ((max 0)) | |
532 (for x from 0 to 10 do | |
533 (let ((this (frob x))) | |
534 (if (< max this) | |
535 (setq max this))))) | |
536 @end group | |
7734 | 537 @end smallexample |
6558 | 538 |
539 @noindent | |
540 The references to @code{max} inside the body of the @code{for}, which | |
541 are supposed to refer to the user's binding of @code{max}, really access | |
542 the binding made by @code{for}. | |
543 | |
544 The way to correct this is to use an uninterned symbol instead of | |
545 @code{max} (@pxref{Creating Symbols}). The uninterned symbol can be | |
7194
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
546 bound and referred to just like any other symbol, but since it is |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
547 created by @code{for}, we know that it cannot already appear in the |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
548 user's program. Since it is not interned, there is no way the user can |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
549 put it into the program later. It will never appear anywhere except |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
550 where put by @code{for}. Here is a definition of @code{for} that works |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
551 this way: |
6558 | 552 |
553 @smallexample | |
554 @group | |
555 (defmacro for (var from init to final do &rest body) | |
556 "Execute a simple for loop: (for i from 1 to 10 do (print i))." | |
557 (let ((tempvar (make-symbol "max"))) | |
12098 | 558 `(let ((,var ,init) |
559 (,tempvar ,final)) | |
560 (while (<= ,var ,tempvar) | |
561 ,@@body | |
562 (inc ,var))))) | |
6558 | 563 @end group |
564 @end smallexample | |
565 | |
566 @noindent | |
567 This creates an uninterned symbol named @code{max} and puts it in the | |
568 expansion instead of the usual interned symbol @code{max} that appears | |
569 in expressions ordinarily. | |
570 | |
571 @node Eval During Expansion | |
572 @subsection Evaluating Macro Arguments in Expansion | |
573 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
574 Another problem can happen if the macro definition itself |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
575 evaluates any of the macro argument expressions, such as by calling |
6558 | 576 @code{eval} (@pxref{Eval}). If the argument is supposed to refer to the |
577 user's variables, you may have trouble if the user happens to use a | |
578 variable with the same name as one of the macro arguments. Inside the | |
579 macro body, the macro argument binding is the most local binding of this | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
580 variable, so any references inside the form being evaluated do refer to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
581 it. Here is an example: |
6558 | 582 |
583 @example | |
584 @group | |
585 (defmacro foo (a) | |
586 (list 'setq (eval a) t)) | |
587 @result{} foo | |
588 @end group | |
589 @group | |
590 (setq x 'b) | |
591 (foo x) @expansion{} (setq b t) | |
592 @result{} t ; @r{and @code{b} has been set.} | |
593 ;; @r{but} | |
594 (setq a 'c) | |
595 (foo a) @expansion{} (setq a t) | |
596 @result{} t ; @r{but this set @code{a}, not @code{c}.} | |
597 | |
598 @end group | |
599 @end example | |
600 | |
601 It makes a difference whether the user's variable is named @code{a} or | |
602 @code{x}, because @code{a} conflicts with the macro argument variable | |
603 @code{a}. | |
604 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
605 Another problem with calling @code{eval} in a macro definition is that |
6558 | 606 it probably won't do what you intend in a compiled program. The |
607 byte-compiler runs macro definitions while compiling the program, when | |
608 the program's own computations (which you might have wished to access | |
609 with @code{eval}) don't occur and its local variable bindings don't | |
610 exist. | |
611 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
612 To avoid these problems, @strong{don't evaluate an argument expression |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
613 while computing the macro expansion}. Instead, substitute the |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
614 expression into the macro expansion, so that its value will be computed |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
615 as part of executing the expansion. This is how the other examples in |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
616 this chapter work. |
6558 | 617 |
618 @node Repeated Expansion | |
619 @subsection How Many Times is the Macro Expanded? | |
620 | |
621 Occasionally problems result from the fact that a macro call is | |
622 expanded each time it is evaluated in an interpreted function, but is | |
623 expanded only once (during compilation) for a compiled function. If the | |
624 macro definition has side effects, they will work differently depending | |
625 on how many times the macro is expanded. | |
626 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
627 Therefore, you should avoid side effects in computation of the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
628 macro expansion, unless you really know what you are doing. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
629 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
630 One special kind of side effect can't be avoided: constructing Lisp |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
631 objects. Almost all macro expansions include constructed lists; that is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
632 the whole point of most macros. This is usually safe; there is just one |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
633 case where you must be careful: when the object you construct is part of a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
634 quoted constant in the macro expansion. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
635 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
636 If the macro is expanded just once, in compilation, then the object is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
637 constructed just once, during compilation. But in interpreted |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
638 execution, the macro is expanded each time the macro call runs, and this |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
639 means a new object is constructed each time. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
640 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
641 In most clean Lisp code, this difference won't matter. It can matter |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
642 only if you perform side-effects on the objects constructed by the macro |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
643 definition. Thus, to avoid trouble, @strong{avoid side effects on |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
644 objects constructed by macro definitions}. Here is an example of how |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
645 such side effects can get you into trouble: |
6558 | 646 |
647 @lisp | |
648 @group | |
649 (defmacro empty-object () | |
650 (list 'quote (cons nil nil))) | |
651 @end group | |
652 | |
653 @group | |
654 (defun initialize (condition) | |
655 (let ((object (empty-object))) | |
656 (if condition | |
657 (setcar object condition)) | |
658 object)) | |
659 @end group | |
660 @end lisp | |
661 | |
662 @noindent | |
663 If @code{initialize} is interpreted, a new list @code{(nil)} is | |
664 constructed each time @code{initialize} is called. Thus, no side effect | |
665 survives between calls. If @code{initialize} is compiled, then the | |
666 macro @code{empty-object} is expanded during compilation, producing a | |
667 single ``constant'' @code{(nil)} that is reused and altered each time | |
668 @code{initialize} is called. | |
669 | |
670 One way to avoid pathological cases like this is to think of | |
671 @code{empty-object} as a funny kind of constant, not as a memory | |
672 allocation construct. You wouldn't use @code{setcar} on a constant such | |
673 as @code{'(nil)}, so naturally you won't use it on @code{(empty-object)} | |
674 either. | |
52145
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
675 |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
676 @node Indenting Macros |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
677 @section Indenting Macros |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
678 |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
679 You can use the @code{declare} form in the macro definition to |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
680 specify how to @key{TAB} should indent indent calls to the macro. You |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
681 write it like this: |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
682 |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
683 @example |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
684 (declare (indent @var{indent-spec})) |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
685 @end example |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
686 |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
687 @noindent |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
688 Here are the possibilities for @var{indent-spec}: |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
689 |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
690 @table @asis |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
691 @item @code{nil} |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
692 This is the same as no property---use the standard indentation pattern. |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
693 @item @code{defun} |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
694 Handle this function like a @samp{def} construct: treat the second |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
695 line as the start of a @dfn{body}. |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
696 @item a number, @var{number} |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
697 The first @var{number} arguments of the function are |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
698 @dfn{distinguished} arguments; the rest are considered the body |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
699 of the expression. A line in the expression is indented according to |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
700 whether the first argument on it is distinguished or not. If the |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
701 argument is part of the body, the line is indented @code{lisp-body-indent} |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
702 more columns than the open-parenthesis starting the containing |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
703 expression. If the argument is distinguished and is either the first |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
704 or second argument, it is indented @emph{twice} that many extra columns. |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
705 If the argument is distinguished and not the first or second argument, |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
706 the line uses the standard pattern. |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
707 @item a symbol, @var{symbol} |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
708 @var{symbol} should be a function name; that function is called to |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
709 calculate the indentation of a line within this expression. The |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
710 function receives two arguments: |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
711 @table @asis |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
712 @item @var{state} |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
713 The value returned by @code{parse-partial-sexp} (a Lisp primitive for |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
714 indentation and nesting computation) when it parses up to the |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
715 beginning of this line. |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
716 @item @var{pos} |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
717 The position at which the line being indented begins. |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
718 @end table |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
719 @noindent |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
720 It should return either a number, which is the number of columns of |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
721 indentation for that line, or a list whose car is such a number. The |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
722 difference between returning a number and returning a list is that a |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
723 number says that all following lines at the same nesting level should |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
724 be indented just like this one; a list says that following lines might |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
725 call for different indentations. This makes a difference when the |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
726 indentation is being computed by @kbd{C-M-q}; if the value is a |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
727 number, @kbd{C-M-q} need not recalculate indentation for the following |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
728 lines until the end of the list. |
58a56145385a
(Defining Macros): Give definition of `declare'
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
729 @end table |
52401 | 730 |
731 @ignore | |
732 arch-tag: d4cce66d-1047-45c3-bfde-db6719d6e82b | |
733 @end ignore |