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