Commit | Line | Data |
---|---|---|
b8d4c8d0 GM |
1 | @c -*-texinfo-*- |
2 | @c This is part of the GNU Emacs Lisp Reference Manual. | |
44e97401 | 3 | @c Copyright (C) 1990-1995, 1998-2012 Free Software Foundation, Inc. |
b8d4c8d0 | 4 | @c See the file elisp.texi for copying conditions. |
ecc6530d | 5 | @node Variables |
b8d4c8d0 GM |
6 | @chapter Variables |
7 | @cindex variable | |
8 | ||
9 | A @dfn{variable} is a name used in a program to stand for a value. | |
1021c761 | 10 | In Lisp, each variable is represented by a Lisp symbol |
735cc5ca CY |
11 | (@pxref{Symbols}). The variable name is simply the symbol's name, and |
12 | the variable's value is stored in the symbol's value cell@footnote{To | |
13 | be precise, under the default @dfn{dynamic binding} rules the value | |
14 | cell always holds the variable's current value, but this is not the | |
15 | case under @dfn{lexical binding} rules. @xref{Variable Scoping}, for | |
16 | details.}. @xref{Symbol Components}. In Emacs Lisp, the use of a | |
17 | symbol as a variable is independent of its use as a function name. | |
1021c761 CY |
18 | |
19 | As previously noted in this manual, a Lisp program is represented | |
20 | primarily by Lisp objects, and only secondarily as text. The textual | |
21 | form of a Lisp program is given by the read syntax of the Lisp objects | |
22 | that constitute the program. Hence, the textual form of a variable in | |
23 | a Lisp program is written using the read syntax for the symbol | |
32770114 | 24 | representing the variable. |
b8d4c8d0 GM |
25 | |
26 | @menu | |
d032d5e7 SM |
27 | * Global Variables:: Variable values that exist permanently, everywhere. |
28 | * Constant Variables:: Certain "variables" have values that never change. | |
29 | * Local Variables:: Variable values that exist only temporarily. | |
30 | * Void Variables:: Symbols that lack values. | |
31 | * Defining Variables:: A definition says a symbol is used as a variable. | |
32 | * Tips for Defining:: Things you should think about when you | |
b8d4c8d0 | 33 | define a variable. |
d032d5e7 | 34 | * Accessing Variables:: Examining values of variables whose names |
b8d4c8d0 | 35 | are known only at run time. |
d032d5e7 SM |
36 | * Setting Variables:: Storing new values in variables. |
37 | * Variable Scoping:: How Lisp chooses among local and global values. | |
38 | * Buffer-Local Variables:: Variable values in effect only in one buffer. | |
39 | * File Local Variables:: Handling local variable lists in files. | |
40 | * Directory Local Variables:: Local variables common to all files in a directory. | |
d032d5e7 | 41 | * Variable Aliases:: Variables that are aliases for other variables. |
b8d4c8d0 GM |
42 | * Variables with Restricted Values:: Non-constant variables whose value can |
43 | @emph{not} be an arbitrary Lisp object. | |
44 | @end menu | |
45 | ||
46 | @node Global Variables | |
47 | @section Global Variables | |
48 | @cindex global variable | |
49 | ||
50 | The simplest way to use a variable is @dfn{globally}. This means that | |
51 | the variable has just one value at a time, and this value is in effect | |
52 | (at least for the moment) throughout the Lisp system. The value remains | |
53 | in effect until you specify a new one. When a new value replaces the | |
54 | old one, no trace of the old value remains in the variable. | |
55 | ||
56 | You specify a value for a symbol with @code{setq}. For example, | |
57 | ||
58 | @example | |
59 | (setq x '(a b)) | |
60 | @end example | |
61 | ||
62 | @noindent | |
63 | gives the variable @code{x} the value @code{(a b)}. Note that | |
32770114 CY |
64 | @code{setq} is a special form (@pxref{Special Forms}); it does not |
65 | evaluate its first argument, the name of the variable, but it does | |
66 | evaluate the second argument, the new value. | |
b8d4c8d0 | 67 | |
32770114 CY |
68 | Once the variable has a value, you can refer to it by using the |
69 | symbol itself as an expression. Thus, | |
b8d4c8d0 GM |
70 | |
71 | @example | |
72 | @group | |
73 | x @result{} (a b) | |
74 | @end group | |
75 | @end example | |
76 | ||
77 | @noindent | |
78 | assuming the @code{setq} form shown above has already been executed. | |
79 | ||
80 | If you do set the same variable again, the new value replaces the old | |
81 | one: | |
82 | ||
83 | @example | |
84 | @group | |
85 | x | |
86 | @result{} (a b) | |
87 | @end group | |
88 | @group | |
89 | (setq x 4) | |
90 | @result{} 4 | |
91 | @end group | |
92 | @group | |
93 | x | |
94 | @result{} 4 | |
95 | @end group | |
96 | @end example | |
97 | ||
98 | @node Constant Variables | |
99 | @section Variables that Never Change | |
7018dbe7 | 100 | @cindex @code{setting-constant} error |
b8d4c8d0 GM |
101 | @cindex keyword symbol |
102 | @cindex variable with constant value | |
103 | @cindex constant variables | |
104 | @cindex symbol that evaluates to itself | |
105 | @cindex symbol with constant value | |
106 | ||
107 | In Emacs Lisp, certain symbols normally evaluate to themselves. These | |
108 | include @code{nil} and @code{t}, as well as any symbol whose name starts | |
109 | with @samp{:} (these are called @dfn{keywords}). These symbols cannot | |
110 | be rebound, nor can their values be changed. Any attempt to set or bind | |
111 | @code{nil} or @code{t} signals a @code{setting-constant} error. The | |
112 | same is true for a keyword (a symbol whose name starts with @samp{:}), | |
113 | if it is interned in the standard obarray, except that setting such a | |
114 | symbol to itself is not an error. | |
115 | ||
116 | @example | |
117 | @group | |
118 | nil @equiv{} 'nil | |
119 | @result{} nil | |
120 | @end group | |
121 | @group | |
122 | (setq nil 500) | |
123 | @error{} Attempt to set constant symbol: nil | |
124 | @end group | |
125 | @end example | |
126 | ||
127 | @defun keywordp object | |
128 | function returns @code{t} if @var{object} is a symbol whose name | |
129 | starts with @samp{:}, interned in the standard obarray, and returns | |
130 | @code{nil} otherwise. | |
131 | @end defun | |
132 | ||
2640fa86 CY |
133 | These constants are fundamentally different from the ``constants'' |
134 | defined using the @code{defconst} special form (@pxref{Defining | |
135 | Variables}). A @code{defconst} form serves to inform human readers | |
136 | that you do not intend to change the value of a variable, but Emacs | |
137 | does not raise an error if you actually change it. | |
138 | ||
b8d4c8d0 GM |
139 | @node Local Variables |
140 | @section Local Variables | |
141 | @cindex binding local variables | |
142 | @cindex local variables | |
143 | @cindex local binding | |
144 | @cindex global binding | |
145 | ||
146 | Global variables have values that last until explicitly superseded | |
1021c761 CY |
147 | with new values. Sometimes it is useful to give a variable a |
148 | @dfn{local value}---a value that takes effect only within a certain | |
149 | part of a Lisp program. When a variable has a local value, we say | |
735cc5ca CY |
150 | that it is @dfn{locally bound} to that value, and that it is a |
151 | @dfn{local variable}. | |
1021c761 CY |
152 | |
153 | For example, when a function is called, its argument variables | |
154 | receive local values, which are the actual arguments supplied to the | |
155 | function call; these local bindings take effect within the body of the | |
156 | function. To take another example, the @code{let} special form | |
157 | explicitly establishes local bindings for specific variables, which | |
158 | take effect within the body of the @code{let} form. | |
b8d4c8d0 GM |
159 | |
160 | We also speak of the @dfn{global binding}, which is where | |
161 | (conceptually) the global value is kept. | |
162 | ||
1021c761 CY |
163 | @cindex shadowing of variables |
164 | Establishing a local binding saves away the variable's previous | |
165 | value (or lack of one). We say that the previous value is | |
166 | @dfn{shadowed}. Both global and local values may be shadowed. If a | |
167 | local binding is in effect, using @code{setq} on the local variable | |
168 | stores the specified value in the local binding. When that local | |
169 | binding is no longer in effect, the previously shadowed value (or lack | |
170 | of one) comes back. | |
171 | ||
b8d4c8d0 | 172 | @cindex current binding |
1021c761 CY |
173 | A variable can have more than one local binding at a time (e.g.@: if |
174 | there are nested @code{let} forms that bind the variable). The | |
175 | @dfn{current binding} is the local binding that is actually in effect. | |
176 | It determines the value returned by evaluating the variable symbol, | |
177 | and it is the binding acted on by @code{setq}. | |
178 | ||
179 | For most purposes, you can think of the current binding as the | |
180 | ``innermost'' local binding, or the global binding if there is no | |
181 | local binding. To be more precise, a rule called the @dfn{scoping | |
182 | rule} determines where in a program a local binding takes effect. The | |
183 | default scoping rule in Emacs Lisp is called @dfn{dynamic scoping}, | |
184 | which simply states that the current binding at any given point in the | |
735cc5ca CY |
185 | execution of a program is the most recently-created binding for that |
186 | variable that still exists. For details about dynamic scoping, and an | |
187 | alternative scoping rule called @dfn{lexical scoping}, @xref{Variable | |
188 | Scoping}. | |
1021c761 CY |
189 | |
190 | The special forms @code{let} and @code{let*} exist to create local | |
191 | bindings: | |
b8d4c8d0 GM |
192 | |
193 | @defspec let (bindings@dots{}) forms@dots{} | |
1021c761 CY |
194 | This special form sets up local bindings for a certain set of |
195 | variables, as specified by @var{bindings}, and then evaluates all of | |
196 | the @var{forms} in textual order. Its return value is the value of | |
197 | the last form in @var{forms}. | |
b8d4c8d0 GM |
198 | |
199 | Each of the @var{bindings} is either @w{(i) a} symbol, in which case | |
1021c761 CY |
200 | that symbol is locally bound to @code{nil}; or @w{(ii) a} list of the |
201 | form @code{(@var{symbol} @var{value-form})}, in which case | |
202 | @var{symbol} is locally bound to the result of evaluating | |
203 | @var{value-form}. If @var{value-form} is omitted, @code{nil} is used. | |
b8d4c8d0 GM |
204 | |
205 | All of the @var{value-form}s in @var{bindings} are evaluated in the | |
206 | order they appear and @emph{before} binding any of the symbols to them. | |
207 | Here is an example of this: @code{z} is bound to the old value of | |
208 | @code{y}, which is 2, not the new value of @code{y}, which is 1. | |
209 | ||
210 | @example | |
211 | @group | |
212 | (setq y 2) | |
213 | @result{} 2 | |
214 | @end group | |
1021c761 | 215 | |
b8d4c8d0 GM |
216 | @group |
217 | (let ((y 1) | |
218 | (z y)) | |
219 | (list y z)) | |
220 | @result{} (1 2) | |
221 | @end group | |
222 | @end example | |
223 | @end defspec | |
224 | ||
225 | @defspec let* (bindings@dots{}) forms@dots{} | |
226 | This special form is like @code{let}, but it binds each variable right | |
227 | after computing its local value, before computing the local value for | |
228 | the next variable. Therefore, an expression in @var{bindings} can | |
1021c761 CY |
229 | refer to the preceding symbols bound in this @code{let*} form. |
230 | Compare the following example with the example above for @code{let}. | |
b8d4c8d0 GM |
231 | |
232 | @example | |
233 | @group | |
234 | (setq y 2) | |
235 | @result{} 2 | |
236 | @end group | |
1021c761 | 237 | |
b8d4c8d0 GM |
238 | @group |
239 | (let* ((y 1) | |
240 | (z y)) ; @r{Use the just-established value of @code{y}.} | |
241 | (list y z)) | |
242 | @result{} (1 1) | |
243 | @end group | |
244 | @end example | |
245 | @end defspec | |
246 | ||
247 | Here is a complete list of the other facilities that create local | |
248 | bindings: | |
249 | ||
250 | @itemize @bullet | |
251 | @item | |
252 | Function calls (@pxref{Functions}). | |
253 | ||
254 | @item | |
255 | Macro calls (@pxref{Macros}). | |
256 | ||
257 | @item | |
258 | @code{condition-case} (@pxref{Errors}). | |
259 | @end itemize | |
260 | ||
261 | Variables can also have buffer-local bindings (@pxref{Buffer-Local | |
e388c68f | 262 | Variables}); a few variables have terminal-local bindings |
3ec61d4e | 263 | (@pxref{Multiple Terminals}). These kinds of bindings work somewhat |
e388c68f | 264 | like ordinary local bindings, but they are localized depending on |
1021c761 | 265 | ``where'' you are in Emacs. |
b8d4c8d0 | 266 | |
01f17ae2 | 267 | @defopt max-specpdl-size |
b8d4c8d0 GM |
268 | @anchor{Definition of max-specpdl-size} |
269 | @cindex variable limit error | |
270 | @cindex evaluation error | |
271 | @cindex infinite recursion | |
272 | This variable defines the limit on the total number of local variable | |
32770114 CY |
273 | bindings and @code{unwind-protect} cleanups (see @ref{Cleanups,, |
274 | Cleaning Up from Nonlocal Exits}) that are allowed before Emacs | |
275 | signals an error (with data @code{"Variable binding depth exceeds | |
b8d4c8d0 GM |
276 | max-specpdl-size"}). |
277 | ||
278 | This limit, with the associated error when it is exceeded, is one way | |
279 | that Lisp avoids infinite recursion on an ill-defined function. | |
280 | @code{max-lisp-eval-depth} provides another limit on depth of nesting. | |
281 | @xref{Definition of max-lisp-eval-depth,, Eval}. | |
282 | ||
1021c761 | 283 | The default value is 1300. Entry to the Lisp debugger increases the |
b8d4c8d0 GM |
284 | value, if there is little room left, to make sure the debugger itself |
285 | has room to execute. | |
01f17ae2 | 286 | @end defopt |
b8d4c8d0 GM |
287 | |
288 | @node Void Variables | |
289 | @section When a Variable is ``Void'' | |
7018dbe7 | 290 | @cindex @code{void-variable} error |
b8d4c8d0 GM |
291 | @cindex void variable |
292 | ||
735cc5ca CY |
293 | We say that a variable is void if its symbol has an unassigned value |
294 | cell (@pxref{Symbol Components}). Under Emacs Lisp's default dynamic | |
295 | binding rules (@pxref{Variable Scoping}), the value cell stores the | |
296 | variable's current (local or global) value. Note that an unassigned | |
297 | value cell is @emph{not} the same as having @code{nil} in the value | |
298 | cell. The symbol @code{nil} is a Lisp object and can be the value of | |
299 | a variable, just as any other object can be; but it is still a value. | |
300 | If a variable is void, trying to evaluate the variable signals a | |
301 | @code{void-variable} error rather than a value. | |
302 | ||
303 | Under lexical binding rules, the value cell only holds the | |
304 | variable's global value, i.e.@: the value outside of any lexical | |
34706efa | 305 | binding construct. When a variable is lexically bound, the local value |
735cc5ca CY |
306 | is determined by the lexical environment; the variable may have a |
307 | local value if its symbol's value cell is unassigned. | |
b8d4c8d0 GM |
308 | |
309 | @defun makunbound symbol | |
1021c761 CY |
310 | This function empties out the value cell of @var{symbol}, making the |
311 | variable void. It returns @var{symbol}. | |
b8d4c8d0 | 312 | |
735cc5ca | 313 | If @var{symbol} has a dynamic local binding, @code{makunbound} voids |
1021c761 CY |
314 | the current binding, and this voidness lasts only as long as the local |
315 | binding is in effect. Afterwards, the previously shadowed local or | |
316 | global binding is reexposed; then the variable will no longer be void, | |
317 | unless the reexposed binding is void too. | |
b8d4c8d0 | 318 | |
1021c761 | 319 | Here are some examples (assuming dynamic binding is in effect): |
b8d4c8d0 GM |
320 | |
321 | @smallexample | |
322 | @group | |
323 | (setq x 1) ; @r{Put a value in the global binding.} | |
324 | @result{} 1 | |
325 | (let ((x 2)) ; @r{Locally bind it.} | |
326 | (makunbound 'x) ; @r{Void the local binding.} | |
327 | x) | |
328 | @error{} Symbol's value as variable is void: x | |
329 | @end group | |
330 | @group | |
331 | x ; @r{The global binding is unchanged.} | |
332 | @result{} 1 | |
333 | ||
334 | (let ((x 2)) ; @r{Locally bind it.} | |
335 | (let ((x 3)) ; @r{And again.} | |
336 | (makunbound 'x) ; @r{Void the innermost-local binding.} | |
337 | x)) ; @r{And refer: it's void.} | |
338 | @error{} Symbol's value as variable is void: x | |
339 | @end group | |
340 | ||
341 | @group | |
342 | (let ((x 2)) | |
343 | (let ((x 3)) | |
344 | (makunbound 'x)) ; @r{Void inner binding, then remove it.} | |
345 | x) ; @r{Now outer @code{let} binding is visible.} | |
346 | @result{} 2 | |
347 | @end group | |
348 | @end smallexample | |
349 | @end defun | |
350 | ||
b8d4c8d0 | 351 | @defun boundp variable |
1021c761 CY |
352 | This function returns @code{t} if @var{variable} (a symbol) is not |
353 | void, and @code{nil} if it is void. | |
354 | ||
355 | Here are some examples (assuming dynamic binding is in effect): | |
b8d4c8d0 GM |
356 | |
357 | @smallexample | |
358 | @group | |
359 | (boundp 'abracadabra) ; @r{Starts out void.} | |
360 | @result{} nil | |
361 | @end group | |
362 | @group | |
363 | (let ((abracadabra 5)) ; @r{Locally bind it.} | |
364 | (boundp 'abracadabra)) | |
365 | @result{} t | |
366 | @end group | |
367 | @group | |
368 | (boundp 'abracadabra) ; @r{Still globally void.} | |
369 | @result{} nil | |
370 | @end group | |
371 | @group | |
372 | (setq abracadabra 5) ; @r{Make it globally nonvoid.} | |
373 | @result{} 5 | |
374 | @end group | |
375 | @group | |
376 | (boundp 'abracadabra) | |
377 | @result{} t | |
378 | @end group | |
379 | @end smallexample | |
380 | @end defun | |
381 | ||
382 | @node Defining Variables | |
383 | @section Defining Global Variables | |
384 | @cindex variable definition | |
385 | ||
1021c761 CY |
386 | A @dfn{variable definition} is a construct that announces your |
387 | intention to use a symbol as a global variable. It uses the special | |
388 | forms @code{defvar} or @code{defconst}, which are documented below. | |
389 | ||
390 | A variable definition serves three purposes. First, it informs | |
391 | people who read the code that the symbol is @emph{intended} to be used | |
392 | a certain way (as a variable). Second, it informs the Lisp system of | |
393 | this, optionally supplying an initial value and a documentation | |
394 | string. Third, it provides information to programming tools such as | |
395 | @command{etags}, allowing them to find where the variable was defined. | |
396 | ||
397 | The difference between @code{defconst} and @code{defvar} is mainly a | |
398 | matter of intent, serving to inform human readers of whether the value | |
399 | should ever change. Emacs Lisp does not actually prevent you from | |
400 | changing the value of a variable defined with @code{defconst}. One | |
401 | notable difference between the two forms is that @code{defconst} | |
402 | unconditionally initializes the variable, whereas @code{defvar} | |
403 | initializes it only if it is originally void. | |
404 | ||
405 | To define a customizable variable, you should use @code{defcustom} | |
ed1f0bd3 CY |
406 | (which calls @code{defvar} as a subroutine). @xref{Variable |
407 | Definitions}. | |
b8d4c8d0 GM |
408 | |
409 | @defspec defvar symbol [value [doc-string]] | |
1021c761 CY |
410 | This special form defines @var{symbol} as a variable. Note that |
411 | @var{symbol} is not evaluated; the symbol to be defined should appear | |
412 | explicitly in the @code{defvar} form. The variable is marked as | |
413 | @dfn{special}, meaning that it should always be dynamically bound | |
414 | (@pxref{Variable Scoping}). | |
b8d4c8d0 GM |
415 | |
416 | If @var{symbol} is void and @var{value} is specified, @code{defvar} | |
1021c761 CY |
417 | evaluates @var{value} and sets @var{symbol} to the result. But if |
418 | @var{symbol} already has a value (i.e.@: it is not void), @var{value} | |
419 | is not even evaluated, and @var{symbol}'s value remains unchanged. If | |
420 | @var{value} is omitted, the value of @var{symbol} is not changed in | |
421 | any case. | |
b8d4c8d0 GM |
422 | |
423 | If @var{symbol} has a buffer-local binding in the current buffer, | |
424 | @code{defvar} operates on the default value, which is buffer-independent, | |
425 | not the current (buffer-local) binding. It sets the default value if | |
426 | the default value is void. @xref{Buffer-Local Variables}. | |
427 | ||
428 | When you evaluate a top-level @code{defvar} form with @kbd{C-M-x} in | |
429 | Emacs Lisp mode (@code{eval-defun}), a special feature of | |
430 | @code{eval-defun} arranges to set the variable unconditionally, without | |
431 | testing whether its value is void. | |
432 | ||
1021c761 CY |
433 | If the @var{doc-string} argument is supplied, it specifies the |
434 | documentation string for the variable (stored in the symbol's | |
435 | @code{variable-documentation} property). @xref{Documentation}. | |
b8d4c8d0 GM |
436 | |
437 | Here are some examples. This form defines @code{foo} but does not | |
438 | initialize it: | |
439 | ||
440 | @example | |
441 | @group | |
442 | (defvar foo) | |
443 | @result{} foo | |
444 | @end group | |
445 | @end example | |
446 | ||
447 | This example initializes the value of @code{bar} to @code{23}, and gives | |
448 | it a documentation string: | |
449 | ||
450 | @example | |
451 | @group | |
452 | (defvar bar 23 | |
453 | "The normal weight of a bar.") | |
454 | @result{} bar | |
455 | @end group | |
456 | @end example | |
457 | ||
b8d4c8d0 GM |
458 | The @code{defvar} form returns @var{symbol}, but it is normally used |
459 | at top level in a file where its value does not matter. | |
460 | @end defspec | |
461 | ||
2640fa86 | 462 | @cindex constant variables |
b8d4c8d0 GM |
463 | @defspec defconst symbol value [doc-string] |
464 | This special form defines @var{symbol} as a value and initializes it. | |
465 | It informs a person reading your code that @var{symbol} has a standard | |
466 | global value, established here, that should not be changed by the user | |
467 | or by other programs. Note that @var{symbol} is not evaluated; the | |
468 | symbol to be defined must appear explicitly in the @code{defconst}. | |
469 | ||
1021c761 CY |
470 | The @code{defconst} form, like @code{defvar}, marks the variable as |
471 | @dfn{special}, meaning that it should always be dynamically bound | |
472 | (@pxref{Variable Scoping}). In addition, it marks the variable as | |
473 | risky (@pxref{File Local Variables}). | |
474 | ||
b8d4c8d0 GM |
475 | @code{defconst} always evaluates @var{value}, and sets the value of |
476 | @var{symbol} to the result. If @var{symbol} does have a buffer-local | |
477 | binding in the current buffer, @code{defconst} sets the default value, | |
478 | not the buffer-local value. (But you should not be making | |
479 | buffer-local bindings for a symbol that is defined with | |
480 | @code{defconst}.) | |
481 | ||
44e97401 | 482 | An example of the use of @code{defconst} is Emacs's definition of |
ec8a6295 CY |
483 | @code{float-pi}---the mathematical constant @math{pi}, which ought not |
484 | to be changed by anyone (attempts by the Indiana State Legislature | |
485 | notwithstanding). As the second form illustrates, however, | |
486 | @code{defconst} is only advisory. | |
b8d4c8d0 GM |
487 | |
488 | @example | |
489 | @group | |
ec8a6295 CY |
490 | (defconst float-pi 3.141592653589793 "The value of Pi.") |
491 | @result{} float-pi | |
b8d4c8d0 GM |
492 | @end group |
493 | @group | |
ec8a6295 CY |
494 | (setq float-pi 3) |
495 | @result{} float-pi | |
b8d4c8d0 GM |
496 | @end group |
497 | @group | |
ec8a6295 | 498 | float-pi |
b8d4c8d0 GM |
499 | @result{} 3 |
500 | @end group | |
501 | @end example | |
502 | @end defspec | |
503 | ||
1021c761 CY |
504 | @strong{Warning:} If you use a @code{defconst} or @code{defvar} |
505 | special form while the variable has a local binding (made with | |
506 | @code{let}, or a function argument), it sets the local binding rather | |
507 | than the global binding. This is not what you usually want. To | |
508 | prevent this, use these special forms at top level in a file, where | |
509 | normally no local binding is in effect, and make sure to load the file | |
510 | before making a local binding for the variable. | |
b8d4c8d0 GM |
511 | |
512 | @node Tips for Defining | |
513 | @section Tips for Defining Variables Robustly | |
514 | ||
515 | When you define a variable whose value is a function, or a list of | |
516 | functions, use a name that ends in @samp{-function} or | |
517 | @samp{-functions}, respectively. | |
518 | ||
519 | There are several other variable name conventions; | |
520 | here is a complete list: | |
521 | ||
522 | @table @samp | |
523 | @item @dots{}-hook | |
524 | The variable is a normal hook (@pxref{Hooks}). | |
525 | ||
526 | @item @dots{}-function | |
527 | The value is a function. | |
528 | ||
529 | @item @dots{}-functions | |
530 | The value is a list of functions. | |
531 | ||
532 | @item @dots{}-form | |
533 | The value is a form (an expression). | |
534 | ||
535 | @item @dots{}-forms | |
536 | The value is a list of forms (expressions). | |
537 | ||
538 | @item @dots{}-predicate | |
539 | The value is a predicate---a function of one argument that returns | |
540 | non-@code{nil} for ``good'' arguments and @code{nil} for ``bad'' | |
541 | arguments. | |
542 | ||
543 | @item @dots{}-flag | |
544 | The value is significant only as to whether it is @code{nil} or not. | |
cc5a5e2d | 545 | Since such variables often end up acquiring more values over time, |
0befcaca | 546 | this convention is not strongly recommended. |
b8d4c8d0 GM |
547 | |
548 | @item @dots{}-program | |
549 | The value is a program name. | |
550 | ||
551 | @item @dots{}-command | |
552 | The value is a whole shell command. | |
553 | ||
554 | @item @dots{}-switches | |
555 | The value specifies options for a command. | |
556 | @end table | |
557 | ||
558 | When you define a variable, always consider whether you should mark | |
32770114 | 559 | it as ``safe'' or ``risky''; see @ref{File Local Variables}. |
b8d4c8d0 GM |
560 | |
561 | When defining and initializing a variable that holds a complicated | |
562 | value (such as a keymap with bindings in it), it's best to put the | |
563 | entire computation of the value into the @code{defvar}, like this: | |
564 | ||
565 | @example | |
566 | (defvar my-mode-map | |
567 | (let ((map (make-sparse-keymap))) | |
568 | (define-key map "\C-c\C-a" 'my-command) | |
569 | @dots{} | |
570 | map) | |
571 | @var{docstring}) | |
572 | @end example | |
573 | ||
574 | @noindent | |
575 | This method has several benefits. First, if the user quits while | |
576 | loading the file, the variable is either still uninitialized or | |
577 | initialized properly, never in-between. If it is still uninitialized, | |
578 | reloading the file will initialize it properly. Second, reloading the | |
579 | file once the variable is initialized will not alter it; that is | |
1021c761 CY |
580 | important if the user has run hooks to alter part of the contents |
581 | (such as, to rebind keys). Third, evaluating the @code{defvar} form | |
582 | with @kbd{C-M-x} will reinitialize the map completely. | |
b8d4c8d0 GM |
583 | |
584 | Putting so much code in the @code{defvar} form has one disadvantage: | |
585 | it puts the documentation string far away from the line which names the | |
586 | variable. Here's a safe way to avoid that: | |
587 | ||
588 | @example | |
589 | (defvar my-mode-map nil | |
590 | @var{docstring}) | |
591 | (unless my-mode-map | |
592 | (let ((map (make-sparse-keymap))) | |
593 | (define-key map "\C-c\C-a" 'my-command) | |
594 | @dots{} | |
595 | (setq my-mode-map map))) | |
596 | @end example | |
597 | ||
598 | @noindent | |
599 | This has all the same advantages as putting the initialization inside | |
600 | the @code{defvar}, except that you must type @kbd{C-M-x} twice, once on | |
601 | each form, if you do want to reinitialize the variable. | |
602 | ||
b8d4c8d0 GM |
603 | @node Accessing Variables |
604 | @section Accessing Variable Values | |
605 | ||
606 | The usual way to reference a variable is to write the symbol which | |
1021c761 CY |
607 | names it. @xref{Symbol Forms}. |
608 | ||
609 | Occasionally, you may want to reference a variable which is only | |
610 | determined at run time. In that case, you cannot specify the variable | |
611 | name in the text of the program. You can use the @code{symbol-value} | |
612 | function to extract the value. | |
b8d4c8d0 GM |
613 | |
614 | @defun symbol-value symbol | |
735cc5ca CY |
615 | This function returns the value stored in @var{symbol}'s value cell. |
616 | This is where the variable's current (dynamic) value is stored. If | |
617 | the variable has no local binding, this is simply its global value. | |
618 | If the variable is void, a @code{void-variable} error is signaled. | |
1021c761 CY |
619 | |
620 | If the variable is lexically bound, the value reported by | |
735cc5ca CY |
621 | @code{symbol-value} is not necessarily the same as the variable's |
622 | lexical value, which is determined by the lexical environment rather | |
623 | than the symbol's value cell. @xref{Variable Scoping}. | |
b8d4c8d0 GM |
624 | |
625 | @example | |
626 | @group | |
627 | (setq abracadabra 5) | |
628 | @result{} 5 | |
629 | @end group | |
630 | @group | |
631 | (setq foo 9) | |
632 | @result{} 9 | |
633 | @end group | |
634 | ||
635 | @group | |
636 | ;; @r{Here the symbol @code{abracadabra}} | |
637 | ;; @r{is the symbol whose value is examined.} | |
638 | (let ((abracadabra 'foo)) | |
639 | (symbol-value 'abracadabra)) | |
640 | @result{} foo | |
641 | @end group | |
642 | ||
643 | @group | |
644 | ;; @r{Here, the value of @code{abracadabra},} | |
645 | ;; @r{which is @code{foo},} | |
646 | ;; @r{is the symbol whose value is examined.} | |
647 | (let ((abracadabra 'foo)) | |
648 | (symbol-value abracadabra)) | |
649 | @result{} 9 | |
650 | @end group | |
651 | ||
652 | @group | |
653 | (symbol-value 'abracadabra) | |
654 | @result{} 5 | |
655 | @end group | |
656 | @end example | |
b8d4c8d0 GM |
657 | @end defun |
658 | ||
659 | @node Setting Variables | |
1021c761 | 660 | @section Setting Variable Values |
b8d4c8d0 GM |
661 | |
662 | The usual way to change the value of a variable is with the special | |
663 | form @code{setq}. When you need to compute the choice of variable at | |
664 | run time, use the function @code{set}. | |
665 | ||
666 | @defspec setq [symbol form]@dots{} | |
667 | This special form is the most common method of changing a variable's | |
668 | value. Each @var{symbol} is given a new value, which is the result of | |
1021c761 CY |
669 | evaluating the corresponding @var{form}. The current binding of the |
670 | symbol is changed. | |
b8d4c8d0 GM |
671 | |
672 | @code{setq} does not evaluate @var{symbol}; it sets the symbol that you | |
673 | write. We say that this argument is @dfn{automatically quoted}. The | |
16152b76 | 674 | @samp{q} in @code{setq} stands for ``quoted''. |
b8d4c8d0 GM |
675 | |
676 | The value of the @code{setq} form is the value of the last @var{form}. | |
677 | ||
678 | @example | |
679 | @group | |
680 | (setq x (1+ 2)) | |
681 | @result{} 3 | |
682 | @end group | |
683 | x ; @r{@code{x} now has a global value.} | |
684 | @result{} 3 | |
685 | @group | |
686 | (let ((x 5)) | |
687 | (setq x 6) ; @r{The local binding of @code{x} is set.} | |
688 | x) | |
689 | @result{} 6 | |
690 | @end group | |
691 | x ; @r{The global value is unchanged.} | |
692 | @result{} 3 | |
693 | @end example | |
694 | ||
695 | Note that the first @var{form} is evaluated, then the first | |
696 | @var{symbol} is set, then the second @var{form} is evaluated, then the | |
697 | second @var{symbol} is set, and so on: | |
698 | ||
699 | @example | |
700 | @group | |
701 | (setq x 10 ; @r{Notice that @code{x} is set before} | |
702 | y (1+ x)) ; @r{the value of @code{y} is computed.} | |
703 | @result{} 11 | |
704 | @end group | |
705 | @end example | |
706 | @end defspec | |
707 | ||
708 | @defun set symbol value | |
1021c761 CY |
709 | This function puts @var{value} in the value cell of @var{symbol}. |
710 | Since it is a function rather than a special form, the expression | |
711 | written for @var{symbol} is evaluated to obtain the symbol to set. | |
712 | The return value is @var{value}. | |
713 | ||
714 | When dynamic variable binding is in effect (the default), @code{set} | |
715 | has the same effect as @code{setq}, apart from the fact that | |
716 | @code{set} evaluates its @var{symbol} argument whereas @code{setq} | |
717 | does not. But when a variable is lexically bound, @code{set} affects | |
718 | its @emph{dynamic} value, whereas @code{setq} affects its current | |
719 | (lexical) value. @xref{Variable Scoping}. | |
b8d4c8d0 GM |
720 | |
721 | @example | |
722 | @group | |
723 | (set one 1) | |
724 | @error{} Symbol's value as variable is void: one | |
725 | @end group | |
726 | @group | |
727 | (set 'one 1) | |
728 | @result{} 1 | |
729 | @end group | |
730 | @group | |
731 | (set 'two 'one) | |
732 | @result{} one | |
733 | @end group | |
734 | @group | |
735 | (set two 2) ; @r{@code{two} evaluates to symbol @code{one}.} | |
736 | @result{} 2 | |
737 | @end group | |
738 | @group | |
739 | one ; @r{So it is @code{one} that was set.} | |
740 | @result{} 2 | |
741 | (let ((one 1)) ; @r{This binding of @code{one} is set,} | |
742 | (set 'one 3) ; @r{not the global value.} | |
743 | one) | |
744 | @result{} 3 | |
745 | @end group | |
746 | @group | |
747 | one | |
748 | @result{} 2 | |
749 | @end group | |
750 | @end example | |
751 | ||
752 | If @var{symbol} is not actually a symbol, a @code{wrong-type-argument} | |
753 | error is signaled. | |
754 | ||
755 | @example | |
756 | (set '(x y) 'z) | |
757 | @error{} Wrong type argument: symbolp, (x y) | |
758 | @end example | |
b8d4c8d0 GM |
759 | @end defun |
760 | ||
761 | @node Variable Scoping | |
762 | @section Scoping Rules for Variable Bindings | |
763 | ||
1021c761 CY |
764 | When you create a local binding for a variable, that binding takes |
765 | effect only within a limited portion of the program (@pxref{Local | |
766 | Variables}). This section describes exactly what this means. | |
b8d4c8d0 GM |
767 | |
768 | @cindex scope | |
769 | @cindex extent | |
1021c761 CY |
770 | Each local binding has a certain @dfn{scope} and @dfn{extent}. |
771 | @dfn{Scope} refers to @emph{where} in the textual source code the | |
772 | binding can be accessed. @dfn{Extent} refers to @emph{when}, as the | |
773 | program is executing, the binding exists. | |
774 | ||
775 | @cindex dynamic binding | |
776 | @cindex indefinite scope | |
777 | @cindex dynamic extent | |
778 | By default, the local bindings that Emacs creates are @dfn{dynamic | |
779 | bindings}. Such a binding has @dfn{indefinite scope}, meaning that | |
780 | any part of the program can potentially access the variable binding. | |
781 | It also has @dfn{dynamic extent}, meaning that the binding lasts only | |
782 | while the binding construct (such as the body of a @code{let} form) is | |
783 | being executed. | |
784 | ||
785 | @cindex lexical binding | |
786 | @cindex lexical scope | |
787 | @cindex indefinite extent | |
788 | Emacs can optionally create @dfn{lexical bindings}. A lexical | |
789 | binding has @dfn{lexical scope}, meaning that any reference to the | |
790 | variable must be located textually within the binding construct. It | |
791 | also has @dfn{indefinite extent}, meaning that under some | |
792 | circumstances the binding can live on even after the binding construct | |
793 | has finished executing, by means of special objects called | |
794 | @dfn{closures}. | |
795 | ||
796 | The following subsections describe dynamic binding and lexical | |
797 | binding in greater detail, and how to enable lexical binding in Emacs | |
798 | Lisp programs. | |
b8d4c8d0 GM |
799 | |
800 | @menu | |
1021c761 CY |
801 | * Dynamic Binding:: The default for binding local variables in Emacs. |
802 | * Dynamic Binding Tips:: Avoiding problems with dynamic binding. | |
803 | * Lexical Binding:: A different type of local variable binding. | |
804 | * Using Lexical Binding:: How to enable lexical binding. | |
b8d4c8d0 GM |
805 | @end menu |
806 | ||
1021c761 CY |
807 | @node Dynamic Binding |
808 | @subsection Dynamic Binding | |
809 | ||
810 | By default, the local variable bindings made by Emacs are dynamic | |
811 | bindings. When a variable is dynamically bound, its current binding | |
812 | at any point in the execution of the Lisp program is simply the most | |
813 | recently-created dynamic local binding for that symbol, or the global | |
814 | binding if there is no such local binding. | |
b8d4c8d0 | 815 | |
1021c761 CY |
816 | Dynamic bindings have indefinite scope and dynamic extent, as shown |
817 | by the following example: | |
b8d4c8d0 GM |
818 | |
819 | @example | |
820 | @group | |
1021c761 | 821 | (defvar x -99) ; @r{@code{x} receives an initial value of -99.} |
b8d4c8d0 | 822 | |
1021c761 CY |
823 | (defun getx () |
824 | x) ; @r{@code{x} is used ``free'' in this function.} | |
825 | ||
826 | (let ((x 1)) ; @r{@code{x} is dynamically bound.} | |
827 | (getx)) | |
828 | @result{} 1 | |
829 | ||
830 | ;; @r{After the @code{let} form finishes, @code{x} reverts to its} | |
831 | ;; @r{previous value, which is -99.} | |
832 | ||
833 | (getx) | |
834 | @result{} -99 | |
b8d4c8d0 GM |
835 | @end group |
836 | @end example | |
837 | ||
1021c761 CY |
838 | @noindent |
839 | The function @code{getx} refers to @code{x}. This is a ``free'' | |
840 | reference, in the sense that there is no binding for @code{x} within | |
841 | that @code{defun} construct itself. When we call @code{getx} from | |
842 | within a @code{let} form in which @code{x} is (dynamically) bound, it | |
843 | retrieves the local value of @code{x} (i.e.@: 1). But when we call | |
844 | @code{getx} outside the @code{let} form, it retrieves the global value | |
845 | of @code{x} (i.e.@: -99). | |
b8d4c8d0 | 846 | |
1021c761 CY |
847 | Here is another example, which illustrates setting a dynamically |
848 | bound variable using @code{setq}: | |
b8d4c8d0 GM |
849 | |
850 | @example | |
851 | @group | |
1021c761 CY |
852 | (defvar x -99) ; @r{@code{x} receives an initial value of -99.} |
853 | ||
854 | (defun addx () | |
855 | (setq x (1+ x))) ; @r{Add 1 to @code{x} and return its new value.} | |
856 | ||
857 | (let ((x 1)) | |
858 | (addx) | |
859 | (addx)) | |
860 | @result{} 3 ; @r{The two @code{addx} calls add to @code{x} twice.} | |
861 | ||
862 | ;; @r{After the @code{let} form finishes, @code{x} reverts to its} | |
863 | ;; @r{previous value, which is -99.} | |
864 | ||
865 | (addx) | |
866 | @result{} -98 | |
b8d4c8d0 GM |
867 | @end group |
868 | @end example | |
869 | ||
1021c761 CY |
870 | Dynamic binding is implemented in Emacs Lisp in a simple way. Each |
871 | symbol has a value cell, which specifies its current dynamic value (or | |
872 | absence of value). @xref{Symbol Components}. When a symbol is given | |
873 | a dynamic local binding, Emacs records the contents of the value cell | |
874 | (or absence thereof) in a stack, and stores the new local value in the | |
875 | value cell. When the binding construct finishes executing, Emacs pops | |
876 | the old value off the stack, and puts it in the value cell. | |
b8d4c8d0 | 877 | |
1021c761 CY |
878 | @node Dynamic Binding Tips |
879 | @subsection Proper Use of Dynamic Binding | |
b8d4c8d0 | 880 | |
1021c761 CY |
881 | Dynamic binding is a powerful feature, as it allows programs to |
882 | refer to variables that are not defined within their local textual | |
883 | scope. However, if used without restraint, this can also make | |
884 | programs hard to understand. There are two clean ways to use this | |
885 | technique: | |
b8d4c8d0 | 886 | |
1021c761 CY |
887 | @itemize @bullet |
888 | @item | |
889 | If a variable has no global definition, use it as a local variable | |
890 | only within a binding construct, e.g.@: the body of the @code{let} | |
891 | form where the variable was bound, or the body of the function for an | |
892 | argument variable. If this convention is followed consistently | |
893 | throughout a program, the value of the variable will not affect, nor | |
894 | be affected by, any uses of the same variable symbol elsewhere in the | |
895 | program. | |
896 | ||
897 | @item | |
898 | Otherwise, define the variable with @code{defvar}, @code{defconst}, or | |
899 | @code{defcustom}. @xref{Defining Variables}. Usually, the definition | |
900 | should be at top-level in an Emacs Lisp file. As far as possible, it | |
901 | should include a documentation string which explains the meaning and | |
902 | purpose of the variable. You should also choose the variable's name | |
903 | to avoid name conflicts (@pxref{Coding Conventions}). | |
904 | ||
905 | Then you can bind the variable anywhere in a program, knowing reliably | |
906 | what the effect will be. Wherever you encounter the variable, it will | |
907 | be easy to refer back to the definition, e.g.@: via the @kbd{C-h v} | |
908 | command (provided the variable definition has been loaded into Emacs). | |
909 | @xref{Name Help,,, emacs, The GNU Emacs Manual}. | |
910 | ||
911 | For example, it is common to use local bindings for customizable | |
912 | variables like @code{case-fold-search}: | |
b8d4c8d0 GM |
913 | |
914 | @example | |
1021c761 CY |
915 | @group |
916 | (defun search-for-abc () | |
917 | "Search for the string \"abc\", ignoring case differences." | |
918 | (let ((case-fold-search nil)) | |
919 | (re-search-forward "abc"))) | |
920 | @end group | |
b8d4c8d0 | 921 | @end example |
1021c761 | 922 | @end itemize |
b8d4c8d0 | 923 | |
1021c761 CY |
924 | @node Lexical Binding |
925 | @subsection Lexical Binding | |
b8d4c8d0 | 926 | |
1021c761 CY |
927 | Optionally, you can create lexical bindings in Emacs Lisp. A |
928 | lexically bound variable has @dfn{lexical scope}, meaning that any | |
929 | reference to the variable must be located textually within the binding | |
b8d4c8d0 GM |
930 | construct. |
931 | ||
1021c761 CY |
932 | Here is an example |
933 | @iftex | |
934 | (see the next subsection, for how to actually enable lexical binding): | |
935 | @end iftex | |
936 | @ifnottex | |
937 | (@pxref{Using Lexical Binding}, for how to actually enable lexical binding): | |
938 | @end ifnottex | |
b8d4c8d0 | 939 | |
1021c761 CY |
940 | @example |
941 | @group | |
1021c761 CY |
942 | (let ((x 1)) ; @r{@code{x} is lexically bound.} |
943 | (+ x 3)) | |
944 | @result{} 4 | |
b8d4c8d0 | 945 | |
735cc5ca CY |
946 | (defun getx () |
947 | x) ; @r{@code{x} is used ``free'' in this function.} | |
948 | ||
1021c761 CY |
949 | (let ((x 1)) ; @r{@code{x} is lexically bound.} |
950 | (getx)) | |
951 | @error{} Symbol's value as variable is void: x | |
952 | @end group | |
953 | @end example | |
b8d4c8d0 | 954 | |
1021c761 CY |
955 | @noindent |
956 | Here, the variable @code{x} has no global value. When it is lexically | |
957 | bound within a @code{let} form, it can be used in the textual confines | |
958 | of that @code{let} form. But it can @emph{not} be used from within a | |
959 | @code{getx} function called from the @code{let} form, since the | |
960 | function definition of @code{getx} occurs outside the @code{let} form | |
961 | itself. | |
962 | ||
963 | @cindex lexical environment | |
964 | Here is how lexical binding works. Each binding construct defines a | |
965 | @dfn{lexical environment}, specifying the symbols that are bound | |
966 | within the construct and their local values. When the Lisp evaluator | |
967 | wants the current value of a variable, it looks first in the lexical | |
968 | environment; if the variable is not specified in there, it looks in | |
735cc5ca | 969 | the symbol's value cell, where the dynamic value is stored. |
1021c761 | 970 | |
a08eadfe | 971 | @cindex closures, example of using |
1021c761 CY |
972 | Lexical bindings have indefinite extent. Even after a binding |
973 | construct has finished executing, its lexical environment can be | |
974 | ``kept around'' in Lisp objects called @dfn{closures}. A closure is | |
a08eadfe | 975 | created when you define a named or anonymous function with lexical |
735cc5ca | 976 | binding enabled. @xref{Closures}, for details. |
1021c761 | 977 | |
735cc5ca CY |
978 | When a closure is called as a function, any lexical variable |
979 | references within its definition use the retained lexical environment. | |
980 | Here is an example: | |
b8d4c8d0 | 981 | |
1021c761 CY |
982 | @example |
983 | (defvar my-ticker nil) ; @r{We will use this dynamically bound} | |
984 | ; @r{variable to store a closure.} | |
b8d4c8d0 | 985 | |
1021c761 CY |
986 | (let ((x 0)) ; @r{@code{x} is lexically bound.} |
987 | (setq my-ticker (lambda () | |
988 | (setq x (1+ x))))) | |
989 | @result{} (closure ((x . 0) t) () | |
990 | (1+ x)) | |
b8d4c8d0 | 991 | |
1021c761 CY |
992 | (funcall my-ticker) |
993 | @result{} 1 | |
b8d4c8d0 | 994 | |
1021c761 CY |
995 | (funcall my-ticker) |
996 | @result{} 2 | |
b8d4c8d0 | 997 | |
1021c761 CY |
998 | (funcall my-ticker) |
999 | @result{} 3 | |
d032d5e7 | 1000 | |
1021c761 CY |
1001 | x ; @r{Note that @code{x} has no global value.} |
1002 | @error{} Symbol's value as variable is void: x | |
1003 | @end example | |
d032d5e7 | 1004 | |
1021c761 CY |
1005 | @noindent |
1006 | The @code{let} binding defines a lexical environment in which the | |
1007 | variable @code{x} is locally bound to 0. Within this binding | |
1008 | construct, we define a lambda expression which increments @code{x} by | |
1009 | one and returns the incremented value. This lambda expression is | |
1010 | automatically turned into a closure, in which the lexical environment | |
1011 | lives on even after the @code{let} binding construct has exited. Each | |
1012 | time we evaluate the closure, it increments @code{x}, using the | |
1013 | binding of @code{x} in that lexical environment. | |
1014 | ||
1015 | Note that functions like @code{symbol-value}, @code{boundp}, and | |
1016 | @code{set} only retrieve or modify a variable's dynamic binding | |
1017 | (i.e.@: the contents of its symbol's value cell). Also, the code in | |
1018 | the body of a @code{defun} or @code{defmacro} cannot refer to | |
1019 | surrounding lexical variables. | |
1020 | ||
1021 | Currently, lexical binding is not much used within the Emacs | |
1022 | sources. However, we expect its importance to increase in the future. | |
1023 | Lexical binding opens up a lot more opportunities for optimization, so | |
1024 | Emacs Lisp code that makes use of lexical binding is likely to run | |
1025 | faster in future Emacs versions. Such code is also much more friendly | |
1026 | to concurrency, which we want to add to Emacs in the near future. | |
1027 | ||
1028 | @node Using Lexical Binding | |
1029 | @subsection Using Lexical Binding | |
1030 | ||
1031 | When loading an Emacs Lisp file or evaluating a Lisp buffer, lexical | |
1032 | binding is enabled if the buffer-local variable @code{lexical-binding} | |
1033 | is non-@code{nil}: | |
d032d5e7 SM |
1034 | |
1035 | @defvar lexical-binding | |
1021c761 CY |
1036 | If this buffer-local variable is non-@code{nil}, Emacs Lisp files and |
1037 | buffers are evaluated using lexical binding instead of dynamic | |
1038 | binding. (However, special variables are still dynamically bound; see | |
1039 | below.) If @code{nil}, dynamic binding is used for all local | |
1040 | variables. This variable is typically set for a whole Emacs Lisp | |
1041 | file, as a file local variable (@pxref{File Local Variables}). | |
48da7392 GM |
1042 | Note that unlike other such variables, this one must be set in the |
1043 | first line of a file. | |
d032d5e7 SM |
1044 | @end defvar |
1045 | ||
1021c761 CY |
1046 | @noindent |
1047 | When evaluating Emacs Lisp code directly using an @code{eval} call, | |
1048 | lexical binding is enabled if the @var{lexical} argument to | |
1049 | @code{eval} is non-@code{nil}. @xref{Eval}. | |
1050 | ||
1051 | @cindex special variables | |
1052 | Even when lexical binding is enabled, certain variables will | |
1053 | continue to be dynamically bound. These are called @dfn{special | |
1054 | variables}. Every variable that has been defined with @code{defvar}, | |
1055 | @code{defcustom} or @code{defconst} is a special variable | |
1056 | (@pxref{Defining Variables}). All other variables are subject to | |
1057 | lexical binding. | |
1058 | ||
d032d5e7 | 1059 | @defun special-variable-p SYMBOL |
1021c761 CY |
1060 | This function returns non-@code{nil} if @var{symbol} is a special |
1061 | variable (i.e.@: it has a @code{defvar}, @code{defcustom}, or | |
1062 | @code{defconst} variable definition). Otherwise, the return value is | |
1063 | @code{nil}. | |
d032d5e7 SM |
1064 | @end defun |
1065 | ||
1021c761 CY |
1066 | The use of a special variable as a formal argument in a function is |
1067 | discouraged. Doing so gives rise to unspecified behavior when lexical | |
1068 | binding mode is enabled (it may use lexical binding sometimes, and | |
1069 | dynamic binding other times). | |
1070 | ||
1071 | Converting an Emacs Lisp program to lexical binding is pretty easy. | |
1072 | First, add a file-local variable setting of @code{lexical-binding} to | |
1073 | @code{t} in the Emacs Lisp source file. Second, check that every | |
1074 | variable in the program which needs to be dynamically bound has a | |
1075 | variable definition, so that it is not inadvertently bound lexically. | |
1076 | ||
1077 | A simple way to find out which variables need a variable definition | |
1078 | is to byte-compile the source file. @xref{Byte Compilation}. If a | |
1079 | non-special variable is used outside of a @code{let} form, the | |
1080 | byte-compiler will warn about reference or assignment to a ``free | |
1081 | variable''. If a non-special variable is bound but not used within a | |
1082 | @code{let} form, the byte-compiler will warn about an ``unused lexical | |
1083 | variable''. The byte-compiler will also issue a warning if you use a | |
1084 | special variable as a function argument. | |
1085 | ||
1086 | (To silence byte-compiler warnings about unused variables, just use | |
1087 | a variable name that start with an underscore. The byte-compiler | |
1088 | interprets this as an indication that this is a variable known not to | |
1089 | be used.) | |
d032d5e7 | 1090 | |
b8d4c8d0 GM |
1091 | @node Buffer-Local Variables |
1092 | @section Buffer-Local Variables | |
1093 | @cindex variable, buffer-local | |
1094 | @cindex buffer-local variables | |
1095 | ||
1096 | Global and local variable bindings are found in most programming | |
e388c68f RS |
1097 | languages in one form or another. Emacs, however, also supports |
1098 | additional, unusual kinds of variable binding, such as | |
1099 | @dfn{buffer-local} bindings, which apply only in one buffer. Having | |
1100 | different values for a variable in different buffers is an important | |
32770114 | 1101 | customization method. (Variables can also have bindings that are |
c830e5ae | 1102 | local to each terminal. @xref{Multiple Terminals}.) |
b8d4c8d0 GM |
1103 | |
1104 | @menu | |
d032d5e7 SM |
1105 | * Intro to Buffer-Local:: Introduction and concepts. |
1106 | * Creating Buffer-Local:: Creating and destroying buffer-local bindings. | |
1107 | * Default Value:: The default value is seen in buffers | |
b8d4c8d0 GM |
1108 | that don't have their own buffer-local values. |
1109 | @end menu | |
1110 | ||
1111 | @node Intro to Buffer-Local | |
1112 | @subsection Introduction to Buffer-Local Variables | |
1113 | ||
1114 | A buffer-local variable has a buffer-local binding associated with a | |
1115 | particular buffer. The binding is in effect when that buffer is | |
1116 | current; otherwise, it is not in effect. If you set the variable while | |
1117 | a buffer-local binding is in effect, the new value goes in that binding, | |
1118 | so its other bindings are unchanged. This means that the change is | |
1119 | visible only in the buffer where you made it. | |
1120 | ||
1121 | The variable's ordinary binding, which is not associated with any | |
1122 | specific buffer, is called the @dfn{default binding}. In most cases, | |
1123 | this is the global binding. | |
1124 | ||
1125 | A variable can have buffer-local bindings in some buffers but not in | |
1126 | other buffers. The default binding is shared by all the buffers that | |
1127 | don't have their own bindings for the variable. (This includes all | |
1128 | newly-created buffers.) If you set the variable in a buffer that does | |
e388c68f | 1129 | not have a buffer-local binding for it, this sets the default binding, |
b8d4c8d0 GM |
1130 | so the new value is visible in all the buffers that see the default |
1131 | binding. | |
1132 | ||
1133 | The most common use of buffer-local bindings is for major modes to change | |
1134 | variables that control the behavior of commands. For example, C mode and | |
1135 | Lisp mode both set the variable @code{paragraph-start} to specify that only | |
1136 | blank lines separate paragraphs. They do this by making the variable | |
1137 | buffer-local in the buffer that is being put into C mode or Lisp mode, and | |
1138 | then setting it to the new value for that mode. @xref{Major Modes}. | |
1139 | ||
1140 | The usual way to make a buffer-local binding is with | |
1141 | @code{make-local-variable}, which is what major mode commands typically | |
1142 | use. This affects just the current buffer; all other buffers (including | |
1143 | those yet to be created) will continue to share the default value unless | |
1144 | they are explicitly given their own buffer-local bindings. | |
1145 | ||
1146 | @cindex automatically buffer-local | |
1147 | A more powerful operation is to mark the variable as | |
1148 | @dfn{automatically buffer-local} by calling | |
1149 | @code{make-variable-buffer-local}. You can think of this as making the | |
1150 | variable local in all buffers, even those yet to be created. More | |
1151 | precisely, the effect is that setting the variable automatically makes | |
1152 | the variable local to the current buffer if it is not already so. All | |
1153 | buffers start out by sharing the default value of the variable as usual, | |
1154 | but setting the variable creates a buffer-local binding for the current | |
1155 | buffer. The new value is stored in the buffer-local binding, leaving | |
1156 | the default binding untouched. This means that the default value cannot | |
1157 | be changed with @code{setq} in any buffer; the only way to change it is | |
1158 | with @code{setq-default}. | |
1159 | ||
e388c68f | 1160 | @strong{Warning:} When a variable has buffer-local |
b8d4c8d0 GM |
1161 | bindings in one or more buffers, @code{let} rebinds the binding that's |
1162 | currently in effect. For instance, if the current buffer has a | |
1163 | buffer-local value, @code{let} temporarily rebinds that. If no | |
e388c68f | 1164 | buffer-local bindings are in effect, @code{let} rebinds |
b8d4c8d0 GM |
1165 | the default value. If inside the @code{let} you then change to a |
1166 | different current buffer in which a different binding is in effect, | |
1167 | you won't see the @code{let} binding any more. And if you exit the | |
1168 | @code{let} while still in the other buffer, you won't see the | |
1169 | unbinding occur (though it will occur properly). Here is an example | |
1170 | to illustrate: | |
1171 | ||
1172 | @example | |
1173 | @group | |
1174 | (setq foo 'g) | |
1175 | (set-buffer "a") | |
1176 | (make-local-variable 'foo) | |
1177 | @end group | |
1178 | (setq foo 'a) | |
1179 | (let ((foo 'temp)) | |
1180 | ;; foo @result{} 'temp ; @r{let binding in buffer @samp{a}} | |
1181 | (set-buffer "b") | |
1182 | ;; foo @result{} 'g ; @r{the global value since foo is not local in @samp{b}} | |
1183 | @var{body}@dots{}) | |
1184 | @group | |
1185 | foo @result{} 'g ; @r{exiting restored the local value in buffer @samp{a},} | |
1186 | ; @r{but we don't see that in buffer @samp{b}} | |
1187 | @end group | |
1188 | @group | |
1189 | (set-buffer "a") ; @r{verify the local value was restored} | |
1190 | foo @result{} 'a | |
1191 | @end group | |
1192 | @end example | |
1193 | ||
735cc5ca CY |
1194 | @noindent |
1195 | Note that references to @code{foo} in @var{body} access the | |
b8d4c8d0 GM |
1196 | buffer-local binding of buffer @samp{b}. |
1197 | ||
1198 | When a file specifies local variable values, these become buffer-local | |
1199 | values when you visit the file. @xref{File Variables,,, emacs, The | |
1200 | GNU Emacs Manual}. | |
1201 | ||
c830e5ae CY |
1202 | A buffer-local variable cannot be made terminal-local |
1203 | (@pxref{Multiple Terminals}). | |
0f7766a4 | 1204 | |
b8d4c8d0 GM |
1205 | @node Creating Buffer-Local |
1206 | @subsection Creating and Deleting Buffer-Local Bindings | |
1207 | ||
1208 | @deffn Command make-local-variable variable | |
1209 | This function creates a buffer-local binding in the current buffer for | |
1210 | @var{variable} (a symbol). Other buffers are not affected. The value | |
1211 | returned is @var{variable}. | |
1212 | ||
b8d4c8d0 GM |
1213 | The buffer-local value of @var{variable} starts out as the same value |
1214 | @var{variable} previously had. If @var{variable} was void, it remains | |
1215 | void. | |
1216 | ||
1217 | @example | |
1218 | @group | |
1219 | ;; @r{In buffer @samp{b1}:} | |
1220 | (setq foo 5) ; @r{Affects all buffers.} | |
1221 | @result{} 5 | |
1222 | @end group | |
1223 | @group | |
1224 | (make-local-variable 'foo) ; @r{Now it is local in @samp{b1}.} | |
1225 | @result{} foo | |
1226 | @end group | |
1227 | @group | |
1228 | foo ; @r{That did not change} | |
1229 | @result{} 5 ; @r{the value.} | |
1230 | @end group | |
1231 | @group | |
1232 | (setq foo 6) ; @r{Change the value} | |
1233 | @result{} 6 ; @r{in @samp{b1}.} | |
1234 | @end group | |
1235 | @group | |
1236 | foo | |
1237 | @result{} 6 | |
1238 | @end group | |
1239 | ||
1240 | @group | |
1241 | ;; @r{In buffer @samp{b2}, the value hasn't changed.} | |
c57008f6 | 1242 | (with-current-buffer "b2" |
b8d4c8d0 GM |
1243 | foo) |
1244 | @result{} 5 | |
1245 | @end group | |
1246 | @end example | |
1247 | ||
1248 | Making a variable buffer-local within a @code{let}-binding for that | |
1249 | variable does not work reliably, unless the buffer in which you do this | |
1250 | is not current either on entry to or exit from the @code{let}. This is | |
1251 | because @code{let} does not distinguish between different kinds of | |
1252 | bindings; it knows only which variable the binding was made for. | |
1253 | ||
c830e5ae CY |
1254 | If the variable is terminal-local (@pxref{Multiple Terminals}), this |
1255 | function signals an error. Such variables cannot have buffer-local | |
1256 | bindings as well. | |
b8d4c8d0 GM |
1257 | |
1258 | @strong{Warning:} do not use @code{make-local-variable} for a hook | |
1259 | variable. The hook variables are automatically made buffer-local as | |
1260 | needed if you use the @var{local} argument to @code{add-hook} or | |
1261 | @code{remove-hook}. | |
1262 | @end deffn | |
1263 | ||
1264 | @deffn Command make-variable-buffer-local variable | |
1265 | This function marks @var{variable} (a symbol) automatically | |
1266 | buffer-local, so that any subsequent attempt to set it will make it | |
6a43ef8e CY |
1267 | local to the current buffer at the time. Unlike |
1268 | @code{make-local-variable}, with which it is often confused, this | |
1269 | cannot be undone, and affects the behavior of the variable in all | |
1270 | buffers. | |
b8d4c8d0 GM |
1271 | |
1272 | A peculiar wrinkle of this feature is that binding the variable (with | |
1273 | @code{let} or other binding constructs) does not create a buffer-local | |
1274 | binding for it. Only setting the variable (with @code{set} or | |
1275 | @code{setq}), while the variable does not have a @code{let}-style | |
1276 | binding that was made in the current buffer, does so. | |
1277 | ||
1278 | If @var{variable} does not have a default value, then calling this | |
1279 | command will give it a default value of @code{nil}. If @var{variable} | |
1280 | already has a default value, that value remains unchanged. | |
1281 | Subsequently calling @code{makunbound} on @var{variable} will result | |
1282 | in a void buffer-local value and leave the default value unaffected. | |
1283 | ||
1284 | The value returned is @var{variable}. | |
1285 | ||
1286 | @strong{Warning:} Don't assume that you should use | |
1287 | @code{make-variable-buffer-local} for user-option variables, simply | |
1288 | because users @emph{might} want to customize them differently in | |
1289 | different buffers. Users can make any variable local, when they wish | |
1290 | to. It is better to leave the choice to them. | |
1291 | ||
1292 | The time to use @code{make-variable-buffer-local} is when it is crucial | |
1293 | that no two buffers ever share the same binding. For example, when a | |
1294 | variable is used for internal purposes in a Lisp program which depends | |
1295 | on having separate values in separate buffers, then using | |
1296 | @code{make-variable-buffer-local} can be the best solution. | |
1297 | @end deffn | |
1298 | ||
1299 | @defun local-variable-p variable &optional buffer | |
1300 | This returns @code{t} if @var{variable} is buffer-local in buffer | |
1301 | @var{buffer} (which defaults to the current buffer); otherwise, | |
1302 | @code{nil}. | |
1303 | @end defun | |
1304 | ||
1305 | @defun local-variable-if-set-p variable &optional buffer | |
1a5432bc CY |
1306 | This returns @code{t} if @var{variable} either has a buffer-local |
1307 | value in buffer @var{buffer}, or is automatically buffer-local. | |
1308 | Otherwise, it returns @code{nil}. If omitted or @code{nil}, | |
1309 | @var{buffer} defaults to the current buffer. | |
b8d4c8d0 GM |
1310 | @end defun |
1311 | ||
1312 | @defun buffer-local-value variable buffer | |
1313 | This function returns the buffer-local binding of @var{variable} (a | |
1314 | symbol) in buffer @var{buffer}. If @var{variable} does not have a | |
1315 | buffer-local binding in buffer @var{buffer}, it returns the default | |
1316 | value (@pxref{Default Value}) of @var{variable} instead. | |
1317 | @end defun | |
1318 | ||
1319 | @defun buffer-local-variables &optional buffer | |
1320 | This function returns a list describing the buffer-local variables in | |
0992bd9c CY |
1321 | buffer @var{buffer}. (If @var{buffer} is omitted, the current buffer |
1322 | is used.) Normally, each list element has the form | |
1323 | @w{@code{(@var{sym} . @var{val})}}, where @var{sym} is a buffer-local | |
1324 | variable (a symbol) and @var{val} is its buffer-local value. But when | |
1325 | a variable's buffer-local binding in @var{buffer} is void, its list | |
1326 | element is just @var{sym}. | |
b8d4c8d0 GM |
1327 | |
1328 | @example | |
1329 | @group | |
1330 | (make-local-variable 'foobar) | |
1331 | (makunbound 'foobar) | |
1332 | (make-local-variable 'bind-me) | |
1333 | (setq bind-me 69) | |
1334 | @end group | |
1335 | (setq lcl (buffer-local-variables)) | |
1336 | ;; @r{First, built-in variables local in all buffers:} | |
1337 | @result{} ((mark-active . nil) | |
1338 | (buffer-undo-list . nil) | |
1339 | (mode-name . "Fundamental") | |
1340 | @dots{} | |
1341 | @group | |
1342 | ;; @r{Next, non-built-in buffer-local variables.} | |
1343 | ;; @r{This one is buffer-local and void:} | |
1344 | foobar | |
1345 | ;; @r{This one is buffer-local and nonvoid:} | |
1346 | (bind-me . 69)) | |
1347 | @end group | |
1348 | @end example | |
1349 | ||
1350 | Note that storing new values into the @sc{cdr}s of cons cells in this | |
1351 | list does @emph{not} change the buffer-local values of the variables. | |
1352 | @end defun | |
1353 | ||
1354 | @deffn Command kill-local-variable variable | |
1355 | This function deletes the buffer-local binding (if any) for | |
1356 | @var{variable} (a symbol) in the current buffer. As a result, the | |
1357 | default binding of @var{variable} becomes visible in this buffer. This | |
1358 | typically results in a change in the value of @var{variable}, since the | |
1359 | default value is usually different from the buffer-local value just | |
1360 | eliminated. | |
1361 | ||
1362 | If you kill the buffer-local binding of a variable that automatically | |
1363 | becomes buffer-local when set, this makes the default value visible in | |
1364 | the current buffer. However, if you set the variable again, that will | |
1365 | once again create a buffer-local binding for it. | |
1366 | ||
1367 | @code{kill-local-variable} returns @var{variable}. | |
1368 | ||
1369 | This function is a command because it is sometimes useful to kill one | |
1370 | buffer-local variable interactively, just as it is useful to create | |
1371 | buffer-local variables interactively. | |
1372 | @end deffn | |
1373 | ||
1374 | @defun kill-all-local-variables | |
1375 | This function eliminates all the buffer-local variable bindings of the | |
ee666f84 EZ |
1376 | current buffer except for variables marked as ``permanent'' and local |
1377 | hook functions that have a non-@code{nil} @code{permanent-local-hook} | |
1378 | property (@pxref{Setting Hooks}). As a result, the buffer will see | |
1379 | the default values of most variables. | |
b8d4c8d0 GM |
1380 | |
1381 | This function also resets certain other information pertaining to the | |
1382 | buffer: it sets the local keymap to @code{nil}, the syntax table to the | |
1383 | value of @code{(standard-syntax-table)}, the case table to | |
1384 | @code{(standard-case-table)}, and the abbrev table to the value of | |
1385 | @code{fundamental-mode-abbrev-table}. | |
1386 | ||
1387 | The very first thing this function does is run the normal hook | |
1388 | @code{change-major-mode-hook} (see below). | |
1389 | ||
1390 | Every major mode command begins by calling this function, which has the | |
1391 | effect of switching to Fundamental mode and erasing most of the effects | |
1392 | of the previous major mode. To ensure that this does its job, the | |
1393 | variables that major modes set should not be marked permanent. | |
1394 | ||
1395 | @code{kill-all-local-variables} returns @code{nil}. | |
1396 | @end defun | |
1397 | ||
1398 | @defvar change-major-mode-hook | |
1399 | The function @code{kill-all-local-variables} runs this normal hook | |
1400 | before it does anything else. This gives major modes a way to arrange | |
1401 | for something special to be done if the user switches to a different | |
1402 | major mode. It is also useful for buffer-specific minor modes | |
1403 | that should be forgotten if the user changes the major mode. | |
1404 | ||
1405 | For best results, make this variable buffer-local, so that it will | |
1406 | disappear after doing its job and will not interfere with the | |
1407 | subsequent major mode. @xref{Hooks}. | |
1408 | @end defvar | |
1409 | ||
1410 | @c Emacs 19 feature | |
1411 | @cindex permanent local variable | |
1412 | A buffer-local variable is @dfn{permanent} if the variable name (a | |
1413 | symbol) has a @code{permanent-local} property that is non-@code{nil}. | |
86ec878a EZ |
1414 | Such variables are unaffected by @code{kill-all-local-variables}, and |
1415 | their local bindings are therefore not cleared by changing major modes. | |
b8d4c8d0 GM |
1416 | Permanent locals are appropriate for data pertaining to where the file |
1417 | came from or how to save it, rather than with how to edit the contents. | |
1418 | ||
1419 | @node Default Value | |
1420 | @subsection The Default Value of a Buffer-Local Variable | |
1421 | @cindex default value | |
1422 | ||
1423 | The global value of a variable with buffer-local bindings is also | |
1424 | called the @dfn{default} value, because it is the value that is in | |
1425 | effect whenever neither the current buffer nor the selected frame has | |
1426 | its own binding for the variable. | |
1427 | ||
1428 | The functions @code{default-value} and @code{setq-default} access and | |
1429 | change a variable's default value regardless of whether the current | |
1430 | buffer has a buffer-local binding. For example, you could use | |
1431 | @code{setq-default} to change the default setting of | |
1432 | @code{paragraph-start} for most buffers; and this would work even when | |
1433 | you are in a C or Lisp mode buffer that has a buffer-local value for | |
1434 | this variable. | |
1435 | ||
1436 | @c Emacs 19 feature | |
1437 | The special forms @code{defvar} and @code{defconst} also set the | |
1438 | default value (if they set the variable at all), rather than any | |
e388c68f | 1439 | buffer-local value. |
b8d4c8d0 GM |
1440 | |
1441 | @defun default-value symbol | |
1442 | This function returns @var{symbol}'s default value. This is the value | |
1443 | that is seen in buffers and frames that do not have their own values for | |
1444 | this variable. If @var{symbol} is not buffer-local, this is equivalent | |
1445 | to @code{symbol-value} (@pxref{Accessing Variables}). | |
1446 | @end defun | |
1447 | ||
1448 | @c Emacs 19 feature | |
1449 | @defun default-boundp symbol | |
1450 | The function @code{default-boundp} tells you whether @var{symbol}'s | |
1451 | default value is nonvoid. If @code{(default-boundp 'foo)} returns | |
1452 | @code{nil}, then @code{(default-value 'foo)} would get an error. | |
1453 | ||
1454 | @code{default-boundp} is to @code{default-value} as @code{boundp} is to | |
1455 | @code{symbol-value}. | |
1456 | @end defun | |
1457 | ||
1458 | @defspec setq-default [symbol form]@dots{} | |
1459 | This special form gives each @var{symbol} a new default value, which is | |
1460 | the result of evaluating the corresponding @var{form}. It does not | |
1461 | evaluate @var{symbol}, but does evaluate @var{form}. The value of the | |
1462 | @code{setq-default} form is the value of the last @var{form}. | |
1463 | ||
1464 | If a @var{symbol} is not buffer-local for the current buffer, and is not | |
1465 | marked automatically buffer-local, @code{setq-default} has the same | |
1466 | effect as @code{setq}. If @var{symbol} is buffer-local for the current | |
1467 | buffer, then this changes the value that other buffers will see (as long | |
1468 | as they don't have a buffer-local value), but not the value that the | |
1469 | current buffer sees. | |
1470 | ||
1471 | @example | |
1472 | @group | |
1473 | ;; @r{In buffer @samp{foo}:} | |
1474 | (make-local-variable 'buffer-local) | |
1475 | @result{} buffer-local | |
1476 | @end group | |
1477 | @group | |
1478 | (setq buffer-local 'value-in-foo) | |
1479 | @result{} value-in-foo | |
1480 | @end group | |
1481 | @group | |
1482 | (setq-default buffer-local 'new-default) | |
1483 | @result{} new-default | |
1484 | @end group | |
1485 | @group | |
1486 | buffer-local | |
1487 | @result{} value-in-foo | |
1488 | @end group | |
1489 | @group | |
1490 | (default-value 'buffer-local) | |
1491 | @result{} new-default | |
1492 | @end group | |
1493 | ||
1494 | @group | |
1495 | ;; @r{In (the new) buffer @samp{bar}:} | |
1496 | buffer-local | |
1497 | @result{} new-default | |
1498 | @end group | |
1499 | @group | |
1500 | (default-value 'buffer-local) | |
1501 | @result{} new-default | |
1502 | @end group | |
1503 | @group | |
1504 | (setq buffer-local 'another-default) | |
1505 | @result{} another-default | |
1506 | @end group | |
1507 | @group | |
1508 | (default-value 'buffer-local) | |
1509 | @result{} another-default | |
1510 | @end group | |
1511 | ||
1512 | @group | |
1513 | ;; @r{Back in buffer @samp{foo}:} | |
1514 | buffer-local | |
1515 | @result{} value-in-foo | |
1516 | (default-value 'buffer-local) | |
1517 | @result{} another-default | |
1518 | @end group | |
1519 | @end example | |
1520 | @end defspec | |
1521 | ||
1522 | @defun set-default symbol value | |
1523 | This function is like @code{setq-default}, except that @var{symbol} is | |
1524 | an ordinary evaluated argument. | |
1525 | ||
1526 | @example | |
1527 | @group | |
1528 | (set-default (car '(a b c)) 23) | |
1529 | @result{} 23 | |
1530 | @end group | |
1531 | @group | |
1532 | (default-value 'a) | |
1533 | @result{} 23 | |
1534 | @end group | |
1535 | @end example | |
1536 | @end defun | |
1537 | ||
b8d4c8d0 GM |
1538 | @node File Local Variables |
1539 | @section File Local Variables | |
1540 | @cindex file local variables | |
1541 | ||
1542 | A file can specify local variable values; Emacs uses these to create | |
1543 | buffer-local bindings for those variables in the buffer visiting that | |
1544 | file. @xref{File variables, , Local Variables in Files, emacs, The | |
32770114 CY |
1545 | GNU Emacs Manual}, for basic information about file-local variables. |
1546 | This section describes the functions and variables that affect how | |
1547 | file-local variables are processed. | |
1548 | ||
1549 | If a file-local variable could specify an arbitrary function or Lisp | |
1550 | expression that would be called later, visiting a file could take over | |
1551 | your Emacs. Emacs protects against this by automatically setting only | |
1552 | those file-local variables whose specified values are known to be | |
1553 | safe. Other file-local variables are set only if the user agrees. | |
b8d4c8d0 | 1554 | |
dd449674 CY |
1555 | For additional safety, @code{read-circle} is temporarily bound to |
1556 | @code{nil} when Emacs reads file-local variables (@pxref{Input | |
1557 | Functions}). This prevents the Lisp reader from recognizing circular | |
1558 | and shared Lisp structures (@pxref{Circular Objects}). | |
1559 | ||
b8d4c8d0 | 1560 | @defopt enable-local-variables |
32770114 | 1561 | This variable controls whether to process file-local variables. |
b8d4c8d0 GM |
1562 | The possible values are: |
1563 | ||
1564 | @table @asis | |
1565 | @item @code{t} (the default) | |
1566 | Set the safe variables, and query (once) about any unsafe variables. | |
1567 | @item @code{:safe} | |
1568 | Set only the safe variables and do not query. | |
1569 | @item @code{:all} | |
1570 | Set all the variables and do not query. | |
1571 | @item @code{nil} | |
1572 | Don't set any variables. | |
1573 | @item anything else | |
1574 | Query (once) about all the variables. | |
1575 | @end table | |
1576 | @end defopt | |
1577 | ||
61086eb6 GM |
1578 | @defvar inhibit-local-variables-regexps |
1579 | This is a list of regular expressions. If a file has a name | |
1580 | matching an element of this list, then it is not scanned for | |
1581 | any form of file-local variable. For examples of why you might want | |
1582 | to use this, @pxref{Auto Major Mode}. | |
1583 | @end defvar | |
1584 | ||
b8d4c8d0 GM |
1585 | @defun hack-local-variables &optional mode-only |
1586 | This function parses, and binds or evaluates as appropriate, any local | |
1587 | variables specified by the contents of the current buffer. The variable | |
1588 | @code{enable-local-variables} has its effect here. However, this | |
1589 | function does not look for the @samp{mode:} local variable in the | |
1590 | @w{@samp{-*-}} line. @code{set-auto-mode} does that, also taking | |
1591 | @code{enable-local-variables} into account (@pxref{Auto Major Mode}). | |
1592 | ||
291703b5 | 1593 | This function works by walking the alist stored in |
3a57591a | 1594 | @code{file-local-variables-alist} and applying each local variable in |
291703b5 EZ |
1595 | turn. It calls @code{before-hack-local-variables-hook} and |
1596 | @code{hack-local-variables-hook} before and after applying the | |
2d3ba9e7 GM |
1597 | variables, respectively. It only calls the before-hook if the alist |
1598 | is non-@code{nil}; it always calls the other hook. This | |
1599 | function ignores a @samp{mode} element if it specifies the same major | |
1600 | mode as the buffer already has. | |
291703b5 | 1601 | |
b8d4c8d0 | 1602 | If the optional argument @var{mode-only} is non-@code{nil}, then all |
eafed945 GM |
1603 | this function does is return a symbol specifying the major mode, |
1604 | if the @w{@samp{-*-}} line or the local variables list specifies one, | |
1605 | and @code{nil} otherwise. It does not set the mode nor any other | |
1606 | file-local variable. | |
b8d4c8d0 GM |
1607 | @end defun |
1608 | ||
291703b5 EZ |
1609 | @defvar file-local-variables-alist |
1610 | This buffer-local variable holds the alist of file-local variable | |
1611 | settings. Each element of the alist is of the form | |
1612 | @w{@code{(@var{var} . @var{value})}}, where @var{var} is a symbol of | |
1613 | the local variable and @var{value} is its value. When Emacs visits a | |
1614 | file, it first collects all the file-local variables into this alist, | |
1615 | and then the @code{hack-local-variables} function applies them one by | |
1616 | one. | |
1617 | @end defvar | |
1618 | ||
1619 | @defvar before-hack-local-variables-hook | |
1620 | Emacs calls this hook immediately before applying file-local variables | |
1621 | stored in @code{file-local-variables-alist}. | |
1622 | @end defvar | |
1623 | ||
1624 | @defvar hack-local-variables-hook | |
1625 | Emacs calls this hook immediately after it finishes applying | |
1626 | file-local variables stored in @code{file-local-variables-alist}. | |
1627 | @end defvar | |
1628 | ||
b8d4c8d0 GM |
1629 | @cindex safe local variable |
1630 | You can specify safe values for a variable with a | |
32770114 CY |
1631 | @code{safe-local-variable} property. The property has to be a |
1632 | function of one argument; any value is safe if the function returns | |
1633 | non-@code{nil} given that value. Many commonly-encountered file | |
1634 | variables have @code{safe-local-variable} properties; these include | |
1635 | @code{fill-column}, @code{fill-prefix}, and @code{indent-tabs-mode}. | |
1636 | For boolean-valued variables that are safe, use @code{booleanp} as the | |
1637 | property value. Lambda expressions should be quoted so that | |
1638 | @code{describe-variable} can display the predicate. | |
b8d4c8d0 | 1639 | |
735cc5ca CY |
1640 | When defining a user option using @code{defcustom}, you can set its |
1641 | @code{safe-local-variable} property by adding the arguments | |
1642 | @code{:safe @var{function}} to @code{defcustom} (@pxref{Variable | |
1643 | Definitions}). | |
1644 | ||
b8d4c8d0 GM |
1645 | @defopt safe-local-variable-values |
1646 | This variable provides another way to mark some variable values as | |
1647 | safe. It is a list of cons cells @code{(@var{var} . @var{val})}, | |
1648 | where @var{var} is a variable name and @var{val} is a value which is | |
1649 | safe for that variable. | |
1650 | ||
32770114 | 1651 | When Emacs asks the user whether or not to obey a set of file-local |
b8d4c8d0 GM |
1652 | variable specifications, the user can choose to mark them as safe. |
1653 | Doing so adds those variable/value pairs to | |
1654 | @code{safe-local-variable-values}, and saves it to the user's custom | |
1655 | file. | |
1656 | @end defopt | |
1657 | ||
1658 | @defun safe-local-variable-p sym val | |
1659 | This function returns non-@code{nil} if it is safe to give @var{sym} | |
1660 | the value @var{val}, based on the above criteria. | |
1661 | @end defun | |
1662 | ||
1663 | @c @cindex risky local variable Duplicates risky-local-variable | |
735cc5ca CY |
1664 | Some variables are considered @dfn{risky}. If a variable is risky, |
1665 | it is never entered automatically into | |
1666 | @code{safe-local-variable-values}; Emacs always queries before setting | |
1667 | a risky variable, unless the user explicitly allows a value by | |
1668 | customizing @code{safe-local-variable-values} directly. | |
1669 | ||
1670 | Any variable whose name has a non-@code{nil} | |
1671 | @code{risky-local-variable} property is considered risky. When you | |
1672 | define a user option using @code{defcustom}, you can set its | |
1673 | @code{risky-local-variable} property by adding the arguments | |
1674 | @code{:risky @var{value}} to @code{defcustom} (@pxref{Variable | |
1675 | Definitions}). In addition, any variable whose name ends in any of | |
1676 | @samp{-command}, @samp{-frame-alist}, @samp{-function}, | |
b8d4c8d0 GM |
1677 | @samp{-functions}, @samp{-hook}, @samp{-hooks}, @samp{-form}, |
1678 | @samp{-forms}, @samp{-map}, @samp{-map-alist}, @samp{-mode-alist}, | |
735cc5ca CY |
1679 | @samp{-program}, or @samp{-predicate} is automatically considered |
1680 | risky. The variables @samp{font-lock-keywords}, | |
1681 | @samp{font-lock-keywords} followed by a digit, and | |
1682 | @samp{font-lock-syntactic-keywords} are also considered risky. | |
b8d4c8d0 GM |
1683 | |
1684 | @defun risky-local-variable-p sym | |
1685 | This function returns non-@code{nil} if @var{sym} is a risky variable, | |
1686 | based on the above criteria. | |
1687 | @end defun | |
1688 | ||
b8d4c8d0 GM |
1689 | @defvar ignored-local-variables |
1690 | This variable holds a list of variables that should not be given local | |
1691 | values by files. Any value specified for one of these variables is | |
1692 | completely ignored. | |
1693 | @end defvar | |
1694 | ||
1695 | The @samp{Eval:} ``variable'' is also a potential loophole, so Emacs | |
1696 | normally asks for confirmation before handling it. | |
1697 | ||
1698 | @defopt enable-local-eval | |
1699 | This variable controls processing of @samp{Eval:} in @samp{-*-} lines | |
1700 | or local variables | |
1701 | lists in files being visited. A value of @code{t} means process them | |
1702 | unconditionally; @code{nil} means ignore them; anything else means ask | |
1703 | the user what to do for each file. The default value is @code{maybe}. | |
1704 | @end defopt | |
1705 | ||
1706 | @defopt safe-local-eval-forms | |
1707 | This variable holds a list of expressions that are safe to | |
1708 | evaluate when found in the @samp{Eval:} ``variable'' in a file | |
1709 | local variables list. | |
1710 | @end defopt | |
1711 | ||
1712 | If the expression is a function call and the function has a | |
1713 | @code{safe-local-eval-function} property, the property value | |
1714 | determines whether the expression is safe to evaluate. The property | |
1715 | value can be a predicate to call to test the expression, a list of | |
1716 | such predicates (it's safe if any predicate succeeds), or @code{t} | |
1717 | (always safe provided the arguments are constant). | |
1718 | ||
1719 | Text properties are also potential loopholes, since their values | |
1720 | could include functions to call. So Emacs discards all text | |
32770114 | 1721 | properties from string values specified for file-local variables. |
b8d4c8d0 | 1722 | |
eb22b78c EZ |
1723 | @node Directory Local Variables |
1724 | @section Directory Local Variables | |
1725 | @cindex directory local variables | |
1726 | ||
1727 | A directory can specify local variable values common to all files in | |
1728 | that directory; Emacs uses these to create buffer-local bindings for | |
1729 | those variables in buffers visiting any file in that directory. This | |
1730 | is useful when the files in the directory belong to some @dfn{project} | |
1731 | and therefore share the same local variables. | |
1732 | ||
1733 | There are two different methods for specifying directory local | |
1734 | variables: by putting them in a special file, or by defining a | |
1735 | @dfn{project class} for that directory. | |
1736 | ||
1737 | @defvr Constant dir-locals-file | |
1738 | This constant is the name of the file where Emacs expects to find the | |
1739 | directory-local variables. The name of the file is | |
1740 | @file{.dir-locals.el}@footnote{ | |
1741 | The MS-DOS version of Emacs uses @file{_dir-locals.el} instead, due to | |
1742 | limitations of the DOS filesystems. | |
1743 | }. A file by that name in a directory causes Emacs to apply its | |
6640b281 GM |
1744 | settings to any file in that directory or any of its subdirectories |
1745 | (optionally, you can exclude subdirectories; see below). | |
eb22b78c EZ |
1746 | If some of the subdirectories have their own @file{.dir-locals.el} |
1747 | files, Emacs uses the settings from the deepest file it finds starting | |
1748 | from the file's directory and moving up the directory tree. The file | |
1749 | specifies local variables as a specially formatted list; see | |
1750 | @ref{Directory Variables, , Per-directory Local Variables, emacs, The | |
1751 | GNU Emacs Manual}, for more details. | |
1752 | @end defvr | |
1753 | ||
1754 | @defun hack-dir-local-variables | |
1755 | This function reads the @code{.dir-locals.el} file and stores the | |
1756 | directory-local variables in @code{file-local-variables-alist} that is | |
1757 | local to the buffer visiting any file in the directory, without | |
1758 | applying them. It also stores the directory-local settings in | |
1759 | @code{dir-locals-class-alist}, where it defines a special class for | |
1760 | the directory in which @file{.dir-locals.el} file was found. This | |
1761 | function works by calling @code{dir-locals-set-class-variables} and | |
1762 | @code{dir-locals-set-directory-class}, described below. | |
1763 | @end defun | |
1764 | ||
89bd9ccd CY |
1765 | @defun hack-dir-local-variables-non-file-buffer |
1766 | This function looks for directory-local variables, and immediately | |
1767 | applies them in the current buffer. It is intended to be called in | |
1768 | the mode commands for non-file buffers, such as Dired buffers, to let | |
1769 | them obey directory-local variable settings. For non-file buffers, | |
1770 | Emacs looks for directory-local variables in @code{default-directory} | |
1771 | and its parent directories. | |
1772 | @end defun | |
1773 | ||
eb22b78c EZ |
1774 | @defun dir-locals-set-class-variables class variables |
1775 | This function defines a set of variable settings for the named | |
1776 | @var{class}, which is a symbol. You can later assign the class to one | |
1777 | or more directories, and Emacs will apply those variable settings to | |
1778 | all files in those directories. The list in @var{variables} can be of | |
1779 | one of the two forms: @code{(@var{major-mode} . @var{alist})} or | |
1780 | @code{(@var{directory} . @var{list})}. With the first form, if the | |
1781 | file's buffer turns on a mode that is derived from @var{major-mode}, | |
1782 | then the all the variables in the associated @var{alist} are applied; | |
1783 | @var{alist} should be of the form @code{(@var{name} . @var{value})}. | |
1784 | A special value @code{nil} for @var{major-mode} means the settings are | |
6640b281 GM |
1785 | applicable to any mode. In @var{alist}, you can use a special |
1786 | @var{name}: @code{subdirs}. If the associated value is | |
1787 | @code{nil}, the alist is only applied to files in the relevant | |
1788 | directory, not to those in any subdirectories. | |
eb22b78c EZ |
1789 | |
1790 | With the second form of @var{variables}, if @var{directory} is the | |
1791 | initial substring of the file's directory, then @var{list} is applied | |
1792 | recursively by following the above rules; @var{list} should be of one | |
1793 | of the two forms accepted by this function in @var{variables}. | |
1794 | @end defun | |
1795 | ||
081f7640 | 1796 | @defun dir-locals-set-directory-class directory class &optional mtime |
eb22b78c EZ |
1797 | This function assigns @var{class} to all the files in @code{directory} |
1798 | and its subdirectories. Thereafter, all the variable settings | |
1799 | specified for @var{class} will be applied to any visited file in | |
1800 | @var{directory} and its children. @var{class} must have been already | |
081f7640 GM |
1801 | defined by @code{dir-locals-set-class-variables}. |
1802 | ||
1803 | Emacs uses this function internally when it loads directory variables | |
1804 | from a @code{.dir-locals.el} file. In that case, the optional | |
1805 | argument @var{mtime} holds the file modification time (as returned by | |
1806 | @code{file-attributes}). Emacs uses this time to check stored | |
1807 | local variables are still valid. If you are assigning a class | |
1808 | directly, not via a file, this argument should be @code{nil}. | |
eb22b78c EZ |
1809 | @end defun |
1810 | ||
1811 | @defvar dir-locals-class-alist | |
1812 | This alist holds the class symbols and the associated variable | |
1813 | settings. It is updated by @code{dir-locals-set-class-variables}. | |
1814 | @end defvar | |
1815 | ||
d259fc4b GM |
1816 | @defvar dir-locals-directory-cache |
1817 | This alist holds directory names, their assigned class names, and | |
081f7640 GM |
1818 | modification times of the associated directory local variables file |
1819 | (if there is one). The function @code{dir-locals-set-directory-class} | |
1820 | updates this list. | |
eb22b78c EZ |
1821 | @end defvar |
1822 | ||
b8d4c8d0 GM |
1823 | @node Variable Aliases |
1824 | @section Variable Aliases | |
1825 | @cindex variable aliases | |
1826 | ||
1827 | It is sometimes useful to make two variables synonyms, so that both | |
1828 | variables always have the same value, and changing either one also | |
1829 | changes the other. Whenever you change the name of a | |
1830 | variable---either because you realize its old name was not well | |
1831 | chosen, or because its meaning has partly changed---it can be useful | |
1832 | to keep the old name as an @emph{alias} of the new one for | |
1833 | compatibility. You can do this with @code{defvaralias}. | |
1834 | ||
1835 | @defun defvaralias new-alias base-variable &optional docstring | |
1836 | This function defines the symbol @var{new-alias} as a variable alias | |
1837 | for symbol @var{base-variable}. This means that retrieving the value | |
1838 | of @var{new-alias} returns the value of @var{base-variable}, and | |
1839 | changing the value of @var{new-alias} changes the value of | |
1840 | @var{base-variable}. The two aliased variable names always share the | |
1841 | same value and the same bindings. | |
1842 | ||
1843 | If the @var{docstring} argument is non-@code{nil}, it specifies the | |
1844 | documentation for @var{new-alias}; otherwise, the alias gets the same | |
1845 | documentation as @var{base-variable} has, if any, unless | |
1846 | @var{base-variable} is itself an alias, in which case @var{new-alias} gets | |
1847 | the documentation of the variable at the end of the chain of aliases. | |
1848 | ||
1849 | This function returns @var{base-variable}. | |
1850 | @end defun | |
1851 | ||
1852 | Variable aliases are convenient for replacing an old name for a | |
1853 | variable with a new name. @code{make-obsolete-variable} declares that | |
1854 | the old name is obsolete and therefore that it may be removed at some | |
1855 | stage in the future. | |
1856 | ||
27d1f87a | 1857 | @defun make-obsolete-variable obsolete-name current-name when &optional access-type |
fc997332 | 1858 | This function makes the byte compiler warn that the variable |
27d1f87a CY |
1859 | @var{obsolete-name} is obsolete. If @var{current-name} is a symbol, |
1860 | it is the variable's new name; then the warning message says to use | |
1861 | @var{current-name} instead of @var{obsolete-name}. If | |
1862 | @var{current-name} is a string, this is the message and there is no | |
1863 | replacement variable. @var{when} should be a string indicating when | |
1864 | the variable was first made obsolete (usually a version number | |
1865 | string). | |
1866 | ||
1867 | The optional argument @var{access-type}, if non-@code{nil}, should | |
1868 | should specify the kind of access that will trigger obsolescence | |
1869 | warnings; it can be either @code{get} or @code{set}. | |
b8d4c8d0 GM |
1870 | @end defun |
1871 | ||
1872 | You can make two variables synonyms and declare one obsolete at the | |
1873 | same time using the macro @code{define-obsolete-variable-alias}. | |
1874 | ||
1875 | @defmac define-obsolete-variable-alias obsolete-name current-name &optional when docstring | |
1876 | This macro marks the variable @var{obsolete-name} as obsolete and also | |
1877 | makes it an alias for the variable @var{current-name}. It is | |
1878 | equivalent to the following: | |
1879 | ||
1880 | @example | |
1881 | (defvaralias @var{obsolete-name} @var{current-name} @var{docstring}) | |
1882 | (make-obsolete-variable @var{obsolete-name} @var{current-name} @var{when}) | |
1883 | @end example | |
1884 | @end defmac | |
1885 | ||
1886 | @defun indirect-variable variable | |
1887 | This function returns the variable at the end of the chain of aliases | |
1888 | of @var{variable}. If @var{variable} is not a symbol, or if @var{variable} is | |
1889 | not defined as an alias, the function returns @var{variable}. | |
1890 | ||
1891 | This function signals a @code{cyclic-variable-indirection} error if | |
1892 | there is a loop in the chain of symbols. | |
1893 | @end defun | |
1894 | ||
1895 | @example | |
1896 | (defvaralias 'foo 'bar) | |
1897 | (indirect-variable 'foo) | |
1898 | @result{} bar | |
1899 | (indirect-variable 'bar) | |
1900 | @result{} bar | |
1901 | (setq bar 2) | |
1902 | bar | |
1903 | @result{} 2 | |
1904 | @group | |
1905 | foo | |
1906 | @result{} 2 | |
1907 | @end group | |
1908 | (setq foo 0) | |
1909 | bar | |
1910 | @result{} 0 | |
1911 | foo | |
1912 | @result{} 0 | |
1913 | @end example | |
1914 | ||
1915 | @node Variables with Restricted Values | |
1916 | @section Variables with Restricted Values | |
1917 | ||
1918 | Ordinary Lisp variables can be assigned any value that is a valid | |
1919 | Lisp object. However, certain Lisp variables are not defined in Lisp, | |
1920 | but in C. Most of these variables are defined in the C code using | |
1921 | @code{DEFVAR_LISP}. Like variables defined in Lisp, these can take on | |
1922 | any value. However, some variables are defined using | |
1923 | @code{DEFVAR_INT} or @code{DEFVAR_BOOL}. @xref{Defining Lisp | |
1924 | variables in C,, Writing Emacs Primitives}, in particular the | |
1925 | description of functions of the type @code{syms_of_@var{filename}}, | |
1926 | for a brief discussion of the C implementation. | |
1927 | ||
1928 | Variables of type @code{DEFVAR_BOOL} can only take on the values | |
1929 | @code{nil} or @code{t}. Attempting to assign them any other value | |
1930 | will set them to @code{t}: | |
1931 | ||
1932 | @example | |
1933 | (let ((display-hourglass 5)) | |
1934 | display-hourglass) | |
1935 | @result{} t | |
1936 | @end example | |
1937 | ||
1938 | @defvar byte-boolean-vars | |
1939 | This variable holds a list of all variables of type @code{DEFVAR_BOOL}. | |
1940 | @end defvar | |
1941 | ||
1942 | Variables of type @code{DEFVAR_INT} can only take on integer values. | |
1943 | Attempting to assign them any other value will result in an error: | |
1944 | ||
1945 | @example | |
9022ae07 JB |
1946 | (setq undo-limit 1000.0) |
1947 | @error{} Wrong type argument: integerp, 1000.0 | |
b8d4c8d0 | 1948 | @end example |