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