Mercurial > hg > xemacs-beta
annotate lisp/cl.el @ 5258:1ed4cefddd12
Add a couple of extra docstring backslashes, #'format-time-string
2010-09-05 Aidan Kehoe <kehoea@parhasard.net>
* editfns.c (Fformat_time_string):
Use two backslashes so that there is at least one present in the
output of describe function, when describing the Roman month
number syntax in this function's docstring. Thanks for provoking
me to look at this, Stephen Turnbull.
| author | Aidan Kehoe <kehoea@parhasard.net> |
|---|---|
| date | Sun, 05 Sep 2010 19:22:37 +0100 |
| parents | 2d0937dc83cf |
| children | aa20a889ff14 308d34e9f07d |
| rev | line source |
|---|---|
| 613 | 1 ;;; cl.el --- Common Lisp extensions for XEmacs Lisp |
| 428 | 2 |
| 3 ;; Copyright (C) 1993, 1997 Free Software Foundation, Inc. | |
|
5066
545ec923b4eb
add documentation on keywords to cl*.el
Ben Wing <ben@xemacs.org>
parents:
4995
diff
changeset
|
4 ;; Copyright (C) 2010 Ben Wing. |
| 428 | 5 |
| 6 ;; Author: Dave Gillespie <daveg@synaptics.com> | |
| 7 ;; Maintainer: XEmacs Development Team | |
| 8 ;; Version: 2.02 | |
| 9 ;; Keywords: extensions, dumped, lisp | |
| 10 | |
| 11 ;; This file is part of XEmacs. | |
| 12 | |
| 13 ;; XEmacs is free software; you can redistribute it and/or modify it | |
| 14 ;; under the terms of the GNU General Public License as published by | |
| 15 ;; the Free Software Foundation; either version 2, or (at your option) | |
| 16 ;; any later version. | |
| 17 | |
| 18 ;; XEmacs is distributed in the hope that it will be useful, but | |
| 19 ;; WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 21 ;; General Public License for more details. | |
| 22 | |
| 23 ;; You should have received a copy of the GNU General Public License | |
| 24 ;; along with XEmacs; see the file COPYING. If not, write to the Free | |
| 25 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA | |
| 26 ;; 02111-1307, USA. | |
| 27 | |
| 2153 | 28 ;;; Synched up with: FSF 21.3. |
| 428 | 29 |
| 30 ;;; Commentary: | |
| 31 | |
| 32 ;; This file is dumped with XEmacs. | |
| 33 | |
| 34 ;; These are extensions to Emacs Lisp that provide a degree of | |
| 35 ;; Common Lisp compatibility, beyond what is already built-in | |
| 36 ;; in Emacs Lisp. | |
| 37 ;; | |
| 38 ;; This package was written by Dave Gillespie; it is a complete | |
| 39 ;; rewrite of Cesar Quiroz's original cl.el package of December 1986. | |
| 40 ;; | |
| 41 ;; Bug reports, comments, and suggestions are welcome! | |
| 42 | |
| 43 ;; This file contains the portions of the Common Lisp extensions | |
| 44 ;; package which should always be present. | |
| 45 | |
| 46 | |
| 47 ;;; Future notes: | |
| 48 | |
| 49 ;; Once Emacs 19 becomes standard, many things in this package which are | |
| 50 ;; messy for reasons of compatibility can be greatly simplified. For now, | |
| 51 ;; I prefer to maintain one unified version. | |
| 52 | |
| 53 | |
| 54 ;;; Change Log: | |
| 55 | |
| 56 ;; Version 2.02 (30 Jul 93): | |
| 57 ;; * Added "cl-compat.el" file, extra compatibility with old package. | |
| 58 ;; * Added `lexical-let' and `lexical-let*'. | |
| 59 ;; * Added `define-modify-macro', `callf', and `callf2'. | |
| 60 ;; * Added `ignore-errors'. | |
| 61 ;; * Changed `(setf (nthcdr N PLACE) X)' to work when N is zero. | |
| 62 ;; * Merged `*gentemp-counter*' into `*gensym-counter*'. | |
| 63 ;; * Extended `subseq' to allow negative START and END like `substring'. | |
| 64 ;; * Added `in-ref', `across-ref', `elements of-ref' loop clauses. | |
| 65 ;; * Added `concat', `vconcat' loop clauses. | |
| 66 ;; * Cleaned up a number of compiler warnings. | |
| 67 | |
| 68 ;; Version 2.01 (7 Jul 93): | |
| 69 ;; * Added support for FSF version of Emacs 19. | |
| 70 ;; * Added `add-hook' for Emacs 18 users. | |
| 71 ;; * Added `defsubst*' and `symbol-macrolet'. | |
| 72 ;; * Added `maplist', `mapc', `mapl', `mapcan', `mapcon'. | |
| 73 ;; * Added `map', `concatenate', `reduce', `merge'. | |
| 74 ;; * Added `revappend', `nreconc', `tailp', `tree-equal'. | |
| 75 ;; * Added `assert', `check-type', `typecase', `typep', and `deftype'. | |
| 76 ;; * Added destructuring and `&environment' support to `defmacro*'. | |
| 77 ;; * Added destructuring to `loop', and added the following clauses: | |
| 78 ;; `elements', `frames', `overlays', `intervals', `buffers', `key-seqs'. | |
| 79 ;; * Renamed `delete' to `delete*' and `remove' to `remove*'. | |
| 80 ;; * Completed support for all keywords in `remove*', `substitute', etc. | |
| 81 ;; * Added `most-positive-float' and company. | |
| 82 ;; * Fixed hash tables to work with latest Lucid Emacs. | |
| 83 ;; * `proclaim' forms are no longer compile-time-evaluating; use `declaim'. | |
| 84 ;; * Syntax for `warn' declarations has changed. | |
| 85 ;; * Improved implementation of `random*'. | |
| 86 ;; * Moved most sequence functions to a new file, cl-seq.el. | |
| 87 ;; * Moved `eval-when' into cl-macs.el. | |
| 88 ;; * Moved `pushnew' and `adjoin' to cl.el for most common cases. | |
| 89 ;; * Moved `provide' forms down to ends of files. | |
| 90 ;; * Changed expansion of `pop' to something that compiles to better code. | |
| 91 ;; * Changed so that no patch is required for Emacs 19 byte compiler. | |
| 92 ;; * Made more things dependent on `optimize' declarations. | |
| 93 ;; * Added a partial implementation of struct print functions. | |
| 94 ;; * Miscellaneous minor changes. | |
| 95 | |
| 96 ;; Version 2.00: | |
| 97 ;; * First public release of this package. | |
| 98 | |
| 99 | |
| 100 ;;; Code: | |
| 101 | |
| 102 (defvar cl-optimize-speed 1) | |
| 103 (defvar cl-optimize-safety 1) | |
| 104 | |
| 105 (defvar custom-print-functions nil | |
| 106 "This is a list of functions that format user objects for printing. | |
| 107 Each function is called in turn with three arguments: the object, the | |
| 108 stream, and the print level (currently ignored). If it is able to | |
| 109 print the object it returns true; otherwise it returns nil and the | |
| 110 printer proceeds to the next function on the list. | |
| 111 | |
| 112 This variable is not used at present, but it is defined in hopes that | |
| 113 a future Emacs interpreter will be able to use it.") | |
| 114 | |
| 115 ;;; Predicates. | |
| 116 | |
| 117 (defun eql (a b) ; See compiler macro in cl-macs.el | |
|
4885
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
118 "Return t if the arguments are the same Lisp object, or numerically equal. |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
119 |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
120 They must be of the same type; the difference between `eq' and `eql' is most |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
121 relevant when it comes to the non-fixnum number types. In this |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
122 implementation, fixnums of the same numeric value are always `eq', but this |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
123 is not true for other numeric types, among them floats, bignums and ratios, |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
124 if available. |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
125 |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
126 See also `=' (which doesn't require that its arguments be of the same type, |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
127 but only accepts numeric arguments, characters and markers) and `equal'." |
|
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
128 (or (eq a b) (and (numberp a) (equal a b)))) |
| 428 | 129 |
| 130 ;;; Generalized variables. These macros are defined here so that they | |
| 131 ;;; can safely be used in .emacs files. | |
| 132 | |
| 133 (defmacro incf (place &optional x) | |
| 3343 | 134 "Increment PLACE by X (1 by default). |
| 428 | 135 PLACE may be a symbol, or any generalized variable allowed by `setf'. |
| 136 The return value is the incremented value of PLACE." | |
| 137 (if (symbolp place) | |
| 138 (list 'setq place (if x (list '+ place x) (list '1+ place))) | |
| 139 ;; XEmacs byte-compiler optimizes (+ FOO 1) to (1+ FOO), so this | |
| 140 ;; is OK. | |
| 141 (list 'callf '+ place (or x 1)))) | |
| 142 | |
| 143 (defmacro decf (place &optional x) | |
| 3343 | 144 "Decrement PLACE by X (1 by default). |
| 428 | 145 PLACE may be a symbol, or any generalized variable allowed by `setf'. |
| 146 The return value is the decremented value of PLACE." | |
| 147 (if (symbolp place) | |
| 148 (list 'setq place (if x (list '- place x) (list '1- place))) | |
| 149 (list 'callf '- place (or x 1)))) | |
| 150 | |
| 151 (defmacro pop (place) | |
| 3343 | 152 "Remove and return the head of the list stored in PLACE. |
| 428 | 153 Analogous to (prog1 (car PLACE) (setf PLACE (cdr PLACE))), though more |
| 154 careful about evaluating each argument only once and in the right order. | |
| 155 PLACE may be a symbol, or any generalized variable allowed by `setf'." | |
| 156 (if (symbolp place) | |
| 157 `(car (prog1 ,place (setq ,place (cdr ,place)))) | |
| 158 (cl-do-pop place))) | |
| 159 | |
| 3343 | 160 (defmacro push (newelt listname) |
| 3355 | 161 "Add NEWELT at the beginning of the list stored in LISTNAME. |
| 162 Analogous to (setf LISTNAME (cons NEWELT LISTNAME)), though more careful | |
| 163 about evaluating each argument only once and in the right order. LISTNAME | |
| 164 may be a symbol, or any generalized variable allowed by `setf'; that is, it | |
| 165 does not necessarily have to be a list, though `push' is most often used on | |
| 166 lists. " | |
| 3343 | 167 (if (symbolp listname) `(setq ,listname (cons ,newelt ,listname)) |
| 168 (list 'callf2 'cons newelt listname))) | |
| 428 | 169 |
| 3343 | 170 (defmacro pushnew (newelt listname &rest keys) |
| 3355 | 171 "Add NEWELT at the beginning of LISTNAME, unless it's already in LISTNAME. |
| 3343 | 172 Like (push NEWELT LISTNAME), except that the list is unmodified if NEWELT is |
| 173 `eql' to an element already on the list. | |
|
5066
545ec923b4eb
add documentation on keywords to cl*.el
Ben Wing <ben@xemacs.org>
parents:
4995
diff
changeset
|
174 Keywords supported: :test :test-not :key |
|
545ec923b4eb
add documentation on keywords to cl*.el
Ben Wing <ben@xemacs.org>
parents:
4995
diff
changeset
|
175 See `member*' for the meaning of :test, :test-not and :key." |
| 3343 | 176 (if (symbolp listname) (list 'setq listname |
| 177 (list* 'adjoin newelt listname keys)) | |
| 178 (list* 'callf2 'adjoin newelt listname keys))) | |
| 428 | 179 |
| 180 (defun cl-set-elt (seq n val) | |
| 181 (if (listp seq) (setcar (nthcdr n seq) val) (aset seq n val))) | |
| 182 | |
| 183 (defun cl-set-nthcdr (n list x) | |
| 184 (if (<= n 0) x (setcdr (nthcdr (1- n) list) x) list)) | |
| 185 | |
| 186 (defun cl-set-buffer-substring (start end val) | |
| 187 (save-excursion (delete-region start end) | |
| 188 (goto-char start) | |
| 189 (insert val) | |
| 190 val)) | |
| 191 | |
| 192 (defun cl-set-substring (str start end val) | |
| 193 (if end (if (< end 0) (incf end (length str))) | |
| 194 (setq end (length str))) | |
| 2136 | 195 (if (< start 0) (incf start (length str))) |
| 428 | 196 (concat (and (> start 0) (substring str 0 start)) |
| 197 val | |
| 198 (and (< end (length str)) (substring str end)))) | |
| 199 | |
| 200 ;;; Control structures. | |
| 201 | |
| 202 ;; The macros `when' and `unless' are so useful that we want them to | |
| 203 ;; ALWAYS be available. So they've been moved from cl.el to eval.c. | |
| 204 ;; Note: FSF Emacs moved them to subr.el in FSF 20. | |
| 205 | |
| 2153 | 206 (defalias 'cl-map-extents 'map-extents) |
| 428 | 207 |
| 208 ;;; Blocks and exits. | |
| 209 | |
|
4677
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3355
diff
changeset
|
210 ;; This used to be #'identity, but that didn't preserve multiple values in |
|
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3355
diff
changeset
|
211 ;; interpreted code. #'and isn't great either, there's no error on too many |
|
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3355
diff
changeset
|
212 ;; arguments passed to it when interpreted. Fortunately most of the places |
|
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3355
diff
changeset
|
213 ;; where cl-block-wrapper is called are generated from old, established |
|
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3355
diff
changeset
|
214 ;; macros, so too many arguments resulting from human error is unlikely; and |
|
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3355
diff
changeset
|
215 ;; the byte compile handler in cl-macs.el warns if more than one arg is |
|
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3355
diff
changeset
|
216 ;; passed to it. |
|
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3355
diff
changeset
|
217 (defalias 'cl-block-wrapper 'and) |
|
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3355
diff
changeset
|
218 |
| 428 | 219 (defalias 'cl-block-throw 'throw) |
| 220 | |
|
4677
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3355
diff
changeset
|
221 ;;; XEmacs; multiple values are in eval.c and cl-macs.el. |
| 2153 | 222 |
|
4677
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3355
diff
changeset
|
223 ;;; We no longer support `multiple-value-apply', which was ill-conceived to |
|
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3355
diff
changeset
|
224 ;;; start with, is not specified by Common Lisp, and which nothing uses, |
|
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3355
diff
changeset
|
225 ;;; according to Google Code Search, as of Sat Mar 14 23:31:35 GMT 2009. |
| 2153 | 226 |
|
4677
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3355
diff
changeset
|
227 (make-obsolete 'multiple-value-apply 'multiple-value-call) |
| 428 | 228 |
| 229 ;;; Macros. | |
| 230 | |
| 231 (defvar cl-macro-environment nil) | |
| 232 ;; XEmacs: we renamed the internal function to macroexpand-internal | |
| 233 ;; to avoid doc-file problems. | |
| 234 (defvar cl-old-macroexpand (prog1 (symbol-function 'macroexpand-internal) | |
| 235 (defalias 'macroexpand 'cl-macroexpand))) | |
| 236 | |
| 237 (defun cl-macroexpand (cl-macro &optional cl-env) | |
| 238 "Return result of expanding macros at top level of FORM. | |
| 239 If FORM is not a macro call, it is returned unchanged. | |
| 240 Otherwise, the macro is expanded and the expansion is considered | |
| 241 in place of FORM. When a non-macro-call results, it is returned. | |
| 242 | |
| 442 | 243 The second optional arg ENVIRONMENT specifies an environment of macro |
| 428 | 244 definitions to shadow the loaded ones for use in file byte-compilation." |
| 245 (let ((cl-macro-environment cl-env)) | |
| 246 (while (progn (setq cl-macro (funcall cl-old-macroexpand cl-macro cl-env)) | |
| 247 (and (symbolp cl-macro) | |
| 248 (cdr (assq (symbol-name cl-macro) cl-env)))) | |
| 249 (setq cl-macro (cadr (assq (symbol-name cl-macro) cl-env)))) | |
| 250 cl-macro)) | |
| 251 | |
| 252 ;;; Declarations. | |
| 253 | |
| 254 (defvar cl-compiling-file nil) | |
| 255 (defun cl-compiling-file () | |
| 256 (or cl-compiling-file | |
| 257 ;; XEmacs change | |
| 258 ; (and (boundp 'outbuffer) (bufferp (symbol-value 'outbuffer)) | |
| 259 ; (equal (buffer-name (symbol-value 'outbuffer)) | |
| 260 ; " *Compiler Output*")) | |
| 261 (and (boundp 'byte-compile-outbuffer) | |
| 262 (bufferp (symbol-value 'byte-compile-outbuffer)) | |
| 263 (equal (buffer-name (symbol-value 'byte-compile-outbuffer)) | |
| 264 " *Compiler Output*")) | |
| 265 )) | |
| 266 | |
| 267 (defvar cl-proclaims-deferred nil) | |
| 268 | |
| 269 (defun proclaim (spec) | |
| 270 (if (fboundp 'cl-do-proclaim) (cl-do-proclaim spec t) | |
| 271 (push spec cl-proclaims-deferred)) | |
| 272 nil) | |
| 273 | |
| 274 (defmacro declaim (&rest specs) | |
| 275 (let ((body (mapcar (function (lambda (x) (list 'proclaim (list 'quote x)))) | |
| 276 specs))) | |
| 277 (if (cl-compiling-file) (list* 'eval-when '(compile load eval) body) | |
| 278 (cons 'progn body)))) ; avoid loading cl-macs.el for eval-when | |
| 279 | |
| 280 ;;; Symbols. | |
| 281 | |
| 282 (defun cl-random-time () | |
| 283 (let* ((time (copy-sequence (current-time-string))) (i (length time)) (v 0)) | |
| 284 (while (>= (decf i) 0) (setq v (+ (* v 3) (aref time i)))) | |
| 2509 | 285 (if-fboundp 'coerce-number |
| 286 (coerce-number v 'fixnum) | |
| 1983 | 287 v))) |
| 428 | 288 |
| 289 (defvar *gensym-counter* (* (logand (cl-random-time) 1023) 100)) | |
| 290 | |
| 2153 | 291 ;; XEmacs change: gensym and gentemp moved here from cl-macs.el |
| 442 | 292 (defun gensym (&optional arg) |
| 293 "Generate a new uninterned symbol. | |
| 2071 | 294 The name is made by appending a number to a prefix. If ARG is a string, it |
| 295 is the prefix, otherwise the prefix defaults to \"G\". If ARG is an integer, | |
| 296 the internal counter is reset to that number before creating the name. | |
| 297 There is no way to specify both using this function." | |
| 442 | 298 (let ((prefix (if (stringp arg) arg "G")) |
| 299 (num (if (integerp arg) arg | |
| 300 (prog1 *gensym-counter* | |
| 301 (setq *gensym-counter* (1+ *gensym-counter*)))))) | |
| 302 (make-symbol (format "%s%d" prefix num)))) | |
| 303 | |
| 304 (defun gentemp (&optional arg) | |
| 305 "Generate a new interned symbol with a unique name. | |
| 2071 | 306 The name is made by appending a number to ARG, default \"G\". |
| 307 If ARG is not a string, it is ignored." | |
| 442 | 308 (let ((prefix (if (stringp arg) arg "G")) |
| 309 name) | |
| 310 (while (intern-soft (setq name (format "%s%d" prefix *gensym-counter*))) | |
| 311 (setq *gensym-counter* (1+ *gensym-counter*))) | |
| 312 (intern name))) | |
| 428 | 313 |
| 314 ;;; Numbers. | |
| 315 | |
|
4885
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
316 ;; XEmacs change: ditch floatp-safe. |
| 428 | 317 |
| 446 | 318 (defun plusp (number) |
| 428 | 319 "Return t if NUMBER is positive." |
| 446 | 320 (> number 0)) |
| 321 | |
| 322 (defun minusp (number) | |
| 323 "Return t if NUMBER is negative." | |
| 324 (< number 0)) | |
| 428 | 325 |
| 446 | 326 (defun oddp (integer) |
| 428 | 327 "Return t if INTEGER is odd." |
| 446 | 328 (eq (logand integer 1) 1)) |
| 428 | 329 |
| 446 | 330 (defun evenp (integer) |
| 428 | 331 "Return t if INTEGER is even." |
| 446 | 332 (eq (logand integer 1) 0)) |
| 428 | 333 |
| 2153 | 334 ;; XEmacs addition |
| 335 (defalias 'cl-abs 'abs) | |
| 428 | 336 |
| 337 (defvar *random-state* (vector 'cl-random-state-tag -1 30 (cl-random-time))) | |
| 338 | |
| 339 ;;; The following are set by code in cl-extra.el | |
| 340 (defconst most-positive-float nil | |
| 341 "The float closest in value to positive infinity.") | |
| 342 (defconst most-negative-float nil | |
| 343 "The float closest in value to negative infinity.") | |
| 344 (defconst least-positive-float nil | |
| 345 "The positive float closest in value to 0.") | |
| 346 (defconst least-negative-float nil | |
| 347 "The negative float closest in value to 0.") | |
| 348 (defconst least-positive-normalized-float nil) | |
| 349 (defconst least-negative-normalized-float nil) | |
| 350 (defconst float-epsilon nil) | |
| 351 (defconst float-negative-epsilon nil) | |
| 352 | |
| 353 ;;; Sequence functions. | |
| 354 | |
| 355 (defalias 'copy-seq 'copy-sequence) | |
| 356 | |
|
5219
2d0937dc83cf
Tidying of CL files; make docstrings read better, remove commented-out code
Aidan Kehoe <kehoea@parhasard.net>
parents:
5066
diff
changeset
|
357 ;; XEmacs; #'mapcar* is in C. |
|
2d0937dc83cf
Tidying of CL files; make docstrings read better, remove commented-out code
Aidan Kehoe <kehoea@parhasard.net>
parents:
5066
diff
changeset
|
358 |
|
2d0937dc83cf
Tidying of CL files; make docstrings read better, remove commented-out code
Aidan Kehoe <kehoea@parhasard.net>
parents:
5066
diff
changeset
|
359 (defalias 'svref 'aref) ;; Compiler macro in cl-macs.el |
| 428 | 360 |
| 361 ;;; List functions. | |
| 362 | |
| 363 ;; These functions are made known to the byte-compiler by cl-macs.el | |
| 364 ;; and turned into efficient car and cdr bytecodes. | |
| 365 | |
| 366 (defalias 'first 'car) | |
| 367 (defalias 'rest 'cdr) | |
| 368 (defalias 'endp 'null) | |
| 369 | |
| 2153 | 370 ;; XEmacs change: make it a real function |
| 428 | 371 (defun second (x) |
| 372 "Return the second element of the list LIST." | |
| 373 (car (cdr x))) | |
| 374 | |
| 375 (defun third (x) | |
| 2153 | 376 "Return the third element of the list X." |
| 428 | 377 (car (cdr (cdr x)))) |
| 378 | |
| 379 (defun fourth (x) | |
| 2153 | 380 "Return the fourth element of the list X." |
| 428 | 381 (nth 3 x)) |
| 382 | |
| 383 (defun fifth (x) | |
| 2153 | 384 "Return the fifth element of the list X." |
| 428 | 385 (nth 4 x)) |
| 386 | |
| 387 (defun sixth (x) | |
| 2153 | 388 "Return the sixth element of the list X." |
| 428 | 389 (nth 5 x)) |
| 390 | |
| 391 (defun seventh (x) | |
| 2153 | 392 "Return the seventh element of the list X." |
| 428 | 393 (nth 6 x)) |
| 394 | |
| 395 (defun eighth (x) | |
| 2153 | 396 "Return the eighth element of the list X." |
| 428 | 397 (nth 7 x)) |
| 398 | |
| 399 (defun ninth (x) | |
| 2153 | 400 "Return the ninth element of the list X." |
| 428 | 401 (nth 8 x)) |
| 402 | |
| 403 (defun tenth (x) | |
| 2153 | 404 "Return the tenth element of the list X." |
| 428 | 405 (nth 9 x)) |
| 406 | |
| 2153 | 407 ;; XEmacs change: Emacs defines caar, cadr, cdar, and cddr in subr.el. |
| 428 | 408 (defun caar (x) |
| 409 "Return the `car' of the `car' of X." | |
| 410 (car (car x))) | |
| 411 | |
| 412 (defun cadr (x) | |
| 413 "Return the `car' of the `cdr' of X." | |
| 414 (car (cdr x))) | |
| 415 | |
| 416 (defun cdar (x) | |
| 417 "Return the `cdr' of the `car' of X." | |
| 418 (cdr (car x))) | |
| 419 | |
| 420 (defun cddr (x) | |
| 421 "Return the `cdr' of the `cdr' of X." | |
| 422 (cdr (cdr x))) | |
| 423 | |
| 424 (defun caaar (x) | |
| 425 "Return the `car' of the `car' of the `car' of X." | |
| 426 (car (car (car x)))) | |
| 427 | |
| 428 (defun caadr (x) | |
| 429 "Return the `car' of the `car' of the `cdr' of X." | |
| 430 (car (car (cdr x)))) | |
| 431 | |
| 432 (defun cadar (x) | |
| 433 "Return the `car' of the `cdr' of the `car' of X." | |
| 434 (car (cdr (car x)))) | |
| 435 | |
| 436 (defun caddr (x) | |
| 437 "Return the `car' of the `cdr' of the `cdr' of X." | |
| 438 (car (cdr (cdr x)))) | |
| 439 | |
| 440 (defun cdaar (x) | |
| 441 "Return the `cdr' of the `car' of the `car' of X." | |
| 442 (cdr (car (car x)))) | |
| 443 | |
| 444 (defun cdadr (x) | |
| 445 "Return the `cdr' of the `car' of the `cdr' of X." | |
| 446 (cdr (car (cdr x)))) | |
| 447 | |
| 448 (defun cddar (x) | |
| 449 "Return the `cdr' of the `cdr' of the `car' of X." | |
| 450 (cdr (cdr (car x)))) | |
| 451 | |
| 452 (defun cdddr (x) | |
| 453 "Return the `cdr' of the `cdr' of the `cdr' of X." | |
| 454 (cdr (cdr (cdr x)))) | |
| 455 | |
| 456 (defun caaaar (x) | |
| 457 "Return the `car' of the `car' of the `car' of the `car' of X." | |
| 458 (car (car (car (car x))))) | |
| 459 | |
| 460 (defun caaadr (x) | |
| 461 "Return the `car' of the `car' of the `car' of the `cdr' of X." | |
| 462 (car (car (car (cdr x))))) | |
| 463 | |
| 464 (defun caadar (x) | |
| 465 "Return the `car' of the `car' of the `cdr' of the `car' of X." | |
| 466 (car (car (cdr (car x))))) | |
| 467 | |
| 468 (defun caaddr (x) | |
| 469 "Return the `car' of the `car' of the `cdr' of the `cdr' of X." | |
| 470 (car (car (cdr (cdr x))))) | |
| 471 | |
| 472 (defun cadaar (x) | |
| 473 "Return the `car' of the `cdr' of the `car' of the `car' of X." | |
| 474 (car (cdr (car (car x))))) | |
| 475 | |
| 476 (defun cadadr (x) | |
| 477 "Return the `car' of the `cdr' of the `car' of the `cdr' of X." | |
| 478 (car (cdr (car (cdr x))))) | |
| 479 | |
| 480 (defun caddar (x) | |
| 481 "Return the `car' of the `cdr' of the `cdr' of the `car' of X." | |
| 482 (car (cdr (cdr (car x))))) | |
| 483 | |
| 484 (defun cadddr (x) | |
| 485 "Return the `car' of the `cdr' of the `cdr' of the `cdr' of X." | |
| 486 (car (cdr (cdr (cdr x))))) | |
| 487 | |
| 488 (defun cdaaar (x) | |
| 489 "Return the `cdr' of the `car' of the `car' of the `car' of X." | |
| 490 (cdr (car (car (car x))))) | |
| 491 | |
| 492 (defun cdaadr (x) | |
| 493 "Return the `cdr' of the `car' of the `car' of the `cdr' of X." | |
| 494 (cdr (car (car (cdr x))))) | |
| 495 | |
| 496 (defun cdadar (x) | |
| 497 "Return the `cdr' of the `car' of the `cdr' of the `car' of X." | |
| 498 (cdr (car (cdr (car x))))) | |
| 499 | |
| 500 (defun cdaddr (x) | |
| 501 "Return the `cdr' of the `car' of the `cdr' of the `cdr' of X." | |
| 502 (cdr (car (cdr (cdr x))))) | |
| 503 | |
| 504 (defun cddaar (x) | |
| 505 "Return the `cdr' of the `cdr' of the `car' of the `car' of X." | |
| 506 (cdr (cdr (car (car x))))) | |
| 507 | |
| 508 (defun cddadr (x) | |
| 509 "Return the `cdr' of the `cdr' of the `car' of the `cdr' of X." | |
| 510 (cdr (cdr (car (cdr x))))) | |
| 511 | |
| 512 (defun cdddar (x) | |
| 513 "Return the `cdr' of the `cdr' of the `cdr' of the `car' of X." | |
| 514 (cdr (cdr (cdr (car x))))) | |
| 515 | |
| 516 (defun cddddr (x) | |
| 517 "Return the `cdr' of the `cdr' of the `cdr' of the `cdr' of X." | |
| 518 (cdr (cdr (cdr (cdr x))))) | |
| 519 | |
| 520 ;;; `last' is implemented as a C primitive, as of 1998-11 | |
| 521 | |
| 522 (defun list* (arg &rest rest) ; See compiler macro in cl-macs.el | |
| 523 "Return a new list with specified args as elements, cons'd to last arg. | |
| 524 Thus, `(list* A B C D)' is equivalent to `(nconc (list A B C) D)', or to | |
| 525 `(cons A (cons B (cons C D)))'." | |
| 526 (cond ((not rest) arg) | |
| 527 ((not (cdr rest)) (cons arg (car rest))) | |
| 528 (t (let* ((n (length rest)) | |
| 529 (copy (copy-sequence rest)) | |
| 530 (last (nthcdr (- n 2) copy))) | |
| 531 (setcdr last (car (cdr last))) | |
| 532 (cons arg copy))))) | |
| 533 | |
| 534 (defun ldiff (list sublist) | |
| 535 "Return a copy of LIST with the tail SUBLIST removed." | |
| 536 (let ((res nil)) | |
| 537 (while (and (consp list) (not (eq list sublist))) | |
| 538 (push (pop list) res)) | |
| 539 (nreverse res))) | |
| 540 | |
| 541 ;;; `copy-list' is implemented as a C primitive, as of 1998-11 | |
| 542 | |
| 543 (defalias 'cl-member 'memq) ; for compatibility with old CL package | |
| 544 (defalias 'cl-floor 'floor*) | |
| 545 (defalias 'cl-ceiling 'ceiling*) | |
| 546 (defalias 'cl-truncate 'truncate*) | |
| 547 (defalias 'cl-round 'round*) | |
| 548 (defalias 'cl-mod 'mod*) | |
| 549 | |
| 550 (defun adjoin (cl-item cl-list &rest cl-keys) ; See compiler macro in cl-macs | |
| 551 "Return ITEM consed onto the front of LIST only if it's not already there. | |
| 552 Otherwise, return LIST unmodified. | |
|
5066
545ec923b4eb
add documentation on keywords to cl*.el
Ben Wing <ben@xemacs.org>
parents:
4995
diff
changeset
|
553 Keywords supported: :test :test-not :key |
|
545ec923b4eb
add documentation on keywords to cl*.el
Ben Wing <ben@xemacs.org>
parents:
4995
diff
changeset
|
554 See `member*' for the meaning of :test, :test-not and :key." |
| 428 | 555 (cond ((or (equal cl-keys '(:test eq)) |
| 556 (and (null cl-keys) (not (numberp cl-item)))) | |
| 557 (if (memq cl-item cl-list) cl-list (cons cl-item cl-list))) | |
| 558 ((or (equal cl-keys '(:test equal)) (null cl-keys)) | |
| 559 (if (member cl-item cl-list) cl-list (cons cl-item cl-list))) | |
| 560 (t (apply 'cl-adjoin cl-item cl-list cl-keys)))) | |
| 561 | |
| 562 (defun subst (cl-new cl-old cl-tree &rest cl-keys) | |
| 563 "Substitute NEW for OLD everywhere in TREE (non-destructively). | |
| 564 Return a copy of TREE with all elements `eql' to OLD replaced by NEW. | |
|
5066
545ec923b4eb
add documentation on keywords to cl*.el
Ben Wing <ben@xemacs.org>
parents:
4995
diff
changeset
|
565 Keywords supported: :test :test-not :key |
|
545ec923b4eb
add documentation on keywords to cl*.el
Ben Wing <ben@xemacs.org>
parents:
4995
diff
changeset
|
566 See `member*' for the meaning of :test, :test-not and :key." |
|
4885
6772ce4d982b
Fix hash tables, #'member*, #'assoc*, #'eql compiler macros if bignums
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
567 (if (or cl-keys (and (numberp cl-old) (not (fixnump cl-old)))) |
| 428 | 568 (apply 'sublis (list (cons cl-old cl-new)) cl-tree cl-keys) |
| 569 (cl-do-subst cl-new cl-old cl-tree))) | |
| 570 | |
| 571 (defun cl-do-subst (cl-new cl-old cl-tree) | |
| 572 (cond ((eq cl-tree cl-old) cl-new) | |
| 573 ((consp cl-tree) | |
| 574 (let ((a (cl-do-subst cl-new cl-old (car cl-tree))) | |
| 575 (d (cl-do-subst cl-new cl-old (cdr cl-tree)))) | |
| 576 (if (and (eq a (car cl-tree)) (eq d (cdr cl-tree))) | |
| 577 cl-tree (cons a d)))) | |
| 578 (t cl-tree))) | |
| 579 | |
|
5219
2d0937dc83cf
Tidying of CL files; make docstrings read better, remove commented-out code
Aidan Kehoe <kehoea@parhasard.net>
parents:
5066
diff
changeset
|
580 (defun acons (key value alist) |
| 428 | 581 "Return a new alist created by adding (KEY . VALUE) to ALIST." |
|
5219
2d0937dc83cf
Tidying of CL files; make docstrings read better, remove commented-out code
Aidan Kehoe <kehoea@parhasard.net>
parents:
5066
diff
changeset
|
582 (cons (cons key value) alist)) |
| 428 | 583 |
|
5219
2d0937dc83cf
Tidying of CL files; make docstrings read better, remove commented-out code
Aidan Kehoe <kehoea@parhasard.net>
parents:
5066
diff
changeset
|
584 (defun pairlis (keys values &optional alist) |
|
2d0937dc83cf
Tidying of CL files; make docstrings read better, remove commented-out code
Aidan Kehoe <kehoea@parhasard.net>
parents:
5066
diff
changeset
|
585 "Make an alist from KEYS and VALUES. |
|
2d0937dc83cf
Tidying of CL files; make docstrings read better, remove commented-out code
Aidan Kehoe <kehoea@parhasard.net>
parents:
5066
diff
changeset
|
586 Return a new alist composed by associating KEYS to corresponding VALUES; |
|
2d0937dc83cf
Tidying of CL files; make docstrings read better, remove commented-out code
Aidan Kehoe <kehoea@parhasard.net>
parents:
5066
diff
changeset
|
587 the process stops as soon as KEYS or VALUES run out. |
|
2d0937dc83cf
Tidying of CL files; make docstrings read better, remove commented-out code
Aidan Kehoe <kehoea@parhasard.net>
parents:
5066
diff
changeset
|
588 If ALIST is non-nil, the new pairs are prepended to it." |
|
2d0937dc83cf
Tidying of CL files; make docstrings read better, remove commented-out code
Aidan Kehoe <kehoea@parhasard.net>
parents:
5066
diff
changeset
|
589 (nconc (mapcar* 'cons keys values) alist)) |
| 428 | 590 |
| 591 ;;; Miscellaneous. | |
| 592 | |
| 593 ;; XEmacs change | |
| 594 (define-error 'cl-assertion-failed "Assertion failed") | |
| 595 | |
| 2153 | 596 ;; XEmacs change: omit the autoload rules; we handle those a different way |
| 428 | 597 |
| 598 ;;; Define data for indentation and edebug. | |
|
4995
8431b52e43b1
Move the various map* functions to C; add #'map-into.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4885
diff
changeset
|
599 (mapc |
| 428 | 600 #'(lambda (entry) |
|
4995
8431b52e43b1
Move the various map* functions to C; add #'map-into.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4885
diff
changeset
|
601 (mapc |
| 428 | 602 #'(lambda (func) |
| 603 (put func 'lisp-indent-function (nth 1 entry)) | |
| 604 (put func 'lisp-indent-hook (nth 1 entry)) | |
| 605 (or (get func 'edebug-form-spec) | |
| 606 (put func 'edebug-form-spec (nth 2 entry)))) | |
| 607 (car entry))) | |
| 608 '(((defun* defmacro*) defun) | |
| 609 ((function*) nil | |
| 610 (&or symbolp ([&optional 'macro] 'lambda (&rest sexp) &rest form))) | |
| 611 ((eval-when) 1 (sexp &rest form)) | |
| 612 ((when unless) 1 (&rest form)) | |
| 613 ((declare) nil (&rest sexp)) | |
| 614 ((the) 1 (sexp &rest form)) | |
| 615 ((case ecase typecase etypecase) 1 (form &rest (sexp &rest form))) | |
| 616 ((block return-from) 1 (sexp &rest form)) | |
| 617 ((return) nil (&optional form)) | |
| 618 ((do do*) 2 ((&rest &or symbolp (symbolp &optional form form)) | |
| 619 (form &rest form) | |
| 620 &rest form)) | |
| 621 ((dolist dotimes) 1 ((symbolp form &rest form) &rest form)) | |
| 622 ((do-symbols) 1 ((symbolp form &optional form form) &rest form)) | |
| 623 ((do-all-symbols) 1 ((symbolp form &optional form) &rest form)) | |
| 624 ((psetq setf psetf) nil edebug-setq-form) | |
| 625 ((progv) 2 (&rest form)) | |
| 626 ((flet labels macrolet) 1 | |
| 627 ((&rest (sexp sexp &rest form)) &rest form)) | |
| 628 ((symbol-macrolet lexical-let lexical-let*) 1 | |
| 629 ((&rest &or symbolp (symbolp form)) &rest form)) | |
| 630 ((multiple-value-bind) 2 ((&rest symbolp) &rest form)) | |
| 631 ((multiple-value-setq) 1 ((&rest symbolp) &rest form)) | |
| 632 ((incf decf remf pop push pushnew shiftf rotatef) nil (&rest form)) | |
| 633 ((letf letf*) 1 ((&rest (&rest form)) &rest form)) | |
| 634 ((callf destructuring-bind) 2 (sexp form &rest form)) | |
| 635 ((callf2) 3 (sexp form form &rest form)) | |
| 636 ((loop) defun (&rest &or symbolp form)) | |
| 637 ((ignore-errors) 0 (&rest form)))) | |
| 638 | |
| 639 ;;; This goes here so that cl-macs can find it if it loads right now. | |
|
5219
2d0937dc83cf
Tidying of CL files; make docstrings read better, remove commented-out code
Aidan Kehoe <kehoea@parhasard.net>
parents:
5066
diff
changeset
|
640 (provide 'cl-19) |
| 428 | 641 |
| 642 ;;; Things to do after byte-compiler is loaded. | |
| 643 ;;; As a side effect, we cause cl-macs to be loaded when compiling, so | |
| 644 ;;; that the compiler-macros defined there will be present. | |
| 645 | |
| 646 (defvar cl-hacked-flag nil) | |
| 647 (defun cl-hack-byte-compiler () | |
| 648 (if (and (not cl-hacked-flag) (fboundp 'byte-compile-file-form)) | |
| 649 (progn | |
| 2153 | 650 (setq cl-hacked-flag t) ; Do it first, to prevent recursion. |
| 442 | 651 (when (not (fboundp 'cl-compile-time-init)) |
| 652 (load "cl-macs" nil t)) | |
| 2153 | 653 (cl-compile-time-init)))) ; In cl-macs.el. |
| 428 | 654 |
| 655 ;;; Try it now in case the compiler has already been loaded. | |
| 656 (cl-hack-byte-compiler) | |
| 657 | |
|
4683
0cc9d22c3732
Be more reliable about loading cl-macs at byte-compile time, cl.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
658 ;;; Also make a hook in case compiler is loaded after this file. |
|
0cc9d22c3732
Be more reliable about loading cl-macs at byte-compile time, cl.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4677
diff
changeset
|
659 (add-hook 'bytecomp-load-hook 'cl-hack-byte-compiler) |
| 428 | 660 |
| 661 ;;; The following ensures that packages which expect the old-style cl.el | |
| 662 ;;; will be happy with this one. | |
| 663 | |
| 664 (provide 'cl) | |
| 665 | |
| 666 (run-hooks 'cl-load-hook) | |
| 667 | |
| 2153 | 668 ;;; arch-tag: 5f07fa74-f153-4524-9303-21f5be125851 |
| 428 | 669 ;;; cl.el ends here |