cl-lib.el 22.1 KB
Newer Older
1
;;; cl-lib.el --- Common Lisp extensions for Emacs  -*- lexical-binding: t -*-
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96

;; Copyright (C) 1993, 2001-2012  Free Software Foundation, Inc.

;; Author: Dave Gillespie <daveg@synaptics.com>
;; Version: 2.02
;; Keywords: extensions

;; This file is part of GNU Emacs.

;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;; These are extensions to Emacs Lisp that provide a degree of
;; Common Lisp compatibility, beyond what is already built-in
;; in Emacs Lisp.
;;
;; This package was written by Dave Gillespie; it is a complete
;; rewrite of Cesar Quiroz's original cl.el package of December 1986.
;;
;; Bug reports, comments, and suggestions are welcome!

;; This file contains the portions of the Common Lisp extensions
;; package which should always be present.


;;; Future notes:

;; Once Emacs 19 becomes standard, many things in this package which are
;; messy for reasons of compatibility can be greatly simplified.  For now,
;; I prefer to maintain one unified version.


;;; Change Log:

;; Version 2.02 (30 Jul 93):
;;  * Added "cl-compat.el" file, extra compatibility with old package.
;;  * Added `lexical-let' and `lexical-let*'.
;;  * Added `define-modify-macro', `callf', and `callf2'.
;;  * Added `ignore-errors'.
;;  * Changed `(setf (nthcdr N PLACE) X)' to work when N is zero.
;;  * Merged `*gentemp-counter*' into `*gensym-counter*'.
;;  * Extended `subseq' to allow negative START and END like `substring'.
;;  * Added `in-ref', `across-ref', `elements of-ref' loop clauses.
;;  * Added `concat', `vconcat' loop clauses.
;;  * Cleaned up a number of compiler warnings.

;; Version 2.01 (7 Jul 93):
;;  * Added support for FSF version of Emacs 19.
;;  * Added `add-hook' for Emacs 18 users.
;;  * Added `defsubst*' and `symbol-macrolet'.
;;  * Added `maplist', `mapc', `mapl', `mapcan', `mapcon'.
;;  * Added `map', `concatenate', `reduce', `merge'.
;;  * Added `revappend', `nreconc', `tailp', `tree-equal'.
;;  * Added `assert', `check-type', `typecase', `typep', and `deftype'.
;;  * Added destructuring and `&environment' support to `defmacro*'.
;;  * Added destructuring to `loop', and added the following clauses:
;;      `elements', `frames', `overlays', `intervals', `buffers', `key-seqs'.
;;  * Renamed `delete' to `delete*' and `remove' to `remove*'.
;;  * Completed support for all keywords in `remove*', `substitute', etc.
;;  * Added `most-positive-float' and company.
;;  * Fixed hash tables to work with latest Lucid Emacs.
;;  * `proclaim' forms are no longer compile-time-evaluating; use `declaim'.
;;  * Syntax for `warn' declarations has changed.
;;  * Improved implementation of `random*'.
;;  * Moved most sequence functions to a new file, cl-seq.el.
;;  * Moved `eval-when' into cl-macs.el.
;;  * Moved `pushnew' and `adjoin' to cl.el for most common cases.
;;  * Moved `provide' forms down to ends of files.
;;  * Changed expansion of `pop' to something that compiles to better code.
;;  * Changed so that no patch is required for Emacs 19 byte compiler.
;;  * Made more things dependent on `optimize' declarations.
;;  * Added a partial implementation of struct print functions.
;;  * Miscellaneous minor changes.

;; Version 2.00:
;;  * First public release of this package.


;;; Code:

(defvar cl-optimize-speed 1)
(defvar cl-optimize-safety 1)

97 98 99 100 101
;;;###autoload
(define-obsolete-variable-alias
  ;; This alias is needed for compatibility with .elc files that use defstruct
  ;; and were compiled with Emacs<24.2.
  'custom-print-functions 'cl-custom-print-functions "24.2")
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116

;;;###autoload
(defvar cl-custom-print-functions nil
  "This is a list of functions that format user objects for printing.
Each function is called in turn with three arguments: the object, the
stream, and the print level (currently ignored).  If it is able to
print the object it returns true; otherwise it returns nil and the
printer proceeds to the next function on the list.

This variable is not used at present, but it is defined in hopes that
a future Emacs interpreter will be able to use it.")

(defun cl-unload-function ()
  "Stop unloading of the Common Lisp extensions."
  (message "Cannot unload the feature `cl'")
117
  ;; Stop standard unloading!
118 119 120 121 122 123 124 125
  t)

;;; Generalized variables.
;; These macros are defined here so that they
;; can safely be used in .emacs files.

(defmacro cl-incf (place &optional x)
  "Increment PLACE by X (1 by default).
126
PLACE may be a symbol, or any generalized variable allowed by `setf'.
127 128 129 130 131 132 133 134
The return value is the incremented value of PLACE."
  (declare (debug (place &optional form)))
  (if (symbolp place)
      (list 'setq place (if x (list '+ place x) (list '1+ place)))
    (list 'cl-callf '+ place (or x 1))))

(defmacro cl-decf (place &optional x)
  "Decrement PLACE by X (1 by default).
135
PLACE may be a symbol, or any generalized variable allowed by `setf'.
136 137 138 139 140 141 142 143
The return value is the decremented value of PLACE."
  (declare (debug cl-incf))
  (if (symbolp place)
      (list 'setq place (if x (list '- place x) (list '1- place)))
    (list 'cl-callf '- place (or x 1))))

(defmacro cl-pushnew (x place &rest keys)
  "(cl-pushnew X PLACE): insert X at the head of the list if not already there.
144
Like (push X PLACE), except that the list is unmodified if X is `eql' to
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
an element already on the list.
\nKeywords supported:  :test :test-not :key
\n(fn X PLACE [KEYWORD VALUE]...)"
  (declare (debug
            (form place &rest
                  &or [[&or ":test" ":test-not" ":key"] function-form]
                  [keywordp form])))
  (if (symbolp place)
      (if (null keys)
 	  `(let ((x ,x))
	     (if (memql x ,place)
                 ;; This symbol may later on expand to actual code which then
                 ;; trigger warnings like "value unused" since cl-pushnew's return
                 ;; value is rarely used.  It should not matter that other
                 ;; warnings may be silenced, since `place' is used earlier and
                 ;; should have triggered them already.
                 (with-no-warnings ,place)
               (setq ,place (cons x ,place))))
	(list 'setq place (cl-list* 'cl-adjoin x place keys)))
    (cl-list* 'cl-callf2 'cl-adjoin x place keys)))

166
(defun cl--set-elt (seq n val)
167 168
  (if (listp seq) (setcar (nthcdr n seq) val) (aset seq n val)))

169
(defun cl--set-buffer-substring (start end val)
170 171 172 173 174
  (save-excursion (delete-region start end)
		  (goto-char start)
		  (insert val)
		  val))

175
(defun cl--set-substring (str start end val)
176 177 178 179 180 181 182 183 184 185
  (if end (if (< end 0) (cl-incf end (length str)))
    (setq end (length str)))
  (if (< start 0) (cl-incf start (length str)))
  (concat (and (> start 0) (substring str 0 start))
	  val
	  (and (< end (length str)) (substring str end))))


;;; Blocks and exits.

186 187
(defalias 'cl--block-wrapper 'identity)
(defalias 'cl--block-throw 'throw)
188 189 190 191 192 193 194


;;; Multiple values.
;; True multiple values are not supported, or even
;; simulated.  Instead, cl-multiple-value-bind and friends simply expect
;; the target form to return the values as a list.

195 196 197 198 199
(defun cl--defalias (cl-f el-f &optional doc)
  (defalias cl-f el-f doc)
  (put cl-f 'byte-optimizer 'byte-compile-inline-expand))

(cl--defalias 'cl-values #'list
200 201 202 203 204 205
  "Return multiple values, Common Lisp style.
The arguments of `cl-values' are the values
that the containing function should return.

\(fn &rest VALUES)")

206
(cl--defalias 'cl-values-list #'identity
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
  "Return multiple values, Common Lisp style, taken from a list.
LIST specifies the list of values
that the containing function should return.

\(fn LIST)")

(defsubst cl-multiple-value-list (expression)
  "Return a list of the multiple values produced by EXPRESSION.
This handles multiple values in Common Lisp style, but it does not
work right when EXPRESSION calls an ordinary Emacs Lisp function
that returns just one value."
  expression)

(defsubst cl-multiple-value-apply (function expression)
  "Evaluate EXPRESSION to get multiple values and apply FUNCTION to them.
This handles multiple values in Common Lisp style, but it does not work
right when EXPRESSION calls an ordinary Emacs Lisp function that returns just
one value."
  (apply function expression))

(defalias 'cl-multiple-value-call 'apply
  "Apply FUNCTION to ARGUMENTS, taking multiple values into account.
This implementation only handles the case where there is only one argument.")

(defsubst cl-nth-value (n expression)
  "Evaluate EXPRESSION to get multiple values and return the Nth one.
This handles multiple values in Common Lisp style, but it does not work
right when EXPRESSION calls an ordinary Emacs Lisp function that returns just
one value."
  (nth n expression))

;;; Declarations.

240 241 242
(defvar cl--compiling-file nil)
(defun cl--compiling-file ()
  (or cl--compiling-file
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
      (and (boundp 'byte-compile--outbuffer)
           (bufferp (symbol-value 'byte-compile--outbuffer))
	   (equal (buffer-name (symbol-value 'byte-compile--outbuffer))
		  " *Compiler Output*"))))

(defvar cl-proclaims-deferred nil)

(defun cl-proclaim (spec)
  (if (fboundp 'cl-do-proclaim) (cl-do-proclaim spec t)
    (push spec cl-proclaims-deferred))
  nil)

(defmacro cl-declaim (&rest specs)
  (let ((body (mapcar (function (lambda (x) (list 'cl-proclaim (list 'quote x))))
		      specs)))
258
    (if (cl--compiling-file) (cl-list* 'cl-eval-when '(compile load eval) body)
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
      (cons 'progn body))))   ; avoid loading cl-macs.el for cl-eval-when


;;; Symbols.

(defun cl-random-time ()
  (let* ((time (copy-sequence (current-time-string))) (i (length time)) (v 0))
    (while (>= (cl-decf i) 0) (setq v (+ (* v 3) (aref time i))))
    v))

(defvar cl--gensym-counter (* (logand (cl-random-time) 1023) 100))


;;; Numbers.

(defun cl-floatp-safe (object)
  "Return t if OBJECT is a floating point number.
On Emacs versions that lack floating-point support, this function
always returns nil."
  (and (numberp object) (not (integerp object))))

280
(defsubst cl-plusp (number)
281 282 283
  "Return t if NUMBER is positive."
  (> number 0))

284
(defsubst cl-minusp (number)
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
  "Return t if NUMBER is negative."
  (< number 0))

(defun cl-oddp (integer)
  "Return t if INTEGER is odd."
  (eq (logand integer 1) 1))

(defun cl-evenp (integer)
  "Return t if INTEGER is even."
  (eq (logand integer 1) 0))

(defvar cl--random-state (vector 'cl-random-state-tag -1 30 (cl-random-time)))

(defconst cl-most-positive-float nil
  "The largest value that a Lisp float can hold.
If your system supports infinities, this is the largest finite value.
For IEEE machines, this is approximately 1.79e+308.
Call `cl-float-limits' to set this.")

(defconst cl-most-negative-float nil
  "The largest negative value that a Lisp float can hold.
This is simply -`cl-most-positive-float'.
Call `cl-float-limits' to set this.")

(defconst cl-least-positive-float nil
  "The smallest value greater than zero that a Lisp float can hold.
For IEEE machines, it is about 4.94e-324 if denormals are supported,
or 2.22e-308 if they are not.
Call `cl-float-limits' to set this.")

(defconst cl-least-negative-float nil
  "The smallest value less than zero that a Lisp float can hold.
This is simply -`cl-least-positive-float'.
Call `cl-float-limits' to set this.")

(defconst cl-least-positive-normalized-float nil
  "The smallest normalized Lisp float greater than zero.
This is the smallest value for which IEEE denormalization does not lose
precision.  For IEEE machines, this value is about 2.22e-308.
For machines that do not support the concept of denormalization
and gradual underflow, this constant equals `cl-least-positive-float'.
Call `cl-float-limits' to set this.")

(defconst cl-least-negative-normalized-float nil
  "The smallest normalized Lisp float less than zero.
This is simply -`cl-least-positive-normalized-float'.
Call `cl-float-limits' to set this.")

(defconst cl-float-epsilon nil
  "The smallest positive float that adds to 1.0 to give a distinct value.
Adding a number less than this to 1.0 returns 1.0 due to roundoff.
For IEEE machines, epsilon is about 2.22e-16.
Call `cl-float-limits' to set this.")

(defconst cl-float-negative-epsilon nil
  "The smallest positive float that subtracts from 1.0 to give a distinct value.
For IEEE machines, it is about 1.11e-16.
Call `cl-float-limits' to set this.")


;;; Sequence functions.

347
(cl--defalias 'cl-copy-seq 'copy-sequence)
348

349
(declare-function cl--mapcar-many "cl-extra" (cl-func cl-seqs))
350 351 352 353 354 355 356 357 358 359

(defun cl-mapcar (cl-func cl-x &rest cl-rest)
  "Apply FUNCTION to each element of SEQ, and make a list of the results.
If there are several SEQs, FUNCTION is called with that many arguments,
and mapping stops as soon as the shortest list runs out.  With just one
SEQ, this is like `mapcar'.  With several, it is like the Common Lisp
`mapcar' function extended to arbitrary sequence types.
\n(fn FUNCTION SEQ...)"
  (if cl-rest
      (if (or (cdr cl-rest) (nlistp cl-x) (nlistp (car cl-rest)))
360
	  (cl--mapcar-many cl-func (cons cl-x cl-rest))
361 362 363 364 365 366
	(let ((cl-res nil) (cl-y (car cl-rest)))
	  (while (and cl-x cl-y)
	    (push (funcall cl-func (pop cl-x) (pop cl-y)) cl-res))
	  (nreverse cl-res)))
    (mapcar cl-func cl-x)))

367
(cl--defalias 'cl-svref 'aref)
368 369 370

;;; List functions.

371 372 373 374
(cl--defalias 'cl-first 'car)
(cl--defalias 'cl-second 'cadr)
(cl--defalias 'cl-rest 'cdr)
(cl--defalias 'cl-endp 'null)
375

376 377
(cl--defalias 'cl-third 'cl-caddr "Return the third element of the list X.")
(cl--defalias 'cl-fourth 'cl-cadddr "Return the fourth element of the list X.")
378

379 380
(defsubst cl-fifth (x)
  "Return the fifth element of the list X."
381 382
  (nth 4 x))

383 384
(defsubst cl-sixth (x)
  "Return the sixth element of the list X."
385 386
  (nth 5 x))

387 388
(defsubst cl-seventh (x)
  "Return the seventh element of the list X."
389 390
  (nth 6 x))

391 392
(defsubst cl-eighth (x)
  "Return the eighth element of the list X."
393 394
  (nth 7 x))

395 396
(defsubst cl-ninth (x)
  "Return the ninth element of the list X."
397 398
  (nth 8 x))

399 400
(defsubst cl-tenth (x)
  "Return the tenth element of the list X."
401 402 403 404
  (nth 9 x))

(defun cl-caaar (x)
  "Return the `car' of the `car' of the `car' of X."
405
  (declare (compiler-macro cl--compiler-macro-cXXr))
406 407 408 409
  (car (car (car x))))

(defun cl-caadr (x)
  "Return the `car' of the `car' of the `cdr' of X."
410
  (declare (compiler-macro cl--compiler-macro-cXXr))
411 412 413 414
  (car (car (cdr x))))

(defun cl-cadar (x)
  "Return the `car' of the `cdr' of the `car' of X."
415
  (declare (compiler-macro cl--compiler-macro-cXXr))
416 417 418 419
  (car (cdr (car x))))

(defun cl-caddr (x)
  "Return the `car' of the `cdr' of the `cdr' of X."
420
  (declare (compiler-macro cl--compiler-macro-cXXr))
421 422 423 424
  (car (cdr (cdr x))))

(defun cl-cdaar (x)
  "Return the `cdr' of the `car' of the `car' of X."
425
  (declare (compiler-macro cl--compiler-macro-cXXr))
426 427 428 429
  (cdr (car (car x))))

(defun cl-cdadr (x)
  "Return the `cdr' of the `car' of the `cdr' of X."
430
  (declare (compiler-macro cl--compiler-macro-cXXr))
431 432 433 434
  (cdr (car (cdr x))))

(defun cl-cddar (x)
  "Return the `cdr' of the `cdr' of the `car' of X."
435
  (declare (compiler-macro cl--compiler-macro-cXXr))
436 437 438 439
  (cdr (cdr (car x))))

(defun cl-cdddr (x)
  "Return the `cdr' of the `cdr' of the `cdr' of X."
440
  (declare (compiler-macro cl--compiler-macro-cXXr))
441 442 443 444
  (cdr (cdr (cdr x))))

(defun cl-caaaar (x)
  "Return the `car' of the `car' of the `car' of the `car' of X."
445
  (declare (compiler-macro cl--compiler-macro-cXXr))
446 447 448 449
  (car (car (car (car x)))))

(defun cl-caaadr (x)
  "Return the `car' of the `car' of the `car' of the `cdr' of X."
450
  (declare (compiler-macro cl--compiler-macro-cXXr))
451 452 453 454
  (car (car (car (cdr x)))))

(defun cl-caadar (x)
  "Return the `car' of the `car' of the `cdr' of the `car' of X."
455
  (declare (compiler-macro cl--compiler-macro-cXXr))
456 457 458 459
  (car (car (cdr (car x)))))

(defun cl-caaddr (x)
  "Return the `car' of the `car' of the `cdr' of the `cdr' of X."
460
  (declare (compiler-macro cl--compiler-macro-cXXr))
461 462 463 464
  (car (car (cdr (cdr x)))))

(defun cl-cadaar (x)
  "Return the `car' of the `cdr' of the `car' of the `car' of X."
465
  (declare (compiler-macro cl--compiler-macro-cXXr))
466 467 468 469
  (car (cdr (car (car x)))))

(defun cl-cadadr (x)
  "Return the `car' of the `cdr' of the `car' of the `cdr' of X."
470
  (declare (compiler-macro cl--compiler-macro-cXXr))
471 472 473 474
  (car (cdr (car (cdr x)))))

(defun cl-caddar (x)
  "Return the `car' of the `cdr' of the `cdr' of the `car' of X."
475
  (declare (compiler-macro cl--compiler-macro-cXXr))
476 477 478 479
  (car (cdr (cdr (car x)))))

(defun cl-cadddr (x)
  "Return the `car' of the `cdr' of the `cdr' of the `cdr' of X."
480
  (declare (compiler-macro cl--compiler-macro-cXXr))
481 482 483 484
  (car (cdr (cdr (cdr x)))))

(defun cl-cdaaar (x)
  "Return the `cdr' of the `car' of the `car' of the `car' of X."
485
  (declare (compiler-macro cl--compiler-macro-cXXr))
486 487 488 489
  (cdr (car (car (car x)))))

(defun cl-cdaadr (x)
  "Return the `cdr' of the `car' of the `car' of the `cdr' of X."
490
  (declare (compiler-macro cl--compiler-macro-cXXr))
491 492 493 494
  (cdr (car (car (cdr x)))))

(defun cl-cdadar (x)
  "Return the `cdr' of the `car' of the `cdr' of the `car' of X."
495
  (declare (compiler-macro cl--compiler-macro-cXXr))
496 497 498 499
  (cdr (car (cdr (car x)))))

(defun cl-cdaddr (x)
  "Return the `cdr' of the `car' of the `cdr' of the `cdr' of X."
500
  (declare (compiler-macro cl--compiler-macro-cXXr))
501 502 503 504
  (cdr (car (cdr (cdr x)))))

(defun cl-cddaar (x)
  "Return the `cdr' of the `cdr' of the `car' of the `car' of X."
505
  (declare (compiler-macro cl--compiler-macro-cXXr))
506 507 508 509
  (cdr (cdr (car (car x)))))

(defun cl-cddadr (x)
  "Return the `cdr' of the `cdr' of the `car' of the `cdr' of X."
510
  (declare (compiler-macro cl--compiler-macro-cXXr))
511 512 513 514
  (cdr (cdr (car (cdr x)))))

(defun cl-cdddar (x)
  "Return the `cdr' of the `cdr' of the `cdr' of the `car' of X."
515
  (declare (compiler-macro cl--compiler-macro-cXXr))
516 517 518 519
  (cdr (cdr (cdr (car x)))))

(defun cl-cddddr (x)
  "Return the `cdr' of the `cdr' of the `cdr' of the `cdr' of X."
520
  (declare (compiler-macro cl--compiler-macro-cXXr))
521 522 523 524 525 526 527 528 529 530 531 532 533
  (cdr (cdr (cdr (cdr x)))))

;;(defun last* (x &optional n)
;;  "Returns the last link in the list LIST.
;;With optional argument N, returns Nth-to-last link (default 1)."
;;  (if n
;;      (let ((m 0) (p x))
;;	(while (consp p) (cl-incf m) (pop p))
;;	(if (<= n 0) p
;;	  (if (< n m) (nthcdr (- m n) x) x)))
;;    (while (consp (cdr x)) (pop x))
;;    x))

534
(defun cl-list* (arg &rest rest)
535 536 537 538
  "Return a new list with specified ARGs as elements, consed to last ARG.
Thus, `(cl-list* A B C D)' is equivalent to `(nconc (list A B C) D)', or to
`(cons A (cons B (cons C D)))'.
\n(fn ARG...)"
539
  (declare (compiler-macro cl--compiler-macro-list*))
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
  (cond ((not rest) arg)
	((not (cdr rest)) (cons arg (car rest)))
	(t (let* ((n (length rest))
		  (copy (copy-sequence rest))
		  (last (nthcdr (- n 2) copy)))
	     (setcdr last (car (cdr last)))
	     (cons arg copy)))))

(defun cl-ldiff (list sublist)
  "Return a copy of LIST with the tail SUBLIST removed."
  (let ((res nil))
    (while (and (consp list) (not (eq list sublist)))
      (push (pop list) res))
    (nreverse res)))

(defun cl-copy-list (list)
  "Return a copy of LIST, which may be a dotted list.
The elements of LIST are not copied, just the list structure itself."
  (if (consp list)
      (let ((res nil))
	(while (consp list) (push (pop list) res))
	(prog1 (nreverse res) (setcdr res list)))
    (car list)))

;; Autoloaded, but we have not loaded cl-loaddefs yet.
(declare-function cl-floor "cl-extra" (x &optional y))
(declare-function cl-ceiling "cl-extra" (x &optional y))
(declare-function cl-truncate "cl-extra" (x &optional y))
(declare-function cl-round "cl-extra" (x &optional y))
(declare-function cl-mod "cl-extra" (x y))

571
(defun cl-adjoin (cl-item cl-list &rest cl-keys)
572 573 574 575
  "Return ITEM consed onto the front of LIST only if it's not already there.
Otherwise, return LIST unmodified.
\nKeywords supported:  :test :test-not :key
\n(fn ITEM LIST [KEYWORD VALUE]...)"
576
  (declare (compiler-macro cl--compiler-macro-adjoin))
577 578 579 580 581 582 583 584 585 586 587 588 589 590
  (cond ((or (equal cl-keys '(:test eq))
	     (and (null cl-keys) (not (numberp cl-item))))
	 (if (memq cl-item cl-list) cl-list (cons cl-item cl-list)))
	((or (equal cl-keys '(:test equal)) (null cl-keys))
	 (if (member cl-item cl-list) cl-list (cons cl-item cl-list)))
	(t (apply 'cl--adjoin cl-item cl-list cl-keys))))

(defun cl-subst (cl-new cl-old cl-tree &rest cl-keys)
  "Substitute NEW for OLD everywhere in TREE (non-destructively).
Return a copy of TREE with all elements `eql' to OLD replaced by NEW.
\nKeywords supported:  :test :test-not :key
\n(fn NEW OLD TREE [KEYWORD VALUE]...)"
  (if (or cl-keys (and (numberp cl-old) (not (integerp cl-old))))
      (apply 'cl-sublis (list (cons cl-old cl-new)) cl-tree cl-keys)
591
    (cl--do-subst cl-new cl-old cl-tree)))
592

593
(defun cl--do-subst (cl-new cl-old cl-tree)
594 595
  (cond ((eq cl-tree cl-old) cl-new)
	((consp cl-tree)
596 597
	 (let ((a (cl--do-subst cl-new cl-old (car cl-tree)))
	       (d (cl--do-subst cl-new cl-old (cdr cl-tree))))
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
	   (if (and (eq a (car cl-tree)) (eq d (cdr cl-tree)))
	       cl-tree (cons a d))))
	(t cl-tree)))

(defun cl-acons (key value alist)
  "Add KEY and VALUE to ALIST.
Return a new list with (cons KEY VALUE) as car and ALIST as cdr."
  (cons (cons key value) alist))

(defun cl-pairlis (keys values &optional alist)
  "Make an alist from KEYS and VALUES.
Return a new alist composed by associating KEYS to corresponding VALUES;
the process stops as soon as KEYS or VALUES run out.
If ALIST is non-nil, the new pairs are prepended to it."
  (nconc (cl-mapcar 'cons keys values) alist))


;;; Miscellaneous.

;;;###autoload
(progn
619 620 621
  ;; Make sure functions defined with cl-defsubst can be inlined even in
  ;; packages which do not require CL.
  (autoload 'cl--defsubst-expand "cl-macs")
622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
  ;; Autoload, so autoload.el and font-lock can use it even when CL
  ;; is not loaded.
  (put 'cl-defun    'doc-string-elt 3)
  (put 'cl-defmacro 'doc-string-elt 3)
  (put 'cl-defsubst 'doc-string-elt 3)
  (put 'cl-defstruct 'doc-string-elt 2))

(load "cl-loaddefs" nil 'quiet)

(provide 'cl-lib)

(run-hooks 'cl-load-hook)

;; Local variables:
;; byte-compile-dynamic: t
;; byte-compile-warnings: (not cl-functions)
;; End:

;;; cl-lib.el ends here