1 ;;; cl-lib.el --- Common Lisp extensions for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1993, 2001-2012 Free Software Foundation, Inc.
5 ;; Author: Dave Gillespie <daveg@synaptics.com>
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/>.
26 ;; These are extensions to Emacs Lisp that provide a degree of
27 ;; Common Lisp compatibility, beyond what is already built-in
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.
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.
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.
89 ;; * First public release of this package.
94 (defvar cl-optimize-speed
1)
95 (defvar cl-optimize-safety
1)
98 (define-obsolete-variable-alias
99 ;; This alias is needed for compatibility with .elc files that use defstruct
100 ;; and were compiled with Emacs<24.2.
101 'custom-print-functions
'cl-custom-print-functions
"24.2")
104 (defvar cl-custom-print-functions nil
105 "This is a list of functions that format user objects for printing.
106 Each function is called in turn with three arguments: the object, the
107 stream, and the print level (currently ignored). If it is able to
108 print the object it returns true; otherwise it returns nil and the
109 printer proceeds to the next function on the list.
111 This variable is not used at present, but it is defined in hopes that
112 a future Emacs interpreter will be able to use it.")
114 (defun cl-unload-function ()
115 "Stop unloading of the Common Lisp extensions."
116 (message "Cannot unload the feature `cl'")
117 ;; Stop standard unloading!
120 ;;; Generalized variables.
121 ;; These macros are defined here so that they
122 ;; can safely be used in .emacs files.
124 (defmacro cl-incf
(place &optional x
)
125 "Increment PLACE by X (1 by default).
126 PLACE may be a symbol, or any generalized variable allowed by `cl-setf'.
127 The return value is the incremented value of PLACE."
128 (declare (debug (place &optional form
)))
130 (list 'setq place
(if x
(list '+ place x
) (list '1+ place
)))
131 (list 'cl-callf
'+ place
(or x
1))))
133 (defmacro cl-decf
(place &optional x
)
134 "Decrement PLACE by X (1 by default).
135 PLACE may be a symbol, or any generalized variable allowed by `cl-setf'.
136 The return value is the decremented value of PLACE."
137 (declare (debug cl-incf
))
139 (list 'setq place
(if x
(list '- place x
) (list '1- place
)))
140 (list 'cl-callf
'- place
(or x
1))))
142 ;; Autoloaded, but we haven't loaded cl-loaddefs yet.
143 (declare-function cl-do-pop
"cl-macs" (place))
145 (defmacro cl-pop
(place)
146 "Remove and return the head of the list stored in PLACE.
147 Analogous to (prog1 (car PLACE) (cl-setf PLACE (cdr PLACE))), though more
148 careful about evaluating each argument only once and in the right order.
149 PLACE may be a symbol, or any generalized variable allowed by `cl-setf'."
150 (declare (debug (place)))
152 (list 'car
(list 'prog1 place
(list 'setq place
(list 'cdr place
))))
155 (defmacro cl-push
(x place
)
156 "Insert X at the head of the list stored in PLACE.
157 Analogous to (cl-setf PLACE (cons X PLACE)), though more careful about
158 evaluating each argument only once and in the right order. PLACE may
159 be a symbol, or any generalized variable allowed by `cl-setf'."
160 (declare (debug (form place
)))
161 (if (symbolp place
) (list 'setq place
(list 'cons x place
))
162 (list 'cl-callf2
'cons x place
)))
164 (defmacro cl-pushnew
(x place
&rest keys
)
165 "(cl-pushnew X PLACE): insert X at the head of the list if not already there.
166 Like (cl-push X PLACE), except that the list is unmodified if X is `eql' to
167 an element already on the list.
168 \nKeywords supported: :test :test-not :key
169 \n(fn X PLACE [KEYWORD VALUE]...)"
172 &or
[[&or
":test" ":test-not" ":key"] function-form
]
178 ;; This symbol may later on expand to actual code which then
179 ;; trigger warnings like "value unused" since cl-pushnew's return
180 ;; value is rarely used. It should not matter that other
181 ;; warnings may be silenced, since `place' is used earlier and
182 ;; should have triggered them already.
183 (with-no-warnings ,place
)
184 (setq ,place
(cons x
,place
))))
185 (list 'setq place
(cl-list* 'cl-adjoin x place keys
)))
186 (cl-list* 'cl-callf2
'cl-adjoin x place keys
)))
188 (defun cl--set-elt (seq n val
)
189 (if (listp seq
) (setcar (nthcdr n seq
) val
) (aset seq n val
)))
191 (defsubst cl--set-nthcdr
(n list x
)
192 (if (<= n
0) x
(setcdr (nthcdr (1- n
) list
) x
) list
))
194 (defun cl--set-buffer-substring (start end val
)
195 (save-excursion (delete-region start end
)
200 (defun cl--set-substring (str start end val
)
201 (if end
(if (< end
0) (cl-incf end
(length str
)))
202 (setq end
(length str
)))
203 (if (< start
0) (cl-incf start
(length str
)))
204 (concat (and (> start
0) (substring str
0 start
))
206 (and (< end
(length str
)) (substring str end
))))
209 ;;; Blocks and exits.
211 (defalias 'cl--block-wrapper
'identity
)
212 (defalias 'cl--block-throw
'throw
)
216 ;; True multiple values are not supported, or even
217 ;; simulated. Instead, cl-multiple-value-bind and friends simply expect
218 ;; the target form to return the values as a list.
220 (defalias 'cl-values
#'list
221 "Return multiple values, Common Lisp style.
222 The arguments of `cl-values' are the values
223 that the containing function should return.
226 (put 'cl-values
'byte-optimizer
'byte-compile-inline-expand
)
228 (defalias 'cl-values-list
#'identity
229 "Return multiple values, Common Lisp style, taken from a list.
230 LIST specifies the list of values
231 that the containing function should return.
234 (put 'cl-values-list
'byte-optimizer
'byte-compile-inline-expand
)
236 (defsubst cl-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."
243 (defsubst cl-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
248 (apply function expression
))
250 (defalias 'cl-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 cl-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
263 (defvar cl--compiling-file nil
)
264 (defun cl--compiling-file ()
265 (or cl--compiling-file
266 (and (boundp 'byte-compile--outbuffer
)
267 (bufferp (symbol-value 'byte-compile--outbuffer
))
268 (equal (buffer-name (symbol-value 'byte-compile--outbuffer
))
269 " *Compiler Output*"))))
271 (defvar cl-proclaims-deferred nil
)
273 (defun cl-proclaim (spec)
274 (if (fboundp 'cl-do-proclaim
) (cl-do-proclaim spec t
)
275 (push spec cl-proclaims-deferred
))
278 (defmacro cl-declaim
(&rest specs
)
279 (let ((body (mapcar (function (lambda (x) (list 'cl-proclaim
(list 'quote x
))))
281 (if (cl--compiling-file) (cl-list* 'cl-eval-when
'(compile load eval
) body
)
282 (cons 'progn body
)))) ; avoid loading cl-macs.el for cl-eval-when
287 (defun cl-random-time ()
288 (let* ((time (copy-sequence (current-time-string))) (i (length time
)) (v 0))
289 (while (>= (cl-decf i
) 0) (setq v
(+ (* v
3) (aref time i
))))
292 (defvar cl--gensym-counter
(* (logand (cl-random-time) 1023) 100))
297 (defun cl-floatp-safe (object)
298 "Return t if OBJECT is a floating point number.
299 On Emacs versions that lack floating-point support, this function
301 (and (numberp object
) (not (integerp object
))))
303 (defun cl-plusp (number)
304 "Return t if NUMBER is positive."
307 (defun cl-minusp (number)
308 "Return t if NUMBER is negative."
311 (defun cl-oddp (integer)
312 "Return t if INTEGER is odd."
313 (eq (logand integer
1) 1))
315 (defun cl-evenp (integer)
316 "Return t if INTEGER is even."
317 (eq (logand integer
1) 0))
319 (defvar cl--random-state
(vector 'cl-random-state-tag -
1 30 (cl-random-time)))
321 (defconst cl-most-positive-float nil
322 "The largest value that a Lisp float can hold.
323 If your system supports infinities, this is the largest finite value.
324 For IEEE machines, this is approximately 1.79e+308.
325 Call `cl-float-limits' to set this.")
327 (defconst cl-most-negative-float nil
328 "The largest negative value that a Lisp float can hold.
329 This is simply -`cl-most-positive-float'.
330 Call `cl-float-limits' to set this.")
332 (defconst cl-least-positive-float nil
333 "The smallest value greater than zero that a Lisp float can hold.
334 For IEEE machines, it is about 4.94e-324 if denormals are supported,
335 or 2.22e-308 if they are not.
336 Call `cl-float-limits' to set this.")
338 (defconst cl-least-negative-float nil
339 "The smallest value less than zero that a Lisp float can hold.
340 This is simply -`cl-least-positive-float'.
341 Call `cl-float-limits' to set this.")
343 (defconst cl-least-positive-normalized-float nil
344 "The smallest normalized Lisp float greater than zero.
345 This is the smallest value for which IEEE denormalization does not lose
346 precision. For IEEE machines, this value is about 2.22e-308.
347 For machines that do not support the concept of denormalization
348 and gradual underflow, this constant equals `cl-least-positive-float'.
349 Call `cl-float-limits' to set this.")
351 (defconst cl-least-negative-normalized-float nil
352 "The smallest normalized Lisp float less than zero.
353 This is simply -`cl-least-positive-normalized-float'.
354 Call `cl-float-limits' to set this.")
356 (defconst cl-float-epsilon nil
357 "The smallest positive float that adds to 1.0 to give a distinct value.
358 Adding a number less than this to 1.0 returns 1.0 due to roundoff.
359 For IEEE machines, epsilon is about 2.22e-16.
360 Call `cl-float-limits' to set this.")
362 (defconst cl-float-negative-epsilon nil
363 "The smallest positive float that subtracts from 1.0 to give a distinct value.
364 For IEEE machines, it is about 1.11e-16.
365 Call `cl-float-limits' to set this.")
368 ;;; Sequence functions.
370 (defalias 'cl-copy-seq
'copy-sequence
)
372 (declare-function cl--mapcar-many
"cl-extra" (cl-func cl-seqs
))
374 (defun cl-mapcar (cl-func cl-x
&rest cl-rest
)
375 "Apply FUNCTION to each element of SEQ, and make a list of the results.
376 If there are several SEQs, FUNCTION is called with that many arguments,
377 and mapping stops as soon as the shortest list runs out. With just one
378 SEQ, this is like `mapcar'. With several, it is like the Common Lisp
379 `mapcar' function extended to arbitrary sequence types.
380 \n(fn FUNCTION SEQ...)"
382 (if (or (cdr cl-rest
) (nlistp cl-x
) (nlistp (car cl-rest
)))
383 (cl--mapcar-many cl-func
(cons cl-x cl-rest
))
384 (let ((cl-res nil
) (cl-y (car cl-rest
)))
385 (while (and cl-x cl-y
)
386 (push (funcall cl-func
(pop cl-x
) (pop cl-y
)) cl-res
))
388 (mapcar cl-func cl-x
)))
390 (defalias 'cl-svref
'aref
)
394 (defalias 'cl-first
'car
)
395 (defalias 'cl-second
'cadr
)
396 (defalias 'cl-rest
'cdr
)
397 (defalias 'cl-endp
'null
)
400 "Return the cl-third element of the list X."
404 "Return the cl-fourth element of the list X."
408 "Return the cl-fifth element of the list X."
412 "Return the cl-sixth element of the list X."
415 (defun cl-seventh (x)
416 "Return the cl-seventh element of the list X."
420 "Return the cl-eighth element of the list X."
424 "Return the cl-ninth element of the list X."
428 "Return the cl-tenth element of the list X."
432 "Return the `car' of the `car' of the `car' of X."
436 "Return the `car' of the `car' of the `cdr' of X."
440 "Return the `car' of the `cdr' of the `car' of X."
444 "Return the `car' of the `cdr' of the `cdr' of X."
448 "Return the `cdr' of the `car' of the `car' of X."
452 "Return the `cdr' of the `car' of the `cdr' of X."
456 "Return the `cdr' of the `cdr' of the `car' of X."
460 "Return the `cdr' of the `cdr' of the `cdr' of X."
464 "Return the `car' of the `car' of the `car' of the `car' of X."
465 (car (car (car (car x
)))))
468 "Return the `car' of the `car' of the `car' of the `cdr' of X."
469 (car (car (car (cdr x
)))))
472 "Return the `car' of the `car' of the `cdr' of the `car' of X."
473 (car (car (cdr (car x
)))))
476 "Return the `car' of the `car' of the `cdr' of the `cdr' of X."
477 (car (car (cdr (cdr x
)))))
480 "Return the `car' of the `cdr' of the `car' of the `car' of X."
481 (car (cdr (car (car x
)))))
484 "Return the `car' of the `cdr' of the `car' of the `cdr' of X."
485 (car (cdr (car (cdr x
)))))
488 "Return the `car' of the `cdr' of the `cdr' of the `car' of X."
489 (car (cdr (cdr (car x
)))))
492 "Return the `car' of the `cdr' of the `cdr' of the `cdr' of X."
493 (car (cdr (cdr (cdr x
)))))
496 "Return the `cdr' of the `car' of the `car' of the `car' of X."
497 (cdr (car (car (car x
)))))
500 "Return the `cdr' of the `car' of the `car' of the `cdr' of X."
501 (cdr (car (car (cdr x
)))))
504 "Return the `cdr' of the `car' of the `cdr' of the `car' of X."
505 (cdr (car (cdr (car x
)))))
508 "Return the `cdr' of the `car' of the `cdr' of the `cdr' of X."
509 (cdr (car (cdr (cdr x
)))))
512 "Return the `cdr' of the `cdr' of the `car' of the `car' of X."
513 (cdr (cdr (car (car x
)))))
516 "Return the `cdr' of the `cdr' of the `car' of the `cdr' of X."
517 (cdr (cdr (car (cdr x
)))))
520 "Return the `cdr' of the `cdr' of the `cdr' of the `car' of X."
521 (cdr (cdr (cdr (car x
)))))
524 "Return the `cdr' of the `cdr' of the `cdr' of the `cdr' of X."
525 (cdr (cdr (cdr (cdr x
)))))
527 ;;(defun last* (x &optional n)
528 ;; "Returns the last link in the list LIST.
529 ;;With optional argument N, returns Nth-to-last link (default 1)."
531 ;; (let ((m 0) (p x))
532 ;; (while (consp p) (cl-incf m) (pop p))
534 ;; (if (< n m) (nthcdr (- m n) x) x)))
535 ;; (while (consp (cdr x)) (pop x))
538 (defun cl-list* (arg &rest rest
)
539 "Return a new list with specified ARGs as elements, consed to last ARG.
540 Thus, `(cl-list* A B C D)' is equivalent to `(nconc (list A B C) D)', or to
541 `(cons A (cons B (cons C D)))'.
543 (declare (compiler-macro cl--compiler-macro-list
*))
544 (cond ((not rest
) arg
)
545 ((not (cdr rest
)) (cons arg
(car rest
)))
546 (t (let* ((n (length rest
))
547 (copy (copy-sequence rest
))
548 (last (nthcdr (- n
2) copy
)))
549 (setcdr last
(car (cdr last
)))
551 (autoload 'cl--compiler-macro-list
* "cl-macs")
553 (defun cl-ldiff (list sublist
)
554 "Return a copy of LIST with the tail SUBLIST removed."
556 (while (and (consp list
) (not (eq list sublist
)))
557 (push (pop list
) res
))
560 (defun cl-copy-list (list)
561 "Return a copy of LIST, which may be a dotted list.
562 The elements of LIST are not copied, just the list structure itself."
565 (while (consp list
) (push (pop list
) res
))
566 (prog1 (nreverse res
) (setcdr res list
)))
569 ;; Autoloaded, but we have not loaded cl-loaddefs yet.
570 (declare-function cl-floor
"cl-extra" (x &optional y
))
571 (declare-function cl-ceiling
"cl-extra" (x &optional y
))
572 (declare-function cl-truncate
"cl-extra" (x &optional y
))
573 (declare-function cl-round
"cl-extra" (x &optional y
))
574 (declare-function cl-mod
"cl-extra" (x y
))
576 (defun cl-adjoin (cl-item cl-list
&rest cl-keys
)
577 "Return ITEM consed onto the front of LIST only if it's not already there.
578 Otherwise, return LIST unmodified.
579 \nKeywords supported: :test :test-not :key
580 \n(fn ITEM LIST [KEYWORD VALUE]...)"
581 (declare (compiler-macro cl--compiler-macro-adjoin
))
582 (cond ((or (equal cl-keys
'(:test eq
))
583 (and (null cl-keys
) (not (numberp cl-item
))))
584 (if (memq cl-item cl-list
) cl-list
(cons cl-item cl-list
)))
585 ((or (equal cl-keys
'(:test equal
)) (null cl-keys
))
586 (if (member cl-item cl-list
) cl-list
(cons cl-item cl-list
)))
587 (t (apply 'cl--adjoin cl-item cl-list cl-keys
))))
588 (autoload 'cl--compiler-macro-adjoin
"cl-macs")
590 (defun cl-subst (cl-new cl-old cl-tree
&rest cl-keys
)
591 "Substitute NEW for OLD everywhere in TREE (non-destructively).
592 Return a copy of TREE with all elements `eql' to OLD replaced by NEW.
593 \nKeywords supported: :test :test-not :key
594 \n(fn NEW OLD TREE [KEYWORD VALUE]...)"
595 (if (or cl-keys
(and (numberp cl-old
) (not (integerp cl-old
))))
596 (apply 'cl-sublis
(list (cons cl-old cl-new
)) cl-tree cl-keys
)
597 (cl--do-subst cl-new cl-old cl-tree
)))
599 (defun cl--do-subst (cl-new cl-old cl-tree
)
600 (cond ((eq cl-tree cl-old
) cl-new
)
602 (let ((a (cl--do-subst cl-new cl-old
(car cl-tree
)))
603 (d (cl--do-subst cl-new cl-old
(cdr cl-tree
))))
604 (if (and (eq a
(car cl-tree
)) (eq d
(cdr cl-tree
)))
605 cl-tree
(cons a d
))))
608 (defun cl-acons (key value alist
)
609 "Add KEY and VALUE to ALIST.
610 Return a new list with (cons KEY VALUE) as car and ALIST as cdr."
611 (cons (cons key value
) alist
))
613 (defun cl-pairlis (keys values
&optional alist
)
614 "Make an alist from KEYS and VALUES.
615 Return a new alist composed by associating KEYS to corresponding VALUES;
616 the process stops as soon as KEYS or VALUES run out.
617 If ALIST is non-nil, the new pairs are prepended to it."
618 (nconc (cl-mapcar 'cons keys values
) alist
))
625 ;; Autoload, so autoload.el and font-lock can use it even when CL
627 (put 'cl-defun
'doc-string-elt
3)
628 (put 'cl-defmacro
'doc-string-elt
3)
629 (put 'cl-defsubst
'doc-string-elt
3)
630 (put 'cl-defstruct
'doc-string-elt
2))
632 (load "cl-loaddefs" nil
'quiet
)
636 (run-hooks 'cl-load-hook
)
639 ;; byte-compile-dynamic: t
640 ;; byte-compile-warnings: (not cl-functions)
643 ;;; cl-lib.el ends here