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