| 1 | ;;; subr.el --- basic lisp subroutines for Emacs |
| 2 | |
| 3 | ;; Copyright (C) 1985, 86, 92, 94, 95, 99, 2000, 2001, 2002, 03, 2004 |
| 4 | ;; Free Software Foundation, Inc. |
| 5 | |
| 6 | ;; Maintainer: FSF |
| 7 | ;; Keywords: internal |
| 8 | |
| 9 | ;; This file is part of GNU Emacs. |
| 10 | |
| 11 | ;; GNU Emacs is free software; you can redistribute it and/or modify |
| 12 | ;; it under the terms of the GNU General Public License as published by |
| 13 | ;; the Free Software Foundation; either version 2, or (at your option) |
| 14 | ;; any later version. |
| 15 | |
| 16 | ;; GNU Emacs is distributed in the hope that it will be useful, |
| 17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 19 | ;; GNU General Public License for more details. |
| 20 | |
| 21 | ;; You should have received a copy of the GNU General Public License |
| 22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
| 23 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
| 24 | ;; Boston, MA 02111-1307, USA. |
| 25 | |
| 26 | ;;; Commentary: |
| 27 | |
| 28 | ;;; Code: |
| 29 | (defvar custom-declare-variable-list nil |
| 30 | "Record `defcustom' calls made before `custom.el' is loaded to handle them. |
| 31 | Each element of this list holds the arguments to one call to `defcustom'.") |
| 32 | |
| 33 | ;; Use this, rather than defcustom, in subr.el and other files loaded |
| 34 | ;; before custom.el. |
| 35 | (defun custom-declare-variable-early (&rest arguments) |
| 36 | (setq custom-declare-variable-list |
| 37 | (cons arguments custom-declare-variable-list))) |
| 38 | |
| 39 | \f |
| 40 | (defun macro-declaration-function (macro decl) |
| 41 | "Process a declaration found in a macro definition. |
| 42 | This is set as the value of the variable `macro-declaration-function'. |
| 43 | MACRO is the name of the macro being defined. |
| 44 | DECL is a list `(declare ...)' containing the declarations. |
| 45 | The return value of this function is not used." |
| 46 | ;; We can't use `dolist' or `cadr' yet for bootstrapping reasons. |
| 47 | (let (d) |
| 48 | ;; Ignore the first element of `decl' (it's always `declare'). |
| 49 | (while (setq decl (cdr decl)) |
| 50 | (setq d (car decl)) |
| 51 | (cond ((and (consp d) (eq (car d) 'indent)) |
| 52 | (put macro 'lisp-indent-function (car (cdr d)))) |
| 53 | ((and (consp d) (eq (car d) 'debug)) |
| 54 | (put macro 'edebug-form-spec (car (cdr d)))) |
| 55 | (t |
| 56 | (message "Unknown declaration %s" d)))))) |
| 57 | |
| 58 | (setq macro-declaration-function 'macro-declaration-function) |
| 59 | |
| 60 | \f |
| 61 | ;;;; Lisp language features. |
| 62 | |
| 63 | (defalias 'not 'null) |
| 64 | |
| 65 | (defmacro noreturn (form) |
| 66 | "Evaluates FORM, with the expectation that the evaluation will signal an error |
| 67 | instead of returning to its caller. If FORM does return, an error is |
| 68 | signalled." |
| 69 | `(prog1 ,form |
| 70 | (error "Form marked with `noreturn' did return"))) |
| 71 | |
| 72 | (defmacro 1value (form) |
| 73 | "Evaluates FORM, with the expectation that all the same value will be returned |
| 74 | from all evaluations of FORM. This is the global do-nothing |
| 75 | version of `1value'. There is also `testcover-1value' that |
| 76 | complains if FORM ever does return differing values." |
| 77 | form) |
| 78 | |
| 79 | (defmacro lambda (&rest cdr) |
| 80 | "Return a lambda expression. |
| 81 | A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is |
| 82 | self-quoting; the result of evaluating the lambda expression is the |
| 83 | expression itself. The lambda expression may then be treated as a |
| 84 | function, i.e., stored as the function value of a symbol, passed to |
| 85 | funcall or mapcar, etc. |
| 86 | |
| 87 | ARGS should take the same form as an argument list for a `defun'. |
| 88 | DOCSTRING is an optional documentation string. |
| 89 | If present, it should describe how to call the function. |
| 90 | But documentation strings are usually not useful in nameless functions. |
| 91 | INTERACTIVE should be a call to the function `interactive', which see. |
| 92 | It may also be omitted. |
| 93 | BODY should be a list of Lisp expressions. |
| 94 | |
| 95 | \(fn ARGS [DOCSTRING] [INTERACTIVE] BODY)" |
| 96 | ;; Note that this definition should not use backquotes; subr.el should not |
| 97 | ;; depend on backquote.el. |
| 98 | (list 'function (cons 'lambda cdr))) |
| 99 | |
| 100 | (defmacro push (newelt listname) |
| 101 | "Add NEWELT to the list stored in the symbol LISTNAME. |
| 102 | This is equivalent to (setq LISTNAME (cons NEWELT LISTNAME)). |
| 103 | LISTNAME must be a symbol." |
| 104 | (declare (debug (form sexp))) |
| 105 | (list 'setq listname |
| 106 | (list 'cons newelt listname))) |
| 107 | |
| 108 | (defmacro pop (listname) |
| 109 | "Return the first element of LISTNAME's value, and remove it from the list. |
| 110 | LISTNAME must be a symbol whose value is a list. |
| 111 | If the value is nil, `pop' returns nil but does not actually |
| 112 | change the list." |
| 113 | (declare (debug (sexp))) |
| 114 | (list 'car |
| 115 | (list 'prog1 listname |
| 116 | (list 'setq listname (list 'cdr listname))))) |
| 117 | |
| 118 | (defmacro when (cond &rest body) |
| 119 | "If COND yields non-nil, do BODY, else return nil." |
| 120 | (declare (indent 1) (debug t)) |
| 121 | (list 'if cond (cons 'progn body))) |
| 122 | |
| 123 | (defmacro unless (cond &rest body) |
| 124 | "If COND yields nil, do BODY, else return nil." |
| 125 | (declare (indent 1) (debug t)) |
| 126 | (cons 'if (cons cond (cons nil body)))) |
| 127 | |
| 128 | (defmacro dolist (spec &rest body) |
| 129 | "Loop over a list. |
| 130 | Evaluate BODY with VAR bound to each car from LIST, in turn. |
| 131 | Then evaluate RESULT to get return value, default nil. |
| 132 | |
| 133 | \(fn (VAR LIST [RESULT]) BODY...)" |
| 134 | (declare (indent 1) (debug ((symbolp form &optional form) body))) |
| 135 | (let ((temp (make-symbol "--dolist-temp--"))) |
| 136 | `(let ((,temp ,(nth 1 spec)) |
| 137 | ,(car spec)) |
| 138 | (while ,temp |
| 139 | (setq ,(car spec) (car ,temp)) |
| 140 | (setq ,temp (cdr ,temp)) |
| 141 | ,@body) |
| 142 | ,@(if (cdr (cdr spec)) |
| 143 | `((setq ,(car spec) nil) ,@(cdr (cdr spec))))))) |
| 144 | |
| 145 | (defmacro dotimes (spec &rest body) |
| 146 | "Loop a certain number of times. |
| 147 | Evaluate BODY with VAR bound to successive integers running from 0, |
| 148 | inclusive, to COUNT, exclusive. Then evaluate RESULT to get |
| 149 | the return value (nil if RESULT is omitted). |
| 150 | |
| 151 | \(fn (VAR COUNT [RESULT]) BODY...)" |
| 152 | (declare (indent 1) (debug dolist)) |
| 153 | (let ((temp (make-symbol "--dotimes-temp--")) |
| 154 | (start 0) |
| 155 | (end (nth 1 spec))) |
| 156 | `(let ((,temp ,end) |
| 157 | (,(car spec) ,start)) |
| 158 | (while (< ,(car spec) ,temp) |
| 159 | ,@body |
| 160 | (setq ,(car spec) (1+ ,(car spec)))) |
| 161 | ,@(cdr (cdr spec))))) |
| 162 | |
| 163 | (defmacro declare (&rest specs) |
| 164 | "Do not evaluate any arguments and return nil. |
| 165 | Treated as a declaration when used at the right place in a |
| 166 | `defmacro' form. \(See Info anchor `(elisp)Definition of declare'.)" |
| 167 | nil) |
| 168 | |
| 169 | (defsubst caar (x) |
| 170 | "Return the car of the car of X." |
| 171 | (car (car x))) |
| 172 | |
| 173 | (defsubst cadr (x) |
| 174 | "Return the car of the cdr of X." |
| 175 | (car (cdr x))) |
| 176 | |
| 177 | (defsubst cdar (x) |
| 178 | "Return the cdr of the car of X." |
| 179 | (cdr (car x))) |
| 180 | |
| 181 | (defsubst cddr (x) |
| 182 | "Return the cdr of the cdr of X." |
| 183 | (cdr (cdr x))) |
| 184 | |
| 185 | (defun last (list &optional n) |
| 186 | "Return the last link of LIST. Its car is the last element. |
| 187 | If LIST is nil, return nil. |
| 188 | If N is non-nil, return the Nth-to-last link of LIST. |
| 189 | If N is bigger than the length of LIST, return LIST." |
| 190 | (if n |
| 191 | (let ((m 0) (p list)) |
| 192 | (while (consp p) |
| 193 | (setq m (1+ m) p (cdr p))) |
| 194 | (if (<= n 0) p |
| 195 | (if (< n m) (nthcdr (- m n) list) list))) |
| 196 | (while (consp (cdr list)) |
| 197 | (setq list (cdr list))) |
| 198 | list)) |
| 199 | |
| 200 | (defun butlast (list &optional n) |
| 201 | "Returns a copy of LIST with the last N elements removed." |
| 202 | (if (and n (<= n 0)) list |
| 203 | (nbutlast (copy-sequence list) n))) |
| 204 | |
| 205 | (defun nbutlast (list &optional n) |
| 206 | "Modifies LIST to remove the last N elements." |
| 207 | (let ((m (length list))) |
| 208 | (or n (setq n 1)) |
| 209 | (and (< n m) |
| 210 | (progn |
| 211 | (if (> n 0) (setcdr (nthcdr (- (1- m) n) list) nil)) |
| 212 | list)))) |
| 213 | |
| 214 | (defun delete-dups (list) |
| 215 | "Destructively remove `equal' duplicates from LIST. |
| 216 | Store the result in LIST and return it. LIST must be a proper list. |
| 217 | Of several `equal' occurrences of an element in LIST, the first |
| 218 | one is kept." |
| 219 | (let ((tail list)) |
| 220 | (while tail |
| 221 | (setcdr tail (delete (car tail) (cdr tail))) |
| 222 | (setq tail (cdr tail)))) |
| 223 | list) |
| 224 | |
| 225 | (defun number-sequence (from &optional to inc) |
| 226 | "Return a sequence of numbers from FROM to TO (both inclusive) as a list. |
| 227 | INC is the increment used between numbers in the sequence and defaults to 1. |
| 228 | So, the Nth element of the list is \(+ FROM \(* N INC)) where N counts from |
| 229 | zero. TO is only included if there is an N for which TO = FROM + N * INC. |
| 230 | If TO is nil or numerically equal to FROM, return \(FROM). |
| 231 | If INC is positive and TO is less than FROM, or INC is negative |
| 232 | and TO is larger than FROM, return nil. |
| 233 | If INC is zero and TO is neither nil nor numerically equal to |
| 234 | FROM, signal an error. |
| 235 | |
| 236 | This function is primarily designed for integer arguments. |
| 237 | Nevertheless, FROM, TO and INC can be integer or float. However, |
| 238 | floating point arithmetic is inexact. For instance, depending on |
| 239 | the machine, it may quite well happen that |
| 240 | \(number-sequence 0.4 0.6 0.2) returns the one element list \(0.4), |
| 241 | whereas \(number-sequence 0.4 0.8 0.2) returns a list with three |
| 242 | elements. Thus, if some of the arguments are floats and one wants |
| 243 | to make sure that TO is included, one may have to explicitly write |
| 244 | TO as \(+ FROM \(* N INC)) or use a variable whose value was |
| 245 | computed with this exact expression. Alternatively, you can, |
| 246 | of course, also replace TO with a slightly larger value |
| 247 | \(or a slightly more negative value if INC is negative)." |
| 248 | (if (or (not to) (= from to)) |
| 249 | (list from) |
| 250 | (or inc (setq inc 1)) |
| 251 | (when (zerop inc) (error "The increment can not be zero")) |
| 252 | (let (seq (n 0) (next from)) |
| 253 | (if (> inc 0) |
| 254 | (while (<= next to) |
| 255 | (setq seq (cons next seq) |
| 256 | n (1+ n) |
| 257 | next (+ from (* n inc)))) |
| 258 | (while (>= next to) |
| 259 | (setq seq (cons next seq) |
| 260 | n (1+ n) |
| 261 | next (+ from (* n inc))))) |
| 262 | (nreverse seq)))) |
| 263 | |
| 264 | (defun remove (elt seq) |
| 265 | "Return a copy of SEQ with all occurrences of ELT removed. |
| 266 | SEQ must be a list, vector, or string. The comparison is done with `equal'." |
| 267 | (if (nlistp seq) |
| 268 | ;; If SEQ isn't a list, there's no need to copy SEQ because |
| 269 | ;; `delete' will return a new object. |
| 270 | (delete elt seq) |
| 271 | (delete elt (copy-sequence seq)))) |
| 272 | |
| 273 | (defun remq (elt list) |
| 274 | "Return LIST with all occurrences of ELT removed. |
| 275 | The comparison is done with `eq'. Contrary to `delq', this does not use |
| 276 | side-effects, and the argument LIST is not modified." |
| 277 | (if (memq elt list) |
| 278 | (delq elt (copy-sequence list)) |
| 279 | list)) |
| 280 | |
| 281 | (defun copy-tree (tree &optional vecp) |
| 282 | "Make a copy of TREE. |
| 283 | If TREE is a cons cell, this recursively copies both its car and its cdr. |
| 284 | Contrast to `copy-sequence', which copies only along the cdrs. With second |
| 285 | argument VECP, this copies vectors as well as conses." |
| 286 | (if (consp tree) |
| 287 | (let (result) |
| 288 | (while (consp tree) |
| 289 | (let ((newcar (car tree))) |
| 290 | (if (or (consp (car tree)) (and vecp (vectorp (car tree)))) |
| 291 | (setq newcar (copy-tree (car tree) vecp))) |
| 292 | (push newcar result)) |
| 293 | (setq tree (cdr tree))) |
| 294 | (nconc (nreverse result) tree)) |
| 295 | (if (and vecp (vectorp tree)) |
| 296 | (let ((i (length (setq tree (copy-sequence tree))))) |
| 297 | (while (>= (setq i (1- i)) 0) |
| 298 | (aset tree i (copy-tree (aref tree i) vecp))) |
| 299 | tree) |
| 300 | tree))) |
| 301 | |
| 302 | (defun assoc-default (key alist &optional test default) |
| 303 | "Find object KEY in a pseudo-alist ALIST. |
| 304 | ALIST is a list of conses or objects. Each element (or the element's car, |
| 305 | if it is a cons) is compared with KEY by evaluating (TEST (car elt) KEY). |
| 306 | If that is non-nil, the element matches; |
| 307 | then `assoc-default' returns the element's cdr, if it is a cons, |
| 308 | or DEFAULT if the element is not a cons. |
| 309 | |
| 310 | If no element matches, the value is nil. |
| 311 | If TEST is omitted or nil, `equal' is used." |
| 312 | (let (found (tail alist) value) |
| 313 | (while (and tail (not found)) |
| 314 | (let ((elt (car tail))) |
| 315 | (when (funcall (or test 'equal) (if (consp elt) (car elt) elt) key) |
| 316 | (setq found t value (if (consp elt) (cdr elt) default)))) |
| 317 | (setq tail (cdr tail))) |
| 318 | value)) |
| 319 | |
| 320 | (make-obsolete 'assoc-ignore-case 'assoc-string) |
| 321 | (defun assoc-ignore-case (key alist) |
| 322 | "Like `assoc', but ignores differences in case and text representation. |
| 323 | KEY must be a string. Upper-case and lower-case letters are treated as equal. |
| 324 | Unibyte strings are converted to multibyte for comparison." |
| 325 | (assoc-string key alist t)) |
| 326 | |
| 327 | (make-obsolete 'assoc-ignore-representation 'assoc-string) |
| 328 | (defun assoc-ignore-representation (key alist) |
| 329 | "Like `assoc', but ignores differences in text representation. |
| 330 | KEY must be a string. |
| 331 | Unibyte strings are converted to multibyte for comparison." |
| 332 | (assoc-string key alist nil)) |
| 333 | |
| 334 | (defun member-ignore-case (elt list) |
| 335 | "Like `member', but ignores differences in case and text representation. |
| 336 | ELT must be a string. Upper-case and lower-case letters are treated as equal. |
| 337 | Unibyte strings are converted to multibyte for comparison. |
| 338 | Non-strings in LIST are ignored." |
| 339 | (while (and list |
| 340 | (not (and (stringp (car list)) |
| 341 | (eq t (compare-strings elt 0 nil (car list) 0 nil t))))) |
| 342 | (setq list (cdr list))) |
| 343 | list) |
| 344 | |
| 345 | \f |
| 346 | ;;;; Keymap support. |
| 347 | |
| 348 | (defun undefined () |
| 349 | (interactive) |
| 350 | (ding)) |
| 351 | |
| 352 | ;Prevent the \{...} documentation construct |
| 353 | ;from mentioning keys that run this command. |
| 354 | (put 'undefined 'suppress-keymap t) |
| 355 | |
| 356 | (defun suppress-keymap (map &optional nodigits) |
| 357 | "Make MAP override all normally self-inserting keys to be undefined. |
| 358 | Normally, as an exception, digits and minus-sign are set to make prefix args, |
| 359 | but optional second arg NODIGITS non-nil treats them like other chars." |
| 360 | (define-key map [remap self-insert-command] 'undefined) |
| 361 | (or nodigits |
| 362 | (let (loop) |
| 363 | (define-key map "-" 'negative-argument) |
| 364 | ;; Make plain numbers do numeric args. |
| 365 | (setq loop ?0) |
| 366 | (while (<= loop ?9) |
| 367 | (define-key map (char-to-string loop) 'digit-argument) |
| 368 | (setq loop (1+ loop)))))) |
| 369 | |
| 370 | ;Moved to keymap.c |
| 371 | ;(defun copy-keymap (keymap) |
| 372 | ; "Return a copy of KEYMAP" |
| 373 | ; (while (not (keymapp keymap)) |
| 374 | ; (setq keymap (signal 'wrong-type-argument (list 'keymapp keymap)))) |
| 375 | ; (if (vectorp keymap) |
| 376 | ; (copy-sequence keymap) |
| 377 | ; (copy-alist keymap))) |
| 378 | |
| 379 | (defvar key-substitution-in-progress nil |
| 380 | "Used internally by substitute-key-definition.") |
| 381 | |
| 382 | (defun substitute-key-definition (olddef newdef keymap &optional oldmap prefix) |
| 383 | "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF. |
| 384 | In other words, OLDDEF is replaced with NEWDEF where ever it appears. |
| 385 | Alternatively, if optional fourth argument OLDMAP is specified, we redefine |
| 386 | in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP." |
| 387 | ;; Don't document PREFIX in the doc string because we don't want to |
| 388 | ;; advertise it. It's meant for recursive calls only. Here's its |
| 389 | ;; meaning |
| 390 | |
| 391 | ;; If optional argument PREFIX is specified, it should be a key |
| 392 | ;; prefix, a string. Redefined bindings will then be bound to the |
| 393 | ;; original key, with PREFIX added at the front. |
| 394 | (or prefix (setq prefix "")) |
| 395 | (let* ((scan (or oldmap keymap)) |
| 396 | (vec1 (vector nil)) |
| 397 | (prefix1 (vconcat prefix vec1)) |
| 398 | (key-substitution-in-progress |
| 399 | (cons scan key-substitution-in-progress))) |
| 400 | ;; Scan OLDMAP, finding each char or event-symbol that |
| 401 | ;; has any definition, and act on it with hack-key. |
| 402 | (while (consp scan) |
| 403 | (if (consp (car scan)) |
| 404 | (let ((char (car (car scan))) |
| 405 | (defn (cdr (car scan)))) |
| 406 | ;; The inside of this let duplicates exactly |
| 407 | ;; the inside of the following let that handles array elements. |
| 408 | (aset vec1 0 char) |
| 409 | (aset prefix1 (length prefix) char) |
| 410 | (let (inner-def skipped) |
| 411 | ;; Skip past menu-prompt. |
| 412 | (while (stringp (car-safe defn)) |
| 413 | (setq skipped (cons (car defn) skipped)) |
| 414 | (setq defn (cdr defn))) |
| 415 | ;; Skip past cached key-equivalence data for menu items. |
| 416 | (and (consp defn) (consp (car defn)) |
| 417 | (setq defn (cdr defn))) |
| 418 | (setq inner-def defn) |
| 419 | ;; Look past a symbol that names a keymap. |
| 420 | (while (and (symbolp inner-def) |
| 421 | (fboundp inner-def)) |
| 422 | (setq inner-def (symbol-function inner-def))) |
| 423 | (if (or (eq defn olddef) |
| 424 | ;; Compare with equal if definition is a key sequence. |
| 425 | ;; That is useful for operating on function-key-map. |
| 426 | (and (or (stringp defn) (vectorp defn)) |
| 427 | (equal defn olddef))) |
| 428 | (define-key keymap prefix1 (nconc (nreverse skipped) newdef)) |
| 429 | (if (and (keymapp defn) |
| 430 | ;; Avoid recursively scanning |
| 431 | ;; where KEYMAP does not have a submap. |
| 432 | (let ((elt (lookup-key keymap prefix1))) |
| 433 | (or (null elt) |
| 434 | (keymapp elt))) |
| 435 | ;; Avoid recursively rescanning keymap being scanned. |
| 436 | (not (memq inner-def |
| 437 | key-substitution-in-progress))) |
| 438 | ;; If this one isn't being scanned already, |
| 439 | ;; scan it now. |
| 440 | (substitute-key-definition olddef newdef keymap |
| 441 | inner-def |
| 442 | prefix1))))) |
| 443 | (if (vectorp (car scan)) |
| 444 | (let* ((array (car scan)) |
| 445 | (len (length array)) |
| 446 | (i 0)) |
| 447 | (while (< i len) |
| 448 | (let ((char i) (defn (aref array i))) |
| 449 | ;; The inside of this let duplicates exactly |
| 450 | ;; the inside of the previous let. |
| 451 | (aset vec1 0 char) |
| 452 | (aset prefix1 (length prefix) char) |
| 453 | (let (inner-def skipped) |
| 454 | ;; Skip past menu-prompt. |
| 455 | (while (stringp (car-safe defn)) |
| 456 | (setq skipped (cons (car defn) skipped)) |
| 457 | (setq defn (cdr defn))) |
| 458 | (and (consp defn) (consp (car defn)) |
| 459 | (setq defn (cdr defn))) |
| 460 | (setq inner-def defn) |
| 461 | (while (and (symbolp inner-def) |
| 462 | (fboundp inner-def)) |
| 463 | (setq inner-def (symbol-function inner-def))) |
| 464 | (if (or (eq defn olddef) |
| 465 | (and (or (stringp defn) (vectorp defn)) |
| 466 | (equal defn olddef))) |
| 467 | (define-key keymap prefix1 |
| 468 | (nconc (nreverse skipped) newdef)) |
| 469 | (if (and (keymapp defn) |
| 470 | (let ((elt (lookup-key keymap prefix1))) |
| 471 | (or (null elt) |
| 472 | (keymapp elt))) |
| 473 | (not (memq inner-def |
| 474 | key-substitution-in-progress))) |
| 475 | (substitute-key-definition olddef newdef keymap |
| 476 | inner-def |
| 477 | prefix1))))) |
| 478 | (setq i (1+ i)))) |
| 479 | (if (char-table-p (car scan)) |
| 480 | (map-char-table |
| 481 | (function (lambda (char defn) |
| 482 | (let () |
| 483 | ;; The inside of this let duplicates exactly |
| 484 | ;; the inside of the previous let, |
| 485 | ;; except that it uses set-char-table-range |
| 486 | ;; instead of define-key. |
| 487 | (aset vec1 0 char) |
| 488 | (aset prefix1 (length prefix) char) |
| 489 | (let (inner-def skipped) |
| 490 | ;; Skip past menu-prompt. |
| 491 | (while (stringp (car-safe defn)) |
| 492 | (setq skipped (cons (car defn) skipped)) |
| 493 | (setq defn (cdr defn))) |
| 494 | (and (consp defn) (consp (car defn)) |
| 495 | (setq defn (cdr defn))) |
| 496 | (setq inner-def defn) |
| 497 | (while (and (symbolp inner-def) |
| 498 | (fboundp inner-def)) |
| 499 | (setq inner-def (symbol-function inner-def))) |
| 500 | (if (or (eq defn olddef) |
| 501 | (and (or (stringp defn) (vectorp defn)) |
| 502 | (equal defn olddef))) |
| 503 | (define-key keymap prefix1 |
| 504 | (nconc (nreverse skipped) newdef)) |
| 505 | (if (and (keymapp defn) |
| 506 | (let ((elt (lookup-key keymap prefix1))) |
| 507 | (or (null elt) |
| 508 | (keymapp elt))) |
| 509 | (not (memq inner-def |
| 510 | key-substitution-in-progress))) |
| 511 | (substitute-key-definition olddef newdef keymap |
| 512 | inner-def |
| 513 | prefix1))))))) |
| 514 | (car scan))))) |
| 515 | (setq scan (cdr scan))))) |
| 516 | |
| 517 | (defun define-key-after (keymap key definition &optional after) |
| 518 | "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding. |
| 519 | This is like `define-key' except that the binding for KEY is placed |
| 520 | just after the binding for the event AFTER, instead of at the beginning |
| 521 | of the map. Note that AFTER must be an event type (like KEY), NOT a command |
| 522 | \(like DEFINITION). |
| 523 | |
| 524 | If AFTER is t or omitted, the new binding goes at the end of the keymap. |
| 525 | AFTER should be a single event type--a symbol or a character, not a sequence. |
| 526 | |
| 527 | Bindings are always added before any inherited map. |
| 528 | |
| 529 | The order of bindings in a keymap matters when it is used as a menu." |
| 530 | (unless after (setq after t)) |
| 531 | (or (keymapp keymap) |
| 532 | (signal 'wrong-type-argument (list 'keymapp keymap))) |
| 533 | (setq key |
| 534 | (if (<= (length key) 1) (aref key 0) |
| 535 | (setq keymap (lookup-key keymap |
| 536 | (apply 'vector |
| 537 | (butlast (mapcar 'identity key))))) |
| 538 | (aref key (1- (length key))))) |
| 539 | (let ((tail keymap) done inserted) |
| 540 | (while (and (not done) tail) |
| 541 | ;; Delete any earlier bindings for the same key. |
| 542 | (if (eq (car-safe (car (cdr tail))) key) |
| 543 | (setcdr tail (cdr (cdr tail)))) |
| 544 | ;; If we hit an included map, go down that one. |
| 545 | (if (keymapp (car tail)) (setq tail (car tail))) |
| 546 | ;; When we reach AFTER's binding, insert the new binding after. |
| 547 | ;; If we reach an inherited keymap, insert just before that. |
| 548 | ;; If we reach the end of this keymap, insert at the end. |
| 549 | (if (or (and (eq (car-safe (car tail)) after) |
| 550 | (not (eq after t))) |
| 551 | (eq (car (cdr tail)) 'keymap) |
| 552 | (null (cdr tail))) |
| 553 | (progn |
| 554 | ;; Stop the scan only if we find a parent keymap. |
| 555 | ;; Keep going past the inserted element |
| 556 | ;; so we can delete any duplications that come later. |
| 557 | (if (eq (car (cdr tail)) 'keymap) |
| 558 | (setq done t)) |
| 559 | ;; Don't insert more than once. |
| 560 | (or inserted |
| 561 | (setcdr tail (cons (cons key definition) (cdr tail)))) |
| 562 | (setq inserted t))) |
| 563 | (setq tail (cdr tail))))) |
| 564 | |
| 565 | |
| 566 | (defmacro kbd (keys) |
| 567 | "Convert KEYS to the internal Emacs key representation. |
| 568 | KEYS should be a string constant in the format used for |
| 569 | saving keyboard macros (see `insert-kbd-macro')." |
| 570 | (read-kbd-macro keys)) |
| 571 | |
| 572 | (put 'keyboard-translate-table 'char-table-extra-slots 0) |
| 573 | |
| 574 | (defun keyboard-translate (from to) |
| 575 | "Translate character FROM to TO at a low level. |
| 576 | This function creates a `keyboard-translate-table' if necessary |
| 577 | and then modifies one entry in it." |
| 578 | (or (char-table-p keyboard-translate-table) |
| 579 | (setq keyboard-translate-table |
| 580 | (make-char-table 'keyboard-translate-table nil))) |
| 581 | (aset keyboard-translate-table from to)) |
| 582 | |
| 583 | \f |
| 584 | ;;;; The global keymap tree. |
| 585 | |
| 586 | ;;; global-map, esc-map, and ctl-x-map have their values set up in |
| 587 | ;;; keymap.c; we just give them docstrings here. |
| 588 | |
| 589 | (defvar global-map nil |
| 590 | "Default global keymap mapping Emacs keyboard input into commands. |
| 591 | The value is a keymap which is usually (but not necessarily) Emacs's |
| 592 | global map.") |
| 593 | |
| 594 | (defvar esc-map nil |
| 595 | "Default keymap for ESC (meta) commands. |
| 596 | The normal global definition of the character ESC indirects to this keymap.") |
| 597 | |
| 598 | (defvar ctl-x-map nil |
| 599 | "Default keymap for C-x commands. |
| 600 | The normal global definition of the character C-x indirects to this keymap.") |
| 601 | |
| 602 | (defvar ctl-x-4-map (make-sparse-keymap) |
| 603 | "Keymap for subcommands of C-x 4.") |
| 604 | (defalias 'ctl-x-4-prefix ctl-x-4-map) |
| 605 | (define-key ctl-x-map "4" 'ctl-x-4-prefix) |
| 606 | |
| 607 | (defvar ctl-x-5-map (make-sparse-keymap) |
| 608 | "Keymap for frame commands.") |
| 609 | (defalias 'ctl-x-5-prefix ctl-x-5-map) |
| 610 | (define-key ctl-x-map "5" 'ctl-x-5-prefix) |
| 611 | |
| 612 | \f |
| 613 | ;;;; Event manipulation functions. |
| 614 | |
| 615 | ;; The call to `read' is to ensure that the value is computed at load time |
| 616 | ;; and not compiled into the .elc file. The value is negative on most |
| 617 | ;; machines, but not on all! |
| 618 | (defconst listify-key-sequence-1 (logior 128 (read "?\\M-\\^@"))) |
| 619 | |
| 620 | (defun listify-key-sequence (key) |
| 621 | "Convert a key sequence to a list of events." |
| 622 | (if (vectorp key) |
| 623 | (append key nil) |
| 624 | (mapcar (function (lambda (c) |
| 625 | (if (> c 127) |
| 626 | (logxor c listify-key-sequence-1) |
| 627 | c))) |
| 628 | key))) |
| 629 | |
| 630 | (defsubst eventp (obj) |
| 631 | "True if the argument is an event object." |
| 632 | (or (integerp obj) |
| 633 | (and (symbolp obj) |
| 634 | (get obj 'event-symbol-elements)) |
| 635 | (and (consp obj) |
| 636 | (symbolp (car obj)) |
| 637 | (get (car obj) 'event-symbol-elements)))) |
| 638 | |
| 639 | (defun event-modifiers (event) |
| 640 | "Returns a list of symbols representing the modifier keys in event EVENT. |
| 641 | The elements of the list may include `meta', `control', |
| 642 | `shift', `hyper', `super', `alt', `click', `double', `triple', `drag', |
| 643 | and `down'." |
| 644 | (let ((type event)) |
| 645 | (if (listp type) |
| 646 | (setq type (car type))) |
| 647 | (if (symbolp type) |
| 648 | (cdr (get type 'event-symbol-elements)) |
| 649 | (let ((list nil) |
| 650 | (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@ |
| 651 | ?\H-\^@ ?\s-\^@ ?\A-\^@))))) |
| 652 | (if (not (zerop (logand type ?\M-\^@))) |
| 653 | (setq list (cons 'meta list))) |
| 654 | (if (or (not (zerop (logand type ?\C-\^@))) |
| 655 | (< char 32)) |
| 656 | (setq list (cons 'control list))) |
| 657 | (if (or (not (zerop (logand type ?\S-\^@))) |
| 658 | (/= char (downcase char))) |
| 659 | (setq list (cons 'shift list))) |
| 660 | (or (zerop (logand type ?\H-\^@)) |
| 661 | (setq list (cons 'hyper list))) |
| 662 | (or (zerop (logand type ?\s-\^@)) |
| 663 | (setq list (cons 'super list))) |
| 664 | (or (zerop (logand type ?\A-\^@)) |
| 665 | (setq list (cons 'alt list))) |
| 666 | list)))) |
| 667 | |
| 668 | (defun event-basic-type (event) |
| 669 | "Returns the basic type of the given event (all modifiers removed). |
| 670 | The value is a printing character (not upper case) or a symbol." |
| 671 | (if (consp event) |
| 672 | (setq event (car event))) |
| 673 | (if (symbolp event) |
| 674 | (car (get event 'event-symbol-elements)) |
| 675 | (let ((base (logand event (1- (lsh 1 18))))) |
| 676 | (downcase (if (< base 32) (logior base 64) base))))) |
| 677 | |
| 678 | (defsubst mouse-movement-p (object) |
| 679 | "Return non-nil if OBJECT is a mouse movement event." |
| 680 | (and (consp object) |
| 681 | (eq (car object) 'mouse-movement))) |
| 682 | |
| 683 | (defsubst event-start (event) |
| 684 | "Return the starting position of EVENT. |
| 685 | If EVENT is a mouse or key press or a mouse click, this returns the location |
| 686 | of the event. |
| 687 | If EVENT is a drag, this returns the drag's starting position. |
| 688 | The return value is of the form |
| 689 | (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW) |
| 690 | IMAGE (DX . DY) (WIDTH . HEIGHT)) |
| 691 | The `posn-' functions access elements of such lists." |
| 692 | (if (consp event) (nth 1 event) |
| 693 | (list (selected-window) (point) '(0 . 0) 0))) |
| 694 | |
| 695 | (defsubst event-end (event) |
| 696 | "Return the ending location of EVENT. |
| 697 | EVENT should be a click, drag, or key press event. |
| 698 | If EVENT is a click event, this function is the same as `event-start'. |
| 699 | The return value is of the form |
| 700 | (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW) |
| 701 | IMAGE (DX . DY) (WIDTH . HEIGHT)) |
| 702 | The `posn-' functions access elements of such lists." |
| 703 | (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event) |
| 704 | (list (selected-window) (point) '(0 . 0) 0))) |
| 705 | |
| 706 | (defsubst event-click-count (event) |
| 707 | "Return the multi-click count of EVENT, a click or drag event. |
| 708 | The return value is a positive integer." |
| 709 | (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1)) |
| 710 | |
| 711 | (defsubst posn-window (position) |
| 712 | "Return the window in POSITION. |
| 713 | POSITION should be a list of the form returned by the `event-start' |
| 714 | and `event-end' functions." |
| 715 | (nth 0 position)) |
| 716 | |
| 717 | (defsubst posn-area (position) |
| 718 | "Return the window area recorded in POSITION, or nil for the text area. |
| 719 | POSITION should be a list of the form returned by the `event-start' |
| 720 | and `event-end' functions." |
| 721 | (let ((area (if (consp (nth 1 position)) |
| 722 | (car (nth 1 position)) |
| 723 | (nth 1 position)))) |
| 724 | (and (symbolp area) area))) |
| 725 | |
| 726 | (defsubst posn-point (position) |
| 727 | "Return the buffer location in POSITION. |
| 728 | POSITION should be a list of the form returned by the `event-start' |
| 729 | and `event-end' functions." |
| 730 | (or (nth 5 position) |
| 731 | (if (consp (nth 1 position)) |
| 732 | (car (nth 1 position)) |
| 733 | (nth 1 position)))) |
| 734 | |
| 735 | (defun posn-set-point (position) |
| 736 | "Move point to POSITION. |
| 737 | Select the corresponding window as well." |
| 738 | (if (not (windowp (posn-window position))) |
| 739 | (error "Position not in text area of window")) |
| 740 | (select-window (posn-window position)) |
| 741 | (if (numberp (posn-point position)) |
| 742 | (goto-char (posn-point position)))) |
| 743 | |
| 744 | (defsubst posn-x-y (position) |
| 745 | "Return the x and y coordinates in POSITION. |
| 746 | POSITION should be a list of the form returned by the `event-start' |
| 747 | and `event-end' functions." |
| 748 | (nth 2 position)) |
| 749 | |
| 750 | (defun posn-col-row (position) |
| 751 | "Return the nominal column and row in POSITION, measured in characters. |
| 752 | The column and row values are approximations calculated from the x |
| 753 | and y coordinates in POSITION and the frame's default character width |
| 754 | and height. |
| 755 | For a scroll-bar event, the result column is 0, and the row |
| 756 | corresponds to the vertical position of the click in the scroll bar. |
| 757 | POSITION should be a list of the form returned by the `event-start' |
| 758 | and `event-end' functions." |
| 759 | (let* ((pair (posn-x-y position)) |
| 760 | (window (posn-window position)) |
| 761 | (area (posn-area position))) |
| 762 | (cond |
| 763 | ((null window) |
| 764 | '(0 . 0)) |
| 765 | ((eq area 'vertical-scroll-bar) |
| 766 | (cons 0 (scroll-bar-scale pair (1- (window-height window))))) |
| 767 | ((eq area 'horizontal-scroll-bar) |
| 768 | (cons (scroll-bar-scale pair (window-width window)) 0)) |
| 769 | (t |
| 770 | (let* ((frame (if (framep window) window (window-frame window))) |
| 771 | (x (/ (car pair) (frame-char-width frame))) |
| 772 | (y (/ (cdr pair) (+ (frame-char-height frame) |
| 773 | (or (frame-parameter frame 'line-spacing) |
| 774 | default-line-spacing |
| 775 | 0))))) |
| 776 | (cons x y)))))) |
| 777 | |
| 778 | (defun posn-actual-col-row (position) |
| 779 | "Return the actual column and row in POSITION, measured in characters. |
| 780 | These are the actual row number in the window and character number in that row. |
| 781 | Return nil if POSITION does not contain the actual position; in that case |
| 782 | `posn-col-row' can be used to get approximate values. |
| 783 | POSITION should be a list of the form returned by the `event-start' |
| 784 | and `event-end' functions." |
| 785 | (nth 6 position)) |
| 786 | |
| 787 | (defsubst posn-timestamp (position) |
| 788 | "Return the timestamp of POSITION. |
| 789 | POSITION should be a list of the form returned by the `event-start' |
| 790 | and `event-end' functions." |
| 791 | (nth 3 position)) |
| 792 | |
| 793 | (defsubst posn-string (position) |
| 794 | "Return the string object of POSITION, or nil if a buffer position. |
| 795 | POSITION should be a list of the form returned by the `event-start' |
| 796 | and `event-end' functions." |
| 797 | (nth 4 position)) |
| 798 | |
| 799 | (defsubst posn-image (position) |
| 800 | "Return the image object of POSITION, or nil if a not an image. |
| 801 | POSITION should be a list of the form returned by the `event-start' |
| 802 | and `event-end' functions." |
| 803 | (nth 7 position)) |
| 804 | |
| 805 | (defsubst posn-object (position) |
| 806 | "Return the object (image or string) of POSITION. |
| 807 | POSITION should be a list of the form returned by the `event-start' |
| 808 | and `event-end' functions." |
| 809 | (or (posn-image position) (posn-string position))) |
| 810 | |
| 811 | (defsubst posn-object-x-y (position) |
| 812 | "Return the x and y coordinates relative to the object of POSITION. |
| 813 | POSITION should be a list of the form returned by the `event-start' |
| 814 | and `event-end' functions." |
| 815 | (nth 8 position)) |
| 816 | |
| 817 | (defsubst posn-object-width-height (position) |
| 818 | "Return the pixel width and height of the object of POSITION. |
| 819 | POSITION should be a list of the form returned by the `event-start' |
| 820 | and `event-end' functions." |
| 821 | (nth 9 position)) |
| 822 | |
| 823 | \f |
| 824 | ;;;; Obsolescent names for functions. |
| 825 | |
| 826 | (defalias 'dot 'point) |
| 827 | (defalias 'dot-marker 'point-marker) |
| 828 | (defalias 'dot-min 'point-min) |
| 829 | (defalias 'dot-max 'point-max) |
| 830 | (defalias 'window-dot 'window-point) |
| 831 | (defalias 'set-window-dot 'set-window-point) |
| 832 | (defalias 'read-input 'read-string) |
| 833 | (defalias 'send-string 'process-send-string) |
| 834 | (defalias 'send-region 'process-send-region) |
| 835 | (defalias 'show-buffer 'set-window-buffer) |
| 836 | (defalias 'buffer-flush-undo 'buffer-disable-undo) |
| 837 | (defalias 'eval-current-buffer 'eval-buffer) |
| 838 | (defalias 'compiled-function-p 'byte-code-function-p) |
| 839 | (defalias 'define-function 'defalias) |
| 840 | |
| 841 | (defalias 'sref 'aref) |
| 842 | (make-obsolete 'sref 'aref "20.4") |
| 843 | (make-obsolete 'char-bytes "now always returns 1." "20.4") |
| 844 | (make-obsolete 'chars-in-region "use (abs (- BEG END))." "20.3") |
| 845 | (make-obsolete 'dot 'point "before 19.15") |
| 846 | (make-obsolete 'dot-max 'point-max "before 19.15") |
| 847 | (make-obsolete 'dot-min 'point-min "before 19.15") |
| 848 | (make-obsolete 'dot-marker 'point-marker "before 19.15") |
| 849 | (make-obsolete 'buffer-flush-undo 'buffer-disable-undo "before 19.15") |
| 850 | (make-obsolete 'baud-rate "use the baud-rate variable instead." "before 19.15") |
| 851 | (make-obsolete 'compiled-function-p 'byte-code-function-p "before 19.15") |
| 852 | (make-obsolete 'define-function 'defalias "20.1") |
| 853 | |
| 854 | (defun insert-string (&rest args) |
| 855 | "Mocklisp-compatibility insert function. |
| 856 | Like the function `insert' except that any argument that is a number |
| 857 | is converted into a string by expressing it in decimal." |
| 858 | (dolist (el args) |
| 859 | (insert (if (integerp el) (number-to-string el) el)))) |
| 860 | (make-obsolete 'insert-string 'insert "21.4") |
| 861 | (defun makehash (&optional test) (make-hash-table :test (or test 'eql))) |
| 862 | (make-obsolete 'makehash 'make-hash-table "21.4") |
| 863 | |
| 864 | ;; Some programs still use this as a function. |
| 865 | (defun baud-rate () |
| 866 | "Return the value of the `baud-rate' variable." |
| 867 | baud-rate) |
| 868 | |
| 869 | (defalias 'focus-frame 'ignore) |
| 870 | (defalias 'unfocus-frame 'ignore) |
| 871 | |
| 872 | \f |
| 873 | ;;;; Obsolescence declarations for variables. |
| 874 | |
| 875 | (make-obsolete-variable 'directory-sep-char "do not use it." "21.1") |
| 876 | (make-obsolete-variable 'mode-line-inverse-video "use the appropriate faces instead." "21.1") |
| 877 | (make-obsolete-variable 'unread-command-char |
| 878 | "use `unread-command-events' instead. That variable is a list of events to reread, so it now uses nil to mean `no event', instead of -1." |
| 879 | "before 19.15") |
| 880 | (make-obsolete-variable 'executing-macro 'executing-kbd-macro "before 19.34") |
| 881 | (make-obsolete-variable 'post-command-idle-hook |
| 882 | "use timers instead, with `run-with-idle-timer'." "before 19.34") |
| 883 | (make-obsolete-variable 'post-command-idle-delay |
| 884 | "use timers instead, with `run-with-idle-timer'." "before 19.34") |
| 885 | |
| 886 | \f |
| 887 | ;;;; Alternate names for functions - these are not being phased out. |
| 888 | |
| 889 | (defalias 'string= 'string-equal) |
| 890 | (defalias 'string< 'string-lessp) |
| 891 | (defalias 'move-marker 'set-marker) |
| 892 | (defalias 'rplaca 'setcar) |
| 893 | (defalias 'rplacd 'setcdr) |
| 894 | (defalias 'beep 'ding) ;preserve lingual purity |
| 895 | (defalias 'indent-to-column 'indent-to) |
| 896 | (defalias 'backward-delete-char 'delete-backward-char) |
| 897 | (defalias 'search-forward-regexp (symbol-function 're-search-forward)) |
| 898 | (defalias 'search-backward-regexp (symbol-function 're-search-backward)) |
| 899 | (defalias 'int-to-string 'number-to-string) |
| 900 | (defalias 'store-match-data 'set-match-data) |
| 901 | (defalias 'make-variable-frame-localizable 'make-variable-frame-local) |
| 902 | ;; These are the XEmacs names: |
| 903 | (defalias 'point-at-eol 'line-end-position) |
| 904 | (defalias 'point-at-bol 'line-beginning-position) |
| 905 | |
| 906 | ;;; Should this be an obsolete name? If you decide it should, you get |
| 907 | ;;; to go through all the sources and change them. |
| 908 | (defalias 'string-to-int 'string-to-number) |
| 909 | \f |
| 910 | ;;;; Hook manipulation functions. |
| 911 | |
| 912 | (defun make-local-hook (hook) |
| 913 | "Make the hook HOOK local to the current buffer. |
| 914 | The return value is HOOK. |
| 915 | |
| 916 | You never need to call this function now that `add-hook' does it for you |
| 917 | if its LOCAL argument is non-nil. |
| 918 | |
| 919 | When a hook is local, its local and global values |
| 920 | work in concert: running the hook actually runs all the hook |
| 921 | functions listed in *either* the local value *or* the global value |
| 922 | of the hook variable. |
| 923 | |
| 924 | This function works by making t a member of the buffer-local value, |
| 925 | which acts as a flag to run the hook functions in the default value as |
| 926 | well. This works for all normal hooks, but does not work for most |
| 927 | non-normal hooks yet. We will be changing the callers of non-normal |
| 928 | hooks so that they can handle localness; this has to be done one by |
| 929 | one. |
| 930 | |
| 931 | This function does nothing if HOOK is already local in the current |
| 932 | buffer. |
| 933 | |
| 934 | Do not use `make-local-variable' to make a hook variable buffer-local." |
| 935 | (if (local-variable-p hook) |
| 936 | nil |
| 937 | (or (boundp hook) (set hook nil)) |
| 938 | (make-local-variable hook) |
| 939 | (set hook (list t))) |
| 940 | hook) |
| 941 | (make-obsolete 'make-local-hook "not necessary any more." "21.1") |
| 942 | |
| 943 | (defun add-hook (hook function &optional append local) |
| 944 | "Add to the value of HOOK the function FUNCTION. |
| 945 | FUNCTION is not added if already present. |
| 946 | FUNCTION is added (if necessary) at the beginning of the hook list |
| 947 | unless the optional argument APPEND is non-nil, in which case |
| 948 | FUNCTION is added at the end. |
| 949 | |
| 950 | The optional fourth argument, LOCAL, if non-nil, says to modify |
| 951 | the hook's buffer-local value rather than its default value. |
| 952 | This makes the hook buffer-local if needed, and it makes t a member |
| 953 | of the buffer-local value. That acts as a flag to run the hook |
| 954 | functions in the default value as well as in the local value. |
| 955 | |
| 956 | HOOK should be a symbol, and FUNCTION may be any valid function. If |
| 957 | HOOK is void, it is first set to nil. If HOOK's value is a single |
| 958 | function, it is changed to a list of functions." |
| 959 | (or (boundp hook) (set hook nil)) |
| 960 | (or (default-boundp hook) (set-default hook nil)) |
| 961 | (if local (unless (local-variable-if-set-p hook) |
| 962 | (set (make-local-variable hook) (list t))) |
| 963 | ;; Detect the case where make-local-variable was used on a hook |
| 964 | ;; and do what we used to do. |
| 965 | (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook))) |
| 966 | (setq local t))) |
| 967 | (let ((hook-value (if local (symbol-value hook) (default-value hook)))) |
| 968 | ;; If the hook value is a single function, turn it into a list. |
| 969 | (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda)) |
| 970 | (setq hook-value (list hook-value))) |
| 971 | ;; Do the actual addition if necessary |
| 972 | (unless (member function hook-value) |
| 973 | (setq hook-value |
| 974 | (if append |
| 975 | (append hook-value (list function)) |
| 976 | (cons function hook-value)))) |
| 977 | ;; Set the actual variable |
| 978 | (if local (set hook hook-value) (set-default hook hook-value)))) |
| 979 | |
| 980 | (defun remove-hook (hook function &optional local) |
| 981 | "Remove from the value of HOOK the function FUNCTION. |
| 982 | HOOK should be a symbol, and FUNCTION may be any valid function. If |
| 983 | FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the |
| 984 | list of hooks to run in HOOK, then nothing is done. See `add-hook'. |
| 985 | |
| 986 | The optional third argument, LOCAL, if non-nil, says to modify |
| 987 | the hook's buffer-local value rather than its default value." |
| 988 | (or (boundp hook) (set hook nil)) |
| 989 | (or (default-boundp hook) (set-default hook nil)) |
| 990 | ;; Do nothing if LOCAL is t but this hook has no local binding. |
| 991 | (unless (and local (not (local-variable-p hook))) |
| 992 | ;; Detect the case where make-local-variable was used on a hook |
| 993 | ;; and do what we used to do. |
| 994 | (when (and (local-variable-p hook) |
| 995 | (not (and (consp (symbol-value hook)) |
| 996 | (memq t (symbol-value hook))))) |
| 997 | (setq local t)) |
| 998 | (let ((hook-value (if local (symbol-value hook) (default-value hook)))) |
| 999 | ;; Remove the function, for both the list and the non-list cases. |
| 1000 | (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda)) |
| 1001 | (if (equal hook-value function) (setq hook-value nil)) |
| 1002 | (setq hook-value (delete function (copy-sequence hook-value)))) |
| 1003 | ;; If the function is on the global hook, we need to shadow it locally |
| 1004 | ;;(when (and local (member function (default-value hook)) |
| 1005 | ;; (not (member (cons 'not function) hook-value))) |
| 1006 | ;; (push (cons 'not function) hook-value)) |
| 1007 | ;; Set the actual variable |
| 1008 | (if (not local) |
| 1009 | (set-default hook hook-value) |
| 1010 | (if (equal hook-value '(t)) |
| 1011 | (kill-local-variable hook) |
| 1012 | (set hook hook-value)))))) |
| 1013 | |
| 1014 | (defun add-to-list (list-var element &optional append) |
| 1015 | "Add to the value of LIST-VAR the element ELEMENT if it isn't there yet. |
| 1016 | The test for presence of ELEMENT is done with `equal'. |
| 1017 | If ELEMENT is added, it is added at the beginning of the list, |
| 1018 | unless the optional argument APPEND is non-nil, in which case |
| 1019 | ELEMENT is added at the end. |
| 1020 | |
| 1021 | The return value is the new value of LIST-VAR. |
| 1022 | |
| 1023 | If you want to use `add-to-list' on a variable that is not defined |
| 1024 | until a certain package is loaded, you should put the call to `add-to-list' |
| 1025 | into a hook function that will be run only after loading the package. |
| 1026 | `eval-after-load' provides one way to do this. In some cases |
| 1027 | other hooks, such as major mode hooks, can do the job." |
| 1028 | (if (member element (symbol-value list-var)) |
| 1029 | (symbol-value list-var) |
| 1030 | (set list-var |
| 1031 | (if append |
| 1032 | (append (symbol-value list-var) (list element)) |
| 1033 | (cons element (symbol-value list-var)))))) |
| 1034 | |
| 1035 | \f |
| 1036 | ;;; Load history |
| 1037 | |
| 1038 | ;;; (defvar symbol-file-load-history-loaded nil |
| 1039 | ;;; "Non-nil means we have loaded the file `fns-VERSION.el' in `exec-directory'. |
| 1040 | ;;; That file records the part of `load-history' for preloaded files, |
| 1041 | ;;; which is cleared out before dumping to make Emacs smaller.") |
| 1042 | |
| 1043 | ;;; (defun load-symbol-file-load-history () |
| 1044 | ;;; "Load the file `fns-VERSION.el' in `exec-directory' if not already done. |
| 1045 | ;;; That file records the part of `load-history' for preloaded files, |
| 1046 | ;;; which is cleared out before dumping to make Emacs smaller." |
| 1047 | ;;; (unless symbol-file-load-history-loaded |
| 1048 | ;;; (load (expand-file-name |
| 1049 | ;;; ;; fns-XX.YY.ZZ.el does not work on DOS filesystem. |
| 1050 | ;;; (if (eq system-type 'ms-dos) |
| 1051 | ;;; "fns.el" |
| 1052 | ;;; (format "fns-%s.el" emacs-version)) |
| 1053 | ;;; exec-directory) |
| 1054 | ;;; ;; The file name fns-%s.el already has a .el extension. |
| 1055 | ;;; nil nil t) |
| 1056 | ;;; (setq symbol-file-load-history-loaded t))) |
| 1057 | |
| 1058 | (defun symbol-file (function) |
| 1059 | "Return the input source from which FUNCTION was loaded. |
| 1060 | The value is normally a string that was passed to `load': |
| 1061 | either an absolute file name, or a library name |
| 1062 | \(with no directory name and no `.el' or `.elc' at the end). |
| 1063 | It can also be nil, if the definition is not associated with any file." |
| 1064 | (if (and (symbolp function) (fboundp function) |
| 1065 | (eq 'autoload (car-safe (symbol-function function)))) |
| 1066 | (nth 1 (symbol-function function)) |
| 1067 | (let ((files load-history) |
| 1068 | file) |
| 1069 | (while files |
| 1070 | (if (member function (cdr (car files))) |
| 1071 | (setq file (car (car files)) files nil)) |
| 1072 | (setq files (cdr files))) |
| 1073 | file))) |
| 1074 | |
| 1075 | \f |
| 1076 | ;;;; Specifying things to do after certain files are loaded. |
| 1077 | |
| 1078 | (defun eval-after-load (file form) |
| 1079 | "Arrange that, if FILE is ever loaded, FORM will be run at that time. |
| 1080 | This makes or adds to an entry on `after-load-alist'. |
| 1081 | If FILE is already loaded, evaluate FORM right now. |
| 1082 | It does nothing if FORM is already on the list for FILE. |
| 1083 | FILE must match exactly. Normally FILE is the name of a library, |
| 1084 | with no directory or extension specified, since that is how `load' |
| 1085 | is normally called. |
| 1086 | FILE can also be a feature (i.e. a symbol), in which case FORM is |
| 1087 | evaluated whenever that feature is `provide'd." |
| 1088 | (let ((elt (assoc file after-load-alist))) |
| 1089 | ;; Make sure there is an element for FILE. |
| 1090 | (unless elt (setq elt (list file)) (push elt after-load-alist)) |
| 1091 | ;; Add FORM to the element if it isn't there. |
| 1092 | (unless (member form (cdr elt)) |
| 1093 | (nconc elt (list form)) |
| 1094 | ;; If the file has been loaded already, run FORM right away. |
| 1095 | (if (if (symbolp file) |
| 1096 | (featurep file) |
| 1097 | ;; Make sure `load-history' contains the files dumped with |
| 1098 | ;; Emacs for the case that FILE is one of them. |
| 1099 | ;; (load-symbol-file-load-history) |
| 1100 | (assoc file load-history)) |
| 1101 | (eval form)))) |
| 1102 | form) |
| 1103 | |
| 1104 | (defun eval-next-after-load (file) |
| 1105 | "Read the following input sexp, and run it whenever FILE is loaded. |
| 1106 | This makes or adds to an entry on `after-load-alist'. |
| 1107 | FILE should be the name of a library, with no directory name." |
| 1108 | (eval-after-load file (read))) |
| 1109 | \f |
| 1110 | ;;; make-network-process wrappers |
| 1111 | |
| 1112 | (if (featurep 'make-network-process) |
| 1113 | (progn |
| 1114 | |
| 1115 | (defun open-network-stream (name buffer host service) |
| 1116 | "Open a TCP connection for a service to a host. |
| 1117 | Returns a subprocess-object to represent the connection. |
| 1118 | Input and output work as for subprocesses; `delete-process' closes it. |
| 1119 | |
| 1120 | Args are NAME BUFFER HOST SERVICE. |
| 1121 | NAME is name for process. It is modified if necessary to make it unique. |
| 1122 | BUFFER is the buffer (or buffer-name) to associate with the process. |
| 1123 | Process output goes at end of that buffer, unless you specify |
| 1124 | an output stream or filter function to handle the output. |
| 1125 | BUFFER may be also nil, meaning that this process is not associated |
| 1126 | with any buffer |
| 1127 | Third arg is name of the host to connect to, or its IP address. |
| 1128 | Fourth arg SERVICE is name of the service desired, or an integer |
| 1129 | specifying a port number to connect to." |
| 1130 | (make-network-process :name name :buffer buffer |
| 1131 | :host host :service service)) |
| 1132 | |
| 1133 | (defun open-network-stream-nowait (name buffer host service &optional sentinel filter) |
| 1134 | "Initiate connection to a TCP connection for a service to a host. |
| 1135 | It returns nil if non-blocking connects are not supported; otherwise, |
| 1136 | it returns a subprocess-object to represent the connection. |
| 1137 | |
| 1138 | This function is similar to `open-network-stream', except that this |
| 1139 | function returns before the connection is established. When the |
| 1140 | connection is completed, the sentinel function will be called with |
| 1141 | second arg matching `open' (if successful) or `failed' (on error). |
| 1142 | |
| 1143 | Args are NAME BUFFER HOST SERVICE SENTINEL FILTER. |
| 1144 | NAME, BUFFER, HOST, and SERVICE are as for `open-network-stream'. |
| 1145 | Optional args, SENTINEL and FILTER specifies the sentinel and filter |
| 1146 | functions to be used for this network stream." |
| 1147 | (if (featurep 'make-network-process '(:nowait t)) |
| 1148 | (make-network-process :name name :buffer buffer :nowait t |
| 1149 | :host host :service service |
| 1150 | :filter filter :sentinel sentinel))) |
| 1151 | |
| 1152 | (defun open-network-stream-server (name buffer service &optional sentinel filter) |
| 1153 | "Create a network server process for a TCP service. |
| 1154 | It returns nil if server processes are not supported; otherwise, |
| 1155 | it returns a subprocess-object to represent the server. |
| 1156 | |
| 1157 | When a client connects to the specified service, a new subprocess |
| 1158 | is created to handle the new connection, and the sentinel function |
| 1159 | is called for the new process. |
| 1160 | |
| 1161 | Args are NAME BUFFER SERVICE SENTINEL FILTER. |
| 1162 | NAME is name for the server process. Client processes are named by |
| 1163 | appending the ip-address and port number of the client to NAME. |
| 1164 | BUFFER is the buffer (or buffer-name) to associate with the server |
| 1165 | process. Client processes will not get a buffer if a process filter |
| 1166 | is specified or BUFFER is nil; otherwise, a new buffer is created for |
| 1167 | the client process. The name is similar to the process name. |
| 1168 | Third arg SERVICE is name of the service desired, or an integer |
| 1169 | specifying a port number to connect to. It may also be t to selected |
| 1170 | an unused port number for the server. |
| 1171 | Optional args, SENTINEL and FILTER specifies the sentinel and filter |
| 1172 | functions to be used for the client processes; the server process |
| 1173 | does not use these function." |
| 1174 | (if (featurep 'make-network-process '(:server t)) |
| 1175 | (make-network-process :name name :buffer buffer |
| 1176 | :service service :server t :noquery t |
| 1177 | :sentinel sentinel :filter filter))) |
| 1178 | |
| 1179 | )) ;; (featurep 'make-network-process) |
| 1180 | |
| 1181 | |
| 1182 | ;; compatibility |
| 1183 | |
| 1184 | (make-obsolete 'process-kill-without-query |
| 1185 | "use `process-query-on-exit-flag'\nor `set-process-query-on-exit-flag'." |
| 1186 | "21.5") |
| 1187 | (defun process-kill-without-query (process &optional flag) |
| 1188 | "Say no query needed if PROCESS is running when Emacs is exited. |
| 1189 | Optional second argument if non-nil says to require a query. |
| 1190 | Value is t if a query was formerly required." |
| 1191 | (let ((old (process-query-on-exit-flag process))) |
| 1192 | (set-process-query-on-exit-flag process nil) |
| 1193 | old)) |
| 1194 | |
| 1195 | ;; process plist management |
| 1196 | |
| 1197 | (defun process-get (process propname) |
| 1198 | "Return the value of PROCESS' PROPNAME property. |
| 1199 | This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'." |
| 1200 | (plist-get (process-plist process) propname)) |
| 1201 | |
| 1202 | (defun process-put (process propname value) |
| 1203 | "Change PROCESS' PROPNAME property to VALUE. |
| 1204 | It can be retrieved with `(process-get PROCESS PROPNAME)'." |
| 1205 | (set-process-plist process |
| 1206 | (plist-put (process-plist process) propname value))) |
| 1207 | |
| 1208 | \f |
| 1209 | ;;;; Input and display facilities. |
| 1210 | |
| 1211 | (defvar read-quoted-char-radix 8 |
| 1212 | "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'. |
| 1213 | Legitimate radix values are 8, 10 and 16.") |
| 1214 | |
| 1215 | (custom-declare-variable-early |
| 1216 | 'read-quoted-char-radix 8 |
| 1217 | "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'. |
| 1218 | Legitimate radix values are 8, 10 and 16." |
| 1219 | :type '(choice (const 8) (const 10) (const 16)) |
| 1220 | :group 'editing-basics) |
| 1221 | |
| 1222 | (defun read-quoted-char (&optional prompt) |
| 1223 | "Like `read-char', but do not allow quitting. |
| 1224 | Also, if the first character read is an octal digit, |
| 1225 | we read any number of octal digits and return the |
| 1226 | specified character code. Any nondigit terminates the sequence. |
| 1227 | If the terminator is RET, it is discarded; |
| 1228 | any other terminator is used itself as input. |
| 1229 | |
| 1230 | The optional argument PROMPT specifies a string to use to prompt the user. |
| 1231 | The variable `read-quoted-char-radix' controls which radix to use |
| 1232 | for numeric input." |
| 1233 | (let ((message-log-max nil) done (first t) (code 0) char translated) |
| 1234 | (while (not done) |
| 1235 | (let ((inhibit-quit first) |
| 1236 | ;; Don't let C-h get the help message--only help function keys. |
| 1237 | (help-char nil) |
| 1238 | (help-form |
| 1239 | "Type the special character you want to use, |
| 1240 | or the octal character code. |
| 1241 | RET terminates the character code and is discarded; |
| 1242 | any other non-digit terminates the character code and is then used as input.")) |
| 1243 | (setq char (read-event (and prompt (format "%s-" prompt)) t)) |
| 1244 | (if inhibit-quit (setq quit-flag nil))) |
| 1245 | ;; Translate TAB key into control-I ASCII character, and so on. |
| 1246 | ;; Note: `read-char' does it using the `ascii-character' property. |
| 1247 | ;; We could try and use read-key-sequence instead, but then C-q ESC |
| 1248 | ;; or C-q C-x might not return immediately since ESC or C-x might be |
| 1249 | ;; bound to some prefix in function-key-map or key-translation-map. |
| 1250 | (setq translated char) |
| 1251 | (let ((translation (lookup-key function-key-map (vector char)))) |
| 1252 | (if (arrayp translation) |
| 1253 | (setq translated (aref translation 0)))) |
| 1254 | (cond ((null translated)) |
| 1255 | ((not (integerp translated)) |
| 1256 | (setq unread-command-events (list char) |
| 1257 | done t)) |
| 1258 | ((/= (logand translated ?\M-\^@) 0) |
| 1259 | ;; Turn a meta-character into a character with the 0200 bit set. |
| 1260 | (setq code (logior (logand translated (lognot ?\M-\^@)) 128) |
| 1261 | done t)) |
| 1262 | ((and (<= ?0 translated) (< translated (+ ?0 (min 10 read-quoted-char-radix)))) |
| 1263 | (setq code (+ (* code read-quoted-char-radix) (- translated ?0))) |
| 1264 | (and prompt (setq prompt (message "%s %c" prompt translated)))) |
| 1265 | ((and (<= ?a (downcase translated)) |
| 1266 | (< (downcase translated) (+ ?a -10 (min 36 read-quoted-char-radix)))) |
| 1267 | (setq code (+ (* code read-quoted-char-radix) |
| 1268 | (+ 10 (- (downcase translated) ?a)))) |
| 1269 | (and prompt (setq prompt (message "%s %c" prompt translated)))) |
| 1270 | ((and (not first) (eq translated ?\C-m)) |
| 1271 | (setq done t)) |
| 1272 | ((not first) |
| 1273 | (setq unread-command-events (list char) |
| 1274 | done t)) |
| 1275 | (t (setq code translated |
| 1276 | done t))) |
| 1277 | (setq first nil)) |
| 1278 | code)) |
| 1279 | |
| 1280 | (defun read-passwd (prompt &optional confirm default) |
| 1281 | "Read a password, prompting with PROMPT. Echo `.' for each character typed. |
| 1282 | End with RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. |
| 1283 | If optional CONFIRM is non-nil, read password twice to make sure. |
| 1284 | Optional DEFAULT is a default password to use instead of empty input." |
| 1285 | (if confirm |
| 1286 | (let (success) |
| 1287 | (while (not success) |
| 1288 | (let ((first (read-passwd prompt nil default)) |
| 1289 | (second (read-passwd "Confirm password: " nil default))) |
| 1290 | (if (equal first second) |
| 1291 | (progn |
| 1292 | (and (arrayp second) (clear-string second)) |
| 1293 | (setq success first)) |
| 1294 | (and (arrayp first) (clear-string first)) |
| 1295 | (and (arrayp second) (clear-string second)) |
| 1296 | (message "Password not repeated accurately; please start over") |
| 1297 | (sit-for 1)))) |
| 1298 | success) |
| 1299 | (let ((pass nil) |
| 1300 | (c 0) |
| 1301 | (echo-keystrokes 0) |
| 1302 | (cursor-in-echo-area t)) |
| 1303 | (while (progn (message "%s%s" |
| 1304 | prompt |
| 1305 | (make-string (length pass) ?.)) |
| 1306 | (setq c (read-char-exclusive nil t)) |
| 1307 | (and (/= c ?\r) (/= c ?\n) (/= c ?\e))) |
| 1308 | (clear-this-command-keys) |
| 1309 | (if (= c ?\C-u) |
| 1310 | (progn |
| 1311 | (and (arrayp pass) (clear-string pass)) |
| 1312 | (setq pass "")) |
| 1313 | (if (and (/= c ?\b) (/= c ?\177)) |
| 1314 | (let* ((new-char (char-to-string c)) |
| 1315 | (new-pass (concat pass new-char))) |
| 1316 | (and (arrayp pass) (clear-string pass)) |
| 1317 | (clear-string new-char) |
| 1318 | (setq c ?\0) |
| 1319 | (setq pass new-pass)) |
| 1320 | (if (> (length pass) 0) |
| 1321 | (let ((new-pass (substring pass 0 -1))) |
| 1322 | (and (arrayp pass) (clear-string pass)) |
| 1323 | (setq pass new-pass)))))) |
| 1324 | (message nil) |
| 1325 | (or pass default "")))) |
| 1326 | |
| 1327 | ;; This should be used by `call-interactively' for `n' specs. |
| 1328 | (defun read-number (prompt &optional default) |
| 1329 | (let ((n nil)) |
| 1330 | (when default |
| 1331 | (setq prompt |
| 1332 | (if (string-match "\\(\\):[^:]*" prompt) |
| 1333 | (replace-match (format " [%s]" default) t t prompt 1) |
| 1334 | (concat prompt (format " [%s] " default))))) |
| 1335 | (while |
| 1336 | (progn |
| 1337 | (let ((str (read-from-minibuffer prompt nil nil nil nil |
| 1338 | (and default |
| 1339 | (number-to-string default))))) |
| 1340 | (setq n (cond |
| 1341 | ((zerop (length str)) default) |
| 1342 | ((stringp str) (read str))))) |
| 1343 | (unless (numberp n) |
| 1344 | (message "Please enter a number.") |
| 1345 | (sit-for 1) |
| 1346 | t))) |
| 1347 | n)) |
| 1348 | \f |
| 1349 | ;;; Atomic change groups. |
| 1350 | |
| 1351 | (defmacro atomic-change-group (&rest body) |
| 1352 | "Perform BODY as an atomic change group. |
| 1353 | This means that if BODY exits abnormally, |
| 1354 | all of its changes to the current buffer are undone. |
| 1355 | This works regardless of whether undo is enabled in the buffer. |
| 1356 | |
| 1357 | This mechanism is transparent to ordinary use of undo; |
| 1358 | if undo is enabled in the buffer and BODY succeeds, the |
| 1359 | user can undo the change normally." |
| 1360 | (let ((handle (make-symbol "--change-group-handle--")) |
| 1361 | (success (make-symbol "--change-group-success--"))) |
| 1362 | `(let ((,handle (prepare-change-group)) |
| 1363 | (,success nil)) |
| 1364 | (unwind-protect |
| 1365 | (progn |
| 1366 | ;; This is inside the unwind-protect because |
| 1367 | ;; it enables undo if that was disabled; we need |
| 1368 | ;; to make sure that it gets disabled again. |
| 1369 | (activate-change-group ,handle) |
| 1370 | ,@body |
| 1371 | (setq ,success t)) |
| 1372 | ;; Either of these functions will disable undo |
| 1373 | ;; if it was disabled before. |
| 1374 | (if ,success |
| 1375 | (accept-change-group ,handle) |
| 1376 | (cancel-change-group ,handle)))))) |
| 1377 | |
| 1378 | (defun prepare-change-group (&optional buffer) |
| 1379 | "Return a handle for the current buffer's state, for a change group. |
| 1380 | If you specify BUFFER, make a handle for BUFFER's state instead. |
| 1381 | |
| 1382 | Pass the handle to `activate-change-group' afterward to initiate |
| 1383 | the actual changes of the change group. |
| 1384 | |
| 1385 | To finish the change group, call either `accept-change-group' or |
| 1386 | `cancel-change-group' passing the same handle as argument. Call |
| 1387 | `accept-change-group' to accept the changes in the group as final; |
| 1388 | call `cancel-change-group' to undo them all. You should use |
| 1389 | `unwind-protect' to make sure the group is always finished. The call |
| 1390 | to `activate-change-group' should be inside the `unwind-protect'. |
| 1391 | Once you finish the group, don't use the handle again--don't try to |
| 1392 | finish the same group twice. For a simple example of correct use, see |
| 1393 | the source code of `atomic-change-group'. |
| 1394 | |
| 1395 | The handle records only the specified buffer. To make a multibuffer |
| 1396 | change group, call this function once for each buffer you want to |
| 1397 | cover, then use `nconc' to combine the returned values, like this: |
| 1398 | |
| 1399 | (nconc (prepare-change-group buffer-1) |
| 1400 | (prepare-change-group buffer-2)) |
| 1401 | |
| 1402 | You can then activate that multibuffer change group with a single |
| 1403 | call to `activate-change-group' and finish it with a single call |
| 1404 | to `accept-change-group' or `cancel-change-group'." |
| 1405 | |
| 1406 | (if buffer |
| 1407 | (list (cons buffer (with-current-buffer buffer buffer-undo-list))) |
| 1408 | (list (cons (current-buffer) buffer-undo-list)))) |
| 1409 | |
| 1410 | (defun activate-change-group (handle) |
| 1411 | "Activate a change group made with `prepare-change-group' (which see)." |
| 1412 | (dolist (elt handle) |
| 1413 | (with-current-buffer (car elt) |
| 1414 | (if (eq buffer-undo-list t) |
| 1415 | (setq buffer-undo-list nil))))) |
| 1416 | |
| 1417 | (defun accept-change-group (handle) |
| 1418 | "Finish a change group made with `prepare-change-group' (which see). |
| 1419 | This finishes the change group by accepting its changes as final." |
| 1420 | (dolist (elt handle) |
| 1421 | (with-current-buffer (car elt) |
| 1422 | (if (eq elt t) |
| 1423 | (setq buffer-undo-list t))))) |
| 1424 | |
| 1425 | (defun cancel-change-group (handle) |
| 1426 | "Finish a change group made with `prepare-change-group' (which see). |
| 1427 | This finishes the change group by reverting all of its changes." |
| 1428 | (dolist (elt handle) |
| 1429 | (with-current-buffer (car elt) |
| 1430 | (setq elt (cdr elt)) |
| 1431 | (let ((old-car |
| 1432 | (if (consp elt) (car elt))) |
| 1433 | (old-cdr |
| 1434 | (if (consp elt) (cdr elt)))) |
| 1435 | ;; Temporarily truncate the undo log at ELT. |
| 1436 | (when (consp elt) |
| 1437 | (setcar elt nil) (setcdr elt nil)) |
| 1438 | (unless (eq last-command 'undo) (undo-start)) |
| 1439 | ;; Make sure there's no confusion. |
| 1440 | (when (and (consp elt) (not (eq elt (last pending-undo-list)))) |
| 1441 | (error "Undoing to some unrelated state")) |
| 1442 | ;; Undo it all. |
| 1443 | (while pending-undo-list (undo-more 1)) |
| 1444 | ;; Reset the modified cons cell ELT to its original content. |
| 1445 | (when (consp elt) |
| 1446 | (setcar elt old-car) |
| 1447 | (setcdr elt old-cdr)) |
| 1448 | ;; Revert the undo info to what it was when we grabbed the state. |
| 1449 | (setq buffer-undo-list elt))))) |
| 1450 | \f |
| 1451 | ;; For compatibility. |
| 1452 | (defalias 'redraw-modeline 'force-mode-line-update) |
| 1453 | |
| 1454 | (defun force-mode-line-update (&optional all) |
| 1455 | "Force redisplay of the current buffer's mode line and header line. |
| 1456 | With optional non-nil ALL, force redisplay of all mode lines and |
| 1457 | header lines. This function also forces recomputation of the |
| 1458 | menu bar menus and the frame title." |
| 1459 | (if all (save-excursion (set-buffer (other-buffer)))) |
| 1460 | (set-buffer-modified-p (buffer-modified-p))) |
| 1461 | |
| 1462 | (defun momentary-string-display (string pos &optional exit-char message) |
| 1463 | "Momentarily display STRING in the buffer at POS. |
| 1464 | Display remains until next event is input. |
| 1465 | Optional third arg EXIT-CHAR can be a character, event or event |
| 1466 | description list. EXIT-CHAR defaults to SPC. If the input is |
| 1467 | EXIT-CHAR it is swallowed; otherwise it is then available as |
| 1468 | input (as a command if nothing else). |
| 1469 | Display MESSAGE (optional fourth arg) in the echo area. |
| 1470 | If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there." |
| 1471 | (or exit-char (setq exit-char ?\ )) |
| 1472 | (let ((inhibit-read-only t) |
| 1473 | ;; Don't modify the undo list at all. |
| 1474 | (buffer-undo-list t) |
| 1475 | (modified (buffer-modified-p)) |
| 1476 | (name buffer-file-name) |
| 1477 | insert-end) |
| 1478 | (unwind-protect |
| 1479 | (progn |
| 1480 | (save-excursion |
| 1481 | (goto-char pos) |
| 1482 | ;; defeat file locking... don't try this at home, kids! |
| 1483 | (setq buffer-file-name nil) |
| 1484 | (insert-before-markers string) |
| 1485 | (setq insert-end (point)) |
| 1486 | ;; If the message end is off screen, recenter now. |
| 1487 | (if (< (window-end nil t) insert-end) |
| 1488 | (recenter (/ (window-height) 2))) |
| 1489 | ;; If that pushed message start off the screen, |
| 1490 | ;; scroll to start it at the top of the screen. |
| 1491 | (move-to-window-line 0) |
| 1492 | (if (> (point) pos) |
| 1493 | (progn |
| 1494 | (goto-char pos) |
| 1495 | (recenter 0)))) |
| 1496 | (message (or message "Type %s to continue editing.") |
| 1497 | (single-key-description exit-char)) |
| 1498 | (let (char) |
| 1499 | (if (integerp exit-char) |
| 1500 | (condition-case nil |
| 1501 | (progn |
| 1502 | (setq char (read-char)) |
| 1503 | (or (eq char exit-char) |
| 1504 | (setq unread-command-events (list char)))) |
| 1505 | (error |
| 1506 | ;; `exit-char' is a character, hence it differs |
| 1507 | ;; from char, which is an event. |
| 1508 | (setq unread-command-events (list char)))) |
| 1509 | ;; `exit-char' can be an event, or an event description |
| 1510 | ;; list. |
| 1511 | (setq char (read-event)) |
| 1512 | (or (eq char exit-char) |
| 1513 | (eq char (event-convert-list exit-char)) |
| 1514 | (setq unread-command-events (list char)))))) |
| 1515 | (if insert-end |
| 1516 | (save-excursion |
| 1517 | (delete-region pos insert-end))) |
| 1518 | (setq buffer-file-name name) |
| 1519 | (set-buffer-modified-p modified)))) |
| 1520 | |
| 1521 | \f |
| 1522 | ;;;; Overlay operations |
| 1523 | |
| 1524 | (defun copy-overlay (o) |
| 1525 | "Return a copy of overlay O." |
| 1526 | (let ((o1 (make-overlay (overlay-start o) (overlay-end o) |
| 1527 | ;; FIXME: there's no easy way to find the |
| 1528 | ;; insertion-type of the two markers. |
| 1529 | (overlay-buffer o))) |
| 1530 | (props (overlay-properties o))) |
| 1531 | (while props |
| 1532 | (overlay-put o1 (pop props) (pop props))) |
| 1533 | o1)) |
| 1534 | |
| 1535 | (defun remove-overlays (&optional beg end name val) |
| 1536 | "Clear BEG and END of overlays whose property NAME has value VAL. |
| 1537 | Overlays might be moved and/or split. |
| 1538 | BEG and END default respectively to the beginning and end of buffer." |
| 1539 | (unless beg (setq beg (point-min))) |
| 1540 | (unless end (setq end (point-max))) |
| 1541 | (if (< end beg) |
| 1542 | (setq beg (prog1 end (setq end beg)))) |
| 1543 | (save-excursion |
| 1544 | (dolist (o (overlays-in beg end)) |
| 1545 | (when (eq (overlay-get o name) val) |
| 1546 | ;; Either push this overlay outside beg...end |
| 1547 | ;; or split it to exclude beg...end |
| 1548 | ;; or delete it entirely (if it is contained in beg...end). |
| 1549 | (if (< (overlay-start o) beg) |
| 1550 | (if (> (overlay-end o) end) |
| 1551 | (progn |
| 1552 | (move-overlay (copy-overlay o) |
| 1553 | (overlay-start o) beg) |
| 1554 | (move-overlay o end (overlay-end o))) |
| 1555 | (move-overlay o (overlay-start o) beg)) |
| 1556 | (if (> (overlay-end o) end) |
| 1557 | (move-overlay o end (overlay-end o)) |
| 1558 | (delete-overlay o))))))) |
| 1559 | \f |
| 1560 | ;;;; Miscellanea. |
| 1561 | |
| 1562 | ;; A number of major modes set this locally. |
| 1563 | ;; Give it a global value to avoid compiler warnings. |
| 1564 | (defvar font-lock-defaults nil) |
| 1565 | |
| 1566 | (defvar suspend-hook nil |
| 1567 | "Normal hook run by `suspend-emacs', before suspending.") |
| 1568 | |
| 1569 | (defvar suspend-resume-hook nil |
| 1570 | "Normal hook run by `suspend-emacs', after Emacs is continued.") |
| 1571 | |
| 1572 | (defvar temp-buffer-show-hook nil |
| 1573 | "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer. |
| 1574 | When the hook runs, the temporary buffer is current, and the window it |
| 1575 | was displayed in is selected. This hook is normally set up with a |
| 1576 | function to make the buffer read only, and find function names and |
| 1577 | variable names in it, provided the major mode is still Help mode.") |
| 1578 | |
| 1579 | (defvar temp-buffer-setup-hook nil |
| 1580 | "Normal hook run by `with-output-to-temp-buffer' at the start. |
| 1581 | When the hook runs, the temporary buffer is current. |
| 1582 | This hook is normally set up with a function to put the buffer in Help |
| 1583 | mode.") |
| 1584 | |
| 1585 | ;; Avoid compiler warnings about this variable, |
| 1586 | ;; which has a special meaning on certain system types. |
| 1587 | (defvar buffer-file-type nil |
| 1588 | "Non-nil if the visited file is a binary file. |
| 1589 | This variable is meaningful on MS-DOG and Windows NT. |
| 1590 | On those systems, it is automatically local in every buffer. |
| 1591 | On other systems, this variable is normally always nil.") |
| 1592 | |
| 1593 | ;; This should probably be written in C (i.e., without using `walk-windows'). |
| 1594 | (defun get-buffer-window-list (buffer &optional minibuf frame) |
| 1595 | "Return windows currently displaying BUFFER, or nil if none. |
| 1596 | See `walk-windows' for the meaning of MINIBUF and FRAME." |
| 1597 | (let ((buffer (if (bufferp buffer) buffer (get-buffer buffer))) windows) |
| 1598 | (walk-windows (function (lambda (window) |
| 1599 | (if (eq (window-buffer window) buffer) |
| 1600 | (setq windows (cons window windows))))) |
| 1601 | minibuf frame) |
| 1602 | windows)) |
| 1603 | |
| 1604 | (defun ignore (&rest ignore) |
| 1605 | "Do nothing and return nil. |
| 1606 | This function accepts any number of arguments, but ignores them." |
| 1607 | (interactive) |
| 1608 | nil) |
| 1609 | |
| 1610 | (defun error (&rest args) |
| 1611 | "Signal an error, making error message by passing all args to `format'. |
| 1612 | In Emacs, the convention is that error messages start with a capital |
| 1613 | letter but *do not* end with a period. Please follow this convention |
| 1614 | for the sake of consistency." |
| 1615 | (while t |
| 1616 | (signal 'error (list (apply 'format args))))) |
| 1617 | |
| 1618 | (defalias 'user-original-login-name 'user-login-name) |
| 1619 | |
| 1620 | (defvar yank-excluded-properties) |
| 1621 | |
| 1622 | (defun remove-yank-excluded-properties (start end) |
| 1623 | "Remove `yank-excluded-properties' between START and END positions. |
| 1624 | Replaces `category' properties with their defined properties." |
| 1625 | (let ((inhibit-read-only t)) |
| 1626 | ;; Replace any `category' property with the properties it stands for. |
| 1627 | (unless (memq yank-excluded-properties '(t nil)) |
| 1628 | (save-excursion |
| 1629 | (goto-char start) |
| 1630 | (while (< (point) end) |
| 1631 | (let ((cat (get-text-property (point) 'category)) |
| 1632 | run-end) |
| 1633 | (setq run-end |
| 1634 | (next-single-property-change (point) 'category nil end)) |
| 1635 | (when cat |
| 1636 | (let (run-end2 original) |
| 1637 | (remove-list-of-text-properties (point) run-end '(category)) |
| 1638 | (while (< (point) run-end) |
| 1639 | (setq run-end2 (next-property-change (point) nil run-end)) |
| 1640 | (setq original (text-properties-at (point))) |
| 1641 | (set-text-properties (point) run-end2 (symbol-plist cat)) |
| 1642 | (add-text-properties (point) run-end2 original) |
| 1643 | (goto-char run-end2)))) |
| 1644 | (goto-char run-end))))) |
| 1645 | (if (eq yank-excluded-properties t) |
| 1646 | (set-text-properties start end nil) |
| 1647 | (remove-list-of-text-properties start end yank-excluded-properties)))) |
| 1648 | |
| 1649 | (defvar yank-undo-function) |
| 1650 | |
| 1651 | (defun insert-for-yank (string) |
| 1652 | "Calls `insert-for-yank-1' repetitively for each `yank-handler' segment. |
| 1653 | |
| 1654 | See `insert-for-yank-1' for more details." |
| 1655 | (let (to) |
| 1656 | (while (setq to (next-single-property-change 0 'yank-handler string)) |
| 1657 | (insert-for-yank-1 (substring string 0 to)) |
| 1658 | (setq string (substring string to)))) |
| 1659 | (insert-for-yank-1 string)) |
| 1660 | |
| 1661 | (defun insert-for-yank-1 (string) |
| 1662 | "Insert STRING at point, stripping some text properties. |
| 1663 | |
| 1664 | Strip text properties from the inserted text according to |
| 1665 | `yank-excluded-properties'. Otherwise just like (insert STRING). |
| 1666 | |
| 1667 | If STRING has a non-nil `yank-handler' property on the first character, |
| 1668 | the normal insert behaviour is modified in various ways. The value of |
| 1669 | the yank-handler property must be a list with one to five elements |
| 1670 | with the following format: (FUNCTION PARAM NOEXCLUDE UNDO). |
| 1671 | When FUNCTION is present and non-nil, it is called instead of `insert' |
| 1672 | to insert the string. FUNCTION takes one argument--the object to insert. |
| 1673 | If PARAM is present and non-nil, it replaces STRING as the object |
| 1674 | passed to FUNCTION (or `insert'); for example, if FUNCTION is |
| 1675 | `yank-rectangle', PARAM may be a list of strings to insert as a |
| 1676 | rectangle. |
| 1677 | If NOEXCLUDE is present and non-nil, the normal removal of the |
| 1678 | yank-excluded-properties is not performed; instead FUNCTION is |
| 1679 | responsible for removing those properties. This may be necessary |
| 1680 | if FUNCTION adjusts point before or after inserting the object. |
| 1681 | If UNDO is present and non-nil, it is a function that will be called |
| 1682 | by `yank-pop' to undo the insertion of the current object. It is |
| 1683 | called with two arguments, the start and end of the current region. |
| 1684 | FUNCTION may set `yank-undo-function' to override the UNDO value." |
| 1685 | (let* ((handler (and (stringp string) |
| 1686 | (get-text-property 0 'yank-handler string))) |
| 1687 | (param (or (nth 1 handler) string)) |
| 1688 | (opoint (point))) |
| 1689 | (setq yank-undo-function t) |
| 1690 | (if (nth 0 handler) ;; FUNCTION |
| 1691 | (funcall (car handler) param) |
| 1692 | (insert param)) |
| 1693 | (unless (nth 2 handler) ;; NOEXCLUDE |
| 1694 | (remove-yank-excluded-properties opoint (point))) |
| 1695 | (if (eq yank-undo-function t) ;; not set by FUNCTION |
| 1696 | (setq yank-undo-function (nth 3 handler))) ;; UNDO |
| 1697 | (if (nth 4 handler) ;; COMMAND |
| 1698 | (setq this-command (nth 4 handler))))) |
| 1699 | |
| 1700 | (defun insert-buffer-substring-no-properties (buffer &optional start end) |
| 1701 | "Insert before point a substring of BUFFER, without text properties. |
| 1702 | BUFFER may be a buffer or a buffer name. |
| 1703 | Arguments START and END are character numbers specifying the substring. |
| 1704 | They default to the beginning and the end of BUFFER." |
| 1705 | (let ((opoint (point))) |
| 1706 | (insert-buffer-substring buffer start end) |
| 1707 | (let ((inhibit-read-only t)) |
| 1708 | (set-text-properties opoint (point) nil)))) |
| 1709 | |
| 1710 | (defun insert-buffer-substring-as-yank (buffer &optional start end) |
| 1711 | "Insert before point a part of BUFFER, stripping some text properties. |
| 1712 | BUFFER may be a buffer or a buffer name. |
| 1713 | Arguments START and END are character numbers specifying the substring. |
| 1714 | They default to the beginning and the end of BUFFER. |
| 1715 | Strip text properties from the inserted text according to |
| 1716 | `yank-excluded-properties'." |
| 1717 | ;; Since the buffer text should not normally have yank-handler properties, |
| 1718 | ;; there is no need to handle them here. |
| 1719 | (let ((opoint (point))) |
| 1720 | (insert-buffer-substring buffer start end) |
| 1721 | (remove-yank-excluded-properties opoint (point)))) |
| 1722 | |
| 1723 | \f |
| 1724 | ;; Synchronous shell commands. |
| 1725 | |
| 1726 | (defun start-process-shell-command (name buffer &rest args) |
| 1727 | "Start a program in a subprocess. Return the process object for it. |
| 1728 | Args are NAME BUFFER COMMAND &rest COMMAND-ARGS. |
| 1729 | NAME is name for process. It is modified if necessary to make it unique. |
| 1730 | BUFFER is the buffer or (buffer-name) to associate with the process. |
| 1731 | Process output goes at end of that buffer, unless you specify |
| 1732 | an output stream or filter function to handle the output. |
| 1733 | BUFFER may be also nil, meaning that this process is not associated |
| 1734 | with any buffer |
| 1735 | Third arg is command name, the name of a shell command. |
| 1736 | Remaining arguments are the arguments for the command. |
| 1737 | Wildcards and redirection are handled as usual in the shell." |
| 1738 | (cond |
| 1739 | ((eq system-type 'vax-vms) |
| 1740 | (apply 'start-process name buffer args)) |
| 1741 | ;; We used to use `exec' to replace the shell with the command, |
| 1742 | ;; but that failed to handle (...) and semicolon, etc. |
| 1743 | (t |
| 1744 | (start-process name buffer shell-file-name shell-command-switch |
| 1745 | (mapconcat 'identity args " "))))) |
| 1746 | |
| 1747 | (defun call-process-shell-command (command &optional infile buffer display |
| 1748 | &rest args) |
| 1749 | "Execute the shell command COMMAND synchronously in separate process. |
| 1750 | The remaining arguments are optional. |
| 1751 | The program's input comes from file INFILE (nil means `/dev/null'). |
| 1752 | Insert output in BUFFER before point; t means current buffer; |
| 1753 | nil for BUFFER means discard it; 0 means discard and don't wait. |
| 1754 | BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case, |
| 1755 | REAL-BUFFER says what to do with standard output, as above, |
| 1756 | while STDERR-FILE says what to do with standard error in the child. |
| 1757 | STDERR-FILE may be nil (discard standard error output), |
| 1758 | t (mix it with ordinary output), or a file name string. |
| 1759 | |
| 1760 | Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted. |
| 1761 | Remaining arguments are strings passed as additional arguments for COMMAND. |
| 1762 | Wildcards and redirection are handled as usual in the shell. |
| 1763 | |
| 1764 | If BUFFER is 0, `call-process-shell-command' returns immediately with value nil. |
| 1765 | Otherwise it waits for COMMAND to terminate and returns a numeric exit |
| 1766 | status or a signal description string. |
| 1767 | If you quit, the process is killed with SIGINT, or SIGKILL if you quit again." |
| 1768 | (cond |
| 1769 | ((eq system-type 'vax-vms) |
| 1770 | (apply 'call-process command infile buffer display args)) |
| 1771 | ;; We used to use `exec' to replace the shell with the command, |
| 1772 | ;; but that failed to handle (...) and semicolon, etc. |
| 1773 | (t |
| 1774 | (call-process shell-file-name |
| 1775 | infile buffer display |
| 1776 | shell-command-switch |
| 1777 | (mapconcat 'identity (cons command args) " "))))) |
| 1778 | \f |
| 1779 | (defmacro with-current-buffer (buffer &rest body) |
| 1780 | "Execute the forms in BODY with BUFFER as the current buffer. |
| 1781 | The value returned is the value of the last form in BODY. |
| 1782 | See also `with-temp-buffer'." |
| 1783 | (declare (indent 1) (debug t)) |
| 1784 | `(save-current-buffer |
| 1785 | (set-buffer ,buffer) |
| 1786 | ,@body)) |
| 1787 | |
| 1788 | (defmacro with-selected-window (window &rest body) |
| 1789 | "Execute the forms in BODY with WINDOW as the selected window. |
| 1790 | The value returned is the value of the last form in BODY. |
| 1791 | This does not alter the buffer list ordering. |
| 1792 | See also `with-temp-buffer'." |
| 1793 | (declare (indent 1) (debug t)) |
| 1794 | ;; Most of this code is a copy of save-selected-window. |
| 1795 | `(let ((save-selected-window-window (selected-window)) |
| 1796 | (save-selected-window-alist |
| 1797 | (mapcar (lambda (frame) (list frame (frame-selected-window frame))) |
| 1798 | (frame-list)))) |
| 1799 | (unwind-protect |
| 1800 | (progn (select-window ,window 'norecord) |
| 1801 | ,@body) |
| 1802 | (dolist (elt save-selected-window-alist) |
| 1803 | (and (frame-live-p (car elt)) |
| 1804 | (window-live-p (cadr elt)) |
| 1805 | (set-frame-selected-window (car elt) (cadr elt)))) |
| 1806 | (if (window-live-p save-selected-window-window) |
| 1807 | ;; This is where the code differs from save-selected-window. |
| 1808 | (select-window save-selected-window-window 'norecord))))) |
| 1809 | |
| 1810 | (defmacro with-temp-file (file &rest body) |
| 1811 | "Create a new buffer, evaluate BODY there, and write the buffer to FILE. |
| 1812 | The value returned is the value of the last form in BODY. |
| 1813 | See also `with-temp-buffer'." |
| 1814 | (declare (debug t)) |
| 1815 | (let ((temp-file (make-symbol "temp-file")) |
| 1816 | (temp-buffer (make-symbol "temp-buffer"))) |
| 1817 | `(let ((,temp-file ,file) |
| 1818 | (,temp-buffer |
| 1819 | (get-buffer-create (generate-new-buffer-name " *temp file*")))) |
| 1820 | (unwind-protect |
| 1821 | (prog1 |
| 1822 | (with-current-buffer ,temp-buffer |
| 1823 | ,@body) |
| 1824 | (with-current-buffer ,temp-buffer |
| 1825 | (widen) |
| 1826 | (write-region (point-min) (point-max) ,temp-file nil 0))) |
| 1827 | (and (buffer-name ,temp-buffer) |
| 1828 | (kill-buffer ,temp-buffer)))))) |
| 1829 | |
| 1830 | (defmacro with-temp-message (message &rest body) |
| 1831 | "Display MESSAGE temporarily if non-nil while BODY is evaluated. |
| 1832 | The original message is restored to the echo area after BODY has finished. |
| 1833 | The value returned is the value of the last form in BODY. |
| 1834 | MESSAGE is written to the message log buffer if `message-log-max' is non-nil. |
| 1835 | If MESSAGE is nil, the echo area and message log buffer are unchanged. |
| 1836 | Use a MESSAGE of \"\" to temporarily clear the echo area." |
| 1837 | (declare (debug t)) |
| 1838 | (let ((current-message (make-symbol "current-message")) |
| 1839 | (temp-message (make-symbol "with-temp-message"))) |
| 1840 | `(let ((,temp-message ,message) |
| 1841 | (,current-message)) |
| 1842 | (unwind-protect |
| 1843 | (progn |
| 1844 | (when ,temp-message |
| 1845 | (setq ,current-message (current-message)) |
| 1846 | (message "%s" ,temp-message)) |
| 1847 | ,@body) |
| 1848 | (and ,temp-message |
| 1849 | (if ,current-message |
| 1850 | (message "%s" ,current-message) |
| 1851 | (message nil))))))) |
| 1852 | |
| 1853 | (defmacro with-temp-buffer (&rest body) |
| 1854 | "Create a temporary buffer, and evaluate BODY there like `progn'. |
| 1855 | See also `with-temp-file' and `with-output-to-string'." |
| 1856 | (declare (indent 0) (debug t)) |
| 1857 | (let ((temp-buffer (make-symbol "temp-buffer"))) |
| 1858 | `(let ((,temp-buffer |
| 1859 | (get-buffer-create (generate-new-buffer-name " *temp*")))) |
| 1860 | (unwind-protect |
| 1861 | (with-current-buffer ,temp-buffer |
| 1862 | ,@body) |
| 1863 | (and (buffer-name ,temp-buffer) |
| 1864 | (kill-buffer ,temp-buffer)))))) |
| 1865 | |
| 1866 | (defmacro with-output-to-string (&rest body) |
| 1867 | "Execute BODY, return the text it sent to `standard-output', as a string." |
| 1868 | (declare (indent 0) (debug t)) |
| 1869 | `(let ((standard-output |
| 1870 | (get-buffer-create (generate-new-buffer-name " *string-output*")))) |
| 1871 | (let ((standard-output standard-output)) |
| 1872 | ,@body) |
| 1873 | (with-current-buffer standard-output |
| 1874 | (prog1 |
| 1875 | (buffer-string) |
| 1876 | (kill-buffer nil))))) |
| 1877 | |
| 1878 | (defmacro with-local-quit (&rest body) |
| 1879 | "Execute BODY with `inhibit-quit' temporarily bound to nil." |
| 1880 | (declare (debug t) (indent 0)) |
| 1881 | `(condition-case nil |
| 1882 | (let ((inhibit-quit nil)) |
| 1883 | ,@body) |
| 1884 | (quit (setq quit-flag t)))) |
| 1885 | |
| 1886 | (defmacro combine-after-change-calls (&rest body) |
| 1887 | "Execute BODY, but don't call the after-change functions till the end. |
| 1888 | If BODY makes changes in the buffer, they are recorded |
| 1889 | and the functions on `after-change-functions' are called several times |
| 1890 | when BODY is finished. |
| 1891 | The return value is the value of the last form in BODY. |
| 1892 | |
| 1893 | If `before-change-functions' is non-nil, then calls to the after-change |
| 1894 | functions can't be deferred, so in that case this macro has no effect. |
| 1895 | |
| 1896 | Do not alter `after-change-functions' or `before-change-functions' |
| 1897 | in BODY." |
| 1898 | (declare (indent 0) (debug t)) |
| 1899 | `(unwind-protect |
| 1900 | (let ((combine-after-change-calls t)) |
| 1901 | . ,body) |
| 1902 | (combine-after-change-execute))) |
| 1903 | |
| 1904 | |
| 1905 | (defvar delay-mode-hooks nil |
| 1906 | "If non-nil, `run-mode-hooks' should delay running the hooks.") |
| 1907 | (defvar delayed-mode-hooks nil |
| 1908 | "List of delayed mode hooks waiting to be run.") |
| 1909 | (make-variable-buffer-local 'delayed-mode-hooks) |
| 1910 | (put 'delay-mode-hooks 'permanent-local t) |
| 1911 | |
| 1912 | (defun run-mode-hooks (&rest hooks) |
| 1913 | "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS. |
| 1914 | Execution is delayed if `delay-mode-hooks' is non-nil. |
| 1915 | Major mode functions should use this." |
| 1916 | (if delay-mode-hooks |
| 1917 | ;; Delaying case. |
| 1918 | (dolist (hook hooks) |
| 1919 | (push hook delayed-mode-hooks)) |
| 1920 | ;; Normal case, just run the hook as before plus any delayed hooks. |
| 1921 | (setq hooks (nconc (nreverse delayed-mode-hooks) hooks)) |
| 1922 | (setq delayed-mode-hooks nil) |
| 1923 | (apply 'run-hooks hooks))) |
| 1924 | |
| 1925 | (defmacro delay-mode-hooks (&rest body) |
| 1926 | "Execute BODY, but delay any `run-mode-hooks'. |
| 1927 | Only affects hooks run in the current buffer." |
| 1928 | (declare (debug t)) |
| 1929 | `(progn |
| 1930 | (make-local-variable 'delay-mode-hooks) |
| 1931 | (let ((delay-mode-hooks t)) |
| 1932 | ,@body))) |
| 1933 | |
| 1934 | ;; PUBLIC: find if the current mode derives from another. |
| 1935 | |
| 1936 | (defun derived-mode-p (&rest modes) |
| 1937 | "Non-nil if the current major mode is derived from one of MODES. |
| 1938 | Uses the `derived-mode-parent' property of the symbol to trace backwards." |
| 1939 | (let ((parent major-mode)) |
| 1940 | (while (and (not (memq parent modes)) |
| 1941 | (setq parent (get parent 'derived-mode-parent)))) |
| 1942 | parent)) |
| 1943 | |
| 1944 | (defmacro with-syntax-table (table &rest body) |
| 1945 | "Evaluate BODY with syntax table of current buffer set to TABLE. |
| 1946 | The syntax table of the current buffer is saved, BODY is evaluated, and the |
| 1947 | saved table is restored, even in case of an abnormal exit. |
| 1948 | Value is what BODY returns." |
| 1949 | (declare (debug t)) |
| 1950 | (let ((old-table (make-symbol "table")) |
| 1951 | (old-buffer (make-symbol "buffer"))) |
| 1952 | `(let ((,old-table (syntax-table)) |
| 1953 | (,old-buffer (current-buffer))) |
| 1954 | (unwind-protect |
| 1955 | (progn |
| 1956 | (set-syntax-table ,table) |
| 1957 | ,@body) |
| 1958 | (save-current-buffer |
| 1959 | (set-buffer ,old-buffer) |
| 1960 | (set-syntax-table ,old-table)))))) |
| 1961 | |
| 1962 | (defmacro dynamic-completion-table (fun) |
| 1963 | "Use function FUN as a dynamic completion table. |
| 1964 | FUN is called with one argument, the string for which completion is required, |
| 1965 | and it should return an alist containing all the intended possible |
| 1966 | completions. This alist may be a full list of possible completions so that FUN |
| 1967 | can ignore the value of its argument. If completion is performed in the |
| 1968 | minibuffer, FUN will be called in the buffer from which the minibuffer was |
| 1969 | entered. |
| 1970 | |
| 1971 | The result of the `dynamic-completion-table' form is a function |
| 1972 | that can be used as the ALIST argument to `try-completion' and |
| 1973 | `all-completion'. See Info node `(elisp)Programmed Completion'." |
| 1974 | (let ((win (make-symbol "window")) |
| 1975 | (string (make-symbol "string")) |
| 1976 | (predicate (make-symbol "predicate")) |
| 1977 | (mode (make-symbol "mode"))) |
| 1978 | `(lambda (,string ,predicate ,mode) |
| 1979 | (with-current-buffer (let ((,win (minibuffer-selected-window))) |
| 1980 | (if (window-live-p ,win) (window-buffer ,win) |
| 1981 | (current-buffer))) |
| 1982 | (cond |
| 1983 | ((eq ,mode t) (all-completions ,string (,fun ,string) ,predicate)) |
| 1984 | ((not ,mode) (try-completion ,string (,fun ,string) ,predicate)) |
| 1985 | (t (test-completion ,string (,fun ,string) ,predicate))))))) |
| 1986 | |
| 1987 | (defmacro lazy-completion-table (var fun &rest args) |
| 1988 | "Initialize variable VAR as a lazy completion table. |
| 1989 | If the completion table VAR is used for the first time (e.g., by passing VAR |
| 1990 | as an argument to `try-completion'), the function FUN is called with arguments |
| 1991 | ARGS. FUN must return the completion table that will be stored in VAR. |
| 1992 | If completion is requested in the minibuffer, FUN will be called in the buffer |
| 1993 | from which the minibuffer was entered. The return value of |
| 1994 | `lazy-completion-table' must be used to initialize the value of VAR." |
| 1995 | (let ((str (make-symbol "string"))) |
| 1996 | `(dynamic-completion-table |
| 1997 | (lambda (,str) |
| 1998 | (unless (listp ,var) |
| 1999 | (setq ,var (funcall ',fun ,@args))) |
| 2000 | ,var)))) |
| 2001 | \f |
| 2002 | ;;; Matching and substitution |
| 2003 | |
| 2004 | (defvar save-match-data-internal) |
| 2005 | |
| 2006 | ;; We use save-match-data-internal as the local variable because |
| 2007 | ;; that works ok in practice (people should not use that variable elsewhere). |
| 2008 | ;; We used to use an uninterned symbol; the compiler handles that properly |
| 2009 | ;; now, but it generates slower code. |
| 2010 | (defmacro save-match-data (&rest body) |
| 2011 | "Execute the BODY forms, restoring the global value of the match data. |
| 2012 | The value returned is the value of the last form in BODY." |
| 2013 | ;; It is better not to use backquote here, |
| 2014 | ;; because that makes a bootstrapping problem |
| 2015 | ;; if you need to recompile all the Lisp files using interpreted code. |
| 2016 | (declare (indent 0) (debug t)) |
| 2017 | (list 'let |
| 2018 | '((save-match-data-internal (match-data))) |
| 2019 | (list 'unwind-protect |
| 2020 | (cons 'progn body) |
| 2021 | '(set-match-data save-match-data-internal)))) |
| 2022 | |
| 2023 | (defun match-string (num &optional string) |
| 2024 | "Return string of text matched by last search. |
| 2025 | NUM specifies which parenthesized expression in the last regexp. |
| 2026 | Value is nil if NUMth pair didn't match, or there were less than NUM pairs. |
| 2027 | Zero means the entire text matched by the whole regexp or whole string. |
| 2028 | STRING should be given if the last search was by `string-match' on STRING." |
| 2029 | (if (match-beginning num) |
| 2030 | (if string |
| 2031 | (substring string (match-beginning num) (match-end num)) |
| 2032 | (buffer-substring (match-beginning num) (match-end num))))) |
| 2033 | |
| 2034 | (defun match-string-no-properties (num &optional string) |
| 2035 | "Return string of text matched by last search, without text properties. |
| 2036 | NUM specifies which parenthesized expression in the last regexp. |
| 2037 | Value is nil if NUMth pair didn't match, or there were less than NUM pairs. |
| 2038 | Zero means the entire text matched by the whole regexp or whole string. |
| 2039 | STRING should be given if the last search was by `string-match' on STRING." |
| 2040 | (if (match-beginning num) |
| 2041 | (if string |
| 2042 | (substring-no-properties string (match-beginning num) |
| 2043 | (match-end num)) |
| 2044 | (buffer-substring-no-properties (match-beginning num) |
| 2045 | (match-end num))))) |
| 2046 | |
| 2047 | (defun looking-back (regexp &optional limit) |
| 2048 | "Return non-nil if text before point matches regular expression REGEXP. |
| 2049 | Like `looking-at' except backwards and slower. |
| 2050 | LIMIT if non-nil speeds up the search by specifying how far back the |
| 2051 | match can start." |
| 2052 | (save-excursion |
| 2053 | (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t))) |
| 2054 | |
| 2055 | (defconst split-string-default-separators "[ \f\t\n\r\v]+" |
| 2056 | "The default value of separators for `split-string'. |
| 2057 | |
| 2058 | A regexp matching strings of whitespace. May be locale-dependent |
| 2059 | \(as yet unimplemented). Should not match non-breaking spaces. |
| 2060 | |
| 2061 | Warning: binding this to a different value and using it as default is |
| 2062 | likely to have undesired semantics.") |
| 2063 | |
| 2064 | ;; The specification says that if both SEPARATORS and OMIT-NULLS are |
| 2065 | ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical |
| 2066 | ;; expression leads to the equivalent implementation that if SEPARATORS |
| 2067 | ;; is defaulted, OMIT-NULLS is treated as t. |
| 2068 | (defun split-string (string &optional separators omit-nulls) |
| 2069 | "Splits STRING into substrings bounded by matches for SEPARATORS. |
| 2070 | |
| 2071 | The beginning and end of STRING, and each match for SEPARATORS, are |
| 2072 | splitting points. The substrings matching SEPARATORS are removed, and |
| 2073 | the substrings between the splitting points are collected as a list, |
| 2074 | which is returned. |
| 2075 | |
| 2076 | If SEPARATORS is non-nil, it should be a regular expression matching text |
| 2077 | which separates, but is not part of, the substrings. If nil it defaults to |
| 2078 | `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and |
| 2079 | OMIT-NULLS is forced to t. |
| 2080 | |
| 2081 | If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so |
| 2082 | that for the default value of SEPARATORS leading and trailing whitespace |
| 2083 | are effectively trimmed). If nil, all zero-length substrings are retained, |
| 2084 | which correctly parses CSV format, for example. |
| 2085 | |
| 2086 | Note that the effect of `(split-string STRING)' is the same as |
| 2087 | `(split-string STRING split-string-default-separators t)'). In the rare |
| 2088 | case that you wish to retain zero-length substrings when splitting on |
| 2089 | whitespace, use `(split-string STRING split-string-default-separators)'. |
| 2090 | |
| 2091 | Modifies the match data; use `save-match-data' if necessary." |
| 2092 | (let ((keep-nulls (not (if separators omit-nulls t))) |
| 2093 | (rexp (or separators split-string-default-separators)) |
| 2094 | (start 0) |
| 2095 | notfirst |
| 2096 | (list nil)) |
| 2097 | (while (and (string-match rexp string |
| 2098 | (if (and notfirst |
| 2099 | (= start (match-beginning 0)) |
| 2100 | (< start (length string))) |
| 2101 | (1+ start) start)) |
| 2102 | (< start (length string))) |
| 2103 | (setq notfirst t) |
| 2104 | (if (or keep-nulls (< start (match-beginning 0))) |
| 2105 | (setq list |
| 2106 | (cons (substring string start (match-beginning 0)) |
| 2107 | list))) |
| 2108 | (setq start (match-end 0))) |
| 2109 | (if (or keep-nulls (< start (length string))) |
| 2110 | (setq list |
| 2111 | (cons (substring string start) |
| 2112 | list))) |
| 2113 | (nreverse list))) |
| 2114 | |
| 2115 | (defun subst-char-in-string (fromchar tochar string &optional inplace) |
| 2116 | "Replace FROMCHAR with TOCHAR in STRING each time it occurs. |
| 2117 | Unless optional argument INPLACE is non-nil, return a new string." |
| 2118 | (let ((i (length string)) |
| 2119 | (newstr (if inplace string (copy-sequence string)))) |
| 2120 | (while (> i 0) |
| 2121 | (setq i (1- i)) |
| 2122 | (if (eq (aref newstr i) fromchar) |
| 2123 | (aset newstr i tochar))) |
| 2124 | newstr)) |
| 2125 | |
| 2126 | (defun replace-regexp-in-string (regexp rep string &optional |
| 2127 | fixedcase literal subexp start) |
| 2128 | "Replace all matches for REGEXP with REP in STRING. |
| 2129 | |
| 2130 | Return a new string containing the replacements. |
| 2131 | |
| 2132 | Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the |
| 2133 | arguments with the same names of function `replace-match'. If START |
| 2134 | is non-nil, start replacements at that index in STRING. |
| 2135 | |
| 2136 | REP is either a string used as the NEWTEXT arg of `replace-match' or a |
| 2137 | function. If it is a function it is applied to each match to generate |
| 2138 | the replacement passed to `replace-match'; the match-data at this |
| 2139 | point are such that match 0 is the function's argument. |
| 2140 | |
| 2141 | To replace only the first match (if any), make REGEXP match up to \\' |
| 2142 | and replace a sub-expression, e.g. |
| 2143 | (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1) |
| 2144 | => \" bar foo\" |
| 2145 | " |
| 2146 | |
| 2147 | ;; To avoid excessive consing from multiple matches in long strings, |
| 2148 | ;; don't just call `replace-match' continually. Walk down the |
| 2149 | ;; string looking for matches of REGEXP and building up a (reversed) |
| 2150 | ;; list MATCHES. This comprises segments of STRING which weren't |
| 2151 | ;; matched interspersed with replacements for segments that were. |
| 2152 | ;; [For a `large' number of replacements it's more efficient to |
| 2153 | ;; operate in a temporary buffer; we can't tell from the function's |
| 2154 | ;; args whether to choose the buffer-based implementation, though it |
| 2155 | ;; might be reasonable to do so for long enough STRING.] |
| 2156 | (let ((l (length string)) |
| 2157 | (start (or start 0)) |
| 2158 | matches str mb me) |
| 2159 | (save-match-data |
| 2160 | (while (and (< start l) (string-match regexp string start)) |
| 2161 | (setq mb (match-beginning 0) |
| 2162 | me (match-end 0)) |
| 2163 | ;; If we matched the empty string, make sure we advance by one char |
| 2164 | (when (= me mb) (setq me (min l (1+ mb)))) |
| 2165 | ;; Generate a replacement for the matched substring. |
| 2166 | ;; Operate only on the substring to minimize string consing. |
| 2167 | ;; Set up match data for the substring for replacement; |
| 2168 | ;; presumably this is likely to be faster than munging the |
| 2169 | ;; match data directly in Lisp. |
| 2170 | (string-match regexp (setq str (substring string mb me))) |
| 2171 | (setq matches |
| 2172 | (cons (replace-match (if (stringp rep) |
| 2173 | rep |
| 2174 | (funcall rep (match-string 0 str))) |
| 2175 | fixedcase literal str subexp) |
| 2176 | (cons (substring string start mb) ; unmatched prefix |
| 2177 | matches))) |
| 2178 | (setq start me)) |
| 2179 | ;; Reconstruct a string from the pieces. |
| 2180 | (setq matches (cons (substring string start l) matches)) ; leftover |
| 2181 | (apply #'concat (nreverse matches))))) |
| 2182 | \f |
| 2183 | (defun shell-quote-argument (argument) |
| 2184 | "Quote an argument for passing as argument to an inferior shell." |
| 2185 | (if (eq system-type 'ms-dos) |
| 2186 | ;; Quote using double quotes, but escape any existing quotes in |
| 2187 | ;; the argument with backslashes. |
| 2188 | (let ((result "") |
| 2189 | (start 0) |
| 2190 | end) |
| 2191 | (if (or (null (string-match "[^\"]" argument)) |
| 2192 | (< (match-end 0) (length argument))) |
| 2193 | (while (string-match "[\"]" argument start) |
| 2194 | (setq end (match-beginning 0) |
| 2195 | result (concat result (substring argument start end) |
| 2196 | "\\" (substring argument end (1+ end))) |
| 2197 | start (1+ end)))) |
| 2198 | (concat "\"" result (substring argument start) "\"")) |
| 2199 | (if (eq system-type 'windows-nt) |
| 2200 | (concat "\"" argument "\"") |
| 2201 | (if (equal argument "") |
| 2202 | "''" |
| 2203 | ;; Quote everything except POSIX filename characters. |
| 2204 | ;; This should be safe enough even for really weird shells. |
| 2205 | (let ((result "") (start 0) end) |
| 2206 | (while (string-match "[^-0-9a-zA-Z_./]" argument start) |
| 2207 | (setq end (match-beginning 0) |
| 2208 | result (concat result (substring argument start end) |
| 2209 | "\\" (substring argument end (1+ end))) |
| 2210 | start (1+ end))) |
| 2211 | (concat result (substring argument start))))))) |
| 2212 | |
| 2213 | (defun make-syntax-table (&optional oldtable) |
| 2214 | "Return a new syntax table. |
| 2215 | Create a syntax table which inherits from OLDTABLE (if non-nil) or |
| 2216 | from `standard-syntax-table' otherwise." |
| 2217 | (let ((table (make-char-table 'syntax-table nil))) |
| 2218 | (set-char-table-parent table (or oldtable (standard-syntax-table))) |
| 2219 | table)) |
| 2220 | |
| 2221 | (defun syntax-after (pos) |
| 2222 | "Return the syntax of the char after POS." |
| 2223 | (unless (or (< pos (point-min)) (>= pos (point-max))) |
| 2224 | (let ((st (if parse-sexp-lookup-properties |
| 2225 | (get-char-property pos 'syntax-table)))) |
| 2226 | (if (consp st) st |
| 2227 | (aref (or st (syntax-table)) (char-after pos)))))) |
| 2228 | |
| 2229 | (defun add-to-invisibility-spec (arg) |
| 2230 | "Add elements to `buffer-invisibility-spec'. |
| 2231 | See documentation for `buffer-invisibility-spec' for the kind of elements |
| 2232 | that can be added." |
| 2233 | (if (eq buffer-invisibility-spec t) |
| 2234 | (setq buffer-invisibility-spec (list t))) |
| 2235 | (setq buffer-invisibility-spec |
| 2236 | (cons arg buffer-invisibility-spec))) |
| 2237 | |
| 2238 | (defun remove-from-invisibility-spec (arg) |
| 2239 | "Remove elements from `buffer-invisibility-spec'." |
| 2240 | (if (consp buffer-invisibility-spec) |
| 2241 | (setq buffer-invisibility-spec (delete arg buffer-invisibility-spec)))) |
| 2242 | \f |
| 2243 | (defun global-set-key (key command) |
| 2244 | "Give KEY a global binding as COMMAND. |
| 2245 | COMMAND is the command definition to use; usually it is |
| 2246 | a symbol naming an interactively-callable function. |
| 2247 | KEY is a key sequence; noninteractively, it is a string or vector |
| 2248 | of characters or event types, and non-ASCII characters with codes |
| 2249 | above 127 (such as ISO Latin-1) can be included if you use a vector. |
| 2250 | |
| 2251 | Note that if KEY has a local binding in the current buffer, |
| 2252 | that local binding will continue to shadow any global binding |
| 2253 | that you make with this function." |
| 2254 | (interactive "KSet key globally: \nCSet key %s to command: ") |
| 2255 | (or (vectorp key) (stringp key) |
| 2256 | (signal 'wrong-type-argument (list 'arrayp key))) |
| 2257 | (define-key (current-global-map) key command)) |
| 2258 | |
| 2259 | (defun local-set-key (key command) |
| 2260 | "Give KEY a local binding as COMMAND. |
| 2261 | COMMAND is the command definition to use; usually it is |
| 2262 | a symbol naming an interactively-callable function. |
| 2263 | KEY is a key sequence; noninteractively, it is a string or vector |
| 2264 | of characters or event types, and non-ASCII characters with codes |
| 2265 | above 127 (such as ISO Latin-1) can be included if you use a vector. |
| 2266 | |
| 2267 | The binding goes in the current buffer's local map, |
| 2268 | which in most cases is shared with all other buffers in the same major mode." |
| 2269 | (interactive "KSet key locally: \nCSet key %s locally to command: ") |
| 2270 | (let ((map (current-local-map))) |
| 2271 | (or map |
| 2272 | (use-local-map (setq map (make-sparse-keymap)))) |
| 2273 | (or (vectorp key) (stringp key) |
| 2274 | (signal 'wrong-type-argument (list 'arrayp key))) |
| 2275 | (define-key map key command))) |
| 2276 | |
| 2277 | (defun global-unset-key (key) |
| 2278 | "Remove global binding of KEY. |
| 2279 | KEY is a string representing a sequence of keystrokes." |
| 2280 | (interactive "kUnset key globally: ") |
| 2281 | (global-set-key key nil)) |
| 2282 | |
| 2283 | (defun local-unset-key (key) |
| 2284 | "Remove local binding of KEY. |
| 2285 | KEY is a string representing a sequence of keystrokes." |
| 2286 | (interactive "kUnset key locally: ") |
| 2287 | (if (current-local-map) |
| 2288 | (local-set-key key nil)) |
| 2289 | nil) |
| 2290 | \f |
| 2291 | ;; We put this here instead of in frame.el so that it's defined even on |
| 2292 | ;; systems where frame.el isn't loaded. |
| 2293 | (defun frame-configuration-p (object) |
| 2294 | "Return non-nil if OBJECT seems to be a frame configuration. |
| 2295 | Any list whose car is `frame-configuration' is assumed to be a frame |
| 2296 | configuration." |
| 2297 | (and (consp object) |
| 2298 | (eq (car object) 'frame-configuration))) |
| 2299 | |
| 2300 | (defun functionp (object) |
| 2301 | "Non-nil if OBJECT is any kind of function or a special form. |
| 2302 | Also non-nil if OBJECT is a symbol and its function definition is |
| 2303 | \(recursively) a function or special form. This does not include |
| 2304 | macros." |
| 2305 | (or (and (symbolp object) (fboundp object) |
| 2306 | (condition-case nil |
| 2307 | (setq object (indirect-function object)) |
| 2308 | (error nil)) |
| 2309 | (eq (car-safe object) 'autoload) |
| 2310 | (not (car-safe (cdr-safe (cdr-safe (cdr-safe (cdr-safe object))))))) |
| 2311 | (subrp object) (byte-code-function-p object) |
| 2312 | (eq (car-safe object) 'lambda))) |
| 2313 | |
| 2314 | (defun assq-delete-all (key alist) |
| 2315 | "Delete from ALIST all elements whose car is KEY. |
| 2316 | Return the modified alist. |
| 2317 | Elements of ALIST that are not conses are ignored." |
| 2318 | (let ((tail alist)) |
| 2319 | (while tail |
| 2320 | (if (and (consp (car tail)) (eq (car (car tail)) key)) |
| 2321 | (setq alist (delq (car tail) alist))) |
| 2322 | (setq tail (cdr tail))) |
| 2323 | alist)) |
| 2324 | |
| 2325 | (defun make-temp-file (prefix &optional dir-flag suffix) |
| 2326 | "Create a temporary file. |
| 2327 | The returned file name (created by appending some random characters at the end |
| 2328 | of PREFIX, and expanding against `temporary-file-directory' if necessary), |
| 2329 | is guaranteed to point to a newly created empty file. |
| 2330 | You can then use `write-region' to write new data into the file. |
| 2331 | |
| 2332 | If DIR-FLAG is non-nil, create a new empty directory instead of a file. |
| 2333 | |
| 2334 | If SUFFIX is non-nil, add that at the end of the file name." |
| 2335 | (let ((umask (default-file-modes)) |
| 2336 | file) |
| 2337 | (unwind-protect |
| 2338 | (progn |
| 2339 | ;; Create temp files with strict access rights. It's easy to |
| 2340 | ;; loosen them later, whereas it's impossible to close the |
| 2341 | ;; time-window of loose permissions otherwise. |
| 2342 | (set-default-file-modes ?\700) |
| 2343 | (while (condition-case () |
| 2344 | (progn |
| 2345 | (setq file |
| 2346 | (make-temp-name |
| 2347 | (expand-file-name prefix temporary-file-directory))) |
| 2348 | (if suffix |
| 2349 | (setq file (concat file suffix))) |
| 2350 | (if dir-flag |
| 2351 | (make-directory file) |
| 2352 | (write-region "" nil file nil 'silent nil 'excl)) |
| 2353 | nil) |
| 2354 | (file-already-exists t)) |
| 2355 | ;; the file was somehow created by someone else between |
| 2356 | ;; `make-temp-name' and `write-region', let's try again. |
| 2357 | nil) |
| 2358 | file) |
| 2359 | ;; Reset the umask. |
| 2360 | (set-default-file-modes umask)))) |
| 2361 | |
| 2362 | \f |
| 2363 | ;; If a minor mode is not defined with define-minor-mode, |
| 2364 | ;; add it here explicitly. |
| 2365 | ;; isearch-mode is deliberately excluded, since you should |
| 2366 | ;; not call it yourself. |
| 2367 | (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode |
| 2368 | overwrite-mode view-mode |
| 2369 | hs-minor-mode) |
| 2370 | "List of all minor mode functions.") |
| 2371 | |
| 2372 | (defun add-minor-mode (toggle name &optional keymap after toggle-fun) |
| 2373 | "Register a new minor mode. |
| 2374 | |
| 2375 | This is an XEmacs-compatibility function. Use `define-minor-mode' instead. |
| 2376 | |
| 2377 | TOGGLE is a symbol which is the name of a buffer-local variable that |
| 2378 | is toggled on or off to say whether the minor mode is active or not. |
| 2379 | |
| 2380 | NAME specifies what will appear in the mode line when the minor mode |
| 2381 | is active. NAME should be either a string starting with a space, or a |
| 2382 | symbol whose value is such a string. |
| 2383 | |
| 2384 | Optional KEYMAP is the keymap for the minor mode that will be added |
| 2385 | to `minor-mode-map-alist'. |
| 2386 | |
| 2387 | Optional AFTER specifies that TOGGLE should be added after AFTER |
| 2388 | in `minor-mode-alist'. |
| 2389 | |
| 2390 | Optional TOGGLE-FUN is an interactive function to toggle the mode. |
| 2391 | It defaults to (and should by convention be) TOGGLE. |
| 2392 | |
| 2393 | If TOGGLE has a non-nil `:included' property, an entry for the mode is |
| 2394 | included in the mode-line minor mode menu. |
| 2395 | If TOGGLE has a `:menu-tag', that is used for the menu item's label." |
| 2396 | (unless (memq toggle minor-mode-list) |
| 2397 | (push toggle minor-mode-list)) |
| 2398 | |
| 2399 | (unless toggle-fun (setq toggle-fun toggle)) |
| 2400 | ;; Add the name to the minor-mode-alist. |
| 2401 | (when name |
| 2402 | (let ((existing (assq toggle minor-mode-alist))) |
| 2403 | (if existing |
| 2404 | (setcdr existing (list name)) |
| 2405 | (let ((tail minor-mode-alist) found) |
| 2406 | (while (and tail (not found)) |
| 2407 | (if (eq after (caar tail)) |
| 2408 | (setq found tail) |
| 2409 | (setq tail (cdr tail)))) |
| 2410 | (if found |
| 2411 | (let ((rest (cdr found))) |
| 2412 | (setcdr found nil) |
| 2413 | (nconc found (list (list toggle name)) rest)) |
| 2414 | (setq minor-mode-alist (cons (list toggle name) |
| 2415 | minor-mode-alist))))))) |
| 2416 | ;; Add the toggle to the minor-modes menu if requested. |
| 2417 | (when (get toggle :included) |
| 2418 | (define-key mode-line-mode-menu |
| 2419 | (vector toggle) |
| 2420 | (list 'menu-item |
| 2421 | (concat |
| 2422 | (or (get toggle :menu-tag) |
| 2423 | (if (stringp name) name (symbol-name toggle))) |
| 2424 | (let ((mode-name (if (symbolp name) (symbol-value name)))) |
| 2425 | (if (and (stringp mode-name) (string-match "[^ ]+" mode-name)) |
| 2426 | (concat " (" (match-string 0 mode-name) ")")))) |
| 2427 | toggle-fun |
| 2428 | :button (cons :toggle toggle)))) |
| 2429 | |
| 2430 | ;; Add the map to the minor-mode-map-alist. |
| 2431 | (when keymap |
| 2432 | (let ((existing (assq toggle minor-mode-map-alist))) |
| 2433 | (if existing |
| 2434 | (setcdr existing keymap) |
| 2435 | (let ((tail minor-mode-map-alist) found) |
| 2436 | (while (and tail (not found)) |
| 2437 | (if (eq after (caar tail)) |
| 2438 | (setq found tail) |
| 2439 | (setq tail (cdr tail)))) |
| 2440 | (if found |
| 2441 | (let ((rest (cdr found))) |
| 2442 | (setcdr found nil) |
| 2443 | (nconc found (list (cons toggle keymap)) rest)) |
| 2444 | (setq minor-mode-map-alist (cons (cons toggle keymap) |
| 2445 | minor-mode-map-alist)))))))) |
| 2446 | \f |
| 2447 | ;; Clones ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
| 2448 | |
| 2449 | (defun text-clone-maintain (ol1 after beg end &optional len) |
| 2450 | "Propagate the changes made under the overlay OL1 to the other clones. |
| 2451 | This is used on the `modification-hooks' property of text clones." |
| 2452 | (when (and after (not undo-in-progress) (overlay-start ol1)) |
| 2453 | (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0))) |
| 2454 | (setq beg (max beg (+ (overlay-start ol1) margin))) |
| 2455 | (setq end (min end (- (overlay-end ol1) margin))) |
| 2456 | (when (<= beg end) |
| 2457 | (save-excursion |
| 2458 | (when (overlay-get ol1 'text-clone-syntax) |
| 2459 | ;; Check content of the clone's text. |
| 2460 | (let ((cbeg (+ (overlay-start ol1) margin)) |
| 2461 | (cend (- (overlay-end ol1) margin))) |
| 2462 | (goto-char cbeg) |
| 2463 | (save-match-data |
| 2464 | (if (not (re-search-forward |
| 2465 | (overlay-get ol1 'text-clone-syntax) cend t)) |
| 2466 | ;; Mark the overlay for deletion. |
| 2467 | (overlay-put ol1 'text-clones nil) |
| 2468 | (when (< (match-end 0) cend) |
| 2469 | ;; Shrink the clone at its end. |
| 2470 | (setq end (min end (match-end 0))) |
| 2471 | (move-overlay ol1 (overlay-start ol1) |
| 2472 | (+ (match-end 0) margin))) |
| 2473 | (when (> (match-beginning 0) cbeg) |
| 2474 | ;; Shrink the clone at its beginning. |
| 2475 | (setq beg (max (match-beginning 0) beg)) |
| 2476 | (move-overlay ol1 (- (match-beginning 0) margin) |
| 2477 | (overlay-end ol1))))))) |
| 2478 | ;; Now go ahead and update the clones. |
| 2479 | (let ((head (- beg (overlay-start ol1))) |
| 2480 | (tail (- (overlay-end ol1) end)) |
| 2481 | (str (buffer-substring beg end)) |
| 2482 | (nothing-left t) |
| 2483 | (inhibit-modification-hooks t)) |
| 2484 | (dolist (ol2 (overlay-get ol1 'text-clones)) |
| 2485 | (let ((oe (overlay-end ol2))) |
| 2486 | (unless (or (eq ol1 ol2) (null oe)) |
| 2487 | (setq nothing-left nil) |
| 2488 | (let ((mod-beg (+ (overlay-start ol2) head))) |
| 2489 | ;;(overlay-put ol2 'modification-hooks nil) |
| 2490 | (goto-char (- (overlay-end ol2) tail)) |
| 2491 | (unless (> mod-beg (point)) |
| 2492 | (save-excursion (insert str)) |
| 2493 | (delete-region mod-beg (point))) |
| 2494 | ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain)) |
| 2495 | )))) |
| 2496 | (if nothing-left (delete-overlay ol1)))))))) |
| 2497 | |
| 2498 | (defun text-clone-create (start end &optional spreadp syntax) |
| 2499 | "Create a text clone of START...END at point. |
| 2500 | Text clones are chunks of text that are automatically kept identical: |
| 2501 | changes done to one of the clones will be immediately propagated to the other. |
| 2502 | |
| 2503 | The buffer's content at point is assumed to be already identical to |
| 2504 | the one between START and END. |
| 2505 | If SYNTAX is provided it's a regexp that describes the possible text of |
| 2506 | the clones; the clone will be shrunk or killed if necessary to ensure that |
| 2507 | its text matches the regexp. |
| 2508 | If SPREADP is non-nil it indicates that text inserted before/after the |
| 2509 | clone should be incorporated in the clone." |
| 2510 | ;; To deal with SPREADP we can either use an overlay with `nil t' along |
| 2511 | ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay |
| 2512 | ;; (with a one-char margin at each end) with `t nil'. |
| 2513 | ;; We opted for a larger overlay because it behaves better in the case |
| 2514 | ;; where the clone is reduced to the empty string (we want the overlay to |
| 2515 | ;; stay when the clone's content is the empty string and we want to use |
| 2516 | ;; `evaporate' to make sure those overlays get deleted when needed). |
| 2517 | ;; |
| 2518 | (let* ((pt-end (+ (point) (- end start))) |
| 2519 | (start-margin (if (or (not spreadp) (bobp) (<= start (point-min))) |
| 2520 | 0 1)) |
| 2521 | (end-margin (if (or (not spreadp) |
| 2522 | (>= pt-end (point-max)) |
| 2523 | (>= start (point-max))) |
| 2524 | 0 1)) |
| 2525 | (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t)) |
| 2526 | (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t)) |
| 2527 | (dups (list ol1 ol2))) |
| 2528 | (overlay-put ol1 'modification-hooks '(text-clone-maintain)) |
| 2529 | (when spreadp (overlay-put ol1 'text-clone-spreadp t)) |
| 2530 | (when syntax (overlay-put ol1 'text-clone-syntax syntax)) |
| 2531 | ;;(overlay-put ol1 'face 'underline) |
| 2532 | (overlay-put ol1 'evaporate t) |
| 2533 | (overlay-put ol1 'text-clones dups) |
| 2534 | ;; |
| 2535 | (overlay-put ol2 'modification-hooks '(text-clone-maintain)) |
| 2536 | (when spreadp (overlay-put ol2 'text-clone-spreadp t)) |
| 2537 | (when syntax (overlay-put ol2 'text-clone-syntax syntax)) |
| 2538 | ;;(overlay-put ol2 'face 'underline) |
| 2539 | (overlay-put ol2 'evaporate t) |
| 2540 | (overlay-put ol2 'text-clones dups))) |
| 2541 | |
| 2542 | (defun play-sound (sound) |
| 2543 | "SOUND is a list of the form `(sound KEYWORD VALUE...)'. |
| 2544 | The following keywords are recognized: |
| 2545 | |
| 2546 | :file FILE - read sound data from FILE. If FILE isn't an |
| 2547 | absolute file name, it is searched in `data-directory'. |
| 2548 | |
| 2549 | :data DATA - read sound data from string DATA. |
| 2550 | |
| 2551 | Exactly one of :file or :data must be present. |
| 2552 | |
| 2553 | :volume VOL - set volume to VOL. VOL must an integer in the |
| 2554 | range 0..100 or a float in the range 0..1.0. If not specified, |
| 2555 | don't change the volume setting of the sound device. |
| 2556 | |
| 2557 | :device DEVICE - play sound on DEVICE. If not specified, |
| 2558 | a system-dependent default device name is used." |
| 2559 | (unless (fboundp 'play-sound-internal) |
| 2560 | (error "This Emacs binary lacks sound support")) |
| 2561 | (play-sound-internal sound)) |
| 2562 | |
| 2563 | (defun define-mail-user-agent (symbol composefunc sendfunc |
| 2564 | &optional abortfunc hookvar) |
| 2565 | "Define a symbol to identify a mail-sending package for `mail-user-agent'. |
| 2566 | |
| 2567 | SYMBOL can be any Lisp symbol. Its function definition and/or |
| 2568 | value as a variable do not matter for this usage; we use only certain |
| 2569 | properties on its property list, to encode the rest of the arguments. |
| 2570 | |
| 2571 | COMPOSEFUNC is program callable function that composes an outgoing |
| 2572 | mail message buffer. This function should set up the basics of the |
| 2573 | buffer without requiring user interaction. It should populate the |
| 2574 | standard mail headers, leaving the `to:' and `subject:' headers blank |
| 2575 | by default. |
| 2576 | |
| 2577 | COMPOSEFUNC should accept several optional arguments--the same |
| 2578 | arguments that `compose-mail' takes. See that function's documentation. |
| 2579 | |
| 2580 | SENDFUNC is the command a user would run to send the message. |
| 2581 | |
| 2582 | Optional ABORTFUNC is the command a user would run to abort the |
| 2583 | message. For mail packages that don't have a separate abort function, |
| 2584 | this can be `kill-buffer' (the equivalent of omitting this argument). |
| 2585 | |
| 2586 | Optional HOOKVAR is a hook variable that gets run before the message |
| 2587 | is actually sent. Callers that use the `mail-user-agent' may |
| 2588 | install a hook function temporarily on this hook variable. |
| 2589 | If HOOKVAR is nil, `mail-send-hook' is used. |
| 2590 | |
| 2591 | The properties used on SYMBOL are `composefunc', `sendfunc', |
| 2592 | `abortfunc', and `hookvar'." |
| 2593 | (put symbol 'composefunc composefunc) |
| 2594 | (put symbol 'sendfunc sendfunc) |
| 2595 | (put symbol 'abortfunc (or abortfunc 'kill-buffer)) |
| 2596 | (put symbol 'hookvar (or hookvar 'mail-send-hook))) |
| 2597 | |
| 2598 | ;;; arch-tag: f7e0e6e5-70aa-4897-ae72-7a3511ec40bc |
| 2599 | ;;; subr.el ends here |