comparison lisp/cl/cl.el @ 0:376386a54a3c r19-14

Import from CVS: tag r19-14
author cvs
date Mon, 13 Aug 2007 08:45:50 +0200
parents
children ac2d302a0011
comparison
equal deleted inserted replaced
-1:000000000000 0:376386a54a3c
1 ;;; cl.el --- Common Lisp extensions for GNU Emacs Lisp
2
3 ;; Copyright (C) 1993 Free Software Foundation, Inc.
4
5 ;; Author: Dave Gillespie <daveg@synaptics.com>
6 ;; Version: 2.02
7 ;; Keywords: extensions, lisp
8
9 ;; This file is part of XEmacs.
10
11 ;; XEmacs is free software; you can redistribute it and/or modify it
12 ;; under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
15
16 ;; XEmacs is distributed in the hope that it will be useful, but
17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 ;; General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with XEmacs; see the file COPYING. If not, write to the Free
23 ;; Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
24
25 ;;; Synched up with: FSF 19.30.
26
27 ;;; Commentary:
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 ;;
36 ;; This package works with Emacs 18, Emacs 19, and XEmacs/Lucid Emacs 19.
37 ;;
38 ;; Bug reports, comments, and suggestions are welcome!
39
40 ;; This file contains the portions of the Common Lisp extensions
41 ;; package which should always be present.
42
43
44 ;;; Future notes:
45
46 ;; Once Emacs 19 becomes standard, many things in this package which are
47 ;; messy for reasons of compatibility can be greatly simplified. For now,
48 ;; I prefer to maintain one unified version.
49
50
51 ;;; Change Log:
52
53 ;; Version 2.02 (30 Jul 93):
54 ;; * Added "cl-compat.el" file, extra compatibility with old package.
55 ;; * Added `lexical-let' and `lexical-let*'.
56 ;; * Added `define-modify-macro', `callf', and `callf2'.
57 ;; * Added `ignore-errors'.
58 ;; * Changed `(setf (nthcdr N PLACE) X)' to work when N is zero.
59 ;; * Merged `*gentemp-counter*' into `*gensym-counter*'.
60 ;; * Extended `subseq' to allow negative START and END like `substring'.
61 ;; * Added `in-ref', `across-ref', `elements of-ref' loop clauses.
62 ;; * Added `concat', `vconcat' loop clauses.
63 ;; * Cleaned up a number of compiler warnings.
64
65 ;; Version 2.01 (7 Jul 93):
66 ;; * Added support for FSF version of Emacs 19.
67 ;; * Added `add-hook' for Emacs 18 users.
68 ;; * Added `defsubst*' and `symbol-macrolet'.
69 ;; * Added `maplist', `mapc', `mapl', `mapcan', `mapcon'.
70 ;; * Added `map', `concatenate', `reduce', `merge'.
71 ;; * Added `revappend', `nreconc', `tailp', `tree-equal'.
72 ;; * Added `assert', `check-type', `typecase', `typep', and `deftype'.
73 ;; * Added destructuring and `&environment' support to `defmacro*'.
74 ;; * Added destructuring to `loop', and added the following clauses:
75 ;; `elements', `frames', `overlays', `intervals', `buffers', `key-seqs'.
76 ;; * Renamed `delete' to `delete*' and `remove' to `remove*'.
77 ;; * Completed support for all keywords in `remove*', `substitute', etc.
78 ;; * Added `most-positive-float' and company.
79 ;; * Fixed hash tables to work with latest Lucid Emacs.
80 ;; * `proclaim' forms are no longer compile-time-evaluating; use `declaim'.
81 ;; * Syntax for `warn' declarations has changed.
82 ;; * Improved implementation of `random*'.
83 ;; * Moved most sequence functions to a new file, cl-seq.el.
84 ;; * Moved `eval-when' into cl-macs.el.
85 ;; * Moved `pushnew' and `adjoin' to cl.el for most common cases.
86 ;; * Moved `provide' forms down to ends of files.
87 ;; * Changed expansion of `pop' to something that compiles to better code.
88 ;; * Changed so that no patch is required for Emacs 19 byte compiler.
89 ;; * Made more things dependent on `optimize' declarations.
90 ;; * Added a partial implementation of struct print functions.
91 ;; * Miscellaneous minor changes.
92
93 ;; Version 2.00:
94 ;; * First public release of this package.
95
96
97 ;;; Code:
98
99 (defvar cl-emacs-type (cond ((or (and (fboundp 'epoch::version)
100 (symbol-value 'epoch::version))
101 (string-lessp emacs-version "19")) 18)
102 ((string-match "XEmacs" emacs-version)
103 'lucid)
104 (t 19)))
105
106 (or (fboundp 'defalias) (fset 'defalias 'fset))
107
108 (defvar cl-optimize-speed 1)
109 (defvar cl-optimize-safety 1)
110
111
112 ;;; Keywords used in this package.
113
114 ;;; XEmacs - keywords are done in Fintern().
115 ;;;
116 ;;; (defconst :test ':test)
117 ;;; (defconst :test-not ':test-not)
118 ;;; (defconst :key ':key)
119 ;;; (defconst :start ':start)
120 ;;; (defconst :start1 ':start1)
121 ;;; (defconst :start2 ':start2)
122 ;;; (defconst :end ':end)
123 ;;; (defconst :end1 ':end1)
124 ;;; (defconst :end2 ':end2)
125 ;;; (defconst :count ':count)
126 ;;; (defconst :initial-value ':initial-value)
127 ;;; (defconst :size ':size)
128 ;;; (defconst :from-end ':from-end)
129 ;;; (defconst :rehash-size ':rehash-size)
130 ;;; (defconst :rehash-threshold ':rehash-threshold)
131 ;;; (defconst :allow-other-keys ':allow-other-keys)
132
133
134 (defvar custom-print-functions nil
135 "This is a list of functions that format user objects for printing.
136 Each function is called in turn with three arguments: the object, the
137 stream, and the print level (currently ignored). If it is able to
138 print the object it returns true; otherwise it returns nil and the
139 printer proceeds to the next function on the list.
140
141 This variable is not used at present, but it is defined in hopes that
142 a future Emacs interpreter will be able to use it.")
143
144
145 ;;; Predicates.
146
147 (defun eql (a b) ; See compiler macro in cl-macs.el
148 "T if the two args are the same Lisp object.
149 Floating-point numbers of equal value are `eql', but they may not be `eq'."
150 (if (numberp a)
151 (equal a b)
152 (eq a b)))
153
154
155 ;;; Generalized variables. These macros are defined here so that they
156 ;;; can safely be used in .emacs files.
157
158 (defmacro incf (place &optional x)
159 "(incf PLACE [X]): increment PLACE by X (1 by default).
160 PLACE may be a symbol, or any generalized variable allowed by `setf'.
161 The return value is the incremented value of PLACE."
162 (if (symbolp place)
163 (list 'setq place (if x (list '+ place x) (list '1+ place)))
164 (list 'callf '+ place (or x 1))))
165
166 (defmacro decf (place &optional x)
167 "(decf PLACE [X]): decrement PLACE by X (1 by default).
168 PLACE may be a symbol, or any generalized variable allowed by `setf'.
169 The return value is the decremented value of PLACE."
170 (if (symbolp place)
171 (list 'setq place (if x (list '- place x) (list '1- place)))
172 (list 'callf '- place (or x 1))))
173
174 (defmacro pop (place)
175 "(pop PLACE): remove and return the head of the list stored in PLACE.
176 Analogous to (prog1 (car PLACE) (setf PLACE (cdr PLACE))), though more
177 careful about evaluating each argument only once and in the right order.
178 PLACE may be a symbol, or any generalized variable allowed by `setf'."
179 (if (symbolp place)
180 (list 'car (list 'prog1 place (list 'setq place (list 'cdr place))))
181 (cl-do-pop place)))
182
183 (defmacro push (x place)
184 "(push X PLACE): insert X at the head of the list stored in PLACE.
185 Analogous to (setf PLACE (cons X PLACE)), though more careful about
186 evaluating each argument only once and in the right order. PLACE may
187 be a symbol, or any generalized variable allowed by `setf'."
188 (if (symbolp place) (list 'setq place (list 'cons x place))
189 (list 'callf2 'cons x place)))
190
191 (defmacro pushnew (x place &rest keys)
192 "(pushnew X PLACE): insert X at the head of the list if not already there.
193 Like (push X PLACE), except that the list is unmodified if X is `eql' to
194 an element already on the list.
195 Keywords supported: :test :test-not :key"
196 (if (symbolp place) (list 'setq place (list* 'adjoin x place keys))
197 (list* 'callf2 'adjoin x place keys)))
198
199 (defun cl-set-elt (seq n val)
200 (if (listp seq) (setcar (nthcdr n seq) val) (aset seq n val)))
201
202 (defun cl-set-nthcdr (n list x)
203 (if (<= n 0) x (setcdr (nthcdr (1- n) list) x) list))
204
205 (defun cl-set-buffer-substring (start end val)
206 (save-excursion (delete-region start end)
207 (goto-char start)
208 (insert val)
209 val))
210
211 (defun cl-set-substring (str start end val)
212 (if end (if (< end 0) (incf end (length str)))
213 (setq end (length str)))
214 (if (< start 0) (incf start str))
215 (concat (and (> start 0) (substring str 0 start))
216 val
217 (and (< end (length str)) (substring str end))))
218
219
220 ;;; Control structures.
221
222 ;;; These macros are so simple and so often-used that it's better to have
223 ;;; them all the time than to load them from cl-macs.el.
224
225 (defmacro when (cond &rest body)
226 "(when COND BODY...): if COND yields non-nil, do BODY, else return nil."
227 (list 'if cond (cons 'progn body)))
228
229 (defmacro unless (cond &rest body)
230 "(unless COND BODY...): if COND yields nil, do BODY, else return nil."
231 (cons 'if (cons cond (cons nil body))))
232
233 (defun cl-map-extents (&rest cl-args)
234 (if (fboundp 'next-overlay-at) (apply 'cl-map-overlays cl-args)
235 (if (fboundp 'map-extents) (apply 'map-extents cl-args))))
236
237
238 ;;; Blocks and exits.
239
240 (defalias 'cl-block-wrapper 'identity)
241 (defalias 'cl-block-throw 'throw)
242
243
244 ;;; Multiple values. True multiple values are not supported, or even
245 ;;; simulated. Instead, multiple-value-bind and friends simply expect
246 ;;; the target form to return the values as a list.
247
248 (defalias 'values 'list)
249 (defalias 'values-list 'identity)
250 (defalias 'multiple-value-list 'identity)
251 (defalias 'multiple-value-call 'apply) ; only works for one arg
252 (defalias 'nth-value 'nth)
253
254
255 ;;; Macros.
256
257 (defvar cl-macro-environment nil)
258 ;; XEmacs: we renamed the internal function to macroexpand-internal
259 ;; to avoid doc-file problems.
260 (defvar cl-old-macroexpand (prog1 (symbol-function 'macroexpand-internal)
261 (defalias 'macroexpand 'cl-macroexpand)))
262
263 (defun cl-macroexpand (cl-macro &optional cl-env)
264 "Return result of expanding macros at top level of FORM.
265 If FORM is not a macro call, it is returned unchanged.
266 Otherwise, the macro is expanded and the expansion is considered
267 in place of FORM. When a non-macro-call results, it is returned.
268
269 The second optional arg ENVIRONMENT species an environment of macro
270 definitions to shadow the loaded ones for use in file byte-compilation."
271 (let ((cl-macro-environment cl-env))
272 (while (progn (setq cl-macro (funcall cl-old-macroexpand cl-macro cl-env))
273 (and (symbolp cl-macro)
274 (cdr (assq (symbol-name cl-macro) cl-env))))
275 (setq cl-macro (cadr (assq (symbol-name cl-macro) cl-env))))
276 cl-macro))
277
278
279 ;;; Declarations.
280
281 (defvar cl-compiling-file nil)
282 (defun cl-compiling-file ()
283 (or cl-compiling-file
284 ; (and (boundp 'outbuffer) (bufferp (symbol-value 'outbuffer))
285 ; (equal (buffer-name (symbol-value 'outbuffer))
286 ; " *Compiler Output*"))
287 (and (boundp 'byte-compile-outbuffer)
288 (bufferp (symbol-value 'byte-compile-outbuffer))
289 (equal (buffer-name (symbol-value 'byte-compile-outbuffer))
290 " *Compiler Output*"))
291 ))
292
293 (defvar cl-proclaims-deferred nil)
294
295 (defun proclaim (spec)
296 (if (fboundp 'cl-do-proclaim) (cl-do-proclaim spec t)
297 (push spec cl-proclaims-deferred))
298 nil)
299
300 (defmacro declaim (&rest specs)
301 (let ((body (mapcar (function (lambda (x) (list 'proclaim (list 'quote x))))
302 specs)))
303 (if (cl-compiling-file) (list* 'eval-when '(compile load eval) body)
304 (cons 'progn body)))) ; avoid loading cl-macs.el for eval-when
305
306
307 ;;; Symbols.
308
309 (defun cl-random-time ()
310 (let* ((time (copy-sequence (current-time-string))) (i (length time)) (v 0))
311 (while (>= (decf i) 0) (setq v (+ (* v 3) (aref time i))))
312 v))
313
314 (defvar *gensym-counter* (* (logand (cl-random-time) 1023) 100))
315
316
317 ;;; Numbers.
318
319 (defun floatp-safe (x)
320 "T if OBJECT is a floating point number.
321 On Emacs versions that lack floating-point support, this function
322 always returns nil."
323 (and (numberp x) (not (integerp x))))
324
325 (defun plusp (x)
326 "T if NUMBER is positive."
327 (> x 0))
328
329 (defun minusp (x)
330 "T if NUMBER is negative."
331 (< x 0))
332
333 (defun oddp (x)
334 "T if INTEGER is odd."
335 (eq (logand x 1) 1))
336
337 (defun evenp (x)
338 "T if INTEGER is even."
339 (eq (logand x 1) 0))
340
341 (defun cl-abs (x)
342 "Return the absolute value of ARG."
343 (if (>= x 0) x (- x)))
344 (or (fboundp 'abs) (defalias 'abs 'cl-abs)) ; This is built-in to Emacs 19
345
346 (defvar *random-state* (vector 'cl-random-state-tag -1 30 (cl-random-time)))
347
348 ;;; We use `eval' in case VALBITS differs from compile-time to load-time.
349 (defconst most-positive-fixnum (eval '(lsh -1 -1)))
350 (defconst most-negative-fixnum (eval '(- -1 (lsh -1 -1))))
351
352 ;;; The following are actually set by cl-float-limits.
353 (defconst most-positive-float nil)
354 (defconst most-negative-float nil)
355 (defconst least-positive-float nil)
356 (defconst least-negative-float nil)
357 (defconst least-positive-normalized-float nil)
358 (defconst least-negative-normalized-float nil)
359 (defconst float-epsilon nil)
360 (defconst float-negative-epsilon nil)
361
362
363 ;;; Sequence functions.
364
365 (defalias 'copy-seq 'copy-sequence)
366
367 (defun mapcar* (cl-func cl-x &rest cl-rest)
368 "Apply FUNCTION to each element of SEQ, and make a list of the results.
369 If there are several SEQs, FUNCTION is called with that many arguments,
370 and mapping stops as soon as the shortest list runs out. With just one
371 SEQ, this is like `mapcar'. With several, it is like the Common Lisp
372 `mapcar' function extended to arbitrary sequence types."
373 (if cl-rest
374 (if (or (cdr cl-rest) (nlistp cl-x) (nlistp (car cl-rest)))
375 (cl-mapcar-many cl-func (cons cl-x cl-rest))
376 (let ((cl-res nil) (cl-y (car cl-rest)))
377 (while (and cl-x cl-y)
378 (push (funcall cl-func (pop cl-x) (pop cl-y)) cl-res))
379 (nreverse cl-res)))
380 (mapcar cl-func cl-x)))
381
382
383 ;;; List functions.
384
385 (defalias 'first 'car)
386 (defalias 'rest 'cdr)
387 (defalias 'endp 'null)
388
389 (defun second (x)
390 "Return the second element of the list LIST."
391 (car (cdr x)))
392
393 (defun third (x)
394 "Return the third element of the list LIST."
395 (car (cdr (cdr x))))
396
397 (defun fourth (x)
398 "Return the fourth element of the list LIST."
399 (nth 3 x))
400
401 (defun fifth (x)
402 "Return the fifth element of the list LIST."
403 (nth 4 x))
404
405 (defun sixth (x)
406 "Return the sixth element of the list LIST."
407 (nth 5 x))
408
409 (defun seventh (x)
410 "Return the seventh element of the list LIST."
411 (nth 6 x))
412
413 (defun eighth (x)
414 "Return the eighth element of the list LIST."
415 (nth 7 x))
416
417 (defun ninth (x)
418 "Return the ninth element of the list LIST."
419 (nth 8 x))
420
421 (defun tenth (x)
422 "Return the tenth element of the list LIST."
423 (nth 9 x))
424
425 (defun caar (x)
426 "Return the `car' of the `car' of X."
427 (car (car x)))
428
429 (defun cadr (x)
430 "Return the `car' of the `cdr' of X."
431 (car (cdr x)))
432
433 (defun cdar (x)
434 "Return the `cdr' of the `car' of X."
435 (cdr (car x)))
436
437 (defun cddr (x)
438 "Return the `cdr' of the `cdr' of X."
439 (cdr (cdr x)))
440
441 (defun caaar (x)
442 "Return the `car' of the `car' of the `car' of X."
443 (car (car (car x))))
444
445 (defun caadr (x)
446 "Return the `car' of the `car' of the `cdr' of X."
447 (car (car (cdr x))))
448
449 (defun cadar (x)
450 "Return the `car' of the `cdr' of the `car' of X."
451 (car (cdr (car x))))
452
453 (defun caddr (x)
454 "Return the `car' of the `cdr' of the `cdr' of X."
455 (car (cdr (cdr x))))
456
457 (defun cdaar (x)
458 "Return the `cdr' of the `car' of the `car' of X."
459 (cdr (car (car x))))
460
461 (defun cdadr (x)
462 "Return the `cdr' of the `car' of the `cdr' of X."
463 (cdr (car (cdr x))))
464
465 (defun cddar (x)
466 "Return the `cdr' of the `cdr' of the `car' of X."
467 (cdr (cdr (car x))))
468
469 (defun cdddr (x)
470 "Return the `cdr' of the `cdr' of the `cdr' of X."
471 (cdr (cdr (cdr x))))
472
473 (defun caaaar (x)
474 "Return the `car' of the `car' of the `car' of the `car' of X."
475 (car (car (car (car x)))))
476
477 (defun caaadr (x)
478 "Return the `car' of the `car' of the `car' of the `cdr' of X."
479 (car (car (car (cdr x)))))
480
481 (defun caadar (x)
482 "Return the `car' of the `car' of the `cdr' of the `car' of X."
483 (car (car (cdr (car x)))))
484
485 (defun caaddr (x)
486 "Return the `car' of the `car' of the `cdr' of the `cdr' of X."
487 (car (car (cdr (cdr x)))))
488
489 (defun cadaar (x)
490 "Return the `car' of the `cdr' of the `car' of the `car' of X."
491 (car (cdr (car (car x)))))
492
493 (defun cadadr (x)
494 "Return the `car' of the `cdr' of the `car' of the `cdr' of X."
495 (car (cdr (car (cdr x)))))
496
497 (defun caddar (x)
498 "Return the `car' of the `cdr' of the `cdr' of the `car' of X."
499 (car (cdr (cdr (car x)))))
500
501 (defun cadddr (x)
502 "Return the `car' of the `cdr' of the `cdr' of the `cdr' of X."
503 (car (cdr (cdr (cdr x)))))
504
505 (defun cdaaar (x)
506 "Return the `cdr' of the `car' of the `car' of the `car' of X."
507 (cdr (car (car (car x)))))
508
509 (defun cdaadr (x)
510 "Return the `cdr' of the `car' of the `car' of the `cdr' of X."
511 (cdr (car (car (cdr x)))))
512
513 (defun cdadar (x)
514 "Return the `cdr' of the `car' of the `cdr' of the `car' of X."
515 (cdr (car (cdr (car x)))))
516
517 (defun cdaddr (x)
518 "Return the `cdr' of the `car' of the `cdr' of the `cdr' of X."
519 (cdr (car (cdr (cdr x)))))
520
521 (defun cddaar (x)
522 "Return the `cdr' of the `cdr' of the `car' of the `car' of X."
523 (cdr (cdr (car (car x)))))
524
525 (defun cddadr (x)
526 "Return the `cdr' of the `cdr' of the `car' of the `cdr' of X."
527 (cdr (cdr (car (cdr x)))))
528
529 (defun cdddar (x)
530 "Return the `cdr' of the `cdr' of the `cdr' of the `car' of X."
531 (cdr (cdr (cdr (car x)))))
532
533 (defun cddddr (x)
534 "Return the `cdr' of the `cdr' of the `cdr' of the `cdr' of X."
535 (cdr (cdr (cdr (cdr x)))))
536
537 (defun last (x &optional n)
538 "Returns the last link in the list LIST.
539 With optional argument N, returns Nth-to-last link (default 1)."
540 (if n
541 (let ((m 0) (p x))
542 (while (consp p) (incf m) (pop p))
543 (if (<= n 0) p
544 (if (< n m) (nthcdr (- m n) x) x)))
545 (while (consp (cdr x)) (pop x))
546 x))
547
548 (defun butlast (x &optional n)
549 "Returns a copy of LIST with the last N elements removed."
550 (if (and n (<= n 0)) x
551 (nbutlast (copy-sequence x) n)))
552
553 (defun nbutlast (x &optional n)
554 "Modifies LIST to remove the last N elements."
555 (let ((m (length x)))
556 (or n (setq n 1))
557 (and (< n m)
558 (progn
559 (if (> n 0) (setcdr (nthcdr (- (1- m) n) x) nil))
560 x))))
561
562 (defun list* (arg &rest rest) ; See compiler macro in cl-macs.el
563 "Return a new list with specified args as elements, cons'd to last arg.
564 Thus, `(list* A B C D)' is equivalent to `(nconc (list A B C) D)', or to
565 `(cons A (cons B (cons C D)))'."
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)))))
573
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)))
580
581 (defun copy-list (list)
582 "Return a copy of a list, which may be a dotted list.
583 The elements of the 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)))
589
590 (defun cl-maclisp-member (item list)
591 (while (and list (not (equal item (car list)))) (setq list (cdr list)))
592 list)
593
594 ;;; Define an Emacs 19-compatible `member' for the benefit of Emacs 18 users.
595 (or (and (fboundp 'member) (subrp (symbol-function 'member)))
596 (defalias 'member 'cl-maclisp-member))
597
598 (defalias 'cl-member 'memq) ; for compatibility with old CL package
599 (defalias 'cl-floor 'floor*)
600 (defalias 'cl-ceiling 'ceiling*)
601 (defalias 'cl-truncate 'truncate*)
602 (defalias 'cl-round 'round*)
603 (defalias 'cl-mod 'mod*)
604
605 (defun adjoin (cl-item cl-list &rest cl-keys) ; See compiler macro in cl-macs
606 "Return ITEM consed onto the front of LIST only if it's not already there.
607 Otherwise, return LIST unmodified.
608 Keywords supported: :test :test-not :key"
609 (cond ((or (equal cl-keys '(:test eq))
610 (and (null cl-keys) (not (numberp cl-item))))
611 (if (memq cl-item cl-list) cl-list (cons cl-item cl-list)))
612 ((or (equal cl-keys '(:test equal)) (null cl-keys))
613 (if (member cl-item cl-list) cl-list (cons cl-item cl-list)))
614 (t (apply 'cl-adjoin cl-item cl-list cl-keys))))
615
616 (defun subst (cl-new cl-old cl-tree &rest cl-keys)
617 "Substitute NEW for OLD everywhere in TREE (non-destructively).
618 Return a copy of TREE with all elements `eql' to OLD replaced by NEW.
619 Keywords supported: :test :test-not :key"
620 (if (or cl-keys (and (numberp cl-old) (not (integerp cl-old))))
621 (apply 'sublis (list (cons cl-old cl-new)) cl-tree cl-keys)
622 (cl-do-subst cl-new cl-old cl-tree)))
623
624 (defun cl-do-subst (cl-new cl-old cl-tree)
625 (cond ((eq cl-tree cl-old) cl-new)
626 ((consp cl-tree)
627 (let ((a (cl-do-subst cl-new cl-old (car cl-tree)))
628 (d (cl-do-subst cl-new cl-old (cdr cl-tree))))
629 (if (and (eq a (car cl-tree)) (eq d (cdr cl-tree)))
630 cl-tree (cons a d))))
631 (t cl-tree)))
632
633 (defun acons (a b c) (cons (cons a b) c))
634 (defun pairlis (a b &optional c) (nconc (mapcar* 'cons a b) c))
635
636
637 ;;; Miscellaneous.
638
639 ;; XEmacs change
640 (define-error 'cl-assertion-failed "Assertion failed")
641
642 ;;; This is defined in Emacs 19; define it here for Emacs 18 users.
643 (defun cl-add-hook (hook func &optional append)
644 "Add to hook variable HOOK the function FUNC.
645 FUNC is not added if it already appears on the list stored in HOOK."
646 (let ((old (and (boundp hook) (symbol-value hook))))
647 (and (listp old) (not (eq (car old) 'lambda))
648 (setq old (list old)))
649 (and (not (member func old))
650 (set hook (if append (nconc old (list func)) (cons func old))))))
651 (or (fboundp 'add-hook) (defalias 'add-hook 'cl-add-hook))
652
653 ;; XEmacs change
654 (load "cl-defs")
655
656 ;;; Define data for indentation and edebug.
657 (mapcar (function
658 (lambda (entry)
659 (mapcar (function
660 (lambda (func)
661 (put func 'lisp-indent-function (nth 1 entry))
662 (put func 'lisp-indent-hook (nth 1 entry))
663 (or (get func 'edebug-form-spec)
664 (put func 'edebug-form-spec (nth 2 entry)))))
665 (car entry))))
666 '(((defun* defmacro*) 2)
667 ((function*) nil
668 (&or symbolp ([&optional 'macro] 'lambda (&rest sexp) &rest form)))
669 ((eval-when) 1 (sexp &rest form))
670 ((when unless) 1 (&rest form))
671 ((declare) nil (&rest sexp))
672 ((the) 1 (sexp &rest form))
673 ((case ecase typecase etypecase) 1 (form &rest (sexp &rest form)))
674 ((block return-from) 1 (sexp &rest form))
675 ((return) nil (&optional form))
676 ((do do*) 2 ((&rest &or symbolp (symbolp &optional form form))
677 (form &rest form)
678 &rest form))
679 ((dolist dotimes) 1 ((symbolp form &rest form) &rest form))
680 ((do-symbols) 1 ((symbolp form &optional form form) &rest form))
681 ((do-all-symbols) 1 ((symbolp form &optional form) &rest form))
682 ((psetq setf psetf) nil edebug-setq-form)
683 ((progv) 2 (&rest form))
684 ((flet labels macrolet) 1
685 ((&rest (sexp sexp &rest form)) &rest form))
686 ((symbol-macrolet lexical-let lexical-let*) 1
687 ((&rest &or symbolp (symbolp form)) &rest form))
688 ((multiple-value-bind) 2 ((&rest symbolp) &rest form))
689 ((multiple-value-setq) 1 ((&rest symbolp) &rest form))
690 ((incf decf remf pop push pushnew shiftf rotatef) nil (&rest form))
691 ((letf letf*) 1 ((&rest (&rest form)) &rest form))
692 ((callf destructuring-bind) 2 (sexp form &rest form))
693 ((callf2) 3 (sexp form form &rest form))
694 ((loop) nil (&rest &or symbolp form))
695 ((ignore-errors) 0 (&rest form))))
696
697
698 ;;; This goes here so that cl-macs can find it if it loads right now.
699 (provide 'cl-19) ; usage: (require 'cl-19 "cl")
700
701
702 ;;; Things to do after byte-compiler is loaded.
703 ;;; As a side effect, we cause cl-macs to be loaded when compiling, so
704 ;;; that the compiler-macros defined there will be present.
705
706 (defvar cl-hacked-flag nil)
707 (defun cl-hack-byte-compiler ()
708 (if (and (not cl-hacked-flag) (fboundp 'byte-compile-file-form))
709 (progn
710 (cl-compile-time-init) ; in cl-macs.el
711 (setq cl-hacked-flag t))))
712
713 ;;; Try it now in case the compiler has already been loaded.
714 (cl-hack-byte-compiler)
715
716 ;;; Also make a hook in case compiler is loaded after this file.
717 ;;; The compiler doesn't call any hooks when it loads or runs, but
718 ;;; we can take advantage of the fact that emacs-lisp-mode will be
719 ;;; called when the compiler reads in the file to be compiled.
720 ;;; BUG: If the first compilation is `byte-compile' rather than
721 ;;; `byte-compile-file', we lose. Oh, well.
722 (add-hook 'emacs-lisp-mode-hook 'cl-hack-byte-compiler)
723
724
725 ;;; The following ensures that packages which expect the old-style cl.el
726 ;;; will be happy with this one.
727
728 (provide 'cl)
729
730 (provide 'mini-cl) ; for Epoch
731
732 (run-hooks 'cl-load-hook)
733
734 ;;; cl.el ends here