annotate lispref/variables.texi @ 90692:d108d1785ea7

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