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