1 ;;; subr.el --- basic lisp subroutines for Emacs
3 ;; Copyright (C) 1985, 1986, 1992, 1994, 1995, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005 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 ;;;; Lisp language features.
44 (defmacro noreturn
(form)
45 "Evaluates FORM, with the expectation that the evaluation will signal an error
46 instead of returning to its caller. If FORM does return, an error is
49 (error "Form marked with `noreturn' did return")))
51 (defmacro 1value
(form)
52 "Evaluates FORM, with the expectation that the same value will be returned
53 from all evaluations of FORM. This is the global do-nothing
54 version of `1value'. There is also `testcover-1value' that
55 complains if FORM ever does return differing values."
58 (defmacro lambda
(&rest cdr
)
59 "Return a lambda expression.
60 A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
61 self-quoting; the result of evaluating the lambda expression is the
62 expression itself. The lambda expression may then be treated as a
63 function, i.e., stored as the function value of a symbol, passed to
64 `funcall' or `mapcar', etc.
66 ARGS should take the same form as an argument list for a `defun'.
67 DOCSTRING is an optional documentation string.
68 If present, it should describe how to call the function.
69 But documentation strings are usually not useful in nameless functions.
70 INTERACTIVE should be a call to the function `interactive', which see.
71 It may also be omitted.
72 BODY should be a list of Lisp expressions.
74 \(fn ARGS [DOCSTRING] [INTERACTIVE] BODY)"
75 ;; Note that this definition should not use backquotes; subr.el should not
76 ;; depend on backquote.el.
77 (list 'function
(cons 'lambda cdr
)))
79 (defmacro push
(newelt listname
)
80 "Add NEWELT to the list stored in the symbol LISTNAME.
81 This is equivalent to (setq LISTNAME (cons NEWELT LISTNAME)).
82 LISTNAME must be a symbol."
83 (declare (debug (form sexp
)))
85 (list 'cons newelt listname
)))
87 (defmacro pop
(listname)
88 "Return the first element of LISTNAME's value, and remove it from the list.
89 LISTNAME must be a symbol whose value is a list.
90 If the value is nil, `pop' returns nil but does not actually
92 (declare (debug (sexp)))
95 (list 'setq listname
(list 'cdr listname
)))))
97 (defmacro when
(cond &rest body
)
98 "If COND yields non-nil, do BODY, else return nil."
99 (declare (indent 1) (debug t
))
100 (list 'if cond
(cons 'progn body
)))
102 (defmacro unless
(cond &rest body
)
103 "If COND yields nil, do BODY, else return nil."
104 (declare (indent 1) (debug t
))
105 (cons 'if
(cons cond
(cons nil body
))))
107 (defmacro dolist
(spec &rest body
)
109 Evaluate BODY with VAR bound to each car from LIST, in turn.
110 Then evaluate RESULT to get return value, default nil.
112 \(fn (VAR LIST [RESULT]) BODY...)"
113 (declare (indent 1) (debug ((symbolp form
&optional form
) body
)))
114 (let ((temp (make-symbol "--dolist-temp--")))
115 `(let ((,temp
,(nth 1 spec
))
118 (setq ,(car spec
) (car ,temp
))
119 (setq ,temp
(cdr ,temp
))
121 ,@(if (cdr (cdr spec
))
122 `((setq ,(car spec
) nil
) ,@(cdr (cdr spec
)))))))
124 (defmacro dotimes
(spec &rest body
)
125 "Loop a certain number of times.
126 Evaluate BODY with VAR bound to successive integers running from 0,
127 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
128 the return value (nil if RESULT is omitted).
130 \(fn (VAR COUNT [RESULT]) BODY...)"
131 (declare (indent 1) (debug dolist
))
132 (let ((temp (make-symbol "--dotimes-temp--"))
136 (,(car spec
) ,start
))
137 (while (< ,(car spec
) ,temp
)
139 (setq ,(car spec
) (1+ ,(car spec
))))
140 ,@(cdr (cdr spec
)))))
142 (defmacro declare
(&rest specs
)
143 "Do not evaluate any arguments and return nil.
144 Treated as a declaration when used at the right place in a
145 `defmacro' form. \(See Info anchor `(elisp)Definition of declare'.)"
149 "Return the car of the car of X."
153 "Return the car of the cdr of X."
157 "Return the cdr of the car of X."
161 "Return the cdr of the cdr of X."
164 (defun last (list &optional n
)
165 "Return the last link of LIST. Its car is the last element.
166 If LIST is nil, return nil.
167 If N is non-nil, return the Nth-to-last link of LIST.
168 If N is bigger than the length of LIST, return LIST."
170 (let ((m 0) (p list
))
172 (setq m
(1+ m
) p
(cdr p
)))
174 (if (< n m
) (nthcdr (- m n
) list
) list
)))
175 (while (consp (cdr list
))
176 (setq list
(cdr list
)))
179 (defun butlast (list &optional n
)
180 "Return a copy of LIST with the last N elements removed."
181 (if (and n
(<= n
0)) list
182 (nbutlast (copy-sequence list
) n
)))
184 (defun nbutlast (list &optional n
)
185 "Modifies LIST to remove the last N elements."
186 (let ((m (length list
)))
190 (if (> n
0) (setcdr (nthcdr (- (1- m
) n
) list
) nil
))
193 (defun delete-dups (list)
194 "Destructively remove `equal' duplicates from LIST.
195 Store the result in LIST and return it. LIST must be a proper list.
196 Of several `equal' occurrences of an element in LIST, the first
200 (setcdr tail
(delete (car tail
) (cdr tail
)))
201 (setq tail
(cdr tail
))))
204 (defun number-sequence (from &optional to inc
)
205 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
206 INC is the increment used between numbers in the sequence and defaults to 1.
207 So, the Nth element of the list is \(+ FROM \(* N INC)) where N counts from
208 zero. TO is only included if there is an N for which TO = FROM + N * INC.
209 If TO is nil or numerically equal to FROM, return \(FROM).
210 If INC is positive and TO is less than FROM, or INC is negative
211 and TO is larger than FROM, return nil.
212 If INC is zero and TO is neither nil nor numerically equal to
213 FROM, signal an error.
215 This function is primarily designed for integer arguments.
216 Nevertheless, FROM, TO and INC can be integer or float. However,
217 floating point arithmetic is inexact. For instance, depending on
218 the machine, it may quite well happen that
219 \(number-sequence 0.4 0.6 0.2) returns the one element list \(0.4),
220 whereas \(number-sequence 0.4 0.8 0.2) returns a list with three
221 elements. Thus, if some of the arguments are floats and one wants
222 to make sure that TO is included, one may have to explicitly write
223 TO as \(+ FROM \(* N INC)) or use a variable whose value was
224 computed with this exact expression. Alternatively, you can,
225 of course, also replace TO with a slightly larger value
226 \(or a slightly more negative value if INC is negative)."
227 (if (or (not to
) (= from to
))
229 (or inc
(setq inc
1))
230 (when (zerop inc
) (error "The increment can not be zero"))
231 (let (seq (n 0) (next from
))
234 (setq seq
(cons next seq
)
236 next
(+ from
(* n inc
))))
238 (setq seq
(cons next seq
)
240 next
(+ from
(* n inc
)))))
243 (defun remove (elt seq
)
244 "Return a copy of SEQ with all occurrences of ELT removed.
245 SEQ must be a list, vector, or string. The comparison is done with `equal'."
247 ;; If SEQ isn't a list, there's no need to copy SEQ because
248 ;; `delete' will return a new object.
250 (delete elt
(copy-sequence seq
))))
252 (defun remq (elt list
)
253 "Return LIST with all occurrences of ELT removed.
254 The comparison is done with `eq'. Contrary to `delq', this does not use
255 side-effects, and the argument LIST is not modified."
257 (delq elt
(copy-sequence list
))
260 (defun copy-tree (tree &optional vecp
)
261 "Make a copy of TREE.
262 If TREE is a cons cell, this recursively copies both its car and its cdr.
263 Contrast to `copy-sequence', which copies only along the cdrs. With second
264 argument VECP, this copies vectors as well as conses."
268 (let ((newcar (car tree
)))
269 (if (or (consp (car tree
)) (and vecp
(vectorp (car tree
))))
270 (setq newcar
(copy-tree (car tree
) vecp
)))
271 (push newcar result
))
272 (setq tree
(cdr tree
)))
273 (nconc (nreverse result
) tree
))
274 (if (and vecp
(vectorp tree
))
275 (let ((i (length (setq tree
(copy-sequence tree
)))))
276 (while (>= (setq i
(1- i
)) 0)
277 (aset tree i
(copy-tree (aref tree i
) vecp
)))
281 (defun assoc-default (key alist
&optional test default
)
282 "Find object KEY in a pseudo-alist ALIST.
283 ALIST is a list of conses or objects. Each element (or the element's car,
284 if it is a cons) is compared with KEY by evaluating (TEST (car elt) KEY).
285 If that is non-nil, the element matches;
286 then `assoc-default' returns the element's cdr, if it is a cons,
287 or DEFAULT if the element is not a cons.
289 If no element matches, the value is nil.
290 If TEST is omitted or nil, `equal' is used."
291 (let (found (tail alist
) value
)
292 (while (and tail
(not found
))
293 (let ((elt (car tail
)))
294 (when (funcall (or test
'equal
) (if (consp elt
) (car elt
) elt
) key
)
295 (setq found t value
(if (consp elt
) (cdr elt
) default
))))
296 (setq tail
(cdr tail
)))
299 (make-obsolete 'assoc-ignore-case
'assoc-string
)
300 (defun assoc-ignore-case (key alist
)
301 "Like `assoc', but ignores differences in case and text representation.
302 KEY must be a string. Upper-case and lower-case letters are treated as equal.
303 Unibyte strings are converted to multibyte for comparison."
304 (assoc-string key alist t
))
306 (make-obsolete 'assoc-ignore-representation
'assoc-string
)
307 (defun assoc-ignore-representation (key alist
)
308 "Like `assoc', but ignores differences in text representation.
309 KEY must be a string.
310 Unibyte strings are converted to multibyte for comparison."
311 (assoc-string key alist nil
))
313 (defun member-ignore-case (elt list
)
314 "Like `member', but ignores differences in case and text representation.
315 ELT must be a string. Upper-case and lower-case letters are treated as equal.
316 Unibyte strings are converted to multibyte for comparison.
317 Non-strings in LIST are ignored."
319 (not (and (stringp (car list
))
320 (eq t
(compare-strings elt
0 nil
(car list
) 0 nil t
)))))
321 (setq list
(cdr list
)))
331 ;Prevent the \{...} documentation construct
332 ;from mentioning keys that run this command.
333 (put 'undefined
'suppress-keymap t
)
335 (defun suppress-keymap (map &optional nodigits
)
336 "Make MAP override all normally self-inserting keys to be undefined.
337 Normally, as an exception, digits and minus-sign are set to make prefix args,
338 but optional second arg NODIGITS non-nil treats them like other chars."
339 (define-key map
[remap self-insert-command
] 'undefined
)
342 (define-key map
"-" 'negative-argument
)
343 ;; Make plain numbers do numeric args.
346 (define-key map
(char-to-string loop
) 'digit-argument
)
347 (setq loop
(1+ loop
))))))
349 (defvar key-substitution-in-progress nil
350 "Used internally by `substitute-key-definition'.")
352 (defun substitute-key-definition (olddef newdef keymap
&optional oldmap prefix
)
353 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
354 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
355 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
356 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
358 For most uses, it is simpler and safer to use command remappping like this:
359 \(define-key KEYMAP [remap OLDDEF] NEWDEF)"
360 ;; Don't document PREFIX in the doc string because we don't want to
361 ;; advertise it. It's meant for recursive calls only. Here's its
364 ;; If optional argument PREFIX is specified, it should be a key
365 ;; prefix, a string. Redefined bindings will then be bound to the
366 ;; original key, with PREFIX added at the front.
367 (or prefix
(setq prefix
""))
368 (let* ((scan (or oldmap keymap
))
369 (prefix1 (vconcat prefix
[nil]))
370 (key-substitution-in-progress
371 (cons scan key-substitution-in-progress)))
372 ;; Scan OLDMAP, finding each char or event-symbol that
373 ;; has any definition, and act on it with hack-key.
376 (aset prefix1 (length prefix) char)
377 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
380 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
381 (let (inner-def skipped menu-item)
382 ;; Find the actual command name within the binding.
383 (if (eq (car-safe defn) 'menu-item)
384 (setq menu-item defn defn (nth 2 defn))
385 ;; Skip past menu-prompt.
386 (while (stringp (car-safe defn))
387 (push (pop defn) skipped))
388 ;; Skip past cached key-equivalence data for menu items.
389 (if (consp (car-safe defn))
390 (setq defn (cdr defn))))
391 (if (or (eq defn olddef)
392 ;; Compare with equal if definition is a key sequence.
393 ;; That is useful for operating on function-key-map.
394 (and (or (stringp defn) (vectorp defn))
395 (equal defn olddef)))
396 (define-key keymap prefix
398 (let ((copy (copy-sequence menu-item)))
399 (setcar (nthcdr 2 copy) newdef)
401 (nconc (nreverse skipped) newdef)))
402 ;; Look past a symbol that names a keymap.
405 (condition-case nil (indirect-function defn) (error defn))))
406 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
407 ;; avoid autoloading a keymap. This is mostly done to preserve the
408 ;; original non-autoloading behavior of pre-map-keymap times.
409 (if (and (keymapp inner-def)
410 ;; Avoid recursively scanning
411 ;; where KEYMAP does not have a submap.
412 (let ((elt (lookup-key keymap prefix)))
413 (or (null elt) (natnump elt) (keymapp elt)))
414 ;; Avoid recursively rescanning keymap being scanned.
415 (not (memq inner-def key-substitution-in-progress)))
416 ;; If this one isn't being scanned already, scan it now.
417 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
419 (defun define-key-after (keymap key definition &optional after)
420 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
421 This is like `define-key' except that the binding for KEY is placed
422 just after the binding for the event AFTER, instead of at the beginning
423 of the map. Note that AFTER must be an event type (like KEY), NOT a command
426 If AFTER is t or omitted, the new binding goes at the end of the keymap.
427 AFTER should be a single event type--a symbol or a character, not a sequence.
429 Bindings are always added before any inherited map.
431 The order of bindings in a keymap matters when it is used as a menu."
432 (unless after (setq after t))
434 (signal 'wrong-type-argument (list 'keymapp keymap)))
436 (if (<= (length key) 1) (aref key 0)
437 (setq keymap (lookup-key keymap
439 (butlast (mapcar 'identity key)))))
440 (aref key (1- (length key)))))
441 (let ((tail keymap) done inserted)
442 (while (and (not done) tail)
443 ;; Delete any earlier bindings for the same key.
444 (if (eq (car-safe (car (cdr tail))) key)
445 (setcdr tail (cdr (cdr tail))))
446 ;; If we hit an included map, go down that one.
447 (if (keymapp (car tail)) (setq tail (car tail)))
448 ;; When we reach AFTER's binding, insert the new binding after.
449 ;; If we reach an inherited keymap, insert just before that.
450 ;; If we reach the end of this keymap, insert at the end.
451 (if (or (and (eq (car-safe (car tail)) after)
453 (eq (car (cdr tail)) 'keymap)
456 ;; Stop the scan only if we find a parent keymap.
457 ;; Keep going past the inserted element
458 ;; so we can delete any duplications that come later.
459 (if (eq (car (cdr tail)) 'keymap)
461 ;; Don't insert more than once.
463 (setcdr tail (cons (cons key definition) (cdr tail))))
465 (setq tail (cdr tail)))))
467 (defun map-keymap-internal (function keymap &optional sort-first)
468 "Implement `map-keymap' with sorting.
469 Don't call this function; it is for internal use only."
472 (map-keymap (lambda (a b) (push (cons a b) list))
474 (setq list (sort list
476 (setq a (car a) b (car b))
478 (if (integerp b) (< a b)
483 (funcall function (car p) (cdr p))))
484 (map-keymap function keymap)))
487 "Convert KEYS to the internal Emacs key representation.
488 KEYS should be a string constant in the format used for
489 saving keyboard macros (see `edmacro-mode')."
490 (read-kbd-macro keys))
492 (put 'keyboard-translate-table 'char-table-extra-slots 0)
494 (defun keyboard-translate (from to)
495 "Translate character FROM to TO at a low level.
496 This function creates a `keyboard-translate-table' if necessary
497 and then modifies one entry in it."
498 (or (char-table-p keyboard-translate-table)
499 (setq keyboard-translate-table
500 (make-char-table 'keyboard-translate-table nil)))
501 (aset keyboard-translate-table from to))
504 ;;;; The global keymap tree.
506 ;;; global-map, esc-map, and ctl-x-map have their values set up in
507 ;;; keymap.c; we just give them docstrings here.
509 (defvar global-map nil
510 "Default global keymap mapping Emacs keyboard input into commands.
511 The value is a keymap which is usually (but not necessarily) Emacs's
515 "Default keymap for ESC (meta) commands.
516 The normal global definition of the character ESC indirects to this keymap.")
518 (defvar ctl-x-map nil
519 "Default keymap for C-x commands.
520 The normal global definition of the character C-x indirects to this keymap.")
522 (defvar ctl-x-4-map (make-sparse-keymap)
523 "Keymap for subcommands of C-x 4.")
524 (defalias 'ctl-x-4-prefix ctl-x-4-map)
525 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
527 (defvar ctl-x-5-map (make-sparse-keymap)
528 "Keymap for frame commands.")
529 (defalias 'ctl-x-5-prefix ctl-x-5-map)
530 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
533 ;;;; Event manipulation functions.
535 ;; The call to `read' is to ensure that the value is computed at load time
536 ;; and not compiled into the .elc file. The value is negative on most
537 ;; machines, but not on all!
538 (defconst listify-key-sequence-1 (logior 128 (read "?\\M-\\^@")))
540 (defun listify-key-sequence (key)
541 "Convert a key sequence to a list of events."
544 (mapcar (function (lambda (c)
546 (logxor c listify-key-sequence-1)
550 (defsubst eventp (obj)
551 "True if the argument is an event object."
552 (or (and (integerp obj)
553 ;; Filter out integers too large to be events.
554 ;; M is the biggest modifier.
555 (zerop (logand obj (lognot (1- (lsh ?\M-\^@ 1)))))
556 (char-valid-p (event-basic-type obj)))
558 (get obj 'event-symbol-elements))
561 (get (car obj) 'event-symbol-elements))))
563 (defun event-modifiers (event)
564 "Return a list of symbols representing the modifier keys in event EVENT.
565 The elements of the list may include `meta', `control',
566 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
568 EVENT may be an event or an event type. If EVENT is a symbol
569 that has never been used in an event that has been read as input
570 in the current Emacs session, then this function can return nil,
571 even when EVENT actually has modifiers."
574 (setq type (car type)))
576 (cdr (get type 'event-symbol-elements))
578 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
579 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
580 (if (not (zerop (logand type ?\M-\^@)))
582 (if (or (not (zerop (logand type ?\C-\^@)))
584 (push 'control list))
585 (if (or (not (zerop (logand type ?\S-\^@)))
586 (/= char (downcase char)))
588 (or (zerop (logand type ?\H-\^@))
590 (or (zerop (logand type ?\s-\^@))
592 (or (zerop (logand type ?\A-\^@))
596 (defun event-basic-type (event)
597 "Return the basic type of the given event (all modifiers removed).
598 The value is a printing character (not upper case) or a symbol.
599 EVENT may be an event or an event type. If EVENT is a symbol
600 that has never been used in an event that has been read as input
601 in the current Emacs session, then this function may return nil."
603 (setq event (car event)))
605 (car (get event 'event-symbol-elements))
606 (let* ((base (logand event (1- ?\A-\^@)))
607 (uncontrolled (if (< base 32) (logior base 64) base)))
608 ;; There are some numbers that are invalid characters and
609 ;; cause `downcase' to get an error.
611 (downcase uncontrolled)
612 (error uncontrolled)))))
614 (defsubst mouse-movement-p (object)
615 "Return non-nil if OBJECT is a mouse movement event."
616 (eq (car-safe object) 'mouse-movement))
618 (defsubst event-start (event)
619 "Return the starting position of EVENT.
620 If EVENT is a mouse or key press or a mouse click, this returns the location
622 If EVENT is a drag, this returns the drag's starting position.
623 The return value is of the form
624 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
625 IMAGE (DX . DY) (WIDTH . HEIGHT))
626 The `posn-' functions access elements of such lists."
627 (if (consp event) (nth 1 event)
628 (list (selected-window) (point) '(0 . 0) 0)))
630 (defsubst event-end (event)
631 "Return the ending location of EVENT.
632 EVENT should be a click, drag, or key press event.
633 If EVENT is a click event, this function is the same as `event-start'.
634 The return value is of the form
635 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
636 IMAGE (DX . DY) (WIDTH . HEIGHT))
637 The `posn-' functions access elements of such lists."
638 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
639 (list (selected-window) (point) '(0 . 0) 0)))
641 (defsubst event-click-count (event)
642 "Return the multi-click count of EVENT, a click or drag event.
643 The return value is a positive integer."
644 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
646 (defsubst posn-window (position)
647 "Return the window in POSITION.
648 POSITION should be a list of the form returned by the `event-start'
649 and `event-end' functions."
652 (defsubst posn-area (position)
653 "Return the window area recorded in POSITION, or nil for the text area.
654 POSITION should be a list of the form returned by the `event-start'
655 and `event-end' functions."
656 (let ((area (if (consp (nth 1 position))
657 (car (nth 1 position))
659 (and (symbolp area) area)))
661 (defsubst posn-point (position)
662 "Return the buffer location in POSITION.
663 POSITION should be a list of the form returned by the `event-start'
664 and `event-end' functions."
666 (if (consp (nth 1 position))
667 (car (nth 1 position))
670 (defun posn-set-point (position)
671 "Move point to POSITION.
672 Select the corresponding window as well."
673 (if (not (windowp (posn-window position)))
674 (error "Position not in text area of window"))
675 (select-window (posn-window position))
676 (if (numberp (posn-point position))
677 (goto-char (posn-point position))))
679 (defsubst posn-x-y (position)
680 "Return the x and y coordinates in POSITION.
681 POSITION should be a list of the form returned by the `event-start'
682 and `event-end' functions."
685 (defun posn-col-row (position)
686 "Return the nominal column and row in POSITION, measured in characters.
687 The column and row values are approximations calculated from the x
688 and y coordinates in POSITION and the frame's default character width
690 For a scroll-bar event, the result column is 0, and the row
691 corresponds to the vertical position of the click in the scroll bar.
692 POSITION should be a list of the form returned by the `event-start'
693 and `event-end' functions."
694 (let* ((pair (posn-x-y position))
695 (window (posn-window position))
696 (area (posn-area position)))
700 ((eq area 'vertical-scroll-bar)
701 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
702 ((eq area 'horizontal-scroll-bar)
703 (cons (scroll-bar-scale pair (window-width window)) 0))
705 (let* ((frame (if (framep window) window (window-frame window)))
706 (x (/ (car pair) (frame-char-width frame)))
707 (y (/ (cdr pair) (+ (frame-char-height frame)
708 (or (frame-parameter frame 'line-spacing)
713 (defun posn-actual-col-row (position)
714 "Return the actual column and row in POSITION, measured in characters.
715 These are the actual row number in the window and character number in that row.
716 Return nil if POSITION does not contain the actual position; in that case
717 `posn-col-row' can be used to get approximate values.
718 POSITION should be a list of the form returned by the `event-start'
719 and `event-end' functions."
722 (defsubst posn-timestamp (position)
723 "Return the timestamp of POSITION.
724 POSITION should be a list of the form returned by the `event-start'
725 and `event-end' functions."
728 (defsubst posn-string (position)
729 "Return the string object of POSITION, or nil if a buffer position.
730 POSITION should be a list of the form returned by the `event-start'
731 and `event-end' functions."
734 (defsubst posn-image (position)
735 "Return the image object of POSITION, or nil if a not an image.
736 POSITION should be a list of the form returned by the `event-start'
737 and `event-end' functions."
740 (defsubst posn-object (position)
741 "Return the object (image or string) of POSITION.
742 POSITION should be a list of the form returned by the `event-start'
743 and `event-end' functions."
744 (or (posn-image position) (posn-string position)))
746 (defsubst posn-object-x-y (position)
747 "Return the x and y coordinates relative to the object of POSITION.
748 POSITION should be a list of the form returned by the `event-start'
749 and `event-end' functions."
752 (defsubst posn-object-width-height (position)
753 "Return the pixel width and height of the object of POSITION.
754 POSITION should be a list of the form returned by the `event-start'
755 and `event-end' functions."
759 ;;;; Obsolescent names for functions.
761 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
762 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
763 (define-obsolete-function-alias 'read-input 'read-string "22.1")
764 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
765 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
766 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
768 (make-obsolete 'char-bytes "now always returns 1." "20.4")
770 (defun insert-string (&rest args)
771 "Mocklisp-compatibility insert function.
772 Like the function `insert' except that any argument that is a number
773 is converted into a string by expressing it in decimal."
775 (insert (if (integerp el) (number-to-string el) el))))
776 (make-obsolete 'insert-string 'insert "22.1")
778 (defun makehash (&optional test) (make-hash-table :test (or test 'eql)))
779 (make-obsolete 'makehash 'make-hash-table "22.1")
781 ;; Some programs still use this as a function.
783 "Return the value of the `baud-rate' variable."
785 (make-obsolete 'baud-rate "use the `baud-rate' variable instead." "before 19.15")
787 ;; These are used by VM and some old programs
788 (defalias 'focus-frame 'ignore "")
789 (make-obsolete 'focus-frame "it does nothing." "22.1")
790 (defalias 'unfocus-frame 'ignore "")
791 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
794 ;;;; Obsolescence declarations for variables, and aliases.
796 (make-obsolete-variable 'directory-sep-char "do not use it." "21.1")
797 (make-obsolete-variable 'mode-line-inverse-video "use the appropriate faces instead." "21.1")
798 (make-obsolete-variable 'unread-command-char
799 "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."
802 ;; Lisp manual only updated in 22.1.
803 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
806 (defvaralias 'x-lost-selection-hooks 'x-lost-selection-functions)
807 (make-obsolete-variable 'x-lost-selection-hooks 'x-lost-selection-functions "22.1")
808 (defvaralias 'x-sent-selection-hooks 'x-sent-selection-functions)
809 (make-obsolete-variable 'x-sent-selection-hooks 'x-sent-selection-functions "22.1")
811 (defvaralias 'messages-buffer-max-lines 'message-log-max)
813 ;;;; Alternate names for functions - these are not being phased out.
815 (defalias 'send-string 'process-send-string)
816 (defalias 'send-region 'process-send-region)
817 (defalias 'string= 'string-equal)
818 (defalias 'string< 'string-lessp)
819 (defalias 'move-marker 'set-marker)
820 (defalias 'rplaca 'setcar)
821 (defalias 'rplacd 'setcdr)
822 (defalias 'beep 'ding) ;preserve lingual purity
823 (defalias 'indent-to-column 'indent-to)
824 (defalias 'backward-delete-char 'delete-backward-char)
825 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
826 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
827 (defalias 'int-to-string 'number-to-string)
828 (defalias 'store-match-data 'set-match-data)
829 (defalias 'make-variable-frame-localizable 'make-variable-frame-local)
830 ;; These are the XEmacs names:
831 (defalias 'point-at-eol 'line-end-position)
832 (defalias 'point-at-bol 'line-beginning-position)
835 ;;;; Hook manipulation functions.
837 (defun make-local-hook (hook)
838 "Make the hook HOOK local to the current buffer.
839 The return value is HOOK.
841 You never need to call this function now that `add-hook' does it for you
842 if its LOCAL argument is non-nil.
844 When a hook is local, its local and global values
845 work in concert: running the hook actually runs all the hook
846 functions listed in *either* the local value *or* the global value
847 of the hook variable.
849 This function works by making t a member of the buffer-local value,
850 which acts as a flag to run the hook functions in the default value as
851 well. This works for all normal hooks, but does not work for most
852 non-normal hooks yet. We will be changing the callers of non-normal
853 hooks so that they can handle localness; this has to be done one by
856 This function does nothing if HOOK is already local in the current
859 Do not use `make-local-variable' to make a hook variable buffer-local."
860 (if (local-variable-p hook)
862 (or (boundp hook) (set hook nil))
863 (make-local-variable hook)
866 (make-obsolete 'make-local-hook "not necessary any more." "21.1")
868 (defun add-hook (hook function &optional append local)
869 "Add to the value of HOOK the function FUNCTION.
870 FUNCTION is not added if already present.
871 FUNCTION is added (if necessary) at the beginning of the hook list
872 unless the optional argument APPEND is non-nil, in which case
873 FUNCTION is added at the end.
875 The optional fourth argument, LOCAL, if non-nil, says to modify
876 the hook's buffer-local value rather than its default value.
877 This makes the hook buffer-local if needed, and it makes t a member
878 of the buffer-local value. That acts as a flag to run the hook
879 functions in the default value as well as in the local value.
881 HOOK should be a symbol, and FUNCTION may be any valid function. If
882 HOOK is void, it is first set to nil. If HOOK's value is a single
883 function, it is changed to a list of functions."
884 (or (boundp hook) (set hook nil))
885 (or (default-boundp hook) (set-default hook nil))
886 (if local (unless (local-variable-if-set-p hook)
887 (set (make-local-variable hook) (list t)))
888 ;; Detect the case where make-local-variable was used on a hook
889 ;; and do what we used to do.
890 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
892 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
893 ;; If the hook value is a single function, turn it into a list.
894 (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
895 (setq hook-value (list hook-value)))
896 ;; Do the actual addition if necessary
897 (unless (member function hook-value)
900 (append hook-value (list function))
901 (cons function hook-value))))
902 ;; Set the actual variable
903 (if local (set hook hook-value) (set-default hook hook-value))))
905 (defun remove-hook (hook function &optional local)
906 "Remove from the value of HOOK the function FUNCTION.
907 HOOK should be a symbol, and FUNCTION may be any valid function. If
908 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
909 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
911 The optional third argument, LOCAL, if non-nil, says to modify
912 the hook's buffer-local value rather than its default value."
913 (or (boundp hook) (set hook nil))
914 (or (default-boundp hook) (set-default hook nil))
915 ;; Do nothing if LOCAL is t but this hook has no local binding.
916 (unless (and local (not (local-variable-p hook)))
917 ;; Detect the case where make-local-variable was used on a hook
918 ;; and do what we used to do.
919 (when (and (local-variable-p hook)
920 (not (and (consp (symbol-value hook))
921 (memq t (symbol-value hook)))))
923 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
924 ;; Remove the function, for both the list and the non-list cases.
925 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
926 (if (equal hook-value function) (setq hook-value nil))
927 (setq hook-value (delete function (copy-sequence hook-value))))
928 ;; If the function is on the global hook, we need to shadow it locally
929 ;;(when (and local (member function (default-value hook))
930 ;; (not (member (cons 'not function) hook-value)))
931 ;; (push (cons 'not function) hook-value))
932 ;; Set the actual variable
934 (set-default hook hook-value)
935 (if (equal hook-value '(t))
936 (kill-local-variable hook)
937 (set hook hook-value))))))
939 (defun add-to-list (list-var element &optional append)
940 "Add to the value of LIST-VAR the element ELEMENT if it isn't there yet.
941 The test for presence of ELEMENT is done with `equal'.
942 If ELEMENT is added, it is added at the beginning of the list,
943 unless the optional argument APPEND is non-nil, in which case
944 ELEMENT is added at the end.
946 The return value is the new value of LIST-VAR.
948 If you want to use `add-to-list' on a variable that is not defined
949 until a certain package is loaded, you should put the call to `add-to-list'
950 into a hook function that will be run only after loading the package.
951 `eval-after-load' provides one way to do this. In some cases
952 other hooks, such as major mode hooks, can do the job."
953 (if (member element (symbol-value list-var))
954 (symbol-value list-var)
957 (append (symbol-value list-var) (list element))
958 (cons element (symbol-value list-var))))))
961 (defun add-to-ordered-list (list-var element &optional order)
962 "Add to the value of LIST-VAR the element ELEMENT if it isn't there yet.
963 The test for presence of ELEMENT is done with `eq'.
965 The resulting list is reordered so that the elements are in the
966 order given by each element's numeric list order. Elements
967 without a numeric list order are placed at the end of the list.
969 If the third optional argument ORDER is non-nil, set the
970 element's list order to the given value.
972 The list order for each element is stored in LIST-VAR's
973 `list-order' property.
975 The return value is the new value of LIST-VAR."
976 (let ((ordering (get list-var 'list-order)))
978 (put list-var 'list-order
979 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
981 (puthash element (and (numberp order) order) ordering))
982 (unless (memq element (symbol-value list-var))
983 (set list-var (cons element (symbol-value list-var))))
984 (set list-var (sort (symbol-value list-var)
986 (let ((oa (gethash a ordering))
987 (ob (gethash b ordering)))
995 ;;; (defvar symbol-file-load-history-loaded nil
996 ;;; "Non-nil means we have loaded the file `fns-VERSION.el' in `exec-directory'.
997 ;;; That file records the part of `load-history' for preloaded files,
998 ;;; which is cleared out before dumping to make Emacs smaller.")
1000 ;;; (defun load-symbol-file-load-history ()
1001 ;;; "Load the file `fns-VERSION.el' in `exec-directory' if not already done.
1002 ;;; That file records the part of `load-history' for preloaded files,
1003 ;;; which is cleared out before dumping to make Emacs smaller."
1004 ;;; (unless symbol-file-load-history-loaded
1005 ;;; (load (expand-file-name
1006 ;;; ;; fns-XX.YY.ZZ.el does not work on DOS filesystem.
1007 ;;; (if (eq system-type 'ms-dos)
1009 ;;; (format "fns-%s.el" emacs-version))
1011 ;;; ;; The file name fns-%s.el already has a .el extension.
1013 ;;; (setq symbol-file-load-history-loaded t)))
1015 (defun symbol-file (symbol &optional type)
1016 "Return the input source in which SYMBOL was defined.
1017 The value is normally a string that was passed to `load':
1018 either an absolute file name, or a library name
1019 \(with no directory name and no `.el' or `.elc' at the end).
1020 It can also be nil, if the definition is not associated with any file.
1022 If TYPE is nil, then any kind of definition is acceptable.
1023 If TYPE is `defun' or `defvar', that specifies function
1024 definition only or variable definition only.
1025 `defface' specifies a face definition only."
1026 (if (and (or (null type) (eq type 'defun))
1027 (symbolp symbol) (fboundp symbol)
1028 (eq 'autoload (car-safe (symbol-function symbol))))
1029 (nth 1 (symbol-function symbol))
1030 (let ((files load-history)
1034 (if (eq type 'defvar)
1035 ;; Variables are present just as their names.
1036 (member symbol (cdr (car files)))
1037 ;; Other types are represented as (TYPE . NAME).
1038 (member (cons type symbol) (cdr (car files))))
1039 ;; We accept all types, so look for variable def
1040 ;; and then for any other kind.
1041 (or (member symbol (cdr (car files)))
1042 (rassq symbol (cdr (car files)))))
1043 (setq file (car (car files)) files nil))
1044 (setq files (cdr files)))
1048 ;;;; Specifying things to do after certain files are loaded.
1050 (defun eval-after-load (file form)
1051 "Arrange that, if FILE is ever loaded, FORM will be run at that time.
1052 This makes or adds to an entry on `after-load-alist'.
1053 If FILE is already loaded, evaluate FORM right now.
1054 It does nothing if FORM is already on the list for FILE.
1055 FILE must match exactly. Normally FILE is the name of a library,
1056 with no directory or extension specified, since that is how `load'
1058 FILE can also be a feature (i.e. a symbol), in which case FORM is
1059 evaluated whenever that feature is `provide'd."
1060 (let ((elt (assoc file after-load-alist)))
1061 ;; Make sure there is an element for FILE.
1062 (unless elt (setq elt (list file)) (push elt after-load-alist))
1063 ;; Add FORM to the element if it isn't there.
1064 (unless (member form (cdr elt))
1065 (nconc elt (list form))
1066 ;; If the file has been loaded already, run FORM right away.
1067 (if (if (symbolp file)
1069 ;; Make sure `load-history' contains the files dumped with
1070 ;; Emacs for the case that FILE is one of them.
1071 ;; (load-symbol-file-load-history)
1072 (assoc file load-history))
1076 (defun eval-next-after-load (file)
1077 "Read the following input sexp, and run it whenever FILE is loaded.
1078 This makes or adds to an entry on `after-load-alist'.
1079 FILE should be the name of a library, with no directory name."
1080 (eval-after-load file (read)))
1082 ;;; open-network-stream is a wrapper around make-network-process.
1084 (when (featurep 'make-network-process)
1085 (defun open-network-stream (name buffer host service)
1086 "Open a TCP connection for a service to a host.
1087 Returns a subprocess-object to represent the connection.
1088 Input and output work as for subprocesses; `delete-process' closes it.
1090 Args are NAME BUFFER HOST SERVICE.
1091 NAME is name for process. It is modified if necessary to make it unique.
1092 BUFFER is the buffer (or buffer name) to associate with the process.
1093 Process output goes at end of that buffer, unless you specify
1094 an output stream or filter function to handle the output.
1095 BUFFER may be also nil, meaning that this process is not associated
1097 HOST is name of the host to connect to, or its IP address.
1098 SERVICE is name of the service desired, or an integer specifying
1099 a port number to connect to."
1100 (make-network-process :name name :buffer buffer
1101 :host host :service service)))
1105 (make-obsolete 'process-kill-without-query
1106 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1108 (defun process-kill-without-query (process &optional flag)
1109 "Say no query needed if PROCESS is running when Emacs is exited.
1110 Optional second argument if non-nil says to require a query.
1111 Value is t if a query was formerly required."
1112 (let ((old (process-query-on-exit-flag process)))
1113 (set-process-query-on-exit-flag process nil)
1116 ;; process plist management
1118 (defun process-get (process propname)
1119 "Return the value of PROCESS' PROPNAME property.
1120 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
1121 (plist-get (process-plist process) propname))
1123 (defun process-put (process propname value)
1124 "Change PROCESS' PROPNAME property to VALUE.
1125 It can be retrieved with `(process-get PROCESS PROPNAME)'."
1126 (set-process-plist process
1127 (plist-put (process-plist process) propname value)))
1130 ;;;; Input and display facilities.
1132 (defvar read-quoted-char-radix 8
1133 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1134 Legitimate radix values are 8, 10 and 16.")
1136 (custom-declare-variable-early
1137 'read-quoted-char-radix 8
1138 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1139 Legitimate radix values are 8, 10 and 16."
1140 :type '(choice (const 8) (const 10) (const 16))
1141 :group 'editing-basics)
1143 (defun read-quoted-char (&optional prompt)
1144 "Like `read-char', but do not allow quitting.
1145 Also, if the first character read is an octal digit,
1146 we read any number of octal digits and return the
1147 specified character code. Any nondigit terminates the sequence.
1148 If the terminator is RET, it is discarded;
1149 any other terminator is used itself as input.
1151 The optional argument PROMPT specifies a string to use to prompt the user.
1152 The variable `read-quoted-char-radix' controls which radix to use
1154 (let ((message-log-max nil) done (first t) (code 0) char translated)
1156 (let ((inhibit-quit first)
1157 ;; Don't let C-h get the help message--only help function keys.
1160 "Type the special character you want to use,
1161 or the octal character code.
1162 RET terminates the character code and is discarded;
1163 any other non-digit terminates the character code and is then used as input."))
1164 (setq char (read-event (and prompt (format "%s-" prompt)) t))
1165 (if inhibit-quit (setq quit-flag nil)))
1166 ;; Translate TAB key into control-I ASCII character, and so on.
1167 ;; Note: `read-char' does it using the `ascii-character' property.
1168 ;; We could try and use read-key-sequence instead, but then C-q ESC
1169 ;; or C-q C-x might not return immediately since ESC or C-x might be
1170 ;; bound to some prefix in function-key-map or key-translation-map.
1171 (setq translated char)
1172 (let ((translation (lookup-key function-key-map (vector char))))
1173 (if (arrayp translation)
1174 (setq translated (aref translation 0))))
1175 (cond ((null translated))
1176 ((not (integerp translated))
1177 (setq unread-command-events (list char)
1179 ((/= (logand translated ?\M-\^@) 0)
1180 ;; Turn a meta-character into a character with the 0200 bit set.
1181 (setq code (logior (logand translated (lognot ?\M-\^@)) 128)
1183 ((and (<= ?0 translated) (< translated (+ ?0 (min 10 read-quoted-char-radix))))
1184 (setq code (+ (* code read-quoted-char-radix) (- translated ?0)))
1185 (and prompt (setq prompt (message "%s %c" prompt translated))))
1186 ((and (<= ?a (downcase translated))
1187 (< (downcase translated) (+ ?a -10 (min 36 read-quoted-char-radix))))
1188 (setq code (+ (* code read-quoted-char-radix)
1189 (+ 10 (- (downcase translated) ?a))))
1190 (and prompt (setq prompt (message "%s %c" prompt translated))))
1191 ((and (not first) (eq translated ?\C-m))
1194 (setq unread-command-events (list char)
1196 (t (setq code translated
1201 (defun read-passwd (prompt &optional confirm default)
1202 "Read a password, prompting with PROMPT, and return it.
1203 If optional CONFIRM is non-nil, read the password twice to make sure.
1204 Optional DEFAULT is a default password to use instead of empty input.
1206 This function echoes `.' for each character that the user types.
1207 The user ends with RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line.
1208 C-g quits; if `inhibit-quit' was non-nil around this function,
1209 then it returns nil if the user types C-g.
1211 Once the caller uses the password, it can erase the password
1212 by doing (clear-string STRING)."
1216 (while (not success)
1217 (let ((first (read-passwd prompt nil default))
1218 (second (read-passwd "Confirm password: " nil default)))
1219 (if (equal first second)
1221 (and (arrayp second) (clear-string second))
1222 (setq success first))
1223 (and (arrayp first) (clear-string first))
1224 (and (arrayp second) (clear-string second))
1225 (message "Password not repeated accurately; please start over")
1231 (cursor-in-echo-area t))
1232 (while (progn (message "%s%s"
1234 (make-string (length pass) ?.))
1235 (setq c (read-char-exclusive nil t))
1236 (and (/= c ?\r) (/= c ?\n) (/= c ?\e)))
1237 (clear-this-command-keys)
1240 (and (arrayp pass) (clear-string pass))
1242 (if (and (/= c ?\b) (/= c ?\177))
1243 (let* ((new-char (char-to-string c))
1244 (new-pass (concat pass new-char)))
1245 (and (arrayp pass) (clear-string pass))
1246 (clear-string new-char)
1248 (setq pass new-pass))
1249 (if (> (length pass) 0)
1250 (let ((new-pass (substring pass 0 -1)))
1251 (and (arrayp pass) (clear-string pass))
1252 (setq pass new-pass))))))
1254 (or pass default "")))))
1256 ;; This should be used by `call-interactively' for `n' specs.
1257 (defun read-number (prompt &optional default)
1261 (if (string-match "\\(\\):[ \t]*\\'" prompt)
1262 (replace-match (format " (default %s)" default) t t prompt 1)
1263 (replace-regexp-in-string "[ \t]*\\'"
1264 (format " (default %s) " default)
1268 (let ((str (read-from-minibuffer prompt nil nil nil nil
1270 (number-to-string default)))))
1272 ((zerop (length str)) default)
1273 ((stringp str) (read str)))))
1275 (message "Please enter a number.")
1280 ;;; Atomic change groups.
1282 (defmacro atomic-change-group (&rest body)
1283 "Perform BODY as an atomic change group.
1284 This means that if BODY exits abnormally,
1285 all of its changes to the current buffer are undone.
1286 This works regardless of whether undo is enabled in the buffer.
1288 This mechanism is transparent to ordinary use of undo;
1289 if undo is enabled in the buffer and BODY succeeds, the
1290 user can undo the change normally."
1291 (let ((handle (make-symbol "--change-group-handle--"))
1292 (success (make-symbol "--change-group-success--")))
1293 `(let ((,handle (prepare-change-group))
1297 ;; This is inside the unwind-protect because
1298 ;; it enables undo if that was disabled; we need
1299 ;; to make sure that it gets disabled again.
1300 (activate-change-group ,handle)
1303 ;; Either of these functions will disable undo
1304 ;; if it was disabled before.
1306 (accept-change-group ,handle)
1307 (cancel-change-group ,handle))))))
1309 (defun prepare-change-group (&optional buffer)
1310 "Return a handle for the current buffer's state, for a change group.
1311 If you specify BUFFER, make a handle for BUFFER's state instead.
1313 Pass the handle to `activate-change-group' afterward to initiate
1314 the actual changes of the change group.
1316 To finish the change group, call either `accept-change-group' or
1317 `cancel-change-group' passing the same handle as argument. Call
1318 `accept-change-group' to accept the changes in the group as final;
1319 call `cancel-change-group' to undo them all. You should use
1320 `unwind-protect' to make sure the group is always finished. The call
1321 to `activate-change-group' should be inside the `unwind-protect'.
1322 Once you finish the group, don't use the handle again--don't try to
1323 finish the same group twice. For a simple example of correct use, see
1324 the source code of `atomic-change-group'.
1326 The handle records only the specified buffer. To make a multibuffer
1327 change group, call this function once for each buffer you want to
1328 cover, then use `nconc' to combine the returned values, like this:
1330 (nconc (prepare-change-group buffer-1)
1331 (prepare-change-group buffer-2))
1333 You can then activate that multibuffer change group with a single
1334 call to `activate-change-group' and finish it with a single call
1335 to `accept-change-group' or `cancel-change-group'."
1338 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
1339 (list (cons (current-buffer) buffer-undo-list))))
1341 (defun activate-change-group (handle)
1342 "Activate a change group made with `prepare-change-group' (which see)."
1343 (dolist (elt handle)
1344 (with-current-buffer (car elt)
1345 (if (eq buffer-undo-list t)
1346 (setq buffer-undo-list nil)))))
1348 (defun accept-change-group (handle)
1349 "Finish a change group made with `prepare-change-group' (which see).
1350 This finishes the change group by accepting its changes as final."
1351 (dolist (elt handle)
1352 (with-current-buffer (car elt)
1354 (setq buffer-undo-list t)))))
1356 (defun cancel-change-group (handle)
1357 "Finish a change group made with `prepare-change-group' (which see).
1358 This finishes the change group by reverting all of its changes."
1359 (dolist (elt handle)
1360 (with-current-buffer (car elt)
1361 (setq elt (cdr elt))
1363 (if (consp elt) (car elt)))
1365 (if (consp elt) (cdr elt))))
1366 ;; Temporarily truncate the undo log at ELT.
1368 (setcar elt nil) (setcdr elt nil))
1369 (unless (eq last-command 'undo) (undo-start))
1370 ;; Make sure there's no confusion.
1371 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
1372 (error "Undoing to some unrelated state"))
1374 (while pending-undo-list (undo-more 1))
1375 ;; Reset the modified cons cell ELT to its original content.
1377 (setcar elt old-car)
1378 (setcdr elt old-cdr))
1379 ;; Revert the undo info to what it was when we grabbed the state.
1380 (setq buffer-undo-list elt)))))
1382 ;; For compatibility.
1383 (defalias 'redraw-modeline 'force-mode-line-update)
1385 (defun force-mode-line-update (&optional all)
1386 "Force redisplay of the current buffer's mode line and header line.
1387 With optional non-nil ALL, force redisplay of all mode lines and
1388 header lines. This function also forces recomputation of the
1389 menu bar menus and the frame title."
1390 (if all (save-excursion (set-buffer (other-buffer))))
1391 (set-buffer-modified-p (buffer-modified-p)))
1393 (defun momentary-string-display (string pos &optional exit-char message)
1394 "Momentarily display STRING in the buffer at POS.
1395 Display remains until next event is input.
1396 Optional third arg EXIT-CHAR can be a character, event or event
1397 description list. EXIT-CHAR defaults to SPC. If the input is
1398 EXIT-CHAR it is swallowed; otherwise it is then available as
1399 input (as a command if nothing else).
1400 Display MESSAGE (optional fourth arg) in the echo area.
1401 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
1402 (or exit-char (setq exit-char ?\ ))
1403 (let ((inhibit-read-only t)
1404 ;; Don't modify the undo list at all.
1405 (buffer-undo-list t)
1406 (modified (buffer-modified-p))
1407 (name buffer-file-name)
1413 ;; defeat file locking... don't try this at home, kids!
1414 (setq buffer-file-name nil)
1415 (insert-before-markers string)
1416 (setq insert-end (point))
1417 ;; If the message end is off screen, recenter now.
1418 (if (< (window-end nil t) insert-end)
1419 (recenter (/ (window-height) 2)))
1420 ;; If that pushed message start off the screen,
1421 ;; scroll to start it at the top of the screen.
1422 (move-to-window-line 0)
1427 (message (or message "Type %s to continue editing.")
1428 (single-key-description exit-char))
1430 (if (integerp exit-char)
1433 (setq char (read-char))
1434 (or (eq char exit-char)
1435 (setq unread-command-events (list char))))
1437 ;; `exit-char' is a character, hence it differs
1438 ;; from char, which is an event.
1439 (setq unread-command-events (list char))))
1440 ;; `exit-char' can be an event, or an event description
1442 (setq char (read-event))
1443 (or (eq char exit-char)
1444 (eq char (event-convert-list exit-char))
1445 (setq unread-command-events (list char))))))
1448 (delete-region pos insert-end)))
1449 (setq buffer-file-name name)
1450 (set-buffer-modified-p modified))))
1453 ;;;; Overlay operations
1455 (defun copy-overlay (o)
1456 "Return a copy of overlay O."
1457 (let ((o1 (make-overlay (overlay-start o) (overlay-end o)
1458 ;; FIXME: there's no easy way to find the
1459 ;; insertion-type of the two markers.
1460 (overlay-buffer o)))
1461 (props (overlay-properties o)))
1463 (overlay-put o1 (pop props) (pop props)))
1466 (defun remove-overlays (&optional beg end name val)
1467 "Clear BEG and END of overlays whose property NAME has value VAL.
1468 Overlays might be moved and/or split.
1469 BEG and END default respectively to the beginning and end of buffer."
1470 (unless beg (setq beg (point-min)))
1471 (unless end (setq end (point-max)))
1473 (setq beg (prog1 end (setq end beg))))
1475 (dolist (o (overlays-in beg end))
1476 (when (eq (overlay-get o name) val)
1477 ;; Either push this overlay outside beg...end
1478 ;; or split it to exclude beg...end
1479 ;; or delete it entirely (if it is contained in beg...end).
1480 (if (< (overlay-start o) beg)
1481 (if (> (overlay-end o) end)
1483 (move-overlay (copy-overlay o)
1484 (overlay-start o) beg)
1485 (move-overlay o end (overlay-end o)))
1486 (move-overlay o (overlay-start o) beg))
1487 (if (> (overlay-end o) end)
1488 (move-overlay o end (overlay-end o))
1489 (delete-overlay o)))))))
1493 (defvar suspend-hook nil
1494 "Normal hook run by `suspend-emacs', before suspending.")
1496 (defvar suspend-resume-hook nil
1497 "Normal hook run by `suspend-emacs', after Emacs is continued.")
1499 (defvar temp-buffer-show-hook nil
1500 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
1501 When the hook runs, the temporary buffer is current, and the window it
1502 was displayed in is selected. This hook is normally set up with a
1503 function to make the buffer read only, and find function names and
1504 variable names in it, provided the major mode is still Help mode.")
1506 (defvar temp-buffer-setup-hook nil
1507 "Normal hook run by `with-output-to-temp-buffer' at the start.
1508 When the hook runs, the temporary buffer is current.
1509 This hook is normally set up with a function to put the buffer in Help
1512 ;; Avoid compiler warnings about this variable,
1513 ;; which has a special meaning on certain system types.
1514 (defvar buffer-file-type nil
1515 "Non-nil if the visited file is a binary file.
1516 This variable is meaningful on MS-DOG and Windows NT.
1517 On those systems, it is automatically local in every buffer.
1518 On other systems, this variable is normally always nil.")
1520 ;; This should probably be written in C (i.e., without using `walk-windows').
1521 (defun get-buffer-window-list (buffer &optional minibuf frame)
1522 "Return list of all windows displaying BUFFER, or nil if none.
1523 BUFFER can be a buffer or a buffer name.
1524 See `walk-windows' for the meaning of MINIBUF and FRAME."
1525 (let ((buffer (if (bufferp buffer) buffer (get-buffer buffer))) windows)
1526 (walk-windows (function (lambda (window)
1527 (if (eq (window-buffer window) buffer)
1528 (setq windows (cons window windows)))))
1532 (defun ignore (&rest ignore)
1533 "Do nothing and return nil.
1534 This function accepts any number of arguments, but ignores them."
1538 (defun error (&rest args)
1539 "Signal an error, making error message by passing all args to `format'.
1540 In Emacs, the convention is that error messages start with a capital
1541 letter but *do not* end with a period. Please follow this convention
1542 for the sake of consistency."
1544 (signal 'error (list (apply 'format args)))))
1546 (defalias 'user-original-login-name 'user-login-name)
1548 (defvar yank-excluded-properties)
1550 (defun remove-yank-excluded-properties (start end)
1551 "Remove `yank-excluded-properties' between START and END positions.
1552 Replaces `category' properties with their defined properties."
1553 (let ((inhibit-read-only t))
1554 ;; Replace any `category' property with the properties it stands for.
1555 (unless (memq yank-excluded-properties '(t nil))
1558 (while (< (point) end)
1559 (let ((cat (get-text-property (point) 'category))
1562 (next-single-property-change (point) 'category nil end))
1564 (let (run-end2 original)
1565 (remove-list-of-text-properties (point) run-end '(category))
1566 (while (< (point) run-end)
1567 (setq run-end2 (next-property-change (point) nil run-end))
1568 (setq original (text-properties-at (point)))
1569 (set-text-properties (point) run-end2 (symbol-plist cat))
1570 (add-text-properties (point) run-end2 original)
1571 (goto-char run-end2))))
1572 (goto-char run-end)))))
1573 (if (eq yank-excluded-properties t)
1574 (set-text-properties start end nil)
1575 (remove-list-of-text-properties start end yank-excluded-properties))))
1577 (defvar yank-undo-function)
1579 (defun insert-for-yank (string)
1580 "Calls `insert-for-yank-1' repetitively for each `yank-handler' segment.
1582 See `insert-for-yank-1' for more details."
1584 (while (setq to (next-single-property-change 0 'yank-handler string))
1585 (insert-for-yank-1 (substring string 0 to))
1586 (setq string (substring string to))))
1587 (insert-for-yank-1 string))
1589 (defun insert-for-yank-1 (string)
1590 "Insert STRING at point, stripping some text properties.
1592 Strip text properties from the inserted text according to
1593 `yank-excluded-properties'. Otherwise just like (insert STRING).
1595 If STRING has a non-nil `yank-handler' property on the first character,
1596 the normal insert behavior is modified in various ways. The value of
1597 the yank-handler property must be a list with one to five elements
1598 with the following format: (FUNCTION PARAM NOEXCLUDE UNDO).
1599 When FUNCTION is present and non-nil, it is called instead of `insert'
1600 to insert the string. FUNCTION takes one argument--the object to insert.
1601 If PARAM is present and non-nil, it replaces STRING as the object
1602 passed to FUNCTION (or `insert'); for example, if FUNCTION is
1603 `yank-rectangle', PARAM may be a list of strings to insert as a
1605 If NOEXCLUDE is present and non-nil, the normal removal of the
1606 yank-excluded-properties is not performed; instead FUNCTION is
1607 responsible for removing those properties. This may be necessary
1608 if FUNCTION adjusts point before or after inserting the object.
1609 If UNDO is present and non-nil, it is a function that will be called
1610 by `yank-pop' to undo the insertion of the current object. It is
1611 called with two arguments, the start and end of the current region.
1612 FUNCTION may set `yank-undo-function' to override the UNDO value."
1613 (let* ((handler (and (stringp string)
1614 (get-text-property 0 'yank-handler string)))
1615 (param (or (nth 1 handler) string))
1617 (setq yank-undo-function t)
1618 (if (nth 0 handler) ;; FUNCTION
1619 (funcall (car handler) param)
1621 (unless (nth 2 handler) ;; NOEXCLUDE
1622 (remove-yank-excluded-properties opoint (point)))
1623 (if (eq yank-undo-function t) ;; not set by FUNCTION
1624 (setq yank-undo-function (nth 3 handler))) ;; UNDO
1625 (if (nth 4 handler) ;; COMMAND
1626 (setq this-command (nth 4 handler)))))
1628 (defun insert-buffer-substring-no-properties (buffer &optional start end)
1629 "Insert before point a substring of BUFFER, without text properties.
1630 BUFFER may be a buffer or a buffer name.
1631 Arguments START and END are character positions specifying the substring.
1632 They default to the values of (point-min) and (point-max) in BUFFER."
1633 (let ((opoint (point)))
1634 (insert-buffer-substring buffer start end)
1635 (let ((inhibit-read-only t))
1636 (set-text-properties opoint (point) nil))))
1638 (defun insert-buffer-substring-as-yank (buffer &optional start end)
1639 "Insert before point a part of BUFFER, stripping some text properties.
1640 BUFFER may be a buffer or a buffer name.
1641 Arguments START and END are character positions specifying the substring.
1642 They default to the values of (point-min) and (point-max) in BUFFER.
1643 Strip text properties from the inserted text according to
1644 `yank-excluded-properties'."
1645 ;; Since the buffer text should not normally have yank-handler properties,
1646 ;; there is no need to handle them here.
1647 (let ((opoint (point)))
1648 (insert-buffer-substring buffer start end)
1649 (remove-yank-excluded-properties opoint (point))))
1652 ;; Synchronous shell commands.
1654 (defun start-process-shell-command (name buffer &rest args)
1655 "Start a program in a subprocess. Return the process object for it.
1656 NAME is name for process. It is modified if necessary to make it unique.
1657 BUFFER is the buffer (or buffer name) to associate with the process.
1658 Process output goes at end of that buffer, unless you specify
1659 an output stream or filter function to handle the output.
1660 BUFFER may be also nil, meaning that this process is not associated
1662 COMMAND is the name of a shell command.
1663 Remaining arguments are the arguments for the command.
1664 Wildcards and redirection are handled as usual in the shell.
1666 \(fn NAME BUFFER COMMAND &rest COMMAND-ARGS)"
1668 ((eq system-type 'vax-vms)
1669 (apply 'start-process name buffer args))
1670 ;; We used to use `exec' to replace the shell with the command,
1671 ;; but that failed to handle (...) and semicolon, etc.
1673 (start-process name buffer shell-file-name shell-command-switch
1674 (mapconcat 'identity args " ")))))
1676 (defun call-process-shell-command (command &optional infile buffer display
1678 "Execute the shell command COMMAND synchronously in separate process.
1679 The remaining arguments are optional.
1680 The program's input comes from file INFILE (nil means `/dev/null').
1681 Insert output in BUFFER before point; t means current buffer;
1682 nil for BUFFER means discard it; 0 means discard and don't wait.
1683 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1684 REAL-BUFFER says what to do with standard output, as above,
1685 while STDERR-FILE says what to do with standard error in the child.
1686 STDERR-FILE may be nil (discard standard error output),
1687 t (mix it with ordinary output), or a file name string.
1689 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1690 Remaining arguments are strings passed as additional arguments for COMMAND.
1691 Wildcards and redirection are handled as usual in the shell.
1693 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
1694 Otherwise it waits for COMMAND to terminate and returns a numeric exit
1695 status or a signal description string.
1696 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
1698 ((eq system-type 'vax-vms)
1699 (apply 'call-process command infile buffer display args))
1700 ;; We used to use `exec' to replace the shell with the command,
1701 ;; but that failed to handle (...) and semicolon, etc.
1703 (call-process shell-file-name
1704 infile buffer display
1705 shell-command-switch
1706 (mapconcat 'identity (cons command args) " ")))))
1708 (defmacro with-current-buffer (buffer &rest body)
1709 "Execute the forms in BODY with BUFFER as the current buffer.
1710 The value returned is the value of the last form in BODY.
1711 See also `with-temp-buffer'."
1712 (declare (indent 1) (debug t))
1713 `(save-current-buffer
1714 (set-buffer ,buffer)
1717 (defmacro with-selected-window (window &rest body)
1718 "Execute the forms in BODY with WINDOW as the selected window.
1719 The value returned is the value of the last form in BODY.
1720 This does not alter the buffer list ordering.
1721 This function saves and restores the selected window, as well as
1722 the selected window in each frame. If the previously selected
1723 window of some frame is no longer live at the end of BODY, that
1724 frame's selected window is left alone. If the selected window is
1725 no longer live, then whatever window is selected at the end of
1726 BODY remains selected.
1727 See also `with-temp-buffer'."
1728 (declare (indent 1) (debug t))
1729 ;; Most of this code is a copy of save-selected-window.
1730 `(let ((save-selected-window-window (selected-window))
1731 ;; It is necessary to save all of these, because calling
1732 ;; select-window changes frame-selected-window for whatever
1733 ;; frame that window is in.
1734 (save-selected-window-alist
1735 (mapcar (lambda (frame) (list frame (frame-selected-window frame)))
1738 (progn (select-window ,window 'norecord)
1740 (dolist (elt save-selected-window-alist)
1741 (and (frame-live-p (car elt))
1742 (window-live-p (cadr elt))
1743 (set-frame-selected-window (car elt) (cadr elt))))
1744 (if (window-live-p save-selected-window-window)
1745 (select-window save-selected-window-window 'norecord)))))
1747 (defmacro with-selected-frame (frame &rest body)
1748 "Execute the forms in BODY with FRAME as the selected frame.
1749 The value returned is the value of the last form in BODY.
1750 See also `with-temp-buffer'."
1751 (declare (indent 1) (debug t))
1752 `(let ((save-selected-frame (selected-frame)))
1754 (progn (select-frame ,frame)
1756 (if (frame-live-p save-selected-frame)
1757 (select-frame save-selected-frame)))))
1759 (defmacro with-temp-file (file &rest body)
1760 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
1761 The value returned is the value of the last form in BODY.
1762 See also `with-temp-buffer'."
1764 (let ((temp-file (make-symbol "temp-file"))
1765 (temp-buffer (make-symbol "temp-buffer")))
1766 `(let ((,temp-file ,file)
1768 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
1771 (with-current-buffer ,temp-buffer
1773 (with-current-buffer ,temp-buffer
1775 (write-region (point-min) (point-max) ,temp-file nil 0)))
1776 (and (buffer-name ,temp-buffer)
1777 (kill-buffer ,temp-buffer))))))
1779 (defmacro with-temp-message (message &rest body)
1780 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
1781 The original message is restored to the echo area after BODY has finished.
1782 The value returned is the value of the last form in BODY.
1783 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
1784 If MESSAGE is nil, the echo area and message log buffer are unchanged.
1785 Use a MESSAGE of \"\" to temporarily clear the echo area."
1787 (let ((current-message (make-symbol "current-message"))
1788 (temp-message (make-symbol "with-temp-message")))
1789 `(let ((,temp-message ,message)
1794 (setq ,current-message (current-message))
1795 (message "%s" ,temp-message))
1798 (if ,current-message
1799 (message "%s" ,current-message)
1802 (defmacro with-temp-buffer (&rest body)
1803 "Create a temporary buffer, and evaluate BODY there like `progn'.
1804 See also `with-temp-file' and `with-output-to-string'."
1805 (declare (indent 0) (debug t))
1806 (let ((temp-buffer (make-symbol "temp-buffer")))
1807 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
1809 (with-current-buffer ,temp-buffer
1811 (and (buffer-name ,temp-buffer)
1812 (kill-buffer ,temp-buffer))))))
1814 (defmacro with-output-to-string (&rest body)
1815 "Execute BODY, return the text it sent to `standard-output', as a string."
1816 (declare (indent 0) (debug t))
1817 `(let ((standard-output
1818 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
1819 (let ((standard-output standard-output))
1821 (with-current-buffer standard-output
1824 (kill-buffer nil)))))
1826 (defmacro with-local-quit (&rest body)
1827 "Execute BODY, allowing quits to terminate BODY but not escape further.
1828 When a quit terminates BODY, `with-local-quit' returns nil but
1829 requests another quit. That quit will be processed, the next time quitting
1830 is allowed once again."
1831 (declare (debug t) (indent 0))
1832 `(condition-case nil
1833 (let ((inhibit-quit nil))
1835 (quit (setq quit-flag t) nil)))
1837 (defmacro while-no-input (&rest body)
1838 "Execute BODY only as long as there's no pending input.
1839 If input arrives, that ends the execution of BODY,
1840 and `while-no-input' returns nil. If BODY finishes,
1841 `while-no-input' returns whatever value BODY produced."
1842 (declare (debug t) (indent 0))
1843 (let ((catch-sym (make-symbol "input")))
1846 (let ((throw-on-input ',catch-sym))
1847 (when (sit-for 0 0 t)
1850 (defmacro combine-after-change-calls (&rest body)
1851 "Execute BODY, but don't call the after-change functions till the end.
1852 If BODY makes changes in the buffer, they are recorded
1853 and the functions on `after-change-functions' are called several times
1854 when BODY is finished.
1855 The return value is the value of the last form in BODY.
1857 If `before-change-functions' is non-nil, then calls to the after-change
1858 functions can't be deferred, so in that case this macro has no effect.
1860 Do not alter `after-change-functions' or `before-change-functions'
1862 (declare (indent 0) (debug t))
1864 (let ((combine-after-change-calls t))
1866 (combine-after-change-execute)))
1869 (defvar delay-mode-hooks nil
1870 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1871 (defvar delayed-mode-hooks nil
1872 "List of delayed mode hooks waiting to be run.")
1873 (make-variable-buffer-local 'delayed-mode-hooks)
1874 (put 'delay-mode-hooks 'permanent-local t)
1876 (defvar after-change-major-mode-hook nil
1877 "Normal hook run at the very end of major mode functions.")
1879 (defun run-mode-hooks (&rest hooks)
1880 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1881 Execution is delayed if `delay-mode-hooks' is non-nil.
1882 If `delay-mode-hooks' is nil, run `after-change-major-mode-hook'
1883 after running the mode hooks.
1884 Major mode functions should use this."
1885 (if delay-mode-hooks
1887 (dolist (hook hooks)
1888 (push hook delayed-mode-hooks))
1889 ;; Normal case, just run the hook as before plus any delayed hooks.
1890 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1891 (setq delayed-mode-hooks nil)
1892 (apply 'run-hooks hooks)
1893 (run-hooks 'after-change-major-mode-hook)))
1895 (defmacro delay-mode-hooks (&rest body)
1896 "Execute BODY, but delay any `run-mode-hooks'.
1897 These hooks will be executed by the first following call to
1898 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1899 Only affects hooks run in the current buffer."
1900 (declare (debug t) (indent 0))
1902 (make-local-variable 'delay-mode-hooks)
1903 (let ((delay-mode-hooks t))
1906 ;; PUBLIC: find if the current mode derives from another.
1908 (defun derived-mode-p (&rest modes)
1909 "Non-nil if the current major mode is derived from one of MODES.
1910 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1911 (let ((parent major-mode))
1912 (while (and (not (memq parent modes))
1913 (setq parent (get parent 'derived-mode-parent))))
1916 (defun find-tag-default ()
1917 "Determine default tag to search for, based on text at point.
1918 If there is no plausible default, return nil."
1920 (while (looking-at "\\sw\\|\\s_")
1922 (if (or (re-search-backward "\\sw\\|\\s_"
1923 (save-excursion (beginning-of-line) (point))
1925 (re-search-forward "\\(\\sw\\|\\s_\\)+"
1926 (save-excursion (end-of-line) (point))
1929 (goto-char (match-end 0))
1931 (buffer-substring-no-properties
1933 (progn (forward-sexp -1)
1934 (while (looking-at "\\s'")
1940 (defmacro with-syntax-table (table &rest body)
1941 "Evaluate BODY with syntax table of current buffer set to TABLE.
1942 The syntax table of the current buffer is saved, BODY is evaluated, and the
1943 saved table is restored, even in case of an abnormal exit.
1944 Value is what BODY returns."
1946 (let ((old-table (make-symbol "table"))
1947 (old-buffer (make-symbol "buffer")))
1948 `(let ((,old-table (syntax-table))
1949 (,old-buffer (current-buffer)))
1952 (set-syntax-table ,table)
1954 (save-current-buffer
1955 (set-buffer ,old-buffer)
1956 (set-syntax-table ,old-table))))))
1958 (defmacro dynamic-completion-table (fun)
1959 "Use function FUN as a dynamic completion table.
1960 FUN is called with one argument, the string for which completion is required,
1961 and it should return an alist containing all the intended possible
1962 completions. This alist may be a full list of possible completions so that FUN
1963 can ignore the value of its argument. If completion is performed in the
1964 minibuffer, FUN will be called in the buffer from which the minibuffer was
1967 The result of the `dynamic-completion-table' form is a function
1968 that can be used as the ALIST argument to `try-completion' and
1969 `all-completion'. See Info node `(elisp)Programmed Completion'."
1970 (declare (debug (lambda-expr)))
1971 (let ((win (make-symbol "window"))
1972 (string (make-symbol "string"))
1973 (predicate (make-symbol "predicate"))
1974 (mode (make-symbol "mode")))
1975 `(lambda (,string ,predicate ,mode)
1976 (with-current-buffer (let ((,win (minibuffer-selected-window)))
1977 (if (window-live-p ,win) (window-buffer ,win)
1980 ((eq ,mode t) (all-completions ,string (,fun ,string) ,predicate))
1981 ((not ,mode) (try-completion ,string (,fun ,string) ,predicate))
1982 (t (test-completion ,string (,fun ,string) ,predicate)))))))
1984 (defmacro lazy-completion-table (var fun &rest args)
1985 "Initialize variable VAR as a lazy completion table.
1986 If the completion table VAR is used for the first time (e.g., by passing VAR
1987 as an argument to `try-completion'), the function FUN is called with arguments
1988 ARGS. FUN must return the completion table that will be stored in VAR.
1989 If completion is requested in the minibuffer, FUN will be called in the buffer
1990 from which the minibuffer was entered. The return value of
1991 `lazy-completion-table' must be used to initialize the value of VAR."
1992 (declare (debug (symbol lambda-expr def-body)))
1993 (let ((str (make-symbol "string")))
1994 `(dynamic-completion-table
1996 (unless (listp ,var)
1997 (setq ,var (,fun ,@args)))
2000 (defmacro complete-in-turn (a b)
2001 "Create a completion table that first tries completion in A and then in B.
2002 A and B should not be costly (or side-effecting) expressions."
2003 (declare (debug (def-form def-form)))
2004 `(lambda (string predicate mode)
2007 (or (all-completions string ,a predicate)
2008 (all-completions string ,b predicate)))
2010 (or (try-completion string ,a predicate)
2011 (try-completion string ,b predicate)))
2013 (or (test-completion string ,a predicate)
2014 (test-completion string ,b predicate))))))
2016 ;;; Matching and substitution
2018 (defvar save-match-data-internal)
2020 ;; We use save-match-data-internal as the local variable because
2021 ;; that works ok in practice (people should not use that variable elsewhere).
2022 ;; We used to use an uninterned symbol; the compiler handles that properly
2023 ;; now, but it generates slower code.
2024 (defmacro save-match-data (&rest body)
2025 "Execute the BODY forms, restoring the global value of the match data.
2026 The value returned is the value of the last form in BODY."
2027 ;; It is better not to use backquote here,
2028 ;; because that makes a bootstrapping problem
2029 ;; if you need to recompile all the Lisp files using interpreted code.
2030 (declare (indent 0) (debug t))
2032 '((save-match-data-internal (match-data)))
2033 (list 'unwind-protect
2035 ;; It is safe to free (evaporate) markers immediately here,
2036 ;; as Lisp programs should not copy from save-match-data-internal.
2037 '(set-match-data save-match-data-internal 'evaporate))))
2039 (defun match-string (num &optional string)
2040 "Return string of text matched by last search.
2041 NUM specifies which parenthesized expression in the last regexp.
2042 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2043 Zero means the entire text matched by the whole regexp or whole string.
2044 STRING should be given if the last search was by `string-match' on STRING."
2045 (if (match-beginning num)
2047 (substring string (match-beginning num) (match-end num))
2048 (buffer-substring (match-beginning num) (match-end num)))))
2050 (defun match-string-no-properties (num &optional string)
2051 "Return string of text matched by last search, without text properties.
2052 NUM specifies which parenthesized expression in the last regexp.
2053 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2054 Zero means the entire text matched by the whole regexp or whole string.
2055 STRING should be given if the last search was by `string-match' on STRING."
2056 (if (match-beginning num)
2058 (substring-no-properties string (match-beginning num)
2060 (buffer-substring-no-properties (match-beginning num)
2063 (defun looking-back (regexp &optional limit greedy)
2064 "Return non-nil if text before point matches regular expression REGEXP.
2065 Like `looking-at' except matches before point, and is slower.
2066 LIMIT if non-nil speeds up the search by specifying how far back the
2069 If GREEDY is non-nil, extend the match backwards as far as possible,
2070 stopping when a single additional previous character cannot be part
2071 of a match for REGEXP."
2072 (let ((start (point))
2075 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
2077 (if (and greedy pos)
2079 (narrow-to-region (point-min) start)
2080 (while (and (> pos (point-min))
2084 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
2085 (setq pos (1- pos)))
2088 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
2092 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
2093 "The default value of separators for `split-string'.
2095 A regexp matching strings of whitespace. May be locale-dependent
2096 \(as yet unimplemented). Should not match non-breaking spaces.
2098 Warning: binding this to a different value and using it as default is
2099 likely to have undesired semantics.")
2101 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
2102 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
2103 ;; expression leads to the equivalent implementation that if SEPARATORS
2104 ;; is defaulted, OMIT-NULLS is treated as t.
2105 (defun split-string (string &optional separators omit-nulls)
2106 "Split STRING into substrings bounded by matches for SEPARATORS.
2108 The beginning and end of STRING, and each match for SEPARATORS, are
2109 splitting points. The substrings matching SEPARATORS are removed, and
2110 the substrings between the splitting points are collected as a list,
2113 If SEPARATORS is non-nil, it should be a regular expression matching text
2114 which separates, but is not part of, the substrings. If nil it defaults to
2115 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
2116 OMIT-NULLS is forced to t.
2118 If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so
2119 that for the default value of SEPARATORS leading and trailing whitespace
2120 are effectively trimmed). If nil, all zero-length substrings are retained,
2121 which correctly parses CSV format, for example.
2123 Note that the effect of `(split-string STRING)' is the same as
2124 `(split-string STRING split-string-default-separators t)'). In the rare
2125 case that you wish to retain zero-length substrings when splitting on
2126 whitespace, use `(split-string STRING split-string-default-separators)'.
2128 Modifies the match data; use `save-match-data' if necessary."
2129 (let ((keep-nulls (not (if separators omit-nulls t)))
2130 (rexp (or separators split-string-default-separators))
2134 (while (and (string-match rexp string
2136 (= start (match-beginning 0))
2137 (< start (length string)))
2139 (< start (length string)))
2141 (if (or keep-nulls (< start (match-beginning 0)))
2143 (cons (substring string start (match-beginning 0))
2145 (setq start (match-end 0)))
2146 (if (or keep-nulls (< start (length string)))
2148 (cons (substring string start)
2152 (defun subst-char-in-string (fromchar tochar string &optional inplace)
2153 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
2154 Unless optional argument INPLACE is non-nil, return a new string."
2155 (let ((i (length string))
2156 (newstr (if inplace string (copy-sequence string))))
2159 (if (eq (aref newstr i) fromchar)
2160 (aset newstr i tochar)))
2163 (defun replace-regexp-in-string (regexp rep string &optional
2164 fixedcase literal subexp start)
2165 "Replace all matches for REGEXP with REP in STRING.
2167 Return a new string containing the replacements.
2169 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
2170 arguments with the same names of function `replace-match'. If START
2171 is non-nil, start replacements at that index in STRING.
2173 REP is either a string used as the NEWTEXT arg of `replace-match' or a
2174 function. If it is a function it is applied to each match to generate
2175 the replacement passed to `replace-match'; the match-data at this
2176 point are such that match 0 is the function's argument.
2178 To replace only the first match (if any), make REGEXP match up to \\'
2179 and replace a sub-expression, e.g.
2180 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
2184 ;; To avoid excessive consing from multiple matches in long strings,
2185 ;; don't just call `replace-match' continually. Walk down the
2186 ;; string looking for matches of REGEXP and building up a (reversed)
2187 ;; list MATCHES. This comprises segments of STRING which weren't
2188 ;; matched interspersed with replacements for segments that were.
2189 ;; [For a `large' number of replacements it's more efficient to
2190 ;; operate in a temporary buffer; we can't tell from the function's
2191 ;; args whether to choose the buffer-based implementation, though it
2192 ;; might be reasonable to do so for long enough STRING.]
2193 (let ((l (length string))
2194 (start (or start 0))
2197 (while (and (< start l) (string-match regexp string start))
2198 (setq mb (match-beginning 0)
2200 ;; If we matched the empty string, make sure we advance by one char
2201 (when (= me mb) (setq me (min l (1+ mb))))
2202 ;; Generate a replacement for the matched substring.
2203 ;; Operate only on the substring to minimize string consing.
2204 ;; Set up match data for the substring for replacement;
2205 ;; presumably this is likely to be faster than munging the
2206 ;; match data directly in Lisp.
2207 (string-match regexp (setq str (substring string mb me)))
2209 (cons (replace-match (if (stringp rep)
2211 (funcall rep (match-string 0 str)))
2212 fixedcase literal str subexp)
2213 (cons (substring string start mb) ; unmatched prefix
2216 ;; Reconstruct a string from the pieces.
2217 (setq matches (cons (substring string start l) matches)) ; leftover
2218 (apply #'concat (nreverse matches)))))
2220 (defun subregexp-context-p (regexp pos &optional start)
2221 "Return non-nil if POS is in a normal subregexp context in REGEXP.
2222 A subregexp context is one where a sub-regexp can appear.
2223 A non-subregexp context is for example within brackets, or within a
2224 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
2225 If START is non-nil, it should be a position in REGEXP, smaller
2226 than POS, and known to be in a subregexp context."
2227 ;; Here's one possible implementation, with the great benefit that it
2228 ;; reuses the regexp-matcher's own parser, so it understands all the
2229 ;; details of the syntax. A disadvantage is that it needs to match the
2233 (string-match (substring regexp (or start 0) pos) "")
2236 (not (member (cadr err) '("Unmatched [ or [^"
2238 "Trailing backslash")))))
2239 ;; An alternative implementation:
2240 ;; (defconst re-context-re
2241 ;; (let* ((harmless-ch "[^\\[]")
2242 ;; (harmless-esc "\\\\[^{]")
2243 ;; (class-harmless-ch "[^][]")
2244 ;; (class-lb-harmless "[^]:]")
2245 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
2246 ;; (class-lb (concat "\\[\\(" class-lb-harmless
2247 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
2249 ;; (concat "\\[^?]?"
2250 ;; "\\(" class-harmless-ch
2251 ;; "\\|" class-lb "\\)*"
2252 ;; "\\[?]")) ; special handling for bare [ at end of re
2253 ;; (braces "\\\\{[0-9,]+\\\\}"))
2254 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
2255 ;; "\\|" class "\\|" braces "\\)*\\'"))
2256 ;; "Matches any prefix that corresponds to a normal subregexp context.")
2257 ;; (string-match re-context-re (substring regexp (or start 0) pos))
2260 (defun shell-quote-argument (argument)
2261 "Quote an argument for passing as argument to an inferior shell."
2262 (if (eq system-type 'ms-dos)
2263 ;; Quote using double quotes, but escape any existing quotes in
2264 ;; the argument with backslashes.
2268 (if (or (null (string-match "[^\"]" argument))
2269 (< (match-end 0) (length argument)))
2270 (while (string-match "[\"]" argument start)
2271 (setq end (match-beginning 0)
2272 result (concat result (substring argument start end)
2273 "\\" (substring argument end (1+ end)))
2275 (concat "\"" result (substring argument start) "\""))
2276 (if (eq system-type 'windows-nt)
2277 (concat "\"" argument "\"")
2278 (if (equal argument "")
2280 ;; Quote everything except POSIX filename characters.
2281 ;; This should be safe enough even for really weird shells.
2282 (let ((result "") (start 0) end)
2283 (while (string-match "[^-0-9a-zA-Z_./]" argument start)
2284 (setq end (match-beginning 0)
2285 result (concat result (substring argument start end)
2286 "\\" (substring argument end (1+ end)))
2288 (concat result (substring argument start)))))))
2290 (defun make-syntax-table (&optional oldtable)
2291 "Return a new syntax table.
2292 Create a syntax table which inherits from OLDTABLE (if non-nil) or
2293 from `standard-syntax-table' otherwise."
2294 (let ((table (make-char-table 'syntax-table nil)))
2295 (set-char-table-parent table (or oldtable (standard-syntax-table)))
2298 (defun syntax-after (pos)
2299 "Return the raw syntax of the char after POS.
2300 If POS is outside the buffer's accessible portion, return nil."
2301 (unless (or (< pos (point-min)) (>= pos (point-max)))
2302 (let ((st (if parse-sexp-lookup-properties
2303 (get-char-property pos 'syntax-table))))
2305 (aref (or st (syntax-table)) (char-after pos))))))
2307 (defun syntax-class (syntax)
2308 "Return the syntax class part of the syntax descriptor SYNTAX.
2309 If SYNTAX is nil, return nil."
2310 (and syntax (logand (car syntax) 65535)))
2312 (defun add-to-invisibility-spec (element)
2313 "Add ELEMENT to `buffer-invisibility-spec'.
2314 See documentation for `buffer-invisibility-spec' for the kind of elements
2316 (if (eq buffer-invisibility-spec t)
2317 (setq buffer-invisibility-spec (list t)))
2318 (setq buffer-invisibility-spec
2319 (cons element buffer-invisibility-spec)))
2321 (defun remove-from-invisibility-spec (element)
2322 "Remove ELEMENT from `buffer-invisibility-spec'."
2323 (if (consp buffer-invisibility-spec)
2324 (setq buffer-invisibility-spec (delete element buffer-invisibility-spec))))
2326 (defun global-set-key (key command)
2327 "Give KEY a global binding as COMMAND.
2328 COMMAND is the command definition to use; usually it is
2329 a symbol naming an interactively-callable function.
2330 KEY is a key sequence; noninteractively, it is a string or vector
2331 of characters or event types, and non-ASCII characters with codes
2332 above 127 (such as ISO Latin-1) can be included if you use a vector.
2334 Note that if KEY has a local binding in the current buffer,
2335 that local binding will continue to shadow any global binding
2336 that you make with this function."
2337 (interactive "KSet key globally: \nCSet key %s to command: ")
2338 (or (vectorp key) (stringp key)
2339 (signal 'wrong-type-argument (list 'arrayp key)))
2340 (define-key (current-global-map) key command))
2342 (defun local-set-key (key command)
2343 "Give KEY a local binding as COMMAND.
2344 COMMAND is the command definition to use; usually it is
2345 a symbol naming an interactively-callable function.
2346 KEY is a key sequence; noninteractively, it is a string or vector
2347 of characters or event types, and non-ASCII characters with codes
2348 above 127 (such as ISO Latin-1) can be included if you use a vector.
2350 The binding goes in the current buffer's local map,
2351 which in most cases is shared with all other buffers in the same major mode."
2352 (interactive "KSet key locally: \nCSet key %s locally to command: ")
2353 (let ((map (current-local-map)))
2355 (use-local-map (setq map (make-sparse-keymap))))
2356 (or (vectorp key) (stringp key)
2357 (signal 'wrong-type-argument (list 'arrayp key)))
2358 (define-key map key command)))
2360 (defun global-unset-key (key)
2361 "Remove global binding of KEY.
2362 KEY is a string or vector representing a sequence of keystrokes."
2363 (interactive "kUnset key globally: ")
2364 (global-set-key key nil))
2366 (defun local-unset-key (key)
2367 "Remove local binding of KEY.
2368 KEY is a string or vector representing a sequence of keystrokes."
2369 (interactive "kUnset key locally: ")
2370 (if (current-local-map)
2371 (local-set-key key nil))
2374 ;; We put this here instead of in frame.el so that it's defined even on
2375 ;; systems where frame.el isn't loaded.
2376 (defun frame-configuration-p (object)
2377 "Return non-nil if OBJECT seems to be a frame configuration.
2378 Any list whose car is `frame-configuration' is assumed to be a frame
2381 (eq (car object) 'frame-configuration)))
2383 (defun functionp (object)
2384 "Non-nil if OBJECT is any kind of function or a special form.
2385 Also non-nil if OBJECT is a symbol and its function definition is
2386 \(recursively) a function or special form. This does not include
2388 (or (and (symbolp object) (fboundp object)
2390 (setq object (indirect-function object))
2392 (eq (car-safe object) 'autoload)
2393 (not (car-safe (cdr-safe (cdr-safe (cdr-safe (cdr-safe object)))))))
2394 (subrp object) (byte-code-function-p object)
2395 (eq (car-safe object) 'lambda)))
2397 (defun assq-delete-all (key alist)
2398 "Delete from ALIST all elements whose car is `eq' to KEY.
2399 Return the modified alist.
2400 Elements of ALIST that are not conses are ignored."
2401 (while (and (consp (car alist))
2402 (eq (car (car alist)) key))
2403 (setq alist (cdr alist)))
2404 (let ((tail alist) tail-cdr)
2405 (while (setq tail-cdr (cdr tail))
2406 (if (and (consp (car tail-cdr))
2407 (eq (car (car tail-cdr)) key))
2408 (setcdr tail (cdr tail-cdr))
2409 (setq tail tail-cdr))))
2412 (defun rassq-delete-all (value alist)
2413 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
2414 Return the modified alist.
2415 Elements of ALIST that are not conses are ignored."
2416 (while (and (consp (car alist))
2417 (eq (cdr (car alist)) value))
2418 (setq alist (cdr alist)))
2419 (let ((tail alist) tail-cdr)
2420 (while (setq tail-cdr (cdr tail))
2421 (if (and (consp (car tail-cdr))
2422 (eq (cdr (car tail-cdr)) value))
2423 (setcdr tail (cdr tail-cdr))
2424 (setq tail tail-cdr))))
2427 (defun make-temp-file (prefix &optional dir-flag suffix)
2428 "Create a temporary file.
2429 The returned file name (created by appending some random characters at the end
2430 of PREFIX, and expanding against `temporary-file-directory' if necessary),
2431 is guaranteed to point to a newly created empty file.
2432 You can then use `write-region' to write new data into the file.
2434 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
2436 If SUFFIX is non-nil, add that at the end of the file name."
2437 (let ((umask (default-file-modes))
2441 ;; Create temp files with strict access rights. It's easy to
2442 ;; loosen them later, whereas it's impossible to close the
2443 ;; time-window of loose permissions otherwise.
2444 (set-default-file-modes ?\700)
2445 (while (condition-case ()
2449 (expand-file-name prefix temporary-file-directory)))
2451 (setq file (concat file suffix)))
2453 (make-directory file)
2454 (write-region "" nil file nil 'silent nil 'excl))
2456 (file-already-exists t))
2457 ;; the file was somehow created by someone else between
2458 ;; `make-temp-name' and `write-region', let's try again.
2462 (set-default-file-modes umask))))
2465 ;; If a minor mode is not defined with define-minor-mode,
2466 ;; add it here explicitly.
2467 ;; isearch-mode is deliberately excluded, since you should
2468 ;; not call it yourself.
2469 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
2470 overwrite-mode view-mode
2472 "List of all minor mode functions.")
2474 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
2475 "Register a new minor mode.
2477 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
2479 TOGGLE is a symbol which is the name of a buffer-local variable that
2480 is toggled on or off to say whether the minor mode is active or not.
2482 NAME specifies what will appear in the mode line when the minor mode
2483 is active. NAME should be either a string starting with a space, or a
2484 symbol whose value is such a string.
2486 Optional KEYMAP is the keymap for the minor mode that will be added
2487 to `minor-mode-map-alist'.
2489 Optional AFTER specifies that TOGGLE should be added after AFTER
2490 in `minor-mode-alist'.
2492 Optional TOGGLE-FUN is an interactive function to toggle the mode.
2493 It defaults to (and should by convention be) TOGGLE.
2495 If TOGGLE has a non-nil `:included' property, an entry for the mode is
2496 included in the mode-line minor mode menu.
2497 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
2498 (unless (memq toggle minor-mode-list)
2499 (push toggle minor-mode-list))
2501 (unless toggle-fun (setq toggle-fun toggle))
2502 (unless (eq toggle-fun toggle)
2503 (put toggle :minor-mode-function toggle-fun))
2504 ;; Add the name to the minor-mode-alist.
2506 (let ((existing (assq toggle minor-mode-alist)))
2508 (setcdr existing (list name))
2509 (let ((tail minor-mode-alist) found)
2510 (while (and tail (not found))
2511 (if (eq after (caar tail))
2513 (setq tail (cdr tail))))
2515 (let ((rest (cdr found)))
2517 (nconc found (list (list toggle name)) rest))
2518 (setq minor-mode-alist (cons (list toggle name)
2519 minor-mode-alist)))))))
2520 ;; Add the toggle to the minor-modes menu if requested.
2521 (when (get toggle :included)
2522 (define-key mode-line-mode-menu
2526 (or (get toggle :menu-tag)
2527 (if (stringp name) name (symbol-name toggle)))
2528 (let ((mode-name (if (symbolp name) (symbol-value name))))
2529 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
2530 (concat " (" (match-string 0 mode-name) ")"))))
2532 :button (cons :toggle toggle))))
2534 ;; Add the map to the minor-mode-map-alist.
2536 (let ((existing (assq toggle minor-mode-map-alist)))
2538 (setcdr existing keymap)
2539 (let ((tail minor-mode-map-alist) found)
2540 (while (and tail (not found))
2541 (if (eq after (caar tail))
2543 (setq tail (cdr tail))))
2545 (let ((rest (cdr found)))
2547 (nconc found (list (cons toggle keymap)) rest))
2548 (setq minor-mode-map-alist (cons (cons toggle keymap)
2549 minor-mode-map-alist))))))))
2551 ;; Clones ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2553 (defun text-clone-maintain (ol1 after beg end &optional len)
2554 "Propagate the changes made under the overlay OL1 to the other clones.
2555 This is used on the `modification-hooks' property of text clones."
2556 (when (and after (not undo-in-progress) (overlay-start ol1))
2557 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
2558 (setq beg (max beg (+ (overlay-start ol1) margin)))
2559 (setq end (min end (- (overlay-end ol1) margin)))
2562 (when (overlay-get ol1 'text-clone-syntax)
2563 ;; Check content of the clone's text.
2564 (let ((cbeg (+ (overlay-start ol1) margin))
2565 (cend (- (overlay-end ol1) margin)))
2568 (if (not (re-search-forward
2569 (overlay-get ol1 'text-clone-syntax) cend t))
2570 ;; Mark the overlay for deletion.
2571 (overlay-put ol1 'text-clones nil)
2572 (when (< (match-end 0) cend)
2573 ;; Shrink the clone at its end.
2574 (setq end (min end (match-end 0)))
2575 (move-overlay ol1 (overlay-start ol1)
2576 (+ (match-end 0) margin)))
2577 (when (> (match-beginning 0) cbeg)
2578 ;; Shrink the clone at its beginning.
2579 (setq beg (max (match-beginning 0) beg))
2580 (move-overlay ol1 (- (match-beginning 0) margin)
2581 (overlay-end ol1)))))))
2582 ;; Now go ahead and update the clones.
2583 (let ((head (- beg (overlay-start ol1)))
2584 (tail (- (overlay-end ol1) end))
2585 (str (buffer-substring beg end))
2587 (inhibit-modification-hooks t))
2588 (dolist (ol2 (overlay-get ol1 'text-clones))
2589 (let ((oe (overlay-end ol2)))
2590 (unless (or (eq ol1 ol2) (null oe))
2591 (setq nothing-left nil)
2592 (let ((mod-beg (+ (overlay-start ol2) head)))
2593 ;;(overlay-put ol2 'modification-hooks nil)
2594 (goto-char (- (overlay-end ol2) tail))
2595 (unless (> mod-beg (point))
2596 (save-excursion (insert str))
2597 (delete-region mod-beg (point)))
2598 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
2600 (if nothing-left (delete-overlay ol1))))))))
2602 (defun text-clone-create (start end &optional spreadp syntax)
2603 "Create a text clone of START...END at point.
2604 Text clones are chunks of text that are automatically kept identical:
2605 changes done to one of the clones will be immediately propagated to the other.
2607 The buffer's content at point is assumed to be already identical to
2608 the one between START and END.
2609 If SYNTAX is provided it's a regexp that describes the possible text of
2610 the clones; the clone will be shrunk or killed if necessary to ensure that
2611 its text matches the regexp.
2612 If SPREADP is non-nil it indicates that text inserted before/after the
2613 clone should be incorporated in the clone."
2614 ;; To deal with SPREADP we can either use an overlay with `nil t' along
2615 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
2616 ;; (with a one-char margin at each end) with `t nil'.
2617 ;; We opted for a larger overlay because it behaves better in the case
2618 ;; where the clone is reduced to the empty string (we want the overlay to
2619 ;; stay when the clone's content is the empty string and we want to use
2620 ;; `evaporate' to make sure those overlays get deleted when needed).
2622 (let* ((pt-end (+ (point) (- end start)))
2623 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
2625 (end-margin (if (or (not spreadp)
2626 (>= pt-end (point-max))
2627 (>= start (point-max)))
2629 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
2630 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
2631 (dups (list ol1 ol2)))
2632 (overlay-put ol1 'modification-hooks '(text-clone-maintain))
2633 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
2634 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
2635 ;;(overlay-put ol1 'face 'underline)
2636 (overlay-put ol1 'evaporate t)
2637 (overlay-put ol1 'text-clones dups)
2639 (overlay-put ol2 'modification-hooks '(text-clone-maintain))
2640 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
2641 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
2642 ;;(overlay-put ol2 'face 'underline)
2643 (overlay-put ol2 'evaporate t)
2644 (overlay-put ol2 'text-clones dups)))
2646 (defun play-sound (sound)
2647 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2648 The following keywords are recognized:
2650 :file FILE - read sound data from FILE. If FILE isn't an
2651 absolute file name, it is searched in `data-directory'.
2653 :data DATA - read sound data from string DATA.
2655 Exactly one of :file or :data must be present.
2657 :volume VOL - set volume to VOL. VOL must an integer in the
2658 range 0..100 or a float in the range 0..1.0. If not specified,
2659 don't change the volume setting of the sound device.
2661 :device DEVICE - play sound on DEVICE. If not specified,
2662 a system-dependent default device name is used."
2663 (unless (fboundp 'play-sound-internal)
2664 (error "This Emacs binary lacks sound support"))
2665 (play-sound-internal sound))
2667 (defun define-mail-user-agent (symbol composefunc sendfunc
2668 &optional abortfunc hookvar)
2669 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
2671 SYMBOL can be any Lisp symbol. Its function definition and/or
2672 value as a variable do not matter for this usage; we use only certain
2673 properties on its property list, to encode the rest of the arguments.
2675 COMPOSEFUNC is program callable function that composes an outgoing
2676 mail message buffer. This function should set up the basics of the
2677 buffer without requiring user interaction. It should populate the
2678 standard mail headers, leaving the `to:' and `subject:' headers blank
2681 COMPOSEFUNC should accept several optional arguments--the same
2682 arguments that `compose-mail' takes. See that function's documentation.
2684 SENDFUNC is the command a user would run to send the message.
2686 Optional ABORTFUNC is the command a user would run to abort the
2687 message. For mail packages that don't have a separate abort function,
2688 this can be `kill-buffer' (the equivalent of omitting this argument).
2690 Optional HOOKVAR is a hook variable that gets run before the message
2691 is actually sent. Callers that use the `mail-user-agent' may
2692 install a hook function temporarily on this hook variable.
2693 If HOOKVAR is nil, `mail-send-hook' is used.
2695 The properties used on SYMBOL are `composefunc', `sendfunc',
2696 `abortfunc', and `hookvar'."
2697 (put symbol 'composefunc composefunc)
2698 (put symbol 'sendfunc sendfunc)
2699 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
2700 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
2702 ;; Standardized progress reporting
2704 ;; Progress reporter has the following structure:
2706 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
2713 ;; This weirdeness is for optimization reasons: we want
2714 ;; `progress-reporter-update' to be as fast as possible, so
2715 ;; `(car reporter)' is better than `(aref reporter 0)'.
2717 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
2718 ;; digits of precision, it doesn't really matter here. On the other
2719 ;; hand, it greatly simplifies the code.
2721 (defsubst progress-reporter-update (reporter value)
2722 "Report progress of an operation in the echo area.
2723 However, if the change since last echo area update is too small
2724 or not enough time has passed, then do nothing (see
2725 `make-progress-reporter' for details).
2727 First parameter, REPORTER, should be the result of a call to
2728 `make-progress-reporter'. Second, VALUE, determines the actual
2729 progress of operation; it must be between MIN-VALUE and MAX-VALUE
2730 as passed to `make-progress-reporter'.
2732 This function is very inexpensive, you may not bother how often
2734 (when (>= value (car reporter))
2735 (progress-reporter-do-update reporter value)))
2737 (defun make-progress-reporter (message min-value max-value
2738 &optional current-value
2739 min-change min-time)
2740 "Return progress reporter object to be used with `progress-reporter-update'.
2742 MESSAGE is shown in the echo area. When at least 1% of operation
2743 is complete, the exact percentage will be appended to the
2744 MESSAGE. When you call `progress-reporter-done', word \"done\"
2745 is printed after the MESSAGE. You can change MESSAGE of an
2746 existing progress reporter with `progress-reporter-force-update'.
2748 MIN-VALUE and MAX-VALUE designate starting (0% complete) and
2749 final (100% complete) states of operation. The latter should be
2750 larger; if this is not the case, then simply negate all values.
2751 Optional CURRENT-VALUE specifies the progress by the moment you
2752 call this function. You should omit it or set it to nil in most
2753 cases since it defaults to MIN-VALUE.
2755 Optional MIN-CHANGE determines the minimal change in percents to
2756 report (default is 1%.) Optional MIN-TIME specifies the minimal
2757 time before echo area updates (default is 0.2 seconds.) If
2758 `float-time' function is not present, then time is not tracked
2759 at all. If OS is not capable of measuring fractions of seconds,
2760 then this parameter is effectively rounded up."
2763 (setq min-time 0.2))
2765 (cons min-value ;; Force a call to `message' now
2766 (vector (if (and (fboundp 'float-time)
2772 (if min-change (max (min min-change 50) 1) 1)
2774 (progress-reporter-update reporter (or current-value min-value))
2777 (defun progress-reporter-force-update (reporter value &optional new-message)
2778 "Report progress of an operation in the echo area unconditionally.
2780 First two parameters are the same as for
2781 `progress-reporter-update'. Optional NEW-MESSAGE allows you to
2782 change the displayed message."
2783 (let ((parameters (cdr reporter)))
2785 (aset parameters 3 new-message))
2786 (when (aref parameters 0)
2787 (aset parameters 0 (float-time)))
2788 (progress-reporter-do-update reporter value)))
2790 (defun progress-reporter-do-update (reporter value)
2791 (let* ((parameters (cdr reporter))
2792 (min-value (aref parameters 1))
2793 (max-value (aref parameters 2))
2794 (one-percent (/ (- max-value min-value) 100.0))
2795 (percentage (if (= max-value min-value)
2797 (truncate (/ (- value min-value) one-percent))))
2798 (update-time (aref parameters 0))
2799 (current-time (float-time))
2801 ;; See if enough time has passed since the last update.
2802 (or (not update-time)
2803 (when (>= current-time update-time)
2804 ;; Calculate time for the next update
2805 (aset parameters 0 (+ update-time (aref parameters 5)))))))
2807 ;; Calculate NEXT-UPDATE-VALUE. If we are not going to print
2808 ;; message this time because not enough time has passed, then use
2809 ;; 1 instead of MIN-CHANGE. This makes delays between echo area
2810 ;; updates closer to MIN-TIME.
2812 (min (+ min-value (* (+ percentage
2813 (if enough-time-passed
2814 (aref parameters 4) ;; MIN-CHANGE
2818 (when (integerp value)
2819 (setcar reporter (ceiling (car reporter))))
2821 ;; Only print message if enough time has passed
2822 (when enough-time-passed
2823 (if (> percentage 0)
2824 (message "%s%d%%" (aref parameters 3) percentage)
2825 (message "%s" (aref parameters 3))))))
2827 (defun progress-reporter-done (reporter)
2828 "Print reporter's message followed by word \"done\" in echo area."
2829 (message "%sdone" (aref (cdr reporter) 3)))
2831 (defmacro dotimes-with-progress-reporter (spec message &rest body)
2832 "Loop a certain number of times and report progress in the echo area.
2833 Evaluate BODY with VAR bound to successive integers running from
2834 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
2835 the return value (nil if RESULT is omitted).
2837 At each iteration MESSAGE followed by progress percentage is
2838 printed in the echo area. After the loop is finished, MESSAGE
2839 followed by word \"done\" is printed. This macro is a
2840 convenience wrapper around `make-progress-reporter' and friends.
2842 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
2843 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
2844 (let ((temp (make-symbol "--dotimes-temp--"))
2845 (temp2 (make-symbol "--dotimes-temp2--"))
2849 (,(car spec) ,start)
2850 (,temp2 (make-progress-reporter ,message ,start ,end)))
2851 (while (< ,(car spec) ,temp)
2853 (progress-reporter-update ,temp2
2854 (setq ,(car spec) (1+ ,(car spec)))))
2855 (progress-reporter-done ,temp2)
2856 nil ,@(cdr (cdr spec)))))
2858 ;; arch-tag: f7e0e6e5-70aa-4897-ae72-7a3511ec40bc
2859 ;;; subr.el ends here