cl.el 22.6 KB
Newer Older
1
;;; cl.el --- Common Lisp extensions for Emacs
Richard M. Stallman's avatar
Richard M. Stallman committed
2

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 1993, 2001, 2002, 2003, 2004, 2005,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2006, 2007, 2008 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
5 6 7 8 9 10 11

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

;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Richard M. Stallman's avatar
Richard M. Stallman committed
16 17 18 19 20 21 22

;; 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
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
24

Richard M. Stallman's avatar
Richard M. Stallman committed
25
;;; Commentary:
Richard M. Stallman's avatar
Richard M. Stallman committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39

;; 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.


Richard M. Stallman's avatar
Richard M. Stallman committed
40
;;; Future notes:
Richard M. Stallman's avatar
Richard M. Stallman committed
41 42 43 44 45 46

;; 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.


Richard M. Stallman's avatar
Richard M. Stallman committed
47
;;; Change Log:
Richard M. Stallman's avatar
Richard M. Stallman committed
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

;; 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.


Richard M. Stallman's avatar
Richard M. Stallman committed
93
;;; Code:
Richard M. Stallman's avatar
Richard M. Stallman committed
94 95 96 97 98

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


99
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
100 101 102 103 104 105 106 107 108 109
(defvar 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.")

110 111 112 113 114
(defun cl-unload-function ()
  "Stop unloading of the Common Lisp extensions."
  (message "Cannot unload the feature `cl'")
  ;; stop standard unloading!
  t)
Richard M. Stallman's avatar
Richard M. Stallman committed
115

116 117 118
;;; Generalized variables.
;; These macros are defined here so that they
;; can safely be used in .emacs files.
Richard M. Stallman's avatar
Richard M. Stallman committed
119 120

(defmacro incf (place &optional x)
121
  "Increment PLACE by X (1 by default).
Richard M. Stallman's avatar
Richard M. Stallman committed
122 123 124 125 126 127 128
PLACE may be a symbol, or any generalized variable allowed by `setf'.
The return value is the incremented value of PLACE."
  (if (symbolp place)
      (list 'setq place (if x (list '+ place x) (list '1+ place)))
    (list 'callf '+ place (or x 1))))

(defmacro decf (place &optional x)
129
  "Decrement PLACE by X (1 by default).
Richard M. Stallman's avatar
Richard M. Stallman committed
130 131 132 133 134 135
PLACE may be a symbol, or any generalized variable allowed by `setf'.
The return value is the decremented value of PLACE."
  (if (symbolp place)
      (list 'setq place (if x (list '- place x) (list '1- place)))
    (list 'callf '- place (or x 1))))

136 137 138
;; Autoloaded, but we haven't loaded cl-loaddefs yet.
(declare-function cl-do-pop "cl-macs" (place))

Richard M. Stallman's avatar
Richard M. Stallman committed
139
(defmacro pop (place)
140
  "Remove and return the head of the list stored in PLACE.
Richard M. Stallman's avatar
Richard M. Stallman committed
141 142 143 144 145 146 147 148
Analogous to (prog1 (car PLACE) (setf PLACE (cdr PLACE))), though more
careful about evaluating each argument only once and in the right order.
PLACE may be a symbol, or any generalized variable allowed by `setf'."
  (if (symbolp place)
      (list 'car (list 'prog1 place (list 'setq place (list 'cdr place))))
    (cl-do-pop place)))

(defmacro push (x place)
149
  "Insert X at the head of the list stored in PLACE.
Richard M. Stallman's avatar
Richard M. Stallman committed
150 151 152 153 154 155 156 157 158 159
Analogous to (setf PLACE (cons X PLACE)), though more careful about
evaluating each argument only once and in the right order.  PLACE may
be a symbol, or any generalized variable allowed by `setf'."
  (if (symbolp place) (list 'setq place (list 'cons x place))
    (list 'callf2 'cons x place)))

(defmacro pushnew (x place &rest keys)
  "(pushnew X PLACE): insert X at the head of the list if not already there.
Like (push X PLACE), except that the list is unmodified if X is `eql' to
an element already on the list.
160 161
\nKeywords supported:  :test :test-not :key
\n(fn X PLACE [KEYWORD VALUE]...)"
162 163
  (if (symbolp place)
      (if (null keys)
164 165
 	  `(let ((x ,x))
	     (if (memql x ,place) ,place (setq ,place (cons x ,place))))
166
	(list 'setq place (list* 'adjoin x place keys)))
Richard M. Stallman's avatar
Richard M. Stallman committed
167 168 169 170 171
    (list* 'callf2 'adjoin x place keys)))

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

172
(defsubst cl-set-nthcdr (n list x)
Richard M. Stallman's avatar
Richard M. Stallman committed
173 174 175 176 177 178 179 180 181 182 183
  (if (<= n 0) x (setcdr (nthcdr (1- n) list) x) list))

(defun cl-set-buffer-substring (start end val)
  (save-excursion (delete-region start end)
		  (goto-char start)
		  (insert val)
		  val))

(defun cl-set-substring (str start end val)
  (if end (if (< end 0) (incf end (length str)))
    (setq end (length str)))
184
  (if (< start 0) (incf start (length str)))
Richard M. Stallman's avatar
Richard M. Stallman committed
185 186 187 188 189 190 191
  (concat (and (> start 0) (substring str 0 start))
	  val
	  (and (< end (length str)) (substring str end))))


;;; Control structures.

192 193
;; These macros are so simple and so often-used that it's better to have
;; them all the time than to load them from cl-macs.el.
Richard M. Stallman's avatar
Richard M. Stallman committed
194 195

(defun cl-map-extents (&rest cl-args)
196
  (apply 'cl-map-overlays cl-args))
Richard M. Stallman's avatar
Richard M. Stallman committed
197 198 199 200 201 202 203 204


;;; Blocks and exits.

(defalias 'cl-block-wrapper 'identity)
(defalias 'cl-block-throw 'throw)


205 206 207 208
;;; Multiple values.
;; True multiple values are not supported, or even
;; simulated.  Instead, multiple-value-bind and friends simply expect
;; the target form to return the values as a list.
Richard M. Stallman's avatar
Richard M. Stallman committed
209

210 211 212 213
(defsubst values (&rest values)
  "Return multiple values, Common Lisp style.
The arguments of `values' are the values
that the containing function should return."
214
  values)
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235

(defsubst values-list (list)
  "Return multiple values, Common Lisp style, taken from a list.
LIST specifies the list of values
that the containing function should return."
  list)

(defsubst 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 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))

236 237 238
(defalias '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.")
239

240 241 242 243 244 245
(defsubst 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))
Richard M. Stallman's avatar
Richard M. Stallman committed
246 247 248 249 250 251 252 253

;;; Macros.

(defvar cl-macro-environment nil)
(defvar cl-old-macroexpand (prog1 (symbol-function 'macroexpand)
			     (defalias 'macroexpand 'cl-macroexpand)))

(defun cl-macroexpand (cl-macro &optional cl-env)
254 255 256 257 258
  "Return result of expanding macros at top level of FORM.
If FORM is not a macro call, it is returned unchanged.
Otherwise, the macro is expanded and the expansion is considered
in place of FORM.  When a non-macro-call results, it is returned.

Gerd Moellmann's avatar
Gerd Moellmann committed
259
The second optional arg ENVIRONMENT specifies an environment of macro
260 261
definitions to shadow the loaded ones for use in file byte-compilation.
\n(fn FORM &optional ENVIRONMENT)"
Richard M. Stallman's avatar
Richard M. Stallman committed
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
  (let ((cl-macro-environment cl-env))
    (while (progn (setq cl-macro (funcall cl-old-macroexpand cl-macro cl-env))
		  (and (symbolp cl-macro)
		       (cdr (assq (symbol-name cl-macro) cl-env))))
      (setq cl-macro (cadr (assq (symbol-name cl-macro) cl-env))))
    cl-macro))


;;; Declarations.

(defvar cl-compiling-file nil)
(defun cl-compiling-file ()
  (or cl-compiling-file
      (and (boundp 'outbuffer) (bufferp (symbol-value 'outbuffer))
	   (equal (buffer-name (symbol-value 'outbuffer))
		  " *Compiler Output*"))))

(defvar cl-proclaims-deferred nil)

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

(defmacro declaim (&rest specs)
  (let ((body (mapcar (function (lambda (x) (list 'proclaim (list 'quote x))))
		      specs)))
    (if (cl-compiling-file) (list* 'eval-when '(compile load eval) body)
      (cons 'progn body))))   ; avoid loading cl-macs.el for eval-when


;;; Symbols.

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

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


;;; Numbers.

305
(defun floatp-safe (object)
306
  "Return t if OBJECT is a floating point number.
Richard M. Stallman's avatar
Richard M. Stallman committed
307 308
On Emacs versions that lack floating-point support, this function
always returns nil."
309
  (and (numberp object) (not (integerp object))))
Richard M. Stallman's avatar
Richard M. Stallman committed
310

311
(defun plusp (number)
312
  "Return t if NUMBER is positive."
313
  (> number 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
314

315
(defun minusp (number)
316
  "Return t if NUMBER is negative."
317
  (< number 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
318

319
(defun oddp (integer)
320
  "Return t if INTEGER is odd."
321
  (eq (logand integer 1) 1))
Richard M. Stallman's avatar
Richard M. Stallman committed
322

323
(defun evenp (integer)
324
  "Return t if INTEGER is even."
325
  (eq (logand integer 1) 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
326 327 328

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

329
;; The following are actually set by cl-float-limits.
Richard M. Stallman's avatar
Richard M. Stallman committed
330 331 332 333 334 335 336 337 338 339 340 341 342 343
(defconst most-positive-float nil)
(defconst most-negative-float nil)
(defconst least-positive-float nil)
(defconst least-negative-float nil)
(defconst least-positive-normalized-float nil)
(defconst least-negative-normalized-float nil)
(defconst float-epsilon nil)
(defconst float-negative-epsilon nil)


;;; Sequence functions.

(defalias 'copy-seq 'copy-sequence)

344 345
(declare-function cl-mapcar-many "cl-extra" (cl-func cl-seqs))

Richard M. Stallman's avatar
Richard M. Stallman committed
346 347 348 349 350
(defun 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
351 352
`mapcar' function extended to arbitrary sequence types.
\n(fn FUNCTION SEQ...)"
Richard M. Stallman's avatar
Richard M. Stallman committed
353 354 355 356 357 358 359 360 361
  (if cl-rest
      (if (or (cdr cl-rest) (nlistp cl-x) (nlistp (car cl-rest)))
	  (cl-mapcar-many cl-func (cons cl-x cl-rest))
	(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)))

Stefan Monnier's avatar
Stefan Monnier committed
362
(defalias 'svref 'aref)
Richard M. Stallman's avatar
Richard M. Stallman committed
363 364 365 366

;;; List functions.

(defalias 'first 'car)
367
(defalias 'second 'cadr)
Richard M. Stallman's avatar
Richard M. Stallman committed
368 369 370
(defalias 'rest 'cdr)
(defalias 'endp 'null)

371
(defun third (x)
372 373
  "Return the third element of the list X."
  (car (cdr (cdr x))))
Richard M. Stallman's avatar
Richard M. Stallman committed
374

375
(defun fourth (x)
376 377
  "Return the fourth element of the list X."
  (nth 3 x))
Richard M. Stallman's avatar
Richard M. Stallman committed
378

379
(defun fifth (x)
380 381
  "Return the fifth element of the list X."
  (nth 4 x))
Richard M. Stallman's avatar
Richard M. Stallman committed
382

383
(defun sixth (x)
384 385
  "Return the sixth element of the list X."
  (nth 5 x))
Richard M. Stallman's avatar
Richard M. Stallman committed
386

387
(defun seventh (x)
388 389
  "Return the seventh element of the list X."
  (nth 6 x))
Richard M. Stallman's avatar
Richard M. Stallman committed
390

391
(defun eighth (x)
392 393
  "Return the eighth element of the list X."
  (nth 7 x))
Richard M. Stallman's avatar
Richard M. Stallman committed
394

395
(defun ninth (x)
396 397
  "Return the ninth element of the list X."
  (nth 8 x))
Richard M. Stallman's avatar
Richard M. Stallman committed
398

399
(defun tenth (x)
400 401
  "Return the tenth element of the list X."
  (nth 9 x))
Richard M. Stallman's avatar
Richard M. Stallman committed
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498

(defun caaar (x)
  "Return the `car' of the `car' of the `car' of X."
  (car (car (car x))))

(defun caadr (x)
  "Return the `car' of the `car' of the `cdr' of X."
  (car (car (cdr x))))

(defun cadar (x)
  "Return the `car' of the `cdr' of the `car' of X."
  (car (cdr (car x))))

(defun caddr (x)
  "Return the `car' of the `cdr' of the `cdr' of X."
  (car (cdr (cdr x))))

(defun cdaar (x)
  "Return the `cdr' of the `car' of the `car' of X."
  (cdr (car (car x))))

(defun cdadr (x)
  "Return the `cdr' of the `car' of the `cdr' of X."
  (cdr (car (cdr x))))

(defun cddar (x)
  "Return the `cdr' of the `cdr' of the `car' of X."
  (cdr (cdr (car x))))

(defun cdddr (x)
  "Return the `cdr' of the `cdr' of the `cdr' of X."
  (cdr (cdr (cdr x))))

(defun caaaar (x)
  "Return the `car' of the `car' of the `car' of the `car' of X."
  (car (car (car (car x)))))

(defun caaadr (x)
  "Return the `car' of the `car' of the `car' of the `cdr' of X."
  (car (car (car (cdr x)))))

(defun caadar (x)
  "Return the `car' of the `car' of the `cdr' of the `car' of X."
  (car (car (cdr (car x)))))

(defun caaddr (x)
  "Return the `car' of the `car' of the `cdr' of the `cdr' of X."
  (car (car (cdr (cdr x)))))

(defun cadaar (x)
  "Return the `car' of the `cdr' of the `car' of the `car' of X."
  (car (cdr (car (car x)))))

(defun cadadr (x)
  "Return the `car' of the `cdr' of the `car' of the `cdr' of X."
  (car (cdr (car (cdr x)))))

(defun caddar (x)
  "Return the `car' of the `cdr' of the `cdr' of the `car' of X."
  (car (cdr (cdr (car x)))))

(defun cadddr (x)
  "Return the `car' of the `cdr' of the `cdr' of the `cdr' of X."
  (car (cdr (cdr (cdr x)))))

(defun cdaaar (x)
  "Return the `cdr' of the `car' of the `car' of the `car' of X."
  (cdr (car (car (car x)))))

(defun cdaadr (x)
  "Return the `cdr' of the `car' of the `car' of the `cdr' of X."
  (cdr (car (car (cdr x)))))

(defun cdadar (x)
  "Return the `cdr' of the `car' of the `cdr' of the `car' of X."
  (cdr (car (cdr (car x)))))

(defun cdaddr (x)
  "Return the `cdr' of the `car' of the `cdr' of the `cdr' of X."
  (cdr (car (cdr (cdr x)))))

(defun cddaar (x)
  "Return the `cdr' of the `cdr' of the `car' of the `car' of X."
  (cdr (cdr (car (car x)))))

(defun cddadr (x)
  "Return the `cdr' of the `cdr' of the `car' of the `cdr' of X."
  (cdr (cdr (car (cdr x)))))

(defun cdddar (x)
  "Return the `cdr' of the `cdr' of the `cdr' of the `car' of X."
  (cdr (cdr (cdr (car x)))))

(defun cddddr (x)
  "Return the `cdr' of the `cdr' of the `cdr' of the `cdr' of X."
  (cdr (cdr (cdr (cdr x)))))

499 500 501 502 503 504 505 506 507 508
;;(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) (incf m) (pop p))
;;	(if (<= n 0) p
;;	  (if (< n m) (nthcdr (- m n) x) x)))
;;    (while (consp (cdr x)) (pop x))
;;    x))
Richard M. Stallman's avatar
Richard M. Stallman committed
509 510

(defun list* (arg &rest rest)   ; See compiler macro in cl-macs.el
511
  "Return a new list with specified ARGs as elements, consed to last ARG.
Richard M. Stallman's avatar
Richard M. Stallman committed
512
Thus, `(list* A B C D)' is equivalent to `(nconc (list A B C) D)', or to
513 514
`(cons A (cons B (cons C D)))'.
\n(fn ARG...)"
Richard M. Stallman's avatar
Richard M. Stallman committed
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
  (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 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)))

530
(defun copy-list (list)
531 532
  "Return a copy of LIST, which may be a dotted list.
The elements of LIST are not copied, just the list structure itself."
533 534 535 536 537 538
  (if (consp list)
      (let ((res nil))
	(while (consp list) (push (pop list) res))
	(prog1 (nreverse res) (setcdr res list)))
    (car list)))

Richard M. Stallman's avatar
Richard M. Stallman committed
539 540 541 542 543
(defun cl-maclisp-member (item list)
  (while (and list (not (equal item (car list)))) (setq list (cdr list)))
  list)

(defalias 'cl-member 'memq)   ; for compatibility with old CL package
544 545 546 547 548 549 550 551

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

Richard M. Stallman's avatar
Richard M. Stallman committed
552 553 554 555 556 557 558 559 560
(defalias 'cl-floor 'floor*)
(defalias 'cl-ceiling 'ceiling*)
(defalias 'cl-truncate 'truncate*)
(defalias 'cl-round 'round*)
(defalias 'cl-mod 'mod*)

(defun adjoin (cl-item cl-list &rest cl-keys)  ; See compiler macro in cl-macs
  "Return ITEM consed onto the front of LIST only if it's not already there.
Otherwise, return LIST unmodified.
561 562
\nKeywords supported:  :test :test-not :key
\n(fn ITEM LIST [KEYWORD VALUE]...)"
Richard M. Stallman's avatar
Richard M. Stallman committed
563 564 565 566 567 568 569 570 571 572
  (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 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.
573 574
\nKeywords supported:  :test :test-not :key
\n(fn NEW OLD TREE [KEYWORD VALUE]...)"
Richard M. Stallman's avatar
Richard M. Stallman committed
575 576 577 578 579 580 581 582 583 584 585 586 587
  (if (or cl-keys (and (numberp cl-old) (not (integerp cl-old))))
      (apply 'sublis (list (cons cl-old cl-new)) cl-tree cl-keys)
    (cl-do-subst cl-new cl-old cl-tree)))

(defun cl-do-subst (cl-new cl-old cl-tree)
  (cond ((eq cl-tree cl-old) cl-new)
	((consp cl-tree)
	 (let ((a (cl-do-subst cl-new cl-old (car cl-tree)))
	       (d (cl-do-subst cl-new cl-old (cdr cl-tree))))
	   (if (and (eq a (car cl-tree)) (eq d (cdr cl-tree)))
	       cl-tree (cons a d))))
	(t cl-tree)))

588 589 590 591 592 593 594 595 596 597 598
(defun 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 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 (mapcar* 'cons keys values) alist))
Richard M. Stallman's avatar
Richard M. Stallman committed
599 600 601 602


;;; Miscellaneous.

603
;; Define data for indentation and edebug.
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
(dolist (entry
         '(((defun* defmacro*) 2)
           ((function*) nil
            (&or symbolp ([&optional 'macro] 'lambda (&rest sexp) &rest form)))
           ((eval-when) 1 (sexp &rest form))
           ((declare) nil (&rest sexp))
           ((the) 1 (sexp &rest form))
           ((case ecase typecase etypecase) 1 (form &rest (sexp &rest form)))
           ((block return-from) 1 (sexp &rest form))
           ((return) nil (&optional form))
           ((do do*) 2 ((&rest &or symbolp (symbolp &optional form form))
                        (form &rest form)
                        &rest form))
           ((do-symbols) 1 ((symbolp form &optional form form) &rest form))
           ((do-all-symbols) 1 ((symbolp form &optional form) &rest form))
           ((psetq setf psetf) nil edebug-setq-form)
           ((progv) 2 (&rest form))
           ((flet labels macrolet) 1
            ((&rest (sexp sexp &rest form)) &rest form))
           ((symbol-macrolet lexical-let lexical-let*) 1
            ((&rest &or symbolp (symbolp form)) &rest form))
           ((multiple-value-bind) 2 ((&rest symbolp) &rest form))
           ((multiple-value-setq) 1 ((&rest symbolp) &rest form))
           ((incf decf remf pushnew shiftf rotatef) nil (&rest form))
           ((letf letf*) 1 ((&rest (&rest form)) &rest form))
           ((callf destructuring-bind) 2 (sexp form &rest form))
           ((callf2) 3 (sexp form form &rest form))
           ((loop) nil (&rest &or symbolp form))
           ((ignore-errors) 0 (&rest form))))
  (dolist (func (car entry))
    (put func 'lisp-indent-function (nth 1 entry))
    (put func 'lisp-indent-hook (nth 1 entry))
    (or (get func 'edebug-form-spec)
        (put func 'edebug-form-spec (nth 2 entry)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
638

639 640 641 642 643
;; Autoload the other portions of the package.
;; We want to replace the basic versions of dolist, dotimes, declare below.
(fmakunbound 'dolist)
(fmakunbound 'dotimes)
(fmakunbound 'declare)
Stefan Monnier's avatar
Stefan Monnier committed
644
(load "cl-loaddefs" nil 'quiet)
Richard M. Stallman's avatar
Richard M. Stallman committed
645

646
;; This goes here so that cl-macs can find it if it loads right now.
Richard M. Stallman's avatar
Richard M. Stallman committed
647
(provide 'cl-19)     ; usage: (require 'cl-19 "cl")
648
(provide 'cl)
Richard M. Stallman's avatar
Richard M. Stallman committed
649

650
;; Things to do after byte-compiler is loaded.
Richard M. Stallman's avatar
Richard M. Stallman committed
651 652 653

(defvar cl-hacked-flag nil)
(defun cl-hack-byte-compiler ()
654 655 656 657 658
  (and (not cl-hacked-flag) (fboundp 'byte-compile-file-form)
       (progn
         (setq cl-hacked-flag t)  ; Do it first, to prevent recursion.
         (load "cl-macs" nil t)
         (run-hooks 'cl-hack-bytecomp-hook))))
Richard M. Stallman's avatar
Richard M. Stallman committed
659

660
;; Try it now in case the compiler has already been loaded.
Richard M. Stallman's avatar
Richard M. Stallman committed
661 662
(cl-hack-byte-compiler)

663
;; Also make a hook in case compiler is loaded after this file.
664
(add-hook 'bytecomp-load-hook 'cl-hack-byte-compiler)
Richard M. Stallman's avatar
Richard M. Stallman committed
665 666


667 668
;; The following ensures that packages which expect the old-style cl.el
;; will be happy with this one.
Richard M. Stallman's avatar
Richard M. Stallman committed
669 670 671 672 673

(provide 'cl)

(run-hooks 'cl-load-hook)

674 675 676 677 678
;; Local variables:
;; byte-compile-dynamic: t
;; byte-compile-warnings: (not cl-functions)
;; End:

679
;; arch-tag: 5f07fa74-f153-4524-9303-21f5be125851
Richard M. Stallman's avatar
Richard M. Stallman committed
680
;;; cl.el ends here