annotate doc/lispref/variables.texi @ 98687:eaf07c77b37b

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