Commit | Line | Data |
---|---|---|
73217411 | 1 | ;;; cl.el --- Common Lisp extensions for Emacs -*-byte-compile-dynamic: t;-*- |
fcd73769 | 2 | |
ceb4c4d3 TTN |
3 | ;; Copyright (C) 1993, 2002, 2003, 2004, 2005, |
4 | ;; 2006 Free Software Foundation, Inc. | |
fcd73769 RS |
5 | |
6 | ;; Author: Dave Gillespie <daveg@synaptics.com> | |
7 | ;; Version: 2.02 | |
8 | ;; Keywords: extensions | |
9 | ||
10 | ;; This file is part of GNU Emacs. | |
11 | ||
12 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
13 | ;; it under the terms of the GNU General Public License as published by | |
7c938215 | 14 | ;; the Free Software Foundation; either version 2, or (at your option) |
fcd73769 RS |
15 | ;; any later version. |
16 | ||
17 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;; GNU General Public License for more details. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
b578f267 | 23 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
3a35cf56 LK |
24 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
25 | ;; Boston, MA 02110-1301, USA. | |
fcd73769 | 26 | |
07b3798c | 27 | ;;; Commentary: |
fcd73769 RS |
28 | |
29 | ;; These are extensions to Emacs Lisp that provide a degree of | |
30 | ;; Common Lisp compatibility, beyond what is already built-in | |
31 | ;; in Emacs Lisp. | |
32 | ;; | |
33 | ;; This package was written by Dave Gillespie; it is a complete | |
34 | ;; rewrite of Cesar Quiroz's original cl.el package of December 1986. | |
35 | ;; | |
fcd73769 RS |
36 | ;; Bug reports, comments, and suggestions are welcome! |
37 | ||
38 | ;; This file contains the portions of the Common Lisp extensions | |
39 | ;; package which should always be present. | |
40 | ||
41 | ||
07b3798c | 42 | ;;; Future notes: |
fcd73769 RS |
43 | |
44 | ;; Once Emacs 19 becomes standard, many things in this package which are | |
45 | ;; messy for reasons of compatibility can be greatly simplified. For now, | |
46 | ;; I prefer to maintain one unified version. | |
47 | ||
48 | ||
07b3798c | 49 | ;;; Change Log: |
fcd73769 RS |
50 | |
51 | ;; Version 2.02 (30 Jul 93): | |
52 | ;; * Added "cl-compat.el" file, extra compatibility with old package. | |
53 | ;; * Added `lexical-let' and `lexical-let*'. | |
54 | ;; * Added `define-modify-macro', `callf', and `callf2'. | |
55 | ;; * Added `ignore-errors'. | |
56 | ;; * Changed `(setf (nthcdr N PLACE) X)' to work when N is zero. | |
57 | ;; * Merged `*gentemp-counter*' into `*gensym-counter*'. | |
58 | ;; * Extended `subseq' to allow negative START and END like `substring'. | |
59 | ;; * Added `in-ref', `across-ref', `elements of-ref' loop clauses. | |
60 | ;; * Added `concat', `vconcat' loop clauses. | |
61 | ;; * Cleaned up a number of compiler warnings. | |
62 | ||
63 | ;; Version 2.01 (7 Jul 93): | |
64 | ;; * Added support for FSF version of Emacs 19. | |
65 | ;; * Added `add-hook' for Emacs 18 users. | |
66 | ;; * Added `defsubst*' and `symbol-macrolet'. | |
67 | ;; * Added `maplist', `mapc', `mapl', `mapcan', `mapcon'. | |
68 | ;; * Added `map', `concatenate', `reduce', `merge'. | |
69 | ;; * Added `revappend', `nreconc', `tailp', `tree-equal'. | |
70 | ;; * Added `assert', `check-type', `typecase', `typep', and `deftype'. | |
71 | ;; * Added destructuring and `&environment' support to `defmacro*'. | |
72 | ;; * Added destructuring to `loop', and added the following clauses: | |
73 | ;; `elements', `frames', `overlays', `intervals', `buffers', `key-seqs'. | |
74 | ;; * Renamed `delete' to `delete*' and `remove' to `remove*'. | |
75 | ;; * Completed support for all keywords in `remove*', `substitute', etc. | |
76 | ;; * Added `most-positive-float' and company. | |
77 | ;; * Fixed hash tables to work with latest Lucid Emacs. | |
78 | ;; * `proclaim' forms are no longer compile-time-evaluating; use `declaim'. | |
79 | ;; * Syntax for `warn' declarations has changed. | |
80 | ;; * Improved implementation of `random*'. | |
81 | ;; * Moved most sequence functions to a new file, cl-seq.el. | |
82 | ;; * Moved `eval-when' into cl-macs.el. | |
83 | ;; * Moved `pushnew' and `adjoin' to cl.el for most common cases. | |
84 | ;; * Moved `provide' forms down to ends of files. | |
85 | ;; * Changed expansion of `pop' to something that compiles to better code. | |
86 | ;; * Changed so that no patch is required for Emacs 19 byte compiler. | |
87 | ;; * Made more things dependent on `optimize' declarations. | |
88 | ;; * Added a partial implementation of struct print functions. | |
89 | ;; * Miscellaneous minor changes. | |
90 | ||
91 | ;; Version 2.00: | |
92 | ;; * First public release of this package. | |
93 | ||
94 | ||
07b3798c | 95 | ;;; Code: |
fcd73769 | 96 | |
fcd73769 RS |
97 | (defvar cl-optimize-speed 1) |
98 | (defvar cl-optimize-safety 1) | |
99 | ||
100 | ||
7dcf6269 | 101 | ;;;###autoload |
fcd73769 RS |
102 | (defvar custom-print-functions nil |
103 | "This is a list of functions that format user objects for printing. | |
104 | Each function is called in turn with three arguments: the object, the | |
105 | stream, and the print level (currently ignored). If it is able to | |
106 | print the object it returns true; otherwise it returns nil and the | |
107 | printer proceeds to the next function on the list. | |
108 | ||
109 | This variable is not used at present, but it is defined in hopes that | |
110 | a future Emacs interpreter will be able to use it.") | |
111 | ||
61f1ca4e | 112 | (add-hook 'cl-unload-hook 'cl-cannot-unload) |
7a21fef9 RS |
113 | (defun cl-cannot-unload () |
114 | (error "Cannot unload the feature `cl'")) | |
fcd73769 | 115 | |
fcd73769 RS |
116 | ;;; Generalized variables. These macros are defined here so that they |
117 | ;;; can safely be used in .emacs files. | |
118 | ||
119 | (defmacro incf (place &optional x) | |
64a4c526 | 120 | "Increment PLACE by X (1 by default). |
fcd73769 RS |
121 | PLACE may be a symbol, or any generalized variable allowed by `setf'. |
122 | The return value is the incremented value of PLACE." | |
123 | (if (symbolp place) | |
124 | (list 'setq place (if x (list '+ place x) (list '1+ place))) | |
125 | (list 'callf '+ place (or x 1)))) | |
126 | ||
127 | (defmacro decf (place &optional x) | |
64a4c526 | 128 | "Decrement PLACE by X (1 by default). |
fcd73769 RS |
129 | PLACE may be a symbol, or any generalized variable allowed by `setf'. |
130 | The return value is the decremented value of PLACE." | |
131 | (if (symbolp place) | |
132 | (list 'setq place (if x (list '- place x) (list '1- place))) | |
133 | (list 'callf '- place (or x 1)))) | |
134 | ||
135 | (defmacro pop (place) | |
64a4c526 | 136 | "Remove and return the head of the list stored in PLACE. |
fcd73769 RS |
137 | Analogous to (prog1 (car PLACE) (setf PLACE (cdr PLACE))), though more |
138 | careful about evaluating each argument only once and in the right order. | |
139 | PLACE may be a symbol, or any generalized variable allowed by `setf'." | |
140 | (if (symbolp place) | |
141 | (list 'car (list 'prog1 place (list 'setq place (list 'cdr place)))) | |
142 | (cl-do-pop place))) | |
143 | ||
144 | (defmacro push (x place) | |
64a4c526 | 145 | "Insert X at the head of the list stored in PLACE. |
fcd73769 RS |
146 | Analogous to (setf PLACE (cons X PLACE)), though more careful about |
147 | evaluating each argument only once and in the right order. PLACE may | |
148 | be a symbol, or any generalized variable allowed by `setf'." | |
149 | (if (symbolp place) (list 'setq place (list 'cons x place)) | |
150 | (list 'callf2 'cons x place))) | |
151 | ||
152 | (defmacro pushnew (x place &rest keys) | |
153 | "(pushnew X PLACE): insert X at the head of the list if not already there. | |
154 | Like (push X PLACE), except that the list is unmodified if X is `eql' to | |
155 | an element already on the list. | |
708c63a6 JB |
156 | \nKeywords supported: :test :test-not :key |
157 | \n(fn X PLACE [KEYWORD VALUE]...)" | |
fcd73769 RS |
158 | (if (symbolp place) (list 'setq place (list* 'adjoin x place keys)) |
159 | (list* 'callf2 'adjoin x place keys))) | |
160 | ||
161 | (defun cl-set-elt (seq n val) | |
162 | (if (listp seq) (setcar (nthcdr n seq) val) (aset seq n val))) | |
163 | ||
164 | (defun cl-set-nthcdr (n list x) | |
165 | (if (<= n 0) x (setcdr (nthcdr (1- n) list) x) list)) | |
166 | ||
167 | (defun cl-set-buffer-substring (start end val) | |
168 | (save-excursion (delete-region start end) | |
169 | (goto-char start) | |
170 | (insert val) | |
171 | val)) | |
172 | ||
173 | (defun cl-set-substring (str start end val) | |
174 | (if end (if (< end 0) (incf end (length str))) | |
175 | (setq end (length str))) | |
87dd507f | 176 | (if (< start 0) (incf start (length str))) |
fcd73769 RS |
177 | (concat (and (> start 0) (substring str 0 start)) |
178 | val | |
179 | (and (< end (length str)) (substring str end)))) | |
180 | ||
181 | ||
182 | ;;; Control structures. | |
183 | ||
184 | ;;; These macros are so simple and so often-used that it's better to have | |
185 | ;;; them all the time than to load them from cl-macs.el. | |
186 | ||
fcd73769 | 187 | (defun cl-map-extents (&rest cl-args) |
f67171e6 | 188 | (apply 'cl-map-overlays cl-args)) |
fcd73769 RS |
189 | |
190 | ||
191 | ;;; Blocks and exits. | |
192 | ||
193 | (defalias 'cl-block-wrapper 'identity) | |
194 | (defalias 'cl-block-throw 'throw) | |
195 | ||
196 | ||
197 | ;;; Multiple values. True multiple values are not supported, or even | |
198 | ;;; simulated. Instead, multiple-value-bind and friends simply expect | |
199 | ;;; the target form to return the values as a list. | |
200 | ||
413da451 RS |
201 | (defsubst values (&rest values) |
202 | "Return multiple values, Common Lisp style. | |
203 | The arguments of `values' are the values | |
204 | that the containing function should return." | |
8f7ef366 | 205 | values) |
413da451 RS |
206 | |
207 | (defsubst values-list (list) | |
208 | "Return multiple values, Common Lisp style, taken from a list. | |
209 | LIST specifies the list of values | |
210 | that the containing function should return." | |
211 | list) | |
212 | ||
213 | (defsubst multiple-value-list (expression) | |
214 | "Return a list of the multiple values produced by EXPRESSION. | |
215 | This handles multiple values in Common Lisp style, but it does not | |
216 | work right when EXPRESSION calls an ordinary Emacs Lisp function | |
217 | that returns just one value." | |
218 | expression) | |
219 | ||
220 | (defsubst multiple-value-apply (function expression) | |
221 | "Evaluate EXPRESSION to get multiple values and apply FUNCTION to them. | |
222 | This handles multiple values in Common Lisp style, but it does not work | |
223 | right when EXPRESSION calls an ordinary Emacs Lisp function that returns just | |
224 | one value." | |
225 | (apply function expression)) | |
226 | ||
a2e74caa SM |
227 | (defalias 'multiple-value-call 'apply |
228 | "Apply FUNCTION to ARGUMENTS, taking multiple values into account. | |
229 | This implementation only handles the case where there is only one argument.") | |
f988b541 | 230 | |
413da451 RS |
231 | (defsubst nth-value (n expression) |
232 | "Evaluate EXPRESSION to get multiple values and return the Nth one. | |
233 | This handles multiple values in Common Lisp style, but it does not work | |
234 | right when EXPRESSION calls an ordinary Emacs Lisp function that returns just | |
235 | one value." | |
236 | (nth n expression)) | |
fcd73769 RS |
237 | |
238 | ;;; Macros. | |
239 | ||
240 | (defvar cl-macro-environment nil) | |
241 | (defvar cl-old-macroexpand (prog1 (symbol-function 'macroexpand) | |
242 | (defalias 'macroexpand 'cl-macroexpand))) | |
243 | ||
244 | (defun cl-macroexpand (cl-macro &optional cl-env) | |
2a8160e6 RS |
245 | "Return result of expanding macros at top level of FORM. |
246 | If FORM is not a macro call, it is returned unchanged. | |
247 | Otherwise, the macro is expanded and the expansion is considered | |
248 | in place of FORM. When a non-macro-call results, it is returned. | |
249 | ||
f15e298c | 250 | The second optional arg ENVIRONMENT specifies an environment of macro |
708c63a6 JB |
251 | definitions to shadow the loaded ones for use in file byte-compilation. |
252 | \n(fn FORM &optional ENVIRONMENT)" | |
fcd73769 RS |
253 | (let ((cl-macro-environment cl-env)) |
254 | (while (progn (setq cl-macro (funcall cl-old-macroexpand cl-macro cl-env)) | |
255 | (and (symbolp cl-macro) | |
256 | (cdr (assq (symbol-name cl-macro) cl-env)))) | |
257 | (setq cl-macro (cadr (assq (symbol-name cl-macro) cl-env)))) | |
258 | cl-macro)) | |
259 | ||
260 | ||
261 | ;;; Declarations. | |
262 | ||
263 | (defvar cl-compiling-file nil) | |
264 | (defun cl-compiling-file () | |
265 | (or cl-compiling-file | |
266 | (and (boundp 'outbuffer) (bufferp (symbol-value 'outbuffer)) | |
267 | (equal (buffer-name (symbol-value 'outbuffer)) | |
268 | " *Compiler Output*")))) | |
269 | ||
270 | (defvar cl-proclaims-deferred nil) | |
271 | ||
272 | (defun proclaim (spec) | |
273 | (if (fboundp 'cl-do-proclaim) (cl-do-proclaim spec t) | |
274 | (push spec cl-proclaims-deferred)) | |
275 | nil) | |
276 | ||
277 | (defmacro declaim (&rest specs) | |
278 | (let ((body (mapcar (function (lambda (x) (list 'proclaim (list 'quote x)))) | |
279 | specs))) | |
280 | (if (cl-compiling-file) (list* 'eval-when '(compile load eval) body) | |
281 | (cons 'progn body)))) ; avoid loading cl-macs.el for eval-when | |
282 | ||
283 | ||
284 | ;;; Symbols. | |
285 | ||
286 | (defun cl-random-time () | |
287 | (let* ((time (copy-sequence (current-time-string))) (i (length time)) (v 0)) | |
288 | (while (>= (decf i) 0) (setq v (+ (* v 3) (aref time i)))) | |
289 | v)) | |
290 | ||
291 | (defvar *gensym-counter* (* (logand (cl-random-time) 1023) 100)) | |
292 | ||
293 | ||
294 | ;;; Numbers. | |
295 | ||
708c63a6 | 296 | (defun floatp-safe (object) |
f4db41fc | 297 | "Return t if OBJECT is a floating point number. |
fcd73769 RS |
298 | On Emacs versions that lack floating-point support, this function |
299 | always returns nil." | |
708c63a6 | 300 | (and (numberp object) (not (integerp object)))) |
fcd73769 | 301 | |
708c63a6 | 302 | (defun plusp (number) |
f4db41fc | 303 | "Return t if NUMBER is positive." |
708c63a6 | 304 | (> number 0)) |
fcd73769 | 305 | |
708c63a6 | 306 | (defun minusp (number) |
f4db41fc | 307 | "Return t if NUMBER is negative." |
708c63a6 | 308 | (< number 0)) |
fcd73769 | 309 | |
708c63a6 | 310 | (defun oddp (integer) |
f4db41fc | 311 | "Return t if INTEGER is odd." |
708c63a6 | 312 | (eq (logand integer 1) 1)) |
fcd73769 | 313 | |
708c63a6 | 314 | (defun evenp (integer) |
f4db41fc | 315 | "Return t if INTEGER is even." |
708c63a6 | 316 | (eq (logand integer 1) 0)) |
fcd73769 | 317 | |
fcd73769 RS |
318 | (defvar *random-state* (vector 'cl-random-state-tag -1 30 (cl-random-time))) |
319 | ||
fcd73769 RS |
320 | ;;; The following are actually set by cl-float-limits. |
321 | (defconst most-positive-float nil) | |
322 | (defconst most-negative-float nil) | |
323 | (defconst least-positive-float nil) | |
324 | (defconst least-negative-float nil) | |
325 | (defconst least-positive-normalized-float nil) | |
326 | (defconst least-negative-normalized-float nil) | |
327 | (defconst float-epsilon nil) | |
328 | (defconst float-negative-epsilon nil) | |
329 | ||
330 | ||
331 | ;;; Sequence functions. | |
332 | ||
333 | (defalias 'copy-seq 'copy-sequence) | |
334 | ||
335 | (defun mapcar* (cl-func cl-x &rest cl-rest) | |
336 | "Apply FUNCTION to each element of SEQ, and make a list of the results. | |
337 | If there are several SEQs, FUNCTION is called with that many arguments, | |
338 | and mapping stops as soon as the shortest list runs out. With just one | |
339 | SEQ, this is like `mapcar'. With several, it is like the Common Lisp | |
708c63a6 JB |
340 | `mapcar' function extended to arbitrary sequence types. |
341 | \n(fn FUNCTION SEQ...)" | |
fcd73769 RS |
342 | (if cl-rest |
343 | (if (or (cdr cl-rest) (nlistp cl-x) (nlistp (car cl-rest))) | |
344 | (cl-mapcar-many cl-func (cons cl-x cl-rest)) | |
345 | (let ((cl-res nil) (cl-y (car cl-rest))) | |
346 | (while (and cl-x cl-y) | |
347 | (push (funcall cl-func (pop cl-x) (pop cl-y)) cl-res)) | |
348 | (nreverse cl-res))) | |
349 | (mapcar cl-func cl-x))) | |
350 | ||
686d0681 | 351 | (defalias 'svref 'aref) |
fcd73769 RS |
352 | |
353 | ;;; List functions. | |
354 | ||
355 | (defalias 'first 'car) | |
dc79c3ea | 356 | (defalias 'second 'cadr) |
fcd73769 RS |
357 | (defalias 'rest 'cdr) |
358 | (defalias 'endp 'null) | |
359 | ||
dc79c3ea | 360 | (defun third (x) |
b7a90344 SM |
361 | "Return the third element of the list X." |
362 | (car (cdr (cdr x)))) | |
fcd73769 | 363 | |
dc79c3ea | 364 | (defun fourth (x) |
b7a90344 SM |
365 | "Return the fourth element of the list X." |
366 | (nth 3 x)) | |
fcd73769 | 367 | |
dc79c3ea | 368 | (defun fifth (x) |
b7a90344 SM |
369 | "Return the fifth element of the list X." |
370 | (nth 4 x)) | |
fcd73769 | 371 | |
dc79c3ea | 372 | (defun sixth (x) |
b7a90344 SM |
373 | "Return the sixth element of the list X." |
374 | (nth 5 x)) | |
fcd73769 | 375 | |
dc79c3ea | 376 | (defun seventh (x) |
b7a90344 SM |
377 | "Return the seventh element of the list X." |
378 | (nth 6 x)) | |
fcd73769 | 379 | |
dc79c3ea | 380 | (defun eighth (x) |
b7a90344 SM |
381 | "Return the eighth element of the list X." |
382 | (nth 7 x)) | |
fcd73769 | 383 | |
dc79c3ea | 384 | (defun ninth (x) |
b7a90344 SM |
385 | "Return the ninth element of the list X." |
386 | (nth 8 x)) | |
fcd73769 | 387 | |
dc79c3ea | 388 | (defun tenth (x) |
b7a90344 SM |
389 | "Return the tenth element of the list X." |
390 | (nth 9 x)) | |
fcd73769 | 391 | |
fcd73769 RS |
392 | (defun caaar (x) |
393 | "Return the `car' of the `car' of the `car' of X." | |
394 | (car (car (car x)))) | |
395 | ||
396 | (defun caadr (x) | |
397 | "Return the `car' of the `car' of the `cdr' of X." | |
398 | (car (car (cdr x)))) | |
399 | ||
400 | (defun cadar (x) | |
401 | "Return the `car' of the `cdr' of the `car' of X." | |
402 | (car (cdr (car x)))) | |
403 | ||
404 | (defun caddr (x) | |
405 | "Return the `car' of the `cdr' of the `cdr' of X." | |
406 | (car (cdr (cdr x)))) | |
407 | ||
408 | (defun cdaar (x) | |
409 | "Return the `cdr' of the `car' of the `car' of X." | |
410 | (cdr (car (car x)))) | |
411 | ||
412 | (defun cdadr (x) | |
413 | "Return the `cdr' of the `car' of the `cdr' of X." | |
414 | (cdr (car (cdr x)))) | |
415 | ||
416 | (defun cddar (x) | |
417 | "Return the `cdr' of the `cdr' of the `car' of X." | |
418 | (cdr (cdr (car x)))) | |
419 | ||
420 | (defun cdddr (x) | |
421 | "Return the `cdr' of the `cdr' of the `cdr' of X." | |
422 | (cdr (cdr (cdr x)))) | |
423 | ||
424 | (defun caaaar (x) | |
425 | "Return the `car' of the `car' of the `car' of the `car' of X." | |
426 | (car (car (car (car x))))) | |
427 | ||
428 | (defun caaadr (x) | |
429 | "Return the `car' of the `car' of the `car' of the `cdr' of X." | |
430 | (car (car (car (cdr x))))) | |
431 | ||
432 | (defun caadar (x) | |
433 | "Return the `car' of the `car' of the `cdr' of the `car' of X." | |
434 | (car (car (cdr (car x))))) | |
435 | ||
436 | (defun caaddr (x) | |
437 | "Return the `car' of the `car' of the `cdr' of the `cdr' of X." | |
438 | (car (car (cdr (cdr x))))) | |
439 | ||
440 | (defun cadaar (x) | |
441 | "Return the `car' of the `cdr' of the `car' of the `car' of X." | |
442 | (car (cdr (car (car x))))) | |
443 | ||
444 | (defun cadadr (x) | |
445 | "Return the `car' of the `cdr' of the `car' of the `cdr' of X." | |
446 | (car (cdr (car (cdr x))))) | |
447 | ||
448 | (defun caddar (x) | |
449 | "Return the `car' of the `cdr' of the `cdr' of the `car' of X." | |
450 | (car (cdr (cdr (car x))))) | |
451 | ||
452 | (defun cadddr (x) | |
453 | "Return the `car' of the `cdr' of the `cdr' of the `cdr' of X." | |
454 | (car (cdr (cdr (cdr x))))) | |
455 | ||
456 | (defun cdaaar (x) | |
457 | "Return the `cdr' of the `car' of the `car' of the `car' of X." | |
458 | (cdr (car (car (car x))))) | |
459 | ||
460 | (defun cdaadr (x) | |
461 | "Return the `cdr' of the `car' of the `car' of the `cdr' of X." | |
462 | (cdr (car (car (cdr x))))) | |
463 | ||
464 | (defun cdadar (x) | |
465 | "Return the `cdr' of the `car' of the `cdr' of the `car' of X." | |
466 | (cdr (car (cdr (car x))))) | |
467 | ||
468 | (defun cdaddr (x) | |
469 | "Return the `cdr' of the `car' of the `cdr' of the `cdr' of X." | |
470 | (cdr (car (cdr (cdr x))))) | |
471 | ||
472 | (defun cddaar (x) | |
473 | "Return the `cdr' of the `cdr' of the `car' of the `car' of X." | |
474 | (cdr (cdr (car (car x))))) | |
475 | ||
476 | (defun cddadr (x) | |
477 | "Return the `cdr' of the `cdr' of the `car' of the `cdr' of X." | |
478 | (cdr (cdr (car (cdr x))))) | |
479 | ||
480 | (defun cdddar (x) | |
481 | "Return the `cdr' of the `cdr' of the `cdr' of the `car' of X." | |
482 | (cdr (cdr (cdr (car x))))) | |
483 | ||
484 | (defun cddddr (x) | |
485 | "Return the `cdr' of the `cdr' of the `cdr' of the `cdr' of X." | |
486 | (cdr (cdr (cdr (cdr x))))) | |
487 | ||
f9efebca RS |
488 | ;;(defun last* (x &optional n) |
489 | ;; "Returns the last link in the list LIST. | |
490 | ;;With optional argument N, returns Nth-to-last link (default 1)." | |
491 | ;; (if n | |
492 | ;; (let ((m 0) (p x)) | |
493 | ;; (while (consp p) (incf m) (pop p)) | |
494 | ;; (if (<= n 0) p | |
495 | ;; (if (< n m) (nthcdr (- m n) x) x))) | |
496 | ;; (while (consp (cdr x)) (pop x)) | |
497 | ;; x)) | |
fcd73769 | 498 | |
fcd73769 | 499 | (defun list* (arg &rest rest) ; See compiler macro in cl-macs.el |
708c63a6 | 500 | "Return a new list with specified ARGs as elements, consed to last ARG. |
fcd73769 | 501 | Thus, `(list* A B C D)' is equivalent to `(nconc (list A B C) D)', or to |
708c63a6 JB |
502 | `(cons A (cons B (cons C D)))'. |
503 | \n(fn ARG...)" | |
fcd73769 RS |
504 | (cond ((not rest) arg) |
505 | ((not (cdr rest)) (cons arg (car rest))) | |
506 | (t (let* ((n (length rest)) | |
507 | (copy (copy-sequence rest)) | |
508 | (last (nthcdr (- n 2) copy))) | |
509 | (setcdr last (car (cdr last))) | |
510 | (cons arg copy))))) | |
511 | ||
512 | (defun ldiff (list sublist) | |
513 | "Return a copy of LIST with the tail SUBLIST removed." | |
514 | (let ((res nil)) | |
515 | (while (and (consp list) (not (eq list sublist))) | |
516 | (push (pop list) res)) | |
517 | (nreverse res))) | |
518 | ||
6b25a2f5 | 519 | (defun copy-list (list) |
708c63a6 JB |
520 | "Return a copy of LIST, which may be a dotted list. |
521 | The elements of LIST are not copied, just the list structure itself." | |
6b25a2f5 RS |
522 | (if (consp list) |
523 | (let ((res nil)) | |
524 | (while (consp list) (push (pop list) res)) | |
525 | (prog1 (nreverse res) (setcdr res list))) | |
526 | (car list))) | |
527 | ||
fcd73769 RS |
528 | (defun cl-maclisp-member (item list) |
529 | (while (and list (not (equal item (car list)))) (setq list (cdr list))) | |
530 | list) | |
531 | ||
fcd73769 RS |
532 | (defalias 'cl-member 'memq) ; for compatibility with old CL package |
533 | (defalias 'cl-floor 'floor*) | |
534 | (defalias 'cl-ceiling 'ceiling*) | |
535 | (defalias 'cl-truncate 'truncate*) | |
536 | (defalias 'cl-round 'round*) | |
537 | (defalias 'cl-mod 'mod*) | |
538 | ||
539 | (defun adjoin (cl-item cl-list &rest cl-keys) ; See compiler macro in cl-macs | |
540 | "Return ITEM consed onto the front of LIST only if it's not already there. | |
541 | Otherwise, return LIST unmodified. | |
708c63a6 JB |
542 | \nKeywords supported: :test :test-not :key |
543 | \n(fn ITEM LIST [KEYWORD VALUE]...)" | |
fcd73769 RS |
544 | (cond ((or (equal cl-keys '(:test eq)) |
545 | (and (null cl-keys) (not (numberp cl-item)))) | |
546 | (if (memq cl-item cl-list) cl-list (cons cl-item cl-list))) | |
547 | ((or (equal cl-keys '(:test equal)) (null cl-keys)) | |
548 | (if (member cl-item cl-list) cl-list (cons cl-item cl-list))) | |
549 | (t (apply 'cl-adjoin cl-item cl-list cl-keys)))) | |
550 | ||
551 | (defun subst (cl-new cl-old cl-tree &rest cl-keys) | |
552 | "Substitute NEW for OLD everywhere in TREE (non-destructively). | |
553 | Return a copy of TREE with all elements `eql' to OLD replaced by NEW. | |
708c63a6 JB |
554 | \nKeywords supported: :test :test-not :key |
555 | \n(fn NEW OLD TREE [KEYWORD VALUE]...)" | |
fcd73769 RS |
556 | (if (or cl-keys (and (numberp cl-old) (not (integerp cl-old)))) |
557 | (apply 'sublis (list (cons cl-old cl-new)) cl-tree cl-keys) | |
558 | (cl-do-subst cl-new cl-old cl-tree))) | |
559 | ||
560 | (defun cl-do-subst (cl-new cl-old cl-tree) | |
561 | (cond ((eq cl-tree cl-old) cl-new) | |
562 | ((consp cl-tree) | |
563 | (let ((a (cl-do-subst cl-new cl-old (car cl-tree))) | |
564 | (d (cl-do-subst cl-new cl-old (cdr cl-tree)))) | |
565 | (if (and (eq a (car cl-tree)) (eq d (cdr cl-tree))) | |
566 | cl-tree (cons a d)))) | |
567 | (t cl-tree))) | |
568 | ||
868904eb JB |
569 | (defun acons (key value alist) |
570 | "Add KEY and VALUE to ALIST. | |
571 | Return a new list with (cons KEY VALUE) as car and ALIST as cdr." | |
572 | (cons (cons key value) alist)) | |
573 | ||
574 | (defun pairlis (keys values &optional alist) | |
575 | "Make an alist from KEYS and VALUES. | |
576 | Return a new alist composed by associating KEYS to corresponding VALUES; | |
577 | the process stops as soon as KEYS or VALUES run out. | |
578 | If ALIST is non-nil, the new pairs are prepended to it." | |
579 | (nconc (mapcar* 'cons keys values) alist)) | |
fcd73769 RS |
580 | |
581 | ||
582 | ;;; Miscellaneous. | |
583 | ||
ed590ca8 GM |
584 | (defvar cl-fake-autoloads nil |
585 | "Non-nil means don't make CL functions autoload.") | |
586 | ||
fcd73769 | 587 | ;;; Autoload the other portions of the package. |
3e7274ae | 588 | ;; We want to replace the basic versions of dolist, dotimes, declare below. |
335db3c1 DL |
589 | (fmakunbound 'dolist) |
590 | (fmakunbound 'dotimes) | |
637692f4 | 591 | (fmakunbound 'declare) |
fcd73769 RS |
592 | (mapcar (function |
593 | (lambda (set) | |
ed590ca8 GM |
594 | (let ((file (if cl-fake-autoloads "<none>" (car set)))) |
595 | (mapcar (function | |
596 | (lambda (func) | |
597 | (autoload func (car set) nil nil (nth 1 set)))) | |
598 | (cddr set))))) | |
fcd73769 RS |
599 | '(("cl-extra" nil |
600 | coerce equalp cl-map-keymap maplist mapc mapl mapcan mapcon | |
601 | cl-map-keymap cl-map-keymap-recursively cl-map-intervals | |
602 | cl-map-overlays cl-set-frame-visible-p cl-float-limits | |
a599ac7c | 603 | gcd lcm isqrt floor* ceiling* truncate* round* |
fcd73769 RS |
604 | mod* rem* signum random* make-random-state random-state-p |
605 | subseq concatenate cl-mapcar-many map some every notany | |
606 | notevery revappend nreconc list-length tailp copy-tree get* getf | |
f67171e6 DL |
607 | cl-set-getf cl-do-remf remprop cl-make-hash-table cl-hash-lookup |
608 | cl-gethash cl-puthash cl-remhash cl-clrhash cl-maphash cl-hash-table-p | |
609 | cl-hash-table-count cl-progv-before cl-prettyexpand | |
fcd73769 RS |
610 | cl-macroexpand-all) |
611 | ("cl-seq" nil | |
ed590ca8 | 612 | reduce fill replace remove* remove-if remove-if-not |
a599ac7c | 613 | delete* delete-if delete-if-not remove-duplicates |
fcd73769 RS |
614 | delete-duplicates substitute substitute-if substitute-if-not |
615 | nsubstitute nsubstitute-if nsubstitute-if-not find find-if | |
616 | find-if-not position position-if position-if-not count count-if | |
617 | count-if-not mismatch search sort* stable-sort merge member* | |
618 | member-if member-if-not cl-adjoin assoc* assoc-if assoc-if-not | |
a599ac7c | 619 | rassoc* rassoc-if rassoc-if-not union nunion intersection |
fcd73769 RS |
620 | nintersection set-difference nset-difference set-exclusive-or |
621 | nset-exclusive-or subsetp subst-if subst-if-not nsubst nsubst-if | |
622 | nsubst-if-not sublis nsublis tree-equal) | |
623 | ("cl-macs" nil | |
624 | gensym gentemp typep cl-do-pop get-setf-method | |
625 | cl-struct-setf-expander compiler-macroexpand cl-compile-time-init) | |
626 | ("cl-macs" t | |
627 | defun* defmacro* function* destructuring-bind eval-when | |
f67171e6 | 628 | load-time-value case ecase typecase etypecase |
cc4dfff0 | 629 | block return return-from loop do do* dolist dotimes do-symbols |
fcd73769 RS |
630 | do-all-symbols psetq progv flet labels macrolet symbol-macrolet |
631 | lexical-let lexical-let* multiple-value-bind multiple-value-setq | |
632 | locally the declare define-setf-method defsetf define-modify-macro | |
633 | setf psetf remf shiftf rotatef letf letf* callf callf2 defstruct | |
634 | check-type assert ignore-errors define-compiler-macro))) | |
635 | ||
636 | ;;; Define data for indentation and edebug. | |
637 | (mapcar (function | |
638 | (lambda (entry) | |
639 | (mapcar (function | |
640 | (lambda (func) | |
641 | (put func 'lisp-indent-function (nth 1 entry)) | |
642 | (put func 'lisp-indent-hook (nth 1 entry)) | |
643 | (or (get func 'edebug-form-spec) | |
644 | (put func 'edebug-form-spec (nth 2 entry))))) | |
645 | (car entry)))) | |
646 | '(((defun* defmacro*) 2) | |
647 | ((function*) nil | |
648 | (&or symbolp ([&optional 'macro] 'lambda (&rest sexp) &rest form))) | |
649 | ((eval-when) 1 (sexp &rest form)) | |
fcd73769 RS |
650 | ((declare) nil (&rest sexp)) |
651 | ((the) 1 (sexp &rest form)) | |
652 | ((case ecase typecase etypecase) 1 (form &rest (sexp &rest form))) | |
653 | ((block return-from) 1 (sexp &rest form)) | |
654 | ((return) nil (&optional form)) | |
655 | ((do do*) 2 ((&rest &or symbolp (symbolp &optional form form)) | |
656 | (form &rest form) | |
657 | &rest form)) | |
fcd73769 RS |
658 | ((do-symbols) 1 ((symbolp form &optional form form) &rest form)) |
659 | ((do-all-symbols) 1 ((symbolp form &optional form) &rest form)) | |
660 | ((psetq setf psetf) nil edebug-setq-form) | |
661 | ((progv) 2 (&rest form)) | |
662 | ((flet labels macrolet) 1 | |
663 | ((&rest (sexp sexp &rest form)) &rest form)) | |
664 | ((symbol-macrolet lexical-let lexical-let*) 1 | |
665 | ((&rest &or symbolp (symbolp form)) &rest form)) | |
666 | ((multiple-value-bind) 2 ((&rest symbolp) &rest form)) | |
667 | ((multiple-value-setq) 1 ((&rest symbolp) &rest form)) | |
7df85084 | 668 | ((incf decf remf pushnew shiftf rotatef) nil (&rest form)) |
fcd73769 RS |
669 | ((letf letf*) 1 ((&rest (&rest form)) &rest form)) |
670 | ((callf destructuring-bind) 2 (sexp form &rest form)) | |
671 | ((callf2) 3 (sexp form form &rest form)) | |
672 | ((loop) nil (&rest &or symbolp form)) | |
673 | ((ignore-errors) 0 (&rest form)))) | |
674 | ||
675 | ||
676 | ;;; This goes here so that cl-macs can find it if it loads right now. | |
677 | (provide 'cl-19) ; usage: (require 'cl-19 "cl") | |
678 | ||
679 | ||
680 | ;;; Things to do after byte-compiler is loaded. | |
681 | ;;; As a side effect, we cause cl-macs to be loaded when compiling, so | |
682 | ;;; that the compiler-macros defined there will be present. | |
683 | ||
684 | (defvar cl-hacked-flag nil) | |
685 | (defun cl-hack-byte-compiler () | |
686 | (if (and (not cl-hacked-flag) (fboundp 'byte-compile-file-form)) | |
687 | (progn | |
87dd507f SM |
688 | (setq cl-hacked-flag t) ; Do it first, to prevent recursion. |
689 | (cl-compile-time-init)))) ; In cl-macs.el. | |
fcd73769 RS |
690 | |
691 | ;;; Try it now in case the compiler has already been loaded. | |
692 | (cl-hack-byte-compiler) | |
693 | ||
694 | ;;; Also make a hook in case compiler is loaded after this file. | |
0d752cda | 695 | (add-hook 'bytecomp-load-hook 'cl-hack-byte-compiler) |
fcd73769 RS |
696 | |
697 | ||
698 | ;;; The following ensures that packages which expect the old-style cl.el | |
699 | ;;; will be happy with this one. | |
700 | ||
701 | (provide 'cl) | |
702 | ||
fcd73769 RS |
703 | (run-hooks 'cl-load-hook) |
704 | ||
6cd0254f | 705 | ;; arch-tag: 5f07fa74-f153-4524-9303-21f5be125851 |
fcd73769 | 706 | ;;; cl.el ends here |