Mercurial > emacs
annotate lispref/symbols.texi @ 27158:9045ae8c1171
*** empty log message ***
author | Gerd Moellmann <gerd@gnu.org> |
---|---|
date | Tue, 04 Jan 2000 23:09:30 +0000 |
parents | 4b1a67a46d8c |
children | d2e5f1b7d8e2 |
rev | line source |
---|---|
6411 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998 Free Software Foundation, Inc. |
6411 | 4 @c See the file elisp.texi for copying conditions. |
5 @setfilename ../info/symbols | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23727
diff
changeset
|
6 @node Symbols, Evaluation, Hash Tables, Top |
6411 | 7 @chapter Symbols |
8 @cindex symbol | |
9 | |
10 A @dfn{symbol} is an object with a unique name. This chapter | |
11 describes symbols, their components, their property lists, and how they | |
12 are created and interned. Separate chapters describe the use of symbols | |
13 as variables and as function names; see @ref{Variables}, and | |
14 @ref{Functions}. For the precise read syntax for symbols, see | |
15 @ref{Symbol Type}. | |
16 | |
17 You can test whether an arbitrary Lisp object is a symbol | |
18 with @code{symbolp}: | |
19 | |
20 @defun symbolp object | |
21 This function returns @code{t} if @var{object} is a symbol, @code{nil} | |
22 otherwise. | |
23 @end defun | |
24 | |
25 @menu | |
26 * Symbol Components:: Symbols have names, values, function definitions | |
27 and property lists. | |
28 * Definitions:: A definition says how a symbol will be used. | |
29 * Creating Symbols:: How symbols are kept unique. | |
30 * Property Lists:: Each symbol has a property list | |
31 for recording miscellaneous information. | |
32 @end menu | |
33 | |
34 @node Symbol Components, Definitions, Symbols, Symbols | |
35 @section Symbol Components | |
36 @cindex symbol components | |
37 | |
38 Each symbol has four components (or ``cells''), each of which | |
39 references another object: | |
40 | |
41 @table @asis | |
42 @item Print name | |
43 @cindex print name cell | |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
44 The @dfn{print name cell} holds a string that names the symbol for |
6411 | 45 reading and printing. See @code{symbol-name} in @ref{Creating Symbols}. |
46 | |
47 @item Value | |
48 @cindex value cell | |
49 The @dfn{value cell} holds the current value of the symbol as a | |
50 variable. When a symbol is used as a form, the value of the form is the | |
51 contents of the symbol's value cell. See @code{symbol-value} in | |
52 @ref{Accessing Variables}. | |
53 | |
54 @item Function | |
55 @cindex function cell | |
56 The @dfn{function cell} holds the function definition of the symbol. | |
57 When a symbol is used as a function, its function definition is used in | |
58 its place. This cell is also used to make a symbol stand for a keymap | |
59 or a keyboard macro, for editor command execution. Because each symbol | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23727
diff
changeset
|
60 has separate value and function cells, variables names and function names do |
6411 | 61 not conflict. See @code{symbol-function} in @ref{Function Cells}. |
62 | |
63 @item Property list | |
64 @cindex property list cell | |
65 The @dfn{property list cell} holds the property list of the symbol. See | |
66 @code{symbol-plist} in @ref{Property Lists}. | |
67 @end table | |
68 | |
69 The print name cell always holds a string, and cannot be changed. The | |
70 other three cells can be set individually to any specified Lisp object. | |
71 | |
72 The print name cell holds the string that is the name of the symbol. | |
73 Since symbols are represented textually by their names, it is important | |
74 not to have two symbols with the same name. The Lisp reader ensures | |
75 this: every time it reads a symbol, it looks for an existing symbol with | |
76 the specified name before it creates a new one. (In GNU Emacs Lisp, | |
77 this lookup uses a hashing algorithm and an obarray; see @ref{Creating | |
78 Symbols}.) | |
79 | |
27093
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25751
diff
changeset
|
80 The value cell holds the symbol's value as a variable |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25751
diff
changeset
|
81 (@pxref{Variables}). That is what you get if you evaluate the symbol as |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25751
diff
changeset
|
82 a Lisp expression (@pxref{Evaluation}). Any Lisp object is a legitimate |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25751
diff
changeset
|
83 value. Certain symbols have values that cannot be changed; these |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25751
diff
changeset
|
84 include @code{nil} and @code{t}, and any symbol whose name starts with |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25751
diff
changeset
|
85 @samp{:} (those are called @dfn{keywords}). @xref{Constant Variables}. |
4b1a67a46d8c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25751
diff
changeset
|
86 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
87 In normal usage, the function cell usually contains a function |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
88 (@pxref{Functions}) or a macro (@pxref{Macros}), as that is what the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
89 Lisp interpreter expects to see there (@pxref{Evaluation}). Keyboard |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
90 macros (@pxref{Keyboard Macros}), keymaps (@pxref{Keymaps}) and autoload |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
91 objects (@pxref{Autoloading}) are also sometimes stored in the function |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
92 cells of symbols. We often refer to ``the function @code{foo}'' when we |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
93 really mean the function stored in the function cell of the symbol |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
94 @code{foo}. We make the distinction only when necessary. |
6411 | 95 |
96 The property list cell normally should hold a correctly formatted | |
97 property list (@pxref{Property Lists}), as a number of functions expect | |
98 to see a property list there. | |
99 | |
100 The function cell or the value cell may be @dfn{void}, which means | |
101 that the cell does not reference any object. (This is not the same | |
102 thing as holding the symbol @code{void}, nor the same as holding the | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
103 symbol @code{nil}.) Examining a function or value cell that is void |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
104 results in an error, such as @samp{Symbol's value as variable is void}. |
6411 | 105 |
106 The four functions @code{symbol-name}, @code{symbol-value}, | |
107 @code{symbol-plist}, and @code{symbol-function} return the contents of | |
108 the four cells of a symbol. Here as an example we show the contents of | |
109 the four cells of the symbol @code{buffer-file-name}: | |
110 | |
111 @example | |
112 (symbol-name 'buffer-file-name) | |
113 @result{} "buffer-file-name" | |
114 (symbol-value 'buffer-file-name) | |
115 @result{} "/gnu/elisp/symbols.texi" | |
116 (symbol-plist 'buffer-file-name) | |
117 @result{} (variable-documentation 29529) | |
118 (symbol-function 'buffer-file-name) | |
119 @result{} #<subr buffer-file-name> | |
120 @end example | |
121 | |
122 @noindent | |
123 Because this symbol is the variable which holds the name of the file | |
124 being visited in the current buffer, the value cell contents we see are | |
125 the name of the source file of this chapter of the Emacs Lisp Manual. | |
126 The property list cell contains the list @code{(variable-documentation | |
127 29529)} which tells the documentation functions where to find the | |
128 documentation string for the variable @code{buffer-file-name} in the | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
129 @file{DOC-@var{version}} file. (29529 is the offset from the beginning |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
130 of the @file{DOC-@var{version}} file to where that documentation string |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
131 begins---see @ref{Documentation Basics}.) The function cell contains |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
132 the function for returning the name of the file. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
133 @code{buffer-file-name} names a primitive function, which has no read |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
134 syntax and prints in hash notation (@pxref{Primitive Function Type}). A |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
135 symbol naming a function written in Lisp would have a lambda expression |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
136 (or a byte-code object) in this cell. |
6411 | 137 |
138 @node Definitions, Creating Symbols, Symbol Components, Symbols | |
139 @section Defining Symbols | |
140 @cindex definition of a symbol | |
141 | |
142 A @dfn{definition} in Lisp is a special form that announces your | |
143 intention to use a certain symbol in a particular way. In Emacs Lisp, | |
144 you can define a symbol as a variable, or define it as a function (or | |
145 macro), or both independently. | |
146 | |
147 A definition construct typically specifies a value or meaning for the | |
148 symbol for one kind of use, plus documentation for its meaning when used | |
149 in this way. Thus, when you define a symbol as a variable, you can | |
150 supply an initial value for the variable, plus documentation for the | |
151 variable. | |
152 | |
153 @code{defvar} and @code{defconst} are special forms that define a | |
154 symbol as a global variable. They are documented in detail in | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
155 @ref{Defining Variables}. For defining user option variables that can |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
156 be customized, use @code{defcustom} (@pxref{Customization}). |
6411 | 157 |
158 @code{defun} defines a symbol as a function, creating a lambda | |
159 expression and storing it in the function cell of the symbol. This | |
160 lambda expression thus becomes the function definition of the symbol. | |
161 (The term ``function definition'', meaning the contents of the function | |
162 cell, is derived from the idea that @code{defun} gives the symbol its | |
12098 | 163 definition as a function.) @code{defsubst} and @code{defalias} are two |
164 other ways of defining a function. @xref{Functions}. | |
6411 | 165 |
166 @code{defmacro} defines a symbol as a macro. It creates a macro | |
167 object and stores it in the function cell of the symbol. Note that a | |
168 given symbol can be a macro or a function, but not both at once, because | |
169 both macro and function definitions are kept in the function cell, and | |
170 that cell can hold only one Lisp object at any given time. | |
171 @xref{Macros}. | |
172 | |
12098 | 173 In Emacs Lisp, a definition is not required in order to use a symbol |
174 as a variable or function. Thus, you can make a symbol a global | |
6411 | 175 variable with @code{setq}, whether you define it first or not. The real |
176 purpose of definitions is to guide programmers and programming tools. | |
177 They inform programmers who read the code that certain symbols are | |
178 @emph{intended} to be used as variables, or as functions. In addition, | |
179 utilities such as @file{etags} and @file{make-docfile} recognize | |
180 definitions, and add appropriate information to tag tables and the | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
181 @file{DOC-@var{version}} file. @xref{Accessing Documentation}. |
6411 | 182 |
183 @node Creating Symbols, Property Lists, Definitions, Symbols | |
184 @section Creating and Interning Symbols | |
185 @cindex reading symbols | |
186 | |
187 To understand how symbols are created in GNU Emacs Lisp, you must know | |
188 how Lisp reads them. Lisp must ensure that it finds the same symbol | |
189 every time it reads the same set of characters. Failure to do so would | |
190 cause complete confusion. | |
191 | |
192 @cindex symbol name hashing | |
193 @cindex hashing | |
194 @cindex obarray | |
195 @cindex bucket (in obarray) | |
196 When the Lisp reader encounters a symbol, it reads all the characters | |
197 of the name. Then it ``hashes'' those characters to find an index in a | |
198 table called an @dfn{obarray}. Hashing is an efficient method of | |
199 looking something up. For example, instead of searching a telephone | |
200 book cover to cover when looking up Jan Jones, you start with the J's | |
201 and go from there. That is a simple version of hashing. Each element | |
202 of the obarray is a @dfn{bucket} which holds all the symbols with a | |
203 given hash code; to look for a given name, it is sufficient to look | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23727
diff
changeset
|
204 through all the symbols in the bucket for that name's hash code. (The |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23727
diff
changeset
|
205 same idea is used for general Emacs hash tables, but they are a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23727
diff
changeset
|
206 different data type; see @ref{Hash Tables}.) |
6411 | 207 |
208 @cindex interning | |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
209 If a symbol with the desired name is found, the reader uses that |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
210 symbol. If the obarray does not contain a symbol with that name, the |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
211 reader makes a new symbol and adds it to the obarray. Finding or adding |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
212 a symbol with a certain name is called @dfn{interning} it, and the |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
213 symbol is then called an @dfn{interned symbol}. |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
214 |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
215 Interning ensures that each obarray has just one symbol with any |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
216 particular name. Other like-named symbols may exist, but not in the |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
217 same obarray. Thus, the reader gets the same symbols for the same |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
218 names, as long as you keep reading with the same obarray. |
6411 | 219 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23727
diff
changeset
|
220 Interning usually happens automatically in the reader, but sometimes |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23727
diff
changeset
|
221 other programs need to do it. For example, after the @kbd{M-x} command |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23727
diff
changeset
|
222 obtains the command name as a string using the minibuffer, it then |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23727
diff
changeset
|
223 interns the string, to get the interned symbol with that name. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23727
diff
changeset
|
224 |
6411 | 225 @cindex symbol equality |
226 @cindex uninterned symbol | |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
227 No obarray contains all symbols; in fact, some symbols are not in any |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
228 obarray. They are called @dfn{uninterned symbols}. An uninterned |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
229 symbol has the same four cells as other symbols; however, the only way |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
230 to gain access to it is by finding it in some other object or as the |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
231 value of a variable. |
6411 | 232 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23727
diff
changeset
|
233 Creating an uninterned symbol is useful in generating Lisp code, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23727
diff
changeset
|
234 because an uninterned symbol used as a variable in the code you generate |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23727
diff
changeset
|
235 cannot clash with any variables used in other Lisp programs. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23727
diff
changeset
|
236 |
6411 | 237 In Emacs Lisp, an obarray is actually a vector. Each element of the |
238 vector is a bucket; its value is either an interned symbol whose name | |
239 hashes to that bucket, or 0 if the bucket is empty. Each interned | |
240 symbol has an internal link (invisible to the user) to the next symbol | |
241 in the bucket. Because these links are invisible, there is no way to | |
242 find all the symbols in an obarray except using @code{mapatoms} (below). | |
243 The order of symbols in a bucket is not significant. | |
244 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23727
diff
changeset
|
245 In an empty obarray, every element is 0, so you can create an obarray |
6411 | 246 with @code{(make-vector @var{length} 0)}. @strong{This is the only |
247 valid way to create an obarray.} Prime numbers as lengths tend | |
248 to result in good hashing; lengths one less than a power of two are also | |
249 good. | |
250 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
251 @strong{Do not try to put symbols in an obarray yourself.} This does |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
252 not work---only @code{intern} can enter a symbol in an obarray properly. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
253 |
6411 | 254 @cindex CL note---symbol in obarrays |
255 @quotation | |
7734 | 256 @b{Common Lisp note:} In Common Lisp, a single symbol may be interned in |
6411 | 257 several obarrays. |
258 @end quotation | |
259 | |
260 Most of the functions below take a name and sometimes an obarray as | |
261 arguments. A @code{wrong-type-argument} error is signaled if the name | |
262 is not a string, or if the obarray is not a vector. | |
263 | |
264 @defun symbol-name symbol | |
265 This function returns the string that is @var{symbol}'s name. For example: | |
266 | |
267 @example | |
268 @group | |
269 (symbol-name 'foo) | |
270 @result{} "foo" | |
271 @end group | |
272 @end example | |
273 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
274 @strong{Warning:} Changing the string by substituting characters does |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
275 change the name of the symbol, but fails to update the obarray, so don't |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
276 do it! |
6411 | 277 @end defun |
278 | |
279 @defun make-symbol name | |
280 This function returns a newly-allocated, uninterned symbol whose name is | |
281 @var{name} (which must be a string). Its value and function definition | |
282 are void, and its property list is @code{nil}. In the example below, | |
283 the value of @code{sym} is not @code{eq} to @code{foo} because it is a | |
284 distinct uninterned symbol whose name is also @samp{foo}. | |
285 | |
286 @example | |
287 (setq sym (make-symbol "foo")) | |
288 @result{} foo | |
289 (eq sym 'foo) | |
290 @result{} nil | |
291 @end example | |
292 @end defun | |
293 | |
294 @defun intern name &optional obarray | |
295 This function returns the interned symbol whose name is @var{name}. If | |
296 there is no such symbol in the obarray @var{obarray}, @code{intern} | |
297 creates a new one, adds it to the obarray, and returns it. If | |
298 @var{obarray} is omitted, the value of the global variable | |
299 @code{obarray} is used. | |
300 | |
301 @example | |
302 (setq sym (intern "foo")) | |
303 @result{} foo | |
304 (eq sym 'foo) | |
305 @result{} t | |
306 | |
307 (setq sym1 (intern "foo" other-obarray)) | |
308 @result{} foo | |
23727 | 309 (eq sym1 'foo) |
6411 | 310 @result{} nil |
311 @end example | |
312 @end defun | |
313 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
314 @cindex CL note---interning existing symbol |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
315 @quotation |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
316 @b{Common Lisp note:} In Common Lisp, you can intern an existing symbol |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
317 in an obarray. In Emacs Lisp, you cannot do this, because the argument |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
318 to @code{intern} must be a string, not a symbol. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
319 @end quotation |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
320 |
6411 | 321 @defun intern-soft name &optional obarray |
322 This function returns the symbol in @var{obarray} whose name is | |
323 @var{name}, or @code{nil} if @var{obarray} has no symbol with that name. | |
324 Therefore, you can use @code{intern-soft} to test whether a symbol with | |
325 a given name is already interned. If @var{obarray} is omitted, the | |
326 value of the global variable @code{obarray} is used. | |
327 | |
328 @smallexample | |
329 (intern-soft "frazzle") ; @r{No such symbol exists.} | |
330 @result{} nil | |
331 (make-symbol "frazzle") ; @r{Create an uninterned one.} | |
332 @result{} frazzle | |
12282
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
333 @group |
6411 | 334 (intern-soft "frazzle") ; @r{That one cannot be found.} |
335 @result{} nil | |
12282
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
336 @end group |
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
337 @group |
6411 | 338 (setq sym (intern "frazzle")) ; @r{Create an interned one.} |
339 @result{} frazzle | |
12282
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
340 @end group |
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
341 @group |
6411 | 342 (intern-soft "frazzle") ; @r{That one can be found!} |
343 @result{} frazzle | |
12282
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12128
diff
changeset
|
344 @end group |
6411 | 345 @group |
346 (eq sym 'frazzle) ; @r{And it is the same one.} | |
347 @result{} t | |
348 @end group | |
349 @end smallexample | |
350 @end defun | |
351 | |
352 @defvar obarray | |
353 This variable is the standard obarray for use by @code{intern} and | |
354 @code{read}. | |
355 @end defvar | |
356 | |
357 @defun mapatoms function &optional obarray | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
358 This function calls @var{function} once with each symbol in the obarray |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
359 @var{obarray}. Then it returns @code{nil}. If @var{obarray} is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
360 omitted, it defaults to the value of @code{obarray}, the standard |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
361 obarray for ordinary symbols. |
6411 | 362 |
363 @smallexample | |
364 (setq count 0) | |
365 @result{} 0 | |
366 (defun count-syms (s) | |
367 (setq count (1+ count))) | |
368 @result{} count-syms | |
369 (mapatoms 'count-syms) | |
370 @result{} nil | |
371 count | |
372 @result{} 1871 | |
373 @end smallexample | |
374 | |
375 See @code{documentation} in @ref{Accessing Documentation}, for another | |
376 example using @code{mapatoms}. | |
377 @end defun | |
378 | |
12067 | 379 @defun unintern symbol &optional obarray |
380 This function deletes @var{symbol} from the obarray @var{obarray}. If | |
381 @code{symbol} is not actually in the obarray, @code{unintern} does | |
382 nothing. If @var{obarray} is @code{nil}, the current obarray is used. | |
383 | |
384 If you provide a string instead of a symbol as @var{symbol}, it stands | |
385 for a symbol name. Then @code{unintern} deletes the symbol (if any) in | |
386 the obarray which has that name. If there is no such symbol, | |
387 @code{unintern} does nothing. | |
388 | |
389 If @code{unintern} does delete a symbol, it returns @code{t}. Otherwise | |
390 it returns @code{nil}. | |
391 @end defun | |
392 | |
6411 | 393 @node Property Lists,, Creating Symbols, Symbols |
394 @section Property Lists | |
395 @cindex property list | |
396 @cindex plist | |
397 | |
398 A @dfn{property list} (@dfn{plist} for short) is a list of paired | |
399 elements stored in the property list cell of a symbol. Each of the | |
400 pairs associates a property name (usually a symbol) with a property or | |
401 value. Property lists are generally used to record information about a | |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
402 symbol, such as its documentation as a variable, the name of the file |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
403 where it was defined, or perhaps even the grammatical class of the |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
404 symbol (representing a word) in a language-understanding system. |
6411 | 405 |
406 Character positions in a string or buffer can also have property lists. | |
407 @xref{Text Properties}. | |
408 | |
409 The property names and values in a property list can be any Lisp | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
410 objects, but the names are usually symbols. Property list functions |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
411 compare the property names using @code{eq}. Here is an example of a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
412 property list, found on the symbol @code{progn} when the compiler is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
413 loaded: |
6411 | 414 |
415 @example | |
416 (lisp-indent-function 0 byte-compile byte-compile-progn) | |
417 @end example | |
418 | |
419 @noindent | |
420 Here @code{lisp-indent-function} and @code{byte-compile} are property | |
421 names, and the other two elements are the corresponding values. | |
422 | |
12067 | 423 @menu |
424 * Plists and Alists:: Comparison of the advantages of property | |
425 lists and association lists. | |
426 * Symbol Plists:: Functions to access symbols' property lists. | |
427 * Other Plists:: Accessing property lists stored elsewhere. | |
428 @end menu | |
429 | |
430 @node Plists and Alists | |
431 @subsection Property Lists and Association Lists | |
432 | |
6411 | 433 @cindex property lists vs association lists |
434 Association lists (@pxref{Association Lists}) are very similar to | |
435 property lists. In contrast to association lists, the order of the | |
436 pairs in the property list is not significant since the property names | |
437 must be distinct. | |
438 | |
439 Property lists are better than association lists for attaching | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
440 information to various Lisp function names or variables. If your |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
441 program keeps all of its associations in one association list, it will |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
442 typically need to search that entire list each time it checks for an |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
443 association. This could be slow. By contrast, if you keep the same |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
444 information in the property lists of the function names or variables |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
445 themselves, each search will scan only the length of one property list, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
446 which is usually short. This is why the documentation for a variable is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
447 recorded in a property named @code{variable-documentation}. The byte |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
448 compiler likewise uses properties to record those functions needing |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
449 special treatment. |
6411 | 450 |
451 However, association lists have their own advantages. Depending on | |
452 your application, it may be faster to add an association to the front of | |
453 an association list than to update a property. All properties for a | |
454 symbol are stored in the same property list, so there is a possibility | |
455 of a conflict between different uses of a property name. (For this | |
456 reason, it is a good idea to choose property names that are probably | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
457 unique, such as by beginning the property name with the program's usual |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
458 name-prefix for variables and functions.) An association list may be |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
459 used like a stack where associations are pushed on the front of the list |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
460 and later discarded; this is not possible with a property list. |
6411 | 461 |
12067 | 462 @node Symbol Plists |
463 @subsection Property List Functions for Symbols | |
464 | |
6411 | 465 @defun symbol-plist symbol |
466 This function returns the property list of @var{symbol}. | |
467 @end defun | |
468 | |
469 @defun setplist symbol plist | |
12067 | 470 This function sets @var{symbol}'s property list to @var{plist}. |
6411 | 471 Normally, @var{plist} should be a well-formed property list, but this is |
472 not enforced. | |
473 | |
474 @smallexample | |
475 (setplist 'foo '(a 1 b (2 3) c nil)) | |
476 @result{} (a 1 b (2 3) c nil) | |
477 (symbol-plist 'foo) | |
478 @result{} (a 1 b (2 3) c nil) | |
479 @end smallexample | |
480 | |
481 For symbols in special obarrays, which are not used for ordinary | |
482 purposes, it may make sense to use the property list cell in a | |
483 nonstandard fashion; in fact, the abbrev mechanism does so | |
484 (@pxref{Abbrevs}). | |
485 @end defun | |
486 | |
487 @defun get symbol property | |
488 This function finds the value of the property named @var{property} in | |
489 @var{symbol}'s property list. If there is no such property, @code{nil} | |
490 is returned. Thus, there is no distinction between a value of | |
491 @code{nil} and the absence of the property. | |
492 | |
493 The name @var{property} is compared with the existing property names | |
494 using @code{eq}, so any object is a legitimate property. | |
495 | |
496 See @code{put} for an example. | |
497 @end defun | |
498 | |
499 @defun put symbol property value | |
500 This function puts @var{value} onto @var{symbol}'s property list under | |
501 the property name @var{property}, replacing any previous property value. | |
502 The @code{put} function returns @var{value}. | |
503 | |
504 @smallexample | |
505 (put 'fly 'verb 'transitive) | |
506 @result{}'transitive | |
507 (put 'fly 'noun '(a buzzing little bug)) | |
508 @result{} (a buzzing little bug) | |
509 (get 'fly 'verb) | |
510 @result{} transitive | |
511 (symbol-plist 'fly) | |
512 @result{} (verb transitive noun (a buzzing little bug)) | |
513 @end smallexample | |
514 @end defun | |
12067 | 515 |
516 @node Other Plists | |
517 @subsection Property Lists Outside Symbols | |
518 | |
519 These two functions are useful for manipulating property lists | |
520 that are stored in places other than symbols: | |
521 | |
522 @defun plist-get plist property | |
523 This returns the value of the @var{property} property | |
524 stored in the property list @var{plist}. For example, | |
525 | |
526 @example | |
527 (plist-get '(foo 4) 'foo) | |
528 @result{} 4 | |
529 @end example | |
530 @end defun | |
531 | |
532 @defun plist-put plist property value | |
12098 | 533 This stores @var{value} as the value of the @var{property} property in |
534 the property list @var{plist}. It may modify @var{plist} destructively, | |
12128
27144f55d1c6
fixed errors that appeared during update to 19.29.
Melissa Weisshaus <melissa@gnu.org>
parents:
12098
diff
changeset
|
535 or it may construct a new list structure without altering the old. The |
12098 | 536 function returns the modified property list, so you can store that back |
537 in the place where you got @var{plist}. For example, | |
12067 | 538 |
539 @example | |
540 (setq my-plist '(bar t foo 4)) | |
541 @result{} (bar t foo 4) | |
542 (setq my-plist (plist-put my-plist 'foo 69)) | |
543 @result{} (bar t foo 69) | |
544 (setq my-plist (plist-put my-plist 'quux '(a))) | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
545 @result{} (bar t foo 69 quux (a)) |
12067 | 546 @end example |
547 @end defun | |
548 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
549 You could define @code{put} in terms of @code{plist-put} as follows: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
550 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
551 @example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
552 (defun put (symbol prop value) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
553 (setplist symbol |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
554 (plist-put (symbol-plist symbol) prop value))) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
555 @end example |