|
0
|
1 @c -*-texinfo-*-
|
|
|
2 @c This is part of the XEmacs Lisp Reference Manual.
|
|
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc.
|
|
|
4 @c See the file lispref.texi for copying conditions.
|
|
|
5 @setfilename ../../info/symbols.info
|
|
|
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 * Symbol Properties:: Each symbol has a property list
|
|
|
31 for recording miscellaneous information.
|
|
|
32 @end menu
|
|
|
33
|
|
|
34 @node Symbol Components
|
|
|
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
|
|
|
44 The @dfn{print name cell} holds a string that names the symbol for
|
|
|
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 (symbol)
|
|
|
65 The @dfn{property list cell} holds the property list of the symbol. See
|
|
|
66 @code{symbol-plist} in @ref{Symbol Properties}.
|
|
|
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 XEmacs Lisp,
|
|
|
77 this lookup uses a hashing algorithm and an obarray; see @ref{Creating
|
|
|
78 Symbols}.)
|
|
|
79
|
|
|
80 In normal usage, the function cell usually contains a function or
|
|
|
81 macro, as that is what the Lisp interpreter expects to see there
|
|
|
82 (@pxref{Evaluation}). Keyboard macros (@pxref{Keyboard Macros}),
|
|
|
83 keymaps (@pxref{Keymaps}) and autoload objects (@pxref{Autoloading}) are
|
|
|
84 also sometimes stored in the function cell of symbols. We often refer
|
|
|
85 to ``the function @code{foo}'' when we really mean the function stored
|
|
|
86 in the function cell of the symbol @code{foo}. We make the distinction
|
|
|
87 only when necessary.
|
|
|
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
|
|
|
96 symbol @code{nil}.) Examining a cell that is void results in an error,
|
|
|
97 such as @samp{Symbol's value as variable is void}.
|
|
|
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 XEmacs 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
|
|
|
122 @file{DOC} file. (29529 is the offset from the beginning of the
|
|
|
123 @file{DOC} file to where that documentation string begins.) The
|
|
|
124 function cell contains the function for returning the name of the file.
|
|
|
125 @code{buffer-file-name} names a primitive function, which has no read
|
|
|
126 syntax and prints in hash notation (@pxref{Primitive Function Type}). A
|
|
|
127 symbol naming a function written in Lisp would have a lambda expression
|
|
|
128 (or a byte-code object) in this cell.
|
|
|
129
|
|
|
130 @node Definitions
|
|
|
131 @section Defining Symbols
|
|
|
132 @cindex definition of a symbol
|
|
|
133
|
|
|
134 A @dfn{definition} in Lisp is a special form that announces your
|
|
|
135 intention to use a certain symbol in a particular way. In XEmacs Lisp,
|
|
|
136 you can define a symbol as a variable, or define it as a function (or
|
|
|
137 macro), or both independently.
|
|
|
138
|
|
|
139 A definition construct typically specifies a value or meaning for the
|
|
|
140 symbol for one kind of use, plus documentation for its meaning when used
|
|
|
141 in this way. Thus, when you define a symbol as a variable, you can
|
|
|
142 supply an initial value for the variable, plus documentation for the
|
|
|
143 variable.
|
|
|
144
|
|
|
145 @code{defvar} and @code{defconst} are special forms that define a
|
|
|
146 symbol as a global variable. They are documented in detail in
|
|
|
147 @ref{Defining Variables}.
|
|
|
148
|
|
|
149 @code{defun} defines a symbol as a function, creating a lambda
|
|
|
150 expression and storing it in the function cell of the symbol. This
|
|
|
151 lambda expression thus becomes the function definition of the symbol.
|
|
|
152 (The term ``function definition'', meaning the contents of the function
|
|
|
153 cell, is derived from the idea that @code{defun} gives the symbol its
|
|
|
154 definition as a function.) @code{defsubst}, @code{define-function} and
|
|
|
155 @code{defalias} are other ways of defining a function.
|
|
|
156 @xref{Functions}.
|
|
|
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
|
|
|
165 In XEmacs 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
|
|
|
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
|
|
78
|
173 @file{DOC} file. @xref{Accessing Documentation}.
|
|
0
|
174
|
|
|
175 @node Creating Symbols
|
|
|
176 @section Creating and Interning Symbols
|
|
|
177 @cindex reading symbols
|
|
|
178
|
|
|
179 To understand how symbols are created in XEmacs 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
|
|
|
199 If a symbol with the desired name is found, the reader uses that
|
|
|
200 symbol. If the obarray does not contain a symbol with that name, the
|
|
|
201 reader makes a new symbol and adds it to the obarray. Finding or adding
|
|
|
202 a symbol with a certain name is called @dfn{interning} it, and the
|
|
|
203 symbol is then called an @dfn{interned symbol}.
|
|
|
204
|
|
|
205 Interning ensures that each obarray has just one symbol with any
|
|
|
206 particular name. Other like-named symbols may exist, but not in the
|
|
|
207 same obarray. Thus, the reader gets the same symbols for the same
|
|
|
208 names, as long as you keep reading with the same obarray.
|
|
|
209
|
|
|
210 @cindex symbol equality
|
|
|
211 @cindex uninterned symbol
|
|
|
212 No obarray contains all symbols; in fact, some symbols are not in any
|
|
|
213 obarray. They are called @dfn{uninterned symbols}. An uninterned
|
|
|
214 symbol has the same four cells as other symbols; however, the only way
|
|
|
215 to gain access to it is by finding it in some other object or as the
|
|
|
216 value of a variable.
|
|
|
217
|
|
|
218 In XEmacs 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 @strong{Do not try to put symbols in an obarray yourself.} This does
|
|
|
233 not work---only @code{intern} can enter a symbol in an obarray properly.
|
|
|
234 @strong{Do not try to intern one symbol in two obarrays.} This would
|
|
|
235 garble both obarrays, because a symbol has just one slot to hold the
|
|
|
236 following symbol in the obarray bucket. The results would be
|
|
|
237 unpredictable.
|
|
|
238
|
|
|
239 It is possible for two different symbols to have the same name in
|
|
|
240 different obarrays; these symbols are not @code{eq} or @code{equal}.
|
|
|
241 However, this normally happens only as part of the abbrev mechanism
|
|
|
242 (@pxref{Abbrevs}).
|
|
|
243
|
|
|
244 @cindex CL note---symbol in obarrays
|
|
|
245 @quotation
|
|
|
246 @b{Common Lisp note:} In Common Lisp, a single symbol may be interned in
|
|
|
247 several obarrays.
|
|
|
248 @end quotation
|
|
|
249
|
|
|
250 Most of the functions below take a name and sometimes an obarray as
|
|
|
251 arguments. A @code{wrong-type-argument} error is signaled if the name
|
|
|
252 is not a string, or if the obarray is not a vector.
|
|
|
253
|
|
|
254 @defun symbol-name symbol
|
|
|
255 This function returns the string that is @var{symbol}'s name. For example:
|
|
|
256
|
|
|
257 @example
|
|
|
258 @group
|
|
|
259 (symbol-name 'foo)
|
|
|
260 @result{} "foo"
|
|
|
261 @end group
|
|
|
262 @end example
|
|
|
263
|
|
|
264 Changing the string by substituting characters, etc, does change the
|
|
|
265 name of the symbol, but fails to update the obarray, so don't do it!
|
|
|
266 @end defun
|
|
|
267
|
|
|
268 @defun make-symbol name
|
|
|
269 This function returns a newly-allocated, uninterned symbol whose name is
|
|
|
270 @var{name} (which must be a string). Its value and function definition
|
|
|
271 are void, and its property list is @code{nil}. In the example below,
|
|
|
272 the value of @code{sym} is not @code{eq} to @code{foo} because it is a
|
|
|
273 distinct uninterned symbol whose name is also @samp{foo}.
|
|
|
274
|
|
|
275 @example
|
|
|
276 (setq sym (make-symbol "foo"))
|
|
|
277 @result{} foo
|
|
|
278 (eq sym 'foo)
|
|
|
279 @result{} nil
|
|
|
280 @end example
|
|
|
281 @end defun
|
|
|
282
|
|
|
283 @defun intern name &optional obarray
|
|
|
284 This function returns the interned symbol whose name is @var{name}. If
|
|
|
285 there is no such symbol in the obarray @var{obarray}, @code{intern}
|
|
|
286 creates a new one, adds it to the obarray, and returns it. If
|
|
|
287 @var{obarray} is omitted, the value of the global variable
|
|
|
288 @code{obarray} is used.
|
|
|
289
|
|
|
290 @example
|
|
|
291 (setq sym (intern "foo"))
|
|
|
292 @result{} foo
|
|
|
293 (eq sym 'foo)
|
|
|
294 @result{} t
|
|
|
295
|
|
|
296 (setq sym1 (intern "foo" other-obarray))
|
|
|
297 @result{} foo
|
|
|
298 (eq sym 'foo)
|
|
|
299 @result{} nil
|
|
|
300 @end example
|
|
|
301 @end defun
|
|
|
302
|
|
|
303 @defun intern-soft name &optional obarray
|
|
|
304 This function returns the symbol in @var{obarray} whose name is
|
|
|
305 @var{name}, or @code{nil} if @var{obarray} has no symbol with that name.
|
|
|
306 Therefore, you can use @code{intern-soft} to test whether a symbol with
|
|
|
307 a given name is already interned. If @var{obarray} is omitted, the
|
|
|
308 value of the global variable @code{obarray} is used.
|
|
|
309
|
|
|
310 @smallexample
|
|
|
311 (intern-soft "frazzle") ; @r{No such symbol exists.}
|
|
|
312 @result{} nil
|
|
|
313 (make-symbol "frazzle") ; @r{Create an uninterned one.}
|
|
|
314 @result{} frazzle
|
|
|
315 @group
|
|
|
316 (intern-soft "frazzle") ; @r{That one cannot be found.}
|
|
|
317 @result{} nil
|
|
|
318 @end group
|
|
|
319 @group
|
|
|
320 (setq sym (intern "frazzle")) ; @r{Create an interned one.}
|
|
|
321 @result{} frazzle
|
|
|
322 @end group
|
|
|
323 @group
|
|
|
324 (intern-soft "frazzle") ; @r{That one can be found!}
|
|
|
325 @result{} frazzle
|
|
|
326 @end group
|
|
|
327 @group
|
|
|
328 (eq sym 'frazzle) ; @r{And it is the same one.}
|
|
|
329 @result{} t
|
|
|
330 @end group
|
|
|
331 @end smallexample
|
|
|
332 @end defun
|
|
|
333
|
|
|
334 @defvar obarray
|
|
|
335 This variable is the standard obarray for use by @code{intern} and
|
|
|
336 @code{read}.
|
|
|
337 @end defvar
|
|
|
338
|
|
|
339 @defun mapatoms function &optional obarray
|
|
|
340 This function calls @var{function} for each symbol in the obarray
|
|
|
341 @var{obarray}. It returns @code{nil}. If @var{obarray} is omitted, it
|
|
|
342 defaults to the value of @code{obarray}, the standard obarray for
|
|
|
343 ordinary symbols.
|
|
|
344
|
|
|
345 @smallexample
|
|
|
346 (setq count 0)
|
|
|
347 @result{} 0
|
|
|
348 (defun count-syms (s)
|
|
|
349 (setq count (1+ count)))
|
|
|
350 @result{} count-syms
|
|
|
351 (mapatoms 'count-syms)
|
|
|
352 @result{} nil
|
|
|
353 count
|
|
|
354 @result{} 1871
|
|
|
355 @end smallexample
|
|
|
356
|
|
|
357 See @code{documentation} in @ref{Accessing Documentation}, for another
|
|
|
358 example using @code{mapatoms}.
|
|
|
359 @end defun
|
|
|
360
|
|
|
361 @defun unintern symbol &optional obarray
|
|
|
362 This function deletes @var{symbol} from the obarray @var{obarray}. If
|
|
|
363 @code{symbol} is not actually in the obarray, @code{unintern} does
|
|
|
364 nothing. If @var{obarray} is @code{nil}, the current obarray is used.
|
|
|
365
|
|
|
366 If you provide a string instead of a symbol as @var{symbol}, it stands
|
|
|
367 for a symbol name. Then @code{unintern} deletes the symbol (if any) in
|
|
|
368 the obarray which has that name. If there is no such symbol,
|
|
|
369 @code{unintern} does nothing.
|
|
|
370
|
|
|
371 If @code{unintern} does delete a symbol, it returns @code{t}. Otherwise
|
|
|
372 it returns @code{nil}.
|
|
|
373 @end defun
|
|
|
374
|
|
|
375 @node Symbol Properties
|
|
|
376 @section Symbol Properties
|
|
|
377 @cindex property list, symbol
|
|
|
378 @cindex plist, symbol
|
|
|
379
|
|
|
380 A @dfn{property list} (@dfn{plist} for short) is a list of paired
|
|
|
381 elements stored in the property list cell of a symbol. Each of the
|
|
|
382 pairs associates a property name (usually a symbol) with a property or
|
|
|
383 value. Property lists are generally used to record information about a
|
|
|
384 symbol, such as its documentation as a variable, the name of the file
|
|
|
385 where it was defined, or perhaps even the grammatical class of the
|
|
|
386 symbol (representing a word) in a language-understanding system.
|
|
|
387
|
|
|
388 Many objects other than symbols can have property lists associated
|
|
|
389 with them, and XEmacs provides a full complement of functions for
|
|
|
390 working with property lists. @xref{Property Lists}.
|
|
|
391
|
|
|
392 The property names and values in a property list can be any Lisp
|
|
|
393 objects, but the names are usually symbols. They are compared using
|
|
|
394 @code{eq}. Here is an example of a property list, found on the symbol
|
|
|
395 @code{progn} when the compiler is loaded:
|
|
|
396
|
|
|
397 @example
|
|
|
398 (lisp-indent-function 0 byte-compile byte-compile-progn)
|
|
|
399 @end example
|
|
|
400
|
|
|
401 @noindent
|
|
|
402 Here @code{lisp-indent-function} and @code{byte-compile} are property
|
|
|
403 names, and the other two elements are the corresponding values.
|
|
|
404
|
|
|
405 @menu
|
|
|
406 * Plists and Alists:: Comparison of the advantages of property
|
|
|
407 lists and association lists.
|
|
|
408 * Symbol Plists:: Functions to access symbols' property lists.
|
|
|
409 * Other Plists:: Accessing property lists stored elsewhere.
|
|
|
410 @end menu
|
|
|
411
|
|
|
412 @node Plists and Alists
|
|
|
413 @subsection Property Lists and Association Lists
|
|
|
414
|
|
|
415 @cindex property lists vs association lists
|
|
|
416 Association lists (@pxref{Association Lists}) are very similar to
|
|
|
417 property lists. In contrast to association lists, the order of the
|
|
|
418 pairs in the property list is not significant since the property names
|
|
|
419 must be distinct.
|
|
|
420
|
|
|
421 Property lists are better than association lists for attaching
|
|
|
422 information to various Lisp function names or variables. If all the
|
|
|
423 associations are recorded in one association list, the program will need
|
|
|
424 to search that entire list each time a function or variable is to be
|
|
|
425 operated on. By contrast, if the information is recorded in the
|
|
|
426 property lists of the function names or variables themselves, each
|
|
|
427 search will scan only the length of one property list, which is usually
|
|
|
428 short. This is why the documentation for a variable is recorded in a
|
|
|
429 property named @code{variable-documentation}. The byte compiler
|
|
|
430 likewise uses properties to record those functions needing special
|
|
|
431 treatment.
|
|
|
432
|
|
|
433 However, association lists have their own advantages. Depending on
|
|
|
434 your application, it may be faster to add an association to the front of
|
|
|
435 an association list than to update a property. All properties for a
|
|
|
436 symbol are stored in the same property list, so there is a possibility
|
|
|
437 of a conflict between different uses of a property name. (For this
|
|
|
438 reason, it is a good idea to choose property names that are probably
|
|
|
439 unique, such as by including the name of the library in the property
|
|
|
440 name.) An association list may be used like a stack where associations
|
|
|
441 are pushed on the front of the list and later discarded; this is not
|
|
|
442 possible with a property list.
|
|
|
443
|
|
|
444 @node Symbol Plists
|
|
|
445 @subsection Property List Functions for Symbols
|
|
|
446
|
|
|
447 @defun symbol-plist symbol
|
|
|
448 This function returns the property list of @var{symbol}.
|
|
|
449 @end defun
|
|
|
450
|
|
|
451 @defun setplist symbol plist
|
|
|
452 This function sets @var{symbol}'s property list to @var{plist}.
|
|
|
453 Normally, @var{plist} should be a well-formed property list, but this is
|
|
|
454 not enforced.
|
|
|
455
|
|
|
456 @smallexample
|
|
|
457 (setplist 'foo '(a 1 b (2 3) c nil))
|
|
|
458 @result{} (a 1 b (2 3) c nil)
|
|
|
459 (symbol-plist 'foo)
|
|
|
460 @result{} (a 1 b (2 3) c nil)
|
|
|
461 @end smallexample
|
|
|
462
|
|
|
463 For symbols in special obarrays, which are not used for ordinary
|
|
|
464 purposes, it may make sense to use the property list cell in a
|
|
|
465 nonstandard fashion; in fact, the abbrev mechanism does so
|
|
|
466 (@pxref{Abbrevs}).
|
|
|
467 @end defun
|
|
|
468
|
|
|
469 @defun get symbol property
|
|
|
470 This function finds the value of the property named @var{property} in
|
|
|
471 @var{symbol}'s property list. If there is no such property, @code{nil}
|
|
|
472 is returned. Thus, there is no distinction between a value of
|
|
|
473 @code{nil} and the absence of the property.
|
|
|
474
|
|
|
475 The name @var{property} is compared with the existing property names
|
|
|
476 using @code{eq}, so any object is a legitimate property.
|
|
|
477
|
|
|
478 See @code{put} for an example.
|
|
|
479 @end defun
|
|
|
480
|
|
|
481 @defun put symbol property value
|
|
|
482 This function puts @var{value} onto @var{symbol}'s property list under
|
|
|
483 the property name @var{property}, replacing any previous property value.
|
|
|
484 The @code{put} function returns @var{value}.
|
|
|
485
|
|
|
486 @smallexample
|
|
|
487 (put 'fly 'verb 'transitive)
|
|
|
488 @result{}'transitive
|
|
|
489 (put 'fly 'noun '(a buzzing little bug))
|
|
|
490 @result{} (a buzzing little bug)
|
|
|
491 (get 'fly 'verb)
|
|
|
492 @result{} transitive
|
|
|
493 (symbol-plist 'fly)
|
|
|
494 @result{} (verb transitive noun (a buzzing little bug))
|
|
|
495 @end smallexample
|
|
|
496 @end defun
|
|
|
497
|
|
|
498 @node Other Plists
|
|
|
499 @subsection Property Lists Outside Symbols
|
|
|
500
|
|
|
501 These functions are useful for manipulating property lists
|
|
|
502 that are stored in places other than symbols:
|
|
|
503
|
|
|
504 @defun getf plist property &optional default
|
|
|
505 This returns the value of the @var{property} property
|
|
|
506 stored in the property list @var{plist}. For example,
|
|
|
507
|
|
|
508 @example
|
|
|
509 (getf '(foo 4) 'foo)
|
|
|
510 @result{} 4
|
|
|
511 @end example
|
|
|
512 @end defun
|
|
|
513
|
|
|
514 @defun putf plist property value
|
|
|
515 This stores @var{value} as the value of the @var{property} property in
|
|
|
516 the property list @var{plist}. It may modify @var{plist} destructively,
|
|
|
517 or it may construct a new list structure without altering the old. The
|
|
|
518 function returns the modified property list, so you can store that back
|
|
|
519 in the place where you got @var{plist}. For example,
|
|
|
520
|
|
|
521 @example
|
|
|
522 (setq my-plist '(bar t foo 4))
|
|
|
523 @result{} (bar t foo 4)
|
|
|
524 (setq my-plist (putf my-plist 'foo 69))
|
|
|
525 @result{} (bar t foo 69)
|
|
|
526 (setq my-plist (putf my-plist 'quux '(a)))
|
|
|
527 @result{} (quux (a) bar t foo 5)
|
|
|
528 @end example
|
|
|
529 @end defun
|
|
|
530
|
|
|
531 @defun plists-eq a b
|
|
|
532 This function returns non-@code{nil} if property lists @var{a} and @var{b}
|
|
|
533 are @code{eq}. This means that the property lists have the same values
|
|
|
534 for all the same properties, where comparison between values is done using
|
|
|
535 @code{eq}.
|
|
|
536 @end defun
|
|
|
537
|
|
|
538 @defun plists-equal a b
|
|
|
539 This function returns non-@code{nil} if property lists @var{a} and @var{b}
|
|
|
540 are @code{equal}.
|
|
|
541 @end defun
|
|
|
542
|
|
|
543 Both of the above functions do order-insensitive comparisons.
|
|
|
544
|
|
|
545 @example
|
|
|
546 (plists-eq '(a 1 b 2 c nil) '(b 2 a 1))
|
|
|
547 @result{} t
|
|
|
548 (plists-eq '(foo "hello" bar "goodbye") '(bar "goodbye" foo "hello"))
|
|
|
549 @result{} nil
|
|
|
550 (plists-equal '(foo "hello" bar "goodbye") '(bar "goodbye" foo "hello"))
|
|
|
551 @result{} t
|
|
|
552 @end example
|
|
|
553
|
|
|
554
|
|
|
555
|
