annotate man/cl.texi @ 38122:4aeb215906f3

Proofreading fixes from Peter Milliken <Peter.Milliken@GTECH.COM>.
author Eli Zaretskii <eliz@gnu.org>
date Wed, 20 Jun 2001 09:22:42 +0000
parents 508fd85ab816
children e9ca70d27e37
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1 \input texinfo @c -*-texinfo-*-
Dave Love <fx@gnu.org>
parents:
diff changeset
2 @setfilename ../info/cl
Dave Love <fx@gnu.org>
parents:
diff changeset
3 @settitle Common Lisp Extensions
Dave Love <fx@gnu.org>
parents:
diff changeset
4
30009
95bdbefcdac6 Use dircategory `Emacs'.
Gerd Moellmann <gerd@gnu.org>
parents: 29713
diff changeset
5 @dircategory Emacs
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
6 @direntry
Dave Love <fx@gnu.org>
parents:
diff changeset
7 * CL: (cl). Partial Common Lisp support for Emacs Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
8 @end direntry
Dave Love <fx@gnu.org>
parents:
diff changeset
9
Dave Love <fx@gnu.org>
parents:
diff changeset
10 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
11 @finalout
Dave Love <fx@gnu.org>
parents:
diff changeset
12 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
13
Dave Love <fx@gnu.org>
parents:
diff changeset
14 @ifinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
15 This file documents the GNU Emacs Common Lisp emulation package.
Dave Love <fx@gnu.org>
parents:
diff changeset
16
Dave Love <fx@gnu.org>
parents:
diff changeset
17 Copyright (C) 1993 Free Software Foundation, Inc.
Dave Love <fx@gnu.org>
parents:
diff changeset
18
32315
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
19
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
20 Permission is granted to copy, distribute and/or modify this document
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
21 under the terms of the GNU Free Documentation License, Version 1.1 or
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
22 any later version published by the Free Software Foundation; with no
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
23 Invariant Sections, with the Front-Cover texts being ``A GNU
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
24 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
25 license is included in the section entitled ``GNU Free Documentation
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
26 License'' in the Emacs manual.
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
27
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
28 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
29 this GNU Manual, like GNU software. Copies published by the Free
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
30 Software Foundation raise funds for GNU development.''
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
31
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
32 This document is part of a collection distributed under the GNU Free
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
33 Documentation License. If you want to distribute this document
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
34 separately from the collection, you can do so by adding a copy of the
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
35 license to the document, as described in section 6 of the license.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
36 @end ifinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
37
Dave Love <fx@gnu.org>
parents:
diff changeset
38 @titlepage
Dave Love <fx@gnu.org>
parents:
diff changeset
39 @sp 6
Dave Love <fx@gnu.org>
parents:
diff changeset
40 @center @titlefont{Common Lisp Extensions}
Dave Love <fx@gnu.org>
parents:
diff changeset
41 @sp 4
Dave Love <fx@gnu.org>
parents:
diff changeset
42 @center For GNU Emacs Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
43 @sp 1
Dave Love <fx@gnu.org>
parents:
diff changeset
44 @center Version 2.02
Dave Love <fx@gnu.org>
parents:
diff changeset
45 @sp 5
Dave Love <fx@gnu.org>
parents:
diff changeset
46 @center Dave Gillespie
Dave Love <fx@gnu.org>
parents:
diff changeset
47 @center daveg@@synaptics.com
Dave Love <fx@gnu.org>
parents:
diff changeset
48 @page
Dave Love <fx@gnu.org>
parents:
diff changeset
49
Dave Love <fx@gnu.org>
parents:
diff changeset
50 @vskip 0pt plus 1filll
Dave Love <fx@gnu.org>
parents:
diff changeset
51 Copyright @copyright{} 1993 Free Software Foundation, Inc.
Dave Love <fx@gnu.org>
parents:
diff changeset
52
32315
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
53 Permission is granted to copy, distribute and/or modify this document
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
54 under the terms of the GNU Free Documentation License, Version 1.1 or
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
55 any later version published by the Free Software Foundation; with no
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
56 Invariant Sections, with the Front-Cover texts being ``A GNU
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
57 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
58 license is included in the section entitled ``GNU Free Documentation
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
59 License'' in the Emacs manual.
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
60
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
61 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
62 this GNU Manual, like GNU software. Copies published by the Free
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
63 Software Foundation raise funds for GNU development.''
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
64
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
65 This document is part of a collection distributed under the GNU Free
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
66 Documentation License. If you want to distribute this document
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
67 separately from the collection, you can do so by adding a copy of the
0da9507401c4 Convert to GFDL.
Dave Love <fx@gnu.org>
parents: 31572
diff changeset
68 license to the document, as described in section 6 of the license.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
69 @end titlepage
Dave Love <fx@gnu.org>
parents:
diff changeset
70
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
71 @node Top, Overview, (dir), (dir)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
72 @chapter Common Lisp Extensions
Dave Love <fx@gnu.org>
parents:
diff changeset
73
Dave Love <fx@gnu.org>
parents:
diff changeset
74 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
75 This document describes a set of Emacs Lisp facilities borrowed from
Dave Love <fx@gnu.org>
parents:
diff changeset
76 Common Lisp. All the facilities are described here in detail. While
Dave Love <fx@gnu.org>
parents:
diff changeset
77 this document does not assume any prior knowledge of Common Lisp, it
Dave Love <fx@gnu.org>
parents:
diff changeset
78 does assume a basic familiarity with Emacs Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
79
Dave Love <fx@gnu.org>
parents:
diff changeset
80 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
81 * Overview:: Installation, usage, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
82 * Program Structure:: Arglists, `eval-when', `defalias'
Dave Love <fx@gnu.org>
parents:
diff changeset
83 * Predicates:: `typep', `eql', and `equalp'
Dave Love <fx@gnu.org>
parents:
diff changeset
84 * Control Structure:: `setf', `do', `loop', etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
85 * Macros:: Destructuring, `define-compiler-macro'
Dave Love <fx@gnu.org>
parents:
diff changeset
86 * Declarations:: `proclaim', `declare', etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
87 * Symbols:: Property lists, `gensym'
Dave Love <fx@gnu.org>
parents:
diff changeset
88 * Numbers:: Predicates, functions, random numbers
Dave Love <fx@gnu.org>
parents:
diff changeset
89 * Sequences:: Mapping, functions, searching, sorting
Dave Love <fx@gnu.org>
parents:
diff changeset
90 * Lists:: `cadr', `sublis', `member*', `assoc*', etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
91 * Structures:: `defstruct'
Dave Love <fx@gnu.org>
parents:
diff changeset
92 * Assertions:: `check-type', `assert', `ignore-errors'.
Dave Love <fx@gnu.org>
parents:
diff changeset
93
Dave Love <fx@gnu.org>
parents:
diff changeset
94 * Efficiency Concerns:: Hints and techniques
Dave Love <fx@gnu.org>
parents:
diff changeset
95 * Common Lisp Compatibility:: All known differences with Steele
Dave Love <fx@gnu.org>
parents:
diff changeset
96 * Old CL Compatibility:: All known differences with old cl.el
Dave Love <fx@gnu.org>
parents:
diff changeset
97 * Porting Common Lisp:: Hints for porting Common Lisp code
Dave Love <fx@gnu.org>
parents:
diff changeset
98
Dave Love <fx@gnu.org>
parents:
diff changeset
99 * Function Index::
Dave Love <fx@gnu.org>
parents:
diff changeset
100 * Variable Index::
Dave Love <fx@gnu.org>
parents:
diff changeset
101 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
102
Dave Love <fx@gnu.org>
parents:
diff changeset
103 @node Overview, Program Structure, Top, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
104 @ifinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
105 @chapter Overview
Dave Love <fx@gnu.org>
parents:
diff changeset
106 @end ifinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
107 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
108 @section Overview
Dave Love <fx@gnu.org>
parents:
diff changeset
109 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
110
Dave Love <fx@gnu.org>
parents:
diff changeset
111 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
112 Common Lisp is a huge language, and Common Lisp systems tend to be
Dave Love <fx@gnu.org>
parents:
diff changeset
113 massive and extremely complex. Emacs Lisp, by contrast, is rather
Dave Love <fx@gnu.org>
parents:
diff changeset
114 minimalist in the choice of Lisp features it offers the programmer.
Dave Love <fx@gnu.org>
parents:
diff changeset
115 As Emacs Lisp programmers have grown in number, and the applications
Dave Love <fx@gnu.org>
parents:
diff changeset
116 they write have grown more ambitious, it has become clear that Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
117 Lisp could benefit from many of the conveniences of Common Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
118
Dave Love <fx@gnu.org>
parents:
diff changeset
119 The @dfn{CL} package adds a number of Common Lisp functions and
Dave Love <fx@gnu.org>
parents:
diff changeset
120 control structures to Emacs Lisp. While not a 100% complete
Dave Love <fx@gnu.org>
parents:
diff changeset
121 implementation of Common Lisp, @dfn{CL} adds enough functionality
Dave Love <fx@gnu.org>
parents:
diff changeset
122 to make Emacs Lisp programming significantly more convenient.
Dave Love <fx@gnu.org>
parents:
diff changeset
123
Dave Love <fx@gnu.org>
parents:
diff changeset
124 Some Common Lisp features have been omitted from this package
Dave Love <fx@gnu.org>
parents:
diff changeset
125 for various reasons:
Dave Love <fx@gnu.org>
parents:
diff changeset
126
Dave Love <fx@gnu.org>
parents:
diff changeset
127 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
128 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
129 Some features are too complex or bulky relative to their benefit
Dave Love <fx@gnu.org>
parents:
diff changeset
130 to Emacs Lisp programmers. CLOS and Common Lisp streams are fine
Dave Love <fx@gnu.org>
parents:
diff changeset
131 examples of this group.
Dave Love <fx@gnu.org>
parents:
diff changeset
132
Dave Love <fx@gnu.org>
parents:
diff changeset
133 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
134 Other features cannot be implemented without modification to the
Dave Love <fx@gnu.org>
parents:
diff changeset
135 Emacs Lisp interpreter itself, such as multiple return values,
Dave Love <fx@gnu.org>
parents:
diff changeset
136 lexical scoping, case-insensitive symbols, and complex numbers.
Dave Love <fx@gnu.org>
parents:
diff changeset
137 The @dfn{CL} package generally makes no attempt to emulate these
Dave Love <fx@gnu.org>
parents:
diff changeset
138 features.
Dave Love <fx@gnu.org>
parents:
diff changeset
139
Dave Love <fx@gnu.org>
parents:
diff changeset
140 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
141 Some features conflict with existing things in Emacs Lisp. For
Dave Love <fx@gnu.org>
parents:
diff changeset
142 example, Emacs' @code{assoc} function is incompatible with the
Dave Love <fx@gnu.org>
parents:
diff changeset
143 Common Lisp @code{assoc}. In such cases, this package usually
Dave Love <fx@gnu.org>
parents:
diff changeset
144 adds the suffix @samp{*} to the function name of the Common
Dave Love <fx@gnu.org>
parents:
diff changeset
145 Lisp version of the function (e.g., @code{assoc*}).
Dave Love <fx@gnu.org>
parents:
diff changeset
146 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
147
Dave Love <fx@gnu.org>
parents:
diff changeset
148 The package described here was written by Dave Gillespie,
Dave Love <fx@gnu.org>
parents:
diff changeset
149 @file{daveg@@synaptics.com}. It is a total rewrite of the original
Dave Love <fx@gnu.org>
parents:
diff changeset
150 1986 @file{cl.el} package by Cesar Quiroz. Most features of the
Dave Love <fx@gnu.org>
parents:
diff changeset
151 the Quiroz package have been retained; any incompatibilities are
Dave Love <fx@gnu.org>
parents:
diff changeset
152 noted in the descriptions below. Care has been taken in this
Dave Love <fx@gnu.org>
parents:
diff changeset
153 version to ensure that each function is defined efficiently,
Dave Love <fx@gnu.org>
parents:
diff changeset
154 concisely, and with minimal impact on the rest of the Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
155 environment.
Dave Love <fx@gnu.org>
parents:
diff changeset
156
Dave Love <fx@gnu.org>
parents:
diff changeset
157 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
158 * Usage:: How to use the CL package
Dave Love <fx@gnu.org>
parents:
diff changeset
159 * Organization:: The package's five component files
Dave Love <fx@gnu.org>
parents:
diff changeset
160 * Installation:: Compiling and installing CL
Dave Love <fx@gnu.org>
parents:
diff changeset
161 * Naming Conventions:: Notes on CL function names
Dave Love <fx@gnu.org>
parents:
diff changeset
162 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
163
Dave Love <fx@gnu.org>
parents:
diff changeset
164 @node Usage, Organization, Overview, Overview
Dave Love <fx@gnu.org>
parents:
diff changeset
165 @section Usage
Dave Love <fx@gnu.org>
parents:
diff changeset
166
Dave Love <fx@gnu.org>
parents:
diff changeset
167 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
168 Lisp code that uses features from the @dfn{CL} package should
Dave Love <fx@gnu.org>
parents:
diff changeset
169 include at the beginning:
Dave Love <fx@gnu.org>
parents:
diff changeset
170
Dave Love <fx@gnu.org>
parents:
diff changeset
171 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
172 (require 'cl)
Dave Love <fx@gnu.org>
parents:
diff changeset
173 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
174
Dave Love <fx@gnu.org>
parents:
diff changeset
175 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
176 If you want to ensure that the new (Gillespie) version of @dfn{CL}
Dave Love <fx@gnu.org>
parents:
diff changeset
177 is the one that is present, add an additional @code{(require 'cl-19)}
Dave Love <fx@gnu.org>
parents:
diff changeset
178 call:
Dave Love <fx@gnu.org>
parents:
diff changeset
179
Dave Love <fx@gnu.org>
parents:
diff changeset
180 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
181 (require 'cl)
Dave Love <fx@gnu.org>
parents:
diff changeset
182 (require 'cl-19)
Dave Love <fx@gnu.org>
parents:
diff changeset
183 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
184
Dave Love <fx@gnu.org>
parents:
diff changeset
185 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
186 The second call will fail (with ``@file{cl-19.el} not found'') if
Dave Love <fx@gnu.org>
parents:
diff changeset
187 the old @file{cl.el} package was in use.
Dave Love <fx@gnu.org>
parents:
diff changeset
188
Dave Love <fx@gnu.org>
parents:
diff changeset
189 It is safe to arrange to load @dfn{CL} at all times, e.g.,
Dave Love <fx@gnu.org>
parents:
diff changeset
190 in your @file{.emacs} file. But it's a good idea, for portability,
Dave Love <fx@gnu.org>
parents:
diff changeset
191 to @code{(require 'cl)} in your code even if you do this.
Dave Love <fx@gnu.org>
parents:
diff changeset
192
Dave Love <fx@gnu.org>
parents:
diff changeset
193 @node Organization, Installation, Usage, Overview
Dave Love <fx@gnu.org>
parents:
diff changeset
194 @section Organization
Dave Love <fx@gnu.org>
parents:
diff changeset
195
Dave Love <fx@gnu.org>
parents:
diff changeset
196 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
197 The Common Lisp package is organized into four files:
Dave Love <fx@gnu.org>
parents:
diff changeset
198
Dave Love <fx@gnu.org>
parents:
diff changeset
199 @table @file
Dave Love <fx@gnu.org>
parents:
diff changeset
200 @item cl.el
Dave Love <fx@gnu.org>
parents:
diff changeset
201 This is the ``main'' file, which contains basic functions
Dave Love <fx@gnu.org>
parents:
diff changeset
202 and information about the package. This file is relatively
Dave Love <fx@gnu.org>
parents:
diff changeset
203 compact---about 700 lines.
Dave Love <fx@gnu.org>
parents:
diff changeset
204
Dave Love <fx@gnu.org>
parents:
diff changeset
205 @item cl-extra.el
Dave Love <fx@gnu.org>
parents:
diff changeset
206 This file contains the larger, more complex or unusual functions.
Dave Love <fx@gnu.org>
parents:
diff changeset
207 It is kept separate so that packages which only want to use Common
Dave Love <fx@gnu.org>
parents:
diff changeset
208 Lisp fundamentals like the @code{cadr} function won't need to pay
Dave Love <fx@gnu.org>
parents:
diff changeset
209 the overhead of loading the more advanced functions.
Dave Love <fx@gnu.org>
parents:
diff changeset
210
Dave Love <fx@gnu.org>
parents:
diff changeset
211 @item cl-seq.el
Dave Love <fx@gnu.org>
parents:
diff changeset
212 This file contains most of the advanced functions for operating
Dave Love <fx@gnu.org>
parents:
diff changeset
213 on sequences or lists, such as @code{delete-if} and @code{assoc*}.
Dave Love <fx@gnu.org>
parents:
diff changeset
214
Dave Love <fx@gnu.org>
parents:
diff changeset
215 @item cl-macs.el
Dave Love <fx@gnu.org>
parents:
diff changeset
216 This file contains the features of the packages which are macros
Dave Love <fx@gnu.org>
parents:
diff changeset
217 instead of functions. Macros expand when the caller is compiled,
Dave Love <fx@gnu.org>
parents:
diff changeset
218 not when it is run, so the macros generally only need to be
Dave Love <fx@gnu.org>
parents:
diff changeset
219 present when the byte-compiler is running (or when the macros are
Dave Love <fx@gnu.org>
parents:
diff changeset
220 used in uncompiled code such as a @file{.emacs} file). Most of
Dave Love <fx@gnu.org>
parents:
diff changeset
221 the macros of this package are isolated in @file{cl-macs.el} so
Dave Love <fx@gnu.org>
parents:
diff changeset
222 that they won't take up memory unless you are compiling.
Dave Love <fx@gnu.org>
parents:
diff changeset
223 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
224
Dave Love <fx@gnu.org>
parents:
diff changeset
225 The file @file{cl.el} includes all necessary @code{autoload}
Dave Love <fx@gnu.org>
parents:
diff changeset
226 commands for the functions and macros in the other three files.
Dave Love <fx@gnu.org>
parents:
diff changeset
227 All you have to do is @code{(require 'cl)}, and @file{cl.el}
Dave Love <fx@gnu.org>
parents:
diff changeset
228 will take care of pulling in the other files when they are
Dave Love <fx@gnu.org>
parents:
diff changeset
229 needed.
Dave Love <fx@gnu.org>
parents:
diff changeset
230
Dave Love <fx@gnu.org>
parents:
diff changeset
231 There is another file, @file{cl-compat.el}, which defines some
Dave Love <fx@gnu.org>
parents:
diff changeset
232 routines from the older @file{cl.el} package that are no longer
Dave Love <fx@gnu.org>
parents:
diff changeset
233 present in the new package. This includes internal routines
Dave Love <fx@gnu.org>
parents:
diff changeset
234 like @code{setelt} and @code{zip-lists}, deprecated features
Dave Love <fx@gnu.org>
parents:
diff changeset
235 like @code{defkeyword}, and an emulation of the old-style
Dave Love <fx@gnu.org>
parents:
diff changeset
236 multiple-values feature. @xref{Old CL Compatibility}.
Dave Love <fx@gnu.org>
parents:
diff changeset
237
Dave Love <fx@gnu.org>
parents:
diff changeset
238 @node Installation, Naming Conventions, Organization, Overview
Dave Love <fx@gnu.org>
parents:
diff changeset
239 @section Installation
Dave Love <fx@gnu.org>
parents:
diff changeset
240
Dave Love <fx@gnu.org>
parents:
diff changeset
241 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
242 Installation of the @dfn{CL} package is simple: Just put the
Dave Love <fx@gnu.org>
parents:
diff changeset
243 byte-compiled files @file{cl.elc}, @file{cl-extra.elc},
Dave Love <fx@gnu.org>
parents:
diff changeset
244 @file{cl-seq.elc}, @file{cl-macs.elc}, and @file{cl-compat.elc}
Dave Love <fx@gnu.org>
parents:
diff changeset
245 into a directory on your @code{load-path}.
Dave Love <fx@gnu.org>
parents:
diff changeset
246
Dave Love <fx@gnu.org>
parents:
diff changeset
247 There are no special requirements to compile this package:
Dave Love <fx@gnu.org>
parents:
diff changeset
248 The files do not have to be loaded before they are compiled,
Dave Love <fx@gnu.org>
parents:
diff changeset
249 nor do they need to be compiled in any particular order.
Dave Love <fx@gnu.org>
parents:
diff changeset
250
Dave Love <fx@gnu.org>
parents:
diff changeset
251 You may choose to put the files into your main @file{lisp/}
Dave Love <fx@gnu.org>
parents:
diff changeset
252 directory, replacing the original @file{cl.el} file there. Or,
Dave Love <fx@gnu.org>
parents:
diff changeset
253 you could put them into a directory that comes before @file{lisp/}
Dave Love <fx@gnu.org>
parents:
diff changeset
254 on your @code{load-path} so that the old @file{cl.el} is
Dave Love <fx@gnu.org>
parents:
diff changeset
255 effectively hidden.
Dave Love <fx@gnu.org>
parents:
diff changeset
256
Dave Love <fx@gnu.org>
parents:
diff changeset
257 Also, format the @file{cl.texinfo} file and put the resulting
Dave Love <fx@gnu.org>
parents:
diff changeset
258 Info files in the @file{info/} directory or another suitable place.
Dave Love <fx@gnu.org>
parents:
diff changeset
259
Dave Love <fx@gnu.org>
parents:
diff changeset
260 You may instead wish to leave this package's components all in
Dave Love <fx@gnu.org>
parents:
diff changeset
261 their own directory, and then add this directory to your
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
262 @code{load-path} and @code{Info-directory-list}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
263 Add the directory to the front of the list so the old @dfn{CL}
Dave Love <fx@gnu.org>
parents:
diff changeset
264 package and its documentation are hidden.
Dave Love <fx@gnu.org>
parents:
diff changeset
265
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
266 @node Naming Conventions, , Installation, Overview
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
267 @section Naming Conventions
Dave Love <fx@gnu.org>
parents:
diff changeset
268
Dave Love <fx@gnu.org>
parents:
diff changeset
269 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
270 Except where noted, all functions defined by this package have the
Dave Love <fx@gnu.org>
parents:
diff changeset
271 same names and calling conventions as their Common Lisp counterparts.
Dave Love <fx@gnu.org>
parents:
diff changeset
272
Dave Love <fx@gnu.org>
parents:
diff changeset
273 Following is a complete list of functions whose names were changed
Dave Love <fx@gnu.org>
parents:
diff changeset
274 from Common Lisp, usually to avoid conflicts with Emacs. In each
Dave Love <fx@gnu.org>
parents:
diff changeset
275 case, a @samp{*} has been appended to the Common Lisp name to obtain
Dave Love <fx@gnu.org>
parents:
diff changeset
276 the Emacs name:
Dave Love <fx@gnu.org>
parents:
diff changeset
277
Dave Love <fx@gnu.org>
parents:
diff changeset
278 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
279 defun* defsubst* defmacro* function*
Dave Love <fx@gnu.org>
parents:
diff changeset
280 member* assoc* rassoc* get*
Dave Love <fx@gnu.org>
parents:
diff changeset
281 remove* delete* mapcar* sort*
Dave Love <fx@gnu.org>
parents:
diff changeset
282 floor* ceiling* truncate* round*
36931
508fd85ab816 expurgate last*
Dave Love <fx@gnu.org>
parents: 35089
diff changeset
283 mod* rem* random*
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
284 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
285
Dave Love <fx@gnu.org>
parents:
diff changeset
286 Internal function and variable names in the package are prefixed
Dave Love <fx@gnu.org>
parents:
diff changeset
287 by @code{cl-}. Here is a complete list of functions @emph{not}
Dave Love <fx@gnu.org>
parents:
diff changeset
288 prefixed by @code{cl-} which were not taken from Common Lisp:
Dave Love <fx@gnu.org>
parents:
diff changeset
289
Dave Love <fx@gnu.org>
parents:
diff changeset
290 @example
28039
c3a446101beb Remove references to rassoc, delete, expt.
Dave Love <fx@gnu.org>
parents: 27511
diff changeset
291 floatp-safe lexical-let lexical-let*
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
292 callf callf2 letf letf*
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
293 defsubst*
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
294 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
295
Dave Love <fx@gnu.org>
parents:
diff changeset
296 The following simple functions and macros are defined in @file{cl.el};
Dave Love <fx@gnu.org>
parents:
diff changeset
297 they do not cause other components like @file{cl-extra} to be loaded.
Dave Love <fx@gnu.org>
parents:
diff changeset
298
Dave Love <fx@gnu.org>
parents:
diff changeset
299 @example
27225
ee242fddb1ab Remove various old stuff and references thereto.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
300 eql floatp-safe endp
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
301 evenp oddp plusp minusp
35089
bc14e9ea5378 Delete butlast, nbutlast.
Dave Love <fx@gnu.org>
parents: 33295
diff changeset
302 caaar .. cddddr
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
303 list* ldiff rest first .. tenth
27225
ee242fddb1ab Remove various old stuff and references thereto.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
304 copy-list subst mapcar* [2]
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
305 adjoin [3] acons pairlis pop [4]
Dave Love <fx@gnu.org>
parents:
diff changeset
306 push [4] pushnew [3,4] incf [4] decf [4]
Dave Love <fx@gnu.org>
parents:
diff changeset
307 proclaim declaim
Dave Love <fx@gnu.org>
parents:
diff changeset
308 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
309
Dave Love <fx@gnu.org>
parents:
diff changeset
310 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
311 [2] Only for one sequence argument or two list arguments.
Dave Love <fx@gnu.org>
parents:
diff changeset
312
Dave Love <fx@gnu.org>
parents:
diff changeset
313 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
314 [3] Only if @code{:test} is @code{eq}, @code{equal}, or unspecified,
Dave Love <fx@gnu.org>
parents:
diff changeset
315 and @code{:key} is not used.
Dave Love <fx@gnu.org>
parents:
diff changeset
316
Dave Love <fx@gnu.org>
parents:
diff changeset
317 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
318 [4] Only when @var{place} is a plain variable name.
Dave Love <fx@gnu.org>
parents:
diff changeset
319
Dave Love <fx@gnu.org>
parents:
diff changeset
320 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
321 @chapno=4
Dave Love <fx@gnu.org>
parents:
diff changeset
322 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
323
Dave Love <fx@gnu.org>
parents:
diff changeset
324 @node Program Structure, Predicates, Overview, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
325 @chapter Program Structure
Dave Love <fx@gnu.org>
parents:
diff changeset
326
Dave Love <fx@gnu.org>
parents:
diff changeset
327 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
328 This section describes features of the @dfn{CL} package which have to
Dave Love <fx@gnu.org>
parents:
diff changeset
329 do with programs as a whole: advanced argument lists for functions,
Dave Love <fx@gnu.org>
parents:
diff changeset
330 and the @code{eval-when} construct.
Dave Love <fx@gnu.org>
parents:
diff changeset
331
Dave Love <fx@gnu.org>
parents:
diff changeset
332 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
333 * Argument Lists:: `&key', `&aux', `defun*', `defmacro*'.
Dave Love <fx@gnu.org>
parents:
diff changeset
334 * Time of Evaluation:: The `eval-when' construct.
Dave Love <fx@gnu.org>
parents:
diff changeset
335 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
336
Dave Love <fx@gnu.org>
parents:
diff changeset
337 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
338 @secno=1
Dave Love <fx@gnu.org>
parents:
diff changeset
339 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
340
Dave Love <fx@gnu.org>
parents:
diff changeset
341 @node Argument Lists, Time of Evaluation, Program Structure, Program Structure
Dave Love <fx@gnu.org>
parents:
diff changeset
342 @section Argument Lists
Dave Love <fx@gnu.org>
parents:
diff changeset
343
Dave Love <fx@gnu.org>
parents:
diff changeset
344 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
345 Emacs Lisp's notation for argument lists of functions is a subset of
Dave Love <fx@gnu.org>
parents:
diff changeset
346 the Common Lisp notation. As well as the familiar @code{&optional}
Dave Love <fx@gnu.org>
parents:
diff changeset
347 and @code{&rest} markers, Common Lisp allows you to specify default
Dave Love <fx@gnu.org>
parents:
diff changeset
348 values for optional arguments, and it provides the additional markers
Dave Love <fx@gnu.org>
parents:
diff changeset
349 @code{&key} and @code{&aux}.
Dave Love <fx@gnu.org>
parents:
diff changeset
350
Dave Love <fx@gnu.org>
parents:
diff changeset
351 Since argument parsing is built-in to Emacs, there is no way for
Dave Love <fx@gnu.org>
parents:
diff changeset
352 this package to implement Common Lisp argument lists seamlessly.
Dave Love <fx@gnu.org>
parents:
diff changeset
353 Instead, this package defines alternates for several Lisp forms
Dave Love <fx@gnu.org>
parents:
diff changeset
354 which you must use if you need Common Lisp argument lists.
Dave Love <fx@gnu.org>
parents:
diff changeset
355
Dave Love <fx@gnu.org>
parents:
diff changeset
356 @defspec defun* name arglist body...
Dave Love <fx@gnu.org>
parents:
diff changeset
357 This form is identical to the regular @code{defun} form, except
Dave Love <fx@gnu.org>
parents:
diff changeset
358 that @var{arglist} is allowed to be a full Common Lisp argument
Dave Love <fx@gnu.org>
parents:
diff changeset
359 list. Also, the function body is enclosed in an implicit block
Dave Love <fx@gnu.org>
parents:
diff changeset
360 called @var{name}; @pxref{Blocks and Exits}.
Dave Love <fx@gnu.org>
parents:
diff changeset
361 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
362
Dave Love <fx@gnu.org>
parents:
diff changeset
363 @defspec defsubst* name arglist body...
Dave Love <fx@gnu.org>
parents:
diff changeset
364 This is just like @code{defun*}, except that the function that
Dave Love <fx@gnu.org>
parents:
diff changeset
365 is defined is automatically proclaimed @code{inline}, i.e.,
Dave Love <fx@gnu.org>
parents:
diff changeset
366 calls to it may be expanded into in-line code by the byte compiler.
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
367 This is analogous to the @code{defsubst} form;
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
368 @code{defsubst*} uses a different method (compiler macros) which
Dave Love <fx@gnu.org>
parents:
diff changeset
369 works in all version of Emacs, and also generates somewhat more
Dave Love <fx@gnu.org>
parents:
diff changeset
370 efficient inline expansions. In particular, @code{defsubst*}
Dave Love <fx@gnu.org>
parents:
diff changeset
371 arranges for the processing of keyword arguments, default values,
Dave Love <fx@gnu.org>
parents:
diff changeset
372 etc., to be done at compile-time whenever possible.
Dave Love <fx@gnu.org>
parents:
diff changeset
373 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
374
Dave Love <fx@gnu.org>
parents:
diff changeset
375 @defspec defmacro* name arglist body...
Dave Love <fx@gnu.org>
parents:
diff changeset
376 This is identical to the regular @code{defmacro} form,
Dave Love <fx@gnu.org>
parents:
diff changeset
377 except that @var{arglist} is allowed to be a full Common Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
378 argument list. The @code{&environment} keyword is supported as
Dave Love <fx@gnu.org>
parents:
diff changeset
379 described in Steele. The @code{&whole} keyword is supported only
Dave Love <fx@gnu.org>
parents:
diff changeset
380 within destructured lists (see below); top-level @code{&whole}
Dave Love <fx@gnu.org>
parents:
diff changeset
381 cannot be implemented with the current Emacs Lisp interpreter.
Dave Love <fx@gnu.org>
parents:
diff changeset
382 The macro expander body is enclosed in an implicit block called
Dave Love <fx@gnu.org>
parents:
diff changeset
383 @var{name}.
Dave Love <fx@gnu.org>
parents:
diff changeset
384 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
385
Dave Love <fx@gnu.org>
parents:
diff changeset
386 @defspec function* symbol-or-lambda
Dave Love <fx@gnu.org>
parents:
diff changeset
387 This is identical to the regular @code{function} form,
Dave Love <fx@gnu.org>
parents:
diff changeset
388 except that if the argument is a @code{lambda} form then that
Dave Love <fx@gnu.org>
parents:
diff changeset
389 form may use a full Common Lisp argument list.
Dave Love <fx@gnu.org>
parents:
diff changeset
390 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
391
Dave Love <fx@gnu.org>
parents:
diff changeset
392 Also, all forms (such as @code{defsetf} and @code{flet}) defined
Dave Love <fx@gnu.org>
parents:
diff changeset
393 in this package that include @var{arglist}s in their syntax allow
Dave Love <fx@gnu.org>
parents:
diff changeset
394 full Common Lisp argument lists.
Dave Love <fx@gnu.org>
parents:
diff changeset
395
Dave Love <fx@gnu.org>
parents:
diff changeset
396 Note that it is @emph{not} necessary to use @code{defun*} in
Dave Love <fx@gnu.org>
parents:
diff changeset
397 order to have access to most @dfn{CL} features in your function.
Dave Love <fx@gnu.org>
parents:
diff changeset
398 These features are always present; @code{defun*}'s only
Dave Love <fx@gnu.org>
parents:
diff changeset
399 difference from @code{defun} is its more flexible argument
Dave Love <fx@gnu.org>
parents:
diff changeset
400 lists and its implicit block.
Dave Love <fx@gnu.org>
parents:
diff changeset
401
Dave Love <fx@gnu.org>
parents:
diff changeset
402 The full form of a Common Lisp argument list is
Dave Love <fx@gnu.org>
parents:
diff changeset
403
Dave Love <fx@gnu.org>
parents:
diff changeset
404 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
405 (@var{var}...
Dave Love <fx@gnu.org>
parents:
diff changeset
406 &optional (@var{var} @var{initform} @var{svar})...
Dave Love <fx@gnu.org>
parents:
diff changeset
407 &rest @var{var}
Dave Love <fx@gnu.org>
parents:
diff changeset
408 &key ((@var{keyword} @var{var}) @var{initform} @var{svar})...
Dave Love <fx@gnu.org>
parents:
diff changeset
409 &aux (@var{var} @var{initform})...)
Dave Love <fx@gnu.org>
parents:
diff changeset
410 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
411
Dave Love <fx@gnu.org>
parents:
diff changeset
412 Each of the five argument list sections is optional. The @var{svar},
Dave Love <fx@gnu.org>
parents:
diff changeset
413 @var{initform}, and @var{keyword} parts are optional; if they are
Dave Love <fx@gnu.org>
parents:
diff changeset
414 omitted, then @samp{(@var{var})} may be written simply @samp{@var{var}}.
Dave Love <fx@gnu.org>
parents:
diff changeset
415
Dave Love <fx@gnu.org>
parents:
diff changeset
416 The first section consists of zero or more @dfn{required} arguments.
Dave Love <fx@gnu.org>
parents:
diff changeset
417 These arguments must always be specified in a call to the function;
Dave Love <fx@gnu.org>
parents:
diff changeset
418 there is no difference between Emacs Lisp and Common Lisp as far as
Dave Love <fx@gnu.org>
parents:
diff changeset
419 required arguments are concerned.
Dave Love <fx@gnu.org>
parents:
diff changeset
420
Dave Love <fx@gnu.org>
parents:
diff changeset
421 The second section consists of @dfn{optional} arguments. These
Dave Love <fx@gnu.org>
parents:
diff changeset
422 arguments may be specified in the function call; if they are not,
Dave Love <fx@gnu.org>
parents:
diff changeset
423 @var{initform} specifies the default value used for the argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
424 (No @var{initform} means to use @code{nil} as the default.) The
Dave Love <fx@gnu.org>
parents:
diff changeset
425 @var{initform} is evaluated with the bindings for the preceding
Dave Love <fx@gnu.org>
parents:
diff changeset
426 arguments already established; @code{(a &optional (b (1+ a)))}
Dave Love <fx@gnu.org>
parents:
diff changeset
427 matches one or two arguments, with the second argument defaulting
Dave Love <fx@gnu.org>
parents:
diff changeset
428 to one plus the first argument. If the @var{svar} is specified,
Dave Love <fx@gnu.org>
parents:
diff changeset
429 it is an auxiliary variable which is bound to @code{t} if the optional
Dave Love <fx@gnu.org>
parents:
diff changeset
430 argument was specified, or to @code{nil} if the argument was omitted.
Dave Love <fx@gnu.org>
parents:
diff changeset
431 If you don't use an @var{svar}, then there will be no way for your
Dave Love <fx@gnu.org>
parents:
diff changeset
432 function to tell whether it was called with no argument, or with
Dave Love <fx@gnu.org>
parents:
diff changeset
433 the default value passed explicitly as an argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
434
Dave Love <fx@gnu.org>
parents:
diff changeset
435 The third section consists of a single @dfn{rest} argument. If
Dave Love <fx@gnu.org>
parents:
diff changeset
436 more arguments were passed to the function than are accounted for
Dave Love <fx@gnu.org>
parents:
diff changeset
437 by the required and optional arguments, those extra arguments are
Dave Love <fx@gnu.org>
parents:
diff changeset
438 collected into a list and bound to the ``rest'' argument variable.
Dave Love <fx@gnu.org>
parents:
diff changeset
439 Common Lisp's @code{&rest} is equivalent to that of Emacs Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
440 Common Lisp accepts @code{&body} as a synonym for @code{&rest} in
Dave Love <fx@gnu.org>
parents:
diff changeset
441 macro contexts; this package accepts it all the time.
Dave Love <fx@gnu.org>
parents:
diff changeset
442
Dave Love <fx@gnu.org>
parents:
diff changeset
443 The fourth section consists of @dfn{keyword} arguments. These
Dave Love <fx@gnu.org>
parents:
diff changeset
444 are optional arguments which are specified by name rather than
Dave Love <fx@gnu.org>
parents:
diff changeset
445 positionally in the argument list. For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
446
Dave Love <fx@gnu.org>
parents:
diff changeset
447 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
448 (defun* foo (a &optional b &key c d (e 17)))
Dave Love <fx@gnu.org>
parents:
diff changeset
449 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
450
Dave Love <fx@gnu.org>
parents:
diff changeset
451 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
452 defines a function which may be called with one, two, or more
Dave Love <fx@gnu.org>
parents:
diff changeset
453 arguments. The first two arguments are bound to @code{a} and
Dave Love <fx@gnu.org>
parents:
diff changeset
454 @code{b} in the usual way. The remaining arguments must be
Dave Love <fx@gnu.org>
parents:
diff changeset
455 pairs of the form @code{:c}, @code{:d}, or @code{:e} followed
Dave Love <fx@gnu.org>
parents:
diff changeset
456 by the value to be bound to the corresponding argument variable.
Dave Love <fx@gnu.org>
parents:
diff changeset
457 (Symbols whose names begin with a colon are called @dfn{keywords},
Dave Love <fx@gnu.org>
parents:
diff changeset
458 and they are self-quoting in the same way as @code{nil} and
Dave Love <fx@gnu.org>
parents:
diff changeset
459 @code{t}.)
Dave Love <fx@gnu.org>
parents:
diff changeset
460
Dave Love <fx@gnu.org>
parents:
diff changeset
461 For example, the call @code{(foo 1 2 :d 3 :c 4)} sets the five
Dave Love <fx@gnu.org>
parents:
diff changeset
462 arguments to 1, 2, 4, 3, and 17, respectively. If the same keyword
Dave Love <fx@gnu.org>
parents:
diff changeset
463 appears more than once in the function call, the first occurrence
Dave Love <fx@gnu.org>
parents:
diff changeset
464 takes precedence over the later ones. Note that it is not possible
Dave Love <fx@gnu.org>
parents:
diff changeset
465 to specify keyword arguments without specifying the optional
Dave Love <fx@gnu.org>
parents:
diff changeset
466 argument @code{b} as well, since @code{(foo 1 :c 2)} would bind
Dave Love <fx@gnu.org>
parents:
diff changeset
467 @code{b} to the keyword @code{:c}, then signal an error because
Dave Love <fx@gnu.org>
parents:
diff changeset
468 @code{2} is not a valid keyword.
Dave Love <fx@gnu.org>
parents:
diff changeset
469
Dave Love <fx@gnu.org>
parents:
diff changeset
470 If a @var{keyword} symbol is explicitly specified in the argument
Dave Love <fx@gnu.org>
parents:
diff changeset
471 list as shown in the above diagram, then that keyword will be
Dave Love <fx@gnu.org>
parents:
diff changeset
472 used instead of just the variable name prefixed with a colon.
Dave Love <fx@gnu.org>
parents:
diff changeset
473 You can specify a @var{keyword} symbol which does not begin with
Dave Love <fx@gnu.org>
parents:
diff changeset
474 a colon at all, but such symbols will not be self-quoting; you
Dave Love <fx@gnu.org>
parents:
diff changeset
475 will have to quote them explicitly with an apostrophe in the
Dave Love <fx@gnu.org>
parents:
diff changeset
476 function call.
Dave Love <fx@gnu.org>
parents:
diff changeset
477
Dave Love <fx@gnu.org>
parents:
diff changeset
478 Ordinarily it is an error to pass an unrecognized keyword to
Dave Love <fx@gnu.org>
parents:
diff changeset
479 a function, e.g., @code{(foo 1 2 :c 3 :goober 4)}. You can ask
Dave Love <fx@gnu.org>
parents:
diff changeset
480 Lisp to ignore unrecognized keywords, either by adding the
Dave Love <fx@gnu.org>
parents:
diff changeset
481 marker @code{&allow-other-keys} after the keyword section
Dave Love <fx@gnu.org>
parents:
diff changeset
482 of the argument list, or by specifying an @code{:allow-other-keys}
Dave Love <fx@gnu.org>
parents:
diff changeset
483 argument in the call whose value is non-@code{nil}. If the
Dave Love <fx@gnu.org>
parents:
diff changeset
484 function uses both @code{&rest} and @code{&key} at the same time,
Dave Love <fx@gnu.org>
parents:
diff changeset
485 the ``rest'' argument is bound to the keyword list as it appears
Dave Love <fx@gnu.org>
parents:
diff changeset
486 in the call. For example:
Dave Love <fx@gnu.org>
parents:
diff changeset
487
Dave Love <fx@gnu.org>
parents:
diff changeset
488 @smallexample
Dave Love <fx@gnu.org>
parents:
diff changeset
489 (defun* find-thing (thing &rest rest &key need &allow-other-keys)
Dave Love <fx@gnu.org>
parents:
diff changeset
490 (or (apply 'member* thing thing-list :allow-other-keys t rest)
Dave Love <fx@gnu.org>
parents:
diff changeset
491 (if need (error "Thing not found"))))
Dave Love <fx@gnu.org>
parents:
diff changeset
492 @end smallexample
Dave Love <fx@gnu.org>
parents:
diff changeset
493
Dave Love <fx@gnu.org>
parents:
diff changeset
494 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
495 This function takes a @code{:need} keyword argument, but also
Dave Love <fx@gnu.org>
parents:
diff changeset
496 accepts other keyword arguments which are passed on to the
Dave Love <fx@gnu.org>
parents:
diff changeset
497 @code{member*} function. @code{allow-other-keys} is used to
Dave Love <fx@gnu.org>
parents:
diff changeset
498 keep both @code{find-thing} and @code{member*} from complaining
Dave Love <fx@gnu.org>
parents:
diff changeset
499 about each others' keywords in the arguments.
Dave Love <fx@gnu.org>
parents:
diff changeset
500
Dave Love <fx@gnu.org>
parents:
diff changeset
501 The fifth section of the argument list consists of @dfn{auxiliary
Dave Love <fx@gnu.org>
parents:
diff changeset
502 variables}. These are not really arguments at all, but simply
Dave Love <fx@gnu.org>
parents:
diff changeset
503 variables which are bound to @code{nil} or to the specified
Dave Love <fx@gnu.org>
parents:
diff changeset
504 @var{initforms} during execution of the function. There is no
Dave Love <fx@gnu.org>
parents:
diff changeset
505 difference between the following two functions, except for a
Dave Love <fx@gnu.org>
parents:
diff changeset
506 matter of stylistic taste:
Dave Love <fx@gnu.org>
parents:
diff changeset
507
Dave Love <fx@gnu.org>
parents:
diff changeset
508 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
509 (defun* foo (a b &aux (c (+ a b)) d)
Dave Love <fx@gnu.org>
parents:
diff changeset
510 @var{body})
Dave Love <fx@gnu.org>
parents:
diff changeset
511
Dave Love <fx@gnu.org>
parents:
diff changeset
512 (defun* foo (a b)
Dave Love <fx@gnu.org>
parents:
diff changeset
513 (let ((c (+ a b)) d)
Dave Love <fx@gnu.org>
parents:
diff changeset
514 @var{body}))
Dave Love <fx@gnu.org>
parents:
diff changeset
515 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
516
Dave Love <fx@gnu.org>
parents:
diff changeset
517 Argument lists support @dfn{destructuring}. In Common Lisp,
Dave Love <fx@gnu.org>
parents:
diff changeset
518 destructuring is only allowed with @code{defmacro}; this package
Dave Love <fx@gnu.org>
parents:
diff changeset
519 allows it with @code{defun*} and other argument lists as well.
Dave Love <fx@gnu.org>
parents:
diff changeset
520 In destructuring, any argument variable (@var{var} in the above
Dave Love <fx@gnu.org>
parents:
diff changeset
521 diagram) can be replaced by a list of variables, or more generally,
Dave Love <fx@gnu.org>
parents:
diff changeset
522 a recursive argument list. The corresponding argument value must
Dave Love <fx@gnu.org>
parents:
diff changeset
523 be a list whose elements match this recursive argument list.
Dave Love <fx@gnu.org>
parents:
diff changeset
524 For example:
Dave Love <fx@gnu.org>
parents:
diff changeset
525
Dave Love <fx@gnu.org>
parents:
diff changeset
526 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
527 (defmacro* dolist ((var listform &optional resultform)
Dave Love <fx@gnu.org>
parents:
diff changeset
528 &rest body)
Dave Love <fx@gnu.org>
parents:
diff changeset
529 ...)
Dave Love <fx@gnu.org>
parents:
diff changeset
530 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
531
Dave Love <fx@gnu.org>
parents:
diff changeset
532 This says that the first argument of @code{dolist} must be a list
Dave Love <fx@gnu.org>
parents:
diff changeset
533 of two or three items; if there are other arguments as well as this
Dave Love <fx@gnu.org>
parents:
diff changeset
534 list, they are stored in @code{body}. All features allowed in
Dave Love <fx@gnu.org>
parents:
diff changeset
535 regular argument lists are allowed in these recursive argument lists.
Dave Love <fx@gnu.org>
parents:
diff changeset
536 In addition, the clause @samp{&whole @var{var}} is allowed at the
Dave Love <fx@gnu.org>
parents:
diff changeset
537 front of a recursive argument list. It binds @var{var} to the
Dave Love <fx@gnu.org>
parents:
diff changeset
538 whole list being matched; thus @code{(&whole all a b)} matches
Dave Love <fx@gnu.org>
parents:
diff changeset
539 a list of two things, with @code{a} bound to the first thing,
Dave Love <fx@gnu.org>
parents:
diff changeset
540 @code{b} bound to the second thing, and @code{all} bound to the
Dave Love <fx@gnu.org>
parents:
diff changeset
541 list itself. (Common Lisp allows @code{&whole} in top-level
Dave Love <fx@gnu.org>
parents:
diff changeset
542 @code{defmacro} argument lists as well, but Emacs Lisp does not
Dave Love <fx@gnu.org>
parents:
diff changeset
543 support this usage.)
Dave Love <fx@gnu.org>
parents:
diff changeset
544
Dave Love <fx@gnu.org>
parents:
diff changeset
545 One last feature of destructuring is that the argument list may be
Dave Love <fx@gnu.org>
parents:
diff changeset
546 dotted, so that the argument list @code{(a b . c)} is functionally
Dave Love <fx@gnu.org>
parents:
diff changeset
547 equivalent to @code{(a b &rest c)}.
Dave Love <fx@gnu.org>
parents:
diff changeset
548
Dave Love <fx@gnu.org>
parents:
diff changeset
549 If the optimization quality @code{safety} is set to 0
Dave Love <fx@gnu.org>
parents:
diff changeset
550 (@pxref{Declarations}), error checking for wrong number of
Dave Love <fx@gnu.org>
parents:
diff changeset
551 arguments and invalid keyword arguments is disabled. By default,
Dave Love <fx@gnu.org>
parents:
diff changeset
552 argument lists are rigorously checked.
Dave Love <fx@gnu.org>
parents:
diff changeset
553
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
554 @node Time of Evaluation, , Argument Lists, Program Structure
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
555 @section Time of Evaluation
Dave Love <fx@gnu.org>
parents:
diff changeset
556
Dave Love <fx@gnu.org>
parents:
diff changeset
557 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
558 Normally, the byte-compiler does not actually execute the forms in
Dave Love <fx@gnu.org>
parents:
diff changeset
559 a file it compiles. For example, if a file contains @code{(setq foo t)},
Dave Love <fx@gnu.org>
parents:
diff changeset
560 the act of compiling it will not actually set @code{foo} to @code{t}.
Dave Love <fx@gnu.org>
parents:
diff changeset
561 This is true even if the @code{setq} was a top-level form (i.e., not
Dave Love <fx@gnu.org>
parents:
diff changeset
562 enclosed in a @code{defun} or other form). Sometimes, though, you
Dave Love <fx@gnu.org>
parents:
diff changeset
563 would like to have certain top-level forms evaluated at compile-time.
Dave Love <fx@gnu.org>
parents:
diff changeset
564 For example, the compiler effectively evaluates @code{defmacro} forms
Dave Love <fx@gnu.org>
parents:
diff changeset
565 at compile-time so that later parts of the file can refer to the
Dave Love <fx@gnu.org>
parents:
diff changeset
566 macros that are defined.
Dave Love <fx@gnu.org>
parents:
diff changeset
567
Dave Love <fx@gnu.org>
parents:
diff changeset
568 @defspec eval-when (situations...) forms...
Dave Love <fx@gnu.org>
parents:
diff changeset
569 This form controls when the body @var{forms} are evaluated.
Dave Love <fx@gnu.org>
parents:
diff changeset
570 The @var{situations} list may contain any set of the symbols
Dave Love <fx@gnu.org>
parents:
diff changeset
571 @code{compile}, @code{load}, and @code{eval} (or their long-winded
Dave Love <fx@gnu.org>
parents:
diff changeset
572 ANSI equivalents, @code{:compile-toplevel}, @code{:load-toplevel},
Dave Love <fx@gnu.org>
parents:
diff changeset
573 and @code{:execute}).
Dave Love <fx@gnu.org>
parents:
diff changeset
574
Dave Love <fx@gnu.org>
parents:
diff changeset
575 The @code{eval-when} form is handled differently depending on
Dave Love <fx@gnu.org>
parents:
diff changeset
576 whether or not it is being compiled as a top-level form.
Dave Love <fx@gnu.org>
parents:
diff changeset
577 Specifically, it gets special treatment if it is being compiled
Dave Love <fx@gnu.org>
parents:
diff changeset
578 by a command such as @code{byte-compile-file} which compiles files
Dave Love <fx@gnu.org>
parents:
diff changeset
579 or buffers of code, and it appears either literally at the
Dave Love <fx@gnu.org>
parents:
diff changeset
580 top level of the file or inside a top-level @code{progn}.
Dave Love <fx@gnu.org>
parents:
diff changeset
581
Dave Love <fx@gnu.org>
parents:
diff changeset
582 For compiled top-level @code{eval-when}s, the body @var{forms} are
Dave Love <fx@gnu.org>
parents:
diff changeset
583 executed at compile-time if @code{compile} is in the @var{situations}
Dave Love <fx@gnu.org>
parents:
diff changeset
584 list, and the @var{forms} are written out to the file (to be executed
Dave Love <fx@gnu.org>
parents:
diff changeset
585 at load-time) if @code{load} is in the @var{situations} list.
Dave Love <fx@gnu.org>
parents:
diff changeset
586
Dave Love <fx@gnu.org>
parents:
diff changeset
587 For non-compiled-top-level forms, only the @code{eval} situation is
Dave Love <fx@gnu.org>
parents:
diff changeset
588 relevant. (This includes forms executed by the interpreter, forms
Dave Love <fx@gnu.org>
parents:
diff changeset
589 compiled with @code{byte-compile} rather than @code{byte-compile-file},
Dave Love <fx@gnu.org>
parents:
diff changeset
590 and non-top-level forms.) The @code{eval-when} acts like a
Dave Love <fx@gnu.org>
parents:
diff changeset
591 @code{progn} if @code{eval} is specified, and like @code{nil}
Dave Love <fx@gnu.org>
parents:
diff changeset
592 (ignoring the body @var{forms}) if not.
Dave Love <fx@gnu.org>
parents:
diff changeset
593
Dave Love <fx@gnu.org>
parents:
diff changeset
594 The rules become more subtle when @code{eval-when}s are nested;
Dave Love <fx@gnu.org>
parents:
diff changeset
595 consult Steele (second edition) for the gruesome details (and
Dave Love <fx@gnu.org>
parents:
diff changeset
596 some gruesome examples).
Dave Love <fx@gnu.org>
parents:
diff changeset
597
Dave Love <fx@gnu.org>
parents:
diff changeset
598 Some simple examples:
Dave Love <fx@gnu.org>
parents:
diff changeset
599
Dave Love <fx@gnu.org>
parents:
diff changeset
600 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
601 ;; Top-level forms in foo.el:
Dave Love <fx@gnu.org>
parents:
diff changeset
602 (eval-when (compile) (setq foo1 'bar))
Dave Love <fx@gnu.org>
parents:
diff changeset
603 (eval-when (load) (setq foo2 'bar))
Dave Love <fx@gnu.org>
parents:
diff changeset
604 (eval-when (compile load) (setq foo3 'bar))
Dave Love <fx@gnu.org>
parents:
diff changeset
605 (eval-when (eval) (setq foo4 'bar))
Dave Love <fx@gnu.org>
parents:
diff changeset
606 (eval-when (eval compile) (setq foo5 'bar))
Dave Love <fx@gnu.org>
parents:
diff changeset
607 (eval-when (eval load) (setq foo6 'bar))
Dave Love <fx@gnu.org>
parents:
diff changeset
608 (eval-when (eval compile load) (setq foo7 'bar))
Dave Love <fx@gnu.org>
parents:
diff changeset
609 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
610
Dave Love <fx@gnu.org>
parents:
diff changeset
611 When @file{foo.el} is compiled, these variables will be set during
Dave Love <fx@gnu.org>
parents:
diff changeset
612 the compilation itself:
Dave Love <fx@gnu.org>
parents:
diff changeset
613
Dave Love <fx@gnu.org>
parents:
diff changeset
614 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
615 foo1 foo3 foo5 foo7 ; `compile'
Dave Love <fx@gnu.org>
parents:
diff changeset
616 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
617
Dave Love <fx@gnu.org>
parents:
diff changeset
618 When @file{foo.elc} is loaded, these variables will be set:
Dave Love <fx@gnu.org>
parents:
diff changeset
619
Dave Love <fx@gnu.org>
parents:
diff changeset
620 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
621 foo2 foo3 foo6 foo7 ; `load'
Dave Love <fx@gnu.org>
parents:
diff changeset
622 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
623
Dave Love <fx@gnu.org>
parents:
diff changeset
624 And if @file{foo.el} is loaded uncompiled, these variables will
Dave Love <fx@gnu.org>
parents:
diff changeset
625 be set:
Dave Love <fx@gnu.org>
parents:
diff changeset
626
Dave Love <fx@gnu.org>
parents:
diff changeset
627 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
628 foo4 foo5 foo6 foo7 ; `eval'
Dave Love <fx@gnu.org>
parents:
diff changeset
629 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
630
Dave Love <fx@gnu.org>
parents:
diff changeset
631 If these seven @code{eval-when}s had been, say, inside a @code{defun},
Dave Love <fx@gnu.org>
parents:
diff changeset
632 then the first three would have been equivalent to @code{nil} and the
Dave Love <fx@gnu.org>
parents:
diff changeset
633 last four would have been equivalent to the corresponding @code{setq}s.
Dave Love <fx@gnu.org>
parents:
diff changeset
634
Dave Love <fx@gnu.org>
parents:
diff changeset
635 Note that @code{(eval-when (load eval) @dots{})} is equivalent
Dave Love <fx@gnu.org>
parents:
diff changeset
636 to @code{(progn @dots{})} in all contexts. The compiler treats
Dave Love <fx@gnu.org>
parents:
diff changeset
637 certain top-level forms, like @code{defmacro} (sort-of) and
Dave Love <fx@gnu.org>
parents:
diff changeset
638 @code{require}, as if they were wrapped in @code{(eval-when
Dave Love <fx@gnu.org>
parents:
diff changeset
639 (compile load eval) @dots{})}.
Dave Love <fx@gnu.org>
parents:
diff changeset
640 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
641
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
642 Emacs includes two special forms related to @code{eval-when}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
643 One of these, @code{eval-when-compile}, is not quite equivalent to
27225
ee242fddb1ab Remove various old stuff and references thereto.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
644 any @code{eval-when} construct and is described below.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
645
Dave Love <fx@gnu.org>
parents:
diff changeset
646 The other form, @code{(eval-and-compile @dots{})}, is exactly
Dave Love <fx@gnu.org>
parents:
diff changeset
647 equivalent to @samp{(eval-when (compile load eval) @dots{})} and
Dave Love <fx@gnu.org>
parents:
diff changeset
648 so is not itself defined by this package.
Dave Love <fx@gnu.org>
parents:
diff changeset
649
Dave Love <fx@gnu.org>
parents:
diff changeset
650 @defspec eval-when-compile forms...
Dave Love <fx@gnu.org>
parents:
diff changeset
651 The @var{forms} are evaluated at compile-time; at execution time,
Dave Love <fx@gnu.org>
parents:
diff changeset
652 this form acts like a quoted constant of the resulting value. Used
Dave Love <fx@gnu.org>
parents:
diff changeset
653 at top-level, @code{eval-when-compile} is just like @samp{eval-when
Dave Love <fx@gnu.org>
parents:
diff changeset
654 (compile eval)}. In other contexts, @code{eval-when-compile}
Dave Love <fx@gnu.org>
parents:
diff changeset
655 allows code to be evaluated once at compile-time for efficiency
Dave Love <fx@gnu.org>
parents:
diff changeset
656 or other reasons.
Dave Love <fx@gnu.org>
parents:
diff changeset
657
Dave Love <fx@gnu.org>
parents:
diff changeset
658 This form is similar to the @samp{#.} syntax of true Common Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
659 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
660
Dave Love <fx@gnu.org>
parents:
diff changeset
661 @defspec load-time-value form
Dave Love <fx@gnu.org>
parents:
diff changeset
662 The @var{form} is evaluated at load-time; at execution time,
Dave Love <fx@gnu.org>
parents:
diff changeset
663 this form acts like a quoted constant of the resulting value.
Dave Love <fx@gnu.org>
parents:
diff changeset
664
Dave Love <fx@gnu.org>
parents:
diff changeset
665 Early Common Lisp had a @samp{#,} syntax that was similar to
Dave Love <fx@gnu.org>
parents:
diff changeset
666 this, but ANSI Common Lisp replaced it with @code{load-time-value}
Dave Love <fx@gnu.org>
parents:
diff changeset
667 and gave it more well-defined semantics.
Dave Love <fx@gnu.org>
parents:
diff changeset
668
Dave Love <fx@gnu.org>
parents:
diff changeset
669 In a compiled file, @code{load-time-value} arranges for @var{form}
Dave Love <fx@gnu.org>
parents:
diff changeset
670 to be evaluated when the @file{.elc} file is loaded and then used
Dave Love <fx@gnu.org>
parents:
diff changeset
671 as if it were a quoted constant. In code compiled by
Dave Love <fx@gnu.org>
parents:
diff changeset
672 @code{byte-compile} rather than @code{byte-compile-file}, the
Dave Love <fx@gnu.org>
parents:
diff changeset
673 effect is identical to @code{eval-when-compile}. In uncompiled
Dave Love <fx@gnu.org>
parents:
diff changeset
674 code, both @code{eval-when-compile} and @code{load-time-value}
Dave Love <fx@gnu.org>
parents:
diff changeset
675 act exactly like @code{progn}.
Dave Love <fx@gnu.org>
parents:
diff changeset
676
Dave Love <fx@gnu.org>
parents:
diff changeset
677 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
678 (defun report ()
Dave Love <fx@gnu.org>
parents:
diff changeset
679 (insert "This function was executed on: "
Dave Love <fx@gnu.org>
parents:
diff changeset
680 (current-time-string)
Dave Love <fx@gnu.org>
parents:
diff changeset
681 ", compiled on: "
Dave Love <fx@gnu.org>
parents:
diff changeset
682 (eval-when-compile (current-time-string))
Dave Love <fx@gnu.org>
parents:
diff changeset
683 ;; or '#.(current-time-string) in real Common Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
684 ", and loaded on: "
Dave Love <fx@gnu.org>
parents:
diff changeset
685 (load-time-value (current-time-string))))
Dave Love <fx@gnu.org>
parents:
diff changeset
686 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
687
Dave Love <fx@gnu.org>
parents:
diff changeset
688 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
689 Byte-compiled, the above defun will result in the following code
Dave Love <fx@gnu.org>
parents:
diff changeset
690 (or its compiled equivalent, of course) in the @file{.elc} file:
Dave Love <fx@gnu.org>
parents:
diff changeset
691
Dave Love <fx@gnu.org>
parents:
diff changeset
692 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
693 (setq --temp-- (current-time-string))
Dave Love <fx@gnu.org>
parents:
diff changeset
694 (defun report ()
Dave Love <fx@gnu.org>
parents:
diff changeset
695 (insert "This function was executed on: "
Dave Love <fx@gnu.org>
parents:
diff changeset
696 (current-time-string)
Dave Love <fx@gnu.org>
parents:
diff changeset
697 ", compiled on: "
Dave Love <fx@gnu.org>
parents:
diff changeset
698 '"Wed Jun 23 18:33:43 1993"
Dave Love <fx@gnu.org>
parents:
diff changeset
699 ", and loaded on: "
Dave Love <fx@gnu.org>
parents:
diff changeset
700 --temp--))
Dave Love <fx@gnu.org>
parents:
diff changeset
701 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
702 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
703
Dave Love <fx@gnu.org>
parents:
diff changeset
704 @node Predicates, Control Structure, Program Structure, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
705 @chapter Predicates
Dave Love <fx@gnu.org>
parents:
diff changeset
706
Dave Love <fx@gnu.org>
parents:
diff changeset
707 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
708 This section describes functions for testing whether various
Dave Love <fx@gnu.org>
parents:
diff changeset
709 facts are true or false.
Dave Love <fx@gnu.org>
parents:
diff changeset
710
Dave Love <fx@gnu.org>
parents:
diff changeset
711 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
712 * Type Predicates:: `typep', `deftype', and `coerce'
Dave Love <fx@gnu.org>
parents:
diff changeset
713 * Equality Predicates:: `eql' and `equalp'
Dave Love <fx@gnu.org>
parents:
diff changeset
714 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
715
Dave Love <fx@gnu.org>
parents:
diff changeset
716 @node Type Predicates, Equality Predicates, Predicates, Predicates
Dave Love <fx@gnu.org>
parents:
diff changeset
717 @section Type Predicates
Dave Love <fx@gnu.org>
parents:
diff changeset
718
Dave Love <fx@gnu.org>
parents:
diff changeset
719 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
720 The @dfn{CL} package defines a version of the Common Lisp @code{typep}
Dave Love <fx@gnu.org>
parents:
diff changeset
721 predicate.
Dave Love <fx@gnu.org>
parents:
diff changeset
722
Dave Love <fx@gnu.org>
parents:
diff changeset
723 @defun typep object type
Dave Love <fx@gnu.org>
parents:
diff changeset
724 Check if @var{object} is of type @var{type}, where @var{type} is a
Dave Love <fx@gnu.org>
parents:
diff changeset
725 (quoted) type name of the sort used by Common Lisp. For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
726 @code{(typep foo 'integer)} is equivalent to @code{(integerp foo)}.
Dave Love <fx@gnu.org>
parents:
diff changeset
727 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
728
Dave Love <fx@gnu.org>
parents:
diff changeset
729 The @var{type} argument to the above function is either a symbol
Dave Love <fx@gnu.org>
parents:
diff changeset
730 or a list beginning with a symbol.
Dave Love <fx@gnu.org>
parents:
diff changeset
731
Dave Love <fx@gnu.org>
parents:
diff changeset
732 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
733 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
734 If the type name is a symbol, Emacs appends @samp{-p} to the
Dave Love <fx@gnu.org>
parents:
diff changeset
735 symbol name to form the name of a predicate function for testing
Dave Love <fx@gnu.org>
parents:
diff changeset
736 the type. (Built-in predicates whose names end in @samp{p} rather
Dave Love <fx@gnu.org>
parents:
diff changeset
737 than @samp{-p} are used when appropriate.)
Dave Love <fx@gnu.org>
parents:
diff changeset
738
Dave Love <fx@gnu.org>
parents:
diff changeset
739 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
740 The type symbol @code{t} stands for the union of all types.
Dave Love <fx@gnu.org>
parents:
diff changeset
741 @code{(typep @var{object} t)} is always true. Likewise, the
Dave Love <fx@gnu.org>
parents:
diff changeset
742 type symbol @code{nil} stands for nothing at all, and
Dave Love <fx@gnu.org>
parents:
diff changeset
743 @code{(typep @var{object} nil)} is always false.
Dave Love <fx@gnu.org>
parents:
diff changeset
744
Dave Love <fx@gnu.org>
parents:
diff changeset
745 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
746 The type symbol @code{null} represents the symbol @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
747 Thus @code{(typep @var{object} 'null)} is equivalent to
Dave Love <fx@gnu.org>
parents:
diff changeset
748 @code{(null @var{object})}.
Dave Love <fx@gnu.org>
parents:
diff changeset
749
Dave Love <fx@gnu.org>
parents:
diff changeset
750 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
751 The type symbol @code{real} is a synonym for @code{number}, and
Dave Love <fx@gnu.org>
parents:
diff changeset
752 @code{fixnum} is a synonym for @code{integer}.
Dave Love <fx@gnu.org>
parents:
diff changeset
753
Dave Love <fx@gnu.org>
parents:
diff changeset
754 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
755 The type symbols @code{character} and @code{string-char} match
Dave Love <fx@gnu.org>
parents:
diff changeset
756 integers in the range from 0 to 255.
Dave Love <fx@gnu.org>
parents:
diff changeset
757
Dave Love <fx@gnu.org>
parents:
diff changeset
758 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
759 The type symbol @code{float} uses the @code{floatp-safe} predicate
Dave Love <fx@gnu.org>
parents:
diff changeset
760 defined by this package rather than @code{floatp}, so it will work
Dave Love <fx@gnu.org>
parents:
diff changeset
761 correctly even in Emacs versions without floating-point support.
Dave Love <fx@gnu.org>
parents:
diff changeset
762
Dave Love <fx@gnu.org>
parents:
diff changeset
763 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
764 The type list @code{(integer @var{low} @var{high})} represents all
Dave Love <fx@gnu.org>
parents:
diff changeset
765 integers between @var{low} and @var{high}, inclusive. Either bound
Dave Love <fx@gnu.org>
parents:
diff changeset
766 may be a list of a single integer to specify an exclusive limit,
Dave Love <fx@gnu.org>
parents:
diff changeset
767 or a @code{*} to specify no limit. The type @code{(integer * *)}
Dave Love <fx@gnu.org>
parents:
diff changeset
768 is thus equivalent to @code{integer}.
Dave Love <fx@gnu.org>
parents:
diff changeset
769
Dave Love <fx@gnu.org>
parents:
diff changeset
770 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
771 Likewise, lists beginning with @code{float}, @code{real}, or
Dave Love <fx@gnu.org>
parents:
diff changeset
772 @code{number} represent numbers of that type falling in a particular
Dave Love <fx@gnu.org>
parents:
diff changeset
773 range.
Dave Love <fx@gnu.org>
parents:
diff changeset
774
Dave Love <fx@gnu.org>
parents:
diff changeset
775 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
776 Lists beginning with @code{and}, @code{or}, and @code{not} form
Dave Love <fx@gnu.org>
parents:
diff changeset
777 combinations of types. For example, @code{(or integer (float 0 *))}
Dave Love <fx@gnu.org>
parents:
diff changeset
778 represents all objects that are integers or non-negative floats.
Dave Love <fx@gnu.org>
parents:
diff changeset
779
Dave Love <fx@gnu.org>
parents:
diff changeset
780 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
781 Lists beginning with @code{member} or @code{member*} represent
Dave Love <fx@gnu.org>
parents:
diff changeset
782 objects @code{eql} to any of the following values. For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
783 @code{(member 1 2 3 4)} is equivalent to @code{(integer 1 4)},
Dave Love <fx@gnu.org>
parents:
diff changeset
784 and @code{(member nil)} is equivalent to @code{null}.
Dave Love <fx@gnu.org>
parents:
diff changeset
785
Dave Love <fx@gnu.org>
parents:
diff changeset
786 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
787 Lists of the form @code{(satisfies @var{predicate})} represent
Dave Love <fx@gnu.org>
parents:
diff changeset
788 all objects for which @var{predicate} returns true when called
Dave Love <fx@gnu.org>
parents:
diff changeset
789 with that object as an argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
790 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
791
Dave Love <fx@gnu.org>
parents:
diff changeset
792 The following function and macro (not technically predicates) are
Dave Love <fx@gnu.org>
parents:
diff changeset
793 related to @code{typep}.
Dave Love <fx@gnu.org>
parents:
diff changeset
794
Dave Love <fx@gnu.org>
parents:
diff changeset
795 @defun coerce object type
Dave Love <fx@gnu.org>
parents:
diff changeset
796 This function attempts to convert @var{object} to the specified
Dave Love <fx@gnu.org>
parents:
diff changeset
797 @var{type}. If @var{object} is already of that type as determined by
Dave Love <fx@gnu.org>
parents:
diff changeset
798 @code{typep}, it is simply returned. Otherwise, certain types of
Dave Love <fx@gnu.org>
parents:
diff changeset
799 conversions will be made: If @var{type} is any sequence type
Dave Love <fx@gnu.org>
parents:
diff changeset
800 (@code{string}, @code{list}, etc.) then @var{object} will be
Dave Love <fx@gnu.org>
parents:
diff changeset
801 converted to that type if possible. If @var{type} is
Dave Love <fx@gnu.org>
parents:
diff changeset
802 @code{character}, then strings of length one and symbols with
Dave Love <fx@gnu.org>
parents:
diff changeset
803 one-character names can be coerced. If @var{type} is @code{float},
Dave Love <fx@gnu.org>
parents:
diff changeset
804 then integers can be coerced in versions of Emacs that support
Dave Love <fx@gnu.org>
parents:
diff changeset
805 floats. In all other circumstances, @code{coerce} signals an
Dave Love <fx@gnu.org>
parents:
diff changeset
806 error.
Dave Love <fx@gnu.org>
parents:
diff changeset
807 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
808
Dave Love <fx@gnu.org>
parents:
diff changeset
809 @defspec deftype name arglist forms...
Dave Love <fx@gnu.org>
parents:
diff changeset
810 This macro defines a new type called @var{name}. It is similar
Dave Love <fx@gnu.org>
parents:
diff changeset
811 to @code{defmacro} in many ways; when @var{name} is encountered
Dave Love <fx@gnu.org>
parents:
diff changeset
812 as a type name, the body @var{forms} are evaluated and should
Dave Love <fx@gnu.org>
parents:
diff changeset
813 return a type specifier that is equivalent to the type. The
Dave Love <fx@gnu.org>
parents:
diff changeset
814 @var{arglist} is a Common Lisp argument list of the sort accepted
Dave Love <fx@gnu.org>
parents:
diff changeset
815 by @code{defmacro*}. The type specifier @samp{(@var{name} @var{args}...)}
Dave Love <fx@gnu.org>
parents:
diff changeset
816 is expanded by calling the expander with those arguments; the type
Dave Love <fx@gnu.org>
parents:
diff changeset
817 symbol @samp{@var{name}} is expanded by calling the expander with
Dave Love <fx@gnu.org>
parents:
diff changeset
818 no arguments. The @var{arglist} is processed the same as for
Dave Love <fx@gnu.org>
parents:
diff changeset
819 @code{defmacro*} except that optional arguments without explicit
Dave Love <fx@gnu.org>
parents:
diff changeset
820 defaults use @code{*} instead of @code{nil} as the ``default''
Dave Love <fx@gnu.org>
parents:
diff changeset
821 default. Some examples:
Dave Love <fx@gnu.org>
parents:
diff changeset
822
Dave Love <fx@gnu.org>
parents:
diff changeset
823 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
824 (deftype null () '(satisfies null)) ; predefined
Dave Love <fx@gnu.org>
parents:
diff changeset
825 (deftype list () '(or null cons)) ; predefined
Dave Love <fx@gnu.org>
parents:
diff changeset
826 (deftype unsigned-byte (&optional bits)
Dave Love <fx@gnu.org>
parents:
diff changeset
827 (list 'integer 0 (if (eq bits '*) bits (1- (lsh 1 bits)))))
Dave Love <fx@gnu.org>
parents:
diff changeset
828 (unsigned-byte 8) @equiv{} (integer 0 255)
Dave Love <fx@gnu.org>
parents:
diff changeset
829 (unsigned-byte) @equiv{} (integer 0 *)
Dave Love <fx@gnu.org>
parents:
diff changeset
830 unsigned-byte @equiv{} (integer 0 *)
Dave Love <fx@gnu.org>
parents:
diff changeset
831 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
832
Dave Love <fx@gnu.org>
parents:
diff changeset
833 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
834 The last example shows how the Common Lisp @code{unsigned-byte}
Dave Love <fx@gnu.org>
parents:
diff changeset
835 type specifier could be implemented if desired; this package does
Dave Love <fx@gnu.org>
parents:
diff changeset
836 not implement @code{unsigned-byte} by default.
Dave Love <fx@gnu.org>
parents:
diff changeset
837 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
838
Dave Love <fx@gnu.org>
parents:
diff changeset
839 The @code{typecase} and @code{check-type} macros also use type
Dave Love <fx@gnu.org>
parents:
diff changeset
840 names. @xref{Conditionals}. @xref{Assertions}. The @code{map},
Dave Love <fx@gnu.org>
parents:
diff changeset
841 @code{concatenate}, and @code{merge} functions take type-name
Dave Love <fx@gnu.org>
parents:
diff changeset
842 arguments to specify the type of sequence to return. @xref{Sequences}.
Dave Love <fx@gnu.org>
parents:
diff changeset
843
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
844 @node Equality Predicates, , Type Predicates, Predicates
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
845 @section Equality Predicates
Dave Love <fx@gnu.org>
parents:
diff changeset
846
Dave Love <fx@gnu.org>
parents:
diff changeset
847 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
848 This package defines two Common Lisp predicates, @code{eql} and
Dave Love <fx@gnu.org>
parents:
diff changeset
849 @code{equalp}.
Dave Love <fx@gnu.org>
parents:
diff changeset
850
Dave Love <fx@gnu.org>
parents:
diff changeset
851 @defun eql a b
Dave Love <fx@gnu.org>
parents:
diff changeset
852 This function is almost the same as @code{eq}, except that if @var{a}
Dave Love <fx@gnu.org>
parents:
diff changeset
853 and @var{b} are numbers of the same type, it compares them for numeric
Dave Love <fx@gnu.org>
parents:
diff changeset
854 equality (as if by @code{equal} instead of @code{eq}). This makes a
Dave Love <fx@gnu.org>
parents:
diff changeset
855 difference only for versions of Emacs that are compiled with
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
856 floating-point support. Emacs floats are allocated
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
857 objects just like cons cells, which means that @code{(eq 3.0 3.0)}
Dave Love <fx@gnu.org>
parents:
diff changeset
858 will not necessarily be true---if the two @code{3.0}s were allocated
Dave Love <fx@gnu.org>
parents:
diff changeset
859 separately, the pointers will be different even though the numbers are
Dave Love <fx@gnu.org>
parents:
diff changeset
860 the same. But @code{(eql 3.0 3.0)} will always be true.
Dave Love <fx@gnu.org>
parents:
diff changeset
861
Dave Love <fx@gnu.org>
parents:
diff changeset
862 The types of the arguments must match, so @code{(eql 3 3.0)} is
Dave Love <fx@gnu.org>
parents:
diff changeset
863 still false.
Dave Love <fx@gnu.org>
parents:
diff changeset
864
Dave Love <fx@gnu.org>
parents:
diff changeset
865 Note that Emacs integers are ``direct'' rather than allocated, which
Dave Love <fx@gnu.org>
parents:
diff changeset
866 basically means @code{(eq 3 3)} will always be true. Thus @code{eq}
Dave Love <fx@gnu.org>
parents:
diff changeset
867 and @code{eql} behave differently only if floating-point numbers are
Dave Love <fx@gnu.org>
parents:
diff changeset
868 involved, and are indistinguishable on Emacs versions that don't
Dave Love <fx@gnu.org>
parents:
diff changeset
869 support floats.
Dave Love <fx@gnu.org>
parents:
diff changeset
870
Dave Love <fx@gnu.org>
parents:
diff changeset
871 There is a slight inconsistency with Common Lisp in the treatment of
Dave Love <fx@gnu.org>
parents:
diff changeset
872 positive and negative zeros. Some machines, notably those with IEEE
Dave Love <fx@gnu.org>
parents:
diff changeset
873 standard arithmetic, represent @code{+0} and @code{-0} as distinct
Dave Love <fx@gnu.org>
parents:
diff changeset
874 values. Normally this doesn't matter because the standard specifies
Dave Love <fx@gnu.org>
parents:
diff changeset
875 that @code{(= 0.0 -0.0)} should always be true, and this is indeed
Dave Love <fx@gnu.org>
parents:
diff changeset
876 what Emacs Lisp and Common Lisp do. But the Common Lisp standard
Dave Love <fx@gnu.org>
parents:
diff changeset
877 states that @code{(eql 0.0 -0.0)} and @code{(equal 0.0 -0.0)} should
Dave Love <fx@gnu.org>
parents:
diff changeset
878 be false on IEEE-like machines; Emacs Lisp does not do this, and in
Dave Love <fx@gnu.org>
parents:
diff changeset
879 fact the only known way to distinguish between the two zeros in Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
880 Lisp is to @code{format} them and check for a minus sign.
Dave Love <fx@gnu.org>
parents:
diff changeset
881 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
882
Dave Love <fx@gnu.org>
parents:
diff changeset
883 @defun equalp a b
Dave Love <fx@gnu.org>
parents:
diff changeset
884 This function is a more flexible version of @code{equal}. In
Dave Love <fx@gnu.org>
parents:
diff changeset
885 particular, it compares strings case-insensitively, and it compares
Dave Love <fx@gnu.org>
parents:
diff changeset
886 numbers without regard to type (so that @code{(equalp 3 3.0)} is
Dave Love <fx@gnu.org>
parents:
diff changeset
887 true). Vectors and conses are compared recursively. All other
Dave Love <fx@gnu.org>
parents:
diff changeset
888 objects are compared as if by @code{equal}.
Dave Love <fx@gnu.org>
parents:
diff changeset
889
Dave Love <fx@gnu.org>
parents:
diff changeset
890 This function differs from Common Lisp @code{equalp} in several
Dave Love <fx@gnu.org>
parents:
diff changeset
891 respects. First, Common Lisp's @code{equalp} also compares
Dave Love <fx@gnu.org>
parents:
diff changeset
892 @emph{characters} case-insensitively, which would be impractical
Dave Love <fx@gnu.org>
parents:
diff changeset
893 in this package since Emacs does not distinguish between integers
Dave Love <fx@gnu.org>
parents:
diff changeset
894 and characters. In keeping with the idea that strings are less
Dave Love <fx@gnu.org>
parents:
diff changeset
895 vector-like in Emacs Lisp, this package's @code{equalp} also will
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
896 not compare strings against vectors of integers.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
897 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
898
Dave Love <fx@gnu.org>
parents:
diff changeset
899 Also note that the Common Lisp functions @code{member} and @code{assoc}
Dave Love <fx@gnu.org>
parents:
diff changeset
900 use @code{eql} to compare elements, whereas Emacs Lisp follows the
Dave Love <fx@gnu.org>
parents:
diff changeset
901 MacLisp tradition and uses @code{equal} for these two functions.
Dave Love <fx@gnu.org>
parents:
diff changeset
902 In Emacs, use @code{member*} and @code{assoc*} to get functions
Dave Love <fx@gnu.org>
parents:
diff changeset
903 which use @code{eql} for comparisons.
Dave Love <fx@gnu.org>
parents:
diff changeset
904
Dave Love <fx@gnu.org>
parents:
diff changeset
905 @node Control Structure, Macros, Predicates, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
906 @chapter Control Structure
Dave Love <fx@gnu.org>
parents:
diff changeset
907
Dave Love <fx@gnu.org>
parents:
diff changeset
908 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
909 The features described in the following sections implement
Dave Love <fx@gnu.org>
parents:
diff changeset
910 various advanced control structures, including the powerful
Dave Love <fx@gnu.org>
parents:
diff changeset
911 @code{setf} facility and a number of looping and conditional
Dave Love <fx@gnu.org>
parents:
diff changeset
912 constructs.
Dave Love <fx@gnu.org>
parents:
diff changeset
913
Dave Love <fx@gnu.org>
parents:
diff changeset
914 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
915 * Assignment:: The `psetq' form
Dave Love <fx@gnu.org>
parents:
diff changeset
916 * Generalized Variables:: `setf', `incf', `push', etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
917 * Variable Bindings:: `progv', `lexical-let', `flet', `macrolet'
Dave Love <fx@gnu.org>
parents:
diff changeset
918 * Conditionals:: `case', `typecase'
Dave Love <fx@gnu.org>
parents:
diff changeset
919 * Blocks and Exits:: `block', `return', `return-from'
27511
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
920 * Iteration:: `do', `dotimes', `dolist', `do-symbols'
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
921 * Loop Facility:: The Common Lisp `loop' macro
Dave Love <fx@gnu.org>
parents:
diff changeset
922 * Multiple Values:: `values', `multiple-value-bind', etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
923 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
924
Dave Love <fx@gnu.org>
parents:
diff changeset
925 @node Assignment, Generalized Variables, Control Structure, Control Structure
Dave Love <fx@gnu.org>
parents:
diff changeset
926 @section Assignment
Dave Love <fx@gnu.org>
parents:
diff changeset
927
Dave Love <fx@gnu.org>
parents:
diff changeset
928 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
929 The @code{psetq} form is just like @code{setq}, except that multiple
Dave Love <fx@gnu.org>
parents:
diff changeset
930 assignments are done in parallel rather than sequentially.
Dave Love <fx@gnu.org>
parents:
diff changeset
931
Dave Love <fx@gnu.org>
parents:
diff changeset
932 @defspec psetq [symbol form]@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
933 This special form (actually a macro) is used to assign to several
Dave Love <fx@gnu.org>
parents:
diff changeset
934 variables simultaneously. Given only one @var{symbol} and @var{form},
Dave Love <fx@gnu.org>
parents:
diff changeset
935 it has the same effect as @code{setq}. Given several @var{symbol}
Dave Love <fx@gnu.org>
parents:
diff changeset
936 and @var{form} pairs, it evaluates all the @var{form}s in advance
Dave Love <fx@gnu.org>
parents:
diff changeset
937 and then stores the corresponding variables afterwards.
Dave Love <fx@gnu.org>
parents:
diff changeset
938
Dave Love <fx@gnu.org>
parents:
diff changeset
939 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
940 (setq x 2 y 3)
Dave Love <fx@gnu.org>
parents:
diff changeset
941 (setq x (+ x y) y (* x y))
Dave Love <fx@gnu.org>
parents:
diff changeset
942 x
Dave Love <fx@gnu.org>
parents:
diff changeset
943 @result{} 5
Dave Love <fx@gnu.org>
parents:
diff changeset
944 y ; @r{@code{y} was computed after @code{x} was set.}
Dave Love <fx@gnu.org>
parents:
diff changeset
945 @result{} 15
Dave Love <fx@gnu.org>
parents:
diff changeset
946 (setq x 2 y 3)
Dave Love <fx@gnu.org>
parents:
diff changeset
947 (psetq x (+ x y) y (* x y))
Dave Love <fx@gnu.org>
parents:
diff changeset
948 x
Dave Love <fx@gnu.org>
parents:
diff changeset
949 @result{} 5
Dave Love <fx@gnu.org>
parents:
diff changeset
950 y ; @r{@code{y} was computed before @code{x} was set.}
Dave Love <fx@gnu.org>
parents:
diff changeset
951 @result{} 6
Dave Love <fx@gnu.org>
parents:
diff changeset
952 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
953
Dave Love <fx@gnu.org>
parents:
diff changeset
954 The simplest use of @code{psetq} is @code{(psetq x y y x)}, which
Dave Love <fx@gnu.org>
parents:
diff changeset
955 exchanges the values of two variables. (The @code{rotatef} form
Dave Love <fx@gnu.org>
parents:
diff changeset
956 provides an even more convenient way to swap two variables;
Dave Love <fx@gnu.org>
parents:
diff changeset
957 @pxref{Modify Macros}.)
Dave Love <fx@gnu.org>
parents:
diff changeset
958
Dave Love <fx@gnu.org>
parents:
diff changeset
959 @code{psetq} always returns @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
960 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
961
Dave Love <fx@gnu.org>
parents:
diff changeset
962 @node Generalized Variables, Variable Bindings, Assignment, Control Structure
Dave Love <fx@gnu.org>
parents:
diff changeset
963 @section Generalized Variables
Dave Love <fx@gnu.org>
parents:
diff changeset
964
Dave Love <fx@gnu.org>
parents:
diff changeset
965 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
966 A ``generalized variable'' or ``place form'' is one of the many places
Dave Love <fx@gnu.org>
parents:
diff changeset
967 in Lisp memory where values can be stored. The simplest place form is
Dave Love <fx@gnu.org>
parents:
diff changeset
968 a regular Lisp variable. But the cars and cdrs of lists, elements
Dave Love <fx@gnu.org>
parents:
diff changeset
969 of arrays, properties of symbols, and many other locations are also
Dave Love <fx@gnu.org>
parents:
diff changeset
970 places where Lisp values are stored.
Dave Love <fx@gnu.org>
parents:
diff changeset
971
Dave Love <fx@gnu.org>
parents:
diff changeset
972 The @code{setf} form is like @code{setq}, except that it accepts
Dave Love <fx@gnu.org>
parents:
diff changeset
973 arbitrary place forms on the left side rather than just
Dave Love <fx@gnu.org>
parents:
diff changeset
974 symbols. For example, @code{(setf (car a) b)} sets the car of
Dave Love <fx@gnu.org>
parents:
diff changeset
975 @code{a} to @code{b}, doing the same operation as @code{(setcar a b)}
Dave Love <fx@gnu.org>
parents:
diff changeset
976 but without having to remember two separate functions for setting
Dave Love <fx@gnu.org>
parents:
diff changeset
977 and accessing every type of place.
Dave Love <fx@gnu.org>
parents:
diff changeset
978
Dave Love <fx@gnu.org>
parents:
diff changeset
979 Generalized variables are analogous to ``lvalues'' in the C
Dave Love <fx@gnu.org>
parents:
diff changeset
980 language, where @samp{x = a[i]} gets an element from an array
Dave Love <fx@gnu.org>
parents:
diff changeset
981 and @samp{a[i] = x} stores an element using the same notation.
Dave Love <fx@gnu.org>
parents:
diff changeset
982 Just as certain forms like @code{a[i]} can be lvalues in C, there
Dave Love <fx@gnu.org>
parents:
diff changeset
983 is a set of forms that can be generalized variables in Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
984
Dave Love <fx@gnu.org>
parents:
diff changeset
985 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
986 * Basic Setf:: `setf' and place forms
Dave Love <fx@gnu.org>
parents:
diff changeset
987 * Modify Macros:: `incf', `push', `rotatef', `letf', `callf', etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
988 * Customizing Setf:: `define-modify-macro', `defsetf', `define-setf-method'
Dave Love <fx@gnu.org>
parents:
diff changeset
989 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
990
Dave Love <fx@gnu.org>
parents:
diff changeset
991 @node Basic Setf, Modify Macros, Generalized Variables, Generalized Variables
Dave Love <fx@gnu.org>
parents:
diff changeset
992 @subsection Basic Setf
Dave Love <fx@gnu.org>
parents:
diff changeset
993
Dave Love <fx@gnu.org>
parents:
diff changeset
994 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
995 The @code{setf} macro is the most basic way to operate on generalized
Dave Love <fx@gnu.org>
parents:
diff changeset
996 variables.
Dave Love <fx@gnu.org>
parents:
diff changeset
997
Dave Love <fx@gnu.org>
parents:
diff changeset
998 @defspec setf [place form]@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
999 This macro evaluates @var{form} and stores it in @var{place}, which
Dave Love <fx@gnu.org>
parents:
diff changeset
1000 must be a valid generalized variable form. If there are several
Dave Love <fx@gnu.org>
parents:
diff changeset
1001 @var{place} and @var{form} pairs, the assignments are done sequentially
Dave Love <fx@gnu.org>
parents:
diff changeset
1002 just as with @code{setq}. @code{setf} returns the value of the last
Dave Love <fx@gnu.org>
parents:
diff changeset
1003 @var{form}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1004
Dave Love <fx@gnu.org>
parents:
diff changeset
1005 The following Lisp forms will work as generalized variables, and
Dave Love <fx@gnu.org>
parents:
diff changeset
1006 so may legally appear in the @var{place} argument of @code{setf}:
Dave Love <fx@gnu.org>
parents:
diff changeset
1007
Dave Love <fx@gnu.org>
parents:
diff changeset
1008 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
1009 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1010 A symbol naming a variable. In other words, @code{(setf x y)} is
Dave Love <fx@gnu.org>
parents:
diff changeset
1011 exactly equivalent to @code{(setq x y)}, and @code{setq} itself is
Dave Love <fx@gnu.org>
parents:
diff changeset
1012 strictly speaking redundant now that @code{setf} exists. Many
Dave Love <fx@gnu.org>
parents:
diff changeset
1013 programmers continue to prefer @code{setq} for setting simple
Dave Love <fx@gnu.org>
parents:
diff changeset
1014 variables, though, purely for stylistic or historical reasons.
Dave Love <fx@gnu.org>
parents:
diff changeset
1015 The macro @code{(setf x y)} actually expands to @code{(setq x y)},
Dave Love <fx@gnu.org>
parents:
diff changeset
1016 so there is no performance penalty for using it in compiled code.
Dave Love <fx@gnu.org>
parents:
diff changeset
1017
Dave Love <fx@gnu.org>
parents:
diff changeset
1018 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1019 A call to any of the following Lisp functions:
Dave Love <fx@gnu.org>
parents:
diff changeset
1020
Dave Love <fx@gnu.org>
parents:
diff changeset
1021 @smallexample
Dave Love <fx@gnu.org>
parents:
diff changeset
1022 car cdr caar .. cddddr
Dave Love <fx@gnu.org>
parents:
diff changeset
1023 nth rest first .. tenth
Dave Love <fx@gnu.org>
parents:
diff changeset
1024 aref elt nthcdr
Dave Love <fx@gnu.org>
parents:
diff changeset
1025 symbol-function symbol-value symbol-plist
Dave Love <fx@gnu.org>
parents:
diff changeset
1026 get get* getf
Dave Love <fx@gnu.org>
parents:
diff changeset
1027 gethash subseq
Dave Love <fx@gnu.org>
parents:
diff changeset
1028 @end smallexample
Dave Love <fx@gnu.org>
parents:
diff changeset
1029
Dave Love <fx@gnu.org>
parents:
diff changeset
1030 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1031 Note that for @code{nthcdr} and @code{getf}, the list argument
Dave Love <fx@gnu.org>
parents:
diff changeset
1032 of the function must itself be a valid @var{place} form. For
Dave Love <fx@gnu.org>
parents:
diff changeset
1033 example, @code{(setf (nthcdr 0 foo) 7)} will set @code{foo} itself
Dave Love <fx@gnu.org>
parents:
diff changeset
1034 to 7. Note that @code{push} and @code{pop} on an @code{nthcdr}
Dave Love <fx@gnu.org>
parents:
diff changeset
1035 place can be used to insert or delete at any position in a list.
Dave Love <fx@gnu.org>
parents:
diff changeset
1036 The use of @code{nthcdr} as a @var{place} form is an extension
Dave Love <fx@gnu.org>
parents:
diff changeset
1037 to standard Common Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
1038
Dave Love <fx@gnu.org>
parents:
diff changeset
1039 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1040 The following Emacs-specific functions are also @code{setf}-able.
Dave Love <fx@gnu.org>
parents:
diff changeset
1041
Dave Love <fx@gnu.org>
parents:
diff changeset
1042 @smallexample
Dave Love <fx@gnu.org>
parents:
diff changeset
1043 buffer-file-name marker-position
Dave Love <fx@gnu.org>
parents:
diff changeset
1044 buffer-modified-p match-data
Dave Love <fx@gnu.org>
parents:
diff changeset
1045 buffer-name mouse-position
Dave Love <fx@gnu.org>
parents:
diff changeset
1046 buffer-string overlay-end
Dave Love <fx@gnu.org>
parents:
diff changeset
1047 buffer-substring overlay-get
Dave Love <fx@gnu.org>
parents:
diff changeset
1048 current-buffer overlay-start
Dave Love <fx@gnu.org>
parents:
diff changeset
1049 current-case-table point
Dave Love <fx@gnu.org>
parents:
diff changeset
1050 current-column point-marker
Dave Love <fx@gnu.org>
parents:
diff changeset
1051 current-global-map point-max
Dave Love <fx@gnu.org>
parents:
diff changeset
1052 current-input-mode point-min
Dave Love <fx@gnu.org>
parents:
diff changeset
1053 current-local-map process-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1054 current-window-configuration process-filter
Dave Love <fx@gnu.org>
parents:
diff changeset
1055 default-file-modes process-sentinel
Dave Love <fx@gnu.org>
parents:
diff changeset
1056 default-value read-mouse-position
Dave Love <fx@gnu.org>
parents:
diff changeset
1057 documentation-property screen-height
Dave Love <fx@gnu.org>
parents:
diff changeset
1058 extent-data screen-menubar
Dave Love <fx@gnu.org>
parents:
diff changeset
1059 extent-end-position screen-width
Dave Love <fx@gnu.org>
parents:
diff changeset
1060 extent-start-position selected-window
Dave Love <fx@gnu.org>
parents:
diff changeset
1061 face-background selected-screen
Dave Love <fx@gnu.org>
parents:
diff changeset
1062 face-background-pixmap selected-frame
Dave Love <fx@gnu.org>
parents:
diff changeset
1063 face-font standard-case-table
Dave Love <fx@gnu.org>
parents:
diff changeset
1064 face-foreground syntax-table
Dave Love <fx@gnu.org>
parents:
diff changeset
1065 face-underline-p window-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1066 file-modes window-dedicated-p
Dave Love <fx@gnu.org>
parents:
diff changeset
1067 frame-height window-display-table
Dave Love <fx@gnu.org>
parents:
diff changeset
1068 frame-parameters window-height
Dave Love <fx@gnu.org>
parents:
diff changeset
1069 frame-visible-p window-hscroll
Dave Love <fx@gnu.org>
parents:
diff changeset
1070 frame-width window-point
Dave Love <fx@gnu.org>
parents:
diff changeset
1071 get-register window-start
Dave Love <fx@gnu.org>
parents:
diff changeset
1072 getenv window-width
Dave Love <fx@gnu.org>
parents:
diff changeset
1073 global-key-binding x-get-cut-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1074 keymap-parent x-get-cutbuffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1075 local-key-binding x-get-secondary-selection
Dave Love <fx@gnu.org>
parents:
diff changeset
1076 mark x-get-selection
Dave Love <fx@gnu.org>
parents:
diff changeset
1077 mark-marker
Dave Love <fx@gnu.org>
parents:
diff changeset
1078 @end smallexample
Dave Love <fx@gnu.org>
parents:
diff changeset
1079
Dave Love <fx@gnu.org>
parents:
diff changeset
1080 Most of these have directly corresponding ``set'' functions, like
Dave Love <fx@gnu.org>
parents:
diff changeset
1081 @code{use-local-map} for @code{current-local-map}, or @code{goto-char}
Dave Love <fx@gnu.org>
parents:
diff changeset
1082 for @code{point}. A few, like @code{point-min}, expand to longer
Dave Love <fx@gnu.org>
parents:
diff changeset
1083 sequences of code when they are @code{setf}'d (@code{(narrow-to-region
Dave Love <fx@gnu.org>
parents:
diff changeset
1084 x (point-max))} in this case).
Dave Love <fx@gnu.org>
parents:
diff changeset
1085
Dave Love <fx@gnu.org>
parents:
diff changeset
1086 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1087 A call of the form @code{(substring @var{subplace} @var{n} [@var{m}])},
Dave Love <fx@gnu.org>
parents:
diff changeset
1088 where @var{subplace} is itself a legal generalized variable whose
Dave Love <fx@gnu.org>
parents:
diff changeset
1089 current value is a string, and where the value stored is also a
Dave Love <fx@gnu.org>
parents:
diff changeset
1090 string. The new string is spliced into the specified part of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1091 destination string. For example:
Dave Love <fx@gnu.org>
parents:
diff changeset
1092
Dave Love <fx@gnu.org>
parents:
diff changeset
1093 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1094 (setq a (list "hello" "world"))
Dave Love <fx@gnu.org>
parents:
diff changeset
1095 @result{} ("hello" "world")
Dave Love <fx@gnu.org>
parents:
diff changeset
1096 (cadr a)
Dave Love <fx@gnu.org>
parents:
diff changeset
1097 @result{} "world"
Dave Love <fx@gnu.org>
parents:
diff changeset
1098 (substring (cadr a) 2 4)
Dave Love <fx@gnu.org>
parents:
diff changeset
1099 @result{} "rl"
Dave Love <fx@gnu.org>
parents:
diff changeset
1100 (setf (substring (cadr a) 2 4) "o")
Dave Love <fx@gnu.org>
parents:
diff changeset
1101 @result{} "o"
Dave Love <fx@gnu.org>
parents:
diff changeset
1102 (cadr a)
Dave Love <fx@gnu.org>
parents:
diff changeset
1103 @result{} "wood"
Dave Love <fx@gnu.org>
parents:
diff changeset
1104 a
Dave Love <fx@gnu.org>
parents:
diff changeset
1105 @result{} ("hello" "wood")
Dave Love <fx@gnu.org>
parents:
diff changeset
1106 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1107
Dave Love <fx@gnu.org>
parents:
diff changeset
1108 The generalized variable @code{buffer-substring}, listed above,
Dave Love <fx@gnu.org>
parents:
diff changeset
1109 also works in this way by replacing a portion of the current buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1110
Dave Love <fx@gnu.org>
parents:
diff changeset
1111 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1112 A call of the form @code{(apply '@var{func} @dots{})} or
Dave Love <fx@gnu.org>
parents:
diff changeset
1113 @code{(apply (function @var{func}) @dots{})}, where @var{func}
Dave Love <fx@gnu.org>
parents:
diff changeset
1114 is a @code{setf}-able function whose store function is ``suitable''
Dave Love <fx@gnu.org>
parents:
diff changeset
1115 in the sense described in Steele's book; since none of the standard
Dave Love <fx@gnu.org>
parents:
diff changeset
1116 Emacs place functions are suitable in this sense, this feature is
Dave Love <fx@gnu.org>
parents:
diff changeset
1117 only interesting when used with places you define yourself with
Dave Love <fx@gnu.org>
parents:
diff changeset
1118 @code{define-setf-method} or the long form of @code{defsetf}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1119
Dave Love <fx@gnu.org>
parents:
diff changeset
1120 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1121 A macro call, in which case the macro is expanded and @code{setf}
Dave Love <fx@gnu.org>
parents:
diff changeset
1122 is applied to the resulting form.
Dave Love <fx@gnu.org>
parents:
diff changeset
1123
Dave Love <fx@gnu.org>
parents:
diff changeset
1124 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1125 Any form for which a @code{defsetf} or @code{define-setf-method}
Dave Love <fx@gnu.org>
parents:
diff changeset
1126 has been made.
Dave Love <fx@gnu.org>
parents:
diff changeset
1127 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
1128
Dave Love <fx@gnu.org>
parents:
diff changeset
1129 Using any forms other than these in the @var{place} argument to
Dave Love <fx@gnu.org>
parents:
diff changeset
1130 @code{setf} will signal an error.
Dave Love <fx@gnu.org>
parents:
diff changeset
1131
Dave Love <fx@gnu.org>
parents:
diff changeset
1132 The @code{setf} macro takes care to evaluate all subforms in
Dave Love <fx@gnu.org>
parents:
diff changeset
1133 the proper left-to-right order; for example,
Dave Love <fx@gnu.org>
parents:
diff changeset
1134
Dave Love <fx@gnu.org>
parents:
diff changeset
1135 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1136 (setf (aref vec (incf i)) i)
Dave Love <fx@gnu.org>
parents:
diff changeset
1137 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1138
Dave Love <fx@gnu.org>
parents:
diff changeset
1139 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1140 looks like it will evaluate @code{(incf i)} exactly once, before the
Dave Love <fx@gnu.org>
parents:
diff changeset
1141 following access to @code{i}; the @code{setf} expander will insert
Dave Love <fx@gnu.org>
parents:
diff changeset
1142 temporary variables as necessary to ensure that it does in fact work
Dave Love <fx@gnu.org>
parents:
diff changeset
1143 this way no matter what setf-method is defined for @code{aref}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1144 (In this case, @code{aset} would be used and no such steps would
Dave Love <fx@gnu.org>
parents:
diff changeset
1145 be necessary since @code{aset} takes its arguments in a convenient
Dave Love <fx@gnu.org>
parents:
diff changeset
1146 order.)
Dave Love <fx@gnu.org>
parents:
diff changeset
1147
Dave Love <fx@gnu.org>
parents:
diff changeset
1148 However, if the @var{place} form is a macro which explicitly
Dave Love <fx@gnu.org>
parents:
diff changeset
1149 evaluates its arguments in an unusual order, this unusual order
Dave Love <fx@gnu.org>
parents:
diff changeset
1150 will be preserved. Adapting an example from Steele, given
Dave Love <fx@gnu.org>
parents:
diff changeset
1151
Dave Love <fx@gnu.org>
parents:
diff changeset
1152 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1153 (defmacro wrong-order (x y) (list 'aref y x))
Dave Love <fx@gnu.org>
parents:
diff changeset
1154 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1155
Dave Love <fx@gnu.org>
parents:
diff changeset
1156 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1157 the form @code{(setf (wrong-order @var{a} @var{b}) 17)} will
Dave Love <fx@gnu.org>
parents:
diff changeset
1158 evaluate @var{b} first, then @var{a}, just as in an actual call
Dave Love <fx@gnu.org>
parents:
diff changeset
1159 to @code{wrong-order}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1160 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1161
Dave Love <fx@gnu.org>
parents:
diff changeset
1162 @node Modify Macros, Customizing Setf, Basic Setf, Generalized Variables
Dave Love <fx@gnu.org>
parents:
diff changeset
1163 @subsection Modify Macros
Dave Love <fx@gnu.org>
parents:
diff changeset
1164
Dave Love <fx@gnu.org>
parents:
diff changeset
1165 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1166 This package defines a number of other macros besides @code{setf}
Dave Love <fx@gnu.org>
parents:
diff changeset
1167 that operate on generalized variables. Many are interesting and
Dave Love <fx@gnu.org>
parents:
diff changeset
1168 useful even when the @var{place} is just a variable name.
Dave Love <fx@gnu.org>
parents:
diff changeset
1169
Dave Love <fx@gnu.org>
parents:
diff changeset
1170 @defspec psetf [place form]@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
1171 This macro is to @code{setf} what @code{psetq} is to @code{setq}:
Dave Love <fx@gnu.org>
parents:
diff changeset
1172 When several @var{place}s and @var{form}s are involved, the
Dave Love <fx@gnu.org>
parents:
diff changeset
1173 assignments take place in parallel rather than sequentially.
Dave Love <fx@gnu.org>
parents:
diff changeset
1174 Specifically, all subforms are evaluated from left to right, then
Dave Love <fx@gnu.org>
parents:
diff changeset
1175 all the assignments are done (in an undefined order).
Dave Love <fx@gnu.org>
parents:
diff changeset
1176 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1177
Dave Love <fx@gnu.org>
parents:
diff changeset
1178 @defspec incf place &optional x
Dave Love <fx@gnu.org>
parents:
diff changeset
1179 This macro increments the number stored in @var{place} by one, or
Dave Love <fx@gnu.org>
parents:
diff changeset
1180 by @var{x} if specified. The incremented value is returned. For
Dave Love <fx@gnu.org>
parents:
diff changeset
1181 example, @code{(incf i)} is equivalent to @code{(setq i (1+ i))}, and
Dave Love <fx@gnu.org>
parents:
diff changeset
1182 @code{(incf (car x) 2)} is equivalent to @code{(setcar x (+ (car x) 2))}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1183
Dave Love <fx@gnu.org>
parents:
diff changeset
1184 Once again, care is taken to preserve the ``apparent'' order of
Dave Love <fx@gnu.org>
parents:
diff changeset
1185 evaluation. For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
1186
Dave Love <fx@gnu.org>
parents:
diff changeset
1187 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1188 (incf (aref vec (incf i)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1189 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1190
Dave Love <fx@gnu.org>
parents:
diff changeset
1191 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1192 appears to increment @code{i} once, then increment the element of
Dave Love <fx@gnu.org>
parents:
diff changeset
1193 @code{vec} addressed by @code{i}; this is indeed exactly what it
Dave Love <fx@gnu.org>
parents:
diff changeset
1194 does, which means the above form is @emph{not} equivalent to the
Dave Love <fx@gnu.org>
parents:
diff changeset
1195 ``obvious'' expansion,
Dave Love <fx@gnu.org>
parents:
diff changeset
1196
Dave Love <fx@gnu.org>
parents:
diff changeset
1197 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1198 (setf (aref vec (incf i)) (1+ (aref vec (incf i)))) ; Wrong!
Dave Love <fx@gnu.org>
parents:
diff changeset
1199 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1200
Dave Love <fx@gnu.org>
parents:
diff changeset
1201 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1202 but rather to something more like
Dave Love <fx@gnu.org>
parents:
diff changeset
1203
Dave Love <fx@gnu.org>
parents:
diff changeset
1204 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1205 (let ((temp (incf i)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1206 (setf (aref vec temp) (1+ (aref vec temp))))
Dave Love <fx@gnu.org>
parents:
diff changeset
1207 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1208
Dave Love <fx@gnu.org>
parents:
diff changeset
1209 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1210 Again, all of this is taken care of automatically by @code{incf} and
Dave Love <fx@gnu.org>
parents:
diff changeset
1211 the other generalized-variable macros.
Dave Love <fx@gnu.org>
parents:
diff changeset
1212
Dave Love <fx@gnu.org>
parents:
diff changeset
1213 As a more Emacs-specific example of @code{incf}, the expression
Dave Love <fx@gnu.org>
parents:
diff changeset
1214 @code{(incf (point) @var{n})} is essentially equivalent to
Dave Love <fx@gnu.org>
parents:
diff changeset
1215 @code{(forward-char @var{n})}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1216 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1217
Dave Love <fx@gnu.org>
parents:
diff changeset
1218 @defspec decf place &optional x
Dave Love <fx@gnu.org>
parents:
diff changeset
1219 This macro decrements the number stored in @var{place} by one, or
Dave Love <fx@gnu.org>
parents:
diff changeset
1220 by @var{x} if specified.
Dave Love <fx@gnu.org>
parents:
diff changeset
1221 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1222
Dave Love <fx@gnu.org>
parents:
diff changeset
1223 @defspec pop place
Dave Love <fx@gnu.org>
parents:
diff changeset
1224 This macro removes and returns the first element of the list stored
Dave Love <fx@gnu.org>
parents:
diff changeset
1225 in @var{place}. It is analogous to @code{(prog1 (car @var{place})
Dave Love <fx@gnu.org>
parents:
diff changeset
1226 (setf @var{place} (cdr @var{place})))}, except that it takes care
Dave Love <fx@gnu.org>
parents:
diff changeset
1227 to evaluate all subforms only once.
Dave Love <fx@gnu.org>
parents:
diff changeset
1228 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1229
Dave Love <fx@gnu.org>
parents:
diff changeset
1230 @defspec push x place
Dave Love <fx@gnu.org>
parents:
diff changeset
1231 This macro inserts @var{x} at the front of the list stored in
Dave Love <fx@gnu.org>
parents:
diff changeset
1232 @var{place}. It is analogous to @code{(setf @var{place} (cons
Dave Love <fx@gnu.org>
parents:
diff changeset
1233 @var{x} @var{place}))}, except for evaluation of the subforms.
Dave Love <fx@gnu.org>
parents:
diff changeset
1234 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1235
Dave Love <fx@gnu.org>
parents:
diff changeset
1236 @defspec pushnew x place @t{&key :test :test-not :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
1237 This macro inserts @var{x} at the front of the list stored in
Dave Love <fx@gnu.org>
parents:
diff changeset
1238 @var{place}, but only if @var{x} was not @code{eql} to any
Dave Love <fx@gnu.org>
parents:
diff changeset
1239 existing element of the list. The optional keyword arguments
Dave Love <fx@gnu.org>
parents:
diff changeset
1240 are interpreted in the same way as for @code{adjoin}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1241 @xref{Lists as Sets}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1242 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1243
Dave Love <fx@gnu.org>
parents:
diff changeset
1244 @defspec shiftf place@dots{} newvalue
Dave Love <fx@gnu.org>
parents:
diff changeset
1245 This macro shifts the @var{place}s left by one, shifting in the
Dave Love <fx@gnu.org>
parents:
diff changeset
1246 value of @var{newvalue} (which may be any Lisp expression, not just
Dave Love <fx@gnu.org>
parents:
diff changeset
1247 a generalized variable), and returning the value shifted out of
Dave Love <fx@gnu.org>
parents:
diff changeset
1248 the first @var{place}. Thus, @code{(shiftf @var{a} @var{b} @var{c}
Dave Love <fx@gnu.org>
parents:
diff changeset
1249 @var{d})} is equivalent to
Dave Love <fx@gnu.org>
parents:
diff changeset
1250
Dave Love <fx@gnu.org>
parents:
diff changeset
1251 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1252 (prog1
Dave Love <fx@gnu.org>
parents:
diff changeset
1253 @var{a}
Dave Love <fx@gnu.org>
parents:
diff changeset
1254 (psetf @var{a} @var{b}
Dave Love <fx@gnu.org>
parents:
diff changeset
1255 @var{b} @var{c}
Dave Love <fx@gnu.org>
parents:
diff changeset
1256 @var{c} @var{d}))
Dave Love <fx@gnu.org>
parents:
diff changeset
1257 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1258
Dave Love <fx@gnu.org>
parents:
diff changeset
1259 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1260 except that the subforms of @var{a}, @var{b}, and @var{c} are actually
Dave Love <fx@gnu.org>
parents:
diff changeset
1261 evaluated only once each and in the apparent order.
Dave Love <fx@gnu.org>
parents:
diff changeset
1262 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1263
Dave Love <fx@gnu.org>
parents:
diff changeset
1264 @defspec rotatef place@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
1265 This macro rotates the @var{place}s left by one in circular fashion.
Dave Love <fx@gnu.org>
parents:
diff changeset
1266 Thus, @code{(rotatef @var{a} @var{b} @var{c} @var{d})} is equivalent to
Dave Love <fx@gnu.org>
parents:
diff changeset
1267
Dave Love <fx@gnu.org>
parents:
diff changeset
1268 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1269 (psetf @var{a} @var{b}
Dave Love <fx@gnu.org>
parents:
diff changeset
1270 @var{b} @var{c}
Dave Love <fx@gnu.org>
parents:
diff changeset
1271 @var{c} @var{d}
Dave Love <fx@gnu.org>
parents:
diff changeset
1272 @var{d} @var{a})
Dave Love <fx@gnu.org>
parents:
diff changeset
1273 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1274
Dave Love <fx@gnu.org>
parents:
diff changeset
1275 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1276 except for the evaluation of subforms. @code{rotatef} always
Dave Love <fx@gnu.org>
parents:
diff changeset
1277 returns @code{nil}. Note that @code{(rotatef @var{a} @var{b})}
Dave Love <fx@gnu.org>
parents:
diff changeset
1278 conveniently exchanges @var{a} and @var{b}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1279 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1280
Dave Love <fx@gnu.org>
parents:
diff changeset
1281 The following macros were invented for this package; they have no
Dave Love <fx@gnu.org>
parents:
diff changeset
1282 analogues in Common Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
1283
Dave Love <fx@gnu.org>
parents:
diff changeset
1284 @defspec letf (bindings@dots{}) forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
1285 This macro is analogous to @code{let}, but for generalized variables
Dave Love <fx@gnu.org>
parents:
diff changeset
1286 rather than just symbols. Each @var{binding} should be of the form
Dave Love <fx@gnu.org>
parents:
diff changeset
1287 @code{(@var{place} @var{value})}; the original contents of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1288 @var{place}s are saved, the @var{value}s are stored in them, and
Dave Love <fx@gnu.org>
parents:
diff changeset
1289 then the body @var{form}s are executed. Afterwards, the @var{places}
Dave Love <fx@gnu.org>
parents:
diff changeset
1290 are set back to their original saved contents. This cleanup happens
Dave Love <fx@gnu.org>
parents:
diff changeset
1291 even if the @var{form}s exit irregularly due to a @code{throw} or an
Dave Love <fx@gnu.org>
parents:
diff changeset
1292 error.
Dave Love <fx@gnu.org>
parents:
diff changeset
1293
Dave Love <fx@gnu.org>
parents:
diff changeset
1294 For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
1295
Dave Love <fx@gnu.org>
parents:
diff changeset
1296 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1297 (letf (((point) (point-min))
Dave Love <fx@gnu.org>
parents:
diff changeset
1298 (a 17))
Dave Love <fx@gnu.org>
parents:
diff changeset
1299 ...)
Dave Love <fx@gnu.org>
parents:
diff changeset
1300 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1301
Dave Love <fx@gnu.org>
parents:
diff changeset
1302 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1303 moves ``point'' in the current buffer to the beginning of the buffer,
Dave Love <fx@gnu.org>
parents:
diff changeset
1304 and also binds @code{a} to 17 (as if by a normal @code{let}, since
Dave Love <fx@gnu.org>
parents:
diff changeset
1305 @code{a} is just a regular variable). After the body exits, @code{a}
Dave Love <fx@gnu.org>
parents:
diff changeset
1306 is set back to its original value and point is moved back to its
Dave Love <fx@gnu.org>
parents:
diff changeset
1307 original position.
Dave Love <fx@gnu.org>
parents:
diff changeset
1308
Dave Love <fx@gnu.org>
parents:
diff changeset
1309 Note that @code{letf} on @code{(point)} is not quite like a
Dave Love <fx@gnu.org>
parents:
diff changeset
1310 @code{save-excursion}, as the latter effectively saves a marker
Dave Love <fx@gnu.org>
parents:
diff changeset
1311 which tracks insertions and deletions in the buffer. Actually,
Dave Love <fx@gnu.org>
parents:
diff changeset
1312 a @code{letf} of @code{(point-marker)} is much closer to this
Dave Love <fx@gnu.org>
parents:
diff changeset
1313 behavior. (@code{point} and @code{point-marker} are equivalent
Dave Love <fx@gnu.org>
parents:
diff changeset
1314 as @code{setf} places; each will accept either an integer or a
Dave Love <fx@gnu.org>
parents:
diff changeset
1315 marker as the stored value.)
Dave Love <fx@gnu.org>
parents:
diff changeset
1316
Dave Love <fx@gnu.org>
parents:
diff changeset
1317 Since generalized variables look like lists, @code{let}'s shorthand
Dave Love <fx@gnu.org>
parents:
diff changeset
1318 of using @samp{foo} for @samp{(foo nil)} as a @var{binding} would
Dave Love <fx@gnu.org>
parents:
diff changeset
1319 be ambiguous in @code{letf} and is not allowed.
Dave Love <fx@gnu.org>
parents:
diff changeset
1320
Dave Love <fx@gnu.org>
parents:
diff changeset
1321 However, a @var{binding} specifier may be a one-element list
Dave Love <fx@gnu.org>
parents:
diff changeset
1322 @samp{(@var{place})}, which is similar to @samp{(@var{place}
Dave Love <fx@gnu.org>
parents:
diff changeset
1323 @var{place})}. In other words, the @var{place} is not disturbed
Dave Love <fx@gnu.org>
parents:
diff changeset
1324 on entry to the body, and the only effect of the @code{letf} is
Dave Love <fx@gnu.org>
parents:
diff changeset
1325 to restore the original value of @var{place} afterwards. (The
Dave Love <fx@gnu.org>
parents:
diff changeset
1326 redundant access-and-store suggested by the @code{(@var{place}
Dave Love <fx@gnu.org>
parents:
diff changeset
1327 @var{place})} example does not actually occur.)
Dave Love <fx@gnu.org>
parents:
diff changeset
1328
Dave Love <fx@gnu.org>
parents:
diff changeset
1329 In most cases, the @var{place} must have a well-defined value on
Dave Love <fx@gnu.org>
parents:
diff changeset
1330 entry to the @code{letf} form. The only exceptions are plain
Dave Love <fx@gnu.org>
parents:
diff changeset
1331 variables and calls to @code{symbol-value} and @code{symbol-function}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1332 If the symbol is not bound on entry, it is simply made unbound by
Dave Love <fx@gnu.org>
parents:
diff changeset
1333 @code{makunbound} or @code{fmakunbound} on exit.
Dave Love <fx@gnu.org>
parents:
diff changeset
1334 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1335
Dave Love <fx@gnu.org>
parents:
diff changeset
1336 @defspec letf* (bindings@dots{}) forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
1337 This macro is to @code{letf} what @code{let*} is to @code{let}:
Dave Love <fx@gnu.org>
parents:
diff changeset
1338 It does the bindings in sequential rather than parallel order.
Dave Love <fx@gnu.org>
parents:
diff changeset
1339 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1340
Dave Love <fx@gnu.org>
parents:
diff changeset
1341 @defspec callf @var{function} @var{place} @var{args}@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
1342 This is the ``generic'' modify macro. It calls @var{function},
Dave Love <fx@gnu.org>
parents:
diff changeset
1343 which should be an unquoted function name, macro name, or lambda.
Dave Love <fx@gnu.org>
parents:
diff changeset
1344 It passes @var{place} and @var{args} as arguments, and assigns the
Dave Love <fx@gnu.org>
parents:
diff changeset
1345 result back to @var{place}. For example, @code{(incf @var{place}
Dave Love <fx@gnu.org>
parents:
diff changeset
1346 @var{n})} is the same as @code{(callf + @var{place} @var{n})}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1347 Some more examples:
Dave Love <fx@gnu.org>
parents:
diff changeset
1348
Dave Love <fx@gnu.org>
parents:
diff changeset
1349 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1350 (callf abs my-number)
Dave Love <fx@gnu.org>
parents:
diff changeset
1351 (callf concat (buffer-name) "<" (int-to-string n) ">")
Dave Love <fx@gnu.org>
parents:
diff changeset
1352 (callf union happy-people (list joe bob) :test 'same-person)
Dave Love <fx@gnu.org>
parents:
diff changeset
1353 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1354
Dave Love <fx@gnu.org>
parents:
diff changeset
1355 @xref{Customizing Setf}, for @code{define-modify-macro}, a way
Dave Love <fx@gnu.org>
parents:
diff changeset
1356 to create even more concise notations for modify macros. Note
Dave Love <fx@gnu.org>
parents:
diff changeset
1357 again that @code{callf} is an extension to standard Common Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
1358 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1359
Dave Love <fx@gnu.org>
parents:
diff changeset
1360 @defspec callf2 @var{function} @var{arg1} @var{place} @var{args}@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
1361 This macro is like @code{callf}, except that @var{place} is
Dave Love <fx@gnu.org>
parents:
diff changeset
1362 the @emph{second} argument of @var{function} rather than the
Dave Love <fx@gnu.org>
parents:
diff changeset
1363 first. For example, @code{(push @var{x} @var{place})} is
Dave Love <fx@gnu.org>
parents:
diff changeset
1364 equivalent to @code{(callf2 cons @var{x} @var{place})}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1365 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1366
Dave Love <fx@gnu.org>
parents:
diff changeset
1367 The @code{callf} and @code{callf2} macros serve as building
Dave Love <fx@gnu.org>
parents:
diff changeset
1368 blocks for other macros like @code{incf}, @code{pushnew}, and
Dave Love <fx@gnu.org>
parents:
diff changeset
1369 @code{define-modify-macro}. The @code{letf} and @code{letf*}
Dave Love <fx@gnu.org>
parents:
diff changeset
1370 macros are used in the processing of symbol macros;
Dave Love <fx@gnu.org>
parents:
diff changeset
1371 @pxref{Macro Bindings}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1372
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
1373 @node Customizing Setf, , Modify Macros, Generalized Variables
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1374 @subsection Customizing Setf
Dave Love <fx@gnu.org>
parents:
diff changeset
1375
Dave Love <fx@gnu.org>
parents:
diff changeset
1376 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1377 Common Lisp defines three macros, @code{define-modify-macro},
Dave Love <fx@gnu.org>
parents:
diff changeset
1378 @code{defsetf}, and @code{define-setf-method}, that allow the
Dave Love <fx@gnu.org>
parents:
diff changeset
1379 user to extend generalized variables in various ways.
Dave Love <fx@gnu.org>
parents:
diff changeset
1380
Dave Love <fx@gnu.org>
parents:
diff changeset
1381 @defspec define-modify-macro name arglist function [doc-string]
Dave Love <fx@gnu.org>
parents:
diff changeset
1382 This macro defines a ``read-modify-write'' macro similar to
Dave Love <fx@gnu.org>
parents:
diff changeset
1383 @code{incf} and @code{decf}. The macro @var{name} is defined
Dave Love <fx@gnu.org>
parents:
diff changeset
1384 to take a @var{place} argument followed by additional arguments
Dave Love <fx@gnu.org>
parents:
diff changeset
1385 described by @var{arglist}. The call
Dave Love <fx@gnu.org>
parents:
diff changeset
1386
Dave Love <fx@gnu.org>
parents:
diff changeset
1387 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1388 (@var{name} @var{place} @var{args}...)
Dave Love <fx@gnu.org>
parents:
diff changeset
1389 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1390
Dave Love <fx@gnu.org>
parents:
diff changeset
1391 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1392 will be expanded to
Dave Love <fx@gnu.org>
parents:
diff changeset
1393
Dave Love <fx@gnu.org>
parents:
diff changeset
1394 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1395 (callf @var{func} @var{place} @var{args}...)
Dave Love <fx@gnu.org>
parents:
diff changeset
1396 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1397
Dave Love <fx@gnu.org>
parents:
diff changeset
1398 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1399 which in turn is roughly equivalent to
Dave Love <fx@gnu.org>
parents:
diff changeset
1400
Dave Love <fx@gnu.org>
parents:
diff changeset
1401 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1402 (setf @var{place} (@var{func} @var{place} @var{args}...))
Dave Love <fx@gnu.org>
parents:
diff changeset
1403 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1404
Dave Love <fx@gnu.org>
parents:
diff changeset
1405 For example:
Dave Love <fx@gnu.org>
parents:
diff changeset
1406
Dave Love <fx@gnu.org>
parents:
diff changeset
1407 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1408 (define-modify-macro incf (&optional (n 1)) +)
Dave Love <fx@gnu.org>
parents:
diff changeset
1409 (define-modify-macro concatf (&rest args) concat)
Dave Love <fx@gnu.org>
parents:
diff changeset
1410 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1411
Dave Love <fx@gnu.org>
parents:
diff changeset
1412 Note that @code{&key} is not allowed in @var{arglist}, but
Dave Love <fx@gnu.org>
parents:
diff changeset
1413 @code{&rest} is sufficient to pass keywords on to the function.
Dave Love <fx@gnu.org>
parents:
diff changeset
1414
Dave Love <fx@gnu.org>
parents:
diff changeset
1415 Most of the modify macros defined by Common Lisp do not exactly
Dave Love <fx@gnu.org>
parents:
diff changeset
1416 follow the pattern of @code{define-modify-macro}. For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
1417 @code{push} takes its arguments in the wrong order, and @code{pop}
Dave Love <fx@gnu.org>
parents:
diff changeset
1418 is completely irregular. You can define these macros ``by hand''
Dave Love <fx@gnu.org>
parents:
diff changeset
1419 using @code{get-setf-method}, or consult the source file
Dave Love <fx@gnu.org>
parents:
diff changeset
1420 @file{cl-macs.el} to see how to use the internal @code{setf}
Dave Love <fx@gnu.org>
parents:
diff changeset
1421 building blocks.
Dave Love <fx@gnu.org>
parents:
diff changeset
1422 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1423
Dave Love <fx@gnu.org>
parents:
diff changeset
1424 @defspec defsetf access-fn update-fn
Dave Love <fx@gnu.org>
parents:
diff changeset
1425 This is the simpler of two @code{defsetf} forms. Where
Dave Love <fx@gnu.org>
parents:
diff changeset
1426 @var{access-fn} is the name of a function which accesses a place,
Dave Love <fx@gnu.org>
parents:
diff changeset
1427 this declares @var{update-fn} to be the corresponding store
Dave Love <fx@gnu.org>
parents:
diff changeset
1428 function. From now on,
Dave Love <fx@gnu.org>
parents:
diff changeset
1429
Dave Love <fx@gnu.org>
parents:
diff changeset
1430 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1431 (setf (@var{access-fn} @var{arg1} @var{arg2} @var{arg3}) @var{value})
Dave Love <fx@gnu.org>
parents:
diff changeset
1432 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1433
Dave Love <fx@gnu.org>
parents:
diff changeset
1434 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1435 will be expanded to
Dave Love <fx@gnu.org>
parents:
diff changeset
1436
Dave Love <fx@gnu.org>
parents:
diff changeset
1437 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1438 (@var{update-fn} @var{arg1} @var{arg2} @var{arg3} @var{value})
Dave Love <fx@gnu.org>
parents:
diff changeset
1439 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1440
Dave Love <fx@gnu.org>
parents:
diff changeset
1441 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1442 The @var{update-fn} is required to be either a true function, or
Dave Love <fx@gnu.org>
parents:
diff changeset
1443 a macro which evaluates its arguments in a function-like way. Also,
Dave Love <fx@gnu.org>
parents:
diff changeset
1444 the @var{update-fn} is expected to return @var{value} as its result.
Dave Love <fx@gnu.org>
parents:
diff changeset
1445 Otherwise, the above expansion would not obey the rules for the way
Dave Love <fx@gnu.org>
parents:
diff changeset
1446 @code{setf} is supposed to behave.
Dave Love <fx@gnu.org>
parents:
diff changeset
1447
Dave Love <fx@gnu.org>
parents:
diff changeset
1448 As a special (non-Common-Lisp) extension, a third argument of @code{t}
Dave Love <fx@gnu.org>
parents:
diff changeset
1449 to @code{defsetf} says that the @code{update-fn}'s return value is
Dave Love <fx@gnu.org>
parents:
diff changeset
1450 not suitable, so that the above @code{setf} should be expanded to
Dave Love <fx@gnu.org>
parents:
diff changeset
1451 something more like
Dave Love <fx@gnu.org>
parents:
diff changeset
1452
Dave Love <fx@gnu.org>
parents:
diff changeset
1453 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1454 (let ((temp @var{value}))
Dave Love <fx@gnu.org>
parents:
diff changeset
1455 (@var{update-fn} @var{arg1} @var{arg2} @var{arg3} temp)
Dave Love <fx@gnu.org>
parents:
diff changeset
1456 temp)
Dave Love <fx@gnu.org>
parents:
diff changeset
1457 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1458
Dave Love <fx@gnu.org>
parents:
diff changeset
1459 Some examples of the use of @code{defsetf}, drawn from the standard
Dave Love <fx@gnu.org>
parents:
diff changeset
1460 suite of setf methods, are:
Dave Love <fx@gnu.org>
parents:
diff changeset
1461
Dave Love <fx@gnu.org>
parents:
diff changeset
1462 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1463 (defsetf car setcar)
Dave Love <fx@gnu.org>
parents:
diff changeset
1464 (defsetf symbol-value set)
Dave Love <fx@gnu.org>
parents:
diff changeset
1465 (defsetf buffer-name rename-buffer t)
Dave Love <fx@gnu.org>
parents:
diff changeset
1466 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1467 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1468
Dave Love <fx@gnu.org>
parents:
diff changeset
1469 @defspec defsetf access-fn arglist (store-var) forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
1470 This is the second, more complex, form of @code{defsetf}. It is
Dave Love <fx@gnu.org>
parents:
diff changeset
1471 rather like @code{defmacro} except for the additional @var{store-var}
Dave Love <fx@gnu.org>
parents:
diff changeset
1472 argument. The @var{forms} should return a Lisp form which stores
Dave Love <fx@gnu.org>
parents:
diff changeset
1473 the value of @var{store-var} into the generalized variable formed
Dave Love <fx@gnu.org>
parents:
diff changeset
1474 by a call to @var{access-fn} with arguments described by @var{arglist}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1475 The @var{forms} may begin with a string which documents the @code{setf}
Dave Love <fx@gnu.org>
parents:
diff changeset
1476 method (analogous to the doc string that appears at the front of a
Dave Love <fx@gnu.org>
parents:
diff changeset
1477 function).
Dave Love <fx@gnu.org>
parents:
diff changeset
1478
Dave Love <fx@gnu.org>
parents:
diff changeset
1479 For example, the simple form of @code{defsetf} is shorthand for
Dave Love <fx@gnu.org>
parents:
diff changeset
1480
Dave Love <fx@gnu.org>
parents:
diff changeset
1481 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1482 (defsetf @var{access-fn} (&rest args) (store)
Dave Love <fx@gnu.org>
parents:
diff changeset
1483 (append '(@var{update-fn}) args (list store)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1484 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1485
Dave Love <fx@gnu.org>
parents:
diff changeset
1486 The Lisp form that is returned can access the arguments from
Dave Love <fx@gnu.org>
parents:
diff changeset
1487 @var{arglist} and @var{store-var} in an unrestricted fashion;
Dave Love <fx@gnu.org>
parents:
diff changeset
1488 macros like @code{setf} and @code{incf} which invoke this
Dave Love <fx@gnu.org>
parents:
diff changeset
1489 setf-method will insert temporary variables as needed to make
Dave Love <fx@gnu.org>
parents:
diff changeset
1490 sure the apparent order of evaluation is preserved.
Dave Love <fx@gnu.org>
parents:
diff changeset
1491
Dave Love <fx@gnu.org>
parents:
diff changeset
1492 Another example drawn from the standard package:
Dave Love <fx@gnu.org>
parents:
diff changeset
1493
Dave Love <fx@gnu.org>
parents:
diff changeset
1494 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1495 (defsetf nth (n x) (store)
Dave Love <fx@gnu.org>
parents:
diff changeset
1496 (list 'setcar (list 'nthcdr n x) store))
Dave Love <fx@gnu.org>
parents:
diff changeset
1497 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1498 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1499
Dave Love <fx@gnu.org>
parents:
diff changeset
1500 @defspec define-setf-method access-fn arglist forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
1501 This is the most general way to create new place forms. When
Dave Love <fx@gnu.org>
parents:
diff changeset
1502 a @code{setf} to @var{access-fn} with arguments described by
Dave Love <fx@gnu.org>
parents:
diff changeset
1503 @var{arglist} is expanded, the @var{forms} are evaluated and
Dave Love <fx@gnu.org>
parents:
diff changeset
1504 must return a list of five items:
Dave Love <fx@gnu.org>
parents:
diff changeset
1505
Dave Love <fx@gnu.org>
parents:
diff changeset
1506 @enumerate
Dave Love <fx@gnu.org>
parents:
diff changeset
1507 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1508 A list of @dfn{temporary variables}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1509
Dave Love <fx@gnu.org>
parents:
diff changeset
1510 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1511 A list of @dfn{value forms} corresponding to the temporary variables
Dave Love <fx@gnu.org>
parents:
diff changeset
1512 above. The temporary variables will be bound to these value forms
Dave Love <fx@gnu.org>
parents:
diff changeset
1513 as the first step of any operation on the generalized variable.
Dave Love <fx@gnu.org>
parents:
diff changeset
1514
Dave Love <fx@gnu.org>
parents:
diff changeset
1515 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1516 A list of exactly one @dfn{store variable} (generally obtained
Dave Love <fx@gnu.org>
parents:
diff changeset
1517 from a call to @code{gensym}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1518
Dave Love <fx@gnu.org>
parents:
diff changeset
1519 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1520 A Lisp form which stores the contents of the store variable into
Dave Love <fx@gnu.org>
parents:
diff changeset
1521 the generalized variable, assuming the temporaries have been
Dave Love <fx@gnu.org>
parents:
diff changeset
1522 bound as described above.
Dave Love <fx@gnu.org>
parents:
diff changeset
1523
Dave Love <fx@gnu.org>
parents:
diff changeset
1524 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1525 A Lisp form which accesses the contents of the generalized variable,
Dave Love <fx@gnu.org>
parents:
diff changeset
1526 assuming the temporaries have been bound.
Dave Love <fx@gnu.org>
parents:
diff changeset
1527 @end enumerate
Dave Love <fx@gnu.org>
parents:
diff changeset
1528
Dave Love <fx@gnu.org>
parents:
diff changeset
1529 This is exactly like the Common Lisp macro of the same name,
Dave Love <fx@gnu.org>
parents:
diff changeset
1530 except that the method returns a list of five values rather
Dave Love <fx@gnu.org>
parents:
diff changeset
1531 than the five values themselves, since Emacs Lisp does not
Dave Love <fx@gnu.org>
parents:
diff changeset
1532 support Common Lisp's notion of multiple return values.
Dave Love <fx@gnu.org>
parents:
diff changeset
1533
Dave Love <fx@gnu.org>
parents:
diff changeset
1534 Once again, the @var{forms} may begin with a documentation string.
Dave Love <fx@gnu.org>
parents:
diff changeset
1535
Dave Love <fx@gnu.org>
parents:
diff changeset
1536 A setf-method should be maximally conservative with regard to
Dave Love <fx@gnu.org>
parents:
diff changeset
1537 temporary variables. In the setf-methods generated by
Dave Love <fx@gnu.org>
parents:
diff changeset
1538 @code{defsetf}, the second return value is simply the list of
Dave Love <fx@gnu.org>
parents:
diff changeset
1539 arguments in the place form, and the first return value is a
Dave Love <fx@gnu.org>
parents:
diff changeset
1540 list of a corresponding number of temporary variables generated
Dave Love <fx@gnu.org>
parents:
diff changeset
1541 by @code{gensym}. Macros like @code{setf} and @code{incf} which
Dave Love <fx@gnu.org>
parents:
diff changeset
1542 use this setf-method will optimize away most temporaries that
Dave Love <fx@gnu.org>
parents:
diff changeset
1543 turn out to be unnecessary, so there is little reason for the
Dave Love <fx@gnu.org>
parents:
diff changeset
1544 setf-method itself to optimize.
Dave Love <fx@gnu.org>
parents:
diff changeset
1545 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1546
Dave Love <fx@gnu.org>
parents:
diff changeset
1547 @defun get-setf-method place &optional env
Dave Love <fx@gnu.org>
parents:
diff changeset
1548 This function returns the setf-method for @var{place}, by
Dave Love <fx@gnu.org>
parents:
diff changeset
1549 invoking the definition previously recorded by @code{defsetf}
Dave Love <fx@gnu.org>
parents:
diff changeset
1550 or @code{define-setf-method}. The result is a list of five
Dave Love <fx@gnu.org>
parents:
diff changeset
1551 values as described above. You can use this function to build
Dave Love <fx@gnu.org>
parents:
diff changeset
1552 your own @code{incf}-like modify macros. (Actually, it is
Dave Love <fx@gnu.org>
parents:
diff changeset
1553 better to use the internal functions @code{cl-setf-do-modify}
Dave Love <fx@gnu.org>
parents:
diff changeset
1554 and @code{cl-setf-do-store}, which are a bit easier to use and
Dave Love <fx@gnu.org>
parents:
diff changeset
1555 which also do a number of optimizations; consult the source
Dave Love <fx@gnu.org>
parents:
diff changeset
1556 code for the @code{incf} function for a simple example.)
Dave Love <fx@gnu.org>
parents:
diff changeset
1557
Dave Love <fx@gnu.org>
parents:
diff changeset
1558 The argument @var{env} specifies the ``environment'' to be
Dave Love <fx@gnu.org>
parents:
diff changeset
1559 passed on to @code{macroexpand} if @code{get-setf-method} should
Dave Love <fx@gnu.org>
parents:
diff changeset
1560 need to expand a macro in @var{place}. It should come from
Dave Love <fx@gnu.org>
parents:
diff changeset
1561 an @code{&environment} argument to the macro or setf-method
Dave Love <fx@gnu.org>
parents:
diff changeset
1562 that called @code{get-setf-method}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1563
Dave Love <fx@gnu.org>
parents:
diff changeset
1564 See also the source code for the setf-methods for @code{apply}
Dave Love <fx@gnu.org>
parents:
diff changeset
1565 and @code{substring}, each of which works by calling
Dave Love <fx@gnu.org>
parents:
diff changeset
1566 @code{get-setf-method} on a simpler case, then massaging
Dave Love <fx@gnu.org>
parents:
diff changeset
1567 the result in various ways.
Dave Love <fx@gnu.org>
parents:
diff changeset
1568 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
1569
Dave Love <fx@gnu.org>
parents:
diff changeset
1570 Modern Common Lisp defines a second, independent way to specify
Dave Love <fx@gnu.org>
parents:
diff changeset
1571 the @code{setf} behavior of a function, namely ``@code{setf}
Dave Love <fx@gnu.org>
parents:
diff changeset
1572 functions'' whose names are lists @code{(setf @var{name})}
Dave Love <fx@gnu.org>
parents:
diff changeset
1573 rather than symbols. For example, @code{(defun (setf foo) @dots{})}
Dave Love <fx@gnu.org>
parents:
diff changeset
1574 defines the function that is used when @code{setf} is applied to
Dave Love <fx@gnu.org>
parents:
diff changeset
1575 @code{foo}. This package does not currently support @code{setf}
Dave Love <fx@gnu.org>
parents:
diff changeset
1576 functions. In particular, it is a compile-time error to use
Dave Love <fx@gnu.org>
parents:
diff changeset
1577 @code{setf} on a form which has not already been @code{defsetf}'d
Dave Love <fx@gnu.org>
parents:
diff changeset
1578 or otherwise declared; in newer Common Lisps, this would not be
Dave Love <fx@gnu.org>
parents:
diff changeset
1579 an error since the function @code{(setf @var{func})} might be
Dave Love <fx@gnu.org>
parents:
diff changeset
1580 defined later.
Dave Love <fx@gnu.org>
parents:
diff changeset
1581
Dave Love <fx@gnu.org>
parents:
diff changeset
1582 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
1583 @secno=4
Dave Love <fx@gnu.org>
parents:
diff changeset
1584 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
1585
Dave Love <fx@gnu.org>
parents:
diff changeset
1586 @node Variable Bindings, Conditionals, Generalized Variables, Control Structure
Dave Love <fx@gnu.org>
parents:
diff changeset
1587 @section Variable Bindings
Dave Love <fx@gnu.org>
parents:
diff changeset
1588
Dave Love <fx@gnu.org>
parents:
diff changeset
1589 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1590 These Lisp forms make bindings to variables and function names,
Dave Love <fx@gnu.org>
parents:
diff changeset
1591 analogous to Lisp's built-in @code{let} form.
Dave Love <fx@gnu.org>
parents:
diff changeset
1592
Dave Love <fx@gnu.org>
parents:
diff changeset
1593 @xref{Modify Macros}, for the @code{letf} and @code{letf*} forms which
Dave Love <fx@gnu.org>
parents:
diff changeset
1594 are also related to variable bindings.
Dave Love <fx@gnu.org>
parents:
diff changeset
1595
Dave Love <fx@gnu.org>
parents:
diff changeset
1596 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1597 * Dynamic Bindings:: The `progv' form
Dave Love <fx@gnu.org>
parents:
diff changeset
1598 * Lexical Bindings:: `lexical-let' and lexical closures
Dave Love <fx@gnu.org>
parents:
diff changeset
1599 * Function Bindings:: `flet' and `labels'
Dave Love <fx@gnu.org>
parents:
diff changeset
1600 * Macro Bindings:: `macrolet' and `symbol-macrolet'
Dave Love <fx@gnu.org>
parents:
diff changeset
1601 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1602
Dave Love <fx@gnu.org>
parents:
diff changeset
1603 @node Dynamic Bindings, Lexical Bindings, Variable Bindings, Variable Bindings
Dave Love <fx@gnu.org>
parents:
diff changeset
1604 @subsection Dynamic Bindings
Dave Love <fx@gnu.org>
parents:
diff changeset
1605
Dave Love <fx@gnu.org>
parents:
diff changeset
1606 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1607 The standard @code{let} form binds variables whose names are known
Dave Love <fx@gnu.org>
parents:
diff changeset
1608 at compile-time. The @code{progv} form provides an easy way to
Dave Love <fx@gnu.org>
parents:
diff changeset
1609 bind variables whose names are computed at run-time.
Dave Love <fx@gnu.org>
parents:
diff changeset
1610
Dave Love <fx@gnu.org>
parents:
diff changeset
1611 @defspec progv symbols values forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
1612 This form establishes @code{let}-style variable bindings on a
Dave Love <fx@gnu.org>
parents:
diff changeset
1613 set of variables computed at run-time. The expressions
Dave Love <fx@gnu.org>
parents:
diff changeset
1614 @var{symbols} and @var{values} are evaluated, and must return lists
Dave Love <fx@gnu.org>
parents:
diff changeset
1615 of symbols and values, respectively. The symbols are bound to the
Dave Love <fx@gnu.org>
parents:
diff changeset
1616 corresponding values for the duration of the body @var{form}s.
Dave Love <fx@gnu.org>
parents:
diff changeset
1617 If @var{values} is shorter than @var{symbols}, the last few symbols
Dave Love <fx@gnu.org>
parents:
diff changeset
1618 are made unbound (as if by @code{makunbound}) inside the body.
Dave Love <fx@gnu.org>
parents:
diff changeset
1619 If @var{symbols} is shorter than @var{values}, the excess values
Dave Love <fx@gnu.org>
parents:
diff changeset
1620 are ignored.
Dave Love <fx@gnu.org>
parents:
diff changeset
1621 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1622
Dave Love <fx@gnu.org>
parents:
diff changeset
1623 @node Lexical Bindings, Function Bindings, Dynamic Bindings, Variable Bindings
Dave Love <fx@gnu.org>
parents:
diff changeset
1624 @subsection Lexical Bindings
Dave Love <fx@gnu.org>
parents:
diff changeset
1625
Dave Love <fx@gnu.org>
parents:
diff changeset
1626 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1627 The @dfn{CL} package defines the following macro which
Dave Love <fx@gnu.org>
parents:
diff changeset
1628 more closely follows the Common Lisp @code{let} form:
Dave Love <fx@gnu.org>
parents:
diff changeset
1629
Dave Love <fx@gnu.org>
parents:
diff changeset
1630 @defspec lexical-let (bindings@dots{}) forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
1631 This form is exactly like @code{let} except that the bindings it
Dave Love <fx@gnu.org>
parents:
diff changeset
1632 establishes are purely lexical. Lexical bindings are similar to
Dave Love <fx@gnu.org>
parents:
diff changeset
1633 local variables in a language like C: Only the code physically
Dave Love <fx@gnu.org>
parents:
diff changeset
1634 within the body of the @code{lexical-let} (after macro expansion)
Dave Love <fx@gnu.org>
parents:
diff changeset
1635 may refer to the bound variables.
Dave Love <fx@gnu.org>
parents:
diff changeset
1636
Dave Love <fx@gnu.org>
parents:
diff changeset
1637 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1638 (setq a 5)
Dave Love <fx@gnu.org>
parents:
diff changeset
1639 (defun foo (b) (+ a b))
Dave Love <fx@gnu.org>
parents:
diff changeset
1640 (let ((a 2)) (foo a))
Dave Love <fx@gnu.org>
parents:
diff changeset
1641 @result{} 4
Dave Love <fx@gnu.org>
parents:
diff changeset
1642 (lexical-let ((a 2)) (foo a))
Dave Love <fx@gnu.org>
parents:
diff changeset
1643 @result{} 7
Dave Love <fx@gnu.org>
parents:
diff changeset
1644 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1645
Dave Love <fx@gnu.org>
parents:
diff changeset
1646 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1647 In this example, a regular @code{let} binding of @code{a} actually
Dave Love <fx@gnu.org>
parents:
diff changeset
1648 makes a temporary change to the global variable @code{a}, so @code{foo}
Dave Love <fx@gnu.org>
parents:
diff changeset
1649 is able to see the binding of @code{a} to 2. But @code{lexical-let}
Dave Love <fx@gnu.org>
parents:
diff changeset
1650 actually creates a distinct local variable @code{a} for use within its
Dave Love <fx@gnu.org>
parents:
diff changeset
1651 body, without any effect on the global variable of the same name.
Dave Love <fx@gnu.org>
parents:
diff changeset
1652
Dave Love <fx@gnu.org>
parents:
diff changeset
1653 The most important use of lexical bindings is to create @dfn{closures}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1654 A closure is a function object that refers to an outside lexical
Dave Love <fx@gnu.org>
parents:
diff changeset
1655 variable. For example:
Dave Love <fx@gnu.org>
parents:
diff changeset
1656
Dave Love <fx@gnu.org>
parents:
diff changeset
1657 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1658 (defun make-adder (n)
Dave Love <fx@gnu.org>
parents:
diff changeset
1659 (lexical-let ((n n))
Dave Love <fx@gnu.org>
parents:
diff changeset
1660 (function (lambda (m) (+ n m)))))
Dave Love <fx@gnu.org>
parents:
diff changeset
1661 (setq add17 (make-adder 17))
Dave Love <fx@gnu.org>
parents:
diff changeset
1662 (funcall add17 4)
Dave Love <fx@gnu.org>
parents:
diff changeset
1663 @result{} 21
Dave Love <fx@gnu.org>
parents:
diff changeset
1664 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1665
Dave Love <fx@gnu.org>
parents:
diff changeset
1666 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1667 The call @code{(make-adder 17)} returns a function object which adds
Dave Love <fx@gnu.org>
parents:
diff changeset
1668 17 to its argument. If @code{let} had been used instead of
Dave Love <fx@gnu.org>
parents:
diff changeset
1669 @code{lexical-let}, the function object would have referred to the
Dave Love <fx@gnu.org>
parents:
diff changeset
1670 global @code{n}, which would have been bound to 17 only during the
Dave Love <fx@gnu.org>
parents:
diff changeset
1671 call to @code{make-adder} itself.
Dave Love <fx@gnu.org>
parents:
diff changeset
1672
Dave Love <fx@gnu.org>
parents:
diff changeset
1673 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1674 (defun make-counter ()
Dave Love <fx@gnu.org>
parents:
diff changeset
1675 (lexical-let ((n 0))
Dave Love <fx@gnu.org>
parents:
diff changeset
1676 (function* (lambda (&optional (m 1)) (incf n m)))))
Dave Love <fx@gnu.org>
parents:
diff changeset
1677 (setq count-1 (make-counter))
Dave Love <fx@gnu.org>
parents:
diff changeset
1678 (funcall count-1 3)
Dave Love <fx@gnu.org>
parents:
diff changeset
1679 @result{} 3
Dave Love <fx@gnu.org>
parents:
diff changeset
1680 (funcall count-1 14)
Dave Love <fx@gnu.org>
parents:
diff changeset
1681 @result{} 17
Dave Love <fx@gnu.org>
parents:
diff changeset
1682 (setq count-2 (make-counter))
Dave Love <fx@gnu.org>
parents:
diff changeset
1683 (funcall count-2 5)
Dave Love <fx@gnu.org>
parents:
diff changeset
1684 @result{} 5
Dave Love <fx@gnu.org>
parents:
diff changeset
1685 (funcall count-1 2)
Dave Love <fx@gnu.org>
parents:
diff changeset
1686 @result{} 19
Dave Love <fx@gnu.org>
parents:
diff changeset
1687 (funcall count-2)
Dave Love <fx@gnu.org>
parents:
diff changeset
1688 @result{} 6
Dave Love <fx@gnu.org>
parents:
diff changeset
1689 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1690
Dave Love <fx@gnu.org>
parents:
diff changeset
1691 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1692 Here we see that each call to @code{make-counter} creates a distinct
Dave Love <fx@gnu.org>
parents:
diff changeset
1693 local variable @code{n}, which serves as a private counter for the
Dave Love <fx@gnu.org>
parents:
diff changeset
1694 function object that is returned.
Dave Love <fx@gnu.org>
parents:
diff changeset
1695
Dave Love <fx@gnu.org>
parents:
diff changeset
1696 Closed-over lexical variables persist until the last reference to
Dave Love <fx@gnu.org>
parents:
diff changeset
1697 them goes away, just like all other Lisp objects. For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
1698 @code{count-2} refers to a function object which refers to an
Dave Love <fx@gnu.org>
parents:
diff changeset
1699 instance of the variable @code{n}; this is the only reference
Dave Love <fx@gnu.org>
parents:
diff changeset
1700 to that variable, so after @code{(setq count-2 nil)} the garbage
Dave Love <fx@gnu.org>
parents:
diff changeset
1701 collector would be able to delete this instance of @code{n}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1702 Of course, if a @code{lexical-let} does not actually create any
Dave Love <fx@gnu.org>
parents:
diff changeset
1703 closures, then the lexical variables are free as soon as the
Dave Love <fx@gnu.org>
parents:
diff changeset
1704 @code{lexical-let} returns.
Dave Love <fx@gnu.org>
parents:
diff changeset
1705
Dave Love <fx@gnu.org>
parents:
diff changeset
1706 Many closures are used only during the extent of the bindings they
Dave Love <fx@gnu.org>
parents:
diff changeset
1707 refer to; these are known as ``downward funargs'' in Lisp parlance.
Dave Love <fx@gnu.org>
parents:
diff changeset
1708 When a closure is used in this way, regular Emacs Lisp dynamic
Dave Love <fx@gnu.org>
parents:
diff changeset
1709 bindings suffice and will be more efficient than @code{lexical-let}
Dave Love <fx@gnu.org>
parents:
diff changeset
1710 closures:
Dave Love <fx@gnu.org>
parents:
diff changeset
1711
Dave Love <fx@gnu.org>
parents:
diff changeset
1712 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1713 (defun add-to-list (x list)
28344
54fda0e8528a Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28039
diff changeset
1714 (mapcar (lambda (y) (+ x y))) list)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1715 (add-to-list 7 '(1 2 5))
Dave Love <fx@gnu.org>
parents:
diff changeset
1716 @result{} (8 9 12)
Dave Love <fx@gnu.org>
parents:
diff changeset
1717 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1718
Dave Love <fx@gnu.org>
parents:
diff changeset
1719 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1720 Since this lambda is only used while @code{x} is still bound,
Dave Love <fx@gnu.org>
parents:
diff changeset
1721 it is not necessary to make a true closure out of it.
Dave Love <fx@gnu.org>
parents:
diff changeset
1722
Dave Love <fx@gnu.org>
parents:
diff changeset
1723 You can use @code{defun} or @code{flet} inside a @code{lexical-let}
Dave Love <fx@gnu.org>
parents:
diff changeset
1724 to create a named closure. If several closures are created in the
Dave Love <fx@gnu.org>
parents:
diff changeset
1725 body of a single @code{lexical-let}, they all close over the same
Dave Love <fx@gnu.org>
parents:
diff changeset
1726 instance of the lexical variable.
Dave Love <fx@gnu.org>
parents:
diff changeset
1727
Dave Love <fx@gnu.org>
parents:
diff changeset
1728 The @code{lexical-let} form is an extension to Common Lisp. In
Dave Love <fx@gnu.org>
parents:
diff changeset
1729 true Common Lisp, all bindings are lexical unless declared otherwise.
Dave Love <fx@gnu.org>
parents:
diff changeset
1730 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1731
Dave Love <fx@gnu.org>
parents:
diff changeset
1732 @defspec lexical-let* (bindings@dots{}) forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
1733 This form is just like @code{lexical-let}, except that the bindings
Dave Love <fx@gnu.org>
parents:
diff changeset
1734 are made sequentially in the manner of @code{let*}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1735 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1736
Dave Love <fx@gnu.org>
parents:
diff changeset
1737 @node Function Bindings, Macro Bindings, Lexical Bindings, Variable Bindings
Dave Love <fx@gnu.org>
parents:
diff changeset
1738 @subsection Function Bindings
Dave Love <fx@gnu.org>
parents:
diff changeset
1739
Dave Love <fx@gnu.org>
parents:
diff changeset
1740 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1741 These forms make @code{let}-like bindings to functions instead
Dave Love <fx@gnu.org>
parents:
diff changeset
1742 of variables.
Dave Love <fx@gnu.org>
parents:
diff changeset
1743
Dave Love <fx@gnu.org>
parents:
diff changeset
1744 @defspec flet (bindings@dots{}) forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
1745 This form establishes @code{let}-style bindings on the function
Dave Love <fx@gnu.org>
parents:
diff changeset
1746 cells of symbols rather than on the value cells. Each @var{binding}
Dave Love <fx@gnu.org>
parents:
diff changeset
1747 must be a list of the form @samp{(@var{name} @var{arglist}
Dave Love <fx@gnu.org>
parents:
diff changeset
1748 @var{forms}@dots{})}, which defines a function exactly as if
Dave Love <fx@gnu.org>
parents:
diff changeset
1749 it were a @code{defun*} form. The function @var{name} is defined
Dave Love <fx@gnu.org>
parents:
diff changeset
1750 accordingly for the duration of the body of the @code{flet}; then
Dave Love <fx@gnu.org>
parents:
diff changeset
1751 the old function definition, or lack thereof, is restored.
Dave Love <fx@gnu.org>
parents:
diff changeset
1752
Dave Love <fx@gnu.org>
parents:
diff changeset
1753 While @code{flet} in Common Lisp establishes a lexical binding of
Dave Love <fx@gnu.org>
parents:
diff changeset
1754 @var{name}, Emacs Lisp @code{flet} makes a dynamic binding. The
Dave Love <fx@gnu.org>
parents:
diff changeset
1755 result is that @code{flet} affects indirect calls to a function as
Dave Love <fx@gnu.org>
parents:
diff changeset
1756 well as calls directly inside the @code{flet} form itself.
Dave Love <fx@gnu.org>
parents:
diff changeset
1757
Dave Love <fx@gnu.org>
parents:
diff changeset
1758 You can use @code{flet} to disable or modify the behavior of a
Dave Love <fx@gnu.org>
parents:
diff changeset
1759 function in a temporary fashion. This will even work on Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
1760 primitives, although note that some calls to primitive functions
Dave Love <fx@gnu.org>
parents:
diff changeset
1761 internal to Emacs are made without going through the symbol's
Dave Love <fx@gnu.org>
parents:
diff changeset
1762 function cell, and so will not be affected by @code{flet}. For
Dave Love <fx@gnu.org>
parents:
diff changeset
1763 example,
Dave Love <fx@gnu.org>
parents:
diff changeset
1764
Dave Love <fx@gnu.org>
parents:
diff changeset
1765 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1766 (flet ((message (&rest args) (push args saved-msgs)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1767 (do-something))
Dave Love <fx@gnu.org>
parents:
diff changeset
1768 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1769
Dave Love <fx@gnu.org>
parents:
diff changeset
1770 This code attempts to replace the built-in function @code{message}
Dave Love <fx@gnu.org>
parents:
diff changeset
1771 with a function that simply saves the messages in a list rather
Dave Love <fx@gnu.org>
parents:
diff changeset
1772 than displaying them. The original definition of @code{message}
Dave Love <fx@gnu.org>
parents:
diff changeset
1773 will be restored after @code{do-something} exits. This code will
Dave Love <fx@gnu.org>
parents:
diff changeset
1774 work fine on messages generated by other Lisp code, but messages
Dave Love <fx@gnu.org>
parents:
diff changeset
1775 generated directly inside Emacs will not be caught since they make
Dave Love <fx@gnu.org>
parents:
diff changeset
1776 direct C-language calls to the message routines rather than going
Dave Love <fx@gnu.org>
parents:
diff changeset
1777 through the Lisp @code{message} function.
Dave Love <fx@gnu.org>
parents:
diff changeset
1778
Dave Love <fx@gnu.org>
parents:
diff changeset
1779 Functions defined by @code{flet} may use the full Common Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1780 argument notation supported by @code{defun*}; also, the function
Dave Love <fx@gnu.org>
parents:
diff changeset
1781 body is enclosed in an implicit block as if by @code{defun*}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1782 @xref{Program Structure}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1783 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1784
Dave Love <fx@gnu.org>
parents:
diff changeset
1785 @defspec labels (bindings@dots{}) forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
1786 The @code{labels} form is like @code{flet}, except that it
Dave Love <fx@gnu.org>
parents:
diff changeset
1787 makes lexical bindings of the function names rather than
Dave Love <fx@gnu.org>
parents:
diff changeset
1788 dynamic bindings. (In true Common Lisp, both @code{flet} and
Dave Love <fx@gnu.org>
parents:
diff changeset
1789 @code{labels} make lexical bindings of slightly different sorts;
Dave Love <fx@gnu.org>
parents:
diff changeset
1790 since Emacs Lisp is dynamically bound by default, it seemed
Dave Love <fx@gnu.org>
parents:
diff changeset
1791 more appropriate for @code{flet} also to use dynamic binding.
Dave Love <fx@gnu.org>
parents:
diff changeset
1792 The @code{labels} form, with its lexical binding, is fully
Dave Love <fx@gnu.org>
parents:
diff changeset
1793 compatible with Common Lisp.)
Dave Love <fx@gnu.org>
parents:
diff changeset
1794
Dave Love <fx@gnu.org>
parents:
diff changeset
1795 Lexical scoping means that all references to the named
Dave Love <fx@gnu.org>
parents:
diff changeset
1796 functions must appear physically within the body of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1797 @code{labels} form. References may appear both in the body
Dave Love <fx@gnu.org>
parents:
diff changeset
1798 @var{forms} of @code{labels} itself, and in the bodies of
Dave Love <fx@gnu.org>
parents:
diff changeset
1799 the functions themselves. Thus, @code{labels} can define
Dave Love <fx@gnu.org>
parents:
diff changeset
1800 local recursive functions, or mutually-recursive sets of
Dave Love <fx@gnu.org>
parents:
diff changeset
1801 functions.
Dave Love <fx@gnu.org>
parents:
diff changeset
1802
Dave Love <fx@gnu.org>
parents:
diff changeset
1803 A ``reference'' to a function name is either a call to that
Dave Love <fx@gnu.org>
parents:
diff changeset
1804 function, or a use of its name quoted by @code{quote} or
Dave Love <fx@gnu.org>
parents:
diff changeset
1805 @code{function} to be passed on to, say, @code{mapcar}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1806 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1807
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
1808 @node Macro Bindings, , Function Bindings, Variable Bindings
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1809 @subsection Macro Bindings
Dave Love <fx@gnu.org>
parents:
diff changeset
1810
Dave Love <fx@gnu.org>
parents:
diff changeset
1811 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1812 These forms create local macros and ``symbol macros.''
Dave Love <fx@gnu.org>
parents:
diff changeset
1813
Dave Love <fx@gnu.org>
parents:
diff changeset
1814 @defspec macrolet (bindings@dots{}) forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
1815 This form is analogous to @code{flet}, but for macros instead of
Dave Love <fx@gnu.org>
parents:
diff changeset
1816 functions. Each @var{binding} is a list of the same form as the
Dave Love <fx@gnu.org>
parents:
diff changeset
1817 arguments to @code{defmacro*} (i.e., a macro name, argument list,
Dave Love <fx@gnu.org>
parents:
diff changeset
1818 and macro-expander forms). The macro is defined accordingly for
Dave Love <fx@gnu.org>
parents:
diff changeset
1819 use within the body of the @code{macrolet}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1820
Dave Love <fx@gnu.org>
parents:
diff changeset
1821 Because of the nature of macros, @code{macrolet} is lexically
Dave Love <fx@gnu.org>
parents:
diff changeset
1822 scoped even in Emacs Lisp: The @code{macrolet} binding will
Dave Love <fx@gnu.org>
parents:
diff changeset
1823 affect only calls that appear physically within the body
Dave Love <fx@gnu.org>
parents:
diff changeset
1824 @var{forms}, possibly after expansion of other macros in the
Dave Love <fx@gnu.org>
parents:
diff changeset
1825 body.
Dave Love <fx@gnu.org>
parents:
diff changeset
1826 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1827
Dave Love <fx@gnu.org>
parents:
diff changeset
1828 @defspec symbol-macrolet (bindings@dots{}) forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
1829 This form creates @dfn{symbol macros}, which are macros that look
Dave Love <fx@gnu.org>
parents:
diff changeset
1830 like variable references rather than function calls. Each
Dave Love <fx@gnu.org>
parents:
diff changeset
1831 @var{binding} is a list @samp{(@var{var} @var{expansion})};
Dave Love <fx@gnu.org>
parents:
diff changeset
1832 any reference to @var{var} within the body @var{forms} is
Dave Love <fx@gnu.org>
parents:
diff changeset
1833 replaced by @var{expansion}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1834
Dave Love <fx@gnu.org>
parents:
diff changeset
1835 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1836 (setq bar '(5 . 9))
Dave Love <fx@gnu.org>
parents:
diff changeset
1837 (symbol-macrolet ((foo (car bar)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1838 (incf foo))
Dave Love <fx@gnu.org>
parents:
diff changeset
1839 bar
Dave Love <fx@gnu.org>
parents:
diff changeset
1840 @result{} (6 . 9)
Dave Love <fx@gnu.org>
parents:
diff changeset
1841 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1842
Dave Love <fx@gnu.org>
parents:
diff changeset
1843 A @code{setq} of a symbol macro is treated the same as a @code{setf}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1844 I.e., @code{(setq foo 4)} in the above would be equivalent to
Dave Love <fx@gnu.org>
parents:
diff changeset
1845 @code{(setf foo 4)}, which in turn expands to @code{(setf (car bar) 4)}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1846
Dave Love <fx@gnu.org>
parents:
diff changeset
1847 Likewise, a @code{let} or @code{let*} binding a symbol macro is
Dave Love <fx@gnu.org>
parents:
diff changeset
1848 treated like a @code{letf} or @code{letf*}. This differs from true
Dave Love <fx@gnu.org>
parents:
diff changeset
1849 Common Lisp, where the rules of lexical scoping cause a @code{let}
Dave Love <fx@gnu.org>
parents:
diff changeset
1850 binding to shadow a @code{symbol-macrolet} binding. In this package,
Dave Love <fx@gnu.org>
parents:
diff changeset
1851 only @code{lexical-let} and @code{lexical-let*} will shadow a symbol
Dave Love <fx@gnu.org>
parents:
diff changeset
1852 macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
1853
Dave Love <fx@gnu.org>
parents:
diff changeset
1854 There is no analogue of @code{defmacro} for symbol macros; all symbol
Dave Love <fx@gnu.org>
parents:
diff changeset
1855 macros are local. A typical use of @code{symbol-macrolet} is in the
Dave Love <fx@gnu.org>
parents:
diff changeset
1856 expansion of another macro:
Dave Love <fx@gnu.org>
parents:
diff changeset
1857
Dave Love <fx@gnu.org>
parents:
diff changeset
1858 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1859 (defmacro* my-dolist ((x list) &rest body)
Dave Love <fx@gnu.org>
parents:
diff changeset
1860 (let ((var (gensym)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1861 (list 'loop 'for var 'on list 'do
Dave Love <fx@gnu.org>
parents:
diff changeset
1862 (list* 'symbol-macrolet (list (list x (list 'car var)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1863 body))))
Dave Love <fx@gnu.org>
parents:
diff changeset
1864
Dave Love <fx@gnu.org>
parents:
diff changeset
1865 (setq mylist '(1 2 3 4))
Dave Love <fx@gnu.org>
parents:
diff changeset
1866 (my-dolist (x mylist) (incf x))
Dave Love <fx@gnu.org>
parents:
diff changeset
1867 mylist
Dave Love <fx@gnu.org>
parents:
diff changeset
1868 @result{} (2 3 4 5)
Dave Love <fx@gnu.org>
parents:
diff changeset
1869 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1870
Dave Love <fx@gnu.org>
parents:
diff changeset
1871 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1872 In this example, the @code{my-dolist} macro is similar to @code{dolist}
27511
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
1873 (@pxref{Iteration}) except that the variable @code{x} becomes a true
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1874 reference onto the elements of the list. The @code{my-dolist} call
Dave Love <fx@gnu.org>
parents:
diff changeset
1875 shown here expands to
Dave Love <fx@gnu.org>
parents:
diff changeset
1876
Dave Love <fx@gnu.org>
parents:
diff changeset
1877 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1878 (loop for G1234 on mylist do
Dave Love <fx@gnu.org>
parents:
diff changeset
1879 (symbol-macrolet ((x (car G1234)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1880 (incf x)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1881 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1882
Dave Love <fx@gnu.org>
parents:
diff changeset
1883 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1884 which in turn expands to
Dave Love <fx@gnu.org>
parents:
diff changeset
1885
Dave Love <fx@gnu.org>
parents:
diff changeset
1886 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1887 (loop for G1234 on mylist do (incf (car G1234)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1888 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1889
Dave Love <fx@gnu.org>
parents:
diff changeset
1890 @xref{Loop Facility}, for a description of the @code{loop} macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
1891 This package defines a nonstandard @code{in-ref} loop clause that
Dave Love <fx@gnu.org>
parents:
diff changeset
1892 works much like @code{my-dolist}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1893 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1894
Dave Love <fx@gnu.org>
parents:
diff changeset
1895 @node Conditionals, Blocks and Exits, Variable Bindings, Control Structure
Dave Love <fx@gnu.org>
parents:
diff changeset
1896 @section Conditionals
Dave Love <fx@gnu.org>
parents:
diff changeset
1897
Dave Love <fx@gnu.org>
parents:
diff changeset
1898 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1899 These conditional forms augment Emacs Lisp's simple @code{if},
Dave Love <fx@gnu.org>
parents:
diff changeset
1900 @code{and}, @code{or}, and @code{cond} forms.
Dave Love <fx@gnu.org>
parents:
diff changeset
1901
Dave Love <fx@gnu.org>
parents:
diff changeset
1902 @defspec case keyform clause@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
1903 This macro evaluates @var{keyform}, then compares it with the key
Dave Love <fx@gnu.org>
parents:
diff changeset
1904 values listed in the various @var{clause}s. Whichever clause matches
Dave Love <fx@gnu.org>
parents:
diff changeset
1905 the key is executed; comparison is done by @code{eql}. If no clause
Dave Love <fx@gnu.org>
parents:
diff changeset
1906 matches, the @code{case} form returns @code{nil}. The clauses are
Dave Love <fx@gnu.org>
parents:
diff changeset
1907 of the form
Dave Love <fx@gnu.org>
parents:
diff changeset
1908
Dave Love <fx@gnu.org>
parents:
diff changeset
1909 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1910 (@var{keylist} @var{body-forms}@dots{})
Dave Love <fx@gnu.org>
parents:
diff changeset
1911 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1912
Dave Love <fx@gnu.org>
parents:
diff changeset
1913 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1914 where @var{keylist} is a list of key values. If there is exactly
Dave Love <fx@gnu.org>
parents:
diff changeset
1915 one value, and it is not a cons cell or the symbol @code{nil} or
Dave Love <fx@gnu.org>
parents:
diff changeset
1916 @code{t}, then it can be used by itself as a @var{keylist} without
Dave Love <fx@gnu.org>
parents:
diff changeset
1917 being enclosed in a list. All key values in the @code{case} form
Dave Love <fx@gnu.org>
parents:
diff changeset
1918 must be distinct. The final clauses may use @code{t} in place of
Dave Love <fx@gnu.org>
parents:
diff changeset
1919 a @var{keylist} to indicate a default clause that should be taken
Dave Love <fx@gnu.org>
parents:
diff changeset
1920 if none of the other clauses match. (The symbol @code{otherwise}
Dave Love <fx@gnu.org>
parents:
diff changeset
1921 is also recognized in place of @code{t}. To make a clause that
Dave Love <fx@gnu.org>
parents:
diff changeset
1922 matches the actual symbol @code{t}, @code{nil}, or @code{otherwise},
Dave Love <fx@gnu.org>
parents:
diff changeset
1923 enclose the symbol in a list.)
Dave Love <fx@gnu.org>
parents:
diff changeset
1924
Dave Love <fx@gnu.org>
parents:
diff changeset
1925 For example, this expression reads a keystroke, then does one of
Dave Love <fx@gnu.org>
parents:
diff changeset
1926 four things depending on whether it is an @samp{a}, a @samp{b},
Dave Love <fx@gnu.org>
parents:
diff changeset
1927 a @key{RET} or @kbd{C-j}, or anything else.
Dave Love <fx@gnu.org>
parents:
diff changeset
1928
Dave Love <fx@gnu.org>
parents:
diff changeset
1929 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1930 (case (read-char)
Dave Love <fx@gnu.org>
parents:
diff changeset
1931 (?a (do-a-thing))
Dave Love <fx@gnu.org>
parents:
diff changeset
1932 (?b (do-b-thing))
Dave Love <fx@gnu.org>
parents:
diff changeset
1933 ((?\r ?\n) (do-ret-thing))
Dave Love <fx@gnu.org>
parents:
diff changeset
1934 (t (do-other-thing)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1935 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1936 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1937
Dave Love <fx@gnu.org>
parents:
diff changeset
1938 @defspec ecase keyform clause@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
1939 This macro is just like @code{case}, except that if the key does
Dave Love <fx@gnu.org>
parents:
diff changeset
1940 not match any of the clauses, an error is signaled rather than
Dave Love <fx@gnu.org>
parents:
diff changeset
1941 simply returning @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1942 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1943
Dave Love <fx@gnu.org>
parents:
diff changeset
1944 @defspec typecase keyform clause@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
1945 This macro is a version of @code{case} that checks for types
Dave Love <fx@gnu.org>
parents:
diff changeset
1946 rather than values. Each @var{clause} is of the form
Dave Love <fx@gnu.org>
parents:
diff changeset
1947 @samp{(@var{type} @var{body}...)}. @xref{Type Predicates},
Dave Love <fx@gnu.org>
parents:
diff changeset
1948 for a description of type specifiers. For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
1949
Dave Love <fx@gnu.org>
parents:
diff changeset
1950 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1951 (typecase x
Dave Love <fx@gnu.org>
parents:
diff changeset
1952 (integer (munch-integer x))
Dave Love <fx@gnu.org>
parents:
diff changeset
1953 (float (munch-float x))
Dave Love <fx@gnu.org>
parents:
diff changeset
1954 (string (munch-integer (string-to-int x)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1955 (t (munch-anything x)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1956 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1957
Dave Love <fx@gnu.org>
parents:
diff changeset
1958 The type specifier @code{t} matches any type of object; the word
Dave Love <fx@gnu.org>
parents:
diff changeset
1959 @code{otherwise} is also allowed. To make one clause match any of
Dave Love <fx@gnu.org>
parents:
diff changeset
1960 several types, use an @code{(or ...)} type specifier.
Dave Love <fx@gnu.org>
parents:
diff changeset
1961 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1962
Dave Love <fx@gnu.org>
parents:
diff changeset
1963 @defspec etypecase keyform clause@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
1964 This macro is just like @code{typecase}, except that if the key does
Dave Love <fx@gnu.org>
parents:
diff changeset
1965 not match any of the clauses, an error is signaled rather than
Dave Love <fx@gnu.org>
parents:
diff changeset
1966 simply returning @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1967 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
1968
Dave Love <fx@gnu.org>
parents:
diff changeset
1969 @node Blocks and Exits, Iteration, Conditionals, Control Structure
Dave Love <fx@gnu.org>
parents:
diff changeset
1970 @section Blocks and Exits
Dave Love <fx@gnu.org>
parents:
diff changeset
1971
Dave Love <fx@gnu.org>
parents:
diff changeset
1972 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1973 Common Lisp @dfn{blocks} provide a non-local exit mechanism very
Dave Love <fx@gnu.org>
parents:
diff changeset
1974 similar to @code{catch} and @code{throw}, but lexically rather than
Dave Love <fx@gnu.org>
parents:
diff changeset
1975 dynamically scoped. This package actually implements @code{block}
Dave Love <fx@gnu.org>
parents:
diff changeset
1976 in terms of @code{catch}; however, the lexical scoping allows the
Dave Love <fx@gnu.org>
parents:
diff changeset
1977 optimizing byte-compiler to omit the costly @code{catch} step if the
Dave Love <fx@gnu.org>
parents:
diff changeset
1978 body of the block does not actually @code{return-from} the block.
Dave Love <fx@gnu.org>
parents:
diff changeset
1979
Dave Love <fx@gnu.org>
parents:
diff changeset
1980 @defspec block name forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
1981 The @var{forms} are evaluated as if by a @code{progn}. However,
Dave Love <fx@gnu.org>
parents:
diff changeset
1982 if any of the @var{forms} execute @code{(return-from @var{name})},
Dave Love <fx@gnu.org>
parents:
diff changeset
1983 they will jump out and return directly from the @code{block} form.
Dave Love <fx@gnu.org>
parents:
diff changeset
1984 The @code{block} returns the result of the last @var{form} unless
Dave Love <fx@gnu.org>
parents:
diff changeset
1985 a @code{return-from} occurs.
Dave Love <fx@gnu.org>
parents:
diff changeset
1986
Dave Love <fx@gnu.org>
parents:
diff changeset
1987 The @code{block}/@code{return-from} mechanism is quite similar to
Dave Love <fx@gnu.org>
parents:
diff changeset
1988 the @code{catch}/@code{throw} mechanism. The main differences are
Dave Love <fx@gnu.org>
parents:
diff changeset
1989 that block @var{name}s are unevaluated symbols, rather than forms
Dave Love <fx@gnu.org>
parents:
diff changeset
1990 (such as quoted symbols) which evaluate to a tag at run-time; and
Dave Love <fx@gnu.org>
parents:
diff changeset
1991 also that blocks are lexically scoped whereas @code{catch}/@code{throw}
Dave Love <fx@gnu.org>
parents:
diff changeset
1992 are dynamically scoped. This means that functions called from the
Dave Love <fx@gnu.org>
parents:
diff changeset
1993 body of a @code{catch} can also @code{throw} to the @code{catch},
Dave Love <fx@gnu.org>
parents:
diff changeset
1994 but the @code{return-from} referring to a block name must appear
Dave Love <fx@gnu.org>
parents:
diff changeset
1995 physically within the @var{forms} that make up the body of the block.
Dave Love <fx@gnu.org>
parents:
diff changeset
1996 They may not appear within other called functions, although they may
Dave Love <fx@gnu.org>
parents:
diff changeset
1997 appear within macro expansions or @code{lambda}s in the body. Block
Dave Love <fx@gnu.org>
parents:
diff changeset
1998 names and @code{catch} names form independent name-spaces.
Dave Love <fx@gnu.org>
parents:
diff changeset
1999
Dave Love <fx@gnu.org>
parents:
diff changeset
2000 In true Common Lisp, @code{defun} and @code{defmacro} surround
Dave Love <fx@gnu.org>
parents:
diff changeset
2001 the function or expander bodies with implicit blocks with the
Dave Love <fx@gnu.org>
parents:
diff changeset
2002 same name as the function or macro. This does not occur in Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
2003 Lisp, but this package provides @code{defun*} and @code{defmacro*}
Dave Love <fx@gnu.org>
parents:
diff changeset
2004 forms which do create the implicit block.
Dave Love <fx@gnu.org>
parents:
diff changeset
2005
Dave Love <fx@gnu.org>
parents:
diff changeset
2006 The Common Lisp looping constructs defined by this package,
27511
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2007 such as @code{loop} and @code{dolist}, also create implicit blocks
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2008 just as in Common Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
2009
Dave Love <fx@gnu.org>
parents:
diff changeset
2010 Because they are implemented in terms of Emacs Lisp @code{catch}
Dave Love <fx@gnu.org>
parents:
diff changeset
2011 and @code{throw}, blocks have the same overhead as actual
Dave Love <fx@gnu.org>
parents:
diff changeset
2012 @code{catch} constructs (roughly two function calls). However,
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
2013 the optimizing byte compiler will optimize away the @code{catch}
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
2014 if the block does
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2015 not in fact contain any @code{return} or @code{return-from} calls
Dave Love <fx@gnu.org>
parents:
diff changeset
2016 that jump to it. This means that @code{do} loops and @code{defun*}
Dave Love <fx@gnu.org>
parents:
diff changeset
2017 functions which don't use @code{return} don't pay the overhead to
Dave Love <fx@gnu.org>
parents:
diff changeset
2018 support it.
Dave Love <fx@gnu.org>
parents:
diff changeset
2019 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
2020
Dave Love <fx@gnu.org>
parents:
diff changeset
2021 @defspec return-from name [result]
Dave Love <fx@gnu.org>
parents:
diff changeset
2022 This macro returns from the block named @var{name}, which must be
Dave Love <fx@gnu.org>
parents:
diff changeset
2023 an (unevaluated) symbol. If a @var{result} form is specified, it
Dave Love <fx@gnu.org>
parents:
diff changeset
2024 is evaluated to produce the result returned from the @code{block}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2025 Otherwise, @code{nil} is returned.
Dave Love <fx@gnu.org>
parents:
diff changeset
2026 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
2027
Dave Love <fx@gnu.org>
parents:
diff changeset
2028 @defspec return [result]
Dave Love <fx@gnu.org>
parents:
diff changeset
2029 This macro is exactly like @code{(return-from nil @var{result})}.
27511
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2030 Common Lisp loops like @code{do} and @code{dolist} implicitly enclose
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2031 themselves in @code{nil} blocks.
Dave Love <fx@gnu.org>
parents:
diff changeset
2032 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
2033
Dave Love <fx@gnu.org>
parents:
diff changeset
2034 @node Iteration, Loop Facility, Blocks and Exits, Control Structure
Dave Love <fx@gnu.org>
parents:
diff changeset
2035 @section Iteration
Dave Love <fx@gnu.org>
parents:
diff changeset
2036
Dave Love <fx@gnu.org>
parents:
diff changeset
2037 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2038 The macros described here provide more sophisticated, high-level
Dave Love <fx@gnu.org>
parents:
diff changeset
2039 looping constructs to complement Emacs Lisp's basic @code{while}
Dave Love <fx@gnu.org>
parents:
diff changeset
2040 loop.
Dave Love <fx@gnu.org>
parents:
diff changeset
2041
Dave Love <fx@gnu.org>
parents:
diff changeset
2042 @defspec loop forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
2043 The @dfn{CL} package supports both the simple, old-style meaning of
Dave Love <fx@gnu.org>
parents:
diff changeset
2044 @code{loop} and the extremely powerful and flexible feature known as
Dave Love <fx@gnu.org>
parents:
diff changeset
2045 the @dfn{Loop Facility} or @dfn{Loop Macro}. This more advanced
Dave Love <fx@gnu.org>
parents:
diff changeset
2046 facility is discussed in the following section; @pxref{Loop Facility}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2047 The simple form of @code{loop} is described here.
Dave Love <fx@gnu.org>
parents:
diff changeset
2048
Dave Love <fx@gnu.org>
parents:
diff changeset
2049 If @code{loop} is followed by zero or more Lisp expressions,
Dave Love <fx@gnu.org>
parents:
diff changeset
2050 then @code{(loop @var{exprs}@dots{})} simply creates an infinite
Dave Love <fx@gnu.org>
parents:
diff changeset
2051 loop executing the expressions over and over. The loop is
Dave Love <fx@gnu.org>
parents:
diff changeset
2052 enclosed in an implicit @code{nil} block. Thus,
Dave Love <fx@gnu.org>
parents:
diff changeset
2053
Dave Love <fx@gnu.org>
parents:
diff changeset
2054 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2055 (loop (foo) (if (no-more) (return 72)) (bar))
Dave Love <fx@gnu.org>
parents:
diff changeset
2056 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2057
Dave Love <fx@gnu.org>
parents:
diff changeset
2058 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2059 is exactly equivalent to
Dave Love <fx@gnu.org>
parents:
diff changeset
2060
Dave Love <fx@gnu.org>
parents:
diff changeset
2061 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2062 (block nil (while t (foo) (if (no-more) (return 72)) (bar)))
Dave Love <fx@gnu.org>
parents:
diff changeset
2063 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2064
Dave Love <fx@gnu.org>
parents:
diff changeset
2065 If any of the expressions are plain symbols, the loop is instead
Dave Love <fx@gnu.org>
parents:
diff changeset
2066 interpreted as a Loop Macro specification as described later.
Dave Love <fx@gnu.org>
parents:
diff changeset
2067 (This is not a restriction in practice, since a plain symbol
Dave Love <fx@gnu.org>
parents:
diff changeset
2068 in the above notation would simply access and throw away the
Dave Love <fx@gnu.org>
parents:
diff changeset
2069 value of a variable.)
Dave Love <fx@gnu.org>
parents:
diff changeset
2070 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
2071
Dave Love <fx@gnu.org>
parents:
diff changeset
2072 @defspec do (spec@dots{}) (end-test [result@dots{}]) forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
2073 This macro creates a general iterative loop. Each @var{spec} is
Dave Love <fx@gnu.org>
parents:
diff changeset
2074 of the form
Dave Love <fx@gnu.org>
parents:
diff changeset
2075
Dave Love <fx@gnu.org>
parents:
diff changeset
2076 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2077 (@var{var} [@var{init} [@var{step}]])
Dave Love <fx@gnu.org>
parents:
diff changeset
2078 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2079
Dave Love <fx@gnu.org>
parents:
diff changeset
2080 The loop works as follows: First, each @var{var} is bound to the
Dave Love <fx@gnu.org>
parents:
diff changeset
2081 associated @var{init} value as if by a @code{let} form. Then, in
Dave Love <fx@gnu.org>
parents:
diff changeset
2082 each iteration of the loop, the @var{end-test} is evaluated; if
Dave Love <fx@gnu.org>
parents:
diff changeset
2083 true, the loop is finished. Otherwise, the body @var{forms} are
Dave Love <fx@gnu.org>
parents:
diff changeset
2084 evaluated, then each @var{var} is set to the associated @var{step}
Dave Love <fx@gnu.org>
parents:
diff changeset
2085 expression (as if by a @code{psetq} form) and the next iteration
Dave Love <fx@gnu.org>
parents:
diff changeset
2086 begins. Once the @var{end-test} becomes true, the @var{result}
Dave Love <fx@gnu.org>
parents:
diff changeset
2087 forms are evaluated (with the @var{var}s still bound to their
Dave Love <fx@gnu.org>
parents:
diff changeset
2088 values) to produce the result returned by @code{do}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2089
Dave Love <fx@gnu.org>
parents:
diff changeset
2090 The entire @code{do} loop is enclosed in an implicit @code{nil}
Dave Love <fx@gnu.org>
parents:
diff changeset
2091 block, so that you can use @code{(return)} to break out of the
Dave Love <fx@gnu.org>
parents:
diff changeset
2092 loop at any time.
Dave Love <fx@gnu.org>
parents:
diff changeset
2093
Dave Love <fx@gnu.org>
parents:
diff changeset
2094 If there are no @var{result} forms, the loop returns @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2095 If a given @var{var} has no @var{step} form, it is bound to its
Dave Love <fx@gnu.org>
parents:
diff changeset
2096 @var{init} value but not otherwise modified during the @code{do}
Dave Love <fx@gnu.org>
parents:
diff changeset
2097 loop (unless the code explicitly modifies it); this case is just
Dave Love <fx@gnu.org>
parents:
diff changeset
2098 a shorthand for putting a @code{(let ((@var{var} @var{init})) @dots{})}
Dave Love <fx@gnu.org>
parents:
diff changeset
2099 around the loop. If @var{init} is also omitted it defaults to
Dave Love <fx@gnu.org>
parents:
diff changeset
2100 @code{nil}, and in this case a plain @samp{@var{var}} can be used
Dave Love <fx@gnu.org>
parents:
diff changeset
2101 in place of @samp{(@var{var})}, again following the analogy with
Dave Love <fx@gnu.org>
parents:
diff changeset
2102 @code{let}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2103
Dave Love <fx@gnu.org>
parents:
diff changeset
2104 This example (from Steele) illustrates a loop which applies the
Dave Love <fx@gnu.org>
parents:
diff changeset
2105 function @code{f} to successive pairs of values from the lists
Dave Love <fx@gnu.org>
parents:
diff changeset
2106 @code{foo} and @code{bar}; it is equivalent to the call
Dave Love <fx@gnu.org>
parents:
diff changeset
2107 @code{(mapcar* 'f foo bar)}. Note that this loop has no body
Dave Love <fx@gnu.org>
parents:
diff changeset
2108 @var{forms} at all, performing all its work as side effects of
Dave Love <fx@gnu.org>
parents:
diff changeset
2109 the rest of the loop.
Dave Love <fx@gnu.org>
parents:
diff changeset
2110
Dave Love <fx@gnu.org>
parents:
diff changeset
2111 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2112 (do ((x foo (cdr x))
Dave Love <fx@gnu.org>
parents:
diff changeset
2113 (y bar (cdr y))
Dave Love <fx@gnu.org>
parents:
diff changeset
2114 (z nil (cons (f (car x) (car y)) z)))
Dave Love <fx@gnu.org>
parents:
diff changeset
2115 ((or (null x) (null y))
Dave Love <fx@gnu.org>
parents:
diff changeset
2116 (nreverse z)))
Dave Love <fx@gnu.org>
parents:
diff changeset
2117 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2118 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
2119
Dave Love <fx@gnu.org>
parents:
diff changeset
2120 @defspec do* (spec@dots{}) (end-test [result@dots{}]) forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
2121 This is to @code{do} what @code{let*} is to @code{let}. In
Dave Love <fx@gnu.org>
parents:
diff changeset
2122 particular, the initial values are bound as if by @code{let*}
Dave Love <fx@gnu.org>
parents:
diff changeset
2123 rather than @code{let}, and the steps are assigned as if by
Dave Love <fx@gnu.org>
parents:
diff changeset
2124 @code{setq} rather than @code{psetq}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2125
Dave Love <fx@gnu.org>
parents:
diff changeset
2126 Here is another way to write the above loop:
Dave Love <fx@gnu.org>
parents:
diff changeset
2127
Dave Love <fx@gnu.org>
parents:
diff changeset
2128 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2129 (do* ((xp foo (cdr xp))
Dave Love <fx@gnu.org>
parents:
diff changeset
2130 (yp bar (cdr yp))
Dave Love <fx@gnu.org>
parents:
diff changeset
2131 (x (car xp) (car xp))
Dave Love <fx@gnu.org>
parents:
diff changeset
2132 (y (car yp) (car yp))
Dave Love <fx@gnu.org>
parents:
diff changeset
2133 z)
Dave Love <fx@gnu.org>
parents:
diff changeset
2134 ((or (null xp) (null yp))
Dave Love <fx@gnu.org>
parents:
diff changeset
2135 (nreverse z))
Dave Love <fx@gnu.org>
parents:
diff changeset
2136 (push (f x y) z))
Dave Love <fx@gnu.org>
parents:
diff changeset
2137 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2138 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
2139
27511
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2140 @defspec dolist (var list [result]) forms@dots{}
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2141 This is a more specialized loop which iterates across the elements
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2142 of a list. @var{list} should evaluate to a list; the body @var{forms}
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2143 are executed with @var{var} bound to each element of the list in
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2144 turn. Finally, the @var{result} form (or @code{nil}) is evaluated
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2145 with @var{var} bound to @code{nil} to produce the result returned by
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2146 the loop. Unlike with Emacs's built in @code{dolist}, the loop is
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2147 surrounded by an implicit @code{nil} block.
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2148 @end defspec
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2149
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2150 @defspec dotimes (var count [result]) forms@dots{}
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2151 This is a more specialized loop which iterates a specified number
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2152 of times. The body is executed with @var{var} bound to the integers
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2153 from zero (inclusive) to @var{count} (exclusive), in turn. Then
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2154 the @code{result} form is evaluated with @var{var} bound to the total
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2155 number of iterations that were done (i.e., @code{(max 0 @var{count})})
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2156 to get the return value for the loop form. Unlike with Emacs's built in
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2157 @code{dolist}, the loop is surrounded by an implicit @code{nil} block.
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2158 @end defspec
ead47a92d9d0 Replace dotimes, dolist, with comment.
Dave Love <fx@gnu.org>
parents: 27487
diff changeset
2159
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2160 @defspec do-symbols (var [obarray [result]]) forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
2161 This loop iterates over all interned symbols. If @var{obarray}
Dave Love <fx@gnu.org>
parents:
diff changeset
2162 is specified and is not @code{nil}, it loops over all symbols in
Dave Love <fx@gnu.org>
parents:
diff changeset
2163 that obarray. For each symbol, the body @var{forms} are evaluated
Dave Love <fx@gnu.org>
parents:
diff changeset
2164 with @var{var} bound to that symbol. The symbols are visited in
Dave Love <fx@gnu.org>
parents:
diff changeset
2165 an unspecified order. Afterward the @var{result} form, if any,
Dave Love <fx@gnu.org>
parents:
diff changeset
2166 is evaluated (with @var{var} bound to @code{nil}) to get the return
Dave Love <fx@gnu.org>
parents:
diff changeset
2167 value. The loop is surrounded by an implicit @code{nil} block.
Dave Love <fx@gnu.org>
parents:
diff changeset
2168 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
2169
Dave Love <fx@gnu.org>
parents:
diff changeset
2170 @defspec do-all-symbols (var [result]) forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
2171 This is identical to @code{do-symbols} except that the @var{obarray}
Dave Love <fx@gnu.org>
parents:
diff changeset
2172 argument is omitted; it always iterates over the default obarray.
Dave Love <fx@gnu.org>
parents:
diff changeset
2173 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
2174
Dave Love <fx@gnu.org>
parents:
diff changeset
2175 @xref{Mapping over Sequences}, for some more functions for
Dave Love <fx@gnu.org>
parents:
diff changeset
2176 iterating over vectors or lists.
Dave Love <fx@gnu.org>
parents:
diff changeset
2177
Dave Love <fx@gnu.org>
parents:
diff changeset
2178 @node Loop Facility, Multiple Values, Iteration, Control Structure
Dave Love <fx@gnu.org>
parents:
diff changeset
2179 @section Loop Facility
Dave Love <fx@gnu.org>
parents:
diff changeset
2180
Dave Love <fx@gnu.org>
parents:
diff changeset
2181 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2182 A common complaint with Lisp's traditional looping constructs is
Dave Love <fx@gnu.org>
parents:
diff changeset
2183 that they are either too simple and limited, such as Common Lisp's
Dave Love <fx@gnu.org>
parents:
diff changeset
2184 @code{dotimes} or Emacs Lisp's @code{while}, or too unreadable and
Dave Love <fx@gnu.org>
parents:
diff changeset
2185 obscure, like Common Lisp's @code{do} loop.
Dave Love <fx@gnu.org>
parents:
diff changeset
2186
Dave Love <fx@gnu.org>
parents:
diff changeset
2187 To remedy this, recent versions of Common Lisp have added a new
Dave Love <fx@gnu.org>
parents:
diff changeset
2188 construct called the ``Loop Facility'' or ``@code{loop} macro,''
Dave Love <fx@gnu.org>
parents:
diff changeset
2189 with an easy-to-use but very powerful and expressive syntax.
Dave Love <fx@gnu.org>
parents:
diff changeset
2190
Dave Love <fx@gnu.org>
parents:
diff changeset
2191 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
2192 * Loop Basics:: `loop' macro, basic clause structure
Dave Love <fx@gnu.org>
parents:
diff changeset
2193 * Loop Examples:: Working examples of `loop' macro
Dave Love <fx@gnu.org>
parents:
diff changeset
2194 * For Clauses:: Clauses introduced by `for' or `as'
Dave Love <fx@gnu.org>
parents:
diff changeset
2195 * Iteration Clauses:: `repeat', `while', `thereis', etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
2196 * Accumulation Clauses:: `collect', `sum', `maximize', etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
2197 * Other Clauses:: `with', `if', `initially', `finally'
Dave Love <fx@gnu.org>
parents:
diff changeset
2198 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
2199
Dave Love <fx@gnu.org>
parents:
diff changeset
2200 @node Loop Basics, Loop Examples, Loop Facility, Loop Facility
Dave Love <fx@gnu.org>
parents:
diff changeset
2201 @subsection Loop Basics
Dave Love <fx@gnu.org>
parents:
diff changeset
2202
Dave Love <fx@gnu.org>
parents:
diff changeset
2203 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2204 The @code{loop} macro essentially creates a mini-language within
Dave Love <fx@gnu.org>
parents:
diff changeset
2205 Lisp that is specially tailored for describing loops. While this
Dave Love <fx@gnu.org>
parents:
diff changeset
2206 language is a little strange-looking by the standards of regular Lisp,
Dave Love <fx@gnu.org>
parents:
diff changeset
2207 it turns out to be very easy to learn and well-suited to its purpose.
Dave Love <fx@gnu.org>
parents:
diff changeset
2208
Dave Love <fx@gnu.org>
parents:
diff changeset
2209 Since @code{loop} is a macro, all parsing of the loop language
Dave Love <fx@gnu.org>
parents:
diff changeset
2210 takes place at byte-compile time; compiled @code{loop}s are just
Dave Love <fx@gnu.org>
parents:
diff changeset
2211 as efficient as the equivalent @code{while} loops written longhand.
Dave Love <fx@gnu.org>
parents:
diff changeset
2212
Dave Love <fx@gnu.org>
parents:
diff changeset
2213 @defspec loop clauses@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
2214 A loop construct consists of a series of @var{clause}s, each
Dave Love <fx@gnu.org>
parents:
diff changeset
2215 introduced by a symbol like @code{for} or @code{do}. Clauses
Dave Love <fx@gnu.org>
parents:
diff changeset
2216 are simply strung together in the argument list of @code{loop},
Dave Love <fx@gnu.org>
parents:
diff changeset
2217 with minimal extra parentheses. The various types of clauses
Dave Love <fx@gnu.org>
parents:
diff changeset
2218 specify initializations, such as the binding of temporary
Dave Love <fx@gnu.org>
parents:
diff changeset
2219 variables, actions to be taken in the loop, stepping actions,
Dave Love <fx@gnu.org>
parents:
diff changeset
2220 and final cleanup.
Dave Love <fx@gnu.org>
parents:
diff changeset
2221
Dave Love <fx@gnu.org>
parents:
diff changeset
2222 Common Lisp specifies a certain general order of clauses in a
Dave Love <fx@gnu.org>
parents:
diff changeset
2223 loop:
Dave Love <fx@gnu.org>
parents:
diff changeset
2224
Dave Love <fx@gnu.org>
parents:
diff changeset
2225 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2226 (loop @var{name-clause}
Dave Love <fx@gnu.org>
parents:
diff changeset
2227 @var{var-clauses}@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
2228 @var{action-clauses}@dots{})
Dave Love <fx@gnu.org>
parents:
diff changeset
2229 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2230
Dave Love <fx@gnu.org>
parents:
diff changeset
2231 The @var{name-clause} optionally gives a name to the implicit
Dave Love <fx@gnu.org>
parents:
diff changeset
2232 block that surrounds the loop. By default, the implicit block
Dave Love <fx@gnu.org>
parents:
diff changeset
2233 is named @code{nil}. The @var{var-clauses} specify what
Dave Love <fx@gnu.org>
parents:
diff changeset
2234 variables should be bound during the loop, and how they should
Dave Love <fx@gnu.org>
parents:
diff changeset
2235 be modified or iterated throughout the course of the loop. The
Dave Love <fx@gnu.org>
parents:
diff changeset
2236 @var{action-clauses} are things to be done during the loop, such
Dave Love <fx@gnu.org>
parents:
diff changeset
2237 as computing, collecting, and returning values.
Dave Love <fx@gnu.org>
parents:
diff changeset
2238
Dave Love <fx@gnu.org>
parents:
diff changeset
2239 The Emacs version of the @code{loop} macro is less restrictive about
Dave Love <fx@gnu.org>
parents:
diff changeset
2240 the order of clauses, but things will behave most predictably if
Dave Love <fx@gnu.org>
parents:
diff changeset
2241 you put the variable-binding clauses @code{with}, @code{for}, and
Dave Love <fx@gnu.org>
parents:
diff changeset
2242 @code{repeat} before the action clauses. As in Common Lisp,
Dave Love <fx@gnu.org>
parents:
diff changeset
2243 @code{initially} and @code{finally} clauses can go anywhere.
Dave Love <fx@gnu.org>
parents:
diff changeset
2244
Dave Love <fx@gnu.org>
parents:
diff changeset
2245 Loops generally return @code{nil} by default, but you can cause
Dave Love <fx@gnu.org>
parents:
diff changeset
2246 them to return a value by using an accumulation clause like
Dave Love <fx@gnu.org>
parents:
diff changeset
2247 @code{collect}, an end-test clause like @code{always}, or an
Dave Love <fx@gnu.org>
parents:
diff changeset
2248 explicit @code{return} clause to jump out of the implicit block.
Dave Love <fx@gnu.org>
parents:
diff changeset
2249 (Because the loop body is enclosed in an implicit block, you can
Dave Love <fx@gnu.org>
parents:
diff changeset
2250 also use regular Lisp @code{return} or @code{return-from} to
Dave Love <fx@gnu.org>
parents:
diff changeset
2251 break out of the loop.)
Dave Love <fx@gnu.org>
parents:
diff changeset
2252 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
2253
Dave Love <fx@gnu.org>
parents:
diff changeset
2254 The following sections give some examples of the Loop Macro in
Dave Love <fx@gnu.org>
parents:
diff changeset
2255 action, and describe the particular loop clauses in great detail.
Dave Love <fx@gnu.org>
parents:
diff changeset
2256 Consult the second edition of Steele's @dfn{Common Lisp, the Language},
Dave Love <fx@gnu.org>
parents:
diff changeset
2257 for additional discussion and examples of the @code{loop} macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
2258
Dave Love <fx@gnu.org>
parents:
diff changeset
2259 @node Loop Examples, For Clauses, Loop Basics, Loop Facility
Dave Love <fx@gnu.org>
parents:
diff changeset
2260 @subsection Loop Examples
Dave Love <fx@gnu.org>
parents:
diff changeset
2261
Dave Love <fx@gnu.org>
parents:
diff changeset
2262 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2263 Before listing the full set of clauses that are allowed, let's
Dave Love <fx@gnu.org>
parents:
diff changeset
2264 look at a few example loops just to get a feel for the @code{loop}
Dave Love <fx@gnu.org>
parents:
diff changeset
2265 language.
Dave Love <fx@gnu.org>
parents:
diff changeset
2266
Dave Love <fx@gnu.org>
parents:
diff changeset
2267 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2268 (loop for buf in (buffer-list)
Dave Love <fx@gnu.org>
parents:
diff changeset
2269 collect (buffer-file-name buf))
Dave Love <fx@gnu.org>
parents:
diff changeset
2270 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2271
Dave Love <fx@gnu.org>
parents:
diff changeset
2272 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2273 This loop iterates over all Emacs buffers, using the list
Dave Love <fx@gnu.org>
parents:
diff changeset
2274 returned by @code{buffer-list}. For each buffer @code{buf},
Dave Love <fx@gnu.org>
parents:
diff changeset
2275 it calls @code{buffer-file-name} and collects the results into
Dave Love <fx@gnu.org>
parents:
diff changeset
2276 a list, which is then returned from the @code{loop} construct.
Dave Love <fx@gnu.org>
parents:
diff changeset
2277 The result is a list of the file names of all the buffers in
Dave Love <fx@gnu.org>
parents:
diff changeset
2278 Emacs' memory. The words @code{for}, @code{in}, and @code{collect}
Dave Love <fx@gnu.org>
parents:
diff changeset
2279 are reserved words in the @code{loop} language.
Dave Love <fx@gnu.org>
parents:
diff changeset
2280
Dave Love <fx@gnu.org>
parents:
diff changeset
2281 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2282 (loop repeat 20 do (insert "Yowsa\n"))
Dave Love <fx@gnu.org>
parents:
diff changeset
2283 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2284
Dave Love <fx@gnu.org>
parents:
diff changeset
2285 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2286 This loop inserts the phrase ``Yowsa'' twenty times in the
Dave Love <fx@gnu.org>
parents:
diff changeset
2287 current buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
2288
Dave Love <fx@gnu.org>
parents:
diff changeset
2289 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2290 (loop until (eobp) do (munch-line) (forward-line 1))
Dave Love <fx@gnu.org>
parents:
diff changeset
2291 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2292
Dave Love <fx@gnu.org>
parents:
diff changeset
2293 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2294 This loop calls @code{munch-line} on every line until the end
Dave Love <fx@gnu.org>
parents:
diff changeset
2295 of the buffer. If point is already at the end of the buffer,
Dave Love <fx@gnu.org>
parents:
diff changeset
2296 the loop exits immediately.
Dave Love <fx@gnu.org>
parents:
diff changeset
2297
Dave Love <fx@gnu.org>
parents:
diff changeset
2298 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2299 (loop do (munch-line) until (eobp) do (forward-line 1))
Dave Love <fx@gnu.org>
parents:
diff changeset
2300 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2301
Dave Love <fx@gnu.org>
parents:
diff changeset
2302 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2303 This loop is similar to the above one, except that @code{munch-line}
Dave Love <fx@gnu.org>
parents:
diff changeset
2304 is always called at least once.
Dave Love <fx@gnu.org>
parents:
diff changeset
2305
Dave Love <fx@gnu.org>
parents:
diff changeset
2306 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2307 (loop for x from 1 to 100
Dave Love <fx@gnu.org>
parents:
diff changeset
2308 for y = (* x x)
Dave Love <fx@gnu.org>
parents:
diff changeset
2309 until (>= y 729)
Dave Love <fx@gnu.org>
parents:
diff changeset
2310 finally return (list x (= y 729)))
Dave Love <fx@gnu.org>
parents:
diff changeset
2311 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2312
Dave Love <fx@gnu.org>
parents:
diff changeset
2313 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2314 This more complicated loop searches for a number @code{x} whose
Dave Love <fx@gnu.org>
parents:
diff changeset
2315 square is 729. For safety's sake it only examines @code{x}
Dave Love <fx@gnu.org>
parents:
diff changeset
2316 values up to 100; dropping the phrase @samp{to 100} would
Dave Love <fx@gnu.org>
parents:
diff changeset
2317 cause the loop to count upwards with no limit. The second
Dave Love <fx@gnu.org>
parents:
diff changeset
2318 @code{for} clause defines @code{y} to be the square of @code{x}
Dave Love <fx@gnu.org>
parents:
diff changeset
2319 within the loop; the expression after the @code{=} sign is
Dave Love <fx@gnu.org>
parents:
diff changeset
2320 reevaluated each time through the loop. The @code{until}
Dave Love <fx@gnu.org>
parents:
diff changeset
2321 clause gives a condition for terminating the loop, and the
Dave Love <fx@gnu.org>
parents:
diff changeset
2322 @code{finally} clause says what to do when the loop finishes.
Dave Love <fx@gnu.org>
parents:
diff changeset
2323 (This particular example was written less concisely than it
Dave Love <fx@gnu.org>
parents:
diff changeset
2324 could have been, just for the sake of illustration.)
Dave Love <fx@gnu.org>
parents:
diff changeset
2325
Dave Love <fx@gnu.org>
parents:
diff changeset
2326 Note that even though this loop contains three clauses (two
Dave Love <fx@gnu.org>
parents:
diff changeset
2327 @code{for}s and an @code{until}) that would have been enough to
Dave Love <fx@gnu.org>
parents:
diff changeset
2328 define loops all by themselves, it still creates a single loop
Dave Love <fx@gnu.org>
parents:
diff changeset
2329 rather than some sort of triple-nested loop. You must explicitly
Dave Love <fx@gnu.org>
parents:
diff changeset
2330 nest your @code{loop} constructs if you want nested loops.
Dave Love <fx@gnu.org>
parents:
diff changeset
2331
Dave Love <fx@gnu.org>
parents:
diff changeset
2332 @node For Clauses, Iteration Clauses, Loop Examples, Loop Facility
Dave Love <fx@gnu.org>
parents:
diff changeset
2333 @subsection For Clauses
Dave Love <fx@gnu.org>
parents:
diff changeset
2334
Dave Love <fx@gnu.org>
parents:
diff changeset
2335 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2336 Most loops are governed by one or more @code{for} clauses.
Dave Love <fx@gnu.org>
parents:
diff changeset
2337 A @code{for} clause simultaneously describes variables to be
Dave Love <fx@gnu.org>
parents:
diff changeset
2338 bound, how those variables are to be stepped during the loop,
Dave Love <fx@gnu.org>
parents:
diff changeset
2339 and usually an end condition based on those variables.
Dave Love <fx@gnu.org>
parents:
diff changeset
2340
Dave Love <fx@gnu.org>
parents:
diff changeset
2341 The word @code{as} is a synonym for the word @code{for}. This
Dave Love <fx@gnu.org>
parents:
diff changeset
2342 word is followed by a variable name, then a word like @code{from}
Dave Love <fx@gnu.org>
parents:
diff changeset
2343 or @code{across} that describes the kind of iteration desired.
Dave Love <fx@gnu.org>
parents:
diff changeset
2344 In Common Lisp, the phrase @code{being the} sometimes precedes
Dave Love <fx@gnu.org>
parents:
diff changeset
2345 the type of iteration; in this package both @code{being} and
Dave Love <fx@gnu.org>
parents:
diff changeset
2346 @code{the} are optional. The word @code{each} is a synonym
Dave Love <fx@gnu.org>
parents:
diff changeset
2347 for @code{the}, and the word that follows it may be singular
Dave Love <fx@gnu.org>
parents:
diff changeset
2348 or plural: @samp{for x being the elements of y} or
Dave Love <fx@gnu.org>
parents:
diff changeset
2349 @samp{for x being each element of y}. Which form you use
Dave Love <fx@gnu.org>
parents:
diff changeset
2350 is purely a matter of style.
Dave Love <fx@gnu.org>
parents:
diff changeset
2351
Dave Love <fx@gnu.org>
parents:
diff changeset
2352 The variable is bound around the loop as if by @code{let}:
Dave Love <fx@gnu.org>
parents:
diff changeset
2353
Dave Love <fx@gnu.org>
parents:
diff changeset
2354 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2355 (setq i 'happy)
Dave Love <fx@gnu.org>
parents:
diff changeset
2356 (loop for i from 1 to 10 do (do-something-with i))
Dave Love <fx@gnu.org>
parents:
diff changeset
2357 i
Dave Love <fx@gnu.org>
parents:
diff changeset
2358 @result{} happy
Dave Love <fx@gnu.org>
parents:
diff changeset
2359 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2360
Dave Love <fx@gnu.org>
parents:
diff changeset
2361 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
2362 @item for @var{var} from @var{expr1} to @var{expr2} by @var{expr3}
Dave Love <fx@gnu.org>
parents:
diff changeset
2363 This type of @code{for} clause creates a counting loop. Each of
Dave Love <fx@gnu.org>
parents:
diff changeset
2364 the three sub-terms is optional, though there must be at least one
Dave Love <fx@gnu.org>
parents:
diff changeset
2365 term so that the clause is marked as a counting clause.
Dave Love <fx@gnu.org>
parents:
diff changeset
2366
Dave Love <fx@gnu.org>
parents:
diff changeset
2367 The three expressions are the starting value, the ending value, and
Dave Love <fx@gnu.org>
parents:
diff changeset
2368 the step value, respectively, of the variable. The loop counts
Dave Love <fx@gnu.org>
parents:
diff changeset
2369 upwards by default (@var{expr3} must be positive), from @var{expr1}
Dave Love <fx@gnu.org>
parents:
diff changeset
2370 to @var{expr2} inclusively. If you omit the @code{from} term, the
Dave Love <fx@gnu.org>
parents:
diff changeset
2371 loop counts from zero; if you omit the @code{to} term, the loop
Dave Love <fx@gnu.org>
parents:
diff changeset
2372 counts forever without stopping (unless stopped by some other
Dave Love <fx@gnu.org>
parents:
diff changeset
2373 loop clause, of course); if you omit the @code{by} term, the loop
Dave Love <fx@gnu.org>
parents:
diff changeset
2374 counts in steps of one.
Dave Love <fx@gnu.org>
parents:
diff changeset
2375
Dave Love <fx@gnu.org>
parents:
diff changeset
2376 You can replace the word @code{from} with @code{upfrom} or
Dave Love <fx@gnu.org>
parents:
diff changeset
2377 @code{downfrom} to indicate the direction of the loop. Likewise,
Dave Love <fx@gnu.org>
parents:
diff changeset
2378 you can replace @code{to} with @code{upto} or @code{downto}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2379 For example, @samp{for x from 5 downto 1} executes five times
Dave Love <fx@gnu.org>
parents:
diff changeset
2380 with @code{x} taking on the integers from 5 down to 1 in turn.
Dave Love <fx@gnu.org>
parents:
diff changeset
2381 Also, you can replace @code{to} with @code{below} or @code{above},
Dave Love <fx@gnu.org>
parents:
diff changeset
2382 which are like @code{upto} and @code{downto} respectively except
Dave Love <fx@gnu.org>
parents:
diff changeset
2383 that they are exclusive rather than inclusive limits:
Dave Love <fx@gnu.org>
parents:
diff changeset
2384
Dave Love <fx@gnu.org>
parents:
diff changeset
2385 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2386 (loop for x to 10 collect x)
Dave Love <fx@gnu.org>
parents:
diff changeset
2387 @result{} (0 1 2 3 4 5 6 7 8 9 10)
Dave Love <fx@gnu.org>
parents:
diff changeset
2388 (loop for x below 10 collect x)
Dave Love <fx@gnu.org>
parents:
diff changeset
2389 @result{} (0 1 2 3 4 5 6 7 8 9)
Dave Love <fx@gnu.org>
parents:
diff changeset
2390 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2391
Dave Love <fx@gnu.org>
parents:
diff changeset
2392 The @code{by} value is always positive, even for downward-counting
Dave Love <fx@gnu.org>
parents:
diff changeset
2393 loops. Some sort of @code{from} value is required for downward
Dave Love <fx@gnu.org>
parents:
diff changeset
2394 loops; @samp{for x downto 5} is not a legal loop clause all by
Dave Love <fx@gnu.org>
parents:
diff changeset
2395 itself.
Dave Love <fx@gnu.org>
parents:
diff changeset
2396
Dave Love <fx@gnu.org>
parents:
diff changeset
2397 @item for @var{var} in @var{list} by @var{function}
Dave Love <fx@gnu.org>
parents:
diff changeset
2398 This clause iterates @var{var} over all the elements of @var{list},
Dave Love <fx@gnu.org>
parents:
diff changeset
2399 in turn. If you specify the @code{by} term, then @var{function}
Dave Love <fx@gnu.org>
parents:
diff changeset
2400 is used to traverse the list instead of @code{cdr}; it must be a
Dave Love <fx@gnu.org>
parents:
diff changeset
2401 function taking one argument. For example:
Dave Love <fx@gnu.org>
parents:
diff changeset
2402
Dave Love <fx@gnu.org>
parents:
diff changeset
2403 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2404 (loop for x in '(1 2 3 4 5 6) collect (* x x))
Dave Love <fx@gnu.org>
parents:
diff changeset
2405 @result{} (1 4 9 16 25 36)
Dave Love <fx@gnu.org>
parents:
diff changeset
2406 (loop for x in '(1 2 3 4 5 6) by 'cddr collect (* x x))
Dave Love <fx@gnu.org>
parents:
diff changeset
2407 @result{} (1 9 25)
Dave Love <fx@gnu.org>
parents:
diff changeset
2408 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2409
Dave Love <fx@gnu.org>
parents:
diff changeset
2410 @item for @var{var} on @var{list} by @var{function}
Dave Love <fx@gnu.org>
parents:
diff changeset
2411 This clause iterates @var{var} over all the cons cells of @var{list}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2412
Dave Love <fx@gnu.org>
parents:
diff changeset
2413 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2414 (loop for x on '(1 2 3 4) collect x)
Dave Love <fx@gnu.org>
parents:
diff changeset
2415 @result{} ((1 2 3 4) (2 3 4) (3 4) (4))
Dave Love <fx@gnu.org>
parents:
diff changeset
2416 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2417
Dave Love <fx@gnu.org>
parents:
diff changeset
2418 With @code{by}, there is no real reason that the @code{on} expression
Dave Love <fx@gnu.org>
parents:
diff changeset
2419 must be a list. For example:
Dave Love <fx@gnu.org>
parents:
diff changeset
2420
Dave Love <fx@gnu.org>
parents:
diff changeset
2421 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2422 (loop for x on first-animal by 'next-animal collect x)
Dave Love <fx@gnu.org>
parents:
diff changeset
2423 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2424
Dave Love <fx@gnu.org>
parents:
diff changeset
2425 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2426 where @code{(next-animal x)} takes an ``animal'' @var{x} and returns
Dave Love <fx@gnu.org>
parents:
diff changeset
2427 the next in the (assumed) sequence of animals, or @code{nil} if
Dave Love <fx@gnu.org>
parents:
diff changeset
2428 @var{x} was the last animal in the sequence.
Dave Love <fx@gnu.org>
parents:
diff changeset
2429
Dave Love <fx@gnu.org>
parents:
diff changeset
2430 @item for @var{var} in-ref @var{list} by @var{function}
Dave Love <fx@gnu.org>
parents:
diff changeset
2431 This is like a regular @code{in} clause, but @var{var} becomes
Dave Love <fx@gnu.org>
parents:
diff changeset
2432 a @code{setf}-able ``reference'' onto the elements of the list
Dave Love <fx@gnu.org>
parents:
diff changeset
2433 rather than just a temporary variable. For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
2434
Dave Love <fx@gnu.org>
parents:
diff changeset
2435 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2436 (loop for x in-ref my-list do (incf x))
Dave Love <fx@gnu.org>
parents:
diff changeset
2437 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2438
Dave Love <fx@gnu.org>
parents:
diff changeset
2439 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2440 increments every element of @code{my-list} in place. This clause
Dave Love <fx@gnu.org>
parents:
diff changeset
2441 is an extension to standard Common Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
2442
Dave Love <fx@gnu.org>
parents:
diff changeset
2443 @item for @var{var} across @var{array}
Dave Love <fx@gnu.org>
parents:
diff changeset
2444 This clause iterates @var{var} over all the elements of @var{array},
Dave Love <fx@gnu.org>
parents:
diff changeset
2445 which may be a vector or a string.
Dave Love <fx@gnu.org>
parents:
diff changeset
2446
Dave Love <fx@gnu.org>
parents:
diff changeset
2447 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2448 (loop for x across "aeiou"
Dave Love <fx@gnu.org>
parents:
diff changeset
2449 do (use-vowel (char-to-string x)))
Dave Love <fx@gnu.org>
parents:
diff changeset
2450 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2451
Dave Love <fx@gnu.org>
parents:
diff changeset
2452 @item for @var{var} across-ref @var{array}
Dave Love <fx@gnu.org>
parents:
diff changeset
2453 This clause iterates over an array, with @var{var} a @code{setf}-able
Dave Love <fx@gnu.org>
parents:
diff changeset
2454 reference onto the elements; see @code{in-ref} above.
Dave Love <fx@gnu.org>
parents:
diff changeset
2455
Dave Love <fx@gnu.org>
parents:
diff changeset
2456 @item for @var{var} being the elements of @var{sequence}
Dave Love <fx@gnu.org>
parents:
diff changeset
2457 This clause iterates over the elements of @var{sequence}, which may
Dave Love <fx@gnu.org>
parents:
diff changeset
2458 be a list, vector, or string. Since the type must be determined
Dave Love <fx@gnu.org>
parents:
diff changeset
2459 at run-time, this is somewhat less efficient than @code{in} or
Dave Love <fx@gnu.org>
parents:
diff changeset
2460 @code{across}. The clause may be followed by the additional term
Dave Love <fx@gnu.org>
parents:
diff changeset
2461 @samp{using (index @var{var2})} to cause @var{var2} to be bound to
Dave Love <fx@gnu.org>
parents:
diff changeset
2462 the successive indices (starting at 0) of the elements.
Dave Love <fx@gnu.org>
parents:
diff changeset
2463
Dave Love <fx@gnu.org>
parents:
diff changeset
2464 This clause type is taken from older versions of the @code{loop} macro,
Dave Love <fx@gnu.org>
parents:
diff changeset
2465 and is not present in modern Common Lisp. The @samp{using (sequence ...)}
Dave Love <fx@gnu.org>
parents:
diff changeset
2466 term of the older macros is not supported.
Dave Love <fx@gnu.org>
parents:
diff changeset
2467
Dave Love <fx@gnu.org>
parents:
diff changeset
2468 @item for @var{var} being the elements of-ref @var{sequence}
Dave Love <fx@gnu.org>
parents:
diff changeset
2469 This clause iterates over a sequence, with @var{var} a @code{setf}-able
Dave Love <fx@gnu.org>
parents:
diff changeset
2470 reference onto the elements; see @code{in-ref} above.
Dave Love <fx@gnu.org>
parents:
diff changeset
2471
Dave Love <fx@gnu.org>
parents:
diff changeset
2472 @item for @var{var} being the symbols [of @var{obarray}]
Dave Love <fx@gnu.org>
parents:
diff changeset
2473 This clause iterates over symbols, either over all interned symbols
Dave Love <fx@gnu.org>
parents:
diff changeset
2474 or over all symbols in @var{obarray}. The loop is executed with
Dave Love <fx@gnu.org>
parents:
diff changeset
2475 @var{var} bound to each symbol in turn. The symbols are visited in
Dave Love <fx@gnu.org>
parents:
diff changeset
2476 an unspecified order.
Dave Love <fx@gnu.org>
parents:
diff changeset
2477
Dave Love <fx@gnu.org>
parents:
diff changeset
2478 As an example,
Dave Love <fx@gnu.org>
parents:
diff changeset
2479
Dave Love <fx@gnu.org>
parents:
diff changeset
2480 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2481 (loop for sym being the symbols
Dave Love <fx@gnu.org>
parents:
diff changeset
2482 when (fboundp sym)
Dave Love <fx@gnu.org>
parents:
diff changeset
2483 when (string-match "^map" (symbol-name sym))
Dave Love <fx@gnu.org>
parents:
diff changeset
2484 collect sym)
Dave Love <fx@gnu.org>
parents:
diff changeset
2485 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2486
Dave Love <fx@gnu.org>
parents:
diff changeset
2487 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2488 returns a list of all the functions whose names begin with @samp{map}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2489
Dave Love <fx@gnu.org>
parents:
diff changeset
2490 The Common Lisp words @code{external-symbols} and @code{present-symbols}
Dave Love <fx@gnu.org>
parents:
diff changeset
2491 are also recognized but are equivalent to @code{symbols} in Emacs Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
2492
Dave Love <fx@gnu.org>
parents:
diff changeset
2493 Due to a minor implementation restriction, it will not work to have
Dave Love <fx@gnu.org>
parents:
diff changeset
2494 more than one @code{for} clause iterating over symbols, hash tables,
Dave Love <fx@gnu.org>
parents:
diff changeset
2495 keymaps, overlays, or intervals in a given @code{loop}. Fortunately,
Dave Love <fx@gnu.org>
parents:
diff changeset
2496 it would rarely if ever be useful to do so. It @emph{is} legal to mix
Dave Love <fx@gnu.org>
parents:
diff changeset
2497 one of these types of clauses with other clauses like @code{for ... to}
Dave Love <fx@gnu.org>
parents:
diff changeset
2498 or @code{while}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2499
Dave Love <fx@gnu.org>
parents:
diff changeset
2500 @item for @var{var} being the hash-keys of @var{hash-table}
Dave Love <fx@gnu.org>
parents:
diff changeset
2501 This clause iterates over the entries in @var{hash-table}. For each
Dave Love <fx@gnu.org>
parents:
diff changeset
2502 hash table entry, @var{var} is bound to the entry's key. If you write
Dave Love <fx@gnu.org>
parents:
diff changeset
2503 @samp{the hash-values} instead, @var{var} is bound to the values
Dave Love <fx@gnu.org>
parents:
diff changeset
2504 of the entries. The clause may be followed by the additional
Dave Love <fx@gnu.org>
parents:
diff changeset
2505 term @samp{using (hash-values @var{var2})} (where @code{hash-values}
Dave Love <fx@gnu.org>
parents:
diff changeset
2506 is the opposite word of the word following @code{the}) to cause
Dave Love <fx@gnu.org>
parents:
diff changeset
2507 @var{var} and @var{var2} to be bound to the two parts of each
Dave Love <fx@gnu.org>
parents:
diff changeset
2508 hash table entry.
Dave Love <fx@gnu.org>
parents:
diff changeset
2509
Dave Love <fx@gnu.org>
parents:
diff changeset
2510 @item for @var{var} being the key-codes of @var{keymap}
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
2511 This clause iterates over the entries in @var{keymap}.
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
2512 The iteration does not enter nested keymaps or inherited (parent) keymaps.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2513 You can use @samp{the key-bindings} to access the commands bound to
Dave Love <fx@gnu.org>
parents:
diff changeset
2514 the keys rather than the key codes, and you can add a @code{using}
Dave Love <fx@gnu.org>
parents:
diff changeset
2515 clause to access both the codes and the bindings together.
Dave Love <fx@gnu.org>
parents:
diff changeset
2516
Dave Love <fx@gnu.org>
parents:
diff changeset
2517 @item for @var{var} being the key-seqs of @var{keymap}
Dave Love <fx@gnu.org>
parents:
diff changeset
2518 This clause iterates over all key sequences defined by @var{keymap}
Dave Love <fx@gnu.org>
parents:
diff changeset
2519 and its nested keymaps, where @var{var} takes on values which are
27225
ee242fddb1ab Remove various old stuff and references thereto.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
2520 vectors. The strings or vectors
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2521 are reused for each iteration, so you must copy them if you wish to keep
Dave Love <fx@gnu.org>
parents:
diff changeset
2522 them permanently. You can add a @samp{using (key-bindings ...)}
Dave Love <fx@gnu.org>
parents:
diff changeset
2523 clause to get the command bindings as well.
Dave Love <fx@gnu.org>
parents:
diff changeset
2524
Dave Love <fx@gnu.org>
parents:
diff changeset
2525 @item for @var{var} being the overlays [of @var{buffer}] @dots{}
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
2526 This clause iterates over the ``overlays'' of a buffer
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
2527 (the clause @code{extents} is synonymous
27225
ee242fddb1ab Remove various old stuff and references thereto.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
2528 with @code{overlays}). If the @code{of} term is omitted, the current
ee242fddb1ab Remove various old stuff and references thereto.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
2529 buffer is used.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2530 This clause also accepts optional @samp{from @var{pos}} and
Dave Love <fx@gnu.org>
parents:
diff changeset
2531 @samp{to @var{pos}} terms, limiting the clause to overlays which
Dave Love <fx@gnu.org>
parents:
diff changeset
2532 overlap the specified region.
Dave Love <fx@gnu.org>
parents:
diff changeset
2533
Dave Love <fx@gnu.org>
parents:
diff changeset
2534 @item for @var{var} being the intervals [of @var{buffer}] @dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
2535 This clause iterates over all intervals of a buffer with constant
Dave Love <fx@gnu.org>
parents:
diff changeset
2536 text properties. The variable @var{var} will be bound to conses
Dave Love <fx@gnu.org>
parents:
diff changeset
2537 of start and end positions, where one start position is always equal
Dave Love <fx@gnu.org>
parents:
diff changeset
2538 to the previous end position. The clause allows @code{of},
Dave Love <fx@gnu.org>
parents:
diff changeset
2539 @code{from}, @code{to}, and @code{property} terms, where the latter
Dave Love <fx@gnu.org>
parents:
diff changeset
2540 term restricts the search to just the specified property. The
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
2541 @code{of} term may specify either a buffer or a string.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2542
Dave Love <fx@gnu.org>
parents:
diff changeset
2543 @item for @var{var} being the frames
Dave Love <fx@gnu.org>
parents:
diff changeset
2544 This clause iterates over all frames, i.e., X window system windows
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
2545 open on Emacs files. The
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2546 clause @code{screens} is a synonym for @code{frames}. The frames
Dave Love <fx@gnu.org>
parents:
diff changeset
2547 are visited in @code{next-frame} order starting from
Dave Love <fx@gnu.org>
parents:
diff changeset
2548 @code{selected-frame}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2549
Dave Love <fx@gnu.org>
parents:
diff changeset
2550 @item for @var{var} being the windows [of @var{frame}]
Dave Love <fx@gnu.org>
parents:
diff changeset
2551 This clause iterates over the windows (in the Emacs sense) of
27225
ee242fddb1ab Remove various old stuff and references thereto.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
2552 the current frame, or of the specified @var{frame}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2553
Dave Love <fx@gnu.org>
parents:
diff changeset
2554 @item for @var{var} being the buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
2555 This clause iterates over all buffers in Emacs. It is equivalent
Dave Love <fx@gnu.org>
parents:
diff changeset
2556 to @samp{for @var{var} in (buffer-list)}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2557
Dave Love <fx@gnu.org>
parents:
diff changeset
2558 @item for @var{var} = @var{expr1} then @var{expr2}
Dave Love <fx@gnu.org>
parents:
diff changeset
2559 This clause does a general iteration. The first time through
Dave Love <fx@gnu.org>
parents:
diff changeset
2560 the loop, @var{var} will be bound to @var{expr1}. On the second
Dave Love <fx@gnu.org>
parents:
diff changeset
2561 and successive iterations it will be set by evaluating @var{expr2}
Dave Love <fx@gnu.org>
parents:
diff changeset
2562 (which may refer to the old value of @var{var}). For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
2563 these two loops are effectively the same:
Dave Love <fx@gnu.org>
parents:
diff changeset
2564
Dave Love <fx@gnu.org>
parents:
diff changeset
2565 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2566 (loop for x on my-list by 'cddr do ...)
Dave Love <fx@gnu.org>
parents:
diff changeset
2567 (loop for x = my-list then (cddr x) while x do ...)
Dave Love <fx@gnu.org>
parents:
diff changeset
2568 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2569
Dave Love <fx@gnu.org>
parents:
diff changeset
2570 Note that this type of @code{for} clause does not imply any sort
Dave Love <fx@gnu.org>
parents:
diff changeset
2571 of terminating condition; the above example combines it with a
Dave Love <fx@gnu.org>
parents:
diff changeset
2572 @code{while} clause to tell when to end the loop.
Dave Love <fx@gnu.org>
parents:
diff changeset
2573
Dave Love <fx@gnu.org>
parents:
diff changeset
2574 If you omit the @code{then} term, @var{expr1} is used both for
Dave Love <fx@gnu.org>
parents:
diff changeset
2575 the initial setting and for successive settings:
Dave Love <fx@gnu.org>
parents:
diff changeset
2576
Dave Love <fx@gnu.org>
parents:
diff changeset
2577 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2578 (loop for x = (random) when (> x 0) return x)
Dave Love <fx@gnu.org>
parents:
diff changeset
2579 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2580
Dave Love <fx@gnu.org>
parents:
diff changeset
2581 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2582 This loop keeps taking random numbers from the @code{(random)}
Dave Love <fx@gnu.org>
parents:
diff changeset
2583 function until it gets a positive one, which it then returns.
Dave Love <fx@gnu.org>
parents:
diff changeset
2584 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
2585
Dave Love <fx@gnu.org>
parents:
diff changeset
2586 If you include several @code{for} clauses in a row, they are
Dave Love <fx@gnu.org>
parents:
diff changeset
2587 treated sequentially (as if by @code{let*} and @code{setq}).
Dave Love <fx@gnu.org>
parents:
diff changeset
2588 You can instead use the word @code{and} to link the clauses,
Dave Love <fx@gnu.org>
parents:
diff changeset
2589 in which case they are processed in parallel (as if by @code{let}
Dave Love <fx@gnu.org>
parents:
diff changeset
2590 and @code{psetq}).
Dave Love <fx@gnu.org>
parents:
diff changeset
2591
Dave Love <fx@gnu.org>
parents:
diff changeset
2592 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2593 (loop for x below 5 for y = nil then x collect (list x y))
Dave Love <fx@gnu.org>
parents:
diff changeset
2594 @result{} ((0 nil) (1 1) (2 2) (3 3) (4 4))
Dave Love <fx@gnu.org>
parents:
diff changeset
2595 (loop for x below 5 and y = nil then x collect (list x y))
Dave Love <fx@gnu.org>
parents:
diff changeset
2596 @result{} ((0 nil) (1 0) (2 1) (3 2) (4 3))
Dave Love <fx@gnu.org>
parents:
diff changeset
2597 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2598
Dave Love <fx@gnu.org>
parents:
diff changeset
2599 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2600 In the first loop, @code{y} is set based on the value of @code{x}
Dave Love <fx@gnu.org>
parents:
diff changeset
2601 that was just set by the previous clause; in the second loop,
Dave Love <fx@gnu.org>
parents:
diff changeset
2602 @code{x} and @code{y} are set simultaneously so @code{y} is set
Dave Love <fx@gnu.org>
parents:
diff changeset
2603 based on the value of @code{x} left over from the previous time
Dave Love <fx@gnu.org>
parents:
diff changeset
2604 through the loop.
Dave Love <fx@gnu.org>
parents:
diff changeset
2605
Dave Love <fx@gnu.org>
parents:
diff changeset
2606 Another feature of the @code{loop} macro is @dfn{destructuring},
Dave Love <fx@gnu.org>
parents:
diff changeset
2607 similar in concept to the destructuring provided by @code{defmacro}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2608 The @var{var} part of any @code{for} clause can be given as a list
Dave Love <fx@gnu.org>
parents:
diff changeset
2609 of variables instead of a single variable. The values produced
Dave Love <fx@gnu.org>
parents:
diff changeset
2610 during loop execution must be lists; the values in the lists are
Dave Love <fx@gnu.org>
parents:
diff changeset
2611 stored in the corresponding variables.
Dave Love <fx@gnu.org>
parents:
diff changeset
2612
Dave Love <fx@gnu.org>
parents:
diff changeset
2613 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2614 (loop for (x y) in '((2 3) (4 5) (6 7)) collect (+ x y))
Dave Love <fx@gnu.org>
parents:
diff changeset
2615 @result{} (5 9 13)
Dave Love <fx@gnu.org>
parents:
diff changeset
2616 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2617
Dave Love <fx@gnu.org>
parents:
diff changeset
2618 In loop destructuring, if there are more values than variables
Dave Love <fx@gnu.org>
parents:
diff changeset
2619 the trailing values are ignored, and if there are more variables
Dave Love <fx@gnu.org>
parents:
diff changeset
2620 than values the trailing variables get the value @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2621 If @code{nil} is used as a variable name, the corresponding
Dave Love <fx@gnu.org>
parents:
diff changeset
2622 values are ignored. Destructuring may be nested, and dotted
Dave Love <fx@gnu.org>
parents:
diff changeset
2623 lists of variables like @code{(x . y)} are allowed.
Dave Love <fx@gnu.org>
parents:
diff changeset
2624
Dave Love <fx@gnu.org>
parents:
diff changeset
2625 @node Iteration Clauses, Accumulation Clauses, For Clauses, Loop Facility
Dave Love <fx@gnu.org>
parents:
diff changeset
2626 @subsection Iteration Clauses
Dave Love <fx@gnu.org>
parents:
diff changeset
2627
Dave Love <fx@gnu.org>
parents:
diff changeset
2628 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2629 Aside from @code{for} clauses, there are several other loop clauses
Dave Love <fx@gnu.org>
parents:
diff changeset
2630 that control the way the loop operates. They might be used by
Dave Love <fx@gnu.org>
parents:
diff changeset
2631 themselves, or in conjunction with one or more @code{for} clauses.
Dave Love <fx@gnu.org>
parents:
diff changeset
2632
Dave Love <fx@gnu.org>
parents:
diff changeset
2633 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
2634 @item repeat @var{integer}
Dave Love <fx@gnu.org>
parents:
diff changeset
2635 This clause simply counts up to the specified number using an
Dave Love <fx@gnu.org>
parents:
diff changeset
2636 internal temporary variable. The loops
Dave Love <fx@gnu.org>
parents:
diff changeset
2637
Dave Love <fx@gnu.org>
parents:
diff changeset
2638 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2639 (loop repeat n do ...)
Dave Love <fx@gnu.org>
parents:
diff changeset
2640 (loop for temp to n do ...)
Dave Love <fx@gnu.org>
parents:
diff changeset
2641 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2642
Dave Love <fx@gnu.org>
parents:
diff changeset
2643 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2644 are identical except that the second one forces you to choose
Dave Love <fx@gnu.org>
parents:
diff changeset
2645 a name for a variable you aren't actually going to use.
Dave Love <fx@gnu.org>
parents:
diff changeset
2646
Dave Love <fx@gnu.org>
parents:
diff changeset
2647 @item while @var{condition}
Dave Love <fx@gnu.org>
parents:
diff changeset
2648 This clause stops the loop when the specified condition (any Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2649 expression) becomes @code{nil}. For example, the following two
Dave Love <fx@gnu.org>
parents:
diff changeset
2650 loops are equivalent, except for the implicit @code{nil} block
Dave Love <fx@gnu.org>
parents:
diff changeset
2651 that surrounds the second one:
Dave Love <fx@gnu.org>
parents:
diff changeset
2652
Dave Love <fx@gnu.org>
parents:
diff changeset
2653 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2654 (while @var{cond} @var{forms}@dots{})
Dave Love <fx@gnu.org>
parents:
diff changeset
2655 (loop while @var{cond} do @var{forms}@dots{})
Dave Love <fx@gnu.org>
parents:
diff changeset
2656 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2657
Dave Love <fx@gnu.org>
parents:
diff changeset
2658 @item until @var{condition}
Dave Love <fx@gnu.org>
parents:
diff changeset
2659 This clause stops the loop when the specified condition is true,
Dave Love <fx@gnu.org>
parents:
diff changeset
2660 i.e., non-@code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2661
Dave Love <fx@gnu.org>
parents:
diff changeset
2662 @item always @var{condition}
Dave Love <fx@gnu.org>
parents:
diff changeset
2663 This clause stops the loop when the specified condition is @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2664 Unlike @code{while}, it stops the loop using @code{return nil} so that
Dave Love <fx@gnu.org>
parents:
diff changeset
2665 the @code{finally} clauses are not executed. If all the conditions
Dave Love <fx@gnu.org>
parents:
diff changeset
2666 were non-@code{nil}, the loop returns @code{t}:
Dave Love <fx@gnu.org>
parents:
diff changeset
2667
Dave Love <fx@gnu.org>
parents:
diff changeset
2668 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2669 (if (loop for size in size-list always (> size 10))
Dave Love <fx@gnu.org>
parents:
diff changeset
2670 (some-big-sizes)
Dave Love <fx@gnu.org>
parents:
diff changeset
2671 (no-big-sizes))
Dave Love <fx@gnu.org>
parents:
diff changeset
2672 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2673
Dave Love <fx@gnu.org>
parents:
diff changeset
2674 @item never @var{condition}
Dave Love <fx@gnu.org>
parents:
diff changeset
2675 This clause is like @code{always}, except that the loop returns
Dave Love <fx@gnu.org>
parents:
diff changeset
2676 @code{t} if any conditions were false, or @code{nil} otherwise.
Dave Love <fx@gnu.org>
parents:
diff changeset
2677
Dave Love <fx@gnu.org>
parents:
diff changeset
2678 @item thereis @var{condition}
Dave Love <fx@gnu.org>
parents:
diff changeset
2679 This clause stops the loop when the specified form is non-@code{nil};
Dave Love <fx@gnu.org>
parents:
diff changeset
2680 in this case, it returns that non-@code{nil} value. If all the
Dave Love <fx@gnu.org>
parents:
diff changeset
2681 values were @code{nil}, the loop returns @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2682 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
2683
Dave Love <fx@gnu.org>
parents:
diff changeset
2684 @node Accumulation Clauses, Other Clauses, Iteration Clauses, Loop Facility
Dave Love <fx@gnu.org>
parents:
diff changeset
2685 @subsection Accumulation Clauses
Dave Love <fx@gnu.org>
parents:
diff changeset
2686
Dave Love <fx@gnu.org>
parents:
diff changeset
2687 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2688 These clauses cause the loop to accumulate information about the
Dave Love <fx@gnu.org>
parents:
diff changeset
2689 specified Lisp @var{form}. The accumulated result is returned
Dave Love <fx@gnu.org>
parents:
diff changeset
2690 from the loop unless overridden, say, by a @code{return} clause.
Dave Love <fx@gnu.org>
parents:
diff changeset
2691
Dave Love <fx@gnu.org>
parents:
diff changeset
2692 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
2693 @item collect @var{form}
Dave Love <fx@gnu.org>
parents:
diff changeset
2694 This clause collects the values of @var{form} into a list. Several
Dave Love <fx@gnu.org>
parents:
diff changeset
2695 examples of @code{collect} appear elsewhere in this manual.
Dave Love <fx@gnu.org>
parents:
diff changeset
2696
Dave Love <fx@gnu.org>
parents:
diff changeset
2697 The word @code{collecting} is a synonym for @code{collect}, and
Dave Love <fx@gnu.org>
parents:
diff changeset
2698 likewise for the other accumulation clauses.
Dave Love <fx@gnu.org>
parents:
diff changeset
2699
Dave Love <fx@gnu.org>
parents:
diff changeset
2700 @item append @var{form}
Dave Love <fx@gnu.org>
parents:
diff changeset
2701 This clause collects lists of values into a result list using
Dave Love <fx@gnu.org>
parents:
diff changeset
2702 @code{append}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2703
Dave Love <fx@gnu.org>
parents:
diff changeset
2704 @item nconc @var{form}
Dave Love <fx@gnu.org>
parents:
diff changeset
2705 This clause collects lists of values into a result list by
Dave Love <fx@gnu.org>
parents:
diff changeset
2706 destructively modifying the lists rather than copying them.
Dave Love <fx@gnu.org>
parents:
diff changeset
2707
Dave Love <fx@gnu.org>
parents:
diff changeset
2708 @item concat @var{form}
Dave Love <fx@gnu.org>
parents:
diff changeset
2709 This clause concatenates the values of the specified @var{form}
Dave Love <fx@gnu.org>
parents:
diff changeset
2710 into a string. (It and the following clause are extensions to
Dave Love <fx@gnu.org>
parents:
diff changeset
2711 standard Common Lisp.)
Dave Love <fx@gnu.org>
parents:
diff changeset
2712
Dave Love <fx@gnu.org>
parents:
diff changeset
2713 @item vconcat @var{form}
Dave Love <fx@gnu.org>
parents:
diff changeset
2714 This clause concatenates the values of the specified @var{form}
Dave Love <fx@gnu.org>
parents:
diff changeset
2715 into a vector.
Dave Love <fx@gnu.org>
parents:
diff changeset
2716
Dave Love <fx@gnu.org>
parents:
diff changeset
2717 @item count @var{form}
Dave Love <fx@gnu.org>
parents:
diff changeset
2718 This clause counts the number of times the specified @var{form}
Dave Love <fx@gnu.org>
parents:
diff changeset
2719 evaluates to a non-@code{nil} value.
Dave Love <fx@gnu.org>
parents:
diff changeset
2720
Dave Love <fx@gnu.org>
parents:
diff changeset
2721 @item sum @var{form}
Dave Love <fx@gnu.org>
parents:
diff changeset
2722 This clause accumulates the sum of the values of the specified
Dave Love <fx@gnu.org>
parents:
diff changeset
2723 @var{form}, which must evaluate to a number.
Dave Love <fx@gnu.org>
parents:
diff changeset
2724
Dave Love <fx@gnu.org>
parents:
diff changeset
2725 @item maximize @var{form}
Dave Love <fx@gnu.org>
parents:
diff changeset
2726 This clause accumulates the maximum value of the specified @var{form},
Dave Love <fx@gnu.org>
parents:
diff changeset
2727 which must evaluate to a number. The return value is undefined if
Dave Love <fx@gnu.org>
parents:
diff changeset
2728 @code{maximize} is executed zero times.
Dave Love <fx@gnu.org>
parents:
diff changeset
2729
Dave Love <fx@gnu.org>
parents:
diff changeset
2730 @item minimize @var{form}
Dave Love <fx@gnu.org>
parents:
diff changeset
2731 This clause accumulates the minimum value of the specified @var{form}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2732 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
2733
Dave Love <fx@gnu.org>
parents:
diff changeset
2734 Accumulation clauses can be followed by @samp{into @var{var}} to
Dave Love <fx@gnu.org>
parents:
diff changeset
2735 cause the data to be collected into variable @var{var} (which is
Dave Love <fx@gnu.org>
parents:
diff changeset
2736 automatically @code{let}-bound during the loop) rather than an
Dave Love <fx@gnu.org>
parents:
diff changeset
2737 unnamed temporary variable. Also, @code{into} accumulations do
Dave Love <fx@gnu.org>
parents:
diff changeset
2738 not automatically imply a return value. The loop must use some
Dave Love <fx@gnu.org>
parents:
diff changeset
2739 explicit mechanism, such as @code{finally return}, to return
Dave Love <fx@gnu.org>
parents:
diff changeset
2740 the accumulated result.
Dave Love <fx@gnu.org>
parents:
diff changeset
2741
Dave Love <fx@gnu.org>
parents:
diff changeset
2742 It is legal for several accumulation clauses of the same type to
Dave Love <fx@gnu.org>
parents:
diff changeset
2743 accumulate into the same place. From Steele:
Dave Love <fx@gnu.org>
parents:
diff changeset
2744
Dave Love <fx@gnu.org>
parents:
diff changeset
2745 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2746 (loop for name in '(fred sue alice joe june)
Dave Love <fx@gnu.org>
parents:
diff changeset
2747 for kids in '((bob ken) () () (kris sunshine) ())
Dave Love <fx@gnu.org>
parents:
diff changeset
2748 collect name
Dave Love <fx@gnu.org>
parents:
diff changeset
2749 append kids)
Dave Love <fx@gnu.org>
parents:
diff changeset
2750 @result{} (fred bob ken sue alice joe kris sunshine june)
Dave Love <fx@gnu.org>
parents:
diff changeset
2751 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2752
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
2753 @node Other Clauses, , Accumulation Clauses, Loop Facility
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2754 @subsection Other Clauses
Dave Love <fx@gnu.org>
parents:
diff changeset
2755
Dave Love <fx@gnu.org>
parents:
diff changeset
2756 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2757 This section describes the remaining loop clauses.
Dave Love <fx@gnu.org>
parents:
diff changeset
2758
Dave Love <fx@gnu.org>
parents:
diff changeset
2759 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
2760 @item with @var{var} = @var{value}
Dave Love <fx@gnu.org>
parents:
diff changeset
2761 This clause binds a variable to a value around the loop, but
Dave Love <fx@gnu.org>
parents:
diff changeset
2762 otherwise leaves the variable alone during the loop. The following
Dave Love <fx@gnu.org>
parents:
diff changeset
2763 loops are basically equivalent:
Dave Love <fx@gnu.org>
parents:
diff changeset
2764
Dave Love <fx@gnu.org>
parents:
diff changeset
2765 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2766 (loop with x = 17 do ...)
Dave Love <fx@gnu.org>
parents:
diff changeset
2767 (let ((x 17)) (loop do ...))
Dave Love <fx@gnu.org>
parents:
diff changeset
2768 (loop for x = 17 then x do ...)
Dave Love <fx@gnu.org>
parents:
diff changeset
2769 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2770
Dave Love <fx@gnu.org>
parents:
diff changeset
2771 Naturally, the variable @var{var} might be used for some purpose
Dave Love <fx@gnu.org>
parents:
diff changeset
2772 in the rest of the loop. For example:
Dave Love <fx@gnu.org>
parents:
diff changeset
2773
Dave Love <fx@gnu.org>
parents:
diff changeset
2774 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2775 (loop for x in my-list with res = nil do (push x res)
Dave Love <fx@gnu.org>
parents:
diff changeset
2776 finally return res)
Dave Love <fx@gnu.org>
parents:
diff changeset
2777 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2778
Dave Love <fx@gnu.org>
parents:
diff changeset
2779 This loop inserts the elements of @code{my-list} at the front of
Dave Love <fx@gnu.org>
parents:
diff changeset
2780 a new list being accumulated in @code{res}, then returns the
Dave Love <fx@gnu.org>
parents:
diff changeset
2781 list @code{res} at the end of the loop. The effect is similar
Dave Love <fx@gnu.org>
parents:
diff changeset
2782 to that of a @code{collect} clause, but the list gets reversed
Dave Love <fx@gnu.org>
parents:
diff changeset
2783 by virtue of the fact that elements are being pushed onto the
Dave Love <fx@gnu.org>
parents:
diff changeset
2784 front of @code{res} rather than the end.
Dave Love <fx@gnu.org>
parents:
diff changeset
2785
Dave Love <fx@gnu.org>
parents:
diff changeset
2786 If you omit the @code{=} term, the variable is initialized to
Dave Love <fx@gnu.org>
parents:
diff changeset
2787 @code{nil}. (Thus the @samp{= nil} in the above example is
Dave Love <fx@gnu.org>
parents:
diff changeset
2788 unnecessary.)
Dave Love <fx@gnu.org>
parents:
diff changeset
2789
Dave Love <fx@gnu.org>
parents:
diff changeset
2790 Bindings made by @code{with} are sequential by default, as if
Dave Love <fx@gnu.org>
parents:
diff changeset
2791 by @code{let*}. Just like @code{for} clauses, @code{with} clauses
Dave Love <fx@gnu.org>
parents:
diff changeset
2792 can be linked with @code{and} to cause the bindings to be made by
Dave Love <fx@gnu.org>
parents:
diff changeset
2793 @code{let} instead.
Dave Love <fx@gnu.org>
parents:
diff changeset
2794
Dave Love <fx@gnu.org>
parents:
diff changeset
2795 @item if @var{condition} @var{clause}
Dave Love <fx@gnu.org>
parents:
diff changeset
2796 This clause executes the following loop clause only if the specified
Dave Love <fx@gnu.org>
parents:
diff changeset
2797 condition is true. The following @var{clause} should be an accumulation,
Dave Love <fx@gnu.org>
parents:
diff changeset
2798 @code{do}, @code{return}, @code{if}, or @code{unless} clause.
Dave Love <fx@gnu.org>
parents:
diff changeset
2799 Several clauses may be linked by separating them with @code{and}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2800 These clauses may be followed by @code{else} and a clause or clauses
Dave Love <fx@gnu.org>
parents:
diff changeset
2801 to execute if the condition was false. The whole construct may
Dave Love <fx@gnu.org>
parents:
diff changeset
2802 optionally be followed by the word @code{end} (which may be used to
Dave Love <fx@gnu.org>
parents:
diff changeset
2803 disambiguate an @code{else} or @code{and} in a nested @code{if}).
Dave Love <fx@gnu.org>
parents:
diff changeset
2804
Dave Love <fx@gnu.org>
parents:
diff changeset
2805 The actual non-@code{nil} value of the condition form is available
Dave Love <fx@gnu.org>
parents:
diff changeset
2806 by the name @code{it} in the ``then'' part. For example:
Dave Love <fx@gnu.org>
parents:
diff changeset
2807
Dave Love <fx@gnu.org>
parents:
diff changeset
2808 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2809 (setq funny-numbers '(6 13 -1))
Dave Love <fx@gnu.org>
parents:
diff changeset
2810 @result{} (6 13 -1)
Dave Love <fx@gnu.org>
parents:
diff changeset
2811 (loop for x below 10
Dave Love <fx@gnu.org>
parents:
diff changeset
2812 if (oddp x)
Dave Love <fx@gnu.org>
parents:
diff changeset
2813 collect x into odds
Dave Love <fx@gnu.org>
parents:
diff changeset
2814 and if (memq x funny-numbers) return (cdr it) end
Dave Love <fx@gnu.org>
parents:
diff changeset
2815 else
Dave Love <fx@gnu.org>
parents:
diff changeset
2816 collect x into evens
Dave Love <fx@gnu.org>
parents:
diff changeset
2817 finally return (vector odds evens))
Dave Love <fx@gnu.org>
parents:
diff changeset
2818 @result{} [(1 3 5 7 9) (0 2 4 6 8)]
Dave Love <fx@gnu.org>
parents:
diff changeset
2819 (setq funny-numbers '(6 7 13 -1))
Dave Love <fx@gnu.org>
parents:
diff changeset
2820 @result{} (6 7 13 -1)
Dave Love <fx@gnu.org>
parents:
diff changeset
2821 (loop <@r{same thing again}>)
Dave Love <fx@gnu.org>
parents:
diff changeset
2822 @result{} (13 -1)
Dave Love <fx@gnu.org>
parents:
diff changeset
2823 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2824
Dave Love <fx@gnu.org>
parents:
diff changeset
2825 Note the use of @code{and} to put two clauses into the ``then''
Dave Love <fx@gnu.org>
parents:
diff changeset
2826 part, one of which is itself an @code{if} clause. Note also that
Dave Love <fx@gnu.org>
parents:
diff changeset
2827 @code{end}, while normally optional, was necessary here to make
Dave Love <fx@gnu.org>
parents:
diff changeset
2828 it clear that the @code{else} refers to the outermost @code{if}
Dave Love <fx@gnu.org>
parents:
diff changeset
2829 clause. In the first case, the loop returns a vector of lists
Dave Love <fx@gnu.org>
parents:
diff changeset
2830 of the odd and even values of @var{x}. In the second case, the
Dave Love <fx@gnu.org>
parents:
diff changeset
2831 odd number 7 is one of the @code{funny-numbers} so the loop
Dave Love <fx@gnu.org>
parents:
diff changeset
2832 returns early; the actual returned value is based on the result
Dave Love <fx@gnu.org>
parents:
diff changeset
2833 of the @code{memq} call.
Dave Love <fx@gnu.org>
parents:
diff changeset
2834
Dave Love <fx@gnu.org>
parents:
diff changeset
2835 @item when @var{condition} @var{clause}
Dave Love <fx@gnu.org>
parents:
diff changeset
2836 This clause is just a synonym for @code{if}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2837
Dave Love <fx@gnu.org>
parents:
diff changeset
2838 @item unless @var{condition} @var{clause}
Dave Love <fx@gnu.org>
parents:
diff changeset
2839 The @code{unless} clause is just like @code{if} except that the
Dave Love <fx@gnu.org>
parents:
diff changeset
2840 sense of the condition is reversed.
Dave Love <fx@gnu.org>
parents:
diff changeset
2841
Dave Love <fx@gnu.org>
parents:
diff changeset
2842 @item named @var{name}
Dave Love <fx@gnu.org>
parents:
diff changeset
2843 This clause gives a name other than @code{nil} to the implicit
Dave Love <fx@gnu.org>
parents:
diff changeset
2844 block surrounding the loop. The @var{name} is the symbol to be
Dave Love <fx@gnu.org>
parents:
diff changeset
2845 used as the block name.
Dave Love <fx@gnu.org>
parents:
diff changeset
2846
Dave Love <fx@gnu.org>
parents:
diff changeset
2847 @item initially [do] @var{forms}...
Dave Love <fx@gnu.org>
parents:
diff changeset
2848 This keyword introduces one or more Lisp forms which will be
Dave Love <fx@gnu.org>
parents:
diff changeset
2849 executed before the loop itself begins (but after any variables
Dave Love <fx@gnu.org>
parents:
diff changeset
2850 requested by @code{for} or @code{with} have been bound to their
Dave Love <fx@gnu.org>
parents:
diff changeset
2851 initial values). @code{initially} clauses can appear anywhere;
Dave Love <fx@gnu.org>
parents:
diff changeset
2852 if there are several, they are executed in the order they appear
Dave Love <fx@gnu.org>
parents:
diff changeset
2853 in the loop. The keyword @code{do} is optional.
Dave Love <fx@gnu.org>
parents:
diff changeset
2854
Dave Love <fx@gnu.org>
parents:
diff changeset
2855 @item finally [do] @var{forms}...
Dave Love <fx@gnu.org>
parents:
diff changeset
2856 This introduces Lisp forms which will be executed after the loop
Dave Love <fx@gnu.org>
parents:
diff changeset
2857 finishes (say, on request of a @code{for} or @code{while}).
Dave Love <fx@gnu.org>
parents:
diff changeset
2858 @code{initially} and @code{finally} clauses may appear anywhere
Dave Love <fx@gnu.org>
parents:
diff changeset
2859 in the loop construct, but they are executed (in the specified
Dave Love <fx@gnu.org>
parents:
diff changeset
2860 order) at the beginning or end, respectively, of the loop.
Dave Love <fx@gnu.org>
parents:
diff changeset
2861
Dave Love <fx@gnu.org>
parents:
diff changeset
2862 @item finally return @var{form}
Dave Love <fx@gnu.org>
parents:
diff changeset
2863 This says that @var{form} should be executed after the loop
Dave Love <fx@gnu.org>
parents:
diff changeset
2864 is done to obtain a return value. (Without this, or some other
Dave Love <fx@gnu.org>
parents:
diff changeset
2865 clause like @code{collect} or @code{return}, the loop will simply
Dave Love <fx@gnu.org>
parents:
diff changeset
2866 return @code{nil}.) Variables bound by @code{for}, @code{with},
Dave Love <fx@gnu.org>
parents:
diff changeset
2867 or @code{into} will still contain their final values when @var{form}
Dave Love <fx@gnu.org>
parents:
diff changeset
2868 is executed.
Dave Love <fx@gnu.org>
parents:
diff changeset
2869
Dave Love <fx@gnu.org>
parents:
diff changeset
2870 @item do @var{forms}...
Dave Love <fx@gnu.org>
parents:
diff changeset
2871 The word @code{do} may be followed by any number of Lisp expressions
Dave Love <fx@gnu.org>
parents:
diff changeset
2872 which are executed as an implicit @code{progn} in the body of the
Dave Love <fx@gnu.org>
parents:
diff changeset
2873 loop. Many of the examples in this section illustrate the use of
Dave Love <fx@gnu.org>
parents:
diff changeset
2874 @code{do}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2875
Dave Love <fx@gnu.org>
parents:
diff changeset
2876 @item return @var{form}
Dave Love <fx@gnu.org>
parents:
diff changeset
2877 This clause causes the loop to return immediately. The following
Dave Love <fx@gnu.org>
parents:
diff changeset
2878 Lisp form is evaluated to give the return value of the @code{loop}
Dave Love <fx@gnu.org>
parents:
diff changeset
2879 form. The @code{finally} clauses, if any, are not executed.
Dave Love <fx@gnu.org>
parents:
diff changeset
2880 Of course, @code{return} is generally used inside an @code{if} or
Dave Love <fx@gnu.org>
parents:
diff changeset
2881 @code{unless}, as its use in a top-level loop clause would mean
Dave Love <fx@gnu.org>
parents:
diff changeset
2882 the loop would never get to ``loop'' more than once.
Dave Love <fx@gnu.org>
parents:
diff changeset
2883
Dave Love <fx@gnu.org>
parents:
diff changeset
2884 The clause @samp{return @var{form}} is equivalent to
Dave Love <fx@gnu.org>
parents:
diff changeset
2885 @samp{do (return @var{form})} (or @code{return-from} if the loop
Dave Love <fx@gnu.org>
parents:
diff changeset
2886 was named). The @code{return} clause is implemented a bit more
Dave Love <fx@gnu.org>
parents:
diff changeset
2887 efficiently, though.
Dave Love <fx@gnu.org>
parents:
diff changeset
2888 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
2889
Dave Love <fx@gnu.org>
parents:
diff changeset
2890 While there is no high-level way to add user extensions to @code{loop}
Dave Love <fx@gnu.org>
parents:
diff changeset
2891 (comparable to @code{defsetf} for @code{setf}, say), this package
Dave Love <fx@gnu.org>
parents:
diff changeset
2892 does offer two properties called @code{cl-loop-handler} and
Dave Love <fx@gnu.org>
parents:
diff changeset
2893 @code{cl-loop-for-handler} which are functions to be called when
Dave Love <fx@gnu.org>
parents:
diff changeset
2894 a given symbol is encountered as a top-level loop clause or
Dave Love <fx@gnu.org>
parents:
diff changeset
2895 @code{for} clause, respectively. Consult the source code in
Dave Love <fx@gnu.org>
parents:
diff changeset
2896 file @file{cl-macs.el} for details.
Dave Love <fx@gnu.org>
parents:
diff changeset
2897
Dave Love <fx@gnu.org>
parents:
diff changeset
2898 This package's @code{loop} macro is compatible with that of Common
Dave Love <fx@gnu.org>
parents:
diff changeset
2899 Lisp, except that a few features are not implemented: @code{loop-finish}
Dave Love <fx@gnu.org>
parents:
diff changeset
2900 and data-type specifiers. Naturally, the @code{for} clauses which
Dave Love <fx@gnu.org>
parents:
diff changeset
2901 iterate over keymaps, overlays, intervals, frames, windows, and
Dave Love <fx@gnu.org>
parents:
diff changeset
2902 buffers are Emacs-specific extensions.
Dave Love <fx@gnu.org>
parents:
diff changeset
2903
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
2904 @node Multiple Values, , Loop Facility, Control Structure
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2905 @section Multiple Values
Dave Love <fx@gnu.org>
parents:
diff changeset
2906
Dave Love <fx@gnu.org>
parents:
diff changeset
2907 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2908 Common Lisp functions can return zero or more results. Emacs Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2909 functions, by contrast, always return exactly one result. This
Dave Love <fx@gnu.org>
parents:
diff changeset
2910 package makes no attempt to emulate Common Lisp multiple return
Dave Love <fx@gnu.org>
parents:
diff changeset
2911 values; Emacs versions of Common Lisp functions that return more
Dave Love <fx@gnu.org>
parents:
diff changeset
2912 than one value either return just the first value (as in
Dave Love <fx@gnu.org>
parents:
diff changeset
2913 @code{compiler-macroexpand}) or return a list of values (as in
Dave Love <fx@gnu.org>
parents:
diff changeset
2914 @code{get-setf-method}). This package @emph{does} define placeholders
Dave Love <fx@gnu.org>
parents:
diff changeset
2915 for the Common Lisp functions that work with multiple values, but
Dave Love <fx@gnu.org>
parents:
diff changeset
2916 in Emacs Lisp these functions simply operate on lists instead.
Dave Love <fx@gnu.org>
parents:
diff changeset
2917 The @code{values} form, for example, is a synonym for @code{list}
Dave Love <fx@gnu.org>
parents:
diff changeset
2918 in Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
2919
Dave Love <fx@gnu.org>
parents:
diff changeset
2920 @defspec multiple-value-bind (var@dots{}) values-form forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
2921 This form evaluates @var{values-form}, which must return a list of
Dave Love <fx@gnu.org>
parents:
diff changeset
2922 values. It then binds the @var{var}s to these respective values,
Dave Love <fx@gnu.org>
parents:
diff changeset
2923 as if by @code{let}, and then executes the body @var{forms}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2924 If there are more @var{var}s than values, the extra @var{var}s
Dave Love <fx@gnu.org>
parents:
diff changeset
2925 are bound to @code{nil}. If there are fewer @var{var}s than
Dave Love <fx@gnu.org>
parents:
diff changeset
2926 values, the excess values are ignored.
Dave Love <fx@gnu.org>
parents:
diff changeset
2927 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
2928
Dave Love <fx@gnu.org>
parents:
diff changeset
2929 @defspec multiple-value-setq (var@dots{}) form
Dave Love <fx@gnu.org>
parents:
diff changeset
2930 This form evaluates @var{form}, which must return a list of values.
Dave Love <fx@gnu.org>
parents:
diff changeset
2931 It then sets the @var{var}s to these respective values, as if by
Dave Love <fx@gnu.org>
parents:
diff changeset
2932 @code{setq}. Extra @var{var}s or values are treated the same as
Dave Love <fx@gnu.org>
parents:
diff changeset
2933 in @code{multiple-value-bind}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2934 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
2935
Dave Love <fx@gnu.org>
parents:
diff changeset
2936 The older Quiroz package attempted a more faithful (but still
Dave Love <fx@gnu.org>
parents:
diff changeset
2937 imperfect) emulation of Common Lisp multiple values. The old
Dave Love <fx@gnu.org>
parents:
diff changeset
2938 method ``usually'' simulated true multiple values quite well,
Dave Love <fx@gnu.org>
parents:
diff changeset
2939 but under certain circumstances would leave spurious return
Dave Love <fx@gnu.org>
parents:
diff changeset
2940 values in memory where a later, unrelated @code{multiple-value-bind}
Dave Love <fx@gnu.org>
parents:
diff changeset
2941 form would see them.
Dave Love <fx@gnu.org>
parents:
diff changeset
2942
Dave Love <fx@gnu.org>
parents:
diff changeset
2943 Since a perfect emulation is not feasible in Emacs Lisp, this
Dave Love <fx@gnu.org>
parents:
diff changeset
2944 package opts to keep it as simple and predictable as possible.
Dave Love <fx@gnu.org>
parents:
diff changeset
2945
Dave Love <fx@gnu.org>
parents:
diff changeset
2946 @node Macros, Declarations, Control Structure, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
2947 @chapter Macros
Dave Love <fx@gnu.org>
parents:
diff changeset
2948
Dave Love <fx@gnu.org>
parents:
diff changeset
2949 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2950 This package implements the various Common Lisp features of
Dave Love <fx@gnu.org>
parents:
diff changeset
2951 @code{defmacro}, such as destructuring, @code{&environment},
Dave Love <fx@gnu.org>
parents:
diff changeset
2952 and @code{&body}. Top-level @code{&whole} is not implemented
Dave Love <fx@gnu.org>
parents:
diff changeset
2953 for @code{defmacro} due to technical difficulties.
Dave Love <fx@gnu.org>
parents:
diff changeset
2954 @xref{Argument Lists}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2955
Dave Love <fx@gnu.org>
parents:
diff changeset
2956 Destructuring is made available to the user by way of the
Dave Love <fx@gnu.org>
parents:
diff changeset
2957 following macro:
Dave Love <fx@gnu.org>
parents:
diff changeset
2958
Dave Love <fx@gnu.org>
parents:
diff changeset
2959 @defspec destructuring-bind arglist expr forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
2960 This macro expands to code which executes @var{forms}, with
Dave Love <fx@gnu.org>
parents:
diff changeset
2961 the variables in @var{arglist} bound to the list of values
Dave Love <fx@gnu.org>
parents:
diff changeset
2962 returned by @var{expr}. The @var{arglist} can include all
Dave Love <fx@gnu.org>
parents:
diff changeset
2963 the features allowed for @code{defmacro} argument lists,
Dave Love <fx@gnu.org>
parents:
diff changeset
2964 including destructuring. (The @code{&environment} keyword
Dave Love <fx@gnu.org>
parents:
diff changeset
2965 is not allowed.) The macro expansion will signal an error
Dave Love <fx@gnu.org>
parents:
diff changeset
2966 if @var{expr} returns a list of the wrong number of arguments
Dave Love <fx@gnu.org>
parents:
diff changeset
2967 or with incorrect keyword arguments.
Dave Love <fx@gnu.org>
parents:
diff changeset
2968 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
2969
Dave Love <fx@gnu.org>
parents:
diff changeset
2970 This package also includes the Common Lisp @code{define-compiler-macro}
Dave Love <fx@gnu.org>
parents:
diff changeset
2971 facility, which allows you to define compile-time expansions and
Dave Love <fx@gnu.org>
parents:
diff changeset
2972 optimizations for your functions.
Dave Love <fx@gnu.org>
parents:
diff changeset
2973
Dave Love <fx@gnu.org>
parents:
diff changeset
2974 @defspec define-compiler-macro name arglist forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
2975 This form is similar to @code{defmacro}, except that it only expands
Dave Love <fx@gnu.org>
parents:
diff changeset
2976 calls to @var{name} at compile-time; calls processed by the Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2977 interpreter are not expanded, nor are they expanded by the
Dave Love <fx@gnu.org>
parents:
diff changeset
2978 @code{macroexpand} function.
Dave Love <fx@gnu.org>
parents:
diff changeset
2979
Dave Love <fx@gnu.org>
parents:
diff changeset
2980 The argument list may begin with a @code{&whole} keyword and a
Dave Love <fx@gnu.org>
parents:
diff changeset
2981 variable. This variable is bound to the macro-call form itself,
Dave Love <fx@gnu.org>
parents:
diff changeset
2982 i.e., to a list of the form @samp{(@var{name} @var{args}@dots{})}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2983 If the macro expander returns this form unchanged, then the
Dave Love <fx@gnu.org>
parents:
diff changeset
2984 compiler treats it as a normal function call. This allows
Dave Love <fx@gnu.org>
parents:
diff changeset
2985 compiler macros to work as optimizers for special cases of a
Dave Love <fx@gnu.org>
parents:
diff changeset
2986 function, leaving complicated cases alone.
Dave Love <fx@gnu.org>
parents:
diff changeset
2987
Dave Love <fx@gnu.org>
parents:
diff changeset
2988 For example, here is a simplified version of a definition that
Dave Love <fx@gnu.org>
parents:
diff changeset
2989 appears as a standard part of this package:
Dave Love <fx@gnu.org>
parents:
diff changeset
2990
Dave Love <fx@gnu.org>
parents:
diff changeset
2991 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2992 (define-compiler-macro member* (&whole form a list &rest keys)
Dave Love <fx@gnu.org>
parents:
diff changeset
2993 (if (and (null keys)
Dave Love <fx@gnu.org>
parents:
diff changeset
2994 (eq (car-safe a) 'quote)
Dave Love <fx@gnu.org>
parents:
diff changeset
2995 (not (floatp-safe (cadr a))))
Dave Love <fx@gnu.org>
parents:
diff changeset
2996 (list 'memq a list)
Dave Love <fx@gnu.org>
parents:
diff changeset
2997 form))
Dave Love <fx@gnu.org>
parents:
diff changeset
2998 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2999
Dave Love <fx@gnu.org>
parents:
diff changeset
3000 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3001 This definition causes @code{(member* @var{a} @var{list})} to change
Dave Love <fx@gnu.org>
parents:
diff changeset
3002 to a call to the faster @code{memq} in the common case where @var{a}
Dave Love <fx@gnu.org>
parents:
diff changeset
3003 is a non-floating-point constant; if @var{a} is anything else, or
Dave Love <fx@gnu.org>
parents:
diff changeset
3004 if there are any keyword arguments in the call, then the original
Dave Love <fx@gnu.org>
parents:
diff changeset
3005 @code{member*} call is left intact. (The actual compiler macro
Dave Love <fx@gnu.org>
parents:
diff changeset
3006 for @code{member*} optimizes a number of other cases, including
Dave Love <fx@gnu.org>
parents:
diff changeset
3007 common @code{:test} predicates.)
Dave Love <fx@gnu.org>
parents:
diff changeset
3008 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
3009
Dave Love <fx@gnu.org>
parents:
diff changeset
3010 @defun compiler-macroexpand form
Dave Love <fx@gnu.org>
parents:
diff changeset
3011 This function is analogous to @code{macroexpand}, except that it
Dave Love <fx@gnu.org>
parents:
diff changeset
3012 expands compiler macros rather than regular macros. It returns
Dave Love <fx@gnu.org>
parents:
diff changeset
3013 @var{form} unchanged if it is not a call to a function for which
Dave Love <fx@gnu.org>
parents:
diff changeset
3014 a compiler macro has been defined, or if that compiler macro
Dave Love <fx@gnu.org>
parents:
diff changeset
3015 decided to punt by returning its @code{&whole} argument. Like
Dave Love <fx@gnu.org>
parents:
diff changeset
3016 @code{macroexpand}, it expands repeatedly until it reaches a form
Dave Love <fx@gnu.org>
parents:
diff changeset
3017 for which no further expansion is possible.
Dave Love <fx@gnu.org>
parents:
diff changeset
3018 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3019
Dave Love <fx@gnu.org>
parents:
diff changeset
3020 @xref{Macro Bindings}, for descriptions of the @code{macrolet}
Dave Love <fx@gnu.org>
parents:
diff changeset
3021 and @code{symbol-macrolet} forms for making ``local'' macro
Dave Love <fx@gnu.org>
parents:
diff changeset
3022 definitions.
Dave Love <fx@gnu.org>
parents:
diff changeset
3023
Dave Love <fx@gnu.org>
parents:
diff changeset
3024 @node Declarations, Symbols, Macros, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
3025 @chapter Declarations
Dave Love <fx@gnu.org>
parents:
diff changeset
3026
Dave Love <fx@gnu.org>
parents:
diff changeset
3027 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3028 Common Lisp includes a complex and powerful ``declaration''
Dave Love <fx@gnu.org>
parents:
diff changeset
3029 mechanism that allows you to give the compiler special hints
Dave Love <fx@gnu.org>
parents:
diff changeset
3030 about the types of data that will be stored in particular variables,
Dave Love <fx@gnu.org>
parents:
diff changeset
3031 and about the ways those variables and functions will be used. This
Dave Love <fx@gnu.org>
parents:
diff changeset
3032 package defines versions of all the Common Lisp declaration forms:
Dave Love <fx@gnu.org>
parents:
diff changeset
3033 @code{declare}, @code{locally}, @code{proclaim}, @code{declaim},
Dave Love <fx@gnu.org>
parents:
diff changeset
3034 and @code{the}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3035
Dave Love <fx@gnu.org>
parents:
diff changeset
3036 Most of the Common Lisp declarations are not currently useful in
Dave Love <fx@gnu.org>
parents:
diff changeset
3037 Emacs Lisp, as the byte-code system provides little opportunity
Dave Love <fx@gnu.org>
parents:
diff changeset
3038 to benefit from type information, and @code{special} declarations
Dave Love <fx@gnu.org>
parents:
diff changeset
3039 are redundant in a fully dynamically-scoped Lisp. A few
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
3040 declarations are meaningful when the optimizing byte
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3041 compiler is being used, however. Under the earlier non-optimizing
Dave Love <fx@gnu.org>
parents:
diff changeset
3042 compiler, these declarations will effectively be ignored.
Dave Love <fx@gnu.org>
parents:
diff changeset
3043
Dave Love <fx@gnu.org>
parents:
diff changeset
3044 @defun proclaim decl-spec
Dave Love <fx@gnu.org>
parents:
diff changeset
3045 This function records a ``global'' declaration specified by
Dave Love <fx@gnu.org>
parents:
diff changeset
3046 @var{decl-spec}. Since @code{proclaim} is a function, @var{decl-spec}
Dave Love <fx@gnu.org>
parents:
diff changeset
3047 is evaluated and thus should normally be quoted.
Dave Love <fx@gnu.org>
parents:
diff changeset
3048 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3049
Dave Love <fx@gnu.org>
parents:
diff changeset
3050 @defspec declaim decl-specs@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
3051 This macro is like @code{proclaim}, except that it takes any number
Dave Love <fx@gnu.org>
parents:
diff changeset
3052 of @var{decl-spec} arguments, and the arguments are unevaluated and
Dave Love <fx@gnu.org>
parents:
diff changeset
3053 unquoted. The @code{declaim} macro also puts an @code{(eval-when
Dave Love <fx@gnu.org>
parents:
diff changeset
3054 (compile load eval) ...)} around the declarations so that they will
Dave Love <fx@gnu.org>
parents:
diff changeset
3055 be registered at compile-time as well as at run-time. (This is vital,
Dave Love <fx@gnu.org>
parents:
diff changeset
3056 since normally the declarations are meant to influence the way the
Dave Love <fx@gnu.org>
parents:
diff changeset
3057 compiler treats the rest of the file that contains the @code{declaim}
Dave Love <fx@gnu.org>
parents:
diff changeset
3058 form.)
Dave Love <fx@gnu.org>
parents:
diff changeset
3059 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
3060
Dave Love <fx@gnu.org>
parents:
diff changeset
3061 @defspec declare decl-specs@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
3062 This macro is used to make declarations within functions and other
Dave Love <fx@gnu.org>
parents:
diff changeset
3063 code. Common Lisp allows declarations in various locations, generally
Dave Love <fx@gnu.org>
parents:
diff changeset
3064 at the beginning of any of the many ``implicit @code{progn}s''
Dave Love <fx@gnu.org>
parents:
diff changeset
3065 throughout Lisp syntax, such as function bodies, @code{let} bodies,
Dave Love <fx@gnu.org>
parents:
diff changeset
3066 etc. Currently the only declaration understood by @code{declare}
Dave Love <fx@gnu.org>
parents:
diff changeset
3067 is @code{special}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3068 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
3069
Dave Love <fx@gnu.org>
parents:
diff changeset
3070 @defspec locally declarations@dots{} forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
3071 In this package, @code{locally} is no different from @code{progn}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3072 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
3073
Dave Love <fx@gnu.org>
parents:
diff changeset
3074 @defspec the type form
Dave Love <fx@gnu.org>
parents:
diff changeset
3075 Type information provided by @code{the} is ignored in this package;
Dave Love <fx@gnu.org>
parents:
diff changeset
3076 in other words, @code{(the @var{type} @var{form})} is equivalent
Dave Love <fx@gnu.org>
parents:
diff changeset
3077 to @var{form}. Future versions of the optimizing byte-compiler may
Dave Love <fx@gnu.org>
parents:
diff changeset
3078 make use of this information.
Dave Love <fx@gnu.org>
parents:
diff changeset
3079
Dave Love <fx@gnu.org>
parents:
diff changeset
3080 For example, @code{mapcar} can map over both lists and arrays. It is
Dave Love <fx@gnu.org>
parents:
diff changeset
3081 hard for the compiler to expand @code{mapcar} into an in-line loop
Dave Love <fx@gnu.org>
parents:
diff changeset
3082 unless it knows whether the sequence will be a list or an array ahead
Dave Love <fx@gnu.org>
parents:
diff changeset
3083 of time. With @code{(mapcar 'car (the vector foo))}, a future
Dave Love <fx@gnu.org>
parents:
diff changeset
3084 compiler would have enough information to expand the loop in-line.
Dave Love <fx@gnu.org>
parents:
diff changeset
3085 For now, Emacs Lisp will treat the above code as exactly equivalent
Dave Love <fx@gnu.org>
parents:
diff changeset
3086 to @code{(mapcar 'car foo)}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3087 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
3088
Dave Love <fx@gnu.org>
parents:
diff changeset
3089 Each @var{decl-spec} in a @code{proclaim}, @code{declaim}, or
Dave Love <fx@gnu.org>
parents:
diff changeset
3090 @code{declare} should be a list beginning with a symbol that says
Dave Love <fx@gnu.org>
parents:
diff changeset
3091 what kind of declaration it is. This package currently understands
Dave Love <fx@gnu.org>
parents:
diff changeset
3092 @code{special}, @code{inline}, @code{notinline}, @code{optimize},
Dave Love <fx@gnu.org>
parents:
diff changeset
3093 and @code{warn} declarations. (The @code{warn} declaration is an
Dave Love <fx@gnu.org>
parents:
diff changeset
3094 extension of standard Common Lisp.) Other Common Lisp declarations,
Dave Love <fx@gnu.org>
parents:
diff changeset
3095 such as @code{type} and @code{ftype}, are silently ignored.
Dave Love <fx@gnu.org>
parents:
diff changeset
3096
Dave Love <fx@gnu.org>
parents:
diff changeset
3097 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
3098 @item special
Dave Love <fx@gnu.org>
parents:
diff changeset
3099 Since all variables in Emacs Lisp are ``special'' (in the Common
Dave Love <fx@gnu.org>
parents:
diff changeset
3100 Lisp sense), @code{special} declarations are only advisory. They
Dave Love <fx@gnu.org>
parents:
diff changeset
3101 simply tell the optimizing byte compiler that the specified
Dave Love <fx@gnu.org>
parents:
diff changeset
3102 variables are intentionally being referred to without being
Dave Love <fx@gnu.org>
parents:
diff changeset
3103 bound in the body of the function. The compiler normally emits
Dave Love <fx@gnu.org>
parents:
diff changeset
3104 warnings for such references, since they could be typographical
Dave Love <fx@gnu.org>
parents:
diff changeset
3105 errors for references to local variables.
Dave Love <fx@gnu.org>
parents:
diff changeset
3106
Dave Love <fx@gnu.org>
parents:
diff changeset
3107 The declaration @code{(declare (special @var{var1} @var{var2}))} is
Dave Love <fx@gnu.org>
parents:
diff changeset
3108 equivalent to @code{(defvar @var{var1}) (defvar @var{var2})} in the
Dave Love <fx@gnu.org>
parents:
diff changeset
3109 optimizing compiler, or to nothing at all in older compilers (which
Dave Love <fx@gnu.org>
parents:
diff changeset
3110 do not warn for non-local references).
Dave Love <fx@gnu.org>
parents:
diff changeset
3111
Dave Love <fx@gnu.org>
parents:
diff changeset
3112 In top-level contexts, it is generally better to write
Dave Love <fx@gnu.org>
parents:
diff changeset
3113 @code{(defvar @var{var})} than @code{(declaim (special @var{var}))},
Dave Love <fx@gnu.org>
parents:
diff changeset
3114 since @code{defvar} makes your intentions clearer. But the older
Dave Love <fx@gnu.org>
parents:
diff changeset
3115 byte compilers can not handle @code{defvar}s appearing inside of
Dave Love <fx@gnu.org>
parents:
diff changeset
3116 functions, while @code{(declare (special @var{var}))} takes care
Dave Love <fx@gnu.org>
parents:
diff changeset
3117 to work correctly with all compilers.
Dave Love <fx@gnu.org>
parents:
diff changeset
3118
Dave Love <fx@gnu.org>
parents:
diff changeset
3119 @item inline
Dave Love <fx@gnu.org>
parents:
diff changeset
3120 The @code{inline} @var{decl-spec} lists one or more functions
Dave Love <fx@gnu.org>
parents:
diff changeset
3121 whose bodies should be expanded ``in-line'' into calling functions
Dave Love <fx@gnu.org>
parents:
diff changeset
3122 whenever the compiler is able to arrange for it. For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
3123 the Common Lisp function @code{cadr} is declared @code{inline}
Dave Love <fx@gnu.org>
parents:
diff changeset
3124 by this package so that the form @code{(cadr @var{x})} will
Dave Love <fx@gnu.org>
parents:
diff changeset
3125 expand directly into @code{(car (cdr @var{x}))} when it is called
Dave Love <fx@gnu.org>
parents:
diff changeset
3126 in user functions, for a savings of one (relatively expensive)
Dave Love <fx@gnu.org>
parents:
diff changeset
3127 function call.
Dave Love <fx@gnu.org>
parents:
diff changeset
3128
Dave Love <fx@gnu.org>
parents:
diff changeset
3129 The following declarations are all equivalent. Note that the
Dave Love <fx@gnu.org>
parents:
diff changeset
3130 @code{defsubst} form is a convenient way to define a function
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
3131 and declare it inline all at once.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3132
Dave Love <fx@gnu.org>
parents:
diff changeset
3133 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3134 (declaim (inline foo bar))
Dave Love <fx@gnu.org>
parents:
diff changeset
3135 (eval-when (compile load eval) (proclaim '(inline foo bar)))
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
3136 (defsubst foo (...) ...) ; instead of defun
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3137 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3138
Dave Love <fx@gnu.org>
parents:
diff changeset
3139 @strong{Note:} This declaration remains in effect after the
Dave Love <fx@gnu.org>
parents:
diff changeset
3140 containing source file is done. It is correct to use it to
Dave Love <fx@gnu.org>
parents:
diff changeset
3141 request that a function you have defined should be inlined,
Dave Love <fx@gnu.org>
parents:
diff changeset
3142 but it is impolite to use it to request inlining of an external
Dave Love <fx@gnu.org>
parents:
diff changeset
3143 function.
Dave Love <fx@gnu.org>
parents:
diff changeset
3144
Dave Love <fx@gnu.org>
parents:
diff changeset
3145 In Common Lisp, it is possible to use @code{(declare (inline @dots{}))}
Dave Love <fx@gnu.org>
parents:
diff changeset
3146 before a particular call to a function to cause just that call to
Dave Love <fx@gnu.org>
parents:
diff changeset
3147 be inlined; the current byte compilers provide no way to implement
Dave Love <fx@gnu.org>
parents:
diff changeset
3148 this, so @code{(declare (inline @dots{}))} is currently ignored by
Dave Love <fx@gnu.org>
parents:
diff changeset
3149 this package.
Dave Love <fx@gnu.org>
parents:
diff changeset
3150
Dave Love <fx@gnu.org>
parents:
diff changeset
3151 @item notinline
Dave Love <fx@gnu.org>
parents:
diff changeset
3152 The @code{notinline} declaration lists functions which should
Dave Love <fx@gnu.org>
parents:
diff changeset
3153 not be inlined after all; it cancels a previous @code{inline}
Dave Love <fx@gnu.org>
parents:
diff changeset
3154 declaration.
Dave Love <fx@gnu.org>
parents:
diff changeset
3155
Dave Love <fx@gnu.org>
parents:
diff changeset
3156 @item optimize
Dave Love <fx@gnu.org>
parents:
diff changeset
3157 This declaration controls how much optimization is performed by
Dave Love <fx@gnu.org>
parents:
diff changeset
3158 the compiler. Naturally, it is ignored by the earlier non-optimizing
Dave Love <fx@gnu.org>
parents:
diff changeset
3159 compilers.
Dave Love <fx@gnu.org>
parents:
diff changeset
3160
Dave Love <fx@gnu.org>
parents:
diff changeset
3161 The word @code{optimize} is followed by any number of lists like
Dave Love <fx@gnu.org>
parents:
diff changeset
3162 @code{(speed 3)} or @code{(safety 2)}. Common Lisp defines several
Dave Love <fx@gnu.org>
parents:
diff changeset
3163 optimization ``qualities''; this package ignores all but @code{speed}
Dave Love <fx@gnu.org>
parents:
diff changeset
3164 and @code{safety}. The value of a quality should be an integer from
Dave Love <fx@gnu.org>
parents:
diff changeset
3165 0 to 3, with 0 meaning ``unimportant'' and 3 meaning ``very important.''
Dave Love <fx@gnu.org>
parents:
diff changeset
3166 The default level for both qualities is 1.
Dave Love <fx@gnu.org>
parents:
diff changeset
3167
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
3168 In this package, with the optimizing compiler, the
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3169 @code{speed} quality is tied to the @code{byte-compile-optimize}
Dave Love <fx@gnu.org>
parents:
diff changeset
3170 flag, which is set to @code{nil} for @code{(speed 0)} and to
Dave Love <fx@gnu.org>
parents:
diff changeset
3171 @code{t} for higher settings; and the @code{safety} quality is
Dave Love <fx@gnu.org>
parents:
diff changeset
3172 tied to the @code{byte-compile-delete-errors} flag, which is
Dave Love <fx@gnu.org>
parents:
diff changeset
3173 set to @code{t} for @code{(safety 3)} and to @code{nil} for all
Dave Love <fx@gnu.org>
parents:
diff changeset
3174 lower settings. (The latter flag controls whether the compiler
Dave Love <fx@gnu.org>
parents:
diff changeset
3175 is allowed to optimize out code whose only side-effect could
Dave Love <fx@gnu.org>
parents:
diff changeset
3176 be to signal an error, e.g., rewriting @code{(progn foo bar)} to
Dave Love <fx@gnu.org>
parents:
diff changeset
3177 @code{bar} when it is not known whether @code{foo} will be bound
Dave Love <fx@gnu.org>
parents:
diff changeset
3178 at run-time.)
Dave Love <fx@gnu.org>
parents:
diff changeset
3179
Dave Love <fx@gnu.org>
parents:
diff changeset
3180 Note that even compiling with @code{(safety 0)}, the Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
3181 byte-code system provides sufficient checking to prevent real
Dave Love <fx@gnu.org>
parents:
diff changeset
3182 harm from being done. For example, barring serious bugs in
Dave Love <fx@gnu.org>
parents:
diff changeset
3183 Emacs itself, Emacs will not crash with a segmentation fault
Dave Love <fx@gnu.org>
parents:
diff changeset
3184 just because of an error in a fully-optimized Lisp program.
Dave Love <fx@gnu.org>
parents:
diff changeset
3185
Dave Love <fx@gnu.org>
parents:
diff changeset
3186 The @code{optimize} declaration is normally used in a top-level
Dave Love <fx@gnu.org>
parents:
diff changeset
3187 @code{proclaim} or @code{declaim} in a file; Common Lisp allows
Dave Love <fx@gnu.org>
parents:
diff changeset
3188 it to be used with @code{declare} to set the level of optimization
Dave Love <fx@gnu.org>
parents:
diff changeset
3189 locally for a given form, but this will not work correctly with the
Dave Love <fx@gnu.org>
parents:
diff changeset
3190 current version of the optimizing compiler. (The @code{declare}
Dave Love <fx@gnu.org>
parents:
diff changeset
3191 will set the new optimization level, but that level will not
Dave Love <fx@gnu.org>
parents:
diff changeset
3192 automatically be unset after the enclosing form is done.)
Dave Love <fx@gnu.org>
parents:
diff changeset
3193
Dave Love <fx@gnu.org>
parents:
diff changeset
3194 @item warn
Dave Love <fx@gnu.org>
parents:
diff changeset
3195 This declaration controls what sorts of warnings are generated
Dave Love <fx@gnu.org>
parents:
diff changeset
3196 by the byte compiler. Again, only the optimizing compiler
Dave Love <fx@gnu.org>
parents:
diff changeset
3197 generates warnings. The word @code{warn} is followed by any
Dave Love <fx@gnu.org>
parents:
diff changeset
3198 number of ``warning qualities,'' similar in form to optimization
Dave Love <fx@gnu.org>
parents:
diff changeset
3199 qualities. The currently supported warning types are
Dave Love <fx@gnu.org>
parents:
diff changeset
3200 @code{redefine}, @code{callargs}, @code{unresolved}, and
Dave Love <fx@gnu.org>
parents:
diff changeset
3201 @code{free-vars}; in the current system, a value of 0 will
Dave Love <fx@gnu.org>
parents:
diff changeset
3202 disable these warnings and any higher value will enable them.
Dave Love <fx@gnu.org>
parents:
diff changeset
3203 See the documentation for the optimizing byte compiler for details.
Dave Love <fx@gnu.org>
parents:
diff changeset
3204 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
3205
Dave Love <fx@gnu.org>
parents:
diff changeset
3206 @node Symbols, Numbers, Declarations, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
3207 @chapter Symbols
Dave Love <fx@gnu.org>
parents:
diff changeset
3208
Dave Love <fx@gnu.org>
parents:
diff changeset
3209 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3210 This package defines several symbol-related features that were
Dave Love <fx@gnu.org>
parents:
diff changeset
3211 missing from Emacs Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
3212
Dave Love <fx@gnu.org>
parents:
diff changeset
3213 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
3214 * Property Lists:: `get*', `remprop', `getf', `remf'
Dave Love <fx@gnu.org>
parents:
diff changeset
3215 * Creating Symbols:: `gensym', `gentemp'
Dave Love <fx@gnu.org>
parents:
diff changeset
3216 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
3217
Dave Love <fx@gnu.org>
parents:
diff changeset
3218 @node Property Lists, Creating Symbols, Symbols, Symbols
Dave Love <fx@gnu.org>
parents:
diff changeset
3219 @section Property Lists
Dave Love <fx@gnu.org>
parents:
diff changeset
3220
Dave Love <fx@gnu.org>
parents:
diff changeset
3221 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3222 These functions augment the standard Emacs Lisp functions @code{get}
Dave Love <fx@gnu.org>
parents:
diff changeset
3223 and @code{put} for operating on properties attached to symbols.
Dave Love <fx@gnu.org>
parents:
diff changeset
3224 There are also functions for working with property lists as
Dave Love <fx@gnu.org>
parents:
diff changeset
3225 first-class data structures not attached to particular symbols.
Dave Love <fx@gnu.org>
parents:
diff changeset
3226
Dave Love <fx@gnu.org>
parents:
diff changeset
3227 @defun get* symbol property &optional default
Dave Love <fx@gnu.org>
parents:
diff changeset
3228 This function is like @code{get}, except that if the property is
Dave Love <fx@gnu.org>
parents:
diff changeset
3229 not found, the @var{default} argument provides the return value.
Dave Love <fx@gnu.org>
parents:
diff changeset
3230 (The Emacs Lisp @code{get} function always uses @code{nil} as
Dave Love <fx@gnu.org>
parents:
diff changeset
3231 the default; this package's @code{get*} is equivalent to Common
Dave Love <fx@gnu.org>
parents:
diff changeset
3232 Lisp's @code{get}.)
Dave Love <fx@gnu.org>
parents:
diff changeset
3233
Dave Love <fx@gnu.org>
parents:
diff changeset
3234 The @code{get*} function is @code{setf}-able; when used in this
Dave Love <fx@gnu.org>
parents:
diff changeset
3235 fashion, the @var{default} argument is allowed but ignored.
Dave Love <fx@gnu.org>
parents:
diff changeset
3236 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3237
Dave Love <fx@gnu.org>
parents:
diff changeset
3238 @defun remprop symbol property
Dave Love <fx@gnu.org>
parents:
diff changeset
3239 This function removes the entry for @var{property} from the property
Dave Love <fx@gnu.org>
parents:
diff changeset
3240 list of @var{symbol}. It returns a true value if the property was
Dave Love <fx@gnu.org>
parents:
diff changeset
3241 indeed found and removed, or @code{nil} if there was no such property.
Dave Love <fx@gnu.org>
parents:
diff changeset
3242 (This function was probably omitted from Emacs originally because,
Dave Love <fx@gnu.org>
parents:
diff changeset
3243 since @code{get} did not allow a @var{default}, it was very difficult
Dave Love <fx@gnu.org>
parents:
diff changeset
3244 to distinguish between a missing property and a property whose value
Dave Love <fx@gnu.org>
parents:
diff changeset
3245 was @code{nil}; thus, setting a property to @code{nil} was close
Dave Love <fx@gnu.org>
parents:
diff changeset
3246 enough to @code{remprop} for most purposes.)
Dave Love <fx@gnu.org>
parents:
diff changeset
3247 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3248
Dave Love <fx@gnu.org>
parents:
diff changeset
3249 @defun getf place property &optional default
Dave Love <fx@gnu.org>
parents:
diff changeset
3250 This function scans the list @var{place} as if it were a property
Dave Love <fx@gnu.org>
parents:
diff changeset
3251 list, i.e., a list of alternating property names and values. If
Dave Love <fx@gnu.org>
parents:
diff changeset
3252 an even-numbered element of @var{place} is found which is @code{eq}
Dave Love <fx@gnu.org>
parents:
diff changeset
3253 to @var{property}, the following odd-numbered element is returned.
Dave Love <fx@gnu.org>
parents:
diff changeset
3254 Otherwise, @var{default} is returned (or @code{nil} if no default
Dave Love <fx@gnu.org>
parents:
diff changeset
3255 is given).
Dave Love <fx@gnu.org>
parents:
diff changeset
3256
Dave Love <fx@gnu.org>
parents:
diff changeset
3257 In particular,
Dave Love <fx@gnu.org>
parents:
diff changeset
3258
Dave Love <fx@gnu.org>
parents:
diff changeset
3259 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3260 (get sym prop) @equiv{} (getf (symbol-plist sym) prop)
Dave Love <fx@gnu.org>
parents:
diff changeset
3261 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3262
Dave Love <fx@gnu.org>
parents:
diff changeset
3263 It is legal to use @code{getf} as a @code{setf} place, in which case
Dave Love <fx@gnu.org>
parents:
diff changeset
3264 its @var{place} argument must itself be a legal @code{setf} place.
Dave Love <fx@gnu.org>
parents:
diff changeset
3265 The @var{default} argument, if any, is ignored in this context.
Dave Love <fx@gnu.org>
parents:
diff changeset
3266 The effect is to change (via @code{setcar}) the value cell in the
Dave Love <fx@gnu.org>
parents:
diff changeset
3267 list that corresponds to @var{property}, or to cons a new property-value
Dave Love <fx@gnu.org>
parents:
diff changeset
3268 pair onto the list if the property is not yet present.
Dave Love <fx@gnu.org>
parents:
diff changeset
3269
Dave Love <fx@gnu.org>
parents:
diff changeset
3270 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3271 (put sym prop val) @equiv{} (setf (getf (symbol-plist sym) prop) val)
Dave Love <fx@gnu.org>
parents:
diff changeset
3272 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3273
Dave Love <fx@gnu.org>
parents:
diff changeset
3274 The @code{get} and @code{get*} functions are also @code{setf}-able.
Dave Love <fx@gnu.org>
parents:
diff changeset
3275 The fact that @code{default} is ignored can sometimes be useful:
Dave Love <fx@gnu.org>
parents:
diff changeset
3276
Dave Love <fx@gnu.org>
parents:
diff changeset
3277 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3278 (incf (get* 'foo 'usage-count 0))
Dave Love <fx@gnu.org>
parents:
diff changeset
3279 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3280
Dave Love <fx@gnu.org>
parents:
diff changeset
3281 Here, symbol @code{foo}'s @code{usage-count} property is incremented
Dave Love <fx@gnu.org>
parents:
diff changeset
3282 if it exists, or set to 1 (an incremented 0) otherwise.
Dave Love <fx@gnu.org>
parents:
diff changeset
3283
Dave Love <fx@gnu.org>
parents:
diff changeset
3284 When not used as a @code{setf} form, @code{getf} is just a regular
Dave Love <fx@gnu.org>
parents:
diff changeset
3285 function and its @var{place} argument can actually be any Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3286 expression.
Dave Love <fx@gnu.org>
parents:
diff changeset
3287 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3288
Dave Love <fx@gnu.org>
parents:
diff changeset
3289 @defspec remf place property
Dave Love <fx@gnu.org>
parents:
diff changeset
3290 This macro removes the property-value pair for @var{property} from
Dave Love <fx@gnu.org>
parents:
diff changeset
3291 the property list stored at @var{place}, which is any @code{setf}-able
Dave Love <fx@gnu.org>
parents:
diff changeset
3292 place expression. It returns true if the property was found. Note
Dave Love <fx@gnu.org>
parents:
diff changeset
3293 that if @var{property} happens to be first on the list, this will
Dave Love <fx@gnu.org>
parents:
diff changeset
3294 effectively do a @code{(setf @var{place} (cddr @var{place}))},
Dave Love <fx@gnu.org>
parents:
diff changeset
3295 whereas if it occurs later, this simply uses @code{setcdr} to splice
Dave Love <fx@gnu.org>
parents:
diff changeset
3296 out the property and value cells.
Dave Love <fx@gnu.org>
parents:
diff changeset
3297 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
3298
Dave Love <fx@gnu.org>
parents:
diff changeset
3299 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
3300 @secno=2
Dave Love <fx@gnu.org>
parents:
diff changeset
3301 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
3302
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
3303 @node Creating Symbols, , Property Lists, Symbols
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3304 @section Creating Symbols
Dave Love <fx@gnu.org>
parents:
diff changeset
3305
Dave Love <fx@gnu.org>
parents:
diff changeset
3306 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3307 These functions create unique symbols, typically for use as
Dave Love <fx@gnu.org>
parents:
diff changeset
3308 temporary variables.
Dave Love <fx@gnu.org>
parents:
diff changeset
3309
Dave Love <fx@gnu.org>
parents:
diff changeset
3310 @defun gensym &optional x
Dave Love <fx@gnu.org>
parents:
diff changeset
3311 This function creates a new, uninterned symbol (using @code{make-symbol})
Dave Love <fx@gnu.org>
parents:
diff changeset
3312 with a unique name. (The name of an uninterned symbol is relevant
Dave Love <fx@gnu.org>
parents:
diff changeset
3313 only if the symbol is printed.) By default, the name is generated
Dave Love <fx@gnu.org>
parents:
diff changeset
3314 from an increasing sequence of numbers, @samp{G1000}, @samp{G1001},
Dave Love <fx@gnu.org>
parents:
diff changeset
3315 @samp{G1002}, etc. If the optional argument @var{x} is a string, that
Dave Love <fx@gnu.org>
parents:
diff changeset
3316 string is used as a prefix instead of @samp{G}. Uninterned symbols
Dave Love <fx@gnu.org>
parents:
diff changeset
3317 are used in macro expansions for temporary variables, to ensure that
Dave Love <fx@gnu.org>
parents:
diff changeset
3318 their names will not conflict with ``real'' variables in the user's
Dave Love <fx@gnu.org>
parents:
diff changeset
3319 code.
Dave Love <fx@gnu.org>
parents:
diff changeset
3320 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3321
Dave Love <fx@gnu.org>
parents:
diff changeset
3322 @defvar *gensym-counter*
Dave Love <fx@gnu.org>
parents:
diff changeset
3323 This variable holds the counter used to generate @code{gensym} names.
Dave Love <fx@gnu.org>
parents:
diff changeset
3324 It is incremented after each use by @code{gensym}. In Common Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3325 this is initialized with 0, but this package initializes it with a
Dave Love <fx@gnu.org>
parents:
diff changeset
3326 random (time-dependent) value to avoid trouble when two files that
Dave Love <fx@gnu.org>
parents:
diff changeset
3327 each used @code{gensym} in their compilation are loaded together.
Dave Love <fx@gnu.org>
parents:
diff changeset
3328 (Uninterned symbols become interned when the compiler writes them
Dave Love <fx@gnu.org>
parents:
diff changeset
3329 out to a file and the Emacs loader loads them, so their names have to
Dave Love <fx@gnu.org>
parents:
diff changeset
3330 be treated a bit more carefully than in Common Lisp where uninterned
Dave Love <fx@gnu.org>
parents:
diff changeset
3331 symbols remain uninterned after loading.)
Dave Love <fx@gnu.org>
parents:
diff changeset
3332 @end defvar
Dave Love <fx@gnu.org>
parents:
diff changeset
3333
Dave Love <fx@gnu.org>
parents:
diff changeset
3334 @defun gentemp &optional x
Dave Love <fx@gnu.org>
parents:
diff changeset
3335 This function is like @code{gensym}, except that it produces a new
Dave Love <fx@gnu.org>
parents:
diff changeset
3336 @emph{interned} symbol. If the symbol that is generated already
Dave Love <fx@gnu.org>
parents:
diff changeset
3337 exists, the function keeps incrementing the counter and trying
Dave Love <fx@gnu.org>
parents:
diff changeset
3338 again until a new symbol is generated.
Dave Love <fx@gnu.org>
parents:
diff changeset
3339 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3340
Dave Love <fx@gnu.org>
parents:
diff changeset
3341 The Quiroz @file{cl.el} package also defined a @code{defkeyword}
Dave Love <fx@gnu.org>
parents:
diff changeset
3342 form for creating self-quoting keyword symbols. This package
Dave Love <fx@gnu.org>
parents:
diff changeset
3343 automatically creates all keywords that are called for by
Dave Love <fx@gnu.org>
parents:
diff changeset
3344 @code{&key} argument specifiers, and discourages the use of
Dave Love <fx@gnu.org>
parents:
diff changeset
3345 keywords as data unrelated to keyword arguments, so the
Dave Love <fx@gnu.org>
parents:
diff changeset
3346 @code{defkeyword} form has been discontinued.
Dave Love <fx@gnu.org>
parents:
diff changeset
3347
Dave Love <fx@gnu.org>
parents:
diff changeset
3348 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
3349 @chapno=11
Dave Love <fx@gnu.org>
parents:
diff changeset
3350 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
3351
Dave Love <fx@gnu.org>
parents:
diff changeset
3352 @node Numbers, Sequences, Symbols, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
3353 @chapter Numbers
Dave Love <fx@gnu.org>
parents:
diff changeset
3354
Dave Love <fx@gnu.org>
parents:
diff changeset
3355 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3356 This section defines a few simple Common Lisp operations on numbers
Dave Love <fx@gnu.org>
parents:
diff changeset
3357 which were left out of Emacs Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
3358
Dave Love <fx@gnu.org>
parents:
diff changeset
3359 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
3360 * Predicates on Numbers:: `plusp', `oddp', `floatp-safe', etc.
28039
c3a446101beb Remove references to rassoc, delete, expt.
Dave Love <fx@gnu.org>
parents: 27511
diff changeset
3361 * Numerical Functions:: `abs', `floor*', etc.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3362 * Random Numbers:: `random*', `make-random-state'
Dave Love <fx@gnu.org>
parents:
diff changeset
3363 * Implementation Parameters:: `most-positive-fixnum', `most-positive-float'
Dave Love <fx@gnu.org>
parents:
diff changeset
3364 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
3365
Dave Love <fx@gnu.org>
parents:
diff changeset
3366 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
3367 @secno=1
Dave Love <fx@gnu.org>
parents:
diff changeset
3368 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
3369
Dave Love <fx@gnu.org>
parents:
diff changeset
3370 @node Predicates on Numbers, Numerical Functions, Numbers, Numbers
Dave Love <fx@gnu.org>
parents:
diff changeset
3371 @section Predicates on Numbers
Dave Love <fx@gnu.org>
parents:
diff changeset
3372
Dave Love <fx@gnu.org>
parents:
diff changeset
3373 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3374 These functions return @code{t} if the specified condition is
Dave Love <fx@gnu.org>
parents:
diff changeset
3375 true of the numerical argument, or @code{nil} otherwise.
Dave Love <fx@gnu.org>
parents:
diff changeset
3376
Dave Love <fx@gnu.org>
parents:
diff changeset
3377 @defun plusp number
Dave Love <fx@gnu.org>
parents:
diff changeset
3378 This predicate tests whether @var{number} is positive. It is an
Dave Love <fx@gnu.org>
parents:
diff changeset
3379 error if the argument is not a number.
Dave Love <fx@gnu.org>
parents:
diff changeset
3380 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3381
Dave Love <fx@gnu.org>
parents:
diff changeset
3382 @defun minusp number
Dave Love <fx@gnu.org>
parents:
diff changeset
3383 This predicate tests whether @var{number} is negative. It is an
Dave Love <fx@gnu.org>
parents:
diff changeset
3384 error if the argument is not a number.
Dave Love <fx@gnu.org>
parents:
diff changeset
3385 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3386
Dave Love <fx@gnu.org>
parents:
diff changeset
3387 @defun oddp integer
Dave Love <fx@gnu.org>
parents:
diff changeset
3388 This predicate tests whether @var{integer} is odd. It is an
Dave Love <fx@gnu.org>
parents:
diff changeset
3389 error if the argument is not an integer.
Dave Love <fx@gnu.org>
parents:
diff changeset
3390 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3391
Dave Love <fx@gnu.org>
parents:
diff changeset
3392 @defun evenp integer
Dave Love <fx@gnu.org>
parents:
diff changeset
3393 This predicate tests whether @var{integer} is even. It is an
Dave Love <fx@gnu.org>
parents:
diff changeset
3394 error if the argument is not an integer.
Dave Love <fx@gnu.org>
parents:
diff changeset
3395 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3396
Dave Love <fx@gnu.org>
parents:
diff changeset
3397 @defun floatp-safe object
Dave Love <fx@gnu.org>
parents:
diff changeset
3398 This predicate tests whether @var{object} is a floating-point
Dave Love <fx@gnu.org>
parents:
diff changeset
3399 number. On systems that support floating-point, this is equivalent
Dave Love <fx@gnu.org>
parents:
diff changeset
3400 to @code{floatp}. On other systems, this always returns @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3401 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3402
Dave Love <fx@gnu.org>
parents:
diff changeset
3403 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
3404 @secno=3
Dave Love <fx@gnu.org>
parents:
diff changeset
3405 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
3406
Dave Love <fx@gnu.org>
parents:
diff changeset
3407 @node Numerical Functions, Random Numbers, Predicates on Numbers, Numbers
Dave Love <fx@gnu.org>
parents:
diff changeset
3408 @section Numerical Functions
Dave Love <fx@gnu.org>
parents:
diff changeset
3409
Dave Love <fx@gnu.org>
parents:
diff changeset
3410 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3411 These functions perform various arithmetic operations on numbers.
Dave Love <fx@gnu.org>
parents:
diff changeset
3412
Dave Love <fx@gnu.org>
parents:
diff changeset
3413 @defun gcd &rest integers
Dave Love <fx@gnu.org>
parents:
diff changeset
3414 This function returns the Greatest Common Divisor of the arguments.
Dave Love <fx@gnu.org>
parents:
diff changeset
3415 For one argument, it returns the absolute value of that argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
3416 For zero arguments, it returns zero.
Dave Love <fx@gnu.org>
parents:
diff changeset
3417 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3418
Dave Love <fx@gnu.org>
parents:
diff changeset
3419 @defun lcm &rest integers
Dave Love <fx@gnu.org>
parents:
diff changeset
3420 This function returns the Least Common Multiple of the arguments.
Dave Love <fx@gnu.org>
parents:
diff changeset
3421 For one argument, it returns the absolute value of that argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
3422 For zero arguments, it returns one.
Dave Love <fx@gnu.org>
parents:
diff changeset
3423 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3424
Dave Love <fx@gnu.org>
parents:
diff changeset
3425 @defun isqrt integer
Dave Love <fx@gnu.org>
parents:
diff changeset
3426 This function computes the ``integer square root'' of its integer
Dave Love <fx@gnu.org>
parents:
diff changeset
3427 argument, i.e., the greatest integer less than or equal to the true
Dave Love <fx@gnu.org>
parents:
diff changeset
3428 square root of the argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
3429 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3430
Dave Love <fx@gnu.org>
parents:
diff changeset
3431 @defun floor* number &optional divisor
Dave Love <fx@gnu.org>
parents:
diff changeset
3432 This function implements the Common Lisp @code{floor} function.
Dave Love <fx@gnu.org>
parents:
diff changeset
3433 It is called @code{floor*} to avoid name conflicts with the
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
3434 simpler @code{floor} function built-in to Emacs.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3435
Dave Love <fx@gnu.org>
parents:
diff changeset
3436 With one argument, @code{floor*} returns a list of two numbers:
Dave Love <fx@gnu.org>
parents:
diff changeset
3437 The argument rounded down (toward minus infinity) to an integer,
Dave Love <fx@gnu.org>
parents:
diff changeset
3438 and the ``remainder'' which would have to be added back to the
Dave Love <fx@gnu.org>
parents:
diff changeset
3439 first return value to yield the argument again. If the argument
Dave Love <fx@gnu.org>
parents:
diff changeset
3440 is an integer @var{x}, the result is always the list @code{(@var{x} 0)}.
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
3441 If the argument is a floating-point number, the first
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3442 result is a Lisp integer and the second is a Lisp float between
Dave Love <fx@gnu.org>
parents:
diff changeset
3443 0 (inclusive) and 1 (exclusive).
Dave Love <fx@gnu.org>
parents:
diff changeset
3444
Dave Love <fx@gnu.org>
parents:
diff changeset
3445 With two arguments, @code{floor*} divides @var{number} by
Dave Love <fx@gnu.org>
parents:
diff changeset
3446 @var{divisor}, and returns the floor of the quotient and the
Dave Love <fx@gnu.org>
parents:
diff changeset
3447 corresponding remainder as a list of two numbers. If
Dave Love <fx@gnu.org>
parents:
diff changeset
3448 @code{(floor* @var{x} @var{y})} returns @code{(@var{q} @var{r})},
Dave Love <fx@gnu.org>
parents:
diff changeset
3449 then @code{@var{q}*@var{y} + @var{r} = @var{x}}, with @var{r}
Dave Love <fx@gnu.org>
parents:
diff changeset
3450 between 0 (inclusive) and @var{r} (exclusive). Also, note
Dave Love <fx@gnu.org>
parents:
diff changeset
3451 that @code{(floor* @var{x})} is exactly equivalent to
Dave Love <fx@gnu.org>
parents:
diff changeset
3452 @code{(floor* @var{x} 1)}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3453
Dave Love <fx@gnu.org>
parents:
diff changeset
3454 This function is entirely compatible with Common Lisp's @code{floor}
Dave Love <fx@gnu.org>
parents:
diff changeset
3455 function, except that it returns the two results in a list since
Dave Love <fx@gnu.org>
parents:
diff changeset
3456 Emacs Lisp does not support multiple-valued functions.
Dave Love <fx@gnu.org>
parents:
diff changeset
3457 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3458
Dave Love <fx@gnu.org>
parents:
diff changeset
3459 @defun ceiling* number &optional divisor
Dave Love <fx@gnu.org>
parents:
diff changeset
3460 This function implements the Common Lisp @code{ceiling} function,
Dave Love <fx@gnu.org>
parents:
diff changeset
3461 which is analogous to @code{floor} except that it rounds the
Dave Love <fx@gnu.org>
parents:
diff changeset
3462 argument or quotient of the arguments up toward plus infinity.
Dave Love <fx@gnu.org>
parents:
diff changeset
3463 The remainder will be between 0 and minus @var{r}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3464 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3465
Dave Love <fx@gnu.org>
parents:
diff changeset
3466 @defun truncate* number &optional divisor
Dave Love <fx@gnu.org>
parents:
diff changeset
3467 This function implements the Common Lisp @code{truncate} function,
Dave Love <fx@gnu.org>
parents:
diff changeset
3468 which is analogous to @code{floor} except that it rounds the
Dave Love <fx@gnu.org>
parents:
diff changeset
3469 argument or quotient of the arguments toward zero. Thus it is
Dave Love <fx@gnu.org>
parents:
diff changeset
3470 equivalent to @code{floor*} if the argument or quotient is
Dave Love <fx@gnu.org>
parents:
diff changeset
3471 positive, or to @code{ceiling*} otherwise. The remainder has
Dave Love <fx@gnu.org>
parents:
diff changeset
3472 the same sign as @var{number}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3473 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3474
Dave Love <fx@gnu.org>
parents:
diff changeset
3475 @defun round* number &optional divisor
Dave Love <fx@gnu.org>
parents:
diff changeset
3476 This function implements the Common Lisp @code{round} function,
Dave Love <fx@gnu.org>
parents:
diff changeset
3477 which is analogous to @code{floor} except that it rounds the
Dave Love <fx@gnu.org>
parents:
diff changeset
3478 argument or quotient of the arguments to the nearest integer.
Dave Love <fx@gnu.org>
parents:
diff changeset
3479 In the case of a tie (the argument or quotient is exactly
Dave Love <fx@gnu.org>
parents:
diff changeset
3480 halfway between two integers), it rounds to the even integer.
Dave Love <fx@gnu.org>
parents:
diff changeset
3481 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3482
Dave Love <fx@gnu.org>
parents:
diff changeset
3483 @defun mod* number divisor
Dave Love <fx@gnu.org>
parents:
diff changeset
3484 This function returns the same value as the second return value
Dave Love <fx@gnu.org>
parents:
diff changeset
3485 of @code{floor}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3486 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3487
Dave Love <fx@gnu.org>
parents:
diff changeset
3488 @defun rem* number divisor
Dave Love <fx@gnu.org>
parents:
diff changeset
3489 This function returns the same value as the second return value
Dave Love <fx@gnu.org>
parents:
diff changeset
3490 of @code{truncate}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3491 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3492
Dave Love <fx@gnu.org>
parents:
diff changeset
3493 These definitions are compatible with those in the Quiroz
Dave Love <fx@gnu.org>
parents:
diff changeset
3494 @file{cl.el} package, except that this package appends @samp{*}
Dave Love <fx@gnu.org>
parents:
diff changeset
3495 to certain function names to avoid conflicts with existing
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
3496 Emacs functions, and that the mechanism for returning
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3497 multiple values is different.
Dave Love <fx@gnu.org>
parents:
diff changeset
3498
Dave Love <fx@gnu.org>
parents:
diff changeset
3499 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
3500 @secno=8
Dave Love <fx@gnu.org>
parents:
diff changeset
3501 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
3502
Dave Love <fx@gnu.org>
parents:
diff changeset
3503 @node Random Numbers, Implementation Parameters, Numerical Functions, Numbers
Dave Love <fx@gnu.org>
parents:
diff changeset
3504 @section Random Numbers
Dave Love <fx@gnu.org>
parents:
diff changeset
3505
Dave Love <fx@gnu.org>
parents:
diff changeset
3506 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3507 This package also provides an implementation of the Common Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3508 random number generator. It uses its own additive-congruential
Dave Love <fx@gnu.org>
parents:
diff changeset
3509 algorithm, which is much more likely to give statistically clean
Dave Love <fx@gnu.org>
parents:
diff changeset
3510 random numbers than the simple generators supplied by many
Dave Love <fx@gnu.org>
parents:
diff changeset
3511 operating systems.
Dave Love <fx@gnu.org>
parents:
diff changeset
3512
Dave Love <fx@gnu.org>
parents:
diff changeset
3513 @defun random* number &optional state
Dave Love <fx@gnu.org>
parents:
diff changeset
3514 This function returns a random nonnegative number less than
Dave Love <fx@gnu.org>
parents:
diff changeset
3515 @var{number}, and of the same type (either integer or floating-point).
Dave Love <fx@gnu.org>
parents:
diff changeset
3516 The @var{state} argument should be a @code{random-state} object
Dave Love <fx@gnu.org>
parents:
diff changeset
3517 which holds the state of the random number generator. The
Dave Love <fx@gnu.org>
parents:
diff changeset
3518 function modifies this state object as a side effect. If
Dave Love <fx@gnu.org>
parents:
diff changeset
3519 @var{state} is omitted, it defaults to the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
3520 @code{*random-state*}, which contains a pre-initialized
Dave Love <fx@gnu.org>
parents:
diff changeset
3521 @code{random-state} object.
Dave Love <fx@gnu.org>
parents:
diff changeset
3522 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3523
Dave Love <fx@gnu.org>
parents:
diff changeset
3524 @defvar *random-state*
Dave Love <fx@gnu.org>
parents:
diff changeset
3525 This variable contains the system ``default'' @code{random-state}
Dave Love <fx@gnu.org>
parents:
diff changeset
3526 object, used for calls to @code{random*} that do not specify an
Dave Love <fx@gnu.org>
parents:
diff changeset
3527 alternative state object. Since any number of programs in the
Dave Love <fx@gnu.org>
parents:
diff changeset
3528 Emacs process may be accessing @code{*random-state*} in interleaved
Dave Love <fx@gnu.org>
parents:
diff changeset
3529 fashion, the sequence generated from this variable will be
Dave Love <fx@gnu.org>
parents:
diff changeset
3530 irreproducible for all intents and purposes.
Dave Love <fx@gnu.org>
parents:
diff changeset
3531 @end defvar
Dave Love <fx@gnu.org>
parents:
diff changeset
3532
Dave Love <fx@gnu.org>
parents:
diff changeset
3533 @defun make-random-state &optional state
Dave Love <fx@gnu.org>
parents:
diff changeset
3534 This function creates or copies a @code{random-state} object.
Dave Love <fx@gnu.org>
parents:
diff changeset
3535 If @var{state} is omitted or @code{nil}, it returns a new copy of
Dave Love <fx@gnu.org>
parents:
diff changeset
3536 @code{*random-state*}. This is a copy in the sense that future
Dave Love <fx@gnu.org>
parents:
diff changeset
3537 sequences of calls to @code{(random* @var{n})} and
Dave Love <fx@gnu.org>
parents:
diff changeset
3538 @code{(random* @var{n} @var{s})} (where @var{s} is the new
Dave Love <fx@gnu.org>
parents:
diff changeset
3539 random-state object) will return identical sequences of random
Dave Love <fx@gnu.org>
parents:
diff changeset
3540 numbers.
Dave Love <fx@gnu.org>
parents:
diff changeset
3541
Dave Love <fx@gnu.org>
parents:
diff changeset
3542 If @var{state} is a @code{random-state} object, this function
Dave Love <fx@gnu.org>
parents:
diff changeset
3543 returns a copy of that object. If @var{state} is @code{t}, this
Dave Love <fx@gnu.org>
parents:
diff changeset
3544 function returns a new @code{random-state} object seeded from the
Dave Love <fx@gnu.org>
parents:
diff changeset
3545 date and time. As an extension to Common Lisp, @var{state} may also
Dave Love <fx@gnu.org>
parents:
diff changeset
3546 be an integer in which case the new object is seeded from that
Dave Love <fx@gnu.org>
parents:
diff changeset
3547 integer; each different integer seed will result in a completely
Dave Love <fx@gnu.org>
parents:
diff changeset
3548 different sequence of random numbers.
Dave Love <fx@gnu.org>
parents:
diff changeset
3549
Dave Love <fx@gnu.org>
parents:
diff changeset
3550 It is legal to print a @code{random-state} object to a buffer or
Dave Love <fx@gnu.org>
parents:
diff changeset
3551 file and later read it back with @code{read}. If a program wishes
Dave Love <fx@gnu.org>
parents:
diff changeset
3552 to use a sequence of pseudo-random numbers which can be reproduced
Dave Love <fx@gnu.org>
parents:
diff changeset
3553 later for debugging, it can call @code{(make-random-state t)} to
Dave Love <fx@gnu.org>
parents:
diff changeset
3554 get a new sequence, then print this sequence to a file. When the
Dave Love <fx@gnu.org>
parents:
diff changeset
3555 program is later rerun, it can read the original run's random-state
Dave Love <fx@gnu.org>
parents:
diff changeset
3556 from the file.
Dave Love <fx@gnu.org>
parents:
diff changeset
3557 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3558
Dave Love <fx@gnu.org>
parents:
diff changeset
3559 @defun random-state-p object
Dave Love <fx@gnu.org>
parents:
diff changeset
3560 This predicate returns @code{t} if @var{object} is a
Dave Love <fx@gnu.org>
parents:
diff changeset
3561 @code{random-state} object, or @code{nil} otherwise.
Dave Love <fx@gnu.org>
parents:
diff changeset
3562 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3563
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
3564 @node Implementation Parameters, , Random Numbers, Numbers
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3565 @section Implementation Parameters
Dave Love <fx@gnu.org>
parents:
diff changeset
3566
Dave Love <fx@gnu.org>
parents:
diff changeset
3567 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3568 This package defines several useful constants having to with numbers.
Dave Love <fx@gnu.org>
parents:
diff changeset
3569
Dave Love <fx@gnu.org>
parents:
diff changeset
3570 @defvar most-positive-fixnum
Dave Love <fx@gnu.org>
parents:
diff changeset
3571 This constant equals the largest value a Lisp integer can hold.
Dave Love <fx@gnu.org>
parents:
diff changeset
3572 It is typically @code{2^23-1} or @code{2^25-1}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3573 @end defvar
Dave Love <fx@gnu.org>
parents:
diff changeset
3574
Dave Love <fx@gnu.org>
parents:
diff changeset
3575 @defvar most-negative-fixnum
Dave Love <fx@gnu.org>
parents:
diff changeset
3576 This constant equals the smallest (most negative) value a Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3577 integer can hold.
Dave Love <fx@gnu.org>
parents:
diff changeset
3578 @end defvar
Dave Love <fx@gnu.org>
parents:
diff changeset
3579
Dave Love <fx@gnu.org>
parents:
diff changeset
3580 The following parameters have to do with floating-point numbers.
Dave Love <fx@gnu.org>
parents:
diff changeset
3581 This package determines their values by exercising the computer's
Dave Love <fx@gnu.org>
parents:
diff changeset
3582 floating-point arithmetic in various ways. Because this operation
Dave Love <fx@gnu.org>
parents:
diff changeset
3583 might be slow, the code for initializing them is kept in a separate
Dave Love <fx@gnu.org>
parents:
diff changeset
3584 function that must be called before the parameters can be used.
Dave Love <fx@gnu.org>
parents:
diff changeset
3585
Dave Love <fx@gnu.org>
parents:
diff changeset
3586 @defun cl-float-limits
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
3587 This function makes sure that the Common Lisp floating-point parameters
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
3588 like @code{most-positive-float} have been initialized. Until it is
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
3589 called, these parameters will be @code{nil}. If this version of Emacs
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
3590 does not support floats, the parameters will remain @code{nil}. If the
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
3591 parameters have already been initialized, the function returns
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
3592 immediately.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3593
Dave Love <fx@gnu.org>
parents:
diff changeset
3594 The algorithm makes assumptions that will be valid for most modern
Dave Love <fx@gnu.org>
parents:
diff changeset
3595 machines, but will fail if the machine's arithmetic is extremely
Dave Love <fx@gnu.org>
parents:
diff changeset
3596 unusual, e.g., decimal.
Dave Love <fx@gnu.org>
parents:
diff changeset
3597 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3598
Dave Love <fx@gnu.org>
parents:
diff changeset
3599 Since true Common Lisp supports up to four different floating-point
Dave Love <fx@gnu.org>
parents:
diff changeset
3600 precisions, it has families of constants like
Dave Love <fx@gnu.org>
parents:
diff changeset
3601 @code{most-positive-single-float}, @code{most-positive-double-float},
Dave Love <fx@gnu.org>
parents:
diff changeset
3602 @code{most-positive-long-float}, and so on. Emacs has only one
Dave Love <fx@gnu.org>
parents:
diff changeset
3603 floating-point precision, so this package omits the precision word
Dave Love <fx@gnu.org>
parents:
diff changeset
3604 from the constants' names.
Dave Love <fx@gnu.org>
parents:
diff changeset
3605
Dave Love <fx@gnu.org>
parents:
diff changeset
3606 @defvar most-positive-float
Dave Love <fx@gnu.org>
parents:
diff changeset
3607 This constant equals the largest value a Lisp float can hold.
Dave Love <fx@gnu.org>
parents:
diff changeset
3608 For those systems whose arithmetic supports infinities, this is
Dave Love <fx@gnu.org>
parents:
diff changeset
3609 the largest @emph{finite} value. For IEEE machines, the value
Dave Love <fx@gnu.org>
parents:
diff changeset
3610 is approximately @code{1.79e+308}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3611 @end defvar
Dave Love <fx@gnu.org>
parents:
diff changeset
3612
Dave Love <fx@gnu.org>
parents:
diff changeset
3613 @defvar most-negative-float
Dave Love <fx@gnu.org>
parents:
diff changeset
3614 This constant equals the most-negative value a Lisp float can hold.
Dave Love <fx@gnu.org>
parents:
diff changeset
3615 (It is assumed to be equal to @code{(- most-positive-float)}.)
Dave Love <fx@gnu.org>
parents:
diff changeset
3616 @end defvar
Dave Love <fx@gnu.org>
parents:
diff changeset
3617
Dave Love <fx@gnu.org>
parents:
diff changeset
3618 @defvar least-positive-float
Dave Love <fx@gnu.org>
parents:
diff changeset
3619 This constant equals the smallest Lisp float value greater than zero.
Dave Love <fx@gnu.org>
parents:
diff changeset
3620 For IEEE machines, it is about @code{4.94e-324} if denormals are
Dave Love <fx@gnu.org>
parents:
diff changeset
3621 supported or @code{2.22e-308} if not.
Dave Love <fx@gnu.org>
parents:
diff changeset
3622 @end defvar
Dave Love <fx@gnu.org>
parents:
diff changeset
3623
Dave Love <fx@gnu.org>
parents:
diff changeset
3624 @defvar least-positive-normalized-float
Dave Love <fx@gnu.org>
parents:
diff changeset
3625 This constant equals the smallest @emph{normalized} Lisp float greater
Dave Love <fx@gnu.org>
parents:
diff changeset
3626 than zero, i.e., the smallest value for which IEEE denormalization
Dave Love <fx@gnu.org>
parents:
diff changeset
3627 will not result in a loss of precision. For IEEE machines, this
Dave Love <fx@gnu.org>
parents:
diff changeset
3628 value is about @code{2.22e-308}. For machines that do not support
Dave Love <fx@gnu.org>
parents:
diff changeset
3629 the concept of denormalization and gradual underflow, this constant
Dave Love <fx@gnu.org>
parents:
diff changeset
3630 will always equal @code{least-positive-float}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3631 @end defvar
Dave Love <fx@gnu.org>
parents:
diff changeset
3632
Dave Love <fx@gnu.org>
parents:
diff changeset
3633 @defvar least-negative-float
Dave Love <fx@gnu.org>
parents:
diff changeset
3634 This constant is the negative counterpart of @code{least-positive-float}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3635 @end defvar
Dave Love <fx@gnu.org>
parents:
diff changeset
3636
Dave Love <fx@gnu.org>
parents:
diff changeset
3637 @defvar least-negative-normalized-float
Dave Love <fx@gnu.org>
parents:
diff changeset
3638 This constant is the negative counterpart of
Dave Love <fx@gnu.org>
parents:
diff changeset
3639 @code{least-positive-normalized-float}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3640 @end defvar
Dave Love <fx@gnu.org>
parents:
diff changeset
3641
Dave Love <fx@gnu.org>
parents:
diff changeset
3642 @defvar float-epsilon
Dave Love <fx@gnu.org>
parents:
diff changeset
3643 This constant is the smallest positive Lisp float that can be added
Dave Love <fx@gnu.org>
parents:
diff changeset
3644 to 1.0 to produce a distinct value. Adding a smaller number to 1.0
Dave Love <fx@gnu.org>
parents:
diff changeset
3645 will yield 1.0 again due to roundoff. For IEEE machines, epsilon
Dave Love <fx@gnu.org>
parents:
diff changeset
3646 is about @code{2.22e-16}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3647 @end defvar
Dave Love <fx@gnu.org>
parents:
diff changeset
3648
Dave Love <fx@gnu.org>
parents:
diff changeset
3649 @defvar float-negative-epsilon
Dave Love <fx@gnu.org>
parents:
diff changeset
3650 This is the smallest positive value that can be subtracted from
Dave Love <fx@gnu.org>
parents:
diff changeset
3651 1.0 to produce a distinct value. For IEEE machines, it is about
Dave Love <fx@gnu.org>
parents:
diff changeset
3652 @code{1.11e-16}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3653 @end defvar
Dave Love <fx@gnu.org>
parents:
diff changeset
3654
Dave Love <fx@gnu.org>
parents:
diff changeset
3655 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
3656 @chapno=13
Dave Love <fx@gnu.org>
parents:
diff changeset
3657 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
3658
Dave Love <fx@gnu.org>
parents:
diff changeset
3659 @node Sequences, Lists, Numbers, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
3660 @chapter Sequences
Dave Love <fx@gnu.org>
parents:
diff changeset
3661
Dave Love <fx@gnu.org>
parents:
diff changeset
3662 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3663 Common Lisp defines a number of functions that operate on
Dave Love <fx@gnu.org>
parents:
diff changeset
3664 @dfn{sequences}, which are either lists, strings, or vectors.
Dave Love <fx@gnu.org>
parents:
diff changeset
3665 Emacs Lisp includes a few of these, notably @code{elt} and
Dave Love <fx@gnu.org>
parents:
diff changeset
3666 @code{length}; this package defines most of the rest.
Dave Love <fx@gnu.org>
parents:
diff changeset
3667
Dave Love <fx@gnu.org>
parents:
diff changeset
3668 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
3669 * Sequence Basics:: Arguments shared by all sequence functions
Dave Love <fx@gnu.org>
parents:
diff changeset
3670 * Mapping over Sequences:: `mapcar*', `mapcan', `map', `every', etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
3671 * Sequence Functions:: `subseq', `remove*', `substitute', etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
3672 * Searching Sequences:: `find', `position', `count', `search', etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
3673 * Sorting Sequences:: `sort*', `stable-sort', `merge'
Dave Love <fx@gnu.org>
parents:
diff changeset
3674 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
3675
Dave Love <fx@gnu.org>
parents:
diff changeset
3676 @node Sequence Basics, Mapping over Sequences, Sequences, Sequences
Dave Love <fx@gnu.org>
parents:
diff changeset
3677 @section Sequence Basics
Dave Love <fx@gnu.org>
parents:
diff changeset
3678
Dave Love <fx@gnu.org>
parents:
diff changeset
3679 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3680 Many of the sequence functions take keyword arguments; @pxref{Argument
Dave Love <fx@gnu.org>
parents:
diff changeset
3681 Lists}. All keyword arguments are optional and, if specified,
Dave Love <fx@gnu.org>
parents:
diff changeset
3682 may appear in any order.
Dave Love <fx@gnu.org>
parents:
diff changeset
3683
Dave Love <fx@gnu.org>
parents:
diff changeset
3684 The @code{:key} argument should be passed either @code{nil}, or a
Dave Love <fx@gnu.org>
parents:
diff changeset
3685 function of one argument. This key function is used as a filter
Dave Love <fx@gnu.org>
parents:
diff changeset
3686 through which the elements of the sequence are seen; for example,
Dave Love <fx@gnu.org>
parents:
diff changeset
3687 @code{(find x y :key 'car)} is similar to @code{(assoc* x y)}:
Dave Love <fx@gnu.org>
parents:
diff changeset
3688 It searches for an element of the list whose @code{car} equals
Dave Love <fx@gnu.org>
parents:
diff changeset
3689 @code{x}, rather than for an element which equals @code{x} itself.
Dave Love <fx@gnu.org>
parents:
diff changeset
3690 If @code{:key} is omitted or @code{nil}, the filter is effectively
Dave Love <fx@gnu.org>
parents:
diff changeset
3691 the identity function.
Dave Love <fx@gnu.org>
parents:
diff changeset
3692
Dave Love <fx@gnu.org>
parents:
diff changeset
3693 The @code{:test} and @code{:test-not} arguments should be either
Dave Love <fx@gnu.org>
parents:
diff changeset
3694 @code{nil}, or functions of two arguments. The test function is
Dave Love <fx@gnu.org>
parents:
diff changeset
3695 used to compare two sequence elements, or to compare a search value
Dave Love <fx@gnu.org>
parents:
diff changeset
3696 with sequence elements. (The two values are passed to the test
Dave Love <fx@gnu.org>
parents:
diff changeset
3697 function in the same order as the original sequence function
Dave Love <fx@gnu.org>
parents:
diff changeset
3698 arguments from which they are derived, or, if they both come from
Dave Love <fx@gnu.org>
parents:
diff changeset
3699 the same sequence, in the same order as they appear in that sequence.)
Dave Love <fx@gnu.org>
parents:
diff changeset
3700 The @code{:test} argument specifies a function which must return
Dave Love <fx@gnu.org>
parents:
diff changeset
3701 true (non-@code{nil}) to indicate a match; instead, you may use
Dave Love <fx@gnu.org>
parents:
diff changeset
3702 @code{:test-not} to give a function which returns @emph{false} to
Dave Love <fx@gnu.org>
parents:
diff changeset
3703 indicate a match. The default test function is @code{:test 'eql}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3704
Dave Love <fx@gnu.org>
parents:
diff changeset
3705 Many functions which take @var{item} and @code{:test} or @code{:test-not}
Dave Love <fx@gnu.org>
parents:
diff changeset
3706 arguments also come in @code{-if} and @code{-if-not} varieties,
Dave Love <fx@gnu.org>
parents:
diff changeset
3707 where a @var{predicate} function is passed instead of @var{item},
Dave Love <fx@gnu.org>
parents:
diff changeset
3708 and sequence elements match if the predicate returns true on them
Dave Love <fx@gnu.org>
parents:
diff changeset
3709 (or false in the case of @code{-if-not}). For example:
Dave Love <fx@gnu.org>
parents:
diff changeset
3710
Dave Love <fx@gnu.org>
parents:
diff changeset
3711 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3712 (remove* 0 seq :test '=) @equiv{} (remove-if 'zerop seq)
Dave Love <fx@gnu.org>
parents:
diff changeset
3713 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3714
Dave Love <fx@gnu.org>
parents:
diff changeset
3715 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3716 to remove all zeros from sequence @code{seq}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3717
Dave Love <fx@gnu.org>
parents:
diff changeset
3718 Some operations can work on a subsequence of the argument sequence;
Dave Love <fx@gnu.org>
parents:
diff changeset
3719 these function take @code{:start} and @code{:end} arguments which
Dave Love <fx@gnu.org>
parents:
diff changeset
3720 default to zero and the length of the sequence, respectively.
Dave Love <fx@gnu.org>
parents:
diff changeset
3721 Only elements between @var{start} (inclusive) and @var{end}
Dave Love <fx@gnu.org>
parents:
diff changeset
3722 (exclusive) are affected by the operation. The @var{end} argument
Dave Love <fx@gnu.org>
parents:
diff changeset
3723 may be passed @code{nil} to signify the length of the sequence;
Dave Love <fx@gnu.org>
parents:
diff changeset
3724 otherwise, both @var{start} and @var{end} must be integers, with
Dave Love <fx@gnu.org>
parents:
diff changeset
3725 @code{0 <= @var{start} <= @var{end} <= (length @var{seq})}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3726 If the function takes two sequence arguments, the limits are
Dave Love <fx@gnu.org>
parents:
diff changeset
3727 defined by keywords @code{:start1} and @code{:end1} for the first,
Dave Love <fx@gnu.org>
parents:
diff changeset
3728 and @code{:start2} and @code{:end2} for the second.
Dave Love <fx@gnu.org>
parents:
diff changeset
3729
Dave Love <fx@gnu.org>
parents:
diff changeset
3730 A few functions accept a @code{:from-end} argument, which, if
Dave Love <fx@gnu.org>
parents:
diff changeset
3731 non-@code{nil}, causes the operation to go from right-to-left
Dave Love <fx@gnu.org>
parents:
diff changeset
3732 through the sequence instead of left-to-right, and a @code{:count}
Dave Love <fx@gnu.org>
parents:
diff changeset
3733 argument, which specifies an integer maximum number of elements
Dave Love <fx@gnu.org>
parents:
diff changeset
3734 to be removed or otherwise processed.
Dave Love <fx@gnu.org>
parents:
diff changeset
3735
Dave Love <fx@gnu.org>
parents:
diff changeset
3736 The sequence functions make no guarantees about the order in
Dave Love <fx@gnu.org>
parents:
diff changeset
3737 which the @code{:test}, @code{:test-not}, and @code{:key} functions
Dave Love <fx@gnu.org>
parents:
diff changeset
3738 are called on various elements. Therefore, it is a bad idea to depend
Dave Love <fx@gnu.org>
parents:
diff changeset
3739 on side effects of these functions. For example, @code{:from-end}
Dave Love <fx@gnu.org>
parents:
diff changeset
3740 may cause the sequence to be scanned actually in reverse, or it may
Dave Love <fx@gnu.org>
parents:
diff changeset
3741 be scanned forwards but computing a result ``as if'' it were scanned
Dave Love <fx@gnu.org>
parents:
diff changeset
3742 backwards. (Some functions, like @code{mapcar*} and @code{every},
Dave Love <fx@gnu.org>
parents:
diff changeset
3743 @emph{do} specify exactly the order in which the function is called
Dave Love <fx@gnu.org>
parents:
diff changeset
3744 so side effects are perfectly acceptable in those cases.)
Dave Love <fx@gnu.org>
parents:
diff changeset
3745
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
3746 Strings may contain ``text properties'' as well
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3747 as character data. Except as noted, it is undefined whether or
Dave Love <fx@gnu.org>
parents:
diff changeset
3748 not text properties are preserved by sequence functions. For
Dave Love <fx@gnu.org>
parents:
diff changeset
3749 example, @code{(remove* ?A @var{str})} may or may not preserve
Dave Love <fx@gnu.org>
parents:
diff changeset
3750 the properties of the characters copied from @var{str} into the
Dave Love <fx@gnu.org>
parents:
diff changeset
3751 result.
Dave Love <fx@gnu.org>
parents:
diff changeset
3752
Dave Love <fx@gnu.org>
parents:
diff changeset
3753 @node Mapping over Sequences, Sequence Functions, Sequence Basics, Sequences
Dave Love <fx@gnu.org>
parents:
diff changeset
3754 @section Mapping over Sequences
Dave Love <fx@gnu.org>
parents:
diff changeset
3755
Dave Love <fx@gnu.org>
parents:
diff changeset
3756 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3757 These functions ``map'' the function you specify over the elements
Dave Love <fx@gnu.org>
parents:
diff changeset
3758 of lists or arrays. They are all variations on the theme of the
Dave Love <fx@gnu.org>
parents:
diff changeset
3759 built-in function @code{mapcar}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3760
Dave Love <fx@gnu.org>
parents:
diff changeset
3761 @defun mapcar* function seq &rest more-seqs
Dave Love <fx@gnu.org>
parents:
diff changeset
3762 This function calls @var{function} on successive parallel sets of
Dave Love <fx@gnu.org>
parents:
diff changeset
3763 elements from its argument sequences. Given a single @var{seq}
Dave Love <fx@gnu.org>
parents:
diff changeset
3764 argument it is equivalent to @code{mapcar}; given @var{n} sequences,
Dave Love <fx@gnu.org>
parents:
diff changeset
3765 it calls the function with the first elements of each of the sequences
Dave Love <fx@gnu.org>
parents:
diff changeset
3766 as the @var{n} arguments to yield the first element of the result
Dave Love <fx@gnu.org>
parents:
diff changeset
3767 list, then with the second elements, and so on. The mapping stops as
Dave Love <fx@gnu.org>
parents:
diff changeset
3768 soon as the shortest sequence runs out. The argument sequences may
Dave Love <fx@gnu.org>
parents:
diff changeset
3769 be any mixture of lists, strings, and vectors; the return sequence
Dave Love <fx@gnu.org>
parents:
diff changeset
3770 is always a list.
Dave Love <fx@gnu.org>
parents:
diff changeset
3771
Dave Love <fx@gnu.org>
parents:
diff changeset
3772 Common Lisp's @code{mapcar} accepts multiple arguments but works
Dave Love <fx@gnu.org>
parents:
diff changeset
3773 only on lists; Emacs Lisp's @code{mapcar} accepts a single sequence
Dave Love <fx@gnu.org>
parents:
diff changeset
3774 argument. This package's @code{mapcar*} works as a compatible
Dave Love <fx@gnu.org>
parents:
diff changeset
3775 superset of both.
Dave Love <fx@gnu.org>
parents:
diff changeset
3776 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3777
Dave Love <fx@gnu.org>
parents:
diff changeset
3778 @defun map result-type function seq &rest more-seqs
Dave Love <fx@gnu.org>
parents:
diff changeset
3779 This function maps @var{function} over the argument sequences,
Dave Love <fx@gnu.org>
parents:
diff changeset
3780 just like @code{mapcar*}, but it returns a sequence of type
Dave Love <fx@gnu.org>
parents:
diff changeset
3781 @var{result-type} rather than a list. @var{result-type} must
Dave Love <fx@gnu.org>
parents:
diff changeset
3782 be one of the following symbols: @code{vector}, @code{string},
Dave Love <fx@gnu.org>
parents:
diff changeset
3783 @code{list} (in which case the effect is the same as for
Dave Love <fx@gnu.org>
parents:
diff changeset
3784 @code{mapcar*}), or @code{nil} (in which case the results are
Dave Love <fx@gnu.org>
parents:
diff changeset
3785 thrown away and @code{map} returns @code{nil}).
Dave Love <fx@gnu.org>
parents:
diff changeset
3786 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3787
Dave Love <fx@gnu.org>
parents:
diff changeset
3788 @defun maplist function list &rest more-lists
Dave Love <fx@gnu.org>
parents:
diff changeset
3789 This function calls @var{function} on each of its argument lists,
Dave Love <fx@gnu.org>
parents:
diff changeset
3790 then on the @code{cdr}s of those lists, and so on, until the
Dave Love <fx@gnu.org>
parents:
diff changeset
3791 shortest list runs out. The results are returned in the form
Dave Love <fx@gnu.org>
parents:
diff changeset
3792 of a list. Thus, @code{maplist} is like @code{mapcar*} except
Dave Love <fx@gnu.org>
parents:
diff changeset
3793 that it passes in the list pointers themselves rather than the
Dave Love <fx@gnu.org>
parents:
diff changeset
3794 @code{car}s of the advancing pointers.
Dave Love <fx@gnu.org>
parents:
diff changeset
3795 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3796
Dave Love <fx@gnu.org>
parents:
diff changeset
3797 @defun mapc function seq &rest more-seqs
36931
508fd85ab816 expurgate last*
Dave Love <fx@gnu.org>
parents: 35089
diff changeset
3798 This function is like @code{mapcar*}, except that the values returned
508fd85ab816 expurgate last*
Dave Love <fx@gnu.org>
parents: 35089
diff changeset
3799 by @var{function} are ignored and thrown away rather than being
508fd85ab816 expurgate last*
Dave Love <fx@gnu.org>
parents: 35089
diff changeset
3800 collected into a list. The return value of @code{mapc} is @var{seq},
508fd85ab816 expurgate last*
Dave Love <fx@gnu.org>
parents: 35089
diff changeset
3801 the first sequence. This function is more general than the Emacs
508fd85ab816 expurgate last*
Dave Love <fx@gnu.org>
parents: 35089
diff changeset
3802 primitive @code{mapc}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3803 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3804
Dave Love <fx@gnu.org>
parents:
diff changeset
3805 @defun mapl function list &rest more-lists
Dave Love <fx@gnu.org>
parents:
diff changeset
3806 This function is like @code{maplist}, except that it throws away
Dave Love <fx@gnu.org>
parents:
diff changeset
3807 the values returned by @var{function}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3808 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3809
Dave Love <fx@gnu.org>
parents:
diff changeset
3810 @defun mapcan function seq &rest more-seqs
Dave Love <fx@gnu.org>
parents:
diff changeset
3811 This function is like @code{mapcar*}, except that it concatenates
Dave Love <fx@gnu.org>
parents:
diff changeset
3812 the return values (which must be lists) using @code{nconc},
Dave Love <fx@gnu.org>
parents:
diff changeset
3813 rather than simply collecting them into a list.
Dave Love <fx@gnu.org>
parents:
diff changeset
3814 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3815
Dave Love <fx@gnu.org>
parents:
diff changeset
3816 @defun mapcon function list &rest more-lists
Dave Love <fx@gnu.org>
parents:
diff changeset
3817 This function is like @code{maplist}, except that it concatenates
Dave Love <fx@gnu.org>
parents:
diff changeset
3818 the return values using @code{nconc}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3819 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3820
Dave Love <fx@gnu.org>
parents:
diff changeset
3821 @defun some predicate seq &rest more-seqs
Dave Love <fx@gnu.org>
parents:
diff changeset
3822 This function calls @var{predicate} on each element of @var{seq}
Dave Love <fx@gnu.org>
parents:
diff changeset
3823 in turn; if @var{predicate} returns a non-@code{nil} value,
Dave Love <fx@gnu.org>
parents:
diff changeset
3824 @code{some} returns that value, otherwise it returns @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3825 Given several sequence arguments, it steps through the sequences
Dave Love <fx@gnu.org>
parents:
diff changeset
3826 in parallel until the shortest one runs out, just as in
Dave Love <fx@gnu.org>
parents:
diff changeset
3827 @code{mapcar*}. You can rely on the left-to-right order in which
Dave Love <fx@gnu.org>
parents:
diff changeset
3828 the elements are visited, and on the fact that mapping stops
Dave Love <fx@gnu.org>
parents:
diff changeset
3829 immediately as soon as @var{predicate} returns non-@code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3830 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3831
Dave Love <fx@gnu.org>
parents:
diff changeset
3832 @defun every predicate seq &rest more-seqs
Dave Love <fx@gnu.org>
parents:
diff changeset
3833 This function calls @var{predicate} on each element of the sequence(s)
Dave Love <fx@gnu.org>
parents:
diff changeset
3834 in turn; it returns @code{nil} as soon as @var{predicate} returns
Dave Love <fx@gnu.org>
parents:
diff changeset
3835 @code{nil} for any element, or @code{t} if the predicate was true
Dave Love <fx@gnu.org>
parents:
diff changeset
3836 for all elements.
Dave Love <fx@gnu.org>
parents:
diff changeset
3837 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3838
Dave Love <fx@gnu.org>
parents:
diff changeset
3839 @defun notany predicate seq &rest more-seqs
Dave Love <fx@gnu.org>
parents:
diff changeset
3840 This function calls @var{predicate} on each element of the sequence(s)
Dave Love <fx@gnu.org>
parents:
diff changeset
3841 in turn; it returns @code{nil} as soon as @var{predicate} returns
Dave Love <fx@gnu.org>
parents:
diff changeset
3842 a non-@code{nil} value for any element, or @code{t} if the predicate
Dave Love <fx@gnu.org>
parents:
diff changeset
3843 was @code{nil} for all elements.
Dave Love <fx@gnu.org>
parents:
diff changeset
3844 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3845
Dave Love <fx@gnu.org>
parents:
diff changeset
3846 @defun notevery predicate seq &rest more-seqs
Dave Love <fx@gnu.org>
parents:
diff changeset
3847 This function calls @var{predicate} on each element of the sequence(s)
Dave Love <fx@gnu.org>
parents:
diff changeset
3848 in turn; it returns a non-@code{nil} value as soon as @var{predicate}
Dave Love <fx@gnu.org>
parents:
diff changeset
3849 returns @code{nil} for any element, or @code{t} if the predicate was
Dave Love <fx@gnu.org>
parents:
diff changeset
3850 true for all elements.
Dave Love <fx@gnu.org>
parents:
diff changeset
3851 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3852
Dave Love <fx@gnu.org>
parents:
diff changeset
3853 @defun reduce function seq @t{&key :from-end :start :end :initial-value :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
3854 This function combines the elements of @var{seq} using an associative
Dave Love <fx@gnu.org>
parents:
diff changeset
3855 binary operation. Suppose @var{function} is @code{*} and @var{seq} is
Dave Love <fx@gnu.org>
parents:
diff changeset
3856 the list @code{(2 3 4 5)}. The first two elements of the list are
Dave Love <fx@gnu.org>
parents:
diff changeset
3857 combined with @code{(* 2 3) = 6}; this is combined with the next
Dave Love <fx@gnu.org>
parents:
diff changeset
3858 element, @code{(* 6 4) = 24}, and that is combined with the final
Dave Love <fx@gnu.org>
parents:
diff changeset
3859 element: @code{(* 24 5) = 120}. Note that the @code{*} function happens
Dave Love <fx@gnu.org>
parents:
diff changeset
3860 to be self-reducing, so that @code{(* 2 3 4 5)} has the same effect as
Dave Love <fx@gnu.org>
parents:
diff changeset
3861 an explicit call to @code{reduce}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3862
Dave Love <fx@gnu.org>
parents:
diff changeset
3863 If @code{:from-end} is true, the reduction is right-associative instead
Dave Love <fx@gnu.org>
parents:
diff changeset
3864 of left-associative:
Dave Love <fx@gnu.org>
parents:
diff changeset
3865
Dave Love <fx@gnu.org>
parents:
diff changeset
3866 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3867 (reduce '- '(1 2 3 4))
Dave Love <fx@gnu.org>
parents:
diff changeset
3868 @equiv{} (- (- (- 1 2) 3) 4) @result{} -8
Dave Love <fx@gnu.org>
parents:
diff changeset
3869 (reduce '- '(1 2 3 4) :from-end t)
Dave Love <fx@gnu.org>
parents:
diff changeset
3870 @equiv{} (- 1 (- 2 (- 3 4))) @result{} -2
Dave Love <fx@gnu.org>
parents:
diff changeset
3871 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3872
Dave Love <fx@gnu.org>
parents:
diff changeset
3873 If @code{:key} is specified, it is a function of one argument which
Dave Love <fx@gnu.org>
parents:
diff changeset
3874 is called on each of the sequence elements in turn.
Dave Love <fx@gnu.org>
parents:
diff changeset
3875
Dave Love <fx@gnu.org>
parents:
diff changeset
3876 If @code{:initial-value} is specified, it is effectively added to the
Dave Love <fx@gnu.org>
parents:
diff changeset
3877 front (or rear in the case of @code{:from-end}) of the sequence.
Dave Love <fx@gnu.org>
parents:
diff changeset
3878 The @code{:key} function is @emph{not} applied to the initial value.
Dave Love <fx@gnu.org>
parents:
diff changeset
3879
Dave Love <fx@gnu.org>
parents:
diff changeset
3880 If the sequence, including the initial value, has exactly one element
Dave Love <fx@gnu.org>
parents:
diff changeset
3881 then that element is returned without ever calling @var{function}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3882 If the sequence is empty (and there is no initial value), then
Dave Love <fx@gnu.org>
parents:
diff changeset
3883 @var{function} is called with no arguments to obtain the return value.
Dave Love <fx@gnu.org>
parents:
diff changeset
3884 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3885
Dave Love <fx@gnu.org>
parents:
diff changeset
3886 All of these mapping operations can be expressed conveniently in
Dave Love <fx@gnu.org>
parents:
diff changeset
3887 terms of the @code{loop} macro. In compiled code, @code{loop} will
Dave Love <fx@gnu.org>
parents:
diff changeset
3888 be faster since it generates the loop as in-line code with no
Dave Love <fx@gnu.org>
parents:
diff changeset
3889 function calls.
Dave Love <fx@gnu.org>
parents:
diff changeset
3890
Dave Love <fx@gnu.org>
parents:
diff changeset
3891 @node Sequence Functions, Searching Sequences, Mapping over Sequences, Sequences
Dave Love <fx@gnu.org>
parents:
diff changeset
3892 @section Sequence Functions
Dave Love <fx@gnu.org>
parents:
diff changeset
3893
Dave Love <fx@gnu.org>
parents:
diff changeset
3894 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3895 This section describes a number of Common Lisp functions for
Dave Love <fx@gnu.org>
parents:
diff changeset
3896 operating on sequences.
Dave Love <fx@gnu.org>
parents:
diff changeset
3897
Dave Love <fx@gnu.org>
parents:
diff changeset
3898 @defun subseq sequence start &optional end
Dave Love <fx@gnu.org>
parents:
diff changeset
3899 This function returns a given subsequence of the argument
Dave Love <fx@gnu.org>
parents:
diff changeset
3900 @var{sequence}, which may be a list, string, or vector.
Dave Love <fx@gnu.org>
parents:
diff changeset
3901 The indices @var{start} and @var{end} must be in range, and
Dave Love <fx@gnu.org>
parents:
diff changeset
3902 @var{start} must be no greater than @var{end}. If @var{end}
Dave Love <fx@gnu.org>
parents:
diff changeset
3903 is omitted, it defaults to the length of the sequence. The
Dave Love <fx@gnu.org>
parents:
diff changeset
3904 return value is always a copy; it does not share structure
Dave Love <fx@gnu.org>
parents:
diff changeset
3905 with @var{sequence}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3906
Dave Love <fx@gnu.org>
parents:
diff changeset
3907 As an extension to Common Lisp, @var{start} and/or @var{end}
Dave Love <fx@gnu.org>
parents:
diff changeset
3908 may be negative, in which case they represent a distance back
Dave Love <fx@gnu.org>
parents:
diff changeset
3909 from the end of the sequence. This is for compatibility with
Dave Love <fx@gnu.org>
parents:
diff changeset
3910 Emacs' @code{substring} function. Note that @code{subseq} is
Dave Love <fx@gnu.org>
parents:
diff changeset
3911 the @emph{only} sequence function that allows negative
Dave Love <fx@gnu.org>
parents:
diff changeset
3912 @var{start} and @var{end}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3913
Dave Love <fx@gnu.org>
parents:
diff changeset
3914 You can use @code{setf} on a @code{subseq} form to replace a
Dave Love <fx@gnu.org>
parents:
diff changeset
3915 specified range of elements with elements from another sequence.
Dave Love <fx@gnu.org>
parents:
diff changeset
3916 The replacement is done as if by @code{replace}, described below.
Dave Love <fx@gnu.org>
parents:
diff changeset
3917 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3918
Dave Love <fx@gnu.org>
parents:
diff changeset
3919 @defun concatenate result-type &rest seqs
Dave Love <fx@gnu.org>
parents:
diff changeset
3920 This function concatenates the argument sequences together to
Dave Love <fx@gnu.org>
parents:
diff changeset
3921 form a result sequence of type @var{result-type}, one of the
Dave Love <fx@gnu.org>
parents:
diff changeset
3922 symbols @code{vector}, @code{string}, or @code{list}. The
Dave Love <fx@gnu.org>
parents:
diff changeset
3923 arguments are always copied, even in cases such as
Dave Love <fx@gnu.org>
parents:
diff changeset
3924 @code{(concatenate 'list '(1 2 3))} where the result is
Dave Love <fx@gnu.org>
parents:
diff changeset
3925 identical to an argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
3926 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3927
Dave Love <fx@gnu.org>
parents:
diff changeset
3928 @defun fill seq item @t{&key :start :end}
Dave Love <fx@gnu.org>
parents:
diff changeset
3929 This function fills the elements of the sequence (or the specified
Dave Love <fx@gnu.org>
parents:
diff changeset
3930 part of the sequence) with the value @var{item}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3931 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3932
Dave Love <fx@gnu.org>
parents:
diff changeset
3933 @defun replace seq1 seq2 @t{&key :start1 :end1 :start2 :end2}
Dave Love <fx@gnu.org>
parents:
diff changeset
3934 This function copies part of @var{seq2} into part of @var{seq1}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3935 The sequence @var{seq1} is not stretched or resized; the amount
Dave Love <fx@gnu.org>
parents:
diff changeset
3936 of data copied is simply the shorter of the source and destination
Dave Love <fx@gnu.org>
parents:
diff changeset
3937 (sub)sequences. The function returns @var{seq1}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3938
Dave Love <fx@gnu.org>
parents:
diff changeset
3939 If @var{seq1} and @var{seq2} are @code{eq}, then the replacement
Dave Love <fx@gnu.org>
parents:
diff changeset
3940 will work correctly even if the regions indicated by the start
Dave Love <fx@gnu.org>
parents:
diff changeset
3941 and end arguments overlap. However, if @var{seq1} and @var{seq2}
Dave Love <fx@gnu.org>
parents:
diff changeset
3942 are lists which share storage but are not @code{eq}, and the
Dave Love <fx@gnu.org>
parents:
diff changeset
3943 start and end arguments specify overlapping regions, the effect
Dave Love <fx@gnu.org>
parents:
diff changeset
3944 is undefined.
Dave Love <fx@gnu.org>
parents:
diff changeset
3945 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3946
Dave Love <fx@gnu.org>
parents:
diff changeset
3947 @defun remove* item seq @t{&key :test :test-not :key :count :start :end :from-end}
Dave Love <fx@gnu.org>
parents:
diff changeset
3948 This returns a copy of @var{seq} with all elements matching
Dave Love <fx@gnu.org>
parents:
diff changeset
3949 @var{item} removed. The result may share storage with or be
Dave Love <fx@gnu.org>
parents:
diff changeset
3950 @code{eq} to @var{seq} in some circumstances, but the original
Dave Love <fx@gnu.org>
parents:
diff changeset
3951 @var{seq} will not be modified. The @code{:test}, @code{:test-not},
Dave Love <fx@gnu.org>
parents:
diff changeset
3952 and @code{:key} arguments define the matching test that is used;
Dave Love <fx@gnu.org>
parents:
diff changeset
3953 by default, elements @code{eql} to @var{item} are removed. The
Dave Love <fx@gnu.org>
parents:
diff changeset
3954 @code{:count} argument specifies the maximum number of matching
Dave Love <fx@gnu.org>
parents:
diff changeset
3955 elements that can be removed (only the leftmost @var{count} matches
Dave Love <fx@gnu.org>
parents:
diff changeset
3956 are removed). The @code{:start} and @code{:end} arguments specify
Dave Love <fx@gnu.org>
parents:
diff changeset
3957 a region in @var{seq} in which elements will be removed; elements
Dave Love <fx@gnu.org>
parents:
diff changeset
3958 outside that region are not matched or removed. The @code{:from-end}
Dave Love <fx@gnu.org>
parents:
diff changeset
3959 argument, if true, says that elements should be deleted from the
Dave Love <fx@gnu.org>
parents:
diff changeset
3960 end of the sequence rather than the beginning (this matters only
Dave Love <fx@gnu.org>
parents:
diff changeset
3961 if @var{count} was also specified).
Dave Love <fx@gnu.org>
parents:
diff changeset
3962 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3963
Dave Love <fx@gnu.org>
parents:
diff changeset
3964 @defun delete* item seq @t{&key :test :test-not :key :count :start :end :from-end}
Dave Love <fx@gnu.org>
parents:
diff changeset
3965 This deletes all elements of @var{seq} which match @var{item}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3966 It is a destructive operation. Since Emacs Lisp does not support
Dave Love <fx@gnu.org>
parents:
diff changeset
3967 stretchable strings or vectors, this is the same as @code{remove*}
Dave Love <fx@gnu.org>
parents:
diff changeset
3968 for those sequence types. On lists, @code{remove*} will copy the
Dave Love <fx@gnu.org>
parents:
diff changeset
3969 list if necessary to preserve the original list, whereas
Dave Love <fx@gnu.org>
parents:
diff changeset
3970 @code{delete*} will splice out parts of the argument list.
Dave Love <fx@gnu.org>
parents:
diff changeset
3971 Compare @code{append} and @code{nconc}, which are analogous
Dave Love <fx@gnu.org>
parents:
diff changeset
3972 non-destructive and destructive list operations in Emacs Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
3973 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3974
Dave Love <fx@gnu.org>
parents:
diff changeset
3975 @findex remove-if
Dave Love <fx@gnu.org>
parents:
diff changeset
3976 @findex remove-if-not
Dave Love <fx@gnu.org>
parents:
diff changeset
3977 @findex delete-if
Dave Love <fx@gnu.org>
parents:
diff changeset
3978 @findex delete-if-not
Dave Love <fx@gnu.org>
parents:
diff changeset
3979 The predicate-oriented functions @code{remove-if}, @code{remove-if-not},
Dave Love <fx@gnu.org>
parents:
diff changeset
3980 @code{delete-if}, and @code{delete-if-not} are defined similarly.
Dave Love <fx@gnu.org>
parents:
diff changeset
3981
Dave Love <fx@gnu.org>
parents:
diff changeset
3982 @defun remove-duplicates seq @t{&key :test :test-not :key :start :end :from-end}
Dave Love <fx@gnu.org>
parents:
diff changeset
3983 This function returns a copy of @var{seq} with duplicate elements
Dave Love <fx@gnu.org>
parents:
diff changeset
3984 removed. Specifically, if two elements from the sequence match
Dave Love <fx@gnu.org>
parents:
diff changeset
3985 according to the @code{:test}, @code{:test-not}, and @code{:key}
Dave Love <fx@gnu.org>
parents:
diff changeset
3986 arguments, only the rightmost one is retained. If @code{:from-end}
Dave Love <fx@gnu.org>
parents:
diff changeset
3987 is true, the leftmost one is retained instead. If @code{:start} or
Dave Love <fx@gnu.org>
parents:
diff changeset
3988 @code{:end} is specified, only elements within that subsequence are
Dave Love <fx@gnu.org>
parents:
diff changeset
3989 examined or removed.
Dave Love <fx@gnu.org>
parents:
diff changeset
3990 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3991
Dave Love <fx@gnu.org>
parents:
diff changeset
3992 @defun delete-duplicates seq @t{&key :test :test-not :key :start :end :from-end}
Dave Love <fx@gnu.org>
parents:
diff changeset
3993 This function deletes duplicate elements from @var{seq}. It is
Dave Love <fx@gnu.org>
parents:
diff changeset
3994 a destructive version of @code{remove-duplicates}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3995 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
3996
Dave Love <fx@gnu.org>
parents:
diff changeset
3997 @defun substitute new old seq @t{&key :test :test-not :key :count :start :end :from-end}
Dave Love <fx@gnu.org>
parents:
diff changeset
3998 This function returns a copy of @var{seq}, with all elements
Dave Love <fx@gnu.org>
parents:
diff changeset
3999 matching @var{old} replaced with @var{new}. The @code{:count},
Dave Love <fx@gnu.org>
parents:
diff changeset
4000 @code{:start}, @code{:end}, and @code{:from-end} arguments may be
Dave Love <fx@gnu.org>
parents:
diff changeset
4001 used to limit the number of substitutions made.
Dave Love <fx@gnu.org>
parents:
diff changeset
4002 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4003
Dave Love <fx@gnu.org>
parents:
diff changeset
4004 @defun nsubstitute new old seq @t{&key :test :test-not :key :count :start :end :from-end}
Dave Love <fx@gnu.org>
parents:
diff changeset
4005 This is a destructive version of @code{substitute}; it performs
Dave Love <fx@gnu.org>
parents:
diff changeset
4006 the substitution using @code{setcar} or @code{aset} rather than
Dave Love <fx@gnu.org>
parents:
diff changeset
4007 by returning a changed copy of the sequence.
Dave Love <fx@gnu.org>
parents:
diff changeset
4008 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4009
Dave Love <fx@gnu.org>
parents:
diff changeset
4010 @findex substitute-if
Dave Love <fx@gnu.org>
parents:
diff changeset
4011 @findex substitute-if-not
Dave Love <fx@gnu.org>
parents:
diff changeset
4012 @findex nsubstitute-if
Dave Love <fx@gnu.org>
parents:
diff changeset
4013 @findex nsubstitute-if-not
Dave Love <fx@gnu.org>
parents:
diff changeset
4014 The @code{substitute-if}, @code{substitute-if-not}, @code{nsubstitute-if},
Dave Love <fx@gnu.org>
parents:
diff changeset
4015 and @code{nsubstitute-if-not} functions are defined similarly. For
Dave Love <fx@gnu.org>
parents:
diff changeset
4016 these, a @var{predicate} is given in place of the @var{old} argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
4017
Dave Love <fx@gnu.org>
parents:
diff changeset
4018 @node Searching Sequences, Sorting Sequences, Sequence Functions, Sequences
Dave Love <fx@gnu.org>
parents:
diff changeset
4019 @section Searching Sequences
Dave Love <fx@gnu.org>
parents:
diff changeset
4020
Dave Love <fx@gnu.org>
parents:
diff changeset
4021 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4022 These functions search for elements or subsequences in a sequence.
Dave Love <fx@gnu.org>
parents:
diff changeset
4023 (See also @code{member*} and @code{assoc*}; @pxref{Lists}.)
Dave Love <fx@gnu.org>
parents:
diff changeset
4024
Dave Love <fx@gnu.org>
parents:
diff changeset
4025 @defun find item seq @t{&key :test :test-not :key :start :end :from-end}
Dave Love <fx@gnu.org>
parents:
diff changeset
4026 This function searches @var{seq} for an element matching @var{item}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4027 If it finds a match, it returns the matching element. Otherwise,
Dave Love <fx@gnu.org>
parents:
diff changeset
4028 it returns @code{nil}. It returns the leftmost match, unless
Dave Love <fx@gnu.org>
parents:
diff changeset
4029 @code{:from-end} is true, in which case it returns the rightmost
Dave Love <fx@gnu.org>
parents:
diff changeset
4030 match. The @code{:start} and @code{:end} arguments may be used to
Dave Love <fx@gnu.org>
parents:
diff changeset
4031 limit the range of elements that are searched.
Dave Love <fx@gnu.org>
parents:
diff changeset
4032 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4033
Dave Love <fx@gnu.org>
parents:
diff changeset
4034 @defun position item seq @t{&key :test :test-not :key :start :end :from-end}
Dave Love <fx@gnu.org>
parents:
diff changeset
4035 This function is like @code{find}, except that it returns the
Dave Love <fx@gnu.org>
parents:
diff changeset
4036 integer position in the sequence of the matching item rather than
Dave Love <fx@gnu.org>
parents:
diff changeset
4037 the item itself. The position is relative to the start of the
Dave Love <fx@gnu.org>
parents:
diff changeset
4038 sequence as a whole, even if @code{:start} is non-zero. The function
Dave Love <fx@gnu.org>
parents:
diff changeset
4039 returns @code{nil} if no matching element was found.
Dave Love <fx@gnu.org>
parents:
diff changeset
4040 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4041
Dave Love <fx@gnu.org>
parents:
diff changeset
4042 @defun count item seq @t{&key :test :test-not :key :start :end}
Dave Love <fx@gnu.org>
parents:
diff changeset
4043 This function returns the number of elements of @var{seq} which
Dave Love <fx@gnu.org>
parents:
diff changeset
4044 match @var{item}. The result is always a nonnegative integer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4045 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4046
Dave Love <fx@gnu.org>
parents:
diff changeset
4047 @findex find-if
Dave Love <fx@gnu.org>
parents:
diff changeset
4048 @findex find-if-not
Dave Love <fx@gnu.org>
parents:
diff changeset
4049 @findex position-if
Dave Love <fx@gnu.org>
parents:
diff changeset
4050 @findex position-if-not
Dave Love <fx@gnu.org>
parents:
diff changeset
4051 @findex count-if
Dave Love <fx@gnu.org>
parents:
diff changeset
4052 @findex count-if-not
Dave Love <fx@gnu.org>
parents:
diff changeset
4053 The @code{find-if}, @code{find-if-not}, @code{position-if},
Dave Love <fx@gnu.org>
parents:
diff changeset
4054 @code{position-if-not}, @code{count-if}, and @code{count-if-not}
Dave Love <fx@gnu.org>
parents:
diff changeset
4055 functions are defined similarly.
Dave Love <fx@gnu.org>
parents:
diff changeset
4056
Dave Love <fx@gnu.org>
parents:
diff changeset
4057 @defun mismatch seq1 seq2 @t{&key :test :test-not :key :start1 :end1 :start2 :end2 :from-end}
Dave Love <fx@gnu.org>
parents:
diff changeset
4058 This function compares the specified parts of @var{seq1} and
Dave Love <fx@gnu.org>
parents:
diff changeset
4059 @var{seq2}. If they are the same length and the corresponding
Dave Love <fx@gnu.org>
parents:
diff changeset
4060 elements match (according to @code{:test}, @code{:test-not},
Dave Love <fx@gnu.org>
parents:
diff changeset
4061 and @code{:key}), the function returns @code{nil}. If there is
Dave Love <fx@gnu.org>
parents:
diff changeset
4062 a mismatch, the function returns the index (relative to @var{seq1})
Dave Love <fx@gnu.org>
parents:
diff changeset
4063 of the first mismatching element. This will be the leftmost pair of
Dave Love <fx@gnu.org>
parents:
diff changeset
4064 elements which do not match, or the position at which the shorter of
Dave Love <fx@gnu.org>
parents:
diff changeset
4065 the two otherwise-matching sequences runs out.
Dave Love <fx@gnu.org>
parents:
diff changeset
4066
Dave Love <fx@gnu.org>
parents:
diff changeset
4067 If @code{:from-end} is true, then the elements are compared from right
Dave Love <fx@gnu.org>
parents:
diff changeset
4068 to left starting at @code{(1- @var{end1})} and @code{(1- @var{end2})}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4069 If the sequences differ, then one plus the index of the rightmost
Dave Love <fx@gnu.org>
parents:
diff changeset
4070 difference (relative to @var{seq1}) is returned.
Dave Love <fx@gnu.org>
parents:
diff changeset
4071
Dave Love <fx@gnu.org>
parents:
diff changeset
4072 An interesting example is @code{(mismatch str1 str2 :key 'upcase)},
Dave Love <fx@gnu.org>
parents:
diff changeset
4073 which compares two strings case-insensitively.
Dave Love <fx@gnu.org>
parents:
diff changeset
4074 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4075
Dave Love <fx@gnu.org>
parents:
diff changeset
4076 @defun search seq1 seq2 @t{&key :test :test-not :key :from-end :start1 :end1 :start2 :end2}
Dave Love <fx@gnu.org>
parents:
diff changeset
4077 This function searches @var{seq2} for a subsequence that matches
Dave Love <fx@gnu.org>
parents:
diff changeset
4078 @var{seq1} (or part of it specified by @code{:start1} and
Dave Love <fx@gnu.org>
parents:
diff changeset
4079 @code{:end1}.) Only matches which fall entirely within the region
Dave Love <fx@gnu.org>
parents:
diff changeset
4080 defined by @code{:start2} and @code{:end2} will be considered.
Dave Love <fx@gnu.org>
parents:
diff changeset
4081 The return value is the index of the leftmost element of the
Dave Love <fx@gnu.org>
parents:
diff changeset
4082 leftmost match, relative to the start of @var{seq2}, or @code{nil}
Dave Love <fx@gnu.org>
parents:
diff changeset
4083 if no matches were found. If @code{:from-end} is true, the
Dave Love <fx@gnu.org>
parents:
diff changeset
4084 function finds the @emph{rightmost} matching subsequence.
Dave Love <fx@gnu.org>
parents:
diff changeset
4085 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4086
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
4087 @node Sorting Sequences, , Searching Sequences, Sequences
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4088 @section Sorting Sequences
Dave Love <fx@gnu.org>
parents:
diff changeset
4089
Dave Love <fx@gnu.org>
parents:
diff changeset
4090 @defun sort* seq predicate @t{&key :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4091 This function sorts @var{seq} into increasing order as determined
Dave Love <fx@gnu.org>
parents:
diff changeset
4092 by using @var{predicate} to compare pairs of elements. @var{predicate}
Dave Love <fx@gnu.org>
parents:
diff changeset
4093 should return true (non-@code{nil}) if and only if its first argument
Dave Love <fx@gnu.org>
parents:
diff changeset
4094 is less than (not equal to) its second argument. For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
4095 @code{<} and @code{string-lessp} are suitable predicate functions
Dave Love <fx@gnu.org>
parents:
diff changeset
4096 for sorting numbers and strings, respectively; @code{>} would sort
Dave Love <fx@gnu.org>
parents:
diff changeset
4097 numbers into decreasing rather than increasing order.
Dave Love <fx@gnu.org>
parents:
diff changeset
4098
Dave Love <fx@gnu.org>
parents:
diff changeset
4099 This function differs from Emacs' built-in @code{sort} in that it
Dave Love <fx@gnu.org>
parents:
diff changeset
4100 can operate on any type of sequence, not just lists. Also, it
Dave Love <fx@gnu.org>
parents:
diff changeset
4101 accepts a @code{:key} argument which is used to preprocess data
Dave Love <fx@gnu.org>
parents:
diff changeset
4102 fed to the @var{predicate} function. For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
4103
Dave Love <fx@gnu.org>
parents:
diff changeset
4104 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4105 (setq data (sort data 'string-lessp :key 'downcase))
Dave Love <fx@gnu.org>
parents:
diff changeset
4106 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4107
Dave Love <fx@gnu.org>
parents:
diff changeset
4108 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4109 sorts @var{data}, a sequence of strings, into increasing alphabetical
Dave Love <fx@gnu.org>
parents:
diff changeset
4110 order without regard to case. A @code{:key} function of @code{car}
Dave Love <fx@gnu.org>
parents:
diff changeset
4111 would be useful for sorting association lists.
Dave Love <fx@gnu.org>
parents:
diff changeset
4112
Dave Love <fx@gnu.org>
parents:
diff changeset
4113 The @code{sort*} function is destructive; it sorts lists by actually
Dave Love <fx@gnu.org>
parents:
diff changeset
4114 rearranging the @code{cdr} pointers in suitable fashion.
Dave Love <fx@gnu.org>
parents:
diff changeset
4115 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4116
Dave Love <fx@gnu.org>
parents:
diff changeset
4117 @defun stable-sort seq predicate @t{&key :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4118 This function sorts @var{seq} @dfn{stably}, meaning two elements
Dave Love <fx@gnu.org>
parents:
diff changeset
4119 which are equal in terms of @var{predicate} are guaranteed not to
Dave Love <fx@gnu.org>
parents:
diff changeset
4120 be rearranged out of their original order by the sort.
Dave Love <fx@gnu.org>
parents:
diff changeset
4121
Dave Love <fx@gnu.org>
parents:
diff changeset
4122 In practice, @code{sort*} and @code{stable-sort} are equivalent
Dave Love <fx@gnu.org>
parents:
diff changeset
4123 in Emacs Lisp because the underlying @code{sort} function is
Dave Love <fx@gnu.org>
parents:
diff changeset
4124 stable by default. However, this package reserves the right to
Dave Love <fx@gnu.org>
parents:
diff changeset
4125 use non-stable methods for @code{sort*} in the future.
Dave Love <fx@gnu.org>
parents:
diff changeset
4126 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4127
Dave Love <fx@gnu.org>
parents:
diff changeset
4128 @defun merge type seq1 seq2 predicate @t{&key :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4129 This function merges two sequences @var{seq1} and @var{seq2} by
Dave Love <fx@gnu.org>
parents:
diff changeset
4130 interleaving their elements. The result sequence, of type @var{type}
Dave Love <fx@gnu.org>
parents:
diff changeset
4131 (in the sense of @code{concatenate}), has length equal to the sum
Dave Love <fx@gnu.org>
parents:
diff changeset
4132 of the lengths of the two input sequences. The sequences may be
Dave Love <fx@gnu.org>
parents:
diff changeset
4133 modified destructively. Order of elements within @var{seq1} and
Dave Love <fx@gnu.org>
parents:
diff changeset
4134 @var{seq2} is preserved in the interleaving; elements of the two
Dave Love <fx@gnu.org>
parents:
diff changeset
4135 sequences are compared by @var{predicate} (in the sense of
Dave Love <fx@gnu.org>
parents:
diff changeset
4136 @code{sort}) and the lesser element goes first in the result.
Dave Love <fx@gnu.org>
parents:
diff changeset
4137 When elements are equal, those from @var{seq1} precede those from
Dave Love <fx@gnu.org>
parents:
diff changeset
4138 @var{seq2} in the result. Thus, if @var{seq1} and @var{seq2} are
Dave Love <fx@gnu.org>
parents:
diff changeset
4139 both sorted according to @var{predicate}, then the result will be
Dave Love <fx@gnu.org>
parents:
diff changeset
4140 a merged sequence which is (stably) sorted according to
Dave Love <fx@gnu.org>
parents:
diff changeset
4141 @var{predicate}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4142 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4143
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
4144 @node Lists, Structures, Sequences, Top
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4145 @chapter Lists
Dave Love <fx@gnu.org>
parents:
diff changeset
4146
Dave Love <fx@gnu.org>
parents:
diff changeset
4147 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4148 The functions described here operate on lists.
Dave Love <fx@gnu.org>
parents:
diff changeset
4149
Dave Love <fx@gnu.org>
parents:
diff changeset
4150 @menu
36931
508fd85ab816 expurgate last*
Dave Love <fx@gnu.org>
parents: 35089
diff changeset
4151 * List Functions:: `caddr', `first', `list*', etc.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4152 * Substitution of Expressions:: `subst', `sublis', etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
4153 * Lists as Sets:: `member*', `adjoin', `union', etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
4154 * Association Lists:: `assoc*', `rassoc*', `acons', `pairlis'
Dave Love <fx@gnu.org>
parents:
diff changeset
4155 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
4156
Dave Love <fx@gnu.org>
parents:
diff changeset
4157 @node List Functions, Substitution of Expressions, Lists, Lists
Dave Love <fx@gnu.org>
parents:
diff changeset
4158 @section List Functions
Dave Love <fx@gnu.org>
parents:
diff changeset
4159
Dave Love <fx@gnu.org>
parents:
diff changeset
4160 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4161 This section describes a number of simple operations on lists,
Dave Love <fx@gnu.org>
parents:
diff changeset
4162 i.e., chains of cons cells.
Dave Love <fx@gnu.org>
parents:
diff changeset
4163
Dave Love <fx@gnu.org>
parents:
diff changeset
4164 @defun caddr x
Dave Love <fx@gnu.org>
parents:
diff changeset
4165 This function is equivalent to @code{(car (cdr (cdr @var{x})))}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4166 Likewise, this package defines all 28 @code{c@var{xxx}r} functions
Dave Love <fx@gnu.org>
parents:
diff changeset
4167 where @var{xxx} is up to four @samp{a}s and/or @samp{d}s.
Dave Love <fx@gnu.org>
parents:
diff changeset
4168 All of these functions are @code{setf}-able, and calls to them
Dave Love <fx@gnu.org>
parents:
diff changeset
4169 are expanded inline by the byte-compiler for maximum efficiency.
Dave Love <fx@gnu.org>
parents:
diff changeset
4170 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4171
Dave Love <fx@gnu.org>
parents:
diff changeset
4172 @defun first x
Dave Love <fx@gnu.org>
parents:
diff changeset
4173 This function is a synonym for @code{(car @var{x})}. Likewise,
Dave Love <fx@gnu.org>
parents:
diff changeset
4174 the functions @code{second}, @code{third}, @dots{}, through
Dave Love <fx@gnu.org>
parents:
diff changeset
4175 @code{tenth} return the given element of the list @var{x}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4176 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4177
Dave Love <fx@gnu.org>
parents:
diff changeset
4178 @defun rest x
Dave Love <fx@gnu.org>
parents:
diff changeset
4179 This function is a synonym for @code{(cdr @var{x})}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4180 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4181
Dave Love <fx@gnu.org>
parents:
diff changeset
4182 @defun endp x
Dave Love <fx@gnu.org>
parents:
diff changeset
4183 Common Lisp defines this function to act like @code{null}, but
Dave Love <fx@gnu.org>
parents:
diff changeset
4184 signaling an error if @code{x} is neither a @code{nil} nor a
Dave Love <fx@gnu.org>
parents:
diff changeset
4185 cons cell. This package simply defines @code{endp} as a synonym
Dave Love <fx@gnu.org>
parents:
diff changeset
4186 for @code{null}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4187 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4188
Dave Love <fx@gnu.org>
parents:
diff changeset
4189 @defun list-length x
Dave Love <fx@gnu.org>
parents:
diff changeset
4190 This function returns the length of list @var{x}, exactly like
Dave Love <fx@gnu.org>
parents:
diff changeset
4191 @code{(length @var{x})}, except that if @var{x} is a circular
Dave Love <fx@gnu.org>
parents:
diff changeset
4192 list (where the cdr-chain forms a loop rather than terminating
Dave Love <fx@gnu.org>
parents:
diff changeset
4193 with @code{nil}), this function returns @code{nil}. (The regular
Dave Love <fx@gnu.org>
parents:
diff changeset
4194 @code{length} function would get stuck if given a circular list.)
Dave Love <fx@gnu.org>
parents:
diff changeset
4195 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4196
Dave Love <fx@gnu.org>
parents:
diff changeset
4197 @defun list* arg &rest others
Dave Love <fx@gnu.org>
parents:
diff changeset
4198 This function constructs a list of its arguments. The final
Dave Love <fx@gnu.org>
parents:
diff changeset
4199 argument becomes the @code{cdr} of the last cell constructed.
Dave Love <fx@gnu.org>
parents:
diff changeset
4200 Thus, @code{(list* @var{a} @var{b} @var{c})} is equivalent to
Dave Love <fx@gnu.org>
parents:
diff changeset
4201 @code{(cons @var{a} (cons @var{b} @var{c}))}, and
Dave Love <fx@gnu.org>
parents:
diff changeset
4202 @code{(list* @var{a} @var{b} nil)} is equivalent to
Dave Love <fx@gnu.org>
parents:
diff changeset
4203 @code{(list @var{a} @var{b})}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4204
Dave Love <fx@gnu.org>
parents:
diff changeset
4205 (Note that this function really is called @code{list*} in Common
Dave Love <fx@gnu.org>
parents:
diff changeset
4206 Lisp; it is not a name invented for this package like @code{member*}
Dave Love <fx@gnu.org>
parents:
diff changeset
4207 or @code{defun*}.)
Dave Love <fx@gnu.org>
parents:
diff changeset
4208 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4209
Dave Love <fx@gnu.org>
parents:
diff changeset
4210 @defun ldiff list sublist
Dave Love <fx@gnu.org>
parents:
diff changeset
4211 If @var{sublist} is a sublist of @var{list}, i.e., is @code{eq} to
Dave Love <fx@gnu.org>
parents:
diff changeset
4212 one of the cons cells of @var{list}, then this function returns
Dave Love <fx@gnu.org>
parents:
diff changeset
4213 a copy of the part of @var{list} up to but not including
Dave Love <fx@gnu.org>
parents:
diff changeset
4214 @var{sublist}. For example, @code{(ldiff x (cddr x))} returns
Dave Love <fx@gnu.org>
parents:
diff changeset
4215 the first two elements of the list @code{x}. The result is a
Dave Love <fx@gnu.org>
parents:
diff changeset
4216 copy; the original @var{list} is not modified. If @var{sublist}
Dave Love <fx@gnu.org>
parents:
diff changeset
4217 is not a sublist of @var{list}, a copy of the entire @var{list}
Dave Love <fx@gnu.org>
parents:
diff changeset
4218 is returned.
Dave Love <fx@gnu.org>
parents:
diff changeset
4219 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4220
Dave Love <fx@gnu.org>
parents:
diff changeset
4221 @defun copy-list list
Dave Love <fx@gnu.org>
parents:
diff changeset
4222 This function returns a copy of the list @var{list}. It copies
Dave Love <fx@gnu.org>
parents:
diff changeset
4223 dotted lists like @code{(1 2 . 3)} correctly.
Dave Love <fx@gnu.org>
parents:
diff changeset
4224 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4225
Dave Love <fx@gnu.org>
parents:
diff changeset
4226 @defun copy-tree x &optional vecp
Dave Love <fx@gnu.org>
parents:
diff changeset
4227 This function returns a copy of the tree of cons cells @var{x}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4228 Unlike @code{copy-sequence} (and its alias @code{copy-list}),
Dave Love <fx@gnu.org>
parents:
diff changeset
4229 which copies only along the @code{cdr} direction, this function
Dave Love <fx@gnu.org>
parents:
diff changeset
4230 copies (recursively) along both the @code{car} and the @code{cdr}
Dave Love <fx@gnu.org>
parents:
diff changeset
4231 directions. If @var{x} is not a cons cell, the function simply
Dave Love <fx@gnu.org>
parents:
diff changeset
4232 returns @var{x} unchanged. If the optional @var{vecp} argument
Dave Love <fx@gnu.org>
parents:
diff changeset
4233 is true, this function copies vectors (recursively) as well as
Dave Love <fx@gnu.org>
parents:
diff changeset
4234 cons cells.
Dave Love <fx@gnu.org>
parents:
diff changeset
4235 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4236
Dave Love <fx@gnu.org>
parents:
diff changeset
4237 @defun tree-equal x y @t{&key :test :test-not :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4238 This function compares two trees of cons cells. If @var{x} and
Dave Love <fx@gnu.org>
parents:
diff changeset
4239 @var{y} are both cons cells, their @code{car}s and @code{cdr}s are
Dave Love <fx@gnu.org>
parents:
diff changeset
4240 compared recursively. If neither @var{x} nor @var{y} is a cons
Dave Love <fx@gnu.org>
parents:
diff changeset
4241 cell, they are compared by @code{eql}, or according to the
Dave Love <fx@gnu.org>
parents:
diff changeset
4242 specified test. The @code{:key} function, if specified, is
Dave Love <fx@gnu.org>
parents:
diff changeset
4243 applied to the elements of both trees. @xref{Sequences}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4244 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4245
Dave Love <fx@gnu.org>
parents:
diff changeset
4246 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
4247 @secno=3
Dave Love <fx@gnu.org>
parents:
diff changeset
4248 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
4249
Dave Love <fx@gnu.org>
parents:
diff changeset
4250 @node Substitution of Expressions, Lists as Sets, List Functions, Lists
Dave Love <fx@gnu.org>
parents:
diff changeset
4251 @section Substitution of Expressions
Dave Love <fx@gnu.org>
parents:
diff changeset
4252
Dave Love <fx@gnu.org>
parents:
diff changeset
4253 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4254 These functions substitute elements throughout a tree of cons
Dave Love <fx@gnu.org>
parents:
diff changeset
4255 cells. (@xref{Sequence Functions}, for the @code{substitute}
Dave Love <fx@gnu.org>
parents:
diff changeset
4256 function, which works on just the top-level elements of a list.)
Dave Love <fx@gnu.org>
parents:
diff changeset
4257
Dave Love <fx@gnu.org>
parents:
diff changeset
4258 @defun subst new old tree @t{&key :test :test-not :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4259 This function substitutes occurrences of @var{old} with @var{new}
Dave Love <fx@gnu.org>
parents:
diff changeset
4260 in @var{tree}, a tree of cons cells. It returns a substituted
Dave Love <fx@gnu.org>
parents:
diff changeset
4261 tree, which will be a copy except that it may share storage with
Dave Love <fx@gnu.org>
parents:
diff changeset
4262 the argument @var{tree} in parts where no substitutions occurred.
Dave Love <fx@gnu.org>
parents:
diff changeset
4263 The original @var{tree} is not modified. This function recurses
Dave Love <fx@gnu.org>
parents:
diff changeset
4264 on, and compares against @var{old}, both @code{car}s and @code{cdr}s
Dave Love <fx@gnu.org>
parents:
diff changeset
4265 of the component cons cells. If @var{old} is itself a cons cell,
Dave Love <fx@gnu.org>
parents:
diff changeset
4266 then matching cells in the tree are substituted as usual without
Dave Love <fx@gnu.org>
parents:
diff changeset
4267 recursively substituting in that cell. Comparisons with @var{old}
Dave Love <fx@gnu.org>
parents:
diff changeset
4268 are done according to the specified test (@code{eql} by default).
Dave Love <fx@gnu.org>
parents:
diff changeset
4269 The @code{:key} function is applied to the elements of the tree
Dave Love <fx@gnu.org>
parents:
diff changeset
4270 but not to @var{old}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4271 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4272
Dave Love <fx@gnu.org>
parents:
diff changeset
4273 @defun nsubst new old tree @t{&key :test :test-not :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4274 This function is like @code{subst}, except that it works by
Dave Love <fx@gnu.org>
parents:
diff changeset
4275 destructive modification (by @code{setcar} or @code{setcdr})
Dave Love <fx@gnu.org>
parents:
diff changeset
4276 rather than copying.
Dave Love <fx@gnu.org>
parents:
diff changeset
4277 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4278
Dave Love <fx@gnu.org>
parents:
diff changeset
4279 @findex subst-if
Dave Love <fx@gnu.org>
parents:
diff changeset
4280 @findex subst-if-not
Dave Love <fx@gnu.org>
parents:
diff changeset
4281 @findex nsubst-if
Dave Love <fx@gnu.org>
parents:
diff changeset
4282 @findex nsubst-if-not
Dave Love <fx@gnu.org>
parents:
diff changeset
4283 The @code{subst-if}, @code{subst-if-not}, @code{nsubst-if}, and
Dave Love <fx@gnu.org>
parents:
diff changeset
4284 @code{nsubst-if-not} functions are defined similarly.
Dave Love <fx@gnu.org>
parents:
diff changeset
4285
Dave Love <fx@gnu.org>
parents:
diff changeset
4286 @defun sublis alist tree @t{&key :test :test-not :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4287 This function is like @code{subst}, except that it takes an
Dave Love <fx@gnu.org>
parents:
diff changeset
4288 association list @var{alist} of @var{old}-@var{new} pairs.
Dave Love <fx@gnu.org>
parents:
diff changeset
4289 Each element of the tree (after applying the @code{:key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4290 function, if any), is compared with the @code{car}s of
Dave Love <fx@gnu.org>
parents:
diff changeset
4291 @var{alist}; if it matches, it is replaced by the corresponding
Dave Love <fx@gnu.org>
parents:
diff changeset
4292 @code{cdr}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4293 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4294
Dave Love <fx@gnu.org>
parents:
diff changeset
4295 @defun nsublis alist tree @t{&key :test :test-not :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4296 This is a destructive version of @code{sublis}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4297 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4298
Dave Love <fx@gnu.org>
parents:
diff changeset
4299 @node Lists as Sets, Association Lists, Substitution of Expressions, Lists
Dave Love <fx@gnu.org>
parents:
diff changeset
4300 @section Lists as Sets
Dave Love <fx@gnu.org>
parents:
diff changeset
4301
Dave Love <fx@gnu.org>
parents:
diff changeset
4302 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4303 These functions perform operations on lists which represent sets
Dave Love <fx@gnu.org>
parents:
diff changeset
4304 of elements.
Dave Love <fx@gnu.org>
parents:
diff changeset
4305
Dave Love <fx@gnu.org>
parents:
diff changeset
4306 @defun member* item list @t{&key :test :test-not :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4307 This function searches @var{list} for an element matching @var{item}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4308 If a match is found, it returns the cons cell whose @code{car} was
Dave Love <fx@gnu.org>
parents:
diff changeset
4309 the matching element. Otherwise, it returns @code{nil}. Elements
Dave Love <fx@gnu.org>
parents:
diff changeset
4310 are compared by @code{eql} by default; you can use the @code{:test},
Dave Love <fx@gnu.org>
parents:
diff changeset
4311 @code{:test-not}, and @code{:key} arguments to modify this behavior.
Dave Love <fx@gnu.org>
parents:
diff changeset
4312 @xref{Sequences}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4313
Dave Love <fx@gnu.org>
parents:
diff changeset
4314 Note that this function's name is suffixed by @samp{*} to avoid
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
4315 the incompatible @code{member} function defined in Emacs.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4316 (That function uses @code{equal} for comparisons; it is equivalent
Dave Love <fx@gnu.org>
parents:
diff changeset
4317 to @code{(member* @var{item} @var{list} :test 'equal)}.)
Dave Love <fx@gnu.org>
parents:
diff changeset
4318 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4319
Dave Love <fx@gnu.org>
parents:
diff changeset
4320 @findex member-if
Dave Love <fx@gnu.org>
parents:
diff changeset
4321 @findex member-if-not
Dave Love <fx@gnu.org>
parents:
diff changeset
4322 The @code{member-if} and @code{member-if-not} functions
Dave Love <fx@gnu.org>
parents:
diff changeset
4323 analogously search for elements which satisfy a given predicate.
Dave Love <fx@gnu.org>
parents:
diff changeset
4324
Dave Love <fx@gnu.org>
parents:
diff changeset
4325 @defun tailp sublist list
Dave Love <fx@gnu.org>
parents:
diff changeset
4326 This function returns @code{t} if @var{sublist} is a sublist of
Dave Love <fx@gnu.org>
parents:
diff changeset
4327 @var{list}, i.e., if @var{sublist} is @code{eql} to @var{list} or to
Dave Love <fx@gnu.org>
parents:
diff changeset
4328 any of its @code{cdr}s.
Dave Love <fx@gnu.org>
parents:
diff changeset
4329 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4330
Dave Love <fx@gnu.org>
parents:
diff changeset
4331 @defun adjoin item list @t{&key :test :test-not :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4332 This function conses @var{item} onto the front of @var{list},
Dave Love <fx@gnu.org>
parents:
diff changeset
4333 like @code{(cons @var{item} @var{list})}, but only if @var{item}
Dave Love <fx@gnu.org>
parents:
diff changeset
4334 is not already present on the list (as determined by @code{member*}).
Dave Love <fx@gnu.org>
parents:
diff changeset
4335 If a @code{:key} argument is specified, it is applied to
Dave Love <fx@gnu.org>
parents:
diff changeset
4336 @var{item} as well as to the elements of @var{list} during
Dave Love <fx@gnu.org>
parents:
diff changeset
4337 the search, on the reasoning that @var{item} is ``about'' to
Dave Love <fx@gnu.org>
parents:
diff changeset
4338 become part of the list.
Dave Love <fx@gnu.org>
parents:
diff changeset
4339 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4340
Dave Love <fx@gnu.org>
parents:
diff changeset
4341 @defun union list1 list2 @t{&key :test :test-not :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4342 This function combines two lists which represent sets of items,
Dave Love <fx@gnu.org>
parents:
diff changeset
4343 returning a list that represents the union of those two sets.
Dave Love <fx@gnu.org>
parents:
diff changeset
4344 The result list will contain all items which appear in @var{list1}
Dave Love <fx@gnu.org>
parents:
diff changeset
4345 or @var{list2}, and no others. If an item appears in both
Dave Love <fx@gnu.org>
parents:
diff changeset
4346 @var{list1} and @var{list2} it will be copied only once. If
Dave Love <fx@gnu.org>
parents:
diff changeset
4347 an item is duplicated in @var{list1} or @var{list2}, it is
Dave Love <fx@gnu.org>
parents:
diff changeset
4348 undefined whether or not that duplication will survive in the
Dave Love <fx@gnu.org>
parents:
diff changeset
4349 result list. The order of elements in the result list is also
Dave Love <fx@gnu.org>
parents:
diff changeset
4350 undefined.
Dave Love <fx@gnu.org>
parents:
diff changeset
4351 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4352
Dave Love <fx@gnu.org>
parents:
diff changeset
4353 @defun nunion list1 list2 @t{&key :test :test-not :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4354 This is a destructive version of @code{union}; rather than copying,
Dave Love <fx@gnu.org>
parents:
diff changeset
4355 it tries to reuse the storage of the argument lists if possible.
Dave Love <fx@gnu.org>
parents:
diff changeset
4356 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4357
Dave Love <fx@gnu.org>
parents:
diff changeset
4358 @defun intersection list1 list2 @t{&key :test :test-not :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4359 This function computes the intersection of the sets represented
Dave Love <fx@gnu.org>
parents:
diff changeset
4360 by @var{list1} and @var{list2}. It returns the list of items
Dave Love <fx@gnu.org>
parents:
diff changeset
4361 which appear in both @var{list1} and @var{list2}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4362 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4363
Dave Love <fx@gnu.org>
parents:
diff changeset
4364 @defun nintersection list1 list2 @t{&key :test :test-not :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4365 This is a destructive version of @code{intersection}. It
Dave Love <fx@gnu.org>
parents:
diff changeset
4366 tries to reuse storage of @var{list1} rather than copying.
Dave Love <fx@gnu.org>
parents:
diff changeset
4367 It does @emph{not} reuse the storage of @var{list2}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4368 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4369
Dave Love <fx@gnu.org>
parents:
diff changeset
4370 @defun set-difference list1 list2 @t{&key :test :test-not :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4371 This function computes the ``set difference'' of @var{list1}
Dave Love <fx@gnu.org>
parents:
diff changeset
4372 and @var{list2}, i.e., the set of elements that appear in
Dave Love <fx@gnu.org>
parents:
diff changeset
4373 @var{list1} but @emph{not} in @var{list2}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4374 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4375
Dave Love <fx@gnu.org>
parents:
diff changeset
4376 @defun nset-difference list1 list2 @t{&key :test :test-not :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4377 This is a destructive @code{set-difference}, which will try
Dave Love <fx@gnu.org>
parents:
diff changeset
4378 to reuse @var{list1} if possible.
Dave Love <fx@gnu.org>
parents:
diff changeset
4379 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4380
Dave Love <fx@gnu.org>
parents:
diff changeset
4381 @defun set-exclusive-or list1 list2 @t{&key :test :test-not :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4382 This function computes the ``set exclusive or'' of @var{list1}
Dave Love <fx@gnu.org>
parents:
diff changeset
4383 and @var{list2}, i.e., the set of elements that appear in
Dave Love <fx@gnu.org>
parents:
diff changeset
4384 exactly one of @var{list1} and @var{list2}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4385 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4386
Dave Love <fx@gnu.org>
parents:
diff changeset
4387 @defun nset-exclusive-or list1 list2 @t{&key :test :test-not :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4388 This is a destructive @code{set-exclusive-or}, which will try
Dave Love <fx@gnu.org>
parents:
diff changeset
4389 to reuse @var{list1} and @var{list2} if possible.
Dave Love <fx@gnu.org>
parents:
diff changeset
4390 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4391
Dave Love <fx@gnu.org>
parents:
diff changeset
4392 @defun subsetp list1 list2 @t{&key :test :test-not :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4393 This function checks whether @var{list1} represents a subset
Dave Love <fx@gnu.org>
parents:
diff changeset
4394 of @var{list2}, i.e., whether every element of @var{list1}
Dave Love <fx@gnu.org>
parents:
diff changeset
4395 also appears in @var{list2}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4396 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4397
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
4398 @node Association Lists, , Lists as Sets, Lists
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4399 @section Association Lists
Dave Love <fx@gnu.org>
parents:
diff changeset
4400
Dave Love <fx@gnu.org>
parents:
diff changeset
4401 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4402 An @dfn{association list} is a list representing a mapping from
Dave Love <fx@gnu.org>
parents:
diff changeset
4403 one set of values to another; any list whose elements are cons
Dave Love <fx@gnu.org>
parents:
diff changeset
4404 cells is an association list.
Dave Love <fx@gnu.org>
parents:
diff changeset
4405
Dave Love <fx@gnu.org>
parents:
diff changeset
4406 @defun assoc* item a-list @t{&key :test :test-not :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4407 This function searches the association list @var{a-list} for an
Dave Love <fx@gnu.org>
parents:
diff changeset
4408 element whose @code{car} matches (in the sense of @code{:test},
Dave Love <fx@gnu.org>
parents:
diff changeset
4409 @code{:test-not}, and @code{:key}, or by comparison with @code{eql})
Dave Love <fx@gnu.org>
parents:
diff changeset
4410 a given @var{item}. It returns the matching element, if any,
Dave Love <fx@gnu.org>
parents:
diff changeset
4411 otherwise @code{nil}. It ignores elements of @var{a-list} which
Dave Love <fx@gnu.org>
parents:
diff changeset
4412 are not cons cells. (This corresponds to the behavior of
Dave Love <fx@gnu.org>
parents:
diff changeset
4413 @code{assq} and @code{assoc} in Emacs Lisp; Common Lisp's
Dave Love <fx@gnu.org>
parents:
diff changeset
4414 @code{assoc} ignores @code{nil}s but considers any other non-cons
Dave Love <fx@gnu.org>
parents:
diff changeset
4415 elements of @var{a-list} to be an error.)
Dave Love <fx@gnu.org>
parents:
diff changeset
4416 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4417
Dave Love <fx@gnu.org>
parents:
diff changeset
4418 @defun rassoc* item a-list @t{&key :test :test-not :key}
Dave Love <fx@gnu.org>
parents:
diff changeset
4419 This function searches for an element whose @code{cdr} matches
Dave Love <fx@gnu.org>
parents:
diff changeset
4420 @var{item}. If @var{a-list} represents a mapping, this applies
Dave Love <fx@gnu.org>
parents:
diff changeset
4421 the inverse of the mapping to @var{item}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4422 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4423
Dave Love <fx@gnu.org>
parents:
diff changeset
4424 @findex assoc-if
Dave Love <fx@gnu.org>
parents:
diff changeset
4425 @findex assoc-if-not
Dave Love <fx@gnu.org>
parents:
diff changeset
4426 @findex rassoc-if
Dave Love <fx@gnu.org>
parents:
diff changeset
4427 @findex rassoc-if-not
Dave Love <fx@gnu.org>
parents:
diff changeset
4428 The @code{assoc-if}, @code{assoc-if-not}, @code{rassoc-if},
Dave Love <fx@gnu.org>
parents:
diff changeset
4429 and @code{rassoc-if-not} functions are defined similarly.
Dave Love <fx@gnu.org>
parents:
diff changeset
4430
Dave Love <fx@gnu.org>
parents:
diff changeset
4431 Two simple functions for constructing association lists are:
Dave Love <fx@gnu.org>
parents:
diff changeset
4432
Dave Love <fx@gnu.org>
parents:
diff changeset
4433 @defun acons key value alist
Dave Love <fx@gnu.org>
parents:
diff changeset
4434 This is equivalent to @code{(cons (cons @var{key} @var{value}) @var{alist})}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4435 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4436
Dave Love <fx@gnu.org>
parents:
diff changeset
4437 @defun pairlis keys values &optional alist
Dave Love <fx@gnu.org>
parents:
diff changeset
4438 This is equivalent to @code{(nconc (mapcar* 'cons @var{keys} @var{values})
Dave Love <fx@gnu.org>
parents:
diff changeset
4439 @var{alist})}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4440 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4441
Dave Love <fx@gnu.org>
parents:
diff changeset
4442 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
4443 @chapno=18
Dave Love <fx@gnu.org>
parents:
diff changeset
4444 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
4445
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
4446 @node Structures, Assertions, Lists, Top
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4447 @chapter Structures
Dave Love <fx@gnu.org>
parents:
diff changeset
4448
Dave Love <fx@gnu.org>
parents:
diff changeset
4449 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4450 The Common Lisp @dfn{structure} mechanism provides a general way
Dave Love <fx@gnu.org>
parents:
diff changeset
4451 to define data types similar to C's @code{struct} types. A
Dave Love <fx@gnu.org>
parents:
diff changeset
4452 structure is a Lisp object containing some number of @dfn{slots},
Dave Love <fx@gnu.org>
parents:
diff changeset
4453 each of which can hold any Lisp data object. Functions are
Dave Love <fx@gnu.org>
parents:
diff changeset
4454 provided for accessing and setting the slots, creating or copying
Dave Love <fx@gnu.org>
parents:
diff changeset
4455 structure objects, and recognizing objects of a particular structure
Dave Love <fx@gnu.org>
parents:
diff changeset
4456 type.
Dave Love <fx@gnu.org>
parents:
diff changeset
4457
Dave Love <fx@gnu.org>
parents:
diff changeset
4458 In true Common Lisp, each structure type is a new type distinct
Dave Love <fx@gnu.org>
parents:
diff changeset
4459 from all existing Lisp types. Since the underlying Emacs Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
4460 system provides no way to create new distinct types, this package
Dave Love <fx@gnu.org>
parents:
diff changeset
4461 implements structures as vectors (or lists upon request) with a
Dave Love <fx@gnu.org>
parents:
diff changeset
4462 special ``tag'' symbol to identify them.
Dave Love <fx@gnu.org>
parents:
diff changeset
4463
Dave Love <fx@gnu.org>
parents:
diff changeset
4464 @defspec defstruct name slots@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
4465 The @code{defstruct} form defines a new structure type called
Dave Love <fx@gnu.org>
parents:
diff changeset
4466 @var{name}, with the specified @var{slots}. (The @var{slots}
Dave Love <fx@gnu.org>
parents:
diff changeset
4467 may begin with a string which documents the structure type.)
Dave Love <fx@gnu.org>
parents:
diff changeset
4468 In the simplest case, @var{name} and each of the @var{slots}
Dave Love <fx@gnu.org>
parents:
diff changeset
4469 are symbols. For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
4470
Dave Love <fx@gnu.org>
parents:
diff changeset
4471 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4472 (defstruct person name age sex)
Dave Love <fx@gnu.org>
parents:
diff changeset
4473 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4474
Dave Love <fx@gnu.org>
parents:
diff changeset
4475 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4476 defines a struct type called @code{person} which contains three
Dave Love <fx@gnu.org>
parents:
diff changeset
4477 slots. Given a @code{person} object @var{p}, you can access those
Dave Love <fx@gnu.org>
parents:
diff changeset
4478 slots by calling @code{(person-name @var{p})}, @code{(person-age @var{p})},
Dave Love <fx@gnu.org>
parents:
diff changeset
4479 and @code{(person-sex @var{p})}. You can also change these slots by
Dave Love <fx@gnu.org>
parents:
diff changeset
4480 using @code{setf} on any of these place forms:
Dave Love <fx@gnu.org>
parents:
diff changeset
4481
Dave Love <fx@gnu.org>
parents:
diff changeset
4482 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4483 (incf (person-age birthday-boy))
Dave Love <fx@gnu.org>
parents:
diff changeset
4484 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4485
Dave Love <fx@gnu.org>
parents:
diff changeset
4486 You can create a new @code{person} by calling @code{make-person},
Dave Love <fx@gnu.org>
parents:
diff changeset
4487 which takes keyword arguments @code{:name}, @code{:age}, and
Dave Love <fx@gnu.org>
parents:
diff changeset
4488 @code{:sex} to specify the initial values of these slots in the
Dave Love <fx@gnu.org>
parents:
diff changeset
4489 new object. (Omitting any of these arguments leaves the corresponding
Dave Love <fx@gnu.org>
parents:
diff changeset
4490 slot ``undefined,'' according to the Common Lisp standard; in Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
4491 Lisp, such uninitialized slots are filled with @code{nil}.)
Dave Love <fx@gnu.org>
parents:
diff changeset
4492
Dave Love <fx@gnu.org>
parents:
diff changeset
4493 Given a @code{person}, @code{(copy-person @var{p})} makes a new
Dave Love <fx@gnu.org>
parents:
diff changeset
4494 object of the same type whose slots are @code{eq} to those of @var{p}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4495
Dave Love <fx@gnu.org>
parents:
diff changeset
4496 Given any Lisp object @var{x}, @code{(person-p @var{x})} returns
Dave Love <fx@gnu.org>
parents:
diff changeset
4497 true if @var{x} looks like a @code{person}, false otherwise. (Again,
Dave Love <fx@gnu.org>
parents:
diff changeset
4498 in Common Lisp this predicate would be exact; in Emacs Lisp the
Dave Love <fx@gnu.org>
parents:
diff changeset
4499 best it can do is verify that @var{x} is a vector of the correct
Dave Love <fx@gnu.org>
parents:
diff changeset
4500 length which starts with the correct tag symbol.)
Dave Love <fx@gnu.org>
parents:
diff changeset
4501
Dave Love <fx@gnu.org>
parents:
diff changeset
4502 Accessors like @code{person-name} normally check their arguments
Dave Love <fx@gnu.org>
parents:
diff changeset
4503 (effectively using @code{person-p}) and signal an error if the
Dave Love <fx@gnu.org>
parents:
diff changeset
4504 argument is the wrong type. This check is affected by
Dave Love <fx@gnu.org>
parents:
diff changeset
4505 @code{(optimize (safety @dots{}))} declarations. Safety level 1,
Dave Love <fx@gnu.org>
parents:
diff changeset
4506 the default, uses a somewhat optimized check that will detect all
Dave Love <fx@gnu.org>
parents:
diff changeset
4507 incorrect arguments, but may use an uninformative error message
Dave Love <fx@gnu.org>
parents:
diff changeset
4508 (e.g., ``expected a vector'' instead of ``expected a @code{person}'').
Dave Love <fx@gnu.org>
parents:
diff changeset
4509 Safety level 0 omits all checks except as provided by the underlying
Dave Love <fx@gnu.org>
parents:
diff changeset
4510 @code{aref} call; safety levels 2 and 3 do rigorous checking that will
Dave Love <fx@gnu.org>
parents:
diff changeset
4511 always print a descriptive error message for incorrect inputs.
Dave Love <fx@gnu.org>
parents:
diff changeset
4512 @xref{Declarations}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4513
Dave Love <fx@gnu.org>
parents:
diff changeset
4514 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4515 (setq dave (make-person :name "Dave" :sex 'male))
Dave Love <fx@gnu.org>
parents:
diff changeset
4516 @result{} [cl-struct-person "Dave" nil male]
Dave Love <fx@gnu.org>
parents:
diff changeset
4517 (setq other (copy-person dave))
Dave Love <fx@gnu.org>
parents:
diff changeset
4518 @result{} [cl-struct-person "Dave" nil male]
Dave Love <fx@gnu.org>
parents:
diff changeset
4519 (eq dave other)
Dave Love <fx@gnu.org>
parents:
diff changeset
4520 @result{} nil
Dave Love <fx@gnu.org>
parents:
diff changeset
4521 (eq (person-name dave) (person-name other))
Dave Love <fx@gnu.org>
parents:
diff changeset
4522 @result{} t
Dave Love <fx@gnu.org>
parents:
diff changeset
4523 (person-p dave)
Dave Love <fx@gnu.org>
parents:
diff changeset
4524 @result{} t
Dave Love <fx@gnu.org>
parents:
diff changeset
4525 (person-p [1 2 3 4])
Dave Love <fx@gnu.org>
parents:
diff changeset
4526 @result{} nil
Dave Love <fx@gnu.org>
parents:
diff changeset
4527 (person-p "Bogus")
Dave Love <fx@gnu.org>
parents:
diff changeset
4528 @result{} nil
Dave Love <fx@gnu.org>
parents:
diff changeset
4529 (person-p '[cl-struct-person counterfeit person object])
Dave Love <fx@gnu.org>
parents:
diff changeset
4530 @result{} t
Dave Love <fx@gnu.org>
parents:
diff changeset
4531 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4532
Dave Love <fx@gnu.org>
parents:
diff changeset
4533 In general, @var{name} is either a name symbol or a list of a name
Dave Love <fx@gnu.org>
parents:
diff changeset
4534 symbol followed by any number of @dfn{struct options}; each @var{slot}
Dave Love <fx@gnu.org>
parents:
diff changeset
4535 is either a slot symbol or a list of the form @samp{(@var{slot-name}
Dave Love <fx@gnu.org>
parents:
diff changeset
4536 @var{default-value} @var{slot-options}@dots{})}. The @var{default-value}
Dave Love <fx@gnu.org>
parents:
diff changeset
4537 is a Lisp form which is evaluated any time an instance of the
Dave Love <fx@gnu.org>
parents:
diff changeset
4538 structure type is created without specifying that slot's value.
Dave Love <fx@gnu.org>
parents:
diff changeset
4539
Dave Love <fx@gnu.org>
parents:
diff changeset
4540 Common Lisp defines several slot options, but the only one
Dave Love <fx@gnu.org>
parents:
diff changeset
4541 implemented in this package is @code{:read-only}. A non-@code{nil}
Dave Love <fx@gnu.org>
parents:
diff changeset
4542 value for this option means the slot should not be @code{setf}-able;
Dave Love <fx@gnu.org>
parents:
diff changeset
4543 the slot's value is determined when the object is created and does
Dave Love <fx@gnu.org>
parents:
diff changeset
4544 not change afterward.
Dave Love <fx@gnu.org>
parents:
diff changeset
4545
Dave Love <fx@gnu.org>
parents:
diff changeset
4546 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4547 (defstruct person
Dave Love <fx@gnu.org>
parents:
diff changeset
4548 (name nil :read-only t)
Dave Love <fx@gnu.org>
parents:
diff changeset
4549 age
Dave Love <fx@gnu.org>
parents:
diff changeset
4550 (sex 'unknown))
Dave Love <fx@gnu.org>
parents:
diff changeset
4551 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4552
Dave Love <fx@gnu.org>
parents:
diff changeset
4553 Any slot options other than @code{:read-only} are ignored.
Dave Love <fx@gnu.org>
parents:
diff changeset
4554
Dave Love <fx@gnu.org>
parents:
diff changeset
4555 For obscure historical reasons, structure options take a different
Dave Love <fx@gnu.org>
parents:
diff changeset
4556 form than slot options. A structure option is either a keyword
Dave Love <fx@gnu.org>
parents:
diff changeset
4557 symbol, or a list beginning with a keyword symbol possibly followed
Dave Love <fx@gnu.org>
parents:
diff changeset
4558 by arguments. (By contrast, slot options are key-value pairs not
Dave Love <fx@gnu.org>
parents:
diff changeset
4559 enclosed in lists.)
Dave Love <fx@gnu.org>
parents:
diff changeset
4560
Dave Love <fx@gnu.org>
parents:
diff changeset
4561 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4562 (defstruct (person (:constructor create-person)
Dave Love <fx@gnu.org>
parents:
diff changeset
4563 (:type list)
Dave Love <fx@gnu.org>
parents:
diff changeset
4564 :named)
Dave Love <fx@gnu.org>
parents:
diff changeset
4565 name age sex)
Dave Love <fx@gnu.org>
parents:
diff changeset
4566 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4567
Dave Love <fx@gnu.org>
parents:
diff changeset
4568 The following structure options are recognized.
Dave Love <fx@gnu.org>
parents:
diff changeset
4569
Dave Love <fx@gnu.org>
parents:
diff changeset
4570 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
4571 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
4572 @itemmax=0 in
Dave Love <fx@gnu.org>
parents:
diff changeset
4573 @advance@leftskip-.5@tableindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4574 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
4575 @item :conc-name
Dave Love <fx@gnu.org>
parents:
diff changeset
4576 The argument is a symbol whose print name is used as the prefix for
Dave Love <fx@gnu.org>
parents:
diff changeset
4577 the names of slot accessor functions. The default is the name of
Dave Love <fx@gnu.org>
parents:
diff changeset
4578 the struct type followed by a hyphen. The option @code{(:conc-name p-)}
Dave Love <fx@gnu.org>
parents:
diff changeset
4579 would change this prefix to @code{p-}. Specifying @code{nil} as an
Dave Love <fx@gnu.org>
parents:
diff changeset
4580 argument means no prefix, so that the slot names themselves are used
Dave Love <fx@gnu.org>
parents:
diff changeset
4581 to name the accessor functions.
Dave Love <fx@gnu.org>
parents:
diff changeset
4582
Dave Love <fx@gnu.org>
parents:
diff changeset
4583 @item :constructor
Dave Love <fx@gnu.org>
parents:
diff changeset
4584 In the simple case, this option takes one argument which is an
Dave Love <fx@gnu.org>
parents:
diff changeset
4585 alternate name to use for the constructor function. The default
Dave Love <fx@gnu.org>
parents:
diff changeset
4586 is @code{make-@var{name}}, e.g., @code{make-person}. The above
Dave Love <fx@gnu.org>
parents:
diff changeset
4587 example changes this to @code{create-person}. Specifying @code{nil}
Dave Love <fx@gnu.org>
parents:
diff changeset
4588 as an argument means that no standard constructor should be
Dave Love <fx@gnu.org>
parents:
diff changeset
4589 generated at all.
Dave Love <fx@gnu.org>
parents:
diff changeset
4590
Dave Love <fx@gnu.org>
parents:
diff changeset
4591 In the full form of this option, the constructor name is followed
Dave Love <fx@gnu.org>
parents:
diff changeset
4592 by an arbitrary argument list. @xref{Program Structure}, for a
Dave Love <fx@gnu.org>
parents:
diff changeset
4593 description of the format of Common Lisp argument lists. All
Dave Love <fx@gnu.org>
parents:
diff changeset
4594 options, such as @code{&rest} and @code{&key}, are supported.
Dave Love <fx@gnu.org>
parents:
diff changeset
4595 The argument names should match the slot names; each slot is
Dave Love <fx@gnu.org>
parents:
diff changeset
4596 initialized from the corresponding argument. Slots whose names
Dave Love <fx@gnu.org>
parents:
diff changeset
4597 do not appear in the argument list are initialized based on the
Dave Love <fx@gnu.org>
parents:
diff changeset
4598 @var{default-value} in their slot descriptor. Also, @code{&optional}
Dave Love <fx@gnu.org>
parents:
diff changeset
4599 and @code{&key} arguments which don't specify defaults take their
Dave Love <fx@gnu.org>
parents:
diff changeset
4600 defaults from the slot descriptor. It is legal to include arguments
Dave Love <fx@gnu.org>
parents:
diff changeset
4601 which don't correspond to slot names; these are useful if they are
Dave Love <fx@gnu.org>
parents:
diff changeset
4602 referred to in the defaults for optional, keyword, or @code{&aux}
Dave Love <fx@gnu.org>
parents:
diff changeset
4603 arguments which @emph{do} correspond to slots.
Dave Love <fx@gnu.org>
parents:
diff changeset
4604
Dave Love <fx@gnu.org>
parents:
diff changeset
4605 You can specify any number of full-format @code{:constructor}
Dave Love <fx@gnu.org>
parents:
diff changeset
4606 options on a structure. The default constructor is still generated
Dave Love <fx@gnu.org>
parents:
diff changeset
4607 as well unless you disable it with a simple-format @code{:constructor}
Dave Love <fx@gnu.org>
parents:
diff changeset
4608 option.
Dave Love <fx@gnu.org>
parents:
diff changeset
4609
Dave Love <fx@gnu.org>
parents:
diff changeset
4610 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4611 (defstruct
Dave Love <fx@gnu.org>
parents:
diff changeset
4612 (person
Dave Love <fx@gnu.org>
parents:
diff changeset
4613 (:constructor nil) ; no default constructor
Dave Love <fx@gnu.org>
parents:
diff changeset
4614 (:constructor new-person (name sex &optional (age 0)))
Dave Love <fx@gnu.org>
parents:
diff changeset
4615 (:constructor new-hound (&key (name "Rover")
Dave Love <fx@gnu.org>
parents:
diff changeset
4616 (dog-years 0)
Dave Love <fx@gnu.org>
parents:
diff changeset
4617 &aux (age (* 7 dog-years))
Dave Love <fx@gnu.org>
parents:
diff changeset
4618 (sex 'canine))))
Dave Love <fx@gnu.org>
parents:
diff changeset
4619 name age sex)
Dave Love <fx@gnu.org>
parents:
diff changeset
4620 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4621
Dave Love <fx@gnu.org>
parents:
diff changeset
4622 The first constructor here takes its arguments positionally rather
Dave Love <fx@gnu.org>
parents:
diff changeset
4623 than by keyword. (In official Common Lisp terminology, constructors
Dave Love <fx@gnu.org>
parents:
diff changeset
4624 that work By Order of Arguments instead of by keyword are called
Dave Love <fx@gnu.org>
parents:
diff changeset
4625 ``BOA constructors.'' No, I'm not making this up.) For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
4626 @code{(new-person "Jane" 'female)} generates a person whose slots
Dave Love <fx@gnu.org>
parents:
diff changeset
4627 are @code{"Jane"}, 0, and @code{female}, respectively.
Dave Love <fx@gnu.org>
parents:
diff changeset
4628
Dave Love <fx@gnu.org>
parents:
diff changeset
4629 The second constructor takes two keyword arguments, @code{:name},
Dave Love <fx@gnu.org>
parents:
diff changeset
4630 which initializes the @code{name} slot and defaults to @code{"Rover"},
Dave Love <fx@gnu.org>
parents:
diff changeset
4631 and @code{:dog-years}, which does not itself correspond to a slot
Dave Love <fx@gnu.org>
parents:
diff changeset
4632 but which is used to initialize the @code{age} slot. The @code{sex}
Dave Love <fx@gnu.org>
parents:
diff changeset
4633 slot is forced to the symbol @code{canine} with no syntax for
Dave Love <fx@gnu.org>
parents:
diff changeset
4634 overriding it.
Dave Love <fx@gnu.org>
parents:
diff changeset
4635
Dave Love <fx@gnu.org>
parents:
diff changeset
4636 @item :copier
Dave Love <fx@gnu.org>
parents:
diff changeset
4637 The argument is an alternate name for the copier function for
Dave Love <fx@gnu.org>
parents:
diff changeset
4638 this type. The default is @code{copy-@var{name}}. @code{nil}
Dave Love <fx@gnu.org>
parents:
diff changeset
4639 means not to generate a copier function. (In this implementation,
Dave Love <fx@gnu.org>
parents:
diff changeset
4640 all copier functions are simply synonyms for @code{copy-sequence}.)
Dave Love <fx@gnu.org>
parents:
diff changeset
4641
Dave Love <fx@gnu.org>
parents:
diff changeset
4642 @item :predicate
Dave Love <fx@gnu.org>
parents:
diff changeset
4643 The argument is an alternate name for the predicate which recognizes
Dave Love <fx@gnu.org>
parents:
diff changeset
4644 objects of this type. The default is @code{@var{name}-p}. @code{nil}
Dave Love <fx@gnu.org>
parents:
diff changeset
4645 means not to generate a predicate function. (If the @code{:type}
Dave Love <fx@gnu.org>
parents:
diff changeset
4646 option is used without the @code{:named} option, no predicate is
Dave Love <fx@gnu.org>
parents:
diff changeset
4647 ever generated.)
Dave Love <fx@gnu.org>
parents:
diff changeset
4648
Dave Love <fx@gnu.org>
parents:
diff changeset
4649 In true Common Lisp, @code{typep} is always able to recognize a
Dave Love <fx@gnu.org>
parents:
diff changeset
4650 structure object even if @code{:predicate} was used. In this
Dave Love <fx@gnu.org>
parents:
diff changeset
4651 package, @code{typep} simply looks for a function called
Dave Love <fx@gnu.org>
parents:
diff changeset
4652 @code{@var{typename}-p}, so it will work for structure types
Dave Love <fx@gnu.org>
parents:
diff changeset
4653 only if they used the default predicate name.
Dave Love <fx@gnu.org>
parents:
diff changeset
4654
Dave Love <fx@gnu.org>
parents:
diff changeset
4655 @item :include
Dave Love <fx@gnu.org>
parents:
diff changeset
4656 This option implements a very limited form of C++-style inheritance.
Dave Love <fx@gnu.org>
parents:
diff changeset
4657 The argument is the name of another structure type previously
Dave Love <fx@gnu.org>
parents:
diff changeset
4658 created with @code{defstruct}. The effect is to cause the new
Dave Love <fx@gnu.org>
parents:
diff changeset
4659 structure type to inherit all of the included structure's slots
Dave Love <fx@gnu.org>
parents:
diff changeset
4660 (plus, of course, any new slots described by this struct's slot
Dave Love <fx@gnu.org>
parents:
diff changeset
4661 descriptors). The new structure is considered a ``specialization''
Dave Love <fx@gnu.org>
parents:
diff changeset
4662 of the included one. In fact, the predicate and slot accessors
Dave Love <fx@gnu.org>
parents:
diff changeset
4663 for the included type will also accept objects of the new type.
Dave Love <fx@gnu.org>
parents:
diff changeset
4664
Dave Love <fx@gnu.org>
parents:
diff changeset
4665 If there are extra arguments to the @code{:include} option after
Dave Love <fx@gnu.org>
parents:
diff changeset
4666 the included-structure name, these options are treated as replacement
Dave Love <fx@gnu.org>
parents:
diff changeset
4667 slot descriptors for slots in the included structure, possibly with
Dave Love <fx@gnu.org>
parents:
diff changeset
4668 modified default values. Borrowing an example from Steele:
Dave Love <fx@gnu.org>
parents:
diff changeset
4669
Dave Love <fx@gnu.org>
parents:
diff changeset
4670 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4671 (defstruct person name (age 0) sex)
Dave Love <fx@gnu.org>
parents:
diff changeset
4672 @result{} person
Dave Love <fx@gnu.org>
parents:
diff changeset
4673 (defstruct (astronaut (:include person (age 45)))
Dave Love <fx@gnu.org>
parents:
diff changeset
4674 helmet-size
Dave Love <fx@gnu.org>
parents:
diff changeset
4675 (favorite-beverage 'tang))
Dave Love <fx@gnu.org>
parents:
diff changeset
4676 @result{} astronaut
Dave Love <fx@gnu.org>
parents:
diff changeset
4677
Dave Love <fx@gnu.org>
parents:
diff changeset
4678 (setq joe (make-person :name "Joe"))
Dave Love <fx@gnu.org>
parents:
diff changeset
4679 @result{} [cl-struct-person "Joe" 0 nil]
Dave Love <fx@gnu.org>
parents:
diff changeset
4680 (setq buzz (make-astronaut :name "Buzz"))
Dave Love <fx@gnu.org>
parents:
diff changeset
4681 @result{} [cl-struct-astronaut "Buzz" 45 nil nil tang]
Dave Love <fx@gnu.org>
parents:
diff changeset
4682
Dave Love <fx@gnu.org>
parents:
diff changeset
4683 (list (person-p joe) (person-p buzz))
Dave Love <fx@gnu.org>
parents:
diff changeset
4684 @result{} (t t)
Dave Love <fx@gnu.org>
parents:
diff changeset
4685 (list (astronaut-p joe) (astronaut-p buzz))
Dave Love <fx@gnu.org>
parents:
diff changeset
4686 @result{} (nil t)
Dave Love <fx@gnu.org>
parents:
diff changeset
4687
Dave Love <fx@gnu.org>
parents:
diff changeset
4688 (person-name buzz)
Dave Love <fx@gnu.org>
parents:
diff changeset
4689 @result{} "Buzz"
Dave Love <fx@gnu.org>
parents:
diff changeset
4690 (astronaut-name joe)
Dave Love <fx@gnu.org>
parents:
diff changeset
4691 @result{} error: "astronaut-name accessing a non-astronaut"
Dave Love <fx@gnu.org>
parents:
diff changeset
4692 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4693
Dave Love <fx@gnu.org>
parents:
diff changeset
4694 Thus, if @code{astronaut} is a specialization of @code{person},
Dave Love <fx@gnu.org>
parents:
diff changeset
4695 then every @code{astronaut} is also a @code{person} (but not the
Dave Love <fx@gnu.org>
parents:
diff changeset
4696 other way around). Every @code{astronaut} includes all the slots
Dave Love <fx@gnu.org>
parents:
diff changeset
4697 of a @code{person}, plus extra slots that are specific to
Dave Love <fx@gnu.org>
parents:
diff changeset
4698 astronauts. Operations that work on people (like @code{person-name})
Dave Love <fx@gnu.org>
parents:
diff changeset
4699 work on astronauts just like other people.
Dave Love <fx@gnu.org>
parents:
diff changeset
4700
Dave Love <fx@gnu.org>
parents:
diff changeset
4701 @item :print-function
Dave Love <fx@gnu.org>
parents:
diff changeset
4702 In full Common Lisp, this option allows you to specify a function
Dave Love <fx@gnu.org>
parents:
diff changeset
4703 which is called to print an instance of the structure type. The
Dave Love <fx@gnu.org>
parents:
diff changeset
4704 Emacs Lisp system offers no hooks into the Lisp printer which would
Dave Love <fx@gnu.org>
parents:
diff changeset
4705 allow for such a feature, so this package simply ignores
Dave Love <fx@gnu.org>
parents:
diff changeset
4706 @code{:print-function}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4707
Dave Love <fx@gnu.org>
parents:
diff changeset
4708 @item :type
Dave Love <fx@gnu.org>
parents:
diff changeset
4709 The argument should be one of the symbols @code{vector} or @code{list}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4710 This tells which underlying Lisp data type should be used to implement
Dave Love <fx@gnu.org>
parents:
diff changeset
4711 the new structure type. Vectors are used by default, but
Dave Love <fx@gnu.org>
parents:
diff changeset
4712 @code{(:type list)} will cause structure objects to be stored as
Dave Love <fx@gnu.org>
parents:
diff changeset
4713 lists instead.
Dave Love <fx@gnu.org>
parents:
diff changeset
4714
Dave Love <fx@gnu.org>
parents:
diff changeset
4715 The vector representation for structure objects has the advantage
Dave Love <fx@gnu.org>
parents:
diff changeset
4716 that all structure slots can be accessed quickly, although creating
Dave Love <fx@gnu.org>
parents:
diff changeset
4717 vectors is a bit slower in Emacs Lisp. Lists are easier to create,
Dave Love <fx@gnu.org>
parents:
diff changeset
4718 but take a relatively long time accessing the later slots.
Dave Love <fx@gnu.org>
parents:
diff changeset
4719
Dave Love <fx@gnu.org>
parents:
diff changeset
4720 @item :named
Dave Love <fx@gnu.org>
parents:
diff changeset
4721 This option, which takes no arguments, causes a characteristic ``tag''
Dave Love <fx@gnu.org>
parents:
diff changeset
4722 symbol to be stored at the front of the structure object. Using
Dave Love <fx@gnu.org>
parents:
diff changeset
4723 @code{:type} without also using @code{:named} will result in a
Dave Love <fx@gnu.org>
parents:
diff changeset
4724 structure type stored as plain vectors or lists with no identifying
Dave Love <fx@gnu.org>
parents:
diff changeset
4725 features.
Dave Love <fx@gnu.org>
parents:
diff changeset
4726
Dave Love <fx@gnu.org>
parents:
diff changeset
4727 The default, if you don't specify @code{:type} explicitly, is to
Dave Love <fx@gnu.org>
parents:
diff changeset
4728 use named vectors. Therefore, @code{:named} is only useful in
Dave Love <fx@gnu.org>
parents:
diff changeset
4729 conjunction with @code{:type}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4730
Dave Love <fx@gnu.org>
parents:
diff changeset
4731 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4732 (defstruct (person1) name age sex)
Dave Love <fx@gnu.org>
parents:
diff changeset
4733 (defstruct (person2 (:type list) :named) name age sex)
Dave Love <fx@gnu.org>
parents:
diff changeset
4734 (defstruct (person3 (:type list)) name age sex)
Dave Love <fx@gnu.org>
parents:
diff changeset
4735
Dave Love <fx@gnu.org>
parents:
diff changeset
4736 (setq p1 (make-person1))
Dave Love <fx@gnu.org>
parents:
diff changeset
4737 @result{} [cl-struct-person1 nil nil nil]
Dave Love <fx@gnu.org>
parents:
diff changeset
4738 (setq p2 (make-person2))
Dave Love <fx@gnu.org>
parents:
diff changeset
4739 @result{} (person2 nil nil nil)
Dave Love <fx@gnu.org>
parents:
diff changeset
4740 (setq p3 (make-person3))
Dave Love <fx@gnu.org>
parents:
diff changeset
4741 @result{} (nil nil nil)
Dave Love <fx@gnu.org>
parents:
diff changeset
4742
Dave Love <fx@gnu.org>
parents:
diff changeset
4743 (person1-p p1)
Dave Love <fx@gnu.org>
parents:
diff changeset
4744 @result{} t
Dave Love <fx@gnu.org>
parents:
diff changeset
4745 (person2-p p2)
Dave Love <fx@gnu.org>
parents:
diff changeset
4746 @result{} t
Dave Love <fx@gnu.org>
parents:
diff changeset
4747 (person3-p p3)
Dave Love <fx@gnu.org>
parents:
diff changeset
4748 @result{} error: function person3-p undefined
Dave Love <fx@gnu.org>
parents:
diff changeset
4749 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4750
Dave Love <fx@gnu.org>
parents:
diff changeset
4751 Since unnamed structures don't have tags, @code{defstruct} is not
Dave Love <fx@gnu.org>
parents:
diff changeset
4752 able to make a useful predicate for recognizing them. Also,
Dave Love <fx@gnu.org>
parents:
diff changeset
4753 accessors like @code{person3-name} will be generated but they
Dave Love <fx@gnu.org>
parents:
diff changeset
4754 will not be able to do any type checking. The @code{person3-name}
Dave Love <fx@gnu.org>
parents:
diff changeset
4755 function, for example, will simply be a synonym for @code{car} in
Dave Love <fx@gnu.org>
parents:
diff changeset
4756 this case. By contrast, @code{person2-name} is able to verify
Dave Love <fx@gnu.org>
parents:
diff changeset
4757 that its argument is indeed a @code{person2} object before
Dave Love <fx@gnu.org>
parents:
diff changeset
4758 proceeding.
Dave Love <fx@gnu.org>
parents:
diff changeset
4759
Dave Love <fx@gnu.org>
parents:
diff changeset
4760 @item :initial-offset
Dave Love <fx@gnu.org>
parents:
diff changeset
4761 The argument must be a nonnegative integer. It specifies a
Dave Love <fx@gnu.org>
parents:
diff changeset
4762 number of slots to be left ``empty'' at the front of the
Dave Love <fx@gnu.org>
parents:
diff changeset
4763 structure. If the structure is named, the tag appears at the
Dave Love <fx@gnu.org>
parents:
diff changeset
4764 specified position in the list or vector; otherwise, the first
Dave Love <fx@gnu.org>
parents:
diff changeset
4765 slot appears at that position. Earlier positions are filled
Dave Love <fx@gnu.org>
parents:
diff changeset
4766 with @code{nil} by the constructors and ignored otherwise. If
Dave Love <fx@gnu.org>
parents:
diff changeset
4767 the type @code{:include}s another type, then @code{:initial-offset}
Dave Love <fx@gnu.org>
parents:
diff changeset
4768 specifies a number of slots to be skipped between the last slot
Dave Love <fx@gnu.org>
parents:
diff changeset
4769 of the included type and the first new slot.
Dave Love <fx@gnu.org>
parents:
diff changeset
4770 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
4771 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
4772
Dave Love <fx@gnu.org>
parents:
diff changeset
4773 Except as noted, the @code{defstruct} facility of this package is
Dave Love <fx@gnu.org>
parents:
diff changeset
4774 entirely compatible with that of Common Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
4775
Dave Love <fx@gnu.org>
parents:
diff changeset
4776 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
4777 @chapno=23
Dave Love <fx@gnu.org>
parents:
diff changeset
4778 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
4779
Dave Love <fx@gnu.org>
parents:
diff changeset
4780 @node Assertions, Efficiency Concerns, Structures, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
4781 @chapter Assertions and Errors
Dave Love <fx@gnu.org>
parents:
diff changeset
4782
Dave Love <fx@gnu.org>
parents:
diff changeset
4783 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4784 This section describes two macros that test @dfn{assertions}, i.e.,
Dave Love <fx@gnu.org>
parents:
diff changeset
4785 conditions which must be true if the program is operating correctly.
Dave Love <fx@gnu.org>
parents:
diff changeset
4786 Assertions never add to the behavior of a Lisp program; they simply
Dave Love <fx@gnu.org>
parents:
diff changeset
4787 make ``sanity checks'' to make sure everything is as it should be.
Dave Love <fx@gnu.org>
parents:
diff changeset
4788
Dave Love <fx@gnu.org>
parents:
diff changeset
4789 If the optimization property @code{speed} has been set to 3, and
Dave Love <fx@gnu.org>
parents:
diff changeset
4790 @code{safety} is less than 3, then the byte-compiler will optimize
Dave Love <fx@gnu.org>
parents:
diff changeset
4791 away the following assertions. Because assertions might be optimized
Dave Love <fx@gnu.org>
parents:
diff changeset
4792 away, it is a bad idea for them to include side-effects.
Dave Love <fx@gnu.org>
parents:
diff changeset
4793
Dave Love <fx@gnu.org>
parents:
diff changeset
4794 @defspec assert test-form [show-args string args@dots{}]
Dave Love <fx@gnu.org>
parents:
diff changeset
4795 This form verifies that @var{test-form} is true (i.e., evaluates to
Dave Love <fx@gnu.org>
parents:
diff changeset
4796 a non-@code{nil} value). If so, it returns @code{nil}. If the test
Dave Love <fx@gnu.org>
parents:
diff changeset
4797 is not satisfied, @code{assert} signals an error.
Dave Love <fx@gnu.org>
parents:
diff changeset
4798
Dave Love <fx@gnu.org>
parents:
diff changeset
4799 A default error message will be supplied which includes @var{test-form}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4800 You can specify a different error message by including a @var{string}
Dave Love <fx@gnu.org>
parents:
diff changeset
4801 argument plus optional extra arguments. Those arguments are simply
Dave Love <fx@gnu.org>
parents:
diff changeset
4802 passed to @code{error} to signal the error.
Dave Love <fx@gnu.org>
parents:
diff changeset
4803
Dave Love <fx@gnu.org>
parents:
diff changeset
4804 If the optional second argument @var{show-args} is @code{t} instead
Dave Love <fx@gnu.org>
parents:
diff changeset
4805 of @code{nil}, then the error message (with or without @var{string})
Dave Love <fx@gnu.org>
parents:
diff changeset
4806 will also include all non-constant arguments of the top-level
Dave Love <fx@gnu.org>
parents:
diff changeset
4807 @var{form}. For example:
Dave Love <fx@gnu.org>
parents:
diff changeset
4808
Dave Love <fx@gnu.org>
parents:
diff changeset
4809 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4810 (assert (> x 10) t "x is too small: %d")
Dave Love <fx@gnu.org>
parents:
diff changeset
4811 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4812
Dave Love <fx@gnu.org>
parents:
diff changeset
4813 This usage of @var{show-args} is an extension to Common Lisp. In
Dave Love <fx@gnu.org>
parents:
diff changeset
4814 true Common Lisp, the second argument gives a list of @var{places}
Dave Love <fx@gnu.org>
parents:
diff changeset
4815 which can be @code{setf}'d by the user before continuing from the
Dave Love <fx@gnu.org>
parents:
diff changeset
4816 error. Since Emacs Lisp does not support continuable errors, it
Dave Love <fx@gnu.org>
parents:
diff changeset
4817 makes no sense to specify @var{places}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4818 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
4819
Dave Love <fx@gnu.org>
parents:
diff changeset
4820 @defspec check-type form type [string]
Dave Love <fx@gnu.org>
parents:
diff changeset
4821 This form verifies that @var{form} evaluates to a value of type
Dave Love <fx@gnu.org>
parents:
diff changeset
4822 @var{type}. If so, it returns @code{nil}. If not, @code{check-type}
Dave Love <fx@gnu.org>
parents:
diff changeset
4823 signals a @code{wrong-type-argument} error. The default error message
Dave Love <fx@gnu.org>
parents:
diff changeset
4824 lists the erroneous value along with @var{type} and @var{form}
Dave Love <fx@gnu.org>
parents:
diff changeset
4825 themselves. If @var{string} is specified, it is included in the
Dave Love <fx@gnu.org>
parents:
diff changeset
4826 error message in place of @var{type}. For example:
Dave Love <fx@gnu.org>
parents:
diff changeset
4827
Dave Love <fx@gnu.org>
parents:
diff changeset
4828 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4829 (check-type x (integer 1 *) "a positive integer")
Dave Love <fx@gnu.org>
parents:
diff changeset
4830 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4831
Dave Love <fx@gnu.org>
parents:
diff changeset
4832 @xref{Type Predicates}, for a description of the type specifiers
Dave Love <fx@gnu.org>
parents:
diff changeset
4833 that may be used for @var{type}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4834
Dave Love <fx@gnu.org>
parents:
diff changeset
4835 Note that in Common Lisp, the first argument to @code{check-type}
Dave Love <fx@gnu.org>
parents:
diff changeset
4836 must be a @var{place} suitable for use by @code{setf}, because
Dave Love <fx@gnu.org>
parents:
diff changeset
4837 @code{check-type} signals a continuable error that allows the
Dave Love <fx@gnu.org>
parents:
diff changeset
4838 user to modify @var{place}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4839 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
4840
Dave Love <fx@gnu.org>
parents:
diff changeset
4841 The following error-related macro is also defined:
Dave Love <fx@gnu.org>
parents:
diff changeset
4842
Dave Love <fx@gnu.org>
parents:
diff changeset
4843 @defspec ignore-errors forms@dots{}
Dave Love <fx@gnu.org>
parents:
diff changeset
4844 This executes @var{forms} exactly like a @code{progn}, except that
Dave Love <fx@gnu.org>
parents:
diff changeset
4845 errors are ignored during the @var{forms}. More precisely, if
Dave Love <fx@gnu.org>
parents:
diff changeset
4846 an error is signaled then @code{ignore-errors} immediately
Dave Love <fx@gnu.org>
parents:
diff changeset
4847 aborts execution of the @var{forms} and returns @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4848 If the @var{forms} complete successfully, @code{ignore-errors}
Dave Love <fx@gnu.org>
parents:
diff changeset
4849 returns the result of the last @var{form}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4850 @end defspec
Dave Love <fx@gnu.org>
parents:
diff changeset
4851
Dave Love <fx@gnu.org>
parents:
diff changeset
4852 @node Efficiency Concerns, Common Lisp Compatibility, Assertions, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
4853 @appendix Efficiency Concerns
Dave Love <fx@gnu.org>
parents:
diff changeset
4854
Dave Love <fx@gnu.org>
parents:
diff changeset
4855 @appendixsec Macros
Dave Love <fx@gnu.org>
parents:
diff changeset
4856
Dave Love <fx@gnu.org>
parents:
diff changeset
4857 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4858 Many of the advanced features of this package, such as @code{defun*},
Dave Love <fx@gnu.org>
parents:
diff changeset
4859 @code{loop}, and @code{setf}, are implemented as Lisp macros. In
Dave Love <fx@gnu.org>
parents:
diff changeset
4860 byte-compiled code, these complex notations will be expanded into
Dave Love <fx@gnu.org>
parents:
diff changeset
4861 equivalent Lisp code which is simple and efficient. For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
4862 the forms
Dave Love <fx@gnu.org>
parents:
diff changeset
4863
Dave Love <fx@gnu.org>
parents:
diff changeset
4864 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4865 (incf i n)
Dave Love <fx@gnu.org>
parents:
diff changeset
4866 (push x (car p))
Dave Love <fx@gnu.org>
parents:
diff changeset
4867 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4868
Dave Love <fx@gnu.org>
parents:
diff changeset
4869 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4870 are expanded at compile-time to the Lisp forms
Dave Love <fx@gnu.org>
parents:
diff changeset
4871
Dave Love <fx@gnu.org>
parents:
diff changeset
4872 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4873 (setq i (+ i n))
Dave Love <fx@gnu.org>
parents:
diff changeset
4874 (setcar p (cons x (car p)))
Dave Love <fx@gnu.org>
parents:
diff changeset
4875 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4876
Dave Love <fx@gnu.org>
parents:
diff changeset
4877 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4878 which are the most efficient ways of doing these respective operations
Dave Love <fx@gnu.org>
parents:
diff changeset
4879 in Lisp. Thus, there is no performance penalty for using the more
Dave Love <fx@gnu.org>
parents:
diff changeset
4880 readable @code{incf} and @code{push} forms in your compiled code.
Dave Love <fx@gnu.org>
parents:
diff changeset
4881
Dave Love <fx@gnu.org>
parents:
diff changeset
4882 @emph{Interpreted} code, on the other hand, must expand these macros
Dave Love <fx@gnu.org>
parents:
diff changeset
4883 every time they are executed. For this reason it is strongly
Dave Love <fx@gnu.org>
parents:
diff changeset
4884 recommended that code making heavy use of macros be compiled.
Dave Love <fx@gnu.org>
parents:
diff changeset
4885 (The features labeled ``Special Form'' instead of ``Function'' in
Dave Love <fx@gnu.org>
parents:
diff changeset
4886 this manual are macros.) A loop using @code{incf} a hundred times
Dave Love <fx@gnu.org>
parents:
diff changeset
4887 will execute considerably faster if compiled, and will also
Dave Love <fx@gnu.org>
parents:
diff changeset
4888 garbage-collect less because the macro expansion will not have
Dave Love <fx@gnu.org>
parents:
diff changeset
4889 to be generated, used, and thrown away a hundred times.
Dave Love <fx@gnu.org>
parents:
diff changeset
4890
Dave Love <fx@gnu.org>
parents:
diff changeset
4891 You can find out how a macro expands by using the
Dave Love <fx@gnu.org>
parents:
diff changeset
4892 @code{cl-prettyexpand} function.
Dave Love <fx@gnu.org>
parents:
diff changeset
4893
Dave Love <fx@gnu.org>
parents:
diff changeset
4894 @defun cl-prettyexpand form &optional full
Dave Love <fx@gnu.org>
parents:
diff changeset
4895 This function takes a single Lisp form as an argument and inserts
Dave Love <fx@gnu.org>
parents:
diff changeset
4896 a nicely formatted copy of it in the current buffer (which must be
Dave Love <fx@gnu.org>
parents:
diff changeset
4897 in Lisp mode so that indentation works properly). It also expands
Dave Love <fx@gnu.org>
parents:
diff changeset
4898 all Lisp macros which appear in the form. The easiest way to use
Dave Love <fx@gnu.org>
parents:
diff changeset
4899 this function is to go to the @code{*scratch*} buffer and type, say,
Dave Love <fx@gnu.org>
parents:
diff changeset
4900
Dave Love <fx@gnu.org>
parents:
diff changeset
4901 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4902 (cl-prettyexpand '(loop for x below 10 collect x))
Dave Love <fx@gnu.org>
parents:
diff changeset
4903 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4904
Dave Love <fx@gnu.org>
parents:
diff changeset
4905 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4906 and type @kbd{C-x C-e} immediately after the closing parenthesis;
Dave Love <fx@gnu.org>
parents:
diff changeset
4907 the expansion
Dave Love <fx@gnu.org>
parents:
diff changeset
4908
Dave Love <fx@gnu.org>
parents:
diff changeset
4909 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4910 (block nil
Dave Love <fx@gnu.org>
parents:
diff changeset
4911 (let* ((x 0)
Dave Love <fx@gnu.org>
parents:
diff changeset
4912 (G1004 nil))
Dave Love <fx@gnu.org>
parents:
diff changeset
4913 (while (< x 10)
Dave Love <fx@gnu.org>
parents:
diff changeset
4914 (setq G1004 (cons x G1004))
Dave Love <fx@gnu.org>
parents:
diff changeset
4915 (setq x (+ x 1)))
Dave Love <fx@gnu.org>
parents:
diff changeset
4916 (nreverse G1004)))
Dave Love <fx@gnu.org>
parents:
diff changeset
4917 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4918
Dave Love <fx@gnu.org>
parents:
diff changeset
4919 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4920 will be inserted into the buffer. (The @code{block} macro is
Dave Love <fx@gnu.org>
parents:
diff changeset
4921 expanded differently in the interpreter and compiler, so
Dave Love <fx@gnu.org>
parents:
diff changeset
4922 @code{cl-prettyexpand} just leaves it alone. The temporary
Dave Love <fx@gnu.org>
parents:
diff changeset
4923 variable @code{G1004} was created by @code{gensym}.)
Dave Love <fx@gnu.org>
parents:
diff changeset
4924
Dave Love <fx@gnu.org>
parents:
diff changeset
4925 If the optional argument @var{full} is true, then @emph{all}
Dave Love <fx@gnu.org>
parents:
diff changeset
4926 macros are expanded, including @code{block}, @code{eval-when},
Dave Love <fx@gnu.org>
parents:
diff changeset
4927 and compiler macros. Expansion is done as if @var{form} were
Dave Love <fx@gnu.org>
parents:
diff changeset
4928 a top-level form in a file being compiled. For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
4929
Dave Love <fx@gnu.org>
parents:
diff changeset
4930 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4931 (cl-prettyexpand '(pushnew 'x list))
Dave Love <fx@gnu.org>
parents:
diff changeset
4932 @print{} (setq list (adjoin 'x list))
Dave Love <fx@gnu.org>
parents:
diff changeset
4933 (cl-prettyexpand '(pushnew 'x list) t)
Dave Love <fx@gnu.org>
parents:
diff changeset
4934 @print{} (setq list (if (memq 'x list) list (cons 'x list)))
Dave Love <fx@gnu.org>
parents:
diff changeset
4935 (cl-prettyexpand '(caddr (member* 'a list)) t)
Dave Love <fx@gnu.org>
parents:
diff changeset
4936 @print{} (car (cdr (cdr (memq 'a list))))
Dave Love <fx@gnu.org>
parents:
diff changeset
4937 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4938
Dave Love <fx@gnu.org>
parents:
diff changeset
4939 Note that @code{adjoin}, @code{caddr}, and @code{member*} all
Dave Love <fx@gnu.org>
parents:
diff changeset
4940 have built-in compiler macros to optimize them in common cases.
Dave Love <fx@gnu.org>
parents:
diff changeset
4941 @end defun
Dave Love <fx@gnu.org>
parents:
diff changeset
4942
Dave Love <fx@gnu.org>
parents:
diff changeset
4943 @ifinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
4944 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4945
Dave Love <fx@gnu.org>
parents:
diff changeset
4946 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4947 @end ifinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
4948 @appendixsec Error Checking
Dave Love <fx@gnu.org>
parents:
diff changeset
4949
Dave Love <fx@gnu.org>
parents:
diff changeset
4950 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4951 Common Lisp compliance has in general not been sacrificed for the
Dave Love <fx@gnu.org>
parents:
diff changeset
4952 sake of efficiency. A few exceptions have been made for cases
Dave Love <fx@gnu.org>
parents:
diff changeset
4953 where substantial gains were possible at the expense of marginal
33295
d66d9f108b83 Remove obsolete warnings about use of memq for keyword args.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 32315
diff changeset
4954 incompatibility.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4955
Dave Love <fx@gnu.org>
parents:
diff changeset
4956 The Common Lisp standard (as embodied in Steele's book) uses the
Dave Love <fx@gnu.org>
parents:
diff changeset
4957 phrase ``it is an error if'' to indicate a situation which is not
Dave Love <fx@gnu.org>
parents:
diff changeset
4958 supposed to arise in complying programs; implementations are strongly
Dave Love <fx@gnu.org>
parents:
diff changeset
4959 encouraged but not required to signal an error in these situations.
Dave Love <fx@gnu.org>
parents:
diff changeset
4960 This package sometimes omits such error checking in the interest of
Dave Love <fx@gnu.org>
parents:
diff changeset
4961 compactness and efficiency. For example, @code{do} variable
Dave Love <fx@gnu.org>
parents:
diff changeset
4962 specifiers are supposed to be lists of one, two, or three forms;
Dave Love <fx@gnu.org>
parents:
diff changeset
4963 extra forms are ignored by this package rather than signaling a
Dave Love <fx@gnu.org>
parents:
diff changeset
4964 syntax error. The @code{endp} function is simply a synonym for
Dave Love <fx@gnu.org>
parents:
diff changeset
4965 @code{null} in this package. Functions taking keyword arguments
Dave Love <fx@gnu.org>
parents:
diff changeset
4966 will accept an odd number of arguments, treating the trailing
Dave Love <fx@gnu.org>
parents:
diff changeset
4967 keyword as if it were followed by the value @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4968
Dave Love <fx@gnu.org>
parents:
diff changeset
4969 Argument lists (as processed by @code{defun*} and friends)
Dave Love <fx@gnu.org>
parents:
diff changeset
4970 @emph{are} checked rigorously except for the minor point just
Dave Love <fx@gnu.org>
parents:
diff changeset
4971 mentioned; in particular, keyword arguments are checked for
Dave Love <fx@gnu.org>
parents:
diff changeset
4972 validity, and @code{&allow-other-keys} and @code{:allow-other-keys}
Dave Love <fx@gnu.org>
parents:
diff changeset
4973 are fully implemented. Keyword validity checking is slightly
Dave Love <fx@gnu.org>
parents:
diff changeset
4974 time consuming (though not too bad in byte-compiled code);
Dave Love <fx@gnu.org>
parents:
diff changeset
4975 you can use @code{&allow-other-keys} to omit this check. Functions
Dave Love <fx@gnu.org>
parents:
diff changeset
4976 defined in this package such as @code{find} and @code{member*}
Dave Love <fx@gnu.org>
parents:
diff changeset
4977 do check their keyword arguments for validity.
Dave Love <fx@gnu.org>
parents:
diff changeset
4978
Dave Love <fx@gnu.org>
parents:
diff changeset
4979 @ifinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
4980 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4981
Dave Love <fx@gnu.org>
parents:
diff changeset
4982 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4983 @end ifinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
4984 @appendixsec Optimizing Compiler
Dave Love <fx@gnu.org>
parents:
diff changeset
4985
Dave Love <fx@gnu.org>
parents:
diff changeset
4986 @noindent
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
4987 Use of the optimizing Emacs compiler is highly recommended; many of the Common
27225
ee242fddb1ab Remove various old stuff and references thereto.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
4988 Lisp macros emit
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4989 code which can be improved by optimization. In particular,
Dave Love <fx@gnu.org>
parents:
diff changeset
4990 @code{block}s (whether explicit or implicit in constructs like
Dave Love <fx@gnu.org>
parents:
diff changeset
4991 @code{defun*} and @code{loop}) carry a fair run-time penalty; the
Dave Love <fx@gnu.org>
parents:
diff changeset
4992 optimizing compiler removes @code{block}s which are not actually
Dave Love <fx@gnu.org>
parents:
diff changeset
4993 referenced by @code{return} or @code{return-from} inside the block.
Dave Love <fx@gnu.org>
parents:
diff changeset
4994
Dave Love <fx@gnu.org>
parents:
diff changeset
4995 @node Common Lisp Compatibility, Old CL Compatibility, Efficiency Concerns, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
4996 @appendix Common Lisp Compatibility
Dave Love <fx@gnu.org>
parents:
diff changeset
4997
Dave Love <fx@gnu.org>
parents:
diff changeset
4998 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4999 Following is a list of all known incompatibilities between this
Dave Love <fx@gnu.org>
parents:
diff changeset
5000 package and Common Lisp as documented in Steele (2nd edition).
Dave Love <fx@gnu.org>
parents:
diff changeset
5001
Dave Love <fx@gnu.org>
parents:
diff changeset
5002 Certain function names, such as @code{member}, @code{assoc}, and
Dave Love <fx@gnu.org>
parents:
diff changeset
5003 @code{floor}, were already taken by (incompatible) Emacs Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
5004 functions; this package appends @samp{*} to the names of its
Dave Love <fx@gnu.org>
parents:
diff changeset
5005 Common Lisp versions of these functions.
Dave Love <fx@gnu.org>
parents:
diff changeset
5006
Dave Love <fx@gnu.org>
parents:
diff changeset
5007 The word @code{defun*} is required instead of @code{defun} in order
Dave Love <fx@gnu.org>
parents:
diff changeset
5008 to use extended Common Lisp argument lists in a function. Likewise,
Dave Love <fx@gnu.org>
parents:
diff changeset
5009 @code{defmacro*} and @code{function*} are versions of those forms
Dave Love <fx@gnu.org>
parents:
diff changeset
5010 which understand full-featured argument lists. The @code{&whole}
Dave Love <fx@gnu.org>
parents:
diff changeset
5011 keyword does not work in @code{defmacro} argument lists (except
Dave Love <fx@gnu.org>
parents:
diff changeset
5012 inside recursive argument lists).
Dave Love <fx@gnu.org>
parents:
diff changeset
5013
Dave Love <fx@gnu.org>
parents:
diff changeset
5014 The @code{eql} and @code{equal} predicates do not distinguish
Dave Love <fx@gnu.org>
parents:
diff changeset
5015 between IEEE floating-point plus and minus zero. The @code{equalp}
Dave Love <fx@gnu.org>
parents:
diff changeset
5016 predicate has several differences with Common Lisp; @pxref{Predicates}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5017
Dave Love <fx@gnu.org>
parents:
diff changeset
5018 The @code{setf} mechanism is entirely compatible, except that
Dave Love <fx@gnu.org>
parents:
diff changeset
5019 setf-methods return a list of five values rather than five
Dave Love <fx@gnu.org>
parents:
diff changeset
5020 values directly. Also, the new ``@code{setf} function'' concept
Dave Love <fx@gnu.org>
parents:
diff changeset
5021 (typified by @code{(defun (setf foo) @dots{})}) is not implemented.
Dave Love <fx@gnu.org>
parents:
diff changeset
5022
Dave Love <fx@gnu.org>
parents:
diff changeset
5023 The @code{do-all-symbols} form is the same as @code{do-symbols}
Dave Love <fx@gnu.org>
parents:
diff changeset
5024 with no @var{obarray} argument. In Common Lisp, this form would
Dave Love <fx@gnu.org>
parents:
diff changeset
5025 iterate over all symbols in all packages. Since Emacs obarrays
Dave Love <fx@gnu.org>
parents:
diff changeset
5026 are not a first-class package mechanism, there is no way for
Dave Love <fx@gnu.org>
parents:
diff changeset
5027 @code{do-all-symbols} to locate any but the default obarray.
Dave Love <fx@gnu.org>
parents:
diff changeset
5028
Dave Love <fx@gnu.org>
parents:
diff changeset
5029 The @code{loop} macro is complete except that @code{loop-finish}
Dave Love <fx@gnu.org>
parents:
diff changeset
5030 and type specifiers are unimplemented.
Dave Love <fx@gnu.org>
parents:
diff changeset
5031
Dave Love <fx@gnu.org>
parents:
diff changeset
5032 The multiple-value return facility treats lists as multiple
Dave Love <fx@gnu.org>
parents:
diff changeset
5033 values, since Emacs Lisp cannot support multiple return values
Dave Love <fx@gnu.org>
parents:
diff changeset
5034 directly. The macros will be compatible with Common Lisp if
Dave Love <fx@gnu.org>
parents:
diff changeset
5035 @code{values} or @code{values-list} is always used to return to
Dave Love <fx@gnu.org>
parents:
diff changeset
5036 a @code{multiple-value-bind} or other multiple-value receiver;
Dave Love <fx@gnu.org>
parents:
diff changeset
5037 if @code{values} is used without @code{multiple-value-@dots{}}
Dave Love <fx@gnu.org>
parents:
diff changeset
5038 or vice-versa the effect will be different from Common Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
5039
Dave Love <fx@gnu.org>
parents:
diff changeset
5040 Many Common Lisp declarations are ignored, and others match
Dave Love <fx@gnu.org>
parents:
diff changeset
5041 the Common Lisp standard in concept but not in detail. For
Dave Love <fx@gnu.org>
parents:
diff changeset
5042 example, local @code{special} declarations, which are purely
Dave Love <fx@gnu.org>
parents:
diff changeset
5043 advisory in Emacs Lisp, do not rigorously obey the scoping rules
Dave Love <fx@gnu.org>
parents:
diff changeset
5044 set down in Steele's book.
Dave Love <fx@gnu.org>
parents:
diff changeset
5045
Dave Love <fx@gnu.org>
parents:
diff changeset
5046 The variable @code{*gensym-counter*} starts out with a pseudo-random
Dave Love <fx@gnu.org>
parents:
diff changeset
5047 value rather than with zero. This is to cope with the fact that
Dave Love <fx@gnu.org>
parents:
diff changeset
5048 generated symbols become interned when they are written to and
Dave Love <fx@gnu.org>
parents:
diff changeset
5049 loaded back from a file.
Dave Love <fx@gnu.org>
parents:
diff changeset
5050
Dave Love <fx@gnu.org>
parents:
diff changeset
5051 The @code{defstruct} facility is compatible, except that structures
Dave Love <fx@gnu.org>
parents:
diff changeset
5052 are of type @code{:type vector :named} by default rather than some
Dave Love <fx@gnu.org>
parents:
diff changeset
5053 special, distinct type. Also, the @code{:type} slot option is ignored.
Dave Love <fx@gnu.org>
parents:
diff changeset
5054
Dave Love <fx@gnu.org>
parents:
diff changeset
5055 The second argument of @code{check-type} is treated differently.
Dave Love <fx@gnu.org>
parents:
diff changeset
5056
Dave Love <fx@gnu.org>
parents:
diff changeset
5057 @node Old CL Compatibility, Porting Common Lisp, Common Lisp Compatibility, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
5058 @appendix Old CL Compatibility
Dave Love <fx@gnu.org>
parents:
diff changeset
5059
Dave Love <fx@gnu.org>
parents:
diff changeset
5060 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
5061 Following is a list of all known incompatibilities between this package
Dave Love <fx@gnu.org>
parents:
diff changeset
5062 and the older Quiroz @file{cl.el} package.
Dave Love <fx@gnu.org>
parents:
diff changeset
5063
Dave Love <fx@gnu.org>
parents:
diff changeset
5064 This package's emulation of multiple return values in functions is
Dave Love <fx@gnu.org>
parents:
diff changeset
5065 incompatible with that of the older package. That package attempted
Dave Love <fx@gnu.org>
parents:
diff changeset
5066 to come as close as possible to true Common Lisp multiple return
Dave Love <fx@gnu.org>
parents:
diff changeset
5067 values; unfortunately, it could not be 100% reliable and so was prone
Dave Love <fx@gnu.org>
parents:
diff changeset
5068 to occasional surprises if used freely. This package uses a simpler
Dave Love <fx@gnu.org>
parents:
diff changeset
5069 method, namely replacing multiple values with lists of values, which
Dave Love <fx@gnu.org>
parents:
diff changeset
5070 is more predictable though more noticeably different from Common Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
5071
Dave Love <fx@gnu.org>
parents:
diff changeset
5072 The @code{defkeyword} form and @code{keywordp} function are not
Dave Love <fx@gnu.org>
parents:
diff changeset
5073 implemented in this package.
Dave Love <fx@gnu.org>
parents:
diff changeset
5074
Dave Love <fx@gnu.org>
parents:
diff changeset
5075 The @code{member}, @code{floor}, @code{ceiling}, @code{truncate},
Dave Love <fx@gnu.org>
parents:
diff changeset
5076 @code{round}, @code{mod}, and @code{rem} functions are suffixed
Dave Love <fx@gnu.org>
parents:
diff changeset
5077 by @samp{*} in this package to avoid collision with existing
27225
ee242fddb1ab Remove various old stuff and references thereto.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
5078 functions in Emacs. The older package simply
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
5079 redefined these functions, overwriting the built-in meanings and
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
5080 causing serious portability problems. (Some more
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
5081 recent versions of the Quiroz package changed the names to
Dave Love <fx@gnu.org>
parents:
diff changeset
5082 @code{cl-member}, etc.; this package defines the latter names as
Dave Love <fx@gnu.org>
parents:
diff changeset
5083 aliases for @code{member*}, etc.)
Dave Love <fx@gnu.org>
parents:
diff changeset
5084
Dave Love <fx@gnu.org>
parents:
diff changeset
5085 Certain functions in the old package which were buggy or inconsistent
Dave Love <fx@gnu.org>
parents:
diff changeset
5086 with the Common Lisp standard are incompatible with the conforming
Dave Love <fx@gnu.org>
parents:
diff changeset
5087 versions in this package. For example, @code{eql} and @code{member}
Dave Love <fx@gnu.org>
parents:
diff changeset
5088 were synonyms for @code{eq} and @code{memq} in that package, @code{setf}
Dave Love <fx@gnu.org>
parents:
diff changeset
5089 failed to preserve correct order of evaluation of its arguments, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
5090
Dave Love <fx@gnu.org>
parents:
diff changeset
5091 Finally, unlike the older package, this package is careful to
Dave Love <fx@gnu.org>
parents:
diff changeset
5092 prefix all of its internal names with @code{cl-}. Except for a
Dave Love <fx@gnu.org>
parents:
diff changeset
5093 few functions which are explicitly defined as additional features
Dave Love <fx@gnu.org>
parents:
diff changeset
5094 (such as @code{floatp-safe} and @code{letf}), this package does not
Dave Love <fx@gnu.org>
parents:
diff changeset
5095 export any non-@samp{cl-} symbols which are not also part of Common
Dave Love <fx@gnu.org>
parents:
diff changeset
5096 Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
5097
Dave Love <fx@gnu.org>
parents:
diff changeset
5098 @ifinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
5099 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
5100
Dave Love <fx@gnu.org>
parents:
diff changeset
5101 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
5102 @end ifinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
5103 @appendixsec The @code{cl-compat} package
Dave Love <fx@gnu.org>
parents:
diff changeset
5104
Dave Love <fx@gnu.org>
parents:
diff changeset
5105 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
5106 The @dfn{CL} package includes emulations of some features of the
Dave Love <fx@gnu.org>
parents:
diff changeset
5107 old @file{cl.el}, in the form of a compatibility package
Dave Love <fx@gnu.org>
parents:
diff changeset
5108 @code{cl-compat}. To use it, put @code{(require 'cl-compat)} in
Dave Love <fx@gnu.org>
parents:
diff changeset
5109 your program.
Dave Love <fx@gnu.org>
parents:
diff changeset
5110
Dave Love <fx@gnu.org>
parents:
diff changeset
5111 The old package defined a number of internal routines without
Dave Love <fx@gnu.org>
parents:
diff changeset
5112 @code{cl-} prefixes or other annotations. Call to these routines
Dave Love <fx@gnu.org>
parents:
diff changeset
5113 may have crept into existing Lisp code. @code{cl-compat}
Dave Love <fx@gnu.org>
parents:
diff changeset
5114 provides emulations of the following internal routines:
Dave Love <fx@gnu.org>
parents:
diff changeset
5115 @code{pair-with-newsyms}, @code{zip-lists}, @code{unzip-lists},
Dave Love <fx@gnu.org>
parents:
diff changeset
5116 @code{reassemble-arglists}, @code{duplicate-symbols-p},
Dave Love <fx@gnu.org>
parents:
diff changeset
5117 @code{safe-idiv}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5118
Dave Love <fx@gnu.org>
parents:
diff changeset
5119 Some @code{setf} forms translated into calls to internal
Dave Love <fx@gnu.org>
parents:
diff changeset
5120 functions that user code might call directly. The functions
Dave Love <fx@gnu.org>
parents:
diff changeset
5121 @code{setnth}, @code{setnthcdr}, and @code{setelt} fall in
Dave Love <fx@gnu.org>
parents:
diff changeset
5122 this category; they are defined by @code{cl-compat}, but the
Dave Love <fx@gnu.org>
parents:
diff changeset
5123 best fix is to change to use @code{setf} properly.
Dave Love <fx@gnu.org>
parents:
diff changeset
5124
Dave Love <fx@gnu.org>
parents:
diff changeset
5125 The @code{cl-compat} file defines the keyword functions
Dave Love <fx@gnu.org>
parents:
diff changeset
5126 @code{keywordp}, @code{keyword-of}, and @code{defkeyword},
Dave Love <fx@gnu.org>
parents:
diff changeset
5127 which are not defined by the new @dfn{CL} package because the
Dave Love <fx@gnu.org>
parents:
diff changeset
5128 use of keywords as data is discouraged.
Dave Love <fx@gnu.org>
parents:
diff changeset
5129
Dave Love <fx@gnu.org>
parents:
diff changeset
5130 The @code{build-klist} mechanism for parsing keyword arguments
Dave Love <fx@gnu.org>
parents:
diff changeset
5131 is emulated by @code{cl-compat}; the @code{with-keyword-args}
Dave Love <fx@gnu.org>
parents:
diff changeset
5132 macro is not, however, and in any case it's best to change to
Dave Love <fx@gnu.org>
parents:
diff changeset
5133 use the more natural keyword argument processing offered by
Dave Love <fx@gnu.org>
parents:
diff changeset
5134 @code{defun*}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5135
Dave Love <fx@gnu.org>
parents:
diff changeset
5136 Multiple return values are treated differently by the two
Dave Love <fx@gnu.org>
parents:
diff changeset
5137 Common Lisp packages. The old package's method was more
Dave Love <fx@gnu.org>
parents:
diff changeset
5138 compatible with true Common Lisp, though it used heuristics
Dave Love <fx@gnu.org>
parents:
diff changeset
5139 that caused it to report spurious multiple return values in
Dave Love <fx@gnu.org>
parents:
diff changeset
5140 certain cases. The @code{cl-compat} package defines a set
Dave Love <fx@gnu.org>
parents:
diff changeset
5141 of multiple-value macros that are compatible with the old
Dave Love <fx@gnu.org>
parents:
diff changeset
5142 CL package; again, they are heuristic in nature, but they
Dave Love <fx@gnu.org>
parents:
diff changeset
5143 are guaranteed to work in any case where the old package's
Dave Love <fx@gnu.org>
parents:
diff changeset
5144 macros worked. To avoid name collision with the ``official''
Dave Love <fx@gnu.org>
parents:
diff changeset
5145 multiple-value facilities, the ones in @code{cl-compat} have
Dave Love <fx@gnu.org>
parents:
diff changeset
5146 capitalized names: @code{Values}, @code{Values-list},
Dave Love <fx@gnu.org>
parents:
diff changeset
5147 @code{Multiple-value-bind}, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
5148
Dave Love <fx@gnu.org>
parents:
diff changeset
5149 The functions @code{cl-floor}, @code{cl-ceiling}, @code{cl-truncate},
Dave Love <fx@gnu.org>
parents:
diff changeset
5150 and @code{cl-round} are defined by @code{cl-compat} to use the
Dave Love <fx@gnu.org>
parents:
diff changeset
5151 old-style multiple-value mechanism, just as they did in the old
Dave Love <fx@gnu.org>
parents:
diff changeset
5152 package. The newer @code{floor*} and friends return their two
Dave Love <fx@gnu.org>
parents:
diff changeset
5153 results in a list rather than as multiple values. Note that
Dave Love <fx@gnu.org>
parents:
diff changeset
5154 older versions of the old package used the unadorned names
Dave Love <fx@gnu.org>
parents:
diff changeset
5155 @code{floor}, @code{ceiling}, etc.; @code{cl-compat} cannot use
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
5156 these names because they conflict with Emacs built-ins.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
5157
Dave Love <fx@gnu.org>
parents:
diff changeset
5158 @node Porting Common Lisp, Function Index, Old CL Compatibility, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
5159 @appendix Porting Common Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
5160
Dave Love <fx@gnu.org>
parents:
diff changeset
5161 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
5162 This package is meant to be used as an extension to Emacs Lisp,
Dave Love <fx@gnu.org>
parents:
diff changeset
5163 not as an Emacs implementation of true Common Lisp. Some of the
Dave Love <fx@gnu.org>
parents:
diff changeset
5164 remaining differences between Emacs Lisp and Common Lisp make it
Dave Love <fx@gnu.org>
parents:
diff changeset
5165 difficult to port large Common Lisp applications to Emacs. For
Dave Love <fx@gnu.org>
parents:
diff changeset
5166 one, some of the features in this package are not fully compliant
Dave Love <fx@gnu.org>
parents:
diff changeset
5167 with ANSI or Steele; @pxref{Common Lisp Compatibility}. But there
Dave Love <fx@gnu.org>
parents:
diff changeset
5168 are also quite a few features that this package does not provide
Dave Love <fx@gnu.org>
parents:
diff changeset
5169 at all. Here are some major omissions that you will want watch out
Dave Love <fx@gnu.org>
parents:
diff changeset
5170 for when bringing Common Lisp code into Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
5171
Dave Love <fx@gnu.org>
parents:
diff changeset
5172 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5173 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5174 Case-insensitivity. Symbols in Common Lisp are case-insensitive
Dave Love <fx@gnu.org>
parents:
diff changeset
5175 by default. Some programs refer to a function or variable as
Dave Love <fx@gnu.org>
parents:
diff changeset
5176 @code{foo} in one place and @code{Foo} or @code{FOO} in another.
Dave Love <fx@gnu.org>
parents:
diff changeset
5177 Emacs Lisp will treat these as three distinct symbols.
Dave Love <fx@gnu.org>
parents:
diff changeset
5178
Dave Love <fx@gnu.org>
parents:
diff changeset
5179 Some Common Lisp code is written entirely in upper case. While Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
5180 is happy to let the program's own functions and variables use
Dave Love <fx@gnu.org>
parents:
diff changeset
5181 this convention, calls to Lisp builtins like @code{if} and
Dave Love <fx@gnu.org>
parents:
diff changeset
5182 @code{defun} will have to be changed to lower case.
Dave Love <fx@gnu.org>
parents:
diff changeset
5183
Dave Love <fx@gnu.org>
parents:
diff changeset
5184 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5185 Lexical scoping. In Common Lisp, function arguments and @code{let}
Dave Love <fx@gnu.org>
parents:
diff changeset
5186 bindings apply only to references physically within their bodies
Dave Love <fx@gnu.org>
parents:
diff changeset
5187 (or within macro expansions in their bodies). Emacs Lisp, by
Dave Love <fx@gnu.org>
parents:
diff changeset
5188 contrast, uses @dfn{dynamic scoping} wherein a binding to a
Dave Love <fx@gnu.org>
parents:
diff changeset
5189 variable is visible even inside functions called from the body.
Dave Love <fx@gnu.org>
parents:
diff changeset
5190
Dave Love <fx@gnu.org>
parents:
diff changeset
5191 Variables in Common Lisp can be made dynamically scoped by
Dave Love <fx@gnu.org>
parents:
diff changeset
5192 declaring them @code{special} or using @code{defvar}. In Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
5193 Lisp it is as if all variables were declared @code{special}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5194
Dave Love <fx@gnu.org>
parents:
diff changeset
5195 Often you can use code that was written for lexical scoping
Dave Love <fx@gnu.org>
parents:
diff changeset
5196 even in a dynamically scoped Lisp, but not always. Here is
Dave Love <fx@gnu.org>
parents:
diff changeset
5197 an example of a Common Lisp code fragment that would fail in
Dave Love <fx@gnu.org>
parents:
diff changeset
5198 Emacs Lisp:
Dave Love <fx@gnu.org>
parents:
diff changeset
5199
Dave Love <fx@gnu.org>
parents:
diff changeset
5200 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
5201 (defun map-odd-elements (func list)
Dave Love <fx@gnu.org>
parents:
diff changeset
5202 (loop for x in list
Dave Love <fx@gnu.org>
parents:
diff changeset
5203 for flag = t then (not flag)
Dave Love <fx@gnu.org>
parents:
diff changeset
5204 collect (if flag x (funcall func x))))
Dave Love <fx@gnu.org>
parents:
diff changeset
5205
Dave Love <fx@gnu.org>
parents:
diff changeset
5206 (defun add-odd-elements (list x)
28344
54fda0e8528a Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28039
diff changeset
5207 (map-odd-elements (lambda (a) (+ a x))) list)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
5208 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
5209
Dave Love <fx@gnu.org>
parents:
diff changeset
5210 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
5211 In Common Lisp, the two functions' usages of @code{x} are completely
Dave Love <fx@gnu.org>
parents:
diff changeset
5212 independent. In Emacs Lisp, the binding to @code{x} made by
Dave Love <fx@gnu.org>
parents:
diff changeset
5213 @code{add-odd-elements} will have been hidden by the binding
Dave Love <fx@gnu.org>
parents:
diff changeset
5214 in @code{map-odd-elements} by the time the @code{(+ a x)} function
Dave Love <fx@gnu.org>
parents:
diff changeset
5215 is called.
Dave Love <fx@gnu.org>
parents:
diff changeset
5216
Dave Love <fx@gnu.org>
parents:
diff changeset
5217 (This package avoids such problems in its own mapping functions
Dave Love <fx@gnu.org>
parents:
diff changeset
5218 by using names like @code{cl-x} instead of @code{x} internally;
Dave Love <fx@gnu.org>
parents:
diff changeset
5219 as long as you don't use the @code{cl-} prefix for your own
Dave Love <fx@gnu.org>
parents:
diff changeset
5220 variables no collision can occur.)
Dave Love <fx@gnu.org>
parents:
diff changeset
5221
Dave Love <fx@gnu.org>
parents:
diff changeset
5222 @xref{Lexical Bindings}, for a description of the @code{lexical-let}
Dave Love <fx@gnu.org>
parents:
diff changeset
5223 form which establishes a Common Lisp-style lexical binding, and some
Dave Love <fx@gnu.org>
parents:
diff changeset
5224 examples of how it differs from Emacs' regular @code{let}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5225
Dave Love <fx@gnu.org>
parents:
diff changeset
5226 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5227 Reader macros. Common Lisp includes a second type of macro that
Dave Love <fx@gnu.org>
parents:
diff changeset
5228 works at the level of individual characters. For example, Common
Dave Love <fx@gnu.org>
parents:
diff changeset
5229 Lisp implements the quote notation by a reader macro called @code{'},
Dave Love <fx@gnu.org>
parents:
diff changeset
5230 whereas Emacs Lisp's parser just treats quote as a special case.
Dave Love <fx@gnu.org>
parents:
diff changeset
5231 Some Lisp packages use reader macros to create special syntaxes
Dave Love <fx@gnu.org>
parents:
diff changeset
5232 for themselves, which the Emacs parser is incapable of reading.
Dave Love <fx@gnu.org>
parents:
diff changeset
5233
Dave Love <fx@gnu.org>
parents:
diff changeset
5234 The lack of reader macros, incidentally, is the reason behind
Dave Love <fx@gnu.org>
parents:
diff changeset
5235 Emacs Lisp's unusual backquote syntax. Since backquotes are
Dave Love <fx@gnu.org>
parents:
diff changeset
5236 implemented as a Lisp package and not built-in to the Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
5237 parser, they are forced to use a regular macro named @code{`}
Dave Love <fx@gnu.org>
parents:
diff changeset
5238 which is used with the standard function/macro call notation.
Dave Love <fx@gnu.org>
parents:
diff changeset
5239
Dave Love <fx@gnu.org>
parents:
diff changeset
5240 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5241 Other syntactic features. Common Lisp provides a number of
Dave Love <fx@gnu.org>
parents:
diff changeset
5242 notations beginning with @code{#} that the Emacs Lisp parser
Dave Love <fx@gnu.org>
parents:
diff changeset
5243 won't understand. For example, @samp{#| ... |#} is an
Dave Love <fx@gnu.org>
parents:
diff changeset
5244 alternate comment notation, and @samp{#+lucid (foo)} tells
Dave Love <fx@gnu.org>
parents:
diff changeset
5245 the parser to ignore the @code{(foo)} except in Lucid Common
Dave Love <fx@gnu.org>
parents:
diff changeset
5246 Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
5247
Dave Love <fx@gnu.org>
parents:
diff changeset
5248 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5249 Packages. In Common Lisp, symbols are divided into @dfn{packages}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5250 Symbols that are Lisp built-ins are typically stored in one package;
Dave Love <fx@gnu.org>
parents:
diff changeset
5251 symbols that are vendor extensions are put in another, and each
Dave Love <fx@gnu.org>
parents:
diff changeset
5252 application program would have a package for its own symbols.
Dave Love <fx@gnu.org>
parents:
diff changeset
5253 Certain symbols are ``exported'' by a package and others are
Dave Love <fx@gnu.org>
parents:
diff changeset
5254 internal; certain packages ``use'' or import the exported symbols
Dave Love <fx@gnu.org>
parents:
diff changeset
5255 of other packages. To access symbols that would not normally be
Dave Love <fx@gnu.org>
parents:
diff changeset
5256 visible due to this importing and exporting, Common Lisp provides
Dave Love <fx@gnu.org>
parents:
diff changeset
5257 a syntax like @code{package:symbol} or @code{package::symbol}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5258
Dave Love <fx@gnu.org>
parents:
diff changeset
5259 Emacs Lisp has a single namespace for all interned symbols, and
Dave Love <fx@gnu.org>
parents:
diff changeset
5260 then uses a naming convention of putting a prefix like @code{cl-}
Dave Love <fx@gnu.org>
parents:
diff changeset
5261 in front of the name. Some Emacs packages adopt the Common Lisp-like
Dave Love <fx@gnu.org>
parents:
diff changeset
5262 convention of using @code{cl:} or @code{cl::} as the prefix.
Dave Love <fx@gnu.org>
parents:
diff changeset
5263 However, the Emacs parser does not understand colons and just
Dave Love <fx@gnu.org>
parents:
diff changeset
5264 treats them as part of the symbol name. Thus, while @code{mapcar}
Dave Love <fx@gnu.org>
parents:
diff changeset
5265 and @code{lisp:mapcar} may refer to the same symbol in Common
Dave Love <fx@gnu.org>
parents:
diff changeset
5266 Lisp, they are totally distinct in Emacs Lisp. Common Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
5267 programs which refer to a symbol by the full name sometimes
Dave Love <fx@gnu.org>
parents:
diff changeset
5268 and the short name other times will not port cleanly to Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
5269
Dave Love <fx@gnu.org>
parents:
diff changeset
5270 Emacs Lisp does have a concept of ``obarrays,'' which are
Dave Love <fx@gnu.org>
parents:
diff changeset
5271 package-like collections of symbols, but this feature is not
Dave Love <fx@gnu.org>
parents:
diff changeset
5272 strong enough to be used as a true package mechanism.
Dave Love <fx@gnu.org>
parents:
diff changeset
5273
Dave Love <fx@gnu.org>
parents:
diff changeset
5274 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5275 The @code{format} function is quite different between Common
Dave Love <fx@gnu.org>
parents:
diff changeset
5276 Lisp and Emacs Lisp. It takes an additional ``destination''
Dave Love <fx@gnu.org>
parents:
diff changeset
5277 argument before the format string. A destination of @code{nil}
Dave Love <fx@gnu.org>
parents:
diff changeset
5278 means to format to a string as in Emacs Lisp; a destination
Dave Love <fx@gnu.org>
parents:
diff changeset
5279 of @code{t} means to write to the terminal (similar to
Dave Love <fx@gnu.org>
parents:
diff changeset
5280 @code{message} in Emacs). Also, format control strings are
Dave Love <fx@gnu.org>
parents:
diff changeset
5281 utterly different; @code{~} is used instead of @code{%} to
Dave Love <fx@gnu.org>
parents:
diff changeset
5282 introduce format codes, and the set of available codes is
Dave Love <fx@gnu.org>
parents:
diff changeset
5283 much richer. There are no notations like @code{\n} for
Dave Love <fx@gnu.org>
parents:
diff changeset
5284 string literals; instead, @code{format} is used with the
Dave Love <fx@gnu.org>
parents:
diff changeset
5285 ``newline'' format code, @code{~%}. More advanced formatting
Dave Love <fx@gnu.org>
parents:
diff changeset
5286 codes provide such features as paragraph filling, case
Dave Love <fx@gnu.org>
parents:
diff changeset
5287 conversion, and even loops and conditionals.
Dave Love <fx@gnu.org>
parents:
diff changeset
5288
Dave Love <fx@gnu.org>
parents:
diff changeset
5289 While it would have been possible to implement most of Common
Dave Love <fx@gnu.org>
parents:
diff changeset
5290 Lisp @code{format} in this package (under the name @code{format*},
Dave Love <fx@gnu.org>
parents:
diff changeset
5291 of course), it was not deemed worthwhile. It would have required
Dave Love <fx@gnu.org>
parents:
diff changeset
5292 a huge amount of code to implement even a decent subset of
Dave Love <fx@gnu.org>
parents:
diff changeset
5293 @code{format*}, yet the functionality it would provide over
Dave Love <fx@gnu.org>
parents:
diff changeset
5294 Emacs Lisp's @code{format} would rarely be useful.
Dave Love <fx@gnu.org>
parents:
diff changeset
5295
Dave Love <fx@gnu.org>
parents:
diff changeset
5296 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5297 Vector constants use square brackets in Emacs Lisp, but
Dave Love <fx@gnu.org>
parents:
diff changeset
5298 @code{#(a b c)} notation in Common Lisp. To further complicate
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
5299 matters, Emacs has its own @code{#(} notation for
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
5300 something entirely different---strings with properties.
Dave Love <fx@gnu.org>
parents:
diff changeset
5301
Dave Love <fx@gnu.org>
parents:
diff changeset
5302 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5303 Characters are distinct from integers in Common Lisp. The
Dave Love <fx@gnu.org>
parents:
diff changeset
5304 notation for character constants is also different: @code{#\A}
Dave Love <fx@gnu.org>
parents:
diff changeset
5305 instead of @code{?A}. Also, @code{string=} and @code{string-equal}
Dave Love <fx@gnu.org>
parents:
diff changeset
5306 are synonyms in Emacs Lisp whereas the latter is case-insensitive
Dave Love <fx@gnu.org>
parents:
diff changeset
5307 in Common Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
5308
Dave Love <fx@gnu.org>
parents:
diff changeset
5309 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5310 Data types. Some Common Lisp data types do not exist in Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
5311 Lisp. Rational numbers and complex numbers are not present,
Dave Love <fx@gnu.org>
parents:
diff changeset
5312 nor are large integers (all integers are ``fixnums''). All
Dave Love <fx@gnu.org>
parents:
diff changeset
5313 arrays are one-dimensional. There are no readtables or pathnames;
Dave Love <fx@gnu.org>
parents:
diff changeset
5314 streams are a set of existing data types rather than a new data
Dave Love <fx@gnu.org>
parents:
diff changeset
5315 type of their own. Hash tables, random-states, structures, and
Dave Love <fx@gnu.org>
parents:
diff changeset
5316 packages (obarrays) are built from Lisp vectors or lists rather
Dave Love <fx@gnu.org>
parents:
diff changeset
5317 than being distinct types.
Dave Love <fx@gnu.org>
parents:
diff changeset
5318
Dave Love <fx@gnu.org>
parents:
diff changeset
5319 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5320 The Common Lisp Object System (CLOS) is not implemented,
Dave Love <fx@gnu.org>
parents:
diff changeset
5321 nor is the Common Lisp Condition System. However, the EIEIO package
Dave Love <fx@gnu.org>
parents:
diff changeset
5322 from @uref{ftp://ftp.ultranet.com/pub/zappo} does implement some
Dave Love <fx@gnu.org>
parents:
diff changeset
5323 CLOS functionality.
Dave Love <fx@gnu.org>
parents:
diff changeset
5324
Dave Love <fx@gnu.org>
parents:
diff changeset
5325 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5326 Common Lisp features that are completely redundant with Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
5327 Lisp features of a different name generally have not been
Dave Love <fx@gnu.org>
parents:
diff changeset
5328 implemented. For example, Common Lisp writes @code{defconstant}
Dave Love <fx@gnu.org>
parents:
diff changeset
5329 where Emacs Lisp uses @code{defconst}. Similarly, @code{make-list}
Dave Love <fx@gnu.org>
parents:
diff changeset
5330 takes its arguments in different ways in the two Lisps but does
Dave Love <fx@gnu.org>
parents:
diff changeset
5331 exactly the same thing, so this package has not bothered to
Dave Love <fx@gnu.org>
parents:
diff changeset
5332 implement a Common Lisp-style @code{make-list}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5333
Dave Love <fx@gnu.org>
parents:
diff changeset
5334 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5335 A few more notable Common Lisp features not included in this
Dave Love <fx@gnu.org>
parents:
diff changeset
5336 package: @code{compiler-let}, @code{tagbody}, @code{prog},
Dave Love <fx@gnu.org>
parents:
diff changeset
5337 @code{ldb/dpb}, @code{parse-integer}, @code{cerror}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5338
Dave Love <fx@gnu.org>
parents:
diff changeset
5339 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5340 Recursion. While recursion works in Emacs Lisp just like it
Dave Love <fx@gnu.org>
parents:
diff changeset
5341 does in Common Lisp, various details of the Emacs Lisp system
Dave Love <fx@gnu.org>
parents:
diff changeset
5342 and compiler make recursion much less efficient than it is in
Dave Love <fx@gnu.org>
parents:
diff changeset
5343 most Lisps. Some schools of thought prefer to use recursion
Dave Love <fx@gnu.org>
parents:
diff changeset
5344 in Lisp over other techniques; they would sum a list of
Dave Love <fx@gnu.org>
parents:
diff changeset
5345 numbers using something like
Dave Love <fx@gnu.org>
parents:
diff changeset
5346
Dave Love <fx@gnu.org>
parents:
diff changeset
5347 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
5348 (defun sum-list (list)
Dave Love <fx@gnu.org>
parents:
diff changeset
5349 (if list
Dave Love <fx@gnu.org>
parents:
diff changeset
5350 (+ (car list) (sum-list (cdr list)))
Dave Love <fx@gnu.org>
parents:
diff changeset
5351 0))
Dave Love <fx@gnu.org>
parents:
diff changeset
5352 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
5353
Dave Love <fx@gnu.org>
parents:
diff changeset
5354 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
5355 where a more iteratively-minded programmer might write one of
Dave Love <fx@gnu.org>
parents:
diff changeset
5356 these forms:
Dave Love <fx@gnu.org>
parents:
diff changeset
5357
Dave Love <fx@gnu.org>
parents:
diff changeset
5358 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
5359 (let ((total 0)) (dolist (x my-list) (incf total x)) total)
Dave Love <fx@gnu.org>
parents:
diff changeset
5360 (loop for x in my-list sum x)
Dave Love <fx@gnu.org>
parents:
diff changeset
5361 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
5362
Dave Love <fx@gnu.org>
parents:
diff changeset
5363 While this would be mainly a stylistic choice in most Common Lisps,
Dave Love <fx@gnu.org>
parents:
diff changeset
5364 in Emacs Lisp you should be aware that the iterative forms are
Dave Love <fx@gnu.org>
parents:
diff changeset
5365 much faster than recursion. Also, Lisp programmers will want to
Dave Love <fx@gnu.org>
parents:
diff changeset
5366 note that the current Emacs Lisp compiler does not optimize tail
Dave Love <fx@gnu.org>
parents:
diff changeset
5367 recursion.
Dave Love <fx@gnu.org>
parents:
diff changeset
5368 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5369
Dave Love <fx@gnu.org>
parents:
diff changeset
5370 @node Function Index, Variable Index, Porting Common Lisp, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
5371 @unnumbered Function Index
Dave Love <fx@gnu.org>
parents:
diff changeset
5372
Dave Love <fx@gnu.org>
parents:
diff changeset
5373 @printindex fn
Dave Love <fx@gnu.org>
parents:
diff changeset
5374
31572
384603523f41 Remove obsolescences, especially hash tables and refs to Emacs 19.
Dave Love <fx@gnu.org>
parents: 30009
diff changeset
5375 @node Variable Index, , Function Index, Top
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
5376 @unnumbered Variable Index
Dave Love <fx@gnu.org>
parents:
diff changeset
5377
Dave Love <fx@gnu.org>
parents:
diff changeset
5378 @printindex vr
Dave Love <fx@gnu.org>
parents:
diff changeset
5379
29713
983e65f12610 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28344
diff changeset
5380 @setchapternewpage odd
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
5381 @contents
Dave Love <fx@gnu.org>
parents:
diff changeset
5382 @bye