annotate lisp/cl/cl-compat.el @ 0:376386a54a3c r19-14

Import from CVS: tag r19-14
author cvs
date Mon, 13 Aug 2007 08:45:50 +0200
parents
children ac2d302a0011
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1 ;;; cl-compat.el --- Common Lisp extensions for GNU Emacs Lisp (compatibility)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
3 ;; Copyright (C) 1993 Free Software Foundation, Inc.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5 ;; Author: Dave Gillespie <daveg@synaptics.com>
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6 ;; Version: 2.02
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7 ;; Keywords: extensions
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
9 ;; This file is part of XEmacs.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
10
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11 ;; XEmacs is free software; you can redistribute it and/or modify it
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12 ;; under the terms of the GNU General Public License as published by
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13 ;; the Free Software Foundation; either version 2, or (at your option)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14 ;; any later version.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16 ;; XEmacs is distributed in the hope that it will be useful, but
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19 ;; General Public License for more details.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21 ;; You should have received a copy of the GNU General Public License
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22 ;; along with XEmacs; see the file COPYING. If not, write to the Free
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23 ;; Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25 ;;; Synched up with: FSF 19.30.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27 ;;; Commentary:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29 ;; These are extensions to Emacs Lisp that provide a degree of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30 ;; Common Lisp compatibility, beyond what is already built-in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31 ;; in Emacs Lisp.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32 ;;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33 ;; This package was written by Dave Gillespie; it is a complete
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34 ;; rewrite of Cesar Quiroz's original cl.el package of December 1986.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35 ;;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36 ;; This package works with Emacs 18, Emacs 19, and XEmacs/Lucid Emacs 19.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37 ;;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38 ;; Bug reports, comments, and suggestions are welcome!
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 ;; This file contains emulations of internal routines of the older
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41 ;; CL package which users may have called directly from their code.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42 ;; Use (require 'cl-compat) to get these routines.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44 ;; See cl.el for Change Log.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47 ;;; Code:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49 ;; Require at load-time, but not when compiling cl-compat.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50 (or (featurep 'cl) (require 'cl))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53 ;;; Keyword routines not supported by new package.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55 (defmacro defkeyword (x &optional doc)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56 (list* 'defconst x (list 'quote x) (and doc (list doc))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58 (defun keywordp (sym)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59 (and (symbolp sym) (eq (aref (symbol-name sym) 0) ?\:) (set sym sym)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
61 (defun keyword-of (sym)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
62 (or (keywordp sym) (keywordp (intern (format ":%s" sym)))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
63
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
64
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
65 ;;; Multiple values. Note that the new package uses a different
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66 ;;; convention for multiple values. The following definitions
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
67 ;;; emulate the old convention; all function names have been changed
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
68 ;;; by capitalizing the first letter: Values, Multiple-value-*,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
69 ;;; to avoid conflict with the new-style definitions in cl-macs.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
70
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
71 (put 'Multiple-value-bind 'lisp-indent-function 2)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
72 (put 'Multiple-value-setq 'lisp-indent-function 2)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
73 (put 'Multiple-value-call 'lisp-indent-function 1)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
74 (put 'Multiple-value-prog1 'lisp-indent-function 1)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
75
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
76 (defvar *mvalues-values* nil)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
77
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
78 (defun Values (&rest val-forms)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
79 (setq *mvalues-values* val-forms)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
80 (car val-forms))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
81
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
82 (defun Values-list (val-forms)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
83 (apply 'values val-forms))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
84
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
85 (defmacro Multiple-value-list (form)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
86 (list 'let* (list '(*mvalues-values* nil) (list '*mvalues-temp* form))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
87 '(or (and (eq *mvalues-temp* (car *mvalues-values*)) *mvalues-values*)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
88 (list *mvalues-temp*))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
89
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
90 (defmacro Multiple-value-call (function &rest args)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
91 (list 'apply function
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
92 (cons 'append
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
93 (mapcar (function (lambda (x) (list 'Multiple-value-list x)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
94 args))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
95
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
96 (defmacro Multiple-value-bind (vars form &rest body)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
97 (list* 'multiple-value-bind vars (list 'Multiple-value-list form) body))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
98
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
99 (defmacro Multiple-value-setq (vars form)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
100 (list 'multiple-value-setq vars (list 'Multiple-value-list form)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
101
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
102 (defmacro Multiple-value-prog1 (form &rest body)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
103 (list 'prog1 form (list* 'let '((*mvalues-values* nil)) body)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
104
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
105
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
106 ;;; Routines for parsing keyword arguments.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
107
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
108 (defun build-klist (arglist keys &optional allow-others)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
109 (let ((res (Multiple-value-call 'mapcar* 'cons (unzip-lists arglist))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
110 (or allow-others
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
111 (let ((bad (set-difference (mapcar 'car res) keys)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
112 (if bad (error "Bad keywords: %s not in %s" bad keys))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
113 res))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
114
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
115 (defun extract-from-klist (klist key &optional def)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
116 (let ((res (assq key klist))) (if res (cdr res) def)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
117
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
118 (defun keyword-argument-supplied-p (klist key)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
119 (assq key klist))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
120
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
121 (defun elt-satisfies-test-p (item elt klist)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
122 (let ((test-not (cdr (assq ':test-not klist)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
123 (test (cdr (assq ':test klist)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
124 (key (cdr (assq ':key klist))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
125 (if key (setq elt (funcall key elt)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
126 (if test-not (not (funcall test-not item elt))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
127 (funcall (or test 'eql) item elt))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
128
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
129
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
130 ;;; Rounding functions with old-style multiple value returns.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
131
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
132 (defun cl-floor (a &optional b) (Values-list (floor* a b)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
133 (defun cl-ceiling (a &optional b) (Values-list (ceiling* a b)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
134 (defun cl-round (a &optional b) (Values-list (round* a b)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
135 (defun cl-truncate (a &optional b) (Values-list (truncate* a b)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
136
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
137 (defun safe-idiv (a b)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
138 (let* ((q (/ (abs a) (abs b)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
139 (s (* (signum a) (signum b))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
140 (Values q (- a (* s q b)) s)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
141
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
142
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
143 ;; Internal routines.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
144
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
145 (defun pair-with-newsyms (oldforms)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
146 (let ((newsyms (mapcar (function (lambda (x) (gensym))) oldforms)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
147 (Values (mapcar* 'list newsyms oldforms) newsyms)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
148
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
149 (defun zip-lists (evens odds)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
150 (mapcan 'list evens odds))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
151
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
152 (defun unzip-lists (list)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
153 (let ((e nil) (o nil))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
154 (while list
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
155 (setq e (cons (car list) e) o (cons (cadr list) o) list (cddr list)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
156 (Values (nreverse e) (nreverse o))))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
157
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
158 (defun reassemble-argslists (list)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
159 (let ((n (apply 'min (mapcar 'length list))) (res nil))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
160 (while (>= (setq n (1- n)) 0)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
161 (setq res (cons (mapcar (function (lambda (x) (elt x n))) list) res)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
162 res))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
163
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
164 (defun duplicate-symbols-p (list)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
165 (let ((res nil))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
166 (while list
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
167 (if (memq (car list) (cdr list)) (setq res (cons (car list) res)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
168 (setq list (cdr list)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
169 res))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
170
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
171
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
172 ;;; Setf internals.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
173
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
174 (defun setnth (n list x)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
175 (setcar (nthcdr n list) x))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
176
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
177 (defun setnthcdr (n list x)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
178 (setcdr (nthcdr (1- n) list) x))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
179
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
180 (defun setelt (seq n x)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
181 (if (consp seq) (setcar (nthcdr n seq) x) (aset seq n x)))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
182
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
183
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
184 ;;; Functions omitted: case-clausify, check-do-stepforms, check-do-endforms,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
185 ;;; extract-do-inits, extract-do[*]-steps, select-stepping-forms,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
186 ;;; elt-satisfies-if[-not]-p, with-keyword-args, mv-bind-clausify,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
187 ;;; all names with embedded `$'.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
188
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
189
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
190 (provide 'cl-compat)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
191
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
192 ;;; cl-compat.el ends here
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
193