Mercurial > emacs

annotate lispref/variables.texi @ 18582:fd88d8f82bbc

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