comparison lisp/cl.el @ 209:41ff10fd062f r20-4b3

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