Mercurial > emacs
annotate lispref/symbols.texi @ 21347:aca24aa07fb4
(rmail-mode-2): Locally set enable-local-variables
to nil, so a local var list in a message won't confuse things.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Fri, 03 Apr 1998 05:34:10 +0000 |
parents | 66d807bdc5b4 |
children | 90da2489c498 |
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 | |
6 @node Symbols, Evaluation, Sequences Arrays Vectors, Top | |
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 | |
60 has separate value and function cells, variables and function names do | |
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 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
80 In normal usage, the function cell usually contains a function |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
81 (@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
|
82 Lisp interpreter expects to see there (@pxref{Evaluation}). Keyboard |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
83 macros (@pxref{Keyboard Macros}), keymaps (@pxref{Keymaps}) and autoload |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
84 objects (@pxref{Autoloading}) are also sometimes stored in the function |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
85 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
|
86 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
|
87 @code{foo}. We make the distinction only when necessary. |
6411 | 88 |
89 The property list cell normally should hold a correctly formatted | |
90 property list (@pxref{Property Lists}), as a number of functions expect | |
91 to see a property list there. | |
92 | |
93 The function cell or the value cell may be @dfn{void}, which means | |
94 that the cell does not reference any object. (This is not the same | |
95 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
|
96 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
|
97 results in an error, such as @samp{Symbol's value as variable is void}. |
6411 | 98 |
99 The four functions @code{symbol-name}, @code{symbol-value}, | |
100 @code{symbol-plist}, and @code{symbol-function} return the contents of | |
101 the four cells of a symbol. Here as an example we show the contents of | |
102 the four cells of the symbol @code{buffer-file-name}: | |
103 | |
104 @example | |
105 (symbol-name 'buffer-file-name) | |
106 @result{} "buffer-file-name" | |
107 (symbol-value 'buffer-file-name) | |
108 @result{} "/gnu/elisp/symbols.texi" | |
109 (symbol-plist 'buffer-file-name) | |
110 @result{} (variable-documentation 29529) | |
111 (symbol-function 'buffer-file-name) | |
112 @result{} #<subr buffer-file-name> | |
113 @end example | |
114 | |
115 @noindent | |
116 Because this symbol is the variable which holds the name of the file | |
117 being visited in the current buffer, the value cell contents we see are | |
118 the name of the source file of this chapter of the Emacs Lisp Manual. | |
119 The property list cell contains the list @code{(variable-documentation | |
120 29529)} which tells the documentation functions where to find the | |
121 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
|
122 @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
|
123 of the @file{DOC-@var{version}} file to where that documentation string |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
124 begins---@pxref{Documentation Basics}) The function cell contains the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
125 function for returning the name of the file. @code{buffer-file-name} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
126 names a primitive function, which has no read syntax and prints in hash |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
127 notation (@pxref{Primitive Function Type}). A symbol naming a function |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
128 written in Lisp would have a lambda expression (or a byte-code object) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
129 in this cell. |
6411 | 130 |
131 @node Definitions, Creating Symbols, Symbol Components, Symbols | |
132 @section Defining Symbols | |
133 @cindex definition of a symbol | |
134 | |
135 A @dfn{definition} in Lisp is a special form that announces your | |
136 intention to use a certain symbol in a particular way. In Emacs Lisp, | |
137 you can define a symbol as a variable, or define it as a function (or | |
138 macro), or both independently. | |
139 | |
140 A definition construct typically specifies a value or meaning for the | |
141 symbol for one kind of use, plus documentation for its meaning when used | |
142 in this way. Thus, when you define a symbol as a variable, you can | |
143 supply an initial value for the variable, plus documentation for the | |
144 variable. | |
145 | |
146 @code{defvar} and @code{defconst} are special forms that define a | |
147 symbol as a global variable. They are documented in detail in | |
148 @ref{Defining Variables}. | |
149 | |
150 @code{defun} defines a symbol as a function, creating a lambda | |
151 expression and storing it in the function cell of the symbol. This | |
152 lambda expression thus becomes the function definition of the symbol. | |
153 (The term ``function definition'', meaning the contents of the function | |
154 cell, is derived from the idea that @code{defun} gives the symbol its | |
12098 | 155 definition as a function.) @code{defsubst} and @code{defalias} are two |
156 other ways of defining a function. @xref{Functions}. | |
6411 | 157 |
158 @code{defmacro} defines a symbol as a macro. It creates a macro | |
159 object and stores it in the function cell of the symbol. Note that a | |
160 given symbol can be a macro or a function, but not both at once, because | |
161 both macro and function definitions are kept in the function cell, and | |
162 that cell can hold only one Lisp object at any given time. | |
163 @xref{Macros}. | |
164 | |
12098 | 165 In Emacs Lisp, a definition is not required in order to use a symbol |
166 as a variable or function. Thus, you can make a symbol a global | |
6411 | 167 variable with @code{setq}, whether you define it first or not. The real |
168 purpose of definitions is to guide programmers and programming tools. | |
169 They inform programmers who read the code that certain symbols are | |
170 @emph{intended} to be used as variables, or as functions. In addition, | |
171 utilities such as @file{etags} and @file{make-docfile} recognize | |
172 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
|
173 @file{DOC-@var{version}} file. @xref{Accessing Documentation}. |
6411 | 174 |
175 @node Creating Symbols, Property Lists, Definitions, Symbols | |
176 @section Creating and Interning Symbols | |
177 @cindex reading symbols | |
178 | |
179 To understand how symbols are created in GNU Emacs Lisp, you must know | |
180 how Lisp reads them. Lisp must ensure that it finds the same symbol | |
181 every time it reads the same set of characters. Failure to do so would | |
182 cause complete confusion. | |
183 | |
184 @cindex symbol name hashing | |
185 @cindex hashing | |
186 @cindex obarray | |
187 @cindex bucket (in obarray) | |
188 When the Lisp reader encounters a symbol, it reads all the characters | |
189 of the name. Then it ``hashes'' those characters to find an index in a | |
190 table called an @dfn{obarray}. Hashing is an efficient method of | |
191 looking something up. For example, instead of searching a telephone | |
192 book cover to cover when looking up Jan Jones, you start with the J's | |
193 and go from there. That is a simple version of hashing. Each element | |
194 of the obarray is a @dfn{bucket} which holds all the symbols with a | |
195 given hash code; to look for a given name, it is sufficient to look | |
196 through all the symbols in the bucket for that name's hash code. | |
197 | |
198 @cindex interning | |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
199 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
|
200 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
|
201 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
|
202 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
|
203 symbol is then called an @dfn{interned symbol}. |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
204 |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
205 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
|
206 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
|
207 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
|
208 names, as long as you keep reading with the same obarray. |
6411 | 209 |
210 @cindex symbol equality | |
211 @cindex uninterned symbol | |
7118
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
212 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
|
213 obarray. They are called @dfn{uninterned symbols}. An uninterned |
08d61ef58d13
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6411
diff
changeset
|
214 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
|
215 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
|
216 value of a variable. |
6411 | 217 |
218 In Emacs Lisp, an obarray is actually a vector. Each element of the | |
219 vector is a bucket; its value is either an interned symbol whose name | |
220 hashes to that bucket, or 0 if the bucket is empty. Each interned | |
221 symbol has an internal link (invisible to the user) to the next symbol | |
222 in the bucket. Because these links are invisible, there is no way to | |
223 find all the symbols in an obarray except using @code{mapatoms} (below). | |
224 The order of symbols in a bucket is not significant. | |
225 | |
226 In an empty obarray, every element is 0, and you can create an obarray | |
227 with @code{(make-vector @var{length} 0)}. @strong{This is the only | |
228 valid way to create an obarray.} Prime numbers as lengths tend | |
229 to result in good hashing; lengths one less than a power of two are also | |
230 good. | |
231 | |
232 It is possible for two different symbols to have the same name in | |
233 different obarrays; these symbols are not @code{eq} or @code{equal}. | |
234 However, this normally happens only as part of the abbrev mechanism | |
235 (@pxref{Abbrevs}). | |
236 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
237 @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
|
238 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
|
239 |
6411 | 240 @cindex CL note---symbol in obarrays |
241 @quotation | |
7734 | 242 @b{Common Lisp note:} In Common Lisp, a single symbol may be interned in |
6411 | 243 several obarrays. |
244 @end quotation | |
245 | |
246 Most of the functions below take a name and sometimes an obarray as | |
247 arguments. A @code{wrong-type-argument} error is signaled if the name | |
248 is not a string, or if the obarray is not a vector. | |
249 | |
250 @defun symbol-name symbol | |
251 This function returns the string that is @var{symbol}'s name. For example: | |
252 | |
253 @example | |
254 @group | |
255 (symbol-name 'foo) | |
256 @result{} "foo" | |
257 @end group | |
258 @end example | |
259 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
260 @strong{Warning:} Changing the string by substituting characters does |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
261 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
|
262 do it! |
6411 | 263 @end defun |
264 | |
265 @defun make-symbol name | |
266 This function returns a newly-allocated, uninterned symbol whose name is | |
267 @var{name} (which must be a string). Its value and function definition | |
268 are void, and its property list is @code{nil}. In the example below, | |
269 the value of @code{sym} is not @code{eq} to @code{foo} because it is a | |
270 distinct uninterned symbol whose name is also @samp{foo}. | |
271 | |
272 @example | |
273 (setq sym (make-symbol "foo")) | |
274 @result{} foo | |
275 (eq sym 'foo) | |
276 @result{} nil | |
277 @end example | |
278 @end defun | |
279 | |
280 @defun intern name &optional obarray | |
281 This function returns the interned symbol whose name is @var{name}. If | |
282 there is no such symbol in the obarray @var{obarray}, @code{intern} | |
283 creates a new one, adds it to the obarray, and returns it. If | |
284 @var{obarray} is omitted, the value of the global variable | |
285 @code{obarray} is used. | |
286 | |
287 @example | |
288 (setq sym (intern "foo")) | |
289 @result{} foo | |
290 (eq sym 'foo) | |
291 @result{} t | |
292 | |
293 (setq sym1 (intern "foo" other-obarray)) | |
294 @result{} foo | |
295 (eq sym 'foo) | |
296 @result{} nil | |
297 @end example | |
298 @end defun | |
299 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
300 @cindex CL note---interning existing symbol |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
301 @quotation |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
302 @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
|
303 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
|
304 to @code{intern} must be a string, not a symbol. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
305 @end quotation |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
306 |
6411 | 307 @defun intern-soft name &optional obarray |
308 This function returns the symbol in @var{obarray} whose name is | |
309 @var{name}, or @code{nil} if @var{obarray} has no symbol with that name. | |
310 Therefore, you can use @code{intern-soft} to test whether a symbol with | |
311 a given name is already interned. If @var{obarray} is omitted, the | |
312 value of the global variable @code{obarray} is used. | |
313 | |
314 @smallexample | |
315 (intern-soft "frazzle") ; @r{No such symbol exists.} | |
316 @result{} nil | |
317 (make-symbol "frazzle") ; @r{Create an uninterned one.} | |
318 @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
|
319 @group |
6411 | 320 (intern-soft "frazzle") ; @r{That one cannot be found.} |
321 @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
|
322 @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
|
323 @group |
6411 | 324 (setq sym (intern "frazzle")) ; @r{Create an interned one.} |
325 @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
|
326 @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
|
327 @group |
6411 | 328 (intern-soft "frazzle") ; @r{That one can be found!} |
329 @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
|
330 @end group |
6411 | 331 @group |
332 (eq sym 'frazzle) ; @r{And it is the same one.} | |
333 @result{} t | |
334 @end group | |
335 @end smallexample | |
336 @end defun | |
337 | |
338 @defvar obarray | |
339 This variable is the standard obarray for use by @code{intern} and | |
340 @code{read}. | |
341 @end defvar | |
342 | |
343 @defun mapatoms function &optional obarray | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
344 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
|
345 @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
|
346 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
|
347 obarray for ordinary symbols. |
6411 | 348 |
349 @smallexample | |
350 (setq count 0) | |
351 @result{} 0 | |
352 (defun count-syms (s) | |
353 (setq count (1+ count))) | |
354 @result{} count-syms | |
355 (mapatoms 'count-syms) | |
356 @result{} nil | |
357 count | |
358 @result{} 1871 | |
359 @end smallexample | |
360 | |
361 See @code{documentation} in @ref{Accessing Documentation}, for another | |
362 example using @code{mapatoms}. | |
363 @end defun | |
364 | |
12067 | 365 @defun unintern symbol &optional obarray |
366 This function deletes @var{symbol} from the obarray @var{obarray}. If | |
367 @code{symbol} is not actually in the obarray, @code{unintern} does | |
368 nothing. If @var{obarray} is @code{nil}, the current obarray is used. | |
369 | |
370 If you provide a string instead of a symbol as @var{symbol}, it stands | |
371 for a symbol name. Then @code{unintern} deletes the symbol (if any) in | |
372 the obarray which has that name. If there is no such symbol, | |
373 @code{unintern} does nothing. | |
374 | |
375 If @code{unintern} does delete a symbol, it returns @code{t}. Otherwise | |
376 it returns @code{nil}. | |
377 @end defun | |
378 | |
6411 | 379 @node Property Lists,, Creating Symbols, Symbols |
380 @section Property Lists | |
381 @cindex property list | |
382 @cindex plist | |
383 | |
384 A @dfn{property list} (@dfn{plist} for short) is a list of paired | |
385 elements stored in the property list cell of a symbol. Each of the | |
386 pairs associates a property name (usually a symbol) with a property or | |
387 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
|
388 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
|
389 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
|
390 symbol (representing a word) in a language-understanding system. |
6411 | 391 |
392 Character positions in a string or buffer can also have property lists. | |
393 @xref{Text Properties}. | |
394 | |
395 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
|
396 objects, but the names are usually symbols. Property list functions |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
397 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
|
398 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
|
399 loaded: |
6411 | 400 |
401 @example | |
402 (lisp-indent-function 0 byte-compile byte-compile-progn) | |
403 @end example | |
404 | |
405 @noindent | |
406 Here @code{lisp-indent-function} and @code{byte-compile} are property | |
407 names, and the other two elements are the corresponding values. | |
408 | |
12067 | 409 @menu |
410 * Plists and Alists:: Comparison of the advantages of property | |
411 lists and association lists. | |
412 * Symbol Plists:: Functions to access symbols' property lists. | |
413 * Other Plists:: Accessing property lists stored elsewhere. | |
414 @end menu | |
415 | |
416 @node Plists and Alists | |
417 @subsection Property Lists and Association Lists | |
418 | |
6411 | 419 @cindex property lists vs association lists |
420 Association lists (@pxref{Association Lists}) are very similar to | |
421 property lists. In contrast to association lists, the order of the | |
422 pairs in the property list is not significant since the property names | |
423 must be distinct. | |
424 | |
425 Property lists are better than association lists for attaching | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
426 information to various Lisp function names or variables. If your |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
427 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
|
428 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
|
429 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
|
430 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
|
431 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
|
432 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
|
433 recorded in a property named @code{variable-documentation}. The byte |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
434 compiler likewise uses properties to record those functions needing |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
435 special treatment. |
6411 | 436 |
437 However, association lists have their own advantages. Depending on | |
438 your application, it may be faster to add an association to the front of | |
439 an association list than to update a property. All properties for a | |
440 symbol are stored in the same property list, so there is a possibility | |
441 of a conflict between different uses of a property name. (For this | |
442 reason, it is a good idea to choose property names that are probably | |
443 unique, such as by including the name of the library in the property | |
444 name.) An association list may be used like a stack where associations | |
445 are pushed on the front of the list and later discarded; this is not | |
446 possible with a property list. | |
447 | |
12067 | 448 @node Symbol Plists |
449 @subsection Property List Functions for Symbols | |
450 | |
6411 | 451 @defun symbol-plist symbol |
452 This function returns the property list of @var{symbol}. | |
453 @end defun | |
454 | |
455 @defun setplist symbol plist | |
12067 | 456 This function sets @var{symbol}'s property list to @var{plist}. |
6411 | 457 Normally, @var{plist} should be a well-formed property list, but this is |
458 not enforced. | |
459 | |
460 @smallexample | |
461 (setplist 'foo '(a 1 b (2 3) c nil)) | |
462 @result{} (a 1 b (2 3) c nil) | |
463 (symbol-plist 'foo) | |
464 @result{} (a 1 b (2 3) c nil) | |
465 @end smallexample | |
466 | |
467 For symbols in special obarrays, which are not used for ordinary | |
468 purposes, it may make sense to use the property list cell in a | |
469 nonstandard fashion; in fact, the abbrev mechanism does so | |
470 (@pxref{Abbrevs}). | |
471 @end defun | |
472 | |
473 @defun get symbol property | |
474 This function finds the value of the property named @var{property} in | |
475 @var{symbol}'s property list. If there is no such property, @code{nil} | |
476 is returned. Thus, there is no distinction between a value of | |
477 @code{nil} and the absence of the property. | |
478 | |
479 The name @var{property} is compared with the existing property names | |
480 using @code{eq}, so any object is a legitimate property. | |
481 | |
482 See @code{put} for an example. | |
483 @end defun | |
484 | |
485 @defun put symbol property value | |
486 This function puts @var{value} onto @var{symbol}'s property list under | |
487 the property name @var{property}, replacing any previous property value. | |
488 The @code{put} function returns @var{value}. | |
489 | |
490 @smallexample | |
491 (put 'fly 'verb 'transitive) | |
492 @result{}'transitive | |
493 (put 'fly 'noun '(a buzzing little bug)) | |
494 @result{} (a buzzing little bug) | |
495 (get 'fly 'verb) | |
496 @result{} transitive | |
497 (symbol-plist 'fly) | |
498 @result{} (verb transitive noun (a buzzing little bug)) | |
499 @end smallexample | |
500 @end defun | |
12067 | 501 |
502 @node Other Plists | |
503 @subsection Property Lists Outside Symbols | |
504 | |
505 These two functions are useful for manipulating property lists | |
506 that are stored in places other than symbols: | |
507 | |
508 @defun plist-get plist property | |
509 This returns the value of the @var{property} property | |
510 stored in the property list @var{plist}. For example, | |
511 | |
512 @example | |
513 (plist-get '(foo 4) 'foo) | |
514 @result{} 4 | |
515 @end example | |
516 @end defun | |
517 | |
518 @defun plist-put plist property value | |
12098 | 519 This stores @var{value} as the value of the @var{property} property in |
520 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
|
521 or it may construct a new list structure without altering the old. The |
12098 | 522 function returns the modified property list, so you can store that back |
523 in the place where you got @var{plist}. For example, | |
12067 | 524 |
525 @example | |
526 (setq my-plist '(bar t foo 4)) | |
527 @result{} (bar t foo 4) | |
528 (setq my-plist (plist-put my-plist 'foo 69)) | |
529 @result{} (bar t foo 69) | |
530 (setq my-plist (plist-put my-plist 'quux '(a))) | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
531 @result{} (bar t foo 69 quux (a)) |
12067 | 532 @end example |
533 @end defun | |
534 |