cl-extra.el 23 KB
Newer Older
1
;;; cl-extra.el --- Common Lisp features, part 2  -*- lexical-binding: t -*-
Richard M. Stallman's avatar
Richard M. Stallman committed
2

3
;; Copyright (C) 1993, 2000-2012 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4 5 6

;; Author: Dave Gillespie <daveg@synaptics.com>
;; Keywords: extensions
7
;; Package: emacs
Richard M. Stallman's avatar
Richard M. Stallman committed
8 9 10

;; 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-lib)
Richard M. Stallman's avatar
Richard M. Stallman committed
41 42 43

;;; Type coercion.

44
;;;###autoload
45
(defun cl-coerce (x type)
Richard M. Stallman's avatar
Richard M. Stallman committed
46
  "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
  (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))
54
	((and (eq type 'character) (symbolp x)) (cl-coerce (symbol-name x) type))
Richard M. Stallman's avatar
Richard M. Stallman committed
55
	((eq type 'float) (float x))
56
	((cl-typep x type) x)
Richard M. Stallman's avatar
Richard M. Stallman committed
57 58 59 60 61
	(t (error "Can't coerce %s to type %s" x type))))


;;; Predicates.

62
;;;###autoload
63
(defun cl-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
	 (while (and (consp x) (consp y) (cl-equalp (car x) (car y)))
77
	   (setq x (cdr x) y (cdr y)))
78
	 (and (not (consp x)) (cl-equalp x y)))
Richard M. Stallman's avatar
Richard M. Stallman committed
79 80 81 82
	((vectorp x)
	 (and (vectorp y) (= (length x) (length y))
	      (let ((i (length x)))
		(while (and (>= (setq i (1- i)) 0)
83
			    (cl-equalp (aref x i) (aref y i))))
Richard M. Stallman's avatar
Richard M. Stallman committed
84 85 86 87 88 89
		(< i 0))))
	(t (equal x y))))


;;; Control structures.

90
;;;###autoload
91
(defun cl--mapcar-many (cl-func cl-seqs)
Richard M. Stallman's avatar
Richard M. Stallman committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
  (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
	  (push (funcall cl-func
118 119 120
                         (if (consp cl-x) (pop cl-x) (aref cl-x cl-i))
                         (if (consp cl-y) (pop cl-y) (aref cl-y cl-i)))
                cl-res)))
Richard M. Stallman's avatar
Richard M. Stallman committed
121 122
      (nreverse cl-res))))

123
;;;###autoload
124
(defun cl-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...)"
128 129
  (let ((cl-res (apply 'cl-mapcar cl-func cl-seq cl-rest)))
    (and cl-type (cl-coerce cl-res cl-type))))
Richard M. Stallman's avatar
Richard M. Stallman committed
130

131
;;;###autoload
132
(defun cl-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
156
      (progn (apply 'cl-map nil cl-func cl-seq cl-rest)
Dave Love's avatar
Dave Love committed
157
	     cl-seq)
158
    (mapc cl-func cl-seq)))
Richard M. Stallman's avatar
Richard M. Stallman committed
159

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

170
;;;###autoload
171
(defun cl-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...)"
174
  (apply 'nconc (apply 'cl-mapcar cl-func cl-seq cl-rest)))
Richard M. Stallman's avatar
Richard M. Stallman committed
175

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

182
;;;###autoload
183
(defun cl-some (cl-pred cl-seq &rest cl-rest)
Richard M. Stallman's avatar
Richard M. Stallman committed
184
  "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
  (if (or cl-rest (nlistp cl-seq))
      (catch 'cl-some
189
	(apply 'cl-map nil
Richard M. Stallman's avatar
Richard M. Stallman committed
190 191 192 193 194
	       (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
199
(defun cl-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
  (if (or cl-rest (nlistp cl-seq))
      (catch 'cl-every
204
	(apply 'cl-map nil
Richard M. Stallman's avatar
Richard M. Stallman committed
205 206 207 208 209 210 211
	       (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
213
(defun cl-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...)"
216
  (not (apply 'cl-some cl-pred cl-seq cl-rest)))
Richard M. Stallman's avatar
Richard M. Stallman committed
217

218
;;;###autoload
219
(defun cl-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...)"
222
  (not (apply 'cl-every cl-pred cl-seq cl-rest)))
Richard M. Stallman's avatar
Richard M. Stallman committed
223

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

239
;;;###autoload
240
(defun cl--map-intervals (cl-func &optional cl-what cl-prop cl-start cl-end)
Richard M. Stallman's avatar
Richard M. Stallman committed
241 242 243
  (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
244
	(with-current-buffer cl-what
Richard M. Stallman's avatar
Richard M. Stallman committed
245 246 247
	  (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
248 249 250 251 252
	  (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
253 254 255 256 257 258 259
	  (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
260 261 262
      (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
263 264 265 266
			 cl-end)))
	(funcall cl-func cl-start (min cl-next cl-end))
	(setq cl-start cl-next)))))

267
;;;###autoload
268
(defun cl--map-overlays (cl-func &optional cl-buffer cl-start cl-end cl-arg)
Richard M. Stallman's avatar
Richard M. Stallman committed
269 270 271 272 273
  (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
274
	(with-current-buffer cl-buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
275 276 277 278 279 280 281 282 283 284 285 286 287 288
	  (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
289 290 291 292
    (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
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
	  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)))))

308
;;; Support for `setf'.
309
;;;###autoload
310
(defun cl--set-frame-visible-p (frame val)
Richard M. Stallman's avatar
Richard M. Stallman committed
311 312 313 314 315
  (cond ((null val) (make-frame-invisible frame))
	((eq val 'icon) (iconify-frame frame))
	(t (make-frame-visible frame)))
  val)

316
;;; Support for `cl-progv'.
317
(defvar cl--progv-save)
318
;;;###autoload
319
(defun cl--progv-before (syms values)
Richard M. Stallman's avatar
Richard M. Stallman committed
320
  (while syms
321
    (push (if (boundp (car syms))
Richard M. Stallman's avatar
Richard M. Stallman committed
322
		 (cons (car syms) (symbol-value (car syms)))
323
	       (car syms)) cl--progv-save)
Richard M. Stallman's avatar
Richard M. Stallman committed
324
    (if values
325 326
	(set (pop syms) (pop values))
      (makunbound (pop syms)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
327

328 329 330 331 332 333
(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)))
    (pop cl--progv-save)))
Richard M. Stallman's avatar
Richard M. Stallman committed
334 335 336 337


;;; Numbers.

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

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

358
;;;###autoload
359
(defun cl-isqrt (x)
Richard M. Stallman's avatar
Richard M. Stallman committed
360
  "Return the integer square root of the argument."
361 362 363
  (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
364
	    g2)
365
	(while (< (setq g2 (/ (+ g (/ x g)) 2)) g)
Richard M. Stallman's avatar
Richard M. Stallman committed
366 367
	  (setq g g2))
	g)
368
    (if (eq x 0) 0 (signal 'arith-error nil))))
Richard M. Stallman's avatar
Richard M. Stallman committed
369

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

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

385
;;;###autoload
386
(defun cl-truncate (x &optional y)
Richard M. Stallman's avatar
Richard M. Stallman committed
387 388 389
  "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)))
390
      (cl-floor x y) (cl-ceiling x y)))
Richard M. Stallman's avatar
Richard M. Stallman committed
391

392
;;;###autoload
393
(defun cl-round (x &optional y)
Richard M. Stallman's avatar
Richard M. Stallman committed
394 395 396 397 398
  "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))
399
		 (res (cl-floor (+ x hy) y)))
Richard M. Stallman's avatar
Richard M. Stallman committed
400 401 402 403 404 405 406 407 408 409 410
	    (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))))))

411
;;;###autoload
412
(defun cl-mod (x y)
Richard M. Stallman's avatar
Richard M. Stallman committed
413
  "The remainder of X divided by Y, with the same sign as Y."
414
  (nth 1 (cl-floor x y)))
Richard M. Stallman's avatar
Richard M. Stallman committed
415

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

421
;;;###autoload
422
(defun cl-signum (x)
423 424
  "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
425 426 427 428


;; Random numbers.

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

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

463
;;;###autoload
464
(defun cl-random-state-p (object)
Richard M. Stallman's avatar
Richard M. Stallman committed
465 466 467 468 469 470 471
  "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.

472 473
(defun cl--finite-do (func a b)
  (condition-case _
Richard M. Stallman's avatar
Richard M. Stallman committed
474 475 476 477
      (let ((res (funcall func a b)))   ; check for IEEE infinity
	(and (numberp res) (/= res (/ res 2)) res))
    (arith-error nil)))

478
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
479
(defun cl-float-limits ()
480
  "Initialize the Common Lisp floating-point parameters.
481 482 483 484 485
This sets the values of: `cl-most-positive-float', `cl-most-negative-float',
`cl-least-positive-float', `cl-least-negative-float', `cl-float-epsilon',
`cl-float-negative-epsilon', `cl-least-positive-normalized-float', and
`cl-least-negative-normalized-float'."
  (or cl-most-positive-float (not (numberp '2e1))
Richard M. Stallman's avatar
Richard M. Stallman committed
486 487
      (let ((x '2e0) y z)
	;; Find maximum exponent (first two loops are optimizations)
488 489 490
	(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)))
Richard M. Stallman's avatar
Richard M. Stallman committed
491
	(setq z x y (/ x 2))
492
	;; Now cl-fill in 1's in the mantissa.
493
	(while (and (cl--finite-do '+ x y) (/= (+ x y) x))
Richard M. Stallman's avatar
Richard M. Stallman committed
494
	  (setq x (+ x y) y (/ y 2)))
495 496
	(setq cl-most-positive-float x
	      cl-most-negative-float (- x))
Richard M. Stallman's avatar
Richard M. Stallman committed
497 498
	;; Divide down until mantissa starts rounding.
	(setq x (/ x z) y (/ 16 z) x (* x y))
499
	(while (condition-case _ (and (= x (* (/ x 2) 2)) (> (/ y 2) 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
500 501
		 (arith-error nil))
	  (setq x (/ x 2) y (/ y 2)))
502 503
	(setq cl-least-positive-normalized-float y
	      cl-least-negative-normalized-float (- y))
Richard M. Stallman's avatar
Richard M. Stallman committed
504 505
	;; Divide down until value underflows to zero.
	(setq x (/ 1 z) y x)
506
	(while (condition-case _ (> (/ x 2) 0) (arith-error nil))
Richard M. Stallman's avatar
Richard M. Stallman committed
507
	  (setq x (/ x 2)))
508 509
	(setq cl-least-positive-float x
	      cl-least-negative-float (- x))
Richard M. Stallman's avatar
Richard M. Stallman committed
510 511
	(setq x '1e0)
	(while (/= (+ '1e0 x) '1e0) (setq x (/ x 2)))
512
	(setq cl-float-epsilon (* x 2))
Richard M. Stallman's avatar
Richard M. Stallman committed
513 514
	(setq x '1e0)
	(while (/= (- '1e0 x) '1e0) (setq x (/ x 2)))
515
	(setq cl-float-negative-epsilon (* x 2))))
Richard M. Stallman's avatar
Richard M. Stallman committed
516 517 518 519 520
  nil)


;;; Sequence functions.

521
;;;###autoload
522
(defun cl-subseq (seq start &optional end)
Richard M. Stallman's avatar
Richard M. Stallman committed
523 524 525 526 527 528 529 530 531 532 533 534
  "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)
535
		     (push (pop seq) res))
Richard M. Stallman's avatar
Richard M. Stallman committed
536 537 538 539 540 541 542 543 544 545 546
		   (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))))))

547
;;;###autoload
548
(defun cl-concatenate (type &rest seqs)
549 550
  "Concatenate, into a sequence of type TYPE, the argument SEQUENCEs.
\n(fn TYPE SEQUENCE...)"
Richard M. Stallman's avatar
Richard M. Stallman committed
551 552 553 554 555 556 557 558
  (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.

559
;;;###autoload
560
(defun cl-revappend (x y)
Richard M. Stallman's avatar
Richard M. Stallman committed
561 562 563
  "Equivalent to (append (reverse X) Y)."
  (nconc (reverse x) y))

564
;;;###autoload
565
(defun cl-nreconc (x y)
Richard M. Stallman's avatar
Richard M. Stallman committed
566 567 568
  "Equivalent to (nconc (nreverse X) Y)."
  (nconc (nreverse x) y))

569
;;;###autoload
570
(defun cl-list-length (x)
571
  "Return the length of list X.  Return nil if list is circular."
Richard M. Stallman's avatar
Richard M. Stallman committed
572 573 574 575 576
  (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)))

577
;;;###autoload
578
(defun cl-tailp (sublist list)
Richard M. Stallman's avatar
Richard M. Stallman committed
579 580 581 582 583 584 585
  "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)))

;;; Property lists.

586
;;;###autoload
587
(defun cl-get (sym tag &optional def)
588 589
  "Return the value of SYMBOL's PROPNAME property, or DEFAULT if none.
\n(fn SYMBOL PROPNAME &optional DEFAULT)"
590
  (declare (compiler-macro cl--compiler-macro-get))
Richard M. Stallman's avatar
Richard M. Stallman committed
591 592
  (or (get sym tag)
      (and def
593
           ;; Make sure `def' is really absent as opposed to set to nil.
Richard M. Stallman's avatar
Richard M. Stallman committed
594 595 596 597
	   (let ((plist (symbol-plist sym)))
	     (while (and plist (not (eq (car plist) tag)))
	       (setq plist (cdr (cdr plist))))
	     (if plist (car (cdr plist)) def)))))
598
(autoload 'cl--compiler-macro-get "cl-macs")
Richard M. Stallman's avatar
Richard M. Stallman committed
599

600
;;;###autoload
601
(defun cl-getf (plist tag &optional def)
Richard M. Stallman's avatar
Richard M. Stallman committed
602
  "Search PROPLIST for property PROPNAME; return its value or DEFAULT.
603 604
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
605 606
  (setplist '--cl-getf-symbol-- plist)
  (or (get '--cl-getf-symbol-- tag)
607 608
      ;; Originally we called cl-get here,
      ;; but that fails, because cl-get has a compiler macro
Karl Heuer's avatar
Karl Heuer committed
609 610
      ;; definition that uses getf!
      (when def
611
        ;; Make sure `def' is really absent as opposed to set to nil.
Karl Heuer's avatar
Karl Heuer committed
612 613 614
	(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
615

616
;;;###autoload
617
(defun cl--set-getf (plist tag val)
Richard M. Stallman's avatar
Richard M. Stallman committed
618 619
  (let ((p plist))
    (while (and p (not (eq (car p) tag))) (setq p (cdr (cdr p))))
620
    (if p (progn (setcar (cdr p) val) plist) (cl-list* tag val plist))))
Richard M. Stallman's avatar
Richard M. Stallman committed
621

622
;;;###autoload
623
(defun cl--do-remf (plist tag)
Richard M. Stallman's avatar
Richard M. Stallman committed
624 625 626 627
  (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))))

628
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
629
(defun cl-remprop (sym tag)
630 631
  "Remove from SYMBOL's plist the property PROPNAME and its value.
\n(fn SYMBOL PROPNAME)"
Richard M. Stallman's avatar
Richard M. Stallman committed
632 633 634
  (let ((plist (symbol-plist sym)))
    (if (and plist (eq tag (car plist)))
	(progn (setplist sym (cdr (cdr plist))) t)
635
      (cl--do-remf plist tag))))
Richard M. Stallman's avatar
Richard M. Stallman committed
636 637 638 639 640 641 642 643 644 645

;;; 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)
646
      (delete-char -7)
Richard M. Stallman's avatar
Richard M. Stallman committed
647 648 649 650
      (insert "'")
      (forward-sexp)
      (delete-char 1))
    (goto-char (1+ pt))
651
    (cl--do-prettyprint)))
Richard M. Stallman's avatar
Richard M. Stallman committed
652

653
(defun cl--do-prettyprint ()
Richard M. Stallman's avatar
Richard M. Stallman committed
654 655 656 657 658
  (skip-chars-forward " ")
  (if (looking-at "(")
      (let ((skip (or (looking-at "((") (looking-at "(prog")
		      (looking-at "(unwind-protect ")
		      (looking-at "(function (")
659
		      (looking-at "(cl--block-wrapper ")))
Richard M. Stallman's avatar
Richard M. Stallman committed
660 661 662 663 664 665 666 667 668
	    (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)
669 670 671
	      (cl--do-prettyprint)
	      (or skip (looking-at ")") (cl--do-prettyprint))
	      (or (not two) (looking-at ")") (cl--do-prettyprint))
Richard M. Stallman's avatar
Richard M. Stallman committed
672 673 674 675
	      (while (not (looking-at ")"))
		(if set (setq nl (not nl)))
		(if nl (insert "\n"))
		(lisp-indent-line)
676
		(cl--do-prettyprint))
Richard M. Stallman's avatar
Richard M. Stallman committed
677 678 679
	      (forward-char 1))))
    (forward-sexp)))

680
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
681 682
(defun cl-prettyexpand (form &optional full)
  (message "Expanding...")
683
  (let ((cl--compiling-file full)
Richard M. Stallman's avatar
Richard M. Stallman committed
684
	(byte-compile-macro-environment nil))
685 686
    (setq form (macroexpand-all form
                                (and (not full) '((cl-block) (cl-eval-when)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
687 688 689 690 691 692 693 694
    (message "Formatting...")
    (prog1 (cl-prettyprint form)
      (message ""))))



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

695
;; Local variables:
Glenn Morris's avatar
Glenn Morris committed
696 697
;; byte-compile-dynamic: t
;; byte-compile-warnings: (not cl-functions)
698 699 700
;; generated-autoload-file: "cl-loaddefs.el"
;; End:

Richard M. Stallman's avatar
Richard M. Stallman committed
701
;;; cl-extra.el ends here