cl-extra.el 27.1 KB
Newer Older
Glenn Morris's avatar
Glenn Morris committed
1
;;; cl-extra.el --- Common Lisp features, part 2
Richard M. Stallman's avatar
Richard M. Stallman committed
2

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

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

;; This file is part of GNU Emacs.

11
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
12
;; it under the terms of the GNU General Public License as published by
13 14
;; 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
15 16 17 18 19 20 21

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

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

;; 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 portions of the Common Lisp extensions
;; package which are autoloaded since they are relatively obscure.

Richard M. Stallman's avatar
Richard M. Stallman committed
38
;;; Code:
Richard M. Stallman's avatar
Richard M. Stallman committed
39

40
(require 'cl)
Richard M. Stallman's avatar
Richard M. Stallman committed
41 42 43

;;; Type coercion.

44
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
45 46
(defun coerce (x type)
  "Coerce OBJECT to type TYPE.
47 48
TYPE is a Common Lisp type specifier.
\n(fn OBJECT TYPE)"
Richard M. Stallman's avatar
Richard M. Stallman committed
49 50 51 52 53 54 55 56 57 58 59 60 61
  (cond ((eq type 'list) (if (listp x) x (append x nil)))
	((eq type 'vector) (if (vectorp x) x (vconcat x)))
	((eq type 'string) (if (stringp x) x (concat x)))
	((eq type 'array) (if (arrayp x) x (vconcat x)))
	((and (eq type 'character) (stringp x) (= (length x) 1)) (aref x 0))
	((and (eq type 'character) (symbolp x)) (coerce (symbol-name x) type))
	((eq type 'float) (float x))
	((typep x type) x)
	(t (error "Can't coerce %s to type %s" x type))))


;;; Predicates.

62
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
63
(defun equalp (x y)
Juanma Barranquero's avatar
Juanma Barranquero committed
64
  "Return t if two Lisp objects have similar structures and contents.
Richard M. Stallman's avatar
Richard M. Stallman committed
65 66 67 68 69 70
This is like `equal', except that it accepts numerically equal
numbers of different types (float vs. integer), and also compares
strings case-insensitively."
  (cond ((eq x y) t)
	((stringp x)
	 (and (stringp y) (= (length x) (length y))
71 72
	      (or (string-equal x y)
		  (string-equal (downcase x) (downcase y)))))   ; lazy but simple!
Richard M. Stallman's avatar
Richard M. Stallman committed
73 74 75
	((numberp x)
	 (and (numberp y) (= x y)))
	((consp x)
76 77
	 (while (and (consp x) (consp y) (equalp (car x) (car y)))
	   (setq x (cdr x) y (cdr y)))
Richard M. Stallman's avatar
Richard M. Stallman committed
78 79 80 81 82 83 84 85 86 87 88 89
	 (and (not (consp x)) (equalp x y)))
	((vectorp x)
	 (and (vectorp y) (= (length x) (length y))
	      (let ((i (length x)))
		(while (and (>= (setq i (1- i)) 0)
			    (equalp (aref x i) (aref y i))))
		(< i 0))))
	(t (equal x y))))


;;; Control structures.

90
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
(defun cl-mapcar-many (cl-func cl-seqs)
  (if (cdr (cdr cl-seqs))
      (let* ((cl-res nil)
	     (cl-n (apply 'min (mapcar 'length cl-seqs)))
	     (cl-i 0)
	     (cl-args (copy-sequence cl-seqs))
	     cl-p1 cl-p2)
	(setq cl-seqs (copy-sequence cl-seqs))
	(while (< cl-i cl-n)
	  (setq cl-p1 cl-seqs cl-p2 cl-args)
	  (while cl-p1
	    (setcar cl-p2
		    (if (consp (car cl-p1))
			(prog1 (car (car cl-p1))
			  (setcar cl-p1 (cdr (car cl-p1))))
		      (aref (car cl-p1) cl-i)))
	    (setq cl-p1 (cdr cl-p1) cl-p2 (cdr cl-p2)))
108
	  (push (apply cl-func cl-args) cl-res)
Richard M. Stallman's avatar
Richard M. Stallman committed
109 110 111 112 113 114 115 116
	  (setq cl-i (1+ cl-i)))
	(nreverse cl-res))
    (let ((cl-res nil)
	  (cl-x (car cl-seqs))
	  (cl-y (nth 1 cl-seqs)))
      (let ((cl-n (min (length cl-x) (length cl-y)))
	    (cl-i -1))
	(while (< (setq cl-i (1+ cl-i)) cl-n)
117 118 119
	  (push (funcall cl-func
			    (if (consp cl-x) (pop cl-x) (aref cl-x cl-i))
			    (if (consp cl-y) (pop cl-y) (aref cl-y cl-i)))
Richard M. Stallman's avatar
Richard M. Stallman committed
120 121 122
		   cl-res)))
      (nreverse cl-res))))

123
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
124
(defun map (cl-type cl-func cl-seq &rest cl-rest)
125 126 127
  "Map a FUNCTION across one or more SEQUENCEs, returning a sequence.
TYPE is the sequence type to return.
\n(fn TYPE FUNCTION SEQUENCE...)"
Richard M. Stallman's avatar
Richard M. Stallman committed
128 129 130
  (let ((cl-res (apply 'mapcar* cl-func cl-seq cl-rest)))
    (and cl-type (coerce cl-res cl-type))))

131
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
132
(defun maplist (cl-func cl-list &rest cl-rest)
133
  "Map FUNCTION to each sublist of LIST or LISTs.
Richard M. Stallman's avatar
Richard M. Stallman committed
134
Like `mapcar', except applies to lists and their cdr's rather than to
135 136
the elements themselves.
\n(fn FUNCTION LIST...)"
Richard M. Stallman's avatar
Richard M. Stallman committed
137 138 139 140 141
  (if cl-rest
      (let ((cl-res nil)
	    (cl-args (cons cl-list (copy-sequence cl-rest)))
	    cl-p)
	(while (not (memq nil cl-args))
142
	  (push (apply cl-func cl-args) cl-res)
Richard M. Stallman's avatar
Richard M. Stallman committed
143
	  (setq cl-p cl-args)
144
	  (while cl-p (setcar cl-p (cdr (pop cl-p)) )))
Richard M. Stallman's avatar
Richard M. Stallman committed
145 146 147
	(nreverse cl-res))
    (let ((cl-res nil))
      (while cl-list
148
	(push (funcall cl-func cl-list) cl-res)
Richard M. Stallman's avatar
Richard M. Stallman committed
149 150 151
	(setq cl-list (cdr cl-list)))
      (nreverse cl-res))))

Dave Love's avatar
Dave Love committed
152
(defun cl-mapc (cl-func cl-seq &rest cl-rest)
153 154
  "Like `mapcar', but does not accumulate values returned by the function.
\n(fn FUNCTION SEQUENCE...)"
Richard M. Stallman's avatar
Richard M. Stallman committed
155
  (if cl-rest
Dave Love's avatar
Dave Love committed
156 157
      (progn (apply 'map nil cl-func cl-seq cl-rest)
	     cl-seq)
158
    (mapc cl-func cl-seq)))
Richard M. Stallman's avatar
Richard M. Stallman committed
159

160
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
161
(defun mapl (cl-func cl-list &rest cl-rest)
162 163
  "Like `maplist', but does not accumulate values returned by the function.
\n(fn FUNCTION LIST...)"
Richard M. Stallman's avatar
Richard M. Stallman committed
164 165 166 167 168 169
  (if cl-rest
      (apply 'maplist cl-func cl-list cl-rest)
    (let ((cl-p cl-list))
      (while cl-p (funcall cl-func cl-p) (setq cl-p (cdr cl-p)))))
  cl-list)

170
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
171
(defun mapcan (cl-func cl-seq &rest cl-rest)
172 173
  "Like `mapcar', but nconc's together the values returned by the function.
\n(fn FUNCTION SEQUENCE...)"
Richard M. Stallman's avatar
Richard M. Stallman committed
174 175
  (apply 'nconc (apply 'mapcar* cl-func cl-seq cl-rest)))

176
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
177
(defun mapcon (cl-func cl-list &rest cl-rest)
178 179
  "Like `maplist', but nconc's together the values returned by the function.
\n(fn FUNCTION LIST...)"
Richard M. Stallman's avatar
Richard M. Stallman committed
180 181
  (apply 'nconc (apply 'maplist cl-func cl-list cl-rest)))

182
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
183 184
(defun some (cl-pred cl-seq &rest cl-rest)
  "Return true if PREDICATE is true of any element of SEQ or SEQs.
185 186
If so, return the true (non-nil) value returned by PREDICATE.
\n(fn PREDICATE SEQ...)"
Richard M. Stallman's avatar
Richard M. Stallman committed
187 188 189 190 191 192 193 194
  (if (or cl-rest (nlistp cl-seq))
      (catch 'cl-some
	(apply 'map nil
	       (function (lambda (&rest cl-x)
			   (let ((cl-res (apply cl-pred cl-x)))
			     (if cl-res (throw 'cl-some cl-res)))))
	       cl-seq cl-rest) nil)
    (let ((cl-x nil))
195
      (while (and cl-seq (not (setq cl-x (funcall cl-pred (pop cl-seq))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
196 197
      cl-x)))

198
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
199
(defun every (cl-pred cl-seq &rest cl-rest)
200 201
  "Return true if PREDICATE is true of every element of SEQ or SEQs.
\n(fn PREDICATE SEQ...)"
Richard M. Stallman's avatar
Richard M. Stallman committed
202 203 204 205 206 207 208 209 210 211
  (if (or cl-rest (nlistp cl-seq))
      (catch 'cl-every
	(apply 'map nil
	       (function (lambda (&rest cl-x)
			   (or (apply cl-pred cl-x) (throw 'cl-every nil))))
	       cl-seq cl-rest) t)
    (while (and cl-seq (funcall cl-pred (car cl-seq)))
      (setq cl-seq (cdr cl-seq)))
    (null cl-seq)))

212
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
213
(defun notany (cl-pred cl-seq &rest cl-rest)
214 215
  "Return true if PREDICATE is false of every element of SEQ or SEQs.
\n(fn PREDICATE SEQ...)"
Richard M. Stallman's avatar
Richard M. Stallman committed
216 217
  (not (apply 'some cl-pred cl-seq cl-rest)))

218
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
219
(defun notevery (cl-pred cl-seq &rest cl-rest)
220 221
  "Return true if PREDICATE is false of some element of SEQ or SEQs.
\n(fn PREDICATE SEQ...)"
Richard M. Stallman's avatar
Richard M. Stallman committed
222 223 224
  (not (apply 'every cl-pred cl-seq cl-rest)))

;;; Support for `loop'.
225
;;;###autoload
226
(defalias 'cl-map-keymap 'map-keymap)
Richard M. Stallman's avatar
Richard M. Stallman committed
227

228
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
229 230
(defun cl-map-keymap-recursively (cl-func-rec cl-map &optional cl-base)
  (or cl-base
Dave Love's avatar
Dave Love committed
231
      (setq cl-base (copy-sequence [0])))
232
  (map-keymap
Richard M. Stallman's avatar
Richard M. Stallman committed
233 234 235 236 237 238
   (function
    (lambda (cl-key cl-bind)
      (aset cl-base (1- (length cl-base)) cl-key)
      (if (keymapp cl-bind)
	  (cl-map-keymap-recursively
	   cl-func-rec cl-bind
Dave Love's avatar
Dave Love committed
239
	   (vconcat cl-base (list 0)))
Richard M. Stallman's avatar
Richard M. Stallman committed
240 241 242
	(funcall cl-func-rec cl-base cl-bind))))
   cl-map))

243
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
244 245 246 247
(defun cl-map-intervals (cl-func &optional cl-what cl-prop cl-start cl-end)
  (or cl-what (setq cl-what (current-buffer)))
  (if (bufferp cl-what)
      (let (cl-mark cl-mark2 (cl-next t) cl-next2)
Dave Love's avatar
Dave Love committed
248
	(with-current-buffer cl-what
Richard M. Stallman's avatar
Richard M. Stallman committed
249 250 251
	  (setq cl-mark (copy-marker (or cl-start (point-min))))
	  (setq cl-mark2 (and cl-end (copy-marker cl-end))))
	(while (and cl-next (or (not cl-mark2) (< cl-mark cl-mark2)))
Dave Love's avatar
Dave Love committed
252 253 254 255 256
	  (setq cl-next (if cl-prop (next-single-property-change
				     cl-mark cl-prop cl-what)
			  (next-property-change cl-mark cl-what))
		cl-next2 (or cl-next (with-current-buffer cl-what
				       (point-max))))
Richard M. Stallman's avatar
Richard M. Stallman committed
257 258 259 260 261 262 263
	  (funcall cl-func (prog1 (marker-position cl-mark)
			     (set-marker cl-mark cl-next2))
		   (if cl-mark2 (min cl-next2 cl-mark2) cl-next2)))
	(set-marker cl-mark nil) (if cl-mark2 (set-marker cl-mark2 nil)))
    (or cl-start (setq cl-start 0))
    (or cl-end (setq cl-end (length cl-what)))
    (while (< cl-start cl-end)
Dave Love's avatar
Dave Love committed
264 265 266
      (let ((cl-next (or (if cl-prop (next-single-property-change
				      cl-start cl-prop cl-what)
			   (next-property-change cl-start cl-what))
Richard M. Stallman's avatar
Richard M. Stallman committed
267 268 269 270
			 cl-end)))
	(funcall cl-func cl-start (min cl-next cl-end))
	(setq cl-start cl-next)))))

271
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
272 273 274 275 276 277
(defun cl-map-overlays (cl-func &optional cl-buffer cl-start cl-end cl-arg)
  (or cl-buffer (setq cl-buffer (current-buffer)))
  (if (fboundp 'overlay-lists)

      ;; This is the preferred algorithm, though overlay-lists is undocumented.
      (let (cl-ovl)
Dave Love's avatar
Dave Love committed
278
	(with-current-buffer cl-buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
279 280 281 282 283 284 285 286 287 288 289 290 291 292
	  (setq cl-ovl (overlay-lists))
	  (if cl-start (setq cl-start (copy-marker cl-start)))
	  (if cl-end (setq cl-end (copy-marker cl-end))))
	(setq cl-ovl (nconc (car cl-ovl) (cdr cl-ovl)))
	(while (and cl-ovl
		    (or (not (overlay-start (car cl-ovl)))
			(and cl-end (>= (overlay-start (car cl-ovl)) cl-end))
			(and cl-start (<= (overlay-end (car cl-ovl)) cl-start))
			(not (funcall cl-func (car cl-ovl) cl-arg))))
	  (setq cl-ovl (cdr cl-ovl)))
	(if cl-start (set-marker cl-start nil))
	(if cl-end (set-marker cl-end nil)))

    ;; This alternate algorithm fails to find zero-length overlays.
Dave Love's avatar
Dave Love committed
293 294 295 296
    (let ((cl-mark (with-current-buffer cl-buffer
		     (copy-marker (or cl-start (point-min)))))
	  (cl-mark2 (and cl-end (with-current-buffer cl-buffer
				  (copy-marker cl-end))))
Richard M. Stallman's avatar
Richard M. Stallman committed
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
	  cl-pos cl-ovl)
      (while (save-excursion
	       (and (setq cl-pos (marker-position cl-mark))
		    (< cl-pos (or cl-mark2 (point-max)))
		    (progn
		      (set-buffer cl-buffer)
		      (setq cl-ovl (overlays-at cl-pos))
		      (set-marker cl-mark (next-overlay-change cl-pos)))))
	(while (and cl-ovl
		    (or (/= (overlay-start (car cl-ovl)) cl-pos)
			(not (and (funcall cl-func (car cl-ovl) cl-arg)
				  (set-marker cl-mark nil)))))
	  (setq cl-ovl (cdr cl-ovl))))
      (set-marker cl-mark nil) (if cl-mark2 (set-marker cl-mark2 nil)))))

;;; Support for `setf'.
313
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
314 315 316 317 318 319 320 321
(defun cl-set-frame-visible-p (frame val)
  (cond ((null val) (make-frame-invisible frame))
	((eq val 'icon) (iconify-frame frame))
	(t (make-frame-visible frame)))
  val)

;;; Support for `progv'.
(defvar cl-progv-save)
322
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
323 324
(defun cl-progv-before (syms values)
  (while syms
325
    (push (if (boundp (car syms))
Richard M. Stallman's avatar
Richard M. Stallman committed
326 327 328
		 (cons (car syms) (symbol-value (car syms)))
	       (car syms)) cl-progv-save)
    (if values
329 330
	(set (pop syms) (pop values))
      (makunbound (pop syms)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
331 332 333 334 335 336

(defun cl-progv-after ()
  (while cl-progv-save
    (if (consp (car cl-progv-save))
	(set (car (car cl-progv-save)) (cdr (car cl-progv-save)))
      (makunbound (car cl-progv-save)))
337
    (pop cl-progv-save)))
Richard M. Stallman's avatar
Richard M. Stallman committed
338 339 340 341


;;; Numbers.

342
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
343 344
(defun gcd (&rest args)
  "Return the greatest common divisor of the arguments."
345
  (let ((a (abs (or (pop args) 0))))
Richard M. Stallman's avatar
Richard M. Stallman committed
346
    (while args
347
      (let ((b (abs (pop args))))
Richard M. Stallman's avatar
Richard M. Stallman committed
348 349 350
	(while (> b 0) (setq b (% a (setq a b))))))
    a))

351
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
352 353 354 355
(defun lcm (&rest args)
  "Return the least common multiple of the arguments."
  (if (memq 0 args)
      0
356
    (let ((a (abs (or (pop args) 1))))
Richard M. Stallman's avatar
Richard M. Stallman committed
357
      (while args
358
	(let ((b (abs (pop args))))
Richard M. Stallman's avatar
Richard M. Stallman committed
359 360 361
	  (setq a (* (/ a (gcd a b)) b))))
      a)))

362
;;;###autoload
363
(defun isqrt (x)
Richard M. Stallman's avatar
Richard M. Stallman committed
364
  "Return the integer square root of the argument."
365 366 367
  (if (and (integerp x) (> x 0))
      (let ((g (cond ((<= x 100) 10) ((<= x 10000) 100)
		     ((<= x 1000000) 1000) (t x)))
Richard M. Stallman's avatar
Richard M. Stallman committed
368
	    g2)
369
	(while (< (setq g2 (/ (+ g (/ x g)) 2)) g)
Richard M. Stallman's avatar
Richard M. Stallman committed
370 371
	  (setq g g2))
	g)
372
    (if (eq x 0) 0 (signal 'arith-error nil))))
Richard M. Stallman's avatar
Richard M. Stallman committed
373

374
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
375 376 377
(defun floor* (x &optional y)
  "Return a list of the floor of X and the fractional part of X.
With two arguments, return floor and remainder of their quotient."
378 379
  (let ((q (floor x y)))
    (list q (- x (if y (* y q) q)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
380

381
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
382 383 384 385 386 387 388
(defun ceiling* (x &optional y)
  "Return a list of the ceiling of X and the fractional part of X.
With two arguments, return ceiling and remainder of their quotient."
  (let ((res (floor* x y)))
    (if (= (car (cdr res)) 0) res
      (list (1+ (car res)) (- (car (cdr res)) (or y 1))))))

389
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
390 391 392 393 394 395
(defun truncate* (x &optional y)
  "Return a list of the integer part of X and the fractional part of X.
With two arguments, return truncation and remainder of their quotient."
  (if (eq (>= x 0) (or (null y) (>= y 0)))
      (floor* x y) (ceiling* x y)))

396
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
(defun round* (x &optional y)
  "Return a list of X rounded to the nearest integer and the remainder.
With two arguments, return rounding and remainder of their quotient."
  (if y
      (if (and (integerp x) (integerp y))
	  (let* ((hy (/ y 2))
		 (res (floor* (+ x hy) y)))
	    (if (and (= (car (cdr res)) 0)
		     (= (+ hy hy) y)
		     (/= (% (car res) 2) 0))
		(list (1- (car res)) hy)
	      (list (car res) (- (car (cdr res)) hy))))
	(let ((q (round (/ x y))))
	  (list q (- x (* q y)))))
    (if (integerp x) (list x 0)
      (let ((q (round x)))
	(list q (- x q))))))

415
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
416 417 418 419
(defun mod* (x y)
  "The remainder of X divided by Y, with the same sign as Y."
  (nth 1 (floor* x y)))

420
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
421 422 423 424
(defun rem* (x y)
  "The remainder of X divided by Y, with the same sign as X."
  (nth 1 (truncate* x y)))

425
;;;###autoload
426 427 428
(defun signum (x)
  "Return 1 if X is positive, -1 if negative, 0 if zero."
  (cond ((> x 0) 1) ((< x 0) -1) (t 0)))
Richard M. Stallman's avatar
Richard M. Stallman committed
429 430 431 432 433


;; Random numbers.

(defvar *random-state*)
434
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
435 436 437 438 439 440 441
(defun random* (lim &optional state)
  "Return a random nonnegative number less than LIM, an integer or float.
Optional second arg STATE is a random-state object."
  (or state (setq state *random-state*))
  ;; Inspired by "ran3" from Numerical Recipes.  Additive congruential method.
  (let ((vec (aref state 3)))
    (if (integerp vec)
442
	(let ((i 0) (j (- 1357335 (% (abs vec) 1357333))) (k 1))
Richard M. Stallman's avatar
Richard M. Stallman committed
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
	  (aset state 3 (setq vec (make-vector 55 nil)))
	  (aset vec 0 j)
	  (while (> (setq i (% (+ i 21) 55)) 0)
	    (aset vec i (setq j (prog1 k (setq k (- j k))))))
	  (while (< (setq i (1+ i)) 200) (random* 2 state))))
    (let* ((i (aset state 1 (% (1+ (aref state 1)) 55)))
	   (j (aset state 2 (% (1+ (aref state 2)) 55)))
	   (n (logand 8388607 (aset vec i (- (aref vec i) (aref vec j))))))
      (if (integerp lim)
	  (if (<= lim 512) (% n lim)
	    (if (> lim 8388607) (setq n (+ (lsh n 9) (random* 512 state))))
	    (let ((mask 1023))
	      (while (< mask (1- lim)) (setq mask (1+ (+ mask mask))))
	      (if (< (setq n (logand n mask)) lim) n (random* lim state))))
	(* (/ n '8388608e0) lim)))))

459
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
460 461 462 463 464 465 466 467
(defun make-random-state (&optional state)
  "Return a copy of random-state STATE, or of `*random-state*' if omitted.
If STATE is t, return a new state object seeded from the time of day."
  (cond ((null state) (make-random-state *random-state*))
	((vectorp state) (cl-copy-tree state t))
	((integerp state) (vector 'cl-random-state-tag -1 30 state))
	(t (make-random-state (cl-random-time)))))

468
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
(defun random-state-p (object)
  "Return t if OBJECT is a random-state object."
  (and (vectorp object) (= (length object) 4)
       (eq (aref object 0) 'cl-random-state-tag)))


;; Implementation limits.

(defun cl-finite-do (func a b)
  (condition-case err
      (let ((res (funcall func a b)))   ; check for IEEE infinity
	(and (numberp res) (/= res (/ res 2)) res))
    (arith-error nil)))

(defvar most-positive-float)
(defvar most-negative-float)
(defvar least-positive-float)
(defvar least-negative-float)
(defvar least-positive-normalized-float)
(defvar least-negative-normalized-float)
(defvar float-epsilon)
(defvar float-negative-epsilon)

492
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
(defun cl-float-limits ()
  (or most-positive-float (not (numberp '2e1))
      (let ((x '2e0) y z)
	;; Find maximum exponent (first two loops are optimizations)
	(while (cl-finite-do '* x x) (setq x (* x x)))
	(while (cl-finite-do '* x (/ x 2)) (setq x (* x (/ x 2))))
	(while (cl-finite-do '+ x x) (setq x (+ x x)))
	(setq z x y (/ x 2))
	;; Now fill in 1's in the mantissa.
	(while (and (cl-finite-do '+ x y) (/= (+ x y) x))
	  (setq x (+ x y) y (/ y 2)))
	(setq most-positive-float x
	      most-negative-float (- x))
	;; Divide down until mantissa starts rounding.
	(setq x (/ x z) y (/ 16 z) x (* x y))
	(while (condition-case err (and (= x (* (/ x 2) 2)) (> (/ y 2) 0))
		 (arith-error nil))
	  (setq x (/ x 2) y (/ y 2)))
	(setq least-positive-normalized-float y
	      least-negative-normalized-float (- y))
	;; Divide down until value underflows to zero.
	(setq x (/ 1 z) y x)
	(while (condition-case err (> (/ x 2) 0) (arith-error nil))
	  (setq x (/ x 2)))
	(setq least-positive-float x
	      least-negative-float (- x))
	(setq x '1e0)
	(while (/= (+ '1e0 x) '1e0) (setq x (/ x 2)))
	(setq float-epsilon (* x 2))
	(setq x '1e0)
	(while (/= (- '1e0 x) '1e0) (setq x (/ x 2)))
	(setq float-negative-epsilon (* x 2))))
  nil)


;;; Sequence functions.

530
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
531 532 533 534 535 536 537 538 539 540 541 542 543
(defun subseq (seq start &optional end)
  "Return the subsequence of SEQ from START to END.
If END is omitted, it defaults to the length of the sequence.
If START or END is negative, it counts from the end."
  (if (stringp seq) (substring seq start end)
    (let (len)
      (and end (< end 0) (setq end (+ end (setq len (length seq)))))
      (if (< start 0) (setq start (+ start (or len (setq len (length seq))))))
      (cond ((listp seq)
	     (if (> start 0) (setq seq (nthcdr start seq)))
	     (if end
		 (let ((res nil))
		   (while (>= (setq end (1- end)) start)
544
		     (push (pop seq) res))
Richard M. Stallman's avatar
Richard M. Stallman committed
545 546 547 548 549 550 551 552 553 554 555
		   (nreverse res))
	       (copy-sequence seq)))
	    (t
	     (or end (setq end (or len (length seq))))
	     (let ((res (make-vector (max (- end start) 0) nil))
		   (i 0))
	       (while (< start end)
		 (aset res i (aref seq start))
		 (setq i (1+ i) start (1+ start)))
	       res))))))

556
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
557
(defun concatenate (type &rest seqs)
558 559
  "Concatenate, into a sequence of type TYPE, the argument SEQUENCEs.
\n(fn TYPE SEQUENCE...)"
Richard M. Stallman's avatar
Richard M. Stallman committed
560 561 562 563 564 565 566 567
  (cond ((eq type 'vector) (apply 'vconcat seqs))
	((eq type 'string) (apply 'concat seqs))
	((eq type 'list) (apply 'append (append seqs '(nil))))
	(t (error "Not a sequence type name: %s" type))))


;;; List functions.

568
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
569 570 571 572
(defun revappend (x y)
  "Equivalent to (append (reverse X) Y)."
  (nconc (reverse x) y))

573
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
574 575 576 577
(defun nreconc (x y)
  "Equivalent to (nconc (nreverse X) Y)."
  (nconc (nreverse x) y))

578
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
579
(defun list-length (x)
580
  "Return the length of list X.  Return nil if list is circular."
Richard M. Stallman's avatar
Richard M. Stallman committed
581 582 583 584 585
  (let ((n 0) (fast x) (slow x))
    (while (and (cdr fast) (not (and (eq fast slow) (> n 0))))
      (setq n (+ n 2) fast (cdr (cdr fast)) slow (cdr slow)))
    (if fast (if (cdr fast) nil (1+ n)) n)))

586
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
587 588 589 590 591 592
(defun tailp (sublist list)
  "Return true if SUBLIST is a tail of LIST."
  (while (and (consp list) (not (eq sublist list)))
    (setq list (cdr list)))
  (if (numberp sublist) (equal sublist list) (eq sublist list)))

593
(defalias 'cl-copy-tree 'copy-tree)
Richard M. Stallman's avatar
Richard M. Stallman committed
594 595 596 597


;;; Property lists.

598
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
599
(defun get* (sym tag &optional def)    ; See compiler macro in cl-macs.el
600 601
  "Return the value of SYMBOL's PROPNAME property, or DEFAULT if none.
\n(fn SYMBOL PROPNAME &optional DEFAULT)"
Richard M. Stallman's avatar
Richard M. Stallman committed
602 603 604 605 606 607 608
  (or (get sym tag)
      (and def
	   (let ((plist (symbol-plist sym)))
	     (while (and plist (not (eq (car plist) tag)))
	       (setq plist (cdr (cdr plist))))
	     (if plist (car (cdr plist)) def)))))

609
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
610 611
(defun getf (plist tag &optional def)
  "Search PROPLIST for property PROPNAME; return its value or DEFAULT.
612 613
PROPLIST is a list of the sort returned by `symbol-plist'.
\n(fn PROPLIST PROPNAME &optional DEFAULT)"
Richard M. Stallman's avatar
Richard M. Stallman committed
614 615
  (setplist '--cl-getf-symbol-- plist)
  (or (get '--cl-getf-symbol-- tag)
Karl Heuer's avatar
Karl Heuer committed
616 617 618 619 620 621 622
      ;; Originally we called get* here,
      ;; but that fails, because get* has a compiler macro
      ;; definition that uses getf!
      (when def
	(while (and plist (not (eq (car plist) tag)))
	  (setq plist (cdr (cdr plist))))
	(if plist (car (cdr plist)) def))))
Richard M. Stallman's avatar
Richard M. Stallman committed
623

624
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
625 626 627 628 629
(defun cl-set-getf (plist tag val)
  (let ((p plist))
    (while (and p (not (eq (car p) tag))) (setq p (cdr (cdr p))))
    (if p (progn (setcar (cdr p) val) plist) (list* tag val plist))))

630
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
631 632 633 634 635
(defun cl-do-remf (plist tag)
  (let ((p (cdr plist)))
    (while (and (cdr p) (not (eq (car (cdr p)) tag))) (setq p (cdr (cdr p))))
    (and (cdr p) (progn (setcdr p (cdr (cdr (cdr p)))) t))))

636
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
637
(defun cl-remprop (sym tag)
638 639
  "Remove from SYMBOL's plist the property PROPNAME and its value.
\n(fn SYMBOL PROPNAME)"
Richard M. Stallman's avatar
Richard M. Stallman committed
640 641 642 643
  (let ((plist (symbol-plist sym)))
    (if (and plist (eq tag (car plist)))
	(progn (setplist sym (cdr (cdr plist))) t)
      (cl-do-remf plist tag))))
644
;;;###autoload
Dave Love's avatar
Dave Love committed
645
(defalias 'remprop 'cl-remprop)
Richard M. Stallman's avatar
Richard M. Stallman committed
646 647 648 649



;;; Hash tables.
650
;; This is just kept for compatibility with code byte-compiled by Emacs-20.
Richard M. Stallman's avatar
Richard M. Stallman committed
651

652
;; No idea if this might still be needed.
Richard M. Stallman's avatar
Richard M. Stallman committed
653
(defun cl-not-hash-table (x &optional y &rest z)
Dave Love's avatar
Dave Love committed
654
  (signal 'wrong-type-argument (list 'cl-hash-table-p (or y x))))
Richard M. Stallman's avatar
Richard M. Stallman committed
655

656 657 658 659 660
(defvar cl-builtin-gethash (symbol-function 'gethash))
(defvar cl-builtin-remhash (symbol-function 'remhash))
(defvar cl-builtin-clrhash (symbol-function 'clrhash))
(defvar cl-builtin-maphash (symbol-function 'maphash))

661
;;;###autoload
662
(defalias 'cl-gethash 'gethash)
663
;;;###autoload
664
(defalias 'cl-puthash 'puthash)
665
;;;###autoload
666
(defalias 'cl-remhash 'remhash)
667
;;;###autoload
668
(defalias 'cl-clrhash 'clrhash)
669
;;;###autoload
670 671
(defalias 'cl-maphash 'maphash)
;; These three actually didn't exist in Emacs-20.
672
;;;###autoload
673
(defalias 'cl-make-hash-table 'make-hash-table)
674
;;;###autoload
675
(defalias 'cl-hash-table-p 'hash-table-p)
676
;;;###autoload
677
(defalias 'cl-hash-table-count 'hash-table-count)
Richard M. Stallman's avatar
Richard M. Stallman committed
678 679 680 681 682 683 684 685 686 687

;;; Some debugging aids.

(defun cl-prettyprint (form)
  "Insert a pretty-printed rendition of a Lisp FORM in current buffer."
  (let ((pt (point)) last)
    (insert "\n" (prin1-to-string form) "\n")
    (setq last (point))
    (goto-char (1+ pt))
    (while (search-forward "(quote " last t)
688
      (delete-char -7)
Richard M. Stallman's avatar
Richard M. Stallman committed
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
      (insert "'")
      (forward-sexp)
      (delete-char 1))
    (goto-char (1+ pt))
    (cl-do-prettyprint)))

(defun cl-do-prettyprint ()
  (skip-chars-forward " ")
  (if (looking-at "(")
      (let ((skip (or (looking-at "((") (looking-at "(prog")
		      (looking-at "(unwind-protect ")
		      (looking-at "(function (")
		      (looking-at "(cl-block-wrapper ")))
	    (two (or (looking-at "(defun ") (looking-at "(defmacro ")))
	    (let (or (looking-at "(let\\*? ") (looking-at "(while ")))
	    (set (looking-at "(p?set[qf] ")))
	(if (or skip let
		(progn
		  (forward-sexp)
		  (and (>= (current-column) 78) (progn (backward-sexp) t))))
	    (let ((nl t))
	      (forward-char 1)
	      (cl-do-prettyprint)
	      (or skip (looking-at ")") (cl-do-prettyprint))
	      (or (not two) (looking-at ")") (cl-do-prettyprint))
	      (while (not (looking-at ")"))
		(if set (setq nl (not nl)))
		(if nl (insert "\n"))
		(lisp-indent-line)
		(cl-do-prettyprint))
	      (forward-char 1))))
    (forward-sexp)))

(defvar cl-macroexpand-cmacs nil)
(defvar cl-closure-vars nil)

725
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
726 727 728 729 730 731 732 733 734 735 736 737
(defun cl-macroexpand-all (form &optional env)
  "Expand all macro calls through a Lisp FORM.
This also does some trivial optimizations to make the form prettier."
  (while (or (not (eq form (setq form (macroexpand form env))))
	     (and cl-macroexpand-cmacs
		  (not (eq form (setq form (compiler-macroexpand form)))))))
  (cond ((not (consp form)) form)
	((memq (car form) '(let let*))
	 (if (null (nth 1 form))
	     (cl-macroexpand-all (cons 'progn (cddr form)) env)
	   (let ((letf nil) (res nil) (lets (cadr form)))
	     (while lets
738
	       (push (if (consp (car lets))
Richard M. Stallman's avatar
Richard M. Stallman committed
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
			    (let ((exp (cl-macroexpand-all (caar lets) env)))
			      (or (symbolp exp) (setq letf t))
			      (cons exp (cl-macroexpand-body (cdar lets) env)))
			  (let ((exp (cl-macroexpand-all (car lets) env)))
			    (if (symbolp exp) exp
			      (setq letf t) (list exp nil)))) res)
	       (setq lets (cdr lets)))
	     (list* (if letf (if (eq (car form) 'let) 'letf 'letf*) (car form))
		    (nreverse res) (cl-macroexpand-body (cddr form) env)))))
	((eq (car form) 'cond)
	 (cons (car form)
	       (mapcar (function (lambda (x) (cl-macroexpand-body x env)))
		       (cdr form))))
	((eq (car form) 'condition-case)
	 (list* (car form) (nth 1 form) (cl-macroexpand-all (nth 2 form) env)
		(mapcar (function
			 (lambda (x)
			   (cons (car x) (cl-macroexpand-body (cdr x) env))))
			(cdddr form))))
	((memq (car form) '(quote function))
	 (if (eq (car-safe (nth 1 form)) 'lambda)
	     (let ((body (cl-macroexpand-body (cddadr form) env)))
	       (if (and cl-closure-vars (eq (car form) 'function)
			(cl-expr-contains-any body cl-closure-vars))
		   (let* ((new (mapcar 'gensym cl-closure-vars))
			  (sub (pairlis cl-closure-vars new)) (decls nil))
		     (while (or (stringp (car body))
				(eq (car-safe (car body)) 'interactive))
767
		       (push (list 'quote (pop body)) decls))
Richard M. Stallman's avatar
Richard M. Stallman committed
768 769 770 771 772 773
		     (put (car (last cl-closure-vars)) 'used t)
		     (append
		      (list 'list '(quote lambda) '(quote (&rest --cl-rest--)))
		      (sublis sub (nreverse decls))
		      (list
		       (list* 'list '(quote apply)
774 775 776 777
			      (list 'function
				    (list* 'lambda
					   (append new (cadadr form))
					   (sublis sub body)))
Richard M. Stallman's avatar
Richard M. Stallman committed
778 779 780 781 782 783
			      (nconc (mapcar (function
					      (lambda (x)
						(list 'list '(quote quote) x)))
					     cl-closure-vars)
				     '((quote --cl-rest--)))))))
		 (list (car form) (list* 'lambda (cadadr form) body))))
784
	   (let ((found (assq (cadr form) env)))
Stefan Monnier's avatar
Stefan Monnier committed
785 786
	     (if (and found (ignore-errors
			      (eq (cadr (caddr found)) 'cl-labels-args)))
787 788
		 (cl-macroexpand-all (cadr (caddr (cadddr found))) env)
	       form))))
Richard M. Stallman's avatar
Richard M. Stallman committed
789 790 791 792 793 794 795 796
	((memq (car form) '(defun defmacro))
	 (list* (car form) (nth 1 form) (cl-macroexpand-body (cddr form) env)))
	((and (eq (car form) 'progn) (not (cddr form)))
	 (cl-macroexpand-all (nth 1 form) env))
	((eq (car form) 'setq)
	 (let* ((args (cl-macroexpand-body (cdr form) env)) (p args))
	   (while (and p (symbolp (car p))) (setq p (cddr p)))
	   (if p (cl-macroexpand-all (cons 'setf args)) (cons 'setq args))))
797 798 799 800 801
        ((consp (car form))
         (cl-macroexpand-all (list* 'funcall
                                    (list 'function (car form))
                                    (cdr form))
                             env))
Richard M. Stallman's avatar
Richard M. Stallman committed
802 803 804 805 806
	(t (cons (car form) (cl-macroexpand-body (cdr form) env)))))

(defun cl-macroexpand-body (body &optional env)
  (mapcar (function (lambda (x) (cl-macroexpand-all x env))) body))

807
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
808 809 810 811 812 813 814 815 816 817 818 819 820 821
(defun cl-prettyexpand (form &optional full)
  (message "Expanding...")
  (let ((cl-macroexpand-cmacs full) (cl-compiling-file full)
	(byte-compile-macro-environment nil))
    (setq form (cl-macroexpand-all form
				   (and (not full) '((block) (eval-when)))))
    (message "Formatting...")
    (prog1 (cl-prettyprint form)
      (message ""))))



(run-hooks 'cl-extra-load-hook)

822
;; Local variables:
Glenn Morris's avatar
Glenn Morris committed
823 824
;; byte-compile-dynamic: t
;; byte-compile-warnings: (not cl-functions)
825 826 827
;; generated-autoload-file: "cl-loaddefs.el"
;; End:

828
;; arch-tag: bcd03437-0871-43fb-a8f1-ad0e0b5427ed
Richard M. Stallman's avatar
Richard M. Stallman committed
829
;;; cl-extra.el ends here