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