Mercurial > hg > xemacs-beta
annotate lisp/subr.el @ 4372:ebb35ddea76a
Byte-compile menu lambdas; make the menu of available tutorials more readable.
2007-12-31 Aidan Kehoe <kehoea@parhasard.net>
* menubar-items.el (default-menubar):
Byte compile the specified lambdas. Correct some compile time
warnings uncovered by this.
* menubar-items.el (tutorials-menu-filter):
If a language environment doesn't have an associated POSIX locale
specified--which indicates we don't want it used except by those
who know what they're doing--don't show its tutorial in the menu.
* behavior.el (behavior-menu-filter):
Byte compile the lambdas in the generated menu.
| author | Aidan Kehoe <kehoea@parhasard.net> |
|---|---|
| date | Mon, 31 Dec 2007 21:34:45 +0100 |
| parents | d9eb5ea14f65 |
| children | ef9eb714f0e4 |
| rev | line source |
|---|---|
| 428 | 1 ;;; subr.el --- basic lisp subroutines for XEmacs |
| 2 | |
| 2525 | 3 ;; Copyright (C) 1985, 86, 92, 94, 95, 99, 2000, 2001, 2002, 2003 |
| 4 ;; Free Software Foundation, Inc. | |
| 428 | 5 ;; Copyright (C) 1995 Tinker Systems and INS Engineering Corp. |
| 6 ;; Copyright (C) 1995 Sun Microsystems. | |
| 1333 | 7 ;; Copyright (C) 2000, 2001, 2002, 2003 Ben Wing. |
| 428 | 8 |
| 9 ;; Maintainer: XEmacs Development Team | |
| 2525 | 10 ;; Keywords: extensions, dumped, internal |
| 428 | 11 |
| 12 ;; This file is part of XEmacs. | |
| 13 | |
| 14 ;; XEmacs is free software; you can redistribute it and/or modify it | |
| 15 ;; under the terms of the GNU General Public License as published by | |
| 16 ;; the Free Software Foundation; either version 2, or (at your option) | |
| 17 ;; any later version. | |
| 18 | |
| 19 ;; XEmacs is distributed in the hope that it will be useful, but | |
| 20 ;; WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 22 ;; General Public License for more details. | |
| 23 | |
| 24 ;; You should have received a copy of the GNU General Public License | |
| 25 ;; along with XEmacs; see the file COPYING. If not, write to the Free | |
| 3000 | 26 ;; Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
| 27 ;; Boston, MA 02110-1301, USA. | |
| 428 | 28 |
| 1333 | 29 ;;; Synched up with: FSF 19.34. Some things synched up with later versions. |
| 428 | 30 |
| 31 ;;; Commentary: | |
| 32 | |
| 33 ;; This file is dumped with XEmacs. | |
| 34 | |
| 35 ;; There's not a whole lot in common now with the FSF version, | |
| 36 ;; be wary when applying differences. I've left in a number of lines | |
| 37 ;; of commentary just to give diff(1) something to synch itself with to | |
| 38 ;; provide useful context diffs. -sb | |
| 39 | |
| 1333 | 40 ;; BEGIN SYNCHED WITH FSF 21.2 |
| 41 | |
| 428 | 42 ;;; Code: |
| 1333 | 43 (defvar custom-declare-variable-list nil |
| 44 "Record `defcustom' calls made before `custom.el' is loaded to handle them. | |
| 45 Each element of this list holds the arguments to one call to `defcustom'.") | |
| 428 | 46 |
| 1333 | 47 ;; Use this, rather than defcustom, in subr.el and other files loaded |
| 1336 | 48 ;; before custom.el. See dumped-lisp.el. |
| 1333 | 49 (defun custom-declare-variable-early (&rest arguments) |
| 50 (setq custom-declare-variable-list | |
| 51 (cons arguments custom-declare-variable-list))) | |
| 2525 | 52 |
| 53 | |
| 54 (defun macro-declaration-function (macro decl) | |
| 55 "Process a declaration found in a macro definition. | |
| 56 This is set as the value of the variable `macro-declaration-function'. | |
| 57 MACRO is the name of the macro being defined. | |
| 58 DECL is a list `(declare ...)' containing the declarations. | |
| 59 The return value of this function is not used." | |
| 60 (dolist (d (cdr decl)) | |
| 61 (cond ((and (consp d) (eq (car d) 'indent)) | |
| 62 (put macro 'lisp-indent-function (cadr d))) | |
| 63 ((and (consp d) (eq (car d) 'debug)) | |
| 64 (put macro 'edebug-form-spec (cadr d))) | |
| 65 (t | |
| 66 (message "Unknown declaration %s" d))))) | |
| 67 | |
| 68 (setq macro-declaration-function 'macro-declaration-function) | |
| 69 | |
| 428 | 70 |
| 71 ;;;; Lisp language features. | |
| 72 | |
| 73 (defmacro lambda (&rest cdr) | |
| 74 "Return a lambda expression. | |
| 75 A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is | |
| 76 self-quoting; the result of evaluating the lambda expression is the | |
| 77 expression itself. The lambda expression may then be treated as a | |
| 78 function, i.e., stored as the function value of a symbol, passed to | |
| 79 funcall or mapcar, etc. | |
| 80 | |
| 81 ARGS should take the same form as an argument list for a `defun'. | |
| 3842 | 82 Optional DOCSTRING is a documentation string. |
| 83 If present, it should describe how to call the function. Docstrings are | |
| 84 rarely useful unless the lambda will be named, eg, using `fset'. | |
| 85 Optional INTERACTIVE should be a call to the function `interactive'. | |
| 86 BODY should be a list of lisp expressions. | |
| 87 | |
| 88 The byte-compiler treats lambda expressions specially. If the lambda | |
| 89 expression is syntactically a function to be called, it will be compiled | |
| 90 unless protected by `quote'. Conversely, quoting a lambda expression with | |
| 91 `function' hints to the byte-compiler that it should compile the expression. | |
| 92 \(The byte-compiler may or may not actually compile it; for example it will | |
| 93 never compile lambdas nested in a data structure: `'(#'(lambda (x) x))'). | |
| 94 | |
| 95 The byte-compiler will warn about common problems such as the form | |
| 96 `(fset 'f '(lambda (x) x))' (the lambda cannot be byte-compiled; probably | |
| 97 the programmer intended `#'', although leaving the lambda unquoted will | |
| 98 normally suffice), but in general is it the programmer's responsibility to | |
| 99 quote lambda expressions appropriately." | |
| 428 | 100 `(function (lambda ,@cdr))) |
| 101 | |
| 1333 | 102 ;; FSF 21.2 has various basic macros here. We don't because they're either |
| 103 ;; in cl*.el (which we dump and hence is always available) or built-in. | |
| 104 | |
| 105 ;; More powerful versions in cl.el. | |
| 106 ;(defmacro push (newelt listname) | |
| 107 ;(defmacro pop (listname) | |
| 108 | |
| 109 ;; Built-in. | |
| 110 ;(defmacro when (cond &rest body) | |
| 111 ;(defmacro unless (cond &rest body) | |
| 112 | |
| 113 ;; More powerful versions in cl-macs.el. | |
| 114 ;(defmacro dolist (spec &rest body) | |
| 115 ;(defmacro dotimes (spec &rest body) | |
| 116 | |
| 117 ;; In cl.el. Ours are defun, but cl arranges for them to be inlined anyway. | |
| 118 ;(defsubst caar (x) | |
| 119 ;(defsubst cadr (x) | |
| 120 ;(defsubst cdar (x) | |
| 121 ;(defsubst cddr (x) | |
| 122 | |
| 123 ;; Built-in. Our `last' is more powerful in that it handles circularity. | |
| 124 ;(defun last (x &optional n) | |
| 125 ;(defun butlast (x &optional n) | |
| 126 ;(defun nbutlast (x &optional n) | |
| 127 | |
| 128 ;; In cl-seq.el. | |
| 129 ;(defun remove (elt seq) | |
| 130 ;(defun remq (elt list) | |
| 131 | |
| 428 | 132 (defmacro defun-when-void (&rest args) |
| 133 "Define a function, just like `defun', unless it's already defined. | |
| 134 Used for compatibility among different emacs variants." | |
| 135 `(if (fboundp ',(car args)) | |
| 136 nil | |
| 137 (defun ,@args))) | |
| 138 | |
| 139 (defmacro define-function-when-void (&rest args) | |
| 140 "Define a function, just like `define-function', unless it's already defined. | |
| 141 Used for compatibility among different emacs variants." | |
| 142 `(if (fboundp ,(car args)) | |
| 143 nil | |
| 144 (define-function ,@args))) | |
| 145 | |
| 146 | |
| 1333 | 147 (defun assoc-default (key alist &optional test default) |
| 148 "Find object KEY in a pseudo-alist ALIST. | |
| 149 ALIST is a list of conses or objects. Each element (or the element's car, | |
| 150 if it is a cons) is compared with KEY by evaluating (TEST (car elt) KEY). | |
| 151 If that is non-nil, the element matches; | |
| 152 then `assoc-default' returns the element's cdr, if it is a cons, | |
| 153 or DEFAULT if the element is not a cons. | |
| 154 | |
| 155 If no element matches, the value is nil. | |
| 156 If TEST is omitted or nil, `equal' is used." | |
| 157 (let (found (tail alist) value) | |
| 158 (while (and tail (not found)) | |
| 159 (let ((elt (car tail))) | |
| 160 (when (funcall (or test 'equal) (if (consp elt) (car elt) elt) key) | |
| 161 (setq found t value (if (consp elt) (cdr elt) default)))) | |
| 162 (setq tail (cdr tail))) | |
| 163 value)) | |
| 164 | |
| 165 (defun assoc-ignore-case (key alist) | |
| 166 "Like `assoc', but ignores differences in case and text representation. | |
| 167 KEY must be a string. Upper-case and lower-case letters are treated as equal." | |
| 168 (let (element) | |
| 169 (while (and alist (not element)) | |
| 170 (if (eq t (compare-strings key 0 nil (car (car alist)) 0 nil t)) | |
| 171 (setq element (car alist))) | |
| 172 (setq alist (cdr alist))) | |
| 173 element)) | |
| 174 | |
| 175 (defun assoc-ignore-representation (key alist) | |
| 176 "Like `assoc', but ignores differences in text representation. | |
| 177 KEY must be a string." | |
| 178 (let (element) | |
| 179 (while (and alist (not element)) | |
| 180 (if (eq t (compare-strings key 0 nil (car (car alist)) 0 nil)) | |
| 181 (setq element (car alist))) | |
| 182 (setq alist (cdr alist))) | |
| 183 element)) | |
| 184 | |
| 185 (defun member-ignore-case (elt list) | |
| 186 "Like `member', but ignores differences in case and text representation. | |
| 187 ELT must be a string. Upper-case and lower-case letters are treated as equal." | |
| 188 (while (and list (not (eq t (compare-strings elt 0 nil (car list) 0 nil t)))) | |
| 189 (setq list (cdr list))) | |
| 190 list) | |
| 191 | |
| 192 | |
| 428 | 193 ;;;; Keymap support. |
| 194 ;; XEmacs: removed to keymap.el | |
| 195 | |
| 196 ;;;; The global keymap tree. | |
| 197 | |
| 198 ;;; global-map, esc-map, and ctl-x-map have their values set up in | |
| 199 ;;; keymap.c; we just give them docstrings here. | |
| 200 | |
| 201 ;;;; Event manipulation functions. | |
| 202 | |
| 203 ;; XEmacs: This stuff is done in C Code. | |
| 204 | |
| 1333 | 205 ;;;; Obsolescent names for functions generally appear elsewhere, in |
| 206 ;;;; obsolete.el or in the files they are related do. Many very old | |
| 207 ;;;; obsolete stuff has been removed entirely (e.g. anything with `dot' in | |
| 208 ;;;; place of `point'). | |
| 209 | |
| 210 ; alternate names (not obsolete) | |
| 211 (if (not (fboundp 'mod)) (define-function 'mod '%)) | |
| 212 (define-function 'move-marker 'set-marker) | |
| 213 (define-function 'beep 'ding) ; preserve lingual purity | |
| 214 (define-function 'indent-to-column 'indent-to) | |
| 215 (define-function 'backward-delete-char 'delete-backward-char) | |
| 216 (define-function 'search-forward-regexp (symbol-function 're-search-forward)) | |
| 217 (define-function 'search-backward-regexp (symbol-function 're-search-backward)) | |
| 218 (define-function 'remove-directory 'delete-directory) | |
| 219 (define-function 'set-match-data 'store-match-data) | |
| 220 (define-function 'send-string-to-terminal 'external-debugging-output) | |
| 428 | 221 |
| 222 ;; XEmacs: | |
| 223 (defun local-variable-if-set-p (sym buffer) | |
| 224 "Return t if SYM would be local to BUFFER after it is set. | |
| 225 A nil value for BUFFER is *not* the same as (current-buffer), but | |
| 226 can be used to determine whether `make-variable-buffer-local' has been | |
| 227 called on SYM." | |
| 228 (local-variable-p sym buffer t)) | |
| 229 | |
| 230 | |
| 231 ;;;; Hook manipulation functions. | |
| 232 | |
| 233 ;; (defconst run-hooks 'run-hooks ...) | |
| 234 | |
| 235 (defun make-local-hook (hook) | |
| 236 "Make the hook HOOK local to the current buffer. | |
| 1333 | 237 The return value is HOOK. |
| 238 | |
| 239 You never need to call this function now that `add-hook' does it for you | |
| 240 if its LOCAL argument is non-nil. | |
| 241 | |
| 428 | 242 When a hook is local, its local and global values |
| 243 work in concert: running the hook actually runs all the hook | |
| 244 functions listed in *either* the local value *or* the global value | |
| 245 of the hook variable. | |
| 246 | |
| 247 This function works by making `t' a member of the buffer-local value, | |
| 248 which acts as a flag to run the hook functions in the default value as | |
| 249 well. This works for all normal hooks, but does not work for most | |
| 250 non-normal hooks yet. We will be changing the callers of non-normal | |
| 251 hooks so that they can handle localness; this has to be done one by | |
| 252 one. | |
| 253 | |
| 254 This function does nothing if HOOK is already local in the current | |
| 255 buffer. | |
| 256 | |
| 1333 | 257 Do not use `make-local-variable' to make a hook variable buffer-local." |
| 428 | 258 (if (local-variable-p hook (current-buffer)) ; XEmacs |
| 259 nil | |
| 260 (or (boundp hook) (set hook nil)) | |
| 261 (make-local-variable hook) | |
| 1333 | 262 (set hook (list t))) |
| 263 hook) | |
| 428 | 264 |
| 265 (defun add-hook (hook function &optional append local) | |
| 266 "Add to the value of HOOK the function FUNCTION. | |
| 267 FUNCTION is not added if already present. | |
| 268 FUNCTION is added (if necessary) at the beginning of the hook list | |
| 269 unless the optional argument APPEND is non-nil, in which case | |
| 270 FUNCTION is added at the end. | |
| 271 | |
| 272 The optional fourth argument, LOCAL, if non-nil, says to modify | |
| 273 the hook's buffer-local value rather than its default value. | |
| 1333 | 274 This makes the hook buffer-local if needed. |
| 428 | 275 To make a hook variable buffer-local, always use |
| 276 `make-local-hook', not `make-local-variable'. | |
| 277 | |
| 278 HOOK should be a symbol, and FUNCTION may be any valid function. If | |
| 279 HOOK is void, it is first set to nil. If HOOK's value is a single | |
| 442 | 280 function, it is changed to a list of functions. |
| 281 | |
| 282 You can remove this hook yourself using `remove-hook'. | |
| 283 | |
| 1333 | 284 See also `add-one-shot-hook'." |
| 428 | 285 (or (boundp hook) (set hook nil)) |
| 286 (or (default-boundp hook) (set-default hook nil)) | |
| 1333 | 287 (if local (unless (local-variable-if-set-p hook (current-buffer)) ; XEmacs |
| 288 (make-local-hook hook)) | |
| 289 ;; Detect the case where make-local-variable was used on a hook | |
| 290 ;; and do what we used to do. | |
| 291 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook))) | |
| 292 (setq local t))) | |
| 293 (let ((hook-value (if local (symbol-value hook) (default-value hook)))) | |
| 294 ;; If the hook value is a single function, turn it into a list. | |
| 295 (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda)) | |
| 296 (setq hook-value (list hook-value))) | |
| 297 ;; Do the actual addition if necessary | |
| 298 (unless (member function hook-value) | |
| 299 (setq hook-value | |
| 300 (if append | |
| 301 (append hook-value (list function)) | |
| 302 (cons function hook-value)))) | |
| 303 ;; Set the actual variable | |
| 304 (if local (set hook hook-value) (set-default hook hook-value)))) | |
| 428 | 305 |
| 306 (defun remove-hook (hook function &optional local) | |
| 307 "Remove from the value of HOOK the function FUNCTION. | |
| 308 HOOK should be a symbol, and FUNCTION may be any valid function. If | |
| 309 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the | |
| 310 list of hooks to run in HOOK, then nothing is done. See `add-hook'. | |
| 311 | |
| 312 The optional third argument, LOCAL, if non-nil, says to modify | |
| 313 the hook's buffer-local value rather than its default value. | |
| 1333 | 314 This makes the hook buffer-local if needed. |
| 428 | 315 To make a hook variable buffer-local, always use |
| 316 `make-local-hook', not `make-local-variable'." | |
| 1333 | 317 (or (boundp hook) (set hook nil)) |
| 318 (or (default-boundp hook) (set-default hook nil)) | |
| 319 (if local (unless (local-variable-if-set-p hook (current-buffer)) ; XEmacs | |
| 320 (make-local-hook hook)) | |
| 321 ;; Detect the case where make-local-variable was used on a hook | |
| 322 ;; and do what we used to do. | |
| 323 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook))) | |
| 324 (setq local t))) | |
| 325 (let ((hook-value (if local (symbol-value hook) (default-value hook)))) | |
| 326 ;; Remove the function, for both the list and the non-list cases. | |
| 327 ;; XEmacs: add hook-test, for handling one-shot hooks. | |
| 328 (flet ((hook-test | |
| 329 (fn hel) | |
| 330 (or (equal fn hel) | |
| 331 (and (symbolp hel) | |
| 332 (equal fn | |
| 333 (get hel 'one-shot-hook-fun)))))) | |
| 334 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda)) | |
| 335 (if (equal hook-value function) (setq hook-value nil)) | |
| 336 (setq hook-value (delete* function (copy-sequence hook-value) | |
| 337 :test 'hook-test))) | |
| 338 ;; If the function is on the global hook, we need to shadow it locally | |
| 339 ;;(when (and local (member* function (default-value hook) | |
| 340 ;; :test 'hook-test) | |
| 341 ;; (not (member* (cons 'not function) hook-value | |
| 342 ;; :test 'hook-test))) | |
| 343 ;; (push (cons 'not function) hook-value)) | |
| 344 ;; Set the actual variable | |
| 345 (if local (set hook hook-value) (set-default hook hook-value))))) | |
| 442 | 346 |
| 347 ;; XEmacs addition | |
| 348 ;; #### we need a coherent scheme for indicating compatibility info, | |
| 349 ;; so that it can be programmatically retrieved. | |
| 350 (defun add-local-hook (hook function &optional append) | |
| 351 "Add to the local value of HOOK the function FUNCTION. | |
| 1333 | 352 You don't need this any more. It's equivalent to specifying the LOCAL |
| 353 argument to `add-hook'." | |
| 442 | 354 (add-hook hook function append t)) |
| 355 | |
| 356 ;; XEmacs addition | |
| 357 (defun remove-local-hook (hook function) | |
| 358 "Remove from the local value of HOOK the function FUNCTION. | |
| 1333 | 359 You don't need this any more. It's equivalent to specifying the LOCAL |
| 360 argument to `remove-hook'." | |
| 361 (remove-hook hook function t)) | |
| 442 | 362 |
| 363 (defun add-one-shot-hook (hook function &optional append local) | |
| 364 "Add to the value of HOOK the one-shot function FUNCTION. | |
| 365 FUNCTION will automatically be removed from the hook the first time | |
| 366 after it runs (whether to completion or to an error). | |
| 367 FUNCTION is not added if already present. | |
| 368 FUNCTION is added (if necessary) at the beginning of the hook list | |
| 369 unless the optional argument APPEND is non-nil, in which case | |
| 370 FUNCTION is added at the end. | |
| 371 | |
| 372 HOOK should be a symbol, and FUNCTION may be any valid function. If | |
| 373 HOOK is void, it is first set to nil. If HOOK's value is a single | |
| 374 function, it is changed to a list of functions. | |
| 375 | |
| 376 You can remove this hook yourself using `remove-hook'. | |
| 377 | |
| 1333 | 378 See also `add-hook'." |
| 442 | 379 (let ((sym (gensym))) |
| 380 (fset sym `(lambda (&rest args) | |
| 381 (unwind-protect | |
| 382 (apply ',function args) | |
| 383 (remove-hook ',hook ',sym ',local)))) | |
| 384 (put sym 'one-shot-hook-fun function) | |
| 385 (add-hook hook sym append local))) | |
| 386 | |
| 387 (defun add-local-one-shot-hook (hook function &optional append) | |
| 388 "Add to the local value of HOOK the one-shot function FUNCTION. | |
| 1333 | 389 You don't need this any more. It's equivalent to specifying the LOCAL |
| 390 argument to `add-one-shot-hook'." | |
| 442 | 391 (add-one-shot-hook hook function append t)) |
| 428 | 392 |
| 878 | 393 (defun add-to-list (list-var element &optional append) |
| 428 | 394 "Add to the value of LIST-VAR the element ELEMENT if it isn't there yet. |
| 395 The test for presence of ELEMENT is done with `equal'. | |
| 878 | 396 If ELEMENT is added, it is added at the beginning of the list, |
| 397 unless the optional argument APPEND is non-nil, in which case | |
| 398 ELEMENT is added at the end. | |
| 399 | |
| 428 | 400 If you want to use `add-to-list' on a variable that is not defined |
| 401 until a certain package is loaded, you should put the call to `add-to-list' | |
| 402 into a hook function that will be run only after loading the package. | |
| 403 `eval-after-load' provides one way to do this. In some cases | |
| 404 other hooks, such as major mode hooks, can do the job." | |
| 878 | 405 (if (member element (symbol-value list-var)) |
| 406 (symbol-value list-var) | |
| 407 (set list-var | |
| 408 (if append | |
| 409 (append (symbol-value list-var) (list element)) | |
| 410 (cons element (symbol-value list-var)))))) | |
| 428 | 411 |
| 1333 | 412 ;; END SYNCHED WITH FSF 21.2 |
| 413 | |
| 428 | 414 ;; XEmacs additions |
| 415 ;; called by Fkill_buffer() | |
| 416 (defvar kill-buffer-hook nil | |
| 417 "Function or functions to be called when a buffer is killed. | |
| 418 The value of this variable may be buffer-local. | |
| 419 The buffer about to be killed is current when this hook is run.") | |
| 420 | |
| 421 ;; in C in FSFmacs | |
| 422 (defvar kill-emacs-hook nil | |
| 423 "Function or functions to be called when `kill-emacs' is called, | |
| 424 just before emacs is actually killed.") | |
| 425 | |
| 426 ;; not obsolete. | |
| 427 ;; #### These are a bad idea, because the CL RPLACA and RPLACD | |
| 428 ;; return the cons cell, not the new CAR/CDR. -hniksic | |
| 429 ;; The proper definition would be: | |
| 430 ;; (defun rplaca (conscell newcar) | |
| 431 ;; (setcar conscell newcar) | |
| 432 ;; conscell) | |
| 433 ;; ...and analogously for RPLACD. | |
| 434 (define-function 'rplaca 'setcar) | |
| 435 (define-function 'rplacd 'setcdr) | |
| 436 | |
| 437 (defun copy-symbol (symbol &optional copy-properties) | |
| 438 "Return a new uninterned symbol with the same name as SYMBOL. | |
| 439 If COPY-PROPERTIES is non-nil, the new symbol will have a copy of | |
| 440 SYMBOL's value, function, and property lists." | |
| 441 (let ((new (make-symbol (symbol-name symbol)))) | |
| 442 (when copy-properties | |
| 443 ;; This will not copy SYMBOL's chain of forwarding objects, but | |
| 444 ;; I think that's OK. Callers should not expect such magic to | |
| 445 ;; keep working in the copy in the first place. | |
| 446 (and (boundp symbol) | |
| 447 (set new (symbol-value symbol))) | |
| 448 (and (fboundp symbol) | |
| 449 (fset new (symbol-function symbol))) | |
| 450 (setplist new (copy-list (symbol-plist symbol)))) | |
| 451 new)) | |
| 452 | |
| 442 | 453 (defun set-symbol-value-in-buffer (sym val buffer) |
| 454 "Set the value of SYM to VAL in BUFFER. Useful with buffer-local variables. | |
| 455 If SYM has a buffer-local value in BUFFER, or will have one if set, this | |
| 456 function allows you to set the local value. | |
| 457 | |
| 458 NOTE: At some point, this will be moved into C and will be very fast." | |
| 459 (with-current-buffer buffer | |
| 460 (set sym val))) | |
| 444 | 461 |
| 1333 | 462 |
| 463 ;; BEGIN SYNCHED WITH FSF 21.2 | |
| 464 | |
| 465 ;; #### #### #### AAaargh! Must be in C, because it is used insanely | |
| 466 ;; early in the bootstrap process. | |
| 467 ;(defun split-path (path) | |
| 468 ; "Explode a search path into a list of strings. | |
| 469 ;The path components are separated with the characters specified | |
| 470 ;with `path-separator'." | |
| 471 ; (while (or (not stringp path-separator) | |
| 472 ; (/= (length path-separator) 1)) | |
| 473 ; (setq path-separator (signal 'error (list "\ | |
| 474 ;`path-separator' should be set to a single-character string" | |
| 475 ; path-separator)))) | |
| 476 ; (split-string-by-char path (aref separator 0))) | |
| 477 | |
| 478 (defmacro with-current-buffer (buffer &rest body) | |
| 479 "Temporarily make BUFFER the current buffer and execute the forms in BODY. | |
| 480 The value returned is the value of the last form in BODY. | |
| 481 See also `with-temp-buffer'." | |
| 482 `(save-current-buffer | |
| 483 (set-buffer ,buffer) | |
| 484 ,@body)) | |
| 485 | |
| 486 (defmacro with-temp-file (filename &rest forms) | |
| 487 "Create a new buffer, evaluate FORMS there, and write the buffer to FILENAME. | |
| 488 The value of the last form in FORMS is returned, like `progn'. | |
| 489 See also `with-temp-buffer'." | |
| 490 (let ((temp-file (make-symbol "temp-file")) | |
| 491 (temp-buffer (make-symbol "temp-buffer"))) | |
| 492 `(let ((,temp-file ,filename) | |
| 493 (,temp-buffer | |
| 494 (get-buffer-create (generate-new-buffer-name " *temp file*")))) | |
| 495 (unwind-protect | |
| 496 (prog1 | |
| 497 (with-current-buffer ,temp-buffer | |
| 498 ,@forms) | |
| 499 (with-current-buffer ,temp-buffer | |
| 500 (widen) | |
| 501 (write-region (point-min) (point-max) ,temp-file nil 0))) | |
| 502 (and (buffer-name ,temp-buffer) | |
| 503 (kill-buffer ,temp-buffer)))))) | |
| 504 | |
| 505 ;; FSF compatibility | |
| 506 (defmacro with-temp-message (message &rest body) | |
| 507 "Display MESSAGE temporarily while BODY is evaluated. | |
| 508 The original message is restored to the echo area after BODY has finished. | |
| 509 The value returned is the value of the last form in BODY. | |
| 510 If MESSAGE is nil, the echo area and message log buffer are unchanged. | |
| 511 Use a MESSAGE of \"\" to temporarily clear the echo area. | |
| 428 | 512 |
| 1333 | 513 Note that this function exists for FSF compatibility purposes. A better way |
| 514 under XEmacs is to give the message a particular label (see `display-message'); | |
| 515 then, the old message is automatically restored when you clear your message | |
| 516 with `clear-message'." | |
| 517 ;; FSF additional doc string from 21.2: | |
| 518 ;; MESSAGE is written to the message log buffer if `message-log-max' is non-nil. | |
| 519 (let ((current-message (make-symbol "current-message")) | |
| 520 (temp-message (make-symbol "with-temp-message"))) | |
| 521 `(let ((,temp-message ,message) | |
| 522 (,current-message)) | |
| 523 (unwind-protect | |
| 524 (progn | |
| 525 (when ,temp-message | |
| 526 (setq ,current-message (current-message)) | |
| 527 (message "%s" ,temp-message)) | |
| 528 ,@body) | |
| 529 (and ,temp-message ,current-message | |
| 530 (message "%s" ,current-message)))))) | |
| 531 | |
| 532 (defmacro with-temp-buffer (&rest forms) | |
| 533 "Create a temporary buffer, and evaluate FORMS there like `progn'. | |
| 534 See also `with-temp-file' and `with-output-to-string'." | |
| 535 (let ((temp-buffer (make-symbol "temp-buffer"))) | |
| 536 `(let ((,temp-buffer | |
| 537 (get-buffer-create (generate-new-buffer-name " *temp*")))) | |
| 538 (unwind-protect | |
| 539 (with-current-buffer ,temp-buffer | |
| 540 ,@forms) | |
| 541 (and (buffer-name ,temp-buffer) | |
| 542 (kill-buffer ,temp-buffer)))))) | |
| 543 | |
| 544 (defmacro with-output-to-string (&rest body) | |
| 545 "Execute BODY, return the text it sent to `standard-output', as a string." | |
| 546 `(let ((standard-output | |
| 547 (get-buffer-create (generate-new-buffer-name " *string-output*")))) | |
| 548 (let ((standard-output standard-output)) | |
| 549 ,@body) | |
| 550 (with-current-buffer standard-output | |
| 551 (prog1 | |
| 552 (buffer-string) | |
| 553 (kill-buffer nil))))) | |
| 554 | |
| 2135 | 555 (defmacro with-local-quit (&rest body) |
| 556 "Execute BODY with `inhibit-quit' temporarily bound to nil." | |
| 557 `(condition-case nil | |
| 558 (let ((inhibit-quit nil)) | |
| 559 ,@body) | |
| 560 (quit (setq quit-flag t)))) | |
| 561 | |
| 562 ;; FSF 21.3. | |
| 1333 | 563 |
| 564 ; (defmacro combine-after-change-calls (&rest body) | |
| 565 ; "Execute BODY, but don't call the after-change functions till the end. | |
| 566 ; If BODY makes changes in the buffer, they are recorded | |
| 567 ; and the functions on `after-change-functions' are called several times | |
| 568 ; when BODY is finished. | |
| 569 ; The return value is the value of the last form in BODY. | |
| 570 | |
| 571 ; If `before-change-functions' is non-nil, then calls to the after-change | |
| 572 ; functions can't be deferred, so in that case this macro has no effect. | |
| 573 | |
| 574 ; Do not alter `after-change-functions' or `before-change-functions' | |
| 575 ; in BODY." | |
| 2135 | 576 ; (declare (indent 0) (debug t)) |
| 1333 | 577 ; `(unwind-protect |
| 578 ; (let ((combine-after-change-calls t)) | |
| 579 ; . ,body) | |
| 580 ; (combine-after-change-execute))) | |
| 801 | 581 |
| 2135 | 582 |
| 583 (defvar delay-mode-hooks nil | |
| 584 "If non-nil, `run-mode-hooks' should delay running the hooks.") | |
| 585 (defvar delayed-mode-hooks nil | |
| 586 "List of delayed mode hooks waiting to be run.") | |
| 587 (make-variable-buffer-local 'delayed-mode-hooks) | |
| 588 (put 'delay-mode-hooks 'permanent-local t) | |
| 589 | |
| 590 (defun run-mode-hooks (&rest hooks) | |
| 591 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS. | |
| 592 Execution is delayed if `delay-mode-hooks' is non-nil. | |
| 593 Major mode functions should use this." | |
| 594 (if delay-mode-hooks | |
| 595 ;; Delaying case. | |
| 596 (dolist (hook hooks) | |
| 597 (push hook delayed-mode-hooks)) | |
| 598 ;; Normal case, just run the hook as before plus any delayed hooks. | |
| 599 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks)) | |
| 600 (setq delayed-mode-hooks nil) | |
| 601 (apply 'run-hooks hooks))) | |
| 602 | |
| 603 (defmacro delay-mode-hooks (&rest body) | |
| 604 "Execute BODY, but delay any `run-mode-hooks'. | |
| 605 Only affects hooks run in the current buffer." | |
| 606 `(progn | |
| 607 (make-local-variable 'delay-mode-hooks) | |
| 608 (let ((delay-mode-hooks t)) | |
| 609 ,@body))) | |
| 610 | |
| 1333 | 611 (defmacro with-syntax-table (table &rest body) |
| 612 "Evaluate BODY with syntax table of current buffer set to a copy of TABLE. | |
| 613 The syntax table of the current buffer is saved, BODY is evaluated, and the | |
| 614 saved table is restored, even in case of an abnormal exit. | |
| 615 Value is what BODY returns." | |
| 616 (let ((old-table (make-symbol "table")) | |
| 617 (old-buffer (make-symbol "buffer"))) | |
| 618 `(let ((,old-table (syntax-table)) | |
| 619 (,old-buffer (current-buffer))) | |
| 620 (unwind-protect | |
| 621 (progn | |
| 622 (set-syntax-table (copy-syntax-table ,table)) | |
| 623 ,@body) | |
| 624 (save-current-buffer | |
| 625 (set-buffer ,old-buffer) | |
| 626 (set-syntax-table ,old-table)))))) | |
| 627 | |
| 628 (put 'with-syntax-table 'lisp-indent-function 1) | |
| 629 (put 'with-syntax-table 'edebug-form-spec '(form body)) | |
| 630 | |
| 631 | |
| 632 ;; Moved from mule-coding.el. | |
| 633 (defmacro with-string-as-buffer-contents (str &rest body) | |
| 634 "With the contents of the current buffer being STR, run BODY. | |
| 635 Returns the new contents of the buffer, as modified by BODY. | |
| 636 The original current buffer is restored afterwards." | |
| 637 `(with-temp-buffer | |
| 638 (insert ,str) | |
| 639 ,@body | |
| 640 (buffer-string))) | |
| 641 | |
| 642 | |
| 643 (defmacro save-match-data (&rest body) | |
| 644 "Execute BODY forms, restoring the global value of the match data." | |
| 645 (let ((original (make-symbol "match-data"))) | |
| 646 (list 'let (list (list original '(match-data))) | |
| 647 (list 'unwind-protect | |
| 648 (cons 'progn body) | |
| 649 (list 'store-match-data original))))) | |
| 650 | |
| 651 | |
| 652 (defun match-string (num &optional string) | |
| 653 "Return string of text matched by last search. | |
| 654 NUM specifies which parenthesized expression in the last regexp. | |
| 655 Value is nil if NUMth pair didn't match, or there were less than NUM pairs. | |
| 656 Zero means the entire text matched by the whole regexp or whole string. | |
| 657 STRING should be given if the last search was by `string-match' on STRING." | |
| 658 (if (match-beginning num) | |
| 659 (if string | |
| 660 (substring string (match-beginning num) (match-end num)) | |
| 661 (buffer-substring (match-beginning num) (match-end num))))) | |
| 801 | 662 |
| 1333 | 663 (defun match-string-no-properties (num &optional string) |
| 664 "Return string of text matched by last search, without text properties. | |
| 665 NUM specifies which parenthesized expression in the last regexp. | |
| 666 Value is nil if NUMth pair didn't match, or there were less than NUM pairs. | |
| 667 Zero means the entire text matched by the whole regexp or whole string. | |
| 668 STRING should be given if the last search was by `string-match' on STRING." | |
| 669 (if (match-beginning num) | |
| 670 (if string | |
| 671 (let ((result | |
| 672 (substring string (match-beginning num) (match-end num)))) | |
| 673 (set-text-properties 0 (length result) nil result) | |
| 674 result) | |
| 675 (buffer-substring-no-properties (match-beginning num) | |
| 676 (match-end num))))) | |
| 677 | |
| 1425 | 678 (defconst split-string-default-separators "[ \f\t\n\r\v]+" |
| 679 "The default value of separators for `split-string'. | |
| 680 | |
| 681 A regexp matching strings of whitespace. May be locale-dependent | |
| 682 \(as yet unimplemented). Should not match non-breaking spaces. | |
| 683 | |
| 684 Warning: binding this to a different value and using it as default is | |
| 685 likely to have undesired semantics.") | |
| 686 | |
| 687 ;; specification for `split-string' agreed with rms 2003-04-23 | |
| 688 ;; xemacs design <87vfx5vor0.fsf@tleepslib.sk.tsukuba.ac.jp> | |
| 689 | |
| 1495 | 690 ;; The specification says that if both SEPARATORS and OMIT-NULLS are |
| 691 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical | |
| 692 ;; expression leads to the equivalent implementation that if SEPARATORS | |
| 693 ;; is defaulted, OMIT-NULLS is treated as t. | |
| 694 | |
| 1425 | 695 (defun split-string (string &optional separators omit-nulls) |
| 696 "Splits STRING into substrings bounded by matches for SEPARATORS. | |
| 697 | |
| 698 The beginning and end of STRING, and each match for SEPARATORS, are | |
| 699 splitting points. The substrings matching SEPARATORS are removed, and | |
| 700 the substrings between the splitting points are collected as a list, | |
| 1333 | 701 which is returned. |
| 1425 | 702 |
| 2138 | 703 If SEPARATORS is non-`nil', it should be a regular expression matching text |
| 704 which separates, but is not part of, the substrings. If `nil' it defaults to | |
| 1495 | 705 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and |
| 2138 | 706 OMIT-NULLS is forced to `t'. |
| 1333 | 707 |
| 2138 | 708 If OMIT-NULLS is `t', zero-length substrings are omitted from the list \(so |
| 1425 | 709 that for the default value of SEPARATORS leading and trailing whitespace |
| 2138 | 710 are effectively trimmed). If `nil', all zero-length substrings are retained, |
| 1425 | 711 which correctly parses CSV format, for example. |
| 712 | |
| 1495 | 713 Note that the effect of `(split-string STRING)' is the same as |
| 714 `(split-string STRING split-string-default-separators t)'). In the rare | |
| 715 case that you wish to retain zero-length substrings when splitting on | |
| 716 whitespace, use `(split-string STRING split-string-default-separators nil)'. | |
| 1333 | 717 |
| 2138 | 718 Modifies the match data when successful; use `save-match-data' if necessary." |
| 1425 | 719 |
| 1495 | 720 (let ((keep-nulls (not (if separators omit-nulls t))) |
| 1425 | 721 (rexp (or separators split-string-default-separators)) |
| 1333 | 722 (start 0) |
| 723 notfirst | |
| 724 (list nil)) | |
| 725 (while (and (string-match rexp string | |
| 726 (if (and notfirst | |
| 727 (= start (match-beginning 0)) | |
| 728 (< start (length string))) | |
| 729 (1+ start) start)) | |
| 1425 | 730 (< start (length string))) |
| 1333 | 731 (setq notfirst t) |
| 1425 | 732 (if (or keep-nulls (< start (match-beginning 0))) |
| 1333 | 733 (setq list |
| 734 (cons (substring string start (match-beginning 0)) | |
| 735 list))) | |
| 736 (setq start (match-end 0))) | |
| 1425 | 737 (if (or keep-nulls (< start (length string))) |
| 1333 | 738 (setq list |
| 739 (cons (substring string start) | |
| 740 list))) | |
| 741 (nreverse list))) | |
| 742 | |
| 743 (defun subst-char-in-string (fromchar tochar string &optional inplace) | |
| 744 "Replace FROMCHAR with TOCHAR in STRING each time it occurs. | |
| 745 Unless optional argument INPLACE is non-nil, return a new string." | |
| 746 (let ((i (length string)) | |
| 747 (newstr (if inplace string (copy-sequence string)))) | |
| 748 (while (> i 0) | |
| 749 (setq i (1- i)) | |
| 750 (if (eq (aref newstr i) fromchar) | |
| 751 (aset newstr i tochar))) | |
| 752 newstr)) | |
| 753 | |
| 754 | |
| 755 ;; XEmacs addition: | |
| 428 | 756 (defun replace-in-string (str regexp newtext &optional literal) |
| 757 "Replace all matches in STR for REGEXP with NEWTEXT string, | |
| 758 and returns the new string. | |
| 759 Optional LITERAL non-nil means do a literal replacement. | |
| 442 | 760 Otherwise treat `\\' in NEWTEXT as special: |
| 761 `\\&' in NEWTEXT means substitute original matched text. | |
| 762 `\\N' means substitute what matched the Nth `\\(...\\)'. | |
| 763 If Nth parens didn't match, substitute nothing. | |
| 764 `\\\\' means insert one `\\'. | |
| 765 `\\u' means upcase the next character. | |
| 766 `\\l' means downcase the next character. | |
| 767 `\\U' means begin upcasing all following characters. | |
| 768 `\\L' means begin downcasing all following characters. | |
| 769 `\\E' means terminate the effect of any `\\U' or `\\L'." | |
| 428 | 770 (check-argument-type 'stringp str) |
| 771 (check-argument-type 'stringp newtext) | |
| 442 | 772 (if (> (length str) 50) |
| 924 | 773 (let ((cfs case-fold-search)) |
| 774 (with-temp-buffer | |
| 775 (setq case-fold-search cfs) | |
| 776 (insert str) | |
| 777 (goto-char 1) | |
| 442 | 778 (while (re-search-forward regexp nil t) |
| 779 (replace-match newtext t literal)) | |
| 924 | 780 (buffer-string))) |
| 781 (let ((start 0) newstr) | |
| 782 (while (string-match regexp str start) | |
| 783 (setq newstr (replace-match newtext t literal str) | |
| 784 start (+ (match-end 0) (- (length newstr) (length str))) | |
| 785 str newstr)) | |
| 786 str))) | |
| 428 | 787 |
| 1333 | 788 (defun replace-regexp-in-string (regexp rep string &optional |
| 789 fixedcase literal subexp start) | |
| 790 "Replace all matches for REGEXP with REP in STRING. | |
| 791 | |
| 792 Return a new string containing the replacements. | |
| 793 | |
| 4199 | 794 Optional arguments FIXEDCASE and LITERAL are like the arguments with |
| 795 the same names of function `replace-match'. If START is non-nil, | |
| 796 start replacements at that index in STRING. | |
| 797 | |
| 798 For compatibility with old XEmacs code and with recent GNU Emacs, the | |
| 799 interpretation of SUBEXP is somewhat complicated. If SUBEXP is a | |
| 800 buffer, it is interpreted as the buffer which provides syntax tables | |
| 801 and case tables for the match and replacement. If it is not a buffer, | |
| 802 the current buffer is used. If SUBEXP is an integer, it is the index | |
| 803 of the subexpression of REGEXP which is to be replaced. | |
| 428 | 804 |
| 1333 | 805 REP is either a string used as the NEWTEXT arg of `replace-match' or a |
| 806 function. If it is a function it is applied to each match to generate | |
| 807 the replacement passed to `replace-match'; the match-data at this | |
| 4199 | 808 point are such that `(match-string SUBEXP STRING)' is the function's |
| 809 argument if SUBEXP is an integer \(otherwise the whole match is passed | |
| 810 and replaced). | |
| 428 | 811 |
| 1333 | 812 To replace only the first match (if any), make REGEXP match up to \\' |
| 813 and replace a sub-expression, e.g. | |
| 814 (replace-regexp-in-string \"\\(foo\\).*\\'\" \"bar\" \" foo foo\" nil nil 1) | |
| 815 => \" bar foo\" | |
| 4199 | 816 |
| 817 Signals `invalid-argument' if SUBEXP is not an integer, buffer, or nil; | |
| 818 or is an integer, but the indicated subexpression was not matched. | |
| 819 Signals `invalid-argument' if STRING is nil but the last text matched was a string, | |
| 820 or if STRING is a string but the last text matched was a buffer." | |
| 428 | 821 |
| 1333 | 822 ;; To avoid excessive consing from multiple matches in long strings, |
| 823 ;; don't just call `replace-match' continually. Walk down the | |
| 824 ;; string looking for matches of REGEXP and building up a (reversed) | |
| 825 ;; list MATCHES. This comprises segments of STRING which weren't | |
| 826 ;; matched interspersed with replacements for segments that were. | |
| 827 ;; [For a `large' number of replacments it's more efficient to | |
| 828 ;; operate in a temporary buffer; we can't tell from the function's | |
| 829 ;; args whether to choose the buffer-based implementation, though it | |
| 830 ;; might be reasonable to do so for long enough STRING.] | |
| 831 (let ((l (length string)) | |
| 832 (start (or start 0)) | |
| 4199 | 833 (expndx (if (integerp subexp) subexp 0)) |
| 1333 | 834 matches str mb me) |
| 835 (save-match-data | |
| 836 (while (and (< start l) (string-match regexp string start)) | |
| 837 (setq mb (match-beginning 0) | |
| 838 me (match-end 0)) | |
| 839 ;; If we matched the empty string, make sure we advance by one char | |
| 840 (when (= me mb) (setq me (min l (1+ mb)))) | |
| 841 ;; Generate a replacement for the matched substring. | |
| 842 ;; Operate only on the substring to minimize string consing. | |
| 843 ;; Set up match data for the substring for replacement; | |
| 844 ;; presumably this is likely to be faster than munging the | |
| 845 ;; match data directly in Lisp. | |
| 846 (string-match regexp (setq str (substring string mb me))) | |
| 847 (setq matches | |
| 848 (cons (replace-match (if (stringp rep) | |
| 849 rep | |
| 4199 | 850 (funcall rep (match-string expndx str))) |
| 851 ;; no, this subexp shouldn't be expndx | |
| 1333 | 852 fixedcase literal str subexp) |
| 853 (cons (substring string start mb) ; unmatched prefix | |
| 854 matches))) | |
| 855 (setq start me)) | |
| 856 ;; Reconstruct a string from the pieces. | |
| 857 (setq matches (cons (substring string start l) matches)) ; leftover | |
| 858 (apply #'concat (nreverse matches))))) | |
| 428 | 859 |
| 1333 | 860 ;; END SYNCHED WITH FSF 21.2 |
| 861 | |
| 862 | |
| 1899 | 863 ;; BEGIN SYNCHED WITH FSF 21.3 |
| 864 | |
| 865 (defun add-to-invisibility-spec (arg) | |
| 866 "Add elements to `buffer-invisibility-spec'. | |
| 867 See documentation for `buffer-invisibility-spec' for the kind of elements | |
| 868 that can be added." | |
| 869 (if (eq buffer-invisibility-spec t) | |
| 870 (setq buffer-invisibility-spec (list t))) | |
| 871 (setq buffer-invisibility-spec | |
| 872 (cons arg buffer-invisibility-spec))) | |
| 873 | |
| 874 (defun remove-from-invisibility-spec (arg) | |
| 875 "Remove elements from `buffer-invisibility-spec'." | |
| 876 (if (consp buffer-invisibility-spec) | |
| 877 (setq buffer-invisibility-spec (delete arg buffer-invisibility-spec)))) | |
| 878 | |
| 879 ;; END SYNCHED WITH FSF 21.3 | |
| 880 | |
| 881 | |
| 1333 | 882 ;;; Basic string functions |
| 883 | 883 |
| 1333 | 884 ;; XEmacs |
| 885 (defun string-equal-ignore-case (str1 str2) | |
| 886 "Return t if two strings have identical contents, ignoring case differences. | |
| 887 Case is not significant. Text properties and extents are ignored. | |
| 888 Symbols are also allowed; their print names are used instead. | |
| 428 | 889 |
| 1333 | 890 See also `equalp'." |
| 891 (if (symbolp str1) | |
| 892 (setq str1 (symbol-name str1))) | |
| 893 (if (symbolp str2) | |
| 894 (setq str2 (symbol-name str2))) | |
| 895 (eq t (compare-strings str1 nil nil str2 nil nil t))) | |
| 428 | 896 |
| 897 (defun insert-face (string face) | |
| 898 "Insert STRING and highlight with FACE. Return the extent created." | |
| 899 (let ((p (point)) ext) | |
| 900 (insert string) | |
| 901 (setq ext (make-extent p (point))) | |
| 902 (set-extent-face ext face) | |
| 903 ext)) | |
| 904 | |
| 905 ;; not obsolete. | |
| 906 (define-function 'string= 'string-equal) | |
| 907 (define-function 'string< 'string-lessp) | |
| 908 (define-function 'int-to-string 'number-to-string) | |
| 909 (define-function 'string-to-int 'string-to-number) | |
| 910 | |
| 911 ;; These two names are a bit awkward, as they conflict with the normal | |
| 912 ;; foo-to-bar naming scheme, but CLtL2 has them, so they stay. | |
| 913 (define-function 'char-int 'char-to-int) | |
| 914 (define-function 'int-char 'int-to-char) | |
| 915 | |
|
4329
d9eb5ea14f65
Provide %b in #'format; use it for converting between ints and bit vectors.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4267
diff
changeset
|
916 ;; XEmacs addition. |
|
d9eb5ea14f65
Provide %b in #'format; use it for converting between ints and bit vectors.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4267
diff
changeset
|
917 (defun integer-to-bit-vector (integer &optional minlength) |
|
d9eb5ea14f65
Provide %b in #'format; use it for converting between ints and bit vectors.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4267
diff
changeset
|
918 "Return INTEGER converted to a bit vector. |
|
d9eb5ea14f65
Provide %b in #'format; use it for converting between ints and bit vectors.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4267
diff
changeset
|
919 Optional argument MINLENGTH gives a minimum length for the returned vector. |
|
d9eb5ea14f65
Provide %b in #'format; use it for converting between ints and bit vectors.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4267
diff
changeset
|
920 If MINLENGTH is not given, zero high-order bits will be ignored." |
|
d9eb5ea14f65
Provide %b in #'format; use it for converting between ints and bit vectors.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4267
diff
changeset
|
921 (check-argument-type #'integerp integer) |
|
d9eb5ea14f65
Provide %b in #'format; use it for converting between ints and bit vectors.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4267
diff
changeset
|
922 (setq minlength (or minlength 0)) |
|
d9eb5ea14f65
Provide %b in #'format; use it for converting between ints and bit vectors.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4267
diff
changeset
|
923 (check-nonnegative-number minlength) |
|
d9eb5ea14f65
Provide %b in #'format; use it for converting between ints and bit vectors.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4267
diff
changeset
|
924 (read (format (format "#*%%0%db" minlength) integer))) |
|
d9eb5ea14f65
Provide %b in #'format; use it for converting between ints and bit vectors.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4267
diff
changeset
|
925 |
|
d9eb5ea14f65
Provide %b in #'format; use it for converting between ints and bit vectors.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4267
diff
changeset
|
926 ;; XEmacs addition. |
|
d9eb5ea14f65
Provide %b in #'format; use it for converting between ints and bit vectors.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4267
diff
changeset
|
927 (defun bit-vector-to-integer (bit-vector) |
|
d9eb5ea14f65
Provide %b in #'format; use it for converting between ints and bit vectors.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4267
diff
changeset
|
928 "Return BIT-VECTOR converted to an integer. |
|
d9eb5ea14f65
Provide %b in #'format; use it for converting between ints and bit vectors.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4267
diff
changeset
|
929 If bignum support is available, BIT-VECTOR's length is unlimited. |
|
d9eb5ea14f65
Provide %b in #'format; use it for converting between ints and bit vectors.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4267
diff
changeset
|
930 Otherwise the limit is the number of value bits in an Lisp integer. " |
|
d9eb5ea14f65
Provide %b in #'format; use it for converting between ints and bit vectors.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4267
diff
changeset
|
931 (check-argument-type #'bit-vector-p bit-vector) |
|
d9eb5ea14f65
Provide %b in #'format; use it for converting between ints and bit vectors.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4267
diff
changeset
|
932 (setq bit-vector (prin1-to-string bit-vector)) |
|
d9eb5ea14f65
Provide %b in #'format; use it for converting between ints and bit vectors.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4267
diff
changeset
|
933 (aset bit-vector 1 ?b) |
|
d9eb5ea14f65
Provide %b in #'format; use it for converting between ints and bit vectors.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4267
diff
changeset
|
934 (read bit-vector)) |
|
d9eb5ea14f65
Provide %b in #'format; use it for converting between ints and bit vectors.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4267
diff
changeset
|
935 |
| 771 | 936 (defun string-width (string) |
| 937 "Return number of columns STRING occupies when displayed. | |
| 938 With international (Mule) support, uses the charset-columns attribute of | |
| 939 the characters in STRING, which may not accurately represent the actual | |
| 940 display width when using a window system. With no international support, | |
| 941 simply returns the length of the string." | |
| 942 (if (featurep 'mule) | |
| 943 (let ((col 0) | |
| 944 (len (length string)) | |
| 945 (i 0)) | |
| 772 | 946 (with-fboundp '(charset-width char-charset) |
| 947 (while (< i len) | |
| 948 (setq col (+ col (charset-width (char-charset (aref string i))))) | |
| 949 (setq i (1+ i)))) | |
| 771 | 950 col) |
| 951 (length string))) | |
| 952 | |
| 777 | 953 (defun char-width (character) |
| 954 "Return number of columns a CHARACTER occupies when displayed." | |
| 955 (if (featurep 'mule) | |
| 956 (with-fboundp '(charset-width char-charset) | |
| 957 (charset-width (char-charset character))) | |
| 958 1)) | |
| 959 | |
| 960 ;; The following several functions are useful in GNU Emacs 20 because | |
| 961 ;; of the multibyte "characters" the internal representation of which | |
| 962 ;; leaks into Lisp. In XEmacs/Mule they are trivial and unnecessary. | |
| 963 ;; We provide them for compatibility reasons solely. | |
| 964 | |
| 965 (defun string-to-sequence (string type) | |
| 966 "Convert STRING to a sequence of TYPE which contains characters in STRING. | |
| 967 TYPE should be `list' or `vector'." | |
| 968 (ecase type | |
| 969 (list | |
| 4267 | 970 (append string nil)) |
| 777 | 971 (vector |
| 4267 | 972 (vconcat string)))) |
| 777 | 973 |
| 974 (defun string-to-list (string) | |
| 975 "Return a list of characters in STRING." | |
| 4267 | 976 (append string nil)) |
| 777 | 977 |
| 978 (defun string-to-vector (string) | |
| 979 "Return a vector of characters in STRING." | |
| 4267 | 980 (vconcat string)) |
| 777 | 981 |
| 982 (defun store-substring (string idx obj) | |
| 983 "Embed OBJ (string or character) at index IDX of STRING." | |
| 984 (let* ((str (cond ((stringp obj) obj) | |
| 985 ((characterp obj) (char-to-string obj)) | |
| 986 (t (error | |
| 987 "Invalid argument (should be string or character): %s" | |
| 988 obj)))) | |
| 989 (string-len (length string)) | |
| 990 (len (length str)) | |
| 991 (i 0)) | |
| 992 (while (and (< i len) (< idx string-len)) | |
| 993 (aset string idx (aref str i)) | |
| 994 (setq idx (1+ idx) i (1+ i))) | |
| 995 string)) | |
| 996 | |
| 851 | 997 ;; From FSF 21.1; ELLIPSES is XEmacs addition. |
| 998 | |
| 999 (defun truncate-string-to-width (str end-column &optional start-column padding | |
| 1333 | 1000 ellipses) |
| 777 | 1001 "Truncate string STR to end at column END-COLUMN. |
| 814 | 1002 The optional 3rd arg START-COLUMN, if non-nil, specifies |
| 777 | 1003 the starting column; that means to return the characters occupying |
| 1004 columns START-COLUMN ... END-COLUMN of STR. | |
| 1005 | |
| 814 | 1006 The optional 4th arg PADDING, if non-nil, specifies a padding character |
| 777 | 1007 to add at the end of the result if STR doesn't reach column END-COLUMN, |
| 1008 or if END-COLUMN comes in the middle of a character in STR. | |
| 1009 PADDING is also added at the beginning of the result | |
| 1010 if column START-COLUMN appears in the middle of a character in STR. | |
| 1011 | |
| 1012 If PADDING is nil, no padding is added in these cases, so | |
| 851 | 1013 the resulting string may be narrower than END-COLUMN. |
| 1014 | |
| 1015 BUG: Currently assumes that the padding character is of width one. You | |
| 1016 will get weird results if not. | |
| 1017 | |
| 1018 If ELLIPSES is non-nil, add ellipses (specified by ELLIPSES if a string, | |
| 1019 else `...') if STR extends past END-COLUMN. The ellipses will be added in | |
| 1020 such a way that the total string occupies no more than END-COLUMN columns | |
| 1021 -- i.e. if the string goes past END-COLUMN, it will be truncated somewhere | |
| 1022 short of END-COLUMN so that, with the ellipses added (and padding, if the | |
| 1023 proper place to truncate the string would be in the middle of a character), | |
| 1024 the string occupies exactly END-COLUMN columns." | |
| 777 | 1025 (or start-column |
| 1026 (setq start-column 0)) | |
| 814 | 1027 (let ((len (length str)) |
| 1028 (idx 0) | |
| 1029 (column 0) | |
| 1030 (head-padding "") (tail-padding "") | |
| 1031 ch last-column last-idx from-idx) | |
| 851 | 1032 |
| 1033 ;; find the index of START-COLUMN; bail out if end of string reached. | |
| 814 | 1034 (condition-case nil |
| 1035 (while (< column start-column) | |
| 1036 (setq ch (aref str idx) | |
| 1037 column (+ column (char-width ch)) | |
| 1038 idx (1+ idx))) | |
| 1039 (args-out-of-range (setq idx len))) | |
| 1040 (if (< column start-column) | |
| 851 | 1041 ;; if string ends before START-COLUMN, return either a blank string |
| 1042 ;; or a string entirely padded. | |
| 1043 (if padding (make-string (- end-column start-column) padding) "") | |
| 814 | 1044 (if (and padding (> column start-column)) |
| 1045 (setq head-padding (make-string (- column start-column) padding))) | |
| 1046 (setq from-idx idx) | |
| 851 | 1047 ;; If END-COLUMN is before START-COLUMN, then bail out. |
| 814 | 1048 (if (< end-column column) |
| 851 | 1049 (setq idx from-idx ellipses "") |
| 1050 | |
| 1051 ;; handle ELLIPSES | |
| 1052 (cond ((null ellipses) (setq ellipses "")) | |
| 1053 ((if (<= (string-width str) end-column) | |
| 1054 ;; string fits, no ellipses | |
| 1055 (setq ellipses ""))) | |
| 1056 (t | |
| 1057 ;; else, insert default value and ... | |
| 1058 (or (stringp ellipses) (setq ellipses "...")) | |
| 1059 ;; ... take away the width of the ellipses from the | |
| 1060 ;; destination. do all computations with new, shorter | |
| 1061 ;; width. the padding computed will get us exactly up to | |
| 1062 ;; the shorted width, which is right -- it just gets added | |
| 1063 ;; to the right of the ellipses. | |
| 924 | 1064 (setq end-column (- end-column (string-width ellipses))))) |
| 851 | 1065 |
| 1066 ;; find the index of END-COLUMN; bail out if end of string reached. | |
| 814 | 1067 (condition-case nil |
| 1068 (while (< column end-column) | |
| 1069 (setq last-column column | |
| 1070 last-idx idx | |
| 1071 ch (aref str idx) | |
| 1072 column (+ column (char-width ch)) | |
| 1073 idx (1+ idx))) | |
| 1074 (args-out-of-range (setq idx len))) | |
| 851 | 1075 ;; if we went too far (stopped in middle of character), back up. |
| 814 | 1076 (if (> column end-column) |
| 1077 (setq column last-column idx last-idx)) | |
| 851 | 1078 ;; compute remaining padding |
| 814 | 1079 (if (and padding (< column end-column)) |
| 1080 (setq tail-padding (make-string (- end-column column) padding)))) | |
| 851 | 1081 ;; get substring ... |
| 814 | 1082 (setq str (substring str from-idx idx)) |
| 851 | 1083 ;; and construct result |
| 814 | 1084 (if padding |
| 851 | 1085 (concat head-padding str tail-padding ellipses) |
| 1086 (concat str ellipses))))) | |
| 801 | 1087 |
| 428 | 1088 |
| 1089 ;; alist/plist functions | |
| 1090 (defun plist-to-alist (plist) | |
| 1091 "Convert property list PLIST into the equivalent association-list form. | |
| 1092 The alist is returned. This converts from | |
| 1093 | |
| 1094 \(a 1 b 2 c 3) | |
| 1095 | |
| 1096 into | |
| 1097 | |
| 1098 \((a . 1) (b . 2) (c . 3)) | |
| 1099 | |
| 1100 The original plist is not modified. See also `destructive-plist-to-alist'." | |
| 1101 (let (alist) | |
| 1102 (while plist | |
| 1103 (setq alist (cons (cons (car plist) (cadr plist)) alist)) | |
| 1104 (setq plist (cddr plist))) | |
| 1105 (nreverse alist))) | |
| 1106 | |
| 783 | 1107 (defun map-plist (_mp_fun _mp_plist) |
| 1108 "Map _MP_FUN (a function of two args) over each key/value pair in _MP_PLIST. | |
| 1109 Return a list of the results." | |
| 1110 (let (_mp_result) | |
| 1111 (while _mp_plist | |
| 1112 (push (funcall _mp_fun (car _mp_plist) (cadr _mp_plist)) _mp_result) | |
| 1113 (setq _mp_plist (cddr _mp_plist))) | |
| 1114 (nreverse _mp_result))) | |
| 1115 | |
| 428 | 1116 (defun destructive-plist-to-alist (plist) |
| 1117 "Convert property list PLIST into the equivalent association-list form. | |
| 1118 The alist is returned. This converts from | |
| 1119 | |
| 1120 \(a 1 b 2 c 3) | |
| 1121 | |
| 1122 into | |
| 1123 | |
| 1124 \((a . 1) (b . 2) (c . 3)) | |
| 1125 | |
| 1126 The original plist is destroyed in the process of constructing the alist. | |
| 1127 See also `plist-to-alist'." | |
| 1128 (let ((head plist) | |
| 1129 next) | |
| 1130 (while plist | |
| 1131 ;; remember the next plist pair. | |
| 1132 (setq next (cddr plist)) | |
| 1133 ;; make the cons holding the property value into the alist element. | |
| 1134 (setcdr (cdr plist) (cadr plist)) | |
| 1135 (setcar (cdr plist) (car plist)) | |
| 1136 ;; reattach into alist form. | |
| 1137 (setcar plist (cdr plist)) | |
| 1138 (setcdr plist next) | |
| 1139 (setq plist next)) | |
| 1140 head)) | |
| 1141 | |
| 1142 (defun alist-to-plist (alist) | |
| 1143 "Convert association list ALIST into the equivalent property-list form. | |
| 1144 The plist is returned. This converts from | |
| 1145 | |
| 1146 \((a . 1) (b . 2) (c . 3)) | |
| 1147 | |
| 1148 into | |
| 1149 | |
| 1150 \(a 1 b 2 c 3) | |
| 1151 | |
| 1152 The original alist is not modified. See also `destructive-alist-to-plist'." | |
| 1153 (let (plist) | |
| 1154 (while alist | |
| 1155 (let ((el (car alist))) | |
| 1156 (setq plist (cons (cdr el) (cons (car el) plist)))) | |
| 1157 (setq alist (cdr alist))) | |
| 1158 (nreverse plist))) | |
| 1159 | |
| 1160 ;; getf, remf in cl*.el. | |
| 1161 | |
| 444 | 1162 (defmacro putf (plist property value) |
| 1163 "Add property PROPERTY to plist PLIST with value VALUE. | |
| 1164 Analogous to (setq PLIST (plist-put PLIST PROPERTY VALUE))." | |
| 1165 `(setq ,plist (plist-put ,plist ,property ,value))) | |
| 428 | 1166 |
| 444 | 1167 (defmacro laxputf (lax-plist property value) |
| 1168 "Add property PROPERTY to lax plist LAX-PLIST with value VALUE. | |
| 1169 Analogous to (setq LAX-PLIST (lax-plist-put LAX-PLIST PROPERTY VALUE))." | |
| 1170 `(setq ,lax-plist (lax-plist-put ,lax-plist ,property ,value))) | |
| 428 | 1171 |
| 444 | 1172 (defmacro laxremf (lax-plist property) |
| 1173 "Remove property PROPERTY from lax plist LAX-PLIST. | |
| 1174 Analogous to (setq LAX-PLIST (lax-plist-remprop LAX-PLIST PROPERTY))." | |
| 1175 `(setq ,lax-plist (lax-plist-remprop ,lax-plist ,property))) | |
| 428 | 1176 |
| 1177 ;;; Error functions | |
| 1178 | |
| 442 | 1179 (defun error (datum &rest args) |
| 1180 "Signal a non-continuable error. | |
| 1181 DATUM should normally be an error symbol, i.e. a symbol defined using | |
| 1182 `define-error'. ARGS will be made into a list, and DATUM and ARGS passed | |
| 1183 as the two arguments to `signal', the most basic error handling function. | |
| 1184 | |
| 428 | 1185 This error is not continuable: you cannot continue execution after the |
| 442 | 1186 error using the debugger `r' command. See also `cerror'. |
| 1187 | |
| 1188 The correct semantics of ARGS varies from error to error, but for most | |
| 1189 errors that need to be generated in Lisp code, the first argument | |
| 1190 should be a string describing the *context* of the error (i.e. the | |
| 1191 exact operation being performed and what went wrong), and the remaining | |
| 1192 arguments or \"frobs\" (most often, there is one) specify the | |
| 1193 offending object(s) and/or provide additional details such as the exact | |
| 1194 error when a file error occurred, e.g.: | |
| 1195 | |
| 1196 -- the buffer in which an editing error occurred. | |
| 1197 -- an invalid value that was encountered. (In such cases, the string | |
| 1198 should describe the purpose or \"semantics\" of the value [e.g. if the | |
| 1199 value is an argument to a function, the name of the argument; if the value | |
| 1200 is the value corresponding to a keyword, the name of the keyword; if the | |
| 1201 value is supposed to be a list length, say this and say what the purpose | |
| 1202 of the list is; etc.] as well as specifying why the value is invalid, if | |
| 1203 that's not self-evident.) | |
| 1204 -- the file in which an error occurred. (In such cases, there should be a | |
| 1205 second frob, probably a string, specifying the exact error that occurred. | |
| 1206 This does not occur in the string that precedes the first frob, because | |
| 1207 that frob describes the exact operation that was happening. | |
| 1208 | |
| 1209 For historical compatibility, DATUM can also be a string. In this case, | |
| 1210 DATUM and ARGS are passed together as the arguments to `format', and then | |
| 1211 an error is signalled using the error symbol `error' and formatted string. | |
| 1212 Although this usage of `error' is very common, it is deprecated because it | |
| 1213 totally defeats the purpose of having structured errors. There is now | |
| 1214 a rich set of defined errors you can use: | |
| 1215 | |
| 563 | 1216 quit |
| 1217 | |
| 442 | 1218 error |
| 1219 invalid-argument | |
| 563 | 1220 syntax-error |
| 1221 invalid-read-syntax | |
| 1222 invalid-regexp | |
| 1223 structure-formation-error | |
| 1224 list-formation-error | |
| 1225 malformed-list | |
| 1226 malformed-property-list | |
| 1227 circular-list | |
| 1228 circular-property-list | |
| 1229 invalid-function | |
| 1230 no-catch | |
| 1231 undefined-keystroke-sequence | |
| 1232 invalid-constant | |
| 442 | 1233 wrong-type-argument |
| 1234 args-out-of-range | |
| 1235 wrong-number-of-arguments | |
| 428 | 1236 |
| 442 | 1237 invalid-state |
| 1238 void-function | |
| 1239 cyclic-function-indirection | |
| 1240 void-variable | |
| 1241 cyclic-variable-indirection | |
| 509 | 1242 invalid-byte-code |
| 563 | 1243 stack-overflow |
| 1244 out-of-memory | |
| 1245 invalid-key-binding | |
| 1246 internal-error | |
| 442 | 1247 |
| 1248 invalid-operation | |
| 1249 invalid-change | |
| 1250 setting-constant | |
| 563 | 1251 protected-field |
| 442 | 1252 editing-error |
| 1253 beginning-of-buffer | |
| 1254 end-of-buffer | |
| 1255 buffer-read-only | |
| 1256 io-error | |
| 509 | 1257 file-error |
| 1258 file-already-exists | |
| 1259 file-locked | |
| 1260 file-supersession | |
| 563 | 1261 end-of-file |
| 1262 process-error | |
| 1263 network-error | |
| 509 | 1264 tooltalk-error |
| 563 | 1265 gui-error |
| 1266 dialog-box-error | |
| 1267 sound-error | |
| 1268 conversion-error | |
| 1269 text-conversion-error | |
| 1270 image-conversion-error | |
| 1271 base64-conversion-error | |
| 1272 selection-conversion-error | |
| 442 | 1273 arith-error |
| 1274 range-error | |
| 1275 domain-error | |
| 1276 singularity-error | |
| 1277 overflow-error | |
| 1278 underflow-error | |
| 509 | 1279 search-failed |
| 563 | 1280 printing-unreadable-object |
| 1281 unimplemented | |
| 509 | 1282 |
| 563 | 1283 Note the semantic differences between some of the more common errors: |
| 442 | 1284 |
| 563 | 1285 -- `invalid-argument' is for all cases where a bad value is encountered. |
| 1286 -- `invalid-constant' is for arguments where only a specific set of values | |
| 1287 is allowed. | |
| 1288 -- `syntax-error' is when complex structures (parsed strings, lists, | |
| 1289 and the like) are badly formed. If the problem is just a single bad | |
| 1290 value inside the structure, you should probably be using something else, | |
| 1291 e.g. `invalid-constant', `wrong-type-argument', or `invalid-argument'. | |
| 442 | 1292 -- `invalid-state' means that some settings have been changed in such a way |
| 1293 that their current state is unallowable. More and more, code is being | |
| 1294 written more carefully, and catches the error when the settings are being | |
| 1295 changed, rather than afterwards. This leads us to the next error: | |
| 1296 -- `invalid-change' means that an attempt is being made to change some settings | |
| 1297 into an invalid state. `invalid-change' is a type of `invalid-operation'. | |
| 1298 -- `invalid-operation' refers to all cases where code is trying to do something | |
| 563 | 1299 that's disallowed, or when an error occurred during an operation. (These |
| 1300 two concepts are merged because there's no clear distinction between them.) | |
| 1301 -- `io-error' refers to errors involving interaction with any external | |
| 1302 components (files, other programs, the operating system, etc). | |
| 442 | 1303 |
| 1304 See also `cerror', `signal', and `signal-error'." | |
| 1305 (while t (apply | |
| 1306 'cerror datum args))) | |
| 1307 | |
| 1308 (defun cerror (datum &rest args) | |
| 428 | 1309 "Like `error' but signals a continuable error." |
| 442 | 1310 (cond ((stringp datum) |
| 1311 (signal 'error (list (apply 'format datum args)))) | |
| 1312 ((defined-error-p datum) | |
| 1313 (signal datum args)) | |
| 1314 (t | |
| 1315 (error 'invalid-argument "datum not string or error symbol" datum)))) | |
| 428 | 1316 |
| 1317 (defmacro check-argument-type (predicate argument) | |
| 1318 "Check that ARGUMENT satisfies PREDICATE. | |
| 442 | 1319 This is a macro, and ARGUMENT is not evaluated. If ARGUMENT is an lvalue, |
| 1320 this function signals a continuable `wrong-type-argument' error until the | |
| 1321 returned value satisfies PREDICATE, and assigns the returned value | |
| 1322 to ARGUMENT. Otherwise, this function signals a non-continuable | |
| 1323 `wrong-type-argument' error if the returned value does not satisfy PREDICATE." | |
| 1324 (if (symbolp argument) | |
| 1325 `(if (not (,(eval predicate) ,argument)) | |
| 1326 (setq ,argument | |
| 1327 (wrong-type-argument ,predicate ,argument))) | |
| 1328 `(if (not (,(eval predicate) ,argument)) | |
| 1329 (signal-error 'wrong-type-argument (list ,predicate ,argument))))) | |
| 428 | 1330 |
| 872 | 1331 (defun args-out-of-range (value min max) |
| 1332 "Signal an error until the correct in-range value is given by the user. | |
| 1333 This function loops, signalling a continuable `args-out-of-range' error | |
| 1334 with VALUE, MIN and MAX as the data associated with the error and then | |
| 1335 checking the returned value to make sure it's not outside the given | |
| 1336 boundaries \(nil for either means no boundary on that side). At that | |
| 1337 point, the gotten value is returned." | |
| 1338 (loop | |
| 1339 for newval = (signal 'args-out-of-range (list value min max)) | |
| 1340 do (setq value newval) | |
| 1341 finally return value | |
| 1342 while (not (argument-in-range-p value min max)))) | |
| 1343 | |
| 1344 (defun argument-in-range-p (argument min max) | |
| 1345 "Return true if ARGUMENT is within the range of [MIN, MAX]. | |
| 1346 This includes boundaries. nil for either value means no limit on that side." | |
| 1347 (and (or (not min) (<= min argument)) | |
| 1348 (or (not max) (<= argument max)))) | |
| 1349 | |
| 1350 (defmacro check-argument-range (argument min max) | |
| 1351 "Check that ARGUMENT is within the range [MIN, MAX]. | |
| 1352 This is a macro, and ARGUMENT is not evaluated. If ARGUMENT is an lvalue, | |
| 1353 this function signals a continuable `args-out-of-range' error until the | |
| 1354 returned value is within range, and assigns the returned value | |
| 1355 to ARGUMENT. Otherwise, this function signals a non-continuable | |
| 1356 `args-out-of-range' error if the returned value is out of range." | |
| 1357 (if (symbolp argument) | |
| 1358 `(if (not (argument-in-range-p ,argument ,min ,max)) | |
| 924 | 1359 (setq ,argument |
| 1360 (args-out-of-range ,argument ,min ,max))) | |
| 872 | 1361 (let ((newsym (gensym))) |
| 1362 `(let ((,newsym ,argument)) | |
| 924 | 1363 (if (not (argument-in-range-p ,newsym ,min ,max)) |
| 4103 | 1364 (signal-error 'args-out-of-range (list ,newsym ,min ,max))))))) |
| 872 | 1365 |
| 428 | 1366 (defun signal-error (error-symbol data) |
| 1367 "Signal a non-continuable error. Args are ERROR-SYMBOL, and associated DATA. | |
| 1368 An error symbol is a symbol defined using `define-error'. | |
| 1369 DATA should be a list. Its elements are printed as part of the error message. | |
| 1370 If the signal is handled, DATA is made available to the handler. | |
| 1371 See also `signal', and the functions to handle errors: `condition-case' | |
| 1372 and `call-with-condition-handler'." | |
| 1373 (while t | |
| 1374 (signal error-symbol data))) | |
| 1375 | |
| 1376 (defun define-error (error-sym doc-string &optional inherits-from) | |
| 1377 "Define a new error, denoted by ERROR-SYM. | |
| 1378 DOC-STRING is an informative message explaining the error, and will be | |
| 1379 printed out when an unhandled error occurs. | |
| 1380 ERROR-SYM is a sub-error of INHERITS-FROM (which defaults to `error'). | |
| 1381 | |
| 1382 \[`define-error' internally works by putting on ERROR-SYM an `error-message' | |
| 1383 property whose value is DOC-STRING, and an `error-conditions' property | |
| 1384 that is a list of ERROR-SYM followed by each of its super-errors, up | |
| 1385 to and including `error'. You will sometimes see code that sets this up | |
| 1386 directly rather than calling `define-error', but you should *not* do this | |
| 1387 yourself.]" | |
| 1388 (check-argument-type 'symbolp error-sym) | |
| 1389 (check-argument-type 'stringp doc-string) | |
| 1390 (put error-sym 'error-message doc-string) | |
| 1391 (or inherits-from (setq inherits-from 'error)) | |
| 1392 (let ((conds (get inherits-from 'error-conditions))) | |
| 1393 (or conds (signal-error 'error (list "Not an error symbol" error-sym))) | |
| 1394 (put error-sym 'error-conditions (cons error-sym conds)))) | |
| 1395 | |
| 442 | 1396 (defun defined-error-p (sym) |
| 1397 "Returns non-nil if SYM names a currently-defined error." | |
| 1398 (and (symbolp sym) (not (null (get sym 'error-conditions))))) | |
| 1399 | |
| 793 | 1400 (defun backtrace-in-condition-handler-eliminating-handler (handler-arg-name) |
| 1401 "Return a backtrace inside of a condition handler, eliminating the handler. | |
| 1402 This is for use in the condition handler inside of call-with-condition-handler, | |
| 1403 when written like this: | |
| 1404 | |
| 1405 \(call-with-condition-handler | |
| 1406 #'(lambda (__some_weird_arg__) | |
| 1407 do the handling ...) | |
| 1408 #'(lambda () | |
| 1409 do the stuff that might cause an error)) | |
| 1410 | |
| 1411 Pass in the name (a symbol) of the argument used in the lambda function | |
| 1412 that specifies the handler, and make sure the argument name is unique, and | |
| 1413 this function generates a backtrace and strips off the part above where the | |
| 1414 error occurred (i.e. the handler itself)." | |
| 1415 (let* ((bt (with-output-to-string (backtrace nil t))) | |
| 1416 (bt (save-match-data | |
| 1417 ;; Try to eliminate the part of the backtrace | |
| 1418 ;; above where the error occurred. | |
| 1419 (if (string-match | |
| 1420 (concat "bind (\\(?:.* \\)?" (symbol-name handler-arg-name) | |
| 1421 "\\(?:.* \\)?)[ \t\n]*\\(?:(lambda \\|#<compiled-function \\)(" | |
| 1422 (symbol-name handler-arg-name) | |
| 1423 ").*\n\\(\\(?:.\\|\n\\)*\\)$") | |
| 1424 bt) (match-string 1 bt) bt)))) | |
| 1425 bt)) | |
| 1426 | |
| 1427 (put 'with-trapping-errors 'lisp-indent-function 0) | |
| 1428 (defmacro with-trapping-errors (&rest keys-body) | |
| 1429 "Trap errors in BODY, outputting a warning and a backtrace. | |
| 1430 Usage looks like | |
| 1431 | |
| 1432 \(with-trapping-errors | |
| 1433 [:operation OPERATION] | |
| 1434 [:error-form ERROR-FORM] | |
| 1435 [:no-backtrace NO-BACKTRACE] | |
| 1436 [:class CLASS] | |
| 1437 [:level LEVEL] | |
| 1438 [:resignal RESIGNAL] | |
| 1439 BODY) | |
| 1440 | |
| 1441 Return value without error is whatever BODY returns. With error, return | |
| 1442 result of ERROR-FORM (which will be evaluated only when the error actually | |
| 1443 occurs), which defaults to nil. OPERATION is given in the warning message. | |
| 1444 CLASS and LEVEL are the warning class and level (default to class | |
| 1445 `general', level `warning'). If NO-BACKTRACE is given, no backtrace is | |
| 1446 displayed. If RESIGNAL is given, the error is resignaled after the warning | |
| 1447 is displayed and the ERROR-FORM is executed." | |
| 1448 (let ((operation "unknown") | |
| 1449 (error-form nil) | |
| 1450 (no-backtrace nil) | |
| 1451 (class ''general) | |
| 1452 (level ''warning) | |
| 1453 (resignal nil)) | |
| 1454 (let* ((keys '(operation error-form no-backtrace class level resignal)) | |
| 1455 (keys-with-colon | |
| 1456 (mapcar #'(lambda (sym) | |
| 1457 (intern (concat ":" (symbol-name sym)))) keys))) | |
| 1458 (while (memq (car keys-body) keys-with-colon) | |
| 1459 (let* ((key-with-colon (pop keys-body)) | |
| 1460 (key (intern (substring (symbol-name key-with-colon) 1)))) | |
| 1461 (set key (pop keys-body))))) | |
| 1462 `(condition-case ,(if resignal '__cte_cc_var__ nil) | |
| 1463 (call-with-condition-handler | |
| 1464 #'(lambda (__call_trapping_errors_arg__) | |
| 1465 (let ((errstr (error-message-string | |
| 1466 __call_trapping_errors_arg__))) | |
| 1467 ,(if no-backtrace | |
| 1468 `(lwarn ,class ,level | |
| 1469 (if (warning-level-< | |
| 1470 ,level | |
| 1471 display-warning-minimum-level) | |
| 1472 "Error in %s: %s" | |
| 1473 "Error in %s:\n%s\n") | |
| 1474 ,operation errstr) | |
| 1475 `(lwarn ,class ,level | |
| 1476 "Error in %s: %s\n\nBacktrace follows:\n\n%s" | |
| 1477 ,operation errstr | |
| 1478 (backtrace-in-condition-handler-eliminating-handler | |
| 1479 '__call_trapping_errors_arg__))))) | |
| 1480 #'(lambda () | |
| 1481 (progn ,@keys-body))) | |
| 1482 (error | |
| 1483 ,error-form | |
| 1484 ,@(if resignal '((signal (car __cte_cc_var__) (cdr __cte_cc_var__))))) | |
| 1485 ))) | |
| 1486 | |
| 428 | 1487 ;;;; Miscellanea. |
| 1488 | |
| 1489 ;; This is now in C. | |
| 444 | 1490 ;(defun buffer-substring-no-properties (start end) |
| 1491 ; "Return the text from START to END, without text properties, as a string." | |
| 1492 ; (let ((string (buffer-substring start end))) | |
| 428 | 1493 ; (set-text-properties 0 (length string) nil string) |
| 1494 ; string)) | |
| 1495 | |
| 1496 (defun get-buffer-window-list (&optional buffer minibuf frame) | |
| 1497 "Return windows currently displaying BUFFER, or nil if none. | |
| 1498 BUFFER defaults to the current buffer. | |
| 1499 See `walk-windows' for the meaning of MINIBUF and FRAME." | |
| 1500 (cond ((null buffer) | |
| 1501 (setq buffer (current-buffer))) | |
| 1502 ((not (bufferp buffer)) | |
| 1503 (setq buffer (get-buffer buffer)))) | |
| 1504 (let (windows) | |
| 1505 (walk-windows (lambda (window) | |
| 1506 (if (eq (window-buffer window) buffer) | |
| 1507 (push window windows))) | |
| 1508 minibuf frame) | |
| 1509 windows)) | |
| 1510 | |
| 1511 (defun ignore (&rest ignore) | |
| 1512 "Do nothing and return nil. | |
| 1513 This function accepts any number of arguments, but ignores them." | |
| 1514 (interactive) | |
| 1515 nil) | |
| 1516 | |
| 883 | 1517 ;; defined in lisp/bindings.el in GNU Emacs. |
| 1518 (defmacro bound-and-true-p (var) | |
| 1519 "Return the value of symbol VAR if it is bound, else nil." | |
| 1520 `(and (boundp (quote ,var)) ,var)) | |
| 1521 | |
| 1522 ;; `propertize' is a builtin in GNU Emacs 21. | |
| 1523 (defun propertize (string &rest properties) | |
| 1524 "Return a copy of STRING with text properties added. | |
| 1525 First argument is the string to copy. | |
| 1526 Remaining arguments form a sequence of PROPERTY VALUE pairs for text | |
| 1527 properties to add to the result." | |
| 1528 (let ((str (copy-sequence string))) | |
| 1529 (add-text-properties 0 (length str) | |
| 1530 properties | |
| 1531 str) | |
| 1532 str)) | |
| 1533 | |
| 1534 ;; `delete-and-extract-region' is a builtin in GNU Emacs 21. | |
| 1535 (defun delete-and-extract-region (start end) | |
| 1536 "Delete the text between START and END and return it." | |
| 1537 (let ((region (buffer-substring start end))) | |
| 1538 (delete-region start end) | |
| 1539 region)) | |
| 1540 | |
| 428 | 1541 (define-function 'eval-in-buffer 'with-current-buffer) |
| 1542 (make-obsolete 'eval-in-buffer 'with-current-buffer) | |
| 1543 | |
| 1544 ;;; The real defn is in abbrev.el but some early callers | |
| 1545 ;;; (eg lisp-mode-abbrev-table) want this before abbrev.el is loaded... | |
| 1546 | |
| 1547 (if (not (fboundp 'define-abbrev-table)) | |
| 1548 (progn | |
| 1549 (setq abbrev-table-name-list '()) | |
| 924 | 1550 (fset 'define-abbrev-table |
| 1551 (function (lambda (name defs) | |
| 1552 ;; These are fixed-up when abbrev.el loads. | |
| 1553 (setq abbrev-table-name-list | |
| 1554 (cons (cons name defs) | |
| 1555 abbrev-table-name-list))))))) | |
| 428 | 1556 |
| 1557 ;;; `functionp' has been moved into C. | |
| 1558 | |
| 1559 ;;(defun functionp (object) | |
| 1560 ;; "Non-nil if OBJECT can be called as a function." | |
| 1561 ;; (or (and (symbolp object) (fboundp object)) | |
| 1562 ;; (subrp object) | |
| 1563 ;; (compiled-function-p object) | |
| 1564 ;; (eq (car-safe object) 'lambda))) | |
| 1565 | |
| 1566 (defun function-interactive (function) | |
| 1567 "Return the interactive specification of FUNCTION. | |
| 1568 FUNCTION can be any funcallable object. | |
| 1569 The specification will be returned as the list of the symbol `interactive' | |
| 1570 and the specs. | |
| 1571 If FUNCTION is not interactive, nil will be returned." | |
| 1572 (setq function (indirect-function function)) | |
| 1573 (cond ((compiled-function-p function) | |
| 1574 (compiled-function-interactive function)) | |
| 1575 ((subrp function) | |
| 1576 (subr-interactive function)) | |
| 1577 ((eq (car-safe function) 'lambda) | |
| 1578 (let ((spec (if (stringp (nth 2 function)) | |
| 1579 (nth 3 function) | |
| 1580 (nth 2 function)))) | |
| 1581 (and (eq (car-safe spec) 'interactive) | |
| 1582 spec))) | |
| 1583 (t | |
| 1584 (error "Non-funcallable object: %s" function)))) | |
| 1585 | |
| 442 | 1586 (defun function-allows-args (function n) |
| 1587 "Return whether FUNCTION can be called with N arguments." | |
| 1588 (and (<= (function-min-args function) n) | |
| 1589 (or (null (function-max-args function)) | |
| 1590 (<= n (function-max-args function))))) | |
| 1591 | |
| 428 | 1592 ;; This function used to be an alias to `buffer-substring', except |
| 1593 ;; that FSF Emacs 20.4 added a BUFFER argument in an incompatible way. | |
| 1594 ;; The new FSF's semantics makes more sense, but we try to support | |
| 1595 ;; both for backward compatibility. | |
| 1596 (defun buffer-string (&optional buffer old-end old-buffer) | |
| 1597 "Return the contents of the current buffer as a string. | |
| 1598 If narrowing is in effect, this function returns only the visible part | |
| 1599 of the buffer. | |
| 1600 | |
| 1601 If BUFFER is specified, the contents of that buffer are returned. | |
| 1602 | |
| 1603 The arguments OLD-END and OLD-BUFFER are supported for backward | |
| 1604 compatibility with pre-21.2 XEmacsen times when arguments to this | |
| 1605 function were (buffer-string &optional START END BUFFER)." | |
| 1606 (cond | |
| 1607 ((or (stringp buffer) (bufferp buffer)) | |
| 1608 ;; Most definitely the new way. | |
| 1609 (buffer-substring nil nil buffer)) | |
| 1610 ((or (stringp old-buffer) (bufferp old-buffer) | |
| 1611 (natnump buffer) (natnump old-end)) | |
| 1612 ;; Definitely the old way. | |
| 1613 (buffer-substring buffer old-end old-buffer)) | |
| 1614 (t | |
| 1615 ;; Probably the old way. | |
| 1616 (buffer-substring buffer old-end old-buffer)))) | |
| 1617 | |
| 1333 | 1618 ;; BEGIN SYNC WITH FSF 21.2 |
| 1619 | |
| 428 | 1620 ;; This was not present before. I think Jamie had some objections |
| 1621 ;; to this, so I'm leaving this undefined for now. --ben | |
| 1622 | |
| 1623 ;;; The objection is this: there is more than one way to load the same file. | |
| 1624 ;;; "foo", "foo.elc", "foo.el", and "/some/path/foo.elc" are all different | |
| 1625 ;;; ways to load the exact same code. `eval-after-load' is too stupid to | |
| 1626 ;;; deal with this sort of thing. If this sort of feature is desired, then | |
| 1627 ;;; it should work off of a hook on `provide'. Features are unique and | |
| 1628 ;;; the arguments to (load) are not. --Stig | |
| 1629 | |
| 1630 ;; We provide this for FSFmacs compatibility, at least until we devise | |
| 1631 ;; something better. | |
| 1632 | |
| 1633 ;;;; Specifying things to do after certain files are loaded. | |
| 1634 | |
| 1635 (defun eval-after-load (file form) | |
| 1636 "Arrange that, if FILE is ever loaded, FORM will be run at that time. | |
| 1637 This makes or adds to an entry on `after-load-alist'. | |
| 1638 If FILE is already loaded, evaluate FORM right now. | |
| 1639 It does nothing if FORM is already on the list for FILE. | |
| 1333 | 1640 FILE must match exactly. Normally FILE is the name of a library, |
| 1641 with no directory or extension specified, since that is how `load' | |
| 1642 is normally called." | |
| 1643 ;; Make sure `load-history' contains the files dumped with Emacs | |
| 1644 ;; for the case that FILE is one of the files dumped with Emacs. | |
| 1645 (if-fboundp 'load-symbol-file-load-history | |
| 1646 (load-symbol-file-load-history)) | |
| 428 | 1647 ;; Make sure there is an element for FILE. |
| 1648 (or (assoc file after-load-alist) | |
| 1649 (setq after-load-alist (cons (list file) after-load-alist))) | |
| 1650 ;; Add FORM to the element if it isn't there. | |
| 1651 (let ((elt (assoc file after-load-alist))) | |
| 1652 (or (member form (cdr elt)) | |
| 1653 (progn | |
| 1654 (nconc elt (list form)) | |
| 1655 ;; If the file has been loaded already, run FORM right away. | |
| 1656 (and (assoc file load-history) | |
| 1657 (eval form))))) | |
| 1658 form) | |
| 1659 (make-compatible 'eval-after-load "") | |
| 1660 | |
| 1661 (defun eval-next-after-load (file) | |
| 1662 "Read the following input sexp, and run it whenever FILE is loaded. | |
| 1663 This makes or adds to an entry on `after-load-alist'. | |
| 1664 FILE should be the name of a library, with no directory name." | |
| 1665 (eval-after-load file (read))) | |
| 1666 (make-compatible 'eval-next-after-load "") | |
| 1667 | |
| 1333 | 1668 ;; END SYNC WITH FSF 21.2 |
| 428 | 1669 |
| 3000 | 1670 ;; BEGIN SYNC WITH FSF 22.0.50.1 (CVS) |
| 1671 (defun delete-dups (list) | |
| 1672 "Destructively remove `equal' duplicates from LIST. | |
| 1673 Store the result in LIST and return it. LIST must be a proper list. | |
| 1674 Of several `equal' occurrences of an element in LIST, the first | |
| 1675 one is kept." | |
| 1676 (let ((tail list)) | |
| 1677 (while tail | |
| 1678 (setcdr tail (delete (car tail) (cdr tail))) | |
| 1679 (setq tail (cdr tail)))) | |
| 1680 list) | |
| 1681 | |
| 1682 ;; END SYNC WITH FSF 22.0.50.1 (CVS) | |
| 1683 | |
| 2525 | 1684 ;; (defun shell-quote-argument (argument) in process.el. |
| 1685 | |
| 1686 ;; (defun make-syntax-table (&optional oldtable) in syntax.el. | |
| 1687 | |
| 1688 ;; (defun syntax-after (pos) #### doesn't exist. | |
| 1689 | |
| 1690 ;; global-set-key, local-set-key, global-unset-key, local-unset-key in | |
| 1691 ;; keymap.el. | |
| 1692 | |
| 1693 ;; frame-configuration-p is in frame.el. | |
| 1694 | |
| 1695 ;; functionp is built-in. | |
| 1696 | |
| 1697 ;; interactive-form in obsolete.el. | |
| 1698 | |
| 1699 ;; assq-del-all in obsolete.el. | |
| 1700 | |
| 4266 | 1701 ;; make-temp-file in files.el. |
| 2525 | 1702 |
| 1703 ;; add-minor-mode in modeline.el. | |
| 1704 | |
| 1705 ;; text-clone stuff #### doesn't exist; should go in text-props.el and | |
| 1706 ;; requires changes to extents.c (modification hooks). | |
| 1707 | |
| 1708 ;; play-sound is built-in. | |
| 1709 | |
| 1710 ;; define-mail-user-agent is in simple.el. | |
| 1711 | |
| 428 | 1712 ;;; subr.el ends here |