Merge from emacs-23
[bpt/emacs.git] / lisp / emacs-lisp / cl.el
CommitLineData
87787319 1;;; cl.el --- Common Lisp extensions for Emacs
fcd73769 2
4b949062 3;; Copyright (C) 1993, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
5df4f04c 4;; 2009, 2010, 2011 Free Software Foundation, Inc.
fcd73769
RS
5
6;; Author: Dave Gillespie <daveg@synaptics.com>
7;; Version: 2.02
8;; Keywords: extensions
9
10;; This file is part of GNU Emacs.
11
d6cba7ae 12;; GNU Emacs is free software: you can redistribute it and/or modify
fcd73769 13;; it under the terms of the GNU General Public License as published by
d6cba7ae
GM
14;; the Free Software Foundation, either version 3 of the License, or
15;; (at your option) any later version.
fcd73769
RS
16
17;; GNU Emacs is distributed in the hope that it will be useful,
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
21
22;; You should have received a copy of the GNU General Public License
d6cba7ae 23;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
fcd73769 24
07b3798c 25;;; Commentary:
fcd73769
RS
26
27;; These are extensions to Emacs Lisp that provide a degree of
28;; Common Lisp compatibility, beyond what is already built-in
29;; in Emacs Lisp.
30;;
31;; This package was written by Dave Gillespie; it is a complete
32;; rewrite of Cesar Quiroz's original cl.el package of December 1986.
33;;
fcd73769
RS
34;; Bug reports, comments, and suggestions are welcome!
35
36;; This file contains the portions of the Common Lisp extensions
37;; package which should always be present.
38
39
07b3798c 40;;; Future notes:
fcd73769
RS
41
42;; Once Emacs 19 becomes standard, many things in this package which are
43;; messy for reasons of compatibility can be greatly simplified. For now,
44;; I prefer to maintain one unified version.
45
46
07b3798c 47;;; Change Log:
fcd73769
RS
48
49;; Version 2.02 (30 Jul 93):
50;; * Added "cl-compat.el" file, extra compatibility with old package.
51;; * Added `lexical-let' and `lexical-let*'.
52;; * Added `define-modify-macro', `callf', and `callf2'.
53;; * Added `ignore-errors'.
54;; * Changed `(setf (nthcdr N PLACE) X)' to work when N is zero.
55;; * Merged `*gentemp-counter*' into `*gensym-counter*'.
56;; * Extended `subseq' to allow negative START and END like `substring'.
57;; * Added `in-ref', `across-ref', `elements of-ref' loop clauses.
58;; * Added `concat', `vconcat' loop clauses.
59;; * Cleaned up a number of compiler warnings.
60
61;; Version 2.01 (7 Jul 93):
62;; * Added support for FSF version of Emacs 19.
63;; * Added `add-hook' for Emacs 18 users.
64;; * Added `defsubst*' and `symbol-macrolet'.
65;; * Added `maplist', `mapc', `mapl', `mapcan', `mapcon'.
66;; * Added `map', `concatenate', `reduce', `merge'.
67;; * Added `revappend', `nreconc', `tailp', `tree-equal'.
68;; * Added `assert', `check-type', `typecase', `typep', and `deftype'.
69;; * Added destructuring and `&environment' support to `defmacro*'.
70;; * Added destructuring to `loop', and added the following clauses:
71;; `elements', `frames', `overlays', `intervals', `buffers', `key-seqs'.
72;; * Renamed `delete' to `delete*' and `remove' to `remove*'.
73;; * Completed support for all keywords in `remove*', `substitute', etc.
74;; * Added `most-positive-float' and company.
75;; * Fixed hash tables to work with latest Lucid Emacs.
76;; * `proclaim' forms are no longer compile-time-evaluating; use `declaim'.
77;; * Syntax for `warn' declarations has changed.
78;; * Improved implementation of `random*'.
79;; * Moved most sequence functions to a new file, cl-seq.el.
80;; * Moved `eval-when' into cl-macs.el.
81;; * Moved `pushnew' and `adjoin' to cl.el for most common cases.
82;; * Moved `provide' forms down to ends of files.
83;; * Changed expansion of `pop' to something that compiles to better code.
84;; * Changed so that no patch is required for Emacs 19 byte compiler.
85;; * Made more things dependent on `optimize' declarations.
86;; * Added a partial implementation of struct print functions.
87;; * Miscellaneous minor changes.
88
89;; Version 2.00:
90;; * First public release of this package.
91
92
07b3798c 93;;; Code:
fcd73769 94
fcd73769
RS
95(defvar cl-optimize-speed 1)
96(defvar cl-optimize-safety 1)
97
98
7dcf6269 99;;;###autoload
fcd73769
RS
100(defvar custom-print-functions nil
101 "This is a list of functions that format user objects for printing.
102Each function is called in turn with three arguments: the object, the
103stream, and the print level (currently ignored). If it is able to
104print the object it returns true; otherwise it returns nil and the
105printer proceeds to the next function on the list.
106
107This variable is not used at present, but it is defined in hopes that
108a future Emacs interpreter will be able to use it.")
109
66eed827
JB
110(defun cl-unload-function ()
111 "Stop unloading of the Common Lisp extensions."
112 (message "Cannot unload the feature `cl'")
113 ;; stop standard unloading!
114 t)
fcd73769 115
b68f6e48
SM
116;;; Generalized variables.
117;; These macros are defined here so that they
118;; can safely be used in .emacs files.
fcd73769
RS
119
120(defmacro incf (place &optional x)
64a4c526 121 "Increment PLACE by X (1 by default).
fcd73769
RS
122PLACE may be a symbol, or any generalized variable allowed by `setf'.
123The return value is the incremented value of PLACE."
124 (if (symbolp place)
125 (list 'setq place (if x (list '+ place x) (list '1+ place)))
126 (list 'callf '+ place (or x 1))))
127
128(defmacro decf (place &optional x)
64a4c526 129 "Decrement PLACE by X (1 by default).
fcd73769
RS
130PLACE may be a symbol, or any generalized variable allowed by `setf'.
131The return value is the decremented value of PLACE."
132 (if (symbolp place)
133 (list 'setq place (if x (list '- place x) (list '1- place)))
134 (list 'callf '- place (or x 1))))
135
7467c796
GM
136;; Autoloaded, but we haven't loaded cl-loaddefs yet.
137(declare-function cl-do-pop "cl-macs" (place))
138
fcd73769 139(defmacro pop (place)
64a4c526 140 "Remove and return the head of the list stored in PLACE.
fcd73769
RS
141Analogous to (prog1 (car PLACE) (setf PLACE (cdr PLACE))), though more
142careful about evaluating each argument only once and in the right order.
143PLACE may be a symbol, or any generalized variable allowed by `setf'."
144 (if (symbolp place)
145 (list 'car (list 'prog1 place (list 'setq place (list 'cdr place))))
146 (cl-do-pop place)))
147
148(defmacro push (x place)
64a4c526 149 "Insert X at the head of the list stored in PLACE.
fcd73769
RS
150Analogous to (setf PLACE (cons X PLACE)), though more careful about
151evaluating each argument only once and in the right order. PLACE may
152be a symbol, or any generalized variable allowed by `setf'."
153 (if (symbolp place) (list 'setq place (list 'cons x place))
154 (list 'callf2 'cons x place)))
155
156(defmacro pushnew (x place &rest keys)
157 "(pushnew X PLACE): insert X at the head of the list if not already there.
158Like (push X PLACE), except that the list is unmodified if X is `eql' to
159an element already on the list.
708c63a6
JB
160\nKeywords supported: :test :test-not :key
161\n(fn X PLACE [KEYWORD VALUE]...)"
6b34950f
RS
162 (if (symbolp place)
163 (if (null keys)
fcecceea
KS
164 `(let ((x ,x))
165 (if (memql x ,place) ,place (setq ,place (cons x ,place))))
6b34950f 166 (list 'setq place (list* 'adjoin x place keys)))
fcd73769
RS
167 (list* 'callf2 'adjoin x place keys)))
168
169(defun cl-set-elt (seq n val)
170 (if (listp seq) (setcar (nthcdr n seq) val) (aset seq n val)))
171
4ded1ddb 172(defsubst cl-set-nthcdr (n list x)
fcd73769
RS
173 (if (<= n 0) x (setcdr (nthcdr (1- n) list) x) list))
174
175(defun cl-set-buffer-substring (start end val)
176 (save-excursion (delete-region start end)
177 (goto-char start)
178 (insert val)
179 val))
180
181(defun cl-set-substring (str start end val)
182 (if end (if (< end 0) (incf end (length str)))
183 (setq end (length str)))
87dd507f 184 (if (< start 0) (incf start (length str)))
fcd73769
RS
185 (concat (and (> start 0) (substring str 0 start))
186 val
187 (and (< end (length str)) (substring str end))))
188
189
190;;; Control structures.
191
b68f6e48
SM
192;; These macros are so simple and so often-used that it's better to have
193;; them all the time than to load them from cl-macs.el.
fcd73769 194
fcd73769 195(defun cl-map-extents (&rest cl-args)
f67171e6 196 (apply 'cl-map-overlays cl-args))
fcd73769
RS
197
198
199;;; Blocks and exits.
200
201(defalias 'cl-block-wrapper 'identity)
202(defalias 'cl-block-throw 'throw)
203
204
b68f6e48
SM
205;;; Multiple values.
206;; True multiple values are not supported, or even
207;; simulated. Instead, multiple-value-bind and friends simply expect
208;; the target form to return the values as a list.
fcd73769 209
413da451
RS
210(defsubst values (&rest values)
211 "Return multiple values, Common Lisp style.
212The arguments of `values' are the values
213that the containing function should return."
8f7ef366 214 values)
413da451
RS
215
216(defsubst values-list (list)
217 "Return multiple values, Common Lisp style, taken from a list.
218LIST specifies the list of values
219that the containing function should return."
220 list)
221
222(defsubst multiple-value-list (expression)
223 "Return a list of the multiple values produced by EXPRESSION.
224This handles multiple values in Common Lisp style, but it does not
225work right when EXPRESSION calls an ordinary Emacs Lisp function
226that returns just one value."
227 expression)
228
229(defsubst multiple-value-apply (function expression)
230 "Evaluate EXPRESSION to get multiple values and apply FUNCTION to them.
231This handles multiple values in Common Lisp style, but it does not work
232right when EXPRESSION calls an ordinary Emacs Lisp function that returns just
233one value."
234 (apply function expression))
235
a2e74caa
SM
236(defalias 'multiple-value-call 'apply
237 "Apply FUNCTION to ARGUMENTS, taking multiple values into account.
238This implementation only handles the case where there is only one argument.")
f988b541 239
413da451
RS
240(defsubst nth-value (n expression)
241 "Evaluate EXPRESSION to get multiple values and return the Nth one.
242This handles multiple values in Common Lisp style, but it does not work
243right when EXPRESSION calls an ordinary Emacs Lisp function that returns just
244one value."
245 (nth n expression))
fcd73769
RS
246
247;;; Macros.
248
7eb73deb 249(defvar cl-macro-environment)
fcd73769
RS
250(defvar cl-old-macroexpand (prog1 (symbol-function 'macroexpand)
251 (defalias 'macroexpand 'cl-macroexpand)))
252
253(defun cl-macroexpand (cl-macro &optional cl-env)
2a8160e6
RS
254 "Return result of expanding macros at top level of FORM.
255If FORM is not a macro call, it is returned unchanged.
256Otherwise, the macro is expanded and the expansion is considered
257in place of FORM. When a non-macro-call results, it is returned.
258
f15e298c 259The second optional arg ENVIRONMENT specifies an environment of macro
708c63a6
JB
260definitions to shadow the loaded ones for use in file byte-compilation.
261\n(fn FORM &optional ENVIRONMENT)"
fcd73769
RS
262 (let ((cl-macro-environment cl-env))
263 (while (progn (setq cl-macro (funcall cl-old-macroexpand cl-macro cl-env))
264 (and (symbolp cl-macro)
265 (cdr (assq (symbol-name cl-macro) cl-env))))
266 (setq cl-macro (cadr (assq (symbol-name cl-macro) cl-env))))
267 cl-macro))
268
269
270;;; Declarations.
271
272(defvar cl-compiling-file nil)
273(defun cl-compiling-file ()
274 (or cl-compiling-file
4b949062
GM
275 (and (boundp 'bytecomp-outbuffer)
276 (bufferp (symbol-value 'bytecomp-outbuffer))
277 (equal (buffer-name (symbol-value 'bytecomp-outbuffer))
fcd73769
RS
278 " *Compiler Output*"))))
279
280(defvar cl-proclaims-deferred nil)
281
282(defun proclaim (spec)
283 (if (fboundp 'cl-do-proclaim) (cl-do-proclaim spec t)
284 (push spec cl-proclaims-deferred))
285 nil)
286
287(defmacro declaim (&rest specs)
288 (let ((body (mapcar (function (lambda (x) (list 'proclaim (list 'quote x))))
289 specs)))
290 (if (cl-compiling-file) (list* 'eval-when '(compile load eval) body)
291 (cons 'progn body)))) ; avoid loading cl-macs.el for eval-when
292
293
294;;; Symbols.
295
296(defun cl-random-time ()
297 (let* ((time (copy-sequence (current-time-string))) (i (length time)) (v 0))
298 (while (>= (decf i) 0) (setq v (+ (* v 3) (aref time i))))
299 v))
300
301(defvar *gensym-counter* (* (logand (cl-random-time) 1023) 100))
302
303
304;;; Numbers.
305
708c63a6 306(defun floatp-safe (object)
f4db41fc 307 "Return t if OBJECT is a floating point number.
fcd73769
RS
308On Emacs versions that lack floating-point support, this function
309always returns nil."
708c63a6 310 (and (numberp object) (not (integerp object))))
fcd73769 311
708c63a6 312(defun plusp (number)
f4db41fc 313 "Return t if NUMBER is positive."
708c63a6 314 (> number 0))
fcd73769 315
708c63a6 316(defun minusp (number)
f4db41fc 317 "Return t if NUMBER is negative."
708c63a6 318 (< number 0))
fcd73769 319
708c63a6 320(defun oddp (integer)
f4db41fc 321 "Return t if INTEGER is odd."
708c63a6 322 (eq (logand integer 1) 1))
fcd73769 323
708c63a6 324(defun evenp (integer)
f4db41fc 325 "Return t if INTEGER is even."
708c63a6 326 (eq (logand integer 1) 0))
fcd73769 327
fcd73769
RS
328(defvar *random-state* (vector 'cl-random-state-tag -1 30 (cl-random-time)))
329
b68f6e48 330;; The following are actually set by cl-float-limits.
fcd73769
RS
331(defconst most-positive-float nil)
332(defconst most-negative-float nil)
333(defconst least-positive-float nil)
334(defconst least-negative-float nil)
335(defconst least-positive-normalized-float nil)
336(defconst least-negative-normalized-float nil)
337(defconst float-epsilon nil)
338(defconst float-negative-epsilon nil)
339
340
341;;; Sequence functions.
342
343(defalias 'copy-seq 'copy-sequence)
344
7467c796
GM
345(declare-function cl-mapcar-many "cl-extra" (cl-func cl-seqs))
346
fcd73769
RS
347(defun mapcar* (cl-func cl-x &rest cl-rest)
348 "Apply FUNCTION to each element of SEQ, and make a list of the results.
349If there are several SEQs, FUNCTION is called with that many arguments,
350and mapping stops as soon as the shortest list runs out. With just one
351SEQ, this is like `mapcar'. With several, it is like the Common Lisp
708c63a6
JB
352`mapcar' function extended to arbitrary sequence types.
353\n(fn FUNCTION SEQ...)"
fcd73769
RS
354 (if cl-rest
355 (if (or (cdr cl-rest) (nlistp cl-x) (nlistp (car cl-rest)))
356 (cl-mapcar-many cl-func (cons cl-x cl-rest))
357 (let ((cl-res nil) (cl-y (car cl-rest)))
358 (while (and cl-x cl-y)
359 (push (funcall cl-func (pop cl-x) (pop cl-y)) cl-res))
360 (nreverse cl-res)))
361 (mapcar cl-func cl-x)))
362
686d0681 363(defalias 'svref 'aref)
fcd73769
RS
364
365;;; List functions.
366
367(defalias 'first 'car)
dc79c3ea 368(defalias 'second 'cadr)
fcd73769
RS
369(defalias 'rest 'cdr)
370(defalias 'endp 'null)
371
dc79c3ea 372(defun third (x)
b7a90344
SM
373 "Return the third element of the list X."
374 (car (cdr (cdr x))))
fcd73769 375
dc79c3ea 376(defun fourth (x)
b7a90344
SM
377 "Return the fourth element of the list X."
378 (nth 3 x))
fcd73769 379
dc79c3ea 380(defun fifth (x)
b7a90344
SM
381 "Return the fifth element of the list X."
382 (nth 4 x))
fcd73769 383
dc79c3ea 384(defun sixth (x)
b7a90344
SM
385 "Return the sixth element of the list X."
386 (nth 5 x))
fcd73769 387
dc79c3ea 388(defun seventh (x)
b7a90344
SM
389 "Return the seventh element of the list X."
390 (nth 6 x))
fcd73769 391
dc79c3ea 392(defun eighth (x)
b7a90344
SM
393 "Return the eighth element of the list X."
394 (nth 7 x))
fcd73769 395
dc79c3ea 396(defun ninth (x)
b7a90344
SM
397 "Return the ninth element of the list X."
398 (nth 8 x))
fcd73769 399
dc79c3ea 400(defun tenth (x)
b7a90344
SM
401 "Return the tenth element of the list X."
402 (nth 9 x))
fcd73769 403
fcd73769
RS
404(defun caaar (x)
405 "Return the `car' of the `car' of the `car' of X."
406 (car (car (car x))))
407
408(defun caadr (x)
409 "Return the `car' of the `car' of the `cdr' of X."
410 (car (car (cdr x))))
411
412(defun cadar (x)
413 "Return the `car' of the `cdr' of the `car' of X."
414 (car (cdr (car x))))
415
416(defun caddr (x)
417 "Return the `car' of the `cdr' of the `cdr' of X."
418 (car (cdr (cdr x))))
419
420(defun cdaar (x)
421 "Return the `cdr' of the `car' of the `car' of X."
422 (cdr (car (car x))))
423
424(defun cdadr (x)
425 "Return the `cdr' of the `car' of the `cdr' of X."
426 (cdr (car (cdr x))))
427
428(defun cddar (x)
429 "Return the `cdr' of the `cdr' of the `car' of X."
430 (cdr (cdr (car x))))
431
432(defun cdddr (x)
433 "Return the `cdr' of the `cdr' of the `cdr' of X."
434 (cdr (cdr (cdr x))))
435
436(defun caaaar (x)
437 "Return the `car' of the `car' of the `car' of the `car' of X."
438 (car (car (car (car x)))))
439
440(defun caaadr (x)
441 "Return the `car' of the `car' of the `car' of the `cdr' of X."
442 (car (car (car (cdr x)))))
443
444(defun caadar (x)
445 "Return the `car' of the `car' of the `cdr' of the `car' of X."
446 (car (car (cdr (car x)))))
447
448(defun caaddr (x)
449 "Return the `car' of the `car' of the `cdr' of the `cdr' of X."
450 (car (car (cdr (cdr x)))))
451
452(defun cadaar (x)
453 "Return the `car' of the `cdr' of the `car' of the `car' of X."
454 (car (cdr (car (car x)))))
455
456(defun cadadr (x)
457 "Return the `car' of the `cdr' of the `car' of the `cdr' of X."
458 (car (cdr (car (cdr x)))))
459
460(defun caddar (x)
461 "Return the `car' of the `cdr' of the `cdr' of the `car' of X."
462 (car (cdr (cdr (car x)))))
463
464(defun cadddr (x)
465 "Return the `car' of the `cdr' of the `cdr' of the `cdr' of X."
466 (car (cdr (cdr (cdr x)))))
467
468(defun cdaaar (x)
469 "Return the `cdr' of the `car' of the `car' of the `car' of X."
470 (cdr (car (car (car x)))))
471
472(defun cdaadr (x)
473 "Return the `cdr' of the `car' of the `car' of the `cdr' of X."
474 (cdr (car (car (cdr x)))))
475
476(defun cdadar (x)
477 "Return the `cdr' of the `car' of the `cdr' of the `car' of X."
478 (cdr (car (cdr (car x)))))
479
480(defun cdaddr (x)
481 "Return the `cdr' of the `car' of the `cdr' of the `cdr' of X."
482 (cdr (car (cdr (cdr x)))))
483
484(defun cddaar (x)
485 "Return the `cdr' of the `cdr' of the `car' of the `car' of X."
486 (cdr (cdr (car (car x)))))
487
488(defun cddadr (x)
489 "Return the `cdr' of the `cdr' of the `car' of the `cdr' of X."
490 (cdr (cdr (car (cdr x)))))
491
492(defun cdddar (x)
493 "Return the `cdr' of the `cdr' of the `cdr' of the `car' of X."
494 (cdr (cdr (cdr (car x)))))
495
496(defun cddddr (x)
497 "Return the `cdr' of the `cdr' of the `cdr' of the `cdr' of X."
498 (cdr (cdr (cdr (cdr x)))))
499
f9efebca
RS
500;;(defun last* (x &optional n)
501;; "Returns the last link in the list LIST.
502;;With optional argument N, returns Nth-to-last link (default 1)."
503;; (if n
504;; (let ((m 0) (p x))
505;; (while (consp p) (incf m) (pop p))
506;; (if (<= n 0) p
507;; (if (< n m) (nthcdr (- m n) x) x)))
508;; (while (consp (cdr x)) (pop x))
509;; x))
fcd73769 510
fcd73769 511(defun list* (arg &rest rest) ; See compiler macro in cl-macs.el
708c63a6 512 "Return a new list with specified ARGs as elements, consed to last ARG.
fcd73769 513Thus, `(list* A B C D)' is equivalent to `(nconc (list A B C) D)', or to
708c63a6
JB
514`(cons A (cons B (cons C D)))'.
515\n(fn ARG...)"
fcd73769
RS
516 (cond ((not rest) arg)
517 ((not (cdr rest)) (cons arg (car rest)))
518 (t (let* ((n (length rest))
519 (copy (copy-sequence rest))
520 (last (nthcdr (- n 2) copy)))
521 (setcdr last (car (cdr last)))
522 (cons arg copy)))))
523
524(defun ldiff (list sublist)
525 "Return a copy of LIST with the tail SUBLIST removed."
526 (let ((res nil))
527 (while (and (consp list) (not (eq list sublist)))
528 (push (pop list) res))
529 (nreverse res)))
530
6b25a2f5 531(defun copy-list (list)
708c63a6
JB
532 "Return a copy of LIST, which may be a dotted list.
533The elements of LIST are not copied, just the list structure itself."
6b25a2f5
RS
534 (if (consp list)
535 (let ((res nil))
536 (while (consp list) (push (pop list) res))
537 (prog1 (nreverse res) (setcdr res list)))
538 (car list)))
539
fcd73769
RS
540(defun cl-maclisp-member (item list)
541 (while (and list (not (equal item (car list)))) (setq list (cdr list)))
542 list)
543
fcd73769 544(defalias 'cl-member 'memq) ; for compatibility with old CL package
ec302593
GM
545
546;; Autoloaded, but we have not loaded cl-loaddefs yet.
547(declare-function floor* "cl-extra" (x &optional y))
548(declare-function ceiling* "cl-extra" (x &optional y))
549(declare-function truncate* "cl-extra" (x &optional y))
550(declare-function round* "cl-extra" (x &optional y))
551(declare-function mod* "cl-extra" (x y))
552
fcd73769
RS
553(defalias 'cl-floor 'floor*)
554(defalias 'cl-ceiling 'ceiling*)
555(defalias 'cl-truncate 'truncate*)
556(defalias 'cl-round 'round*)
557(defalias 'cl-mod 'mod*)
558
559(defun adjoin (cl-item cl-list &rest cl-keys) ; See compiler macro in cl-macs
560 "Return ITEM consed onto the front of LIST only if it's not already there.
561Otherwise, return LIST unmodified.
708c63a6
JB
562\nKeywords supported: :test :test-not :key
563\n(fn ITEM LIST [KEYWORD VALUE]...)"
fcd73769
RS
564 (cond ((or (equal cl-keys '(:test eq))
565 (and (null cl-keys) (not (numberp cl-item))))
566 (if (memq cl-item cl-list) cl-list (cons cl-item cl-list)))
567 ((or (equal cl-keys '(:test equal)) (null cl-keys))
568 (if (member cl-item cl-list) cl-list (cons cl-item cl-list)))
569 (t (apply 'cl-adjoin cl-item cl-list cl-keys))))
570
571(defun subst (cl-new cl-old cl-tree &rest cl-keys)
572 "Substitute NEW for OLD everywhere in TREE (non-destructively).
573Return a copy of TREE with all elements `eql' to OLD replaced by NEW.
708c63a6
JB
574\nKeywords supported: :test :test-not :key
575\n(fn NEW OLD TREE [KEYWORD VALUE]...)"
fcd73769
RS
576 (if (or cl-keys (and (numberp cl-old) (not (integerp cl-old))))
577 (apply 'sublis (list (cons cl-old cl-new)) cl-tree cl-keys)
578 (cl-do-subst cl-new cl-old cl-tree)))
579
580(defun cl-do-subst (cl-new cl-old cl-tree)
581 (cond ((eq cl-tree cl-old) cl-new)
582 ((consp cl-tree)
583 (let ((a (cl-do-subst cl-new cl-old (car cl-tree)))
584 (d (cl-do-subst cl-new cl-old (cdr cl-tree))))
585 (if (and (eq a (car cl-tree)) (eq d (cdr cl-tree)))
586 cl-tree (cons a d))))
587 (t cl-tree)))
588
868904eb
JB
589(defun acons (key value alist)
590 "Add KEY and VALUE to ALIST.
591Return a new list with (cons KEY VALUE) as car and ALIST as cdr."
592 (cons (cons key value) alist))
593
594(defun pairlis (keys values &optional alist)
595 "Make an alist from KEYS and VALUES.
596Return a new alist composed by associating KEYS to corresponding VALUES;
597the process stops as soon as KEYS or VALUES run out.
598If ALIST is non-nil, the new pairs are prepended to it."
599 (nconc (mapcar* 'cons keys values) alist))
fcd73769
RS
600
601
602;;; Miscellaneous.
603
b68f6e48 604;; Define data for indentation and edebug.
dbc65a5e
SM
605(dolist (entry
606 '(((defun* defmacro*) 2)
607 ((function*) nil
608 (&or symbolp ([&optional 'macro] 'lambda (&rest sexp) &rest form)))
609 ((eval-when) 1 (sexp &rest form))
610 ((declare) nil (&rest sexp))
611 ((the) 1 (sexp &rest form))
612 ((case ecase typecase etypecase) 1 (form &rest (sexp &rest form)))
613 ((block return-from) 1 (sexp &rest form))
614 ((return) nil (&optional form))
615 ((do do*) 2 ((&rest &or symbolp (symbolp &optional form form))
616 (form &rest form)
617 &rest form))
618 ((do-symbols) 1 ((symbolp form &optional form form) &rest form))
619 ((do-all-symbols) 1 ((symbolp form &optional form) &rest form))
620 ((psetq setf psetf) nil edebug-setq-form)
621 ((progv) 2 (&rest form))
622 ((flet labels macrolet) 1
623 ((&rest (sexp sexp &rest form)) &rest form))
624 ((symbol-macrolet lexical-let lexical-let*) 1
625 ((&rest &or symbolp (symbolp form)) &rest form))
626 ((multiple-value-bind) 2 ((&rest symbolp) &rest form))
627 ((multiple-value-setq) 1 ((&rest symbolp) &rest form))
628 ((incf decf remf pushnew shiftf rotatef) nil (&rest form))
629 ((letf letf*) 1 ((&rest (&rest form)) &rest form))
630 ((callf destructuring-bind) 2 (sexp form &rest form))
631 ((callf2) 3 (sexp form form &rest form))
632 ((loop) nil (&rest &or symbolp form))
633 ((ignore-errors) 0 (&rest form))))
634 (dolist (func (car entry))
635 (put func 'lisp-indent-function (nth 1 entry))
636 (put func 'lisp-indent-hook (nth 1 entry))
637 (or (get func 'edebug-form-spec)
638 (put func 'edebug-form-spec (nth 2 entry)))))
fcd73769 639
b68f6e48
SM
640;; Autoload the other portions of the package.
641;; We want to replace the basic versions of dolist, dotimes, declare below.
642(fmakunbound 'dolist)
643(fmakunbound 'dotimes)
644(fmakunbound 'declare)
1cd643e7 645(load "cl-loaddefs" nil 'quiet)
fcd73769 646
b68f6e48 647;; This goes here so that cl-macs can find it if it loads right now.
7467c796 648(provide 'cl)
fcd73769 649
b68f6e48 650;; Things to do after byte-compiler is loaded.
fcd73769
RS
651
652(defvar cl-hacked-flag nil)
653(defun cl-hack-byte-compiler ()
7467c796
GM
654 (and (not cl-hacked-flag) (fboundp 'byte-compile-file-form)
655 (progn
656 (setq cl-hacked-flag t) ; Do it first, to prevent recursion.
657 (load "cl-macs" nil t)
658 (run-hooks 'cl-hack-bytecomp-hook))))
fcd73769 659
b68f6e48 660;; Try it now in case the compiler has already been loaded.
fcd73769
RS
661(cl-hack-byte-compiler)
662
b68f6e48 663;; Also make a hook in case compiler is loaded after this file.
0d752cda 664(add-hook 'bytecomp-load-hook 'cl-hack-byte-compiler)
fcd73769
RS
665
666
b68f6e48
SM
667;; The following ensures that packages which expect the old-style cl.el
668;; will be happy with this one.
fcd73769
RS
669
670(provide 'cl)
671
fcd73769
RS
672(run-hooks 'cl-load-hook)
673
87787319
GM
674;; Local variables:
675;; byte-compile-dynamic: t
676;; byte-compile-warnings: (not cl-functions)
677;; End:
678
6cd0254f 679;; arch-tag: 5f07fa74-f153-4524-9303-21f5be125851
fcd73769 680;;; cl.el ends here