annotate doc/lispref/variables.texi @ 107372:b73242777fb9

Add support for shelving snapshots and for showing shelves. * vc-bzr.el (vc-bzr-shelve-show, vc-bzr-shelve-show-at-point) (vc-bzr-shelve-apply-and-keep-at-point, vc-bzr-shelve-snapshot): New functions. (vc-bzr-shelve-map, vc-bzr-shelve-menu-map) (vc-bzr-extra-menu-map): Map them.
author Dan Nicolaescu <dann@ics.uci.edu>
date Thu, 11 Mar 2010 17:29:30 -0800
parents 1d1d5d9bd884
children 70ad6f6f15c7
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,
106815
1d1d5d9bd884 Add 2010 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 106731
diff changeset
4 @c 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
103456
22a2d318807d (Directory Local Variables): Update for 2009-04-11 name-change of
Glenn Morris <rgm@gnu.org>
parents: 103273
diff changeset
5 @c Free Software Foundation, Inc.
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6 @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
7 @setfilename ../../info/variables
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8 @node Variables, Functions, Control Structures, Top
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9 @chapter Variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10 @cindex variable
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12 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
13 Nearly all programming languages have variables of some sort. In the
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14 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
15 symbols.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17 In Lisp, unlike most programming languages, programs are represented
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18 primarily as Lisp objects and only secondarily as text. The Lisp
102306
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
19 objects used for variables are symbols: the symbol name is the
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
20 variable name, and the variable's value is stored in the value cell of
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
21 the symbol. The use of a symbol as a variable is independent of its
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
22 use as a function name. @xref{Symbol Components}.
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
23
102306
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
24 The textual form of a Lisp program is given by the read syntax of
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
25 the Lisp objects that constitute the program. Hence, a variable in a
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
26 textual Lisp program is written using the read syntax for the symbol
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
27 representing the variable.
84109
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.
100710
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
42 * File Local Variables:: Handling local variable lists in files.
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
43 * Directory Local Variables:: Local variables common to all files in a directory.
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
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
102306
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
68 @code{setq} is a special form (@pxref{Special Forms}); it does not
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
69 evaluate its first argument, the name of the variable, but it does
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
70 evaluate the second argument, the new value.
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
71
102306
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
72 Once the variable has a value, you can refer to it by using the
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
73 symbol itself as an expression. Thus,
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
74
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
75 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
76 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
77 x @result{} (a b)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
78 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
79 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
80
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
81 @noindent
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
82 assuming the @code{setq} form shown above has already been executed.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
83
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
84 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
85 one:
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
86
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
87 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
88 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
89 x
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
90 @result{} (a b)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
91 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
92 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
93 (setq x 4)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
94 @result{} 4
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
95 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
96 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
97 x
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
98 @result{} 4
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
99 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
100 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
101
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
102 @node Constant Variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
103 @section Variables that Never Change
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
104 @kindex setting-constant
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
105 @cindex keyword symbol
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
106 @cindex variable with constant value
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
107 @cindex constant variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
108 @cindex symbol that evaluates to itself
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
109 @cindex symbol with constant value
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
110
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
111 In Emacs Lisp, certain symbols normally evaluate to themselves. These
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
112 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
113 with @samp{:} (these are called @dfn{keywords}). These symbols cannot
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
114 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
115 @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
116 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
117 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
118 symbol to itself is not an error.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
119
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
120 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
121 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
122 nil @equiv{} 'nil
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
123 @result{} nil
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
124 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
125 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
126 (setq nil 500)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
127 @error{} Attempt to set constant symbol: nil
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
128 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
129 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
130
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
131 @defun keywordp object
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
132 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
133 starts with @samp{:}, interned in the standard obarray, and returns
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
134 @code{nil} otherwise.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
135 @end defun
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
136
105622
929678fafdb4 * variables.texi (Constant Variables): Distinguish from defconst
Chong Yidong <cyd@stupidchicken.com>
parents: 103456
diff changeset
137 These constants are fundamentally different from the ``constants''
929678fafdb4 * variables.texi (Constant Variables): Distinguish from defconst
Chong Yidong <cyd@stupidchicken.com>
parents: 103456
diff changeset
138 defined using the @code{defconst} special form (@pxref{Defining
929678fafdb4 * variables.texi (Constant Variables): Distinguish from defconst
Chong Yidong <cyd@stupidchicken.com>
parents: 103456
diff changeset
139 Variables}). A @code{defconst} form serves to inform human readers
929678fafdb4 * variables.texi (Constant Variables): Distinguish from defconst
Chong Yidong <cyd@stupidchicken.com>
parents: 103456
diff changeset
140 that you do not intend to change the value of a variable, but Emacs
929678fafdb4 * variables.texi (Constant Variables): Distinguish from defconst
Chong Yidong <cyd@stupidchicken.com>
parents: 103456
diff changeset
141 does not raise an error if you actually change it.
929678fafdb4 * variables.texi (Constant Variables): Distinguish from defconst
Chong Yidong <cyd@stupidchicken.com>
parents: 103456
diff changeset
142
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
143 @node Local Variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
144 @section Local Variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
145 @cindex binding local variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
146 @cindex local variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
147 @cindex local binding
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
148 @cindex global binding
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
149
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
150 Global variables have values that last until explicitly superseded
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
151 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
152 exist temporarily---only until a certain part of the program finishes.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
153 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
154 called @dfn{local variables}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
155
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
156 For example, when a function is called, its argument variables receive
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
157 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
158 special form explicitly establishes new local values for specified
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
159 variables; these last until exit from the @code{let} form.
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 @cindex shadowing of variables
102306
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
162 Establishing a local value saves away the variable's previous value
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
163 (or lack of one). We say that the previous value is @dfn{shadowed}
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
164 and @dfn{not visible}. Both global and local values may be shadowed
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
165 (@pxref{Scope}). After the life span of the local value is over, the
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
166 previous value (or lack of one) is restored.
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
167
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
168 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
169 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
170 previous local values, that are shadowed. To model this behavior, we
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
171 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
172
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
173 The local binding is a conceptual place that holds a local value.
102306
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
174 Entering a function, or a special form such as @code{let}, creates the
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
175 local binding; exiting the function or the @code{let} removes the
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
176 local binding. While the local binding lasts, the variable's value is
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
177 stored within it. Using @code{setq} or @code{set} while there is a
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
178 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
179 not create a new binding.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
180
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
181 We also speak of the @dfn{global binding}, which is where
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
182 (conceptually) the global value is kept.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
183
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
184 @cindex current binding
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
185 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
186 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
187 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
188 @dfn{current binding} of the variable. (This rule is called
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
189 @dfn{dynamic scoping}; see @ref{Variable Scoping}.) If there are no
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
190 local bindings, the variable's global binding is its current binding.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
191 We sometimes call the current binding the @dfn{most-local existing
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
192 binding}, for emphasis. Ordinary evaluation of a symbol always returns
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
193 the value of its current binding.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
194
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
195 The special forms @code{let} and @code{let*} exist to create
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
196 local bindings.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
197
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
198 @defspec let (bindings@dots{}) forms@dots{}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
199 This special form binds variables according to @var{bindings} and then
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
200 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
201 returns the value of the last form in @var{forms}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
202
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
203 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
204 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
205 @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
206 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
207 is omitted, @code{nil} is used.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
208
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
209 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
210 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
211 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
212 @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
213
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
214 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
215 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
216 (setq y 2)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
217 @result{} 2
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
218 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
219 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
220 (let ((y 1)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
221 (z y))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
222 (list y z))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
223 @result{} (1 2)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
224 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
225 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
226 @end defspec
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
227
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
228 @defspec let* (bindings@dots{}) forms@dots{}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
229 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
230 after computing its local value, before computing the local value for
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
231 the next variable. Therefore, an expression in @var{bindings} can
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
232 reasonably refer to the preceding symbols bound in this @code{let*}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
233 form. Compare the following example with the example above for
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
234 @code{let}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
235
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
236 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
237 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
238 (setq y 2)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
239 @result{} 2
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
240 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
241 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
242 (let* ((y 1)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
243 (z y)) ; @r{Use the just-established value of @code{y}.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
244 (list y z))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
245 @result{} (1 1)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
246 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
247 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
248 @end defspec
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 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
251 bindings:
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 @itemize @bullet
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
254 @item
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
255 Function calls (@pxref{Functions}).
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 @item
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
258 Macro calls (@pxref{Macros}).
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
259
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
260 @item
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
261 @code{condition-case} (@pxref{Errors}).
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
262 @end itemize
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
263
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
264 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
265 Variables}); a few variables have terminal-local bindings
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 102306
diff changeset
266 (@pxref{Multiple Terminals}). These kinds of bindings work somewhat
85688
b210bba3f477 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
267 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
268 ``where'' you are in Emacs, rather than localized in time.
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
269
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 103102
diff changeset
270 @defopt max-specpdl-size
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
271 @anchor{Definition of max-specpdl-size}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
272 @cindex variable limit error
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
273 @cindex evaluation error
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
274 @cindex infinite recursion
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
275 This variable defines the limit on the total number of local variable
102306
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
276 bindings and @code{unwind-protect} cleanups (see @ref{Cleanups,,
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
277 Cleaning Up from Nonlocal Exits}) that are allowed before Emacs
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
278 signals an error (with data @code{"Variable binding depth exceeds
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
279 max-specpdl-size"}).
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
280
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
281 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
282 that Lisp avoids infinite recursion on an ill-defined function.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
283 @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
284 @xref{Definition of max-lisp-eval-depth,, Eval}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
285
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
286 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
287 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
288 has room to execute.
103273
c32ec20d0ab5 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option.
Martin Rudalics <rudalics@gmx.at>
parents: 103102
diff changeset
289 @end defopt
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
290
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
291 @node Void Variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
292 @section When a Variable is ``Void''
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
293 @kindex void-variable
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
294 @cindex void variable
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
295
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
296 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
297 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
298 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
299 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
300 a value.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
301
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
302 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
303 @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
304 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
305 have any value.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
306
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
307 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
308 using @code{makunbound}.
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 @defun makunbound symbol
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
311 This function makes the current variable binding of @var{symbol} void.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
312 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
313 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
314
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
315 @code{makunbound} returns @var{symbol}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
316
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
317 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
318 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
319 (makunbound 'x) ; @r{Make the global value of @code{x} void.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
320 @result{} x
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
321 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
322 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
323 x
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
324 @error{} Symbol's value as variable is void: x
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
325 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
326 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
327
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
328 If @var{symbol} is locally bound, @code{makunbound} affects the most
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
329 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
330 local binding, since all the constructs that create local bindings
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
331 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
332 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
333 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
334 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
335 reexposed binding was void all along.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
336
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
337 @smallexample
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
338 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
339 (setq x 1) ; @r{Put a value in the global binding.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
340 @result{} 1
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
341 (let ((x 2)) ; @r{Locally bind it.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
342 (makunbound 'x) ; @r{Void the local binding.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
343 x)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
344 @error{} Symbol's value as variable is void: x
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
345 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
346 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
347 x ; @r{The global binding is unchanged.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
348 @result{} 1
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 (let ((x 2)) ; @r{Locally bind it.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
351 (let ((x 3)) ; @r{And again.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
352 (makunbound 'x) ; @r{Void the innermost-local binding.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
353 x)) ; @r{And refer: it's void.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
354 @error{} Symbol's value as variable is void: x
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
355 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
356
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
357 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
358 (let ((x 2))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
359 (let ((x 3))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
360 (makunbound 'x)) ; @r{Void inner binding, then remove it.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
361 x) ; @r{Now outer @code{let} binding is visible.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
362 @result{} 2
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
363 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
364 @end smallexample
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
365 @end defun
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 A variable that has been made void with @code{makunbound} is
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
368 indistinguishable from one that has never received a value and has
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
369 always been void.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
370
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
371 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
372 currently void.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
373
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
374 @defun boundp variable
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
375 @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
376 more precisely, if its current binding is not void. It returns
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
377 @code{nil} otherwise.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
378
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
379 @smallexample
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
380 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
381 (boundp 'abracadabra) ; @r{Starts out void.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
382 @result{} nil
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
383 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
384 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
385 (let ((abracadabra 5)) ; @r{Locally bind it.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
386 (boundp 'abracadabra))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
387 @result{} t
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
388 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
389 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
390 (boundp 'abracadabra) ; @r{Still globally void.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
391 @result{} nil
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
392 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
393 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
394 (setq abracadabra 5) ; @r{Make it globally nonvoid.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
395 @result{} 5
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
396 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
397 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
398 (boundp 'abracadabra)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
399 @result{} t
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
400 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
401 @end smallexample
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
402 @end defun
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
403
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
404 @node Defining Variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
405 @section Defining Global Variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
406 @cindex variable definition
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
407
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
408 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
409 with a @dfn{variable definition}: a special form, either @code{defconst}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
410 or @code{defvar}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
411
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
412 In Emacs Lisp, definitions serve three purposes. First, they inform
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
413 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
414 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
415 of these things, supplying a value and documentation. Third, they
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
416 provide information to utilities such as @code{etags} and
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
417 @code{make-docfile}, which create data bases of the functions and
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
418 variables in a program.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
419
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
420 The difference between @code{defconst} and @code{defvar} is primarily
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
421 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
422 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
423 variable can be used based on @code{defconst} or @code{defvar}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
424 declarations. However, it does make a difference for initialization:
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
425 @code{defconst} unconditionally initializes the variable, while
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
426 @code{defvar} initializes it only if it is void.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
427
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
428 @ignore
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
429 One would expect user option variables to be defined with
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
430 @code{defconst}, since programs do not change them. Unfortunately, this
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
431 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
432 @code{defconst} would override any prior value when the library is
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
433 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
434 files, and override the default values given in the definitions. For
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
435 this reason, user options must be defined with @code{defvar}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
436 @end ignore
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 @defspec defvar symbol [value [doc-string]]
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
439 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
440 initialize and document it. The definition informs a person reading
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
441 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
442 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
443 defined must appear explicitly in the @code{defvar}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
444
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
445 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
446 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
447 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
448 evaluated, and @var{symbol}'s value remains unchanged. If @var{value}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
449 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
450
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
451 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
452 @code{defvar} operates on the default value, which is buffer-independent,
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
453 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
454 the default value is void. @xref{Buffer-Local Variables}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
455
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
456 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
457 Emacs Lisp mode (@code{eval-defun}), a special feature of
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
458 @code{eval-defun} arranges to set the variable unconditionally, without
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
459 testing whether its value is void.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
460
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
461 If the @var{doc-string} argument appears, it specifies the documentation
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
462 for the variable. (This opportunity to specify documentation is one of
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
463 the main benefits of defining the variable.) The documentation is
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
464 stored in the symbol's @code{variable-documentation} property. The
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
465 Emacs help functions (@pxref{Documentation}) look for this property.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
466
99898
d9a2d006b717 (Defining Variables): Note that `*' is not necessary if defcustom is
Chong Yidong <cyd@stupidchicken.com>
parents: 98896
diff changeset
467 If the documentation string begins with the character @samp{*}, Emacs
d9a2d006b717 (Defining Variables): Note that `*' is not necessary if defcustom is
Chong Yidong <cyd@stupidchicken.com>
parents: 98896
diff changeset
468 allows users to set it interactively using the @code{set-variable}
d9a2d006b717 (Defining Variables): Note that `*' is not necessary if defcustom is
Chong Yidong <cyd@stupidchicken.com>
parents: 98896
diff changeset
469 command. However, you should nearly always use @code{defcustom}
d9a2d006b717 (Defining Variables): Note that `*' is not necessary if defcustom is
Chong Yidong <cyd@stupidchicken.com>
parents: 98896
diff changeset
470 instead of @code{defvar} to define such variables, so that users can
d9a2d006b717 (Defining Variables): Note that `*' is not necessary if defcustom is
Chong Yidong <cyd@stupidchicken.com>
parents: 98896
diff changeset
471 use @kbd{M-x customize} and related commands to set them. In that
d9a2d006b717 (Defining Variables): Note that `*' is not necessary if defcustom is
Chong Yidong <cyd@stupidchicken.com>
parents: 98896
diff changeset
472 case, it is not necessary to begin the documentation string with
d9a2d006b717 (Defining Variables): Note that `*' is not necessary if defcustom is
Chong Yidong <cyd@stupidchicken.com>
parents: 98896
diff changeset
473 @samp{*}. @xref{Customization}.
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
474
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
475 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
476 initialize it:
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 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
479 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
480 (defvar foo)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
481 @result{} foo
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
482 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
483 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
484
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
485 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
486 it a documentation string:
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
487
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
488 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
489 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
490 (defvar bar 23
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
491 "The normal weight of a bar.")
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
492 @result{} bar
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
493 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
494 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
495
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
496 The following form changes the documentation string for @code{bar},
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
497 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
498 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
499 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
500
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
501 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
502 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
503 (defvar bar (1+ nil)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
504 "*The normal weight of a bar.")
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
505 @result{} bar
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
506 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
507 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
508 bar
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
509 @result{} 23
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
510 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
511 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
512
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
513 Here is an equivalent expression for the @code{defvar} special form:
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
514
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
515 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
516 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
517 (defvar @var{symbol} @var{value} @var{doc-string})
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
518 @equiv{}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
519 (progn
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
520 (if (not (boundp '@var{symbol}))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
521 (setq @var{symbol} @var{value}))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
522 (if '@var{doc-string}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
523 (put '@var{symbol} 'variable-documentation '@var{doc-string}))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
524 '@var{symbol})
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
525 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
526 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
527
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
528 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
529 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
530 @end defspec
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
531
105622
929678fafdb4 * variables.texi (Constant Variables): Distinguish from defconst
Chong Yidong <cyd@stupidchicken.com>
parents: 103456
diff changeset
532 @cindex constant variables
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
533 @defspec defconst symbol value [doc-string]
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
534 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
535 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
536 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
537 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
538 symbol to be defined must appear explicitly in the @code{defconst}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
539
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
540 @code{defconst} always evaluates @var{value}, and sets the value of
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
541 @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
542 binding in the current buffer, @code{defconst} sets the default value,
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
543 not the buffer-local value. (But you should not be making
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
544 buffer-local bindings for a symbol that is defined with
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
545 @code{defconst}.)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
546
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
547 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
548 by anyone (attempts by the Indiana State Legislature notwithstanding).
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
549 As the second form illustrates, however, this is only advisory.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
550
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
551 @example
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 (defconst pi 3.1415 "Pi to five places.")
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
554 @result{} pi
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 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
557 (setq pi 3)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
558 @result{} pi
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
559 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
560 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
561 pi
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
562 @result{} 3
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
563 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
564 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
565 @end defspec
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
566
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
567 @defun user-variable-p variable
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
568 @cindex user option
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
569 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
570 variable intended to be set by the user for customization---and
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
571 @code{nil} otherwise. (Variables other than user options exist for the
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
572 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
573
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
574 User option variables are distinguished from other variables either
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
575 though being declared using @code{defcustom}@footnote{They may also be
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
576 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
577 of their @code{variable-documentation} property. If the property exists
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
578 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
579 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
580 @end defun
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 @kindex variable-interactive
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
583 If a user option variable has a @code{variable-interactive} property,
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
584 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
585 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
586 specified in @code{interactive} (@pxref{Using Interactive}). However,
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
587 this feature is largely obsoleted by @code{defcustom}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
588 (@pxref{Customization}).
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 @strong{Warning:} If the @code{defconst} and @code{defvar} special
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
591 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
592 @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
593 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
594 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
595 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
596 load the file before making a local binding for the variable.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
597
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
598 @node Tips for Defining
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
599 @section Tips for Defining Variables Robustly
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
600
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
601 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
602 functions, use a name that ends in @samp{-function} or
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
603 @samp{-functions}, respectively.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
604
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
605 There are several other variable name conventions;
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
606 here is a complete list:
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
607
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
608 @table @samp
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
609 @item @dots{}-hook
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
610 The variable is a normal hook (@pxref{Hooks}).
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
611
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
612 @item @dots{}-function
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
613 The value is a function.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
614
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
615 @item @dots{}-functions
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
616 The value is a list of functions.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
617
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
618 @item @dots{}-form
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
619 The value is a form (an expression).
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{}-forms
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
622 The value is a list of forms (expressions).
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{}-predicate
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
625 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
626 non-@code{nil} for ``good'' arguments and @code{nil} for ``bad''
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
627 arguments.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
628
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
629 @item @dots{}-flag
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
630 The value is significant only as to whether it is @code{nil} or not.
101143
5a1ab0e91281 Qualify the `-flag' convention.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 100974
diff changeset
631 Since such variables often end up acquiring more values over time,
101144
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 101143
diff changeset
632 this convention is not strongly recommended.
84109
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 @item @dots{}-program
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
635 The value is a program name.
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 @item @dots{}-command
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
638 The value is a whole shell command.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
639
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
640 @item @dots{}-switches
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
641 The value specifies options for a command.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
642 @end table
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
643
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
644 When you define a variable, always consider whether you should mark
102306
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
645 it as ``safe'' or ``risky''; see @ref{File Local Variables}.
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
646
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
647 When defining and initializing a variable that holds a complicated
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
648 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
649 entire computation of the value into the @code{defvar}, like this:
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
650
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
651 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
652 (defvar my-mode-map
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
653 (let ((map (make-sparse-keymap)))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
654 (define-key map "\C-c\C-a" 'my-command)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
655 @dots{}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
656 map)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
657 @var{docstring})
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
658 @end example
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 @noindent
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
661 This method has several benefits. First, if the user quits while
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
662 loading the file, the variable is either still uninitialized or
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
663 initialized properly, never in-between. If it is still uninitialized,
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
664 reloading the file will initialize it properly. Second, reloading the
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
665 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
666 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
667 as, to rebind keys). Third, evaluating the @code{defvar} form with
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
668 @kbd{C-M-x} @emph{will} reinitialize the map completely.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
669
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
670 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
671 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
672 variable. Here's a safe way to avoid that:
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 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
675 (defvar my-mode-map nil
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
676 @var{docstring})
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
677 (unless my-mode-map
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
678 (let ((map (make-sparse-keymap)))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
679 (define-key map "\C-c\C-a" 'my-command)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
680 @dots{}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
681 (setq my-mode-map map)))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
682 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
683
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
684 @noindent
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
685 This has all the same advantages as putting the initialization inside
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
686 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
687 each form, if you do want to reinitialize the variable.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
688
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
689 But be careful not to write the code like this:
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
690
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
691 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
692 (defvar my-mode-map nil
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
693 @var{docstring})
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
694 (unless my-mode-map
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
695 (setq my-mode-map (make-sparse-keymap))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
696 (define-key my-mode-map "\C-c\C-a" 'my-command)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
697 @dots{})
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
698 @end example
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 @noindent
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
701 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
702 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
703 variable neither correctly initialized nor void nor @code{nil}. Once
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
704 that happens, reloading the file will not initialize the variable; it
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
705 will remain incomplete.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
706
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
707 @node Accessing Variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
708 @section Accessing Variable Values
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
709
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
710 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
711 names it (@pxref{Symbol Forms}). This requires you to specify the
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
712 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
713 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
714 variable to reference; then you can use @code{symbol-value}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
715
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
716 @defun symbol-value symbol
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
717 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
718 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
719 has no local bindings.
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 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
722 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
723 (setq abracadabra 5)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
724 @result{} 5
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
725 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
726 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
727 (setq foo 9)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
728 @result{} 9
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
729 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
730
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
731 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
732 ;; @r{Here the symbol @code{abracadabra}}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
733 ;; @r{is the symbol whose value is examined.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
734 (let ((abracadabra 'foo))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
735 (symbol-value 'abracadabra))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
736 @result{} foo
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
737 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
738
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
739 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
740 ;; @r{Here, the value of @code{abracadabra},}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
741 ;; @r{which is @code{foo},}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
742 ;; @r{is the symbol whose value is examined.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
743 (let ((abracadabra 'foo))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
744 (symbol-value abracadabra))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
745 @result{} 9
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
746 @end group
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 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
749 (symbol-value 'abracadabra)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
750 @result{} 5
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
751 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
752 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
753
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
754 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
755 @var{symbol} is void.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
756 @end defun
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
757
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
758 @node Setting Variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
759 @section How to Alter a Variable Value
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 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
762 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
763 run time, use the function @code{set}.
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 @defspec setq [symbol form]@dots{}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
766 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
767 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
768 evaluating the corresponding @var{form}. The most-local existing
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
769 binding of the symbol is changed.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
770
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
771 @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
772 write. We say that this argument is @dfn{automatically quoted}. The
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
773 @samp{q} in @code{setq} stands for ``quoted.''
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
774
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
775 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
776
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
777 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
778 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
779 (setq x (1+ 2))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
780 @result{} 3
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
781 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
782 x ; @r{@code{x} now has a global value.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
783 @result{} 3
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
784 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
785 (let ((x 5))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
786 (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
787 x)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
788 @result{} 6
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
789 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
790 x ; @r{The global value is unchanged.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
791 @result{} 3
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
792 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
793
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
794 Note that the first @var{form} is evaluated, then the first
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
795 @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
796 second @var{symbol} is set, and so on:
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
797
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
798 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
799 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
800 (setq x 10 ; @r{Notice that @code{x} is set before}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
801 y (1+ x)) ; @r{the value of @code{y} is computed.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
802 @result{} 11
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
803 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
804 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
805 @end defspec
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
806
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
807 @defun set symbol value
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
808 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
809 @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
810 @var{symbol} is evaluated to obtain the symbol to set.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
811
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
812 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
813 set; shadowed bindings are not affected.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
814
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
815 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
816 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
817 (set one 1)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
818 @error{} Symbol's value as variable is void: one
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
819 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
820 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
821 (set 'one 1)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
822 @result{} 1
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
823 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
824 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
825 (set 'two 'one)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
826 @result{} one
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
827 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
828 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
829 (set two 2) ; @r{@code{two} evaluates to symbol @code{one}.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
830 @result{} 2
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
831 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
832 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
833 one ; @r{So it is @code{one} that was set.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
834 @result{} 2
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
835 (let ((one 1)) ; @r{This binding of @code{one} is set,}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
836 (set 'one 3) ; @r{not the global value.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
837 one)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
838 @result{} 3
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
839 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
840 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
841 one
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
842 @result{} 2
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
843 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
844 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
845
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
846 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
847 error is signaled.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
848
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
849 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
850 (set '(x y) 'z)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
851 @error{} Wrong type argument: symbolp, (x y)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
852 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
853
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
854 Logically speaking, @code{set} is a more fundamental primitive than
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
855 @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
856 @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
857 availability of @code{set}. However, @code{set} itself is rarely used;
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
858 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
859 at run time which variable to set. For example, the command
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
860 @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
861 sets the variable, needs to use @code{set}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
862
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
863 @cindex CL note---@code{set} local
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
864 @quotation
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
865 @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
866 symbol's ``special'' or dynamic value, ignoring any lexical bindings.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
867 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
868 always affects the most local existing binding.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
869 @end quotation
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
870 @end defun
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
871
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
872 @node Variable Scoping
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
873 @section Scoping Rules for Variable Bindings
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
874
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
875 A given symbol @code{foo} can have several local variable bindings,
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
876 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
877 binding. The most recently established binding takes precedence over
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
878 the others.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
879
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
880 @cindex scope
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
881 @cindex extent
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
882 @cindex dynamic scoping
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
883 @cindex lexical scoping
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
884 Local bindings in Emacs Lisp have @dfn{indefinite scope} and
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
885 @dfn{dynamic extent}. @dfn{Scope} refers to @emph{where} textually in
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
886 the source code the binding can be accessed. ``Indefinite scope'' means
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
887 that any part of the program can potentially access the variable
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
888 binding. @dfn{Extent} refers to @emph{when}, as the program is
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
889 executing, the binding exists. ``Dynamic extent'' means that the binding
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
890 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
891
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
892 The combination of dynamic extent and indefinite scope is called
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
893 @dfn{dynamic scoping}. By contrast, most programming languages use
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
894 @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
895 located textually within the function or block that binds the variable.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
896
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
897 @cindex CL note---special variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
898 @quotation
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
899 @b{Common Lisp note:} Variables declared ``special'' in Common Lisp are
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
900 dynamically scoped, like all variables in Emacs Lisp.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
901 @end quotation
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
902
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
903 @menu
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
904 * Scope:: Scope means where in the program a value is visible.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
905 Comparison with other languages.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
906 * Extent:: Extent means how long in time a value exists.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
907 * Impl of Scope:: Two ways to implement dynamic scoping.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
908 * Using Scoping:: How to use dynamic scoping carefully and avoid problems.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
909 @end menu
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
910
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
911 @node Scope
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
912 @subsection Scope
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
913
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
914 Emacs Lisp uses @dfn{indefinite scope} for local variable bindings.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
915 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
916 given binding of a variable. Consider the following function
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
917 definitions:
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
918
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
919 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
920 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
921 (defun binder (x) ; @r{@code{x} is bound in @code{binder}.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
922 (foo 5)) ; @r{@code{foo} is some other function.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
923 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
924
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
925 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
926 (defun user () ; @r{@code{x} is used ``free'' in @code{user}.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
927 (list x))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
928 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
929 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
930
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
931 In a lexically scoped language, the binding of @code{x} in
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
932 @code{binder} would never be accessible in @code{user}, because
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
933 @code{user} is not textually contained within the function
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
934 @code{binder}. However, in dynamically-scoped Emacs Lisp, @code{user}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
935 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
936 @code{binder}, depending on the circumstances:
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 @itemize @bullet
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
939 @item
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
940 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
941 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
942 @code{binder}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
943
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
944 @item
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
945 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
946 binding made in @code{binder} will be seen in @code{user}:
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
947
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
948 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
949 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
950 (defun foo (lose)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
951 (user))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
952 @end group
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 @item
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
956 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
957 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
958 @code{user}:
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
959
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
960 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
961 (defun foo (x)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
962 (user))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
963 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
964
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
965 @noindent
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
966 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
967 (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
968 @code{binder}.) Therefore, @code{user} will access the @code{x} bound
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
969 by @code{foo} instead of the one bound by @code{binder}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
970 @end itemize
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 Emacs Lisp uses dynamic scoping because simple implementations of
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
973 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
974 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
975 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
976 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
977 implementing it with dynamic scoping only was much easier.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
978
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
979 @node Extent
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
980 @subsection Extent
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
981
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
982 @dfn{Extent} refers to the time during program execution that a
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
983 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
984 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
985 extent}. ``Local'' or ``automatic'' variables in most languages,
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
986 including C and Pascal, have dynamic extent.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
987
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
988 One alternative to dynamic extent is @dfn{indefinite extent}. This
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
989 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
990 that made the binding. Common Lisp and Scheme, for example, support
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
991 this, but Emacs Lisp does not.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
992
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
993 To illustrate this, the function below, @code{make-add}, returns a
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
994 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
995 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
996 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
997 is no longer bound to the actual argument 2.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
998
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
999 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1000 (defun make-add (n)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1001 (function (lambda (m) (+ n m)))) ; @r{Return a function.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1002 @result{} make-add
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1003 (fset 'add2 (make-add 2)) ; @r{Define function @code{add2}}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1004 ; @r{with @code{(make-add 2)}.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1005 @result{} (lambda (m) (+ n m))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1006 (add2 4) ; @r{Try to add 2 to 4.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1007 @error{} Symbol's value as variable is void: n
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1008 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1009
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1010 @cindex closures not available
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1011 Some Lisp dialects have ``closures,'' objects that are like functions
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1012 but record additional variable bindings. Emacs Lisp does not have
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1013 closures.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1014
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1015 @node Impl of Scope
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1016 @subsection Implementation of Dynamic Scoping
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1017 @cindex deep binding
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 A simple sample implementation (which is not how Emacs Lisp actually
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1020 works) may help you understand dynamic binding. This technique is
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1021 called @dfn{deep binding} and was used in early Lisp systems.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1022
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1023 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
1024 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
1025 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
1026 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
1027 construct.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1028
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1029 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
1030 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
1031 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
1032 current binding, then store the new value into that binding.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1033
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1034 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
1035 continues execution, even during its calls to other functions. That is
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1036 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
1037 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
1038 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
1039
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1040 @cindex shallow binding
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1041 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
1042 technique called @dfn{shallow binding}. Each variable has a standard
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1043 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
1044 symbol.
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 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
1047 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
1048 (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
1049 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
1050 the old value off the stack, into the value cell.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1051
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1052 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
1053 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
1054 binding.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1055
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1056 @node Using Scoping
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1057 @subsection Proper Use of Dynamic Scoping
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 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
1060 powerful technique, but if used without restraint, it can make programs
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1061 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
1062
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1063 @itemize @bullet
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1064 @item
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1065 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
1066 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
1067 one program.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1068
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1069 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
1070 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
1071 elsewhere.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1072
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1073 @item
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1074 Give the variable a well-defined, documented meaning, and make all
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1075 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
1076 that meaning is relevant. For example, the variable
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1077 @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
1078 when searching''; various search and replace functions refer to it
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1079 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
1080
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1081 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
1082 the effect will be.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1083 @end itemize
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1084
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1085 In either case, you should define the variable with @code{defvar}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1086 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
1087 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
1088 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
1089 use short names like @code{x}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1090
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1091 @node Buffer-Local Variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1092 @section Buffer-Local Variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1093 @cindex variable, buffer-local
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1094 @cindex buffer-local variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1095
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1096 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
1097 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
1098 additional, unusual kinds of variable binding, such as
b210bba3f477 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
1099 @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
1100 different values for a variable in different buffers is an important
102306
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1101 customization method. (Variables can also have bindings that are
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 102306
diff changeset
1102 local to each terminal, or to each frame. @xref{Multiple Terminals},
102306
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1103 and @xref{Frame-Local Variables}.)
84109
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 @menu
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1106 * Intro to Buffer-Local:: Introduction and concepts.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1107 * Creating Buffer-Local:: Creating and destroying buffer-local bindings.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1108 * Default Value:: The default value is seen in buffers
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1109 that don't have their own buffer-local values.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1110 @end menu
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 @node Intro to Buffer-Local
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1113 @subsection Introduction to Buffer-Local Variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1114
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1115 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
1116 particular buffer. The binding is in effect when that buffer is
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1117 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
1118 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
1119 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
1120 visible only in the buffer where you made it.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1121
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1122 The variable's ordinary binding, which is not associated with any
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1123 specific buffer, is called the @dfn{default binding}. In most cases,
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1124 this is the global binding.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1125
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1126 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
1127 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
1128 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
1129 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
1130 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
1131 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
1132 binding.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1133
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1134 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
1135 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
1136 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
1137 blank lines separate paragraphs. They do this by making the variable
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1138 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
1139 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
1140
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1141 The usual way to make a buffer-local binding is with
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1142 @code{make-local-variable}, which is what major mode commands typically
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1143 use. This affects just the current buffer; all other buffers (including
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1144 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
1145 they are explicitly given their own buffer-local bindings.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1146
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1147 @cindex automatically buffer-local
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1148 A more powerful operation is to mark the variable as
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1149 @dfn{automatically buffer-local} by calling
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1150 @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
1151 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
1152 precisely, the effect is that setting the variable automatically makes
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1153 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
1154 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
1155 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
1156 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
1157 the default binding untouched. This means that the default value cannot
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1158 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
1159 with @code{setq-default}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1160
85688
b210bba3f477 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
1161 @strong{Warning:} When a variable has buffer-local
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1162 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
1163 currently in effect. For instance, if the current buffer has a
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1164 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
1165 buffer-local bindings are in effect, @code{let} rebinds
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1166 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
1167 different current buffer in which a different binding is in effect,
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1168 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
1169 @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
1170 unbinding occur (though it will occur properly). Here is an example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1171 to illustrate:
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1172
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1173 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1174 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1175 (setq foo 'g)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1176 (set-buffer "a")
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1177 (make-local-variable 'foo)
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 (setq foo 'a)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1180 (let ((foo 'temp))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1181 ;; foo @result{} 'temp ; @r{let binding in buffer @samp{a}}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1182 (set-buffer "b")
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1183 ;; 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
1184 @var{body}@dots{})
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1185 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1186 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
1187 ; @r{but we don't see that in buffer @samp{b}}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1188 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1189 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1190 (set-buffer "a") ; @r{verify the local value was restored}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1191 foo @result{} 'a
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1192 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1193 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1194
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1195 Note that references to @code{foo} in @var{body} access the
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1196 buffer-local binding of buffer @samp{b}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1197
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1198 When a file specifies local variable values, these become buffer-local
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1199 values when you visit the file. @xref{File Variables,,, emacs, The
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1200 GNU Emacs Manual}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1201
102306
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1202 A buffer-local variable cannot be made frame-local
98680
0cc86df465ef (Frame-Local Variables): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 87649
diff changeset
1203 (@pxref{Frame-Local Variables}) or terminal-local (@pxref{Multiple
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 102306
diff changeset
1204 Terminals}).
98680
0cc86df465ef (Frame-Local Variables): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 87649
diff changeset
1205
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1206 @node Creating Buffer-Local
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1207 @subsection Creating and Deleting Buffer-Local Bindings
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 @deffn Command make-local-variable variable
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1210 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
1211 @var{variable} (a symbol). Other buffers are not affected. The value
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1212 returned is @var{variable}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1213
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1214 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
1215 @var{variable} previously had. If @var{variable} was void, it remains
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1216 void.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1217
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1218 @example
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 ;; @r{In buffer @samp{b1}:}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1221 (setq foo 5) ; @r{Affects all buffers.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1222 @result{} 5
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1223 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1224 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1225 (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
1226 @result{} foo
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1227 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1228 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1229 foo ; @r{That did not change}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1230 @result{} 5 ; @r{the value.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1231 @end group
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 (setq foo 6) ; @r{Change the value}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1234 @result{} 6 ; @r{in @samp{b1}.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1235 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1236 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1237 foo
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1238 @result{} 6
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1239 @end group
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 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1242 ;; @r{In buffer @samp{b2}, the value hasn't changed.}
106731
79fa2d910b72 Avoid dubious uses of save-excursions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105622
diff changeset
1243 (with-current-buffer "b2"
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1244 foo)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1245 @result{} 5
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1246 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1247 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1248
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1249 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
1250 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
1251 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
1252 because @code{let} does not distinguish between different kinds of
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1253 bindings; it knows only which variable the binding was made for.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1254
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 102306
diff changeset
1255 If the variable is terminal-local (@pxref{Multiple Terminals}), or
98680
0cc86df465ef (Frame-Local Variables): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 87649
diff changeset
1256 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
1257 error. Such variables cannot have buffer-local bindings as well.
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1258
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1259 @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
1260 variable. The hook variables are automatically made buffer-local as
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1261 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
1262 @code{remove-hook}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1263 @end deffn
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1264
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1265 @deffn Command make-variable-buffer-local variable
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1266 This function marks @var{variable} (a symbol) automatically
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1267 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
1268 local to the current buffer at the time.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1269
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1270 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
1271 @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
1272 binding for it. Only setting the variable (with @code{set} or
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1273 @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
1274 binding that was made in the current buffer, does so.
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 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
1277 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
1278 already has a default value, that value remains unchanged.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1279 Subsequently calling @code{makunbound} on @var{variable} will result
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1280 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
1281
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1282 The value returned is @var{variable}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1283
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1284 @strong{Warning:} Don't assume that you should use
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1285 @code{make-variable-buffer-local} for user-option variables, simply
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1286 because users @emph{might} want to customize them differently in
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1287 different buffers. Users can make any variable local, when they wish
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1288 to. It is better to leave the choice to them.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1289
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1290 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
1291 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
1292 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
1293 on having separate values in separate buffers, then using
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1294 @code{make-variable-buffer-local} can be the best solution.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1295 @end deffn
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1296
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1297 @defun local-variable-p variable &optional buffer
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1298 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
1299 @var{buffer} (which defaults to the current buffer); otherwise,
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1300 @code{nil}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1301 @end defun
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1302
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1303 @defun local-variable-if-set-p variable &optional buffer
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1304 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
1305 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
1306 set there.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1307 @end defun
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1308
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1309 @defun buffer-local-value variable buffer
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1310 This function returns the buffer-local binding of @var{variable} (a
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1311 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
1312 buffer-local binding in buffer @var{buffer}, it returns the default
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1313 value (@pxref{Default Value}) of @var{variable} instead.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1314 @end defun
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 @defun buffer-local-variables &optional buffer
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1317 This function returns a list describing the buffer-local variables in
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1318 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
1319 used.) It returns an association list (@pxref{Association Lists}) in
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1320 which each element contains one buffer-local variable and its value.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1321 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
1322 then the variable appears directly in the resulting list.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1323
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1324 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1325 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1326 (make-local-variable 'foobar)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1327 (makunbound 'foobar)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1328 (make-local-variable 'bind-me)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1329 (setq bind-me 69)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1330 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1331 (setq lcl (buffer-local-variables))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1332 ;; @r{First, built-in variables local in all buffers:}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1333 @result{} ((mark-active . nil)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1334 (buffer-undo-list . nil)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1335 (mode-name . "Fundamental")
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1336 @dots{}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1337 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1338 ;; @r{Next, non-built-in buffer-local variables.}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1339 ;; @r{This one is buffer-local and void:}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1340 foobar
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1341 ;; @r{This one is buffer-local and nonvoid:}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1342 (bind-me . 69))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1343 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1344 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1345
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1346 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
1347 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
1348 @end defun
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 @deffn Command kill-local-variable variable
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1351 This function deletes the buffer-local binding (if any) for
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1352 @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
1353 default binding of @var{variable} becomes visible in this buffer. This
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1354 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
1355 default value is usually different from the buffer-local value just
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1356 eliminated.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1357
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1358 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
1359 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
1360 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
1361 once again create a buffer-local binding for it.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1362
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1363 @code{kill-local-variable} returns @var{variable}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1364
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1365 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
1366 buffer-local variable interactively, just as it is useful to create
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1367 buffer-local variables interactively.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1368 @end deffn
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1369
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1370 @defun kill-all-local-variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1371 This function eliminates all the buffer-local variable bindings of the
98734
f20cbcf45bb3 (Creating Buffer-Local): Add an xref to "Setting Hooks" for the effect
Eli Zaretskii <eliz@gnu.org>
parents: 98680
diff changeset
1372 current buffer except for variables marked as ``permanent'' and local
f20cbcf45bb3 (Creating Buffer-Local): Add an xref to "Setting Hooks" for the effect
Eli Zaretskii <eliz@gnu.org>
parents: 98680
diff changeset
1373 hook functions that have a non-@code{nil} @code{permanent-local-hook}
f20cbcf45bb3 (Creating Buffer-Local): Add an xref to "Setting Hooks" for the effect
Eli Zaretskii <eliz@gnu.org>
parents: 98680
diff changeset
1374 property (@pxref{Setting Hooks}). As a result, the buffer will see
f20cbcf45bb3 (Creating Buffer-Local): Add an xref to "Setting Hooks" for the effect
Eli Zaretskii <eliz@gnu.org>
parents: 98680
diff changeset
1375 the default values of most variables.
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1376
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1377 This function also resets certain other information pertaining to the
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1378 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
1379 value of @code{(standard-syntax-table)}, the case table to
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1380 @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
1381 @code{fundamental-mode-abbrev-table}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1382
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1383 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
1384 @code{change-major-mode-hook} (see below).
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1385
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1386 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
1387 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
1388 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
1389 variables that major modes set should not be marked permanent.
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 @code{kill-all-local-variables} returns @code{nil}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1392 @end defun
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1393
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1394 @defvar change-major-mode-hook
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1395 The function @code{kill-all-local-variables} runs this normal hook
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1396 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
1397 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
1398 major mode. It is also useful for buffer-specific minor modes
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1399 that should be forgotten if the user changes the major mode.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1400
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1401 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
1402 disappear after doing its job and will not interfere with the
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1403 subsequent major mode. @xref{Hooks}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1404 @end defvar
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1405
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1406 @c Emacs 19 feature
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1407 @cindex permanent local variable
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1408 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
1409 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
1410 Permanent locals are appropriate for data pertaining to where the file
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1411 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
1412
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1413 @node Default Value
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1414 @subsection The Default Value of a Buffer-Local Variable
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1415 @cindex default value
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1416
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1417 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
1418 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
1419 effect whenever neither the current buffer nor the selected frame has
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1420 its own binding for the variable.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1421
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1422 The functions @code{default-value} and @code{setq-default} access and
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1423 change a variable's default value regardless of whether the current
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1424 buffer has a buffer-local binding. For example, you could use
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1425 @code{setq-default} to change the default setting of
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1426 @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
1427 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
1428 this variable.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1429
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1430 @c Emacs 19 feature
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1431 The special forms @code{defvar} and @code{defconst} also set the
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1432 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
1433 buffer-local value.
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1434
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1435 @defun default-value symbol
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1436 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
1437 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
1438 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
1439 to @code{symbol-value} (@pxref{Accessing Variables}).
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 @c Emacs 19 feature
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1443 @defun default-boundp symbol
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1444 The function @code{default-boundp} tells you whether @var{symbol}'s
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1445 default value is nonvoid. If @code{(default-boundp 'foo)} returns
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1446 @code{nil}, then @code{(default-value 'foo)} would get an error.
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 @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
1449 @code{symbol-value}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1450 @end defun
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1451
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1452 @defspec setq-default [symbol form]@dots{}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1453 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
1454 the result of evaluating the corresponding @var{form}. It does not
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1455 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
1456 @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
1457
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1458 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
1459 marked automatically buffer-local, @code{setq-default} has the same
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1460 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
1461 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
1462 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
1463 current buffer sees.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1464
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1465 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1466 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1467 ;; @r{In buffer @samp{foo}:}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1468 (make-local-variable 'buffer-local)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1469 @result{} buffer-local
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1470 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1471 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1472 (setq buffer-local 'value-in-foo)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1473 @result{} value-in-foo
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1474 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1475 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1476 (setq-default buffer-local 'new-default)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1477 @result{} new-default
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1478 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1479 @group
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{} value-in-foo
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
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1488 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1489 ;; @r{In (the new) buffer @samp{bar}:}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1490 buffer-local
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1491 @result{} new-default
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1492 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1493 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1494 (default-value 'buffer-local)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1495 @result{} new-default
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1496 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1497 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1498 (setq buffer-local 'another-default)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1499 @result{} another-default
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1500 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1501 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1502 (default-value 'buffer-local)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1503 @result{} another-default
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1504 @end group
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 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1507 ;; @r{Back in buffer @samp{foo}:}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1508 buffer-local
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1509 @result{} value-in-foo
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1510 (default-value 'buffer-local)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1511 @result{} another-default
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1512 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1513 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1514 @end defspec
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1515
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1516 @defun set-default symbol value
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1517 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
1518 an ordinary evaluated argument.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1519
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1520 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1521 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1522 (set-default (car '(a b c)) 23)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1523 @result{} 23
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1524 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1525 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1526 (default-value 'a)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1527 @result{} 23
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1528 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1529 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1530 @end defun
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1531
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1532 @node File Local Variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1533 @section File Local Variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1534 @cindex file local variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1535
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1536 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
1537 buffer-local bindings for those variables in the buffer visiting that
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1538 file. @xref{File variables, , Local Variables in Files, emacs, The
102306
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1539 GNU Emacs Manual}, for basic information about file-local variables.
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1540 This section describes the functions and variables that affect how
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1541 file-local variables are processed.
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1542
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1543 If a file-local variable could specify an arbitrary function or Lisp
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1544 expression that would be called later, visiting a file could take over
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1545 your Emacs. Emacs protects against this by automatically setting only
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1546 those file-local variables whose specified values are known to be
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1547 safe. Other file-local variables are set only if the user agrees.
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1548
103102
789636652cc9 * variables.texi (File Local Variables): Note that read-circle is
Chong Yidong <cyd@stupidchicken.com>
parents: 102846
diff changeset
1549 For additional safety, @code{read-circle} is temporarily bound to
789636652cc9 * variables.texi (File Local Variables): Note that read-circle is
Chong Yidong <cyd@stupidchicken.com>
parents: 102846
diff changeset
1550 @code{nil} when Emacs reads file-local variables (@pxref{Input
789636652cc9 * variables.texi (File Local Variables): Note that read-circle is
Chong Yidong <cyd@stupidchicken.com>
parents: 102846
diff changeset
1551 Functions}). This prevents the Lisp reader from recognizing circular
789636652cc9 * variables.texi (File Local Variables): Note that read-circle is
Chong Yidong <cyd@stupidchicken.com>
parents: 102846
diff changeset
1552 and shared Lisp structures (@pxref{Circular Objects}).
789636652cc9 * variables.texi (File Local Variables): Note that read-circle is
Chong Yidong <cyd@stupidchicken.com>
parents: 102846
diff changeset
1553
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1554 @defopt enable-local-variables
102306
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1555 This variable controls whether to process file-local variables.
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1556 The possible values are:
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1557
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1558 @table @asis
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1559 @item @code{t} (the default)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1560 Set the safe variables, and query (once) about any unsafe variables.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1561 @item @code{:safe}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1562 Set only the safe variables and do not query.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1563 @item @code{:all}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1564 Set all the variables and do not query.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1565 @item @code{nil}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1566 Don't set any variables.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1567 @item anything else
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1568 Query (once) about all the variables.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1569 @end table
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1570 @end defopt
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1571
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1572 @defun hack-local-variables &optional mode-only
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1573 This function parses, and binds or evaluates as appropriate, any local
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1574 variables specified by the contents of the current buffer. The variable
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1575 @code{enable-local-variables} has its effect here. However, this
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1576 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
1577 @w{@samp{-*-}} line. @code{set-auto-mode} does that, also taking
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1578 @code{enable-local-variables} into account (@pxref{Auto Major Mode}).
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1579
98881
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1580 This function works by walking the alist stored in
98896
b04b1b0d5866 (File Local Variables): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 98881
diff changeset
1581 @code{file-local-variables-alist} and applying each local variable in
98881
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1582 turn. It calls @code{before-hack-local-variables-hook} and
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1583 @code{hack-local-variables-hook} before and after applying the
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1584 variables, respectively.
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1585
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1586 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
1587 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
1588 the local variables list specifies a mode and @code{nil} otherwise.
102306
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1589 It does not set the mode nor any other file-local variable.
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1590 @end defun
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1591
98881
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1592 @defvar file-local-variables-alist
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1593 This buffer-local variable holds the alist of file-local variable
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1594 settings. Each element of the alist is of the form
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1595 @w{@code{(@var{var} . @var{value})}}, where @var{var} is a symbol of
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1596 the local variable and @var{value} is its value. When Emacs visits a
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1597 file, it first collects all the file-local variables into this alist,
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1598 and then the @code{hack-local-variables} function applies them one by
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1599 one.
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1600 @end defvar
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1601
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1602 @defvar before-hack-local-variables-hook
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1603 Emacs calls this hook immediately before applying file-local variables
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1604 stored in @code{file-local-variables-alist}.
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1605 @end defvar
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1606
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1607 @defvar hack-local-variables-hook
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1608 Emacs calls this hook immediately after it finishes applying
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1609 file-local variables stored in @code{file-local-variables-alist}.
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1610 @end defvar
a6d974af2bf4 (File Local Variables): Document `file-local-variables-alist',
Eli Zaretskii <eliz@gnu.org>
parents: 98734
diff changeset
1611
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1612 @cindex safe local variable
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1613 You can specify safe values for a variable with a
102306
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1614 @code{safe-local-variable} property. The property has to be a
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1615 function of one argument; any value is safe if the function returns
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1616 non-@code{nil} given that value. Many commonly-encountered file
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1617 variables have @code{safe-local-variable} properties; these include
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1618 @code{fill-column}, @code{fill-prefix}, and @code{indent-tabs-mode}.
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1619 For boolean-valued variables that are safe, use @code{booleanp} as the
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1620 property value. Lambda expressions should be quoted so that
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1621 @code{describe-variable} can display the predicate.
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1622
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1623 @defopt safe-local-variable-values
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1624 This variable provides another way to mark some variable values as
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1625 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
1626 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
1627 safe for that variable.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1628
102306
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1629 When Emacs asks the user whether or not to obey a set of file-local
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1630 variable specifications, the user can choose to mark them as safe.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1631 Doing so adds those variable/value pairs to
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1632 @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
1633 file.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1634 @end defopt
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1635
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1636 @defun safe-local-variable-p sym val
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1637 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
1638 the value @var{val}, based on the above criteria.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1639 @end defun
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 @c @cindex risky local variable Duplicates risky-local-variable
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1642 Some variables are considered @dfn{risky}. A variable whose name
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1643 ends in any of @samp{-command}, @samp{-frame-alist}, @samp{-function},
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1644 @samp{-functions}, @samp{-hook}, @samp{-hooks}, @samp{-form},
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1645 @samp{-forms}, @samp{-map}, @samp{-map-alist}, @samp{-mode-alist},
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1646 @samp{-program}, or @samp{-predicate} is considered risky. The
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1647 variables @samp{font-lock-keywords}, @samp{font-lock-keywords}
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1648 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
1649 considered risky. Finally, any variable whose name has a
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1650 non-@code{nil} @code{risky-local-variable} property is considered
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1651 risky.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1652
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1653 @defun risky-local-variable-p sym
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1654 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
1655 based on the above criteria.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1656 @end defun
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 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
1659 @code{safe-local-variable-values} as described above. Therefore,
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1660 Emacs will always query before setting a risky variable, unless the
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1661 user explicitly allows the setting by customizing
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1662 @code{safe-local-variable-values} directly.
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 @defvar ignored-local-variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1665 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
1666 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
1667 completely ignored.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1668 @end defvar
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1669
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1670 The @samp{Eval:} ``variable'' is also a potential loophole, so Emacs
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1671 normally asks for confirmation before handling it.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1672
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1673 @defopt enable-local-eval
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1674 This variable controls processing of @samp{Eval:} in @samp{-*-} lines
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1675 or local variables
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1676 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
1677 unconditionally; @code{nil} means ignore them; anything else means ask
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1678 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
1679 @end defopt
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1680
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1681 @defopt safe-local-eval-forms
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1682 This variable holds a list of expressions that are safe to
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1683 evaluate when found in the @samp{Eval:} ``variable'' in a file
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1684 local variables list.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1685 @end defopt
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1686
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1687 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
1688 @code{safe-local-eval-function} property, the property value
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1689 determines whether the expression is safe to evaluate. The property
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1690 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
1691 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
1692 (always safe provided the arguments are constant).
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1693
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1694 Text properties are also potential loopholes, since their values
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1695 could include functions to call. So Emacs discards all text
102306
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1696 properties from string values specified for file-local variables.
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1697
100710
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1698 @node Directory Local Variables
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1699 @section Directory Local Variables
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1700 @cindex directory local variables
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1701
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1702 A directory can specify local variable values common to all files in
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1703 that directory; Emacs uses these to create buffer-local bindings for
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1704 those variables in buffers visiting any file in that directory. This
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1705 is useful when the files in the directory belong to some @dfn{project}
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1706 and therefore share the same local variables.
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1707
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1708 There are two different methods for specifying directory local
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1709 variables: by putting them in a special file, or by defining a
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1710 @dfn{project class} for that directory.
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1711
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1712 @defvr Constant dir-locals-file
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1713 This constant is the name of the file where Emacs expects to find the
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1714 directory-local variables. The name of the file is
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1715 @file{.dir-locals.el}@footnote{
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1716 The MS-DOS version of Emacs uses @file{_dir-locals.el} instead, due to
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1717 limitations of the DOS filesystems.
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1718 }. A file by that name in a directory causes Emacs to apply its
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1719 settings to any file in that directory or any of its subdirectories.
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1720 If some of the subdirectories have their own @file{.dir-locals.el}
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1721 files, Emacs uses the settings from the deepest file it finds starting
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1722 from the file's directory and moving up the directory tree. The file
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1723 specifies local variables as a specially formatted list; see
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1724 @ref{Directory Variables, , Per-directory Local Variables, emacs, The
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1725 GNU Emacs Manual}, for more details.
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1726 @end defvr
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1727
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1728 @defun hack-dir-local-variables
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1729 This function reads the @code{.dir-locals.el} file and stores the
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1730 directory-local variables in @code{file-local-variables-alist} that is
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1731 local to the buffer visiting any file in the directory, without
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1732 applying them. It also stores the directory-local settings in
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1733 @code{dir-locals-class-alist}, where it defines a special class for
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1734 the directory in which @file{.dir-locals.el} file was found. This
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1735 function works by calling @code{dir-locals-set-class-variables} and
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1736 @code{dir-locals-set-directory-class}, described below.
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1737 @end defun
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1738
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1739 @defun dir-locals-set-class-variables class variables
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1740 This function defines a set of variable settings for the named
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1741 @var{class}, which is a symbol. You can later assign the class to one
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1742 or more directories, and Emacs will apply those variable settings to
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1743 all files in those directories. The list in @var{variables} can be of
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1744 one of the two forms: @code{(@var{major-mode} . @var{alist})} or
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1745 @code{(@var{directory} . @var{list})}. With the first form, if the
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1746 file's buffer turns on a mode that is derived from @var{major-mode},
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1747 then the all the variables in the associated @var{alist} are applied;
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1748 @var{alist} should be of the form @code{(@var{name} . @var{value})}.
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1749 A special value @code{nil} for @var{major-mode} means the settings are
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1750 applicable to any mode.
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1751
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1752 With the second form of @var{variables}, if @var{directory} is the
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1753 initial substring of the file's directory, then @var{list} is applied
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1754 recursively by following the above rules; @var{list} should be of one
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1755 of the two forms accepted by this function in @var{variables}.
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1756 @end defun
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1757
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1758 @defun dir-locals-set-directory-class directory class
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1759 This function assigns @var{class} to all the files in @code{directory}
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1760 and its subdirectories. Thereafter, all the variable settings
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1761 specified for @var{class} will be applied to any visited file in
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1762 @var{directory} and its children. @var{class} must have been already
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1763 defined by @code{dir-locals-set-class-variables}
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1764 @end defun
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1765
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1766 @defvar dir-locals-class-alist
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1767 This alist holds the class symbols and the associated variable
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1768 settings. It is updated by @code{dir-locals-set-class-variables}.
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1769 @end defvar
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1770
103456
22a2d318807d (Directory Local Variables): Update for 2009-04-11 name-change of
Glenn Morris <rgm@gnu.org>
parents: 103273
diff changeset
1771 @defvar dir-locals-directory-cache
22a2d318807d (Directory Local Variables): Update for 2009-04-11 name-change of
Glenn Morris <rgm@gnu.org>
parents: 103273
diff changeset
1772 This alist holds directory names, their assigned class names, and
22a2d318807d (Directory Local Variables): Update for 2009-04-11 name-change of
Glenn Morris <rgm@gnu.org>
parents: 103273
diff changeset
1773 modification times of the associated directory local variables file.
22a2d318807d (Directory Local Variables): Update for 2009-04-11 name-change of
Glenn Morris <rgm@gnu.org>
parents: 103273
diff changeset
1774 It is updated by @code{dir-locals-set-directory-class}.
100710
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1775 @end defvar
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1776
98680
0cc86df465ef (Frame-Local Variables): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 87649
diff changeset
1777 @node Frame-Local Variables
0cc86df465ef (Frame-Local Variables): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 87649
diff changeset
1778 @section Frame-Local Values for Variables
0cc86df465ef (Frame-Local Variables): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 87649
diff changeset
1779 @cindex frame-local variables
0cc86df465ef (Frame-Local Variables): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 87649
diff changeset
1780
0cc86df465ef (Frame-Local Variables): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 87649
diff changeset
1781 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
1782 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
1783 binding for a variable is in effect in a frame for which it was
102306
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1784 defined.
98680
0cc86df465ef (Frame-Local Variables): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 87649
diff changeset
1785
102306
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1786 In practice, frame-local variables have not proven very useful.
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1787 Ordinary frame parameters are generally used instead (@pxref{Frame
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1788 Parameters}). The function @code{make-variable-frame-local}, which
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1789 was used to define frame-local variables, has been deprecated since
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1790 Emacs 22.2. However, you can still define a frame-specific binding
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1791 for a variable @var{var} in frame @var{frame}, by setting the
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1792 @var{var} frame parameter for that frame:
98680
0cc86df465ef (Frame-Local Variables): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 87649
diff changeset
1793
0cc86df465ef (Frame-Local Variables): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 87649
diff changeset
1794 @lisp
0cc86df465ef (Frame-Local Variables): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 87649
diff changeset
1795 (modify-frame-parameters @var{frame} '((@var{var} . @var{value})))
0cc86df465ef (Frame-Local Variables): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 87649
diff changeset
1796 @end lisp
0cc86df465ef (Frame-Local Variables): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 87649
diff changeset
1797
0cc86df465ef (Frame-Local Variables): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 87649
diff changeset
1798 @noindent
0cc86df465ef (Frame-Local Variables): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 87649
diff changeset
1799 This causes the variable @var{var} to be bound to the specified
102306
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1800 @var{value} in the named @var{frame}. To check the frame-specific
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1801 values of such variables, use @code{frame-parameter}. @xref{Parameter
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1802 Access}.
100710
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1803
102306
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1804 Note that you cannot have a frame-local binding for a variable that
00d32e2488cf (Variables): Clarify introduction.
Chong Yidong <cyd@stupidchicken.com>
parents: 101144
diff changeset
1805 has a buffer-local binding.
100710
ac3db465bf7b (Directory Local Variables): New node.
Eli Zaretskii <eliz@gnu.org>
parents: 99898
diff changeset
1806
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1807 @node Variable Aliases
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1808 @section Variable Aliases
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1809 @cindex variable aliases
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1810
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1811 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
1812 variables always have the same value, and changing either one also
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1813 changes the other. Whenever you change the name of a
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1814 variable---either because you realize its old name was not well
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1815 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
1816 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
1817 compatibility. You can do this with @code{defvaralias}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1818
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1819 @defun defvaralias new-alias base-variable &optional docstring
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1820 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
1821 for symbol @var{base-variable}. This means that retrieving the value
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1822 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
1823 changing the value of @var{new-alias} changes the value of
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1824 @var{base-variable}. The two aliased variable names always share the
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1825 same value and the same bindings.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1826
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1827 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
1828 documentation for @var{new-alias}; otherwise, the alias gets the same
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1829 documentation as @var{base-variable} has, if any, unless
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1830 @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
1831 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
1832
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1833 This function returns @var{base-variable}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1834 @end defun
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1835
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1836 Variable aliases are convenient for replacing an old name for a
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1837 variable with a new name. @code{make-obsolete-variable} declares that
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1838 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
1839 stage in the future.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1840
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1841 @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
1842 This function makes the byte compiler warn that the variable
84109
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1843 @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
1844 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
1845 @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
1846 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
1847
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1848 If provided, @var{when} should be a string indicating when the
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1849 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
1850 number.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1851 @end defun
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1852
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1853 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
1854 same time using the macro @code{define-obsolete-variable-alias}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1855
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1856 @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
1857 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
1858 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
1859 equivalent to the following:
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1860
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1861 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1862 (defvaralias @var{obsolete-name} @var{current-name} @var{docstring})
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1863 (make-obsolete-variable @var{obsolete-name} @var{current-name} @var{when})
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1864 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1865 @end defmac
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1866
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1867 @defun indirect-variable variable
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1868 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
1869 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
1870 not defined as an alias, the function returns @var{variable}.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1871
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1872 This function signals a @code{cyclic-variable-indirection} error if
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1873 there is a loop in the chain of symbols.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1874 @end defun
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1875
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1876 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1877 (defvaralias 'foo 'bar)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1878 (indirect-variable 'foo)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1879 @result{} bar
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1880 (indirect-variable 'bar)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1881 @result{} bar
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1882 (setq bar 2)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1883 bar
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1884 @result{} 2
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1885 @group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1886 foo
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1887 @result{} 2
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1888 @end group
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1889 (setq foo 0)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1890 bar
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1891 @result{} 0
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1892 foo
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1893 @result{} 0
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1894 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1895
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1896 @node Variables with Restricted Values
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1897 @section Variables with Restricted Values
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1898
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1899 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
1900 Lisp object. However, certain Lisp variables are not defined in Lisp,
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1901 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
1902 @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
1903 any value. However, some variables are defined using
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1904 @code{DEFVAR_INT} or @code{DEFVAR_BOOL}. @xref{Defining Lisp
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1905 variables in C,, Writing Emacs Primitives}, in particular the
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1906 description of functions of the type @code{syms_of_@var{filename}},
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1907 for a brief discussion of the C implementation.
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1908
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1909 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
1910 @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
1911 will set them to @code{t}:
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1912
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1913 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1914 (let ((display-hourglass 5))
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1915 display-hourglass)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1916 @result{} t
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1917 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1918
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1919 @defvar byte-boolean-vars
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1920 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
1921 @end defvar
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1922
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1923 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
1924 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
1925
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1926 @example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1927 (setq window-min-height 5.0)
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1928 @error{} Wrong type argument: integerp, 5.0
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1929 @end example
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1930
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1931 @ignore
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1932 arch-tag: 5ff62c44-2b51-47bb-99d4-fea5aeec5d3e
d5d157f50e33 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1933 @end ignore