cl.texi 201 KB
Newer Older
Glenn Morris's avatar
Glenn Morris committed
1
\input texinfo    @c -*-texinfo-*-
2
@setfilename ../../info/cl
Glenn Morris's avatar
Glenn Morris committed
3
@settitle Common Lisp Extensions
4
@include emacsver.texi
Glenn Morris's avatar
Glenn Morris committed
5 6 7 8

@copying
This file documents the GNU Emacs Common Lisp emulation package.

9
Copyright @copyright{} 1993, 2001-2012 Free Software Foundation, Inc.
Glenn Morris's avatar
Glenn Morris committed
10 11 12

@quotation
Permission is granted to copy, distribute and/or modify this document
13
under the terms of the GNU Free Documentation License, Version 1.3 or
Glenn Morris's avatar
Glenn Morris committed
14
any later version published by the Free Software Foundation; with no
15 16 17
Invariant Sections, with the Front-Cover texts being ``A GNU Manual'',
and with the Back-Cover Texts as in (a) below.  A copy of the license
is included in the section entitled ``GNU Free Documentation License''.
Glenn Morris's avatar
Glenn Morris committed
18

19 20 21
(a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
modify this GNU manual.  Buying copies from the FSF supports it in
developing GNU and promoting software freedom.''
Glenn Morris's avatar
Glenn Morris committed
22 23 24
@end quotation
@end copying

25
@dircategory Emacs lisp libraries
Glenn Morris's avatar
Glenn Morris committed
26
@direntry
Glenn Morris's avatar
Glenn Morris committed
27
* CL: (cl).                     Partial Common Lisp support for Emacs Lisp.
Glenn Morris's avatar
Glenn Morris committed
28 29 30 31 32 33 34 35 36 37
@end direntry

@finalout

@titlepage
@sp 6
@center @titlefont{Common Lisp Extensions}
@sp 4
@center For GNU Emacs Lisp
@sp 1
38
@center as distributed with Emacs @value{EMACSVER}
Glenn Morris's avatar
Glenn Morris committed
39 40 41 42 43 44 45 46
@sp 5
@center Dave Gillespie
@center daveg@@synaptics.com
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage

47 48 49
@contents

@ifnottex
50 51 52
@node Top
@top GNU Emacs Common Lisp Emulation

53 54 55
@insertcopying
@end ifnottex

Glenn Morris's avatar
Glenn Morris committed
56
@menu
57 58 59 60 61
* Overview::             Basics, usage, organization, naming conventions.
* Program Structure::    Arglists, @code{cl-eval-when}.
* Predicates::           Type predicates and equality predicates.
* Control Structure::    Assignment, conditionals, blocks, looping.
* Macros::               Destructuring, compiler macros.
62
* Declarations::         @code{cl-proclaim}, @code{cl-declare}, etc.
63
* Symbols::              Property lists, creating symbols.
64 65
* Numbers::              Predicates, functions, random numbers.
* Sequences::            Mapping, functions, searching, sorting.
66
* Lists::                Functions, substitution, sets, associations.
67
* Structures::           @code{cl-defstruct}.
68
* Assertions::           Assertions and type checking.
Glenn Morris's avatar
Glenn Morris committed
69

70 71 72 73 74
Appendices
* Efficiency Concerns::            Hints and techniques.
* Common Lisp Compatibility::      All known differences with Steele.
* Porting Common Lisp::            Hints for porting Common Lisp code.
* Obsolete Features::              Obsolete features.
Glenn Morris's avatar
Glenn Morris committed
75
* GNU Free Documentation License:: The license for this documentation.
76 77 78 79

Indexes
* Function Index::                 An entry for each documented function.
* Variable Index::                 An entry for each documented variable.
Glenn Morris's avatar
Glenn Morris committed
80 81
@end menu

82
@node Overview
Glenn Morris's avatar
Glenn Morris committed
83 84 85
@chapter Overview

@noindent
86 87 88 89 90
This document describes a set of Emacs Lisp facilities borrowed from
Common Lisp.  All the facilities are described here in detail.  While
this document does not assume any prior knowledge of Common Lisp, it
does assume a basic familiarity with Emacs Lisp.

Glenn Morris's avatar
Glenn Morris committed
91 92 93 94 95 96 97
Common Lisp is a huge language, and Common Lisp systems tend to be
massive and extremely complex.  Emacs Lisp, by contrast, is rather
minimalist in the choice of Lisp features it offers the programmer.
As Emacs Lisp programmers have grown in number, and the applications
they write have grown more ambitious, it has become clear that Emacs
Lisp could benefit from many of the conveniences of Common Lisp.

98
The @dfn{CL} package adds a number of Common Lisp functions and
Glenn Morris's avatar
Glenn Morris committed
99
control structures to Emacs Lisp.  While not a 100% complete
100
implementation of Common Lisp, it adds enough functionality
Glenn Morris's avatar
Glenn Morris committed
101 102 103 104 105 106 107 108 109 110 111 112 113 114
to make Emacs Lisp programming significantly more convenient.

Some Common Lisp features have been omitted from this package
for various reasons:

@itemize @bullet
@item
Some features are too complex or bulky relative to their benefit
to Emacs Lisp programmers.  CLOS and Common Lisp streams are fine
examples of this group.

@item
Other features cannot be implemented without modification to the
Emacs Lisp interpreter itself, such as multiple return values,
115
case-insensitive symbols, and complex numbers.
116
This package generally makes no attempt to emulate these features.
Glenn Morris's avatar
Glenn Morris committed
117 118 119

@end itemize

Glenn Morris's avatar
Glenn Morris committed
120 121 122 123 124 125
This package was originally written by Dave Gillespie,
@file{daveg@@synaptics.com}, as a total rewrite of an earlier 1986
@file{cl.el} package by Cesar Quiroz.  Care has been taken to ensure
that each function is defined efficiently, concisely, and with minimal
impact on the rest of the Emacs environment.  Stefan Monnier added the
file @file{cl-lib.el} and rationalized the namespace for Emacs 24.3.
Glenn Morris's avatar
Glenn Morris committed
126 127

@menu
128
* Usage::                How to use this package.
Glenn Morris's avatar
Glenn Morris committed
129
* Organization::         The package's component files.
130
* Naming Conventions::   Notes on function names.
Glenn Morris's avatar
Glenn Morris committed
131 132
@end menu

133
@node Usage
Glenn Morris's avatar
Glenn Morris committed
134 135 136
@section Usage

@noindent
137
This package is distributed with Emacs, so there is no need
138
to install any additional files in order to start using it.  Lisp code
139
that uses features from this package should simply include at
140
the beginning:
Glenn Morris's avatar
Glenn Morris committed
141 142

@example
143
(require 'cl-lib)
Glenn Morris's avatar
Glenn Morris committed
144 145 146
@end example

@noindent
147
You may wish to add such a statement to your init file, if you
148
make frequent use of features from this package.
Glenn Morris's avatar
Glenn Morris committed
149

150
@node Organization
Glenn Morris's avatar
Glenn Morris committed
151 152 153
@section Organization

@noindent
154
The Common Lisp package is organized into four main files:
Glenn Morris's avatar
Glenn Morris committed
155 156

@table @file
157 158 159
@item cl-lib.el
This is the main file, which contains basic functions
and information about the package.  This file is relatively compact.
Glenn Morris's avatar
Glenn Morris committed
160 161 162 163

@item cl-extra.el
This file contains the larger, more complex or unusual functions.
It is kept separate so that packages which only want to use Common
164
Lisp fundamentals like the @code{cl-incf} function won't need to pay
Glenn Morris's avatar
Glenn Morris committed
165 166 167 168
the overhead of loading the more advanced functions.

@item cl-seq.el
This file contains most of the advanced functions for operating
169
on sequences or lists, such as @code{cl-delete-if} and @code{cl-assoc}.
Glenn Morris's avatar
Glenn Morris committed
170 171

@item cl-macs.el
172 173 174 175 176 177
This file contains the features that are macros instead of functions.
Macros expand when the caller is compiled, not when it is run, so the
macros generally only need to be present when the byte-compiler is
running (or when the macros are used in uncompiled code).  Most of the
macros of this package are isolated in @file{cl-macs.el} so that they
won't take up memory unless you are compiling.
Glenn Morris's avatar
Glenn Morris committed
178 179
@end table

180
The file @file{cl-lib.el} includes all necessary @code{autoload}
Glenn Morris's avatar
Glenn Morris committed
181
commands for the functions and macros in the other three files.
182
All you have to do is @code{(require 'cl-lib)}, and @file{cl-lib.el}
Glenn Morris's avatar
Glenn Morris committed
183 184 185
will take care of pulling in the other files when they are
needed.

186
There is another file, @file{cl.el}, which was the main entry point to
187
this package prior to Emacs 24.3.  Nowadays, it is replaced by
188 189 190 191 192
@file{cl-lib.el}.  The two provide the same features (in most cases),
but use different function names (in fact, @file{cl.el} mainly just
defines aliases to the @file{cl-lib.el} definitions).  Where
@file{cl-lib.el} defines a function called, for example,
@code{cl-incf}, @file{cl.el} uses the same name but without the
193
@samp{cl-} prefix, e.g.@: @code{incf} in this example.  There are a few
194 195 196
exceptions to this.  First, functions such as @code{cl-defun} where
the unprefixed version was already used for a standard Emacs Lisp
function.  In such cases, the @file{cl.el} version adds a @samp{*}
197
suffix, e.g.@: @code{defun*}.  Second, there are some obsolete features
198 199 200 201 202
that are only implemented in @file{cl.el}, not in @file{cl-lib.el},
because they are replaced by other standard Emacs Lisp features.
Finally, in a very few cases the old @file{cl.el} versions do not
behave in exactly the same way as the @file{cl-lib.el} versions.
@xref{Obsolete Features}.
Glenn Morris's avatar
Glenn Morris committed
203 204
@c There is also cl-mapc, which was called cl-mapc even before cl-lib.el.
@c But not autoloaded, so maybe not much used?
205 206 207 208 209 210 211

Since the old @file{cl.el} does not use a clean namespace, Emacs has a
policy that packages distributed with Emacs must not load @code{cl} at
run time.  (It is ok for them to load @code{cl} at @emph{compile}
time, with @code{eval-when-compile}, and use the macros it provides.)
There is no such restriction on the use of @code{cl-lib}.  New code
should use @code{cl-lib} rather than @code{cl}.
212 213

There is one more file, @file{cl-compat.el}, which defines some
214
routines from the older Quiroz @file{cl.el} package that are not otherwise
215 216
present in the new package.  This file is obsolete and should not be
used in new code.
Glenn Morris's avatar
Glenn Morris committed
217

218
@node Naming Conventions
Glenn Morris's avatar
Glenn Morris committed
219 220 221 222
@section Naming Conventions

@noindent
Except where noted, all functions defined by this package have the
223 224
same calling conventions as their Common Lisp counterparts, and
names that are those of Common Lisp plus a @samp{cl-} prefix.
Glenn Morris's avatar
Glenn Morris committed
225 226

Internal function and variable names in the package are prefixed
227
by @code{cl--}.  Here is a complete list of functions prefixed by
228
@code{cl-} that were @emph{not} taken from Common Lisp:
Glenn Morris's avatar
Glenn Morris committed
229 230

@example
231
cl-callf           cl-callf2          cl-defsubst
232
cl-letf            cl-letf*
Glenn Morris's avatar
Glenn Morris committed
233 234
@end example

235 236
@c This is not uninteresting I suppose, but is of zero practical relevance
@c to the user, and seems like a hostage to changing implementation details.
237
The following simple functions and macros are defined in @file{cl-lib.el};
Glenn Morris's avatar
Glenn Morris committed
238 239 240
they do not cause other components like @file{cl-extra} to be loaded.

@example
241
cl-evenp           cl-oddp            cl-minusp
242
cl-plusp           cl-endp            cl-subst
243 244 245 246 247
cl-copy-list       cl-list*           cl-ldiff
cl-rest            cl-decf [1]        cl-incf [1]
cl-acons           cl-adjoin [2]      cl-pairlis
cl-pushnew [1,2]   cl-declaim         cl-proclaim
cl-caaar@dots{}cl-cddddr                  cl-first@dots{}cl-tenth
248
cl-mapcar [3]
Glenn Morris's avatar
Glenn Morris committed
249 250 251
@end example

@noindent
252
[1] Only when @var{place} is a plain variable name.
Glenn Morris's avatar
Glenn Morris committed
253 254

@noindent
255
[2] Only if @code{:test} is @code{eq}, @code{equal}, or unspecified,
Glenn Morris's avatar
Glenn Morris committed
256 257 258
and @code{:key} is not used.

@noindent
259
[3] Only for one sequence argument or two list arguments.
Glenn Morris's avatar
Glenn Morris committed
260

261
@node Program Structure
Glenn Morris's avatar
Glenn Morris committed
262 263 264
@chapter Program Structure

@noindent
265
This section describes features of this package that have to
Glenn Morris's avatar
Glenn Morris committed
266
do with programs as a whole: advanced argument lists for functions,
267
and the @code{cl-eval-when} construct.
Glenn Morris's avatar
Glenn Morris committed
268 269

@menu
270 271
* Argument Lists::       @code{&key}, @code{&aux}, @code{cl-defun}, @code{cl-defmacro}.
* Time of Evaluation::   The @code{cl-eval-when} construct.
Glenn Morris's avatar
Glenn Morris committed
272 273
@end menu

274
@node Argument Lists
Glenn Morris's avatar
Glenn Morris committed
275 276 277 278 279 280 281 282 283 284 285 286 287 288
@section Argument Lists

@noindent
Emacs Lisp's notation for argument lists of functions is a subset of
the Common Lisp notation.  As well as the familiar @code{&optional}
and @code{&rest} markers, Common Lisp allows you to specify default
values for optional arguments, and it provides the additional markers
@code{&key} and @code{&aux}.

Since argument parsing is built-in to Emacs, there is no way for
this package to implement Common Lisp argument lists seamlessly.
Instead, this package defines alternates for several Lisp forms
which you must use if you need Common Lisp argument lists.

289
@defmac cl-defun name arglist body@dots{}
Glenn Morris's avatar
Glenn Morris committed
290 291 292 293
This form is identical to the regular @code{defun} form, except
that @var{arglist} is allowed to be a full Common Lisp argument
list.  Also, the function body is enclosed in an implicit block
called @var{name}; @pxref{Blocks and Exits}.
294
@end defmac
Glenn Morris's avatar
Glenn Morris committed
295

296
@defmac cl-defsubst name arglist body@dots{}
297
This is just like @code{cl-defun}, except that the function that
Glenn Morris's avatar
Glenn Morris committed
298 299 300
is defined is automatically proclaimed @code{inline}, i.e.,
calls to it may be expanded into in-line code by the byte compiler.
This is analogous to the @code{defsubst} form;
301
@code{cl-defsubst} uses a different method (compiler macros) which
302
works in all versions of Emacs, and also generates somewhat more
303 304
@c For some examples,
@c see http://lists.gnu.org/archive/html/emacs-devel/2012-11/msg00009.html
305
efficient inline expansions.  In particular, @code{cl-defsubst}
Glenn Morris's avatar
Glenn Morris committed
306 307
arranges for the processing of keyword arguments, default values,
etc., to be done at compile-time whenever possible.
308
@end defmac
Glenn Morris's avatar
Glenn Morris committed
309

310
@defmac cl-defmacro name arglist body@dots{}
Glenn Morris's avatar
Glenn Morris committed
311 312 313
This is identical to the regular @code{defmacro} form,
except that @var{arglist} is allowed to be a full Common Lisp
argument list.  The @code{&environment} keyword is supported as
Glenn Morris's avatar
Glenn Morris committed
314 315
described in Steele's book @cite{Common Lisp, the Language}.
The @code{&whole} keyword is supported only
Glenn Morris's avatar
Glenn Morris committed
316 317 318 319
within destructured lists (see below); top-level @code{&whole}
cannot be implemented with the current Emacs Lisp interpreter.
The macro expander body is enclosed in an implicit block called
@var{name}.
320
@end defmac
Glenn Morris's avatar
Glenn Morris committed
321

322
@defmac cl-function symbol-or-lambda
Glenn Morris's avatar
Glenn Morris committed
323 324 325
This is identical to the regular @code{function} form,
except that if the argument is a @code{lambda} form then that
form may use a full Common Lisp argument list.
326
@end defmac
Glenn Morris's avatar
Glenn Morris committed
327

328
Also, all forms (such as @code{cl-flet} and @code{cl-labels}) defined
Glenn Morris's avatar
Glenn Morris committed
329 330 331
in this package that include @var{arglist}s in their syntax allow
full Common Lisp argument lists.

332
Note that it is @emph{not} necessary to use @code{cl-defun} in
333
order to have access to most CL features in your function.
334
These features are always present; @code{cl-defun}'s only
Glenn Morris's avatar
Glenn Morris committed
335 336 337 338 339 340
difference from @code{defun} is its more flexible argument
lists and its implicit block.

The full form of a Common Lisp argument list is

@example
341 342
(@var{var}@dots{}
 &optional (@var{var} @var{initform} @var{svar})@dots{}
Glenn Morris's avatar
Glenn Morris committed
343
 &rest @var{var}
344 345
 &key ((@var{keyword} @var{var}) @var{initform} @var{svar})@dots{}
 &aux (@var{var} @var{initform})@dots{})
Glenn Morris's avatar
Glenn Morris committed
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
@end example

Each of the five argument list sections is optional.  The @var{svar},
@var{initform}, and @var{keyword} parts are optional; if they are
omitted, then @samp{(@var{var})} may be written simply @samp{@var{var}}.

The first section consists of zero or more @dfn{required} arguments.
These arguments must always be specified in a call to the function;
there is no difference between Emacs Lisp and Common Lisp as far as
required arguments are concerned.

The second section consists of @dfn{optional} arguments.  These
arguments may be specified in the function call; if they are not,
@var{initform} specifies the default value used for the argument.
(No @var{initform} means to use @code{nil} as the default.)  The
@var{initform} is evaluated with the bindings for the preceding
arguments already established; @code{(a &optional (b (1+ a)))}
matches one or two arguments, with the second argument defaulting
to one plus the first argument.  If the @var{svar} is specified,
it is an auxiliary variable which is bound to @code{t} if the optional
argument was specified, or to @code{nil} if the argument was omitted.
If you don't use an @var{svar}, then there will be no way for your
function to tell whether it was called with no argument, or with
the default value passed explicitly as an argument.

The third section consists of a single @dfn{rest} argument.  If
more arguments were passed to the function than are accounted for
by the required and optional arguments, those extra arguments are
collected into a list and bound to the ``rest'' argument variable.
Common Lisp's @code{&rest} is equivalent to that of Emacs Lisp.
Common Lisp accepts @code{&body} as a synonym for @code{&rest} in
macro contexts; this package accepts it all the time.

The fourth section consists of @dfn{keyword} arguments.  These
are optional arguments which are specified by name rather than
positionally in the argument list.  For example,

@example
384
(cl-defun foo (a &optional b &key c d (e 17)))
Glenn Morris's avatar
Glenn Morris committed
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
@end example

@noindent
defines a function which may be called with one, two, or more
arguments.  The first two arguments are bound to @code{a} and
@code{b} in the usual way.  The remaining arguments must be
pairs of the form @code{:c}, @code{:d}, or @code{:e} followed
by the value to be bound to the corresponding argument variable.
(Symbols whose names begin with a colon are called @dfn{keywords},
and they are self-quoting in the same way as @code{nil} and
@code{t}.)

For example, the call @code{(foo 1 2 :d 3 :c 4)} sets the five
arguments to 1, 2, 4, 3, and 17, respectively.  If the same keyword
appears more than once in the function call, the first occurrence
takes precedence over the later ones.  Note that it is not possible
to specify keyword arguments without specifying the optional
argument @code{b} as well, since @code{(foo 1 :c 2)} would bind
@code{b} to the keyword @code{:c}, then signal an error because
@code{2} is not a valid keyword.

406 407 408 409
You can also explicitly specify the keyword argument; it need not be
simply the variable name prefixed with a colon.  For example,

@example
410
(cl-defun bar (&key (a 1) ((baz b) 4)))
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
@end example

@noindent

specifies a keyword @code{:a} that sets the variable @code{a} with
default value 1, as well as a keyword @code{baz} that sets the
variable @code{b} with default value 4.  In this case, because
@code{baz} is not self-quoting, you must quote it explicitly in the
function call, like this:

@example
(bar :a 10 'baz 42)
@end example

Ordinarily, it is an error to pass an unrecognized keyword to
Glenn Morris's avatar
Glenn Morris committed
426 427 428 429 430 431 432 433 434
a function, e.g., @code{(foo 1 2 :c 3 :goober 4)}.  You can ask
Lisp to ignore unrecognized keywords, either by adding the
marker @code{&allow-other-keys} after the keyword section
of the argument list, or by specifying an @code{:allow-other-keys}
argument in the call whose value is non-@code{nil}.  If the
function uses both @code{&rest} and @code{&key} at the same time,
the ``rest'' argument is bound to the keyword list as it appears
in the call.  For example:

435
@example
436 437
(cl-defun find-thing (thing &rest rest &key need &allow-other-keys)
  (or (apply 'cl-member thing thing-list :allow-other-keys t rest)
Glenn Morris's avatar
Glenn Morris committed
438
      (if need (error "Thing not found"))))
439
@end example
Glenn Morris's avatar
Glenn Morris committed
440 441 442 443

@noindent
This function takes a @code{:need} keyword argument, but also
accepts other keyword arguments which are passed on to the
444 445
@code{cl-member} function.  @code{allow-other-keys} is used to
keep both @code{find-thing} and @code{cl-member} from complaining
Glenn Morris's avatar
Glenn Morris committed
446 447 448 449 450 451 452 453 454 455
about each others' keywords in the arguments.

The fifth section of the argument list consists of @dfn{auxiliary
variables}.  These are not really arguments at all, but simply
variables which are bound to @code{nil} or to the specified
@var{initforms} during execution of the function.  There is no
difference between the following two functions, except for a
matter of stylistic taste:

@example
456
(cl-defun foo (a b &aux (c (+ a b)) d)
Glenn Morris's avatar
Glenn Morris committed
457 458
  @var{body})

459
(cl-defun foo (a b)
Glenn Morris's avatar
Glenn Morris committed
460 461 462 463 464 465
  (let ((c (+ a b)) d)
    @var{body}))
@end example

Argument lists support @dfn{destructuring}.  In Common Lisp,
destructuring is only allowed with @code{defmacro}; this package
466
allows it with @code{cl-defun} and other argument lists as well.
Glenn Morris's avatar
Glenn Morris committed
467
In destructuring, any argument variable (@var{var} in the above
Glenn Morris's avatar
Glenn Morris committed
468
example) can be replaced by a list of variables, or more generally,
Glenn Morris's avatar
Glenn Morris committed
469 470 471 472 473
a recursive argument list.  The corresponding argument value must
be a list whose elements match this recursive argument list.
For example:

@example
474
(cl-defmacro dolist ((var listform &optional resultform)
Glenn Morris's avatar
Glenn Morris committed
475
                   &rest body)
476
  @dots{})
Glenn Morris's avatar
Glenn Morris committed
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
@end example

This says that the first argument of @code{dolist} must be a list
of two or three items; if there are other arguments as well as this
list, they are stored in @code{body}.  All features allowed in
regular argument lists are allowed in these recursive argument lists.
In addition, the clause @samp{&whole @var{var}} is allowed at the
front of a recursive argument list.  It binds @var{var} to the
whole list being matched; thus @code{(&whole all a b)} matches
a list of two things, with @code{a} bound to the first thing,
@code{b} bound to the second thing, and @code{all} bound to the
list itself.  (Common Lisp allows @code{&whole} in top-level
@code{defmacro} argument lists as well, but Emacs Lisp does not
support this usage.)

One last feature of destructuring is that the argument list may be
dotted, so that the argument list @code{(a b . c)} is functionally
equivalent to @code{(a b &rest c)}.

If the optimization quality @code{safety} is set to 0
(@pxref{Declarations}), error checking for wrong number of
arguments and invalid keyword arguments is disabled.  By default,
argument lists are rigorously checked.

501
@node Time of Evaluation
Glenn Morris's avatar
Glenn Morris committed
502 503 504 505 506 507 508 509 510 511 512 513 514
@section Time of Evaluation

@noindent
Normally, the byte-compiler does not actually execute the forms in
a file it compiles.  For example, if a file contains @code{(setq foo t)},
the act of compiling it will not actually set @code{foo} to @code{t}.
This is true even if the @code{setq} was a top-level form (i.e., not
enclosed in a @code{defun} or other form).  Sometimes, though, you
would like to have certain top-level forms evaluated at compile-time.
For example, the compiler effectively evaluates @code{defmacro} forms
at compile-time so that later parts of the file can refer to the
macros that are defined.

515
@defmac cl-eval-when (situations@dots{}) forms@dots{}
Glenn Morris's avatar
Glenn Morris committed
516 517 518 519 520 521
This form controls when the body @var{forms} are evaluated.
The @var{situations} list may contain any set of the symbols
@code{compile}, @code{load}, and @code{eval} (or their long-winded
ANSI equivalents, @code{:compile-toplevel}, @code{:load-toplevel},
and @code{:execute}).

522
The @code{cl-eval-when} form is handled differently depending on
Glenn Morris's avatar
Glenn Morris committed
523 524 525 526 527 528
whether or not it is being compiled as a top-level form.
Specifically, it gets special treatment if it is being compiled
by a command such as @code{byte-compile-file} which compiles files
or buffers of code, and it appears either literally at the
top level of the file or inside a top-level @code{progn}.

529
For compiled top-level @code{cl-eval-when}s, the body @var{forms} are
Glenn Morris's avatar
Glenn Morris committed
530 531 532 533 534 535 536
executed at compile-time if @code{compile} is in the @var{situations}
list, and the @var{forms} are written out to the file (to be executed
at load-time) if @code{load} is in the @var{situations} list.

For non-compiled-top-level forms, only the @code{eval} situation is
relevant.  (This includes forms executed by the interpreter, forms
compiled with @code{byte-compile} rather than @code{byte-compile-file},
537
and non-top-level forms.)  The @code{cl-eval-when} acts like a
Glenn Morris's avatar
Glenn Morris committed
538 539 540
@code{progn} if @code{eval} is specified, and like @code{nil}
(ignoring the body @var{forms}) if not.

541
The rules become more subtle when @code{cl-eval-when}s are nested;
Glenn Morris's avatar
Glenn Morris committed
542 543 544 545 546 547 548
consult Steele (second edition) for the gruesome details (and
some gruesome examples).

Some simple examples:

@example
;; Top-level forms in foo.el:
549 550 551 552 553 554 555
(cl-eval-when (compile)           (setq foo1 'bar))
(cl-eval-when (load)              (setq foo2 'bar))
(cl-eval-when (compile load)      (setq foo3 'bar))
(cl-eval-when (eval)              (setq foo4 'bar))
(cl-eval-when (eval compile)      (setq foo5 'bar))
(cl-eval-when (eval load)         (setq foo6 'bar))
(cl-eval-when (eval compile load) (setq foo7 'bar))
Glenn Morris's avatar
Glenn Morris committed
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
@end example

When @file{foo.el} is compiled, these variables will be set during
the compilation itself:

@example
foo1  foo3  foo5  foo7      ; `compile'
@end example

When @file{foo.elc} is loaded, these variables will be set:

@example
foo2  foo3  foo6  foo7      ; `load'
@end example

And if @file{foo.el} is loaded uncompiled, these variables will
be set:

@example
foo4  foo5  foo6  foo7      ; `eval'
@end example

578
If these seven @code{cl-eval-when}s had been, say, inside a @code{defun},
Glenn Morris's avatar
Glenn Morris committed
579 580 581
then the first three would have been equivalent to @code{nil} and the
last four would have been equivalent to the corresponding @code{setq}s.

582
Note that @code{(cl-eval-when (load eval) @dots{})} is equivalent
Glenn Morris's avatar
Glenn Morris committed
583 584
to @code{(progn @dots{})} in all contexts.  The compiler treats
certain top-level forms, like @code{defmacro} (sort-of) and
Glenn Morris's avatar
Glenn Morris committed
585
@code{require}, as if they were wrapped in @code{(cl-eval-when
Glenn Morris's avatar
Glenn Morris committed
586
(compile load eval) @dots{})}.
587
@end defmac
Glenn Morris's avatar
Glenn Morris committed
588

589
Emacs includes two special forms related to @code{cl-eval-when}.
Glenn Morris's avatar
Glenn Morris committed
590
@xref{Eval During Compile,,,elisp,GNU Emacs Lisp Reference Manual}.
Glenn Morris's avatar
Glenn Morris committed
591
One of these, @code{eval-when-compile}, is not quite equivalent to
Glenn Morris's avatar
Glenn Morris committed
592
any @code{cl-eval-when} construct and is described below.
Glenn Morris's avatar
Glenn Morris committed
593 594

The other form, @code{(eval-and-compile @dots{})}, is exactly
Glenn Morris's avatar
Glenn Morris committed
595
equivalent to @samp{(cl-eval-when (compile load eval) @dots{})}.
Glenn Morris's avatar
Glenn Morris committed
596

597
@defmac eval-when-compile forms@dots{}
Glenn Morris's avatar
Glenn Morris committed
598 599 600 601 602 603 604 605
The @var{forms} are evaluated at compile-time; at execution time,
this form acts like a quoted constant of the resulting value.  Used
at top-level, @code{eval-when-compile} is just like @samp{eval-when
(compile eval)}.  In other contexts, @code{eval-when-compile}
allows code to be evaluated once at compile-time for efficiency
or other reasons.

This form is similar to the @samp{#.} syntax of true Common Lisp.
606
@end defmac
Glenn Morris's avatar
Glenn Morris committed
607

608
@defmac cl-load-time-value form
Glenn Morris's avatar
Glenn Morris committed
609 610 611 612 613 614 615
The @var{form} is evaluated at load-time; at execution time,
this form acts like a quoted constant of the resulting value.

Early Common Lisp had a @samp{#,} syntax that was similar to
this, but ANSI Common Lisp replaced it with @code{load-time-value}
and gave it more well-defined semantics.

616
In a compiled file, @code{cl-load-time-value} arranges for @var{form}
Glenn Morris's avatar
Glenn Morris committed
617 618 619 620
to be evaluated when the @file{.elc} file is loaded and then used
as if it were a quoted constant.  In code compiled by
@code{byte-compile} rather than @code{byte-compile-file}, the
effect is identical to @code{eval-when-compile}.  In uncompiled
621
code, both @code{eval-when-compile} and @code{cl-load-time-value}
Glenn Morris's avatar
Glenn Morris committed
622 623 624 625 626 627 628 629 630 631
act exactly like @code{progn}.

@example
(defun report ()
  (insert "This function was executed on: "
          (current-time-string)
          ", compiled on: "
          (eval-when-compile (current-time-string))
          ;; or '#.(current-time-string) in real Common Lisp
          ", and loaded on: "
632
          (cl-load-time-value (current-time-string))))
Glenn Morris's avatar
Glenn Morris committed
633 634 635 636 637 638 639 640 641 642 643 644
@end example

@noindent
Byte-compiled, the above defun will result in the following code
(or its compiled equivalent, of course) in the @file{.elc} file:

@example
(setq --temp-- (current-time-string))
(defun report ()
  (insert "This function was executed on: "
          (current-time-string)
          ", compiled on: "
645
          '"Wed Oct 31 16:32:28 2012"
Glenn Morris's avatar
Glenn Morris committed
646 647 648
          ", and loaded on: "
          --temp--))
@end example
649
@end defmac
Glenn Morris's avatar
Glenn Morris committed
650

651
@node Predicates
Glenn Morris's avatar
Glenn Morris committed
652 653 654 655 656 657 658
@chapter Predicates

@noindent
This section describes functions for testing whether various
facts are true or false.

@menu
659 660
* Type Predicates::      @code{cl-typep}, @code{cl-deftype}, and @code{cl-coerce}.
* Equality Predicates::  @code{cl-equalp}.
Glenn Morris's avatar
Glenn Morris committed
661 662
@end menu

663
@node Type Predicates
Glenn Morris's avatar
Glenn Morris committed
664 665
@section Type Predicates

666
@defun cl-typep object type
Glenn Morris's avatar
Glenn Morris committed
667 668
Check if @var{object} is of type @var{type}, where @var{type} is a
(quoted) type name of the sort used by Common Lisp.  For example,
669
@code{(cl-typep foo 'integer)} is equivalent to @code{(integerp foo)}.
Glenn Morris's avatar
Glenn Morris committed
670 671 672 673 674 675 676 677 678 679 680 681 682 683
@end defun

The @var{type} argument to the above function is either a symbol
or a list beginning with a symbol.

@itemize @bullet
@item
If the type name is a symbol, Emacs appends @samp{-p} to the
symbol name to form the name of a predicate function for testing
the type.  (Built-in predicates whose names end in @samp{p} rather
than @samp{-p} are used when appropriate.)

@item
The type symbol @code{t} stands for the union of all types.
684
@code{(cl-typep @var{object} t)} is always true.  Likewise, the
Glenn Morris's avatar
Glenn Morris committed
685
type symbol @code{nil} stands for nothing at all, and
686
@code{(cl-typep @var{object} nil)} is always false.
Glenn Morris's avatar
Glenn Morris committed
687 688 689

@item
The type symbol @code{null} represents the symbol @code{nil}.
690
Thus @code{(cl-typep @var{object} 'null)} is equivalent to
Glenn Morris's avatar
Glenn Morris committed
691 692 693 694
@code{(null @var{object})}.

@item
The type symbol @code{atom} represents all objects that are not cons
695
cells. Thus @code{(cl-typep @var{object} 'atom)} is equivalent to
Glenn Morris's avatar
Glenn Morris committed
696 697 698 699 700 701 702 703 704 705
@code{(atom @var{object})}.

@item
The type symbol @code{real} is a synonym for @code{number}, and
@code{fixnum} is a synonym for @code{integer}.

@item
The type symbols @code{character} and @code{string-char} match
integers in the range from 0 to 255.

706 707
@c No longer relevant, so covered by first item above (float -> floatp).
@ignore
Glenn Morris's avatar
Glenn Morris committed
708
@item
709
The type symbol @code{float} uses the @code{cl-floatp-safe} predicate
Glenn Morris's avatar
Glenn Morris committed
710 711
defined by this package rather than @code{floatp}, so it will work
correctly even in Emacs versions without floating-point support.
712
@end ignore
Glenn Morris's avatar
Glenn Morris committed
713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731

@item
The type list @code{(integer @var{low} @var{high})} represents all
integers between @var{low} and @var{high}, inclusive.  Either bound
may be a list of a single integer to specify an exclusive limit,
or a @code{*} to specify no limit.  The type @code{(integer * *)}
is thus equivalent to @code{integer}.

@item
Likewise, lists beginning with @code{float}, @code{real}, or
@code{number} represent numbers of that type falling in a particular
range.

@item
Lists beginning with @code{and}, @code{or}, and @code{not} form
combinations of types.  For example, @code{(or integer (float 0 *))}
represents all objects that are integers or non-negative floats.

@item
732
Lists beginning with @code{member} or @code{cl-member} represent
Glenn Morris's avatar
Glenn Morris committed
733 734 735 736 737 738 739 740 741 742 743
objects @code{eql} to any of the following values.  For example,
@code{(member 1 2 3 4)} is equivalent to @code{(integer 1 4)},
and @code{(member nil)} is equivalent to @code{null}.

@item
Lists of the form @code{(satisfies @var{predicate})} represent
all objects for which @var{predicate} returns true when called
with that object as an argument.
@end itemize

The following function and macro (not technically predicates) are
744
related to @code{cl-typep}.
Glenn Morris's avatar
Glenn Morris committed
745

746
@defun cl-coerce object type
Glenn Morris's avatar
Glenn Morris committed
747 748
This function attempts to convert @var{object} to the specified
@var{type}.  If @var{object} is already of that type as determined by
Glenn Morris's avatar
Glenn Morris committed
749
@code{cl-typep}, it is simply returned.  Otherwise, certain types of
Glenn Morris's avatar
Glenn Morris committed
750 751 752 753 754 755
conversions will be made:  If @var{type} is any sequence type
(@code{string}, @code{list}, etc.) then @var{object} will be
converted to that type if possible.  If @var{type} is
@code{character}, then strings of length one and symbols with
one-character names can be coerced.  If @var{type} is @code{float},
then integers can be coerced in versions of Emacs that support
756
floats.  In all other circumstances, @code{cl-coerce} signals an
Glenn Morris's avatar
Glenn Morris committed
757 758 759
error.
@end defun

760
@defmac cl-deftype name arglist forms@dots{}
Glenn Morris's avatar
Glenn Morris committed
761 762 763 764 765
This macro defines a new type called @var{name}.  It is similar
to @code{defmacro} in many ways; when @var{name} is encountered
as a type name, the body @var{forms} are evaluated and should
return a type specifier that is equivalent to the type.  The
@var{arglist} is a Common Lisp argument list of the sort accepted
766
by @code{cl-defmacro}.  The type specifier @samp{(@var{name} @var{args}@dots{})}
Glenn Morris's avatar
Glenn Morris committed
767 768 769
is expanded by calling the expander with those arguments; the type
symbol @samp{@var{name}} is expanded by calling the expander with
no arguments.  The @var{arglist} is processed the same as for
770
@code{cl-defmacro} except that optional arguments without explicit
Glenn Morris's avatar
Glenn Morris committed
771 772 773 774
defaults use @code{*} instead of @code{nil} as the ``default''
default.  Some examples:

@example
775 776 777
(cl-deftype null () '(satisfies null))    ; predefined
(cl-deftype list () '(or null cons))      ; predefined
(cl-deftype unsigned-byte (&optional bits)
Glenn Morris's avatar
Glenn Morris committed
778 779 780 781 782 783 784 785 786 787
  (list 'integer 0 (if (eq bits '*) bits (1- (lsh 1 bits)))))
(unsigned-byte 8)  @equiv{}  (integer 0 255)
(unsigned-byte)  @equiv{}  (integer 0 *)
unsigned-byte  @equiv{}  (integer 0 *)
@end example

@noindent
The last example shows how the Common Lisp @code{unsigned-byte}
type specifier could be implemented if desired; this package does
not implement @code{unsigned-byte} by default.
788
@end defmac
Glenn Morris's avatar
Glenn Morris committed
789

Glenn Morris's avatar
Glenn Morris committed
790 791
The @code{cl-typecase} (@pxref{Conditionals}) and @code{cl-check-type}
(@pxref{Assertions}) macros also use type names.  The @code{cl-map},
792
@code{cl-concatenate}, and @code{cl-merge} functions take type-name
Glenn Morris's avatar
Glenn Morris committed
793 794
arguments to specify the type of sequence to return.  @xref{Sequences}.

795
@node Equality Predicates
Glenn Morris's avatar
Glenn Morris committed
796 797 798
@section Equality Predicates

@noindent
799
This package defines the Common Lisp predicate @code{cl-equalp}.
Glenn Morris's avatar
Glenn Morris committed
800

801
@defun cl-equalp a b
Glenn Morris's avatar
Glenn Morris committed
802 803
This function is a more flexible version of @code{equal}.  In
particular, it compares strings case-insensitively, and it compares
804
numbers without regard to type (so that @code{(cl-equalp 3 3.0)} is
Glenn Morris's avatar
Glenn Morris committed
805 806 807 808 809 810 811 812
true).  Vectors and conses are compared recursively.  All other
objects are compared as if by @code{equal}.

This function differs from Common Lisp @code{equalp} in several
respects.  First, Common Lisp's @code{equalp} also compares
@emph{characters} case-insensitively, which would be impractical
in this package since Emacs does not distinguish between integers
and characters.  In keeping with the idea that strings are less
813
vector-like in Emacs Lisp, this package's @code{cl-equalp} also will
Glenn Morris's avatar
Glenn Morris committed
814 815 816 817 818 819
not compare strings against vectors of integers.
@end defun

Also note that the Common Lisp functions @code{member} and @code{assoc}
use @code{eql} to compare elements, whereas Emacs Lisp follows the
MacLisp tradition and uses @code{equal} for these two functions.
820 821
In Emacs, use @code{memq} (or @code{cl-member}) and @code{assq} (or
@code{cl-assoc}) to get functions which use @code{eql} for comparisons.
Glenn Morris's avatar
Glenn Morris committed
822

823
@node Control Structure
Glenn Morris's avatar
Glenn Morris committed
824 825 826 827
@chapter Control Structure

@noindent
The features described in the following sections implement
828 829
various advanced control structures, including extensions to the
standard @code{setf} facility, and a number of looping and conditional
Glenn Morris's avatar
Glenn Morris committed
830 831 832
constructs.

@menu
833
* Assignment::             The @code{cl-psetq} form.
834
* Generalized Variables::  Extensions to generalized variables.
835
* Variable Bindings::      @code{cl-progv}, @code{cl-flet}, @code{cl-macrolet}.
836 837 838 839
* Conditionals::           @code{cl-case}, @code{cl-typecase}.
* Blocks and Exits::       @code{cl-block}, @code{cl-return}, @code{cl-return-from}.
* Iteration::              @code{cl-do}, @code{cl-dotimes}, @code{cl-dolist}, @code{cl-do-symbols}.
* Loop Facility::          The Common Lisp @code{cl-loop} macro.
Glenn Morris's avatar
Glenn Morris committed
840
* Multiple Values::        @code{cl-values}, @code{cl-multiple-value-bind}, etc.
Glenn Morris's avatar
Glenn Morris committed
841 842
@end menu

843
@node Assignment
Glenn Morris's avatar
Glenn Morris committed
844 845 846
@section Assignment

@noindent
847
The @code{cl-psetq} form is just like @code{setq}, except that multiple
Glenn Morris's avatar
Glenn Morris committed
848 849
assignments are done in parallel rather than sequentially.

850
@defmac cl-psetq [symbol form]@dots{}
Glenn Morris's avatar
Glenn Morris committed
851 852 853 854 855 856 857 858 859 860 861 862 863 864
This special form (actually a macro) is used to assign to several
variables simultaneously.  Given only one @var{symbol} and @var{form},
it has the same effect as @code{setq}.  Given several @var{symbol}
and @var{form} pairs, it evaluates all the @var{form}s in advance
and then stores the corresponding variables afterwards.

@example
(setq x 2 y 3)
(setq x (+ x y)  y (* x y))
x
     @result{} 5
y                     ; @r{@code{y} was computed after @code{x} was set.}
     @result{} 15
(setq x 2 y 3)
865
(cl-psetq x (+ x y)  y (* x y))
Glenn Morris's avatar
Glenn Morris committed
866 867 868 869 870 871
x
     @result{} 5
y                     ; @r{@code{y} was computed before @code{x} was set.}
     @result{} 6
@end example

872 873
The simplest use of @code{cl-psetq} is @code{(cl-psetq x y y x)}, which
exchanges the values of two variables.  (The @code{cl-rotatef} form
Glenn Morris's avatar
Glenn Morris committed
874 875 876
provides an even more convenient way to swap two variables;
@pxref{Modify Macros}.)

877
@code{cl-psetq} always returns @code{nil}.
878
@end defmac
Glenn Morris's avatar
Glenn Morris committed
879

880
@node Generalized Variables
Glenn Morris's avatar
Glenn Morris committed
881 882
@section Generalized Variables

883 884
A @dfn{generalized variable} or @dfn{place form} is one of the many
places in Lisp memory where values can be stored.  The simplest place
885
form is a regular Lisp variable.  But the @sc{car}s and @sc{cdr}s of lists,
886 887 888 889 890
elements of arrays, properties of symbols, and many other locations
are also places where Lisp values are stored.  For basic information,
@pxref{Generalized Variables,,,elisp,GNU Emacs Lisp Reference Manual}.
This package provides several additional features related to
generalized variables.
Glenn Morris's avatar
Glenn Morris committed
891 892

@menu
893
* Setf Extensions::    Additional @code{setf} places.
894
* Modify Macros::      @code{cl-incf}, @code{cl-rotatef}, @code{cl-letf}, @code{cl-callf}, etc.
Glenn Morris's avatar
Glenn Morris committed
895 896
@end menu

897 898
@node Setf Extensions
@subsection Setf Extensions
Glenn Morris's avatar
Glenn Morris committed
899

900 901
Several standard (e.g.@: @code{car}) and Emacs-specific
(e.g.@: @code{window-point}) Lisp functions are @code{setf}-able by default.
902
This package defines @code{setf} handlers for several additional functions:
Glenn Morris's avatar
Glenn Morris committed
903

904
@itemize
Glenn Morris's avatar
Glenn Morris committed
905
@item
906 907 908 909 910
Functions from this package:
@example
cl-rest        cl-subseq      cl-get         cl-getf
cl-caaar@dots{}cl-cddddr          cl-first@dots{}cl-tenth
@end example
Glenn Morris's avatar
Glenn Morris committed
911

912 913 914 915
@noindent
Note that for @code{cl-getf} (as for @code{nthcdr}), the list argument
of the function must itself be a valid @var{place} form.

Glenn Morris's avatar
Glenn Morris committed
916
@item
917
General Emacs Lisp functions:
918
@example
919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943
buffer-file-name                   getenv
buffer-modified-p                  global-key-binding
buffer-name                        local-key-binding
buffer-string                      mark
buffer-substring                   mark-marker
current-buffer                     marker-position
current-case-table                 mouse-position
current-column                     point
current-global-map                 point-marker
current-input-mode                 point-max
current-local-map                  point-min
current-window-configuration       read-mouse-position
default-file-modes                 screen-height
documentation-property             screen-width
face-background                    selected-window
face-background-pixmap             selected-screen
face-font                          selected-frame
face-foreground                    standard-case-table
face-underline-p                   syntax-table
file-modes                         visited-file-modtime
frame-height                       window-height
frame-parameters                   window-width
frame-visible-p                    x-get-secondary-selection
frame-width                        x-get-selection
get-register
944
@end example
Glenn Morris's avatar
Glenn Morris committed
945 946 947 948

Most of these have directly corresponding ``set'' functions, like
@code{use-local-map} for @code{current-local-map}, or @code{goto-char}
for @code{point}.  A few, like @code{point-min}, expand to longer
949 950
sequences of code when they are used with @code{setf}
(@code{(narrow-to-region x (point-max))} in this case).
Glenn Morris's avatar
Glenn Morris committed
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976

@item
A call of the form @code{(substring @var{subplace} @var{n} [@var{m}])},
where @var{subplace} is itself a valid generalized variable whose
current value is a string, and where the value stored is also a
string.  The new string is spliced into the specified part of the
destination string.  For example:

@example
(setq a (list "hello" "world"))
     @result{} ("hello" "world")
(cadr a)
     @result{} "world"
(substring (cadr a) 2 4)
     @result{} "rl"
(setf (substring (cadr a) 2 4) "o")
     @result{} "o"
(cadr a)
     @result{} "wood"
a
     @result{} ("hello" "wood")
@end example

The generalized variable @code{buffer-substring}, listed above,
also works in this way by replacing a portion of the current buffer.

977 978
@c FIXME? Also `eq'? (see cl-lib.el)

979 980
@c Currently commented out in cl.el.
@ignore
Glenn Morris's avatar
Glenn Morris committed
981 982 983 984 985 986 987 988
@item
A call of the form @code{(apply '@var{func} @dots{})} or
@code{(apply (function @var{func}) @dots{})}, where @var{func}
is a @code{setf}-able function whose store function is ``suitable''
in the sense described in Steele's book; since none of the standard
Emacs place functions are suitable in this sense, this feature is
only interesting when used with places you define yourself with
@code{define-setf-method} or the long form of @code{defsetf}.
989
@xref{Obsolete Setf Customization}.
990
@end ignore
Glenn Morris's avatar
Glenn Morris committed
991 992 993 994 995 996 997

@item
A macro call, in which case the macro is expanded and @code{setf}
is applied to the resulting form.

@item
Any form for which a @code{defsetf} or @code{define-setf-method}