cl-extra.el 32.6 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

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1993, 2000-2019 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 <https://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 55
	((and (eq type 'character) (symbolp x))
         (cl-coerce (symbol-name x) type))
Richard M. Stallman's avatar
Richard M. Stallman committed
56
	((eq type 'float) (float x))
57
	((cl-typep x type) x)
Richard M. Stallman's avatar
Richard M. Stallman committed
58 59 60 61 62
	(t (error "Can't coerce %s to type %s" x type))))


;;; Predicates.

63
;;;###autoload
64
(defun cl-equalp (x y)
Juanma Barranquero's avatar
Juanma Barranquero committed
65
  "Return t if two Lisp objects have similar structures and contents.
Richard M. Stallman's avatar
Richard M. Stallman committed
66 67 68 69 70 71
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))
72
	      (or (string-equal x y)
73
		  (string-equal (downcase x) (downcase y))))) ;Lazy but simple!
Richard M. Stallman's avatar
Richard M. Stallman committed
74 75 76
	((numberp x)
	 (and (numberp y) (= x y)))
	((consp x)
77
	 (while (and (consp x) (consp y) (cl-equalp (car x) (car y)))
78
	   (setq x (cdr x) y (cdr y)))
79
	 (and (not (consp x)) (cl-equalp x y)))
Richard M. Stallman's avatar
Richard M. Stallman committed
80 81 82 83
	((vectorp x)
	 (and (vectorp y) (= (length x) (length y))
	      (let ((i (length x)))
		(while (and (>= (setq i (1- i)) 0)
84
			    (cl-equalp (aref x i) (aref y i))))
Richard M. Stallman's avatar
Richard M. Stallman committed
85 86 87 88 89 90
		(< i 0))))
	(t (equal x y))))


;;; Control structures.

91
;;;###autoload
92
(defun cl--mapcar-many (cl-func cl-seqs &optional acc)
Richard M. Stallman's avatar
Richard M. Stallman committed
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
  (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)))
109 110 111
	  (if acc
	      (push (apply cl-func cl-args) cl-res)
	    (apply cl-func cl-args))
Richard M. Stallman's avatar
Richard M. Stallman committed
112
	  (setq cl-i (1+ cl-i)))
113
	(and acc (nreverse cl-res)))
Richard M. Stallman's avatar
Richard M. Stallman committed
114 115 116 117 118 119
    (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)
120 121 122 123 124 125
	  (let ((val (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)))))
	    (when acc
	      (push val cl-res)))))
	(and acc (nreverse cl-res)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
126

127
;;;###autoload
128
(defun cl-map (cl-type cl-func cl-seq &rest cl-rest)
129 130 131
  "Map a FUNCTION across one or more SEQUENCEs, returning a sequence.
TYPE is the sequence type to return.
\n(fn TYPE FUNCTION SEQUENCE...)"
132 133
  (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
134

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

Glenn Morris's avatar
Glenn Morris committed
156
;;;###autoload
Dave Love's avatar
Dave Love committed
157
(defun cl-mapc (cl-func cl-seq &rest cl-rest)
Glenn Morris's avatar
Glenn Morris committed
158
  "Like `cl-mapcar', but does not accumulate values returned by the function.
159
\n(fn FUNCTION SEQUENCE...)"
Richard M. Stallman's avatar
Richard M. Stallman committed
160
  (if cl-rest
161 162 163 164 165 166 167 168
      (if (or (cdr cl-rest) (nlistp cl-seq) (nlistp (car cl-rest)))
          (progn
            (cl--mapcar-many cl-func (cons cl-seq cl-rest))
            cl-seq)
        (let ((cl-x cl-seq) (cl-y (car cl-rest)))
          (while (and cl-x cl-y)
            (funcall cl-func (pop cl-x) (pop cl-y)))
          cl-seq))
169
    (mapc cl-func cl-seq)))
Richard M. Stallman's avatar
Richard M. Stallman committed
170

171
;;;###autoload
172 173
(defun cl-mapl (cl-func cl-list &rest cl-rest)
  "Like `cl-maplist', but does not accumulate values returned by the function.
174
\n(fn FUNCTION LIST...)"
Richard M. Stallman's avatar
Richard M. Stallman committed
175
  (if cl-rest
176 177 178 179 180 181
      (let ((cl-args (cons cl-list (copy-sequence cl-rest)))
	    cl-p)
	(while (not (memq nil cl-args))
          (apply cl-func cl-args)
	  (setq cl-p cl-args)
	  (while cl-p (setcar cl-p (cdr (pop cl-p))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
182 183 184 185
    (let ((cl-p cl-list))
      (while cl-p (funcall cl-func cl-p) (setq cl-p (cdr cl-p)))))
  cl-list)

186
;;;###autoload
187
(defun cl-mapcan (cl-func cl-seq &rest cl-rest)
Glenn Morris's avatar
Glenn Morris committed
188
  "Like `cl-mapcar', but nconc's together the values returned by the function.
189
\n(fn FUNCTION SEQUENCE...)"
Mario Lang's avatar
Mario Lang committed
190 191 192
  (if cl-rest
      (apply 'nconc (apply 'cl-mapcar cl-func cl-seq cl-rest))
    (mapcan cl-func cl-seq)))
Richard M. Stallman's avatar
Richard M. Stallman committed
193

194
;;;###autoload
195 196
(defun cl-mapcon (cl-func cl-list &rest cl-rest)
  "Like `cl-maplist', but nconc's together the values returned by the function.
197
\n(fn FUNCTION LIST...)"
198
  (apply 'nconc (apply 'cl-maplist cl-func cl-list cl-rest)))
Richard M. Stallman's avatar
Richard M. Stallman committed
199

200
;;;###autoload
201
(defun cl-some (cl-pred cl-seq &rest cl-rest)
Richard M. Stallman's avatar
Richard M. Stallman committed
202
  "Return true if PREDICATE is true of any element of SEQ or SEQs.
203 204
If so, return the true (non-nil) value returned by PREDICATE.
\n(fn PREDICATE SEQ...)"
Richard M. Stallman's avatar
Richard M. Stallman committed
205 206
  (if (or cl-rest (nlistp cl-seq))
      (catch 'cl-some
207
	(apply 'cl-map nil
Richard M. Stallman's avatar
Richard M. Stallman committed
208 209 210 211 212
	       (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))
213
      (while (and cl-seq (not (setq cl-x (funcall cl-pred (pop cl-seq))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
214 215
      cl-x)))

216
;;;###autoload
217
(defun cl-every (cl-pred cl-seq &rest cl-rest)
218 219
  "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
220 221
  (if (or cl-rest (nlistp cl-seq))
      (catch 'cl-every
222
	(apply 'cl-map nil
Richard M. Stallman's avatar
Richard M. Stallman committed
223 224 225 226 227 228 229
	       (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)))

230
;;;###autoload
231
(defun cl-notany (cl-pred cl-seq &rest cl-rest)
232 233
  "Return true if PREDICATE is false of every element of SEQ or SEQs.
\n(fn PREDICATE SEQ...)"
234
  (not (apply 'cl-some cl-pred cl-seq cl-rest)))
Richard M. Stallman's avatar
Richard M. Stallman committed
235

236
;;;###autoload
237
(defun cl-notevery (cl-pred cl-seq &rest cl-rest)
238 239
  "Return true if PREDICATE is false of some element of SEQ or SEQs.
\n(fn PREDICATE SEQ...)"
240
  (not (apply 'cl-every cl-pred cl-seq cl-rest)))
Richard M. Stallman's avatar
Richard M. Stallman committed
241

242
;;;###autoload
243
(defun cl--map-keymap-recursively (cl-func-rec cl-map &optional cl-base)
Richard M. Stallman's avatar
Richard M. Stallman committed
244
  (or cl-base
Dave Love's avatar
Dave Love committed
245
      (setq cl-base (copy-sequence [0])))
246
  (map-keymap
Richard M. Stallman's avatar
Richard M. Stallman committed
247 248 249 250
   (function
    (lambda (cl-key cl-bind)
      (aset cl-base (1- (length cl-base)) cl-key)
      (if (keymapp cl-bind)
251
	  (cl--map-keymap-recursively
Richard M. Stallman's avatar
Richard M. Stallman committed
252
	   cl-func-rec cl-bind
Dave Love's avatar
Dave Love committed
253
	   (vconcat cl-base (list 0)))
Richard M. Stallman's avatar
Richard M. Stallman committed
254 255 256
	(funcall cl-func-rec cl-base cl-bind))))
   cl-map))

257
;;;###autoload
258
(defun cl--map-intervals (cl-func &optional cl-what cl-prop cl-start cl-end)
Richard M. Stallman's avatar
Richard M. Stallman committed
259 260 261
  (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
262
	(with-current-buffer cl-what
Richard M. Stallman's avatar
Richard M. Stallman committed
263 264 265
	  (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
266 267 268 269 270
	  (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
271 272 273 274 275 276 277
	  (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
278 279 280
      (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
281 282 283 284
			 cl-end)))
	(funcall cl-func cl-start (min cl-next cl-end))
	(setq cl-start cl-next)))))

285
;;;###autoload
286
(defun cl--map-overlays (cl-func &optional cl-buffer cl-start cl-end cl-arg)
Richard M. Stallman's avatar
Richard M. Stallman committed
287
  (or cl-buffer (setq cl-buffer (current-buffer)))
288 289 290 291 292 293 294 295 296 297 298 299 300 301
  (let (cl-ovl)
    (with-current-buffer cl-buffer
      (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))))
Richard M. Stallman's avatar
Richard M. Stallman committed
302

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


;;; Numbers.

314
;;;###autoload
315
(defun cl-gcd (&rest args)
Richard M. Stallman's avatar
Richard M. Stallman committed
316
  "Return the greatest common divisor of the arguments."
317 318 319 320 321
  (let ((a (or (pop args) 0)))
    (dolist (b args)
      (while (/= b 0)
        (setq b (% a (setq a b)))))
    (abs a)))
Richard M. Stallman's avatar
Richard M. Stallman committed
322

323
;;;###autoload
324
(defun cl-lcm (&rest args)
Richard M. Stallman's avatar
Richard M. Stallman committed
325 326 327
  "Return the least common multiple of the arguments."
  (if (memq 0 args)
      0
328 329 330 331
    (let ((a (or (pop args) 1)))
      (dolist (b args)
        (setq a (* (/ a (cl-gcd a b)) b)))
      (abs a))))
Richard M. Stallman's avatar
Richard M. Stallman committed
332

333
;;;###autoload
334
(defun cl-isqrt (x)
Richard M. Stallman's avatar
Richard M. Stallman committed
335
  "Return the integer square root of the argument."
336 337 338
  (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
339
	    g2)
340
	(while (< (setq g2 (/ (+ g (/ x g)) 2)) g)
Richard M. Stallman's avatar
Richard M. Stallman committed
341 342
	  (setq g g2))
	g)
343
    (if (eq x 0) 0 (signal 'arith-error nil))))
Richard M. Stallman's avatar
Richard M. Stallman committed
344

345
;;;###autoload
346
(defun cl-floor (x &optional y)
Richard M. Stallman's avatar
Richard M. Stallman committed
347 348
  "Return a list of the floor of X and the fractional part of X.
With two arguments, return floor and remainder of their quotient."
349 350
  (let ((q (floor x y)))
    (list q (- x (if y (* y q) q)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
351

352
;;;###autoload
353
(defun cl-ceiling (x &optional y)
Richard M. Stallman's avatar
Richard M. Stallman committed
354 355
  "Return a list of the ceiling of X and the fractional part of X.
With two arguments, return ceiling and remainder of their quotient."
356
  (let ((res (cl-floor x y)))
Richard M. Stallman's avatar
Richard M. Stallman committed
357 358 359
    (if (= (car (cdr res)) 0) res
      (list (1+ (car res)) (- (car (cdr res)) (or y 1))))))

360
;;;###autoload
361
(defun cl-truncate (x &optional y)
Richard M. Stallman's avatar
Richard M. Stallman committed
362 363 364
  "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)))
365
      (cl-floor x y) (cl-ceiling x y)))
Richard M. Stallman's avatar
Richard M. Stallman committed
366

367
;;;###autoload
368
(defun cl-round (x &optional y)
Richard M. Stallman's avatar
Richard M. Stallman committed
369 370 371 372 373
  "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))
374
		 (res (cl-floor (+ x hy) y)))
Richard M. Stallman's avatar
Richard M. Stallman committed
375 376 377 378 379 380 381 382 383 384 385
	    (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))))))

386
;;;###autoload
387
(defun cl-mod (x y)
Richard M. Stallman's avatar
Richard M. Stallman committed
388
  "The remainder of X divided by Y, with the same sign as Y."
389
  (nth 1 (cl-floor x y)))
Richard M. Stallman's avatar
Richard M. Stallman committed
390

391
;;;###autoload
392
(defun cl-rem (x y)
Richard M. Stallman's avatar
Richard M. Stallman committed
393
  "The remainder of X divided by Y, with the same sign as X."
394
  (nth 1 (cl-truncate x y)))
Richard M. Stallman's avatar
Richard M. Stallman committed
395

396
;;;###autoload
397
(defun cl-signum (x)
398 399
  "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
400

401 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
;;;###autoload
(cl-defun cl-parse-integer (string &key start end radix junk-allowed)
  "Parse integer from the substring of STRING from START to END.
STRING may be surrounded by whitespace chars (chars with syntax ` ').
Other non-digit chars are considered junk.
RADIX is an integer between 2 and 36, the default is 10.  Signal
an error if the substring between START and END cannot be parsed
as an integer unless JUNK-ALLOWED is non-nil."
  (cl-check-type string string)
  (let* ((start (or start 0))
	 (len	(length string))
	 (end   (or end len))
	 (radix (or radix 10)))
    (or (<= start end len)
	(error "Bad interval: [%d, %d)" start end))
    (cl-flet ((skip-whitespace ()
		(while (and (< start end)
			    (= 32 (char-syntax (aref string start))))
		  (setq start (1+ start)))))
      (skip-whitespace)
      (let ((sign (cl-case (and (< start end) (aref string start))
		    (?+ (cl-incf start) +1)
		    (?- (cl-incf start) -1)
		    (t  +1)))
	    digit sum)
	(while (and (< start end)
		    (setq digit (cl-digit-char-p (aref string start) radix)))
	  (setq sum (+ (* (or sum 0) radix) digit)
		start (1+ start)))
	(skip-whitespace)
	(cond ((and junk-allowed (null sum)) sum)
	      (junk-allowed (* sign sum))
433
	      ((or (/= start end) (null sum))
434
	       (error "Not an integer string: `%s'" string))
435 436
	      (t (* sign sum)))))))

Richard M. Stallman's avatar
Richard M. Stallman committed
437 438 439

;; Random numbers.

440
(defun cl--random-time ()
441
  (car (encode-time nil t)))
442 443 444 445 446 447 448 449 450 451 452

;;;###autoload (autoload 'cl-random-state-p "cl-extra")
(cl-defstruct (cl--random-state
               (:copier nil)
               (:predicate cl-random-state-p)
               (:constructor nil)
               (:constructor cl--make-random-state (vec)))
  (i -1) (j 30) vec)

(defvar cl--random-state (cl--make-random-state (cl--random-time)))

453
;;;###autoload
454
(defun cl-random (lim &optional state)
Richard M. Stallman's avatar
Richard M. Stallman committed
455 456
  "Return a random nonnegative number less than LIM, an integer or float.
Optional second arg STATE is a random-state object."
457
  (or state (setq state cl--random-state))
Richard M. Stallman's avatar
Richard M. Stallman committed
458
  ;; Inspired by "ran3" from Numerical Recipes.  Additive congruential method.
459
  (let ((vec (cl--random-state-vec state)))
Richard M. Stallman's avatar
Richard M. Stallman committed
460
    (if (integerp vec)
461
	(let ((i 0) (j (- 1357335 (abs (% vec 1357333)))) (k 1))
462 463
	  (setf (cl--random-state-vec state)
                (setq vec (make-vector 55 nil)))
Richard M. Stallman's avatar
Richard M. Stallman committed
464 465 466
	  (aset vec 0 j)
	  (while (> (setq i (% (+ i 21) 55)) 0)
	    (aset vec i (setq j (prog1 k (setq k (- j k))))))
467
	  (while (< (setq i (1+ i)) 200) (cl-random 2 state))))
468 469
    (let* ((i (cl-callf (lambda (x) (% (1+ x) 55)) (cl--random-state-i state)))
	   (j (cl-callf (lambda (x) (% (1+ x) 55)) (cl--random-state-j state)))
Richard M. Stallman's avatar
Richard M. Stallman committed
470 471 472
	   (n (logand 8388607 (aset vec i (- (aref vec i) (aref vec j))))))
      (if (integerp lim)
	  (if (<= lim 512) (% n lim)
473
	    (if (> lim 8388607) (setq n (+ (ash n 9) (cl-random 512 state))))
Richard M. Stallman's avatar
Richard M. Stallman committed
474 475
	    (let ((mask 1023))
	      (while (< mask (1- lim)) (setq mask (1+ (+ mask mask))))
476
	      (if (< (setq n (logand n mask)) lim) n (cl-random lim state))))
Richard M. Stallman's avatar
Richard M. Stallman committed
477 478
	(* (/ n '8388608e0) lim)))))

479
;;;###autoload
480
(defun cl-make-random-state (&optional state)
481
  "Return a copy of random-state STATE, or of the internal state if omitted.
Richard M. Stallman's avatar
Richard M. Stallman committed
482
If STATE is t, return a new state object seeded from the time of day."
483 484
  (unless state (setq state cl--random-state))
  (if (cl-random-state-p state)
485
      (copy-sequence state)
486
    (cl--make-random-state (if (integerp state) state (cl--random-time)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
487 488 489

;; Implementation limits.

490 491
(defun cl--finite-do (func a b)
  (condition-case _
Richard M. Stallman's avatar
Richard M. Stallman committed
492 493 494 495
      (let ((res (funcall func a b)))   ; check for IEEE infinity
	(and (numberp res) (/= res (/ res 2)) res))
    (arith-error nil)))

496
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
497
(defun cl-float-limits ()
498
  "Initialize the Common Lisp floating-point parameters.
499 500 501 502 503
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
504 505
      (let ((x '2e0) y z)
	;; Find maximum exponent (first two loops are optimizations)
506 507 508
	(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
509
	(setq z x y (/ x 2))
510
	;; Now cl-fill in 1's in the mantissa.
511
	(while (and (cl--finite-do '+ x y) (/= (+ x y) x))
Richard M. Stallman's avatar
Richard M. Stallman committed
512
	  (setq x (+ x y) y (/ y 2)))
513 514
	(setq cl-most-positive-float x
	      cl-most-negative-float (- x))
Richard M. Stallman's avatar
Richard M. Stallman committed
515 516
	;; Divide down until mantissa starts rounding.
	(setq x (/ x z) y (/ 16 z) x (* x y))
517
	(while (condition-case _ (and (= x (* (/ x 2) 2)) (> (/ y 2) 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
518 519
		 (arith-error nil))
	  (setq x (/ x 2) y (/ y 2)))
520 521
	(setq cl-least-positive-normalized-float y
	      cl-least-negative-normalized-float (- y))
Richard M. Stallman's avatar
Richard M. Stallman committed
522
	;; Divide down until value underflows to zero.
523
	(setq x (/ z) y x)
524
	(while (condition-case _ (> (/ x 2) 0) (arith-error nil))
Richard M. Stallman's avatar
Richard M. Stallman committed
525
	  (setq x (/ x 2)))
526 527
	(setq cl-least-positive-float x
	      cl-least-negative-float (- x))
Richard M. Stallman's avatar
Richard M. Stallman committed
528 529
	(setq x '1e0)
	(while (/= (+ '1e0 x) '1e0) (setq x (/ x 2)))
530
	(setq cl-float-epsilon (* x 2))
Richard M. Stallman's avatar
Richard M. Stallman committed
531 532
	(setq x '1e0)
	(while (/= (- '1e0 x) '1e0) (setq x (/ x 2)))
533
	(setq cl-float-negative-epsilon (* x 2))))
Richard M. Stallman's avatar
Richard M. Stallman committed
534 535 536 537 538
  nil)


;;; Sequence functions.

539
;;;###autoload
540
(defun cl-subseq (seq start &optional end)
Richard M. Stallman's avatar
Richard M. Stallman committed
541 542
  "Return the subsequence of SEQ from START to END.
If END is omitted, it defaults to the length of the sequence.
543 544
If START or END is negative, it counts from the end.
Signal an error if START or END are outside of the sequence (i.e
545
too large if positive or too small if negative)."
Stefan Monnier's avatar
Stefan Monnier committed
546 547
  (declare (gv-setter
            (lambda (new)
548 549 550
              (macroexp-let2 nil new new
		`(progn (cl-replace ,seq ,new :start1 ,start :end1 ,end)
			,new)))))
551 552 553 554
  (cond ((or (stringp seq) (vectorp seq)) (substring seq start end))
        ((listp seq)
         (let (len
               (errtext (format "Bad bounding indices: %s, %s" start end)))
555 556
           (and end (< end 0) (setq end (+ end (setq len (length seq)))))
           (if (< start 0) (setq start (+ start (or len (setq len (length seq))))))
557 558 559 560 561 562 563 564 565 566 567 568
           (unless (>= start 0)
             (error "%s" errtext))
           (when (> start 0)
             (setq seq (nthcdr (1- start) seq))
             (or seq (error "%s" errtext))
             (setq seq (cdr seq)))
           (if end
               (let ((res nil))
                 (while (and (>= (setq end (1- end)) start) seq)
                   (push (pop seq) res))
                 (or (= (1+ end) start) (error "%s" errtext))
                 (nreverse res))
569
             (copy-sequence seq))))
570
        (t (error "Unsupported sequence: %s" seq))))
Richard M. Stallman's avatar
Richard M. Stallman committed
571

572
;;;###autoload
573
(defun cl-concatenate (type &rest sequences)
574
  "Concatenate, into a sequence of type TYPE, the argument SEQUENCEs.
575 576
\n(fn TYPE SEQUENCE...)"
  (pcase type
577 578 579
    ('vector (apply #'vconcat sequences))
    ('string (apply #'concat sequences))
    ('list (apply #'append (append sequences '(nil))))
580
    (_ (error "Not a sequence type name: %S" type))))
Richard M. Stallman's avatar
Richard M. Stallman committed
581 582 583

;;; List functions.

584
;;;###autoload
585
(defun cl-revappend (x y)
Richard M. Stallman's avatar
Richard M. Stallman committed
586 587 588
  "Equivalent to (append (reverse X) Y)."
  (nconc (reverse x) y))

589
;;;###autoload
590
(defun cl-nreconc (x y)
Richard M. Stallman's avatar
Richard M. Stallman committed
591 592 593
  "Equivalent to (nconc (nreverse X) Y)."
  (nconc (nreverse x) y))

594
;;;###autoload
595
(defun cl-list-length (x)
596
  "Return the length of list X.  Return nil if list is circular."
Paul Eggert's avatar
Paul Eggert committed
597 598 599 600
  (cl-check-type x list)
  (condition-case nil
      (length x)
    (circular-list)))
Richard M. Stallman's avatar
Richard M. Stallman committed
601

602
;;;###autoload
603
(defun cl-tailp (sublist list)
Richard M. Stallman's avatar
Richard M. Stallman committed
604 605 606 607 608 609 610
  "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.

611
;;;###autoload
612
(defun cl-get (sym tag &optional def)
613 614
  "Return the value of SYMBOL's PROPNAME property, or DEFAULT if none.
\n(fn SYMBOL PROPNAME &optional DEFAULT)"
Stefan Monnier's avatar
Stefan Monnier committed
615
  (declare (compiler-macro cl--compiler-macro-get)
616
           (gv-setter (lambda (store) (ignore def) `(put ,sym ,tag ,store))))
617
  (cl-getf (symbol-plist sym) tag def))
618
(autoload 'cl--compiler-macro-get "cl-macs")
Richard M. Stallman's avatar
Richard M. Stallman committed
619

620
;;;###autoload
621
(defun cl-getf (plist tag &optional def)
Richard M. Stallman's avatar
Richard M. Stallman committed
622
  "Search PROPLIST for property PROPNAME; return its value or DEFAULT.
623 624
PROPLIST is a list of the sort returned by `symbol-plist'.
\n(fn PROPLIST PROPNAME &optional DEFAULT)"
Stefan Monnier's avatar
Stefan Monnier committed
625 626 627
  (declare (gv-expander
            (lambda (do)
              (gv-letplace (getter setter) plist
Leo Liu's avatar
Leo Liu committed
628 629 630 631 632 633 634 635
                (macroexp-let2* nil ((k tag) (d def))
                  (funcall do `(cl-getf ,getter ,k ,d)
			   (lambda (v)
			     (macroexp-let2 nil val v
			       `(progn
				  ,(funcall setter
					    `(cl--set-getf ,getter ,k ,val))
				  ,val)))))))))
636 637
  (let ((val-tail (cdr-safe (plist-member plist tag))))
    (if val-tail (car val-tail) def)))
Richard M. Stallman's avatar
Richard M. Stallman committed
638

639
;;;###autoload
640
(defun cl--set-getf (plist tag val)
641 642 643
  (let ((val-tail (cdr-safe (plist-member plist tag))))
    (if val-tail (progn (setcar val-tail val) plist)
      (cl-list* tag val plist))))
Richard M. Stallman's avatar
Richard M. Stallman committed
644

645
;;;###autoload
646
(defun cl--do-remf (plist tag)
Richard M. Stallman's avatar
Richard M. Stallman committed
647
  (let ((p (cdr plist)))
648 649
    ;; Can't use `plist-member' here because it goes to the cons-cell
    ;; of TAG and we need the one before.
Richard M. Stallman's avatar
Richard M. Stallman committed
650 651 652
    (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))))

653
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
654
(defun cl-remprop (sym tag)
655 656
  "Remove from SYMBOL's plist the property PROPNAME and its value.
\n(fn SYMBOL PROPNAME)"
Richard M. Stallman's avatar
Richard M. Stallman committed
657 658 659
  (let ((plist (symbol-plist sym)))
    (if (and plist (eq tag (car plist)))
	(progn (setplist sym (cdr (cdr plist))) t)
660
      (cl--do-remf plist tag))))
Richard M. Stallman's avatar
Richard M. Stallman committed
661

662 663 664 665 666 667 668
;;; Streams.

;;;###autoload
(defun cl-fresh-line (&optional stream)
  "Output a newline unless already at the beginning of a line."
  (terpri stream 'ensure))

Richard M. Stallman's avatar
Richard M. Stallman committed
669 670 671 672 673 674 675 676 677
;;; 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)
678
      (delete-char -7)
Richard M. Stallman's avatar
Richard M. Stallman committed
679 680 681 682
      (insert "'")
      (forward-sexp)
      (delete-char 1))
    (goto-char (1+ pt))
683
    (cl--do-prettyprint)))
Richard M. Stallman's avatar
Richard M. Stallman committed
684

685
(defun cl--do-prettyprint ()
Richard M. Stallman's avatar
Richard M. Stallman committed
686 687 688 689 690
  (skip-chars-forward " ")
  (if (looking-at "(")
      (let ((skip (or (looking-at "((") (looking-at "(prog")
		      (looking-at "(unwind-protect ")
		      (looking-at "(function (")
691
		      (looking-at "(cl--block-wrapper ")))
Richard M. Stallman's avatar
Richard M. Stallman committed
692 693 694 695 696 697 698 699 700
	    (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)
701 702 703
	      (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
704 705 706 707
	      (while (not (looking-at ")"))
		(if set (setq nl (not nl)))
		(if nl (insert "\n"))
		(lisp-indent-line)
708
		(cl--do-prettyprint))
Richard M. Stallman's avatar
Richard M. Stallman committed
709 710 711
	      (forward-char 1))))
    (forward-sexp)))

712
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
713
(defun cl-prettyexpand (form &optional full)
Glenn Morris's avatar
Glenn Morris committed
714 715 716
  "Expand macros in FORM and insert the pretty-printed result.
Optional argument FULL non-nil means to expand all macros,
including `cl-block' and `cl-eval-when'."
Richard M. Stallman's avatar
Richard M. Stallman committed
717
  (message "Expanding...")
718
  (let ((cl--compiling-file full)
Richard M. Stallman's avatar
Richard M. Stallman committed
719
	(byte-compile-macro-environment nil))
720 721
    (setq form (macroexpand-all form
                                (and (not full) '((cl-block) (cl-eval-when)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
722 723 724 725
    (message "Formatting...")
    (prog1 (cl-prettyprint form)
      (message ""))))

726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
;;; Integration into the online help system.

(eval-when-compile (require 'cl-macs))  ;Explicitly, for cl--find-class.
(require 'help-mode)

;; FIXME: We could go crazy and add another entry so describe-symbol can be
;; used with the slot names of CL structs (and/or EIEIO objects).
(add-to-list 'describe-symbol-backends
             `(nil ,#'cl-find-class ,(lambda (s _b _f) (cl-describe-type s))))

(defconst cl--typedef-regexp
  (concat "(" (regexp-opt '("defclass" "defstruct" "cl-defstruct"
                            "cl-deftype" "deftype"))
          "[ \t\r\n]+%s[ \t\r\n]+"))
(with-eval-after-load 'find-func
  (defvar find-function-regexp-alist)
  (add-to-list 'find-function-regexp-alist
743
               '(define-type . cl--typedef-regexp)))
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784

(define-button-type 'cl-help-type
  :supertype 'help-function-def
  'help-function #'cl-describe-type
  'help-echo (purecopy "mouse-2, RET: describe this type"))

(define-button-type 'cl-type-definition
  :supertype 'help-function-def
  'help-echo (purecopy "mouse-2, RET: find type definition"))

(declare-function help-fns-short-filename "help-fns" (filename))

;;;###autoload
(defun cl-find-class (type) (cl--find-class type))

;;;###autoload
(defun cl-describe-type (type)
  "Display the documentation for type TYPE (a symbol)."
  (interactive
   (let ((str (completing-read "Describe type: " obarray #'cl-find-class t)))
     (if (<= (length str) 0)
         (user-error "Abort!")
       (list (intern str)))))
  (help-setup-xref (list #'cl-describe-type type)
                   (called-interactively-p 'interactive))
  (save-excursion
    (with-help-window (help-buffer)
      (with-current-buffer standard-output
        (let ((class (cl-find-class type)))
          (if class
              (cl--describe-class type class)
            ;; FIXME: Describe other types (the built-in ones, or those from
            ;; cl-deftype).
            (user-error "Unknown type %S" type))))
      (with-current-buffer standard-output
        ;; Return the text we displayed.
        (buffer-string)))))

(defun cl--describe-class (type &optional class)
  (unless class (setq class (cl--find-class type)))
  (let ((location (find-lisp-object-file-name type 'define-type))
785
        (metatype (type-of class)))
786
    (insert (symbol-name type)
787
            (substitute-command-keys " is a type (of kind `"))
788 789
    (help-insert-xref-button (symbol-name metatype)
                             'cl-help-type metatype)
790
    (insert (substitute-command-keys "')"))
791
    (when location
792
      (insert (substitute-command-keys " in `"))
793 794 795
      (help-insert-xref-button
       (help-fns-short-filename location)
       'cl-type-definition type location 'define-type)
796
      (insert (substitute-command-keys "'")))
797 798 799 800 801 802 803 804 805
    (insert ".\n")

    ;; Parents.
    (let ((pl (cl--class-parents class))
          cur)
      (when pl
        (insert " Inherits from ")
        (while (setq cur (pop pl))
          (setq cur (cl--class-name cur))
806
          (insert (substitute-command-keys "`"))
807 808
          (help-insert-xref-button (symbol-name cur)
                                   'cl-help-type cur)
809
          (insert (substitute-command-keys (if pl "', " "'"))))
810 811 812 813 814 815 816 817 818 819
        (insert ".\n")))

    ;; Children, if available.  ¡For EIEIO!
    (let ((ch (condition-case nil
                  (cl-struct-slot-value metatype 'children class)
                (cl-struct-unknown-slot nil)))
          cur)
      (when ch
        (insert " Children ")
        (while (setq cur (pop ch))
820
          (insert (substitute-command-keys "`"))
821 822
          (help-insert-xref-button (symbol-name cur)
                                   'cl-help-type cur)
823
          (insert (substitute-command-keys (if ch "', " "'"))))
824 825 826 827 828 829 830 831 832 833 834
        (insert ".\n")))

    ;; Type's documentation.
    (let ((doc (cl--class-docstring class)))
      (when doc
        (insert "\n" doc "\n\n")))

    ;; Describe all the slots in this class.
    (cl--describe-class-slots class)

    ;; Describe all the methods specific to this class.
835
    (let ((generics (cl-generic-all-functions type)))
836 837 838
      (when generics
        (insert (propertize "Specialized Methods:\n\n" 'face 'bold))
        (dolist (generic generics)
839
          (insert (substitute-command-keys "`"))
840 841
          (help-insert-xref-button (symbol-name generic)
                                   'help-function generic)
842
          (insert (substitute-command-keys "'"))
843 844 845 846 847 848 849 850 851 852 853 854 855 856