|
0
|
1 \input texinfo @c -*-texinfo-*-
|
|
|
2 @setfilename ../info/cl.info
|
|
|
3 @settitle Common Lisp Extensions
|
|
|
4
|
|
|
5 @iftex
|
|
|
6 @finalout
|
|
|
7 @end iftex
|
|
|
8
|
|
|
9 @ifinfo
|
|
|
10 This file documents the GNU Emacs Common Lisp emulation package.
|
|
|
11
|
|
|
12 Copyright (C) 1993 Free Software Foundation, Inc.
|
|
|
13
|
|
|
14 Permission is granted to make and distribute verbatim copies of this
|
|
|
15 manual provided the copyright notice and this permission notice are
|
|
|
16 preserved on all copies.
|
|
|
17
|
|
|
18 @ignore
|
|
|
19 Permission is granted to process this file through TeX and print the
|
|
|
20 results, provided the printed document carries copying permission notice
|
|
|
21 identical to this one except for the removal of this paragraph (this
|
|
|
22 paragraph not being relevant to the printed manual).
|
|
|
23
|
|
|
24 @end ignore
|
|
|
25 Permission is granted to copy and distribute modified versions of this
|
|
|
26 manual under the conditions for verbatim copying, provided also that the
|
|
|
27 section entitled ``GNU General Public License'' is included exactly as
|
|
|
28 in the original, and provided that the entire resulting derived work is
|
|
|
29 distributed under the terms of a permission notice identical to this one.
|
|
|
30
|
|
|
31 Permission is granted to copy and distribute translations of this manual
|
|
|
32 into another language, under the above conditions for modified versions,
|
|
|
33 except that the section entitled ``GNU General Public License'' may be
|
|
|
34 included in a translation approved by the author instead of in the
|
|
|
35 original English.
|
|
|
36 @end ifinfo
|
|
|
37
|
|
|
38 @titlepage
|
|
|
39 @sp 6
|
|
|
40 @center @titlefont{Common Lisp Extensions}
|
|
|
41 @sp 4
|
|
|
42 @center For GNU Emacs Lisp
|
|
|
43 @sp 1
|
|
|
44 @center Version 2.02
|
|
|
45 @sp 5
|
|
|
46 @center Dave Gillespie
|
|
|
47 @center daveg@@synaptics.com
|
|
|
48 @page
|
|
|
49
|
|
|
50 @vskip 0pt plus 1filll
|
|
|
51 Copyright @copyright{} 1993 Free Software Foundation, Inc.
|
|
|
52
|
|
|
53 Permission is granted to make and distribute verbatim copies of
|
|
|
54 this manual provided the copyright notice and this permission notice
|
|
|
55 are preserved on all copies.
|
|
|
56
|
|
|
57 @ignore
|
|
|
58 Permission is granted to process this file through TeX and print the
|
|
|
59 results, provided the printed document carries copying permission notice
|
|
|
60 identical to this one except for the removal of this paragraph (this
|
|
|
61 paragraph not being relevant to the printed manual).
|
|
|
62
|
|
|
63 @end ignore
|
|
|
64 Permission is granted to copy and distribute modified versions of this
|
|
|
65 manual under the conditions for verbatim copying, provided also that the
|
|
|
66 section entitled ``GNU General Public License'' is included exactly as
|
|
|
67 in the original, and provided that the entire resulting derived work is
|
|
|
68 distributed under the terms of a permission notice identical to this one.
|
|
|
69
|
|
|
70 Permission is granted to copy and distribute translations of this manual
|
|
|
71 into another language, under the above conditions for modified versions,
|
|
|
72 except that the section entitled ``GNU General Public License'' may be
|
|
|
73 included in a translation approved by the author instead of in the
|
|
|
74 original English.
|
|
|
75 @end titlepage
|
|
|
76
|
|
|
77 @node Top, Overview,, (dir)
|
|
|
78 @chapter Common Lisp Extensions
|
|
|
79
|
|
|
80 @noindent
|
|
|
81 This document describes a set of Emacs Lisp facilities borrowed from
|
|
|
82 Common Lisp. All the facilities are described here in detail; for
|
|
|
83 more discussion and examples, Guy L. Steele's @cite{Common Lisp, the
|
|
|
84 Language}, second edition, is the definitive book on Common Lisp.
|
|
|
85 @iftex
|
|
|
86 Chapter numbers and most section numbers of this document parallel
|
|
|
87 those of Steele's book.
|
|
|
88 @end iftex
|
|
|
89 While this document does not assume any prior knowledge of Common
|
|
|
90 Lisp, it does assume a basic familiarity with Emacs Lisp.
|
|
|
91
|
|
|
92 @menu
|
|
|
93 * Overview:: Installation, usage, etc.
|
|
|
94 * Program Structure:: Arglists, `eval-when', `defalias'
|
|
|
95 * Predicates:: `typep', `eql', and `equalp'
|
|
|
96 * Control Structure:: `setf', `when', `do', `loop', etc.
|
|
|
97 * Macros:: Destructuring, `define-compiler-macro'
|
|
|
98 * Declarations:: `proclaim', `declare', etc.
|
|
|
99 * Symbols:: Property lists, `gensym'
|
|
|
100 * Numbers:: Predicates, functions, random numbers
|
|
|
101 * Sequences:: Mapping, functions, searching, sorting
|
|
|
102 * Lists:: `cadr', `sublis', `member*', `assoc*', etc.
|
|
|
103 * Hash Tables:: `make-hash-table', `gethash', etc.
|
|
|
104 * Structures:: `defstruct'
|
|
|
105 * Assertions:: `check-type', `assert', `ignore-errors'.
|
|
|
106
|
|
|
107 * Efficiency Concerns:: Hints and techniques
|
|
|
108 * Common Lisp Compatibility:: All known differences with Steele
|
|
|
109 * Old CL Compatibility:: All known differences with old cl.el
|
|
|
110 * Porting Common Lisp:: Hints for porting Common Lisp code
|
|
|
111
|
|
|
112 * Function Index::
|
|
|
113 * Variable Index::
|
|
|
114 @end menu
|
|
|
115
|
|
|
116 @node Overview, Program Structure, Top, Top
|
|
|
117 @ifinfo
|
|
|
118 @chapter Overview
|
|
|
119 @end ifinfo
|
|
|
120 @iftex
|
|
|
121 @section Overview
|
|
|
122 @end iftex
|
|
|
123
|
|
|
124 @noindent
|
|
|
125 Common Lisp is a huge language, and Common Lisp systems tend to be
|
|
|
126 massive and extremely complex. Emacs Lisp, by contrast, is rather
|
|
|
127 minimalist in the choice of Lisp features it offers the programmer.
|
|
|
128 As Emacs Lisp programmers have grown in number, and the applications
|
|
|
129 they write have grown more ambitious, it has become clear that Emacs
|
|
|
130 Lisp could benefit from many of the conveniences of Common Lisp.
|
|
|
131
|
|
|
132 The @dfn{CL} package adds a number of Common Lisp functions and
|
|
|
133 control structures to Emacs Lisp. While not a 100% complete
|
|
|
134 implementation of Common Lisp, @dfn{CL} adds enough functionality
|
|
|
135 to make Emacs Lisp programming significantly more convenient.
|
|
|
136
|
|
|
137 Some Common Lisp features have been omitted from this package
|
|
|
138 for various reasons:
|
|
|
139
|
|
|
140 @itemize @bullet
|
|
|
141 @item
|
|
|
142 Some features are too complex or bulky relative to their benefit
|
|
|
143 to Emacs Lisp programmers. CLOS and Common Lisp streams are fine
|
|
|
144 examples of this group.
|
|
|
145
|
|
|
146 @item
|
|
|
147 Other features cannot be implemented without modification to the
|
|
|
148 Emacs Lisp interpreter itself, such as multiple return values,
|
|
|
149 lexical scoping, case-insensitive symbols, and complex numbers.
|
|
|
150 The @dfn{CL} package generally makes no attempt to emulate these
|
|
|
151 features.
|
|
|
152
|
|
|
153 @item
|
|
|
154 Some features conflict with existing things in Emacs Lisp. For
|
|
|
155 example, Emacs' @code{assoc} function is incompatible with the
|
|
|
156 Common Lisp @code{assoc}. In such cases, this package usually
|
|
|
157 adds the suffix @samp{*} to the function name of the Common
|
|
|
158 Lisp version of the function (e.g., @code{assoc*}).
|
|
|
159 @end itemize
|
|
|
160
|
|
|
161 The package described here was written by Dave Gillespie,
|
|
|
162 @file{daveg@@synaptics.com}. It is a total rewrite of the original
|
|
2
|
163 1986 @file{cl.el} package by Cesar Quiroz. Most features of
|
|
0
|
164 the Quiroz package have been retained; any incompatibilities are
|
|
|
165 noted in the descriptions below. Care has been taken in this
|
|
|
166 version to ensure that each function is defined efficiently,
|
|
|
167 concisely, and with minimal impact on the rest of the Emacs
|
|
|
168 environment.
|
|
|
169
|
|
|
170 @menu
|
|
|
171 * Usage:: How to use the CL package
|
|
|
172 * Organization:: The package's five component files
|
|
|
173 * Installation:: Compiling and installing CL
|
|
|
174 * Naming Conventions:: Notes on CL function names
|
|
|
175 @end menu
|
|
|
176
|
|
|
177 @node Usage, Organization, Overview, Overview
|
|
|
178 @section Usage
|
|
|
179
|
|
|
180 @noindent
|
|
|
181 Lisp code that uses features from the @dfn{CL} package should
|
|
|
182 include at the beginning:
|
|
|
183
|
|
|
184 @example
|
|
|
185 (require 'cl)
|
|
|
186 @end example
|
|
|
187
|
|
|
188 @noindent
|
|
|
189 If you want to ensure that the new (Gillespie) version of @dfn{CL}
|
|
|
190 is the one that is present, add an additional @code{(require 'cl-19)}
|
|
|
191 call:
|
|
|
192
|
|
|
193 @example
|
|
|
194 (require 'cl)
|
|
|
195 (require 'cl-19)
|
|
|
196 @end example
|
|
|
197
|
|
|
198 @noindent
|
|
|
199 The second call will fail (with ``@file{cl-19.el} not found'') if
|
|
|
200 the old @file{cl.el} package was in use.
|
|
|
201
|
|
|
202 It is safe to arrange to load @dfn{CL} at all times, e.g.,
|
|
|
203 in your @file{.emacs} file. But it's a good idea, for portability,
|
|
|
204 to @code{(require 'cl)} in your code even if you do this.
|
|
|
205
|
|
|
206 @node Organization, Installation, Usage, Overview
|
|
|
207 @section Organization
|
|
|
208
|
|
|
209 @noindent
|
|
|
210 The Common Lisp package is organized into four files:
|
|
|
211
|
|
|
212 @table @file
|
|
|
213 @item cl.el
|
|
|
214 This is the ``main'' file, which contains basic functions
|
|
|
215 and information about the package. This file is relatively
|
|
|
216 compact---about 700 lines.
|
|
|
217
|
|
|
218 @item cl-extra.el
|
|
|
219 This file contains the larger, more complex or unusual functions.
|
|
|
220 It is kept separate so that packages which only want to use Common
|
|
|
221 Lisp fundamentals like the @code{cadr} function won't need to pay
|
|
|
222 the overhead of loading the more advanced functions.
|
|
|
223
|
|
|
224 @item cl-seq.el
|
|
|
225 This file contains most of the advanced functions for operating
|
|
|
226 on sequences or lists, such as @code{delete-if} and @code{assoc*}.
|
|
|
227
|
|
|
228 @item cl-macs.el
|
|
|
229 This file contains the features of the packages which are macros
|
|
|
230 instead of functions. Macros expand when the caller is compiled,
|
|
|
231 not when it is run, so the macros generally only need to be
|
|
|
232 present when the byte-compiler is running (or when the macros are
|
|
|
233 used in uncompiled code such as a @file{.emacs} file). Most of
|
|
|
234 the macros of this package are isolated in @file{cl-macs.el} so
|
|
|
235 that they won't take up memory unless you are compiling.
|
|
|
236 @end table
|
|
|
237
|
|
|
238 The file @file{cl.el} includes all necessary @code{autoload}
|
|
|
239 commands for the functions and macros in the other three files.
|
|
|
240 All you have to do is @code{(require 'cl)}, and @file{cl.el}
|
|
|
241 will take care of pulling in the other files when they are
|
|
|
242 needed.
|
|
|
243
|
|
|
244 There is another file, @file{cl-compat.el}, which defines some
|
|
|
245 routines from the older @file{cl.el} package that are no longer
|
|
|
246 present in the new package. This includes internal routines
|
|
|
247 like @code{setelt} and @code{zip-lists}, deprecated features
|
|
|
248 like @code{defkeyword}, and an emulation of the old-style
|
|
|
249 multiple-values feature. @xref{Old CL Compatibility}.
|
|
|
250
|
|
|
251 @node Installation, Naming Conventions, Organization, Overview
|
|
|
252 @section Installation
|
|
|
253
|
|
|
254 @noindent
|
|
|
255 Installation of the @dfn{CL} package is simple: Just put the
|
|
|
256 byte-compiled files @file{cl.elc}, @file{cl-extra.elc},
|
|
|
257 @file{cl-seq.elc}, @file{cl-macs.elc}, and @file{cl-compat.elc}
|
|
|
258 into a directory on your @code{load-path}.
|
|
|
259
|
|
|
260 There are no special requirements to compile this package:
|
|
|
261 The files do not have to be loaded before they are compiled,
|
|
|
262 nor do they need to be compiled in any particular order.
|
|
|
263
|
|
|
264 You may choose to put the files into your main @file{lisp/}
|
|
|
265 directory, replacing the original @file{cl.el} file there. Or,
|
|
|
266 you could put them into a directory that comes before @file{lisp/}
|
|
|
267 on your @code{load-path} so that the old @file{cl.el} is
|
|
|
268 effectively hidden.
|
|
|
269
|
|
|
270 Also, format the @file{cl.texinfo} file and put the resulting
|
|
|
271 Info files in the @file{info/} directory or another suitable place.
|
|
|
272
|
|
|
273 You may instead wish to leave this package's components all in
|
|
|
274 their own directory, and then add this directory to your
|
|
|
275 @code{load-path} and (Emacs 19 only) @code{Info-directory-list}.
|
|
|
276 Add the directory to the front of the list so the old @dfn{CL}
|
|
|
277 package and its documentation are hidden.
|
|
|
278
|
|
|
279 @node Naming Conventions, , Installation, Overview
|
|
|
280 @section Naming Conventions
|
|
|
281
|
|
|
282 @noindent
|
|
|
283 Except where noted, all functions defined by this package have the
|
|
|
284 same names and calling conventions as their Common Lisp counterparts.
|
|
|
285
|
|
|
286 Following is a complete list of functions whose names were changed
|
|
|
287 from Common Lisp, usually to avoid conflicts with Emacs. In each
|
|
|
288 case, a @samp{*} has been appended to the Common Lisp name to obtain
|
|
|
289 the Emacs name:
|
|
|
290
|
|
|
291 @example
|
|
|
292 defun* defsubst* defmacro* function*
|
|
|
293 member* assoc* rassoc* get*
|
|
|
294 remove* delete* mapcar* sort*
|
|
|
295 floor* ceiling* truncate* round*
|
|
|
296 mod* rem* random*
|
|
|
297 @end example
|
|
|
298
|
|
|
299 Internal function and variable names in the package are prefixed
|
|
|
300 by @code{cl-}. Here is a complete list of functions @emph{not}
|
|
|
301 prefixed by @code{cl-} which were not taken from Common Lisp:
|
|
|
302
|
|
|
303 @example
|
|
|
304 member delete remove remq
|
|
|
305 rassoc floatp-safe lexical-let lexical-let*
|
|
|
306 callf callf2 letf letf*
|
|
|
307 defsubst* defalias add-hook eval-when-compile
|
|
|
308 @end example
|
|
|
309
|
|
|
310 @noindent
|
|
|
311 (Most of these are Emacs 19 features provided to Emacs 18 users,
|
|
|
312 or introduced, like @code{remq}, for reasons of symmetry
|
|
|
313 with similar features.)
|
|
|
314
|
|
|
315 The following simple functions and macros are defined in @file{cl.el};
|
|
|
316 they do not cause other components like @file{cl-extra} to be loaded.
|
|
|
317
|
|
|
318 @example
|
|
|
319 eql floatp-safe abs endp
|
|
|
320 evenp oddp plusp minusp
|
|
|
321 last butlast nbutlast caar .. cddddr
|
|
|
322 list* ldiff rest first .. tenth
|
|
|
323 member [1] copy-list subst mapcar* [2]
|
|
|
324 adjoin [3] acons pairlis when
|
|
|
325 unless pop [4] push [4] pushnew [3,4]
|
|
|
326 incf [4] decf [4] proclaim declaim
|
|
|
327 add-hook
|
|
|
328 @end example
|
|
|
329
|
|
|
330 @noindent
|
|
|
331 [1] This is the Emacs 19-compatible function, not @code{member*}.
|
|
|
332
|
|
|
333 @noindent
|
|
|
334 [2] Only for one sequence argument or two list arguments.
|
|
|
335
|
|
|
336 @noindent
|
|
|
337 [3] Only if @code{:test} is @code{eq}, @code{equal}, or unspecified,
|
|
|
338 and @code{:key} is not used.
|
|
|
339
|
|
|
340 @noindent
|
|
|
341 [4] Only when @var{place} is a plain variable name.
|
|
|
342
|
|
|
343 @iftex
|
|
|
344 @chapno=4
|
|
|
345 @end iftex
|
|
|
346
|
|
|
347 @node Program Structure, Predicates, Overview, Top
|
|
|
348 @chapter Program Structure
|
|
|
349
|
|
|
350 @noindent
|
|
|
351 This section describes features of the @dfn{CL} package which have to
|
|
|
352 do with programs as a whole: advanced argument lists for functions,
|
|
|
353 and the @code{eval-when} construct.
|
|
|
354
|
|
|
355 @menu
|
|
|
356 * Argument Lists:: `&key', `&aux', `defun*', `defmacro*'.
|
|
|
357 * Time of Evaluation:: The `eval-when' construct.
|
|
|
358 * Function Aliases:: The `defalias' function.
|
|
|
359 @end menu
|
|
|
360
|
|
|
361 @iftex
|
|
|
362 @secno=1
|
|
|
363 @end iftex
|
|
|
364
|
|
|
365 @node Argument Lists, Time of Evaluation, Program Structure, Program Structure
|
|
|
366 @section Argument Lists
|
|
|
367
|
|
|
368 @noindent
|
|
|
369 Emacs Lisp's notation for argument lists of functions is a subset of
|
|
|
370 the Common Lisp notation. As well as the familiar @code{&optional}
|
|
|
371 and @code{&rest} markers, Common Lisp allows you to specify default
|
|
|
372 values for optional arguments, and it provides the additional markers
|
|
|
373 @code{&key} and @code{&aux}.
|
|
|
374
|
|
|
375 Since argument parsing is built-in to Emacs, there is no way for
|
|
|
376 this package to implement Common Lisp argument lists seamlessly.
|
|
|
377 Instead, this package defines alternates for several Lisp forms
|
|
|
378 which you must use if you need Common Lisp argument lists.
|
|
|
379
|
|
|
380 @defspec defun* name arglist body...
|
|
|
381 This form is identical to the regular @code{defun} form, except
|
|
|
382 that @var{arglist} is allowed to be a full Common Lisp argument
|
|
|
383 list. Also, the function body is enclosed in an implicit block
|
|
|
384 called @var{name}; @pxref{Blocks and Exits}.
|
|
|
385 @end defspec
|
|
|
386
|
|
|
387 @defspec defsubst* name arglist body...
|
|
|
388 This is just like @code{defun*}, except that the function that
|
|
|
389 is defined is automatically proclaimed @code{inline}, i.e.,
|
|
|
390 calls to it may be expanded into in-line code by the byte compiler.
|
|
|
391 This is analogous to the @code{defsubst} form in Emacs 19;
|
|
|
392 @code{defsubst*} uses a different method (compiler macros) which
|
|
|
393 works in all version of Emacs, and also generates somewhat more
|
|
|
394 efficient inline expansions. In particular, @code{defsubst*}
|
|
|
395 arranges for the processing of keyword arguments, default values,
|
|
|
396 etc., to be done at compile-time whenever possible.
|
|
|
397 @end defspec
|
|
|
398
|
|
|
399 @defspec defmacro* name arglist body...
|
|
|
400 This is identical to the regular @code{defmacro} form,
|
|
|
401 except that @var{arglist} is allowed to be a full Common Lisp
|
|
|
402 argument list. The @code{&environment} keyword is supported as
|
|
|
403 described in Steele. The @code{&whole} keyword is supported only
|
|
|
404 within destructured lists (see below); top-level @code{&whole}
|
|
|
405 cannot be implemented with the current Emacs Lisp interpreter.
|
|
|
406 The macro expander body is enclosed in an implicit block called
|
|
|
407 @var{name}.
|
|
|
408 @end defspec
|
|
|
409
|
|
|
410 @defspec function* symbol-or-lambda
|
|
|
411 This is identical to the regular @code{function} form,
|
|
|
412 except that if the argument is a @code{lambda} form then that
|
|
|
413 form may use a full Common Lisp argument list.
|
|
|
414 @end defspec
|
|
|
415
|
|
|
416 Also, all forms (such as @code{defsetf} and @code{flet}) defined
|
|
|
417 in this package that include @var{arglist}s in their syntax allow
|
|
|
418 full Common Lisp argument lists.
|
|
|
419
|
|
|
420 Note that it is @emph{not} necessary to use @code{defun*} in
|
|
|
421 order to have access to most @dfn{CL} features in your function.
|
|
|
422 These features are always present; @code{defun*}'s only
|
|
|
423 difference from @code{defun} is its more flexible argument
|
|
|
424 lists and its implicit block.
|
|
|
425
|
|
|
426 The full form of a Common Lisp argument list is
|
|
|
427
|
|
|
428 @example
|
|
|
429 (@var{var}...
|
|
|
430 &optional (@var{var} @var{initform} @var{svar})...
|
|
|
431 &rest @var{var}
|
|
|
432 &key ((@var{keyword} @var{var}) @var{initform} @var{svar})...
|
|
|
433 &aux (@var{var} @var{initform})...)
|
|
|
434 @end example
|
|
|
435
|
|
|
436 Each of the five argument list sections is optional. The @var{svar},
|
|
|
437 @var{initform}, and @var{keyword} parts are optional; if they are
|
|
|
438 omitted, then @samp{(@var{var})} may be written simply @samp{@var{var}}.
|
|
|
439
|
|
|
440 The first section consists of zero or more @dfn{required} arguments.
|
|
|
441 These arguments must always be specified in a call to the function;
|
|
|
442 there is no difference between Emacs Lisp and Common Lisp as far as
|
|
|
443 required arguments are concerned.
|
|
|
444
|
|
|
445 The second section consists of @dfn{optional} arguments. These
|
|
|
446 arguments may be specified in the function call; if they are not,
|
|
|
447 @var{initform} specifies the default value used for the argument.
|
|
|
448 (No @var{initform} means to use @code{nil} as the default.) The
|
|
|
449 @var{initform} is evaluated with the bindings for the preceding
|
|
|
450 arguments already established; @code{(a &optional (b (1+ a)))}
|
|
|
451 matches one or two arguments, with the second argument defaulting
|
|
|
452 to one plus the first argument. If the @var{svar} is specified,
|
|
|
453 it is an auxiliary variable which is bound to @code{t} if the optional
|
|
|
454 argument was specified, or to @code{nil} if the argument was omitted.
|
|
|
455 If you don't use an @var{svar}, then there will be no way for your
|
|
|
456 function to tell whether it was called with no argument, or with
|
|
|
457 the default value passed explicitly as an argument.
|
|
|
458
|
|
|
459 The third section consists of a single @dfn{rest} argument. If
|
|
|
460 more arguments were passed to the function than are accounted for
|
|
|
461 by the required and optional arguments, those extra arguments are
|
|
|
462 collected into a list and bound to the ``rest'' argument variable.
|
|
|
463 Common Lisp's @code{&rest} is equivalent to that of Emacs Lisp.
|
|
|
464 Common Lisp accepts @code{&body} as a synonym for @code{&rest} in
|
|
|
465 macro contexts; this package accepts it all the time.
|
|
|
466
|
|
|
467 The fourth section consists of @dfn{keyword} arguments. These
|
|
|
468 are optional arguments which are specified by name rather than
|
|
|
469 positionally in the argument list. For example,
|
|
|
470
|
|
|
471 @example
|
|
|
472 (defun* foo (a &optional b &key c d (e 17)))
|
|
|
473 @end example
|
|
|
474
|
|
|
475 @noindent
|
|
|
476 defines a function which may be called with one, two, or more
|
|
|
477 arguments. The first two arguments are bound to @code{a} and
|
|
|
478 @code{b} in the usual way. The remaining arguments must be
|
|
|
479 pairs of the form @code{:c}, @code{:d}, or @code{:e} followed
|
|
|
480 by the value to be bound to the corresponding argument variable.
|
|
|
481 (Symbols whose names begin with a colon are called @dfn{keywords},
|
|
|
482 and they are self-quoting in the same way as @code{nil} and
|
|
|
483 @code{t}.)
|
|
|
484
|
|
|
485 For example, the call @code{(foo 1 2 :d 3 :c 4)} sets the five
|
|
|
486 arguments to 1, 2, 4, 3, and 17, respectively. If the same keyword
|
|
|
487 appears more than once in the function call, the first occurrence
|
|
|
488 takes precedence over the later ones. Note that it is not possible
|
|
|
489 to specify keyword arguments without specifying the optional
|
|
|
490 argument @code{b} as well, since @code{(foo 1 :c 2)} would bind
|
|
|
491 @code{b} to the keyword @code{:c}, then signal an error because
|
|
|
492 @code{2} is not a valid keyword.
|
|
|
493
|
|
|
494 If a @var{keyword} symbol is explicitly specified in the argument
|
|
|
495 list as shown in the above diagram, then that keyword will be
|
|
|
496 used instead of just the variable name prefixed with a colon.
|
|
|
497 You can specify a @var{keyword} symbol which does not begin with
|
|
|
498 a colon at all, but such symbols will not be self-quoting; you
|
|
|
499 will have to quote them explicitly with an apostrophe in the
|
|
|
500 function call.
|
|
|
501
|
|
|
502 Ordinarily it is an error to pass an unrecognized keyword to
|
|
|
503 a function, e.g., @code{(foo 1 2 :c 3 :goober 4)}. You can ask
|
|
|
504 Lisp to ignore unrecognized keywords, either by adding the
|
|
|
505 marker @code{&allow-other-keys} after the keyword section
|
|
|
506 of the argument list, or by specifying an @code{:allow-other-keys}
|
|
|
507 argument in the call whose value is non-@code{nil}. If the
|
|
|
508 function uses both @code{&rest} and @code{&key} at the same time,
|
|
|
509 the ``rest'' argument is bound to the keyword list as it appears
|
|
|
510 in the call. For example:
|
|
|
511
|
|
|
512 @smallexample
|
|
|
513 (defun* find-thing (thing &rest rest &key need &allow-other-keys)
|
|
|
514 (or (apply 'member* thing thing-list :allow-other-keys t rest)
|
|
|
515 (if need (error "Thing not found"))))
|
|
|
516 @end smallexample
|
|
|
517
|
|
|
518 @noindent
|
|
|
519 This function takes a @code{:need} keyword argument, but also
|
|
|
520 accepts other keyword arguments which are passed on to the
|
|
|
521 @code{member*} function. @code{allow-other-keys} is used to
|
|
|
522 keep both @code{find-thing} and @code{member*} from complaining
|
|
|
523 about each others' keywords in the arguments.
|
|
|
524
|
|
|
525 In Common Lisp, keywords are recognized by the Lisp parser itself
|
|
|
526 and treated as special entities. In Emacs, keywords are just
|
|
|
527 symbols whose names begin with colons, which @code{defun*} has
|
|
|
528 arranged to set equal to themselves so that they will essentially
|
|
|
529 be self-quoting.
|
|
|
530
|
|
|
531 As a (significant) performance optimization, this package
|
|
|
532 implements the scan for keyword arguments by calling @code{memq}
|
|
|
533 to search for keywords in a ``rest'' argument. Technically
|
|
|
534 speaking, this is incorrect, since @code{memq} looks at the
|
|
|
535 odd-numbered values as well as the even-numbered keywords.
|
|
|
536 The net effect is that if you happen to pass a keyword symbol
|
|
|
537 as the @emph{value} of another keyword argument, where that
|
|
|
538 keyword symbol happens to equal the name of a valid keyword
|
|
|
539 argument of the same function, then the keyword parser will
|
|
|
540 become confused. This minor bug can only affect you if you
|
|
|
541 use keyword symbols as general-purpose data in your program;
|
|
|
542 this practice is strongly discouraged in Emacs Lisp.
|
|
|
543
|
|
|
544 The fifth section of the argument list consists of @dfn{auxiliary
|
|
|
545 variables}. These are not really arguments at all, but simply
|
|
|
546 variables which are bound to @code{nil} or to the specified
|
|
|
547 @var{initforms} during execution of the function. There is no
|
|
|
548 difference between the following two functions, except for a
|
|
|
549 matter of stylistic taste:
|
|
|
550
|
|
|
551 @example
|
|
|
552 (defun* foo (a b &aux (c (+ a b)) d)
|
|
|
553 @var{body})
|
|
|
554
|
|
|
555 (defun* foo (a b)
|
|
|
556 (let ((c (+ a b)) d)
|
|
|
557 @var{body}))
|
|
|
558 @end example
|
|
|
559
|
|
|
560 Argument lists support @dfn{destructuring}. In Common Lisp,
|
|
|
561 destructuring is only allowed with @code{defmacro}; this package
|
|
|
562 allows it with @code{defun*} and other argument lists as well.
|
|
|
563 In destructuring, any argument variable (@var{var} in the above
|
|
|
564 diagram) can be replaced by a list of variables, or more generally,
|
|
|
565 a recursive argument list. The corresponding argument value must
|
|
|
566 be a list whose elements match this recursive argument list.
|
|
|
567 For example:
|
|
|
568
|
|
|
569 @example
|
|
|
570 (defmacro* dolist ((var listform &optional resultform)
|
|
|
571 &rest body)
|
|
|
572 ...)
|
|
|
573 @end example
|
|
|
574
|
|
|
575 This says that the first argument of @code{dolist} must be a list
|
|
|
576 of two or three items; if there are other arguments as well as this
|
|
|
577 list, they are stored in @code{body}. All features allowed in
|
|
|
578 regular argument lists are allowed in these recursive argument lists.
|
|
|
579 In addition, the clause @samp{&whole @var{var}} is allowed at the
|
|
|
580 front of a recursive argument list. It binds @var{var} to the
|
|
|
581 whole list being matched; thus @code{(&whole all a b)} matches
|
|
|
582 a list of two things, with @code{a} bound to the first thing,
|
|
|
583 @code{b} bound to the second thing, and @code{all} bound to the
|
|
|
584 list itself. (Common Lisp allows @code{&whole} in top-level
|
|
|
585 @code{defmacro} argument lists as well, but Emacs Lisp does not
|
|
|
586 support this usage.)
|
|
|
587
|
|
|
588 One last feature of destructuring is that the argument list may be
|
|
|
589 dotted, so that the argument list @code{(a b . c)} is functionally
|
|
|
590 equivalent to @code{(a b &rest c)}.
|
|
|
591
|
|
|
592 If the optimization quality @code{safety} is set to 0
|
|
|
593 (@pxref{Declarations}), error checking for wrong number of
|
|
|
594 arguments and invalid keyword arguments is disabled. By default,
|
|
|
595 argument lists are rigorously checked.
|
|
|
596
|
|
|
597 @node Time of Evaluation, Function Aliases, Argument Lists, Program Structure
|
|
|
598 @section Time of Evaluation
|
|
|
599
|
|
|
600 @noindent
|
|
|
601 Normally, the byte-compiler does not actually execute the forms in
|
|
|
602 a file it compiles. For example, if a file contains @code{(setq foo t)},
|
|
|
603 the act of compiling it will not actually set @code{foo} to @code{t}.
|
|
|
604 This is true even if the @code{setq} was a top-level form (i.e., not
|
|
|
605 enclosed in a @code{defun} or other form). Sometimes, though, you
|
|
|
606 would like to have certain top-level forms evaluated at compile-time.
|
|
|
607 For example, the compiler effectively evaluates @code{defmacro} forms
|
|
|
608 at compile-time so that later parts of the file can refer to the
|
|
|
609 macros that are defined.
|
|
|
610
|
|
|
611 @defspec eval-when (situations...) forms...
|
|
|
612 This form controls when the body @var{forms} are evaluated.
|
|
|
613 The @var{situations} list may contain any set of the symbols
|
|
|
614 @code{compile}, @code{load}, and @code{eval} (or their long-winded
|
|
|
615 ANSI equivalents, @code{:compile-toplevel}, @code{:load-toplevel},
|
|
|
616 and @code{:execute}).
|
|
|
617
|
|
|
618 The @code{eval-when} form is handled differently depending on
|
|
|
619 whether or not it is being compiled as a top-level form.
|
|
|
620 Specifically, it gets special treatment if it is being compiled
|
|
|
621 by a command such as @code{byte-compile-file} which compiles files
|
|
|
622 or buffers of code, and it appears either literally at the
|
|
|
623 top level of the file or inside a top-level @code{progn}.
|
|
|
624
|
|
|
625 For compiled top-level @code{eval-when}s, the body @var{forms} are
|
|
|
626 executed at compile-time if @code{compile} is in the @var{situations}
|
|
|
627 list, and the @var{forms} are written out to the file (to be executed
|
|
|
628 at load-time) if @code{load} is in the @var{situations} list.
|
|
|
629
|
|
|
630 For non-compiled-top-level forms, only the @code{eval} situation is
|
|
|
631 relevant. (This includes forms executed by the interpreter, forms
|
|
|
632 compiled with @code{byte-compile} rather than @code{byte-compile-file},
|
|
|
633 and non-top-level forms.) The @code{eval-when} acts like a
|
|
|
634 @code{progn} if @code{eval} is specified, and like @code{nil}
|
|
|
635 (ignoring the body @var{forms}) if not.
|
|
|
636
|
|
|
637 The rules become more subtle when @code{eval-when}s are nested;
|
|
|
638 consult Steele (second edition) for the gruesome details (and
|
|
|
639 some gruesome examples).
|
|
|
640
|
|
|
641 Some simple examples:
|
|
|
642
|
|
|
643 @example
|
|
|
644 ;; Top-level forms in foo.el:
|
|
|
645 (eval-when (compile) (setq foo1 'bar))
|
|
|
646 (eval-when (load) (setq foo2 'bar))
|
|
|
647 (eval-when (compile load) (setq foo3 'bar))
|
|
|
648 (eval-when (eval) (setq foo4 'bar))
|
|
|
649 (eval-when (eval compile) (setq foo5 'bar))
|
|
|
650 (eval-when (eval load) (setq foo6 'bar))
|
|
|
651 (eval-when (eval compile load) (setq foo7 'bar))
|
|
|
652 @end example
|
|
|
653
|
|
|
654 When @file{foo.el} is compiled, these variables will be set during
|
|
|
655 the compilation itself:
|
|
|
656
|
|
|
657 @example
|
|
|
658 foo1 foo3 foo5 foo7 ; `compile'
|
|
|
659 @end example
|
|
|
660
|
|
|
661 When @file{foo.elc} is loaded, these variables will be set:
|
|
|
662
|
|
|
663 @example
|
|
|
664 foo2 foo3 foo6 foo7 ; `load'
|
|
|
665 @end example
|
|
|
666
|
|
|
667 And if @file{foo.el} is loaded uncompiled, these variables will
|
|
|
668 be set:
|
|
|
669
|
|
|
670 @example
|
|
|
671 foo4 foo5 foo6 foo7 ; `eval'
|
|
|
672 @end example
|
|
|
673
|
|
|
674 If these seven @code{eval-when}s had been, say, inside a @code{defun},
|
|
|
675 then the first three would have been equivalent to @code{nil} and the
|
|
|
676 last four would have been equivalent to the corresponding @code{setq}s.
|
|
|
677
|
|
|
678 Note that @code{(eval-when (load eval) @dots{})} is equivalent
|
|
|
679 to @code{(progn @dots{})} in all contexts. The compiler treats
|
|
|
680 certain top-level forms, like @code{defmacro} (sort-of) and
|
|
|
681 @code{require}, as if they were wrapped in @code{(eval-when
|
|
|
682 (compile load eval) @dots{})}.
|
|
|
683 @end defspec
|
|
|
684
|
|
|
685 Emacs 19 includes two special forms related to @code{eval-when}.
|
|
|
686 One of these, @code{eval-when-compile}, is not quite equivalent to
|
|
|
687 any @code{eval-when} construct and is described below. This package
|
|
|
688 defines a version of @code{eval-when-compile} for the benefit of
|
|
|
689 Emacs 18 users.
|
|
|
690
|
|
|
691 The other form, @code{(eval-and-compile @dots{})}, is exactly
|
|
|
692 equivalent to @samp{(eval-when (compile load eval) @dots{})} and
|
|
|
693 so is not itself defined by this package.
|
|
|
694
|
|
|
695 @defspec eval-when-compile forms...
|
|
|
696 The @var{forms} are evaluated at compile-time; at execution time,
|
|
|
697 this form acts like a quoted constant of the resulting value. Used
|
|
|
698 at top-level, @code{eval-when-compile} is just like @samp{eval-when
|
|
|
699 (compile eval)}. In other contexts, @code{eval-when-compile}
|
|
|
700 allows code to be evaluated once at compile-time for efficiency
|
|
|
701 or other reasons.
|
|
|
702
|
|
|
703 This form is similar to the @samp{#.} syntax of true Common Lisp.
|
|
|
704 @end defspec
|
|
|
705
|
|
|
706 @defspec load-time-value form
|
|
|
707 The @var{form} is evaluated at load-time; at execution time,
|
|
|
708 this form acts like a quoted constant of the resulting value.
|
|
|
709
|
|
|
710 Early Common Lisp had a @samp{#,} syntax that was similar to
|
|
|
711 this, but ANSI Common Lisp replaced it with @code{load-time-value}
|
|
|
712 and gave it more well-defined semantics.
|
|
|
713
|
|
|
714 In a compiled file, @code{load-time-value} arranges for @var{form}
|
|
|
715 to be evaluated when the @file{.elc} file is loaded and then used
|
|
|
716 as if it were a quoted constant. In code compiled by
|
|
|
717 @code{byte-compile} rather than @code{byte-compile-file}, the
|
|
|
718 effect is identical to @code{eval-when-compile}. In uncompiled
|
|
|
719 code, both @code{eval-when-compile} and @code{load-time-value}
|
|
|
720 act exactly like @code{progn}.
|
|
|
721
|
|
|
722 @example
|
|
|
723 (defun report ()
|
|
|
724 (insert "This function was executed on: "
|
|
|
725 (current-time-string)
|
|
|
726 ", compiled on: "
|
|
|
727 (eval-when-compile (current-time-string))
|
|
|
728 ;; or '#.(current-time-string) in real Common Lisp
|
|
|
729 ", and loaded on: "
|
|
|
730 (load-time-value (current-time-string))))
|
|
|
731 @end example
|
|
|
732
|
|
|
733 @noindent
|
|
|
734 Byte-compiled, the above defun will result in the following code
|
|
|
735 (or its compiled equivalent, of course) in the @file{.elc} file:
|
|
|
736
|
|
|
737 @example
|
|
|
738 (setq --temp-- (current-time-string))
|
|
|
739 (defun report ()
|
|
|
740 (insert "This function was executed on: "
|
|
|
741 (current-time-string)
|
|
|
742 ", compiled on: "
|
|
|
743 '"Wed Jun 23 18:33:43 1993"
|
|
|
744 ", and loaded on: "
|
|
|
745 --temp--))
|
|
|
746 @end example
|
|
|
747 @end defspec
|
|
|
748
|
|
|
749 @node Function Aliases, , Time of Evaluation, Program Structure
|
|
|
750 @section Function Aliases
|
|
|
751
|
|
|
752 @noindent
|
|
|
753 This section describes a feature from GNU Emacs 19 which this
|
|
|
754 package makes available in other versions of Emacs.
|
|
|
755
|
|
|
756 @defun defalias symbol function
|
|
|
757 This function sets @var{symbol}'s function cell to @var{function}.
|
|
|
758 It is equivalent to @code{fset}, except that in GNU Emacs 19 it also
|
|
|
759 records the setting in @code{load-history} so that it can be undone
|
|
|
760 by a later @code{unload-feature}.
|
|
|
761
|
|
|
762 In other versions of Emacs, @code{defalias} is a synonym for
|
|
|
763 @code{fset}.
|
|
|
764 @end defun
|
|
|
765
|
|
|
766 @node Predicates, Control Structure, Program Structure, Top
|
|
|
767 @chapter Predicates
|
|
|
768
|
|
|
769 @noindent
|
|
|
770 This section describes functions for testing whether various
|
|
|
771 facts are true or false.
|
|
|
772
|
|
|
773 @menu
|
|
|
774 * Type Predicates:: `typep', `deftype', and `coerce'
|
|
|
775 * Equality Predicates:: `eql' and `equalp'
|
|
|
776 @end menu
|
|
|
777
|
|
|
778 @node Type Predicates, Equality Predicates, Predicates, Predicates
|
|
|
779 @section Type Predicates
|
|
|
780
|
|
|
781 @noindent
|
|
|
782 The @dfn{CL} package defines a version of the Common Lisp @code{typep}
|
|
|
783 predicate.
|
|
|
784
|
|
|
785 @defun typep object type
|
|
|
786 Check if @var{object} is of type @var{type}, where @var{type} is a
|
|
|
787 (quoted) type name of the sort used by Common Lisp. For example,
|
|
|
788 @code{(typep foo 'integer)} is equivalent to @code{(integerp foo)}.
|
|
|
789 @end defun
|
|
|
790
|
|
|
791 The @var{type} argument to the above function is either a symbol
|
|
|
792 or a list beginning with a symbol.
|
|
|
793
|
|
|
794 @itemize @bullet
|
|
|
795 @item
|
|
|
796 If the type name is a symbol, Emacs appends @samp{-p} to the
|
|
|
797 symbol name to form the name of a predicate function for testing
|
|
|
798 the type. (Built-in predicates whose names end in @samp{p} rather
|
|
|
799 than @samp{-p} are used when appropriate.)
|
|
|
800
|
|
|
801 @item
|
|
|
802 The type symbol @code{t} stands for the union of all types.
|
|
|
803 @code{(typep @var{object} t)} is always true. Likewise, the
|
|
|
804 type symbol @code{nil} stands for nothing at all, and
|
|
|
805 @code{(typep @var{object} nil)} is always false.
|
|
|
806
|
|
|
807 @item
|
|
|
808 The type symbol @code{null} represents the symbol @code{nil}.
|
|
|
809 Thus @code{(typep @var{object} 'null)} is equivalent to
|
|
|
810 @code{(null @var{object})}.
|
|
|
811
|
|
|
812 @item
|
|
|
813 The type symbol @code{real} is a synonym for @code{number}, and
|
|
|
814 @code{fixnum} is a synonym for @code{integer}.
|
|
|
815
|
|
|
816 @item
|
|
|
817 The type symbols @code{character} and @code{string-char} match
|
|
183
|
818 characters. In Emacs-19 and XEmacs-19, characters are the same thing as
|
|
|
819 integers in the range 0-255. In XEmacs-20, where characters are a
|
|
|
820 first-class data type, this checks for actual characters, and
|
|
185
|
821 @code{(typep @var{8bit-integer} 'character)} will return @code{nil}.
|
|
0
|
822
|
|
|
823 @item
|
|
|
824 The type symbol @code{float} uses the @code{floatp-safe} predicate
|
|
|
825 defined by this package rather than @code{floatp}, so it will work
|
|
|
826 correctly even in Emacs versions without floating-point support.
|
|
|
827
|
|
|
828 @item
|
|
|
829 The type list @code{(integer @var{low} @var{high})} represents all
|
|
|
830 integers between @var{low} and @var{high}, inclusive. Either bound
|
|
|
831 may be a list of a single integer to specify an exclusive limit,
|
|
|
832 or a @code{*} to specify no limit. The type @code{(integer * *)}
|
|
|
833 is thus equivalent to @code{integer}.
|
|
|
834
|
|
|
835 @item
|
|
|
836 Likewise, lists beginning with @code{float}, @code{real}, or
|
|
|
837 @code{number} represent numbers of that type falling in a particular
|
|
|
838 range.
|
|
|
839
|
|
|
840 @item
|
|
|
841 Lists beginning with @code{and}, @code{or}, and @code{not} form
|
|
|
842 combinations of types. For example, @code{(or integer (float 0 *))}
|
|
|
843 represents all objects that are integers or non-negative floats.
|
|
|
844
|
|
|
845 @item
|
|
|
846 Lists beginning with @code{member} or @code{member*} represent
|
|
|
847 objects @code{eql} to any of the following values. For example,
|
|
|
848 @code{(member 1 2 3 4)} is equivalent to @code{(integer 1 4)},
|
|
|
849 and @code{(member nil)} is equivalent to @code{null}.
|
|
|
850
|
|
|
851 @item
|
|
|
852 Lists of the form @code{(satisfies @var{predicate})} represent
|
|
|
853 all objects for which @var{predicate} returns true when called
|
|
|
854 with that object as an argument.
|
|
|
855 @end itemize
|
|
|
856
|
|
|
857 The following function and macro (not technically predicates) are
|
|
|
858 related to @code{typep}.
|
|
|
859
|
|
|
860 @defun coerce object type
|
|
|
861 This function attempts to convert @var{object} to the specified
|
|
|
862 @var{type}. If @var{object} is already of that type as determined by
|
|
|
863 @code{typep}, it is simply returned. Otherwise, certain types of
|
|
|
864 conversions will be made: If @var{type} is any sequence type
|
|
|
865 (@code{string}, @code{list}, etc.) then @var{object} will be
|
|
|
866 converted to that type if possible. If @var{type} is
|
|
|
867 @code{character}, then strings of length one and symbols with
|
|
|
868 one-character names can be coerced. If @var{type} is @code{float},
|
|
|
869 then integers can be coerced in versions of Emacs that support
|
|
|
870 floats. In all other circumstances, @code{coerce} signals an
|
|
|
871 error.
|
|
|
872 @end defun
|
|
|
873
|
|
|
874 @defspec deftype name arglist forms...
|
|
|
875 This macro defines a new type called @var{name}. It is similar
|
|
|
876 to @code{defmacro} in many ways; when @var{name} is encountered
|
|
|
877 as a type name, the body @var{forms} are evaluated and should
|
|
|
878 return a type specifier that is equivalent to the type. The
|
|
|
879 @var{arglist} is a Common Lisp argument list of the sort accepted
|
|
|
880 by @code{defmacro*}. The type specifier @samp{(@var{name} @var{args}...)}
|
|
|
881 is expanded by calling the expander with those arguments; the type
|
|
|
882 symbol @samp{@var{name}} is expanded by calling the expander with
|
|
|
883 no arguments. The @var{arglist} is processed the same as for
|
|
|
884 @code{defmacro*} except that optional arguments without explicit
|
|
|
885 defaults use @code{*} instead of @code{nil} as the ``default''
|
|
|
886 default. Some examples:
|
|
|
887
|
|
|
888 @example
|
|
|
889 (deftype null () '(satisfies null)) ; predefined
|
|
|
890 (deftype list () '(or null cons)) ; predefined
|
|
|
891 (deftype unsigned-byte (&optional bits)
|
|
|
892 (list 'integer 0 (if (eq bits '*) bits (1- (lsh 1 bits)))))
|
|
|
893 (unsigned-byte 8) @equiv{} (integer 0 255)
|
|
|
894 (unsigned-byte) @equiv{} (integer 0 *)
|
|
|
895 unsigned-byte @equiv{} (integer 0 *)
|
|
|
896 @end example
|
|
|
897
|
|
|
898 @noindent
|
|
|
899 The last example shows how the Common Lisp @code{unsigned-byte}
|
|
|
900 type specifier could be implemented if desired; this package does
|
|
|
901 not implement @code{unsigned-byte} by default.
|
|
|
902 @end defspec
|
|
|
903
|
|
|
904 The @code{typecase} and @code{check-type} macros also use type
|
|
|
905 names. @xref{Conditionals}. @xref{Assertions}. The @code{map},
|
|
|
906 @code{concatenate}, and @code{merge} functions take type-name
|
|
|
907 arguments to specify the type of sequence to return. @xref{Sequences}.
|
|
|
908
|
|
|
909 @node Equality Predicates, , Type Predicates, Predicates
|
|
|
910 @section Equality Predicates
|
|
|
911
|
|
|
912 @noindent
|
|
|
913 This package defines two Common Lisp predicates, @code{eql} and
|
|
|
914 @code{equalp}.
|
|
|
915
|
|
|
916 @defun eql a b
|
|
|
917 This function is almost the same as @code{eq}, except that if @var{a}
|
|
|
918 and @var{b} are numbers of the same type, it compares them for numeric
|
|
|
919 equality (as if by @code{equal} instead of @code{eq}). This makes a
|
|
|
920 difference only for versions of Emacs that are compiled with
|
|
|
921 floating-point support, such as Emacs 19. Emacs floats are allocated
|
|
|
922 objects just like cons cells, which means that @code{(eq 3.0 3.0)}
|
|
|
923 will not necessarily be true---if the two @code{3.0}s were allocated
|
|
|
924 separately, the pointers will be different even though the numbers are
|
|
|
925 the same. But @code{(eql 3.0 3.0)} will always be true.
|
|
|
926
|
|
|
927 The types of the arguments must match, so @code{(eql 3 3.0)} is
|
|
|
928 still false.
|
|
|
929
|
|
|
930 Note that Emacs integers are ``direct'' rather than allocated, which
|
|
|
931 basically means @code{(eq 3 3)} will always be true. Thus @code{eq}
|
|
|
932 and @code{eql} behave differently only if floating-point numbers are
|
|
|
933 involved, and are indistinguishable on Emacs versions that don't
|
|
|
934 support floats.
|
|
|
935
|
|
|
936 There is a slight inconsistency with Common Lisp in the treatment of
|
|
|
937 positive and negative zeros. Some machines, notably those with IEEE
|
|
|
938 standard arithmetic, represent @code{+0} and @code{-0} as distinct
|
|
|
939 values. Normally this doesn't matter because the standard specifies
|
|
|
940 that @code{(= 0.0 -0.0)} should always be true, and this is indeed
|
|
|
941 what Emacs Lisp and Common Lisp do. But the Common Lisp standard
|
|
|
942 states that @code{(eql 0.0 -0.0)} and @code{(equal 0.0 -0.0)} should
|
|
|
943 be false on IEEE-like machines; Emacs Lisp does not do this, and in
|
|
|
944 fact the only known way to distinguish between the two zeros in Emacs
|
|
|
945 Lisp is to @code{format} them and check for a minus sign.
|
|
|
946 @end defun
|
|
|
947
|
|
|
948 @defun equalp a b
|
|
|
949 This function is a more flexible version of @code{equal}. In
|
|
|
950 particular, it compares strings case-insensitively, and it compares
|
|
|
951 numbers without regard to type (so that @code{(equalp 3 3.0)} is
|
|
|
952 true). Vectors and conses are compared recursively. All other
|
|
|
953 objects are compared as if by @code{equal}.
|
|
|
954
|
|
|
955 This function differs from Common Lisp @code{equalp} in several
|
|
|
956 respects. First, Common Lisp's @code{equalp} also compares
|
|
|
957 @emph{characters} case-insensitively, which would be impractical
|
|
|
958 in this package since Emacs does not distinguish between integers
|
|
|
959 and characters. In keeping with the idea that strings are less
|
|
|
960 vector-like in Emacs Lisp, this package's @code{equalp} also will
|
|
|
961 not compare strings against vectors of integers. Finally, Common
|
|
|
962 Lisp's @code{equalp} compares hash tables without regard to
|
|
|
963 ordering, whereas this package simply compares hash tables in
|
|
|
964 terms of their underlying structure (which means vectors for Lucid
|
|
|
965 Emacs 19 hash tables, or lists for other hash tables).
|
|
|
966 @end defun
|
|
|
967
|
|
|
968 Also note that the Common Lisp functions @code{member} and @code{assoc}
|
|
|
969 use @code{eql} to compare elements, whereas Emacs Lisp follows the
|
|
|
970 MacLisp tradition and uses @code{equal} for these two functions.
|
|
|
971 In Emacs, use @code{member*} and @code{assoc*} to get functions
|
|
|
972 which use @code{eql} for comparisons.
|
|
|
973
|
|
|
974 @node Control Structure, Macros, Predicates, Top
|
|
|
975 @chapter Control Structure
|
|
|
976
|
|
|
977 @noindent
|
|
|
978 The features described in the following sections implement
|
|
|
979 various advanced control structures, including the powerful
|
|
|
980 @code{setf} facility and a number of looping and conditional
|
|
|
981 constructs.
|
|
|
982
|
|
|
983 @menu
|
|
|
984 * Assignment:: The `psetq' form
|
|
|
985 * Generalized Variables:: `setf', `incf', `push', etc.
|
|
|
986 * Variable Bindings:: `progv', `lexical-let', `flet', `macrolet'
|
|
|
987 * Conditionals:: `when', `unless', `case', `typecase'
|
|
|
988 * Blocks and Exits:: `block', `return', `return-from'
|
|
|
989 * Iteration:: `do', `dotimes', `dolist', `do-symbols'
|
|
|
990 * Loop Facility:: The Common Lisp `loop' macro
|
|
|
991 * Multiple Values:: `values', `multiple-value-bind', etc.
|
|
|
992 @end menu
|
|
|
993
|
|
|
994 @node Assignment, Generalized Variables, Control Structure, Control Structure
|
|
|
995 @section Assignment
|
|
|
996
|
|
|
997 @noindent
|
|
|
998 The @code{psetq} form is just like @code{setq}, except that multiple
|
|
|
999 assignments are done in parallel rather than sequentially.
|
|
|
1000
|
|
|
1001 @defspec psetq [symbol form]@dots{}
|
|
|
1002 This special form (actually a macro) is used to assign to several
|
|
|
1003 variables simultaneously. Given only one @var{symbol} and @var{form},
|
|
|
1004 it has the same effect as @code{setq}. Given several @var{symbol}
|
|
|
1005 and @var{form} pairs, it evaluates all the @var{form}s in advance
|
|
|
1006 and then stores the corresponding variables afterwards.
|
|
|
1007
|
|
|
1008 @example
|
|
|
1009 (setq x 2 y 3)
|
|
|
1010 (setq x (+ x y) y (* x y))
|
|
|
1011 x
|
|
|
1012 @result{} 5
|
|
|
1013 y ; @r{@code{y} was computed after @code{x} was set.}
|
|
|
1014 @result{} 15
|
|
|
1015 (setq x 2 y 3)
|
|
|
1016 (psetq x (+ x y) y (* x y))
|
|
|
1017 x
|
|
|
1018 @result{} 5
|
|
|
1019 y ; @r{@code{y} was computed before @code{x} was set.}
|
|
|
1020 @result{} 6
|
|
|
1021 @end example
|
|
|
1022
|
|
|
1023 The simplest use of @code{psetq} is @code{(psetq x y y x)}, which
|
|
|
1024 exchanges the values of two variables. (The @code{rotatef} form
|
|
|
1025 provides an even more convenient way to swap two variables;
|
|
|
1026 @pxref{Modify Macros}.)
|
|
|
1027
|
|
|
1028 @code{psetq} always returns @code{nil}.
|
|
|
1029 @end defspec
|
|
|
1030
|
|
|
1031 @node Generalized Variables, Variable Bindings, Assignment, Control Structure
|
|
|
1032 @section Generalized Variables
|
|
|
1033
|
|
|
1034 @noindent
|
|
|
1035 A ``generalized variable'' or ``place form'' is one of the many places
|
|
|
1036 in Lisp memory where values can be stored. The simplest place form is
|
|
|
1037 a regular Lisp variable. But the cars and cdrs of lists, elements
|
|
|
1038 of arrays, properties of symbols, and many other locations are also
|
|
|
1039 places where Lisp values are stored.
|
|
|
1040
|
|
|
1041 The @code{setf} form is like @code{setq}, except that it accepts
|
|
|
1042 arbitrary place forms on the left side rather than just
|
|
|
1043 symbols. For example, @code{(setf (car a) b)} sets the car of
|
|
|
1044 @code{a} to @code{b}, doing the same operation as @code{(setcar a b)}
|
|
|
1045 but without having to remember two separate functions for setting
|
|
|
1046 and accessing every type of place.
|
|
|
1047
|
|
|
1048 Generalized variables are analogous to ``lvalues'' in the C
|
|
|
1049 language, where @samp{x = a[i]} gets an element from an array
|
|
|
1050 and @samp{a[i] = x} stores an element using the same notation.
|
|
|
1051 Just as certain forms like @code{a[i]} can be lvalues in C, there
|
|
|
1052 is a set of forms that can be generalized variables in Lisp.
|
|
|
1053
|
|
|
1054 @menu
|
|
|
1055 * Basic Setf:: `setf' and place forms
|
|
|
1056 * Modify Macros:: `incf', `push', `rotatef', `letf', `callf', etc.
|
|
|
1057 * Customizing Setf:: `define-modify-macro', `defsetf', `define-setf-method'
|
|
|
1058 @end menu
|
|
|
1059
|
|
|
1060 @node Basic Setf, Modify Macros, Generalized Variables, Generalized Variables
|
|
|
1061 @subsection Basic Setf
|
|
|
1062
|
|
|
1063 @noindent
|
|
|
1064 The @code{setf} macro is the most basic way to operate on generalized
|
|
|
1065 variables.
|
|
|
1066
|
|
|
1067 @defspec setf [place form]@dots{}
|
|
|
1068 This macro evaluates @var{form} and stores it in @var{place}, which
|
|
|
1069 must be a valid generalized variable form. If there are several
|
|
|
1070 @var{place} and @var{form} pairs, the assignments are done sequentially
|
|
|
1071 just as with @code{setq}. @code{setf} returns the value of the last
|
|
|
1072 @var{form}.
|
|
|
1073
|
|
|
1074 The following Lisp forms will work as generalized variables, and
|
|
|
1075 so may legally appear in the @var{place} argument of @code{setf}:
|
|
|
1076
|
|
|
1077 @itemize @bullet
|
|
|
1078 @item
|
|
|
1079 A symbol naming a variable. In other words, @code{(setf x y)} is
|
|
|
1080 exactly equivalent to @code{(setq x y)}, and @code{setq} itself is
|
|
|
1081 strictly speaking redundant now that @code{setf} exists. Many
|
|
|
1082 programmers continue to prefer @code{setq} for setting simple
|
|
|
1083 variables, though, purely for stylistic or historical reasons.
|
|
|
1084 The macro @code{(setf x y)} actually expands to @code{(setq x y)},
|
|
|
1085 so there is no performance penalty for using it in compiled code.
|
|
|
1086
|
|
|
1087 @item
|
|
|
1088 A call to any of the following Lisp functions:
|
|
|
1089
|
|
|
1090 @smallexample
|
|
|
1091 car cdr caar .. cddddr
|
|
|
1092 nth rest first .. tenth
|
|
|
1093 aref elt nthcdr
|
|
|
1094 symbol-function symbol-value symbol-plist
|
|
|
1095 get get* getf
|
|
|
1096 gethash subseq
|
|
|
1097 @end smallexample
|
|
|
1098
|
|
|
1099 @noindent
|
|
|
1100 Note that for @code{nthcdr} and @code{getf}, the list argument
|
|
|
1101 of the function must itself be a valid @var{place} form. For
|
|
|
1102 example, @code{(setf (nthcdr 0 foo) 7)} will set @code{foo} itself
|
|
|
1103 to 7. Note that @code{push} and @code{pop} on an @code{nthcdr}
|
|
|
1104 place can be used to insert or delete at any position in a list.
|
|
|
1105 The use of @code{nthcdr} as a @var{place} form is an extension
|
|
|
1106 to standard Common Lisp.
|
|
|
1107
|
|
|
1108 @item
|
|
|
1109 The following Emacs-specific functions are also @code{setf}-able.
|
|
|
1110 (Some of these are defined only in Emacs 19 or only in Lucid Emacs.)
|
|
|
1111
|
|
|
1112 @smallexample
|
|
|
1113 buffer-file-name marker-position
|
|
|
1114 buffer-modified-p match-data
|
|
|
1115 buffer-name mouse-position
|
|
|
1116 buffer-string overlay-end
|
|
|
1117 buffer-substring overlay-get
|
|
|
1118 current-buffer overlay-start
|
|
|
1119 current-case-table point
|
|
|
1120 current-column point-marker
|
|
|
1121 current-global-map point-max
|
|
|
1122 current-input-mode point-min
|
|
|
1123 current-local-map process-buffer
|
|
|
1124 current-window-configuration process-filter
|
|
|
1125 default-file-modes process-sentinel
|
|
|
1126 default-value read-mouse-position
|
|
|
1127 documentation-property screen-height
|
|
|
1128 extent-data screen-menubar
|
|
|
1129 extent-end-position screen-width
|
|
|
1130 extent-start-position selected-window
|
|
|
1131 face-background selected-screen
|
|
|
1132 face-background-pixmap selected-frame
|
|
|
1133 face-font standard-case-table
|
|
|
1134 face-foreground syntax-table
|
|
|
1135 face-underline-p window-buffer
|
|
|
1136 file-modes window-dedicated-p
|
|
|
1137 frame-height window-display-table
|
|
|
1138 frame-parameters window-height
|
|
|
1139 frame-visible-p window-hscroll
|
|
|
1140 frame-width window-point
|
|
|
1141 get-register window-start
|
|
|
1142 getenv window-width
|
|
|
1143 global-key-binding x-get-cut-buffer
|
|
|
1144 keymap-parent x-get-cutbuffer
|
|
|
1145 local-key-binding x-get-secondary-selection
|
|
|
1146 mark x-get-selection
|
|
|
1147 mark-marker
|
|
|
1148 @end smallexample
|
|
|
1149
|
|
|
1150 Most of these have directly corresponding ``set'' functions, like
|
|
|
1151 @code{use-local-map} for @code{current-local-map}, or @code{goto-char}
|
|
|
1152 for @code{point}. A few, like @code{point-min}, expand to longer
|
|
|
1153 sequences of code when they are @code{setf}'d (@code{(narrow-to-region
|
|
|
1154 x (point-max))} in this case).
|
|
|
1155
|
|
|
1156 @item
|
|
|
1157 A call of the form @code{(substring @var{subplace} @var{n} [@var{m}])},
|
|
|
1158 where @var{subplace} is itself a legal generalized variable whose
|
|
|
1159 current value is a string, and where the value stored is also a
|
|
|
1160 string. The new string is spliced into the specified part of the
|
|
|
1161 destination string. For example:
|
|
|
1162
|
|
|
1163 @example
|
|
|
1164 (setq a (list "hello" "world"))
|
|
|
1165 @result{} ("hello" "world")
|
|
|
1166 (cadr a)
|
|
|
1167 @result{} "world"
|
|
|
1168 (substring (cadr a) 2 4)
|
|
|
1169 @result{} "rl"
|
|
|
1170 (setf (substring (cadr a) 2 4) "o")
|
|
|
1171 @result{} "o"
|
|
|
1172 (cadr a)
|
|
|
1173 @result{} "wood"
|
|
|
1174 a
|
|
|
1175 @result{} ("hello" "wood")
|
|
|
1176 @end example
|
|
|
1177
|
|
|
1178 The generalized variable @code{buffer-substring}, listed above,
|
|
|
1179 also works in this way by replacing a portion of the current buffer.
|
|
|
1180
|
|
|
1181 @item
|
|
|
1182 A call of the form @code{(apply '@var{func} @dots{})} or
|
|
|
1183 @code{(apply (function @var{func}) @dots{})}, where @var{func}
|
|
|
1184 is a @code{setf}-able function whose store function is ``suitable''
|
|
|
1185 in the sense described in Steele's book; since none of the standard
|
|
|
1186 Emacs place functions are suitable in this sense, this feature is
|
|
|
1187 only interesting when used with places you define yourself with
|
|
|
1188 @code{define-setf-method} or the long form of @code{defsetf}.
|
|
|
1189
|
|
|
1190 @item
|
|
|
1191 A macro call, in which case the macro is expanded and @code{setf}
|
|
|
1192 is applied to the resulting form.
|
|
|
1193
|
|
|
1194 @item
|
|
|
1195 Any form for which a @code{defsetf} or @code{define-setf-method}
|
|
|
1196 has been made.
|
|
|
1197 @end itemize
|
|
|
1198
|
|
|
1199 Using any forms other than these in the @var{place} argument to
|
|
|
1200 @code{setf} will signal an error.
|
|
|
1201
|
|
|
1202 The @code{setf} macro takes care to evaluate all subforms in
|
|
|
1203 the proper left-to-right order; for example,
|
|
|
1204
|
|
|
1205 @example
|
|
|
1206 (setf (aref vec (incf i)) i)
|
|
|
1207 @end example
|
|
|
1208
|
|
|
1209 @noindent
|
|
|
1210 looks like it will evaluate @code{(incf i)} exactly once, before the
|
|
|
1211 following access to @code{i}; the @code{setf} expander will insert
|
|
|
1212 temporary variables as necessary to ensure that it does in fact work
|
|
|
1213 this way no matter what setf-method is defined for @code{aref}.
|
|
|
1214 (In this case, @code{aset} would be used and no such steps would
|
|
|
1215 be necessary since @code{aset} takes its arguments in a convenient
|
|
|
1216 order.)
|
|
|
1217
|
|
|
1218 However, if the @var{place} form is a macro which explicitly
|
|
|
1219 evaluates its arguments in an unusual order, this unusual order
|
|
|
1220 will be preserved. Adapting an example from Steele, given
|
|
|
1221
|
|
|
1222 @example
|
|
|
1223 (defmacro wrong-order (x y) (list 'aref y x))
|
|
|
1224 @end example
|
|
|
1225
|
|
|
1226 @noindent
|
|
|
1227 the form @code{(setf (wrong-order @var{a} @var{b}) 17)} will
|
|
|
1228 evaluate @var{b} first, then @var{a}, just as in an actual call
|
|
|
1229 to @code{wrong-order}.
|
|
|
1230 @end defspec
|
|
|
1231
|
|
|
1232 @node Modify Macros, Customizing Setf, Basic Setf, Generalized Variables
|
|
|
1233 @subsection Modify Macros
|
|
|
1234
|
|
|
1235 @noindent
|
|
|
1236 This package defines a number of other macros besides @code{setf}
|
|
|
1237 that operate on generalized variables. Many are interesting and
|
|
|
1238 useful even when the @var{place} is just a variable name.
|
|
|
1239
|
|
|
1240 @defspec psetf [place form]@dots{}
|
|
|
1241 This macro is to @code{setf} what @code{psetq} is to @code{setq}:
|
|
|
1242 When several @var{place}s and @var{form}s are involved, the
|
|
|
1243 assignments take place in parallel rather than sequentially.
|
|
|
1244 Specifically, all subforms are evaluated from left to right, then
|
|
|
1245 all the assignments are done (in an undefined order).
|
|
|
1246 @end defspec
|
|
|
1247
|
|
|
1248 @defspec incf place &optional x
|
|
|
1249 This macro increments the number stored in @var{place} by one, or
|
|
|
1250 by @var{x} if specified. The incremented value is returned. For
|
|
|
1251 example, @code{(incf i)} is equivalent to @code{(setq i (1+ i))}, and
|
|
|
1252 @code{(incf (car x) 2)} is equivalent to @code{(setcar x (+ (car x) 2))}.
|
|
|
1253
|
|
|
1254 Once again, care is taken to preserve the ``apparent'' order of
|
|
|
1255 evaluation. For example,
|
|
|
1256
|
|
|
1257 @example
|
|
|
1258 (incf (aref vec (incf i)))
|
|
|
1259 @end example
|
|
|
1260
|
|
|
1261 @noindent
|
|
|
1262 appears to increment @code{i} once, then increment the element of
|
|
|
1263 @code{vec} addressed by @code{i}; this is indeed exactly what it
|
|
|
1264 does, which means the above form is @emph{not} equivalent to the
|
|
|
1265 ``obvious'' expansion,
|
|
|
1266
|
|
|
1267 @example
|
|
|
1268 (setf (aref vec (incf i)) (1+ (aref vec (incf i)))) ; Wrong!
|
|
|
1269 @end example
|
|
|
1270
|
|
|
1271 @noindent
|
|
|
1272 but rather to something more like
|
|
|
1273
|
|
|
1274 @example
|
|
|
1275 (let ((temp (incf i)))
|
|
|
1276 (setf (aref vec temp) (1+ (aref vec temp))))
|
|
|
1277 @end example
|
|
|
1278
|
|
|
1279 @noindent
|
|
|
1280 Again, all of this is taken care of automatically by @code{incf} and
|
|
|
1281 the other generalized-variable macros.
|
|
|
1282
|
|
|
1283 As a more Emacs-specific example of @code{incf}, the expression
|
|
|
1284 @code{(incf (point) @var{n})} is essentially equivalent to
|
|
|
1285 @code{(forward-char @var{n})}.
|
|
|
1286 @end defspec
|
|
|
1287
|
|
|
1288 @defspec decf place &optional x
|
|
|
1289 This macro decrements the number stored in @var{place} by one, or
|
|
|
1290 by @var{x} if specified.
|
|
|
1291 @end defspec
|
|
|
1292
|
|
|
1293 @defspec pop place
|
|
|
1294 This macro removes and returns the first element of the list stored
|
|
|
1295 in @var{place}. It is analogous to @code{(prog1 (car @var{place})
|
|
|
1296 (setf @var{place} (cdr @var{place})))}, except that it takes care
|
|
|
1297 to evaluate all subforms only once.
|
|
|
1298 @end defspec
|
|
|
1299
|
|
|
1300 @defspec push x place
|
|
|
1301 This macro inserts @var{x} at the front of the list stored in
|
|
|
1302 @var{place}. It is analogous to @code{(setf @var{place} (cons
|
|
|
1303 @var{x} @var{place}))}, except for evaluation of the subforms.
|
|
|
1304 @end defspec
|
|
|
1305
|
|
|
1306 @defspec pushnew x place @t{&key :test :test-not :key}
|
|
|
1307 This macro inserts @var{x} at the front of the list stored in
|
|
|
1308 @var{place}, but only if @var{x} was not @code{eql} to any
|
|
|
1309 existing element of the list. The optional keyword arguments
|
|
|
1310 are interpreted in the same way as for @code{adjoin}.
|
|
|
1311 @xref{Lists as Sets}.
|
|
|
1312 @end defspec
|
|
|
1313
|
|
|
1314 @defspec shiftf place@dots{} newvalue
|
|
|
1315 This macro shifts the @var{place}s left by one, shifting in the
|
|
|
1316 value of @var{newvalue} (which may be any Lisp expression, not just
|
|
|
1317 a generalized variable), and returning the value shifted out of
|
|
|
1318 the first @var{place}. Thus, @code{(shiftf @var{a} @var{b} @var{c}
|
|
|
1319 @var{d})} is equivalent to
|
|
|
1320
|
|
|
1321 @example
|
|
|
1322 (prog1
|
|
|
1323 @var{a}
|
|
|
1324 (psetf @var{a} @var{b}
|
|
|
1325 @var{b} @var{c}
|
|
|
1326 @var{c} @var{d}))
|
|
|
1327 @end example
|
|
|
1328
|
|
|
1329 @noindent
|
|
|
1330 except that the subforms of @var{a}, @var{b}, and @var{c} are actually
|
|
|
1331 evaluated only once each and in the apparent order.
|
|
|
1332 @end defspec
|
|
|
1333
|
|
|
1334 @defspec rotatef place@dots{}
|
|
|
1335 This macro rotates the @var{place}s left by one in circular fashion.
|
|
|
1336 Thus, @code{(rotatef @var{a} @var{b} @var{c} @var{d})} is equivalent to
|
|
|
1337
|
|
|
1338 @example
|
|
|
1339 (psetf @var{a} @var{b}
|
|
|
1340 @var{b} @var{c}
|
|
|
1341 @var{c} @var{d}
|
|
|
1342 @var{d} @var{a})
|
|
|
1343 @end example
|
|
|
1344
|
|
|
1345 @noindent
|
|
|
1346 except for the evaluation of subforms. @code{rotatef} always
|
|
|
1347 returns @code{nil}. Note that @code{(rotatef @var{a} @var{b})}
|
|
|
1348 conveniently exchanges @var{a} and @var{b}.
|
|
|
1349 @end defspec
|
|
|
1350
|
|
|
1351 The following macros were invented for this package; they have no
|
|
|
1352 analogues in Common Lisp.
|
|
|
1353
|
|
|
1354 @defspec letf (bindings@dots{}) forms@dots{}
|
|
|
1355 This macro is analogous to @code{let}, but for generalized variables
|
|
|
1356 rather than just symbols. Each @var{binding} should be of the form
|
|
|
1357 @code{(@var{place} @var{value})}; the original contents of the
|
|
|
1358 @var{place}s are saved, the @var{value}s are stored in them, and
|
|
|
1359 then the body @var{form}s are executed. Afterwards, the @var{places}
|
|
|
1360 are set back to their original saved contents. This cleanup happens
|
|
|
1361 even if the @var{form}s exit irregularly due to a @code{throw} or an
|
|
|
1362 error.
|
|
|
1363
|
|
|
1364 For example,
|
|
|
1365
|
|
|
1366 @example
|
|
|
1367 (letf (((point) (point-min))
|
|
|
1368 (a 17))
|
|
|
1369 ...)
|
|
|
1370 @end example
|
|
|
1371
|
|
|
1372 @noindent
|
|
|
1373 moves ``point'' in the current buffer to the beginning of the buffer,
|
|
|
1374 and also binds @code{a} to 17 (as if by a normal @code{let}, since
|
|
|
1375 @code{a} is just a regular variable). After the body exits, @code{a}
|
|
|
1376 is set back to its original value and point is moved back to its
|
|
|
1377 original position.
|
|
|
1378
|
|
|
1379 Note that @code{letf} on @code{(point)} is not quite like a
|
|
|
1380 @code{save-excursion}, as the latter effectively saves a marker
|
|
|
1381 which tracks insertions and deletions in the buffer. Actually,
|
|
|
1382 a @code{letf} of @code{(point-marker)} is much closer to this
|
|
|
1383 behavior. (@code{point} and @code{point-marker} are equivalent
|
|
|
1384 as @code{setf} places; each will accept either an integer or a
|
|
|
1385 marker as the stored value.)
|
|
|
1386
|
|
|
1387 Since generalized variables look like lists, @code{let}'s shorthand
|
|
|
1388 of using @samp{foo} for @samp{(foo nil)} as a @var{binding} would
|
|
|
1389 be ambiguous in @code{letf} and is not allowed.
|
|
|
1390
|
|
|
1391 However, a @var{binding} specifier may be a one-element list
|
|
|
1392 @samp{(@var{place})}, which is similar to @samp{(@var{place}
|
|
|
1393 @var{place})}. In other words, the @var{place} is not disturbed
|
|
|
1394 on entry to the body, and the only effect of the @code{letf} is
|
|
|
1395 to restore the original value of @var{place} afterwards. (The
|
|
|
1396 redundant access-and-store suggested by the @code{(@var{place}
|
|
|
1397 @var{place})} example does not actually occur.)
|
|
|
1398
|
|
|
1399 In most cases, the @var{place} must have a well-defined value on
|
|
|
1400 entry to the @code{letf} form. The only exceptions are plain
|
|
|
1401 variables and calls to @code{symbol-value} and @code{symbol-function}.
|
|
|
1402 If the symbol is not bound on entry, it is simply made unbound by
|
|
|
1403 @code{makunbound} or @code{fmakunbound} on exit.
|
|
|
1404 @end defspec
|
|
|
1405
|
|
|
1406 @defspec letf* (bindings@dots{}) forms@dots{}
|
|
|
1407 This macro is to @code{letf} what @code{let*} is to @code{let}:
|
|
|
1408 It does the bindings in sequential rather than parallel order.
|
|
|
1409 @end defspec
|
|
|
1410
|
|
|
1411 @defspec callf @var{function} @var{place} @var{args}@dots{}
|
|
|
1412 This is the ``generic'' modify macro. It calls @var{function},
|
|
|
1413 which should be an unquoted function name, macro name, or lambda.
|
|
|
1414 It passes @var{place} and @var{args} as arguments, and assigns the
|
|
|
1415 result back to @var{place}. For example, @code{(incf @var{place}
|
|
|
1416 @var{n})} is the same as @code{(callf + @var{place} @var{n})}.
|
|
|
1417 Some more examples:
|
|
|
1418
|
|
|
1419 @example
|
|
|
1420 (callf abs my-number)
|
|
|
1421 (callf concat (buffer-name) "<" (int-to-string n) ">")
|
|
|
1422 (callf union happy-people (list joe bob) :test 'same-person)
|
|
|
1423 @end example
|
|
|
1424
|
|
|
1425 @xref{Customizing Setf}, for @code{define-modify-macro}, a way
|
|
|
1426 to create even more concise notations for modify macros. Note
|
|
|
1427 again that @code{callf} is an extension to standard Common Lisp.
|
|
|
1428 @end defspec
|
|
|
1429
|
|
|
1430 @defspec callf2 @var{function} @var{arg1} @var{place} @var{args}@dots{}
|
|
|
1431 This macro is like @code{callf}, except that @var{place} is
|
|
|
1432 the @emph{second} argument of @var{function} rather than the
|
|
|
1433 first. For example, @code{(push @var{x} @var{place})} is
|
|
|
1434 equivalent to @code{(callf2 cons @var{x} @var{place})}.
|
|
|
1435 @end defspec
|
|
|
1436
|
|
|
1437 The @code{callf} and @code{callf2} macros serve as building
|
|
|
1438 blocks for other macros like @code{incf}, @code{pushnew}, and
|
|
|
1439 @code{define-modify-macro}. The @code{letf} and @code{letf*}
|
|
|
1440 macros are used in the processing of symbol macros;
|
|
|
1441 @pxref{Macro Bindings}.
|
|
|
1442
|
|
|
1443 @node Customizing Setf, , Modify Macros, Generalized Variables
|
|
|
1444 @subsection Customizing Setf
|
|
|
1445
|
|
|
1446 @noindent
|
|
|
1447 Common Lisp defines three macros, @code{define-modify-macro},
|
|
|
1448 @code{defsetf}, and @code{define-setf-method}, that allow the
|
|
|
1449 user to extend generalized variables in various ways.
|
|
|
1450
|
|
|
1451 @defspec define-modify-macro name arglist function [doc-string]
|
|
|
1452 This macro defines a ``read-modify-write'' macro similar to
|
|
|
1453 @code{incf} and @code{decf}. The macro @var{name} is defined
|
|
|
1454 to take a @var{place} argument followed by additional arguments
|
|
|
1455 described by @var{arglist}. The call
|
|
|
1456
|
|
|
1457 @example
|
|
|
1458 (@var{name} @var{place} @var{args}...)
|
|
|
1459 @end example
|
|
|
1460
|
|
|
1461 @noindent
|
|
|
1462 will be expanded to
|
|
|
1463
|
|
|
1464 @example
|
|
|
1465 (callf @var{func} @var{place} @var{args}...)
|
|
|
1466 @end example
|
|
|
1467
|
|
|
1468 @noindent
|
|
|
1469 which in turn is roughly equivalent to
|
|
|
1470
|
|
|
1471 @example
|
|
|
1472 (setf @var{place} (@var{func} @var{place} @var{args}...))
|
|
|
1473 @end example
|
|
|
1474
|
|
|
1475 For example:
|
|
|
1476
|
|
|
1477 @example
|
|
|
1478 (define-modify-macro incf (&optional (n 1)) +)
|
|
|
1479 (define-modify-macro concatf (&rest args) concat)
|
|
|
1480 @end example
|
|
|
1481
|
|
|
1482 Note that @code{&key} is not allowed in @var{arglist}, but
|
|
|
1483 @code{&rest} is sufficient to pass keywords on to the function.
|
|
|
1484
|
|
|
1485 Most of the modify macros defined by Common Lisp do not exactly
|
|
|
1486 follow the pattern of @code{define-modify-macro}. For example,
|
|
|
1487 @code{push} takes its arguments in the wrong order, and @code{pop}
|
|
|
1488 is completely irregular. You can define these macros ``by hand''
|
|
|
1489 using @code{get-setf-method}, or consult the source file
|
|
|
1490 @file{cl-macs.el} to see how to use the internal @code{setf}
|
|
|
1491 building blocks.
|
|
|
1492 @end defspec
|
|
|
1493
|
|
|
1494 @defspec defsetf access-fn update-fn
|
|
|
1495 This is the simpler of two @code{defsetf} forms. Where
|
|
|
1496 @var{access-fn} is the name of a function which accesses a place,
|
|
|
1497 this declares @var{update-fn} to be the corresponding store
|
|
|
1498 function. From now on,
|
|
|
1499
|
|
|
1500 @example
|
|
|
1501 (setf (@var{access-fn} @var{arg1} @var{arg2} @var{arg3}) @var{value})
|
|
|
1502 @end example
|
|
|
1503
|
|
|
1504 @noindent
|
|
|
1505 will be expanded to
|
|
|
1506
|
|
|
1507 @example
|
|
|
1508 (@var{update-fn} @var{arg1} @var{arg2} @var{arg3} @var{value})
|
|
|
1509 @end example
|
|
|
1510
|
|
|
1511 @noindent
|
|
|
1512 The @var{update-fn} is required to be either a true function, or
|
|
|
1513 a macro which evaluates its arguments in a function-like way. Also,
|
|
|
1514 the @var{update-fn} is expected to return @var{value} as its result.
|
|
|
1515 Otherwise, the above expansion would not obey the rules for the way
|
|
|
1516 @code{setf} is supposed to behave.
|
|
|
1517
|
|
|
1518 As a special (non-Common-Lisp) extension, a third argument of @code{t}
|
|
|
1519 to @code{defsetf} says that the @code{update-fn}'s return value is
|
|
|
1520 not suitable, so that the above @code{setf} should be expanded to
|
|
|
1521 something more like
|
|
|
1522
|
|
|
1523 @example
|
|
|
1524 (let ((temp @var{value}))
|
|
|
1525 (@var{update-fn} @var{arg1} @var{arg2} @var{arg3} temp)
|
|
|
1526 temp)
|
|
|
1527 @end example
|
|
|
1528
|
|
|
1529 Some examples of the use of @code{defsetf}, drawn from the standard
|
|
|
1530 suite of setf methods, are:
|
|
|
1531
|
|
|
1532 @example
|
|
|
1533 (defsetf car setcar)
|
|
|
1534 (defsetf symbol-value set)
|
|
|
1535 (defsetf buffer-name rename-buffer t)
|
|
|
1536 @end example
|
|
|
1537 @end defspec
|
|
|
1538
|
|
|
1539 @defspec defsetf access-fn arglist (store-var) forms@dots{}
|
|
|
1540 This is the second, more complex, form of @code{defsetf}. It is
|
|
|
1541 rather like @code{defmacro} except for the additional @var{store-var}
|
|
|
1542 argument. The @var{forms} should return a Lisp form which stores
|
|
|
1543 the value of @var{store-var} into the generalized variable formed
|
|
|
1544 by a call to @var{access-fn} with arguments described by @var{arglist}.
|
|
|
1545 The @var{forms} may begin with a string which documents the @code{setf}
|
|
|
1546 method (analogous to the doc string that appears at the front of a
|
|
|
1547 function).
|
|
|
1548
|
|
|
1549 For example, the simple form of @code{defsetf} is shorthand for
|
|
|
1550
|
|
|
1551 @example
|
|
|
1552 (defsetf @var{access-fn} (&rest args) (store)
|
|
|
1553 (append '(@var{update-fn}) args (list store)))
|
|
|
1554 @end example
|
|
|
1555
|
|
|
1556 The Lisp form that is returned can access the arguments from
|
|
|
1557 @var{arglist} and @var{store-var} in an unrestricted fashion;
|
|
|
1558 macros like @code{setf} and @code{incf} which invoke this
|
|
|
1559 setf-method will insert temporary variables as needed to make
|
|
|
1560 sure the apparent order of evaluation is preserved.
|
|
|
1561
|
|
|
1562 Another example drawn from the standard package:
|
|
|
1563
|
|
|
1564 @example
|
|
|
1565 (defsetf nth (n x) (store)
|
|
|
1566 (list 'setcar (list 'nthcdr n x) store))
|
|
|
1567 @end example
|
|
|
1568 @end defspec
|
|
|
1569
|
|
|
1570 @defspec define-setf-method access-fn arglist forms@dots{}
|
|
|
1571 This is the most general way to create new place forms. When
|
|
|
1572 a @code{setf} to @var{access-fn} with arguments described by
|
|
|
1573 @var{arglist} is expanded, the @var{forms} are evaluated and
|
|
|
1574 must return a list of five items:
|
|
|
1575
|
|
|
1576 @enumerate
|
|
|
1577 @item
|
|
|
1578 A list of @dfn{temporary variables}.
|
|
|
1579
|
|
|
1580 @item
|
|
|
1581 A list of @dfn{value forms} corresponding to the temporary variables
|
|
|
1582 above. The temporary variables will be bound to these value forms
|
|
|
1583 as the first step of any operation on the generalized variable.
|
|
|
1584
|
|
|
1585 @item
|
|
|
1586 A list of exactly one @dfn{store variable} (generally obtained
|
|
|
1587 from a call to @code{gensym}).
|
|
|
1588
|
|
|
1589 @item
|
|
|
1590 A Lisp form which stores the contents of the store variable into
|
|
|
1591 the generalized variable, assuming the temporaries have been
|
|
|
1592 bound as described above.
|
|
|
1593
|
|
|
1594 @item
|
|
|
1595 A Lisp form which accesses the contents of the generalized variable,
|
|
|
1596 assuming the temporaries have been bound.
|
|
|
1597 @end enumerate
|
|
|
1598
|
|
|
1599 This is exactly like the Common Lisp macro of the same name,
|
|
|
1600 except that the method returns a list of five values rather
|
|
|
1601 than the five values themselves, since Emacs Lisp does not
|
|
|
1602 support Common Lisp's notion of multiple return values.
|
|
|
1603
|
|
|
1604 Once again, the @var{forms} may begin with a documentation string.
|
|
|
1605
|
|
|
1606 A setf-method should be maximally conservative with regard to
|
|
|
1607 temporary variables. In the setf-methods generated by
|
|
|
1608 @code{defsetf}, the second return value is simply the list of
|
|
|
1609 arguments in the place form, and the first return value is a
|
|
|
1610 list of a corresponding number of temporary variables generated
|
|
|
1611 by @code{gensym}. Macros like @code{setf} and @code{incf} which
|
|
|
1612 use this setf-method will optimize away most temporaries that
|
|
|
1613 turn out to be unnecessary, so there is little reason for the
|
|
|
1614 setf-method itself to optimize.
|
|
|
1615 @end defspec
|
|
|
1616
|
|
|
1617 @defun get-setf-method place &optional env
|
|
|
1618 This function returns the setf-method for @var{place}, by
|
|
|
1619 invoking the definition previously recorded by @code{defsetf}
|
|
|
1620 or @code{define-setf-method}. The result is a list of five
|
|
|
1621 values as described above. You can use this function to build
|
|
|
1622 your own @code{incf}-like modify macros. (Actually, it is
|
|
|
1623 better to use the internal functions @code{cl-setf-do-modify}
|
|
|
1624 and @code{cl-setf-do-store}, which are a bit easier to use and
|
|
|
1625 which also do a number of optimizations; consult the source
|
|
|
1626 code for the @code{incf} function for a simple example.)
|
|
|
1627
|
|
|
1628 The argument @var{env} specifies the ``environment'' to be
|
|
|
1629 passed on to @code{macroexpand} if @code{get-setf-method} should
|
|
|
1630 need to expand a macro in @var{place}. It should come from
|
|
|
1631 an @code{&environment} argument to the macro or setf-method
|
|
|
1632 that called @code{get-setf-method}.
|
|
|
1633
|
|
|
1634 See also the source code for the setf-methods for @code{apply}
|
|
|
1635 and @code{substring}, each of which works by calling
|
|
|
1636 @code{get-setf-method} on a simpler case, then massaging
|
|
|
1637 the result in various ways.
|
|
|
1638 @end defun
|
|
|
1639
|
|
|
1640 Modern Common Lisp defines a second, independent way to specify
|
|
|
1641 the @code{setf} behavior of a function, namely ``@code{setf}
|
|
|
1642 functions'' whose names are lists @code{(setf @var{name})}
|
|
|
1643 rather than symbols. For example, @code{(defun (setf foo) @dots{})}
|
|
|
1644 defines the function that is used when @code{setf} is applied to
|
|
|
1645 @code{foo}. This package does not currently support @code{setf}
|
|
|
1646 functions. In particular, it is a compile-time error to use
|
|
|
1647 @code{setf} on a form which has not already been @code{defsetf}'d
|
|
|
1648 or otherwise declared; in newer Common Lisps, this would not be
|
|
|
1649 an error since the function @code{(setf @var{func})} might be
|
|
|
1650 defined later.
|
|
|
1651
|
|
|
1652 @iftex
|
|
|
1653 @secno=4
|
|
|
1654 @end iftex
|
|
|
1655
|
|
|
1656 @node Variable Bindings, Conditionals, Generalized Variables, Control Structure
|
|
|
1657 @section Variable Bindings
|
|
|
1658
|
|
|
1659 @noindent
|
|
|
1660 These Lisp forms make bindings to variables and function names,
|
|
|
1661 analogous to Lisp's built-in @code{let} form.
|
|
|
1662
|
|
|
1663 @xref{Modify Macros}, for the @code{letf} and @code{letf*} forms which
|
|
|
1664 are also related to variable bindings.
|
|
|
1665
|
|
|
1666 @menu
|
|
|
1667 * Dynamic Bindings:: The `progv' form
|
|
|
1668 * Lexical Bindings:: `lexical-let' and lexical closures
|
|
|
1669 * Function Bindings:: `flet' and `labels'
|
|
|
1670 * Macro Bindings:: `macrolet' and `symbol-macrolet'
|
|
|
1671 @end menu
|
|
|
1672
|
|
|
1673 @node Dynamic Bindings, Lexical Bindings, Variable Bindings, Variable Bindings
|
|
|
1674 @subsection Dynamic Bindings
|
|
|
1675
|
|
|
1676 @noindent
|
|
|
1677 The standard @code{let} form binds variables whose names are known
|
|
|
1678 at compile-time. The @code{progv} form provides an easy way to
|
|
|
1679 bind variables whose names are computed at run-time.
|
|
|
1680
|
|
|
1681 @defspec progv symbols values forms@dots{}
|
|
|
1682 This form establishes @code{let}-style variable bindings on a
|
|
|
1683 set of variables computed at run-time. The expressions
|
|
|
1684 @var{symbols} and @var{values} are evaluated, and must return lists
|
|
|
1685 of symbols and values, respectively. The symbols are bound to the
|
|
|
1686 corresponding values for the duration of the body @var{form}s.
|
|
|
1687 If @var{values} is shorter than @var{symbols}, the last few symbols
|
|
|
1688 are made unbound (as if by @code{makunbound}) inside the body.
|
|
|
1689 If @var{symbols} is shorter than @var{values}, the excess values
|
|
|
1690 are ignored.
|
|
|
1691 @end defspec
|
|
|
1692
|
|
|
1693 @node Lexical Bindings, Function Bindings, Dynamic Bindings, Variable Bindings
|
|
|
1694 @subsection Lexical Bindings
|
|
|
1695
|
|
|
1696 @noindent
|
|
|
1697 The @dfn{CL} package defines the following macro which
|
|
|
1698 more closely follows the Common Lisp @code{let} form:
|
|
|
1699
|
|
|
1700 @defspec lexical-let (bindings@dots{}) forms@dots{}
|
|
|
1701 This form is exactly like @code{let} except that the bindings it
|
|
|
1702 establishes are purely lexical. Lexical bindings are similar to
|
|
|
1703 local variables in a language like C: Only the code physically
|
|
|
1704 within the body of the @code{lexical-let} (after macro expansion)
|
|
|
1705 may refer to the bound variables.
|
|
|
1706
|
|
|
1707 @example
|
|
|
1708 (setq a 5)
|
|
|
1709 (defun foo (b) (+ a b))
|
|
|
1710 (let ((a 2)) (foo a))
|
|
|
1711 @result{} 4
|
|
|
1712 (lexical-let ((a 2)) (foo a))
|
|
|
1713 @result{} 7
|
|
|
1714 @end example
|
|
|
1715
|
|
|
1716 @noindent
|
|
|
1717 In this example, a regular @code{let} binding of @code{a} actually
|
|
|
1718 makes a temporary change to the global variable @code{a}, so @code{foo}
|
|
|
1719 is able to see the binding of @code{a} to 2. But @code{lexical-let}
|
|
|
1720 actually creates a distinct local variable @code{a} for use within its
|
|
|
1721 body, without any effect on the global variable of the same name.
|
|
|
1722
|
|
|
1723 The most important use of lexical bindings is to create @dfn{closures}.
|
|
|
1724 A closure is a function object that refers to an outside lexical
|
|
|
1725 variable. For example:
|
|
|
1726
|
|
|
1727 @example
|
|
|
1728 (defun make-adder (n)
|
|
|
1729 (lexical-let ((n n))
|
|
|
1730 (function (lambda (m) (+ n m)))))
|
|
|
1731 (setq add17 (make-adder 17))
|
|
|
1732 (funcall add17 4)
|
|
|
1733 @result{} 21
|
|
|
1734 @end example
|
|
|
1735
|
|
|
1736 @noindent
|
|
|
1737 The call @code{(make-adder 17)} returns a function object which adds
|
|
|
1738 17 to its argument. If @code{let} had been used instead of
|
|
|
1739 @code{lexical-let}, the function object would have referred to the
|
|
|
1740 global @code{n}, which would have been bound to 17 only during the
|
|
|
1741 call to @code{make-adder} itself.
|
|
|
1742
|
|
|
1743 @example
|
|
|
1744 (defun make-counter ()
|
|
|
1745 (lexical-let ((n 0))
|
|
|
1746 (function* (lambda (&optional (m 1)) (incf n m)))))
|
|
|
1747 (setq count-1 (make-counter))
|
|
|
1748 (funcall count-1 3)
|
|
|
1749 @result{} 3
|
|
|
1750 (funcall count-1 14)
|
|
|
1751 @result{} 17
|
|
|
1752 (setq count-2 (make-counter))
|
|
|
1753 (funcall count-2 5)
|
|
|
1754 @result{} 5
|
|
|
1755 (funcall count-1 2)
|
|
|
1756 @result{} 19
|
|
|
1757 (funcall count-2)
|
|
|
1758 @result{} 6
|
|
|
1759 @end example
|
|
|
1760
|
|
|
1761 @noindent
|
|
|
1762 Here we see that each call to @code{make-counter} creates a distinct
|
|
|
1763 local variable @code{n}, which serves as a private counter for the
|
|
|
1764 function object that is returned.
|
|
|
1765
|
|
|
1766 Closed-over lexical variables persist until the last reference to
|
|
|
1767 them goes away, just like all other Lisp objects. For example,
|
|
|
1768 @code{count-2} refers to a function object which refers to an
|
|
|
1769 instance of the variable @code{n}; this is the only reference
|
|
|
1770 to that variable, so after @code{(setq count-2 nil)} the garbage
|
|
|
1771 collector would be able to delete this instance of @code{n}.
|
|
|
1772 Of course, if a @code{lexical-let} does not actually create any
|
|
|
1773 closures, then the lexical variables are free as soon as the
|
|
|
1774 @code{lexical-let} returns.
|
|
|
1775
|
|
|
1776 Many closures are used only during the extent of the bindings they
|
|
|
1777 refer to; these are known as ``downward funargs'' in Lisp parlance.
|
|
|
1778 When a closure is used in this way, regular Emacs Lisp dynamic
|
|
|
1779 bindings suffice and will be more efficient than @code{lexical-let}
|
|
|
1780 closures:
|
|
|
1781
|
|
|
1782 @example
|
|
|
1783 (defun add-to-list (x list)
|
|
|
1784 (mapcar (function (lambda (y) (+ x y))) list))
|
|
|
1785 (add-to-list 7 '(1 2 5))
|
|
|
1786 @result{} (8 9 12)
|
|
|
1787 @end example
|
|
|
1788
|
|
|
1789 @noindent
|
|
|
1790 Since this lambda is only used while @code{x} is still bound,
|
|
|
1791 it is not necessary to make a true closure out of it.
|
|
|
1792
|
|
|
1793 You can use @code{defun} or @code{flet} inside a @code{lexical-let}
|
|
|
1794 to create a named closure. If several closures are created in the
|
|
|
1795 body of a single @code{lexical-let}, they all close over the same
|
|
|
1796 instance of the lexical variable.
|
|
|
1797
|
|
|
1798 The @code{lexical-let} form is an extension to Common Lisp. In
|
|
|
1799 true Common Lisp, all bindings are lexical unless declared otherwise.
|
|
|
1800 @end defspec
|
|
|
1801
|
|
|
1802 @defspec lexical-let* (bindings@dots{}) forms@dots{}
|
|
|
1803 This form is just like @code{lexical-let}, except that the bindings
|
|
|
1804 are made sequentially in the manner of @code{let*}.
|
|
|
1805 @end defspec
|
|
|
1806
|
|
|
1807 @node Function Bindings, Macro Bindings, Lexical Bindings, Variable Bindings
|
|
|
1808 @subsection Function Bindings
|
|
|
1809
|
|
|
1810 @noindent
|
|
|
1811 These forms make @code{let}-like bindings to functions instead
|
|
|
1812 of variables.
|
|
|
1813
|
|
|
1814 @defspec flet (bindings@dots{}) forms@dots{}
|
|
|
1815 This form establishes @code{let}-style bindings on the function
|
|
|
1816 cells of symbols rather than on the value cells. Each @var{binding}
|
|
|
1817 must be a list of the form @samp{(@var{name} @var{arglist}
|
|
|
1818 @var{forms}@dots{})}, which defines a function exactly as if
|
|
|
1819 it were a @code{defun*} form. The function @var{name} is defined
|
|
|
1820 accordingly for the duration of the body of the @code{flet}; then
|
|
|
1821 the old function definition, or lack thereof, is restored.
|
|
|
1822
|
|
|
1823 While @code{flet} in Common Lisp establishes a lexical binding of
|
|
|
1824 @var{name}, Emacs Lisp @code{flet} makes a dynamic binding. The
|
|
|
1825 result is that @code{flet} affects indirect calls to a function as
|
|
|
1826 well as calls directly inside the @code{flet} form itself.
|
|
|
1827
|
|
|
1828 You can use @code{flet} to disable or modify the behavior of a
|
|
|
1829 function in a temporary fashion. This will even work on Emacs
|
|
|
1830 primitives, although note that some calls to primitive functions
|
|
|
1831 internal to Emacs are made without going through the symbol's
|
|
|
1832 function cell, and so will not be affected by @code{flet}. For
|
|
|
1833 example,
|
|
|
1834
|
|
|
1835 @example
|
|
|
1836 (flet ((message (&rest args) (push args saved-msgs)))
|
|
|
1837 (do-something))
|
|
|
1838 @end example
|
|
|
1839
|
|
|
1840 This code attempts to replace the built-in function @code{message}
|
|
|
1841 with a function that simply saves the messages in a list rather
|
|
|
1842 than displaying them. The original definition of @code{message}
|
|
|
1843 will be restored after @code{do-something} exits. This code will
|
|
|
1844 work fine on messages generated by other Lisp code, but messages
|
|
|
1845 generated directly inside Emacs will not be caught since they make
|
|
|
1846 direct C-language calls to the message routines rather than going
|
|
|
1847 through the Lisp @code{message} function.
|
|
|
1848
|
|
|
1849 Functions defined by @code{flet} may use the full Common Lisp
|
|
|
1850 argument notation supported by @code{defun*}; also, the function
|
|
|
1851 body is enclosed in an implicit block as if by @code{defun*}.
|
|
|
1852 @xref{Program Structure}.
|
|
|
1853 @end defspec
|
|
|
1854
|
|
|
1855 @defspec labels (bindings@dots{}) forms@dots{}
|
|
|
1856 The @code{labels} form is a synonym for @code{flet}. (In Common
|
|
|
1857 Lisp, @code{labels} and @code{flet} differ in ways that depend on
|
|
|
1858 their lexical scoping; these distinctions vanish in dynamically
|
|
|
1859 scoped Emacs Lisp.)
|
|
|
1860 @end defspec
|
|
|
1861
|
|
|
1862 @node Macro Bindings, , Function Bindings, Variable Bindings
|
|
|
1863 @subsection Macro Bindings
|
|
|
1864
|
|
|
1865 @noindent
|
|
|
1866 These forms create local macros and ``symbol macros.''
|
|
|
1867
|
|
|
1868 @defspec macrolet (bindings@dots{}) forms@dots{}
|
|
|
1869 This form is analogous to @code{flet}, but for macros instead of
|
|
|
1870 functions. Each @var{binding} is a list of the same form as the
|
|
|
1871 arguments to @code{defmacro*} (i.e., a macro name, argument list,
|
|
|
1872 and macro-expander forms). The macro is defined accordingly for
|
|
|
1873 use within the body of the @code{macrolet}.
|
|
|
1874
|
|
|
1875 Because of the nature of macros, @code{macrolet} is lexically
|
|
|
1876 scoped even in Emacs Lisp: The @code{macrolet} binding will
|
|
|
1877 affect only calls that appear physically within the body
|
|
|
1878 @var{forms}, possibly after expansion of other macros in the
|
|
|
1879 body.
|
|
|
1880 @end defspec
|
|
|
1881
|
|
|
1882 @defspec symbol-macrolet (bindings@dots{}) forms@dots{}
|
|
|
1883 This form creates @dfn{symbol macros}, which are macros that look
|
|
|
1884 like variable references rather than function calls. Each
|
|
|
1885 @var{binding} is a list @samp{(@var{var} @var{expansion})};
|
|
|
1886 any reference to @var{var} within the body @var{forms} is
|
|
|
1887 replaced by @var{expansion}.
|
|
|
1888
|
|
|
1889 @example
|
|
|
1890 (setq bar '(5 . 9))
|
|
|
1891 (symbol-macrolet ((foo (car bar)))
|
|
|
1892 (incf foo))
|
|
|
1893 bar
|
|
|
1894 @result{} (6 . 9)
|
|
|
1895 @end example
|
|
|
1896
|
|
|
1897 A @code{setq} of a symbol macro is treated the same as a @code{setf}.
|
|
|
1898 I.e., @code{(setq foo 4)} in the above would be equivalent to
|
|
|
1899 @code{(setf foo 4)}, which in turn expands to @code{(setf (car bar) 4)}.
|
|
|
1900
|
|
|
1901 Likewise, a @code{let} or @code{let*} binding a symbol macro is
|
|
|
1902 treated like a @code{letf} or @code{letf*}. This differs from true
|
|
|
1903 Common Lisp, where the rules of lexical scoping cause a @code{let}
|
|
|
1904 binding to shadow a @code{symbol-macrolet} binding. In this package,
|
|
|
1905 only @code{lexical-let} and @code{lexical-let*} will shadow a symbol
|
|
|
1906 macro.
|
|
|
1907
|
|
|
1908 There is no analogue of @code{defmacro} for symbol macros; all symbol
|
|
|
1909 macros are local. A typical use of @code{symbol-macrolet} is in the
|
|
|
1910 expansion of another macro:
|
|
|
1911
|
|
|
1912 @example
|
|
|
1913 (defmacro* my-dolist ((x list) &rest body)
|
|
|
1914 (let ((var (gensym)))
|
|
|
1915 (list 'loop 'for var 'on list 'do
|
|
|
1916 (list* 'symbol-macrolet (list (list x (list 'car var)))
|
|
|
1917 body))))
|
|
|
1918
|
|
|
1919 (setq mylist '(1 2 3 4))
|
|
|
1920 (my-dolist (x mylist) (incf x))
|
|
|
1921 mylist
|
|
|
1922 @result{} (2 3 4 5)
|
|
|
1923 @end example
|
|
|
1924
|
|
|
1925 @noindent
|
|
|
1926 In this example, the @code{my-dolist} macro is similar to @code{dolist}
|
|
|
1927 (@pxref{Iteration}) except that the variable @code{x} becomes a true
|
|
|
1928 reference onto the elements of the list. The @code{my-dolist} call
|
|
|
1929 shown here expands to
|
|
|
1930
|
|
|
1931 @example
|
|
|
1932 (loop for G1234 on mylist do
|
|
|
1933 (symbol-macrolet ((x (car G1234)))
|
|
|
1934 (incf x)))
|
|
|
1935 @end example
|
|
|
1936
|
|
|
1937 @noindent
|
|
|
1938 which in turn expands to
|
|
|
1939
|
|
|
1940 @example
|
|
|
1941 (loop for G1234 on mylist do (incf (car G1234)))
|
|
|
1942 @end example
|
|
|
1943
|
|
|
1944 @xref{Loop Facility}, for a description of the @code{loop} macro.
|
|
|
1945 This package defines a nonstandard @code{in-ref} loop clause that
|
|
|
1946 works much like @code{my-dolist}.
|
|
|
1947 @end defspec
|
|
|
1948
|
|
|
1949 @node Conditionals, Blocks and Exits, Variable Bindings, Control Structure
|
|
|
1950 @section Conditionals
|
|
|
1951
|
|
|
1952 @noindent
|
|
|
1953 These conditional forms augment Emacs Lisp's simple @code{if},
|
|
|
1954 @code{and}, @code{or}, and @code{cond} forms.
|
|
|
1955
|
|
|
1956 @defspec when test forms@dots{}
|
|
|
1957 This is a variant of @code{if} where there are no ``else'' forms,
|
|
|
1958 and possibly several ``then'' forms. In particular,
|
|
|
1959
|
|
|
1960 @example
|
|
|
1961 (when @var{test} @var{a} @var{b} @var{c})
|
|
|
1962 @end example
|
|
|
1963
|
|
|
1964 @noindent
|
|
|
1965 is entirely equivalent to
|
|
|
1966
|
|
|
1967 @example
|
|
|
1968 (if @var{test} (progn @var{a} @var{b} @var{c}) nil)
|
|
|
1969 @end example
|
|
|
1970 @end defspec
|
|
|
1971
|
|
|
1972 @defspec unless test forms@dots{}
|
|
|
1973 This is a variant of @code{if} where there are no ``then'' forms,
|
|
|
1974 and possibly several ``else'' forms:
|
|
|
1975
|
|
|
1976 @example
|
|
|
1977 (unless @var{test} @var{a} @var{b} @var{c})
|
|
|
1978 @end example
|
|
|
1979
|
|
|
1980 @noindent
|
|
|
1981 is entirely equivalent to
|
|
|
1982
|
|
|
1983 @example
|
|
|
1984 (when (not @var{test}) @var{a} @var{b} @var{c})
|
|
|
1985 @end example
|
|
|
1986 @end defspec
|
|
|
1987
|
|
|
1988 @defspec case keyform clause@dots{}
|
|
|
1989 This macro evaluates @var{keyform}, then compares it with the key
|
|
|
1990 values listed in the various @var{clause}s. Whichever clause matches
|
|
|
1991 the key is executed; comparison is done by @code{eql}. If no clause
|
|
|
1992 matches, the @code{case} form returns @code{nil}. The clauses are
|
|
|
1993 of the form
|
|
|
1994
|
|
|
1995 @example
|
|
|
1996 (@var{keylist} @var{body-forms}@dots{})
|
|
|
1997 @end example
|
|
|
1998
|
|
|
1999 @noindent
|
|
|
2000 where @var{keylist} is a list of key values. If there is exactly
|
|
|
2001 one value, and it is not a cons cell or the symbol @code{nil} or
|
|
|
2002 @code{t}, then it can be used by itself as a @var{keylist} without
|
|
|
2003 being enclosed in a list. All key values in the @code{case} form
|
|
|
2004 must be distinct. The final clauses may use @code{t} in place of
|
|
|
2005 a @var{keylist} to indicate a default clause that should be taken
|
|
|
2006 if none of the other clauses match. (The symbol @code{otherwise}
|
|
|
2007 is also recognized in place of @code{t}. To make a clause that
|
|
|
2008 matches the actual symbol @code{t}, @code{nil}, or @code{otherwise},
|
|
|
2009 enclose the symbol in a list.)
|
|
|
2010
|
|
|
2011 For example, this expression reads a keystroke, then does one of
|
|
|
2012 four things depending on whether it is an @samp{a}, a @samp{b},
|
|
|
2013 a @key{RET} or @key{LFD}, or anything else.
|
|
|
2014
|
|
|
2015 @example
|
|
|
2016 (case (read-char)
|
|
|
2017 (?a (do-a-thing))
|
|
|
2018 (?b (do-b-thing))
|
|
|
2019 ((?\r ?\n) (do-ret-thing))
|
|
|
2020 (t (do-other-thing)))
|
|
|
2021 @end example
|
|
|
2022 @end defspec
|
|
|
2023
|
|
|
2024 @defspec ecase keyform clause@dots{}
|
|
|
2025 This macro is just like @code{case}, except that if the key does
|
|
|
2026 not match any of the clauses, an error is signalled rather than
|
|
|
2027 simply returning @code{nil}.
|
|
|
2028 @end defspec
|
|
|
2029
|
|
|
2030 @defspec typecase keyform clause@dots{}
|
|
|
2031 This macro is a version of @code{case} that checks for types
|
|
|
2032 rather than values. Each @var{clause} is of the form
|
|
|
2033 @samp{(@var{type} @var{body}...)}. @xref{Type Predicates},
|
|
|
2034 for a description of type specifiers. For example,
|
|
|
2035
|
|
|
2036 @example
|
|
|
2037 (typecase x
|
|
|
2038 (integer (munch-integer x))
|
|
|
2039 (float (munch-float x))
|
|
|
2040 (string (munch-integer (string-to-int x)))
|
|
|
2041 (t (munch-anything x)))
|
|
|
2042 @end example
|
|
|
2043
|
|
|
2044 The type specifier @code{t} matches any type of object; the word
|
|
|
2045 @code{otherwise} is also allowed. To make one clause match any of
|
|
|
2046 several types, use an @code{(or ...)} type specifier.
|
|
|
2047 @end defspec
|
|
|
2048
|
|
|
2049 @defspec etypecase keyform clause@dots{}
|
|
|
2050 This macro is just like @code{typecase}, except that if the key does
|
|
|
2051 not match any of the clauses, an error is signalled rather than
|
|
|
2052 simply returning @code{nil}.
|
|
|
2053 @end defspec
|
|
|
2054
|
|
|
2055 @node Blocks and Exits, Iteration, Conditionals, Control Structure
|
|
|
2056 @section Blocks and Exits
|
|
|
2057
|
|
|
2058 @noindent
|
|
|
2059 Common Lisp @dfn{blocks} provide a non-local exit mechanism very
|
|
|
2060 similar to @code{catch} and @code{throw}, but lexically rather than
|
|
|
2061 dynamically scoped. This package actually implements @code{block}
|
|
|
2062 in terms of @code{catch}; however, the lexical scoping allows the
|
|
|
2063 optimizing byte-compiler to omit the costly @code{catch} step if the
|
|
|
2064 body of the block does not actually @code{return-from} the block.
|
|
|
2065
|
|
|
2066 @defspec block name forms@dots{}
|
|
|
2067 The @var{forms} are evaluated as if by a @code{progn}. However,
|
|
|
2068 if any of the @var{forms} execute @code{(return-from @var{name})},
|
|
|
2069 they will jump out and return directly from the @code{block} form.
|
|
|
2070 The @code{block} returns the result of the last @var{form} unless
|
|
|
2071 a @code{return-from} occurs.
|
|
|
2072
|
|
|
2073 The @code{block}/@code{return-from} mechanism is quite similar to
|
|
|
2074 the @code{catch}/@code{throw} mechanism. The main differences are
|
|
|
2075 that block @var{name}s are unevaluated symbols, rather than forms
|
|
|
2076 (such as quoted symbols) which evaluate to a tag at run-time; and
|
|
|
2077 also that blocks are lexically scoped whereas @code{catch}/@code{throw}
|
|
|
2078 are dynamically scoped. This means that functions called from the
|
|
|
2079 body of a @code{catch} can also @code{throw} to the @code{catch},
|
|
|
2080 but the @code{return-from} referring to a block name must appear
|
|
|
2081 physically within the @var{forms} that make up the body of the block.
|
|
|
2082 They may not appear within other called functions, although they may
|
|
|
2083 appear within macro expansions or @code{lambda}s in the body. Block
|
|
|
2084 names and @code{catch} names form independent name-spaces.
|
|
|
2085
|
|
|
2086 In true Common Lisp, @code{defun} and @code{defmacro} surround
|
|
|
2087 the function or expander bodies with implicit blocks with the
|
|
|
2088 same name as the function or macro. This does not occur in Emacs
|
|
|
2089 Lisp, but this package provides @code{defun*} and @code{defmacro*}
|
|
|
2090 forms which do create the implicit block.
|
|
|
2091
|
|
|
2092 The Common Lisp looping constructs defined by this package,
|
|
|
2093 such as @code{loop} and @code{dolist}, also create implicit blocks
|
|
|
2094 just as in Common Lisp.
|
|
|
2095
|
|
|
2096 Because they are implemented in terms of Emacs Lisp @code{catch}
|
|
|
2097 and @code{throw}, blocks have the same overhead as actual
|
|
|
2098 @code{catch} constructs (roughly two function calls). However,
|
|
|
2099 Zawinski and Furuseth's optimizing byte compiler (standard in
|
|
|
2100 Emacs 19) will optimize away the @code{catch} if the block does
|
|
|
2101 not in fact contain any @code{return} or @code{return-from} calls
|
|
|
2102 that jump to it. This means that @code{do} loops and @code{defun*}
|
|
|
2103 functions which don't use @code{return} don't pay the overhead to
|
|
|
2104 support it.
|
|
|
2105 @end defspec
|
|
|
2106
|
|
|
2107 @defspec return-from name [result]
|
|
|
2108 This macro returns from the block named @var{name}, which must be
|
|
|
2109 an (unevaluated) symbol. If a @var{result} form is specified, it
|
|
|
2110 is evaluated to produce the result returned from the @code{block}.
|
|
|
2111 Otherwise, @code{nil} is returned.
|
|
|
2112 @end defspec
|
|
|
2113
|
|
|
2114 @defspec return [result]
|
|
|
2115 This macro is exactly like @code{(return-from nil @var{result})}.
|
|
|
2116 Common Lisp loops like @code{do} and @code{dolist} implicitly enclose
|
|
|
2117 themselves in @code{nil} blocks.
|
|
|
2118 @end defspec
|
|
|
2119
|
|
|
2120 @node Iteration, Loop Facility, Blocks and Exits, Control Structure
|
|
|
2121 @section Iteration
|
|
|
2122
|
|
|
2123 @noindent
|
|
|
2124 The macros described here provide more sophisticated, high-level
|
|
|
2125 looping constructs to complement Emacs Lisp's basic @code{while}
|
|
|
2126 loop.
|
|
|
2127
|
|
|
2128 @defspec loop forms@dots{}
|
|
|
2129 The @dfn{CL} package supports both the simple, old-style meaning of
|
|
|
2130 @code{loop} and the extremely powerful and flexible feature known as
|
|
|
2131 the @dfn{Loop Facility} or @dfn{Loop Macro}. This more advanced
|
|
|
2132 facility is discussed in the following section; @pxref{Loop Facility}.
|
|
|
2133 The simple form of @code{loop} is described here.
|
|
|
2134
|
|
|
2135 If @code{loop} is followed by zero or more Lisp expressions,
|
|
|
2136 then @code{(loop @var{exprs}@dots{})} simply creates an infinite
|
|
|
2137 loop executing the expressions over and over. The loop is
|
|
|
2138 enclosed in an implicit @code{nil} block. Thus,
|
|
|
2139
|
|
|
2140 @example
|
|
|
2141 (loop (foo) (if (no-more) (return 72)) (bar))
|
|
|
2142 @end example
|
|
|
2143
|
|
|
2144 @noindent
|
|
|
2145 is exactly equivalent to
|
|
|
2146
|
|
|
2147 @example
|
|
|
2148 (block nil (while t (foo) (if (no-more) (return 72)) (bar)))
|
|
|
2149 @end example
|
|
|
2150
|
|
|
2151 If any of the expressions are plain symbols, the loop is instead
|
|
|
2152 interpreted as a Loop Macro specification as described later.
|
|
|
2153 (This is not a restriction in practice, since a plain symbol
|
|
|
2154 in the above notation would simply access and throw away the
|
|
|
2155 value of a variable.)
|
|
|
2156 @end defspec
|
|
|
2157
|
|
|
2158 @defspec do (spec@dots{}) (end-test [result@dots{}]) forms@dots{}
|
|
|
2159 This macro creates a general iterative loop. Each @var{spec} is
|
|
|
2160 of the form
|
|
|
2161
|
|
|
2162 @example
|
|
|
2163 (@var{var} [@var{init} [@var{step}]])
|
|
|
2164 @end example
|
|
|
2165
|
|
|
2166 The loop works as follows: First, each @var{var} is bound to the
|
|
|
2167 associated @var{init} value as if by a @code{let} form. Then, in
|
|
|
2168 each iteration of the loop, the @var{end-test} is evaluated; if
|
|
|
2169 true, the loop is finished. Otherwise, the body @var{forms} are
|
|
|
2170 evaluated, then each @var{var} is set to the associated @var{step}
|
|
|
2171 expression (as if by a @code{psetq} form) and the next iteration
|
|
|
2172 begins. Once the @var{end-test} becomes true, the @var{result}
|
|
|
2173 forms are evaluated (with the @var{var}s still bound to their
|
|
|
2174 values) to produce the result returned by @code{do}.
|
|
|
2175
|
|
|
2176 The entire @code{do} loop is enclosed in an implicit @code{nil}
|
|
|
2177 block, so that you can use @code{(return)} to break out of the
|
|
|
2178 loop at any time.
|
|
|
2179
|
|
|
2180 If there are no @var{result} forms, the loop returns @code{nil}.
|
|
|
2181 If a given @var{var} has no @var{step} form, it is bound to its
|
|
|
2182 @var{init} value but not otherwise modified during the @code{do}
|
|
|
2183 loop (unless the code explicitly modifies it); this case is just
|
|
|
2184 a shorthand for putting a @code{(let ((@var{var} @var{init})) @dots{})}
|
|
|
2185 around the loop. If @var{init} is also omitted it defaults to
|
|
|
2186 @code{nil}, and in this case a plain @samp{@var{var}} can be used
|
|
|
2187 in place of @samp{(@var{var})}, again following the analogy with
|
|
|
2188 @code{let}.
|
|
|
2189
|
|
|
2190 This example (from Steele) illustrates a loop which applies the
|
|
|
2191 function @code{f} to successive pairs of values from the lists
|
|
|
2192 @code{foo} and @code{bar}; it is equivalent to the call
|
|
|
2193 @code{(mapcar* 'f foo bar)}. Note that this loop has no body
|
|
|
2194 @var{forms} at all, performing all its work as side effects of
|
|
|
2195 the rest of the loop.
|
|
|
2196
|
|
|
2197 @example
|
|
|
2198 (do ((x foo (cdr x))
|
|
|
2199 (y bar (cdr y))
|
|
|
2200 (z nil (cons (f (car x) (car y)) z)))
|
|
|
2201 ((or (null x) (null y))
|
|
|
2202 (nreverse z)))
|
|
|
2203 @end example
|
|
|
2204 @end defspec
|
|
|
2205
|
|
|
2206 @defspec do* (spec@dots{}) (end-test [result@dots{}]) forms@dots{}
|
|
|
2207 This is to @code{do} what @code{let*} is to @code{let}. In
|
|
|
2208 particular, the initial values are bound as if by @code{let*}
|
|
|
2209 rather than @code{let}, and the steps are assigned as if by
|
|
|
2210 @code{setq} rather than @code{psetq}.
|
|
|
2211
|
|
|
2212 Here is another way to write the above loop:
|
|
|
2213
|
|
|
2214 @example
|
|
|
2215 (do* ((xp foo (cdr xp))
|
|
|
2216 (yp bar (cdr yp))
|
|
|
2217 (x (car xp) (car xp))
|
|
|
2218 (y (car yp) (car yp))
|
|
|
2219 z)
|
|
|
2220 ((or (null xp) (null yp))
|
|
|
2221 (nreverse z))
|
|
|
2222 (push (f x y) z))
|
|
|
2223 @end example
|
|
|
2224 @end defspec
|
|
|
2225
|
|
|
2226 @defspec dolist (var list [result]) forms@dots{}
|
|
|
2227 This is a more specialized loop which iterates across the elements
|
|
|
2228 of a list. @var{list} should evaluate to a list; the body @var{forms}
|
|
|
2229 are executed with @var{var} bound to each element of the list in
|
|
|
2230 turn. Finally, the @var{result} form (or @code{nil}) is evaluated
|
|
|
2231 with @var{var} bound to @code{nil} to produce the result returned by
|
|
|
2232 the loop. The loop is surrounded by an implicit @code{nil} block.
|
|
|
2233 @end defspec
|
|
|
2234
|
|
|
2235 @defspec dotimes (var count [result]) forms@dots{}
|
|
|
2236 This is a more specialized loop which iterates a specified number
|
|
|
2237 of times. The body is executed with @var{var} bound to the integers
|
|
|
2238 from zero (inclusive) to @var{count} (exclusive), in turn. Then
|
|
|
2239 the @code{result} form is evaluated with @var{var} bound to the total
|
|
|
2240 number of iterations that were done (i.e., @code{(max 0 @var{count})})
|
|
|
2241 to get the return value for the loop form. The loop is surrounded
|
|
|
2242 by an implicit @code{nil} block.
|
|
|
2243 @end defspec
|
|
|
2244
|
|
|
2245 @defspec do-symbols (var [obarray [result]]) forms@dots{}
|
|
|
2246 This loop iterates over all interned symbols. If @var{obarray}
|
|
|
2247 is specified and is not @code{nil}, it loops over all symbols in
|
|
|
2248 that obarray. For each symbol, the body @var{forms} are evaluated
|
|
|
2249 with @var{var} bound to that symbol. The symbols are visited in
|
|
|
2250 an unspecified order. Afterward the @var{result} form, if any,
|
|
|
2251 is evaluated (with @var{var} bound to @code{nil}) to get the return
|
|
|
2252 value. The loop is surrounded by an implicit @code{nil} block.
|
|
|
2253 @end defspec
|
|
|
2254
|
|
|
2255 @defspec do-all-symbols (var [result]) forms@dots{}
|
|
|
2256 This is identical to @code{do-symbols} except that the @var{obarray}
|
|
|
2257 argument is omitted; it always iterates over the default obarray.
|
|
|
2258 @end defspec
|
|
|
2259
|
|
|
2260 @xref{Mapping over Sequences}, for some more functions for
|
|
|
2261 iterating over vectors or lists.
|
|
|
2262
|
|
|
2263 @node Loop Facility, Multiple Values, Iteration, Control Structure
|
|
|
2264 @section Loop Facility
|
|
|
2265
|
|
|
2266 @noindent
|
|
|
2267 A common complaint with Lisp's traditional looping constructs is
|
|
|
2268 that they are either too simple and limited, such as Common Lisp's
|
|
|
2269 @code{dotimes} or Emacs Lisp's @code{while}, or too unreadable and
|
|
|
2270 obscure, like Common Lisp's @code{do} loop.
|
|
|
2271
|
|
|
2272 To remedy this, recent versions of Common Lisp have added a new
|
|
|
2273 construct called the ``Loop Facility'' or ``@code{loop} macro,''
|
|
|
2274 with an easy-to-use but very powerful and expressive syntax.
|
|
|
2275
|
|
|
2276 @menu
|
|
|
2277 * Loop Basics:: `loop' macro, basic clause structure
|
|
|
2278 * Loop Examples:: Working examples of `loop' macro
|
|
|
2279 * For Clauses:: Clauses introduced by `for' or `as'
|
|
|
2280 * Iteration Clauses:: `repeat', `while', `thereis', etc.
|
|
|
2281 * Accumulation Clauses:: `collect', `sum', `maximize', etc.
|
|
|
2282 * Other Clauses:: `with', `if', `initially', `finally'
|
|
|
2283 @end menu
|
|
|
2284
|
|
|
2285 @node Loop Basics, Loop Examples, Loop Facility, Loop Facility
|
|
|
2286 @subsection Loop Basics
|
|
|
2287
|
|
|
2288 @noindent
|
|
|
2289 The @code{loop} macro essentially creates a mini-language within
|
|
|
2290 Lisp that is specially tailored for describing loops. While this
|
|
|
2291 language is a little strange-looking by the standards of regular Lisp,
|
|
|
2292 it turns out to be very easy to learn and well-suited to its purpose.
|
|
|
2293
|
|
|
2294 Since @code{loop} is a macro, all parsing of the loop language
|
|
|
2295 takes place at byte-compile time; compiled @code{loop}s are just
|
|
|
2296 as efficient as the equivalent @code{while} loops written longhand.
|
|
|
2297
|
|
|
2298 @defspec loop clauses@dots{}
|
|
|
2299 A loop construct consists of a series of @var{clause}s, each
|
|
|
2300 introduced by a symbol like @code{for} or @code{do}. Clauses
|
|
|
2301 are simply strung together in the argument list of @code{loop},
|
|
|
2302 with minimal extra parentheses. The various types of clauses
|
|
|
2303 specify initializations, such as the binding of temporary
|
|
|
2304 variables, actions to be taken in the loop, stepping actions,
|
|
|
2305 and final cleanup.
|
|
|
2306
|
|
|
2307 Common Lisp specifies a certain general order of clauses in a
|
|
|
2308 loop:
|
|
|
2309
|
|
|
2310 @example
|
|
|
2311 (loop @var{name-clause}
|
|
|
2312 @var{var-clauses}@dots{}
|
|
|
2313 @var{action-clauses}@dots{})
|
|
|
2314 @end example
|
|
|
2315
|
|
|
2316 The @var{name-clause} optionally gives a name to the implicit
|
|
|
2317 block that surrounds the loop. By default, the implicit block
|
|
|
2318 is named @code{nil}. The @var{var-clauses} specify what
|
|
|
2319 variables should be bound during the loop, and how they should
|
|
|
2320 be modified or iterated throughout the course of the loop. The
|
|
|
2321 @var{action-clauses} are things to be done during the loop, such
|
|
|
2322 as computing, collecting, and returning values.
|
|
|
2323
|
|
|
2324 The Emacs version of the @code{loop} macro is less restrictive about
|
|
|
2325 the order of clauses, but things will behave most predictably if
|
|
|
2326 you put the variable-binding clauses @code{with}, @code{for}, and
|
|
|
2327 @code{repeat} before the action clauses. As in Common Lisp,
|
|
|
2328 @code{initially} and @code{finally} clauses can go anywhere.
|
|
|
2329
|
|
|
2330 Loops generally return @code{nil} by default, but you can cause
|
|
|
2331 them to return a value by using an accumulation clause like
|
|
|
2332 @code{collect}, an end-test clause like @code{always}, or an
|
|
|
2333 explicit @code{return} clause to jump out of the implicit block.
|
|
|
2334 (Because the loop body is enclosed in an implicit block, you can
|
|
|
2335 also use regular Lisp @code{return} or @code{return-from} to
|
|
|
2336 break out of the loop.)
|
|
|
2337 @end defspec
|
|
|
2338
|
|
|
2339 The following sections give some examples of the Loop Macro in
|
|
|
2340 action, and describe the particular loop clauses in great detail.
|
|
|
2341 Consult the second edition of Steele's @dfn{Common Lisp, the Language},
|
|
|
2342 for additional discussion and examples of the @code{loop} macro.
|
|
|
2343
|
|
|
2344 @node Loop Examples, For Clauses, Loop Basics, Loop Facility
|
|
|
2345 @subsection Loop Examples
|
|
|
2346
|
|
|
2347 @noindent
|
|
|
2348 Before listing the full set of clauses that are allowed, let's
|
|
|
2349 look at a few example loops just to get a feel for the @code{loop}
|
|
|
2350 language.
|
|
|
2351
|
|
|
2352 @example
|
|
|
2353 (loop for buf in (buffer-list)
|
|
|
2354 collect (buffer-file-name buf))
|
|
|
2355 @end example
|
|
|
2356
|
|
|
2357 @noindent
|
|
|
2358 This loop iterates over all Emacs buffers, using the list
|
|
|
2359 returned by @code{buffer-list}. For each buffer @code{buf},
|
|
|
2360 it calls @code{buffer-file-name} and collects the results into
|
|
|
2361 a list, which is then returned from the @code{loop} construct.
|
|
|
2362 The result is a list of the file names of all the buffers in
|
|
|
2363 Emacs' memory. The words @code{for}, @code{in}, and @code{collect}
|
|
|
2364 are reserved words in the @code{loop} language.
|
|
|
2365
|
|
|
2366 @example
|
|
|
2367 (loop repeat 20 do (insert "Yowsa\n"))
|
|
|
2368 @end example
|
|
|
2369
|
|
|
2370 @noindent
|
|
|
2371 This loop inserts the phrase ``Yowsa'' twenty times in the
|
|
|
2372 current buffer.
|
|
|
2373
|
|
|
2374 @example
|
|
|
2375 (loop until (eobp) do (munch-line) (forward-line 1))
|
|
|
2376 @end example
|
|
|
2377
|
|
|
2378 @noindent
|
|
|
2379 This loop calls @code{munch-line} on every line until the end
|
|
|
2380 of the buffer. If point is already at the end of the buffer,
|
|
|
2381 the loop exits immediately.
|
|
|
2382
|
|
|
2383 @example
|
|
|
2384 (loop do (munch-line) until (eobp) do (forward-line 1))
|
|
|
2385 @end example
|
|
|
2386
|
|
|
2387 @noindent
|
|
|
2388 This loop is similar to the above one, except that @code{munch-line}
|
|
|
2389 is always called at least once.
|
|
|
2390
|
|
|
2391 @example
|
|
|
2392 (loop for x from 1 to 100
|
|
|
2393 for y = (* x x)
|
|
|
2394 until (>= y 729)
|
|
|
2395 finally return (list x (= y 729)))
|
|
|
2396 @end example
|
|
|
2397
|
|
|
2398 @noindent
|
|
|
2399 This more complicated loop searches for a number @code{x} whose
|
|
|
2400 square is 729. For safety's sake it only examines @code{x}
|
|
|
2401 values up to 100; dropping the phrase @samp{to 100} would
|
|
|
2402 cause the loop to count upwards with no limit. The second
|
|
|
2403 @code{for} clause defines @code{y} to be the square of @code{x}
|
|
|
2404 within the loop; the expression after the @code{=} sign is
|
|
|
2405 reevaluated each time through the loop. The @code{until}
|
|
|
2406 clause gives a condition for terminating the loop, and the
|
|
|
2407 @code{finally} clause says what to do when the loop finishes.
|
|
|
2408 (This particular example was written less concisely than it
|
|
|
2409 could have been, just for the sake of illustration.)
|
|
|
2410
|
|
|
2411 Note that even though this loop contains three clauses (two
|
|
|
2412 @code{for}s and an @code{until}) that would have been enough to
|
|
|
2413 define loops all by themselves, it still creates a single loop
|
|
|
2414 rather than some sort of triple-nested loop. You must explicitly
|
|
|
2415 nest your @code{loop} constructs if you want nested loops.
|
|
|
2416
|
|
|
2417 @node For Clauses, Iteration Clauses, Loop Examples, Loop Facility
|
|
|
2418 @subsection For Clauses
|
|
|
2419
|
|
|
2420 @noindent
|
|
|
2421 Most loops are governed by one or more @code{for} clauses.
|
|
|
2422 A @code{for} clause simultaneously describes variables to be
|
|
|
2423 bound, how those variables are to be stepped during the loop,
|
|
|
2424 and usually an end condition based on those variables.
|
|
|
2425
|
|
|
2426 The word @code{as} is a synonym for the word @code{for}. This
|
|
|
2427 word is followed by a variable name, then a word like @code{from}
|
|
|
2428 or @code{across} that describes the kind of iteration desired.
|
|
|
2429 In Common Lisp, the phrase @code{being the} sometimes precedes
|
|
|
2430 the type of iteration; in this package both @code{being} and
|
|
|
2431 @code{the} are optional. The word @code{each} is a synonym
|
|
|
2432 for @code{the}, and the word that follows it may be singular
|
|
|
2433 or plural: @samp{for x being the elements of y} or
|
|
|
2434 @samp{for x being each element of y}. Which form you use
|
|
|
2435 is purely a matter of style.
|
|
|
2436
|
|
|
2437 The variable is bound around the loop as if by @code{let}:
|
|
|
2438
|
|
|
2439 @example
|
|
|
2440 (setq i 'happy)
|
|
|
2441 (loop for i from 1 to 10 do (do-something-with i))
|
|
|
2442 i
|
|
|
2443 @result{} happy
|
|
|
2444 @end example
|
|
|
2445
|
|
|
2446 @table @code
|
|
|
2447 @item for @var{var} from @var{expr1} to @var{expr2} by @var{expr3}
|
|
|
2448 This type of @code{for} clause creates a counting loop. Each of
|
|
|
2449 the three sub-terms is optional, though there must be at least one
|
|
|
2450 term so that the clause is marked as a counting clause.
|
|
|
2451
|
|
|
2452 The three expressions are the starting value, the ending value, and
|
|
|
2453 the step value, respectively, of the variable. The loop counts
|
|
|
2454 upwards by default (@var{expr3} must be positive), from @var{expr1}
|
|
|
2455 to @var{expr2} inclusively. If you omit the @code{from} term, the
|
|
|
2456 loop counts from zero; if you omit the @code{to} term, the loop
|
|
|
2457 counts forever without stopping (unless stopped by some other
|
|
|
2458 loop clause, of course); if you omit the @code{by} term, the loop
|
|
|
2459 counts in steps of one.
|
|
|
2460
|
|
|
2461 You can replace the word @code{from} with @code{upfrom} or
|
|
|
2462 @code{downfrom} to indicate the direction of the loop. Likewise,
|
|
|
2463 you can replace @code{to} with @code{upto} or @code{downto}.
|
|
|
2464 For example, @samp{for x from 5 downto 1} executes five times
|
|
|
2465 with @code{x} taking on the integers from 5 down to 1 in turn.
|
|
|
2466 Also, you can replace @code{to} with @code{below} or @code{above},
|
|
|
2467 which are like @code{upto} and @code{downto} respectively except
|
|
|
2468 that they are exclusive rather than inclusive limits:
|
|
|
2469
|
|
|
2470 @example
|
|
|
2471 (loop for x to 10 collect x)
|
|
|
2472 @result{} (0 1 2 3 4 5 6 7 8 9 10)
|
|
|
2473 (loop for x below 10 collect x)
|
|
|
2474 @result{} (0 1 2 3 4 5 6 7 8 9)
|
|
|
2475 @end example
|
|
|
2476
|
|
|
2477 The @code{by} value is always positive, even for downward-counting
|
|
|
2478 loops. Some sort of @code{from} value is required for downward
|
|
|
2479 loops; @samp{for x downto 5} is not a legal loop clause all by
|
|
|
2480 itself.
|
|
|
2481
|
|
|
2482 @item for @var{var} in @var{list} by @var{function}
|
|
|
2483 This clause iterates @var{var} over all the elements of @var{list},
|
|
|
2484 in turn. If you specify the @code{by} term, then @var{function}
|
|
|
2485 is used to traverse the list instead of @code{cdr}; it must be a
|
|
|
2486 function taking one argument. For example:
|
|
|
2487
|
|
|
2488 @example
|
|
|
2489 (loop for x in '(1 2 3 4 5 6) collect (* x x))
|
|
|
2490 @result{} (1 4 9 16 25 36)
|
|
|
2491 (loop for x in '(1 2 3 4 5 6) by 'cddr collect (* x x))
|
|
|
2492 @result{} (1 9 25)
|
|
|
2493 @end example
|
|
|
2494
|
|
|
2495 @item for @var{var} on @var{list} by @var{function}
|
|
|
2496 This clause iterates @var{var} over all the cons cells of @var{list}.
|
|
|
2497
|
|
|
2498 @example
|
|
|
2499 (loop for x on '(1 2 3 4) collect x)
|
|
|
2500 @result{} ((1 2 3 4) (2 3 4) (3 4) (4))
|
|
|
2501 @end example
|
|
|
2502
|
|
|
2503 With @code{by}, there is no real reason that the @code{on} expression
|
|
|
2504 must be a list. For example:
|
|
|
2505
|
|
|
2506 @example
|
|
|
2507 (loop for x on first-animal by 'next-animal collect x)
|
|
|
2508 @end example
|
|
|
2509
|
|
|
2510 @noindent
|
|
|
2511 where @code{(next-animal x)} takes an ``animal'' @var{x} and returns
|
|
|
2512 the next in the (assumed) sequence of animals, or @code{nil} if
|
|
|
2513 @var{x} was the last animal in the sequence.
|
|
|
2514
|
|
|
2515 @item for @var{var} in-ref @var{list} by @var{function}
|
|
|
2516 This is like a regular @code{in} clause, but @var{var} becomes
|
|
|
2517 a @code{setf}-able ``reference'' onto the elements of the list
|
|
|
2518 rather than just a temporary variable. For example,
|
|
|
2519
|
|
|
2520 @example
|
|
|
2521 (loop for x in-ref my-list do (incf x))
|
|
|
2522 @end example
|
|
|
2523
|
|
|
2524 @noindent
|
|
|
2525 increments every element of @code{my-list} in place. This clause
|
|
|
2526 is an extension to standard Common Lisp.
|
|
|
2527
|
|
|
2528 @item for @var{var} across @var{array}
|
|
|
2529 This clause iterates @var{var} over all the elements of @var{array},
|
|
|
2530 which may be a vector or a string.
|
|
|
2531
|
|
|
2532 @example
|
|
|
2533 (loop for x across "aeiou"
|
|
|
2534 do (use-vowel (char-to-string x)))
|
|
|
2535 @end example
|
|
|
2536
|
|
|
2537 @item for @var{var} across-ref @var{array}
|
|
|
2538 This clause iterates over an array, with @var{var} a @code{setf}-able
|
|
|
2539 reference onto the elements; see @code{in-ref} above.
|
|
|
2540
|
|
|
2541 @item for @var{var} being the elements of @var{sequence}
|
|
|
2542 This clause iterates over the elements of @var{sequence}, which may
|
|
|
2543 be a list, vector, or string. Since the type must be determined
|
|
|
2544 at run-time, this is somewhat less efficient than @code{in} or
|
|
|
2545 @code{across}. The clause may be followed by the additional term
|
|
|
2546 @samp{using (index @var{var2})} to cause @var{var2} to be bound to
|
|
|
2547 the successive indices (starting at 0) of the elements.
|
|
|
2548
|
|
|
2549 This clause type is taken from older versions of the @code{loop} macro,
|
|
|
2550 and is not present in modern Common Lisp. The @samp{using (sequence ...)}
|
|
|
2551 term of the older macros is not supported.
|
|
|
2552
|
|
|
2553 @item for @var{var} being the elements of-ref @var{sequence}
|
|
|
2554 This clause iterates over a sequence, with @var{var} a @code{setf}-able
|
|
|
2555 reference onto the elements; see @code{in-ref} above.
|
|
|
2556
|
|
|
2557 @item for @var{var} being the symbols [of @var{obarray}]
|
|
|
2558 This clause iterates over symbols, either over all interned symbols
|
|
|
2559 or over all symbols in @var{obarray}. The loop is executed with
|
|
|
2560 @var{var} bound to each symbol in turn. The symbols are visited in
|
|
|
2561 an unspecified order.
|
|
|
2562
|
|
|
2563 As an example,
|
|
|
2564
|
|
|
2565 @example
|
|
|
2566 (loop for sym being the symbols
|
|
|
2567 when (fboundp sym)
|
|
|
2568 when (string-match "^map" (symbol-name sym))
|
|
|
2569 collect sym)
|
|
|
2570 @end example
|
|
|
2571
|
|
|
2572 @noindent
|
|
|
2573 returns a list of all the functions whose names begin with @samp{map}.
|
|
|
2574
|
|
|
2575 The Common Lisp words @code{external-symbols} and @code{present-symbols}
|
|
|
2576 are also recognized but are equivalent to @code{symbols} in Emacs Lisp.
|
|
|
2577
|
|
|
2578 Due to a minor implementation restriction, it will not work to have
|
|
|
2579 more than one @code{for} clause iterating over symbols, hash tables,
|
|
|
2580 keymaps, overlays, or intervals in a given @code{loop}. Fortunately,
|
|
|
2581 it would rarely if ever be useful to do so. It @emph{is} legal to mix
|
|
|
2582 one of these types of clauses with other clauses like @code{for ... to}
|
|
|
2583 or @code{while}.
|
|
|
2584
|
|
|
2585 @item for @var{var} being the hash-keys of @var{hash-table}
|
|
|
2586 This clause iterates over the entries in @var{hash-table}. For each
|
|
|
2587 hash table entry, @var{var} is bound to the entry's key. If you write
|
|
|
2588 @samp{the hash-values} instead, @var{var} is bound to the values
|
|
|
2589 of the entries. The clause may be followed by the additional
|
|
|
2590 term @samp{using (hash-values @var{var2})} (where @code{hash-values}
|
|
|
2591 is the opposite word of the word following @code{the}) to cause
|
|
|
2592 @var{var} and @var{var2} to be bound to the two parts of each
|
|
|
2593 hash table entry.
|
|
|
2594
|
|
|
2595 @item for @var{var} being the key-codes of @var{keymap}
|
|
|
2596 This clause iterates over the entries in @var{keymap}. In GNU Emacs
|
|
|
2597 18 and 19, keymaps are either alists or vectors, and key-codes are
|
|
|
2598 integers or symbols. In Lucid Emacs 19, keymaps are a special new
|
|
|
2599 data type, and key-codes are symbols or lists of symbols. The
|
|
|
2600 iteration does not enter nested keymaps or inherited (parent) keymaps.
|
|
|
2601 You can use @samp{the key-bindings} to access the commands bound to
|
|
|
2602 the keys rather than the key codes, and you can add a @code{using}
|
|
|
2603 clause to access both the codes and the bindings together.
|
|
|
2604
|
|
|
2605 @item for @var{var} being the key-seqs of @var{keymap}
|
|
|
2606 This clause iterates over all key sequences defined by @var{keymap}
|
|
|
2607 and its nested keymaps, where @var{var} takes on values which are
|
|
|
2608 strings in Emacs 18 or vectors in Emacs 19. The strings or vectors
|
|
|
2609 are reused for each iteration, so you must copy them if you wish to keep
|
|
|
2610 them permanently. You can add a @samp{using (key-bindings ...)}
|
|
|
2611 clause to get the command bindings as well.
|
|
|
2612
|
|
|
2613 @item for @var{var} being the overlays [of @var{buffer}] @dots{}
|
|
|
2614 This clause iterates over the Emacs 19 ``overlays'' or Lucid
|
|
|
2615 Emacs ``extents'' of a buffer (the clause @code{extents} is synonymous
|
|
|
2616 with @code{overlays}). Under Emacs 18, this clause iterates zero
|
|
|
2617 times. If the @code{of} term is omitted, the current buffer is used.
|
|
|
2618 This clause also accepts optional @samp{from @var{pos}} and
|
|
|
2619 @samp{to @var{pos}} terms, limiting the clause to overlays which
|
|
|
2620 overlap the specified region.
|
|
|
2621
|
|
|
2622 @item for @var{var} being the intervals [of @var{buffer}] @dots{}
|
|
|
2623 This clause iterates over all intervals of a buffer with constant
|
|
|
2624 text properties. The variable @var{var} will be bound to conses
|
|
|
2625 of start and end positions, where one start position is always equal
|
|
|
2626 to the previous end position. The clause allows @code{of},
|
|
|
2627 @code{from}, @code{to}, and @code{property} terms, where the latter
|
|
|
2628 term restricts the search to just the specified property. The
|
|
|
2629 @code{of} term may specify either a buffer or a string. This
|
|
|
2630 clause is useful only in GNU Emacs 19; in other versions, all
|
|
|
2631 buffers and strings consist of a single interval.
|
|
|
2632
|
|
|
2633 @item for @var{var} being the frames
|
|
|
2634 This clause iterates over all frames, i.e., X window system windows
|
|
|
2635 open on Emacs files. This clause works only under Emacs 19. The
|
|
|
2636 clause @code{screens} is a synonym for @code{frames}. The frames
|
|
|
2637 are visited in @code{next-frame} order starting from
|
|
|
2638 @code{selected-frame}.
|
|
|
2639
|
|
|
2640 @item for @var{var} being the windows [of @var{frame}]
|
|
|
2641 This clause iterates over the windows (in the Emacs sense) of
|
|
|
2642 the current frame, or of the specified @var{frame}. (In Emacs 18
|
|
|
2643 there is only ever one frame, and the @code{of} term is not
|
|
|
2644 allowed there.)
|
|
|
2645
|
|
|
2646 @item for @var{var} being the buffers
|
|
|
2647 This clause iterates over all buffers in Emacs. It is equivalent
|
|
|
2648 to @samp{for @var{var} in (buffer-list)}.
|
|
|
2649
|
|
|
2650 @item for @var{var} = @var{expr1} then @var{expr2}
|
|
|
2651 This clause does a general iteration. The first time through
|
|
|
2652 the loop, @var{var} will be bound to @var{expr1}. On the second
|
|
|
2653 and successive iterations it will be set by evaluating @var{expr2}
|
|
|
2654 (which may refer to the old value of @var{var}). For example,
|
|
|
2655 these two loops are effectively the same:
|
|
|
2656
|
|
|
2657 @example
|
|
|
2658 (loop for x on my-list by 'cddr do ...)
|
|
|
2659 (loop for x = my-list then (cddr x) while x do ...)
|
|
|
2660 @end example
|
|
|
2661
|
|
|
2662 Note that this type of @code{for} clause does not imply any sort
|
|
|
2663 of terminating condition; the above example combines it with a
|
|
|
2664 @code{while} clause to tell when to end the loop.
|
|
|
2665
|
|
|
2666 If you omit the @code{then} term, @var{expr1} is used both for
|
|
|
2667 the initial setting and for successive settings:
|
|
|
2668
|
|
|
2669 @example
|
|
|
2670 (loop for x = (random) when (> x 0) return x)
|
|
|
2671 @end example
|
|
|
2672
|
|
|
2673 @noindent
|
|
|
2674 This loop keeps taking random numbers from the @code{(random)}
|
|
|
2675 function until it gets a positive one, which it then returns.
|
|
|
2676 @end table
|
|
|
2677
|
|
|
2678 If you include several @code{for} clauses in a row, they are
|
|
|
2679 treated sequentially (as if by @code{let*} and @code{setq}).
|
|
|
2680 You can instead use the word @code{and} to link the clauses,
|
|
|
2681 in which case they are processed in parallel (as if by @code{let}
|
|
|
2682 and @code{psetq}).
|
|
|
2683
|
|
|
2684 @example
|
|
|
2685 (loop for x below 5 for y = nil then x collect (list x y))
|
|
|
2686 @result{} ((0 nil) (1 1) (2 2) (3 3) (4 4))
|
|
|
2687 (loop for x below 5 and y = nil then x collect (list x y))
|
|
|
2688 @result{} ((0 nil) (1 0) (2 1) (3 2) (4 3))
|
|
|
2689 @end example
|
|
|
2690
|
|
|
2691 @noindent
|
|
|
2692 In the first loop, @code{y} is set based on the value of @code{x}
|
|
|
2693 that was just set by the previous clause; in the second loop,
|
|
|
2694 @code{x} and @code{y} are set simultaneously so @code{y} is set
|
|
|
2695 based on the value of @code{x} left over from the previous time
|
|
|
2696 through the loop.
|
|
|
2697
|
|
|
2698 Another feature of the @code{loop} macro is @dfn{destructuring},
|
|
|
2699 similar in concept to the destructuring provided by @code{defmacro}.
|
|
|
2700 The @var{var} part of any @code{for} clause can be given as a list
|
|
|
2701 of variables instead of a single variable. The values produced
|
|
|
2702 during loop execution must be lists; the values in the lists are
|
|
|
2703 stored in the corresponding variables.
|
|
|
2704
|
|
|
2705 @example
|
|
|
2706 (loop for (x y) in '((2 3) (4 5) (6 7)) collect (+ x y))
|
|
|
2707 @result{} (5 9 13)
|
|
|
2708 @end example
|
|
|
2709
|
|
|
2710 In loop destructuring, if there are more values than variables
|
|
|
2711 the trailing values are ignored, and if there are more variables
|
|
|
2712 than values the trailing variables get the value @code{nil}.
|
|
|
2713 If @code{nil} is used as a variable name, the corresponding
|
|
|
2714 values are ignored. Destructuring may be nested, and dotted
|
|
|
2715 lists of variables like @code{(x . y)} are allowed.
|
|
|
2716
|
|
|
2717 @node Iteration Clauses, Accumulation Clauses, For Clauses, Loop Facility
|
|
|
2718 @subsection Iteration Clauses
|
|
|
2719
|
|
|
2720 @noindent
|
|
|
2721 Aside from @code{for} clauses, there are several other loop clauses
|
|
|
2722 that control the way the loop operates. They might be used by
|
|
|
2723 themselves, or in conjunction with one or more @code{for} clauses.
|
|
|
2724
|
|
|
2725 @table @code
|
|
|
2726 @item repeat @var{integer}
|
|
|
2727 This clause simply counts up to the specified number using an
|
|
|
2728 internal temporary variable. The loops
|
|
|
2729
|
|
|
2730 @example
|
|
|
2731 (loop repeat n do ...)
|
|
|
2732 (loop for temp to n do ...)
|
|
|
2733 @end example
|
|
|
2734
|
|
|
2735 @noindent
|
|
|
2736 are identical except that the second one forces you to choose
|
|
|
2737 a name for a variable you aren't actually going to use.
|
|
|
2738
|
|
|
2739 @item while @var{condition}
|
|
|
2740 This clause stops the loop when the specified condition (any Lisp
|
|
|
2741 expression) becomes @code{nil}. For example, the following two
|
|
|
2742 loops are equivalent, except for the implicit @code{nil} block
|
|
|
2743 that surrounds the second one:
|
|
|
2744
|
|
|
2745 @example
|
|
|
2746 (while @var{cond} @var{forms}@dots{})
|
|
|
2747 (loop while @var{cond} do @var{forms}@dots{})
|
|
|
2748 @end example
|
|
|
2749
|
|
|
2750 @item until @var{condition}
|
|
|
2751 This clause stops the loop when the specified condition is true,
|
|
|
2752 i.e., non-@code{nil}.
|
|
|
2753
|
|
|
2754 @item always @var{condition}
|
|
|
2755 This clause stops the loop when the specified condition is @code{nil}.
|
|
|
2756 Unlike @code{while}, it stops the loop using @code{return nil} so that
|
|
|
2757 the @code{finally} clauses are not executed. If all the conditions
|
|
|
2758 were non-@code{nil}, the loop returns @code{t}:
|
|
|
2759
|
|
|
2760 @example
|
|
|
2761 (if (loop for size in size-list always (> size 10))
|
|
|
2762 (some-big-sizes)
|
|
|
2763 (no-big-sizes))
|
|
|
2764 @end example
|
|
|
2765
|
|
|
2766 @item never @var{condition}
|
|
|
2767 This clause is like @code{always}, except that the loop returns
|
|
|
2768 @code{t} if any conditions were false, or @code{nil} otherwise.
|
|
|
2769
|
|
|
2770 @item thereis @var{condition}
|
|
|
2771 This clause stops the loop when the specified form is non-@code{nil};
|
|
|
2772 in this case, it returns that non-@code{nil} value. If all the
|
|
|
2773 values were @code{nil}, the loop returns @code{nil}.
|
|
|
2774 @end table
|
|
|
2775
|
|
|
2776 @node Accumulation Clauses, Other Clauses, Iteration Clauses, Loop Facility
|
|
|
2777 @subsection Accumulation Clauses
|
|
|
2778
|
|
|
2779 @noindent
|
|
|
2780 These clauses cause the loop to accumulate information about the
|
|
|
2781 specified Lisp @var{form}. The accumulated result is returned
|
|
|
2782 from the loop unless overridden, say, by a @code{return} clause.
|
|
|
2783
|
|
|
2784 @table @code
|
|
|
2785 @item collect @var{form}
|
|
|
2786 This clause collects the values of @var{form} into a list. Several
|
|
|
2787 examples of @code{collect} appear elsewhere in this manual.
|
|
|
2788
|
|
|
2789 The word @code{collecting} is a synonym for @code{collect}, and
|
|
|
2790 likewise for the other accumulation clauses.
|
|
|
2791
|
|
|
2792 @item append @var{form}
|
|
|
2793 This clause collects lists of values into a result list using
|
|
|
2794 @code{append}.
|
|
|
2795
|
|
|
2796 @item nconc @var{form}
|
|
|
2797 This clause collects lists of values into a result list by
|
|
|
2798 destructively modifying the lists rather than copying them.
|
|
|
2799
|
|
|
2800 @item concat @var{form}
|
|
|
2801 This clause concatenates the values of the specified @var{form}
|
|
|
2802 into a string. (It and the following clause are extensions to
|
|
|
2803 standard Common Lisp.)
|
|
|
2804
|
|
|
2805 @item vconcat @var{form}
|
|
|
2806 This clause concatenates the values of the specified @var{form}
|
|
|
2807 into a vector.
|
|
|
2808
|
|
|
2809 @item count @var{form}
|
|
|
2810 This clause counts the number of times the specified @var{form}
|
|
|
2811 evaluates to a non-@code{nil} value.
|
|
|
2812
|
|
|
2813 @item sum @var{form}
|
|
|
2814 This clause accumulates the sum of the values of the specified
|
|
|
2815 @var{form}, which must evaluate to a number.
|
|
|
2816
|
|
|
2817 @item maximize @var{form}
|
|
|
2818 This clause accumulates the maximum value of the specified @var{form},
|
|
|
2819 which must evaluate to a number. The return value is undefined if
|
|
|
2820 @code{maximize} is executed zero times.
|
|
|
2821
|
|
|
2822 @item minimize @var{form}
|
|
|
2823 This clause accumulates the minimum value of the specified @var{form}.
|
|
|
2824 @end table
|
|
|
2825
|
|
|
2826 Accumulation clauses can be followed by @samp{into @var{var}} to
|
|
|
2827 cause the data to be collected into variable @var{var} (which is
|
|
|
2828 automatically @code{let}-bound during the loop) rather than an
|
|
|
2829 unnamed temporary variable. Also, @code{into} accumulations do
|
|
|
2830 not automatically imply a return value. The loop must use some
|
|
|
2831 explicit mechanism, such as @code{finally return}, to return
|
|
|
2832 the accumulated result.
|
|
|
2833
|
|
|
2834 It is legal for several accumulation clauses of the same type to
|
|
|
2835 accumulate into the same place. From Steele:
|
|
|
2836
|
|
|
2837 @example
|
|
|
2838 (loop for name in '(fred sue alice joe june)
|
|
|
2839 for kids in '((bob ken) () () (kris sunshine) ())
|
|
|
2840 collect name
|
|
|
2841 append kids)
|
|
|
2842 @result{} (fred bob ken sue alice joe kris sunshine june)
|
|
|
2843 @end example
|
|
|
2844
|
|
|
2845 @node Other Clauses, , Accumulation Clauses, Loop Facility
|
|
|
2846 @subsection Other Clauses
|
|
|
2847
|
|
|
2848 @noindent
|
|
|
2849 This section describes the remaining loop clauses.
|
|
|
2850
|
|
|
2851 @table @code
|
|
|
2852 @item with @var{var} = @var{value}
|
|
|
2853 This clause binds a variable to a value around the loop, but
|
|
|
2854 otherwise leaves the variable alone during the loop. The following
|
|
|
2855 loops are basically equivalent:
|
|
|
2856
|
|
|
2857 @example
|
|
|
2858 (loop with x = 17 do ...)
|
|
|
2859 (let ((x 17)) (loop do ...))
|
|
|
2860 (loop for x = 17 then x do ...)
|
|
|
2861 @end example
|
|
|
2862
|
|
|
2863 Naturally, the variable @var{var} might be used for some purpose
|
|
|
2864 in the rest of the loop. For example:
|
|
|
2865
|
|
|
2866 @example
|
|
|
2867 (loop for x in my-list with res = nil do (push x res)
|
|
|
2868 finally return res)
|
|
|
2869 @end example
|
|
|
2870
|
|
|
2871 This loop inserts the elements of @code{my-list} at the front of
|
|
|
2872 a new list being accumulated in @code{res}, then returns the
|
|
|
2873 list @code{res} at the end of the loop. The effect is similar
|
|
|
2874 to that of a @code{collect} clause, but the list gets reversed
|
|
|
2875 by virtue of the fact that elements are being pushed onto the
|
|
|
2876 front of @code{res} rather than the end.
|
|
|
2877
|
|
|
2878 If you omit the @code{=} term, the variable is initialized to
|
|
|
2879 @code{nil}. (Thus the @samp{= nil} in the above example is
|
|
|
2880 unnecessary.)
|
|
|
2881
|
|
|
2882 Bindings made by @code{with} are sequential by default, as if
|
|
|
2883 by @code{let*}. Just like @code{for} clauses, @code{with} clauses
|
|
|
2884 can be linked with @code{and} to cause the bindings to be made by
|
|
|
2885 @code{let} instead.
|
|
|
2886
|
|
|
2887 @item if @var{condition} @var{clause}
|
|
|
2888 This clause executes the following loop clause only if the specified
|
|
|
2889 condition is true. The following @var{clause} should be an accumulation,
|
|
|
2890 @code{do}, @code{return}, @code{if}, or @code{unless} clause.
|
|
|
2891 Several clauses may be linked by separating them with @code{and}.
|
|
|
2892 These clauses may be followed by @code{else} and a clause or clauses
|
|
|
2893 to execute if the condition was false. The whole construct may
|
|
|
2894 optionally be followed by the word @code{end} (which may be used to
|
|
|
2895 disambiguate an @code{else} or @code{and} in a nested @code{if}).
|
|
|
2896
|
|
|
2897 The actual non-@code{nil} value of the condition form is available
|
|
|
2898 by the name @code{it} in the ``then'' part. For example:
|
|
|
2899
|
|
|
2900 @example
|
|
|
2901 (setq funny-numbers '(6 13 -1))
|
|
|
2902 @result{} (6 13 -1)
|
|
|
2903 (loop for x below 10
|
|
|
2904 if (oddp x)
|
|
|
2905 collect x into odds
|
|
|
2906 and if (memq x funny-numbers) return (cdr it) end
|
|
|
2907 else
|
|
|
2908 collect x into evens
|
|
|
2909 finally return (vector odds evens))
|
|
|
2910 @result{} [(1 3 5 7 9) (0 2 4 6 8)]
|
|
|
2911 (setq funny-numbers '(6 7 13 -1))
|
|
|
2912 @result{} (6 7 13 -1)
|
|
|
2913 (loop <@r{same thing again}>)
|
|
|
2914 @result{} (13 -1)
|
|
|
2915 @end example
|
|
|
2916
|
|
|
2917 Note the use of @code{and} to put two clauses into the ``then''
|
|
|
2918 part, one of which is itself an @code{if} clause. Note also that
|
|
|
2919 @code{end}, while normally optional, was necessary here to make
|
|
|
2920 it clear that the @code{else} refers to the outermost @code{if}
|
|
|
2921 clause. In the first case, the loop returns a vector of lists
|
|
|
2922 of the odd and even values of @var{x}. In the second case, the
|
|
|
2923 odd number 7 is one of the @code{funny-numbers} so the loop
|
|
|
2924 returns early; the actual returned value is based on the result
|
|
|
2925 of the @code{memq} call.
|
|
|
2926
|
|
|
2927 @item when @var{condition} @var{clause}
|
|
|
2928 This clause is just a synonym for @code{if}.
|
|
|
2929
|
|
|
2930 @item unless @var{condition} @var{clause}
|
|
|
2931 The @code{unless} clause is just like @code{if} except that the
|
|
|
2932 sense of the condition is reversed.
|
|
|
2933
|
|
|
2934 @item named @var{name}
|
|
|
2935 This clause gives a name other than @code{nil} to the implicit
|
|
|
2936 block surrounding the loop. The @var{name} is the symbol to be
|
|
|
2937 used as the block name.
|
|
|
2938
|
|
|
2939 @item initially [do] @var{forms}...
|
|
|
2940 This keyword introduces one or more Lisp forms which will be
|
|
|
2941 executed before the loop itself begins (but after any variables
|
|
|
2942 requested by @code{for} or @code{with} have been bound to their
|
|
|
2943 initial values). @code{initially} clauses can appear anywhere;
|
|
|
2944 if there are several, they are executed in the order they appear
|
|
|
2945 in the loop. The keyword @code{do} is optional.
|
|
|
2946
|
|
|
2947 @item finally [do] @var{forms}...
|
|
|
2948 This introduces Lisp forms which will be executed after the loop
|
|
|
2949 finishes (say, on request of a @code{for} or @code{while}).
|
|
|
2950 @code{initially} and @code{finally} clauses may appear anywhere
|
|
|
2951 in the loop construct, but they are executed (in the specified
|
|
|
2952 order) at the beginning or end, respectively, of the loop.
|
|
|
2953
|
|
|
2954 @item finally return @var{form}
|
|
|
2955 This says that @var{form} should be executed after the loop
|
|
|
2956 is done to obtain a return value. (Without this, or some other
|
|
|
2957 clause like @code{collect} or @code{return}, the loop will simply
|
|
|
2958 return @code{nil}.) Variables bound by @code{for}, @code{with},
|
|
|
2959 or @code{into} will still contain their final values when @var{form}
|
|
|
2960 is executed.
|
|
|
2961
|
|
|
2962 @item do @var{forms}...
|
|
|
2963 The word @code{do} may be followed by any number of Lisp expressions
|
|
|
2964 which are executed as an implicit @code{progn} in the body of the
|
|
|
2965 loop. Many of the examples in this section illustrate the use of
|
|
|
2966 @code{do}.
|
|
|
2967
|
|
|
2968 @item return @var{form}
|
|
|
2969 This clause causes the loop to return immediately. The following
|
|
|
2970 Lisp form is evaluated to give the return value of the @code{loop}
|
|
|
2971 form. The @code{finally} clauses, if any, are not executed.
|
|
|
2972 Of course, @code{return} is generally used inside an @code{if} or
|
|
|
2973 @code{unless}, as its use in a top-level loop clause would mean
|
|
|
2974 the loop would never get to ``loop'' more than once.
|
|
|
2975
|
|
|
2976 The clause @samp{return @var{form}} is equivalent to
|
|
|
2977 @samp{do (return @var{form})} (or @code{return-from} if the loop
|
|
|
2978 was named). The @code{return} clause is implemented a bit more
|
|
|
2979 efficiently, though.
|
|
|
2980 @end table
|
|
|
2981
|
|
|
2982 While there is no high-level way to add user extensions to @code{loop}
|
|
|
2983 (comparable to @code{defsetf} for @code{setf}, say), this package
|
|
|
2984 does offer two properties called @code{cl-loop-handler} and
|
|
|
2985 @code{cl-loop-for-handler} which are functions to be called when
|
|
|
2986 a given symbol is encountered as a top-level loop clause or
|
|
|
2987 @code{for} clause, respectively. Consult the source code in
|
|
|
2988 file @file{cl-macs.el} for details.
|
|
|
2989
|
|
|
2990 This package's @code{loop} macro is compatible with that of Common
|
|
|
2991 Lisp, except that a few features are not implemented: @code{loop-finish}
|
|
|
2992 and data-type specifiers. Naturally, the @code{for} clauses which
|
|
|
2993 iterate over keymaps, overlays, intervals, frames, windows, and
|
|
|
2994 buffers are Emacs-specific extensions.
|
|
|
2995
|
|
|
2996 @node Multiple Values, , Loop Facility, Control Structure
|
|
|
2997 @section Multiple Values
|
|
|
2998
|
|
|
2999 @noindent
|
|
|
3000 Common Lisp functions can return zero or more results. Emacs Lisp
|
|
|
3001 functions, by contrast, always return exactly one result. This
|
|
|
3002 package makes no attempt to emulate Common Lisp multiple return
|
|
|
3003 values; Emacs versions of Common Lisp functions that return more
|
|
|
3004 than one value either return just the first value (as in
|
|
|
3005 @code{compiler-macroexpand}) or return a list of values (as in
|
|
|
3006 @code{get-setf-method}). This package @emph{does} define placeholders
|
|
|
3007 for the Common Lisp functions that work with multiple values, but
|
|
|
3008 in Emacs Lisp these functions simply operate on lists instead.
|
|
|
3009 The @code{values} form, for example, is a synonym for @code{list}
|
|
|
3010 in Emacs.
|
|
|
3011
|
|
|
3012 @defspec multiple-value-bind (var@dots{}) values-form forms@dots{}
|
|
|
3013 This form evaluates @var{values-form}, which must return a list of
|
|
|
3014 values. It then binds the @var{var}s to these respective values,
|
|
|
3015 as if by @code{let}, and then executes the body @var{forms}.
|
|
|
3016 If there are more @var{var}s than values, the extra @var{var}s
|
|
|
3017 are bound to @code{nil}. If there are fewer @var{var}s than
|
|
|
3018 values, the excess values are ignored.
|
|
|
3019 @end defspec
|
|
|
3020
|
|
|
3021 @defspec multiple-value-setq (var@dots{}) form
|
|
|
3022 This form evaluates @var{form}, which must return a list of values.
|
|
|
3023 It then sets the @var{var}s to these respective values, as if by
|
|
|
3024 @code{setq}. Extra @var{var}s or values are treated the same as
|
|
|
3025 in @code{multiple-value-bind}.
|
|
|
3026 @end defspec
|
|
|
3027
|
|
|
3028 The older Quiroz package attempted a more faithful (but still
|
|
|
3029 imperfect) emulation of Common Lisp multiple values. The old
|
|
|
3030 method ``usually'' simulated true multiple values quite well,
|
|
|
3031 but under certain circumstances would leave spurious return
|
|
|
3032 values in memory where a later, unrelated @code{multiple-value-bind}
|
|
|
3033 form would see them.
|
|
|
3034
|
|
|
3035 Since a perfect emulation is not feasible in Emacs Lisp, this
|
|
|
3036 package opts to keep it as simple and predictable as possible.
|
|
|
3037
|
|
|
3038 @node Macros, Declarations, Control Structure, Top
|
|
|
3039 @chapter Macros
|
|
|
3040
|
|
|
3041 @noindent
|
|
|
3042 This package implements the various Common Lisp features of
|
|
|
3043 @code{defmacro}, such as destructuring, @code{&environment},
|
|
|
3044 and @code{&body}. Top-level @code{&whole} is not implemented
|
|
|
3045 for @code{defmacro} due to technical difficulties.
|
|
|
3046 @xref{Argument Lists}.
|
|
|
3047
|
|
|
3048 Destructuring is made available to the user by way of the
|
|
|
3049 following macro:
|
|
|
3050
|
|
|
3051 @defspec destructuring-bind arglist expr forms@dots{}
|
|
|
3052 This macro expands to code which executes @var{forms}, with
|
|
|
3053 the variables in @var{arglist} bound to the list of values
|
|
|
3054 returned by @var{expr}. The @var{arglist} can include all
|
|
|
3055 the features allowed for @code{defmacro} argument lists,
|
|
|
3056 including destructuring. (The @code{&environment} keyword
|
|
|
3057 is not allowed.) The macro expansion will signal an error
|
|
|
3058 if @var{expr} returns a list of the wrong number of arguments
|
|
|
3059 or with incorrect keyword arguments.
|
|
|
3060 @end defspec
|
|
|
3061
|
|
|
3062 This package also includes the Common Lisp @code{define-compiler-macro}
|
|
|
3063 facility, which allows you to define compile-time expansions and
|
|
|
3064 optimizations for your functions.
|
|
|
3065
|
|
|
3066 @defspec define-compiler-macro name arglist forms@dots{}
|
|
|
3067 This form is similar to @code{defmacro}, except that it only expands
|
|
|
3068 calls to @var{name} at compile-time; calls processed by the Lisp
|
|
|
3069 interpreter are not expanded, nor are they expanded by the
|
|
|
3070 @code{macroexpand} function.
|
|
|
3071
|
|
|
3072 The argument list may begin with a @code{&whole} keyword and a
|
|
|
3073 variable. This variable is bound to the macro-call form itself,
|
|
|
3074 i.e., to a list of the form @samp{(@var{name} @var{args}@dots{})}.
|
|
|
3075 If the macro expander returns this form unchanged, then the
|
|
|
3076 compiler treats it as a normal function call. This allows
|
|
|
3077 compiler macros to work as optimizers for special cases of a
|
|
|
3078 function, leaving complicated cases alone.
|
|
|
3079
|
|
|
3080 For example, here is a simplified version of a definition that
|
|
|
3081 appears as a standard part of this package:
|
|
|
3082
|
|
|
3083 @example
|
|
|
3084 (define-compiler-macro member* (&whole form a list &rest keys)
|
|
|
3085 (if (and (null keys)
|
|
|
3086 (eq (car-safe a) 'quote)
|
|
|
3087 (not (floatp-safe (cadr a))))
|
|
|
3088 (list 'memq a list)
|
|
|
3089 form))
|
|
|
3090 @end example
|
|
|
3091
|
|
|
3092 @noindent
|
|
|
3093 This definition causes @code{(member* @var{a} @var{list})} to change
|
|
|
3094 to a call to the faster @code{memq} in the common case where @var{a}
|
|
|
3095 is a non-floating-point constant; if @var{a} is anything else, or
|
|
|
3096 if there are any keyword arguments in the call, then the original
|
|
|
3097 @code{member*} call is left intact. (The actual compiler macro
|
|
|
3098 for @code{member*} optimizes a number of other cases, including
|
|
|
3099 common @code{:test} predicates.)
|
|
|
3100 @end defspec
|
|
|
3101
|
|
|
3102 @defun compiler-macroexpand form
|
|
|
3103 This function is analogous to @code{macroexpand}, except that it
|
|
|
3104 expands compiler macros rather than regular macros. It returns
|
|
|
3105 @var{form} unchanged if it is not a call to a function for which
|
|
|
3106 a compiler macro has been defined, or if that compiler macro
|
|
|
3107 decided to punt by returning its @code{&whole} argument. Like
|
|
|
3108 @code{macroexpand}, it expands repeatedly until it reaches a form
|
|
|
3109 for which no further expansion is possible.
|
|
|
3110 @end defun
|
|
|
3111
|
|
|
3112 @xref{Macro Bindings}, for descriptions of the @code{macrolet}
|
|
|
3113 and @code{symbol-macrolet} forms for making ``local'' macro
|
|
|
3114 definitions.
|
|
|
3115
|
|
|
3116 @node Declarations, Symbols, Macros, Top
|
|
|
3117 @chapter Declarations
|
|
|
3118
|
|
|
3119 @noindent
|
|
|
3120 Common Lisp includes a complex and powerful ``declaration''
|
|
|
3121 mechanism that allows you to give the compiler special hints
|
|
|
3122 about the types of data that will be stored in particular variables,
|
|
|
3123 and about the ways those variables and functions will be used. This
|
|
|
3124 package defines versions of all the Common Lisp declaration forms:
|
|
|
3125 @code{declare}, @code{locally}, @code{proclaim}, @code{declaim},
|
|
|
3126 and @code{the}.
|
|
|
3127
|
|
|
3128 Most of the Common Lisp declarations are not currently useful in
|
|
|
3129 Emacs Lisp, as the byte-code system provides little opportunity
|
|
|
3130 to benefit from type information, and @code{special} declarations
|
|
|
3131 are redundant in a fully dynamically-scoped Lisp. A few
|
|
|
3132 declarations are meaningful when the optimizing Emacs 19 byte
|
|
|
3133 compiler is being used, however. Under the earlier non-optimizing
|
|
|
3134 compiler, these declarations will effectively be ignored.
|
|
|
3135
|
|
|
3136 @defun proclaim decl-spec
|
|
|
3137 This function records a ``global'' declaration specified by
|
|
|
3138 @var{decl-spec}. Since @code{proclaim} is a function, @var{decl-spec}
|
|
|
3139 is evaluated and thus should normally be quoted.
|
|
|
3140 @end defun
|
|
|
3141
|
|
|
3142 @defspec declaim decl-specs@dots{}
|
|
|
3143 This macro is like @code{proclaim}, except that it takes any number
|
|
|
3144 of @var{decl-spec} arguments, and the arguments are unevaluated and
|
|
|
3145 unquoted. The @code{declaim} macro also puts an @code{(eval-when
|
|
|
3146 (compile load eval) ...)} around the declarations so that they will
|
|
|
3147 be registered at compile-time as well as at run-time. (This is vital,
|
|
|
3148 since normally the declarations are meant to influence the way the
|
|
|
3149 compiler treats the rest of the file that contains the @code{declaim}
|
|
|
3150 form.)
|
|
|
3151 @end defspec
|
|
|
3152
|
|
|
3153 @defspec declare decl-specs@dots{}
|
|
|
3154 This macro is used to make declarations within functions and other
|
|
|
3155 code. Common Lisp allows declarations in various locations, generally
|
|
|
3156 at the beginning of any of the many ``implicit @code{progn}s''
|
|
|
3157 throughout Lisp syntax, such as function bodies, @code{let} bodies,
|
|
|
3158 etc. Currently the only declaration understood by @code{declare}
|
|
|
3159 is @code{special}.
|
|
|
3160 @end defspec
|
|
|
3161
|
|
|
3162 @defspec locally declarations@dots{} forms@dots{}
|
|
|
3163 In this package, @code{locally} is no different from @code{progn}.
|
|
|
3164 @end defspec
|
|
|
3165
|
|
|
3166 @defspec the type form
|
|
|
3167 Type information provided by @code{the} is ignored in this package;
|
|
|
3168 in other words, @code{(the @var{type} @var{form})} is equivalent
|
|
|
3169 to @var{form}. Future versions of the optimizing byte-compiler may
|
|
|
3170 make use of this information.
|
|
|
3171
|
|
|
3172 For example, @code{mapcar} can map over both lists and arrays. It is
|
|
|
3173 hard for the compiler to expand @code{mapcar} into an in-line loop
|
|
|
3174 unless it knows whether the sequence will be a list or an array ahead
|
|
|
3175 of time. With @code{(mapcar 'car (the vector foo))}, a future
|
|
|
3176 compiler would have enough information to expand the loop in-line.
|
|
|
3177 For now, Emacs Lisp will treat the above code as exactly equivalent
|
|
|
3178 to @code{(mapcar 'car foo)}.
|
|
|
3179 @end defspec
|
|
|
3180
|
|
|
3181 Each @var{decl-spec} in a @code{proclaim}, @code{declaim}, or
|
|
|
3182 @code{declare} should be a list beginning with a symbol that says
|
|
|
3183 what kind of declaration it is. This package currently understands
|
|
|
3184 @code{special}, @code{inline}, @code{notinline}, @code{optimize},
|
|
|
3185 and @code{warn} declarations. (The @code{warn} declaration is an
|
|
|
3186 extension of standard Common Lisp.) Other Common Lisp declarations,
|
|
|
3187 such as @code{type} and @code{ftype}, are silently ignored.
|
|
|
3188
|
|
|
3189 @table @code
|
|
|
3190 @item special
|
|
|
3191 Since all variables in Emacs Lisp are ``special'' (in the Common
|
|
|
3192 Lisp sense), @code{special} declarations are only advisory. They
|
|
|
3193 simply tell the optimizing byte compiler that the specified
|
|
|
3194 variables are intentionally being referred to without being
|
|
|
3195 bound in the body of the function. The compiler normally emits
|
|
|
3196 warnings for such references, since they could be typographical
|
|
|
3197 errors for references to local variables.
|
|
|
3198
|
|
|
3199 The declaration @code{(declare (special @var{var1} @var{var2}))} is
|
|
|
3200 equivalent to @code{(defvar @var{var1}) (defvar @var{var2})} in the
|
|
|
3201 optimizing compiler, or to nothing at all in older compilers (which
|
|
|
3202 do not warn for non-local references).
|
|
|
3203
|
|
|
3204 In top-level contexts, it is generally better to write
|
|
|
3205 @code{(defvar @var{var})} than @code{(declaim (special @var{var}))},
|
|
|
3206 since @code{defvar} makes your intentions clearer. But the older
|
|
|
3207 byte compilers can not handle @code{defvar}s appearing inside of
|
|
|
3208 functions, while @code{(declare (special @var{var}))} takes care
|
|
|
3209 to work correctly with all compilers.
|
|
|
3210
|
|
|
3211 @item inline
|
|
|
3212 The @code{inline} @var{decl-spec} lists one or more functions
|
|
|
3213 whose bodies should be expanded ``in-line'' into calling functions
|
|
|
3214 whenever the compiler is able to arrange for it. For example,
|
|
|
3215 the Common Lisp function @code{cadr} is declared @code{inline}
|
|
|
3216 by this package so that the form @code{(cadr @var{x})} will
|
|
|
3217 expand directly into @code{(car (cdr @var{x}))} when it is called
|
|
|
3218 in user functions, for a savings of one (relatively expensive)
|
|
|
3219 function call.
|
|
|
3220
|
|
|
3221 The following declarations are all equivalent. Note that the
|
|
|
3222 @code{defsubst} form is a convenient way to define a function
|
|
|
3223 and declare it inline all at once, but it is available only in
|
|
|
3224 Emacs 19.
|
|
|
3225
|
|
|
3226 @example
|
|
|
3227 (declaim (inline foo bar))
|
|
|
3228 (eval-when (compile load eval) (proclaim '(inline foo bar)))
|
|
|
3229 (proclaim-inline foo bar) ; Lucid Emacs only
|
|
|
3230 (defsubst foo (...) ...) ; instead of defun; Emacs 19 only
|
|
|
3231 @end example
|
|
|
3232
|
|
|
3233 @strong{Note:} This declaration remains in effect after the
|
|
|
3234 containing source file is done. It is correct to use it to
|
|
|
3235 request that a function you have defined should be inlined,
|
|
|
3236 but it is impolite to use it to request inlining of an external
|
|
|
3237 function.
|
|
|
3238
|
|
|
3239 In Common Lisp, it is possible to use @code{(declare (inline @dots{}))}
|
|
|
3240 before a particular call to a function to cause just that call to
|
|
|
3241 be inlined; the current byte compilers provide no way to implement
|
|
|
3242 this, so @code{(declare (inline @dots{}))} is currently ignored by
|
|
|
3243 this package.
|
|
|
3244
|
|
|
3245 @item notinline
|
|
|
3246 The @code{notinline} declaration lists functions which should
|
|
|
3247 not be inlined after all; it cancels a previous @code{inline}
|
|
|
3248 declaration.
|
|
|
3249
|
|
|
3250 @item optimize
|
|
|
3251 This declaration controls how much optimization is performed by
|
|
|
3252 the compiler. Naturally, it is ignored by the earlier non-optimizing
|
|
|
3253 compilers.
|
|
|
3254
|
|
|
3255 The word @code{optimize} is followed by any number of lists like
|
|
|
3256 @code{(speed 3)} or @code{(safety 2)}. Common Lisp defines several
|
|
|
3257 optimization ``qualities''; this package ignores all but @code{speed}
|
|
|
3258 and @code{safety}. The value of a quality should be an integer from
|
|
|
3259 0 to 3, with 0 meaning ``unimportant'' and 3 meaning ``very important.''
|
|
|
3260 The default level for both qualities is 1.
|
|
|
3261
|
|
|
3262 In this package, with the Emacs 19 optimizing compiler, the
|
|
|
3263 @code{speed} quality is tied to the @code{byte-compile-optimize}
|
|
|
3264 flag, which is set to @code{nil} for @code{(speed 0)} and to
|
|
|
3265 @code{t} for higher settings; and the @code{safety} quality is
|
|
|
3266 tied to the @code{byte-compile-delete-errors} flag, which is
|
|
|
3267 set to @code{t} for @code{(safety 3)} and to @code{nil} for all
|
|
|
3268 lower settings. (The latter flag controls whether the compiler
|
|
|
3269 is allowed to optimize out code whose only side-effect could
|
|
|
3270 be to signal an error, e.g., rewriting @code{(progn foo bar)} to
|
|
|
3271 @code{bar} when it is not known whether @code{foo} will be bound
|
|
|
3272 at run-time.)
|
|
|
3273
|
|
|
3274 Note that even compiling with @code{(safety 0)}, the Emacs
|
|
|
3275 byte-code system provides sufficient checking to prevent real
|
|
|
3276 harm from being done. For example, barring serious bugs in
|
|
|
3277 Emacs itself, Emacs will not crash with a segmentation fault
|
|
|
3278 just because of an error in a fully-optimized Lisp program.
|
|
|
3279
|
|
|
3280 The @code{optimize} declaration is normally used in a top-level
|
|
|
3281 @code{proclaim} or @code{declaim} in a file; Common Lisp allows
|
|
|
3282 it to be used with @code{declare} to set the level of optimization
|
|
|
3283 locally for a given form, but this will not work correctly with the
|
|
|
3284 current version of the optimizing compiler. (The @code{declare}
|
|
|
3285 will set the new optimization level, but that level will not
|
|
|
3286 automatically be unset after the enclosing form is done.)
|
|
|
3287
|
|
|
3288 @item warn
|
|
|
3289 This declaration controls what sorts of warnings are generated
|
|
|
3290 by the byte compiler. Again, only the optimizing compiler
|
|
|
3291 generates warnings. The word @code{warn} is followed by any
|
|
|
3292 number of ``warning qualities,'' similar in form to optimization
|
|
|
3293 qualities. The currently supported warning types are
|
|
|
3294 @code{redefine}, @code{callargs}, @code{unresolved}, and
|
|
|
3295 @code{free-vars}; in the current system, a value of 0 will
|
|
|
3296 disable these warnings and any higher value will enable them.
|
|
|
3297 See the documentation for the optimizing byte compiler for details.
|
|
|
3298 @end table
|
|
|
3299
|
|
|
3300 @node Symbols, Numbers, Declarations, Top
|
|
|
3301 @chapter Symbols
|
|
|
3302
|
|
|
3303 @noindent
|
|
|
3304 This package defines several symbol-related features that were
|
|
|
3305 missing from Emacs Lisp.
|
|
|
3306
|
|
|
3307 @menu
|
|
|
3308 * Property Lists:: `get*', `remprop', `getf', `remf'
|
|
|
3309 * Creating Symbols:: `gensym', `gentemp'
|
|
|
3310 @end menu
|
|
|
3311
|
|
|
3312 @node Property Lists, Creating Symbols, Symbols, Symbols
|
|
|
3313 @section Property Lists
|
|
|
3314
|
|
|
3315 @noindent
|
|
|
3316 These functions augment the standard Emacs Lisp functions @code{get}
|
|
|
3317 and @code{put} for operating on properties attached to symbols.
|
|
|
3318 There are also functions for working with property lists as
|
|
|
3319 first-class data structures not attached to particular symbols.
|
|
|
3320
|
|
|
3321 @defun get* symbol property &optional default
|
|
|
3322 This function is like @code{get}, except that if the property is
|
|
|
3323 not found, the @var{default} argument provides the return value.
|
|
|
3324 (The Emacs Lisp @code{get} function always uses @code{nil} as
|
|
|
3325 the default; this package's @code{get*} is equivalent to Common
|
|
|
3326 Lisp's @code{get}.)
|
|
|
3327
|
|
|
3328 The @code{get*} function is @code{setf}-able; when used in this
|
|
|
3329 fashion, the @var{default} argument is allowed but ignored.
|
|
|
3330 @end defun
|
|
|
3331
|
|
|
3332 @defun remprop symbol property
|
|
|
3333 This function removes the entry for @var{property} from the property
|
|
|
3334 list of @var{symbol}. It returns a true value if the property was
|
|
|
3335 indeed found and removed, or @code{nil} if there was no such property.
|
|
|
3336 (This function was probably omitted from Emacs originally because,
|
|
|
3337 since @code{get} did not allow a @var{default}, it was very difficult
|
|
|
3338 to distinguish between a missing property and a property whose value
|
|
|
3339 was @code{nil}; thus, setting a property to @code{nil} was close
|
|
|
3340 enough to @code{remprop} for most purposes.)
|
|
|
3341 @end defun
|
|
|
3342
|
|
|
3343 @defun getf place property &optional default
|
|
|
3344 This function scans the list @var{place} as if it were a property
|
|
|
3345 list, i.e., a list of alternating property names and values. If
|
|
|
3346 an even-numbered element of @var{place} is found which is @code{eq}
|
|
|
3347 to @var{property}, the following odd-numbered element is returned.
|
|
|
3348 Otherwise, @var{default} is returned (or @code{nil} if no default
|
|
|
3349 is given).
|
|
|
3350
|
|
|
3351 In particular,
|
|
|
3352
|
|
|
3353 @example
|
|
|
3354 (get sym prop) @equiv{} (getf (symbol-plist sym) prop)
|
|
|
3355 @end example
|
|
|
3356
|
|
|
3357 It is legal to use @code{getf} as a @code{setf} place, in which case
|
|
|
3358 its @var{place} argument must itself be a legal @code{setf} place.
|
|
|
3359 The @var{default} argument, if any, is ignored in this context.
|
|
|
3360 The effect is to change (via @code{setcar}) the value cell in the
|
|
|
3361 list that corresponds to @var{property}, or to cons a new property-value
|
|
|
3362 pair onto the list if the property is not yet present.
|
|
|
3363
|
|
|
3364 @example
|
|
|
3365 (put sym prop val) @equiv{} (setf (getf (symbol-plist sym) prop) val)
|
|
|
3366 @end example
|
|
|
3367
|
|
|
3368 The @code{get} and @code{get*} functions are also @code{setf}-able.
|
|
|
3369 The fact that @code{default} is ignored can sometimes be useful:
|
|
|
3370
|
|
|
3371 @example
|
|
|
3372 (incf (get* 'foo 'usage-count 0))
|
|
|
3373 @end example
|
|
|
3374
|
|
|
3375 Here, symbol @code{foo}'s @code{usage-count} property is incremented
|
|
|
3376 if it exists, or set to 1 (an incremented 0) otherwise.
|
|
|
3377
|
|
|
3378 When not used as a @code{setf} form, @code{getf} is just a regular
|
|
|
3379 function and its @var{place} argument can actually be any Lisp
|
|
|
3380 expression.
|
|
|
3381 @end defun
|
|
|
3382
|
|
|
3383 @defspec remf place property
|
|
|
3384 This macro removes the property-value pair for @var{property} from
|
|
|
3385 the property list stored at @var{place}, which is any @code{setf}-able
|
|
|
3386 place expression. It returns true if the property was found. Note
|
|
|
3387 that if @var{property} happens to be first on the list, this will
|
|
|
3388 effectively do a @code{(setf @var{place} (cddr @var{place}))},
|
|
|
3389 whereas if it occurs later, this simply uses @code{setcdr} to splice
|
|
|
3390 out the property and value cells.
|
|
|
3391 @end defspec
|
|
|
3392
|
|
|
3393 @iftex
|
|
|
3394 @secno=2
|
|
|
3395 @end iftex
|
|
|
3396
|
|
|
3397 @node Creating Symbols, , Property Lists, Symbols
|
|
|
3398 @section Creating Symbols
|
|
|
3399
|
|
|
3400 @noindent
|
|
|
3401 These functions create unique symbols, typically for use as
|
|
|
3402 temporary variables.
|
|
|
3403
|
|
|
3404 @defun gensym &optional x
|
|
|
3405 This function creates a new, uninterned symbol (using @code{make-symbol})
|
|
|
3406 with a unique name. (The name of an uninterned symbol is relevant
|
|
|
3407 only if the symbol is printed.) By default, the name is generated
|
|
|
3408 from an increasing sequence of numbers, @samp{G1000}, @samp{G1001},
|
|
|
3409 @samp{G1002}, etc. If the optional argument @var{x} is a string, that
|
|
|
3410 string is used as a prefix instead of @samp{G}. Uninterned symbols
|
|
|
3411 are used in macro expansions for temporary variables, to ensure that
|
|
|
3412 their names will not conflict with ``real'' variables in the user's
|
|
|
3413 code.
|
|
|
3414 @end defun
|
|
|
3415
|
|
|
3416 @defvar *gensym-counter*
|
|
|
3417 This variable holds the counter used to generate @code{gensym} names.
|
|
|
3418 It is incremented after each use by @code{gensym}. In Common Lisp
|
|
|
3419 this is initialized with 0, but this package initializes it with a
|
|
|
3420 random (time-dependent) value to avoid trouble when two files that
|
|
|
3421 each used @code{gensym} in their compilation are loaded together.
|
|
|
3422 (Uninterned symbols become interned when the compiler writes them
|
|
|
3423 out to a file and the Emacs loader loads them, so their names have to
|
|
|
3424 be treated a bit more carefully than in Common Lisp where uninterned
|
|
|
3425 symbols remain uninterned after loading.)
|
|
|
3426 @end defvar
|
|
|
3427
|
|
|
3428 @defun gentemp &optional x
|
|
|
3429 This function is like @code{gensym}, except that it produces a new
|
|
|
3430 @emph{interned} symbol. If the symbol that is generated already
|
|
|
3431 exists, the function keeps incrementing the counter and trying
|
|
|
3432 again until a new symbol is generated.
|
|
|
3433 @end defun
|
|
|
3434
|
|
|
3435 The Quiroz @file{cl.el} package also defined a @code{defkeyword}
|
|
|
3436 form for creating self-quoting keyword symbols. This package
|
|
|
3437 automatically creates all keywords that are called for by
|
|
|
3438 @code{&key} argument specifiers, and discourages the use of
|
|
|
3439 keywords as data unrelated to keyword arguments, so the
|
|
|
3440 @code{defkeyword} form has been discontinued.
|
|
|
3441
|
|
|
3442 @iftex
|
|
|
3443 @chapno=11
|
|
|
3444 @end iftex
|
|
|
3445
|
|
|
3446 @node Numbers, Sequences, Symbols, Top
|
|
|
3447 @chapter Numbers
|
|
|
3448
|
|
|
3449 @noindent
|
|
|
3450 This section defines a few simple Common Lisp operations on numbers
|
|
|
3451 which were left out of Emacs Lisp.
|
|
|
3452
|
|
|
3453 @menu
|
|
|
3454 * Predicates on Numbers:: `plusp', `oddp', `floatp-safe', etc.
|
|
|
3455 * Numerical Functions:: `abs', `expt', `floor*', etc.
|
|
|
3456 * Random Numbers:: `random*', `make-random-state'
|
|
|
3457 * Implementation Parameters:: `most-positive-fixnum', `most-positive-float'
|
|
|
3458 @end menu
|
|
|
3459
|
|
|
3460 @iftex
|
|
|
3461 @secno=1
|
|
|
3462 @end iftex
|
|
|
3463
|
|
|
3464 @node Predicates on Numbers, Numerical Functions, Numbers, Numbers
|
|
|
3465 @section Predicates on Numbers
|
|
|
3466
|
|
|
3467 @noindent
|
|
|
3468 These functions return @code{t} if the specified condition is
|
|
|
3469 true of the numerical argument, or @code{nil} otherwise.
|
|
|
3470
|
|
|
3471 @defun plusp number
|
|
|
3472 This predicate tests whether @var{number} is positive. It is an
|
|
|
3473 error if the argument is not a number.
|
|
|
3474 @end defun
|
|
|
3475
|
|
|
3476 @defun minusp number
|
|
|
3477 This predicate tests whether @var{number} is negative. It is an
|
|
|
3478 error if the argument is not a number.
|
|
|
3479 @end defun
|
|
|
3480
|
|
|
3481 @defun oddp integer
|
|
|
3482 This predicate tests whether @var{integer} is odd. It is an
|
|
|
3483 error if the argument is not an integer.
|
|
|
3484 @end defun
|
|
|
3485
|
|
|
3486 @defun evenp integer
|
|
|
3487 This predicate tests whether @var{integer} is even. It is an
|
|
|
3488 error if the argument is not an integer.
|
|
|
3489 @end defun
|
|
|
3490
|
|
|
3491 @defun floatp-safe object
|
|
|
3492 This predicate tests whether @var{object} is a floating-point
|
|
|
3493 number. On systems that support floating-point, this is equivalent
|
|
|
3494 to @code{floatp}. On other systems, this always returns @code{nil}.
|
|
|
3495 @end defun
|
|
|
3496
|
|
|
3497 @iftex
|
|
|
3498 @secno=3
|
|
|
3499 @end iftex
|
|
|
3500
|
|
|
3501 @node Numerical Functions, Random Numbers, Predicates on Numbers, Numbers
|
|
|
3502 @section Numerical Functions
|
|
|
3503
|
|
|
3504 @noindent
|
|
|
3505 These functions perform various arithmetic operations on numbers.
|
|
|
3506
|
|
|
3507 @defun abs number
|
|
|
3508 This function returns the absolute value of @var{number}. (Newer
|
|
|
3509 versions of Emacs provide this as a built-in function; this package
|
|
|
3510 defines @code{abs} only for Emacs 18 versions which don't provide
|
|
|
3511 it as a primitive.)
|
|
|
3512 @end defun
|
|
|
3513
|
|
|
3514 @defun expt base power
|
|
|
3515 This function returns @var{base} raised to the power of @var{number}.
|
|
|
3516 (Newer versions of Emacs provide this as a built-in function; this
|
|
|
3517 package defines @code{expt} only for Emacs 18 versions which don't
|
|
|
3518 provide it as a primitive.)
|
|
|
3519 @end defun
|
|
|
3520
|
|
|
3521 @defun gcd &rest integers
|
|
|
3522 This function returns the Greatest Common Divisor of the arguments.
|
|
|
3523 For one argument, it returns the absolute value of that argument.
|
|
|
3524 For zero arguments, it returns zero.
|
|
|
3525 @end defun
|
|
|
3526
|
|
|
3527 @defun lcm &rest integers
|
|
|
3528 This function returns the Least Common Multiple of the arguments.
|
|
|
3529 For one argument, it returns the absolute value of that argument.
|
|
|
3530 For zero arguments, it returns one.
|
|
|
3531 @end defun
|
|
|
3532
|
|
|
3533 @defun isqrt integer
|
|
|
3534 This function computes the ``integer square root'' of its integer
|
|
|
3535 argument, i.e., the greatest integer less than or equal to the true
|
|
|
3536 square root of the argument.
|
|
|
3537 @end defun
|
|
|
3538
|
|
|
3539 @defun floor* number &optional divisor
|
|
|
3540 This function implements the Common Lisp @code{floor} function.
|
|
|
3541 It is called @code{floor*} to avoid name conflicts with the
|
|
|
3542 simpler @code{floor} function built-in to Emacs 19.
|
|
|
3543
|
|
|
3544 With one argument, @code{floor*} returns a list of two numbers:
|
|
|
3545 The argument rounded down (toward minus infinity) to an integer,
|
|
|
3546 and the ``remainder'' which would have to be added back to the
|
|
|
3547 first return value to yield the argument again. If the argument
|
|
|
3548 is an integer @var{x}, the result is always the list @code{(@var{x} 0)}.
|
|
|
3549 If the argument is an Emacs 19 floating-point number, the first
|
|
|
3550 result is a Lisp integer and the second is a Lisp float between
|
|
|
3551 0 (inclusive) and 1 (exclusive).
|
|
|
3552
|
|
|
3553 With two arguments, @code{floor*} divides @var{number} by
|
|
|
3554 @var{divisor}, and returns the floor of the quotient and the
|
|
|
3555 corresponding remainder as a list of two numbers. If
|
|
|
3556 @code{(floor* @var{x} @var{y})} returns @code{(@var{q} @var{r})},
|
|
|
3557 then @code{@var{q}*@var{y} + @var{r} = @var{x}}, with @var{r}
|
|
|
3558 between 0 (inclusive) and @var{r} (exclusive). Also, note
|
|
|
3559 that @code{(floor* @var{x})} is exactly equivalent to
|
|
|
3560 @code{(floor* @var{x} 1)}.
|
|
|
3561
|
|
|
3562 This function is entirely compatible with Common Lisp's @code{floor}
|
|
|
3563 function, except that it returns the two results in a list since
|
|
|
3564 Emacs Lisp does not support multiple-valued functions.
|
|
|
3565 @end defun
|
|
|
3566
|
|
|
3567 @defun ceiling* number &optional divisor
|
|
|
3568 This function implements the Common Lisp @code{ceiling} function,
|
|
|
3569 which is analogous to @code{floor} except that it rounds the
|
|
|
3570 argument or quotient of the arguments up toward plus infinity.
|
|
|
3571 The remainder will be between 0 and minus @var{r}.
|
|
|
3572 @end defun
|
|
|
3573
|
|
|
3574 @defun truncate* number &optional divisor
|
|
|
3575 This function implements the Common Lisp @code{truncate} function,
|
|
|
3576 which is analogous to @code{floor} except that it rounds the
|
|
|
3577 argument or quotient of the arguments toward zero. Thus it is
|
|
|
3578 equivalent to @code{floor*} if the argument or quotient is
|
|
|
3579 positive, or to @code{ceiling*} otherwise. The remainder has
|
|
|
3580 the same sign as @var{number}.
|
|
|
3581 @end defun
|
|
|
3582
|
|
|
3583 @defun round* number &optional divisor
|
|
|
3584 This function implements the Common Lisp @code{round} function,
|
|
|
3585 which is analogous to @code{floor} except that it rounds the
|
|
|
3586 argument or quotient of the arguments to the nearest integer.
|
|
|
3587 In the case of a tie (the argument or quotient is exactly
|
|
|
3588 halfway between two integers), it rounds to the even integer.
|
|
|
3589 @end defun
|
|
|
3590
|
|
|
3591 @defun mod* number divisor
|
|
|
3592 This function returns the same value as the second return value
|
|
|
3593 of @code{floor}.
|
|
|
3594 @end defun
|
|
|
3595
|
|
|
3596 @defun rem* number divisor
|
|
|
3597 This function returns the same value as the second return value
|
|
|
3598 of @code{truncate}.
|
|
|
3599 @end defun
|
|
|
3600
|
|
|
3601 These definitions are compatible with those in the Quiroz
|
|
|
3602 @file{cl.el} package, except that this package appends @samp{*}
|
|
|
3603 to certain function names to avoid conflicts with existing
|
|
|
3604 Emacs 19 functions, and that the mechanism for returning
|
|
|
3605 multiple values is different.
|
|
|
3606
|
|
|
3607 @iftex
|
|
|
3608 @secno=8
|
|
|
3609 @end iftex
|
|
|
3610
|
|
|
3611 @node Random Numbers, Implementation Parameters, Numerical Functions, Numbers
|
|
|
3612 @section Random Numbers
|
|
|
3613
|
|
|
3614 @noindent
|
|
|
3615 This package also provides an implementation of the Common Lisp
|
|
|
3616 random number generator. It uses its own additive-congruential
|
|
|
3617 algorithm, which is much more likely to give statistically clean
|
|
|
3618 random numbers than the simple generators supplied by many
|
|
|
3619 operating systems.
|
|
|
3620
|
|
|
3621 @defun random* number &optional state
|
|
|
3622 This function returns a random nonnegative number less than
|
|
|
3623 @var{number}, and of the same type (either integer or floating-point).
|
|
|
3624 The @var{state} argument should be a @code{random-state} object
|
|
|
3625 which holds the state of the random number generator. The
|
|
|
3626 function modifies this state object as a side effect. If
|
|
|
3627 @var{state} is omitted, it defaults to the variable
|
|
|
3628 @code{*random-state*}, which contains a pre-initialized
|
|
|
3629 @code{random-state} object.
|
|
|
3630 @end defun
|
|
|
3631
|
|
|
3632 @defvar *random-state*
|
|
|
3633 This variable contains the system ``default'' @code{random-state}
|
|
|
3634 object, used for calls to @code{random*} that do not specify an
|
|
|
3635 alternative state object. Since any number of programs in the
|
|
|
3636 Emacs process may be accessing @code{*random-state*} in interleaved
|
|
|
3637 fashion, the sequence generated from this variable will be
|
|
|
3638 irreproducible for all intents and purposes.
|
|
|
3639 @end defvar
|
|
|
3640
|
|
|
3641 @defun make-random-state &optional state
|
|
|
3642 This function creates or copies a @code{random-state} object.
|
|
|
3643 If @var{state} is omitted or @code{nil}, it returns a new copy of
|
|
|
3644 @code{*random-state*}. This is a copy in the sense that future
|
|
|
3645 sequences of calls to @code{(random* @var{n})} and
|
|
|
3646 @code{(random* @var{n} @var{s})} (where @var{s} is the new
|
|
|
3647 random-state object) will return identical sequences of random
|
|
|
3648 numbers.
|
|
|
3649
|
|
|
3650 If @var{state} is a @code{random-state} object, this function
|
|
|
3651 returns a copy of that object. If @var{state} is @code{t}, this
|
|
|
3652 function returns a new @code{random-state} object seeded from the
|
|
|
3653 date and time. As an extension to Common Lisp, @var{state} may also
|
|
|
3654 be an integer in which case the new object is seeded from that
|
|
|
3655 integer; each different integer seed will result in a completely
|
|
|
3656 different sequence of random numbers.
|
|
|
3657
|
|
|
3658 It is legal to print a @code{random-state} object to a buffer or
|
|
|
3659 file and later read it back with @code{read}. If a program wishes
|
|
|
3660 to use a sequence of pseudo-random numbers which can be reproduced
|
|
|
3661 later for debugging, it can call @code{(make-random-state t)} to
|
|
|
3662 get a new sequence, then print this sequence to a file. When the
|
|
|
3663 program is later rerun, it can read the original run's random-state
|
|
|
3664 from the file.
|
|
|
3665 @end defun
|
|
|
3666
|
|
|
3667 @defun random-state-p object
|
|
|
3668 This predicate returns @code{t} if @var{object} is a
|
|
|
3669 @code{random-state} object, or @code{nil} otherwise.
|
|
|
3670 @end defun
|
|
|
3671
|
|
|
3672 @node Implementation Parameters, , Random Numbers, Numbers
|
|
|
3673 @section Implementation Parameters
|
|
|
3674
|
|
|
3675 @noindent
|
|
|
3676 This package defines several useful constants having to with numbers.
|
|
|
3677
|
|
|
3678 @defvar most-positive-fixnum
|
|
|
3679 This constant equals the largest value a Lisp integer can hold.
|
|
|
3680 It is typically @code{2^23-1} or @code{2^25-1}.
|
|
|
3681 @end defvar
|
|
|
3682
|
|
|
3683 @defvar most-negative-fixnum
|
|
|
3684 This constant equals the smallest (most negative) value a Lisp
|
|
|
3685 integer can hold.
|
|
|
3686 @end defvar
|
|
|
3687
|
|
|
3688 The following parameters have to do with floating-point numbers.
|
|
|
3689 This package determines their values by exercising the computer's
|
|
|
3690 floating-point arithmetic in various ways. Because this operation
|
|
|
3691 might be slow, the code for initializing them is kept in a separate
|
|
|
3692 function that must be called before the parameters can be used.
|
|
|
3693
|
|
|
3694 @defun cl-float-limits
|
|
|
3695 This function makes sure that the Common Lisp floating-point
|
|
|
3696 parameters like @code{most-positive-float} have been initialized.
|
|
|
3697 Until it is called, these parameters will be @code{nil}. If this
|
|
|
3698 version of Emacs does not support floats (e.g., most versions of
|
|
|
3699 Emacs 18), the parameters will remain @code{nil}. If the parameters
|
|
|
3700 have already been initialized, the function returns immediately.
|
|
|
3701
|
|
|
3702 The algorithm makes assumptions that will be valid for most modern
|
|
|
3703 machines, but will fail if the machine's arithmetic is extremely
|
|
|
3704 unusual, e.g., decimal.
|
|
|
3705 @end defun
|
|
|
3706
|
|
|
3707 Since true Common Lisp supports up to four different floating-point
|
|
|
3708 precisions, it has families of constants like
|
|
|
3709 @code{most-positive-single-float}, @code{most-positive-double-float},
|
|
|
3710 @code{most-positive-long-float}, and so on. Emacs has only one
|
|
|
3711 floating-point precision, so this package omits the precision word
|
|
|
3712 from the constants' names.
|
|
|
3713
|
|
|
3714 @defvar most-positive-float
|
|
|
3715 This constant equals the largest value a Lisp float can hold.
|
|
|
3716 For those systems whose arithmetic supports infinities, this is
|
|
|
3717 the largest @emph{finite} value. For IEEE machines, the value
|
|
|
3718 is approximately @code{1.79e+308}.
|
|
|
3719 @end defvar
|
|
|
3720
|
|
|
3721 @defvar most-negative-float
|
|
|
3722 This constant equals the most-negative value a Lisp float can hold.
|
|
|
3723 (It is assumed to be equal to @code{(- most-positive-float)}.)
|
|
|
3724 @end defvar
|
|
|
3725
|
|
|
3726 @defvar least-positive-float
|
|
|
3727 This constant equals the smallest Lisp float value greater than zero.
|
|
|
3728 For IEEE machines, it is about @code{4.94e-324} if denormals are
|
|
|
3729 supported or @code{2.22e-308} if not.
|
|
|
3730 @end defvar
|
|
|
3731
|
|
|
3732 @defvar least-positive-normalized-float
|
|
|
3733 This constant equals the smallest @emph{normalized} Lisp float greater
|
|
|
3734 than zero, i.e., the smallest value for which IEEE denormalization
|
|
|
3735 will not result in a loss of precision. For IEEE machines, this
|
|
|
3736 value is about @code{2.22e-308}. For machines that do not support
|
|
|
3737 the concept of denormalization and gradual underflow, this constant
|
|
|
3738 will always equal @code{least-positive-float}.
|
|
|
3739 @end defvar
|
|
|
3740
|
|
|
3741 @defvar least-negative-float
|
|
|
3742 This constant is the negative counterpart of @code{least-positive-float}.
|
|
|
3743 @end defvar
|
|
|
3744
|
|
|
3745 @defvar least-negative-normalized-float
|
|
|
3746 This constant is the negative counterpart of
|
|
|
3747 @code{least-positive-normalized-float}.
|
|
|
3748 @end defvar
|
|
|
3749
|
|
|
3750 @defvar float-epsilon
|
|
|
3751 This constant is the smallest positive Lisp float that can be added
|
|
|
3752 to 1.0 to produce a distinct value. Adding a smaller number to 1.0
|
|
|
3753 will yield 1.0 again due to roundoff. For IEEE machines, epsilon
|
|
|
3754 is about @code{2.22e-16}.
|
|
|
3755 @end defvar
|
|
|
3756
|
|
|
3757 @defvar float-negative-epsilon
|
|
|
3758 This is the smallest positive value that can be subtracted from
|
|
|
3759 1.0 to produce a distinct value. For IEEE machines, it is about
|
|
|
3760 @code{1.11e-16}.
|
|
|
3761 @end defvar
|
|
|
3762
|
|
|
3763 @iftex
|
|
|
3764 @chapno=13
|
|
|
3765 @end iftex
|
|
|
3766
|
|
|
3767 @node Sequences, Lists, Numbers, Top
|
|
|
3768 @chapter Sequences
|
|
|
3769
|
|
|
3770 @noindent
|
|
|
3771 Common Lisp defines a number of functions that operate on
|
|
|
3772 @dfn{sequences}, which are either lists, strings, or vectors.
|
|
|
3773 Emacs Lisp includes a few of these, notably @code{elt} and
|
|
|
3774 @code{length}; this package defines most of the rest.
|
|
|
3775
|
|
|
3776 @menu
|
|
|
3777 * Sequence Basics:: Arguments shared by all sequence functions
|
|
|
3778 * Mapping over Sequences:: `mapcar*', `mapcan', `map', `every', etc.
|
|
|
3779 * Sequence Functions:: `subseq', `remove*', `substitute', etc.
|
|
|
3780 * Searching Sequences:: `find', `position', `count', `search', etc.
|
|
|
3781 * Sorting Sequences:: `sort*', `stable-sort', `merge'
|
|
|
3782 @end menu
|
|
|
3783
|
|
|
3784 @node Sequence Basics, Mapping over Sequences, Sequences, Sequences
|
|
|
3785 @section Sequence Basics
|
|
|
3786
|
|
|
3787 @noindent
|
|
|
3788 Many of the sequence functions take keyword arguments; @pxref{Argument
|
|
|
3789 Lists}. All keyword arguments are optional and, if specified,
|
|
|
3790 may appear in any order.
|
|
|
3791
|
|
|
3792 The @code{:key} argument should be passed either @code{nil}, or a
|
|
|
3793 function of one argument. This key function is used as a filter
|
|
|
3794 through which the elements of the sequence are seen; for example,
|
|
|
3795 @code{(find x y :key 'car)} is similar to @code{(assoc* x y)}:
|
|
|
3796 It searches for an element of the list whose @code{car} equals
|
|
|
3797 @code{x}, rather than for an element which equals @code{x} itself.
|
|
|
3798 If @code{:key} is omitted or @code{nil}, the filter is effectively
|
|
|
3799 the identity function.
|
|
|
3800
|
|
|
3801 The @code{:test} and @code{:test-not} arguments should be either
|
|
|
3802 @code{nil}, or functions of two arguments. The test function is
|
|
|
3803 used to compare two sequence elements, or to compare a search value
|
|
|
3804 with sequence elements. (The two values are passed to the test
|
|
|
3805 function in the same order as the original sequence function
|
|
|
3806 arguments from which they are derived, or, if they both come from
|
|
|
3807 the same sequence, in the same order as they appear in that sequence.)
|
|
|
3808 The @code{:test} argument specifies a function which must return
|
|
|
3809 true (non-@code{nil}) to indicate a match; instead, you may use
|
|
|
3810 @code{:test-not} to give a function which returns @emph{false} to
|
|
|
3811 indicate a match. The default test function is @code{:test 'eql}.
|
|
|
3812
|
|
|
3813 Many functions which take @var{item} and @code{:test} or @code{:test-not}
|
|
|
3814 arguments also come in @code{-if} and @code{-if-not} varieties,
|
|
|
3815 where a @var{predicate} function is passed instead of @var{item},
|
|
|
3816 and sequence elements match if the predicate returns true on them
|
|
|
3817 (or false in the case of @code{-if-not}). For example:
|
|
|
3818
|
|
|
3819 @example
|
|
|
3820 (remove* 0 seq :test '=) @equiv{} (remove-if 'zerop seq)
|
|
|
3821 @end example
|
|
|
3822
|
|
|
3823 @noindent
|
|
|
3824 to remove all zeros from sequence @code{seq}.
|
|
|
3825
|
|
|
3826 Some operations can work on a subsequence of the argument sequence;
|
|
|
3827 these function take @code{:start} and @code{:end} arguments which
|
|
|
3828 default to zero and the length of the sequence, respectively.
|
|
|
3829 Only elements between @var{start} (inclusive) and @var{end}
|
|
|
3830 (exclusive) are affected by the operation. The @var{end} argument
|
|
|
3831 may be passed @code{nil} to signify the length of the sequence;
|
|
|
3832 otherwise, both @var{start} and @var{end} must be integers, with
|
|
|
3833 @code{0 <= @var{start} <= @var{end} <= (length @var{seq})}.
|
|
|
3834 If the function takes two sequence arguments, the limits are
|
|
|
3835 defined by keywords @code{:start1} and @code{:end1} for the first,
|
|
|
3836 and @code{:start2} and @code{:end2} for the second.
|
|
|
3837
|
|
|
3838 A few functions accept a @code{:from-end} argument, which, if
|
|
|
3839 non-@code{nil}, causes the operation to go from right-to-left
|
|
|
3840 through the sequence instead of left-to-right, and a @code{:count}
|
|
|
3841 argument, which specifies an integer maximum number of elements
|
|
|
3842 to be removed or otherwise processed.
|
|
|
3843
|
|
|
3844 The sequence functions make no guarantees about the order in
|
|
|
3845 which the @code{:test}, @code{:test-not}, and @code{:key} functions
|
|
|
3846 are called on various elements. Therefore, it is a bad idea to depend
|
|
|
3847 on side effects of these functions. For example, @code{:from-end}
|
|
|
3848 may cause the sequence to be scanned actually in reverse, or it may
|
|
|
3849 be scanned forwards but computing a result ``as if'' it were scanned
|
|
|
3850 backwards. (Some functions, like @code{mapcar*} and @code{every},
|
|
|
3851 @emph{do} specify exactly the order in which the function is called
|
|
|
3852 so side effects are perfectly acceptable in those cases.)
|
|
|
3853
|
|
|
3854 Strings in GNU Emacs 19 may contain ``text properties'' as well
|
|
|
3855 as character data. Except as noted, it is undefined whether or
|
|
|
3856 not text properties are preserved by sequence functions. For
|
|
|
3857 example, @code{(remove* ?A @var{str})} may or may not preserve
|
|
|
3858 the properties of the characters copied from @var{str} into the
|
|
|
3859 result.
|
|
|
3860
|
|
|
3861 @node Mapping over Sequences, Sequence Functions, Sequence Basics, Sequences
|
|
|
3862 @section Mapping over Sequences
|
|
|
3863
|
|
|
3864 @noindent
|
|
|
3865 These functions ``map'' the function you specify over the elements
|
|
|
3866 of lists or arrays. They are all variations on the theme of the
|
|
|
3867 built-in function @code{mapcar}.
|
|
|
3868
|
|
|
3869 @defun mapcar* function seq &rest more-seqs
|
|
|
3870 This function calls @var{function} on successive parallel sets of
|
|
|
3871 elements from its argument sequences. Given a single @var{seq}
|
|
|
3872 argument it is equivalent to @code{mapcar}; given @var{n} sequences,
|
|
|
3873 it calls the function with the first elements of each of the sequences
|
|
|
3874 as the @var{n} arguments to yield the first element of the result
|
|
|
3875 list, then with the second elements, and so on. The mapping stops as
|
|
|
3876 soon as the shortest sequence runs out. The argument sequences may
|
|
|
3877 be any mixture of lists, strings, and vectors; the return sequence
|
|
|
3878 is always a list.
|
|
|
3879
|
|
|
3880 Common Lisp's @code{mapcar} accepts multiple arguments but works
|
|
|
3881 only on lists; Emacs Lisp's @code{mapcar} accepts a single sequence
|
|
|
3882 argument. This package's @code{mapcar*} works as a compatible
|
|
|
3883 superset of both.
|
|
|
3884 @end defun
|
|
|
3885
|
|
|
3886 @defun map result-type function seq &rest more-seqs
|
|
|
3887 This function maps @var{function} over the argument sequences,
|
|
|
3888 just like @code{mapcar*}, but it returns a sequence of type
|
|
|
3889 @var{result-type} rather than a list. @var{result-type} must
|
|
|
3890 be one of the following symbols: @code{vector}, @code{string},
|
|
|
3891 @code{list} (in which case the effect is the same as for
|
|
|
3892 @code{mapcar*}), or @code{nil} (in which case the results are
|
|
|
3893 thrown away and @code{map} returns @code{nil}).
|
|
|
3894 @end defun
|
|
|
3895
|
|
|
3896 @defun maplist function list &rest more-lists
|
|
|
3897 This function calls @var{function} on each of its argument lists,
|
|
|
3898 then on the @code{cdr}s of those lists, and so on, until the
|
|
|
3899 shortest list runs out. The results are returned in the form
|
|
|
3900 of a list. Thus, @code{maplist} is like @code{mapcar*} except
|
|
|
3901 that it passes in the list pointers themselves rather than the
|
|
|
3902 @code{car}s of the advancing pointers.
|
|
|
3903 @end defun
|
|
|
3904
|
|
|
3905 @defun mapc function seq &rest more-seqs
|
|
|
3906 This function is like @code{mapcar*}, except that the values
|
|
|
3907 returned by @var{function} are ignored and thrown away rather
|
|
|
3908 than being collected into a list. The return value of @code{mapc}
|
|
|
3909 is @var{seq}, the first sequence.
|
|
|
3910 @end defun
|
|
|
3911
|
|
|
3912 @defun mapl function list &rest more-lists
|
|
|
3913 This function is like @code{maplist}, except that it throws away
|
|
|
3914 the values returned by @var{function}.
|
|
|
3915 @end defun
|
|
|
3916
|
|
|
3917 @defun mapcan function seq &rest more-seqs
|
|
|
3918 This function is like @code{mapcar*}, except that it concatenates
|
|
|
3919 the return values (which must be lists) using @code{nconc},
|
|
|
3920 rather than simply collecting them into a list.
|
|
|
3921 @end defun
|
|
|
3922
|
|
|
3923 @defun mapcon function list &rest more-lists
|
|
|
3924 This function is like @code{maplist}, except that it concatenates
|
|
|
3925 the return values using @code{nconc}.
|
|
|
3926 @end defun
|
|
|
3927
|
|
|
3928 @defun some predicate seq &rest more-seqs
|
|
|
3929 This function calls @var{predicate} on each element of @var{seq}
|
|
|
3930 in turn; if @var{predicate} returns a non-@code{nil} value,
|
|
|
3931 @code{some} returns that value, otherwise it returns @code{nil}.
|
|
|
3932 Given several sequence arguments, it steps through the sequences
|
|
|
3933 in parallel until the shortest one runs out, just as in
|
|
|
3934 @code{mapcar*}. You can rely on the left-to-right order in which
|
|
|
3935 the elements are visited, and on the fact that mapping stops
|
|
|
3936 immediately as soon as @var{predicate} returns non-@code{nil}.
|
|
|
3937 @end defun
|
|
|
3938
|
|
|
3939 @defun every predicate seq &rest more-seqs
|
|
|
3940 This function calls @var{predicate} on each element of the sequence(s)
|
|
|
3941 in turn; it returns @code{nil} as soon as @var{predicate} returns
|
|
|
3942 @code{nil} for any element, or @code{t} if the predicate was true
|
|
|
3943 for all elements.
|
|
|
3944 @end defun
|
|
|
3945
|
|
|
3946 @defun notany predicate seq &rest more-seqs
|
|
|
3947 This function calls @var{predicate} on each element of the sequence(s)
|
|
|
3948 in turn; it returns @code{nil} as soon as @var{predicate} returns
|
|
|
3949 a non-@code{nil} value for any element, or @code{t} if the predicate
|
|
|
3950 was @code{nil} for all elements.
|
|
|
3951 @end defun
|
|
|
3952
|
|
|
3953 @defun notevery predicate seq &rest more-seqs
|
|
|
3954 This function calls @var{predicate} on each element of the sequence(s)
|
|
|
3955 in turn; it returns a non-@code{nil} value as soon as @var{predicate}
|
|
|
3956 returns @code{nil} for any element, or @code{t} if the predicate was
|
|
|
3957 true for all elements.
|
|
|
3958 @end defun
|
|
|
3959
|
|
|
3960 @defun reduce function seq @t{&key :from-end :start :end :initial-value :key}
|
|
|
3961 This function combines the elements of @var{seq} using an associative
|
|
|
3962 binary operation. Suppose @var{function} is @code{*} and @var{seq} is
|
|
|
3963 the list @code{(2 3 4 5)}. The first two elements of the list are
|
|
|
3964 combined with @code{(* 2 3) = 6}; this is combined with the next
|
|
|
3965 element, @code{(* 6 4) = 24}, and that is combined with the final
|
|
|
3966 element: @code{(* 24 5) = 120}. Note that the @code{*} function happens
|
|
|
3967 to be self-reducing, so that @code{(* 2 3 4 5)} has the same effect as
|
|
|
3968 an explicit call to @code{reduce}.
|
|
|
3969
|
|
|
3970 If @code{:from-end} is true, the reduction is right-associative instead
|
|
|
3971 of left-associative:
|
|
|
3972
|
|
|
3973 @example
|
|
|
3974 (reduce '- '(1 2 3 4))
|
|
|
3975 @equiv{} (- (- (- 1 2) 3) 4) @result{} -8
|
|
|
3976 (reduce '- '(1 2 3 4) :from-end t)
|
|
|
3977 @equiv{} (- 1 (- 2 (- 3 4))) @result{} -2
|
|
|
3978 @end example
|
|
|
3979
|
|
|
3980 If @code{:key} is specified, it is a function of one argument which
|
|
|
3981 is called on each of the sequence elements in turn.
|
|
|
3982
|
|
|
3983 If @code{:initial-value} is specified, it is effectively added to the
|
|
|
3984 front (or rear in the case of @code{:from-end}) of the sequence.
|
|
|
3985 The @code{:key} function is @emph{not} applied to the initial value.
|
|
|
3986
|
|
|
3987 If the sequence, including the initial value, has exactly one element
|
|
|
3988 then that element is returned without ever calling @var{function}.
|
|
|
3989 If the sequence is empty (and there is no initial value), then
|
|
|
3990 @var{function} is called with no arguments to obtain the return value.
|
|
|
3991 @end defun
|
|
|
3992
|
|
|
3993 All of these mapping operations can be expressed conveniently in
|
|
|
3994 terms of the @code{loop} macro. In compiled code, @code{loop} will
|
|
|
3995 be faster since it generates the loop as in-line code with no
|
|
|
3996 function calls.
|
|
|
3997
|
|
|
3998 @node Sequence Functions, Searching Sequences, Mapping over Sequences, Sequences
|
|
|
3999 @section Sequence Functions
|
|
|
4000
|
|
|
4001 @noindent
|
|
|
4002 This section describes a number of Common Lisp functions for
|
|
|
4003 operating on sequences.
|
|
|
4004
|
|
|
4005 @defun subseq sequence start &optional end
|
|
|
4006 This function returns a given subsequence of the argument
|
|
|
4007 @var{sequence}, which may be a list, string, or vector.
|
|
|
4008 The indices @var{start} and @var{end} must be in range, and
|
|
|
4009 @var{start} must be no greater than @var{end}. If @var{end}
|
|
|
4010 is omitted, it defaults to the length of the sequence. The
|
|
|
4011 return value is always a copy; it does not share structure
|
|
|
4012 with @var{sequence}.
|
|
|
4013
|
|
|
4014 As an extension to Common Lisp, @var{start} and/or @var{end}
|
|
|
4015 may be negative, in which case they represent a distance back
|
|
|
4016 from the end of the sequence. This is for compatibility with
|
|
|
4017 Emacs' @code{substring} function. Note that @code{subseq} is
|
|
|
4018 the @emph{only} sequence function that allows negative
|
|
|
4019 @var{start} and @var{end}.
|
|
|
4020
|
|
|
4021 You can use @code{setf} on a @code{subseq} form to replace a
|
|
|
4022 specified range of elements with elements from another sequence.
|
|
|
4023 The replacement is done as if by @code{replace}, described below.
|
|
|
4024 @end defun
|
|
|
4025
|
|
|
4026 @defun concatenate result-type &rest seqs
|
|
|
4027 This function concatenates the argument sequences together to
|
|
|
4028 form a result sequence of type @var{result-type}, one of the
|
|
|
4029 symbols @code{vector}, @code{string}, or @code{list}. The
|
|
|
4030 arguments are always copied, even in cases such as
|
|
|
4031 @code{(concatenate 'list '(1 2 3))} where the result is
|
|
|
4032 identical to an argument.
|
|
|
4033 @end defun
|
|
|
4034
|
|
|
4035 @defun fill seq item @t{&key :start :end}
|
|
|
4036 This function fills the elements of the sequence (or the specified
|
|
|
4037 part of the sequence) with the value @var{item}.
|
|
|
4038 @end defun
|
|
|
4039
|
|
|
4040 @defun replace seq1 seq2 @t{&key :start1 :end1 :start2 :end2}
|
|
|
4041 This function copies part of @var{seq2} into part of @var{seq1}.
|
|
|
4042 The sequence @var{seq1} is not stretched or resized; the amount
|
|
|
4043 of data copied is simply the shorter of the source and destination
|
|
|
4044 (sub)sequences. The function returns @var{seq1}.
|
|
|
4045
|
|
|
4046 If @var{seq1} and @var{seq2} are @code{eq}, then the replacement
|
|
|
4047 will work correctly even if the regions indicated by the start
|
|
|
4048 and end arguments overlap. However, if @var{seq1} and @var{seq2}
|
|
|
4049 are lists which share storage but are not @code{eq}, and the
|
|
|
4050 start and end arguments specify overlapping regions, the effect
|
|
|
4051 is undefined.
|
|
|
4052 @end defun
|
|
|
4053
|
|
|
4054 @defun remove* item seq @t{&key :test :test-not :key :count :start :end :from-end}
|
|
|
4055 This returns a copy of @var{seq} with all elements matching
|
|
|
4056 @var{item} removed. The result may share storage with or be
|
|
|
4057 @code{eq} to @var{seq} in some circumstances, but the original
|
|
|
4058 @var{seq} will not be modified. The @code{:test}, @code{:test-not},
|
|
|
4059 and @code{:key} arguments define the matching test that is used;
|
|
|
4060 by default, elements @code{eql} to @var{item} are removed. The
|
|
|
4061 @code{:count} argument specifies the maximum number of matching
|
|
|
4062 elements that can be removed (only the leftmost @var{count} matches
|
|
|
4063 are removed). The @code{:start} and @code{:end} arguments specify
|
|
|
4064 a region in @var{seq} in which elements will be removed; elements
|
|
|
4065 outside that region are not matched or removed. The @code{:from-end}
|
|
|
4066 argument, if true, says that elements should be deleted from the
|
|
|
4067 end of the sequence rather than the beginning (this matters only
|
|
|
4068 if @var{count} was also specified).
|
|
|
4069 @end defun
|
|
|
4070
|
|
|
4071 @defun delete* item seq @t{&key :test :test-not :key :count :start :end :from-end}
|
|
|
4072 This deletes all elements of @var{seq} which match @var{item}.
|
|
|
4073 It is a destructive operation. Since Emacs Lisp does not support
|
|
|
4074 stretchable strings or vectors, this is the same as @code{remove*}
|
|
|
4075 for those sequence types. On lists, @code{remove*} will copy the
|
|
|
4076 list if necessary to preserve the original list, whereas
|
|
|
4077 @code{delete*} will splice out parts of the argument list.
|
|
|
4078 Compare @code{append} and @code{nconc}, which are analogous
|
|
|
4079 non-destructive and destructive list operations in Emacs Lisp.
|
|
|
4080 @end defun
|
|
|
4081
|
|
|
4082 @findex remove-if
|
|
|
4083 @findex remove-if-not
|
|
|
4084 @findex delete-if
|
|
|
4085 @findex delete-if-not
|
|
|
4086 The predicate-oriented functions @code{remove-if}, @code{remove-if-not},
|
|
|
4087 @code{delete-if}, and @code{delete-if-not} are defined similarly.
|
|
|
4088
|
|
|
4089 @defun delete item list
|
|
|
4090 This MacLisp-compatible function deletes from @var{list} all elements
|
|
|
4091 which are @code{equal} to @var{item}. The @code{delete} function is
|
|
|
4092 built-in to Emacs 19; this package defines it equivalently in Emacs 18.
|
|
|
4093 @end defun
|
|
|
4094
|
|
|
4095 @defun remove item list
|
|
|
4096 This function removes from @var{list} all elements which are
|
|
|
4097 @code{equal} to @var{item}. This package defines it for symmetry
|
|
|
4098 with @code{delete}, even though @code{remove} is not built-in to
|
|
|
4099 Emacs 19.
|
|
|
4100 @end defun
|
|
|
4101
|
|
|
4102 @defun remq item list
|
|
|
4103 This function removes from @var{list} all elements which are
|
|
|
4104 @code{eq} to @var{item}. This package defines it for symmetry
|
|
|
4105 with @code{delq}, even though @code{remq} is not built-in to
|
|
|
4106 Emacs 19.
|
|
|
4107 @end defun
|
|
|
4108
|
|
|
4109 @defun remove-duplicates seq @t{&key :test :test-not :key :start :end :from-end}
|
|
|
4110 This function returns a copy of @var{seq} with duplicate elements
|
|
|
4111 removed. Specifically, if two elements from the sequence match
|
|
|
4112 according to the @code{:test}, @code{:test-not}, and @code{:key}
|
|
|
4113 arguments, only the rightmost one is retained. If @code{:from-end}
|
|
|
4114 is true, the leftmost one is retained instead. If @code{:start} or
|
|
|
4115 @code{:end} is specified, only elements within that subsequence are
|
|
|
4116 examined or removed.
|
|
|
4117 @end defun
|
|
|
4118
|
|
|
4119 @defun delete-duplicates seq @t{&key :test :test-not :key :start :end :from-end}
|
|
|
4120 This function deletes duplicate elements from @var{seq}. It is
|
|
|
4121 a destructive version of @code{remove-duplicates}.
|
|
|
4122 @end defun
|
|
|
4123
|
|
|
4124 @defun substitute new old seq @t{&key :test :test-not :key :count :start :end :from-end}
|
|
|
4125 This function returns a copy of @var{seq}, with all elements
|
|
|
4126 matching @var{old} replaced with @var{new}. The @code{:count},
|
|
|
4127 @code{:start}, @code{:end}, and @code{:from-end} arguments may be
|
|
|
4128 used to limit the number of substitutions made.
|
|
|
4129 @end defun
|
|
|
4130
|
|
|
4131 @defun nsubstitute new old seq @t{&key :test :test-not :key :count :start :end :from-end}
|
|
|
4132 This is a destructive version of @code{substitute}; it performs
|
|
|
4133 the substitution using @code{setcar} or @code{aset} rather than
|
|
|
4134 by returning a changed copy of the sequence.
|
|
|
4135 @end defun
|
|
|
4136
|
|
|
4137 @findex substitute-if
|
|
|
4138 @findex substitute-if-not
|
|
|
4139 @findex nsubstitute-if
|
|
|
4140 @findex nsubstitute-if-not
|
|
|
4141 The @code{substitute-if}, @code{substitute-if-not}, @code{nsubstitute-if},
|
|
|
4142 and @code{nsubstitute-if-not} functions are defined similarly. For
|
|
|
4143 these, a @var{predicate} is given in place of the @var{old} argument.
|
|
|
4144
|
|
|
4145 @node Searching Sequences, Sorting Sequences, Sequence Functions, Sequences
|
|
|
4146 @section Searching Sequences
|
|
|
4147
|
|
|
4148 @noindent
|
|
|
4149 These functions search for elements or subsequences in a sequence.
|
|
|
4150 (See also @code{member*} and @code{assoc*}; @pxref{Lists}.)
|
|
|
4151
|
|
|
4152 @defun find item seq @t{&key :test :test-not :key :start :end :from-end}
|
|
|
4153 This function searches @var{seq} for an element matching @var{item}.
|
|
|
4154 If it finds a match, it returns the matching element. Otherwise,
|
|
|
4155 it returns @code{nil}. It returns the leftmost match, unless
|
|
|
4156 @code{:from-end} is true, in which case it returns the rightmost
|
|
|
4157 match. The @code{:start} and @code{:end} arguments may be used to
|
|
|
4158 limit the range of elements that are searched.
|
|
|
4159 @end defun
|
|
|
4160
|
|
|
4161 @defun position item seq @t{&key :test :test-not :key :start :end :from-end}
|
|
|
4162 This function is like @code{find}, except that it returns the
|
|
|
4163 integer position in the sequence of the matching item rather than
|
|
|
4164 the item itself. The position is relative to the start of the
|
|
|
4165 sequence as a whole, even if @code{:start} is non-zero. The function
|
|
|
4166 returns @code{nil} if no matching element was found.
|
|
|
4167 @end defun
|
|
|
4168
|
|
|
4169 @defun count item seq @t{&key :test :test-not :key :start :end}
|
|
|
4170 This function returns the number of elements of @var{seq} which
|
|
|
4171 match @var{item}. The result is always a nonnegative integer.
|
|
|
4172 @end defun
|
|
|
4173
|
|
|
4174 @findex find-if
|
|
|
4175 @findex find-if-not
|
|
|
4176 @findex position-if
|
|
|
4177 @findex position-if-not
|
|
|
4178 @findex count-if
|
|
|
4179 @findex count-if-not
|
|
|
4180 The @code{find-if}, @code{find-if-not}, @code{position-if},
|
|
|
4181 @code{position-if-not}, @code{count-if}, and @code{count-if-not}
|
|
|
4182 functions are defined similarly.
|
|
|
4183
|
|
|
4184 @defun mismatch seq1 seq2 @t{&key :test :test-not :key :start1 :end1 :start2 :end2 :from-end}
|
|
|
4185 This function compares the specified parts of @var{seq1} and
|
|
|
4186 @var{seq2}. If they are the same length and the corresponding
|
|
|
4187 elements match (according to @code{:test}, @code{:test-not},
|
|
|
4188 and @code{:key}), the function returns @code{nil}. If there is
|
|
|
4189 a mismatch, the function returns the index (relative to @var{seq1})
|
|
|
4190 of the first mismatching element. This will be the leftmost pair of
|
|
|
4191 elements which do not match, or the position at which the shorter of
|
|
|
4192 the two otherwise-matching sequences runs out.
|
|
|
4193
|
|
|
4194 If @code{:from-end} is true, then the elements are compared from right
|
|
|
4195 to left starting at @code{(1- @var{end1})} and @code{(1- @var{end2})}.
|
|
|
4196 If the sequences differ, then one plus the index of the rightmost
|
|
|
4197 difference (relative to @var{seq1}) is returned.
|
|
|
4198
|
|
|
4199 An interesting example is @code{(mismatch str1 str2 :key 'upcase)},
|
|
|
4200 which compares two strings case-insensitively.
|
|
|
4201 @end defun
|
|
|
4202
|
|
|
4203 @defun search seq1 seq2 @t{&key :test :test-not :key :from-end :start1 :end1 :start2 :end2}
|
|
|
4204 This function searches @var{seq2} for a subsequence that matches
|
|
|
4205 @var{seq1} (or part of it specified by @code{:start1} and
|
|
|
4206 @code{:end1}.) Only matches which fall entirely within the region
|
|
|
4207 defined by @code{:start2} and @code{:end2} will be considered.
|
|
|
4208 The return value is the index of the leftmost element of the
|
|
|
4209 leftmost match, relative to the start of @var{seq2}, or @code{nil}
|
|
|
4210 if no matches were found. If @code{:from-end} is true, the
|
|
|
4211 function finds the @emph{rightmost} matching subsequence.
|
|
|
4212 @end defun
|
|
|
4213
|
|
|
4214 @node Sorting Sequences, , Searching Sequences, Sequences
|
|
|
4215 @section Sorting Sequences
|
|
|
4216
|
|
|
4217 @defun sort* seq predicate @t{&key :key}
|
|
|
4218 This function sorts @var{seq} into increasing order as determined
|
|
|
4219 by using @var{predicate} to compare pairs of elements. @var{predicate}
|
|
|
4220 should return true (non-@code{nil}) if and only if its first argument
|
|
|
4221 is less than (not equal to) its second argument. For example,
|
|
|
4222 @code{<} and @code{string-lessp} are suitable predicate functions
|
|
|
4223 for sorting numbers and strings, respectively; @code{>} would sort
|
|
|
4224 numbers into decreasing rather than increasing order.
|
|
|
4225
|
|
|
4226 This function differs from Emacs' built-in @code{sort} in that it
|
|
|
4227 can operate on any type of sequence, not just lists. Also, it
|
|
|
4228 accepts a @code{:key} argument which is used to preprocess data
|
|
|
4229 fed to the @var{predicate} function. For example,
|
|
|
4230
|
|
|
4231 @example
|
|
|
4232 (setq data (sort data 'string-lessp :key 'downcase))
|
|
|
4233 @end example
|
|
|
4234
|
|
|
4235 @noindent
|
|
|
4236 sorts @var{data}, a sequence of strings, into increasing alphabetical
|
|
|
4237 order without regard to case. A @code{:key} function of @code{car}
|
|
|
4238 would be useful for sorting association lists.
|
|
|
4239
|
|
|
4240 The @code{sort*} function is destructive; it sorts lists by actually
|
|
|
4241 rearranging the @code{cdr} pointers in suitable fashion.
|
|
|
4242 @end defun
|
|
|
4243
|
|
|
4244 @defun stable-sort seq predicate @t{&key :key}
|
|
|
4245 This function sorts @var{seq} @dfn{stably}, meaning two elements
|
|
|
4246 which are equal in terms of @var{predicate} are guaranteed not to
|
|
|
4247 be rearranged out of their original order by the sort.
|
|
|
4248
|
|
|
4249 In practice, @code{sort*} and @code{stable-sort} are equivalent
|
|
|
4250 in Emacs Lisp because the underlying @code{sort} function is
|
|
|
4251 stable by default. However, this package reserves the right to
|
|
|
4252 use non-stable methods for @code{sort*} in the future.
|
|
|
4253 @end defun
|
|
|
4254
|
|
|
4255 @defun merge type seq1 seq2 predicate @t{&key :key}
|
|
|
4256 This function merges two sequences @var{seq1} and @var{seq2} by
|
|
|
4257 interleaving their elements. The result sequence, of type @var{type}
|
|
|
4258 (in the sense of @code{concatenate}), has length equal to the sum
|
|
|
4259 of the lengths of the two input sequences. The sequences may be
|
|
|
4260 modified destructively. Order of elements within @var{seq1} and
|
|
|
4261 @var{seq2} is preserved in the interleaving; elements of the two
|
|
|
4262 sequences are compared by @var{predicate} (in the sense of
|
|
|
4263 @code{sort}) and the lesser element goes first in the result.
|
|
|
4264 When elements are equal, those from @var{seq1} precede those from
|
|
|
4265 @var{seq2} in the result. Thus, if @var{seq1} and @var{seq2} are
|
|
|
4266 both sorted according to @var{predicate}, then the result will be
|
|
|
4267 a merged sequence which is (stably) sorted according to
|
|
|
4268 @var{predicate}.
|
|
|
4269 @end defun
|
|
|
4270
|
|
|
4271 @node Lists, Hash Tables, Sequences, Top
|
|
|
4272 @chapter Lists
|
|
|
4273
|
|
|
4274 @noindent
|
|
|
4275 The functions described here operate on lists.
|
|
|
4276
|
|
|
4277 @menu
|
|
|
4278 * List Functions:: `caddr', `first', `last', `list*', etc.
|
|
|
4279 * Substitution of Expressions:: `subst', `sublis', etc.
|
|
|
4280 * Lists as Sets:: `member*', `adjoin', `union', etc.
|
|
|
4281 * Association Lists:: `assoc*', `rassoc*', `acons', `pairlis'
|
|
|
4282 @end menu
|
|
|
4283
|
|
|
4284 @node List Functions, Substitution of Expressions, Lists, Lists
|
|
|
4285 @section List Functions
|
|
|
4286
|
|
|
4287 @noindent
|
|
|
4288 This section describes a number of simple operations on lists,
|
|
|
4289 i.e., chains of cons cells.
|
|
|
4290
|
|
|
4291 @defun caddr x
|
|
|
4292 This function is equivalent to @code{(car (cdr (cdr @var{x})))}.
|
|
|
4293 Likewise, this package defines all 28 @code{c@var{xxx}r} functions
|
|
|
4294 where @var{xxx} is up to four @samp{a}s and/or @samp{d}s.
|
|
|
4295 All of these functions are @code{setf}-able, and calls to them
|
|
|
4296 are expanded inline by the byte-compiler for maximum efficiency.
|
|
|
4297 @end defun
|
|
|
4298
|
|
|
4299 @defun first x
|
|
|
4300 This function is a synonym for @code{(car @var{x})}. Likewise,
|
|
|
4301 the functions @code{second}, @code{third}, @dots{}, through
|
|
|
4302 @code{tenth} return the given element of the list @var{x}.
|
|
|
4303 @end defun
|
|
|
4304
|
|
|
4305 @defun rest x
|
|
|
4306 This function is a synonym for @code{(cdr @var{x})}.
|
|
|
4307 @end defun
|
|
|
4308
|
|
|
4309 @defun endp x
|
|
|
4310 Common Lisp defines this function to act like @code{null}, but
|
|
|
4311 signalling an error if @code{x} is neither a @code{nil} nor a
|
|
|
4312 cons cell. This package simply defines @code{endp} as a synonym
|
|
|
4313 for @code{null}.
|
|
|
4314 @end defun
|
|
|
4315
|
|
|
4316 @defun list-length x
|
|
|
4317 This function returns the length of list @var{x}, exactly like
|
|
|
4318 @code{(length @var{x})}, except that if @var{x} is a circular
|
|
|
4319 list (where the cdr-chain forms a loop rather than terminating
|
|
|
4320 with @code{nil}), this function returns @code{nil}. (The regular
|
|
|
4321 @code{length} function would get stuck if given a circular list.)
|
|
|
4322 @end defun
|
|
|
4323
|
|
|
4324 @defun last x &optional n
|
|
|
4325 This function returns the last cons, or the @var{n}th-to-last cons,
|
|
|
4326 of the list @var{x}. If @var{n} is omitted it defaults to 1.
|
|
|
4327 The ``last cons'' means the first cons cell of the list whose
|
|
|
4328 @code{cdr} is not another cons cell. (For normal lists, the
|
|
|
4329 @code{cdr} of the last cons will be @code{nil}.) This function
|
|
|
4330 returns @code{nil} if @var{x} is @code{nil} or shorter than
|
|
|
4331 @var{n}. Note that the last @emph{element} of the list is
|
|
|
4332 @code{(car (last @var{x}))}.
|
|
|
4333 @end defun
|
|
|
4334
|
|
|
4335 @defun butlast x &optional n
|
|
|
4336 This function returns the list @var{x} with the last element,
|
|
|
4337 or the last @var{n} elements, removed. If @var{n} is greater
|
|
|
4338 than zero it makes a copy of the list so as not to damage the
|
|
|
4339 original list. In general, @code{(append (butlast @var{x} @var{n})
|
|
|
4340 (last @var{x} @var{n}))} will return a list equal to @var{x}.
|
|
|
4341 @end defun
|
|
|
4342
|
|
|
4343 @defun nbutlast x &optional n
|
|
|
4344 This is a version of @code{butlast} that works by destructively
|
|
|
4345 modifying the @code{cdr} of the appropriate element, rather than
|
|
|
4346 making a copy of the list.
|
|
|
4347 @end defun
|
|
|
4348
|
|
|
4349 @defun list* arg &rest others
|
|
|
4350 This function constructs a list of its arguments. The final
|
|
|
4351 argument becomes the @code{cdr} of the last cell constructed.
|
|
|
4352 Thus, @code{(list* @var{a} @var{b} @var{c})} is equivalent to
|
|
|
4353 @code{(cons @var{a} (cons @var{b} @var{c}))}, and
|
|
|
4354 @code{(list* @var{a} @var{b} nil)} is equivalent to
|
|
|
4355 @code{(list @var{a} @var{b})}.
|
|
|
4356
|
|
|
4357 (Note that this function really is called @code{list*} in Common
|
|
|
4358 Lisp; it is not a name invented for this package like @code{member*}
|
|
|
4359 or @code{defun*}.)
|
|
|
4360 @end defun
|
|
|
4361
|
|
|
4362 @defun ldiff list sublist
|
|
|
4363 If @var{sublist} is a sublist of @var{list}, i.e., is @code{eq} to
|
|
|
4364 one of the cons cells of @var{list}, then this function returns
|
|
|
4365 a copy of the part of @var{list} up to but not including
|
|
|
4366 @var{sublist}. For example, @code{(ldiff x (cddr x))} returns
|
|
|
4367 the first two elements of the list @code{x}. The result is a
|
|
|
4368 copy; the original @var{list} is not modified. If @var{sublist}
|
|
|
4369 is not a sublist of @var{list}, a copy of the entire @var{list}
|
|
|
4370 is returned.
|
|
|
4371 @end defun
|
|
|
4372
|
|
|
4373 @defun copy-list list
|
|
|
4374 This function returns a copy of the list @var{list}. It copies
|
|
|
4375 dotted lists like @code{(1 2 . 3)} correctly.
|
|
|
4376 @end defun
|
|
|
4377
|
|
|
4378 @defun copy-tree x &optional vecp
|
|
|
4379 This function returns a copy of the tree of cons cells @var{x}.
|
|
|
4380 Unlike @code{copy-sequence} (and its alias @code{copy-list}),
|
|
|
4381 which copies only along the @code{cdr} direction, this function
|
|
|
4382 copies (recursively) along both the @code{car} and the @code{cdr}
|
|
|
4383 directions. If @var{x} is not a cons cell, the function simply
|
|
|
4384 returns @var{x} unchanged. If the optional @var{vecp} argument
|
|
|
4385 is true, this function copies vectors (recursively) as well as
|
|
|
4386 cons cells.
|
|
|
4387 @end defun
|
|
|
4388
|
|
|
4389 @defun tree-equal x y @t{&key :test :test-not :key}
|
|
|
4390 This function compares two trees of cons cells. If @var{x} and
|
|
|
4391 @var{y} are both cons cells, their @code{car}s and @code{cdr}s are
|
|
|
4392 compared recursively. If neither @var{x} nor @var{y} is a cons
|
|
|
4393 cell, they are compared by @code{eql}, or according to the
|
|
|
4394 specified test. The @code{:key} function, if specified, is
|
|
|
4395 applied to the elements of both trees. @xref{Sequences}.
|
|
|
4396 @end defun
|
|
|
4397
|
|
|
4398 @iftex
|
|
|
4399 @secno=3
|
|
|
4400 @end iftex
|
|
|
4401
|
|
|
4402 @node Substitution of Expressions, Lists as Sets, List Functions, Lists
|
|
|
4403 @section Substitution of Expressions
|
|
|
4404
|
|
|
4405 @noindent
|
|
|
4406 These functions substitute elements throughout a tree of cons
|
|
|
4407 cells. (@xref{Sequence Functions}, for the @code{substitute}
|
|
|
4408 function, which works on just the top-level elements of a list.)
|
|
|
4409
|
|
|
4410 @defun subst new old tree @t{&key :test :test-not :key}
|
|
|
4411 This function substitutes occurrences of @var{old} with @var{new}
|
|
|
4412 in @var{tree}, a tree of cons cells. It returns a substituted
|
|
|
4413 tree, which will be a copy except that it may share storage with
|
|
|
4414 the argument @var{tree} in parts where no substitutions occurred.
|
|
|
4415 The original @var{tree} is not modified. This function recurses
|
|
|
4416 on, and compares against @var{old}, both @code{car}s and @code{cdr}s
|
|
|
4417 of the component cons cells. If @var{old} is itself a cons cell,
|
|
|
4418 then matching cells in the tree are substituted as usual without
|
|
|
4419 recursively substituting in that cell. Comparisons with @var{old}
|
|
|
4420 are done according to the specified test (@code{eql} by default).
|
|
|
4421 The @code{:key} function is applied to the elements of the tree
|
|
|
4422 but not to @var{old}.
|
|
|
4423 @end defun
|
|
|
4424
|
|
|
4425 @defun nsubst new old tree @t{&key :test :test-not :key}
|
|
|
4426 This function is like @code{subst}, except that it works by
|
|
|
4427 destructive modification (by @code{setcar} or @code{setcdr})
|
|
|
4428 rather than copying.
|
|
|
4429 @end defun
|
|
|
4430
|
|
|
4431 @findex subst-if
|
|
|
4432 @findex subst-if-not
|
|
|
4433 @findex nsubst-if
|
|
|
4434 @findex nsubst-if-not
|
|
|
4435 The @code{subst-if}, @code{subst-if-not}, @code{nsubst-if}, and
|
|
|
4436 @code{nsubst-if-not} functions are defined similarly.
|
|
|
4437
|
|
|
4438 @defun sublis alist tree @t{&key :test :test-not :key}
|
|
|
4439 This function is like @code{subst}, except that it takes an
|
|
|
4440 association list @var{alist} of @var{old}-@var{new} pairs.
|
|
|
4441 Each element of the tree (after applying the @code{:key}
|
|
|
4442 function, if any), is compared with the @code{car}s of
|
|
|
4443 @var{alist}; if it matches, it is replaced by the corresponding
|
|
|
4444 @code{cdr}.
|
|
|
4445 @end defun
|
|
|
4446
|
|
|
4447 @defun nsublis alist tree @t{&key :test :test-not :key}
|
|
|
4448 This is a destructive version of @code{sublis}.
|
|
|
4449 @end defun
|
|
|
4450
|
|
|
4451 @node Lists as Sets, Association Lists, Substitution of Expressions, Lists
|
|
|
4452 @section Lists as Sets
|
|
|
4453
|
|
|
4454 @noindent
|
|
|
4455 These functions perform operations on lists which represent sets
|
|
|
4456 of elements.
|
|
|
4457
|
|
|
4458 @defun member item list
|
|
|
4459 This MacLisp-compatible function searches @var{list} for an element
|
|
|
4460 which is @code{equal} to @var{item}. The @code{member} function is
|
|
|
4461 built-in to Emacs 19; this package defines it equivalently in Emacs 18.
|
|
|
4462 See the following function for a Common-Lisp compatible version.
|
|
|
4463 @end defun
|
|
|
4464
|
|
|
4465 @defun member* item list @t{&key :test :test-not :key}
|
|
|
4466 This function searches @var{list} for an element matching @var{item}.
|
|
|
4467 If a match is found, it returns the cons cell whose @code{car} was
|
|
|
4468 the matching element. Otherwise, it returns @code{nil}. Elements
|
|
|
4469 are compared by @code{eql} by default; you can use the @code{:test},
|
|
|
4470 @code{:test-not}, and @code{:key} arguments to modify this behavior.
|
|
|
4471 @xref{Sequences}.
|
|
|
4472
|
|
|
4473 Note that this function's name is suffixed by @samp{*} to avoid
|
|
|
4474 the incompatible @code{member} function defined in Emacs 19.
|
|
|
4475 (That function uses @code{equal} for comparisons; it is equivalent
|
|
|
4476 to @code{(member* @var{item} @var{list} :test 'equal)}.)
|
|
|
4477 @end defun
|
|
|
4478
|
|
|
4479 @findex member-if
|
|
|
4480 @findex member-if-not
|
|
|
4481 The @code{member-if} and @code{member-if-not} functions
|
|
|
4482 analogously search for elements which satisfy a given predicate.
|
|
|
4483
|
|
|
4484 @defun tailp sublist list
|
|
|
4485 This function returns @code{t} if @var{sublist} is a sublist of
|
|
|
4486 @var{list}, i.e., if @var{sublist} is @code{eql} to @var{list} or to
|
|
|
4487 any of its @code{cdr}s.
|
|
|
4488 @end defun
|
|
|
4489
|
|
|
4490 @defun adjoin item list @t{&key :test :test-not :key}
|
|
|
4491 This function conses @var{item} onto the front of @var{list},
|
|
|
4492 like @code{(cons @var{item} @var{list})}, but only if @var{item}
|
|
|
4493 is not already present on the list (as determined by @code{member*}).
|
|
|
4494 If a @code{:key} argument is specified, it is applied to
|
|
|
4495 @var{item} as well as to the elements of @var{list} during
|
|
|
4496 the search, on the reasoning that @var{item} is ``about'' to
|
|
|
4497 become part of the list.
|
|
|
4498 @end defun
|
|
|
4499
|
|
|
4500 @defun union list1 list2 @t{&key :test :test-not :key}
|
|
|
4501 This function combines two lists which represent sets of items,
|
|
|
4502 returning a list that represents the union of those two sets.
|
|
|
4503 The result list will contain all items which appear in @var{list1}
|
|
|
4504 or @var{list2}, and no others. If an item appears in both
|
|
|
4505 @var{list1} and @var{list2} it will be copied only once. If
|
|
|
4506 an item is duplicated in @var{list1} or @var{list2}, it is
|
|
|
4507 undefined whether or not that duplication will survive in the
|
|
|
4508 result list. The order of elements in the result list is also
|
|
|
4509 undefined.
|
|
|
4510 @end defun
|
|
|
4511
|
|
|
4512 @defun nunion list1 list2 @t{&key :test :test-not :key}
|
|
|
4513 This is a destructive version of @code{union}; rather than copying,
|
|
|
4514 it tries to reuse the storage of the argument lists if possible.
|
|
|
4515 @end defun
|
|
|
4516
|
|
|
4517 @defun intersection list1 list2 @t{&key :test :test-not :key}
|
|
|
4518 This function computes the intersection of the sets represented
|
|
|
4519 by @var{list1} and @var{list2}. It returns the list of items
|
|
|
4520 which appear in both @var{list1} and @var{list2}.
|
|
|
4521 @end defun
|
|
|
4522
|
|
|
4523 @defun nintersection list1 list2 @t{&key :test :test-not :key}
|
|
|
4524 This is a destructive version of @code{intersection}. It
|
|
|
4525 tries to reuse storage of @var{list1} rather than copying.
|
|
|
4526 It does @emph{not} reuse the storage of @var{list2}.
|
|
|
4527 @end defun
|
|
|
4528
|
|
|
4529 @defun set-difference list1 list2 @t{&key :test :test-not :key}
|
|
|
4530 This function computes the ``set difference'' of @var{list1}
|
|
|
4531 and @var{list2}, i.e., the set of elements that appear in
|
|
|
4532 @var{list1} but @emph{not} in @var{list2}.
|
|
|
4533 @end defun
|
|
|
4534
|
|
|
4535 @defun nset-difference list1 list2 @t{&key :test :test-not :key}
|
|
|
4536 This is a destructive @code{set-difference}, which will try
|
|
|
4537 to reuse @var{list1} if possible.
|
|
|
4538 @end defun
|
|
|
4539
|
|
|
4540 @defun set-exclusive-or list1 list2 @t{&key :test :test-not :key}
|
|
|
4541 This function computes the ``set exclusive or'' of @var{list1}
|
|
|
4542 and @var{list2}, i.e., the set of elements that appear in
|
|
|
4543 exactly one of @var{list1} and @var{list2}.
|
|
|
4544 @end defun
|
|
|
4545
|
|
|
4546 @defun nset-exclusive-or list1 list2 @t{&key :test :test-not :key}
|
|
|
4547 This is a destructive @code{set-exclusive-or}, which will try
|
|
|
4548 to reuse @var{list1} and @var{list2} if possible.
|
|
|
4549 @end defun
|
|
|
4550
|
|
|
4551 @defun subsetp list1 list2 @t{&key :test :test-not :key}
|
|
|
4552 This function checks whether @var{list1} represents a subset
|
|
|
4553 of @var{list2}, i.e., whether every element of @var{list1}
|
|
|
4554 also appears in @var{list2}.
|
|
|
4555 @end defun
|
|
|
4556
|
|
|
4557 @node Association Lists, , Lists as Sets, Lists
|
|
|
4558 @section Association Lists
|
|
|
4559
|
|
|
4560 @noindent
|
|
|
4561 An @dfn{association list} is a list representing a mapping from
|
|
|
4562 one set of values to another; any list whose elements are cons
|
|
|
4563 cells is an association list.
|
|
|
4564
|
|
|
4565 @defun assoc* item a-list @t{&key :test :test-not :key}
|
|
|
4566 This function searches the association list @var{a-list} for an
|
|
|
4567 element whose @code{car} matches (in the sense of @code{:test},
|
|
|
4568 @code{:test-not}, and @code{:key}, or by comparison with @code{eql})
|
|
|
4569 a given @var{item}. It returns the matching element, if any,
|
|
|
4570 otherwise @code{nil}. It ignores elements of @var{a-list} which
|
|
|
4571 are not cons cells. (This corresponds to the behavior of
|
|
|
4572 @code{assq} and @code{assoc} in Emacs Lisp; Common Lisp's
|
|
|
4573 @code{assoc} ignores @code{nil}s but considers any other non-cons
|
|
|
4574 elements of @var{a-list} to be an error.)
|
|
|
4575 @end defun
|
|
|
4576
|
|
|
4577 @defun rassoc* item a-list @t{&key :test :test-not :key}
|
|
|
4578 This function searches for an element whose @code{cdr} matches
|
|
|
4579 @var{item}. If @var{a-list} represents a mapping, this applies
|
|
|
4580 the inverse of the mapping to @var{item}.
|
|
|
4581 @end defun
|
|
|
4582
|
|
|
4583 @defun rassoc item a-list
|
|
|
4584 This function searches like @code{rassoc*} with a @code{:test}
|
|
|
4585 argument of @code{equal}. It is analogous to Emacs Lisp's
|
|
|
4586 standard @code{assoc} function, which derives from the MacLisp
|
|
|
4587 rather than the Common Lisp tradition.
|
|
|
4588 @end defun
|
|
|
4589
|
|
|
4590 @findex assoc-if
|
|
|
4591 @findex assoc-if-not
|
|
|
4592 @findex rassoc-if
|
|
|
4593 @findex rassoc-if-not
|
|
|
4594 The @code{assoc-if}, @code{assoc-if-not}, @code{rassoc-if},
|
|
|
4595 and @code{rassoc-if-not} functions are defined similarly.
|
|
|
4596
|
|
|
4597 Two simple functions for constructing association lists are:
|
|
|
4598
|
|
|
4599 @defun acons key value alist
|
|
|
4600 This is equivalent to @code{(cons (cons @var{key} @var{value}) @var{alist})}.
|
|
|
4601 @end defun
|
|
|
4602
|
|
|
4603 @defun pairlis keys values &optional alist
|
|
|
4604 This is equivalent to @code{(nconc (mapcar* 'cons @var{keys} @var{values})
|
|
|
4605 @var{alist})}.
|
|
|
4606 @end defun
|
|
|
4607
|
|
|
4608 @node Hash Tables, Structures, Lists, Top
|
|
|
4609 @chapter Hash Tables
|
|
|
4610
|
|
|
4611 @noindent
|
|
|
4612 A @dfn{hash table} is a data structure that maps ``keys'' onto
|
|
|
4613 ``values.'' Keys and values can be arbitrary Lisp data objects.
|
|
|
4614 Hash tables have the property that the time to search for a given
|
|
|
4615 key is roughly constant; simpler data structures like association
|
|
|
4616 lists take time proportional to the number of entries in the list.
|
|
|
4617
|
|
|
4618 @defun make-hash-table @t{&key :test :size}
|
|
|
4619 This function creates and returns a hash-table object whose
|
|
|
4620 function for comparing elements is @code{:test} (@code{eql}
|
|
|
4621 by default), and which is allocated to fit about @code{:size}
|
|
|
4622 elements. The @code{:size} argument is purely advisory; the
|
|
|
4623 table will stretch automatically if you store more elements in
|
|
|
4624 it. If @code{:size} is omitted, a reasonable default is used.
|
|
|
4625
|
|
|
4626 Common Lisp allows only @code{eq}, @code{eql}, @code{equal},
|
|
|
4627 and @code{equalp} as legal values for the @code{:test} argument.
|
|
|
4628 In this package, any reasonable predicate function will work,
|
|
|
4629 though if you use something else you should check the details of
|
|
|
4630 the hashing function described below to make sure it is suitable
|
|
|
4631 for your predicate.
|
|
|
4632
|
|
|
4633 Some versions of Emacs (like Lucid Emacs 19) include a built-in
|
|
|
4634 hash table type; in these versions, @code{make-hash-table} with
|
|
|
4635 a test of @code{eq} will use these built-in hash tables. In all
|
|
|
4636 other cases, it will return a hash-table object which takes the
|
|
|
4637 form of a list with an identifying ``tag'' symbol at the front.
|
|
|
4638 All of the hash table functions in this package can operate on
|
|
|
4639 both types of hash table; normally you will never know which
|
|
|
4640 type is being used.
|
|
|
4641
|
|
|
4642 This function accepts the additional Common Lisp keywords
|
|
|
4643 @code{:rehash-size} and @code{:rehash-threshold}, but it ignores
|
|
|
4644 their values.
|
|
|
4645 @end defun
|
|
|
4646
|
|
|
4647 @defun gethash key table &optional default
|
|
|
4648 This function looks up @var{key} in @var{table}. If @var{key}
|
|
|
4649 exists in the table, in the sense that it matches any of the existing
|
|
|
4650 keys according to the table's test function, then the associated value
|
|
|
4651 is returned. Otherwise, @var{default} (or @code{nil}) is returned.
|
|
|
4652
|
|
|
4653 To store new data in the hash table, use @code{setf} on a call to
|
|
|
4654 @code{gethash}. If @var{key} already exists in the table, the
|
|
|
4655 corresponding value is changed to the stored value. If @var{key}
|
|
|
4656 does not already exist, a new entry is added to the table and the
|
|
|
4657 table is reallocated to a larger size if necessary. The @var{default}
|
|
|
4658 argument is allowed but ignored in this case. The situation is
|
|
|
4659 exactly analogous to that of @code{get*}; @pxref{Property Lists}.
|
|
|
4660 @end defun
|
|
|
4661
|
|
|
4662 @defun remhash key table
|
|
|
4663 This function removes the entry for @var{key} from @var{table}.
|
|
|
4664 If an entry was removed, it returns @code{t}. If @var{key} does
|
|
|
4665 not appear in the table, it does nothing and returns @code{nil}.
|
|
|
4666 @end defun
|
|
|
4667
|
|
|
4668 @defun clrhash table
|
|
|
4669 This function removes all the entries from @var{table}, leaving
|
|
|
4670 an empty hash table.
|
|
|
4671 @end defun
|
|
|
4672
|
|
|
4673 @defun maphash function table
|
|
|
4674 This function calls @var{function} for each entry in @var{table}.
|
|
|
4675 It passes two arguments to @var{function}, the key and the value
|
|
|
4676 of the given entry. The return value of @var{function} is ignored;
|
|
|
4677 @var{maphash} itself returns @code{nil}. @xref{Loop Facility}, for
|
|
|
4678 an alternate way of iterating over hash tables.
|
|
|
4679 @end defun
|
|
|
4680
|
|
|
4681 @defun hash-table-count table
|
|
|
4682 This function returns the number of entries in @var{table}.
|
|
|
4683 @strong{Warning:} The current implementation of Lucid Emacs 19
|
|
|
4684 hash-tables does not decrement the stored @code{count} when
|
|
|
4685 @code{remhash} removes an entry. Therefore, the return value of
|
|
|
4686 this function is not dependable if you have used @code{remhash}
|
|
|
4687 on the table and the table's test is @code{eq}. A slower, but
|
|
|
4688 reliable, way to count the entries is @code{(loop for x being the
|
|
|
4689 hash-keys of @var{table} count t)}.
|
|
|
4690 @end defun
|
|
|
4691
|
|
|
4692 @defun hash-table-p object
|
|
|
4693 This function returns @code{t} if @var{object} is a hash table,
|
|
|
4694 @code{nil} otherwise. It recognizes both types of hash tables
|
|
|
4695 (both Lucid Emacs built-in tables and tables implemented with
|
|
|
4696 special lists.)
|
|
|
4697 @end defun
|
|
|
4698
|
|
|
4699 Sometimes when dealing with hash tables it is useful to know the
|
|
|
4700 exact ``hash function'' that is used. This package implements
|
|
|
4701 hash tables using Emacs Lisp ``obarrays,'' which are the same
|
|
|
4702 data structure that Emacs Lisp uses to keep track of symbols.
|
|
|
4703 Each hash table includes an embedded obarray. Key values given
|
|
|
4704 to @code{gethash} are converted by various means into strings,
|
|
|
4705 which are then looked up in the obarray using @code{intern} and
|
|
|
4706 @code{intern-soft}. The symbol, or ``bucket,'' corresponding to
|
|
|
4707 a given key string includes as its @code{symbol-value} an association
|
|
|
4708 list of all key-value pairs which hash to that string. Depending
|
|
|
4709 on the test function, it is possible for many entries to hash to
|
|
|
4710 the same bucket. For example, if the test is @code{eql}, then the
|
|
|
4711 symbol @code{foo} and two separately built strings @code{"foo"} will
|
|
|
4712 create three entries in the same bucket. Search time is linear
|
|
|
4713 within buckets, so hash tables will be most effective if you arrange
|
|
|
4714 not to store too many things that hash the same.
|
|
|
4715
|
|
|
4716 The following algorithm is used to convert Lisp objects to hash
|
|
|
4717 strings:
|
|
|
4718
|
|
|
4719 @itemize @bullet
|
|
|
4720 @item
|
|
|
4721 Strings are used directly as hash strings. (However, if the test
|
|
|
4722 function is @code{equalp}, strings are @code{downcase}d first.)
|
|
|
4723
|
|
|
4724 @item
|
|
|
4725 Symbols are hashed according to their @code{symbol-name}.
|
|
|
4726
|
|
|
4727 @item
|
|
|
4728 Integers are hashed into one of 16 buckets depending on their value
|
|
|
4729 modulo 16. Floating-point numbers are truncated to integers and
|
|
|
4730 hashed modulo 16.
|
|
|
4731
|
|
|
4732 @item
|
|
|
4733 Cons cells are hashed according to their @code{car}s; nonempty vectors
|
|
|
4734 are hashed according to their first element.
|
|
|
4735
|
|
|
4736 @item
|
|
|
4737 All other types of objects hash into a single bucket named @code{"*"}.
|
|
|
4738 @end itemize
|
|
|
4739
|
|
|
4740 @noindent
|
|
|
4741 Thus, for example, searching among many buffer objects in a hash table
|
|
|
4742 will devolve to a (still fairly fast) linear-time search through a
|
|
|
4743 single bucket, whereas searching for different symbols will be very
|
|
|
4744 fast since each symbol will, in general, hash into its own bucket.
|
|
|
4745
|
|
|
4746 The size of the obarray in a hash table is automatically adjusted
|
|
|
4747 as the number of elements increases.
|
|
|
4748
|
|
|
4749 As a special case, @code{make-hash-table} with a @code{:size} argument
|
|
|
4750 of 0 or 1 will create a hash-table object that uses a single association
|
|
|
4751 list rather than an obarray of many lists. For very small tables this
|
|
|
4752 structure will be more efficient since lookup does not require
|
|
|
4753 converting the key to a string or looking it up in an obarray.
|
|
|
4754 However, such tables are guaranteed to take time proportional to
|
|
|
4755 their size to do a search.
|
|
|
4756
|
|
|
4757 @iftex
|
|
|
4758 @chapno=18
|
|
|
4759 @end iftex
|
|
|
4760
|
|
|
4761 @node Structures, Assertions, Hash Tables, Top
|
|
|
4762 @chapter Structures
|
|
|
4763
|
|
|
4764 @noindent
|
|
|
4765 The Common Lisp @dfn{structure} mechanism provides a general way
|
|
|
4766 to define data types similar to C's @code{struct} types. A
|
|
|
4767 structure is a Lisp object containing some number of @dfn{slots},
|
|
|
4768 each of which can hold any Lisp data object. Functions are
|
|
|
4769 provided for accessing and setting the slots, creating or copying
|
|
|
4770 structure objects, and recognizing objects of a particular structure
|
|
|
4771 type.
|
|
|
4772
|
|
|
4773 In true Common Lisp, each structure type is a new type distinct
|
|
|
4774 from all existing Lisp types. Since the underlying Emacs Lisp
|
|
|
4775 system provides no way to create new distinct types, this package
|
|
|
4776 implements structures as vectors (or lists upon request) with a
|
|
|
4777 special ``tag'' symbol to identify them.
|
|
|
4778
|
|
|
4779 @defspec defstruct name slots@dots{}
|
|
|
4780 The @code{defstruct} form defines a new structure type called
|
|
|
4781 @var{name}, with the specified @var{slots}. (The @var{slots}
|
|
|
4782 may begin with a string which documents the structure type.)
|
|
|
4783 In the simplest case, @var{name} and each of the @var{slots}
|
|
|
4784 are symbols. For example,
|
|
|
4785
|
|
|
4786 @example
|
|
|
4787 (defstruct person name age sex)
|
|
|
4788 @end example
|
|
|
4789
|
|
|
4790 @noindent
|
|
|
4791 defines a struct type called @code{person} which contains three
|
|
|
4792 slots. Given a @code{person} object @var{p}, you can access those
|
|
|
4793 slots by calling @code{(person-name @var{p})}, @code{(person-age @var{p})},
|
|
|
4794 and @code{(person-sex @var{p})}. You can also change these slots by
|
|
|
4795 using @code{setf} on any of these place forms:
|
|
|
4796
|
|
|
4797 @example
|
|
|
4798 (incf (person-age birthday-boy))
|
|
|
4799 @end example
|
|
|
4800
|
|
|
4801 You can create a new @code{person} by calling @code{make-person},
|
|
|
4802 which takes keyword arguments @code{:name}, @code{:age}, and
|
|
|
4803 @code{:sex} to specify the initial values of these slots in the
|
|
|
4804 new object. (Omitting any of these arguments leaves the corresponding
|
|
|
4805 slot ``undefined,'' according to the Common Lisp standard; in Emacs
|
|
|
4806 Lisp, such uninitialized slots are filled with @code{nil}.)
|
|
|
4807
|
|
|
4808 Given a @code{person}, @code{(copy-person @var{p})} makes a new
|
|
|
4809 object of the same type whose slots are @code{eq} to those of @var{p}.
|
|
|
4810
|
|
|
4811 Given any Lisp object @var{x}, @code{(person-p @var{x})} returns
|
|
|
4812 true if @var{x} looks like a @code{person}, false otherwise. (Again,
|
|
|
4813 in Common Lisp this predicate would be exact; in Emacs Lisp the
|
|
|
4814 best it can do is verify that @var{x} is a vector of the correct
|
|
|
4815 length which starts with the correct tag symbol.)
|
|
|
4816
|
|
|
4817 Accessors like @code{person-name} normally check their arguments
|
|
|
4818 (effectively using @code{person-p}) and signal an error if the
|
|
|
4819 argument is the wrong type. This check is affected by
|
|
|
4820 @code{(optimize (safety @dots{}))} declarations. Safety level 1,
|
|
|
4821 the default, uses a somewhat optimized check that will detect all
|
|
|
4822 incorrect arguments, but may use an uninformative error message
|
|
|
4823 (e.g., ``expected a vector'' instead of ``expected a @code{person}'').
|
|
|
4824 Safety level 0 omits all checks except as provided by the underlying
|
|
|
4825 @code{aref} call; safety levels 2 and 3 do rigorous checking that will
|
|
|
4826 always print a descriptive error message for incorrect inputs.
|
|
|
4827 @xref{Declarations}.
|
|
|
4828
|
|
|
4829 @example
|
|
|
4830 (setq dave (make-person :name "Dave" :sex 'male))
|
|
|
4831 @result{} [cl-struct-person "Dave" nil male]
|
|
|
4832 (setq other (copy-person dave))
|
|
|
4833 @result{} [cl-struct-person "Dave" nil male]
|
|
|
4834 (eq dave other)
|
|
|
4835 @result{} nil
|
|
|
4836 (eq (person-name dave) (person-name other))
|
|
|
4837 @result{} t
|
|
|
4838 (person-p dave)
|
|
|
4839 @result{} t
|
|
|
4840 (person-p [1 2 3 4])
|
|
|
4841 @result{} nil
|
|
|
4842 (person-p "Bogus")
|
|
|
4843 @result{} nil
|
|
|
4844 (person-p '[cl-struct-person counterfeit person object])
|
|
|
4845 @result{} t
|
|
|
4846 @end example
|
|
|
4847
|
|
|
4848 In general, @var{name} is either a name symbol or a list of a name
|
|
|
4849 symbol followed by any number of @dfn{struct options}; each @var{slot}
|
|
|
4850 is either a slot symbol or a list of the form @samp{(@var{slot-name}
|
|
|
4851 @var{default-value} @var{slot-options}@dots{})}. The @var{default-value}
|
|
|
4852 is a Lisp form which is evaluated any time an instance of the
|
|
|
4853 structure type is created without specifying that slot's value.
|
|
|
4854
|
|
|
4855 Common Lisp defines several slot options, but the only one
|
|
|
4856 implemented in this package is @code{:read-only}. A non-@code{nil}
|
|
|
4857 value for this option means the slot should not be @code{setf}-able;
|
|
|
4858 the slot's value is determined when the object is created and does
|
|
|
4859 not change afterward.
|
|
|
4860
|
|
|
4861 @example
|
|
|
4862 (defstruct person
|
|
|
4863 (name nil :read-only t)
|
|
|
4864 age
|
|
|
4865 (sex 'unknown))
|
|
|
4866 @end example
|
|
|
4867
|
|
|
4868 Any slot options other than @code{:read-only} are ignored.
|
|
|
4869
|
|
|
4870 For obscure historical reasons, structure options take a different
|
|
|
4871 form than slot options. A structure option is either a keyword
|
|
|
4872 symbol, or a list beginning with a keyword symbol possibly followed
|
|
|
4873 by arguments. (By contrast, slot options are key-value pairs not
|
|
|
4874 enclosed in lists.)
|
|
|
4875
|
|
|
4876 @example
|
|
|
4877 (defstruct (person (:constructor create-person)
|
|
|
4878 (:type list)
|
|
|
4879 :named)
|
|
|
4880 name age sex)
|
|
|
4881 @end example
|
|
|
4882
|
|
|
4883 The following structure options are recognized.
|
|
|
4884
|
|
|
4885 @table @code
|
|
|
4886 @iftex
|
|
|
4887 @itemmax=0 in
|
|
|
4888 @advance@leftskip-.5@tableindent
|
|
|
4889 @end iftex
|
|
|
4890 @item :conc-name
|
|
|
4891 The argument is a symbol whose print name is used as the prefix for
|
|
|
4892 the names of slot accessor functions. The default is the name of
|
|
|
4893 the struct type followed by a hyphen. The option @code{(:conc-name p-)}
|
|
|
4894 would change this prefix to @code{p-}. Specifying @code{nil} as an
|
|
|
4895 argument means no prefix, so that the slot names themselves are used
|
|
|
4896 to name the accessor functions.
|
|
|
4897
|
|
|
4898 @item :constructor
|
|
|
4899 In the simple case, this option takes one argument which is an
|
|
|
4900 alternate name to use for the constructor function. The default
|
|
|
4901 is @code{make-@var{name}}, e.g., @code{make-person}. The above
|
|
|
4902 example changes this to @code{create-person}. Specifying @code{nil}
|
|
|
4903 as an argument means that no standard constructor should be
|
|
|
4904 generated at all.
|
|
|
4905
|
|
|
4906 In the full form of this option, the constructor name is followed
|
|
|
4907 by an arbitrary argument list. @xref{Program Structure}, for a
|
|
|
4908 description of the format of Common Lisp argument lists. All
|
|
|
4909 options, such as @code{&rest} and @code{&key}, are supported.
|
|
|
4910 The argument names should match the slot names; each slot is
|
|
|
4911 initialized from the corresponding argument. Slots whose names
|
|
|
4912 do not appear in the argument list are initialized based on the
|
|
|
4913 @var{default-value} in their slot descriptor. Also, @code{&optional}
|
|
|
4914 and @code{&key} arguments which don't specify defaults take their
|
|
|
4915 defaults from the slot descriptor. It is legal to include arguments
|
|
|
4916 which don't correspond to slot names; these are useful if they are
|
|
|
4917 referred to in the defaults for optional, keyword, or @code{&aux}
|
|
|
4918 arguments which @emph{do} correspond to slots.
|
|
|
4919
|
|
|
4920 You can specify any number of full-format @code{:constructor}
|
|
|
4921 options on a structure. The default constructor is still generated
|
|
|
4922 as well unless you disable it with a simple-format @code{:constructor}
|
|
|
4923 option.
|
|
|
4924
|
|
|
4925 @example
|
|
|
4926 (defstruct
|
|
|
4927 (person
|
|
|
4928 (:constructor nil) ; no default constructor
|
|
|
4929 (:constructor new-person (name sex &optional (age 0)))
|
|
|
4930 (:constructor new-hound (&key (name "Rover")
|
|
|
4931 (dog-years 0)
|
|
|
4932 &aux (age (* 7 dog-years))
|
|
|
4933 (sex 'canine))))
|
|
|
4934 name age sex)
|
|
|
4935 @end example
|
|
|
4936
|
|
|
4937 The first constructor here takes its arguments positionally rather
|
|
|
4938 than by keyword. (In official Common Lisp terminology, constructors
|
|
|
4939 that work By Order of Arguments instead of by keyword are called
|
|
|
4940 ``BOA constructors.'' No, I'm not making this up.) For example,
|
|
|
4941 @code{(new-person "Jane" 'female)} generates a person whose slots
|
|
|
4942 are @code{"Jane"}, 0, and @code{female}, respectively.
|
|
|
4943
|
|
|
4944 The second constructor takes two keyword arguments, @code{:name},
|
|
|
4945 which initializes the @code{name} slot and defaults to @code{"Rover"},
|
|
|
4946 and @code{:dog-years}, which does not itself correspond to a slot
|
|
|
4947 but which is used to initialize the @code{age} slot. The @code{sex}
|
|
|
4948 slot is forced to the symbol @code{canine} with no syntax for
|
|
|
4949 overriding it.
|
|
|
4950
|
|
|
4951 @item :copier
|
|
|
4952 The argument is an alternate name for the copier function for
|
|
|
4953 this type. The default is @code{copy-@var{name}}. @code{nil}
|
|
|
4954 means not to generate a copier function. (In this implementation,
|
|
|
4955 all copier functions are simply synonyms for @code{copy-sequence}.)
|
|
|
4956
|
|
|
4957 @item :predicate
|
|
|
4958 The argument is an alternate name for the predicate which recognizes
|
|
|
4959 objects of this type. The default is @code{@var{name}-p}. @code{nil}
|
|
|
4960 means not to generate a predicate function. (If the @code{:type}
|
|
|
4961 option is used without the @code{:named} option, no predicate is
|
|
|
4962 ever generated.)
|
|
|
4963
|
|
|
4964 In true Common Lisp, @code{typep} is always able to recognize a
|
|
|
4965 structure object even if @code{:predicate} was used. In this
|
|
|
4966 package, @code{typep} simply looks for a function called
|
|
|
4967 @code{@var{typename}-p}, so it will work for structure types
|
|
|
4968 only if they used the default predicate name.
|
|
|
4969
|
|
|
4970 @item :include
|
|
|
4971 This option implements a very limited form of C++-style inheritance.
|
|
|
4972 The argument is the name of another structure type previously
|
|
|
4973 created with @code{defstruct}. The effect is to cause the new
|
|
|
4974 structure type to inherit all of the included structure's slots
|
|
|
4975 (plus, of course, any new slots described by this struct's slot
|
|
|
4976 descriptors). The new structure is considered a ``specialization''
|
|
|
4977 of the included one. In fact, the predicate and slot accessors
|
|
|
4978 for the included type will also accept objects of the new type.
|
|
|
4979
|
|
|
4980 If there are extra arguments to the @code{:include} option after
|
|
|
4981 the included-structure name, these options are treated as replacement
|
|
|
4982 slot descriptors for slots in the included structure, possibly with
|
|
|
4983 modified default values. Borrowing an example from Steele:
|
|
|
4984
|
|
|
4985 @example
|
|
|
4986 (defstruct person name (age 0) sex)
|
|
|
4987 @result{} person
|
|
|
4988 (defstruct (astronaut (:include person (age 45)))
|
|
|
4989 helmet-size
|
|
|
4990 (favorite-beverage 'tang))
|
|
|
4991 @result{} astronaut
|
|
|
4992
|
|
|
4993 (setq joe (make-person :name "Joe"))
|
|
|
4994 @result{} [cl-struct-person "Joe" 0 nil]
|
|
|
4995 (setq buzz (make-astronaut :name "Buzz"))
|
|
|
4996 @result{} [cl-struct-astronaut "Buzz" 45 nil nil tang]
|
|
|
4997
|
|
|
4998 (list (person-p joe) (person-p buzz))
|
|
|
4999 @result{} (t t)
|
|
|
5000 (list (astronaut-p joe) (astronaut-p buzz))
|
|
|
5001 @result{} (nil t)
|
|
|
5002
|
|
|
5003 (person-name buzz)
|
|
|
5004 @result{} "Buzz"
|
|
|
5005 (astronaut-name joe)
|
|
|
5006 @result{} error: "astronaut-name accessing a non-astronaut"
|
|
|
5007 @end example
|
|
|
5008
|
|
|
5009 Thus, if @code{astronaut} is a specialization of @code{person},
|
|
|
5010 then every @code{astronaut} is also a @code{person} (but not the
|
|
|
5011 other way around). Every @code{astronaut} includes all the slots
|
|
|
5012 of a @code{person}, plus extra slots that are specific to
|
|
|
5013 astronauts. Operations that work on people (like @code{person-name})
|
|
|
5014 work on astronauts just like other people.
|
|
|
5015
|
|
|
5016 @item :print-function
|
|
|
5017 In full Common Lisp, this option allows you to specify a function
|
|
|
5018 which is called to print an instance of the structure type. The
|
|
|
5019 Emacs Lisp system offers no hooks into the Lisp printer which would
|
|
|
5020 allow for such a feature, so this package simply ignores
|
|
|
5021 @code{:print-function}.
|
|
|
5022
|
|
|
5023 @item :type
|
|
|
5024 The argument should be one of the symbols @code{vector} or @code{list}.
|
|
|
5025 This tells which underlying Lisp data type should be used to implement
|
|
|
5026 the new structure type. Vectors are used by default, but
|
|
|
5027 @code{(:type list)} will cause structure objects to be stored as
|
|
|
5028 lists instead.
|
|
|
5029
|
|
|
5030 The vector representation for structure objects has the advantage
|
|
|
5031 that all structure slots can be accessed quickly, although creating
|
|
|
5032 vectors is a bit slower in Emacs Lisp. Lists are easier to create,
|
|
|
5033 but take a relatively long time accessing the later slots.
|
|
|
5034
|
|
|
5035 @item :named
|
|
|
5036 This option, which takes no arguments, causes a characteristic ``tag''
|
|
|
5037 symbol to be stored at the front of the structure object. Using
|
|
|
5038 @code{:type} without also using @code{:named} will result in a
|
|
|
5039 structure type stored as plain vectors or lists with no identifying
|
|
|
5040 features.
|
|
|
5041
|
|
|
5042 The default, if you don't specify @code{:type} explicitly, is to
|
|
|
5043 use named vectors. Therefore, @code{:named} is only useful in
|
|
|
5044 conjunction with @code{:type}.
|
|
|
5045
|
|
|
5046 @example
|
|
|
5047 (defstruct (person1) name age sex)
|
|
|
5048 (defstruct (person2 (:type list) :named) name age sex)
|
|
|
5049 (defstruct (person3 (:type list)) name age sex)
|
|
|
5050
|
|
|
5051 (setq p1 (make-person1))
|
|
|
5052 @result{} [cl-struct-person1 nil nil nil]
|
|
|
5053 (setq p2 (make-person2))
|
|
|
5054 @result{} (person2 nil nil nil)
|
|
|
5055 (setq p3 (make-person3))
|
|
|
5056 @result{} (nil nil nil)
|
|
|
5057
|
|
|
5058 (person1-p p1)
|
|
|
5059 @result{} t
|
|
|
5060 (person2-p p2)
|
|
|
5061 @result{} t
|
|
|
5062 (person3-p p3)
|
|
|
5063 @result{} error: function person3-p undefined
|
|
|
5064 @end example
|
|
|
5065
|
|
|
5066 Since unnamed structures don't have tags, @code{defstruct} is not
|
|
|
5067 able to make a useful predicate for recognizing them. Also,
|
|
|
5068 accessors like @code{person3-name} will be generated but they
|
|
|
5069 will not be able to do any type checking. The @code{person3-name}
|
|
|
5070 function, for example, will simply be a synonym for @code{car} in
|
|
|
5071 this case. By contrast, @code{person2-name} is able to verify
|
|
|
5072 that its argument is indeed a @code{person2} object before
|
|
|
5073 proceeding.
|
|
|
5074
|
|
|
5075 @item :initial-offset
|
|
|
5076 The argument must be a nonnegative integer. It specifies a
|
|
|
5077 number of slots to be left ``empty'' at the front of the
|
|
|
5078 structure. If the structure is named, the tag appears at the
|
|
|
5079 specified position in the list or vector; otherwise, the first
|
|
|
5080 slot appears at that position. Earlier positions are filled
|
|
|
5081 with @code{nil} by the constructors and ignored otherwise. If
|
|
|
5082 the type @code{:include}s another type, then @code{:initial-offset}
|
|
|
5083 specifies a number of slots to be skipped between the last slot
|
|
|
5084 of the included type and the first new slot.
|
|
|
5085 @end table
|
|
|
5086 @end defspec
|
|
|
5087
|
|
|
5088 Except as noted, the @code{defstruct} facility of this package is
|
|
|
5089 entirely compatible with that of Common Lisp.
|
|
|
5090
|
|
|
5091 @iftex
|
|
|
5092 @chapno=23
|
|
|
5093 @end iftex
|
|
|
5094
|
|
|
5095 @node Assertions, Efficiency Concerns, Structures, Top
|
|
|
5096 @chapter Assertions and Errors
|
|
|
5097
|
|
|
5098 @noindent
|
|
|
5099 This section describes two macros that test @dfn{assertions}, i.e.,
|
|
|
5100 conditions which must be true if the program is operating correctly.
|
|
|
5101 Assertions never add to the behavior of a Lisp program; they simply
|
|
|
5102 make ``sanity checks'' to make sure everything is as it should be.
|
|
|
5103
|
|
|
5104 If the optimization property @code{speed} has been set to 3, and
|
|
|
5105 @code{safety} is less than 3, then the byte-compiler will optimize
|
|
|
5106 away the following assertions. Because assertions might be optimized
|
|
|
5107 away, it is a bad idea for them to include side-effects.
|
|
|
5108
|
|
|
5109 @defspec assert test-form [show-args string args@dots{}]
|
|
|
5110 This form verifies that @var{test-form} is true (i.e., evaluates to
|
|
|
5111 a non-@code{nil} value). If so, it returns @code{nil}. If the test
|
|
|
5112 is not satisfied, @code{assert} signals an error.
|
|
|
5113
|
|
|
5114 A default error message will be supplied which includes @var{test-form}.
|
|
|
5115 You can specify a different error message by including a @var{string}
|
|
|
5116 argument plus optional extra arguments. Those arguments are simply
|
|
|
5117 passed to @code{error} to signal the error.
|
|
|
5118
|
|
|
5119 If the optional second argument @var{show-args} is @code{t} instead
|
|
|
5120 of @code{nil}, then the error message (with or without @var{string})
|
|
|
5121 will also include all non-constant arguments of the top-level
|
|
|
5122 @var{form}. For example:
|
|
|
5123
|
|
|
5124 @example
|
|
|
5125 (assert (> x 10) t "x is too small: %d")
|
|
|
5126 @end example
|
|
|
5127
|
|
|
5128 This usage of @var{show-args} is an extension to Common Lisp. In
|
|
|
5129 true Common Lisp, the second argument gives a list of @var{places}
|
|
|
5130 which can be @code{setf}'d by the user before continuing from the
|
|
|
5131 error. Since Emacs Lisp does not support continuable errors, it
|
|
|
5132 makes no sense to specify @var{places}.
|
|
|
5133 @end defspec
|
|
|
5134
|
|
|
5135 @defspec check-type form type [string]
|
|
|
5136 This form verifies that @var{form} evaluates to a value of type
|
|
|
5137 @var{type}. If so, it returns @code{nil}. If not, @code{check-type}
|
|
|
5138 signals a @code{wrong-type-argument} error. The default error message
|
|
|
5139 lists the erroneous value along with @var{type} and @var{form}
|
|
|
5140 themselves. If @var{string} is specified, it is included in the
|
|
|
5141 error message in place of @var{type}. For example:
|
|
|
5142
|
|
|
5143 @example
|
|
|
5144 (check-type x (integer 1 *) "a positive integer")
|
|
|
5145 @end example
|
|
|
5146
|
|
|
5147 @xref{Type Predicates}, for a description of the type specifiers
|
|
|
5148 that may be used for @var{type}.
|
|
|
5149
|
|
|
5150 Note that in Common Lisp, the first argument to @code{check-type}
|
|
|
5151 must be a @var{place} suitable for use by @code{setf}, because
|
|
|
5152 @code{check-type} signals a continuable error that allows the
|
|
|
5153 user to modify @var{place}.
|
|
|
5154 @end defspec
|
|
|
5155
|
|
|
5156 The following error-related macro is also defined:
|
|
|
5157
|
|
|
5158 @defspec ignore-errors forms@dots{}
|
|
|
5159 This executes @var{forms} exactly like a @code{progn}, except that
|
|
|
5160 errors are ignored during the @var{forms}. More precisely, if
|
|
|
5161 an error is signalled then @code{ignore-errors} immediately
|
|
|
5162 aborts execution of the @var{forms} and returns @code{nil}.
|
|
|
5163 If the @var{forms} complete successfully, @code{ignore-errors}
|
|
|
5164 returns the result of the last @var{form}.
|
|
|
5165 @end defspec
|
|
|
5166
|
|
|
5167 @node Efficiency Concerns, Common Lisp Compatibility, Assertions, Top
|
|
|
5168 @appendix Efficiency Concerns
|
|
|
5169
|
|
|
5170 @appendixsec Macros
|
|
|
5171
|
|
|
5172 @noindent
|
|
|
5173 Many of the advanced features of this package, such as @code{defun*},
|
|
|
5174 @code{loop}, and @code{setf}, are implemented as Lisp macros. In
|
|
|
5175 byte-compiled code, these complex notations will be expanded into
|
|
|
5176 equivalent Lisp code which is simple and efficient. For example,
|
|
|
5177 the forms
|
|
|
5178
|
|
|
5179 @example
|
|
|
5180 (incf i n)
|
|
|
5181 (push x (car p))
|
|
|
5182 @end example
|
|
|
5183
|
|
|
5184 @noindent
|
|
|
5185 are expanded at compile-time to the Lisp forms
|
|
|
5186
|
|
|
5187 @example
|
|
|
5188 (setq i (+ i n))
|
|
|
5189 (setcar p (cons x (car p)))
|
|
|
5190 @end example
|
|
|
5191
|
|
|
5192 @noindent
|
|
|
5193 which are the most efficient ways of doing these respective operations
|
|
|
5194 in Lisp. Thus, there is no performance penalty for using the more
|
|
|
5195 readable @code{incf} and @code{push} forms in your compiled code.
|
|
|
5196
|
|
|
5197 @emph{Interpreted} code, on the other hand, must expand these macros
|
|
|
5198 every time they are executed. For this reason it is strongly
|
|
|
5199 recommended that code making heavy use of macros be compiled.
|
|
|
5200 (The features labelled ``Special Form'' instead of ``Function'' in
|
|
|
5201 this manual are macros.) A loop using @code{incf} a hundred times
|
|
|
5202 will execute considerably faster if compiled, and will also
|
|
|
5203 garbage-collect less because the macro expansion will not have
|
|
|
5204 to be generated, used, and thrown away a hundred times.
|
|
|
5205
|
|
|
5206 You can find out how a macro expands by using the
|
|
|
5207 @code{cl-prettyexpand} function.
|
|
|
5208
|
|
|
5209 @defun cl-prettyexpand form &optional full
|
|
|
5210 This function takes a single Lisp form as an argument and inserts
|
|
|
5211 a nicely formatted copy of it in the current buffer (which must be
|
|
|
5212 in Lisp mode so that indentation works properly). It also expands
|
|
|
5213 all Lisp macros which appear in the form. The easiest way to use
|
|
|
5214 this function is to go to the @code{*scratch*} buffer and type, say,
|
|
|
5215
|
|
|
5216 @example
|
|
|
5217 (cl-prettyexpand '(loop for x below 10 collect x))
|
|
|
5218 @end example
|
|
|
5219
|
|
|
5220 @noindent
|
|
|
5221 and type @kbd{C-x C-e} immediately after the closing parenthesis;
|
|
|
5222 the expansion
|
|
|
5223
|
|
|
5224 @example
|
|
|
5225 (block nil
|
|
|
5226 (let* ((x 0)
|
|
|
5227 (G1004 nil))
|
|
|
5228 (while (< x 10)
|
|
|
5229 (setq G1004 (cons x G1004))
|
|
|
5230 (setq x (+ x 1)))
|
|
|
5231 (nreverse G1004)))
|
|
|
5232 @end example
|
|
|
5233
|
|
|
5234 @noindent
|
|
|
5235 will be inserted into the buffer. (The @code{block} macro is
|
|
|
5236 expanded differently in the interpreter and compiler, so
|
|
|
5237 @code{cl-prettyexpand} just leaves it alone. The temporary
|
|
|
5238 variable @code{G1004} was created by @code{gensym}.)
|
|
|
5239
|
|
|
5240 If the optional argument @var{full} is true, then @emph{all}
|
|
|
5241 macros are expanded, including @code{block}, @code{eval-when},
|
|
|
5242 and compiler macros. Expansion is done as if @var{form} were
|
|
|
5243 a top-level form in a file being compiled. For example,
|
|
|
5244
|
|
|
5245 @example
|
|
|
5246 (cl-prettyexpand '(pushnew 'x list))
|
|
|
5247 @print{} (setq list (adjoin 'x list))
|
|
|
5248 (cl-prettyexpand '(pushnew 'x list) t)
|
|
|
5249 @print{} (setq list (if (memq 'x list) list (cons 'x list)))
|
|
|
5250 (cl-prettyexpand '(caddr (member* 'a list)) t)
|
|
|
5251 @print{} (car (cdr (cdr (memq 'a list))))
|
|
|
5252 @end example
|
|
|
5253
|
|
|
5254 Note that @code{adjoin}, @code{caddr}, and @code{member*} all
|
|
|
5255 have built-in compiler macros to optimize them in common cases.
|
|
|
5256 @end defun
|
|
|
5257
|
|
|
5258 @ifinfo
|
|
|
5259 @example
|
|
|
5260
|
|
|
5261 @end example
|
|
|
5262 @end ifinfo
|
|
|
5263 @appendixsec Error Checking
|
|
|
5264
|
|
|
5265 @noindent
|
|
|
5266 Common Lisp compliance has in general not been sacrificed for the
|
|
|
5267 sake of efficiency. A few exceptions have been made for cases
|
|
|
5268 where substantial gains were possible at the expense of marginal
|
|
|
5269 incompatibility. One example is the use of @code{memq} (which is
|
|
|
5270 treated very efficiently by the byte-compiler) to scan for keyword
|
|
|
5271 arguments; this can become confused in rare cases when keyword
|
|
|
5272 symbols are used as both keywords and data values at once. This
|
|
|
5273 is extremely unlikely to occur in practical code, and the use of
|
|
|
5274 @code{memq} allows functions with keyword arguments to be nearly
|
|
|
5275 as fast as functions that use @code{&optional} arguments.
|
|
|
5276
|
|
|
5277 The Common Lisp standard (as embodied in Steele's book) uses the
|
|
|
5278 phrase ``it is an error if'' to indicate a situation which is not
|
|
|
5279 supposed to arise in complying programs; implementations are strongly
|
|
|
5280 encouraged but not required to signal an error in these situations.
|
|
|
5281 This package sometimes omits such error checking in the interest of
|
|
|
5282 compactness and efficiency. For example, @code{do} variable
|
|
|
5283 specifiers are supposed to be lists of one, two, or three forms;
|
|
|
5284 extra forms are ignored by this package rather than signalling a
|
|
|
5285 syntax error. The @code{endp} function is simply a synonym for
|
|
|
5286 @code{null} in this package. Functions taking keyword arguments
|
|
|
5287 will accept an odd number of arguments, treating the trailing
|
|
|
5288 keyword as if it were followed by the value @code{nil}.
|
|
|
5289
|
|
|
5290 Argument lists (as processed by @code{defun*} and friends)
|
|
|
5291 @emph{are} checked rigorously except for the minor point just
|
|
|
5292 mentioned; in particular, keyword arguments are checked for
|
|
|
5293 validity, and @code{&allow-other-keys} and @code{:allow-other-keys}
|
|
|
5294 are fully implemented. Keyword validity checking is slightly
|
|
|
5295 time consuming (though not too bad in byte-compiled code);
|
|
|
5296 you can use @code{&allow-other-keys} to omit this check. Functions
|
|
|
5297 defined in this package such as @code{find} and @code{member*}
|
|
|
5298 do check their keyword arguments for validity.
|
|
|
5299
|
|
|
5300 @ifinfo
|
|
|
5301 @example
|
|
|
5302
|
|
|
5303 @end example
|
|
|
5304 @end ifinfo
|
|
|
5305 @appendixsec Optimizing Compiler
|
|
|
5306
|
|
|
5307 @noindent
|
|
|
5308 The byte-compiler that comes with Emacs 18 normally fails to expand
|
|
|
5309 macros that appear in top-level positions in the file (i.e., outside
|
|
|
5310 of @code{defun}s or other enclosing forms). This would have
|
|
|
5311 disastrous consequences to programs that used such top-level macros
|
|
|
5312 as @code{defun*}, @code{eval-when}, and @code{defstruct}. To
|
|
|
5313 work around this problem, the @dfn{CL} package patches the Emacs
|
|
|
5314 18 compiler to expand top-level macros. This patch will apply to
|
|
|
5315 your own macros, too, if they are used in a top-level context.
|
|
|
5316 The patch will not harm versions of the Emacs 18 compiler which
|
|
|
5317 have already had a similar patch applied, nor will it affect the
|
|
|
5318 optimizing Emacs 19 byte-compiler written by Jamie Zawinski and
|
|
|
5319 Hallvard Furuseth. The patch is applied to the byte compiler's
|
|
|
5320 code in Emacs' memory, @emph{not} to the @file{bytecomp.elc} file
|
|
|
5321 stored on disk.
|
|
|
5322
|
|
|
5323 The Emacs 19 compiler (for Emacs 18) is available from various
|
|
|
5324 Emacs Lisp archive sites such as @code{archive.cis.ohio-state.edu}.
|
|
|
5325 Its use is highly recommended; many of the Common Lisp macros emit
|
|
|
5326 code which can be improved by optimization. In particular,
|
|
|
5327 @code{block}s (whether explicit or implicit in constructs like
|
|
|
5328 @code{defun*} and @code{loop}) carry a fair run-time penalty; the
|
|
|
5329 optimizing compiler removes @code{block}s which are not actually
|
|
|
5330 referenced by @code{return} or @code{return-from} inside the block.
|
|
|
5331
|
|
|
5332 @node Common Lisp Compatibility, Old CL Compatibility, Efficiency Concerns, Top
|
|
|
5333 @appendix Common Lisp Compatibility
|
|
|
5334
|
|
|
5335 @noindent
|
|
|
5336 Following is a list of all known incompatibilities between this
|
|
|
5337 package and Common Lisp as documented in Steele (2nd edition).
|
|
|
5338
|
|
|
5339 Certain function names, such as @code{member}, @code{assoc}, and
|
|
|
5340 @code{floor}, were already taken by (incompatible) Emacs Lisp
|
|
|
5341 functions; this package appends @samp{*} to the names of its
|
|
|
5342 Common Lisp versions of these functions.
|
|
|
5343
|
|
|
5344 The word @code{defun*} is required instead of @code{defun} in order
|
|
|
5345 to use extended Common Lisp argument lists in a function. Likewise,
|
|
|
5346 @code{defmacro*} and @code{function*} are versions of those forms
|
|
|
5347 which understand full-featured argument lists. The @code{&whole}
|
|
|
5348 keyword does not work in @code{defmacro} argument lists (except
|
|
|
5349 inside recursive argument lists).
|
|
|
5350
|
|
|
5351 In order to allow an efficient implementation, keyword arguments use
|
|
|
5352 a slightly cheesy parser which may be confused if a keyword symbol
|
|
|
5353 is passed as the @emph{value} of another keyword argument.
|
|
|
5354 (Specifically, @code{(memq :@var{keyword} @var{rest-of-arguments})}
|
|
|
5355 is used to scan for @code{:@var{keyword}} among the supplied
|
|
|
5356 keyword arguments.)
|
|
|
5357
|
|
|
5358 The @code{eql} and @code{equal} predicates do not distinguish
|
|
|
5359 between IEEE floating-point plus and minus zero. The @code{equalp}
|
|
|
5360 predicate has several differences with Common Lisp; @pxref{Predicates}.
|
|
|
5361
|
|
|
5362 The @code{setf} mechanism is entirely compatible, except that
|
|
|
5363 setf-methods return a list of five values rather than five
|
|
|
5364 values directly. Also, the new ``@code{setf} function'' concept
|
|
|
5365 (typified by @code{(defun (setf foo) @dots{})}) is not implemented.
|
|
|
5366
|
|
|
5367 The @code{do-all-symbols} form is the same as @code{do-symbols}
|
|
|
5368 with no @var{obarray} argument. In Common Lisp, this form would
|
|
|
5369 iterate over all symbols in all packages. Since Emacs obarrays
|
|
|
5370 are not a first-class package mechanism, there is no way for
|
|
|
5371 @code{do-all-symbols} to locate any but the default obarray.
|
|
|
5372
|
|
|
5373 The @code{loop} macro is complete except that @code{loop-finish}
|
|
|
5374 and type specifiers are unimplemented.
|
|
|
5375
|
|
|
5376 The multiple-value return facility treats lists as multiple
|
|
|
5377 values, since Emacs Lisp cannot support multiple return values
|
|
|
5378 directly. The macros will be compatible with Common Lisp if
|
|
|
5379 @code{values} or @code{values-list} is always used to return to
|
|
|
5380 a @code{multiple-value-bind} or other multiple-value receiver;
|
|
|
5381 if @code{values} is used without @code{multiple-value-@dots{}}
|
|
|
5382 or vice-versa the effect will be different from Common Lisp.
|
|
|
5383
|
|
|
5384 Many Common Lisp declarations are ignored, and others match
|
|
|
5385 the Common Lisp standard in concept but not in detail. For
|
|
|
5386 example, local @code{special} declarations, which are purely
|
|
|
5387 advisory in Emacs Lisp, do not rigorously obey the scoping rules
|
|
|
5388 set down in Steele's book.
|
|
|
5389
|
|
|
5390 The variable @code{*gensym-counter*} starts out with a pseudo-random
|
|
|
5391 value rather than with zero. This is to cope with the fact that
|
|
|
5392 generated symbols become interned when they are written to and
|
|
|
5393 loaded back from a file.
|
|
|
5394
|
|
|
5395 The @code{defstruct} facility is compatible, except that structures
|
|
|
5396 are of type @code{:type vector :named} by default rather than some
|
|
|
5397 special, distinct type. Also, the @code{:type} slot option is ignored.
|
|
|
5398
|
|
|
5399 The second argument of @code{check-type} is treated differently.
|
|
|
5400
|
|
|
5401 @node Old CL Compatibility, Porting Common Lisp, Common Lisp Compatibility, Top
|
|
|
5402 @appendix Old CL Compatibility
|
|
|
5403
|
|
|
5404 @noindent
|
|
|
5405 Following is a list of all known incompatibilities between this package
|
|
|
5406 and the older Quiroz @file{cl.el} package.
|
|
|
5407
|
|
|
5408 This package's emulation of multiple return values in functions is
|
|
|
5409 incompatible with that of the older package. That package attempted
|
|
|
5410 to come as close as possible to true Common Lisp multiple return
|
|
|
5411 values; unfortunately, it could not be 100% reliable and so was prone
|
|
|
5412 to occasional surprises if used freely. This package uses a simpler
|
|
|
5413 method, namely replacing multiple values with lists of values, which
|
|
|
5414 is more predictable though more noticeably different from Common Lisp.
|
|
|
5415
|
|
|
5416 The @code{defkeyword} form and @code{keywordp} function are not
|
|
|
5417 implemented in this package.
|
|
|
5418
|
|
|
5419 The @code{member}, @code{floor}, @code{ceiling}, @code{truncate},
|
|
|
5420 @code{round}, @code{mod}, and @code{rem} functions are suffixed
|
|
|
5421 by @samp{*} in this package to avoid collision with existing
|
|
|
5422 functions in Emacs 18 or Emacs 19. The older package simply
|
|
|
5423 redefined these functions, overwriting the built-in meanings and
|
|
|
5424 causing serious portability problems with Emacs 19. (Some more
|
|
|
5425 recent versions of the Quiroz package changed the names to
|
|
|
5426 @code{cl-member}, etc.; this package defines the latter names as
|
|
|
5427 aliases for @code{member*}, etc.)
|
|
|
5428
|
|
|
5429 Certain functions in the old package which were buggy or inconsistent
|
|
|
5430 with the Common Lisp standard are incompatible with the conforming
|
|
|
5431 versions in this package. For example, @code{eql} and @code{member}
|
|
|
5432 were synonyms for @code{eq} and @code{memq} in that package, @code{setf}
|
|
|
5433 failed to preserve correct order of evaluation of its arguments, etc.
|
|
|
5434
|
|
|
5435 Finally, unlike the older package, this package is careful to
|
|
|
5436 prefix all of its internal names with @code{cl-}. Except for a
|
|
|
5437 few functions which are explicitly defined as additional features
|
|
|
5438 (such as @code{floatp-safe} and @code{letf}), this package does not
|
|
|
5439 export any non-@samp{cl-} symbols which are not also part of Common
|
|
|
5440 Lisp.
|
|
|
5441
|
|
|
5442 @ifinfo
|
|
|
5443 @example
|
|
|
5444
|
|
|
5445 @end example
|
|
|
5446 @end ifinfo
|
|
|
5447 @appendixsec The @code{cl-compat} package
|
|
|
5448
|
|
|
5449 @noindent
|
|
|
5450 The @dfn{CL} package includes emulations of some features of the
|
|
|
5451 old @file{cl.el}, in the form of a compatibility package
|
|
|
5452 @code{cl-compat}. To use it, put @code{(require 'cl-compat)} in
|
|
|
5453 your program.
|
|
|
5454
|
|
|
5455 The old package defined a number of internal routines without
|
|
|
5456 @code{cl-} prefixes or other annotations. Call to these routines
|
|
|
5457 may have crept into existing Lisp code. @code{cl-compat}
|
|
|
5458 provides emulations of the following internal routines:
|
|
|
5459 @code{pair-with-newsyms}, @code{zip-lists}, @code{unzip-lists},
|
|
|
5460 @code{reassemble-arglists}, @code{duplicate-symbols-p},
|
|
|
5461 @code{safe-idiv}.
|
|
|
5462
|
|
|
5463 Some @code{setf} forms translated into calls to internal
|
|
|
5464 functions that user code might call directly. The functions
|
|
|
5465 @code{setnth}, @code{setnthcdr}, and @code{setelt} fall in
|
|
|
5466 this category; they are defined by @code{cl-compat}, but the
|
|
|
5467 best fix is to change to use @code{setf} properly.
|
|
|
5468
|
|
|
5469 The @code{cl-compat} file defines the keyword functions
|
|
|
5470 @code{keywordp}, @code{keyword-of}, and @code{defkeyword},
|
|
|
5471 which are not defined by the new @dfn{CL} package because the
|
|
|
5472 use of keywords as data is discouraged.
|
|
|
5473
|
|
|
5474 The @code{build-klist} mechanism for parsing keyword arguments
|
|
|
5475 is emulated by @code{cl-compat}; the @code{with-keyword-args}
|
|
|
5476 macro is not, however, and in any case it's best to change to
|
|
|
5477 use the more natural keyword argument processing offered by
|
|
|
5478 @code{defun*}.
|
|
|
5479
|
|
|
5480 Multiple return values are treated differently by the two
|
|
|
5481 Common Lisp packages. The old package's method was more
|
|
|
5482 compatible with true Common Lisp, though it used heuristics
|
|
|
5483 that caused it to report spurious multiple return values in
|
|
|
5484 certain cases. The @code{cl-compat} package defines a set
|
|
|
5485 of multiple-value macros that are compatible with the old
|
|
|
5486 CL package; again, they are heuristic in nature, but they
|
|
|
5487 are guaranteed to work in any case where the old package's
|
|
|
5488 macros worked. To avoid name collision with the ``official''
|
|
|
5489 multiple-value facilities, the ones in @code{cl-compat} have
|
|
|
5490 capitalized names: @code{Values}, @code{Values-list},
|
|
|
5491 @code{Multiple-value-bind}, etc.
|
|
|
5492
|
|
|
5493 The functions @code{cl-floor}, @code{cl-ceiling}, @code{cl-truncate},
|
|
|
5494 and @code{cl-round} are defined by @code{cl-compat} to use the
|
|
|
5495 old-style multiple-value mechanism, just as they did in the old
|
|
|
5496 package. The newer @code{floor*} and friends return their two
|
|
|
5497 results in a list rather than as multiple values. Note that
|
|
|
5498 older versions of the old package used the unadorned names
|
|
|
5499 @code{floor}, @code{ceiling}, etc.; @code{cl-compat} cannot use
|
|
|
5500 these names because they conflict with Emacs 19 built-ins.
|
|
|
5501
|
|
|
5502 @node Porting Common Lisp, Function Index, Old CL Compatibility, Top
|
|
|
5503 @appendix Porting Common Lisp
|
|
|
5504
|
|
|
5505 @noindent
|
|
|
5506 This package is meant to be used as an extension to Emacs Lisp,
|
|
|
5507 not as an Emacs implementation of true Common Lisp. Some of the
|
|
|
5508 remaining differences between Emacs Lisp and Common Lisp make it
|
|
|
5509 difficult to port large Common Lisp applications to Emacs. For
|
|
|
5510 one, some of the features in this package are not fully compliant
|
|
|
5511 with ANSI or Steele; @pxref{Common Lisp Compatibility}. But there
|
|
|
5512 are also quite a few features that this package does not provide
|
|
|
5513 at all. Here are some major omissions that you will want watch out
|
|
|
5514 for when bringing Common Lisp code into Emacs.
|
|
|
5515
|
|
|
5516 @itemize @bullet
|
|
|
5517 @item
|
|
|
5518 Case-insensitivity. Symbols in Common Lisp are case-insensitive
|
|
|
5519 by default. Some programs refer to a function or variable as
|
|
|
5520 @code{foo} in one place and @code{Foo} or @code{FOO} in another.
|
|
|
5521 Emacs Lisp will treat these as three distinct symbols.
|
|
|
5522
|
|
|
5523 Some Common Lisp code is written in all upper-case. While Emacs
|
|
|
5524 is happy to let the program's own functions and variables use
|
|
|
5525 this convention, calls to Lisp builtins like @code{if} and
|
|
|
5526 @code{defun} will have to be changed to lower-case.
|
|
|
5527
|
|
|
5528 @item
|
|
|
5529 Lexical scoping. In Common Lisp, function arguments and @code{let}
|
|
|
5530 bindings apply only to references physically within their bodies
|
|
|
5531 (or within macro expansions in their bodies). Emacs Lisp, by
|
|
|
5532 contrast, uses @dfn{dynamic scoping} wherein a binding to a
|
|
|
5533 variable is visible even inside functions called from the body.
|
|
|
5534
|
|
|
5535 Variables in Common Lisp can be made dynamically scoped by
|
|
|
5536 declaring them @code{special} or using @code{defvar}. In Emacs
|
|
|
5537 Lisp it is as if all variables were declared @code{special}.
|
|
|
5538
|
|
|
5539 Often you can use code that was written for lexical scoping
|
|
|
5540 even in a dynamically scoped Lisp, but not always. Here is
|
|
|
5541 an example of a Common Lisp code fragment that would fail in
|
|
|
5542 Emacs Lisp:
|
|
|
5543
|
|
|
5544 @example
|
|
|
5545 (defun map-odd-elements (func list)
|
|
|
5546 (loop for x in list
|
|
|
5547 for flag = t then (not flag)
|
|
|
5548 collect (if flag x (funcall func x))))
|
|
|
5549
|
|
|
5550 (defun add-odd-elements (list x)
|
|
|
5551 (map-odd-elements (function (lambda (a) (+ a x))) list))
|
|
|
5552 @end example
|
|
|
5553
|
|
|
5554 @noindent
|
|
|
5555 In Common Lisp, the two functions' usages of @code{x} are completely
|
|
|
5556 independent. In Emacs Lisp, the binding to @code{x} made by
|
|
|
5557 @code{add-odd-elements} will have been hidden by the binding
|
|
|
5558 in @code{map-odd-elements} by the time the @code{(+ a x)} function
|
|
|
5559 is called.
|
|
|
5560
|
|
|
5561 (This package avoids such problems in its own mapping functions
|
|
|
5562 by using names like @code{cl-x} instead of @code{x} internally;
|
|
|
5563 as long as you don't use the @code{cl-} prefix for your own
|
|
|
5564 variables no collision can occur.)
|
|
|
5565
|
|
|
5566 @xref{Lexical Bindings}, for a description of the @code{lexical-let}
|
|
|
5567 form which establishes a Common Lisp-style lexical binding, and some
|
|
|
5568 examples of how it differs from Emacs' regular @code{let}.
|
|
|
5569
|
|
|
5570 @item
|
|
|
5571 Common Lisp allows the shorthand @code{#'x} to stand for
|
|
|
5572 @code{(function x)}, just as @code{'x} stands for @code{(quote x)}.
|
|
|
5573 In Common Lisp, one traditionally uses @code{#'} notation when
|
|
|
5574 referring to the name of a function. In Emacs Lisp, it works
|
|
|
5575 just as well to use a regular quote:
|
|
|
5576
|
|
|
5577 @example
|
|
|
5578 (loop for x in y by #'cddr collect (mapcar #'plusp x)) ; Common Lisp
|
|
|
5579 (loop for x in y by 'cddr collect (mapcar 'plusp x)) ; Emacs Lisp
|
|
|
5580 @end example
|
|
|
5581
|
|
|
5582 When @code{#'} introduces a @code{lambda} form, it is best to
|
|
|
5583 write out @code{(function ...)} longhand in Emacs Lisp. You can
|
|
|
5584 use a regular quote, but then the byte-compiler won't know that
|
|
|
5585 the @code{lambda} expression is code that can be compiled.
|
|
|
5586
|
|
|
5587 @example
|
|
|
5588 (mapcar #'(lambda (x) (* x 2)) list) ; Common Lisp
|
|
|
5589 (mapcar (function (lambda (x) (* x 2))) list) ; Emacs Lisp
|
|
|
5590 @end example
|
|
|
5591
|
|
|
5592 Lucid Emacs supports @code{#'} notation starting with version 19.8.
|
|
|
5593
|
|
|
5594 @item
|
|
|
5595 The ``backquote'' feature uses a different syntax in Emacs Lisp.
|
|
|
5596
|
|
|
5597 @example
|
|
|
5598 (defmacro foo (v &rest body) `(let ((,v 0)) @@,body)) ; Common Lisp
|
|
|
5599 (defmacro foo (v &rest body) (` (let (((, v) 0)) (@@, body))) ; Emacs
|
|
|
5600 @end example
|
|
|
5601
|
|
|
5602 @item
|
|
|
5603 Reader macros. Common Lisp includes a second type of macro that
|
|
|
5604 works at the level of individual characters. For example, Common
|
|
|
5605 Lisp implements the quote notation by a reader macro called @code{'},
|
|
|
5606 whereas Emacs Lisp's parser just treats quote as a special case.
|
|
|
5607 Some Lisp packages use reader macros to create special syntaxes
|
|
|
5608 for themselves, which the Emacs parser is incapable of reading.
|
|
|
5609
|
|
|
5610 The lack of reader macros, incidentally, is the reason behind
|
|
|
5611 Emacs Lisp's unusual backquote syntax. Since backquotes are
|
|
|
5612 implemented as a Lisp package and not built-in to the Emacs
|
|
|
5613 parser, they are forced to use a regular macro named @code{`}
|
|
|
5614 which is used with the standard function/macro call notation.
|
|
|
5615
|
|
|
5616 @item
|
|
|
5617 Other syntactic features. Common Lisp provides a number of
|
|
|
5618 notations beginning with @code{#} that the Emacs Lisp parser
|
|
|
5619 won't understand. For example, @samp{#| ... |#} is an
|
|
|
5620 alternate comment notation, and @samp{#+lucid (foo)} tells
|
|
|
5621 the parser to ignore the @code{(foo)} except in Lucid Common
|
|
|
5622 Lisp.
|
|
|
5623
|
|
|
5624 @item
|
|
|
5625 Packages. In Common Lisp, symbols are divided into @dfn{packages}.
|
|
|
5626 Symbols that are Lisp built-ins are typically stored in one package;
|
|
|
5627 symbols that are vendor extensions are put in another, and each
|
|
|
5628 application program would have a package for its own symbols.
|
|
|
5629 Certain symbols are ``exported'' by a package and others are
|
|
|
5630 internal; certain packages ``use'' or import the exported symbols
|
|
|
5631 of other packages. To access symbols that would not normally be
|
|
|
5632 visible due to this importing and exporting, Common Lisp provides
|
|
|
5633 a syntax like @code{package:symbol} or @code{package::symbol}.
|
|
|
5634
|
|
|
5635 Emacs Lisp has a single namespace for all interned symbols, and
|
|
|
5636 then uses a naming convention of putting a prefix like @code{cl-}
|
|
|
5637 in front of the name. Some Emacs packages adopt the Common Lisp-like
|
|
|
5638 convention of using @code{cl:} or @code{cl::} as the prefix.
|
|
|
5639 However, the Emacs parser does not understand colons and just
|
|
|
5640 treats them as part of the symbol name. Thus, while @code{mapcar}
|
|
|
5641 and @code{lisp:mapcar} may refer to the same symbol in Common
|
|
|
5642 Lisp, they are totally distinct in Emacs Lisp. Common Lisp
|
|
|
5643 programs which refer to a symbol by the full name sometimes
|
|
|
5644 and the short name other times will not port cleanly to Emacs.
|
|
|
5645
|
|
|
5646 Emacs Lisp does have a concept of ``obarrays,'' which are
|
|
|
5647 package-like collections of symbols, but this feature is not
|
|
|
5648 strong enough to be used as a true package mechanism.
|
|
|
5649
|
|
|
5650 @item
|
|
|
5651 Keywords. The notation @code{:test-not} in Common Lisp really
|
|
|
5652 is a shorthand for @code{keyword:test-not}; keywords are just
|
|
|
5653 symbols in a built-in @code{keyword} package with the special
|
|
|
5654 property that all its symbols are automatically self-evaluating.
|
|
|
5655 Common Lisp programs often use keywords liberally to avoid
|
|
|
5656 having to use quotes.
|
|
|
5657
|
|
|
5658 In Emacs Lisp a keyword is just a symbol whose name begins with
|
|
|
5659 a colon; since the Emacs parser does not treat them specially,
|
|
|
5660 they have to be explicitly made self-evaluating by a statement
|
|
|
5661 like @code{(setq :test-not ':test-not)}. This package arranges
|
|
|
5662 to execute such a statement whenever @code{defun*} or some
|
|
|
5663 other form sees a keyword being used as an argument. Common
|
|
|
5664 Lisp code that assumes that a symbol @code{:mumble} will be
|
|
|
5665 self-evaluating even though it was never introduced by a
|
|
|
5666 @code{defun*} will have to be fixed.
|
|
|
5667
|
|
|
5668 @item
|
|
|
5669 The @code{format} function is quite different between Common
|
|
|
5670 Lisp and Emacs Lisp. It takes an additional ``destination''
|
|
|
5671 argument before the format string. A destination of @code{nil}
|
|
|
5672 means to format to a string as in Emacs Lisp; a destination
|
|
|
5673 of @code{t} means to write to the terminal (similar to
|
|
|
5674 @code{message} in Emacs). Also, format control strings are
|
|
|
5675 utterly different; @code{~} is used instead of @code{%} to
|
|
|
5676 introduce format codes, and the set of available codes is
|
|
|
5677 much richer. There are no notations like @code{\n} for
|
|
|
5678 string literals; instead, @code{format} is used with the
|
|
|
5679 ``newline'' format code, @code{~%}. More advanced formatting
|
|
|
5680 codes provide such features as paragraph filling, case
|
|
|
5681 conversion, and even loops and conditionals.
|
|
|
5682
|
|
|
5683 While it would have been possible to implement most of Common
|
|
|
5684 Lisp @code{format} in this package (under the name @code{format*},
|
|
|
5685 of course), it was not deemed worthwhile. It would have required
|
|
|
5686 a huge amount of code to implement even a decent subset of
|
|
|
5687 @code{format*}, yet the functionality it would provide over
|
|
|
5688 Emacs Lisp's @code{format} would rarely be useful.
|
|
|
5689
|
|
|
5690 @item
|
|
|
5691 Vector constants use square brackets in Emacs Lisp, but
|
|
|
5692 @code{#(a b c)} notation in Common Lisp. To further complicate
|
|
|
5693 matters, Emacs 19 introduces its own @code{#(} notation for
|
|
|
5694 something entirely different---strings with properties.
|
|
|
5695
|
|
|
5696 @item
|
|
|
5697 Characters are distinct from integers in Common Lisp. The
|
|
|
5698 notation for character constants is also different: @code{#\A}
|
|
|
5699 instead of @code{?A}. Also, @code{string=} and @code{string-equal}
|
|
|
5700 are synonyms in Emacs Lisp whereas the latter is case-insensitive
|
|
|
5701 in Common Lisp.
|
|
|
5702
|
|
|
5703 @item
|
|
|
5704 Data types. Some Common Lisp data types do not exist in Emacs
|
|
|
5705 Lisp. Rational numbers and complex numbers are not present,
|
|
|
5706 nor are large integers (all integers are ``fixnums''). All
|
|
|
5707 arrays are one-dimensional. There are no readtables or pathnames;
|
|
|
5708 streams are a set of existing data types rather than a new data
|
|
|
5709 type of their own. Hash tables, random-states, structures, and
|
|
|
5710 packages (obarrays) are built from Lisp vectors or lists rather
|
|
|
5711 than being distinct types.
|
|
|
5712
|
|
|
5713 @item
|
|
|
5714 The Common Lisp Object System (CLOS) is not implemented,
|
|
|
5715 nor is the Common Lisp Condition System.
|
|
|
5716
|
|
|
5717 @item
|
|
|
5718 Common Lisp features that are completely redundant with Emacs
|
|
|
5719 Lisp features of a different name generally have not been
|
|
|
5720 implemented. For example, Common Lisp writes @code{defconstant}
|
|
|
5721 where Emacs Lisp uses @code{defconst}. Similarly, @code{make-list}
|
|
|
5722 takes its arguments in different ways in the two Lisps but does
|
|
|
5723 exactly the same thing, so this package has not bothered to
|
|
|
5724 implement a Common Lisp-style @code{make-list}.
|
|
|
5725
|
|
|
5726 @item
|
|
|
5727 A few more notable Common Lisp features not included in this
|
|
|
5728 package: @code{compiler-let}, @code{tagbody}, @code{prog},
|
|
|
5729 @code{ldb/dpb}, @code{parse-integer}, @code{cerror}.
|
|
|
5730
|
|
|
5731 @item
|
|
|
5732 Recursion. While recursion works in Emacs Lisp just like it
|
|
|
5733 does in Common Lisp, various details of the Emacs Lisp system
|
|
|
5734 and compiler make recursion much less efficient than it is in
|
|
|
5735 most Lisps. Some schools of thought prefer to use recursion
|
|
|
5736 in Lisp over other techniques; they would sum a list of
|
|
|
5737 numbers using something like
|
|
|
5738
|
|
|
5739 @example
|
|
|
5740 (defun sum-list (list)
|
|
|
5741 (if list
|
|
|
5742 (+ (car list) (sum-list (cdr list)))
|
|
|
5743 0))
|
|
|
5744 @end example
|
|
|
5745
|
|
|
5746 @noindent
|
|
|
5747 where a more iteratively-minded programmer might write one of
|
|
|
5748 these forms:
|
|
|
5749
|
|
|
5750 @example
|
|
|
5751 (let ((total 0)) (dolist (x my-list) (incf total x)) total)
|
|
|
5752 (loop for x in my-list sum x)
|
|
|
5753 @end example
|
|
|
5754
|
|
|
5755 While this would be mainly a stylistic choice in most Common Lisps,
|
|
|
5756 in Emacs Lisp you should be aware that the iterative forms are
|
|
|
5757 much faster than recursion. Also, Lisp programmers will want to
|
|
|
5758 note that the current Emacs Lisp compiler does not optimize tail
|
|
|
5759 recursion.
|
|
|
5760 @end itemize
|
|
|
5761
|
|
|
5762 @node Function Index, Variable Index, Porting Common Lisp, Top
|
|
|
5763 @unnumbered Function Index
|
|
|
5764
|
|
|
5765 @printindex fn
|
|
|
5766
|
|
|
5767 @node Variable Index, , Function Index, Top
|
|
|
5768 @unnumbered Variable Index
|
|
|
5769
|
|
|
5770 @printindex vr
|
|
|
5771
|
|
|
5772 @contents
|
|
|
5773 @bye
|
