1 ;;; cl.el --- Compatibility aliases for the old CL library. -*- lexical-binding: t -*-
3 ;; Copyright (C) 2012 Free Software Foundation, Inc.
5 ;; Author: Stefan Monnier <monnier@iro.umontreal.ca>
6 ;; Keywords: extensions
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;; This is a compatibility file which provides the old names provided by CL
26 ;; before we cleaned up its namespace usage.
33 ;; (defun cl--rename ()
36 ;; (case-fold-search nil)
37 ;; (files '("cl.el" "cl-macs.el" "cl-seq.el" "cl-extra.el")))
38 ;; (dolist (file files)
39 ;; (with-current-buffer (find-file-noselect file)
40 ;; (goto-char (point-min))
41 ;; (while (re-search-forward
42 ;; "^(\\(def[^ \t\n]*\\) +'?\\(\\(\\sw\\|\\s_\\)+\\)" nil t)
43 ;; (let ((name (match-string-no-properties 2))
44 ;; (type (match-string-no-properties 1)))
45 ;; (unless (string-match-p "\\`cl-" name)
47 ;; ((member type '("defvar" "defconst"))
48 ;; (unless (member name vdefs) (push name vdefs)))
49 ;; ((member type '("defun" "defsubst" "defalias" "defmacro"))
50 ;; (unless (member name fdefs) (push name fdefs)))
51 ;; ((member type '("def-edebug-spec" "defsetf" "define-setf-method"
52 ;; "define-compiler-macro"))
54 ;; (t (error "Unknown type %S" type))))))))
55 ;; (let ((re (concat "\\_<" (regexp-opt (append vdefs fdefs)) "\\_>"))
57 ;; (dolist (file files)
58 ;; (with-current-buffer (find-file-noselect file)
59 ;; (goto-char (point-min))
60 ;; (while (re-search-forward re nil t)
61 ;; (replace-match "cl-\\&"))
63 ;; (with-current-buffer (find-file-noselect "cl-rename.el")
64 ;; (dolist (def vdefs)
65 ;; (insert (format "(defvaralias '%s 'cl-%s)\n" def def)))
66 ;; (dolist (def fdefs)
67 ;; (insert (format "(defalias '%s 'cl-%s)\n" def def)))
70 ;; (defun cl--unrename ()
71 ;; ;; Taken from "Naming Conventions" node of the doc.
72 ;; (let* ((names '(defun* defsubst* defmacro* function* member*
73 ;; assoc* rassoc* get* remove* delete*
74 ;; mapcar* sort* floor* ceiling* truncate*
75 ;; round* mod* rem* random*))
76 ;; (files '("cl.el" "cl-lib.el" "cl-macs.el" "cl-seq.el" "cl-extra.el"))
77 ;; (re (concat "\\_<cl-" (regexp-opt (mapcar #'symbol-name names))
79 ;; (dolist (file files)
80 ;; (with-current-buffer (find-file-noselect file)
81 ;; (goto-char (point-min))
82 ;; (while (re-search-forward re nil t)
83 ;; (delete-region (1- (point)) (point)))
86 ;;; Aliases to cl-lib's features.
97 ;; lambda-list-keywords
98 float-negative-epsilon
100 least-negative-normalized-float
101 least-positive-normalized-float
106 ;; custom-print-functions
108 (defvaralias var
(intern (format "cl-%s" var
))))
110 ;; Before overwriting subr.el's `dotimes' and `dolist', let's remember
111 ;; them under a different name, so we can use them in our implementation
112 ;; of `dotimes' and `dolist'.
113 (unless (fboundp 'cl--dotimes
)
114 (defalias 'cl--dotimes
(symbol-function 'dotimes
) "The non-CL `dotimes'."))
115 (unless (fboundp 'cl--dolist
)
116 (defalias 'cl--dolist
(symbol-function 'dolist
) "The non-CL `dolist'."))
120 (random* . cl-random
)
124 (truncate* . cl-truncate
)
125 (ceiling* . cl-ceiling
)
127 (rassoc* . cl-rassoc
)
129 (member* . cl-member
)
130 (delete* . cl-delete
)
131 (remove* . cl-remove
)
132 (defsubst* . cl-defsubst
)
134 (function* . cl-function
)
135 (defmacro* . cl-defmacro
)
137 (mapcar* . cl-mapcar
)
216 define-compiler-macro
230 (define-setf-method . define-setf-expander
)
321 (let ((new (if (consp fun
) (prog1 (cdr fun
) (setq fun
(car fun
)))
322 (intern (format "cl-%s" fun
)))))
325 ;;; Features provided a bit differently in Elisp.
327 ;; First, the old lexical-let is now better served by `lexical-binding', tho
328 ;; it's not 100% compatible.
330 (defvar cl-closure-vars nil
)
331 (defvar cl--function-convert-cache nil
)
333 (defun cl--function-convert (f)
334 "Special macro-expander for special cases of (function F).
335 The two cases that are handled are:
336 - closure-conversion of lambda expressions for `lexical-let'.
337 - renaming of F when it's a function defined via `cl-labels' or `labels'."
339 (declare-function cl--expr-contains-any
"cl-macs" (x y
))
341 ;; ¡¡Big Ugly Hack!! We can't use a compiler-macro because those are checked
342 ;; *after* handling `function', but we want to stop macroexpansion from
343 ;; being applied infinitely, so we use a cache to return the exact `form'
344 ;; being expanded even though we don't receive it.
345 ((eq f
(car cl--function-convert-cache
)) (cdr cl--function-convert-cache
))
346 ((eq (car-safe f
) 'lambda
)
347 (let ((body (mapcar (lambda (f)
348 (macroexpand-all f macroexpand-all-environment
))
350 (if (and cl-closure-vars
351 (cl--expr-contains-any body cl-closure-vars
))
352 (let* ((new (mapcar 'cl-gensym cl-closure-vars
))
353 (sub (cl-pairlis cl-closure-vars new
)) (decls nil
))
354 (while (or (stringp (car body
))
355 (eq (car-safe (car body
)) 'interactive
))
356 (push (list 'quote
(pop body
)) decls
))
357 (put (car (last cl-closure-vars
)) 'used t
)
358 `(list 'lambda
'(&rest --cl-rest--
)
359 ,@(cl-sublis sub
(nreverse decls
))
362 #'(lambda ,(append new
(cadr f
))
363 ,@(cl-sublis sub body
)))
364 ,@(nconc (mapcar (lambda (x) `(list 'quote
,x
))
366 '((quote --cl-rest--
))))))
367 (let* ((newf `(lambda ,(cadr f
) ,@body
))
368 (res `(function ,newf
)))
369 (setq cl--function-convert-cache
(cons newf res
))
372 (let ((found (assq f macroexpand-all-environment
)))
373 (if (and found
(ignore-errors
374 (eq (cadr (cl-caddr found
)) 'cl-labels-args
)))
375 (cadr (cl-caddr (cl-cadddr found
)))
376 (let ((res `(function ,f
)))
377 (setq cl--function-convert-cache
(cons f res
))
380 (defmacro lexical-let
(bindings &rest body
)
381 "Like `let', but lexically scoped.
382 The main visible difference is that lambdas inside BODY will create
383 lexical closures as in Common Lisp.
384 \n(fn BINDINGS BODY)"
385 (declare (indent 1) (debug let
))
386 (let* ((cl-closure-vars cl-closure-vars
)
387 (vars (mapcar (function
389 (or (consp x
) (setq x
(list x
)))
390 (push (make-symbol (format "--cl-%s--" (car x
)))
392 (set (car cl-closure-vars
) [bad-lexical-ref
])
393 (list (car x
) (cadr x
) (car cl-closure-vars
))))
399 `(,(car x
) (symbol-value ,(cl-caddr x
))))
402 (cons (cons 'function
#'cl--function-convert
)
403 macroexpand-all-environment
))))
404 (if (not (get (car (last cl-closure-vars
)) 'used
))
405 ;; Turn (let ((foo (cl-gensym)))
406 ;; (set foo <val>) ...(symbol-value foo)...)
407 ;; into (let ((foo <val>)) ...(symbol-value 'foo)...).
408 ;; This is good because it's more efficient but it only works with
409 ;; dynamic scoping, since with lexical scoping we'd need
410 ;; (let ((foo <val>)) ...foo...).
412 ,@(mapcar (lambda (x) `(defvar ,(cl-caddr x
))) vars
)
413 (let ,(mapcar (lambda (x) (list (cl-caddr x
) (cadr x
))) vars
)
414 ,(cl-sublis (mapcar (lambda (x)
419 `(let ,(mapcar (lambda (x)
421 `(make-symbol ,(format "--%s--" (car x
)))))
423 (setf ,@(apply #'append
425 (list `(symbol-value ,(cl-caddr x
)) (cadr x
)))
429 (defmacro lexical-let
* (bindings &rest body
)
430 "Like `let*', but lexically scoped.
431 The main visible difference is that lambdas inside BODY, and in
432 successive bindings within BINDINGS, will create lexical closures
433 as in Common Lisp. This is similar to the behavior of `let*' in
435 \n(fn BINDINGS BODY)"
436 (declare (indent 1) (debug let
))
437 (if (null bindings
) (cons 'progn body
)
438 (setq bindings
(reverse bindings
))
440 (setq body
(list `(lexical-let (,(pop bindings
)) ,@body
))))
443 ;; This should really have some way to shadow 'byte-compile properties, etc.
444 (defmacro flet
(bindings &rest body
)
445 "Make temporary overriding function definitions.
446 This is an analogue of a dynamically scoped `let' that operates on the function
447 cell of FUNCs rather than their value cell.
448 If you want the Common-Lisp style of `flet', you should use `cl-flet'.
449 The FORMs are evaluated with the specified function definitions in place,
450 then the definitions are undone (the FUNCs go back to their previous
451 definitions, or lack thereof).
453 \(fn ((FUNC ARGLIST BODY...) ...) FORM...)"
454 (declare (indent 1) (debug cl-flet
)
455 (obsolete "use either `cl-flet' or `cl-letf'." "24.3"))
458 (if (or (and (fboundp (car x
))
459 (eq (car-safe (symbol-function (car x
))) 'macro
))
460 (cdr (assq (car x
) macroexpand-all-environment
)))
461 (error "Use `labels', not `flet', to rebind macro names"))
462 (let ((func `(cl-function
464 (cl-block ,(car x
) ,@(cddr x
))))))
465 (when (cl--compiling-file)
466 ;; Bug#411. It would be nice to fix this.
467 (and (get (car x
) 'byte-compile
)
468 (error "Byte-compiling a redefinition of `%s' \
469 will not work - use `labels' instead" (symbol-name (car x
))))
470 ;; FIXME This affects the rest of the file, when it
471 ;; should be restricted to the flet body.
472 (and (boundp 'byte-compile-function-environment
)
473 (push (cons (car x
) (eval func
))
474 byte-compile-function-environment
)))
475 (list `(symbol-function ',(car x
)) func
)))
479 (defmacro labels
(bindings &rest body
)
480 "Make temporary function bindings.
481 Like `cl-labels' except that the lexical scoping is handled via `lexical-let'
482 rather than relying on `lexical-binding'."
483 (declare (indent 1) (debug cl-flet
) (obsolete cl-labels
"24.3"))
484 (let ((vars nil
) (sets nil
) (newenv macroexpand-all-environment
))
485 (dolist (binding bindings
)
486 ;; It's important that (not (eq (symbol-name var1) (symbol-name var2)))
487 ;; because these var's *names* get added to the macro-environment.
488 (let ((var (make-symbol (format "--cl-%s--" (car binding
)))))
490 (push `(cl-function (lambda .
,(cdr binding
))) sets
)
492 (push (cons (car binding
)
493 `(lambda (&rest cl-labels-args
)
494 (cl-list* 'funcall
',var
497 (macroexpand-all `(lexical-let ,vars
(setq ,@sets
) ,@body
) newenv
)))
499 ;; Generalized variables are provided by gv.el, but some details are
500 ;; not 100% compatible: not worth the trouble to add them to cl-lib.el, but we
501 ;; still need to support old users of cl.el.
503 (defmacro cl--symbol-function
(symbol)
504 "Like `symbol-function' but return `cl--unbound' if not bound."
505 ;; (declare (gv-setter (lambda (store)
506 ;; `(if (eq ,store 'cl--unbound)
507 ;; (fmakunbound ,symbol) (fset ,symbol ,store)))))
508 `(if (fboundp ,symbol
) (symbol-function ,symbol
) 'cl--unbound
))
509 (gv-define-setter cl--symbol-function
(store symbol
)
510 `(if (eq ,store
'cl--unbound
) (fmakunbound ,symbol
) (fset ,symbol
,store
)))
512 (defmacro letf
(bindings &rest body
)
513 "Dynamically scoped let-style bindings for places.
514 Like `cl-letf', but with some extra backward compatibility."
515 ;; Like cl-letf, but with special handling of symbol-function.
516 `(cl-letf ,(mapcar (lambda (x) (if (eq (car-safe (car x
)) 'symbol-function
)
517 `((cl--symbol-function ,@(cdar x
)) ,@(cdr x
))
522 (defun cl--gv-adapt (cl-gv do
)
523 ;; This function is used by all .elc files that use define-setf-expander and
524 ;; were compiled with Emacs>=24.3.
525 (let ((vars (nth 0 cl-gv
))
529 ;; Use cl-sublis as was done in cl-setf-do-modify.
531 (if (macroexp-copyable-p (car vals
))
532 (push (cons (pop vars
) (pop vals
)) substs
)
533 (push (list (pop vars
) (pop vals
)) binds
)))
536 (funcall do
(cl-sublis substs
(nth 4 cl-gv
))
537 ;; We'd like to do something like
538 ;; (lambda ,(nth 2 cl-gv) ,(nth 3 cl-gv)).
540 (macroexp-let2 macroexp-copyable-p v exp
541 (cl-sublis (cons (cons (car (nth 2 cl-gv
)) v
)
545 (defmacro define-setf-expander
(name arglist
&rest body
)
546 "Define a `setf' method.
547 This method shows how to handle `setf's to places of the form (NAME ARGS...).
548 The argument forms ARGS are bound according to ARGLIST, as if NAME were
549 going to be expanded as a macro, then the BODY forms are executed and must
550 return a list of five elements: a temporary-variables list, a value-forms
551 list, a store-variables list (of length one), a store-form, and an access-
552 form. See `gv-define-expander', `gv-define-setter', and `gv-define-expander'
553 for a better and simpler ways to define setf-methods."
555 (&define name cl-lambda-list cl-declarations-or-string def-body
)))
557 ,@(if (stringp (car body
))
558 (list `(put ',name
'setf-documentation
,(pop body
))))
559 (gv-define-expander ,name
561 (lambda (do ,@arglist
)
562 (cl--gv-adapt (progn ,@body
) do
))))))
564 (defmacro defsetf
(name arg1
&rest args
)
565 "Define a `setf' method.
566 This macro is an easy-to-use substitute for `define-setf-expander' that works
567 well for simple place forms. In the simple `defsetf' form, `setf's of
568 the form (setf (NAME ARGS...) VAL) are transformed to function or macro
569 calls of the form (FUNC ARGS... VAL). Example:
571 (cl-defsetf aref aset)
573 Alternate form: (cl-defsetf NAME ARGLIST (STORE) BODY...).
574 Here, the above `setf' call is expanded by binding the argument forms ARGS
575 according to ARGLIST, binding the value form VAL to STORE, then executing
576 BODY, which must return a Lisp form that does the necessary `setf' operation.
577 Actually, ARGLIST and STORE may be bound to temporary variables which are
578 introduced automatically to preserve proper execution order of the arguments.
581 (cl-defsetf nth (n x) (v) `(setcar (nthcdr ,n ,x) ,v))
583 \(fn NAME [FUNC | ARGLIST (STORE) BODY...])"
586 [&or
[symbolp
&optional stringp
]
587 [cl-lambda-list
(symbolp)]]
588 cl-declarations-or-string def-body
)))
589 (if (and (listp arg1
) (consp args
))
590 ;; Like `gv-define-setter' but with `cl-function'.
591 `(gv-define-expander ,name
592 (lambda (do &rest args
)
593 (gv--defsetter ',name
595 (lambda (,@(car args
) ,@arg1
) ,@(cdr args
)))
597 `(gv-define-simple-setter ,name
,arg1
)))
599 ;; FIXME: CL used to provide a setf method for `apply', but I haven't been able
600 ;; to find a case where it worked. The code below tries to handle it as well.
601 ;; (defun cl--setf-apply (form last-witness last)
603 ;; ((not (consp form)) form)
604 ;; ((eq (ignore-errors (car (last form))) last-witness)
605 ;; `(apply #',(car form) ,@(butlast (cdr form)) ,last))
606 ;; ((and (memq (car form) '(let let*))
607 ;; (rassoc (list last-witness) (cadr form)))
608 ;; (let ((rebind (rassoc (list last-witness) (cadr form))))
609 ;; `(,(car form) ,(remq rebind (cadr form))
610 ;; ,@(mapcar (lambda (form) (cl--setf-apply form (car rebind) last))
612 ;; (t (mapcar (lambda (form) (cl--setf-apply form last-witness last)) form))))
613 ;; (gv-define-setter apply (val fun &rest args)
614 ;; (pcase fun (`#',(and (pred symbolp) f) (setq fun f))
615 ;; (_ (error "First arg to apply in setf is not #'SYM: %S" fun)))
616 ;; (let* ((butlast (butlast args))
617 ;; (last (car (last args)))
618 ;; (last-witness (make-symbol "--cl-tailarg--"))
619 ;; (setter (macroexpand `(setf (,fun ,@butlast ,last-witness) ,val)
620 ;; macroexpand-all-environment)))
621 ;; (cl--setf-apply setter last-witness last)))
624 ;; FIXME: CL used to provide get-setf-method, which was used by some
625 ;; setf-expanders, but now that we use gv.el, it is a lot more difficult
626 ;; and in general impossible to provide get-setf-method. Hopefully, it
627 ;; won't be needed. If needed, we'll have to do something nasty along the
629 ;; (defun get-setf-method (place &optional env)
630 ;; (let* ((witness (list 'cl-gsm))
631 ;; (expansion (gv-letplace (getter setter) place
632 ;; `(,witness ,getter ,(funcall setter witness)))))
633 ;; ...find "let prefix" of expansion, extract getter and setter from
634 ;; ...the rest, and build the 5-tuple))
635 (make-obsolete 'get-setf-method
'gv-letplace
"24.3")
637 (defmacro define-modify-macro
(name arglist func
&optional doc
)
638 "Define a `setf'-like modify macro.
639 If NAME is called, it combines its PLACE argument with the other arguments
640 from ARGLIST using FUNC: (define-modify-macro incf (&optional (n 1)) +)"
642 (&define name cl-lambda-list
;; should exclude &key
643 symbolp
&optional stringp
)))
644 (if (memq '&key arglist
)
645 (error "&key not allowed in define-modify-macro"))
646 (let ((place (make-symbol "--cl-place--")))
647 `(cl-defmacro ,name
(,place
,@arglist
)
649 (,(if (memq '&rest arglist
) #'cl-list
* #'list
)
650 #'cl-callf
',func
,place
651 ,@(cl--arglist-args arglist
)))))
653 ;;; Additional compatibility code.
654 ;; For names that were clean but really aren't needed any more.
656 (define-obsolete-function-alias 'cl-macroexpand
'macroexpand
"24.3")
657 (define-obsolete-variable-alias 'cl-macro-environment
658 'macroexpand-all-environment
"24.3")
659 (define-obsolete-function-alias 'cl-macroexpand-all
'macroexpand-all
"24.3")
662 ;; This is just kept for compatibility with code byte-compiled by Emacs-20.
664 ;; No idea if this might still be needed.
665 (defun cl-not-hash-table (x &optional y
&rest _z
)
666 (declare (obsolete nil
"24.3"))
667 (signal 'wrong-type-argument
(list 'cl-hash-table-p
(or y x
))))
669 (defvar cl-builtin-gethash
(symbol-function 'gethash
))
670 (make-obsolete-variable 'cl-builtin-gethash nil
"24.3")
671 (defvar cl-builtin-remhash
(symbol-function 'remhash
))
672 (make-obsolete-variable 'cl-builtin-remhash nil
"24.3")
673 (defvar cl-builtin-clrhash
(symbol-function 'clrhash
))
674 (make-obsolete-variable 'cl-builtin-clrhash nil
"24.3")
675 (defvar cl-builtin-maphash
(symbol-function 'maphash
))
677 (make-obsolete-variable 'cl-builtin-maphash nil
"24.3")
678 (define-obsolete-function-alias 'cl-map-keymap
'map-keymap
"24.3")
679 (define-obsolete-function-alias 'cl-copy-tree
'copy-tree
"24.3")
680 (define-obsolete-function-alias 'cl-gethash
'gethash
"24.3")
681 (define-obsolete-function-alias 'cl-puthash
'puthash
"24.3")
682 (define-obsolete-function-alias 'cl-remhash
'remhash
"24.3")
683 (define-obsolete-function-alias 'cl-clrhash
'clrhash
"24.3")
684 (define-obsolete-function-alias 'cl-maphash
'maphash
"24.3")
685 (define-obsolete-function-alias 'cl-make-hash-table
'make-hash-table
"24.3")
686 (define-obsolete-function-alias 'cl-hash-table-p
'hash-table-p
"24.3")
687 (define-obsolete-function-alias 'cl-hash-table-count
'hash-table-count
"24.3")
689 (define-obsolete-function-alias 'cl-map-keymap-recursively
690 'cl--map-keymap-recursively
"24.3")
691 (define-obsolete-function-alias 'cl-map-intervals
'cl--map-intervals
"24.3")
692 (define-obsolete-function-alias 'cl-map-extents
'cl--map-overlays
"24.3")
694 (defun cl-maclisp-member (item list
)
695 (declare (obsolete member
"24.3"))
696 (while (and list
(not (equal item
(car list
)))) (setq list
(cdr list
)))
699 ;; Used in the expansion of the old `defstruct'.
700 (defun cl-struct-setf-expander (x name accessor pred-form pos
)
701 (declare (obsolete nil
"24.3"))
702 (let* ((temp (make-symbol "--cl-x--")) (store (make-symbol "--cl-store--")))
703 (list (list temp
) (list x
) (list store
)
706 (list `(or ,(cl-subst temp
'cl-x pred-form
)
708 "%s storing a non-%s"
710 ,(if (eq (car (get name
'cl-struct-type
)) 'vector
)
711 `(aset ,temp
,pos
,store
)
715 (while (>= (setq pos
(1- pos
)) 0)
716 (setq xx
`(cdr ,xx
)))
718 `(nthcdr ,pos
,temp
))
720 (list accessor temp
))))