Mercurial > emacs
annotate lispref/variables.texi @ 12800:1086fa1dfb89
(read_key_sequence): Undo previous change.
Instead, put back the orig_uppercase event if key is not defined.
When downcasing, back up one step in key-translation processing.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Tue, 08 Aug 1995 05:12:31 +0000 |
parents | a6eb5f12b0f3 |
children | 74615e68b2cd |
rev | line source |
---|---|
6510 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc. | |
4 @c See the file elisp.texi for copying conditions. | |
5 @setfilename ../info/variables | |
6 @node Variables, Functions, Control Structures, Top | |
7 @chapter Variables | |
8 @cindex variable | |
9 | |
10 A @dfn{variable} is a name used in a program to stand for a value. | |
11 Nearly all programming languages have variables of some sort. In the | |
12 text of a Lisp program, variables are written using the syntax for | |
13 symbols. | |
14 | |
15 In Lisp, unlike most programming languages, programs are represented | |
16 primarily as Lisp objects and only secondarily as text. The Lisp | |
17 objects used for variables are symbols: the symbol name is the variable | |
18 name, and the variable's value is stored in the value cell of the | |
19 symbol. The use of a symbol as a variable is independent of its use as | |
20 a function name. @xref{Symbol Components}. | |
21 | |
22 The Lisp objects that constitute a Lisp program determine the textual | |
7194
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
23 form of the program---it is simply the read syntax for those Lisp |
6510 | 24 objects. This is why, for example, a variable in a textual Lisp program |
25 is written using the read syntax for the symbol that represents the | |
26 variable. | |
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 * Accessing Variables:: Examining values of variables whose names | |
35 are known only at run time. | |
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 @end menu | |
40 | |
41 @node Global Variables | |
42 @section Global Variables | |
43 @cindex global variable | |
44 | |
45 The simplest way to use a variable is @dfn{globally}. This means that | |
46 the variable has just one value at a time, and this value is in effect | |
47 (at least for the moment) throughout the Lisp system. The value remains | |
48 in effect until you specify a new one. When a new value replaces the | |
49 old one, no trace of the old value remains in the variable. | |
50 | |
51 You specify a value for a symbol with @code{setq}. For example, | |
52 | |
53 @example | |
54 (setq x '(a b)) | |
55 @end example | |
56 | |
57 @noindent | |
58 gives the variable @code{x} the value @code{(a b)}. Note that | |
59 @code{setq} does not evaluate its first argument, the name of the | |
60 variable, but it does evaluate the second argument, the new value. | |
61 | |
62 Once the variable has a value, you can refer to it by using the symbol | |
63 by itself as an expression. Thus, | |
64 | |
65 @example | |
66 @group | |
67 x @result{} (a b) | |
68 @end group | |
69 @end example | |
70 | |
71 @noindent | |
72 assuming the @code{setq} form shown above has already been executed. | |
73 | |
74 If you do another @code{setq}, the new value replaces the old one: | |
75 | |
76 @example | |
77 @group | |
78 x | |
79 @result{} (a b) | |
80 @end group | |
81 @group | |
82 (setq x 4) | |
83 @result{} 4 | |
84 @end group | |
85 @group | |
86 x | |
87 @result{} 4 | |
88 @end group | |
89 @end example | |
90 | |
91 @node Constant Variables | |
92 @section Variables That Never Change | |
93 @vindex nil | |
94 @vindex t | |
95 @kindex setting-constant | |
96 | |
97 Emacs Lisp has two special symbols, @code{nil} and @code{t}, that | |
98 always evaluate to themselves. These symbols cannot be rebound, nor can | |
99 their value cells be changed. An attempt to change the value of | |
100 @code{nil} or @code{t} signals a @code{setting-constant} error. | |
101 | |
102 @example | |
103 @group | |
104 nil @equiv{} 'nil | |
105 @result{} nil | |
106 @end group | |
107 @group | |
108 (setq nil 500) | |
109 @error{} Attempt to set constant symbol: nil | |
110 @end group | |
111 @end example | |
112 | |
113 @node Local Variables | |
114 @section Local Variables | |
115 @cindex binding local variables | |
116 @cindex local variables | |
117 @cindex local binding | |
118 @cindex global binding | |
119 | |
120 Global variables have values that last until explicitly superseded | |
121 with new values. Sometimes it is useful to create variable values that | |
122 exist temporarily---only while within a certain part of the program. | |
123 These values are called @dfn{local}, and the variables so used are | |
124 called @dfn{local variables}. | |
125 | |
126 For example, when a function is called, its argument variables receive | |
127 new local values that last until the function exits. The @code{let} | |
128 special form explicitly establishes new local values for specified | |
129 variables; these last until exit from the @code{let} form. | |
130 | |
131 @cindex shadowing of variables | |
132 Establishing a local value saves away the previous value (or lack of | |
133 one) of the variable. When the life span of the local value is over, | |
134 the previous value is restored. In the mean time, we say that the | |
135 previous value is @dfn{shadowed} and @dfn{not visible}. Both global and | |
136 local values may be shadowed (@pxref{Scope}). | |
137 | |
138 If you set a variable (such as with @code{setq}) while it is local, | |
139 this replaces the local value; it does not alter the global value, or | |
140 previous local values that are shadowed. To model this behavior, we | |
141 speak of a @dfn{local binding} of the variable as well as a local value. | |
142 | |
143 The local binding is a conceptual place that holds a local value. | |
144 Entry to a function, or a special form such as @code{let}, creates the | |
145 local binding; exit from the function or from the @code{let} removes the | |
146 local binding. As long as the local binding lasts, the variable's value | |
147 is stored within it. Use of @code{setq} or @code{set} while there is a | |
148 local binding stores a different value into the local binding; it does | |
149 not create a new binding. | |
150 | |
151 We also speak of the @dfn{global binding}, which is where | |
152 (conceptually) the global value is kept. | |
153 | |
154 @cindex current binding | |
155 A variable can have more than one local binding at a time (for | |
156 example, if there are nested @code{let} forms that bind it). In such a | |
157 case, the most recently created local binding that still exists is the | |
158 @dfn{current binding} of the variable. (This is called @dfn{dynamic | |
159 scoping}; see @ref{Variable Scoping}.) If there are no local bindings, | |
160 the variable's global binding is its current binding. We also call the | |
161 current binding the @dfn{most-local existing binding}, for emphasis. | |
162 Ordinary evaluation of a symbol always returns the value of its current | |
163 binding. | |
164 | |
165 The special forms @code{let} and @code{let*} exist to create | |
166 local bindings. | |
167 | |
168 @defspec let (bindings@dots{}) forms@dots{} | |
7194
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
169 This special form binds variables according to @var{bindings} and then |
6510 | 170 evaluates all of the @var{forms} in textual order. The @code{let}-form |
171 returns the value of the last form in @var{forms}. | |
172 | |
173 Each of the @var{bindings} is either @w{(i) a} symbol, in which case | |
174 that symbol is bound to @code{nil}; or @w{(ii) a} list of the form | |
175 @code{(@var{symbol} @var{value-form})}, in which case @var{symbol} is | |
176 bound to the result of evaluating @var{value-form}. If @var{value-form} | |
177 is omitted, @code{nil} is used. | |
178 | |
179 All of the @var{value-form}s in @var{bindings} are evaluated in the | |
180 order they appear and @emph{before} any of the symbols are bound. Here | |
181 is an example of this: @code{Z} is bound to the old value of @code{Y}, | |
182 which is 2, not the new value, 1. | |
183 | |
184 @example | |
185 @group | |
186 (setq Y 2) | |
187 @result{} 2 | |
188 @end group | |
189 @group | |
190 (let ((Y 1) | |
191 (Z Y)) | |
192 (list Y Z)) | |
193 @result{} (1 2) | |
194 @end group | |
195 @end example | |
196 @end defspec | |
197 | |
198 @defspec let* (bindings@dots{}) forms@dots{} | |
199 This special form is like @code{let}, but it binds each variable right | |
200 after computing its local value, before computing the local value for | |
201 the next variable. Therefore, an expression in @var{bindings} can | |
202 reasonably refer to the preceding symbols bound in this @code{let*} | |
203 form. Compare the following example with the example above for | |
204 @code{let}. | |
205 | |
206 @example | |
207 @group | |
208 (setq Y 2) | |
209 @result{} 2 | |
210 @end group | |
211 @group | |
212 (let* ((Y 1) | |
213 (Z Y)) ; @r{Use the just-established value of @code{Y}.} | |
214 (list Y Z)) | |
215 @result{} (1 1) | |
216 @end group | |
217 @end example | |
218 @end defspec | |
219 | |
7194
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
220 Here is a complete list of the other facilities that create local |
6510 | 221 bindings: |
222 | |
223 @itemize @bullet | |
224 @item | |
225 Function calls (@pxref{Functions}). | |
226 | |
227 @item | |
228 Macro calls (@pxref{Macros}). | |
229 | |
230 @item | |
231 @code{condition-case} (@pxref{Errors}). | |
232 @end itemize | |
233 | |
12098 | 234 Variables can also have buffer-local bindings (@pxref{Buffer-Local |
235 Variables}); a few variables have terminal-local bindings | |
236 (@pxref{Multiple Displays}). These kinds of bindings work somewhat like | |
237 ordinary local bindings, but they are localized depending on ``where'' | |
238 you are in Emacs, rather than localized in time. | |
239 | |
6510 | 240 @defvar max-specpdl-size |
241 @cindex variable limit error | |
242 @cindex evaluation error | |
243 @cindex infinite recursion | |
244 This variable defines the limit on the total number of local variable | |
245 bindings and @code{unwind-protect} cleanups (@pxref{Nonlocal Exits}) | |
246 that are allowed before signaling an error (with data @code{"Variable | |
247 binding depth exceeds max-specpdl-size"}). | |
248 | |
249 This limit, with the associated error when it is exceeded, is one way | |
250 that Lisp avoids infinite recursion on an ill-defined function. | |
251 | |
252 The default value is 600. | |
253 | |
254 @code{max-lisp-eval-depth} provides another limit on depth of nesting. | |
255 @xref{Eval}. | |
256 @end defvar | |
257 | |
258 @node Void Variables | |
259 @section When a Variable is ``Void'' | |
260 @kindex void-variable | |
261 @cindex void variable | |
262 | |
263 If you have never given a symbol any value as a global variable, we | |
264 say that that symbol's global value is @dfn{void}. In other words, the | |
265 symbol's value cell does not have any Lisp object in it. If you try to | |
266 evaluate the symbol, you get a @code{void-variable} error rather than | |
267 a value. | |
268 | |
269 Note that a value of @code{nil} is not the same as void. The symbol | |
270 @code{nil} is a Lisp object and can be the value of a variable just as any | |
271 other object can be; but it is @emph{a value}. A void variable does not | |
272 have any value. | |
273 | |
274 After you have given a variable a value, you can make it void once more | |
275 using @code{makunbound}. | |
276 | |
277 @defun makunbound symbol | |
278 This function makes the current binding of @var{symbol} void. | |
279 Subsequent attempts to use this symbol's value as a variable will signal | |
280 the error @code{void-variable}, unless or until you set it again. | |
281 | |
282 @code{makunbound} returns @var{symbol}. | |
283 | |
284 @example | |
285 @group | |
286 (makunbound 'x) ; @r{Make the global value} | |
287 ; @r{of @code{x} void.} | |
288 @result{} x | |
289 @end group | |
290 @group | |
291 x | |
292 @error{} Symbol's value as variable is void: x | |
293 @end group | |
294 @end example | |
295 | |
296 If @var{symbol} is locally bound, @code{makunbound} affects the most | |
297 local existing binding. This is the only way a symbol can have a void | |
298 local binding, since all the constructs that create local bindings | |
299 create them with values. In this case, the voidness lasts at most as | |
300 long as the binding does; when the binding is removed due to exit from | |
301 the construct that made it, the previous or global binding is reexposed | |
302 as usual, and the variable is no longer void unless the newly reexposed | |
303 binding was void all along. | |
304 | |
305 @smallexample | |
306 @group | |
307 (setq x 1) ; @r{Put a value in the global binding.} | |
308 @result{} 1 | |
309 (let ((x 2)) ; @r{Locally bind it.} | |
310 (makunbound 'x) ; @r{Void the local binding.} | |
311 x) | |
312 @error{} Symbol's value as variable is void: x | |
313 @end group | |
314 @group | |
315 x ; @r{The global binding is unchanged.} | |
316 @result{} 1 | |
317 | |
318 (let ((x 2)) ; @r{Locally bind it.} | |
319 (let ((x 3)) ; @r{And again.} | |
320 (makunbound 'x) ; @r{Void the innermost-local binding.} | |
321 x)) ; @r{And refer: it's void.} | |
322 @error{} Symbol's value as variable is void: x | |
323 @end group | |
324 | |
325 @group | |
326 (let ((x 2)) | |
327 (let ((x 3)) | |
328 (makunbound 'x)) ; @r{Void inner binding, then remove it.} | |
329 x) ; @r{Now outer @code{let} binding is visible.} | |
330 @result{} 2 | |
331 @end group | |
332 @end smallexample | |
333 @end defun | |
334 | |
335 A variable that has been made void with @code{makunbound} is | |
336 indistinguishable from one that has never received a value and has | |
337 always been void. | |
338 | |
339 You can use the function @code{boundp} to test whether a variable is | |
340 currently void. | |
341 | |
342 @defun boundp variable | |
343 @code{boundp} returns @code{t} if @var{variable} (a symbol) is not void; | |
344 more precisely, if its current binding is not void. It returns | |
345 @code{nil} otherwise. | |
346 | |
347 @smallexample | |
348 @group | |
349 (boundp 'abracadabra) ; @r{Starts out void.} | |
350 @result{} nil | |
351 @end group | |
352 @group | |
353 (let ((abracadabra 5)) ; @r{Locally bind it.} | |
354 (boundp 'abracadabra)) | |
355 @result{} t | |
356 @end group | |
357 @group | |
358 (boundp 'abracadabra) ; @r{Still globally void.} | |
359 @result{} nil | |
360 @end group | |
361 @group | |
362 (setq abracadabra 5) ; @r{Make it globally nonvoid.} | |
363 @result{} 5 | |
364 @end group | |
365 @group | |
366 (boundp 'abracadabra) | |
367 @result{} t | |
368 @end group | |
369 @end smallexample | |
370 @end defun | |
371 | |
372 @node Defining Variables | |
373 @section Defining Global Variables | |
7194
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
374 @cindex variable definition |
6510 | 375 |
376 You may announce your intention to use a symbol as a global variable | |
7194
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
377 with a @dfn{variable definition}: a special form, either @code{defconst} |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
378 or @code{defvar}. |
6510 | 379 |
380 In Emacs Lisp, definitions serve three purposes. First, they inform | |
381 people who read the code that certain symbols are @emph{intended} to be | |
382 used a certain way (as variables). Second, they inform the Lisp system | |
383 of these things, supplying a value and documentation. Third, they | |
384 provide information to utilities such as @code{etags} and | |
385 @code{make-docfile}, which create data bases of the functions and | |
386 variables in a program. | |
387 | |
388 The difference between @code{defconst} and @code{defvar} is primarily | |
389 a matter of intent, serving to inform human readers of whether programs | |
390 will change the variable. Emacs Lisp does not restrict the ways in | |
391 which a variable can be used based on @code{defconst} or @code{defvar} | |
7194
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
392 declarations. However, it does make a difference for initialization: |
6510 | 393 @code{defconst} unconditionally initializes the variable, while |
394 @code{defvar} initializes it only if it is void. | |
395 | |
396 One would expect user option variables to be defined with | |
397 @code{defconst}, since programs do not change them. Unfortunately, this | |
398 has bad results if the definition is in a library that is not preloaded: | |
399 @code{defconst} would override any prior value when the library is | |
400 loaded. Users would like to be able to set user options in their init | |
401 files, and override the default values given in the definitions. For | |
402 this reason, user options must be defined with @code{defvar}. | |
403 | |
404 @defspec defvar symbol [value [doc-string]] | |
405 This special form defines @var{symbol} as a value and initializes it. | |
406 The definition informs a person reading your code that @var{symbol} is | |
407 used as a variable that programs are likely to set or change. It is | |
408 also used for all user option variables except in the preloaded parts of | |
409 Emacs. Note that @var{symbol} is not evaluated; the symbol to be | |
410 defined must appear explicitly in the @code{defvar}. | |
411 | |
412 If @var{symbol} already has a value (i.e., it is not void), @var{value} | |
413 is not even evaluated, and @var{symbol}'s value remains unchanged. If | |
414 @var{symbol} is void and @var{value} is specified, @code{defvar} | |
415 evaluates it and sets @var{symbol} to the result. (If @var{value} is | |
416 omitted, the value of @var{symbol} is not changed in any case.) | |
417 | |
12098 | 418 When you evaluate a top-level @code{defvar} form with @kbd{C-M-x} in |
419 Emacs Lisp mode (@code{eval-defun}), a special feature of | |
420 @code{eval-defun} evaluates it as a @code{defconst}. The purpose of | |
421 this is to make sure the variable's value is reinitialized, when you ask | |
422 for it specifically. | |
423 | |
6510 | 424 If @var{symbol} has a buffer-local binding in the current buffer, |
425 @code{defvar} sets the default value, not the local value. | |
426 @xref{Buffer-Local Variables}. | |
427 | |
428 If the @var{doc-string} argument appears, it specifies the documentation | |
429 for the variable. (This opportunity to specify documentation is one of | |
430 the main benefits of defining the variable.) The documentation is | |
431 stored in the symbol's @code{variable-documentation} property. The | |
432 Emacs help functions (@pxref{Documentation}) look for this property. | |
433 | |
434 If the first character of @var{doc-string} is @samp{*}, it means that | |
435 this variable is considered a user option. This lets users set the | |
436 variable conventiently using the commands @code{set-variable} and | |
437 @code{edit-options}. | |
438 | |
439 For example, this form defines @code{foo} but does not set its value: | |
440 | |
441 @example | |
442 @group | |
443 (defvar foo) | |
444 @result{} foo | |
445 @end group | |
446 @end example | |
447 | |
448 The following example sets the value of @code{bar} to @code{23}, and | |
449 gives it a documentation string: | |
450 | |
451 @example | |
452 @group | |
453 (defvar bar 23 | |
454 "The normal weight of a bar.") | |
455 @result{} bar | |
456 @end group | |
457 @end example | |
458 | |
459 The following form changes the documentation string for @code{bar}, | |
460 making it a user option, but does not change the value, since @code{bar} | |
461 already has a value. (The addition @code{(1+ 23)} is not even | |
462 performed.) | |
463 | |
464 @example | |
465 @group | |
466 (defvar bar (1+ 23) | |
467 "*The normal weight of a bar.") | |
468 @result{} bar | |
469 @end group | |
470 @group | |
471 bar | |
472 @result{} 23 | |
473 @end group | |
474 @end example | |
475 | |
476 Here is an equivalent expression for the @code{defvar} special form: | |
477 | |
478 @example | |
479 @group | |
480 (defvar @var{symbol} @var{value} @var{doc-string}) | |
481 @equiv{} | |
482 (progn | |
483 (if (not (boundp '@var{symbol})) | |
484 (setq @var{symbol} @var{value})) | |
485 (put '@var{symbol} 'variable-documentation '@var{doc-string}) | |
486 '@var{symbol}) | |
487 @end group | |
488 @end example | |
489 | |
490 The @code{defvar} form returns @var{symbol}, but it is normally used | |
491 at top level in a file where its value does not matter. | |
492 @end defspec | |
493 | |
494 @defspec defconst symbol [value [doc-string]] | |
495 This special form defines @var{symbol} as a value and initializes it. | |
496 It informs a person reading your code that @var{symbol} has a global | |
497 value, established here, that will not normally be changed or locally | |
498 bound by the execution of the program. The user, however, may be | |
499 welcome to change it. Note that @var{symbol} is not evaluated; the | |
500 symbol to be defined must appear explicitly in the @code{defconst}. | |
501 | |
502 @code{defconst} always evaluates @var{value} and sets the global value | |
503 of @var{symbol} to the result, provided @var{value} is given. If | |
504 @var{symbol} has a buffer-local binding in the current buffer, | |
505 @code{defconst} sets the default value, not the local value. | |
506 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7194
diff
changeset
|
507 @strong{Please note:} Don't use @code{defconst} for user option |
6510 | 508 variables in libraries that are not standardly preloaded. The user |
509 should be able to specify a value for such a variable in the | |
510 @file{.emacs} file, so that it will be in effect if and when the library | |
511 is loaded later. | |
512 | |
513 Here, @code{pi} is a constant that presumably ought not to be changed | |
514 by anyone (attempts by the Indiana State Legislature notwithstanding). | |
515 As the second form illustrates, however, this is only advisory. | |
516 | |
517 @example | |
518 @group | |
519 (defconst pi 3.1415 "Pi to five places.") | |
520 @result{} pi | |
521 @end group | |
522 @group | |
523 (setq pi 3) | |
524 @result{} pi | |
525 @end group | |
526 @group | |
527 pi | |
528 @result{} 3 | |
529 @end group | |
530 @end example | |
531 @end defspec | |
532 | |
533 @defun user-variable-p variable | |
534 @cindex user option | |
7194
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
535 This function returns @code{t} if @var{variable} is a user option---a |
6510 | 536 variable intended to be set by the user for customization---and |
537 @code{nil} otherwise. (Variables other than user options exist for the | |
538 internal purposes of Lisp programs, and users need not know about them.) | |
539 | |
540 User option variables are distinguished from other variables by the | |
541 first character of the @code{variable-documentation} property. If the | |
542 property exists and is a string, and its first character is @samp{*}, | |
543 then the variable is a user option. | |
544 @end defun | |
545 | |
546 If a user option variable has a @code{variable-interactive} property, | |
12098 | 547 the @code{set-variable} command uses that value to control reading the |
548 new value for the variable. The property's value is used as if it were | |
549 the argument to @code{interactive}. | |
6510 | 550 |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7194
diff
changeset
|
551 @strong{Warning:} If the @code{defconst} and @code{defvar} special |
6510 | 552 forms are used while the variable has a local binding, they set the |
553 local binding's value; the global binding is not changed. This is not | |
554 what we really want. To prevent it, use these special forms at top | |
555 level in a file, where normally no local binding is in effect, and make | |
556 sure to load the file before making a local binding for the variable. | |
557 | |
558 @node Accessing Variables | |
559 @section Accessing Variable Values | |
560 | |
561 The usual way to reference a variable is to write the symbol which | |
562 names it (@pxref{Symbol Forms}). This requires you to specify the | |
563 variable name when you write the program. Usually that is exactly what | |
564 you want to do. Occasionally you need to choose at run time which | |
565 variable to reference; then you can use @code{symbol-value}. | |
566 | |
567 @defun symbol-value symbol | |
568 This function returns the value of @var{symbol}. This is the value in | |
569 the innermost local binding of the symbol, or its global value if it | |
570 has no local bindings. | |
571 | |
572 @example | |
573 @group | |
574 (setq abracadabra 5) | |
575 @result{} 5 | |
576 @end group | |
577 @group | |
578 (setq foo 9) | |
579 @result{} 9 | |
580 @end group | |
581 | |
582 @group | |
583 ;; @r{Here the symbol @code{abracadabra}} | |
584 ;; @r{is the symbol whose value is examined.} | |
585 (let ((abracadabra 'foo)) | |
586 (symbol-value 'abracadabra)) | |
587 @result{} foo | |
588 @end group | |
589 | |
590 @group | |
591 ;; @r{Here the value of @code{abracadabra},} | |
592 ;; @r{which is @code{foo},} | |
593 ;; @r{is the symbol whose value is examined.} | |
594 (let ((abracadabra 'foo)) | |
595 (symbol-value abracadabra)) | |
596 @result{} 9 | |
597 @end group | |
598 | |
599 @group | |
600 (symbol-value 'abracadabra) | |
601 @result{} 5 | |
602 @end group | |
603 @end example | |
604 | |
605 A @code{void-variable} error is signaled if @var{symbol} has neither a | |
606 local binding nor a global value. | |
607 @end defun | |
608 | |
609 @node Setting Variables | |
610 @section How to Alter a Variable Value | |
611 | |
612 The usual way to change the value of a variable is with the special | |
613 form @code{setq}. When you need to compute the choice of variable at | |
614 run time, use the function @code{set}. | |
615 | |
616 @defspec setq [symbol form]@dots{} | |
617 This special form is the most common method of changing a variable's | |
618 value. Each @var{symbol} is given a new value, which is the result of | |
619 evaluating the corresponding @var{form}. The most-local existing | |
620 binding of the symbol is changed. | |
621 | |
622 @code{setq} does not evaluate @var{symbol}; it sets the symbol that you | |
623 write. We say that this argument is @dfn{automatically quoted}. The | |
624 @samp{q} in @code{setq} stands for ``quoted.'' | |
625 | |
626 The value of the @code{setq} form is the value of the last @var{form}. | |
627 | |
628 @example | |
629 @group | |
630 (setq x (1+ 2)) | |
631 @result{} 3 | |
632 @end group | |
633 x ; @r{@code{x} now has a global value.} | |
634 @result{} 3 | |
635 @group | |
636 (let ((x 5)) | |
637 (setq x 6) ; @r{The local binding of @code{x} is set.} | |
638 x) | |
639 @result{} 6 | |
640 @end group | |
641 x ; @r{The global value is unchanged.} | |
642 @result{} 3 | |
643 @end example | |
644 | |
645 Note that the first @var{form} is evaluated, then the first | |
646 @var{symbol} is set, then the second @var{form} is evaluated, then the | |
647 second @var{symbol} is set, and so on: | |
648 | |
649 @example | |
650 @group | |
651 (setq x 10 ; @r{Notice that @code{x} is set before} | |
652 y (1+ x)) ; @r{the value of @code{y} is computed.} | |
653 @result{} 11 | |
654 @end group | |
655 @end example | |
656 @end defspec | |
657 | |
658 @defun set symbol value | |
659 This function sets @var{symbol}'s value to @var{value}, then returns | |
660 @var{value}. Since @code{set} is a function, the expression written for | |
661 @var{symbol} is evaluated to obtain the symbol to set. | |
662 | |
663 The most-local existing binding of the variable is the binding that is | |
7194
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
664 set; shadowed bindings are not affected. |
6510 | 665 |
666 @example | |
667 @group | |
668 (set one 1) | |
669 @error{} Symbol's value as variable is void: one | |
670 @end group | |
671 @group | |
672 (set 'one 1) | |
673 @result{} 1 | |
674 @end group | |
675 @group | |
676 (set 'two 'one) | |
677 @result{} one | |
678 @end group | |
679 @group | |
680 (set two 2) ; @r{@code{two} evaluates to symbol @code{one}.} | |
681 @result{} 2 | |
682 @end group | |
683 @group | |
684 one ; @r{So it is @code{one} that was set.} | |
685 @result{} 2 | |
686 (let ((one 1)) ; @r{This binding of @code{one} is set,} | |
687 (set 'one 3) ; @r{not the global value.} | |
688 one) | |
689 @result{} 3 | |
690 @end group | |
691 @group | |
692 one | |
693 @result{} 2 | |
694 @end group | |
695 @end example | |
696 | |
7194
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
697 If @var{symbol} is not actually a symbol, a @code{wrong-type-argument} |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
698 error is signaled. |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
699 |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
700 @example |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
701 (set '(x y) 'z) |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
702 @error{} Wrong type argument: symbolp, (x y) |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
703 @end example |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
704 |
6510 | 705 Logically speaking, @code{set} is a more fundamental primitive than |
706 @code{setq}. Any use of @code{setq} can be trivially rewritten to use | |
707 @code{set}; @code{setq} could even be defined as a macro, given the | |
708 availability of @code{set}. However, @code{set} itself is rarely used; | |
7194
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
709 beginners hardly need to know about it. It is useful only for choosing |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
710 at run time which variable to set. For example, the command |
6510 | 711 @code{set-variable}, which reads a variable name from the user and then |
712 sets the variable, needs to use @code{set}. | |
713 | |
714 @cindex CL note---@code{set} local | |
715 @quotation | |
7194
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
716 @b{Common Lisp note:} In Common Lisp, @code{set} always changes the |
6510 | 717 symbol's special value, ignoring any lexical bindings. In Emacs Lisp, |
718 all variables and all bindings are (in effect) special, so @code{set} | |
719 always affects the most local existing binding. | |
720 @end quotation | |
721 @end defun | |
722 | |
12067 | 723 One other function for setting a variable is designed to add |
724 an element to a list if it is not already present in the list. | |
725 | |
726 @defun add-to-list symbol element | |
727 This function sets the variable @var{symbol} by consing @var{element} | |
728 onto the old value, if @var{element} is not already a member of that | |
12098 | 729 value. It returns the resulting list, whether updated or not. The |
730 value of @var{symbol} had better be a list already before the call. | |
731 | |
732 The argument @var{symbol} is not implicitly quoted; @code{add-to-list} | |
733 is an ordinary function, like @code{set} and unlike @code{setq}. Quote | |
734 the argument yourself if that is what you want. | |
12067 | 735 |
736 Here's a scenario showing how to use @code{add-to-list}: | |
737 | |
738 @example | |
739 (setq foo '(a b)) | |
740 @result{} (a b) | |
741 | |
742 (add-to-list 'foo 'c) ;; @r{Add @code{c}.} | |
743 @result{} (c a b) | |
744 | |
745 (add-to-list 'foo 'b) ;; @r{No effect.} | |
746 @result{} (c a b) | |
747 | |
748 foo ;; @r{@code{foo} was changed.} | |
749 @result{} (c a b) | |
750 @end example | |
751 @end defun | |
752 | |
753 An equivalent expression for @code{(add-to-list '@var{var} | |
754 @var{value})} is this: | |
755 | |
756 @example | |
757 (or (member @var{value} @var{var}) | |
758 (setq @var{var} (cons @var{value} @var{var}))) | |
759 @end example | |
760 | |
6510 | 761 @node Variable Scoping |
762 @section Scoping Rules for Variable Bindings | |
763 | |
764 A given symbol @code{foo} may have several local variable bindings, | |
765 established at different places in the Lisp program, as well as a global | |
766 binding. The most recently established binding takes precedence over | |
767 the others. | |
768 | |
769 @cindex scope | |
770 @cindex extent | |
771 @cindex dynamic scoping | |
772 Local bindings in Emacs Lisp have @dfn{indefinite scope} and | |
773 @dfn{dynamic extent}. @dfn{Scope} refers to @emph{where} textually in | |
774 the source code the binding can be accessed. Indefinite scope means | |
775 that any part of the program can potentially access the variable | |
776 binding. @dfn{Extent} refers to @emph{when}, as the program is | |
777 executing, the binding exists. Dynamic extent means that the binding | |
778 lasts as long as the activation of the construct that established it. | |
779 | |
780 The combination of dynamic extent and indefinite scope is called | |
781 @dfn{dynamic scoping}. By contrast, most programming languages use | |
782 @dfn{lexical scoping}, in which references to a local variable must be | |
783 located textually within the function or block that binds the variable. | |
784 | |
785 @cindex CL note---special variables | |
786 @quotation | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7194
diff
changeset
|
787 @b{Common Lisp note:} Variables declared ``special'' in Common Lisp |
7194
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
788 are dynamically scoped, like variables in Emacs Lisp. |
6510 | 789 @end quotation |
790 | |
791 @menu | |
792 * Scope:: Scope means where in the program a value is visible. | |
793 Comparison with other languages. | |
794 * Extent:: Extent means how long in time a value exists. | |
795 * Impl of Scope:: Two ways to implement dynamic scoping. | |
796 * Using Scoping:: How to use dynamic scoping carefully and avoid problems. | |
797 @end menu | |
798 | |
799 @node Scope | |
800 @subsection Scope | |
801 | |
802 Emacs Lisp uses @dfn{indefinite scope} for local variable bindings. | |
803 This means that any function anywhere in the program text might access a | |
804 given binding of a variable. Consider the following function | |
805 definitions: | |
806 | |
807 @example | |
808 @group | |
809 (defun binder (x) ; @r{@code{x} is bound in @code{binder}.} | |
810 (foo 5)) ; @r{@code{foo} is some other function.} | |
811 @end group | |
812 | |
813 @group | |
814 (defun user () ; @r{@code{x} is used in @code{user}.} | |
815 (list x)) | |
816 @end group | |
817 @end example | |
818 | |
819 In a lexically scoped language, the binding of @code{x} in | |
820 @code{binder} would never be accessible in @code{user}, because | |
821 @code{user} is not textually contained within the function | |
822 @code{binder}. However, in dynamically scoped Emacs Lisp, @code{user} | |
823 may or may not refer to the binding of @code{x} established in | |
824 @code{binder}, depending on circumstances: | |
825 | |
826 @itemize @bullet | |
827 @item | |
828 If we call @code{user} directly without calling @code{binder} at all, | |
829 then whatever binding of @code{x} is found, it cannot come from | |
830 @code{binder}. | |
831 | |
832 @item | |
833 If we define @code{foo} as follows and call @code{binder}, then the | |
834 binding made in @code{binder} will be seen in @code{user}: | |
835 | |
836 @example | |
837 @group | |
838 (defun foo (lose) | |
839 (user)) | |
840 @end group | |
841 @end example | |
842 | |
843 @item | |
844 If we define @code{foo} as follows and call @code{binder}, then the | |
845 binding made in @code{binder} @emph{will not} be seen in @code{user}: | |
846 | |
847 @example | |
848 (defun foo (x) | |
849 (user)) | |
850 @end example | |
851 | |
852 @noindent | |
853 Here, when @code{foo} is called by @code{binder}, it binds @code{x}. | |
854 (The binding in @code{foo} is said to @dfn{shadow} the one made in | |
855 @code{binder}.) Therefore, @code{user} will access the @code{x} bound | |
856 by @code{foo} instead of the one bound by @code{binder}. | |
857 @end itemize | |
858 | |
859 @node Extent | |
860 @subsection Extent | |
861 | |
862 @dfn{Extent} refers to the time during program execution that a | |
863 variable name is valid. In Emacs Lisp, a variable is valid only while | |
864 the form that bound it is executing. This is called @dfn{dynamic | |
865 extent}. ``Local'' or ``automatic'' variables in most languages, | |
866 including C and Pascal, have dynamic extent. | |
867 | |
868 One alternative to dynamic extent is @dfn{indefinite extent}. This | |
869 means that a variable binding can live on past the exit from the form | |
870 that made the binding. Common Lisp and Scheme, for example, support | |
871 this, but Emacs Lisp does not. | |
872 | |
873 To illustrate this, the function below, @code{make-add}, returns a | |
874 function that purports to add @var{n} to its own argument @var{m}. | |
875 This would work in Common Lisp, but it does not work as intended in | |
876 Emacs Lisp, because after the call to @code{make-add} exits, the | |
877 variable @code{n} is no longer bound to the actual argument 2. | |
878 | |
879 @example | |
880 (defun make-add (n) | |
881 (function (lambda (m) (+ n m)))) ; @r{Return a function.} | |
882 @result{} make-add | |
883 (fset 'add2 (make-add 2)) ; @r{Define function @code{add2}} | |
884 ; @r{with @code{(make-add 2)}.} | |
885 @result{} (lambda (m) (+ n m)) | |
886 (add2 4) ; @r{Try to add 2 to 4.} | |
887 @error{} Symbol's value as variable is void: n | |
888 @end example | |
889 | |
890 @cindex closures not available | |
891 Some Lisp dialects have ``closures'', objects that are like functions | |
892 but record additional variable bindings. Emacs Lisp does not have | |
893 closures. | |
894 | |
895 @node Impl of Scope | |
896 @subsection Implementation of Dynamic Scoping | |
897 @cindex deep binding | |
898 | |
899 A simple sample implementation (which is not how Emacs Lisp actually | |
900 works) may help you understand dynamic binding. This technique is | |
901 called @dfn{deep binding} and was used in early Lisp systems. | |
902 | |
903 Suppose there is a stack of bindings: variable-value pairs. At entry | |
904 to a function or to a @code{let} form, we can push bindings on the stack | |
905 for the arguments or local variables created there. We can pop those | |
906 bindings from the stack at exit from the binding construct. | |
907 | |
908 We can find the value of a variable by searching the stack from top to | |
909 bottom for a binding for that variable; the value from that binding is | |
910 the value of the variable. To set the variable, we search for the | |
911 current binding, then store the new value into that binding. | |
912 | |
913 As you can see, a function's bindings remain in effect as long as it | |
914 continues execution, even during its calls to other functions. That is | |
915 why we say the extent of the binding is dynamic. And any other function | |
916 can refer to the bindings, if it uses the same variables while the | |
917 bindings are in effect. That is why we say the scope is indefinite. | |
918 | |
919 @cindex shallow binding | |
920 The actual implementation of variable scoping in GNU Emacs Lisp uses a | |
921 technique called @dfn{shallow binding}. Each variable has a standard | |
922 place in which its current value is always found---the value cell of the | |
923 symbol. | |
924 | |
925 In shallow binding, setting the variable works by storing a value in | |
926 the value cell. Creating a new binding works by pushing the old value | |
927 (belonging to a previous binding) on a stack, and storing the local value | |
928 in the value cell. Eliminating a binding works by popping the old value | |
929 off the stack, into the value cell. | |
930 | |
931 We use shallow binding because it has the same results as deep | |
932 binding, but runs faster, since there is never a need to search for a | |
933 binding. | |
934 | |
935 @node Using Scoping | |
936 @subsection Proper Use of Dynamic Scoping | |
937 | |
938 Binding a variable in one function and using it in another is a | |
939 powerful technique, but if used without restraint, it can make programs | |
940 hard to understand. There are two clean ways to use this technique: | |
941 | |
942 @itemize @bullet | |
943 @item | |
944 Use or bind the variable only in a few related functions, written close | |
945 together in one file. Such a variable is used for communication within | |
946 one program. | |
947 | |
948 You should write comments to inform other programmers that they can see | |
949 all uses of the variable before them, and to advise them not to add uses | |
950 elsewhere. | |
951 | |
952 @item | |
953 Give the variable a well-defined, documented meaning, and make all | |
954 appropriate functions refer to it (but not bind it or set it) wherever | |
955 that meaning is relevant. For example, the variable | |
956 @code{case-fold-search} is defined as ``non-@code{nil} means ignore case | |
957 when searching''; various search and replace functions refer to it | |
958 directly or through their subroutines, but do not bind or set it. | |
959 | |
960 Then you can bind the variable in other programs, knowing reliably what | |
961 the effect will be. | |
962 @end itemize | |
963 | |
12098 | 964 In either case, you should define the variable with @code{defvar}. |
965 This helps other people understand your program by telling them to look | |
966 for inter-function usage. It also avoids a warning from the byte | |
967 compiler. Choose the variable's name to avoid name conflicts---don't | |
968 use short names like @code{x}. | |
969 | |
6510 | 970 @node Buffer-Local Variables |
971 @section Buffer-Local Variables | |
972 @cindex variables, buffer-local | |
973 @cindex buffer-local variables | |
974 | |
975 Global and local variable bindings are found in most programming | |
976 languages in one form or another. Emacs also supports another, unusual | |
977 kind of variable binding: @dfn{buffer-local} bindings, which apply only | |
978 to one buffer. Emacs Lisp is meant for programming editing commands, | |
979 and having different values for a variable in different buffers is an | |
12067 | 980 important customization method. (A few variables have bindings that |
981 are local to a given X terminal; see @ref{Multiple Displays}.) | |
6510 | 982 |
983 @menu | |
984 * Intro to Buffer-Local:: Introduction and concepts. | |
985 * Creating Buffer-Local:: Creating and destroying buffer-local bindings. | |
986 * Default Value:: The default value is seen in buffers | |
987 that don't have their own local values. | |
988 @end menu | |
989 | |
990 @node Intro to Buffer-Local | |
991 @subsection Introduction to Buffer-Local Variables | |
992 | |
993 A buffer-local variable has a buffer-local binding associated with a | |
994 particular buffer. The binding is in effect when that buffer is | |
995 current; otherwise, it is not in effect. If you set the variable while | |
996 a buffer-local binding is in effect, the new value goes in that binding, | |
997 so the global binding is unchanged; this means that the change is | |
998 visible in that buffer alone. | |
999 | |
1000 A variable may have buffer-local bindings in some buffers but not in | |
1001 others. The global binding is shared by all the buffers that don't have | |
1002 their own bindings. Thus, if you set the variable in a buffer that does | |
1003 not have a buffer-local binding for it, the new value is visible in all | |
1004 buffers except those with buffer-local bindings. (Here we are assuming | |
1005 that there are no @code{let}-style local bindings to complicate the issue.) | |
1006 | |
1007 The most common use of buffer-local bindings is for major modes to change | |
1008 variables that control the behavior of commands. For example, C mode and | |
1009 Lisp mode both set the variable @code{paragraph-start} to specify that only | |
1010 blank lines separate paragraphs. They do this by making the variable | |
1011 buffer-local in the buffer that is being put into C mode or Lisp mode, and | |
1012 then setting it to the new value for that mode. | |
1013 | |
1014 The usual way to make a buffer-local binding is with | |
1015 @code{make-local-variable}, which is what major mode commands use. This | |
1016 affects just the current buffer; all other buffers (including those yet to | |
1017 be created) continue to share the global value. | |
1018 | |
1019 @cindex automatically buffer-local | |
1020 A more powerful operation is to mark the variable as | |
1021 @dfn{automatically buffer-local} by calling | |
1022 @code{make-variable-buffer-local}. You can think of this as making the | |
1023 variable local in all buffers, even those yet to be created. More | |
1024 precisely, the effect is that setting the variable automatically makes | |
1025 the variable local to the current buffer if it is not already so. All | |
1026 buffers start out by sharing the global value of the variable as usual, | |
1027 but any @code{setq} creates a buffer-local binding for the current | |
1028 buffer. The new value is stored in the buffer-local binding, leaving | |
1029 the (default) global binding untouched. The global value can no longer | |
1030 be changed with @code{setq}; you need to use @code{setq-default} to do | |
1031 that. | |
1032 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7194
diff
changeset
|
1033 @strong{Warning:} When a variable has local values in one or more |
6510 | 1034 buffers, you can get Emacs very confused by binding the variable with |
1035 @code{let}, changing to a different current buffer in which a different | |
1036 binding is in effect, and then exiting the @code{let}. This can | |
1037 scramble the values of the global and local bindings. | |
1038 | |
1039 To preserve your sanity, avoid that series of actions. If you use | |
1040 @code{save-excursion} around each piece of code that changes to a | |
1041 different current buffer, you will not have this problem. Here is an | |
1042 example of what to avoid: | |
1043 | |
1044 @example | |
1045 @group | |
1046 (setq foo 'b) | |
1047 (set-buffer "a") | |
1048 (make-local-variable 'foo) | |
1049 @end group | |
1050 (setq foo 'a) | |
1051 (let ((foo 'temp)) | |
1052 (set-buffer "b") | |
12098 | 1053 @var{body}@dots{}) |
6510 | 1054 @group |
1055 foo @result{} 'a ; @r{The old buffer-local value from buffer @samp{a}} | |
1056 ; @r{is now the default value.} | |
1057 @end group | |
1058 @group | |
1059 (set-buffer "a") | |
1060 foo @result{} 'temp ; @r{The local value that should be gone} | |
1061 ; @r{is now the buffer-local value in buffer @samp{a}.} | |
1062 @end group | |
1063 @end example | |
1064 | |
1065 @noindent | |
1066 But @code{save-excursion} as shown here avoids the problem: | |
1067 | |
1068 @example | |
1069 @group | |
1070 (let ((foo 'temp)) | |
1071 (save-excursion | |
1072 (set-buffer "b") | |
1073 @var{body}@dots{})) | |
1074 @end group | |
1075 @end example | |
1076 | |
1077 Note that references to @code{foo} in @var{body} access the | |
1078 buffer-local binding of buffer @samp{b}. | |
1079 | |
1080 When a file specifies local variable values, these become buffer-local | |
7194
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
1081 values when you visit the file. @xref{Auto Major Mode}. |
6510 | 1082 |
1083 @node Creating Buffer-Local | |
1084 @subsection Creating and Deleting Buffer-Local Bindings | |
1085 | |
1086 @deffn Command make-local-variable variable | |
1087 This function creates a buffer-local binding in the current buffer for | |
1088 @var{variable} (a symbol). Other buffers are not affected. The value | |
1089 returned is @var{variable}. | |
1090 | |
1091 @c Emacs 19 feature | |
1092 The buffer-local value of @var{variable} starts out as the same value | |
1093 @var{variable} previously had. If @var{variable} was void, it remains | |
1094 void. | |
1095 | |
1096 @example | |
1097 @group | |
1098 ;; @r{In buffer @samp{b1}:} | |
1099 (setq foo 5) ; @r{Affects all buffers.} | |
1100 @result{} 5 | |
1101 @end group | |
1102 @group | |
1103 (make-local-variable 'foo) ; @r{Now it is local in @samp{b1}.} | |
1104 @result{} foo | |
1105 @end group | |
1106 @group | |
1107 foo ; @r{That did not change} | |
1108 @result{} 5 ; @r{the value.} | |
1109 @end group | |
1110 @group | |
1111 (setq foo 6) ; @r{Change the value} | |
1112 @result{} 6 ; @r{in @samp{b1}.} | |
1113 @end group | |
1114 @group | |
1115 foo | |
1116 @result{} 6 | |
1117 @end group | |
1118 | |
1119 @group | |
1120 ;; @r{In buffer @samp{b2}, the value hasn't changed.} | |
1121 (save-excursion | |
1122 (set-buffer "b2") | |
1123 foo) | |
1124 @result{} 5 | |
1125 @end group | |
1126 @end example | |
8214 | 1127 |
1128 Making a variable buffer-local within a @code{let}-binding for that | |
1129 variable does not work. This is because @code{let} does not distinguish | |
1130 between different kinds of bindings; it knows only which variable the | |
1131 binding was made for. | |
12067 | 1132 |
12098 | 1133 If the variable is terminal-local, this function signals an error. Such |
1134 variables cannot have buffer-local bindings as well. @xref{Multiple | |
1135 Displays}. | |
1136 | |
12067 | 1137 @strong{Note:} do not use @code{make-local-variable} for a hook |
1138 variable. Instead, use @code{make-local-hook}. @xref{Hooks}. | |
6510 | 1139 @end deffn |
1140 | |
1141 @deffn Command make-variable-buffer-local variable | |
1142 This function marks @var{variable} (a symbol) automatically | |
1143 buffer-local, so that any subsequent attempt to set it will make it | |
1144 local to the current buffer at the time. | |
1145 | |
1146 The value returned is @var{variable}. | |
1147 @end deffn | |
1148 | |
12098 | 1149 @defun local-variable-p variable &optional buffer |
1150 This returns @code{t} if @var{variable} is buffer-local in buffer | |
1151 @var{buffer} (which defaults to the current buffer); otherwise, | |
1152 @code{nil}. | |
1153 @end defun | |
1154 | |
6510 | 1155 @defun buffer-local-variables &optional buffer |
1156 This function returns a list describing the buffer-local variables in | |
1157 buffer @var{buffer}. It returns an association list (@pxref{Association | |
1158 Lists}) in which each association contains one buffer-local variable and | |
1159 its value. When a buffer-local variable is void in @var{buffer}, then | |
1160 it appears directly in the resulting list. If @var{buffer} is omitted, | |
1161 the current buffer is used. | |
1162 | |
1163 @example | |
1164 @group | |
1165 (make-local-variable 'foobar) | |
1166 (makunbound 'foobar) | |
1167 (make-local-variable 'bind-me) | |
1168 (setq bind-me 69) | |
1169 @end group | |
1170 (setq lcl (buffer-local-variables)) | |
1171 ;; @r{First, built-in variables local in all buffers:} | |
1172 @result{} ((mark-active . nil) | |
1173 (buffer-undo-list nil) | |
1174 (mode-name . "Fundamental") | |
1175 @dots{} | |
1176 @group | |
1177 ;; @r{Next, non-built-in local variables.} | |
1178 ;; @r{This one is local and void:} | |
1179 foobar | |
1180 ;; @r{This one is local and nonvoid:} | |
1181 (bind-me . 69)) | |
1182 @end group | |
1183 @end example | |
1184 | |
1185 Note that storing new values into the @sc{cdr}s of cons cells in this | |
1186 list does @emph{not} change the local values of the variables. | |
1187 @end defun | |
1188 | |
1189 @deffn Command kill-local-variable variable | |
1190 This function deletes the buffer-local binding (if any) for | |
1191 @var{variable} (a symbol) in the current buffer. As a result, the | |
1192 global (default) binding of @var{variable} becomes visible in this | |
1193 buffer. Usually this results in a change in the value of | |
1194 @var{variable}, since the global value is usually different from the | |
1195 buffer-local value just eliminated. | |
1196 | |
1197 If you kill the local binding of a variable that automatically becomes | |
1198 local when set, this makes the global value visible in the current | |
1199 buffer. However, if you set the variable again, that will once again | |
1200 create a local binding for it. | |
1201 | |
1202 @code{kill-local-variable} returns @var{variable}. | |
7194
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
1203 |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
1204 This function is a command because it is sometimes useful to kill one |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
1205 buffer-local variable interactively, just as it is useful to create |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
1206 buffer-local variables interactively. |
6510 | 1207 @end deffn |
1208 | |
1209 @defun kill-all-local-variables | |
1210 This function eliminates all the buffer-local variable bindings of the | |
1211 current buffer except for variables marked as ``permanent''. As a | |
1212 result, the buffer will see the default values of most variables. | |
1213 | |
1214 This function also resets certain other information pertaining to the | |
1215 buffer: it sets the local keymap to @code{nil}, the syntax table to the | |
1216 value of @code{standard-syntax-table}, and the abbrev table to the value | |
1217 of @code{fundamental-mode-abbrev-table}. | |
1218 | |
1219 Every major mode command begins by calling this function, which has the | |
1220 effect of switching to Fundamental mode and erasing most of the effects | |
1221 of the previous major mode. To ensure that this does its job, the | |
1222 variables that major modes set should not be marked permanent. | |
1223 | |
1224 @code{kill-all-local-variables} returns @code{nil}. | |
1225 @end defun | |
1226 | |
1227 @c Emacs 19 feature | |
1228 @cindex permanent local variable | |
1229 A local variable is @dfn{permanent} if the variable name (a symbol) has a | |
1230 @code{permanent-local} property that is non-@code{nil}. Permanent | |
1231 locals are appropriate for data pertaining to where the file came from | |
1232 or how to save it, rather than with how to edit the contents. | |
1233 | |
1234 @node Default Value | |
1235 @subsection The Default Value of a Buffer-Local Variable | |
1236 @cindex default value | |
1237 | |
1238 The global value of a variable with buffer-local bindings is also | |
1239 called the @dfn{default} value, because it is the value that is in | |
1240 effect except when specifically overridden. | |
1241 | |
1242 The functions @code{default-value} and @code{setq-default} access and | |
1243 change a variable's default value regardless of whether the current | |
1244 buffer has a buffer-local binding. For example, you could use | |
1245 @code{setq-default} to change the default setting of | |
1246 @code{paragraph-start} for most buffers; and this would work even when | |
7194
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
1247 you are in a C or Lisp mode buffer that has a buffer-local value for |
6510 | 1248 this variable. |
1249 | |
1250 @c Emacs 19 feature | |
1251 The special forms @code{defvar} and @code{defconst} also set the | |
1252 default value (if they set the variable at all), rather than any local | |
1253 value. | |
1254 | |
1255 @defun default-value symbol | |
1256 This function returns @var{symbol}'s default value. This is the value | |
1257 that is seen in buffers that do not have their own values for this | |
1258 variable. If @var{symbol} is not buffer-local, this is equivalent to | |
1259 @code{symbol-value} (@pxref{Accessing Variables}). | |
1260 @end defun | |
1261 | |
1262 @c Emacs 19 feature | |
7194
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
1263 @defun default-boundp symbol |
3112fb627aa0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6510
diff
changeset
|
1264 The function @code{default-boundp} tells you whether @var{symbol}'s |
6510 | 1265 default value is nonvoid. If @code{(default-boundp 'foo)} returns |
1266 @code{nil}, then @code{(default-value 'foo)} would get an error. | |
1267 | |
1268 @code{default-boundp} is to @code{default-value} as @code{boundp} is to | |
1269 @code{symbol-value}. | |
1270 @end defun | |
1271 | |
1272 @defspec setq-default symbol value | |
1273 This sets the default value of @var{symbol} to @var{value}. It does not | |
1274 evaluate @var{symbol}, but does evaluate @var{value}. The value of the | |
1275 @code{setq-default} form is @var{value}. | |
1276 | |
1277 If a @var{symbol} is not buffer-local for the current buffer, and is not | |
1278 marked automatically buffer-local, @code{setq-default} has the same | |
1279 effect as @code{setq}. If @var{symbol} is buffer-local for the current | |
1280 buffer, then this changes the value that other buffers will see (as long | |
1281 as they don't have a buffer-local value), but not the value that the | |
1282 current buffer sees. | |
1283 | |
1284 @example | |
1285 @group | |
1286 ;; @r{In buffer @samp{foo}:} | |
1287 (make-local-variable 'local) | |
1288 @result{} local | |
1289 @end group | |
1290 @group | |
1291 (setq local 'value-in-foo) | |
1292 @result{} value-in-foo | |
1293 @end group | |
1294 @group | |
1295 (setq-default local 'new-default) | |
1296 @result{} new-default | |
1297 @end group | |
1298 @group | |
1299 local | |
1300 @result{} value-in-foo | |
1301 @end group | |
1302 @group | |
1303 (default-value 'local) | |
1304 @result{} new-default | |
1305 @end group | |
1306 | |
1307 @group | |
1308 ;; @r{In (the new) buffer @samp{bar}:} | |
1309 local | |
1310 @result{} new-default | |
1311 @end group | |
1312 @group | |
1313 (default-value 'local) | |
1314 @result{} new-default | |
1315 @end group | |
1316 @group | |
1317 (setq local 'another-default) | |
1318 @result{} another-default | |
1319 @end group | |
1320 @group | |
1321 (default-value 'local) | |
1322 @result{} another-default | |
1323 @end group | |
1324 | |
1325 @group | |
1326 ;; @r{Back in buffer @samp{foo}:} | |
1327 local | |
1328 @result{} value-in-foo | |
1329 (default-value 'local) | |
1330 @result{} another-default | |
1331 @end group | |
1332 @end example | |
1333 @end defspec | |
1334 | |
1335 @defun set-default symbol value | |
1336 This function is like @code{setq-default}, except that @var{symbol} is | |
1337 evaluated. | |
1338 | |
1339 @example | |
1340 @group | |
1341 (set-default (car '(a b c)) 23) | |
1342 @result{} 23 | |
1343 @end group | |
1344 @group | |
1345 (default-value 'a) | |
1346 @result{} 23 | |
1347 @end group | |
1348 @end example | |
1349 @end defun |