| 1 | ;;; subr.el --- basic lisp subroutines for Emacs |
| 2 | |
| 3 | ;; Copyright (C) 1985, 86, 92, 94, 95, 99, 2000 Free Software Foundation, Inc. |
| 4 | |
| 5 | ;; This file is part of GNU Emacs. |
| 6 | |
| 7 | ;; GNU Emacs is free software; you can redistribute it and/or modify |
| 8 | ;; it under the terms of the GNU General Public License as published by |
| 9 | ;; the Free Software Foundation; either version 2, or (at your option) |
| 10 | ;; any later version. |
| 11 | |
| 12 | ;; GNU Emacs is distributed in the hope that it will be useful, |
| 13 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 | ;; GNU General Public License for more details. |
| 16 | |
| 17 | ;; You should have received a copy of the GNU General Public License |
| 18 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
| 19 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
| 20 | ;; Boston, MA 02111-1307, USA. |
| 21 | |
| 22 | ;;; Code: |
| 23 | (defvar custom-declare-variable-list nil |
| 24 | "Record `defcustom' calls made before `custom.el' is loaded to handle them. |
| 25 | Each element of this list holds the arguments to one call to `defcustom'.") |
| 26 | |
| 27 | ;; Use this, rather than defcustom, in subr.el and other files loaded |
| 28 | ;; before custom.el. |
| 29 | (defun custom-declare-variable-early (&rest arguments) |
| 30 | (setq custom-declare-variable-list |
| 31 | (cons arguments custom-declare-variable-list))) |
| 32 | \f |
| 33 | ;;;; Lisp language features. |
| 34 | |
| 35 | (defmacro lambda (&rest cdr) |
| 36 | "Return a lambda expression. |
| 37 | A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is |
| 38 | self-quoting; the result of evaluating the lambda expression is the |
| 39 | expression itself. The lambda expression may then be treated as a |
| 40 | function, i.e., stored as the function value of a symbol, passed to |
| 41 | funcall or mapcar, etc. |
| 42 | |
| 43 | ARGS should take the same form as an argument list for a `defun'. |
| 44 | DOCSTRING is an optional documentation string. |
| 45 | If present, it should describe how to call the function. |
| 46 | But documentation strings are usually not useful in nameless functions. |
| 47 | INTERACTIVE should be a call to the function `interactive', which see. |
| 48 | It may also be omitted. |
| 49 | BODY should be a list of lisp expressions." |
| 50 | ;; Note that this definition should not use backquotes; subr.el should not |
| 51 | ;; depend on backquote.el. |
| 52 | (list 'function (cons 'lambda cdr))) |
| 53 | |
| 54 | (defmacro push (newelt listname) |
| 55 | "Add NEWELT to the list stored in the symbol LISTNAME. |
| 56 | This is equivalent to (setq LISTNAME (cons NEWELT LISTNAME)). |
| 57 | LISTNAME must be a symbol." |
| 58 | (list 'setq listname |
| 59 | (list 'cons newelt listname))) |
| 60 | |
| 61 | (defmacro pop (listname) |
| 62 | "Return the first element of LISTNAME's value, and remove it from the list. |
| 63 | LISTNAME must be a symbol whose value is a list. |
| 64 | If the value is nil, `pop' returns nil but does not actually |
| 65 | change the list." |
| 66 | (list 'prog1 (list 'car listname) |
| 67 | (list 'setq listname (list 'cdr listname)))) |
| 68 | |
| 69 | (defmacro when (cond &rest body) |
| 70 | "If COND yields non-nil, do BODY, else return nil." |
| 71 | (list 'if cond (cons 'progn body))) |
| 72 | |
| 73 | (defmacro unless (cond &rest body) |
| 74 | "If COND yields nil, do BODY, else return nil." |
| 75 | (cons 'if (cons cond (cons nil body)))) |
| 76 | |
| 77 | (defmacro dolist (spec &rest body) |
| 78 | "(dolist (VAR LIST [RESULT]) BODY...): loop over a list. |
| 79 | Evaluate BODY with VAR bound to each car from LIST, in turn. |
| 80 | Then evaluate RESULT to get return value, default nil." |
| 81 | (let ((temp (make-symbol "--dolist-temp--"))) |
| 82 | (list 'let (list (list temp (nth 1 spec)) (car spec)) |
| 83 | (list 'while temp |
| 84 | (list 'setq (car spec) (list 'car temp)) |
| 85 | (cons 'progn |
| 86 | (append body |
| 87 | (list (list 'setq temp (list 'cdr temp)))))) |
| 88 | (if (cdr (cdr spec)) |
| 89 | (cons 'progn |
| 90 | (cons (list 'setq (car spec) nil) (cdr (cdr spec)))))))) |
| 91 | |
| 92 | (defmacro dotimes (spec &rest body) |
| 93 | "(dotimes (VAR COUNT [RESULT]) BODY...): loop a certain number of times. |
| 94 | Evaluate BODY with VAR bound to successive integers running from 0, |
| 95 | inclusive, to COUNT, exclusive. Then evaluate RESULT to get |
| 96 | the return value (nil if RESULT is omitted)." |
| 97 | (let ((temp (make-symbol "--dotimes-temp--"))) |
| 98 | (list 'let (list (list temp (nth 1 spec)) (list (car spec) 0)) |
| 99 | (list 'while (list '< (car spec) temp) |
| 100 | (cons 'progn |
| 101 | (append body (list (list 'setq (car spec) |
| 102 | (list '1+ (car spec))))))) |
| 103 | (if (cdr (cdr spec)) |
| 104 | (car (cdr (cdr spec))) |
| 105 | nil)))) |
| 106 | |
| 107 | (defsubst caar (x) |
| 108 | "Return the car of the car of X." |
| 109 | (car (car x))) |
| 110 | |
| 111 | (defsubst cadr (x) |
| 112 | "Return the car of the cdr of X." |
| 113 | (car (cdr x))) |
| 114 | |
| 115 | (defsubst cdar (x) |
| 116 | "Return the cdr of the car of X." |
| 117 | (cdr (car x))) |
| 118 | |
| 119 | (defsubst cddr (x) |
| 120 | "Return the cdr of the cdr of X." |
| 121 | (cdr (cdr x))) |
| 122 | |
| 123 | (defun last (x &optional n) |
| 124 | "Return the last link of the list X. Its car is the last element. |
| 125 | If X is nil, return nil. |
| 126 | If N is non-nil, return the Nth-to-last link of X. |
| 127 | If N is bigger than the length of X, return X." |
| 128 | (if n |
| 129 | (let ((m 0) (p x)) |
| 130 | (while (consp p) |
| 131 | (setq m (1+ m) p (cdr p))) |
| 132 | (if (<= n 0) p |
| 133 | (if (< n m) (nthcdr (- m n) x) x))) |
| 134 | (while (cdr x) |
| 135 | (setq x (cdr x))) |
| 136 | x)) |
| 137 | |
| 138 | (defun remove (elt seq) |
| 139 | "Return a copy of SEQ with all occurences of ELT removed. |
| 140 | SEQ must be a list, vector, or string. The comparison is done with `equal'." |
| 141 | (if (nlistp seq) |
| 142 | ;; If SEQ isn't a list, there's no need to copy SEQ because |
| 143 | ;; `delete' will return a new object. |
| 144 | (delete elt seq) |
| 145 | (delete elt (copy-sequence seq)))) |
| 146 | |
| 147 | (defun remq (elt list) |
| 148 | "Return a copy of LIST with all occurences of ELT removed. |
| 149 | The comparison is done with `eq'." |
| 150 | (if (memq elt list) |
| 151 | (delq elt (copy-sequence list)) |
| 152 | list)) |
| 153 | |
| 154 | (defun assoc-default (key alist &optional test default) |
| 155 | "Find object KEY in a pseudo-alist ALIST. |
| 156 | ALIST is a list of conses or objects. Each element (or the element's car, |
| 157 | if it is a cons) is compared with KEY by evaluating (TEST (car elt) KEY). |
| 158 | If that is non-nil, the element matches; |
| 159 | then `assoc-default' returns the element's cdr, if it is a cons, |
| 160 | or DEFAULT if the element is not a cons. |
| 161 | |
| 162 | If no element matches, the value is nil. |
| 163 | If TEST is omitted or nil, `equal' is used." |
| 164 | (let (found (tail alist) value) |
| 165 | (while (and tail (not found)) |
| 166 | (let ((elt (car tail))) |
| 167 | (when (funcall (or test 'equal) (if (consp elt) (car elt) elt) key) |
| 168 | (setq found t value (if (consp elt) (cdr elt) default)))) |
| 169 | (setq tail (cdr tail))) |
| 170 | value)) |
| 171 | |
| 172 | (defun assoc-ignore-case (key alist) |
| 173 | "Like `assoc', but ignores differences in case and text representation. |
| 174 | KEY must be a string. Upper-case and lower-case letters are treated as equal. |
| 175 | Unibyte strings are converted to multibyte for comparison." |
| 176 | (let (element) |
| 177 | (while (and alist (not element)) |
| 178 | (if (eq t (compare-strings key 0 nil (car (car alist)) 0 nil t)) |
| 179 | (setq element (car alist))) |
| 180 | (setq alist (cdr alist))) |
| 181 | element)) |
| 182 | |
| 183 | (defun assoc-ignore-representation (key alist) |
| 184 | "Like `assoc', but ignores differences in text representation. |
| 185 | KEY must be a string. |
| 186 | Unibyte strings are converted to multibyte for comparison." |
| 187 | (let (element) |
| 188 | (while (and alist (not element)) |
| 189 | (if (eq t (compare-strings key 0 nil (car (car alist)) 0 nil)) |
| 190 | (setq element (car alist))) |
| 191 | (setq alist (cdr alist))) |
| 192 | element)) |
| 193 | |
| 194 | (defun member-ignore-case (elt list) |
| 195 | "Like `member', but ignores differences in case and text representation. |
| 196 | ELT must be a string. Upper-case and lower-case letters are treated as equal. |
| 197 | Unibyte strings are converted to multibyte for comparison." |
| 198 | (let (element) |
| 199 | (while (and list (not element)) |
| 200 | (if (eq t (compare-strings elt 0 nil (car list) 0 nil t)) |
| 201 | (setq element (car list))) |
| 202 | (setq list (cdr list))) |
| 203 | element)) |
| 204 | |
| 205 | \f |
| 206 | ;;;; Keymap support. |
| 207 | |
| 208 | (defun undefined () |
| 209 | (interactive) |
| 210 | (ding)) |
| 211 | |
| 212 | ;Prevent the \{...} documentation construct |
| 213 | ;from mentioning keys that run this command. |
| 214 | (put 'undefined 'suppress-keymap t) |
| 215 | |
| 216 | (defun suppress-keymap (map &optional nodigits) |
| 217 | "Make MAP override all normally self-inserting keys to be undefined. |
| 218 | Normally, as an exception, digits and minus-sign are set to make prefix args, |
| 219 | but optional second arg NODIGITS non-nil treats them like other chars." |
| 220 | (substitute-key-definition 'self-insert-command 'undefined map global-map) |
| 221 | (or nodigits |
| 222 | (let (loop) |
| 223 | (define-key map "-" 'negative-argument) |
| 224 | ;; Make plain numbers do numeric args. |
| 225 | (setq loop ?0) |
| 226 | (while (<= loop ?9) |
| 227 | (define-key map (char-to-string loop) 'digit-argument) |
| 228 | (setq loop (1+ loop)))))) |
| 229 | |
| 230 | ;Moved to keymap.c |
| 231 | ;(defun copy-keymap (keymap) |
| 232 | ; "Return a copy of KEYMAP" |
| 233 | ; (while (not (keymapp keymap)) |
| 234 | ; (setq keymap (signal 'wrong-type-argument (list 'keymapp keymap)))) |
| 235 | ; (if (vectorp keymap) |
| 236 | ; (copy-sequence keymap) |
| 237 | ; (copy-alist keymap))) |
| 238 | |
| 239 | (defvar key-substitution-in-progress nil |
| 240 | "Used internally by substitute-key-definition.") |
| 241 | |
| 242 | (defun substitute-key-definition (olddef newdef keymap &optional oldmap prefix) |
| 243 | "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF. |
| 244 | In other words, OLDDEF is replaced with NEWDEF where ever it appears. |
| 245 | Alternatively, if optional fourth argument OLDMAP is specified, we redefine |
| 246 | in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP." |
| 247 | ;; Don't document PREFIX in the doc string because we don't want to |
| 248 | ;; advertise it. It's meant for recursive calls only. Here's its |
| 249 | ;; meaning |
| 250 | |
| 251 | ;; If optional argument PREFIX is specified, it should be a key |
| 252 | ;; prefix, a string. Redefined bindings will then be bound to the |
| 253 | ;; original key, with PREFIX added at the front. |
| 254 | (or prefix (setq prefix "")) |
| 255 | (let* ((scan (or oldmap keymap)) |
| 256 | (vec1 (vector nil)) |
| 257 | (prefix1 (vconcat prefix vec1)) |
| 258 | (key-substitution-in-progress |
| 259 | (cons scan key-substitution-in-progress))) |
| 260 | ;; Scan OLDMAP, finding each char or event-symbol that |
| 261 | ;; has any definition, and act on it with hack-key. |
| 262 | (while (consp scan) |
| 263 | (if (consp (car scan)) |
| 264 | (let ((char (car (car scan))) |
| 265 | (defn (cdr (car scan)))) |
| 266 | ;; The inside of this let duplicates exactly |
| 267 | ;; the inside of the following let that handles array elements. |
| 268 | (aset vec1 0 char) |
| 269 | (aset prefix1 (length prefix) char) |
| 270 | (let (inner-def skipped) |
| 271 | ;; Skip past menu-prompt. |
| 272 | (while (stringp (car-safe defn)) |
| 273 | (setq skipped (cons (car defn) skipped)) |
| 274 | (setq defn (cdr defn))) |
| 275 | ;; Skip past cached key-equivalence data for menu items. |
| 276 | (and (consp defn) (consp (car defn)) |
| 277 | (setq defn (cdr defn))) |
| 278 | (setq inner-def defn) |
| 279 | ;; Look past a symbol that names a keymap. |
| 280 | (while (and (symbolp inner-def) |
| 281 | (fboundp inner-def)) |
| 282 | (setq inner-def (symbol-function inner-def))) |
| 283 | (if (or (eq defn olddef) |
| 284 | ;; Compare with equal if definition is a key sequence. |
| 285 | ;; That is useful for operating on function-key-map. |
| 286 | (and (or (stringp defn) (vectorp defn)) |
| 287 | (equal defn olddef))) |
| 288 | (define-key keymap prefix1 (nconc (nreverse skipped) newdef)) |
| 289 | (if (and (keymapp defn) |
| 290 | ;; Avoid recursively scanning |
| 291 | ;; where KEYMAP does not have a submap. |
| 292 | (let ((elt (lookup-key keymap prefix1))) |
| 293 | (or (null elt) |
| 294 | (keymapp elt))) |
| 295 | ;; Avoid recursively rescanning keymap being scanned. |
| 296 | (not (memq inner-def |
| 297 | key-substitution-in-progress))) |
| 298 | ;; If this one isn't being scanned already, |
| 299 | ;; scan it now. |
| 300 | (substitute-key-definition olddef newdef keymap |
| 301 | inner-def |
| 302 | prefix1))))) |
| 303 | (if (vectorp (car scan)) |
| 304 | (let* ((array (car scan)) |
| 305 | (len (length array)) |
| 306 | (i 0)) |
| 307 | (while (< i len) |
| 308 | (let ((char i) (defn (aref array i))) |
| 309 | ;; The inside of this let duplicates exactly |
| 310 | ;; the inside of the previous let. |
| 311 | (aset vec1 0 char) |
| 312 | (aset prefix1 (length prefix) char) |
| 313 | (let (inner-def skipped) |
| 314 | ;; Skip past menu-prompt. |
| 315 | (while (stringp (car-safe defn)) |
| 316 | (setq skipped (cons (car defn) skipped)) |
| 317 | (setq defn (cdr defn))) |
| 318 | (and (consp defn) (consp (car defn)) |
| 319 | (setq defn (cdr defn))) |
| 320 | (setq inner-def defn) |
| 321 | (while (and (symbolp inner-def) |
| 322 | (fboundp inner-def)) |
| 323 | (setq inner-def (symbol-function inner-def))) |
| 324 | (if (or (eq defn olddef) |
| 325 | (and (or (stringp defn) (vectorp defn)) |
| 326 | (equal defn olddef))) |
| 327 | (define-key keymap prefix1 |
| 328 | (nconc (nreverse skipped) newdef)) |
| 329 | (if (and (keymapp defn) |
| 330 | (let ((elt (lookup-key keymap prefix1))) |
| 331 | (or (null elt) |
| 332 | (keymapp elt))) |
| 333 | (not (memq inner-def |
| 334 | key-substitution-in-progress))) |
| 335 | (substitute-key-definition olddef newdef keymap |
| 336 | inner-def |
| 337 | prefix1))))) |
| 338 | (setq i (1+ i)))) |
| 339 | (if (char-table-p (car scan)) |
| 340 | (map-char-table |
| 341 | (function (lambda (char defn) |
| 342 | (let () |
| 343 | ;; The inside of this let duplicates exactly |
| 344 | ;; the inside of the previous let, |
| 345 | ;; except that it uses set-char-table-range |
| 346 | ;; instead of define-key. |
| 347 | (aset vec1 0 char) |
| 348 | (aset prefix1 (length prefix) char) |
| 349 | (let (inner-def skipped) |
| 350 | ;; Skip past menu-prompt. |
| 351 | (while (stringp (car-safe defn)) |
| 352 | (setq skipped (cons (car defn) skipped)) |
| 353 | (setq defn (cdr defn))) |
| 354 | (and (consp defn) (consp (car defn)) |
| 355 | (setq defn (cdr defn))) |
| 356 | (setq inner-def defn) |
| 357 | (while (and (symbolp inner-def) |
| 358 | (fboundp inner-def)) |
| 359 | (setq inner-def (symbol-function inner-def))) |
| 360 | (if (or (eq defn olddef) |
| 361 | (and (or (stringp defn) (vectorp defn)) |
| 362 | (equal defn olddef))) |
| 363 | (define-key keymap prefix1 |
| 364 | (nconc (nreverse skipped) newdef)) |
| 365 | (if (and (keymapp defn) |
| 366 | (let ((elt (lookup-key keymap prefix1))) |
| 367 | (or (null elt) |
| 368 | (keymapp elt))) |
| 369 | (not (memq inner-def |
| 370 | key-substitution-in-progress))) |
| 371 | (substitute-key-definition olddef newdef keymap |
| 372 | inner-def |
| 373 | prefix1))))))) |
| 374 | (car scan))))) |
| 375 | (setq scan (cdr scan))))) |
| 376 | |
| 377 | (defun define-key-after (keymap key definition &optional after) |
| 378 | "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding. |
| 379 | This is like `define-key' except that the binding for KEY is placed |
| 380 | just after the binding for the event AFTER, instead of at the beginning |
| 381 | of the map. Note that AFTER must be an event type (like KEY), NOT a command |
| 382 | \(like DEFINITION). |
| 383 | |
| 384 | If AFTER is t or omitted, the new binding goes at the end of the keymap. |
| 385 | |
| 386 | KEY must contain just one event type--that is to say, it must be a |
| 387 | string or vector of length 1, but AFTER should be a single event |
| 388 | type--a symbol or a character, not a sequence. |
| 389 | |
| 390 | Bindings are always added before any inherited map. |
| 391 | |
| 392 | The order of bindings in a keymap matters when it is used as a menu." |
| 393 | (unless after (setq after t)) |
| 394 | (or (keymapp keymap) |
| 395 | (signal 'wrong-type-argument (list 'keymapp keymap))) |
| 396 | (if (> (length key) 1) |
| 397 | (error "multi-event key specified in `define-key-after'")) |
| 398 | (let ((tail keymap) done inserted |
| 399 | (first (aref key 0))) |
| 400 | (while (and (not done) tail) |
| 401 | ;; Delete any earlier bindings for the same key. |
| 402 | (if (eq (car-safe (car (cdr tail))) first) |
| 403 | (setcdr tail (cdr (cdr tail)))) |
| 404 | ;; When we reach AFTER's binding, insert the new binding after. |
| 405 | ;; If we reach an inherited keymap, insert just before that. |
| 406 | ;; If we reach the end of this keymap, insert at the end. |
| 407 | (if (or (and (eq (car-safe (car tail)) after) |
| 408 | (not (eq after t))) |
| 409 | (eq (car (cdr tail)) 'keymap) |
| 410 | (null (cdr tail))) |
| 411 | (progn |
| 412 | ;; Stop the scan only if we find a parent keymap. |
| 413 | ;; Keep going past the inserted element |
| 414 | ;; so we can delete any duplications that come later. |
| 415 | (if (eq (car (cdr tail)) 'keymap) |
| 416 | (setq done t)) |
| 417 | ;; Don't insert more than once. |
| 418 | (or inserted |
| 419 | (setcdr tail (cons (cons (aref key 0) definition) (cdr tail)))) |
| 420 | (setq inserted t))) |
| 421 | (setq tail (cdr tail))))) |
| 422 | |
| 423 | (defmacro kbd (keys) |
| 424 | "Convert KEYS to the internal Emacs key representation. |
| 425 | KEYS should be a string constant in the format used for |
| 426 | saving keyboard macros (see `insert-kbd-macro')." |
| 427 | (read-kbd-macro keys)) |
| 428 | |
| 429 | (put 'keyboard-translate-table 'char-table-extra-slots 0) |
| 430 | |
| 431 | (defun keyboard-translate (from to) |
| 432 | "Translate character FROM to TO at a low level. |
| 433 | This function creates a `keyboard-translate-table' if necessary |
| 434 | and then modifies one entry in it." |
| 435 | (or (char-table-p keyboard-translate-table) |
| 436 | (setq keyboard-translate-table |
| 437 | (make-char-table 'keyboard-translate-table nil))) |
| 438 | (aset keyboard-translate-table from to)) |
| 439 | |
| 440 | \f |
| 441 | ;;;; The global keymap tree. |
| 442 | |
| 443 | ;;; global-map, esc-map, and ctl-x-map have their values set up in |
| 444 | ;;; keymap.c; we just give them docstrings here. |
| 445 | |
| 446 | (defvar global-map nil |
| 447 | "Default global keymap mapping Emacs keyboard input into commands. |
| 448 | The value is a keymap which is usually (but not necessarily) Emacs's |
| 449 | global map.") |
| 450 | |
| 451 | (defvar esc-map nil |
| 452 | "Default keymap for ESC (meta) commands. |
| 453 | The normal global definition of the character ESC indirects to this keymap.") |
| 454 | |
| 455 | (defvar ctl-x-map nil |
| 456 | "Default keymap for C-x commands. |
| 457 | The normal global definition of the character C-x indirects to this keymap.") |
| 458 | |
| 459 | (defvar ctl-x-4-map (make-sparse-keymap) |
| 460 | "Keymap for subcommands of C-x 4") |
| 461 | (defalias 'ctl-x-4-prefix ctl-x-4-map) |
| 462 | (define-key ctl-x-map "4" 'ctl-x-4-prefix) |
| 463 | |
| 464 | (defvar ctl-x-5-map (make-sparse-keymap) |
| 465 | "Keymap for frame commands.") |
| 466 | (defalias 'ctl-x-5-prefix ctl-x-5-map) |
| 467 | (define-key ctl-x-map "5" 'ctl-x-5-prefix) |
| 468 | |
| 469 | \f |
| 470 | ;;;; Event manipulation functions. |
| 471 | |
| 472 | ;; The call to `read' is to ensure that the value is computed at load time |
| 473 | ;; and not compiled into the .elc file. The value is negative on most |
| 474 | ;; machines, but not on all! |
| 475 | (defconst listify-key-sequence-1 (logior 128 (read "?\\M-\\^@"))) |
| 476 | |
| 477 | (defun listify-key-sequence (key) |
| 478 | "Convert a key sequence to a list of events." |
| 479 | (if (vectorp key) |
| 480 | (append key nil) |
| 481 | (mapcar (function (lambda (c) |
| 482 | (if (> c 127) |
| 483 | (logxor c listify-key-sequence-1) |
| 484 | c))) |
| 485 | (append key nil)))) |
| 486 | |
| 487 | (defsubst eventp (obj) |
| 488 | "True if the argument is an event object." |
| 489 | (or (integerp obj) |
| 490 | (and (symbolp obj) |
| 491 | (get obj 'event-symbol-elements)) |
| 492 | (and (consp obj) |
| 493 | (symbolp (car obj)) |
| 494 | (get (car obj) 'event-symbol-elements)))) |
| 495 | |
| 496 | (defun event-modifiers (event) |
| 497 | "Returns a list of symbols representing the modifier keys in event EVENT. |
| 498 | The elements of the list may include `meta', `control', |
| 499 | `shift', `hyper', `super', `alt', `click', `double', `triple', `drag', |
| 500 | and `down'." |
| 501 | (let ((type event)) |
| 502 | (if (listp type) |
| 503 | (setq type (car type))) |
| 504 | (if (symbolp type) |
| 505 | (cdr (get type 'event-symbol-elements)) |
| 506 | (let ((list nil)) |
| 507 | (or (zerop (logand type ?\M-\^@)) |
| 508 | (setq list (cons 'meta list))) |
| 509 | (or (and (zerop (logand type ?\C-\^@)) |
| 510 | (>= (logand type 127) 32)) |
| 511 | (setq list (cons 'control list))) |
| 512 | (or (and (zerop (logand type ?\S-\^@)) |
| 513 | (= (logand type 255) (downcase (logand type 255)))) |
| 514 | (setq list (cons 'shift list))) |
| 515 | (or (zerop (logand type ?\H-\^@)) |
| 516 | (setq list (cons 'hyper list))) |
| 517 | (or (zerop (logand type ?\s-\^@)) |
| 518 | (setq list (cons 'super list))) |
| 519 | (or (zerop (logand type ?\A-\^@)) |
| 520 | (setq list (cons 'alt list))) |
| 521 | list)))) |
| 522 | |
| 523 | (defun event-basic-type (event) |
| 524 | "Returns the basic type of the given event (all modifiers removed). |
| 525 | The value is an ASCII printing character (not upper case) or a symbol." |
| 526 | (if (consp event) |
| 527 | (setq event (car event))) |
| 528 | (if (symbolp event) |
| 529 | (car (get event 'event-symbol-elements)) |
| 530 | (let ((base (logand event (1- (lsh 1 18))))) |
| 531 | (downcase (if (< base 32) (logior base 64) base))))) |
| 532 | |
| 533 | (defsubst mouse-movement-p (object) |
| 534 | "Return non-nil if OBJECT is a mouse movement event." |
| 535 | (and (consp object) |
| 536 | (eq (car object) 'mouse-movement))) |
| 537 | |
| 538 | (defsubst event-start (event) |
| 539 | "Return the starting position of EVENT. |
| 540 | If EVENT is a mouse press or a mouse click, this returns the location |
| 541 | of the event. |
| 542 | If EVENT is a drag, this returns the drag's starting position. |
| 543 | The return value is of the form |
| 544 | (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP) |
| 545 | The `posn-' functions access elements of such lists." |
| 546 | (nth 1 event)) |
| 547 | |
| 548 | (defsubst event-end (event) |
| 549 | "Return the ending location of EVENT. EVENT should be a click or drag event. |
| 550 | If EVENT is a click event, this function is the same as `event-start'. |
| 551 | The return value is of the form |
| 552 | (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP) |
| 553 | The `posn-' functions access elements of such lists." |
| 554 | (nth (if (consp (nth 2 event)) 2 1) event)) |
| 555 | |
| 556 | (defsubst event-click-count (event) |
| 557 | "Return the multi-click count of EVENT, a click or drag event. |
| 558 | The return value is a positive integer." |
| 559 | (if (integerp (nth 2 event)) (nth 2 event) 1)) |
| 560 | |
| 561 | (defsubst posn-window (position) |
| 562 | "Return the window in POSITION. |
| 563 | POSITION should be a list of the form |
| 564 | (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP) |
| 565 | as returned by the `event-start' and `event-end' functions." |
| 566 | (nth 0 position)) |
| 567 | |
| 568 | (defsubst posn-point (position) |
| 569 | "Return the buffer location in POSITION. |
| 570 | POSITION should be a list of the form |
| 571 | (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP) |
| 572 | as returned by the `event-start' and `event-end' functions." |
| 573 | (if (consp (nth 1 position)) |
| 574 | (car (nth 1 position)) |
| 575 | (nth 1 position))) |
| 576 | |
| 577 | (defsubst posn-x-y (position) |
| 578 | "Return the x and y coordinates in POSITION. |
| 579 | POSITION should be a list of the form |
| 580 | (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP) |
| 581 | as returned by the `event-start' and `event-end' functions." |
| 582 | (nth 2 position)) |
| 583 | |
| 584 | (defun posn-col-row (position) |
| 585 | "Return the column and row in POSITION, measured in characters. |
| 586 | POSITION should be a list of the form |
| 587 | (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP) |
| 588 | as returned by the `event-start' and `event-end' functions. |
| 589 | For a scroll-bar event, the result column is 0, and the row |
| 590 | corresponds to the vertical position of the click in the scroll bar." |
| 591 | (let ((pair (nth 2 position)) |
| 592 | (window (posn-window position))) |
| 593 | (if (eq (if (consp (nth 1 position)) |
| 594 | (car (nth 1 position)) |
| 595 | (nth 1 position)) |
| 596 | 'vertical-scroll-bar) |
| 597 | (cons 0 (scroll-bar-scale pair (1- (window-height window)))) |
| 598 | (if (eq (if (consp (nth 1 position)) |
| 599 | (car (nth 1 position)) |
| 600 | (nth 1 position)) |
| 601 | 'horizontal-scroll-bar) |
| 602 | (cons (scroll-bar-scale pair (window-width window)) 0) |
| 603 | (let* ((frame (if (framep window) window (window-frame window))) |
| 604 | (x (/ (car pair) (frame-char-width frame))) |
| 605 | (y (/ (cdr pair) (frame-char-height frame)))) |
| 606 | (cons x y)))))) |
| 607 | |
| 608 | (defsubst posn-timestamp (position) |
| 609 | "Return the timestamp of POSITION. |
| 610 | POSITION should be a list of the form |
| 611 | (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP) |
| 612 | as returned by the `event-start' and `event-end' functions." |
| 613 | (nth 3 position)) |
| 614 | |
| 615 | \f |
| 616 | ;;;; Obsolescent names for functions. |
| 617 | |
| 618 | (defalias 'dot 'point) |
| 619 | (defalias 'dot-marker 'point-marker) |
| 620 | (defalias 'dot-min 'point-min) |
| 621 | (defalias 'dot-max 'point-max) |
| 622 | (defalias 'window-dot 'window-point) |
| 623 | (defalias 'set-window-dot 'set-window-point) |
| 624 | (defalias 'read-input 'read-string) |
| 625 | (defalias 'send-string 'process-send-string) |
| 626 | (defalias 'send-region 'process-send-region) |
| 627 | (defalias 'show-buffer 'set-window-buffer) |
| 628 | (defalias 'buffer-flush-undo 'buffer-disable-undo) |
| 629 | (defalias 'eval-current-buffer 'eval-buffer) |
| 630 | (defalias 'compiled-function-p 'byte-code-function-p) |
| 631 | (defalias 'define-function 'defalias) |
| 632 | |
| 633 | (defalias 'sref 'aref) |
| 634 | (make-obsolete 'sref 'aref "20.4") |
| 635 | (make-obsolete 'char-bytes "Now this function always returns 1" "20.4") |
| 636 | |
| 637 | ;; Some programs still use this as a function. |
| 638 | (defun baud-rate () |
| 639 | "Obsolete function returning the value of the `baud-rate' variable. |
| 640 | Please convert your programs to use the variable `baud-rate' directly." |
| 641 | baud-rate) |
| 642 | |
| 643 | (defalias 'focus-frame 'ignore) |
| 644 | (defalias 'unfocus-frame 'ignore) |
| 645 | \f |
| 646 | ;;;; Alternate names for functions - these are not being phased out. |
| 647 | |
| 648 | (defalias 'string= 'string-equal) |
| 649 | (defalias 'string< 'string-lessp) |
| 650 | (defalias 'move-marker 'set-marker) |
| 651 | (defalias 'not 'null) |
| 652 | (defalias 'rplaca 'setcar) |
| 653 | (defalias 'rplacd 'setcdr) |
| 654 | (defalias 'beep 'ding) ;preserve lingual purity |
| 655 | (defalias 'indent-to-column 'indent-to) |
| 656 | (defalias 'backward-delete-char 'delete-backward-char) |
| 657 | (defalias 'search-forward-regexp (symbol-function 're-search-forward)) |
| 658 | (defalias 'search-backward-regexp (symbol-function 're-search-backward)) |
| 659 | (defalias 'int-to-string 'number-to-string) |
| 660 | (defalias 'store-match-data 'set-match-data) |
| 661 | ;; These are the XEmacs names: |
| 662 | (defalias 'point-at-eol 'line-end-position) |
| 663 | (defalias 'point-at-bol 'line-beginning-position) |
| 664 | |
| 665 | ;;; Should this be an obsolete name? If you decide it should, you get |
| 666 | ;;; to go through all the sources and change them. |
| 667 | (defalias 'string-to-int 'string-to-number) |
| 668 | \f |
| 669 | ;;;; Hook manipulation functions. |
| 670 | |
| 671 | (defun make-local-hook (hook) |
| 672 | "Make the hook HOOK local to the current buffer. |
| 673 | The return value is HOOK. |
| 674 | |
| 675 | When a hook is local, its local and global values |
| 676 | work in concert: running the hook actually runs all the hook |
| 677 | functions listed in *either* the local value *or* the global value |
| 678 | of the hook variable. |
| 679 | |
| 680 | This function works by making `t' a member of the buffer-local value, |
| 681 | which acts as a flag to run the hook functions in the default value as |
| 682 | well. This works for all normal hooks, but does not work for most |
| 683 | non-normal hooks yet. We will be changing the callers of non-normal |
| 684 | hooks so that they can handle localness; this has to be done one by |
| 685 | one. |
| 686 | |
| 687 | This function does nothing if HOOK is already local in the current |
| 688 | buffer. |
| 689 | |
| 690 | Do not use `make-local-variable' to make a hook variable buffer-local." |
| 691 | (if (local-variable-p hook) |
| 692 | nil |
| 693 | (or (boundp hook) (set hook nil)) |
| 694 | (make-local-variable hook) |
| 695 | (set hook (list t))) |
| 696 | hook) |
| 697 | |
| 698 | (defun add-hook (hook function &optional append local) |
| 699 | "Add to the value of HOOK the function FUNCTION. |
| 700 | FUNCTION is not added if already present. |
| 701 | FUNCTION is added (if necessary) at the beginning of the hook list |
| 702 | unless the optional argument APPEND is non-nil, in which case |
| 703 | FUNCTION is added at the end. |
| 704 | |
| 705 | The optional fourth argument, LOCAL, if non-nil, says to modify |
| 706 | the hook's buffer-local value rather than its default value. |
| 707 | This makes the hook buffer-local if needed. |
| 708 | To make a hook variable buffer-local, always use |
| 709 | `make-local-hook', not `make-local-variable'. |
| 710 | |
| 711 | HOOK should be a symbol, and FUNCTION may be any valid function. If |
| 712 | HOOK is void, it is first set to nil. If HOOK's value is a single |
| 713 | function, it is changed to a list of functions." |
| 714 | (or (boundp hook) (set hook nil)) |
| 715 | (or (default-boundp hook) (set-default hook nil)) |
| 716 | (if local (make-local-hook hook) |
| 717 | ;; Detect the case where make-local-variable was used on a hook |
| 718 | ;; and do what we used to do. |
| 719 | (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook))) |
| 720 | (setq local t))) |
| 721 | (let ((hook-value (if local (symbol-value hook) (default-value hook)))) |
| 722 | ;; If the hook value is a single function, turn it into a list. |
| 723 | (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda)) |
| 724 | (setq hook-value (list hook-value))) |
| 725 | ;; Do the actual addition if necessary |
| 726 | (unless (member function hook-value) |
| 727 | (setq hook-value |
| 728 | (if append |
| 729 | (append hook-value (list function)) |
| 730 | (cons function hook-value)))) |
| 731 | ;; Set the actual variable |
| 732 | (if local (set hook hook-value) (set-default hook hook-value)))) |
| 733 | |
| 734 | (defun remove-hook (hook function &optional local) |
| 735 | "Remove from the value of HOOK the function FUNCTION. |
| 736 | HOOK should be a symbol, and FUNCTION may be any valid function. If |
| 737 | FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the |
| 738 | list of hooks to run in HOOK, then nothing is done. See `add-hook'. |
| 739 | |
| 740 | The optional third argument, LOCAL, if non-nil, says to modify |
| 741 | the hook's buffer-local value rather than its default value. |
| 742 | This makes the hook buffer-local if needed. |
| 743 | To make a hook variable buffer-local, always use |
| 744 | `make-local-hook', not `make-local-variable'." |
| 745 | (or (boundp hook) (set hook nil)) |
| 746 | (or (default-boundp hook) (set-default hook nil)) |
| 747 | (if local (make-local-hook hook) |
| 748 | ;; Detect the case where make-local-variable was used on a hook |
| 749 | ;; and do what we used to do. |
| 750 | (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook))) |
| 751 | (setq local t))) |
| 752 | (let ((hook-value (if local (symbol-value hook) (default-value hook)))) |
| 753 | ;; Remove the function, for both the list and the non-list cases. |
| 754 | (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda)) |
| 755 | (if (equal hook-value function) (setq hook-value nil)) |
| 756 | (setq hook-value (delete function (copy-sequence hook-value)))) |
| 757 | ;; If the function is on the global hook, we need to shadow it locally |
| 758 | ;;(when (and local (member function (default-value hook)) |
| 759 | ;; (not (member (cons 'not function) hook-value))) |
| 760 | ;; (push (cons 'not function) hook-value)) |
| 761 | ;; Set the actual variable |
| 762 | (if local (set hook hook-value) (set-default hook hook-value)))) |
| 763 | |
| 764 | (defun add-to-list (list-var element &optional append) |
| 765 | "Add to the value of LIST-VAR the element ELEMENT if it isn't there yet. |
| 766 | The test for presence of ELEMENT is done with `equal'. |
| 767 | If ELEMENT is added, it is added at the beginning of the list, |
| 768 | unless the optional argument APPEND is non-nil, in which case |
| 769 | ELEMENT is added at the end. |
| 770 | |
| 771 | If you want to use `add-to-list' on a variable that is not defined |
| 772 | until a certain package is loaded, you should put the call to `add-to-list' |
| 773 | into a hook function that will be run only after loading the package. |
| 774 | `eval-after-load' provides one way to do this. In some cases |
| 775 | other hooks, such as major mode hooks, can do the job." |
| 776 | (if (member element (symbol-value list-var)) |
| 777 | (symbol-value list-var) |
| 778 | (set list-var |
| 779 | (if append |
| 780 | (append (symbol-value list-var) (list element)) |
| 781 | (cons element (symbol-value list-var)))))) |
| 782 | \f |
| 783 | ;;;; Specifying things to do after certain files are loaded. |
| 784 | |
| 785 | (defun eval-after-load (file form) |
| 786 | "Arrange that, if FILE is ever loaded, FORM will be run at that time. |
| 787 | This makes or adds to an entry on `after-load-alist'. |
| 788 | If FILE is already loaded, evaluate FORM right now. |
| 789 | It does nothing if FORM is already on the list for FILE. |
| 790 | FILE should be the name of a library, with no directory name." |
| 791 | ;; Make sure there is an element for FILE. |
| 792 | (or (assoc file after-load-alist) |
| 793 | (setq after-load-alist (cons (list file) after-load-alist))) |
| 794 | ;; Add FORM to the element if it isn't there. |
| 795 | (let ((elt (assoc file after-load-alist))) |
| 796 | (or (member form (cdr elt)) |
| 797 | (progn |
| 798 | (nconc elt (list form)) |
| 799 | ;; If the file has been loaded already, run FORM right away. |
| 800 | (and (assoc file load-history) |
| 801 | (eval form))))) |
| 802 | form) |
| 803 | |
| 804 | (defun eval-next-after-load (file) |
| 805 | "Read the following input sexp, and run it whenever FILE is loaded. |
| 806 | This makes or adds to an entry on `after-load-alist'. |
| 807 | FILE should be the name of a library, with no directory name." |
| 808 | (eval-after-load file (read))) |
| 809 | |
| 810 | \f |
| 811 | ;;;; Input and display facilities. |
| 812 | |
| 813 | (defvar read-quoted-char-radix 8 |
| 814 | "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'. |
| 815 | Legitimate radix values are 8, 10 and 16.") |
| 816 | |
| 817 | (custom-declare-variable-early |
| 818 | 'read-quoted-char-radix 8 |
| 819 | "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'. |
| 820 | Legitimate radix values are 8, 10 and 16." |
| 821 | :type '(choice (const 8) (const 10) (const 16)) |
| 822 | :group 'editing-basics) |
| 823 | |
| 824 | (defun read-quoted-char (&optional prompt) |
| 825 | "Like `read-char', but do not allow quitting. |
| 826 | Also, if the first character read is an octal digit, |
| 827 | we read any number of octal digits and return the |
| 828 | specified character code. Any nondigit terminates the sequence. |
| 829 | If the terminator is RET, it is discarded; |
| 830 | any other terminator is used itself as input. |
| 831 | |
| 832 | The optional argument PROMPT specifies a string to use to prompt the user. |
| 833 | The variable `read-quoted-char-radix' controls which radix to use |
| 834 | for numeric input." |
| 835 | (let ((message-log-max nil) done (first t) (code 0) char) |
| 836 | (while (not done) |
| 837 | (let ((inhibit-quit first) |
| 838 | ;; Don't let C-h get the help message--only help function keys. |
| 839 | (help-char nil) |
| 840 | (help-form |
| 841 | "Type the special character you want to use, |
| 842 | or the octal character code. |
| 843 | RET terminates the character code and is discarded; |
| 844 | any other non-digit terminates the character code and is then used as input.")) |
| 845 | (setq char (read-event (and prompt (format "%s-" prompt)) t)) |
| 846 | (if inhibit-quit (setq quit-flag nil))) |
| 847 | ;; Translate TAB key into control-I ASCII character, and so on. |
| 848 | (and char |
| 849 | (let ((translated (lookup-key function-key-map (vector char)))) |
| 850 | (if (arrayp translated) |
| 851 | (setq char (aref translated 0))))) |
| 852 | (cond ((null char)) |
| 853 | ((not (integerp char)) |
| 854 | (setq unread-command-events (list char) |
| 855 | done t)) |
| 856 | ((/= (logand char ?\M-\^@) 0) |
| 857 | ;; Turn a meta-character into a character with the 0200 bit set. |
| 858 | (setq code (logior (logand char (lognot ?\M-\^@)) 128) |
| 859 | done t)) |
| 860 | ((and (<= ?0 char) (< char (+ ?0 (min 10 read-quoted-char-radix)))) |
| 861 | (setq code (+ (* code read-quoted-char-radix) (- char ?0))) |
| 862 | (and prompt (setq prompt (message "%s %c" prompt char)))) |
| 863 | ((and (<= ?a (downcase char)) |
| 864 | (< (downcase char) (+ ?a -10 (min 26 read-quoted-char-radix)))) |
| 865 | (setq code (+ (* code read-quoted-char-radix) |
| 866 | (+ 10 (- (downcase char) ?a)))) |
| 867 | (and prompt (setq prompt (message "%s %c" prompt char)))) |
| 868 | ((and (not first) (eq char ?\C-m)) |
| 869 | (setq done t)) |
| 870 | ((not first) |
| 871 | (setq unread-command-events (list char) |
| 872 | done t)) |
| 873 | (t (setq code char |
| 874 | done t))) |
| 875 | (setq first nil)) |
| 876 | code)) |
| 877 | |
| 878 | (defun read-passwd (prompt &optional confirm default) |
| 879 | "Read a password, prompting with PROMPT. Echo `.' for each character typed. |
| 880 | End with RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. |
| 881 | Optional argument CONFIRM, if non-nil, then read it twice to make sure. |
| 882 | Optional DEFAULT is a default password to use instead of empty input." |
| 883 | (if confirm |
| 884 | (let (success) |
| 885 | (while (not success) |
| 886 | (let ((first (read-passwd prompt nil default)) |
| 887 | (second (read-passwd "Confirm password: " nil default))) |
| 888 | (if (equal first second) |
| 889 | (setq success first) |
| 890 | (message "Password not repeated accurately; please start over") |
| 891 | (sit-for 1)))) |
| 892 | success) |
| 893 | (let ((pass nil) |
| 894 | (c 0) |
| 895 | (echo-keystrokes 0) |
| 896 | (cursor-in-echo-area t)) |
| 897 | (while (progn (message "%s%s" |
| 898 | prompt |
| 899 | (make-string (length pass) ?.)) |
| 900 | (setq c (read-char-exclusive nil t)) |
| 901 | (and (/= c ?\r) (/= c ?\n) (/= c ?\e))) |
| 902 | (if (= c ?\C-u) |
| 903 | (setq pass "") |
| 904 | (if (and (/= c ?\b) (/= c ?\177)) |
| 905 | (setq pass (concat pass (char-to-string c))) |
| 906 | (if (> (length pass) 0) |
| 907 | (setq pass (substring pass 0 -1)))))) |
| 908 | (clear-this-command-keys) |
| 909 | (message nil) |
| 910 | (or pass default "")))) |
| 911 | \f |
| 912 | (defun force-mode-line-update (&optional all) |
| 913 | "Force the mode-line of the current buffer to be redisplayed. |
| 914 | With optional non-nil ALL, force redisplay of all mode-lines." |
| 915 | (if all (save-excursion (set-buffer (other-buffer)))) |
| 916 | (set-buffer-modified-p (buffer-modified-p))) |
| 917 | |
| 918 | (defun momentary-string-display (string pos &optional exit-char message) |
| 919 | "Momentarily display STRING in the buffer at POS. |
| 920 | Display remains until next character is typed. |
| 921 | If the char is EXIT-CHAR (optional third arg, default is SPC) it is swallowed; |
| 922 | otherwise it is then available as input (as a command if nothing else). |
| 923 | Display MESSAGE (optional fourth arg) in the echo area. |
| 924 | If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there." |
| 925 | (or exit-char (setq exit-char ?\ )) |
| 926 | (let ((inhibit-read-only t) |
| 927 | ;; Don't modify the undo list at all. |
| 928 | (buffer-undo-list t) |
| 929 | (modified (buffer-modified-p)) |
| 930 | (name buffer-file-name) |
| 931 | insert-end) |
| 932 | (unwind-protect |
| 933 | (progn |
| 934 | (save-excursion |
| 935 | (goto-char pos) |
| 936 | ;; defeat file locking... don't try this at home, kids! |
| 937 | (setq buffer-file-name nil) |
| 938 | (insert-before-markers string) |
| 939 | (setq insert-end (point)) |
| 940 | ;; If the message end is off screen, recenter now. |
| 941 | (if (< (window-end nil t) insert-end) |
| 942 | (recenter (/ (window-height) 2))) |
| 943 | ;; If that pushed message start off the screen, |
| 944 | ;; scroll to start it at the top of the screen. |
| 945 | (move-to-window-line 0) |
| 946 | (if (> (point) pos) |
| 947 | (progn |
| 948 | (goto-char pos) |
| 949 | (recenter 0)))) |
| 950 | (message (or message "Type %s to continue editing.") |
| 951 | (single-key-description exit-char)) |
| 952 | (let ((char (read-event))) |
| 953 | (or (eq char exit-char) |
| 954 | (setq unread-command-events (list char))))) |
| 955 | (if insert-end |
| 956 | (save-excursion |
| 957 | (delete-region pos insert-end))) |
| 958 | (setq buffer-file-name name) |
| 959 | (set-buffer-modified-p modified)))) |
| 960 | |
| 961 | \f |
| 962 | ;;;; Miscellanea. |
| 963 | |
| 964 | ;; A number of major modes set this locally. |
| 965 | ;; Give it a global value to avoid compiler warnings. |
| 966 | (defvar font-lock-defaults nil) |
| 967 | |
| 968 | (defvar suspend-hook nil |
| 969 | "Normal hook run by `suspend-emacs', before suspending.") |
| 970 | |
| 971 | (defvar suspend-resume-hook nil |
| 972 | "Normal hook run by `suspend-emacs', after Emacs is continued.") |
| 973 | |
| 974 | ;; Avoid compiler warnings about this variable, |
| 975 | ;; which has a special meaning on certain system types. |
| 976 | (defvar buffer-file-type nil |
| 977 | "Non-nil if the visited file is a binary file. |
| 978 | This variable is meaningful on MS-DOG and Windows NT. |
| 979 | On those systems, it is automatically local in every buffer. |
| 980 | On other systems, this variable is normally always nil.") |
| 981 | |
| 982 | ;; This should probably be written in C (i.e., without using `walk-windows'). |
| 983 | (defun get-buffer-window-list (buffer &optional minibuf frame) |
| 984 | "Return windows currently displaying BUFFER, or nil if none. |
| 985 | See `walk-windows' for the meaning of MINIBUF and FRAME." |
| 986 | (let ((buffer (if (bufferp buffer) buffer (get-buffer buffer))) windows) |
| 987 | (walk-windows (function (lambda (window) |
| 988 | (if (eq (window-buffer window) buffer) |
| 989 | (setq windows (cons window windows))))) |
| 990 | minibuf frame) |
| 991 | windows)) |
| 992 | |
| 993 | (defun ignore (&rest ignore) |
| 994 | "Do nothing and return nil. |
| 995 | This function accepts any number of arguments, but ignores them." |
| 996 | (interactive) |
| 997 | nil) |
| 998 | |
| 999 | (defun error (&rest args) |
| 1000 | "Signal an error, making error message by passing all args to `format'. |
| 1001 | In Emacs, the convention is that error messages start with a capital |
| 1002 | letter but *do not* end with a period. Please follow this convention |
| 1003 | for the sake of consistency." |
| 1004 | (while t |
| 1005 | (signal 'error (list (apply 'format args))))) |
| 1006 | |
| 1007 | (defalias 'user-original-login-name 'user-login-name) |
| 1008 | |
| 1009 | (defun start-process-shell-command (name buffer &rest args) |
| 1010 | "Start a program in a subprocess. Return the process object for it. |
| 1011 | Args are NAME BUFFER COMMAND &rest COMMAND-ARGS. |
| 1012 | NAME is name for process. It is modified if necessary to make it unique. |
| 1013 | BUFFER is the buffer or (buffer-name) to associate with the process. |
| 1014 | Process output goes at end of that buffer, unless you specify |
| 1015 | an output stream or filter function to handle the output. |
| 1016 | BUFFER may be also nil, meaning that this process is not associated |
| 1017 | with any buffer |
| 1018 | Third arg is command name, the name of a shell command. |
| 1019 | Remaining arguments are the arguments for the command. |
| 1020 | Wildcards and redirection are handled as usual in the shell." |
| 1021 | (cond |
| 1022 | ((eq system-type 'vax-vms) |
| 1023 | (apply 'start-process name buffer args)) |
| 1024 | ;; We used to use `exec' to replace the shell with the command, |
| 1025 | ;; but that failed to handle (...) and semicolon, etc. |
| 1026 | (t |
| 1027 | (start-process name buffer shell-file-name shell-command-switch |
| 1028 | (mapconcat 'identity args " "))))) |
| 1029 | \f |
| 1030 | (defmacro with-current-buffer (buffer &rest body) |
| 1031 | "Execute the forms in BODY with BUFFER as the current buffer. |
| 1032 | The value returned is the value of the last form in BODY. |
| 1033 | See also `with-temp-buffer'." |
| 1034 | (cons 'save-current-buffer |
| 1035 | (cons (list 'set-buffer buffer) |
| 1036 | body))) |
| 1037 | |
| 1038 | (defmacro with-temp-file (file &rest body) |
| 1039 | "Create a new buffer, evaluate BODY there, and write the buffer to FILE. |
| 1040 | The value returned is the value of the last form in BODY. |
| 1041 | See also `with-temp-buffer'." |
| 1042 | (let ((temp-file (make-symbol "temp-file")) |
| 1043 | (temp-buffer (make-symbol "temp-buffer"))) |
| 1044 | `(let ((,temp-file ,file) |
| 1045 | (,temp-buffer |
| 1046 | (get-buffer-create (generate-new-buffer-name " *temp file*")))) |
| 1047 | (unwind-protect |
| 1048 | (prog1 |
| 1049 | (with-current-buffer ,temp-buffer |
| 1050 | ,@body) |
| 1051 | (with-current-buffer ,temp-buffer |
| 1052 | (widen) |
| 1053 | (write-region (point-min) (point-max) ,temp-file nil 0))) |
| 1054 | (and (buffer-name ,temp-buffer) |
| 1055 | (kill-buffer ,temp-buffer)))))) |
| 1056 | |
| 1057 | (defmacro with-temp-message (message &rest body) |
| 1058 | "Display MESSAGE temporarily if non-nil while BODY is evaluated. |
| 1059 | The original message is restored to the echo area after BODY has finished. |
| 1060 | The value returned is the value of the last form in BODY. |
| 1061 | MESSAGE is written to the message log buffer if `message-log-max' is non-nil. |
| 1062 | If MESSAGE is nil, the echo area and message log buffer are unchanged. |
| 1063 | Use a MESSAGE of \"\" to temporarily clear the echo area." |
| 1064 | (let ((current-message (make-symbol "current-message")) |
| 1065 | (temp-message (make-symbol "with-temp-message"))) |
| 1066 | `(let ((,temp-message ,message) |
| 1067 | (,current-message)) |
| 1068 | (unwind-protect |
| 1069 | (progn |
| 1070 | (when ,temp-message |
| 1071 | (setq ,current-message (current-message)) |
| 1072 | (message "%s" ,temp-message)) |
| 1073 | ,@body) |
| 1074 | (and ,temp-message ,current-message |
| 1075 | (message "%s" ,current-message)))))) |
| 1076 | |
| 1077 | (defmacro with-temp-buffer (&rest body) |
| 1078 | "Create a temporary buffer, and evaluate BODY there like `progn'. |
| 1079 | See also `with-temp-file' and `with-output-to-string'." |
| 1080 | (let ((temp-buffer (make-symbol "temp-buffer"))) |
| 1081 | `(let ((,temp-buffer |
| 1082 | (get-buffer-create (generate-new-buffer-name " *temp*")))) |
| 1083 | (unwind-protect |
| 1084 | (with-current-buffer ,temp-buffer |
| 1085 | ,@body) |
| 1086 | (and (buffer-name ,temp-buffer) |
| 1087 | (kill-buffer ,temp-buffer)))))) |
| 1088 | |
| 1089 | (defmacro with-output-to-string (&rest body) |
| 1090 | "Execute BODY, return the text it sent to `standard-output', as a string." |
| 1091 | `(let ((standard-output |
| 1092 | (get-buffer-create (generate-new-buffer-name " *string-output*")))) |
| 1093 | (let ((standard-output standard-output)) |
| 1094 | ,@body) |
| 1095 | (with-current-buffer standard-output |
| 1096 | (prog1 |
| 1097 | (buffer-string) |
| 1098 | (kill-buffer nil))))) |
| 1099 | |
| 1100 | (defmacro combine-after-change-calls (&rest body) |
| 1101 | "Execute BODY, but don't call the after-change functions till the end. |
| 1102 | If BODY makes changes in the buffer, they are recorded |
| 1103 | and the functions on `after-change-functions' are called several times |
| 1104 | when BODY is finished. |
| 1105 | The return value is the value of the last form in BODY. |
| 1106 | |
| 1107 | If `before-change-functions' is non-nil, then calls to the after-change |
| 1108 | functions can't be deferred, so in that case this macro has no effect. |
| 1109 | |
| 1110 | Do not alter `after-change-functions' or `before-change-functions' |
| 1111 | in BODY." |
| 1112 | `(unwind-protect |
| 1113 | (let ((combine-after-change-calls t)) |
| 1114 | . ,body) |
| 1115 | (combine-after-change-execute))) |
| 1116 | |
| 1117 | |
| 1118 | (defvar combine-run-hooks t |
| 1119 | "List of hooks delayed. Or t if we're not delaying hooks.") |
| 1120 | |
| 1121 | (defmacro combine-run-hooks (&rest body) |
| 1122 | "Execute BODY, but delay any `run-hooks' until the end." |
| 1123 | (let ((saved-combine-run-hooks (make-symbol "saved-combine-run-hooks")) |
| 1124 | (saved-run-hooks (make-symbol "saved-run-hooks"))) |
| 1125 | `(let ((,saved-combine-run-hooks combine-run-hooks) |
| 1126 | (,saved-run-hooks (symbol-function 'run-hooks))) |
| 1127 | (unwind-protect |
| 1128 | (progn |
| 1129 | ;; If we're not delaying hooks yet, setup the delaying mode |
| 1130 | (unless (listp combine-run-hooks) |
| 1131 | (setq combine-run-hooks nil) |
| 1132 | (fset 'run-hooks |
| 1133 | ,(lambda (&rest hooks) |
| 1134 | (setq combine-run-hooks |
| 1135 | (append combine-run-hooks hooks))))) |
| 1136 | ,@body) |
| 1137 | ;; If we were not already delaying, then it's now time to set things |
| 1138 | ;; back to normal and to execute the delayed hooks. |
| 1139 | (unless (listp ,saved-combine-run-hooks) |
| 1140 | (setq ,saved-combine-run-hooks combine-run-hooks) |
| 1141 | (fset 'run-hooks ,saved-run-hooks) |
| 1142 | (setq combine-run-hooks t) |
| 1143 | (apply 'run-hooks ,saved-combine-run-hooks)))))) |
| 1144 | |
| 1145 | |
| 1146 | (defmacro with-syntax-table (table &rest body) |
| 1147 | "Evaluate BODY with syntax table of current buffer set to a copy of TABLE. |
| 1148 | The syntax table of the current buffer is saved, BODY is evaluated, and the |
| 1149 | saved table is restored, even in case of an abnormal exit. |
| 1150 | Value is what BODY returns." |
| 1151 | (let ((old-table (make-symbol "table")) |
| 1152 | (old-buffer (make-symbol "buffer"))) |
| 1153 | `(let ((,old-table (syntax-table)) |
| 1154 | (,old-buffer (current-buffer))) |
| 1155 | (unwind-protect |
| 1156 | (progn |
| 1157 | (set-syntax-table (copy-syntax-table ,table)) |
| 1158 | ,@body) |
| 1159 | (save-current-buffer |
| 1160 | (set-buffer ,old-buffer) |
| 1161 | (set-syntax-table ,old-table)))))) |
| 1162 | \f |
| 1163 | (defvar save-match-data-internal) |
| 1164 | |
| 1165 | ;; We use save-match-data-internal as the local variable because |
| 1166 | ;; that works ok in practice (people should not use that variable elsewhere). |
| 1167 | ;; We used to use an uninterned symbol; the compiler handles that properly |
| 1168 | ;; now, but it generates slower code. |
| 1169 | (defmacro save-match-data (&rest body) |
| 1170 | "Execute the BODY forms, restoring the global value of the match data." |
| 1171 | ;; It is better not to use backquote here, |
| 1172 | ;; because that makes a bootstrapping problem |
| 1173 | ;; if you need to recompile all the Lisp files using interpreted code. |
| 1174 | (list 'let |
| 1175 | '((save-match-data-internal (match-data))) |
| 1176 | (list 'unwind-protect |
| 1177 | (cons 'progn body) |
| 1178 | '(set-match-data save-match-data-internal)))) |
| 1179 | |
| 1180 | (defun match-string (num &optional string) |
| 1181 | "Return string of text matched by last search. |
| 1182 | NUM specifies which parenthesized expression in the last regexp. |
| 1183 | Value is nil if NUMth pair didn't match, or there were less than NUM pairs. |
| 1184 | Zero means the entire text matched by the whole regexp or whole string. |
| 1185 | STRING should be given if the last search was by `string-match' on STRING." |
| 1186 | (if (match-beginning num) |
| 1187 | (if string |
| 1188 | (substring string (match-beginning num) (match-end num)) |
| 1189 | (buffer-substring (match-beginning num) (match-end num))))) |
| 1190 | |
| 1191 | (defun match-string-no-properties (num &optional string) |
| 1192 | "Return string of text matched by last search, without text properties. |
| 1193 | NUM specifies which parenthesized expression in the last regexp. |
| 1194 | Value is nil if NUMth pair didn't match, or there were less than NUM pairs. |
| 1195 | Zero means the entire text matched by the whole regexp or whole string. |
| 1196 | STRING should be given if the last search was by `string-match' on STRING." |
| 1197 | (if (match-beginning num) |
| 1198 | (if string |
| 1199 | (let ((result |
| 1200 | (substring string (match-beginning num) (match-end num)))) |
| 1201 | (set-text-properties 0 (length result) nil result) |
| 1202 | result) |
| 1203 | (buffer-substring-no-properties (match-beginning num) |
| 1204 | (match-end num))))) |
| 1205 | |
| 1206 | (defun split-string (string &optional separators) |
| 1207 | "Splits STRING into substrings where there are matches for SEPARATORS. |
| 1208 | Each match for SEPARATORS is a splitting point. |
| 1209 | The substrings between the splitting points are made into a list |
| 1210 | which is returned. |
| 1211 | If SEPARATORS is absent, it defaults to \"[ \\f\\t\\n\\r\\v]+\". |
| 1212 | |
| 1213 | If there is match for SEPARATORS at the beginning of STRING, we do not |
| 1214 | include a null substring for that. Likewise, if there is a match |
| 1215 | at the end of STRING, we don't include a null substring for that. |
| 1216 | |
| 1217 | Modifies the match data; use `save-match-data' if necessary." |
| 1218 | (let ((rexp (or separators "[ \f\t\n\r\v]+")) |
| 1219 | (start 0) |
| 1220 | notfirst |
| 1221 | (list nil)) |
| 1222 | (while (and (string-match rexp string |
| 1223 | (if (and notfirst |
| 1224 | (= start (match-beginning 0)) |
| 1225 | (< start (length string))) |
| 1226 | (1+ start) start)) |
| 1227 | (< (match-beginning 0) (length string))) |
| 1228 | (setq notfirst t) |
| 1229 | (or (eq (match-beginning 0) 0) |
| 1230 | (and (eq (match-beginning 0) (match-end 0)) |
| 1231 | (eq (match-beginning 0) start)) |
| 1232 | (setq list |
| 1233 | (cons (substring string start (match-beginning 0)) |
| 1234 | list))) |
| 1235 | (setq start (match-end 0))) |
| 1236 | (or (eq start (length string)) |
| 1237 | (setq list |
| 1238 | (cons (substring string start) |
| 1239 | list))) |
| 1240 | (nreverse list))) |
| 1241 | |
| 1242 | (defun subst-char-in-string (fromchar tochar string &optional inplace) |
| 1243 | "Replace FROMCHAR with TOCHAR in STRING each time it occurs. |
| 1244 | Unless optional argument INPLACE is non-nil, return a new string." |
| 1245 | (let ((i (length string)) |
| 1246 | (newstr (if inplace string (copy-sequence string)))) |
| 1247 | (while (> i 0) |
| 1248 | (setq i (1- i)) |
| 1249 | (if (eq (aref newstr i) fromchar) |
| 1250 | (aset newstr i tochar))) |
| 1251 | newstr)) |
| 1252 | |
| 1253 | (defun replace-regexp-in-string (regexp rep string &optional |
| 1254 | fixedcase literal subexp start) |
| 1255 | "Replace all matches for REGEXP with REP in STRING. |
| 1256 | |
| 1257 | Return a new string containing the replacements. |
| 1258 | |
| 1259 | Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the |
| 1260 | arguments with the same names of function `replace-match'. If START |
| 1261 | is non-nil, start replacements at that index in STRING. |
| 1262 | |
| 1263 | REP is either a string used as the NEWTEXT arg of `replace-match' or a |
| 1264 | function. If it is a function it is applied to each match to generate |
| 1265 | the replacement passed to `replace-match'; the match-data at this |
| 1266 | point are such that match 0 is the function's argument. |
| 1267 | |
| 1268 | To replace only the first match (if any), make REGEXP match up to \\' |
| 1269 | and replace a sub-expression, e.g. |
| 1270 | (replace-regexp-in-string \"\\(foo\\).*\\'\" \"bar\" \" foo foo\" nil nil 1) |
| 1271 | => \" bar foo\" |
| 1272 | " |
| 1273 | |
| 1274 | ;; To avoid excessive consing from multiple matches in long strings, |
| 1275 | ;; don't just call `replace-match' continually. Walk down the |
| 1276 | ;; string looking for matches of REGEXP and building up a (reversed) |
| 1277 | ;; list MATCHES. This comprises segments of STRING which weren't |
| 1278 | ;; matched interspersed with replacements for segments that were. |
| 1279 | ;; [For a `large' number of replacments it's more efficient to |
| 1280 | ;; operate in a temporary buffer; we can't tell from the function's |
| 1281 | ;; args whether to choose the buffer-based implementation, though it |
| 1282 | ;; might be reasonable to do so for long enough STRING.] |
| 1283 | (let ((l (length string)) |
| 1284 | (start (or start 0)) |
| 1285 | matches str mb me) |
| 1286 | (save-match-data |
| 1287 | (while (and (< start l) (string-match regexp string start)) |
| 1288 | (setq mb (match-beginning 0) |
| 1289 | me (match-end 0)) |
| 1290 | ;; If we matched the empty string, make sure we advance by one char |
| 1291 | (when (= me mb) (setq me (min l (1+ mb)))) |
| 1292 | ;; Generate a replacement for the matched substring. |
| 1293 | ;; Operate only on the substring to minimize string consing. |
| 1294 | ;; Set up match data for the substring for replacement; |
| 1295 | ;; presumably this is likely to be faster than munging the |
| 1296 | ;; match data directly in Lisp. |
| 1297 | (string-match regexp (setq str (substring string mb me))) |
| 1298 | (setq matches |
| 1299 | (cons (replace-match (if (stringp rep) |
| 1300 | rep |
| 1301 | (funcall rep (match-string 0 str))) |
| 1302 | fixedcase literal str subexp) |
| 1303 | (cons (substring string start mb) ; unmatched prefix |
| 1304 | matches))) |
| 1305 | (setq start me)) |
| 1306 | ;; Reconstruct a string from the pieces. |
| 1307 | (setq matches (cons (substring string start l) matches)) ; leftover |
| 1308 | (apply #'concat (nreverse matches))))) |
| 1309 | \f |
| 1310 | (defun shell-quote-argument (argument) |
| 1311 | "Quote an argument for passing as argument to an inferior shell." |
| 1312 | (if (eq system-type 'ms-dos) |
| 1313 | ;; Quote using double quotes, but escape any existing quotes in |
| 1314 | ;; the argument with backslashes. |
| 1315 | (let ((result "") |
| 1316 | (start 0) |
| 1317 | end) |
| 1318 | (if (or (null (string-match "[^\"]" argument)) |
| 1319 | (< (match-end 0) (length argument))) |
| 1320 | (while (string-match "[\"]" argument start) |
| 1321 | (setq end (match-beginning 0) |
| 1322 | result (concat result (substring argument start end) |
| 1323 | "\\" (substring argument end (1+ end))) |
| 1324 | start (1+ end)))) |
| 1325 | (concat "\"" result (substring argument start) "\"")) |
| 1326 | (if (eq system-type 'windows-nt) |
| 1327 | (concat "\"" argument "\"") |
| 1328 | (if (equal argument "") |
| 1329 | "''" |
| 1330 | ;; Quote everything except POSIX filename characters. |
| 1331 | ;; This should be safe enough even for really weird shells. |
| 1332 | (let ((result "") (start 0) end) |
| 1333 | (while (string-match "[^-0-9a-zA-Z_./]" argument start) |
| 1334 | (setq end (match-beginning 0) |
| 1335 | result (concat result (substring argument start end) |
| 1336 | "\\" (substring argument end (1+ end))) |
| 1337 | start (1+ end))) |
| 1338 | (concat result (substring argument start))))))) |
| 1339 | |
| 1340 | (defun make-syntax-table (&optional oldtable) |
| 1341 | "Return a new syntax table. |
| 1342 | If OLDTABLE is non-nil, copy OLDTABLE. |
| 1343 | Otherwise, create a syntax table which inherits |
| 1344 | all letters and control characters from the standard syntax table; |
| 1345 | other characters are copied from the standard syntax table." |
| 1346 | (if oldtable |
| 1347 | (copy-syntax-table oldtable) |
| 1348 | (let ((table (copy-syntax-table)) |
| 1349 | i) |
| 1350 | (setq i 0) |
| 1351 | (while (<= i 31) |
| 1352 | (aset table i nil) |
| 1353 | (setq i (1+ i))) |
| 1354 | (setq i ?A) |
| 1355 | (while (<= i ?Z) |
| 1356 | (aset table i nil) |
| 1357 | (setq i (1+ i))) |
| 1358 | (setq i ?a) |
| 1359 | (while (<= i ?z) |
| 1360 | (aset table i nil) |
| 1361 | (setq i (1+ i))) |
| 1362 | (setq i 128) |
| 1363 | (while (<= i 255) |
| 1364 | (aset table i nil) |
| 1365 | (setq i (1+ i))) |
| 1366 | table))) |
| 1367 | |
| 1368 | (defun add-to-invisibility-spec (arg) |
| 1369 | "Add elements to `buffer-invisibility-spec'. |
| 1370 | See documentation for `buffer-invisibility-spec' for the kind of elements |
| 1371 | that can be added." |
| 1372 | (cond |
| 1373 | ((or (null buffer-invisibility-spec) (eq buffer-invisibility-spec t)) |
| 1374 | (setq buffer-invisibility-spec (list arg))) |
| 1375 | (t |
| 1376 | (setq buffer-invisibility-spec |
| 1377 | (cons arg buffer-invisibility-spec))))) |
| 1378 | |
| 1379 | (defun remove-from-invisibility-spec (arg) |
| 1380 | "Remove elements from `buffer-invisibility-spec'." |
| 1381 | (if (consp buffer-invisibility-spec) |
| 1382 | (setq buffer-invisibility-spec (delete arg buffer-invisibility-spec)))) |
| 1383 | \f |
| 1384 | (defun global-set-key (key command) |
| 1385 | "Give KEY a global binding as COMMAND. |
| 1386 | COMMAND is the command definition to use; usually it is |
| 1387 | a symbol naming an interactively-callable function. |
| 1388 | KEY is a key sequence; noninteractively, it is a string or vector |
| 1389 | of characters or event types, and non-ASCII characters with codes |
| 1390 | above 127 (such as ISO Latin-1) can be included if you use a vector. |
| 1391 | |
| 1392 | Note that if KEY has a local binding in the current buffer, |
| 1393 | that local binding will continue to shadow any global binding |
| 1394 | that you make with this function." |
| 1395 | (interactive "KSet key globally: \nCSet key %s to command: ") |
| 1396 | (or (vectorp key) (stringp key) |
| 1397 | (signal 'wrong-type-argument (list 'arrayp key))) |
| 1398 | (define-key (current-global-map) key command)) |
| 1399 | |
| 1400 | (defun local-set-key (key command) |
| 1401 | "Give KEY a local binding as COMMAND. |
| 1402 | COMMAND is the command definition to use; usually it is |
| 1403 | a symbol naming an interactively-callable function. |
| 1404 | KEY is a key sequence; noninteractively, it is a string or vector |
| 1405 | of characters or event types, and non-ASCII characters with codes |
| 1406 | above 127 (such as ISO Latin-1) can be included if you use a vector. |
| 1407 | |
| 1408 | The binding goes in the current buffer's local map, |
| 1409 | which in most cases is shared with all other buffers in the same major mode." |
| 1410 | (interactive "KSet key locally: \nCSet key %s locally to command: ") |
| 1411 | (let ((map (current-local-map))) |
| 1412 | (or map |
| 1413 | (use-local-map (setq map (make-sparse-keymap)))) |
| 1414 | (or (vectorp key) (stringp key) |
| 1415 | (signal 'wrong-type-argument (list 'arrayp key))) |
| 1416 | (define-key map key command))) |
| 1417 | |
| 1418 | (defun global-unset-key (key) |
| 1419 | "Remove global binding of KEY. |
| 1420 | KEY is a string representing a sequence of keystrokes." |
| 1421 | (interactive "kUnset key globally: ") |
| 1422 | (global-set-key key nil)) |
| 1423 | |
| 1424 | (defun local-unset-key (key) |
| 1425 | "Remove local binding of KEY. |
| 1426 | KEY is a string representing a sequence of keystrokes." |
| 1427 | (interactive "kUnset key locally: ") |
| 1428 | (if (current-local-map) |
| 1429 | (local-set-key key nil)) |
| 1430 | nil) |
| 1431 | \f |
| 1432 | ;; We put this here instead of in frame.el so that it's defined even on |
| 1433 | ;; systems where frame.el isn't loaded. |
| 1434 | (defun frame-configuration-p (object) |
| 1435 | "Return non-nil if OBJECT seems to be a frame configuration. |
| 1436 | Any list whose car is `frame-configuration' is assumed to be a frame |
| 1437 | configuration." |
| 1438 | (and (consp object) |
| 1439 | (eq (car object) 'frame-configuration))) |
| 1440 | |
| 1441 | (defun functionp (object) |
| 1442 | "Non-nil if OBJECT is a type of object that can be called as a function." |
| 1443 | (or (subrp object) (byte-code-function-p object) |
| 1444 | (eq (car-safe object) 'lambda) |
| 1445 | (and (symbolp object) (fboundp object)))) |
| 1446 | |
| 1447 | ;; now in fns.c |
| 1448 | ;(defun nth (n list) |
| 1449 | ; "Returns the Nth element of LIST. |
| 1450 | ;N counts from zero. If LIST is not that long, nil is returned." |
| 1451 | ; (car (nthcdr n list))) |
| 1452 | ; |
| 1453 | ;(defun copy-alist (alist) |
| 1454 | ; "Return a copy of ALIST. |
| 1455 | ;This is a new alist which represents the same mapping |
| 1456 | ;from objects to objects, but does not share the alist structure with ALIST. |
| 1457 | ;The objects mapped (cars and cdrs of elements of the alist) |
| 1458 | ;are shared, however." |
| 1459 | ; (setq alist (copy-sequence alist)) |
| 1460 | ; (let ((tail alist)) |
| 1461 | ; (while tail |
| 1462 | ; (if (consp (car tail)) |
| 1463 | ; (setcar tail (cons (car (car tail)) (cdr (car tail))))) |
| 1464 | ; (setq tail (cdr tail)))) |
| 1465 | ; alist) |
| 1466 | |
| 1467 | (defun assq-delete-all (key alist) |
| 1468 | "Delete from ALIST all elements whose car is KEY. |
| 1469 | Return the modified alist." |
| 1470 | (let ((tail alist)) |
| 1471 | (while tail |
| 1472 | (if (eq (car (car tail)) key) |
| 1473 | (setq alist (delq (car tail) alist))) |
| 1474 | (setq tail (cdr tail))) |
| 1475 | alist)) |
| 1476 | |
| 1477 | (defun make-temp-file (prefix &optional dir-flag) |
| 1478 | "Create a temporary file. |
| 1479 | The returned file name (created by appending some random characters at the end |
| 1480 | of PREFIX, and expanding against `temporary-file-directory' if necessary, |
| 1481 | is guaranteed to point to a newly created empty file. |
| 1482 | You can then use `write-region' to write new data into the file. |
| 1483 | |
| 1484 | If DIR-FLAG is non-nil, create a new empty directory instead of a file." |
| 1485 | (let (file) |
| 1486 | (while (condition-case () |
| 1487 | (progn |
| 1488 | (setq file |
| 1489 | (make-temp-name |
| 1490 | (expand-file-name prefix temporary-file-directory))) |
| 1491 | (if dir-flag |
| 1492 | (make-directory file) |
| 1493 | (write-region "" nil file nil 'silent nil 'excl)) |
| 1494 | nil) |
| 1495 | (file-already-exists t)) |
| 1496 | ;; the file was somehow created by someone else between |
| 1497 | ;; `make-temp-name' and `write-region', let's try again. |
| 1498 | nil) |
| 1499 | file)) |
| 1500 | |
| 1501 | \f |
| 1502 | (defun add-minor-mode (toggle name &optional keymap after toggle-fun) |
| 1503 | "Register a new minor mode. |
| 1504 | |
| 1505 | This is an XEmacs-compatibility function. Use `define-minor-mode' instead. |
| 1506 | |
| 1507 | TOGGLE is a symbol which is the name of a buffer-local variable that |
| 1508 | is toggled on or off to say whether the minor mode is active or not. |
| 1509 | |
| 1510 | NAME specifies what will appear in the mode line when the minor mode |
| 1511 | is active. NAME should be either a string starting with a space, or a |
| 1512 | symbol whose value is such a string. |
| 1513 | |
| 1514 | Optional KEYMAP is the keymap for the minor mode that will be added |
| 1515 | to `minor-mode-map-alist'. |
| 1516 | |
| 1517 | Optional AFTER specifies that TOGGLE should be added after AFTER |
| 1518 | in `minor-mode-alist'. |
| 1519 | |
| 1520 | Optional TOGGLE-FUN is an interactive function to toggle the mode. |
| 1521 | It defaults to (and should by convention be) TOGGLE. |
| 1522 | |
| 1523 | If TOGGLE has a non-nil `:included' property, an entry for the mode is |
| 1524 | included in the mode-line minor mode menu. |
| 1525 | If TOGGLE has a `:menu-tag', that is used for the menu item's label." |
| 1526 | (unless toggle-fun (setq toggle-fun toggle)) |
| 1527 | ;; Add the toggle to the minor-modes menu if requested. |
| 1528 | (when (get toggle :included) |
| 1529 | (define-key mode-line-mode-menu |
| 1530 | (vector toggle) |
| 1531 | (list 'menu-item |
| 1532 | (or (get toggle :menu-tag) |
| 1533 | (if (stringp name) name (symbol-name toggle))) |
| 1534 | toggle-fun |
| 1535 | :button (cons :toggle toggle)))) |
| 1536 | ;; Add the name to the minor-mode-alist. |
| 1537 | (when name |
| 1538 | (let ((existing (assq toggle minor-mode-alist))) |
| 1539 | (when (and (stringp name) (not (get-text-property 0 'local-map name))) |
| 1540 | (setq name |
| 1541 | (apply 'propertize name |
| 1542 | 'local-map (make-mode-line-mouse2-map toggle-fun) |
| 1543 | (unless (get-text-property 0 'help-echo name) |
| 1544 | (list 'help-echo |
| 1545 | (format "mouse-2: turn off %S" toggle)))))) |
| 1546 | (if existing |
| 1547 | (setcdr existing (list name)) |
| 1548 | (let ((tail minor-mode-alist) found) |
| 1549 | (while (and tail (not found)) |
| 1550 | (if (eq after (caar tail)) |
| 1551 | (setq found tail) |
| 1552 | (setq tail (cdr tail)))) |
| 1553 | (if found |
| 1554 | (let ((rest (cdr found))) |
| 1555 | (setcdr found nil) |
| 1556 | (nconc found (list (list toggle name)) rest)) |
| 1557 | (setq minor-mode-alist (cons (list toggle name) |
| 1558 | minor-mode-alist))))))) |
| 1559 | ;; Add the map to the minor-mode-map-alist. |
| 1560 | (when keymap |
| 1561 | (let ((existing (assq toggle minor-mode-map-alist))) |
| 1562 | (if existing |
| 1563 | (setcdr existing keymap) |
| 1564 | (let ((tail minor-mode-map-alist) found) |
| 1565 | (while (and tail (not found)) |
| 1566 | (if (eq after (caar tail)) |
| 1567 | (setq found tail) |
| 1568 | (setq tail (cdr tail)))) |
| 1569 | (if found |
| 1570 | (let ((rest (cdr found))) |
| 1571 | (setcdr found nil) |
| 1572 | (nconc found (list (cons toggle keymap)) rest)) |
| 1573 | (setq minor-mode-map-alist (cons (cons toggle keymap) |
| 1574 | minor-mode-map-alist)))))))) |
| 1575 | |
| 1576 | ;; XEmacs compatibility/convenience. |
| 1577 | (if (fboundp 'play-sound) |
| 1578 | (defun play-sound-file (file &optional volume device) |
| 1579 | "Play sound stored in FILE. |
| 1580 | VOLUME and DEVICE correspond to the keywords of the sound |
| 1581 | specification for `play-sound'." |
| 1582 | (interactive "fPlay sound file: ") |
| 1583 | (let ((sound (list :file file))) |
| 1584 | (if volume |
| 1585 | (plist-put sound :volume volume)) |
| 1586 | (if device |
| 1587 | (plist-put sound :device device)) |
| 1588 | (push 'sound sound) |
| 1589 | (play-sound sound)))) |
| 1590 | |
| 1591 | ;;; subr.el ends here |