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