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