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