1 ;;; subr.el --- basic lisp subroutines for Emacs
3 ;; Copyright (C) 1985, 86, 92, 94, 95, 99, 2000, 2001, 2002, 2003
4 ;; Free Software Foundation, Inc.
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)
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.
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
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.
48 ;; Ignore the first element of `decl' (it's always `declare').
49 (while (setq decl
(cdr 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.
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
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."
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
)))
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
111 (declare (debug (sexp)))
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
)
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
))
137 (setq ,(car spec
) (car ,temp
))
138 (setq ,temp
(cdr ,temp
))
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--"))
155 (,(car spec
) ,start
))
156 (while (< ,(car spec
) ,temp
)
158 (setq ,(car spec
) (1+ ,(car spec
))))
159 ,@(cdr (cdr spec
)))))
162 "Return the car of the car of X."
166 "Return the car of the cdr of X."
170 "Return the cdr of the car of X."
174 "Return the cdr of the cdr of X."
177 (defun last (x &optional n
)
178 "Return the last link of the list X. Its car is the last element.
179 If X is nil, return nil.
180 If N is non-nil, return the Nth-to-last link of X.
181 If N is bigger than the length of X, return X."
185 (setq m
(1+ m
) p
(cdr p
)))
187 (if (< n m
) (nthcdr (- m n
) x
) x
)))
188 (while (consp (cdr x
))
192 (defun butlast (x &optional n
)
193 "Returns a copy of LIST with the last N elements removed."
194 (if (and n
(<= n
0)) x
195 (nbutlast (copy-sequence x
) n
)))
197 (defun nbutlast (x &optional n
)
198 "Modifies LIST to remove the last N elements."
199 (let ((m (length x
)))
203 (if (> n
0) (setcdr (nthcdr (- (1- m
) n
) x
) nil
))
206 (defun number-sequence (from &optional to inc
)
207 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
208 INC is the increment used between numbers in the sequence and defaults to 1.
209 So, the Nth element of the list is \(+ FROM \(* N INC)) where N counts from
210 zero. TO is only included if there is an N for which TO = FROM + N * INC.
211 If TO is nil or numerically equal to FROM, return \(FROM).
212 If INC is positive and TO is less than FROM, or INC is negative
213 and TO is larger than FROM, return nil.
214 If INC is zero and TO is neither nil nor numerically equal to
215 FROM, signal an error.
217 This function is primarily designed for integer arguments.
218 Nevertheless, FROM, TO and INC can be integer or float. However,
219 floating point arithmetic is inexact. For instance, depending on
220 the machine, it may quite well happen that
221 \(number-sequence 0.4 0.6 0.2) returns the one element list \(0.4),
222 whereas \(number-sequence 0.4 0.8 0.2) returns a list with three
223 elements. Thus, if some of the arguments are floats and one wants
224 to make sure that TO is included, one may have to explicitly write
225 TO as \(+ FROM \(* N INC)) or use a variable whose value was
226 computed with this exact expression. Alternatively, you can,
227 of course, also replace TO with a slightly larger value
228 \(or a slightly more negative value if INC is negative)."
229 (if (or (not to
) (= from to
))
231 (or inc
(setq inc
1))
232 (when (zerop inc
) (error "The increment can not be zero"))
233 (let (seq (n 0) (next from
))
236 (setq seq
(cons next seq
)
238 next
(+ from
(* n inc
))))
240 (setq seq
(cons next seq
)
242 next
(+ from
(* n inc
)))))
245 (defun remove (elt seq
)
246 "Return a copy of SEQ with all occurrences of ELT removed.
247 SEQ must be a list, vector, or string. The comparison is done with `equal'."
249 ;; If SEQ isn't a list, there's no need to copy SEQ because
250 ;; `delete' will return a new object.
252 (delete elt
(copy-sequence seq
))))
254 (defun remq (elt list
)
255 "Return LIST with all occurrences of ELT removed.
256 The comparison is done with `eq'. Contrary to `delq', this does not use
257 side-effects, and the argument LIST is not modified."
259 (delq elt
(copy-sequence list
))
262 (defun copy-tree (tree &optional vecp
)
263 "Make a copy of TREE.
264 If TREE is a cons cell, this recursively copies both its car and its cdr.
265 Contrast to `copy-sequence', which copies only along the cdrs. With second
266 argument VECP, this copies vectors as well as conses."
270 (let ((newcar (car tree
)))
271 (if (or (consp (car tree
)) (and vecp
(vectorp (car tree
))))
272 (setq newcar
(copy-tree (car tree
) vecp
)))
273 (push newcar result
))
274 (setq tree
(cdr tree
)))
275 (nconc (nreverse result
) tree
))
276 (if (and vecp
(vectorp tree
))
277 (let ((i (length (setq tree
(copy-sequence tree
)))))
278 (while (>= (setq i
(1- i
)) 0)
279 (aset tree i
(copy-tree (aref tree i
) vecp
)))
283 (defun assoc-default (key alist
&optional test default
)
284 "Find object KEY in a pseudo-alist ALIST.
285 ALIST is a list of conses or objects. Each element (or the element's car,
286 if it is a cons) is compared with KEY by evaluating (TEST (car elt) KEY).
287 If that is non-nil, the element matches;
288 then `assoc-default' returns the element's cdr, if it is a cons,
289 or DEFAULT if the element is not a cons.
291 If no element matches, the value is nil.
292 If TEST is omitted or nil, `equal' is used."
293 (let (found (tail alist
) value
)
294 (while (and tail
(not found
))
295 (let ((elt (car tail
)))
296 (when (funcall (or test
'equal
) (if (consp elt
) (car elt
) elt
) key
)
297 (setq found t value
(if (consp elt
) (cdr elt
) default
))))
298 (setq tail
(cdr tail
)))
301 (make-obsolete 'assoc-ignore-case
'assoc-string
)
302 (defun assoc-ignore-case (key alist
)
303 "Like `assoc', but ignores differences in case and text representation.
304 KEY must be a string. Upper-case and lower-case letters are treated as equal.
305 Unibyte strings are converted to multibyte for comparison."
306 (assoc-string key alist t
))
308 (make-obsolete 'assoc-ignore-representation
'assoc-string
)
309 (defun assoc-ignore-representation (key alist
)
310 "Like `assoc', but ignores differences in text representation.
311 KEY must be a string.
312 Unibyte strings are converted to multibyte for comparison."
313 (assoc-string key alist nil
))
315 (defun member-ignore-case (elt list
)
316 "Like `member', but ignores differences in case and text representation.
317 ELT must be a string. Upper-case and lower-case letters are treated as equal.
318 Unibyte strings are converted to multibyte for comparison.
319 Non-strings in LIST are ignored."
321 (not (and (stringp (car list
))
322 (eq t
(compare-strings elt
0 nil
(car list
) 0 nil t
)))))
323 (setq list
(cdr list
)))
333 ;Prevent the \{...} documentation construct
334 ;from mentioning keys that run this command.
335 (put 'undefined
'suppress-keymap t
)
337 (defun suppress-keymap (map &optional nodigits
)
338 "Make MAP override all normally self-inserting keys to be undefined.
339 Normally, as an exception, digits and minus-sign are set to make prefix args,
340 but optional second arg NODIGITS non-nil treats them like other chars."
341 (define-key map
[remap self-insert-command
] 'undefined
)
344 (define-key map
"-" 'negative-argument
)
345 ;; Make plain numbers do numeric args.
348 (define-key map
(char-to-string loop
) 'digit-argument
)
349 (setq loop
(1+ loop
))))))
352 ;(defun copy-keymap (keymap)
353 ; "Return a copy of KEYMAP"
354 ; (while (not (keymapp keymap))
355 ; (setq keymap (signal 'wrong-type-argument (list 'keymapp keymap))))
356 ; (if (vectorp keymap)
357 ; (copy-sequence keymap)
358 ; (copy-alist keymap)))
360 (defvar key-substitution-in-progress nil
361 "Used internally by substitute-key-definition.")
363 (defun substitute-key-definition (olddef newdef keymap
&optional oldmap prefix
)
364 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
365 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
366 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
367 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP."
368 ;; Don't document PREFIX in the doc string because we don't want to
369 ;; advertise it. It's meant for recursive calls only. Here's its
372 ;; If optional argument PREFIX is specified, it should be a key
373 ;; prefix, a string. Redefined bindings will then be bound to the
374 ;; original key, with PREFIX added at the front.
375 (or prefix
(setq prefix
""))
376 (let* ((scan (or oldmap keymap
))
378 (prefix1 (vconcat prefix vec1
))
379 (key-substitution-in-progress
380 (cons scan key-substitution-in-progress
)))
381 ;; Scan OLDMAP, finding each char or event-symbol that
382 ;; has any definition, and act on it with hack-key.
384 (if (consp (car scan
))
385 (let ((char (car (car scan
)))
386 (defn (cdr (car scan
))))
387 ;; The inside of this let duplicates exactly
388 ;; the inside of the following let that handles array elements.
390 (aset prefix1
(length prefix
) char
)
391 (let (inner-def skipped
)
392 ;; Skip past menu-prompt.
393 (while (stringp (car-safe defn
))
394 (setq skipped
(cons (car defn
) skipped
))
395 (setq defn
(cdr defn
)))
396 ;; Skip past cached key-equivalence data for menu items.
397 (and (consp defn
) (consp (car defn
))
398 (setq defn
(cdr defn
)))
399 (setq inner-def defn
)
400 ;; Look past a symbol that names a keymap.
401 (while (and (symbolp inner-def
)
403 (setq inner-def
(symbol-function inner-def
)))
404 (if (or (eq defn olddef
)
405 ;; Compare with equal if definition is a key sequence.
406 ;; That is useful for operating on function-key-map.
407 (and (or (stringp defn
) (vectorp defn
))
408 (equal defn olddef
)))
409 (define-key keymap prefix1
(nconc (nreverse skipped
) newdef
))
410 (if (and (keymapp defn
)
411 ;; Avoid recursively scanning
412 ;; where KEYMAP does not have a submap.
413 (let ((elt (lookup-key keymap prefix1
)))
416 ;; Avoid recursively rescanning keymap being scanned.
418 key-substitution-in-progress
)))
419 ;; If this one isn't being scanned already,
421 (substitute-key-definition olddef newdef keymap
424 (if (vectorp (car scan
))
425 (let* ((array (car scan
))
429 (let ((char i
) (defn (aref array i
)))
430 ;; The inside of this let duplicates exactly
431 ;; the inside of the previous let.
433 (aset prefix1
(length prefix
) char
)
434 (let (inner-def skipped
)
435 ;; Skip past menu-prompt.
436 (while (stringp (car-safe defn
))
437 (setq skipped
(cons (car defn
) skipped
))
438 (setq defn
(cdr defn
)))
439 (and (consp defn
) (consp (car defn
))
440 (setq defn
(cdr defn
)))
441 (setq inner-def defn
)
442 (while (and (symbolp inner-def
)
444 (setq inner-def
(symbol-function inner-def
)))
445 (if (or (eq defn olddef
)
446 (and (or (stringp defn
) (vectorp defn
))
447 (equal defn olddef
)))
448 (define-key keymap prefix1
449 (nconc (nreverse skipped
) newdef
))
450 (if (and (keymapp defn
)
451 (let ((elt (lookup-key keymap prefix1
)))
455 key-substitution-in-progress
)))
456 (substitute-key-definition olddef newdef keymap
460 (if (char-table-p (car scan
))
462 (function (lambda (char defn
)
464 ;; The inside of this let duplicates exactly
465 ;; the inside of the previous let,
466 ;; except that it uses set-char-table-range
467 ;; instead of define-key.
469 (aset prefix1
(length prefix
) char
)
470 (let (inner-def skipped
)
471 ;; Skip past menu-prompt.
472 (while (stringp (car-safe defn
))
473 (setq skipped
(cons (car defn
) skipped
))
474 (setq defn
(cdr defn
)))
475 (and (consp defn
) (consp (car defn
))
476 (setq defn
(cdr defn
)))
477 (setq inner-def defn
)
478 (while (and (symbolp inner-def
)
480 (setq inner-def
(symbol-function inner-def
)))
481 (if (or (eq defn olddef
)
482 (and (or (stringp defn
) (vectorp defn
))
483 (equal defn olddef
)))
484 (define-key keymap prefix1
485 (nconc (nreverse skipped
) newdef
))
486 (if (and (keymapp defn
)
487 (let ((elt (lookup-key keymap prefix1
)))
491 key-substitution-in-progress
)))
492 (substitute-key-definition olddef newdef keymap
496 (setq scan
(cdr scan
)))))
498 (defun define-key-after (keymap key definition
&optional after
)
499 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
500 This is like `define-key' except that the binding for KEY is placed
501 just after the binding for the event AFTER, instead of at the beginning
502 of the map. Note that AFTER must be an event type (like KEY), NOT a command
505 If AFTER is t or omitted, the new binding goes at the end of the keymap.
506 AFTER should be a single event type--a symbol or a character, not a sequence.
508 Bindings are always added before any inherited map.
510 The order of bindings in a keymap matters when it is used as a menu."
511 (unless after
(setq after t
))
513 (signal 'wrong-type-argument
(list 'keymapp keymap
)))
515 (if (<= (length key
) 1) (aref key
0)
516 (setq keymap
(lookup-key keymap
518 (butlast (mapcar 'identity key
)))))
519 (aref key
(1- (length key
)))))
520 (let ((tail keymap
) done inserted
)
521 (while (and (not done
) tail
)
522 ;; Delete any earlier bindings for the same key.
523 (if (eq (car-safe (car (cdr tail
))) key
)
524 (setcdr tail
(cdr (cdr tail
))))
525 ;; If we hit an included map, go down that one.
526 (if (keymapp (car tail
)) (setq tail
(car tail
)))
527 ;; When we reach AFTER's binding, insert the new binding after.
528 ;; If we reach an inherited keymap, insert just before that.
529 ;; If we reach the end of this keymap, insert at the end.
530 (if (or (and (eq (car-safe (car tail
)) after
)
532 (eq (car (cdr tail
)) 'keymap
)
535 ;; Stop the scan only if we find a parent keymap.
536 ;; Keep going past the inserted element
537 ;; so we can delete any duplications that come later.
538 (if (eq (car (cdr tail
)) 'keymap
)
540 ;; Don't insert more than once.
542 (setcdr tail
(cons (cons key definition
) (cdr tail
))))
544 (setq tail
(cdr tail
)))))
548 "Convert KEYS to the internal Emacs key representation.
549 KEYS should be a string constant in the format used for
550 saving keyboard macros (see `insert-kbd-macro')."
551 (read-kbd-macro keys
))
553 (put 'keyboard-translate-table
'char-table-extra-slots
0)
555 (defun keyboard-translate (from to
)
556 "Translate character FROM to TO at a low level.
557 This function creates a `keyboard-translate-table' if necessary
558 and then modifies one entry in it."
559 (or (char-table-p keyboard-translate-table
)
560 (setq keyboard-translate-table
561 (make-char-table 'keyboard-translate-table nil
)))
562 (aset keyboard-translate-table from to
))
565 ;;;; The global keymap tree.
567 ;;; global-map, esc-map, and ctl-x-map have their values set up in
568 ;;; keymap.c; we just give them docstrings here.
570 (defvar global-map nil
571 "Default global keymap mapping Emacs keyboard input into commands.
572 The value is a keymap which is usually (but not necessarily) Emacs's
576 "Default keymap for ESC (meta) commands.
577 The normal global definition of the character ESC indirects to this keymap.")
579 (defvar ctl-x-map nil
580 "Default keymap for C-x commands.
581 The normal global definition of the character C-x indirects to this keymap.")
583 (defvar ctl-x-4-map
(make-sparse-keymap)
584 "Keymap for subcommands of C-x 4.")
585 (defalias 'ctl-x-4-prefix ctl-x-4-map
)
586 (define-key ctl-x-map
"4" 'ctl-x-4-prefix
)
588 (defvar ctl-x-5-map
(make-sparse-keymap)
589 "Keymap for frame commands.")
590 (defalias 'ctl-x-5-prefix ctl-x-5-map
)
591 (define-key ctl-x-map
"5" 'ctl-x-5-prefix
)
594 ;;;; Event manipulation functions.
596 ;; The call to `read' is to ensure that the value is computed at load time
597 ;; and not compiled into the .elc file. The value is negative on most
598 ;; machines, but not on all!
599 (defconst listify-key-sequence-1
(logior 128 (read "?\\M-\\^@")))
601 (defun listify-key-sequence (key)
602 "Convert a key sequence to a list of events."
605 (mapcar (function (lambda (c)
607 (logxor c listify-key-sequence-1
)
611 (defsubst eventp
(obj)
612 "True if the argument is an event object."
615 (get obj
'event-symbol-elements
))
618 (get (car obj
) 'event-symbol-elements
))))
620 (defun event-modifiers (event)
621 "Returns a list of symbols representing the modifier keys in event EVENT.
622 The elements of the list may include `meta', `control',
623 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
627 (setq type
(car type
)))
629 (cdr (get type
'event-symbol-elements
))
631 (or (zerop (logand type ?\M-\^
@))
632 (setq list
(cons 'meta list
)))
633 (or (and (zerop (logand type ?\C-\^
@))
634 (>= (logand type
127) 32))
635 (setq list
(cons 'control list
)))
636 (or (and (zerop (logand type ?\S-\^
@))
637 (= (logand type
255) (downcase (logand type
255))))
638 (setq list
(cons 'shift list
)))
639 (or (zerop (logand type ?\H-\^
@))
640 (setq list
(cons 'hyper list
)))
641 (or (zerop (logand type ?\s-\^
@))
642 (setq list
(cons 'super list
)))
643 (or (zerop (logand type ?\A-\^
@))
644 (setq list
(cons 'alt list
)))
647 (defun event-basic-type (event)
648 "Returns the basic type of the given event (all modifiers removed).
649 The value is a printing character (not upper case) or a symbol."
651 (setq event
(car event
)))
653 (car (get event
'event-symbol-elements
))
654 (let ((base (logand event
(1- (lsh 1 18)))))
655 (downcase (if (< base
32) (logior base
64) base
)))))
657 (defsubst mouse-movement-p
(object)
658 "Return non-nil if OBJECT is a mouse movement event."
660 (eq (car object
) 'mouse-movement
)))
662 (defsubst event-start
(event)
663 "Return the starting position of EVENT.
664 If EVENT is a mouse press or a mouse click, this returns the location
666 If EVENT is a drag, this returns the drag's starting position.
667 The return value is of the form
668 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW))
669 The `posn-' functions access elements of such lists."
670 (if (consp event
) (nth 1 event
)
671 (list (selected-window) (point) '(0 .
0) 0)))
673 (defsubst event-end
(event)
674 "Return the ending location of EVENT. EVENT should be a click or drag event.
675 If EVENT is a click event, this function is the same as `event-start'.
676 The return value is of the form
677 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW))
678 The `posn-' functions access elements of such lists."
679 (if (consp event
) (nth (if (consp (nth 2 event
)) 2 1) event
)
680 (list (selected-window) (point) '(0 .
0) 0)))
682 (defsubst event-click-count
(event)
683 "Return the multi-click count of EVENT, a click or drag event.
684 The return value is a positive integer."
685 (if (and (consp event
) (integerp (nth 2 event
))) (nth 2 event
) 1))
687 (defsubst posn-window
(position)
688 "Return the window in POSITION.
689 POSITION should be a list of the form returned by the `event-start'
690 and `event-end' functions."
693 (defsubst posn-area
(position)
694 "Return the window area recorded in POSITION, or nil for the text area.
695 POSITION should be a list of the form returned by the `event-start'
696 and `event-end' functions."
697 (let ((area (if (consp (nth 1 position
))
698 (car (nth 1 position
))
700 (and (symbolp area
) area
)))
702 (defsubst posn-point
(position)
703 "Return the buffer location in POSITION.
704 POSITION should be a list of the form returned by the `event-start'
705 and `event-end' functions."
707 (if (consp (nth 1 position
))
708 (car (nth 1 position
))
711 (defsubst posn-x-y
(position)
712 "Return the x and y coordinates in POSITION.
713 POSITION should be a list of the form returned by the `event-start'
714 and `event-end' functions."
717 (defun posn-col-row (position)
718 "Return the nominal column and row in POSITION, measured in characters.
719 The column and row values are approximations calculated from the x
720 and y coordinates in POSITION and the frame's default character width
722 For a scroll-bar event, the result column is 0, and the row
723 corresponds to the vertical position of the click in the scroll bar.
724 POSITION should be a list of the form returned by the `event-start'
725 and `event-end' functions."
726 (let* ((pair (posn-x-y position
))
727 (window (posn-window position
))
728 (area (posn-area position
)))
732 ((eq area
'vertical-scroll-bar
)
733 (cons 0 (scroll-bar-scale pair
(1- (window-height window
)))))
734 ((eq area
'horizontal-scroll-bar
)
735 (cons (scroll-bar-scale pair
(window-width window
)) 0))
737 (let* ((frame (if (framep window
) window
(window-frame window
)))
738 (x (/ (car pair
) (frame-char-width frame
)))
739 (y (/ (cdr pair
) (+ (frame-char-height frame
)
740 (or (frame-parameter frame
'line-spacing
)
745 (defun posn-actual-col-row (position)
746 "Return the actual column and row in POSITION, measured in characters.
747 These are the actual row number in the window and character number in that row.
748 Return nil if POSITION does not contain the actual position; in that case
749 `posn-col-row' can be used to get approximate values.
750 POSITION should be a list of the form returned by the `event-start'
751 and `event-end' functions."
754 (defsubst posn-timestamp
(position)
755 "Return the timestamp of POSITION.
756 POSITION should be a list of the form returned by the `event-start'
757 and `event-end' functions."
760 (defsubst posn-object
(position)
761 "Return the object of POSITION.
762 POSITION should be a list of the form returned by the `event-start'
763 and `event-end' functions."
766 (defsubst posn-object-x-y
(position)
767 "Return the x and y coordinates relative to the object of POSITION.
768 POSITION should be a list of the form returned by the `event-start'
769 and `event-end' functions."
773 ;;;; Obsolescent names for functions.
775 (defalias 'dot
'point
)
776 (defalias 'dot-marker
'point-marker
)
777 (defalias 'dot-min
'point-min
)
778 (defalias 'dot-max
'point-max
)
779 (defalias 'window-dot
'window-point
)
780 (defalias 'set-window-dot
'set-window-point
)
781 (defalias 'read-input
'read-string
)
782 (defalias 'send-string
'process-send-string
)
783 (defalias 'send-region
'process-send-region
)
784 (defalias 'show-buffer
'set-window-buffer
)
785 (defalias 'buffer-flush-undo
'buffer-disable-undo
)
786 (defalias 'eval-current-buffer
'eval-buffer
)
787 (defalias 'compiled-function-p
'byte-code-function-p
)
788 (defalias 'define-function
'defalias
)
790 (defalias 'sref
'aref
)
791 (make-obsolete 'sref
'aref
"20.4")
792 (make-obsolete 'char-bytes
"now always returns 1." "20.4")
793 (make-obsolete 'chars-in-region
"use (abs (- BEG END))." "20.3")
794 (make-obsolete 'dot
'point
"before 19.15")
795 (make-obsolete 'dot-max
'point-max
"before 19.15")
796 (make-obsolete 'dot-min
'point-min
"before 19.15")
797 (make-obsolete 'dot-marker
'point-marker
"before 19.15")
798 (make-obsolete 'buffer-flush-undo
'buffer-disable-undo
"before 19.15")
799 (make-obsolete 'baud-rate
"use the baud-rate variable instead." "before 19.15")
800 (make-obsolete 'compiled-function-p
'byte-code-function-p
"before 19.15")
801 (make-obsolete 'define-function
'defalias
"20.1")
803 (defun insert-string (&rest args
)
804 "Mocklisp-compatibility insert function.
805 Like the function `insert' except that any argument that is a number
806 is converted into a string by expressing it in decimal."
808 (insert (if (integerp el
) (number-to-string el
) el
))))
809 (make-obsolete 'insert-string
'insert
"21.4")
810 (defun makehash (&optional test
) (make-hash-table :test
(or test
'eql
)))
811 (make-obsolete 'makehash
'make-hash-table
"21.4")
813 ;; Some programs still use this as a function.
815 "Return the value of the `baud-rate' variable."
818 (defalias 'focus-frame
'ignore
)
819 (defalias 'unfocus-frame
'ignore
)
822 ;;;; Obsolescence declarations for variables.
824 (make-obsolete-variable 'directory-sep-char
"do not use it." "21.1")
825 (make-obsolete-variable 'mode-line-inverse-video
"use the appropriate faces instead." "21.1")
826 (make-obsolete-variable 'unread-command-char
827 "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."
829 (make-obsolete-variable 'executing-macro
'executing-kbd-macro
"before 19.34")
830 (make-obsolete-variable 'post-command-idle-hook
831 "use timers instead, with `run-with-idle-timer'." "before 19.34")
832 (make-obsolete-variable 'post-command-idle-delay
833 "use timers instead, with `run-with-idle-timer'." "before 19.34")
836 ;;;; Alternate names for functions - these are not being phased out.
838 (defalias 'string
= 'string-equal
)
839 (defalias 'string
< 'string-lessp
)
840 (defalias 'move-marker
'set-marker
)
841 (defalias 'rplaca
'setcar
)
842 (defalias 'rplacd
'setcdr
)
843 (defalias 'beep
'ding
) ;preserve lingual purity
844 (defalias 'indent-to-column
'indent-to
)
845 (defalias 'backward-delete-char
'delete-backward-char
)
846 (defalias 'search-forward-regexp
(symbol-function 're-search-forward
))
847 (defalias 'search-backward-regexp
(symbol-function 're-search-backward
))
848 (defalias 'int-to-string
'number-to-string
)
849 (defalias 'store-match-data
'set-match-data
)
850 (defalias 'make-variable-frame-localizable
'make-variable-frame-local
)
851 ;; These are the XEmacs names:
852 (defalias 'point-at-eol
'line-end-position
)
853 (defalias 'point-at-bol
'line-beginning-position
)
855 ;;; Should this be an obsolete name? If you decide it should, you get
856 ;;; to go through all the sources and change them.
857 (defalias 'string-to-int
'string-to-number
)
859 ;;;; Hook manipulation functions.
861 (defun make-local-hook (hook)
862 "Make the hook HOOK local to the current buffer.
863 The return value is HOOK.
865 You never need to call this function now that `add-hook' does it for you
866 if its LOCAL argument is non-nil.
868 When a hook is local, its local and global values
869 work in concert: running the hook actually runs all the hook
870 functions listed in *either* the local value *or* the global value
871 of the hook variable.
873 This function works by making t a member of the buffer-local value,
874 which acts as a flag to run the hook functions in the default value as
875 well. This works for all normal hooks, but does not work for most
876 non-normal hooks yet. We will be changing the callers of non-normal
877 hooks so that they can handle localness; this has to be done one by
880 This function does nothing if HOOK is already local in the current
883 Do not use `make-local-variable' to make a hook variable buffer-local."
884 (if (local-variable-p hook
)
886 (or (boundp hook
) (set hook nil
))
887 (make-local-variable hook
)
890 (make-obsolete 'make-local-hook
"not necessary any more." "21.1")
892 (defun add-hook (hook function
&optional append local
)
893 "Add to the value of HOOK the function FUNCTION.
894 FUNCTION is not added if already present.
895 FUNCTION is added (if necessary) at the beginning of the hook list
896 unless the optional argument APPEND is non-nil, in which case
897 FUNCTION is added at the end.
899 The optional fourth argument, LOCAL, if non-nil, says to modify
900 the hook's buffer-local value rather than its default value.
901 This makes the hook buffer-local if needed, and it makes t a member
902 of the buffer-local value. That acts as a flag to run the hook
903 functions in the default value as well as in the local value.
905 HOOK should be a symbol, and FUNCTION may be any valid function. If
906 HOOK is void, it is first set to nil. If HOOK's value is a single
907 function, it is changed to a list of functions."
908 (or (boundp hook
) (set hook nil
))
909 (or (default-boundp hook
) (set-default hook nil
))
910 (if local
(unless (local-variable-if-set-p hook
)
911 (set (make-local-variable hook
) (list t
)))
912 ;; Detect the case where make-local-variable was used on a hook
913 ;; and do what we used to do.
914 (unless (and (consp (symbol-value hook
)) (memq t
(symbol-value hook
)))
916 (let ((hook-value (if local
(symbol-value hook
) (default-value hook
))))
917 ;; If the hook value is a single function, turn it into a list.
918 (when (or (not (listp hook-value
)) (eq (car hook-value
) 'lambda
))
919 (setq hook-value
(list hook-value
)))
920 ;; Do the actual addition if necessary
921 (unless (member function hook-value
)
924 (append hook-value
(list function
))
925 (cons function hook-value
))))
926 ;; Set the actual variable
927 (if local
(set hook hook-value
) (set-default hook hook-value
))))
929 (defun remove-hook (hook function
&optional local
)
930 "Remove from the value of HOOK the function FUNCTION.
931 HOOK should be a symbol, and FUNCTION may be any valid function. If
932 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
933 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
935 The optional third argument, LOCAL, if non-nil, says to modify
936 the hook's buffer-local value rather than its default value."
937 (or (boundp hook
) (set hook nil
))
938 (or (default-boundp hook
) (set-default hook nil
))
939 ;; Do nothing if LOCAL is t but this hook has no local binding.
940 (unless (and local
(not (local-variable-p hook
)))
941 ;; Detect the case where make-local-variable was used on a hook
942 ;; and do what we used to do.
943 (when (and (local-variable-p hook
)
944 (not (and (consp (symbol-value hook
))
945 (memq t
(symbol-value hook
)))))
947 (let ((hook-value (if local
(symbol-value hook
) (default-value hook
))))
948 ;; Remove the function, for both the list and the non-list cases.
949 (if (or (not (listp hook-value
)) (eq (car hook-value
) 'lambda
))
950 (if (equal hook-value function
) (setq hook-value nil
))
951 (setq hook-value
(delete function
(copy-sequence hook-value
))))
952 ;; If the function is on the global hook, we need to shadow it locally
953 ;;(when (and local (member function (default-value hook))
954 ;; (not (member (cons 'not function) hook-value)))
955 ;; (push (cons 'not function) hook-value))
956 ;; Set the actual variable
958 (set-default hook hook-value
)
959 (if (equal hook-value
'(t))
960 (kill-local-variable hook
)
961 (set hook hook-value
))))))
963 (defun add-to-list (list-var element
&optional append
)
964 "Add to the value of LIST-VAR the element ELEMENT if it isn't there yet.
965 The test for presence of ELEMENT is done with `equal'.
966 If ELEMENT is added, it is added at the beginning of the list,
967 unless the optional argument APPEND is non-nil, in which case
968 ELEMENT is added at the end.
970 The return value is the new value of LIST-VAR.
972 If you want to use `add-to-list' on a variable that is not defined
973 until a certain package is loaded, you should put the call to `add-to-list'
974 into a hook function that will be run only after loading the package.
975 `eval-after-load' provides one way to do this. In some cases
976 other hooks, such as major mode hooks, can do the job."
977 (if (member element
(symbol-value list-var
))
978 (symbol-value list-var
)
981 (append (symbol-value list-var
) (list element
))
982 (cons element
(symbol-value list-var
))))))
987 ;;; (defvar symbol-file-load-history-loaded nil
988 ;;; "Non-nil means we have loaded the file `fns-VERSION.el' in `exec-directory'.
989 ;;; That file records the part of `load-history' for preloaded files,
990 ;;; which is cleared out before dumping to make Emacs smaller.")
992 ;;; (defun load-symbol-file-load-history ()
993 ;;; "Load the file `fns-VERSION.el' in `exec-directory' if not already done.
994 ;;; That file records the part of `load-history' for preloaded files,
995 ;;; which is cleared out before dumping to make Emacs smaller."
996 ;;; (unless symbol-file-load-history-loaded
997 ;;; (load (expand-file-name
998 ;;; ;; fns-XX.YY.ZZ.el does not work on DOS filesystem.
999 ;;; (if (eq system-type 'ms-dos)
1001 ;;; (format "fns-%s.el" emacs-version))
1003 ;;; ;; The file name fns-%s.el already has a .el extension.
1005 ;;; (setq symbol-file-load-history-loaded t)))
1007 (defun symbol-file (function)
1008 "Return the input source from which FUNCTION was loaded.
1009 The value is normally a string that was passed to `load':
1010 either an absolute file name, or a library name
1011 \(with no directory name and no `.el' or `.elc' at the end).
1012 It can also be nil, if the definition is not associated with any file."
1013 (if (and (symbolp function
) (fboundp function
)
1014 (eq 'autoload
(car-safe (symbol-function function
))))
1015 (nth 1 (symbol-function function
))
1016 (let ((files load-history
)
1019 (if (member function
(cdr (car files
)))
1020 (setq file
(car (car files
)) files nil
))
1021 (setq files
(cdr files
)))
1025 ;;;; Specifying things to do after certain files are loaded.
1027 (defun eval-after-load (file form
)
1028 "Arrange that, if FILE is ever loaded, FORM will be run at that time.
1029 This makes or adds to an entry on `after-load-alist'.
1030 If FILE is already loaded, evaluate FORM right now.
1031 It does nothing if FORM is already on the list for FILE.
1032 FILE must match exactly. Normally FILE is the name of a library,
1033 with no directory or extension specified, since that is how `load'
1035 FILE can also be a feature (i.e. a symbol), in which case FORM is
1036 evaluated whenever that feature is `provide'd."
1037 (let ((elt (assoc file after-load-alist
)))
1038 ;; Make sure there is an element for FILE.
1039 (unless elt
(setq elt
(list file
)) (push elt after-load-alist
))
1040 ;; Add FORM to the element if it isn't there.
1041 (unless (member form
(cdr elt
))
1042 (nconc elt
(list form
))
1043 ;; If the file has been loaded already, run FORM right away.
1044 (if (if (symbolp file
)
1046 ;; Make sure `load-history' contains the files dumped with
1047 ;; Emacs for the case that FILE is one of them.
1048 ;; (load-symbol-file-load-history)
1049 (assoc file load-history
))
1053 (defun eval-next-after-load (file)
1054 "Read the following input sexp, and run it whenever FILE is loaded.
1055 This makes or adds to an entry on `after-load-alist'.
1056 FILE should be the name of a library, with no directory name."
1057 (eval-after-load file
(read)))
1059 ;;; make-network-process wrappers
1061 (if (featurep 'make-network-process
)
1064 (defun open-network-stream (name buffer host service
)
1065 "Open a TCP connection for a service to a host.
1066 Returns a subprocess-object to represent the connection.
1067 Input and output work as for subprocesses; `delete-process' closes it.
1068 Args are NAME BUFFER HOST SERVICE.
1069 NAME is name for process. It is modified if necessary to make it unique.
1070 BUFFER is the buffer (or buffer-name) to associate with the process.
1071 Process output goes at end of that buffer, unless you specify
1072 an output stream or filter function to handle the output.
1073 BUFFER may be also nil, meaning that this process is not associated
1075 Third arg is name of the host to connect to, or its IP address.
1076 Fourth arg SERVICE is name of the service desired, or an integer
1077 specifying a port number to connect to."
1078 (make-network-process :name name
:buffer buffer
1079 :host host
:service service
))
1081 (defun open-network-stream-nowait (name buffer host service
&optional sentinel filter
)
1082 "Initiate connection to a TCP connection for a service to a host.
1083 It returns nil if non-blocking connects are not supported; otherwise,
1084 it returns a subprocess-object to represent the connection.
1086 This function is similar to `open-network-stream', except that this
1087 function returns before the connection is established. When the
1088 connection is completed, the sentinel function will be called with
1089 second arg matching `open' (if successful) or `failed' (on error).
1091 Args are NAME BUFFER HOST SERVICE SENTINEL FILTER.
1092 NAME, BUFFER, HOST, and SERVICE are as for `open-network-stream'.
1093 Optional args, SENTINEL and FILTER specifies the sentinel and filter
1094 functions to be used for this network stream."
1095 (if (featurep 'make-network-process
'(:nowait t
))
1096 (make-network-process :name name
:buffer buffer
:nowait t
1097 :host host
:service service
1098 :filter filter
:sentinel sentinel
)))
1100 (defun open-network-stream-server (name buffer service
&optional sentinel filter
)
1101 "Create a network server process for a TCP service.
1102 It returns nil if server processes are not supported; otherwise,
1103 it returns a subprocess-object to represent the server.
1105 When a client connects to the specified service, a new subprocess
1106 is created to handle the new connection, and the sentinel function
1107 is called for the new process.
1109 Args are NAME BUFFER SERVICE SENTINEL FILTER.
1110 NAME is name for the server process. Client processes are named by
1111 appending the ip-address and port number of the client to NAME.
1112 BUFFER is the buffer (or buffer-name) to associate with the server
1113 process. Client processes will not get a buffer if a process filter
1114 is specified or BUFFER is nil; otherwise, a new buffer is created for
1115 the client process. The name is similar to the process name.
1116 Third arg SERVICE is name of the service desired, or an integer
1117 specifying a port number to connect to. It may also be t to selected
1118 an unused port number for the server.
1119 Optional args, SENTINEL and FILTER specifies the sentinel and filter
1120 functions to be used for the client processes; the server process
1121 does not use these function."
1122 (if (featurep 'make-network-process
'(:server t
))
1123 (make-network-process :name name
:buffer buffer
1124 :service service
:server t
:noquery t
1125 :sentinel sentinel
:filter filter
)))
1127 )) ;; (featurep 'make-network-process)
1132 (defun process-kill-without-query (process &optional flag
)
1133 "Say no query needed if PROCESS is running when Emacs is exited.
1134 Optional second argument if non-nil says to require a query.
1135 Value is t if a query was formerly required.
1136 New code should not use this function; use `process-query-on-exit-flag'
1137 or `set-process-query-on-exit-flag' instead."
1138 (let ((old (process-query-on-exit-flag process
)))
1139 (set-process-query-on-exit-flag process nil
)
1142 ;; process plist management
1144 (defun process-get (process propname
)
1145 "Return the value of PROCESS' PROPNAME property.
1146 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
1147 (plist-get (process-plist process
) propname
))
1149 (defun process-put (process propname value
)
1150 "Change PROCESS' PROPNAME property to VALUE.
1151 It can be retrieved with `(process-get PROCESS PROPNAME)'."
1152 (set-process-plist process
1153 (plist-put (process-plist process
) propname value
)))
1156 ;;;; Input and display facilities.
1158 (defvar read-quoted-char-radix
8
1159 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1160 Legitimate radix values are 8, 10 and 16.")
1162 (custom-declare-variable-early
1163 'read-quoted-char-radix
8
1164 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1165 Legitimate radix values are 8, 10 and 16."
1166 :type
'(choice (const 8) (const 10) (const 16))
1167 :group
'editing-basics
)
1169 (defun read-quoted-char (&optional prompt
)
1170 "Like `read-char', but do not allow quitting.
1171 Also, if the first character read is an octal digit,
1172 we read any number of octal digits and return the
1173 specified character code. Any nondigit terminates the sequence.
1174 If the terminator is RET, it is discarded;
1175 any other terminator is used itself as input.
1177 The optional argument PROMPT specifies a string to use to prompt the user.
1178 The variable `read-quoted-char-radix' controls which radix to use
1180 (let ((message-log-max nil
) done
(first t
) (code 0) char translated
)
1182 (let ((inhibit-quit first
)
1183 ;; Don't let C-h get the help message--only help function keys.
1186 "Type the special character you want to use,
1187 or the octal character code.
1188 RET terminates the character code and is discarded;
1189 any other non-digit terminates the character code and is then used as input."))
1190 (setq char
(read-event (and prompt
(format "%s-" prompt
)) t
))
1191 (if inhibit-quit
(setq quit-flag nil
)))
1192 ;; Translate TAB key into control-I ASCII character, and so on.
1193 ;; Note: `read-char' does it using the `ascii-character' property.
1194 ;; We could try and use read-key-sequence instead, but then C-q ESC
1195 ;; or C-q C-x might not return immediately since ESC or C-x might be
1196 ;; bound to some prefix in function-key-map or key-translation-map.
1197 (setq translated char
)
1198 (let ((translation (lookup-key function-key-map
(vector char
))))
1199 (if (arrayp translation
)
1200 (setq translated
(aref translation
0))))
1201 (cond ((null translated
))
1202 ((not (integerp translated
))
1203 (setq unread-command-events
(list char
)
1205 ((/= (logand translated ?\M-\^
@) 0)
1206 ;; Turn a meta-character into a character with the 0200 bit set.
1207 (setq code
(logior (logand translated
(lognot ?\M-\^
@)) 128)
1209 ((and (<= ?
0 translated
) (< translated
(+ ?
0 (min 10 read-quoted-char-radix
))))
1210 (setq code
(+ (* code read-quoted-char-radix
) (- translated ?
0)))
1211 (and prompt
(setq prompt
(message "%s %c" prompt translated
))))
1212 ((and (<= ?a
(downcase translated
))
1213 (< (downcase translated
) (+ ?a -
10 (min 36 read-quoted-char-radix
))))
1214 (setq code
(+ (* code read-quoted-char-radix
)
1215 (+ 10 (- (downcase translated
) ?a
))))
1216 (and prompt
(setq prompt
(message "%s %c" prompt translated
))))
1217 ((and (not first
) (eq translated ?\C-m
))
1220 (setq unread-command-events
(list char
)
1222 (t (setq code translated
1227 (defun read-passwd (prompt &optional confirm default
)
1228 "Read a password, prompting with PROMPT. Echo `.' for each character typed.
1229 End with RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line.
1230 Optional argument CONFIRM, if non-nil, then read it twice to make sure.
1231 Optional DEFAULT is a default password to use instead of empty input."
1234 (while (not success
)
1235 (let ((first (read-passwd prompt nil default
))
1236 (second (read-passwd "Confirm password: " nil default
)))
1237 (if (equal first second
)
1239 (and (arrayp second
) (clear-string second
))
1240 (setq success first
))
1241 (and (arrayp first
) (clear-string first
))
1242 (and (arrayp second
) (clear-string second
))
1243 (message "Password not repeated accurately; please start over")
1249 (cursor-in-echo-area t
))
1250 (while (progn (message "%s%s"
1252 (make-string (length pass
) ?.
))
1253 (setq c
(read-char-exclusive nil t
))
1254 (and (/= c ?
\r) (/= c ?
\n) (/= c ?\e
)))
1255 (clear-this-command-keys)
1258 (and (arrayp pass
) (clear-string pass
))
1260 (if (and (/= c ?
\b) (/= c ?
\177))
1261 (let* ((new-char (char-to-string c
))
1262 (new-pass (concat pass new-char
)))
1263 (and (arrayp pass
) (clear-string pass
))
1264 (clear-string new-char
)
1266 (setq pass new-pass
))
1267 (if (> (length pass
) 0)
1268 (let ((new-pass (substring pass
0 -
1)))
1269 (and (arrayp pass
) (clear-string pass
))
1270 (setq pass new-pass
))))))
1272 (or pass default
""))))
1274 ;;; Atomic change groups.
1276 (defmacro atomic-change-group
(&rest body
)
1277 "Perform BODY as an atomic change group.
1278 This means that if BODY exits abnormally,
1279 all of its changes to the current buffer are undone.
1280 This works regardless of whether undo is enabled in the buffer.
1282 This mechanism is transparent to ordinary use of undo;
1283 if undo is enabled in the buffer and BODY succeeds, the
1284 user can undo the change normally."
1285 (let ((handle (make-symbol "--change-group-handle--"))
1286 (success (make-symbol "--change-group-success--")))
1287 `(let ((,handle
(prepare-change-group))
1291 ;; This is inside the unwind-protect because
1292 ;; it enables undo if that was disabled; we need
1293 ;; to make sure that it gets disabled again.
1294 (activate-change-group ,handle
)
1297 ;; Either of these functions will disable undo
1298 ;; if it was disabled before.
1300 (accept-change-group ,handle
)
1301 (cancel-change-group ,handle
))))))
1303 (defun prepare-change-group (&optional buffer
)
1304 "Return a handle for the current buffer's state, for a change group.
1305 If you specify BUFFER, make a handle for BUFFER's state instead.
1307 Pass the handle to `activate-change-group' afterward to initiate
1308 the actual changes of the change group.
1310 To finish the change group, call either `accept-change-group' or
1311 `cancel-change-group' passing the same handle as argument. Call
1312 `accept-change-group' to accept the changes in the group as final;
1313 call `cancel-change-group' to undo them all. You should use
1314 `unwind-protect' to make sure the group is always finished. The call
1315 to `activate-change-group' should be inside the `unwind-protect'.
1316 Once you finish the group, don't use the handle again--don't try to
1317 finish the same group twice. For a simple example of correct use, see
1318 the source code of `atomic-change-group'.
1320 The handle records only the specified buffer. To make a multibuffer
1321 change group, call this function once for each buffer you want to
1322 cover, then use `nconc' to combine the returned values, like this:
1324 (nconc (prepare-change-group buffer-1)
1325 (prepare-change-group buffer-2))
1327 You can then activate that multibuffer change group with a single
1328 call to `activate-change-group' and finish it with a single call
1329 to `accept-change-group' or `cancel-change-group'."
1332 (list (cons buffer
(with-current-buffer buffer buffer-undo-list
)))
1333 (list (cons (current-buffer) buffer-undo-list
))))
1335 (defun activate-change-group (handle)
1336 "Activate a change group made with `prepare-change-group' (which see)."
1337 (dolist (elt handle
)
1338 (with-current-buffer (car elt
)
1339 (if (eq buffer-undo-list t
)
1340 (setq buffer-undo-list nil
)))))
1342 (defun accept-change-group (handle)
1343 "Finish a change group made with `prepare-change-group' (which see).
1344 This finishes the change group by accepting its changes as final."
1345 (dolist (elt handle
)
1346 (with-current-buffer (car elt
)
1348 (setq buffer-undo-list t
)))))
1350 (defun cancel-change-group (handle)
1351 "Finish a change group made with `prepare-change-group' (which see).
1352 This finishes the change group by reverting all of its changes."
1353 (dolist (elt handle
)
1354 (with-current-buffer (car elt
)
1355 (setq elt
(cdr elt
))
1357 (if (consp elt
) (car elt
)))
1359 (if (consp elt
) (cdr elt
))))
1360 ;; Temporarily truncate the undo log at ELT.
1362 (setcar elt nil
) (setcdr elt nil
))
1363 (unless (eq last-command
'undo
) (undo-start))
1364 ;; Make sure there's no confusion.
1365 (when (and (consp elt
) (not (eq elt
(last pending-undo-list
))))
1366 (error "Undoing to some unrelated state"))
1368 (while pending-undo-list
(undo-more 1))
1369 ;; Reset the modified cons cell ELT to its original content.
1371 (setcar elt old-car
)
1372 (setcdr elt old-cdr
))
1373 ;; Revert the undo info to what it was when we grabbed the state.
1374 (setq buffer-undo-list elt
)))))
1376 ;; For compatibility.
1377 (defalias 'redraw-modeline
'force-mode-line-update
)
1379 (defun force-mode-line-update (&optional all
)
1380 "Force redisplay of the current buffer's mode line and header line.
1381 With optional non-nil ALL, force redisplay of all mode lines and
1382 header lines. This function also forces recomputation of the
1383 menu bar menus and the frame title."
1384 (if all
(save-excursion (set-buffer (other-buffer))))
1385 (set-buffer-modified-p (buffer-modified-p)))
1387 (defun momentary-string-display (string pos
&optional exit-char message
)
1388 "Momentarily display STRING in the buffer at POS.
1389 Display remains until next character is typed.
1390 If the char is EXIT-CHAR (optional third arg, default is SPC) it is swallowed;
1391 otherwise it is then available as input (as a command if nothing else).
1392 Display MESSAGE (optional fourth arg) in the echo area.
1393 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
1394 (or exit-char
(setq exit-char ?\
))
1395 (let ((inhibit-read-only t
)
1396 ;; Don't modify the undo list at all.
1397 (buffer-undo-list t
)
1398 (modified (buffer-modified-p))
1399 (name buffer-file-name
)
1405 ;; defeat file locking... don't try this at home, kids!
1406 (setq buffer-file-name nil
)
1407 (insert-before-markers string
)
1408 (setq insert-end
(point))
1409 ;; If the message end is off screen, recenter now.
1410 (if (< (window-end nil t
) insert-end
)
1411 (recenter (/ (window-height) 2)))
1412 ;; If that pushed message start off the screen,
1413 ;; scroll to start it at the top of the screen.
1414 (move-to-window-line 0)
1419 (message (or message
"Type %s to continue editing.")
1420 (single-key-description exit-char
))
1421 (let ((char (read-event)))
1422 (or (eq char exit-char
)
1423 (setq unread-command-events
(list char
)))))
1426 (delete-region pos insert-end
)))
1427 (setq buffer-file-name name
)
1428 (set-buffer-modified-p modified
))))
1431 ;;;; Overlay operations
1433 (defun copy-overlay (o)
1434 "Return a copy of overlay O."
1435 (let ((o1 (make-overlay (overlay-start o
) (overlay-end o
)
1436 ;; FIXME: there's no easy way to find the
1437 ;; insertion-type of the two markers.
1438 (overlay-buffer o
)))
1439 (props (overlay-properties o
)))
1441 (overlay-put o1
(pop props
) (pop props
)))
1444 (defun remove-overlays (beg end name val
)
1445 "Clear BEG and END of overlays whose property NAME has value VAL.
1446 Overlays might be moved and or split."
1448 (setq beg
(prog1 end
(setq end beg
))))
1450 (dolist (o (overlays-in beg end
))
1451 (when (eq (overlay-get o name
) val
)
1452 ;; Either push this overlay outside beg...end
1453 ;; or split it to exclude beg...end
1454 ;; or delete it entirely (if it is contained in beg...end).
1455 (if (< (overlay-start o
) beg
)
1456 (if (> (overlay-end o
) end
)
1458 (move-overlay (copy-overlay o
)
1459 (overlay-start o
) beg
)
1460 (move-overlay o end
(overlay-end o
)))
1461 (move-overlay o
(overlay-start o
) beg
))
1462 (if (> (overlay-end o
) end
)
1463 (move-overlay o end
(overlay-end o
))
1464 (delete-overlay o
)))))))
1468 ;; A number of major modes set this locally.
1469 ;; Give it a global value to avoid compiler warnings.
1470 (defvar font-lock-defaults nil
)
1472 (defvar suspend-hook nil
1473 "Normal hook run by `suspend-emacs', before suspending.")
1475 (defvar suspend-resume-hook nil
1476 "Normal hook run by `suspend-emacs', after Emacs is continued.")
1478 (defvar temp-buffer-show-hook nil
1479 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
1480 When the hook runs, the temporary buffer is current, and the window it
1481 was displayed in is selected. This hook is normally set up with a
1482 function to make the buffer read only, and find function names and
1483 variable names in it, provided the major mode is still Help mode.")
1485 (defvar temp-buffer-setup-hook nil
1486 "Normal hook run by `with-output-to-temp-buffer' at the start.
1487 When the hook runs, the temporary buffer is current.
1488 This hook is normally set up with a function to put the buffer in Help
1491 ;; Avoid compiler warnings about this variable,
1492 ;; which has a special meaning on certain system types.
1493 (defvar buffer-file-type nil
1494 "Non-nil if the visited file is a binary file.
1495 This variable is meaningful on MS-DOG and Windows NT.
1496 On those systems, it is automatically local in every buffer.
1497 On other systems, this variable is normally always nil.")
1499 ;; This should probably be written in C (i.e., without using `walk-windows').
1500 (defun get-buffer-window-list (buffer &optional minibuf frame
)
1501 "Return windows currently displaying BUFFER, or nil if none.
1502 See `walk-windows' for the meaning of MINIBUF and FRAME."
1503 (let ((buffer (if (bufferp buffer
) buffer
(get-buffer buffer
))) windows
)
1504 (walk-windows (function (lambda (window)
1505 (if (eq (window-buffer window
) buffer
)
1506 (setq windows
(cons window windows
)))))
1510 (defun ignore (&rest ignore
)
1511 "Do nothing and return nil.
1512 This function accepts any number of arguments, but ignores them."
1516 (defun error (&rest args
)
1517 "Signal an error, making error message by passing all args to `format'.
1518 In Emacs, the convention is that error messages start with a capital
1519 letter but *do not* end with a period. Please follow this convention
1520 for the sake of consistency."
1522 (signal 'error
(list (apply 'format args
)))))
1524 (defalias 'user-original-login-name
'user-login-name
)
1526 (defvar yank-excluded-properties
)
1528 (defun remove-yank-excluded-properties (start end
)
1529 "Remove `yank-excluded-properties' between START and END positions.
1530 Replaces `category' properties with their defined properties."
1531 (let ((inhibit-read-only t
))
1532 ;; Replace any `category' property with the properties it stands for.
1533 (unless (memq yank-excluded-properties
'(t nil
))
1536 (while (< (point) end
)
1537 (let ((cat (get-text-property (point) 'category
))
1540 (next-single-property-change (point) 'category nil end
))
1542 (let (run-end2 original
)
1543 (remove-list-of-text-properties (point) run-end
'(category))
1544 (while (< (point) run-end
)
1545 (setq run-end2
(next-property-change (point) nil run-end
))
1546 (setq original
(text-properties-at (point)))
1547 (set-text-properties (point) run-end2
(symbol-plist cat
))
1548 (add-text-properties (point) run-end2 original
)
1549 (goto-char run-end2
))))
1550 (goto-char run-end
)))))
1551 (if (eq yank-excluded-properties t
)
1552 (set-text-properties start end nil
)
1553 (remove-list-of-text-properties start end yank-excluded-properties
))))
1555 (defvar yank-undo-function
)
1557 (defun insert-for-yank (string)
1558 "Calls `insert-for-yank-1' repetitively for each `yank-handler' segment.
1560 See `insert-for-yank-1' for more details."
1562 (while (setq to
(next-single-property-change 0 'yank-handler string
))
1563 (insert-for-yank-1 (substring string
0 to
))
1564 (setq string
(substring string to
))))
1565 (insert-for-yank-1 string
))
1567 (defun insert-for-yank-1 (string)
1568 "Insert STRING at point, stripping some text properties.
1570 Strip text properties from the inserted text according to
1571 `yank-excluded-properties'. Otherwise just like (insert STRING).
1573 If STRING has a non-nil `yank-handler' property on the first character,
1574 the normal insert behaviour is modified in various ways. The value of
1575 the yank-handler property must be a list with one to five elements
1576 with the following format: (FUNCTION PARAM NOEXCLUDE UNDO).
1577 When FUNCTION is present and non-nil, it is called instead of `insert'
1578 to insert the string. FUNCTION takes one argument--the object to insert.
1579 If PARAM is present and non-nil, it replaces STRING as the object
1580 passed to FUNCTION (or `insert'); for example, if FUNCTION is
1581 `yank-rectangle', PARAM may be a list of strings to insert as a
1583 If NOEXCLUDE is present and non-nil, the normal removal of the
1584 yank-excluded-properties is not performed; instead FUNCTION is
1585 responsible for removing those properties. This may be necessary
1586 if FUNCTION adjusts point before or after inserting the object.
1587 If UNDO is present and non-nil, it is a function that will be called
1588 by `yank-pop' to undo the insertion of the current object. It is
1589 called with two arguments, the start and end of the current region.
1590 FUNCTION may set `yank-undo-function' to override the UNDO value."
1591 (let* ((handler (and (stringp string
)
1592 (get-text-property 0 'yank-handler string
)))
1593 (param (or (nth 1 handler
) string
))
1595 (setq yank-undo-function t
)
1596 (if (nth 0 handler
) ;; FUNCTION
1597 (funcall (car handler
) param
)
1599 (unless (nth 2 handler
) ;; NOEXCLUDE
1600 (remove-yank-excluded-properties opoint
(point)))
1601 (if (eq yank-undo-function t
) ;; not set by FUNCTION
1602 (setq yank-undo-function
(nth 3 handler
))) ;; UNDO
1603 (if (nth 4 handler
) ;; COMMAND
1604 (setq this-command
(nth 4 handler
)))))
1606 (defun insert-buffer-substring-no-properties (buf &optional start end
)
1607 "Insert before point a substring of buffer BUFFER, without text properties.
1608 BUFFER may be a buffer or a buffer name.
1609 Arguments START and END are character numbers specifying the substring.
1610 They default to the beginning and the end of BUFFER."
1611 (let ((opoint (point)))
1612 (insert-buffer-substring buf start end
)
1613 (let ((inhibit-read-only t
))
1614 (set-text-properties opoint
(point) nil
))))
1616 (defun insert-buffer-substring-as-yank (buf &optional start end
)
1617 "Insert before point a part of buffer BUFFER, stripping some text properties.
1618 BUFFER may be a buffer or a buffer name. Arguments START and END are
1619 character numbers specifying the substring. They default to the
1620 beginning and the end of BUFFER. Strip text properties from the
1621 inserted text according to `yank-excluded-properties'."
1622 ;; Since the buffer text should not normally have yank-handler properties,
1623 ;; there is no need to handle them here.
1624 (let ((opoint (point)))
1625 (insert-buffer-substring buf start end
)
1626 (remove-yank-excluded-properties opoint
(point))))
1629 ;; Synchronous shell commands.
1631 (defun start-process-shell-command (name buffer
&rest args
)
1632 "Start a program in a subprocess. Return the process object for it.
1633 Args are NAME BUFFER COMMAND &rest COMMAND-ARGS.
1634 NAME is name for process. It is modified if necessary to make it unique.
1635 BUFFER is the buffer or (buffer-name) to associate with the process.
1636 Process output goes at end of that buffer, unless you specify
1637 an output stream or filter function to handle the output.
1638 BUFFER may be also nil, meaning that this process is not associated
1640 Third arg is command name, the name of a shell command.
1641 Remaining arguments are the arguments for the command.
1642 Wildcards and redirection are handled as usual in the shell."
1644 ((eq system-type
'vax-vms
)
1645 (apply 'start-process name buffer args
))
1646 ;; We used to use `exec' to replace the shell with the command,
1647 ;; but that failed to handle (...) and semicolon, etc.
1649 (start-process name buffer shell-file-name shell-command-switch
1650 (mapconcat 'identity args
" ")))))
1652 (defun call-process-shell-command (command &optional infile buffer display
1654 "Execute the shell command COMMAND synchronously in separate process.
1655 The remaining arguments are optional.
1656 The program's input comes from file INFILE (nil means `/dev/null').
1657 Insert output in BUFFER before point; t means current buffer;
1658 nil for BUFFER means discard it; 0 means discard and don't wait.
1659 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1660 REAL-BUFFER says what to do with standard output, as above,
1661 while STDERR-FILE says what to do with standard error in the child.
1662 STDERR-FILE may be nil (discard standard error output),
1663 t (mix it with ordinary output), or a file name string.
1665 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1666 Remaining arguments are strings passed as additional arguments for COMMAND.
1667 Wildcards and redirection are handled as usual in the shell.
1669 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
1670 Otherwise it waits for COMMAND to terminate and returns a numeric exit
1671 status or a signal description string.
1672 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
1674 ((eq system-type
'vax-vms
)
1675 (apply 'call-process command infile buffer display args
))
1676 ;; We used to use `exec' to replace the shell with the command,
1677 ;; but that failed to handle (...) and semicolon, etc.
1679 (call-process shell-file-name
1680 infile buffer display
1681 shell-command-switch
1682 (mapconcat 'identity
(cons command args
) " ")))))
1684 (defmacro with-current-buffer
(buffer &rest body
)
1685 "Execute the forms in BODY with BUFFER as the current buffer.
1686 The value returned is the value of the last form in BODY.
1687 See also `with-temp-buffer'."
1688 (declare (indent 1) (debug t
))
1689 `(save-current-buffer
1690 (set-buffer ,buffer
)
1693 (defmacro with-selected-window
(window &rest body
)
1694 "Execute the forms in BODY with WINDOW as the selected window.
1695 The value returned is the value of the last form in BODY.
1696 This does not alter the buffer list ordering.
1697 See also `with-temp-buffer'."
1698 (declare (indent 1) (debug t
))
1699 ;; Most of this code is a copy of save-selected-window.
1700 `(let ((save-selected-window-window (selected-window))
1701 (save-selected-window-alist
1702 (mapcar (lambda (frame) (list frame
(frame-selected-window frame
)))
1705 (progn (select-window ,window
'norecord
)
1707 (dolist (elt save-selected-window-alist
)
1708 (and (frame-live-p (car elt
))
1709 (window-live-p (cadr elt
))
1710 (set-frame-selected-window (car elt
) (cadr elt
))))
1711 (if (window-live-p save-selected-window-window
)
1712 ;; This is where the code differs from save-selected-window.
1713 (select-window save-selected-window-window
'norecord
)))))
1715 (defmacro with-temp-file
(file &rest body
)
1716 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
1717 The value returned is the value of the last form in BODY.
1718 See also `with-temp-buffer'."
1720 (let ((temp-file (make-symbol "temp-file"))
1721 (temp-buffer (make-symbol "temp-buffer")))
1722 `(let ((,temp-file
,file
)
1724 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
1727 (with-current-buffer ,temp-buffer
1729 (with-current-buffer ,temp-buffer
1731 (write-region (point-min) (point-max) ,temp-file nil
0)))
1732 (and (buffer-name ,temp-buffer
)
1733 (kill-buffer ,temp-buffer
))))))
1735 (defmacro with-temp-message
(message &rest body
)
1736 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
1737 The original message is restored to the echo area after BODY has finished.
1738 The value returned is the value of the last form in BODY.
1739 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
1740 If MESSAGE is nil, the echo area and message log buffer are unchanged.
1741 Use a MESSAGE of \"\" to temporarily clear the echo area."
1743 (let ((current-message (make-symbol "current-message"))
1744 (temp-message (make-symbol "with-temp-message")))
1745 `(let ((,temp-message
,message
)
1750 (setq ,current-message
(current-message))
1751 (message "%s" ,temp-message
))
1754 (if ,current-message
1755 (message "%s" ,current-message
)
1758 (defmacro with-temp-buffer
(&rest body
)
1759 "Create a temporary buffer, and evaluate BODY there like `progn'.
1760 See also `with-temp-file' and `with-output-to-string'."
1761 (declare (indent 0) (debug t
))
1762 (let ((temp-buffer (make-symbol "temp-buffer")))
1763 `(let ((,temp-buffer
1764 (get-buffer-create (generate-new-buffer-name " *temp*"))))
1766 (with-current-buffer ,temp-buffer
1768 (and (buffer-name ,temp-buffer
)
1769 (kill-buffer ,temp-buffer
))))))
1771 (defmacro with-output-to-string
(&rest body
)
1772 "Execute BODY, return the text it sent to `standard-output', as a string."
1773 (declare (indent 0) (debug t
))
1774 `(let ((standard-output
1775 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
1776 (let ((standard-output standard-output
))
1778 (with-current-buffer standard-output
1781 (kill-buffer nil
)))))
1783 (defmacro with-local-quit
(&rest body
)
1784 "Execute BODY with `inhibit-quit' temporarily bound to nil."
1785 (declare (debug t
) (indent 0))
1786 `(condition-case nil
1787 (let ((inhibit-quit nil
))
1789 (quit (setq quit-flag t
))))
1791 (defmacro combine-after-change-calls
(&rest body
)
1792 "Execute BODY, but don't call the after-change functions till the end.
1793 If BODY makes changes in the buffer, they are recorded
1794 and the functions on `after-change-functions' are called several times
1795 when BODY is finished.
1796 The return value is the value of the last form in BODY.
1798 If `before-change-functions' is non-nil, then calls to the after-change
1799 functions can't be deferred, so in that case this macro has no effect.
1801 Do not alter `after-change-functions' or `before-change-functions'
1803 (declare (indent 0) (debug t
))
1805 (let ((combine-after-change-calls t
))
1807 (combine-after-change-execute)))
1810 (defvar delay-mode-hooks nil
1811 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1812 (defvar delayed-mode-hooks nil
1813 "List of delayed mode hooks waiting to be run.")
1814 (make-variable-buffer-local 'delayed-mode-hooks
)
1815 (put 'delay-mode-hooks
'permanent-local t
)
1817 (defun run-mode-hooks (&rest hooks
)
1818 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1819 Execution is delayed if `delay-mode-hooks' is non-nil.
1820 Major mode functions should use this."
1821 (if delay-mode-hooks
1823 (dolist (hook hooks
)
1824 (push hook delayed-mode-hooks
))
1825 ;; Normal case, just run the hook as before plus any delayed hooks.
1826 (setq hooks
(nconc (nreverse delayed-mode-hooks
) hooks
))
1827 (setq delayed-mode-hooks nil
)
1828 (apply 'run-hooks hooks
)))
1830 (defmacro delay-mode-hooks
(&rest body
)
1831 "Execute BODY, but delay any `run-mode-hooks'.
1832 Only affects hooks run in the current buffer."
1835 (make-local-variable 'delay-mode-hooks
)
1836 (let ((delay-mode-hooks t
))
1839 ;; PUBLIC: find if the current mode derives from another.
1841 (defun derived-mode-p (&rest modes
)
1842 "Non-nil if the current major mode is derived from one of MODES.
1843 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1844 (let ((parent major-mode
))
1845 (while (and (not (memq parent modes
))
1846 (setq parent
(get parent
'derived-mode-parent
))))
1849 (defmacro with-syntax-table
(table &rest body
)
1850 "Evaluate BODY with syntax table of current buffer set to TABLE.
1851 The syntax table of the current buffer is saved, BODY is evaluated, and the
1852 saved table is restored, even in case of an abnormal exit.
1853 Value is what BODY returns."
1855 (let ((old-table (make-symbol "table"))
1856 (old-buffer (make-symbol "buffer")))
1857 `(let ((,old-table
(syntax-table))
1858 (,old-buffer
(current-buffer)))
1861 (set-syntax-table ,table
)
1863 (save-current-buffer
1864 (set-buffer ,old-buffer
)
1865 (set-syntax-table ,old-table
))))))
1867 (defmacro dynamic-completion-table
(fun)
1868 "Use function FUN as a dynamic completion table.
1869 FUN is called with one argument, the string for which completion is required,
1870 and it should return an alist containing all the intended possible
1871 completions. This alist may be a full list of possible completions so that FUN
1872 can ignore the value of its argument. If completion is performed in the
1873 minibuffer, FUN will be called in the buffer from which the minibuffer was
1876 The result of the `dynamic-completion-table' form is a function
1877 that can be used as the ALIST argument to `try-completion' and
1878 `all-completion'. See Info node `(elisp)Programmed Completion'."
1879 (let ((win (make-symbol "window"))
1880 (string (make-symbol "string"))
1881 (predicate (make-symbol "predicate"))
1882 (mode (make-symbol "mode")))
1883 `(lambda (,string
,predicate
,mode
)
1884 (with-current-buffer (let ((,win
(minibuffer-selected-window)))
1885 (if (window-live-p ,win
) (window-buffer ,win
)
1888 ((eq ,mode t
) (all-completions ,string
(,fun
,string
) ,predicate
))
1889 ((not ,mode
) (try-completion ,string
(,fun
,string
) ,predicate
))
1890 (t (test-completion ,string
(,fun
,string
) ,predicate
)))))))
1892 (defmacro lazy-completion-table
(var fun
&rest args
)
1893 "Initialize variable VAR as a lazy completion table.
1894 If the completion table VAR is used for the first time (e.g., by passing VAR
1895 as an argument to `try-completion'), the function FUN is called with arguments
1896 ARGS. FUN must return the completion table that will be stored in VAR.
1897 If completion is requested in the minibuffer, FUN will be called in the buffer
1898 from which the minibuffer was entered. The return value of
1899 `lazy-completion-table' must be used to initialize the value of VAR."
1900 (let ((str (make-symbol "string")))
1901 `(dynamic-completion-table
1903 (unless (listp ,var
)
1904 (setq ,var
(funcall ',fun
,@args
)))
1907 ;;; Matching and substitution
1909 (defvar save-match-data-internal
)
1911 ;; We use save-match-data-internal as the local variable because
1912 ;; that works ok in practice (people should not use that variable elsewhere).
1913 ;; We used to use an uninterned symbol; the compiler handles that properly
1914 ;; now, but it generates slower code.
1915 (defmacro save-match-data
(&rest body
)
1916 "Execute the BODY forms, restoring the global value of the match data.
1917 The value returned is the value of the last form in BODY."
1918 ;; It is better not to use backquote here,
1919 ;; because that makes a bootstrapping problem
1920 ;; if you need to recompile all the Lisp files using interpreted code.
1921 (declare (indent 0) (debug t
))
1923 '((save-match-data-internal (match-data)))
1924 (list 'unwind-protect
1926 '(set-match-data save-match-data-internal
))))
1928 (defun match-string (num &optional string
)
1929 "Return string of text matched by last search.
1930 NUM specifies which parenthesized expression in the last regexp.
1931 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
1932 Zero means the entire text matched by the whole regexp or whole string.
1933 STRING should be given if the last search was by `string-match' on STRING."
1934 (if (match-beginning num
)
1936 (substring string
(match-beginning num
) (match-end num
))
1937 (buffer-substring (match-beginning num
) (match-end num
)))))
1939 (defun match-string-no-properties (num &optional string
)
1940 "Return string of text matched by last search, without text properties.
1941 NUM specifies which parenthesized expression in the last regexp.
1942 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
1943 Zero means the entire text matched by the whole regexp or whole string.
1944 STRING should be given if the last search was by `string-match' on STRING."
1945 (if (match-beginning num
)
1948 (substring string
(match-beginning num
) (match-end num
))))
1949 (set-text-properties 0 (length result
) nil result
)
1951 (buffer-substring-no-properties (match-beginning num
)
1954 (defun looking-back (regexp &optional limit
)
1955 "Return non-nil if text before point matches regular expression REGEXP.
1956 Like `looking-at' except backwards and slower.
1957 LIMIT if non-nil speeds up the search by specifying how far back the
1960 (re-search-backward (concat "\\(?:" regexp
"\\)\\=") limit t
)))
1962 (defconst split-string-default-separators
"[ \f\t\n\r\v]+"
1963 "The default value of separators for `split-string'.
1965 A regexp matching strings of whitespace. May be locale-dependent
1966 \(as yet unimplemented). Should not match non-breaking spaces.
1968 Warning: binding this to a different value and using it as default is
1969 likely to have undesired semantics.")
1971 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
1972 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
1973 ;; expression leads to the equivalent implementation that if SEPARATORS
1974 ;; is defaulted, OMIT-NULLS is treated as t.
1975 (defun split-string (string &optional separators omit-nulls
)
1976 "Splits STRING into substrings bounded by matches for SEPARATORS.
1978 The beginning and end of STRING, and each match for SEPARATORS, are
1979 splitting points. The substrings matching SEPARATORS are removed, and
1980 the substrings between the splitting points are collected as a list,
1983 If SEPARATORS is non-nil, it should be a regular expression matching text
1984 which separates, but is not part of, the substrings. If nil it defaults to
1985 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
1986 OMIT-NULLS is forced to t.
1988 If OMIT-NULLs is t, zero-length substrings are omitted from the list \(so
1989 that for the default value of SEPARATORS leading and trailing whitespace
1990 are effectively trimmed). If nil, all zero-length substrings are retained,
1991 which correctly parses CSV format, for example.
1993 Note that the effect of `(split-string STRING)' is the same as
1994 `(split-string STRING split-string-default-separators t)'). In the rare
1995 case that you wish to retain zero-length substrings when splitting on
1996 whitespace, use `(split-string STRING split-string-default-separators)'.
1998 Modifies the match data; use `save-match-data' if necessary."
1999 (let ((keep-nulls (not (if separators omit-nulls t
)))
2000 (rexp (or separators split-string-default-separators
))
2004 (while (and (string-match rexp string
2006 (= start
(match-beginning 0))
2007 (< start
(length string
)))
2009 (< start
(length string
)))
2011 (if (or keep-nulls
(< start
(match-beginning 0)))
2013 (cons (substring string start
(match-beginning 0))
2015 (setq start
(match-end 0)))
2016 (if (or keep-nulls
(< start
(length string
)))
2018 (cons (substring string start
)
2022 (defun subst-char-in-string (fromchar tochar string
&optional inplace
)
2023 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
2024 Unless optional argument INPLACE is non-nil, return a new string."
2025 (let ((i (length string
))
2026 (newstr (if inplace string
(copy-sequence string
))))
2029 (if (eq (aref newstr i
) fromchar
)
2030 (aset newstr i tochar
)))
2033 (defun replace-regexp-in-string (regexp rep string
&optional
2034 fixedcase literal subexp start
)
2035 "Replace all matches for REGEXP with REP in STRING.
2037 Return a new string containing the replacements.
2039 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
2040 arguments with the same names of function `replace-match'. If START
2041 is non-nil, start replacements at that index in STRING.
2043 REP is either a string used as the NEWTEXT arg of `replace-match' or a
2044 function. If it is a function it is applied to each match to generate
2045 the replacement passed to `replace-match'; the match-data at this
2046 point are such that match 0 is the function's argument.
2048 To replace only the first match (if any), make REGEXP match up to \\'
2049 and replace a sub-expression, e.g.
2050 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
2054 ;; To avoid excessive consing from multiple matches in long strings,
2055 ;; don't just call `replace-match' continually. Walk down the
2056 ;; string looking for matches of REGEXP and building up a (reversed)
2057 ;; list MATCHES. This comprises segments of STRING which weren't
2058 ;; matched interspersed with replacements for segments that were.
2059 ;; [For a `large' number of replacements it's more efficient to
2060 ;; operate in a temporary buffer; we can't tell from the function's
2061 ;; args whether to choose the buffer-based implementation, though it
2062 ;; might be reasonable to do so for long enough STRING.]
2063 (let ((l (length string
))
2064 (start (or start
0))
2067 (while (and (< start l
) (string-match regexp string start
))
2068 (setq mb
(match-beginning 0)
2070 ;; If we matched the empty string, make sure we advance by one char
2071 (when (= me mb
) (setq me
(min l
(1+ mb
))))
2072 ;; Generate a replacement for the matched substring.
2073 ;; Operate only on the substring to minimize string consing.
2074 ;; Set up match data for the substring for replacement;
2075 ;; presumably this is likely to be faster than munging the
2076 ;; match data directly in Lisp.
2077 (string-match regexp
(setq str
(substring string mb me
)))
2079 (cons (replace-match (if (stringp rep
)
2081 (funcall rep
(match-string 0 str
)))
2082 fixedcase literal str subexp
)
2083 (cons (substring string start mb
) ; unmatched prefix
2086 ;; Reconstruct a string from the pieces.
2087 (setq matches
(cons (substring string start l
) matches
)) ; leftover
2088 (apply #'concat
(nreverse matches
)))))
2090 (defun shell-quote-argument (argument)
2091 "Quote an argument for passing as argument to an inferior shell."
2092 (if (eq system-type
'ms-dos
)
2093 ;; Quote using double quotes, but escape any existing quotes in
2094 ;; the argument with backslashes.
2098 (if (or (null (string-match "[^\"]" argument
))
2099 (< (match-end 0) (length argument
)))
2100 (while (string-match "[\"]" argument start
)
2101 (setq end
(match-beginning 0)
2102 result
(concat result
(substring argument start end
)
2103 "\\" (substring argument end
(1+ end
)))
2105 (concat "\"" result
(substring argument start
) "\""))
2106 (if (eq system-type
'windows-nt
)
2107 (concat "\"" argument
"\"")
2108 (if (equal argument
"")
2110 ;; Quote everything except POSIX filename characters.
2111 ;; This should be safe enough even for really weird shells.
2112 (let ((result "") (start 0) end
)
2113 (while (string-match "[^-0-9a-zA-Z_./]" argument start
)
2114 (setq end
(match-beginning 0)
2115 result
(concat result
(substring argument start end
)
2116 "\\" (substring argument end
(1+ end
)))
2118 (concat result
(substring argument start
)))))))
2120 (defun make-syntax-table (&optional oldtable
)
2121 "Return a new syntax table.
2122 Create a syntax table which inherits from OLDTABLE (if non-nil) or
2123 from `standard-syntax-table' otherwise."
2124 (let ((table (make-char-table 'syntax-table nil
)))
2125 (set-char-table-parent table
(or oldtable
(standard-syntax-table)))
2128 (defun syntax-after (pos)
2129 "Return the syntax of the char after POS."
2130 (unless (or (< pos
(point-min)) (>= pos
(point-max)))
2131 (let ((st (if parse-sexp-lookup-properties
2132 (get-char-property pos
'syntax-table
))))
2134 (aref (or st
(syntax-table)) (char-after pos
))))))
2136 (defun add-to-invisibility-spec (arg)
2137 "Add elements to `buffer-invisibility-spec'.
2138 See documentation for `buffer-invisibility-spec' for the kind of elements
2140 (if (eq buffer-invisibility-spec t
)
2141 (setq buffer-invisibility-spec
(list t
)))
2142 (setq buffer-invisibility-spec
2143 (cons arg buffer-invisibility-spec
)))
2145 (defun remove-from-invisibility-spec (arg)
2146 "Remove elements from `buffer-invisibility-spec'."
2147 (if (consp buffer-invisibility-spec
)
2148 (setq buffer-invisibility-spec
(delete arg buffer-invisibility-spec
))))
2150 (defun global-set-key (key command
)
2151 "Give KEY a global binding as COMMAND.
2152 COMMAND is the command definition to use; usually it is
2153 a symbol naming an interactively-callable function.
2154 KEY is a key sequence; noninteractively, it is a string or vector
2155 of characters or event types, and non-ASCII characters with codes
2156 above 127 (such as ISO Latin-1) can be included if you use a vector.
2158 Note that if KEY has a local binding in the current buffer,
2159 that local binding will continue to shadow any global binding
2160 that you make with this function."
2161 (interactive "KSet key globally: \nCSet key %s to command: ")
2162 (or (vectorp key
) (stringp key
)
2163 (signal 'wrong-type-argument
(list 'arrayp key
)))
2164 (define-key (current-global-map) key command
))
2166 (defun local-set-key (key command
)
2167 "Give KEY a local binding as COMMAND.
2168 COMMAND is the command definition to use; usually it is
2169 a symbol naming an interactively-callable function.
2170 KEY is a key sequence; noninteractively, it is a string or vector
2171 of characters or event types, and non-ASCII characters with codes
2172 above 127 (such as ISO Latin-1) can be included if you use a vector.
2174 The binding goes in the current buffer's local map,
2175 which in most cases is shared with all other buffers in the same major mode."
2176 (interactive "KSet key locally: \nCSet key %s locally to command: ")
2177 (let ((map (current-local-map)))
2179 (use-local-map (setq map
(make-sparse-keymap))))
2180 (or (vectorp key
) (stringp key
)
2181 (signal 'wrong-type-argument
(list 'arrayp key
)))
2182 (define-key map key command
)))
2184 (defun global-unset-key (key)
2185 "Remove global binding of KEY.
2186 KEY is a string representing a sequence of keystrokes."
2187 (interactive "kUnset key globally: ")
2188 (global-set-key key nil
))
2190 (defun local-unset-key (key)
2191 "Remove local binding of KEY.
2192 KEY is a string representing a sequence of keystrokes."
2193 (interactive "kUnset key locally: ")
2194 (if (current-local-map)
2195 (local-set-key key nil
))
2198 ;; We put this here instead of in frame.el so that it's defined even on
2199 ;; systems where frame.el isn't loaded.
2200 (defun frame-configuration-p (object)
2201 "Return non-nil if OBJECT seems to be a frame configuration.
2202 Any list whose car is `frame-configuration' is assumed to be a frame
2205 (eq (car object
) 'frame-configuration
)))
2207 (defun functionp (object)
2208 "Non-nil iff OBJECT is a type of object that can be called as a function."
2209 (or (and (symbolp object
) (fboundp object
)
2211 (setq object
(indirect-function object
))
2213 (eq (car-safe object
) 'autoload
)
2214 (not (car-safe (cdr-safe (cdr-safe (cdr-safe (cdr-safe object
)))))))
2215 (subrp object
) (byte-code-function-p object
)
2216 (eq (car-safe object
) 'lambda
)))
2218 (defun interactive-form (function)
2219 "Return the interactive form of FUNCTION.
2220 If function is a command (see `commandp'), value is a list of the form
2221 \(interactive SPEC). If function is not a command, return nil."
2222 (setq function
(indirect-function function
))
2223 (when (commandp function
)
2224 (cond ((byte-code-function-p function
)
2225 (when (> (length function
) 5)
2226 (let ((spec (aref function
5)))
2228 (list 'interactive spec
)
2229 (list 'interactive
)))))
2231 (subr-interactive-form function
))
2232 ((eq (car-safe function
) 'lambda
)
2233 (setq function
(cddr function
))
2234 (when (stringp (car function
))
2235 (setq function
(cdr function
)))
2236 (let ((form (car function
)))
2237 (when (eq (car-safe form
) 'interactive
)
2238 (copy-sequence form
)))))))
2240 (defun assq-delete-all (key alist
)
2241 "Delete from ALIST all elements whose car is KEY.
2242 Return the modified alist.
2243 Elements of ALIST that are not conses are ignored."
2246 (if (and (consp (car tail
)) (eq (car (car tail
)) key
))
2247 (setq alist
(delq (car tail
) alist
)))
2248 (setq tail
(cdr tail
)))
2251 (defun make-temp-file (prefix &optional dir-flag suffix
)
2252 "Create a temporary file.
2253 The returned file name (created by appending some random characters at the end
2254 of PREFIX, and expanding against `temporary-file-directory' if necessary),
2255 is guaranteed to point to a newly created empty file.
2256 You can then use `write-region' to write new data into the file.
2258 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
2260 If SUFFIX is non-nil, add that at the end of the file name."
2261 (let ((umask (default-file-modes))
2265 ;; Create temp files with strict access rights. It's easy to
2266 ;; loosen them later, whereas it's impossible to close the
2267 ;; time-window of loose permissions otherwise.
2268 (set-default-file-modes ?
\700)
2269 (while (condition-case ()
2273 (expand-file-name prefix temporary-file-directory
)))
2275 (setq file
(concat file suffix
)))
2277 (make-directory file
)
2278 (write-region "" nil file nil
'silent nil
'excl
))
2280 (file-already-exists t
))
2281 ;; the file was somehow created by someone else between
2282 ;; `make-temp-name' and `write-region', let's try again.
2286 (set-default-file-modes umask
))))
2289 ;; If a minor mode is not defined with define-minor-mode,
2290 ;; add it here explicitly.
2291 ;; isearch-mode is deliberately excluded, since you should
2292 ;; not call it yourself.
2293 (defvar minor-mode-list
'(auto-save-mode auto-fill-mode abbrev-mode
2294 overwrite-mode view-mode
2296 "List of all minor mode functions.")
2298 (defun add-minor-mode (toggle name
&optional keymap after toggle-fun
)
2299 "Register a new minor mode.
2301 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
2303 TOGGLE is a symbol which is the name of a buffer-local variable that
2304 is toggled on or off to say whether the minor mode is active or not.
2306 NAME specifies what will appear in the mode line when the minor mode
2307 is active. NAME should be either a string starting with a space, or a
2308 symbol whose value is such a string.
2310 Optional KEYMAP is the keymap for the minor mode that will be added
2311 to `minor-mode-map-alist'.
2313 Optional AFTER specifies that TOGGLE should be added after AFTER
2314 in `minor-mode-alist'.
2316 Optional TOGGLE-FUN is an interactive function to toggle the mode.
2317 It defaults to (and should by convention be) TOGGLE.
2319 If TOGGLE has a non-nil `:included' property, an entry for the mode is
2320 included in the mode-line minor mode menu.
2321 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
2322 (unless (memq toggle minor-mode-list
)
2323 (push toggle minor-mode-list
))
2325 (unless toggle-fun
(setq toggle-fun toggle
))
2326 ;; Add the name to the minor-mode-alist.
2328 (let ((existing (assq toggle minor-mode-alist
)))
2330 (setcdr existing
(list name
))
2331 (let ((tail minor-mode-alist
) found
)
2332 (while (and tail
(not found
))
2333 (if (eq after
(caar tail
))
2335 (setq tail
(cdr tail
))))
2337 (let ((rest (cdr found
)))
2339 (nconc found
(list (list toggle name
)) rest
))
2340 (setq minor-mode-alist
(cons (list toggle name
)
2341 minor-mode-alist
)))))))
2342 ;; Add the toggle to the minor-modes menu if requested.
2343 (when (get toggle
:included
)
2344 (define-key mode-line-mode-menu
2348 (or (get toggle
:menu-tag
)
2349 (if (stringp name
) name
(symbol-name toggle
)))
2350 (let ((mode-name (if (symbolp name
) (symbol-value name
))))
2351 (if (and (stringp mode-name
) (string-match "[^ ]+" mode-name
))
2352 (concat " (" (match-string 0 mode-name
) ")"))))
2354 :button
(cons :toggle toggle
))))
2356 ;; Add the map to the minor-mode-map-alist.
2358 (let ((existing (assq toggle minor-mode-map-alist
)))
2360 (setcdr existing keymap
)
2361 (let ((tail minor-mode-map-alist
) found
)
2362 (while (and tail
(not found
))
2363 (if (eq after
(caar tail
))
2365 (setq tail
(cdr tail
))))
2367 (let ((rest (cdr found
)))
2369 (nconc found
(list (cons toggle keymap
)) rest
))
2370 (setq minor-mode-map-alist
(cons (cons toggle keymap
)
2371 minor-mode-map-alist
))))))))
2373 ;; Clones ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2375 (defun text-clone-maintain (ol1 after beg end
&optional len
)
2376 "Propagate the changes made under the overlay OL1 to the other clones.
2377 This is used on the `modification-hooks' property of text clones."
2378 (when (and after
(not undo-in-progress
) (overlay-start ol1
))
2379 (let ((margin (if (overlay-get ol1
'text-clone-spreadp
) 1 0)))
2380 (setq beg
(max beg
(+ (overlay-start ol1
) margin
)))
2381 (setq end
(min end
(- (overlay-end ol1
) margin
)))
2384 (when (overlay-get ol1
'text-clone-syntax
)
2385 ;; Check content of the clone's text.
2386 (let ((cbeg (+ (overlay-start ol1
) margin
))
2387 (cend (- (overlay-end ol1
) margin
)))
2390 (if (not (re-search-forward
2391 (overlay-get ol1
'text-clone-syntax
) cend t
))
2392 ;; Mark the overlay for deletion.
2393 (overlay-put ol1
'text-clones nil
)
2394 (when (< (match-end 0) cend
)
2395 ;; Shrink the clone at its end.
2396 (setq end
(min end
(match-end 0)))
2397 (move-overlay ol1
(overlay-start ol1
)
2398 (+ (match-end 0) margin
)))
2399 (when (> (match-beginning 0) cbeg
)
2400 ;; Shrink the clone at its beginning.
2401 (setq beg
(max (match-beginning 0) beg
))
2402 (move-overlay ol1
(- (match-beginning 0) margin
)
2403 (overlay-end ol1
)))))))
2404 ;; Now go ahead and update the clones.
2405 (let ((head (- beg
(overlay-start ol1
)))
2406 (tail (- (overlay-end ol1
) end
))
2407 (str (buffer-substring beg end
))
2409 (inhibit-modification-hooks t
))
2410 (dolist (ol2 (overlay-get ol1
'text-clones
))
2411 (let ((oe (overlay-end ol2
)))
2412 (unless (or (eq ol1 ol2
) (null oe
))
2413 (setq nothing-left nil
)
2414 (let ((mod-beg (+ (overlay-start ol2
) head
)))
2415 ;;(overlay-put ol2 'modification-hooks nil)
2416 (goto-char (- (overlay-end ol2
) tail
))
2417 (unless (> mod-beg
(point))
2418 (save-excursion (insert str
))
2419 (delete-region mod-beg
(point)))
2420 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
2422 (if nothing-left
(delete-overlay ol1
))))))))
2424 (defun text-clone-create (start end
&optional spreadp syntax
)
2425 "Create a text clone of START...END at point.
2426 Text clones are chunks of text that are automatically kept identical:
2427 changes done to one of the clones will be immediately propagated to the other.
2429 The buffer's content at point is assumed to be already identical to
2430 the one between START and END.
2431 If SYNTAX is provided it's a regexp that describes the possible text of
2432 the clones; the clone will be shrunk or killed if necessary to ensure that
2433 its text matches the regexp.
2434 If SPREADP is non-nil it indicates that text inserted before/after the
2435 clone should be incorporated in the clone."
2436 ;; To deal with SPREADP we can either use an overlay with `nil t' along
2437 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
2438 ;; (with a one-char margin at each end) with `t nil'.
2439 ;; We opted for a larger overlay because it behaves better in the case
2440 ;; where the clone is reduced to the empty string (we want the overlay to
2441 ;; stay when the clone's content is the empty string and we want to use
2442 ;; `evaporate' to make sure those overlays get deleted when needed).
2444 (let* ((pt-end (+ (point) (- end start
)))
2445 (start-margin (if (or (not spreadp
) (bobp) (<= start
(point-min)))
2447 (end-margin (if (or (not spreadp
)
2448 (>= pt-end
(point-max))
2449 (>= start
(point-max)))
2451 (ol1 (make-overlay (- start start-margin
) (+ end end-margin
) nil t
))
2452 (ol2 (make-overlay (- (point) start-margin
) (+ pt-end end-margin
) nil t
))
2453 (dups (list ol1 ol2
)))
2454 (overlay-put ol1
'modification-hooks
'(text-clone-maintain))
2455 (when spreadp
(overlay-put ol1
'text-clone-spreadp t
))
2456 (when syntax
(overlay-put ol1
'text-clone-syntax syntax
))
2457 ;;(overlay-put ol1 'face 'underline)
2458 (overlay-put ol1
'evaporate t
)
2459 (overlay-put ol1
'text-clones dups
)
2461 (overlay-put ol2
'modification-hooks
'(text-clone-maintain))
2462 (when spreadp
(overlay-put ol2
'text-clone-spreadp t
))
2463 (when syntax
(overlay-put ol2
'text-clone-syntax syntax
))
2464 ;;(overlay-put ol2 'face 'underline)
2465 (overlay-put ol2
'evaporate t
)
2466 (overlay-put ol2
'text-clones dups
)))
2468 (defun play-sound (sound)
2469 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2470 The following keywords are recognized:
2472 :file FILE - read sound data from FILE. If FILE isn't an
2473 absolute file name, it is searched in `data-directory'.
2475 :data DATA - read sound data from string DATA.
2477 Exactly one of :file or :data must be present.
2479 :volume VOL - set volume to VOL. VOL must an integer in the
2480 range 0..100 or a float in the range 0..1.0. If not specified,
2481 don't change the volume setting of the sound device.
2483 :device DEVICE - play sound on DEVICE. If not specified,
2484 a system-dependent default device name is used."
2485 (unless (fboundp 'play-sound-internal
)
2486 (error "This Emacs binary lacks sound support"))
2487 (play-sound-internal sound
))
2489 (defun define-mail-user-agent (symbol composefunc sendfunc
2490 &optional abortfunc hookvar
)
2491 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
2493 SYMBOL can be any Lisp symbol. Its function definition and/or
2494 value as a variable do not matter for this usage; we use only certain
2495 properties on its property list, to encode the rest of the arguments.
2497 COMPOSEFUNC is program callable function that composes an outgoing
2498 mail message buffer. This function should set up the basics of the
2499 buffer without requiring user interaction. It should populate the
2500 standard mail headers, leaving the `to:' and `subject:' headers blank
2503 COMPOSEFUNC should accept several optional arguments--the same
2504 arguments that `compose-mail' takes. See that function's documentation.
2506 SENDFUNC is the command a user would run to send the message.
2508 Optional ABORTFUNC is the command a user would run to abort the
2509 message. For mail packages that don't have a separate abort function,
2510 this can be `kill-buffer' (the equivalent of omitting this argument).
2512 Optional HOOKVAR is a hook variable that gets run before the message
2513 is actually sent. Callers that use the `mail-user-agent' may
2514 install a hook function temporarily on this hook variable.
2515 If HOOKVAR is nil, `mail-send-hook' is used.
2517 The properties used on SYMBOL are `composefunc', `sendfunc',
2518 `abortfunc', and `hookvar'."
2519 (put symbol
'composefunc composefunc
)
2520 (put symbol
'sendfunc sendfunc
)
2521 (put symbol
'abortfunc
(or abortfunc
'kill-buffer
))
2522 (put symbol
'hookvar
(or hookvar
'mail-send-hook
)))
2524 ;;; arch-tag: f7e0e6e5-70aa-4897-ae72-7a3511ec40bc
2525 ;;; subr.el ends here