(Terminal Output): document `send-string-to-terminal' in batch mode.
[emacs.git] / lisp / subr.el
blobae19a644ee110f8df8f5cbd802232305f8f62461
1 ;;; subr.el --- basic lisp subroutines for Emacs
3 ;; Copyright (C) 1985, 1986, 1992, 1994, 1995, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008, 2009 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 3 of the License, or
14 ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;;; Code:
28 (defvar custom-declare-variable-list nil
29 "Record `defcustom' calls made before `custom.el' is loaded to handle them.
30 Each element of this list holds the arguments to one call to `defcustom'.")
32 ;; Use this, rather than defcustom, in subr.el and other files loaded
33 ;; before custom.el.
34 (defun custom-declare-variable-early (&rest arguments)
35 (setq custom-declare-variable-list
36 (cons arguments custom-declare-variable-list)))
38 (defmacro declare-function (fn file &optional arglist fileonly)
39 "Tell the byte-compiler that function FN is defined, in FILE.
40 Optional ARGLIST is the argument list used by the function. The
41 FILE argument is not used by the byte-compiler, but by the
42 `check-declare' package, which checks that FILE contains a
43 definition for FN. ARGLIST is used by both the byte-compiler and
44 `check-declare' to check for consistency.
46 FILE can be either a Lisp file (in which case the \".el\"
47 extension is optional), or a C file. C files are expanded
48 relative to the Emacs \"src/\" directory. Lisp files are
49 searched for using `locate-library', and if that fails they are
50 expanded relative to the location of the file containing the
51 declaration. A FILE with an \"ext:\" prefix is an external file.
52 `check-declare' will check such files if they are found, and skip
53 them without error if they are not.
55 FILEONLY non-nil means that `check-declare' will only check that
56 FILE exists, not that it defines FN. This is intended for
57 function-definitions that `check-declare' does not recognize, e.g.
58 `defstruct'.
60 To specify a value for FILEONLY without passing an argument list,
61 set ARGLIST to `t'. This is necessary because `nil' means an
62 empty argument list, rather than an unspecified one.
64 Note that for the purposes of `check-declare', this statement
65 must be the first non-whitespace on a line, and everything up to
66 the end of FILE must be all on the same line. For example:
68 \(declare-function c-end-of-defun \"progmodes/cc-cmds.el\"
69 \(&optional arg))
71 For more information, see Info node `(elisp)Declaring Functions'."
72 ;; Does nothing - byte-compile-declare-function does the work.
73 nil)
76 ;;;; Basic Lisp macros.
78 (defalias 'not 'null)
80 (defmacro noreturn (form)
81 "Evaluate FORM, expecting it not to return.
82 If FORM does return, signal an error."
83 `(prog1 ,form
84 (error "Form marked with `noreturn' did return")))
86 (defmacro 1value (form)
87 "Evaluate FORM, expecting a constant return value.
88 This is the global do-nothing version. There is also `testcover-1value'
89 that complains if FORM ever does return differing values."
90 form)
92 (defmacro def-edebug-spec (symbol spec)
93 "Set the `edebug-form-spec' property of SYMBOL according to SPEC.
94 Both SYMBOL and SPEC are unevaluated. The SPEC can be:
95 0 (instrument no arguments); t (instrument all arguments);
96 a symbol (naming a function with an Edebug specification); or a list.
97 The elements of the list describe the argument types; see
98 \(info \"(elisp)Specification List\") for details."
99 `(put (quote ,symbol) 'edebug-form-spec (quote ,spec)))
101 (defmacro lambda (&rest cdr)
102 "Return a lambda expression.
103 A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
104 self-quoting; the result of evaluating the lambda expression is the
105 expression itself. The lambda expression may then be treated as a
106 function, i.e., stored as the function value of a symbol, passed to
107 `funcall' or `mapcar', etc.
109 ARGS should take the same form as an argument list for a `defun'.
110 DOCSTRING is an optional documentation string.
111 If present, it should describe how to call the function.
112 But documentation strings are usually not useful in nameless functions.
113 INTERACTIVE should be a call to the function `interactive', which see.
114 It may also be omitted.
115 BODY should be a list of Lisp expressions.
117 \(fn ARGS [DOCSTRING] [INTERACTIVE] BODY)"
118 ;; Note that this definition should not use backquotes; subr.el should not
119 ;; depend on backquote.el.
120 (list 'function (cons 'lambda cdr)))
122 (defmacro push (newelt listname)
123 "Add NEWELT to the list stored in the symbol LISTNAME.
124 This is equivalent to (setq LISTNAME (cons NEWELT LISTNAME)).
125 LISTNAME must be a symbol."
126 (declare (debug (form sexp)))
127 (list 'setq listname
128 (list 'cons newelt listname)))
130 (defmacro pop (listname)
131 "Return the first element of LISTNAME's value, and remove it from the list.
132 LISTNAME must be a symbol whose value is a list.
133 If the value is nil, `pop' returns nil but does not actually
134 change the list."
135 (declare (debug (sexp)))
136 (list 'car
137 (list 'prog1 listname
138 (list 'setq listname (list 'cdr listname)))))
140 (defmacro when (cond &rest body)
141 "If COND yields non-nil, do BODY, else return nil.
142 When COND yields non-nil, eval BODY forms sequentially and return
143 value of last one, or nil if there are none.
145 \(fn COND BODY...)"
146 (declare (indent 1) (debug t))
147 (list 'if cond (cons 'progn body)))
149 (defmacro unless (cond &rest body)
150 "If COND yields nil, do BODY, else return nil.
151 When COND yields nil, eval BODY forms sequentially and return
152 value of last one, or nil if there are none.
154 \(fn COND BODY...)"
155 (declare (indent 1) (debug t))
156 (cons 'if (cons cond (cons nil body))))
158 (defvar --dolist-tail-- nil
159 "Temporary variable used in `dolist' expansion.")
161 (defmacro dolist (spec &rest body)
162 "Loop over a list.
163 Evaluate BODY with VAR bound to each car from LIST, in turn.
164 Then evaluate RESULT to get return value, default nil.
166 \(fn (VAR LIST [RESULT]) BODY...)"
167 (declare (indent 1) (debug ((symbolp form &optional form) body)))
168 ;; It would be cleaner to create an uninterned symbol,
169 ;; but that uses a lot more space when many functions in many files
170 ;; use dolist.
171 (let ((temp '--dolist-tail--))
172 `(let ((,temp ,(nth 1 spec))
173 ,(car spec))
174 (while ,temp
175 (setq ,(car spec) (car ,temp))
176 ,@body
177 (setq ,temp (cdr ,temp)))
178 ,@(if (cdr (cdr spec))
179 `((setq ,(car spec) nil) ,@(cdr (cdr spec)))))))
181 (defvar --dotimes-limit-- nil
182 "Temporary variable used in `dotimes' expansion.")
184 (defmacro dotimes (spec &rest body)
185 "Loop a certain number of times.
186 Evaluate BODY with VAR bound to successive integers running from 0,
187 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
188 the return value (nil if RESULT is omitted).
190 \(fn (VAR COUNT [RESULT]) BODY...)"
191 (declare (indent 1) (debug dolist))
192 ;; It would be cleaner to create an uninterned symbol,
193 ;; but that uses a lot more space when many functions in many files
194 ;; use dotimes.
195 (let ((temp '--dotimes-limit--)
196 (start 0)
197 (end (nth 1 spec)))
198 `(let ((,temp ,end)
199 (,(car spec) ,start))
200 (while (< ,(car spec) ,temp)
201 ,@body
202 (setq ,(car spec) (1+ ,(car spec))))
203 ,@(cdr (cdr spec)))))
205 (defmacro declare (&rest specs)
206 "Do not evaluate any arguments and return nil.
207 Treated as a declaration when used at the right place in a
208 `defmacro' form. \(See Info anchor `(elisp)Definition of declare'.)"
209 nil)
211 (defmacro ignore-errors (&rest body)
212 "Execute BODY; if an error occurs, return nil.
213 Otherwise, return result of last form in BODY."
214 `(condition-case nil (progn ,@body) (error nil)))
216 ;;;; Basic Lisp functions.
218 (defun ignore (&rest ignore)
219 "Do nothing and return nil.
220 This function accepts any number of arguments, but ignores them."
221 (interactive)
222 nil)
224 (defun error (&rest args)
225 "Signal an error, making error message by passing all args to `format'.
226 In Emacs, the convention is that error messages start with a capital
227 letter but *do not* end with a period. Please follow this convention
228 for the sake of consistency.
230 \(fn STRING &rest ARGS)"
231 (while t
232 (signal 'error (list (apply 'format args)))))
234 ;; We put this here instead of in frame.el so that it's defined even on
235 ;; systems where frame.el isn't loaded.
236 (defun frame-configuration-p (object)
237 "Return non-nil if OBJECT seems to be a frame configuration.
238 Any list whose car is `frame-configuration' is assumed to be a frame
239 configuration."
240 (and (consp object)
241 (eq (car object) 'frame-configuration)))
243 (defun functionp (object)
244 "Non-nil if OBJECT is a function."
245 (or (and (symbolp object) (fboundp object)
246 (condition-case nil
247 (setq object (indirect-function object))
248 (error nil))
249 (eq (car-safe object) 'autoload)
250 (not (car-safe (cdr-safe (cdr-safe (cdr-safe (cdr-safe object)))))))
251 (and (subrp object)
252 ;; Filter out special forms.
253 (not (eq 'unevalled (cdr (subr-arity object)))))
254 (byte-code-function-p object)
255 (eq (car-safe object) 'lambda)))
257 ;;;; List functions.
259 (defsubst caar (x)
260 "Return the car of the car of X."
261 (car (car x)))
263 (defsubst cadr (x)
264 "Return the car of the cdr of X."
265 (car (cdr x)))
267 (defsubst cdar (x)
268 "Return the cdr of the car of X."
269 (cdr (car x)))
271 (defsubst cddr (x)
272 "Return the cdr of the cdr of X."
273 (cdr (cdr x)))
275 (defun last (list &optional n)
276 "Return the last link of LIST. Its car is the last element.
277 If LIST is nil, return nil.
278 If N is non-nil, return the Nth-to-last link of LIST.
279 If N is bigger than the length of LIST, return LIST."
280 (if n
281 (let ((m 0) (p list))
282 (while (consp p)
283 (setq m (1+ m) p (cdr p)))
284 (if (<= n 0) p
285 (if (< n m) (nthcdr (- m n) list) list)))
286 (while (consp (cdr list))
287 (setq list (cdr list)))
288 list))
290 (defun butlast (list &optional n)
291 "Return a copy of LIST with the last N elements removed."
292 (if (and n (<= n 0)) list
293 (nbutlast (copy-sequence list) n)))
295 (defun nbutlast (list &optional n)
296 "Modifies LIST to remove the last N elements."
297 (let ((m (length list)))
298 (or n (setq n 1))
299 (and (< n m)
300 (progn
301 (if (> n 0) (setcdr (nthcdr (- (1- m) n) list) nil))
302 list))))
304 (defun delete-dups (list)
305 "Destructively remove `equal' duplicates from LIST.
306 Store the result in LIST and return it. LIST must be a proper list.
307 Of several `equal' occurrences of an element in LIST, the first
308 one is kept."
309 (let ((tail list))
310 (while tail
311 (setcdr tail (delete (car tail) (cdr tail)))
312 (setq tail (cdr tail))))
313 list)
315 (defun number-sequence (from &optional to inc)
316 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
317 INC is the increment used between numbers in the sequence and defaults to 1.
318 So, the Nth element of the list is \(+ FROM \(* N INC)) where N counts from
319 zero. TO is only included if there is an N for which TO = FROM + N * INC.
320 If TO is nil or numerically equal to FROM, return \(FROM).
321 If INC is positive and TO is less than FROM, or INC is negative
322 and TO is larger than FROM, return nil.
323 If INC is zero and TO is neither nil nor numerically equal to
324 FROM, signal an error.
326 This function is primarily designed for integer arguments.
327 Nevertheless, FROM, TO and INC can be integer or float. However,
328 floating point arithmetic is inexact. For instance, depending on
329 the machine, it may quite well happen that
330 \(number-sequence 0.4 0.6 0.2) returns the one element list \(0.4),
331 whereas \(number-sequence 0.4 0.8 0.2) returns a list with three
332 elements. Thus, if some of the arguments are floats and one wants
333 to make sure that TO is included, one may have to explicitly write
334 TO as \(+ FROM \(* N INC)) or use a variable whose value was
335 computed with this exact expression. Alternatively, you can,
336 of course, also replace TO with a slightly larger value
337 \(or a slightly more negative value if INC is negative)."
338 (if (or (not to) (= from to))
339 (list from)
340 (or inc (setq inc 1))
341 (when (zerop inc) (error "The increment can not be zero"))
342 (let (seq (n 0) (next from))
343 (if (> inc 0)
344 (while (<= next to)
345 (setq seq (cons next seq)
346 n (1+ n)
347 next (+ from (* n inc))))
348 (while (>= next to)
349 (setq seq (cons next seq)
350 n (1+ n)
351 next (+ from (* n inc)))))
352 (nreverse seq))))
354 (defun copy-tree (tree &optional vecp)
355 "Make a copy of TREE.
356 If TREE is a cons cell, this recursively copies both its car and its cdr.
357 Contrast to `copy-sequence', which copies only along the cdrs. With second
358 argument VECP, this copies vectors as well as conses."
359 (if (consp tree)
360 (let (result)
361 (while (consp tree)
362 (let ((newcar (car tree)))
363 (if (or (consp (car tree)) (and vecp (vectorp (car tree))))
364 (setq newcar (copy-tree (car tree) vecp)))
365 (push newcar result))
366 (setq tree (cdr tree)))
367 (nconc (nreverse result) tree))
368 (if (and vecp (vectorp tree))
369 (let ((i (length (setq tree (copy-sequence tree)))))
370 (while (>= (setq i (1- i)) 0)
371 (aset tree i (copy-tree (aref tree i) vecp)))
372 tree)
373 tree)))
375 ;;;; Various list-search functions.
377 (defun assoc-default (key alist &optional test default)
378 "Find object KEY in a pseudo-alist ALIST.
379 ALIST is a list of conses or objects. Each element
380 (or the element's car, if it is a cons) is compared with KEY by
381 calling TEST, with two arguments: (i) the element or its car,
382 and (ii) KEY.
383 If that is non-nil, the element matches; then `assoc-default'
384 returns the element's cdr, if it is a cons, or DEFAULT if the
385 element is not a cons.
387 If no element matches, the value is nil.
388 If TEST is omitted or nil, `equal' is used."
389 (let (found (tail alist) value)
390 (while (and tail (not found))
391 (let ((elt (car tail)))
392 (when (funcall (or test 'equal) (if (consp elt) (car elt) elt) key)
393 (setq found t value (if (consp elt) (cdr elt) default))))
394 (setq tail (cdr tail)))
395 value))
397 (make-obsolete 'assoc-ignore-case 'assoc-string "22.1")
398 (defun assoc-ignore-case (key alist)
399 "Like `assoc', but ignores differences in case and text representation.
400 KEY must be a string. Upper-case and lower-case letters are treated as equal.
401 Unibyte strings are converted to multibyte for comparison."
402 (assoc-string key alist t))
404 (make-obsolete 'assoc-ignore-representation 'assoc-string "22.1")
405 (defun assoc-ignore-representation (key alist)
406 "Like `assoc', but ignores differences in text representation.
407 KEY must be a string.
408 Unibyte strings are converted to multibyte for comparison."
409 (assoc-string key alist nil))
411 (defun member-ignore-case (elt list)
412 "Like `member', but ignores differences in case and text representation.
413 ELT must be a string. Upper-case and lower-case letters are treated as equal.
414 Unibyte strings are converted to multibyte for comparison.
415 Non-strings in LIST are ignored."
416 (while (and list
417 (not (and (stringp (car list))
418 (eq t (compare-strings elt 0 nil (car list) 0 nil t)))))
419 (setq list (cdr list)))
420 list)
422 (defun assq-delete-all (key alist)
423 "Delete from ALIST all elements whose car is `eq' to KEY.
424 Return the modified alist.
425 Elements of ALIST that are not conses are ignored."
426 (while (and (consp (car alist))
427 (eq (car (car alist)) key))
428 (setq alist (cdr alist)))
429 (let ((tail alist) tail-cdr)
430 (while (setq tail-cdr (cdr tail))
431 (if (and (consp (car tail-cdr))
432 (eq (car (car tail-cdr)) key))
433 (setcdr tail (cdr tail-cdr))
434 (setq tail tail-cdr))))
435 alist)
437 (defun rassq-delete-all (value alist)
438 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
439 Return the modified alist.
440 Elements of ALIST that are not conses are ignored."
441 (while (and (consp (car alist))
442 (eq (cdr (car alist)) value))
443 (setq alist (cdr alist)))
444 (let ((tail alist) tail-cdr)
445 (while (setq tail-cdr (cdr tail))
446 (if (and (consp (car tail-cdr))
447 (eq (cdr (car tail-cdr)) value))
448 (setcdr tail (cdr tail-cdr))
449 (setq tail tail-cdr))))
450 alist)
452 (defun remove (elt seq)
453 "Return a copy of SEQ with all occurrences of ELT removed.
454 SEQ must be a list, vector, or string. The comparison is done with `equal'."
455 (if (nlistp seq)
456 ;; If SEQ isn't a list, there's no need to copy SEQ because
457 ;; `delete' will return a new object.
458 (delete elt seq)
459 (delete elt (copy-sequence seq))))
461 (defun remq (elt list)
462 "Return LIST with all occurrences of ELT removed.
463 The comparison is done with `eq'. Contrary to `delq', this does not use
464 side-effects, and the argument LIST is not modified."
465 (if (memq elt list)
466 (delq elt (copy-sequence list))
467 list))
469 ;;;; Keymap support.
471 (defmacro kbd (keys)
472 "Convert KEYS to the internal Emacs key representation.
473 KEYS should be a string constant in the format used for
474 saving keyboard macros (see `edmacro-mode')."
475 (read-kbd-macro keys))
477 (defun undefined ()
478 (interactive)
479 (ding))
481 ;; Prevent the \{...} documentation construct
482 ;; from mentioning keys that run this command.
483 (put 'undefined 'suppress-keymap t)
485 (defun suppress-keymap (map &optional nodigits)
486 "Make MAP override all normally self-inserting keys to be undefined.
487 Normally, as an exception, digits and minus-sign are set to make prefix args,
488 but optional second arg NODIGITS non-nil treats them like other chars."
489 (define-key map [remap self-insert-command] 'undefined)
490 (or nodigits
491 (let (loop)
492 (define-key map "-" 'negative-argument)
493 ;; Make plain numbers do numeric args.
494 (setq loop ?0)
495 (while (<= loop ?9)
496 (define-key map (char-to-string loop) 'digit-argument)
497 (setq loop (1+ loop))))))
499 (defun define-key-after (keymap key definition &optional after)
500 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
501 This is like `define-key' except that the binding for KEY is placed
502 just after the binding for the event AFTER, instead of at the beginning
503 of the map. Note that AFTER must be an event type (like KEY), NOT a command
504 \(like DEFINITION).
506 If AFTER is t or omitted, the new binding goes at the end of the keymap.
507 AFTER should be a single event type--a symbol or a character, not a sequence.
509 Bindings are always added before any inherited map.
511 The order of bindings in a keymap matters when it is used as a menu."
512 (unless after (setq after t))
513 (or (keymapp keymap)
514 (signal 'wrong-type-argument (list 'keymapp keymap)))
515 (setq key
516 (if (<= (length key) 1) (aref key 0)
517 (setq keymap (lookup-key keymap
518 (apply 'vector
519 (butlast (mapcar 'identity key)))))
520 (aref key (1- (length key)))))
521 (let ((tail keymap) done inserted)
522 (while (and (not done) tail)
523 ;; Delete any earlier bindings for the same key.
524 (if (eq (car-safe (car (cdr tail))) key)
525 (setcdr tail (cdr (cdr tail))))
526 ;; If we hit an included map, go down that one.
527 (if (keymapp (car tail)) (setq tail (car tail)))
528 ;; When we reach AFTER's binding, insert the new binding after.
529 ;; If we reach an inherited keymap, insert just before that.
530 ;; If we reach the end of this keymap, insert at the end.
531 (if (or (and (eq (car-safe (car tail)) after)
532 (not (eq after t)))
533 (eq (car (cdr tail)) 'keymap)
534 (null (cdr tail)))
535 (progn
536 ;; Stop the scan only if we find a parent keymap.
537 ;; Keep going past the inserted element
538 ;; so we can delete any duplications that come later.
539 (if (eq (car (cdr tail)) 'keymap)
540 (setq done t))
541 ;; Don't insert more than once.
542 (or inserted
543 (setcdr tail (cons (cons key definition) (cdr tail))))
544 (setq inserted t)))
545 (setq tail (cdr tail)))))
547 (defun map-keymap-sorted (function keymap)
548 "Implement `map-keymap' with sorting.
549 Don't call this function; it is for internal use only."
550 (let (list)
551 (map-keymap (lambda (a b) (push (cons a b) list))
552 keymap)
553 (setq list (sort list
554 (lambda (a b)
555 (setq a (car a) b (car b))
556 (if (integerp a)
557 (if (integerp b) (< a b)
559 (if (integerp b) t
560 ;; string< also accepts symbols.
561 (string< a b))))))
562 (dolist (p list)
563 (funcall function (car p) (cdr p)))))
565 (defun keymap-canonicalize (map)
566 "Return an equivalent keymap, without inheritance."
567 (let ((bindings ())
568 (ranges ())
569 (prompt (keymap-prompt map)))
570 (while (keymapp map)
571 (setq map (map-keymap-internal
572 (lambda (key item)
573 (if (consp key)
574 ;; Treat char-ranges specially.
575 (push (cons key item) ranges)
576 (push (cons key item) bindings)))
577 map)))
578 (setq map (funcall (if ranges 'make-keymap 'make-sparse-keymap) prompt))
579 (dolist (binding ranges)
580 ;; Treat char-ranges specially.
581 (define-key map (vector (car binding)) (cdr binding)))
582 (dolist (binding (prog1 bindings (setq bindings ())))
583 (let* ((key (car binding))
584 (item (cdr binding))
585 (oldbind (assq key bindings)))
586 ;; Newer bindings override older.
587 (if oldbind (setq bindings (delq oldbind bindings)))
588 (when item ;nil bindings just hide older ones.
589 (push binding bindings))))
590 (nconc map bindings)))
592 (put 'keyboard-translate-table 'char-table-extra-slots 0)
594 (defun keyboard-translate (from to)
595 "Translate character FROM to TO at a low level.
596 This function creates a `keyboard-translate-table' if necessary
597 and then modifies one entry in it."
598 (or (char-table-p keyboard-translate-table)
599 (setq keyboard-translate-table
600 (make-char-table 'keyboard-translate-table nil)))
601 (aset keyboard-translate-table from to))
603 ;;;; Key binding commands.
605 (defun global-set-key (key command)
606 "Give KEY a global binding as COMMAND.
607 COMMAND is the command definition to use; usually it is
608 a symbol naming an interactively-callable function.
609 KEY is a key sequence; noninteractively, it is a string or vector
610 of characters or event types, and non-ASCII characters with codes
611 above 127 (such as ISO Latin-1) can be included if you use a vector.
613 Note that if KEY has a local binding in the current buffer,
614 that local binding will continue to shadow any global binding
615 that you make with this function."
616 (interactive "KSet key globally: \nCSet key %s to command: ")
617 (or (vectorp key) (stringp key)
618 (signal 'wrong-type-argument (list 'arrayp key)))
619 (define-key (current-global-map) key command))
621 (defun local-set-key (key command)
622 "Give KEY a local binding as COMMAND.
623 COMMAND is the command definition to use; usually it is
624 a symbol naming an interactively-callable function.
625 KEY is a key sequence; noninteractively, it is a string or vector
626 of characters or event types, and non-ASCII characters with codes
627 above 127 (such as ISO Latin-1) can be included if you use a vector.
629 The binding goes in the current buffer's local map,
630 which in most cases is shared with all other buffers in the same major mode."
631 (interactive "KSet key locally: \nCSet key %s locally to command: ")
632 (let ((map (current-local-map)))
633 (or map
634 (use-local-map (setq map (make-sparse-keymap))))
635 (or (vectorp key) (stringp key)
636 (signal 'wrong-type-argument (list 'arrayp key)))
637 (define-key map key command)))
639 (defun global-unset-key (key)
640 "Remove global binding of KEY.
641 KEY is a string or vector representing a sequence of keystrokes."
642 (interactive "kUnset key globally: ")
643 (global-set-key key nil))
645 (defun local-unset-key (key)
646 "Remove local binding of KEY.
647 KEY is a string or vector representing a sequence of keystrokes."
648 (interactive "kUnset key locally: ")
649 (if (current-local-map)
650 (local-set-key key nil))
651 nil)
653 ;;;; substitute-key-definition and its subroutines.
655 (defvar key-substitution-in-progress nil
656 "Used internally by `substitute-key-definition'.")
658 (defun substitute-key-definition (olddef newdef keymap &optional oldmap prefix)
659 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
660 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
661 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
662 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
664 If you don't specify OLDMAP, you can usually get the same results
665 in a cleaner way with command remapping, like this:
666 \(define-key KEYMAP [remap OLDDEF] NEWDEF)
667 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
668 ;; Don't document PREFIX in the doc string because we don't want to
669 ;; advertise it. It's meant for recursive calls only. Here's its
670 ;; meaning
672 ;; If optional argument PREFIX is specified, it should be a key
673 ;; prefix, a string. Redefined bindings will then be bound to the
674 ;; original key, with PREFIX added at the front.
675 (or prefix (setq prefix ""))
676 (let* ((scan (or oldmap keymap))
677 (prefix1 (vconcat prefix [nil]))
678 (key-substitution-in-progress
679 (cons scan key-substitution-in-progress)))
680 ;; Scan OLDMAP, finding each char or event-symbol that
681 ;; has any definition, and act on it with hack-key.
682 (map-keymap
683 (lambda (char defn)
684 (aset prefix1 (length prefix) char)
685 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
686 scan)))
688 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
689 (let (inner-def skipped menu-item)
690 ;; Find the actual command name within the binding.
691 (if (eq (car-safe defn) 'menu-item)
692 (setq menu-item defn defn (nth 2 defn))
693 ;; Skip past menu-prompt.
694 (while (stringp (car-safe defn))
695 (push (pop defn) skipped))
696 ;; Skip past cached key-equivalence data for menu items.
697 (if (consp (car-safe defn))
698 (setq defn (cdr defn))))
699 (if (or (eq defn olddef)
700 ;; Compare with equal if definition is a key sequence.
701 ;; That is useful for operating on function-key-map.
702 (and (or (stringp defn) (vectorp defn))
703 (equal defn olddef)))
704 (define-key keymap prefix
705 (if menu-item
706 (let ((copy (copy-sequence menu-item)))
707 (setcar (nthcdr 2 copy) newdef)
708 copy)
709 (nconc (nreverse skipped) newdef)))
710 ;; Look past a symbol that names a keymap.
711 (setq inner-def
712 (or (indirect-function defn t) defn))
713 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
714 ;; avoid autoloading a keymap. This is mostly done to preserve the
715 ;; original non-autoloading behavior of pre-map-keymap times.
716 (if (and (keymapp inner-def)
717 ;; Avoid recursively scanning
718 ;; where KEYMAP does not have a submap.
719 (let ((elt (lookup-key keymap prefix)))
720 (or (null elt) (natnump elt) (keymapp elt)))
721 ;; Avoid recursively rescanning keymap being scanned.
722 (not (memq inner-def key-substitution-in-progress)))
723 ;; If this one isn't being scanned already, scan it now.
724 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
727 ;;;; The global keymap tree.
729 ;;; global-map, esc-map, and ctl-x-map have their values set up in
730 ;;; keymap.c; we just give them docstrings here.
732 (defvar global-map nil
733 "Default global keymap mapping Emacs keyboard input into commands.
734 The value is a keymap which is usually (but not necessarily) Emacs's
735 global map.")
737 (defvar esc-map nil
738 "Default keymap for ESC (meta) commands.
739 The normal global definition of the character ESC indirects to this keymap.")
741 (defvar ctl-x-map nil
742 "Default keymap for C-x commands.
743 The normal global definition of the character C-x indirects to this keymap.")
745 (defvar ctl-x-4-map (make-sparse-keymap)
746 "Keymap for subcommands of C-x 4.")
747 (defalias 'ctl-x-4-prefix ctl-x-4-map)
748 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
750 (defvar ctl-x-5-map (make-sparse-keymap)
751 "Keymap for frame commands.")
752 (defalias 'ctl-x-5-prefix ctl-x-5-map)
753 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
756 ;;;; Event manipulation functions.
758 (defconst listify-key-sequence-1 (logior 128 ?\M-\C-@))
760 (defun listify-key-sequence (key)
761 "Convert a key sequence to a list of events."
762 (if (vectorp key)
763 (append key nil)
764 (mapcar (function (lambda (c)
765 (if (> c 127)
766 (logxor c listify-key-sequence-1)
767 c)))
768 key)))
770 (defsubst eventp (obj)
771 "True if the argument is an event object."
772 (or (and (integerp obj)
773 ;; Filter out integers too large to be events.
774 ;; M is the biggest modifier.
775 (zerop (logand obj (lognot (1- (lsh ?\M-\^@ 1)))))
776 (characterp (event-basic-type obj)))
777 (and (symbolp obj)
778 (get obj 'event-symbol-elements))
779 (and (consp obj)
780 (symbolp (car obj))
781 (get (car obj) 'event-symbol-elements))))
783 (defun event-modifiers (event)
784 "Return a list of symbols representing the modifier keys in event EVENT.
785 The elements of the list may include `meta', `control',
786 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
787 and `down'.
788 EVENT may be an event or an event type. If EVENT is a symbol
789 that has never been used in an event that has been read as input
790 in the current Emacs session, then this function can return nil,
791 even when EVENT actually has modifiers."
792 (let ((type event))
793 (if (listp type)
794 (setq type (car type)))
795 (if (symbolp type)
796 ;; Don't read event-symbol-elements directly since we're not
797 ;; sure the symbol has already been parsed.
798 (cdr (internal-event-symbol-parse-modifiers type))
799 (let ((list nil)
800 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
801 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
802 (if (not (zerop (logand type ?\M-\^@)))
803 (push 'meta list))
804 (if (or (not (zerop (logand type ?\C-\^@)))
805 (< char 32))
806 (push 'control list))
807 (if (or (not (zerop (logand type ?\S-\^@)))
808 (/= char (downcase char)))
809 (push 'shift list))
810 (or (zerop (logand type ?\H-\^@))
811 (push 'hyper list))
812 (or (zerop (logand type ?\s-\^@))
813 (push 'super list))
814 (or (zerop (logand type ?\A-\^@))
815 (push 'alt list))
816 list))))
818 (defun event-basic-type (event)
819 "Return the basic type of the given event (all modifiers removed).
820 The value is a printing character (not upper case) or a symbol.
821 EVENT may be an event or an event type. If EVENT is a symbol
822 that has never been used in an event that has been read as input
823 in the current Emacs session, then this function may return nil."
824 (if (consp event)
825 (setq event (car event)))
826 (if (symbolp event)
827 (car (get event 'event-symbol-elements))
828 (let* ((base (logand event (1- ?\A-\^@)))
829 (uncontrolled (if (< base 32) (logior base 64) base)))
830 ;; There are some numbers that are invalid characters and
831 ;; cause `downcase' to get an error.
832 (condition-case ()
833 (downcase uncontrolled)
834 (error uncontrolled)))))
836 (defsubst mouse-movement-p (object)
837 "Return non-nil if OBJECT is a mouse movement event."
838 (eq (car-safe object) 'mouse-movement))
840 (defun mouse-event-p (object)
841 "Return non-nil if OBJECT is a mouse click event."
842 ;; is this really correct? maybe remove mouse-movement?
843 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement)))
845 (defsubst event-start (event)
846 "Return the starting position of EVENT.
847 If EVENT is a mouse or key press or a mouse click, this returns the location
848 of the event.
849 If EVENT is a drag, this returns the drag's starting position.
850 The return value is of the form
851 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
852 IMAGE (DX . DY) (WIDTH . HEIGHT))
853 The `posn-' functions access elements of such lists."
854 (if (consp event) (nth 1 event)
855 (list (selected-window) (point) '(0 . 0) 0)))
857 (defsubst event-end (event)
858 "Return the ending location of EVENT.
859 EVENT should be a click, drag, or key press event.
860 If EVENT is a click event, this function is the same as `event-start'.
861 The return value is of the form
862 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
863 IMAGE (DX . DY) (WIDTH . HEIGHT))
864 The `posn-' functions access elements of such lists."
865 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
866 (list (selected-window) (point) '(0 . 0) 0)))
868 (defsubst event-click-count (event)
869 "Return the multi-click count of EVENT, a click or drag event.
870 The return value is a positive integer."
871 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
873 ;;;; Extracting fields of the positions in an event.
875 (defsubst posn-window (position)
876 "Return the window in POSITION.
877 POSITION should be a list of the form returned by the `event-start'
878 and `event-end' functions."
879 (nth 0 position))
881 (defsubst posn-area (position)
882 "Return the window area recorded in POSITION, or nil for the text area.
883 POSITION should be a list of the form returned by the `event-start'
884 and `event-end' functions."
885 (let ((area (if (consp (nth 1 position))
886 (car (nth 1 position))
887 (nth 1 position))))
888 (and (symbolp area) area)))
890 (defsubst posn-point (position)
891 "Return the buffer location in POSITION.
892 POSITION should be a list of the form returned by the `event-start'
893 and `event-end' functions."
894 (or (nth 5 position)
895 (if (consp (nth 1 position))
896 (car (nth 1 position))
897 (nth 1 position))))
899 (defun posn-set-point (position)
900 "Move point to POSITION.
901 Select the corresponding window as well."
902 (if (not (windowp (posn-window position)))
903 (error "Position not in text area of window"))
904 (select-window (posn-window position))
905 (if (numberp (posn-point position))
906 (goto-char (posn-point position))))
908 (defsubst posn-x-y (position)
909 "Return the x and y coordinates in POSITION.
910 POSITION should be a list of the form returned by the `event-start'
911 and `event-end' functions."
912 (nth 2 position))
914 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
916 (defun posn-col-row (position)
917 "Return the nominal column and row in POSITION, measured in characters.
918 The column and row values are approximations calculated from the x
919 and y coordinates in POSITION and the frame's default character width
920 and height.
921 For a scroll-bar event, the result column is 0, and the row
922 corresponds to the vertical position of the click in the scroll bar.
923 POSITION should be a list of the form returned by the `event-start'
924 and `event-end' functions."
925 (let* ((pair (posn-x-y position))
926 (window (posn-window position))
927 (area (posn-area position)))
928 (cond
929 ((null window)
930 '(0 . 0))
931 ((eq area 'vertical-scroll-bar)
932 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
933 ((eq area 'horizontal-scroll-bar)
934 (cons (scroll-bar-scale pair (window-width window)) 0))
936 (let* ((frame (if (framep window) window (window-frame window)))
937 ;; FIXME: This should take line-spacing properties on
938 ;; newlines into account.
939 (spacing (when (display-graphic-p frame)
940 (or (with-current-buffer (window-buffer window)
941 line-spacing)
942 (frame-parameter frame 'line-spacing)))))
943 (cond ((floatp spacing)
944 (setq spacing (truncate (* spacing
945 (frame-char-height frame)))))
946 ((null spacing)
947 (setq spacing 0)))
948 (cons (/ (car pair) (frame-char-width frame))
949 (/ (cdr pair) (+ (frame-char-height frame) spacing))))))))
951 (defun posn-actual-col-row (position)
952 "Return the actual column and row in POSITION, measured in characters.
953 These are the actual row number in the window and character number in that row.
954 Return nil if POSITION does not contain the actual position; in that case
955 `posn-col-row' can be used to get approximate values.
956 POSITION should be a list of the form returned by the `event-start'
957 and `event-end' functions."
958 (nth 6 position))
960 (defsubst posn-timestamp (position)
961 "Return the timestamp of POSITION.
962 POSITION should be a list of the form returned by the `event-start'
963 and `event-end' functions."
964 (nth 3 position))
966 (defsubst posn-string (position)
967 "Return the string object of POSITION.
968 Value is a cons (STRING . STRING-POS), or nil if not a string.
969 POSITION should be a list of the form returned by the `event-start'
970 and `event-end' functions."
971 (nth 4 position))
973 (defsubst posn-image (position)
974 "Return the image object of POSITION.
975 Value is a list (image ...), or nil if not an image.
976 POSITION should be a list of the form returned by the `event-start'
977 and `event-end' functions."
978 (nth 7 position))
980 (defsubst posn-object (position)
981 "Return the object (image or string) of POSITION.
982 Value is a list (image ...) for an image object, a cons cell
983 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
984 POSITION should be a list of the form returned by the `event-start'
985 and `event-end' functions."
986 (or (posn-image position) (posn-string position)))
988 (defsubst posn-object-x-y (position)
989 "Return the x and y coordinates relative to the object of POSITION.
990 POSITION should be a list of the form returned by the `event-start'
991 and `event-end' functions."
992 (nth 8 position))
994 (defsubst posn-object-width-height (position)
995 "Return the pixel width and height of the object of POSITION.
996 POSITION should be a list of the form returned by the `event-start'
997 and `event-end' functions."
998 (nth 9 position))
1001 ;;;; Obsolescent names for functions.
1003 ;; Special "default-FOO" variables which contain the default value of
1004 ;; the "FOO" variable are nasty. Their implementation is brittle, and
1005 ;; slows down several unrelated variable operations; furthermore, they
1006 ;; can lead to really odd behavior if you decide to make them
1007 ;; buffer-local.
1009 ;; Not used at all in Emacs, last time I checked:
1010 (make-obsolete-variable 'default-mode-line-format 'mode-line-format "23.2")
1011 (make-obsolete-variable 'default-header-line-format 'header-line-format "23.2")
1012 (make-obsolete-variable 'default-line-spacing 'line-spacing "23.2")
1013 (make-obsolete-variable 'default-abbrev-mode 'abbrev-mode "23.2")
1014 (make-obsolete-variable 'default-ctl-arrow 'ctl-arrow "23.2")
1015 (make-obsolete-variable 'default-direction-reversed 'direction-reversed "23.2")
1016 (make-obsolete-variable 'default-truncate-lines 'truncate-lines "23.2")
1017 (make-obsolete-variable 'default-left-margin 'left-margin "23.2")
1018 (make-obsolete-variable 'default-tab-width 'tab-width "23.2")
1019 (make-obsolete-variable 'default-case-fold-search 'case-fold-search "23.2")
1020 (make-obsolete-variable 'default-left-margin-width 'left-margin-width "23.2")
1021 (make-obsolete-variable 'default-right-margin-width 'right-margin-width "23.2")
1022 (make-obsolete-variable 'default-left-fringe-width 'left-fringe-width "23.2")
1023 (make-obsolete-variable 'default-right-fringe-width 'right-fringe-width "23.2")
1024 (make-obsolete-variable 'default-fringes-outside-margins 'fringes-outside-margins "23.2")
1025 (make-obsolete-variable 'default-scroll-bar-width 'scroll-bar-width "23.2")
1026 (make-obsolete-variable 'default-vertical-scroll-bar 'vertical-scroll-bar "23.2")
1027 (make-obsolete-variable 'default-indicate-empty-lines 'indicate-empty-lines "23.2")
1028 (make-obsolete-variable 'default-indicate-buffer-boundaries 'indicate-buffer-boundaries "23.2")
1029 (make-obsolete-variable 'default-fringe-indicator-alist 'fringe-indicator-alist "23.2")
1030 (make-obsolete-variable 'default-fringe-cursor-alist 'fringe-cursor-alist "23.2")
1031 (make-obsolete-variable 'default-scroll-up-aggressively 'scroll-up-aggressively "23.2")
1032 (make-obsolete-variable 'default-scroll-down-aggressively 'scroll-down-aggressively "23.2")
1033 (make-obsolete-variable 'default-fill-column 'fill-column "23.2")
1034 (make-obsolete-variable 'default-cursor-type 'cursor-type "23.2")
1035 (make-obsolete-variable 'default-buffer-file-type 'buffer-file-type "23.2")
1036 (make-obsolete-variable 'default-cursor-in-non-selected-windows 'cursor-in-non-selected-windows "23.2")
1037 (make-obsolete-variable 'default-buffer-file-coding-system 'buffer-file-coding-system "23.2")
1038 (make-obsolete-variable 'default-major-mode 'major-mode "23.2")
1039 (make-obsolete-variable 'default-enable-multibyte-characters
1040 "use enable-multibyte-characters or set-buffer-multibyte instead" "23.2")
1042 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
1043 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
1044 (define-obsolete-function-alias 'read-input 'read-string "22.1")
1045 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
1046 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
1047 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
1049 (make-obsolete 'char-bytes "now always returns 1." "20.4")
1050 (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1")
1052 (defun insert-string (&rest args)
1053 "Mocklisp-compatibility insert function.
1054 Like the function `insert' except that any argument that is a number
1055 is converted into a string by expressing it in decimal."
1056 (dolist (el args)
1057 (insert (if (integerp el) (number-to-string el) el))))
1058 (make-obsolete 'insert-string 'insert "22.1")
1060 (defun makehash (&optional test) (make-hash-table :test (or test 'eql)))
1061 (make-obsolete 'makehash 'make-hash-table "22.1")
1063 ;; Some programs still use this as a function.
1064 (defun baud-rate ()
1065 "Return the value of the `baud-rate' variable."
1066 baud-rate)
1067 (make-obsolete 'baud-rate "use the `baud-rate' variable instead." "before 19.15")
1069 ;; These are used by VM and some old programs
1070 (defalias 'focus-frame 'ignore "")
1071 (make-obsolete 'focus-frame "it does nothing." "22.1")
1072 (defalias 'unfocus-frame 'ignore "")
1073 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
1074 (make-obsolete 'make-variable-frame-local
1075 "explicitly check for a frame-parameter instead." "22.2")
1077 ;;;; Obsolescence declarations for variables, and aliases.
1079 (make-obsolete-variable 'define-key-rebound-commands nil "23.2")
1080 (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
1081 (make-obsolete 'window-redisplay-end-trigger nil "23.1")
1082 (make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
1084 (make-obsolete 'process-filter-multibyte-p nil "23.1")
1085 (make-obsolete 'set-process-filter-multibyte nil "23.1")
1087 (make-obsolete-variable 'directory-sep-char "do not use it." "21.1")
1088 (make-obsolete-variable
1089 'mode-line-inverse-video
1090 "use the appropriate faces instead."
1091 "21.1")
1092 (make-obsolete-variable
1093 'unread-command-char
1094 "use `unread-command-events' instead. That variable is a list of events
1095 to reread, so it now uses nil to mean `no event', instead of -1."
1096 "before 19.15")
1098 ;; Lisp manual only updated in 22.1.
1099 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
1100 "before 19.34")
1102 (defvaralias 'x-lost-selection-hooks 'x-lost-selection-functions)
1103 (make-obsolete-variable 'x-lost-selection-hooks
1104 'x-lost-selection-functions "22.1")
1105 (defvaralias 'x-sent-selection-hooks 'x-sent-selection-functions)
1106 (make-obsolete-variable 'x-sent-selection-hooks
1107 'x-sent-selection-functions "22.1")
1109 ;; This was introduced in 21.4 for pre-unicode unification. That
1110 ;; usage was rendered obsolete in 23.1 which uses Unicode internally.
1111 ;; Other uses are possible, so this variable is not _really_ obsolete,
1112 ;; but Stefan insists to mark it so.
1113 (make-obsolete-variable 'translation-table-for-input nil "23.1")
1115 (defvaralias 'messages-buffer-max-lines 'message-log-max)
1117 ;; These aliases exist in Emacs 19.34, and probably before, but were
1118 ;; only marked as obsolete in 23.1.
1119 ;; The lisp manual (since at least Emacs 21) describes them as
1120 ;; existing "for compatibility with Emacs version 18".
1121 (define-obsolete-variable-alias 'last-input-char 'last-input-event
1122 "at least 19.34")
1123 (define-obsolete-variable-alias 'last-command-char 'last-command-event
1124 "at least 19.34")
1127 ;;;; Alternate names for functions - these are not being phased out.
1129 (defalias 'send-string 'process-send-string)
1130 (defalias 'send-region 'process-send-region)
1131 (defalias 'string= 'string-equal)
1132 (defalias 'string< 'string-lessp)
1133 (defalias 'move-marker 'set-marker)
1134 (defalias 'rplaca 'setcar)
1135 (defalias 'rplacd 'setcdr)
1136 (defalias 'beep 'ding) ;preserve lingual purity
1137 (defalias 'indent-to-column 'indent-to)
1138 (defalias 'backward-delete-char 'delete-backward-char)
1139 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
1140 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
1141 (defalias 'int-to-string 'number-to-string)
1142 (defalias 'store-match-data 'set-match-data)
1143 (defalias 'chmod 'set-file-modes)
1144 (defalias 'mkdir 'make-directory)
1145 ;; These are the XEmacs names:
1146 (defalias 'point-at-eol 'line-end-position)
1147 (defalias 'point-at-bol 'line-beginning-position)
1149 (defalias 'user-original-login-name 'user-login-name)
1152 ;;;; Hook manipulation functions.
1154 (defun make-local-hook (hook)
1155 "Make the hook HOOK local to the current buffer.
1156 The return value is HOOK.
1158 You never need to call this function now that `add-hook' does it for you
1159 if its LOCAL argument is non-nil.
1161 When a hook is local, its local and global values
1162 work in concert: running the hook actually runs all the hook
1163 functions listed in *either* the local value *or* the global value
1164 of the hook variable.
1166 This function works by making t a member of the buffer-local value,
1167 which acts as a flag to run the hook functions in the default value as
1168 well. This works for all normal hooks, but does not work for most
1169 non-normal hooks yet. We will be changing the callers of non-normal
1170 hooks so that they can handle localness; this has to be done one by
1171 one.
1173 This function does nothing if HOOK is already local in the current
1174 buffer.
1176 Do not use `make-local-variable' to make a hook variable buffer-local."
1177 (if (local-variable-p hook)
1179 (or (boundp hook) (set hook nil))
1180 (make-local-variable hook)
1181 (set hook (list t)))
1182 hook)
1183 (make-obsolete 'make-local-hook "not necessary any more." "21.1")
1185 (defun add-hook (hook function &optional append local)
1186 "Add to the value of HOOK the function FUNCTION.
1187 FUNCTION is not added if already present.
1188 FUNCTION is added (if necessary) at the beginning of the hook list
1189 unless the optional argument APPEND is non-nil, in which case
1190 FUNCTION is added at the end.
1192 The optional fourth argument, LOCAL, if non-nil, says to modify
1193 the hook's buffer-local value rather than its default value.
1194 This makes the hook buffer-local if needed, and it makes t a member
1195 of the buffer-local value. That acts as a flag to run the hook
1196 functions in the default value as well as in the local value.
1198 HOOK should be a symbol, and FUNCTION may be any valid function. If
1199 HOOK is void, it is first set to nil. If HOOK's value is a single
1200 function, it is changed to a list of functions."
1201 (or (boundp hook) (set hook nil))
1202 (or (default-boundp hook) (set-default hook nil))
1203 (if local (unless (local-variable-if-set-p hook)
1204 (set (make-local-variable hook) (list t)))
1205 ;; Detect the case where make-local-variable was used on a hook
1206 ;; and do what we used to do.
1207 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1208 (setq local t)))
1209 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1210 ;; If the hook value is a single function, turn it into a list.
1211 (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1212 (setq hook-value (list hook-value)))
1213 ;; Do the actual addition if necessary
1214 (unless (member function hook-value)
1215 (setq hook-value
1216 (if append
1217 (append hook-value (list function))
1218 (cons function hook-value))))
1219 ;; Set the actual variable
1220 (if local
1221 (progn
1222 ;; If HOOK isn't a permanent local,
1223 ;; but FUNCTION wants to survive a change of modes,
1224 ;; mark HOOK as partially permanent.
1225 (and (symbolp function)
1226 (get function 'permanent-local-hook)
1227 (not (get hook 'permanent-local))
1228 (put hook 'permanent-local 'permanent-local-hook))
1229 (set hook hook-value))
1230 (set-default hook hook-value))))
1232 (defun remove-hook (hook function &optional local)
1233 "Remove from the value of HOOK the function FUNCTION.
1234 HOOK should be a symbol, and FUNCTION may be any valid function. If
1235 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
1236 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1238 The optional third argument, LOCAL, if non-nil, says to modify
1239 the hook's buffer-local value rather than its default value."
1240 (or (boundp hook) (set hook nil))
1241 (or (default-boundp hook) (set-default hook nil))
1242 ;; Do nothing if LOCAL is t but this hook has no local binding.
1243 (unless (and local (not (local-variable-p hook)))
1244 ;; Detect the case where make-local-variable was used on a hook
1245 ;; and do what we used to do.
1246 (when (and (local-variable-p hook)
1247 (not (and (consp (symbol-value hook))
1248 (memq t (symbol-value hook)))))
1249 (setq local t))
1250 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1251 ;; Remove the function, for both the list and the non-list cases.
1252 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1253 (if (equal hook-value function) (setq hook-value nil))
1254 (setq hook-value (delete function (copy-sequence hook-value))))
1255 ;; If the function is on the global hook, we need to shadow it locally
1256 ;;(when (and local (member function (default-value hook))
1257 ;; (not (member (cons 'not function) hook-value)))
1258 ;; (push (cons 'not function) hook-value))
1259 ;; Set the actual variable
1260 (if (not local)
1261 (set-default hook hook-value)
1262 (if (equal hook-value '(t))
1263 (kill-local-variable hook)
1264 (set hook hook-value))))))
1266 (defun add-to-list (list-var element &optional append compare-fn)
1267 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1268 The test for presence of ELEMENT is done with `equal',
1269 or with COMPARE-FN if that's non-nil.
1270 If ELEMENT is added, it is added at the beginning of the list,
1271 unless the optional argument APPEND is non-nil, in which case
1272 ELEMENT is added at the end.
1274 The return value is the new value of LIST-VAR.
1276 If you want to use `add-to-list' on a variable that is not defined
1277 until a certain package is loaded, you should put the call to `add-to-list'
1278 into a hook function that will be run only after loading the package.
1279 `eval-after-load' provides one way to do this. In some cases
1280 other hooks, such as major mode hooks, can do the job."
1281 (if (cond
1282 ((null compare-fn)
1283 (member element (symbol-value list-var)))
1284 ((eq compare-fn 'eq)
1285 (memq element (symbol-value list-var)))
1286 ((eq compare-fn 'eql)
1287 (memql element (symbol-value list-var)))
1289 (let ((lst (symbol-value list-var)))
1290 (while (and lst
1291 (not (funcall compare-fn element (car lst))))
1292 (setq lst (cdr lst)))
1293 lst)))
1294 (symbol-value list-var)
1295 (set list-var
1296 (if append
1297 (append (symbol-value list-var) (list element))
1298 (cons element (symbol-value list-var))))))
1301 (defun add-to-ordered-list (list-var element &optional order)
1302 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1303 The test for presence of ELEMENT is done with `eq'.
1305 The resulting list is reordered so that the elements are in the
1306 order given by each element's numeric list order. Elements
1307 without a numeric list order are placed at the end of the list.
1309 If the third optional argument ORDER is a number (integer or
1310 float), set the element's list order to the given value. If
1311 ORDER is nil or omitted, do not change the numeric order of
1312 ELEMENT. If ORDER has any other value, remove the numeric order
1313 of ELEMENT if it has one.
1315 The list order for each element is stored in LIST-VAR's
1316 `list-order' property.
1318 The return value is the new value of LIST-VAR."
1319 (let ((ordering (get list-var 'list-order)))
1320 (unless ordering
1321 (put list-var 'list-order
1322 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
1323 (when order
1324 (puthash element (and (numberp order) order) ordering))
1325 (unless (memq element (symbol-value list-var))
1326 (set list-var (cons element (symbol-value list-var))))
1327 (set list-var (sort (symbol-value list-var)
1328 (lambda (a b)
1329 (let ((oa (gethash a ordering))
1330 (ob (gethash b ordering)))
1331 (if (and oa ob)
1332 (< oa ob)
1333 oa)))))))
1335 (defun add-to-history (history-var newelt &optional maxelt keep-all)
1336 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1337 Return the new history list.
1338 If MAXELT is non-nil, it specifies the maximum length of the history.
1339 Otherwise, the maximum history length is the value of the `history-length'
1340 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1341 variable.
1342 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1343 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1344 if it is empty or a duplicate."
1345 (unless maxelt
1346 (setq maxelt (or (get history-var 'history-length)
1347 history-length)))
1348 (let ((history (symbol-value history-var))
1349 tail)
1350 (when (and (listp history)
1351 (or keep-all
1352 (not (stringp newelt))
1353 (> (length newelt) 0))
1354 (or keep-all
1355 (not (equal (car history) newelt))))
1356 (if history-delete-duplicates
1357 (delete newelt history))
1358 (setq history (cons newelt history))
1359 (when (integerp maxelt)
1360 (if (= 0 maxelt)
1361 (setq history nil)
1362 (setq tail (nthcdr (1- maxelt) history))
1363 (when (consp tail)
1364 (setcdr tail nil)))))
1365 (set history-var history)))
1368 ;;;; Mode hooks.
1370 (defvar delay-mode-hooks nil
1371 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1372 (defvar delayed-mode-hooks nil
1373 "List of delayed mode hooks waiting to be run.")
1374 (make-variable-buffer-local 'delayed-mode-hooks)
1375 (put 'delay-mode-hooks 'permanent-local t)
1377 (defvar after-change-major-mode-hook nil
1378 "Normal hook run at the very end of major mode functions.")
1380 (defun run-mode-hooks (&rest hooks)
1381 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
1382 Execution is delayed if `delay-mode-hooks' is non-nil.
1383 If `delay-mode-hooks' is nil, run `after-change-major-mode-hook'
1384 after running the mode hooks.
1385 Major mode functions should use this instead of `run-hooks' when running their
1386 FOO-mode-hook."
1387 (if delay-mode-hooks
1388 ;; Delaying case.
1389 (dolist (hook hooks)
1390 (push hook delayed-mode-hooks))
1391 ;; Normal case, just run the hook as before plus any delayed hooks.
1392 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1393 (setq delayed-mode-hooks nil)
1394 (apply 'run-hooks hooks)
1395 (run-hooks 'after-change-major-mode-hook)))
1397 (defmacro delay-mode-hooks (&rest body)
1398 "Execute BODY, but delay any `run-mode-hooks'.
1399 These hooks will be executed by the first following call to
1400 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1401 Only affects hooks run in the current buffer."
1402 (declare (debug t) (indent 0))
1403 `(progn
1404 (make-local-variable 'delay-mode-hooks)
1405 (let ((delay-mode-hooks t))
1406 ,@body)))
1408 ;; PUBLIC: find if the current mode derives from another.
1410 (defun derived-mode-p (&rest modes)
1411 "Non-nil if the current major mode is derived from one of MODES.
1412 Uses the `derived-mode-parent' property of the symbol to trace backwards."
1413 (let ((parent major-mode))
1414 (while (and (not (memq parent modes))
1415 (setq parent (get parent 'derived-mode-parent))))
1416 parent))
1418 ;;;; Minor modes.
1420 ;; If a minor mode is not defined with define-minor-mode,
1421 ;; add it here explicitly.
1422 ;; isearch-mode is deliberately excluded, since you should
1423 ;; not call it yourself.
1424 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1425 overwrite-mode view-mode
1426 hs-minor-mode)
1427 "List of all minor mode functions.")
1429 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1430 "Register a new minor mode.
1432 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1434 TOGGLE is a symbol which is the name of a buffer-local variable that
1435 is toggled on or off to say whether the minor mode is active or not.
1437 NAME specifies what will appear in the mode line when the minor mode
1438 is active. NAME should be either a string starting with a space, or a
1439 symbol whose value is such a string.
1441 Optional KEYMAP is the keymap for the minor mode that will be added
1442 to `minor-mode-map-alist'.
1444 Optional AFTER specifies that TOGGLE should be added after AFTER
1445 in `minor-mode-alist'.
1447 Optional TOGGLE-FUN is an interactive function to toggle the mode.
1448 It defaults to (and should by convention be) TOGGLE.
1450 If TOGGLE has a non-nil `:included' property, an entry for the mode is
1451 included in the mode-line minor mode menu.
1452 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1453 (unless (memq toggle minor-mode-list)
1454 (push toggle minor-mode-list))
1456 (unless toggle-fun (setq toggle-fun toggle))
1457 (unless (eq toggle-fun toggle)
1458 (put toggle :minor-mode-function toggle-fun))
1459 ;; Add the name to the minor-mode-alist.
1460 (when name
1461 (let ((existing (assq toggle minor-mode-alist)))
1462 (if existing
1463 (setcdr existing (list name))
1464 (let ((tail minor-mode-alist) found)
1465 (while (and tail (not found))
1466 (if (eq after (caar tail))
1467 (setq found tail)
1468 (setq tail (cdr tail))))
1469 (if found
1470 (let ((rest (cdr found)))
1471 (setcdr found nil)
1472 (nconc found (list (list toggle name)) rest))
1473 (setq minor-mode-alist (cons (list toggle name)
1474 minor-mode-alist)))))))
1475 ;; Add the toggle to the minor-modes menu if requested.
1476 (when (get toggle :included)
1477 (define-key mode-line-mode-menu
1478 (vector toggle)
1479 (list 'menu-item
1480 (concat
1481 (or (get toggle :menu-tag)
1482 (if (stringp name) name (symbol-name toggle)))
1483 (let ((mode-name (if (symbolp name) (symbol-value name))))
1484 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1485 (concat " (" (match-string 0 mode-name) ")"))))
1486 toggle-fun
1487 :button (cons :toggle toggle))))
1489 ;; Add the map to the minor-mode-map-alist.
1490 (when keymap
1491 (let ((existing (assq toggle minor-mode-map-alist)))
1492 (if existing
1493 (setcdr existing keymap)
1494 (let ((tail minor-mode-map-alist) found)
1495 (while (and tail (not found))
1496 (if (eq after (caar tail))
1497 (setq found tail)
1498 (setq tail (cdr tail))))
1499 (if found
1500 (let ((rest (cdr found)))
1501 (setcdr found nil)
1502 (nconc found (list (cons toggle keymap)) rest))
1503 (setq minor-mode-map-alist (cons (cons toggle keymap)
1504 minor-mode-map-alist))))))))
1506 ;;; Load history
1508 ;; (defvar symbol-file-load-history-loaded nil
1509 ;; "Non-nil means we have loaded the file `fns-VERSION.el' in `exec-directory'.
1510 ;; That file records the part of `load-history' for preloaded files,
1511 ;; which is cleared out before dumping to make Emacs smaller.")
1513 ;; (defun load-symbol-file-load-history ()
1514 ;; "Load the file `fns-VERSION.el' in `exec-directory' if not already done.
1515 ;; That file records the part of `load-history' for preloaded files,
1516 ;; which is cleared out before dumping to make Emacs smaller."
1517 ;; (unless symbol-file-load-history-loaded
1518 ;; (load (expand-file-name
1519 ;; ;; fns-XX.YY.ZZ.el does not work on DOS filesystem.
1520 ;; (if (eq system-type 'ms-dos)
1521 ;; "fns.el"
1522 ;; (format "fns-%s.el" emacs-version))
1523 ;; exec-directory)
1524 ;; ;; The file name fns-%s.el already has a .el extension.
1525 ;; nil nil t)
1526 ;; (setq symbol-file-load-history-loaded t)))
1528 (defun symbol-file (symbol &optional type)
1529 "Return the name of the file that defined SYMBOL.
1530 The value is normally an absolute file name. It can also be nil,
1531 if the definition is not associated with any file. If SYMBOL
1532 specifies an autoloaded function, the value can be a relative
1533 file name without extension.
1535 If TYPE is nil, then any kind of definition is acceptable. If
1536 TYPE is `defun', `defvar', or `defface', that specifies function
1537 definition, variable definition, or face definition only."
1538 (if (and (or (null type) (eq type 'defun))
1539 (symbolp symbol) (fboundp symbol)
1540 (eq 'autoload (car-safe (symbol-function symbol))))
1541 (nth 1 (symbol-function symbol))
1542 (let ((files load-history)
1543 file)
1544 (while files
1545 (if (if type
1546 (if (eq type 'defvar)
1547 ;; Variables are present just as their names.
1548 (member symbol (cdr (car files)))
1549 ;; Other types are represented as (TYPE . NAME).
1550 (member (cons type symbol) (cdr (car files))))
1551 ;; We accept all types, so look for variable def
1552 ;; and then for any other kind.
1553 (or (member symbol (cdr (car files)))
1554 (rassq symbol (cdr (car files)))))
1555 (setq file (car (car files)) files nil))
1556 (setq files (cdr files)))
1557 file)))
1559 (defun locate-library (library &optional nosuffix path interactive-call)
1560 "Show the precise file name of Emacs library LIBRARY.
1561 LIBRARY should be a relative file name of the library, a string.
1562 It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is
1563 nil (which is the default, see below).
1564 This command searches the directories in `load-path' like `\\[load-library]'
1565 to find the file that `\\[load-library] RET LIBRARY RET' would load.
1566 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1567 to the specified name LIBRARY.
1569 If the optional third arg PATH is specified, that list of directories
1570 is used instead of `load-path'.
1572 When called from a program, the file name is normally returned as a
1573 string. When run interactively, the argument INTERACTIVE-CALL is t,
1574 and the file name is displayed in the echo area."
1575 (interactive (list (completing-read "Locate library: "
1576 (apply-partially
1577 'locate-file-completion-table
1578 load-path (get-load-suffixes)))
1579 nil nil
1581 (let ((file (locate-file library
1582 (or path load-path)
1583 (append (unless nosuffix (get-load-suffixes))
1584 load-file-rep-suffixes))))
1585 (if interactive-call
1586 (if file
1587 (message "Library is file %s" (abbreviate-file-name file))
1588 (message "No library %s in search path" library)))
1589 file))
1592 ;;;; Specifying things to do later.
1594 (defmacro eval-at-startup (&rest body)
1595 "Make arrangements to evaluate BODY when Emacs starts up.
1596 If this is run after Emacs startup, evaluate BODY immediately.
1597 Always returns nil.
1599 This works by adding a function to `before-init-hook'.
1600 That function's doc string says which file created it."
1601 `(progn
1602 (if command-line-processed
1603 (progn . ,body)
1604 (add-hook 'before-init-hook
1605 '(lambda () ,(concat "From " (or load-file-name "no file"))
1606 . ,body)
1608 nil))
1610 (defun load-history-regexp (file)
1611 "Form a regexp to find FILE in `load-history'.
1612 FILE, a string, is described in the function `eval-after-load'."
1613 (if (file-name-absolute-p file)
1614 (setq file (file-truename file)))
1615 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
1616 (regexp-quote file)
1617 (if (file-name-extension file)
1619 ;; Note: regexp-opt can't be used here, since we need to call
1620 ;; this before Emacs has been fully started. 2006-05-21
1621 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
1622 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
1623 "\\)?\\'"))
1625 (defun load-history-filename-element (file-regexp)
1626 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
1627 Return nil if there isn't one."
1628 (let* ((loads load-history)
1629 (load-elt (and loads (car loads))))
1630 (save-match-data
1631 (while (and loads
1632 (or (null (car load-elt))
1633 (not (string-match file-regexp (car load-elt)))))
1634 (setq loads (cdr loads)
1635 load-elt (and loads (car loads)))))
1636 load-elt))
1638 (defun eval-after-load (file form)
1639 "Arrange that, if FILE is ever loaded, FORM will be run at that time.
1640 If FILE is already loaded, evaluate FORM right now.
1642 If a matching file is loaded again, FORM will be evaluated again.
1644 If FILE is a string, it may be either an absolute or a relative file
1645 name, and may have an extension \(e.g. \".el\") or may lack one, and
1646 additionally may or may not have an extension denoting a compressed
1647 format \(e.g. \".gz\").
1649 When FILE is absolute, this first converts it to a true name by chasing
1650 symbolic links. Only a file of this name \(see next paragraph regarding
1651 extensions) will trigger the evaluation of FORM. When FILE is relative,
1652 a file whose absolute true name ends in FILE will trigger evaluation.
1654 When FILE lacks an extension, a file name with any extension will trigger
1655 evaluation. Otherwise, its extension must match FILE's. A further
1656 extension for a compressed format \(e.g. \".gz\") on FILE will not affect
1657 this name matching.
1659 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
1660 is evaluated whenever that feature is `provide'd. Note that although
1661 provide statements are usually at the end of files, this is not always
1662 the case (e.g., sometimes they are at the start to avoid a recursive
1663 load error). If your FORM should not be evaluated until the code in
1664 FILE has been, do not use the symbol form for FILE in such cases.
1666 Usually FILE is just a library name like \"font-lock\" or a feature name
1667 like 'font-lock.
1669 This function makes or adds to an entry on `after-load-alist'."
1670 ;; Add this FORM into after-load-alist (regardless of whether we'll be
1671 ;; evaluating it now).
1672 (let* ((regexp-or-feature
1673 (if (stringp file) (load-history-regexp file) file))
1674 (elt (assoc regexp-or-feature after-load-alist)))
1675 (unless elt
1676 (setq elt (list regexp-or-feature))
1677 (push elt after-load-alist))
1678 ;; Add FORM to the element unless it's already there.
1679 (unless (member form (cdr elt))
1680 (nconc elt (list form)))
1682 ;; Is there an already loaded file whose name (or `provide' name)
1683 ;; matches FILE?
1684 (if (if (stringp file)
1685 (load-history-filename-element regexp-or-feature)
1686 (featurep file))
1687 (eval form))))
1689 (defun do-after-load-evaluation (abs-file)
1690 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
1691 ABS-FILE, a string, should be the absolute true name of a file just loaded."
1692 (mapc #'(lambda (a-l-element)
1693 (when (and (stringp (car a-l-element))
1694 (string-match-p (car a-l-element) abs-file))
1695 ;; discard the file name regexp
1696 (mapc #'eval (cdr a-l-element))))
1697 after-load-alist))
1699 (defun eval-next-after-load (file)
1700 "Read the following input sexp, and run it whenever FILE is loaded.
1701 This makes or adds to an entry on `after-load-alist'.
1702 FILE should be the name of a library, with no directory name."
1703 (eval-after-load file (read)))
1705 ;;;; Process stuff.
1707 (defun process-lines (program &rest args)
1708 "Execute PROGRAM with ARGS, returning its output as a list of lines.
1709 Signal an error if the program returns with a non-zero exit status."
1710 (with-temp-buffer
1711 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
1712 (unless (eq status 0)
1713 (error "%s exited with status %s" program status))
1714 (goto-char (point-min))
1715 (let (lines)
1716 (while (not (eobp))
1717 (setq lines (cons (buffer-substring-no-properties
1718 (line-beginning-position)
1719 (line-end-position))
1720 lines))
1721 (forward-line 1))
1722 (nreverse lines)))))
1724 ;; open-network-stream is a wrapper around make-network-process.
1726 (when (featurep 'make-network-process)
1727 (defun open-network-stream (name buffer host service)
1728 "Open a TCP connection for a service to a host.
1729 Returns a subprocess-object to represent the connection.
1730 Input and output work as for subprocesses; `delete-process' closes it.
1732 NAME is the name for the process. It is modified if necessary to make
1733 it unique.
1734 BUFFER is the buffer (or buffer name) to associate with the
1735 process. Process output goes at end of that buffer. BUFFER may
1736 be nil, meaning that this process is not associated with any buffer.
1737 HOST is the name or IP address of the host to connect to.
1738 SERVICE is the name of the service desired, or an integer specifying
1739 a port number to connect to.
1741 This is a wrapper around `make-network-process', and only offers a
1742 subset of its functionality."
1743 (make-network-process :name name :buffer buffer
1744 :host host :service service)))
1746 ;; compatibility
1748 (make-obsolete
1749 'process-kill-without-query
1750 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1751 "22.1")
1752 (defun process-kill-without-query (process &optional flag)
1753 "Say no query needed if PROCESS is running when Emacs is exited.
1754 Optional second argument if non-nil says to require a query.
1755 Value is t if a query was formerly required."
1756 (let ((old (process-query-on-exit-flag process)))
1757 (set-process-query-on-exit-flag process nil)
1758 old))
1760 (defun process-kill-buffer-query-function ()
1761 "Ask before killing a buffer that has a running process."
1762 (let ((process (get-buffer-process (current-buffer))))
1763 (or (not process)
1764 (not (memq (process-status process) '(run stop open listen)))
1765 (not (process-query-on-exit-flag process))
1766 (yes-or-no-p "Buffer has a running process; kill it? "))))
1768 (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function)
1770 ;; process plist management
1772 (defun process-get (process propname)
1773 "Return the value of PROCESS' PROPNAME property.
1774 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
1775 (plist-get (process-plist process) propname))
1777 (defun process-put (process propname value)
1778 "Change PROCESS' PROPNAME property to VALUE.
1779 It can be retrieved with `(process-get PROCESS PROPNAME)'."
1780 (set-process-plist process
1781 (plist-put (process-plist process) propname value)))
1784 ;;;; Input and display facilities.
1786 (defvar read-quoted-char-radix 8
1787 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1788 Legitimate radix values are 8, 10 and 16.")
1790 (custom-declare-variable-early
1791 'read-quoted-char-radix 8
1792 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
1793 Legitimate radix values are 8, 10 and 16."
1794 :type '(choice (const 8) (const 10) (const 16))
1795 :group 'editing-basics)
1797 (defconst read-key-empty-map (make-sparse-keymap))
1799 (defvar read-key-delay 0.1)
1801 (defun read-key (&optional prompt)
1802 "Read a key from the keyboard.
1803 Contrary to `read-event' this will not return a raw event but instead will
1804 obey the input decoding and translations usually done by `read-key-sequence'.
1805 So escape sequences and keyboard encoding are taken into account.
1806 When there's an ambiguity because the key looks like the prefix of
1807 some sort of escape sequence, the ambiguity is resolved via `read-key-delay'."
1808 (let ((overriding-terminal-local-map read-key-empty-map)
1809 (overriding-local-map nil)
1810 (old-global-map (current-global-map))
1811 (timer (run-with-idle-timer
1812 ;; Wait long enough that Emacs has the time to receive and
1813 ;; process all the raw events associated with the single-key.
1814 ;; But don't wait too long, or the user may find the delay
1815 ;; annoying (or keep hitting more keys which may then get
1816 ;; lost or misinterpreted).
1817 ;; This is only relevant for keys which Emacs perceives as
1818 ;; "prefixes", such as C-x (because of the C-x 8 map in
1819 ;; key-translate-table and the C-x @ map in function-key-map)
1820 ;; or ESC (because of terminal escape sequences in
1821 ;; input-decode-map).
1822 read-key-delay t
1823 (lambda ()
1824 (let ((keys (this-command-keys-vector)))
1825 (unless (zerop (length keys))
1826 ;; `keys' is non-empty, so the user has hit at least
1827 ;; one key; there's no point waiting any longer, even
1828 ;; though read-key-sequence thinks we should wait
1829 ;; for more input to decide how to interpret the
1830 ;; current input.
1831 (throw 'read-key keys)))))))
1832 (unwind-protect
1833 (progn
1834 (use-global-map read-key-empty-map)
1835 (aref (catch 'read-key (read-key-sequence prompt nil t)) 0))
1836 (cancel-timer timer)
1837 (use-global-map old-global-map))))
1839 (defun read-quoted-char (&optional prompt)
1840 "Like `read-char', but do not allow quitting.
1841 Also, if the first character read is an octal digit,
1842 we read any number of octal digits and return the
1843 specified character code. Any nondigit terminates the sequence.
1844 If the terminator is RET, it is discarded;
1845 any other terminator is used itself as input.
1847 The optional argument PROMPT specifies a string to use to prompt the user.
1848 The variable `read-quoted-char-radix' controls which radix to use
1849 for numeric input."
1850 (let ((message-log-max nil) done (first t) (code 0) char translated)
1851 (while (not done)
1852 (let ((inhibit-quit first)
1853 ;; Don't let C-h get the help message--only help function keys.
1854 (help-char nil)
1855 (help-form
1856 "Type the special character you want to use,
1857 or the octal character code.
1858 RET terminates the character code and is discarded;
1859 any other non-digit terminates the character code and is then used as input."))
1860 (setq char (read-event (and prompt (format "%s-" prompt)) t))
1861 (if inhibit-quit (setq quit-flag nil)))
1862 ;; Translate TAB key into control-I ASCII character, and so on.
1863 ;; Note: `read-char' does it using the `ascii-character' property.
1864 ;; We could try and use read-key-sequence instead, but then C-q ESC
1865 ;; or C-q C-x might not return immediately since ESC or C-x might be
1866 ;; bound to some prefix in function-key-map or key-translation-map.
1867 (setq translated
1868 (if (integerp char)
1869 (char-resolve-modifiers char)
1870 char))
1871 (let ((translation (lookup-key local-function-key-map (vector char))))
1872 (if (arrayp translation)
1873 (setq translated (aref translation 0))))
1874 (cond ((null translated))
1875 ((not (integerp translated))
1876 (setq unread-command-events (list char)
1877 done t))
1878 ((/= (logand translated ?\M-\^@) 0)
1879 ;; Turn a meta-character into a character with the 0200 bit set.
1880 (setq code (logior (logand translated (lognot ?\M-\^@)) 128)
1881 done t))
1882 ((and (<= ?0 translated) (< translated (+ ?0 (min 10 read-quoted-char-radix))))
1883 (setq code (+ (* code read-quoted-char-radix) (- translated ?0)))
1884 (and prompt (setq prompt (message "%s %c" prompt translated))))
1885 ((and (<= ?a (downcase translated))
1886 (< (downcase translated) (+ ?a -10 (min 36 read-quoted-char-radix))))
1887 (setq code (+ (* code read-quoted-char-radix)
1888 (+ 10 (- (downcase translated) ?a))))
1889 (and prompt (setq prompt (message "%s %c" prompt translated))))
1890 ((and (not first) (eq translated ?\C-m))
1891 (setq done t))
1892 ((not first)
1893 (setq unread-command-events (list char)
1894 done t))
1895 (t (setq code translated
1896 done t)))
1897 (setq first nil))
1898 code))
1900 (defun read-passwd (prompt &optional confirm default)
1901 "Read a password, prompting with PROMPT, and return it.
1902 If optional CONFIRM is non-nil, read the password twice to make sure.
1903 Optional DEFAULT is a default password to use instead of empty input.
1905 This function echoes `.' for each character that the user types.
1907 The user ends with RET, LFD, or ESC. DEL or C-h rubs out.
1908 C-y yanks the current kill. C-u kills line.
1909 C-g quits; if `inhibit-quit' was non-nil around this function,
1910 then it returns nil if the user types C-g, but quit-flag remains set.
1912 Once the caller uses the password, it can erase the password
1913 by doing (clear-string STRING)."
1914 (with-local-quit
1915 (if confirm
1916 (let (success)
1917 (while (not success)
1918 (let ((first (read-passwd prompt nil default))
1919 (second (read-passwd "Confirm password: " nil default)))
1920 (if (equal first second)
1921 (progn
1922 (and (arrayp second) (clear-string second))
1923 (setq success first))
1924 (and (arrayp first) (clear-string first))
1925 (and (arrayp second) (clear-string second))
1926 (message "Password not repeated accurately; please start over")
1927 (sit-for 1))))
1928 success)
1929 (let ((pass nil)
1930 ;; Copy it so that add-text-properties won't modify
1931 ;; the object that was passed in by the caller.
1932 (prompt (copy-sequence prompt))
1933 (c 0)
1934 (echo-keystrokes 0)
1935 (cursor-in-echo-area t)
1936 (message-log-max nil)
1937 (stop-keys (list 'return ?\r ?\n ?\e))
1938 (rubout-keys (list 'backspace ?\b ?\177)))
1939 (add-text-properties 0 (length prompt)
1940 minibuffer-prompt-properties prompt)
1941 (while (progn (message "%s%s"
1942 prompt
1943 (make-string (length pass) ?.))
1944 (setq c (read-key))
1945 (not (memq c stop-keys)))
1946 (clear-this-command-keys)
1947 (cond ((memq c rubout-keys) ; rubout
1948 (when (> (length pass) 0)
1949 (let ((new-pass (substring pass 0 -1)))
1950 (and (arrayp pass) (clear-string pass))
1951 (setq pass new-pass))))
1952 ((eq c ?\C-g) (keyboard-quit))
1953 ((not (numberp c)))
1954 ((= c ?\C-u) ; kill line
1955 (and (arrayp pass) (clear-string pass))
1956 (setq pass ""))
1957 ((= c ?\C-y) ; yank
1958 (let* ((str (condition-case nil
1959 (current-kill 0)
1960 (error nil)))
1961 new-pass)
1962 (when str
1963 (setq new-pass
1964 (concat pass
1965 (substring-no-properties str)))
1966 (and (arrayp pass) (clear-string pass))
1967 (setq c ?\0)
1968 (setq pass new-pass))))
1969 ((characterp c) ; insert char
1970 (let* ((new-char (char-to-string c))
1971 (new-pass (concat pass new-char)))
1972 (and (arrayp pass) (clear-string pass))
1973 (clear-string new-char)
1974 (setq c ?\0)
1975 (setq pass new-pass)))))
1976 (message nil)
1977 (or pass default "")))))
1979 ;; This should be used by `call-interactively' for `n' specs.
1980 (defun read-number (prompt &optional default)
1981 "Read a numeric value in the minibuffer, prompting with PROMPT.
1982 DEFAULT specifies a default value to return if the user just types RET.
1983 The value of DEFAULT is inserted into PROMPT."
1984 (let ((n nil))
1985 (when default
1986 (setq prompt
1987 (if (string-match "\\(\\):[ \t]*\\'" prompt)
1988 (replace-match (format " (default %s)" default) t t prompt 1)
1989 (replace-regexp-in-string "[ \t]*\\'"
1990 (format " (default %s) " default)
1991 prompt t t))))
1992 (while
1993 (progn
1994 (let ((str (read-from-minibuffer prompt nil nil nil nil
1995 (and default
1996 (number-to-string default)))))
1997 (condition-case nil
1998 (setq n (cond
1999 ((zerop (length str)) default)
2000 ((stringp str) (read str))))
2001 (error nil)))
2002 (unless (numberp n)
2003 (message "Please enter a number.")
2004 (sit-for 1)
2005 t)))
2008 (defun sit-for (seconds &optional nodisp obsolete)
2009 "Perform redisplay, then wait for SECONDS seconds or until input is available.
2010 SECONDS may be a floating-point value.
2011 \(On operating systems that do not support waiting for fractions of a
2012 second, floating-point values are rounded down to the nearest integer.)
2014 If optional arg NODISP is t, don't redisplay, just wait for input.
2015 Redisplay does not happen if input is available before it starts.
2017 Value is t if waited the full time with no input arriving, and nil otherwise.
2019 An obsolete, but still supported form is
2020 \(sit-for SECONDS &optional MILLISECONDS NODISP)
2021 where the optional arg MILLISECONDS specifies an additional wait period,
2022 in milliseconds; this was useful when Emacs was built without
2023 floating point support.
2025 \(fn SECONDS &optional NODISP)"
2026 (if (numberp nodisp)
2027 (setq seconds (+ seconds (* 1e-3 nodisp))
2028 nodisp obsolete)
2029 (if obsolete (setq nodisp obsolete)))
2030 (cond
2031 (noninteractive
2032 (sleep-for seconds)
2034 ((input-pending-p)
2035 nil)
2036 ((<= seconds 0)
2037 (or nodisp (redisplay)))
2039 (or nodisp (redisplay))
2040 (let ((read (read-event nil nil seconds)))
2041 (or (null read)
2042 (progn
2043 ;; If last command was a prefix arg, e.g. C-u, push this event onto
2044 ;; unread-command-events as (t . EVENT) so it will be added to
2045 ;; this-command-keys by read-key-sequence.
2046 (if (eq overriding-terminal-local-map universal-argument-map)
2047 (setq read (cons t read)))
2048 (push read unread-command-events)
2049 nil))))))
2051 ;;; Atomic change groups.
2053 (defmacro atomic-change-group (&rest body)
2054 "Perform BODY as an atomic change group.
2055 This means that if BODY exits abnormally,
2056 all of its changes to the current buffer are undone.
2057 This works regardless of whether undo is enabled in the buffer.
2059 This mechanism is transparent to ordinary use of undo;
2060 if undo is enabled in the buffer and BODY succeeds, the
2061 user can undo the change normally."
2062 (declare (indent 0) (debug t))
2063 (let ((handle (make-symbol "--change-group-handle--"))
2064 (success (make-symbol "--change-group-success--")))
2065 `(let ((,handle (prepare-change-group))
2066 ;; Don't truncate any undo data in the middle of this.
2067 (undo-outer-limit nil)
2068 (undo-limit most-positive-fixnum)
2069 (undo-strong-limit most-positive-fixnum)
2070 (,success nil))
2071 (unwind-protect
2072 (progn
2073 ;; This is inside the unwind-protect because
2074 ;; it enables undo if that was disabled; we need
2075 ;; to make sure that it gets disabled again.
2076 (activate-change-group ,handle)
2077 ,@body
2078 (setq ,success t))
2079 ;; Either of these functions will disable undo
2080 ;; if it was disabled before.
2081 (if ,success
2082 (accept-change-group ,handle)
2083 (cancel-change-group ,handle))))))
2085 (defun prepare-change-group (&optional buffer)
2086 "Return a handle for the current buffer's state, for a change group.
2087 If you specify BUFFER, make a handle for BUFFER's state instead.
2089 Pass the handle to `activate-change-group' afterward to initiate
2090 the actual changes of the change group.
2092 To finish the change group, call either `accept-change-group' or
2093 `cancel-change-group' passing the same handle as argument. Call
2094 `accept-change-group' to accept the changes in the group as final;
2095 call `cancel-change-group' to undo them all. You should use
2096 `unwind-protect' to make sure the group is always finished. The call
2097 to `activate-change-group' should be inside the `unwind-protect'.
2098 Once you finish the group, don't use the handle again--don't try to
2099 finish the same group twice. For a simple example of correct use, see
2100 the source code of `atomic-change-group'.
2102 The handle records only the specified buffer. To make a multibuffer
2103 change group, call this function once for each buffer you want to
2104 cover, then use `nconc' to combine the returned values, like this:
2106 (nconc (prepare-change-group buffer-1)
2107 (prepare-change-group buffer-2))
2109 You can then activate that multibuffer change group with a single
2110 call to `activate-change-group' and finish it with a single call
2111 to `accept-change-group' or `cancel-change-group'."
2113 (if buffer
2114 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
2115 (list (cons (current-buffer) buffer-undo-list))))
2117 (defun activate-change-group (handle)
2118 "Activate a change group made with `prepare-change-group' (which see)."
2119 (dolist (elt handle)
2120 (with-current-buffer (car elt)
2121 (if (eq buffer-undo-list t)
2122 (setq buffer-undo-list nil)))))
2124 (defun accept-change-group (handle)
2125 "Finish a change group made with `prepare-change-group' (which see).
2126 This finishes the change group by accepting its changes as final."
2127 (dolist (elt handle)
2128 (with-current-buffer (car elt)
2129 (if (eq elt t)
2130 (setq buffer-undo-list t)))))
2132 (defun cancel-change-group (handle)
2133 "Finish a change group made with `prepare-change-group' (which see).
2134 This finishes the change group by reverting all of its changes."
2135 (dolist (elt handle)
2136 (with-current-buffer (car elt)
2137 (setq elt (cdr elt))
2138 (save-restriction
2139 ;; Widen buffer temporarily so if the buffer was narrowed within
2140 ;; the body of `atomic-change-group' all changes can be undone.
2141 (widen)
2142 (let ((old-car
2143 (if (consp elt) (car elt)))
2144 (old-cdr
2145 (if (consp elt) (cdr elt))))
2146 ;; Temporarily truncate the undo log at ELT.
2147 (when (consp elt)
2148 (setcar elt nil) (setcdr elt nil))
2149 (unless (eq last-command 'undo) (undo-start))
2150 ;; Make sure there's no confusion.
2151 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
2152 (error "Undoing to some unrelated state"))
2153 ;; Undo it all.
2154 (save-excursion
2155 (while (listp pending-undo-list) (undo-more 1)))
2156 ;; Reset the modified cons cell ELT to its original content.
2157 (when (consp elt)
2158 (setcar elt old-car)
2159 (setcdr elt old-cdr))
2160 ;; Revert the undo info to what it was when we grabbed the state.
2161 (setq buffer-undo-list elt))))))
2163 ;;;; Display-related functions.
2165 ;; For compatibility.
2166 (defalias 'redraw-modeline 'force-mode-line-update)
2168 (defun force-mode-line-update (&optional all)
2169 "Force redisplay of the current buffer's mode line and header line.
2170 With optional non-nil ALL, force redisplay of all mode lines and
2171 header lines. This function also forces recomputation of the
2172 menu bar menus and the frame title."
2173 (if all (with-current-buffer (other-buffer)))
2174 (set-buffer-modified-p (buffer-modified-p)))
2176 (defun momentary-string-display (string pos &optional exit-char message)
2177 "Momentarily display STRING in the buffer at POS.
2178 Display remains until next event is input.
2179 If POS is a marker, only its position is used; its buffer is ignored.
2180 Optional third arg EXIT-CHAR can be a character, event or event
2181 description list. EXIT-CHAR defaults to SPC. If the input is
2182 EXIT-CHAR it is swallowed; otherwise it is then available as
2183 input (as a command if nothing else).
2184 Display MESSAGE (optional fourth arg) in the echo area.
2185 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
2186 (or exit-char (setq exit-char ?\s))
2187 (let ((ol (make-overlay pos pos))
2188 (message (copy-sequence string)))
2189 (unwind-protect
2190 (progn
2191 (save-excursion
2192 (overlay-put ol 'after-string message)
2193 (goto-char pos)
2194 ;; To avoid trouble with out-of-bounds position
2195 (setq pos (point))
2196 ;; If the message end is off screen, recenter now.
2197 (if (<= (window-end nil t) pos)
2198 (recenter (/ (window-height) 2))))
2199 (message (or message "Type %s to continue editing.")
2200 (single-key-description exit-char))
2201 (let (char)
2202 (if (integerp exit-char)
2203 (condition-case nil
2204 (progn
2205 (setq char (read-char))
2206 (or (eq char exit-char)
2207 (setq unread-command-events (list char))))
2208 (error
2209 ;; `exit-char' is a character, hence it differs
2210 ;; from char, which is an event.
2211 (setq unread-command-events (list char))))
2212 ;; `exit-char' can be an event, or an event description list.
2213 (setq char (read-event))
2214 (or (eq char exit-char)
2215 (eq char (event-convert-list exit-char))
2216 (setq unread-command-events (list char))))))
2217 (delete-overlay ol))))
2220 ;;;; Overlay operations
2222 (defun copy-overlay (o)
2223 "Return a copy of overlay O."
2224 (let ((o1 (make-overlay (overlay-start o) (overlay-end o)
2225 ;; FIXME: there's no easy way to find the
2226 ;; insertion-type of the two markers.
2227 (overlay-buffer o)))
2228 (props (overlay-properties o)))
2229 (while props
2230 (overlay-put o1 (pop props) (pop props)))
2231 o1))
2233 (defun remove-overlays (&optional beg end name val)
2234 "Clear BEG and END of overlays whose property NAME has value VAL.
2235 Overlays might be moved and/or split.
2236 BEG and END default respectively to the beginning and end of buffer."
2237 ;; This speeds up the loops over overlays.
2238 (unless beg (setq beg (point-min)))
2239 (unless end (setq end (point-max)))
2240 (overlay-recenter end)
2241 (if (< end beg)
2242 (setq beg (prog1 end (setq end beg))))
2243 (save-excursion
2244 (dolist (o (overlays-in beg end))
2245 (when (eq (overlay-get o name) val)
2246 ;; Either push this overlay outside beg...end
2247 ;; or split it to exclude beg...end
2248 ;; or delete it entirely (if it is contained in beg...end).
2249 (if (< (overlay-start o) beg)
2250 (if (> (overlay-end o) end)
2251 (progn
2252 (move-overlay (copy-overlay o)
2253 (overlay-start o) beg)
2254 (move-overlay o end (overlay-end o)))
2255 (move-overlay o (overlay-start o) beg))
2256 (if (> (overlay-end o) end)
2257 (move-overlay o end (overlay-end o))
2258 (delete-overlay o)))))))
2260 ;;;; Miscellanea.
2262 (defvar suspend-hook nil
2263 "Normal hook run by `suspend-emacs', before suspending.")
2265 (defvar suspend-resume-hook nil
2266 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2268 (defvar temp-buffer-show-hook nil
2269 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2270 When the hook runs, the temporary buffer is current, and the window it
2271 was displayed in is selected.")
2273 (defvar temp-buffer-setup-hook nil
2274 "Normal hook run by `with-output-to-temp-buffer' at the start.
2275 When the hook runs, the temporary buffer is current.
2276 This hook is normally set up with a function to put the buffer in Help
2277 mode.")
2279 ;; Avoid compiler warnings about this variable,
2280 ;; which has a special meaning on certain system types.
2281 (defvar buffer-file-type nil
2282 "Non-nil if the visited file is a binary file.
2283 This variable is meaningful on MS-DOG and Windows NT.
2284 On those systems, it is automatically local in every buffer.
2285 On other systems, this variable is normally always nil.")
2287 ;; The `assert' macro from the cl package signals
2288 ;; `cl-assertion-failed' at runtime so always define it.
2289 (put 'cl-assertion-failed 'error-conditions '(error))
2290 (put 'cl-assertion-failed 'error-message "Assertion failed")
2292 (defconst user-emacs-directory
2293 (if (eq system-type 'ms-dos)
2294 ;; MS-DOS cannot have initial dot.
2295 "~/_emacs.d/"
2296 "~/.emacs.d/")
2297 "Directory beneath which additional per-user Emacs-specific files are placed.
2298 Various programs in Emacs store information in this directory.
2299 Note that this should end with a directory separator.
2300 See also `locate-user-emacs-file'.")
2302 (defun locate-user-emacs-file (new-name &optional old-name)
2303 "Return an absolute per-user Emacs-specific file name.
2304 If OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
2305 Else return NEW-NAME in `user-emacs-directory', creating the
2306 directory if it does not exist."
2307 (convert-standard-filename
2308 (let* ((home (concat "~" (or init-file-user "")))
2309 (at-home (and old-name (expand-file-name old-name home))))
2310 (if (and at-home (file-readable-p at-home))
2311 at-home
2312 ;; Make sure `user-emacs-directory' exists,
2313 ;; unless we're in batch mode or dumping Emacs
2314 (or noninteractive
2315 purify-flag
2316 (file-accessible-directory-p (directory-file-name user-emacs-directory))
2317 (make-directory user-emacs-directory))
2318 (abbreviate-file-name
2319 (expand-file-name new-name user-emacs-directory))))))
2322 ;;;; Misc. useful functions.
2324 (defun find-tag-default ()
2325 "Determine default tag to search for, based on text at point.
2326 If there is no plausible default, return nil."
2327 (let (from to bound)
2328 (when (or (progn
2329 ;; Look at text around `point'.
2330 (save-excursion
2331 (skip-syntax-backward "w_") (setq from (point)))
2332 (save-excursion
2333 (skip-syntax-forward "w_") (setq to (point)))
2334 (> to from))
2335 ;; Look between `line-beginning-position' and `point'.
2336 (save-excursion
2337 (and (setq bound (line-beginning-position))
2338 (skip-syntax-backward "^w_" bound)
2339 (> (setq to (point)) bound)
2340 (skip-syntax-backward "w_")
2341 (setq from (point))))
2342 ;; Look between `point' and `line-end-position'.
2343 (save-excursion
2344 (and (setq bound (line-end-position))
2345 (skip-syntax-forward "^w_" bound)
2346 (< (setq from (point)) bound)
2347 (skip-syntax-forward "w_")
2348 (setq to (point)))))
2349 (buffer-substring-no-properties from to))))
2351 (defun play-sound (sound)
2352 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2353 The following keywords are recognized:
2355 :file FILE - read sound data from FILE. If FILE isn't an
2356 absolute file name, it is searched in `data-directory'.
2358 :data DATA - read sound data from string DATA.
2360 Exactly one of :file or :data must be present.
2362 :volume VOL - set volume to VOL. VOL must an integer in the
2363 range 0..100 or a float in the range 0..1.0. If not specified,
2364 don't change the volume setting of the sound device.
2366 :device DEVICE - play sound on DEVICE. If not specified,
2367 a system-dependent default device name is used.
2369 Note: :data and :device are currently not supported on Windows."
2370 (if (fboundp 'play-sound-internal)
2371 (play-sound-internal sound)
2372 (error "This Emacs binary lacks sound support")))
2374 (declare-function w32-shell-dos-semantics "w32-fns" nil)
2376 (defun shell-quote-argument (argument)
2377 "Quote ARGUMENT for passing as argument to an inferior shell."
2378 (if (or (eq system-type 'ms-dos)
2379 (and (eq system-type 'windows-nt) (w32-shell-dos-semantics)))
2380 ;; Quote using double quotes, but escape any existing quotes in
2381 ;; the argument with backslashes.
2382 (let ((result "")
2383 (start 0)
2384 end)
2385 (if (or (null (string-match "[^\"]" argument))
2386 (< (match-end 0) (length argument)))
2387 (while (string-match "[\"]" argument start)
2388 (setq end (match-beginning 0)
2389 result (concat result (substring argument start end)
2390 "\\" (substring argument end (1+ end)))
2391 start (1+ end))))
2392 (concat "\"" result (substring argument start) "\""))
2393 (if (equal argument "")
2394 "''"
2395 ;; Quote everything except POSIX filename characters.
2396 ;; This should be safe enough even for really weird shells.
2397 (let ((result "") (start 0) end)
2398 (while (string-match "[^-0-9a-zA-Z_./]" argument start)
2399 (setq end (match-beginning 0)
2400 result (concat result (substring argument start end)
2401 "\\" (substring argument end (1+ end)))
2402 start (1+ end)))
2403 (concat result (substring argument start))))))
2405 (defun string-or-null-p (object)
2406 "Return t if OBJECT is a string or nil.
2407 Otherwise, return nil."
2408 (or (stringp object) (null object)))
2410 (defun booleanp (object)
2411 "Return non-nil if OBJECT is one of the two canonical boolean values: t or nil."
2412 (memq object '(nil t)))
2414 (defun field-at-pos (pos)
2415 "Return the field at position POS, taking stickiness etc into account."
2416 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2417 (if (eq raw-field 'boundary)
2418 (get-char-property (1- (field-end pos)) 'field)
2419 raw-field)))
2422 ;;;; Support for yanking and text properties.
2424 (defvar yank-excluded-properties)
2426 (defun remove-yank-excluded-properties (start end)
2427 "Remove `yank-excluded-properties' between START and END positions.
2428 Replaces `category' properties with their defined properties."
2429 (let ((inhibit-read-only t))
2430 ;; Replace any `category' property with the properties it stands for.
2431 (unless (memq yank-excluded-properties '(t nil))
2432 (save-excursion
2433 (goto-char start)
2434 (while (< (point) end)
2435 (let ((cat (get-text-property (point) 'category))
2436 run-end)
2437 (setq run-end
2438 (next-single-property-change (point) 'category nil end))
2439 (when cat
2440 (let (run-end2 original)
2441 (remove-list-of-text-properties (point) run-end '(category))
2442 (while (< (point) run-end)
2443 (setq run-end2 (next-property-change (point) nil run-end))
2444 (setq original (text-properties-at (point)))
2445 (set-text-properties (point) run-end2 (symbol-plist cat))
2446 (add-text-properties (point) run-end2 original)
2447 (goto-char run-end2))))
2448 (goto-char run-end)))))
2449 (if (eq yank-excluded-properties t)
2450 (set-text-properties start end nil)
2451 (remove-list-of-text-properties start end yank-excluded-properties))))
2453 (defvar yank-undo-function)
2455 (defun insert-for-yank (string)
2456 "Calls `insert-for-yank-1' repetitively for each `yank-handler' segment.
2458 See `insert-for-yank-1' for more details."
2459 (let (to)
2460 (while (setq to (next-single-property-change 0 'yank-handler string))
2461 (insert-for-yank-1 (substring string 0 to))
2462 (setq string (substring string to))))
2463 (insert-for-yank-1 string))
2465 (defun insert-for-yank-1 (string)
2466 "Insert STRING at point, stripping some text properties.
2468 Strip text properties from the inserted text according to
2469 `yank-excluded-properties'. Otherwise just like (insert STRING).
2471 If STRING has a non-nil `yank-handler' property on the first character,
2472 the normal insert behavior is modified in various ways. The value of
2473 the yank-handler property must be a list with one to four elements
2474 with the following format: (FUNCTION PARAM NOEXCLUDE UNDO).
2475 When FUNCTION is present and non-nil, it is called instead of `insert'
2476 to insert the string. FUNCTION takes one argument--the object to insert.
2477 If PARAM is present and non-nil, it replaces STRING as the object
2478 passed to FUNCTION (or `insert'); for example, if FUNCTION is
2479 `yank-rectangle', PARAM may be a list of strings to insert as a
2480 rectangle.
2481 If NOEXCLUDE is present and non-nil, the normal removal of the
2482 yank-excluded-properties is not performed; instead FUNCTION is
2483 responsible for removing those properties. This may be necessary
2484 if FUNCTION adjusts point before or after inserting the object.
2485 If UNDO is present and non-nil, it is a function that will be called
2486 by `yank-pop' to undo the insertion of the current object. It is
2487 called with two arguments, the start and end of the current region.
2488 FUNCTION may set `yank-undo-function' to override the UNDO value."
2489 (let* ((handler (and (stringp string)
2490 (get-text-property 0 'yank-handler string)))
2491 (param (or (nth 1 handler) string))
2492 (opoint (point))
2493 (inhibit-read-only inhibit-read-only)
2494 end)
2496 (setq yank-undo-function t)
2497 (if (nth 0 handler) ;; FUNCTION
2498 (funcall (car handler) param)
2499 (insert param))
2500 (setq end (point))
2502 ;; Prevent read-only properties from interfering with the
2503 ;; following text property changes.
2504 (setq inhibit-read-only t)
2506 ;; What should we do with `font-lock-face' properties?
2507 (if font-lock-defaults
2508 ;; No, just wipe them.
2509 (remove-list-of-text-properties opoint end '(font-lock-face))
2510 ;; Convert them to `face'.
2511 (save-excursion
2512 (goto-char opoint)
2513 (while (< (point) end)
2514 (let ((face (get-text-property (point) 'font-lock-face))
2515 run-end)
2516 (setq run-end
2517 (next-single-property-change (point) 'font-lock-face nil end))
2518 (when face
2519 (remove-text-properties (point) run-end '(font-lock-face nil))
2520 (put-text-property (point) run-end 'face face))
2521 (goto-char run-end)))))
2523 (unless (nth 2 handler) ;; NOEXCLUDE
2524 (remove-yank-excluded-properties opoint (point)))
2526 ;; If last inserted char has properties, mark them as rear-nonsticky.
2527 (if (and (> end opoint)
2528 (text-properties-at (1- end)))
2529 (put-text-property (1- end) end 'rear-nonsticky t))
2531 (if (eq yank-undo-function t) ;; not set by FUNCTION
2532 (setq yank-undo-function (nth 3 handler))) ;; UNDO
2533 (if (nth 4 handler) ;; COMMAND
2534 (setq this-command (nth 4 handler)))))
2536 (defun insert-buffer-substring-no-properties (buffer &optional start end)
2537 "Insert before point a substring of BUFFER, without text properties.
2538 BUFFER may be a buffer or a buffer name.
2539 Arguments START and END are character positions specifying the substring.
2540 They default to the values of (point-min) and (point-max) in BUFFER."
2541 (let ((opoint (point)))
2542 (insert-buffer-substring buffer start end)
2543 (let ((inhibit-read-only t))
2544 (set-text-properties opoint (point) nil))))
2546 (defun insert-buffer-substring-as-yank (buffer &optional start end)
2547 "Insert before point a part of BUFFER, stripping some text properties.
2548 BUFFER may be a buffer or a buffer name.
2549 Arguments START and END are character positions specifying the substring.
2550 They default to the values of (point-min) and (point-max) in BUFFER.
2551 Strip text properties from the inserted text according to
2552 `yank-excluded-properties'."
2553 ;; Since the buffer text should not normally have yank-handler properties,
2554 ;; there is no need to handle them here.
2555 (let ((opoint (point)))
2556 (insert-buffer-substring buffer start end)
2557 (remove-yank-excluded-properties opoint (point))))
2560 ;;;; Synchronous shell commands.
2562 (defun start-process-shell-command (name buffer &rest args)
2563 "Start a program in a subprocess. Return the process object for it.
2564 NAME is name for process. It is modified if necessary to make it unique.
2565 BUFFER is the buffer (or buffer name) to associate with the process.
2566 Process output goes at end of that buffer, unless you specify
2567 an output stream or filter function to handle the output.
2568 BUFFER may be also nil, meaning that this process is not associated
2569 with any buffer
2570 COMMAND is the shell command to run.
2572 An old calling convention accepted any number of arguments after COMMAND,
2573 which were just concatenated to COMMAND. This is still supported but strongly
2574 discouraged.
2576 \(fn NAME BUFFER COMMAND)"
2577 ;; We used to use `exec' to replace the shell with the command,
2578 ;; but that failed to handle (...) and semicolon, etc.
2579 (start-process name buffer shell-file-name shell-command-switch
2580 (mapconcat 'identity args " ")))
2582 (defun start-file-process-shell-command (name buffer &rest args)
2583 "Start a program in a subprocess. Return the process object for it.
2584 Similar to `start-process-shell-command', but calls `start-file-process'.
2586 \(fn NAME BUFFER COMMAND)"
2587 (start-file-process
2588 name buffer
2589 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2590 (if (file-remote-p default-directory) "-c" shell-command-switch)
2591 (mapconcat 'identity args " ")))
2593 (defun call-process-shell-command (command &optional infile buffer display
2594 &rest args)
2595 "Execute the shell command COMMAND synchronously in separate process.
2596 The remaining arguments are optional.
2597 The program's input comes from file INFILE (nil means `/dev/null').
2598 Insert output in BUFFER before point; t means current buffer;
2599 nil for BUFFER means discard it; 0 means discard and don't wait.
2600 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
2601 REAL-BUFFER says what to do with standard output, as above,
2602 while STDERR-FILE says what to do with standard error in the child.
2603 STDERR-FILE may be nil (discard standard error output),
2604 t (mix it with ordinary output), or a file name string.
2606 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
2607 Remaining arguments are strings passed as additional arguments for COMMAND.
2608 Wildcards and redirection are handled as usual in the shell.
2610 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
2611 Otherwise it waits for COMMAND to terminate and returns a numeric exit
2612 status or a signal description string.
2613 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
2614 ;; We used to use `exec' to replace the shell with the command,
2615 ;; but that failed to handle (...) and semicolon, etc.
2616 (call-process shell-file-name
2617 infile buffer display
2618 shell-command-switch
2619 (mapconcat 'identity (cons command args) " ")))
2621 (defun process-file-shell-command (command &optional infile buffer display
2622 &rest args)
2623 "Process files synchronously in a separate process.
2624 Similar to `call-process-shell-command', but calls `process-file'."
2625 (process-file
2626 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2627 infile buffer display
2628 (if (file-remote-p default-directory) "-c" shell-command-switch)
2629 (mapconcat 'identity (cons command args) " ")))
2631 ;;;; Lisp macros to do various things temporarily.
2633 (defmacro with-current-buffer (buffer-or-name &rest body)
2634 "Execute the forms in BODY with BUFFER-OR-NAME temporarily current.
2635 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
2636 The value returned is the value of the last form in BODY. See
2637 also `with-temp-buffer'."
2638 (declare (indent 1) (debug t))
2639 `(save-current-buffer
2640 (set-buffer ,buffer-or-name)
2641 ,@body))
2643 (defmacro with-selected-window (window &rest body)
2644 "Execute the forms in BODY with WINDOW as the selected window.
2645 The value returned is the value of the last form in BODY.
2647 This macro saves and restores the selected window, as well as the
2648 selected window of each frame. It does not change the order of
2649 recently selected windows. If the previously selected window of
2650 some frame is no longer live at the end of BODY, that frame's
2651 selected window is left alone. If the selected window is no
2652 longer live, then whatever window is selected at the end of BODY
2653 remains selected.
2655 This macro uses `save-current-buffer' to save and restore the
2656 current buffer, since otherwise its normal operation could
2657 potentially make a different buffer current. It does not alter
2658 the buffer list ordering."
2659 (declare (indent 1) (debug t))
2660 ;; Most of this code is a copy of save-selected-window.
2661 `(let ((save-selected-window-window (selected-window))
2662 ;; It is necessary to save all of these, because calling
2663 ;; select-window changes frame-selected-window for whatever
2664 ;; frame that window is in.
2665 (save-selected-window-alist
2666 (mapcar (lambda (frame) (list frame (frame-selected-window frame)))
2667 (frame-list))))
2668 (save-current-buffer
2669 (unwind-protect
2670 (progn (select-window ,window 'norecord)
2671 ,@body)
2672 (dolist (elt save-selected-window-alist)
2673 (and (frame-live-p (car elt))
2674 (window-live-p (cadr elt))
2675 (set-frame-selected-window (car elt) (cadr elt) 'norecord)))
2676 (when (window-live-p save-selected-window-window)
2677 (select-window save-selected-window-window 'norecord))))))
2679 (defmacro with-selected-frame (frame &rest body)
2680 "Execute the forms in BODY with FRAME as the selected frame.
2681 The value returned is the value of the last form in BODY.
2683 This macro neither changes the order of recently selected windows
2684 nor the buffer list."
2685 (declare (indent 1) (debug t))
2686 (let ((old-frame (make-symbol "old-frame"))
2687 (old-buffer (make-symbol "old-buffer")))
2688 `(let ((,old-frame (selected-frame))
2689 (,old-buffer (current-buffer)))
2690 (unwind-protect
2691 (progn (select-frame ,frame 'norecord)
2692 ,@body)
2693 (when (frame-live-p ,old-frame)
2694 (select-frame ,old-frame 'norecord))
2695 (when (buffer-live-p ,old-buffer)
2696 (set-buffer ,old-buffer))))))
2698 (defmacro with-temp-file (file &rest body)
2699 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
2700 The value returned is the value of the last form in BODY.
2701 See also `with-temp-buffer'."
2702 (declare (debug t))
2703 (let ((temp-file (make-symbol "temp-file"))
2704 (temp-buffer (make-symbol "temp-buffer")))
2705 `(let ((,temp-file ,file)
2706 (,temp-buffer
2707 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
2708 (unwind-protect
2709 (prog1
2710 (with-current-buffer ,temp-buffer
2711 ,@body)
2712 (with-current-buffer ,temp-buffer
2713 (write-region nil nil ,temp-file nil 0)))
2714 (and (buffer-name ,temp-buffer)
2715 (kill-buffer ,temp-buffer))))))
2717 (defmacro with-temp-message (message &rest body)
2718 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
2719 The original message is restored to the echo area after BODY has finished.
2720 The value returned is the value of the last form in BODY.
2721 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
2722 If MESSAGE is nil, the echo area and message log buffer are unchanged.
2723 Use a MESSAGE of \"\" to temporarily clear the echo area."
2724 (declare (debug t))
2725 (let ((current-message (make-symbol "current-message"))
2726 (temp-message (make-symbol "with-temp-message")))
2727 `(let ((,temp-message ,message)
2728 (,current-message))
2729 (unwind-protect
2730 (progn
2731 (when ,temp-message
2732 (setq ,current-message (current-message))
2733 (message "%s" ,temp-message))
2734 ,@body)
2735 (and ,temp-message
2736 (if ,current-message
2737 (message "%s" ,current-message)
2738 (message nil)))))))
2740 (defmacro with-temp-buffer (&rest body)
2741 "Create a temporary buffer, and evaluate BODY there like `progn'.
2742 See also `with-temp-file' and `with-output-to-string'."
2743 (declare (indent 0) (debug t))
2744 (let ((temp-buffer (make-symbol "temp-buffer")))
2745 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
2746 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
2747 (with-current-buffer ,temp-buffer
2748 (unwind-protect
2749 (progn ,@body)
2750 (and (buffer-name ,temp-buffer)
2751 (kill-buffer ,temp-buffer)))))))
2753 (defmacro with-silent-modifications (&rest body)
2754 "Execute BODY, pretending it does not modifies the buffer.
2755 If BODY performs real modifications to the buffer's text, other
2756 than cosmetic ones, undo data may become corrupted.
2757 Typically used around modifications of text-properties which do not really
2758 affect the buffer's content."
2759 (declare (debug t) (indent 0))
2760 (let ((modified (make-symbol "modified")))
2761 `(let* ((,modified (buffer-modified-p))
2762 (buffer-undo-list t)
2763 (inhibit-read-only t)
2764 (inhibit-modification-hooks t)
2765 deactivate-mark
2766 ;; Avoid setting and removing file locks and checking
2767 ;; buffer's uptodate-ness w.r.t the underlying file.
2768 buffer-file-name
2769 buffer-file-truename)
2770 (unwind-protect
2771 (progn
2772 ,@body)
2773 (unless ,modified
2774 (restore-buffer-modified-p nil))))))
2776 (defmacro with-output-to-string (&rest body)
2777 "Execute BODY, return the text it sent to `standard-output', as a string."
2778 (declare (indent 0) (debug t))
2779 `(let ((standard-output
2780 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
2781 (unwind-protect
2782 (progn
2783 (let ((standard-output standard-output))
2784 ,@body)
2785 (with-current-buffer standard-output
2786 (buffer-string)))
2787 (kill-buffer standard-output))))
2789 (defmacro with-local-quit (&rest body)
2790 "Execute BODY, allowing quits to terminate BODY but not escape further.
2791 When a quit terminates BODY, `with-local-quit' returns nil but
2792 requests another quit. That quit will be processed as soon as quitting
2793 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
2794 (declare (debug t) (indent 0))
2795 `(condition-case nil
2796 (let ((inhibit-quit nil))
2797 ,@body)
2798 (quit (setq quit-flag t)
2799 ;; This call is to give a chance to handle quit-flag
2800 ;; in case inhibit-quit is nil.
2801 ;; Without this, it will not be handled until the next function
2802 ;; call, and that might allow it to exit thru a condition-case
2803 ;; that intends to handle the quit signal next time.
2804 (eval '(ignore nil)))))
2806 (defmacro while-no-input (&rest body)
2807 "Execute BODY only as long as there's no pending input.
2808 If input arrives, that ends the execution of BODY,
2809 and `while-no-input' returns t. Quitting makes it return nil.
2810 If BODY finishes, `while-no-input' returns whatever value BODY produced."
2811 (declare (debug t) (indent 0))
2812 (let ((catch-sym (make-symbol "input")))
2813 `(with-local-quit
2814 (catch ',catch-sym
2815 (let ((throw-on-input ',catch-sym))
2816 (or (input-pending-p)
2817 (progn ,@body)))))))
2819 (defmacro condition-case-no-debug (var bodyform &rest handlers)
2820 "Like `condition-case' except that it does not catch anything when debugging.
2821 More specifically if `debug-on-error' is set, then it does not catch any signal."
2822 (declare (debug condition-case) (indent 2))
2823 (let ((bodysym (make-symbol "body")))
2824 `(let ((,bodysym (lambda () ,bodyform)))
2825 (if debug-on-error
2826 (funcall ,bodysym)
2827 (condition-case ,var
2828 (funcall ,bodysym)
2829 ,@handlers)))))
2831 (defmacro with-demoted-errors (&rest body)
2832 "Run BODY and demote any errors to simple messages.
2833 If `debug-on-error' is non-nil, run BODY without catching its errors.
2834 This is to be used around code which is not expected to signal an error
2835 but which should be robust in the unexpected case that an error is signaled."
2836 (declare (debug t) (indent 0))
2837 (let ((err (make-symbol "err")))
2838 `(condition-case-no-debug ,err
2839 (progn ,@body)
2840 (error (message "Error: %s" ,err) nil))))
2842 (defmacro combine-after-change-calls (&rest body)
2843 "Execute BODY, but don't call the after-change functions till the end.
2844 If BODY makes changes in the buffer, they are recorded
2845 and the functions on `after-change-functions' are called several times
2846 when BODY is finished.
2847 The return value is the value of the last form in BODY.
2849 If `before-change-functions' is non-nil, then calls to the after-change
2850 functions can't be deferred, so in that case this macro has no effect.
2852 Do not alter `after-change-functions' or `before-change-functions'
2853 in BODY."
2854 (declare (indent 0) (debug t))
2855 `(unwind-protect
2856 (let ((combine-after-change-calls t))
2857 . ,body)
2858 (combine-after-change-execute)))
2860 (defmacro with-case-table (table &rest body)
2861 "Execute the forms in BODY with TABLE as the current case table.
2862 The value returned is the value of the last form in BODY."
2863 (declare (indent 1) (debug t))
2864 (let ((old-case-table (make-symbol "table"))
2865 (old-buffer (make-symbol "buffer")))
2866 `(let ((,old-case-table (current-case-table))
2867 (,old-buffer (current-buffer)))
2868 (unwind-protect
2869 (progn (set-case-table ,table)
2870 ,@body)
2871 (with-current-buffer ,old-buffer
2872 (set-case-table ,old-case-table))))))
2874 ;;; Matching and match data.
2876 (defvar save-match-data-internal)
2878 ;; We use save-match-data-internal as the local variable because
2879 ;; that works ok in practice (people should not use that variable elsewhere).
2880 ;; We used to use an uninterned symbol; the compiler handles that properly
2881 ;; now, but it generates slower code.
2882 (defmacro save-match-data (&rest body)
2883 "Execute the BODY forms, restoring the global value of the match data.
2884 The value returned is the value of the last form in BODY."
2885 ;; It is better not to use backquote here,
2886 ;; because that makes a bootstrapping problem
2887 ;; if you need to recompile all the Lisp files using interpreted code.
2888 (declare (indent 0) (debug t))
2889 (list 'let
2890 '((save-match-data-internal (match-data)))
2891 (list 'unwind-protect
2892 (cons 'progn body)
2893 ;; It is safe to free (evaporate) markers immediately here,
2894 ;; as Lisp programs should not copy from save-match-data-internal.
2895 '(set-match-data save-match-data-internal 'evaporate))))
2897 (defun match-string (num &optional string)
2898 "Return string of text matched by last search.
2899 NUM specifies which parenthesized expression in the last regexp.
2900 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2901 Zero means the entire text matched by the whole regexp or whole string.
2902 STRING should be given if the last search was by `string-match' on STRING."
2903 (if (match-beginning num)
2904 (if string
2905 (substring string (match-beginning num) (match-end num))
2906 (buffer-substring (match-beginning num) (match-end num)))))
2908 (defun match-string-no-properties (num &optional string)
2909 "Return string of text matched by last search, without text properties.
2910 NUM specifies which parenthesized expression in the last regexp.
2911 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
2912 Zero means the entire text matched by the whole regexp or whole string.
2913 STRING should be given if the last search was by `string-match' on STRING."
2914 (if (match-beginning num)
2915 (if string
2916 (substring-no-properties string (match-beginning num)
2917 (match-end num))
2918 (buffer-substring-no-properties (match-beginning num)
2919 (match-end num)))))
2922 (defun match-substitute-replacement (replacement
2923 &optional fixedcase literal string subexp)
2924 "Return REPLACEMENT as it will be inserted by `replace-match'.
2925 In other words, all back-references in the form `\\&' and `\\N'
2926 are substituted with actual strings matched by the last search.
2927 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
2928 meaning as for `replace-match'."
2929 (let ((match (match-string 0 string)))
2930 (save-match-data
2931 (set-match-data (mapcar (lambda (x)
2932 (if (numberp x)
2933 (- x (match-beginning 0))
2935 (match-data t)))
2936 (replace-match replacement fixedcase literal match subexp))))
2939 (defun looking-back (regexp &optional limit greedy)
2940 "Return non-nil if text before point matches regular expression REGEXP.
2941 Like `looking-at' except matches before point, and is slower.
2942 LIMIT if non-nil speeds up the search by specifying a minimum
2943 starting position, to avoid checking matches that would start
2944 before LIMIT.
2946 If GREEDY is non-nil, extend the match backwards as far as
2947 possible, stopping when a single additional previous character
2948 cannot be part of a match for REGEXP. When the match is
2949 extended, its starting position is allowed to occur before
2950 LIMIT."
2951 (let ((start (point))
2952 (pos
2953 (save-excursion
2954 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
2955 (point)))))
2956 (if (and greedy pos)
2957 (save-restriction
2958 (narrow-to-region (point-min) start)
2959 (while (and (> pos (point-min))
2960 (save-excursion
2961 (goto-char pos)
2962 (backward-char 1)
2963 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
2964 (setq pos (1- pos)))
2965 (save-excursion
2966 (goto-char pos)
2967 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
2968 (not (null pos))))
2970 (defsubst looking-at-p (regexp)
2972 Same as `looking-at' except this function does not change the match data."
2973 (let ((inhibit-changing-match-data t))
2974 (looking-at regexp)))
2976 (defsubst string-match-p (regexp string &optional start)
2978 Same as `string-match' except this function does not change the match data."
2979 (let ((inhibit-changing-match-data t))
2980 (string-match regexp string start)))
2982 (defun subregexp-context-p (regexp pos &optional start)
2983 "Return non-nil if POS is in a normal subregexp context in REGEXP.
2984 A subregexp context is one where a sub-regexp can appear.
2985 A non-subregexp context is for example within brackets, or within a
2986 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
2987 If START is non-nil, it should be a position in REGEXP, smaller
2988 than POS, and known to be in a subregexp context."
2989 ;; Here's one possible implementation, with the great benefit that it
2990 ;; reuses the regexp-matcher's own parser, so it understands all the
2991 ;; details of the syntax. A disadvantage is that it needs to match the
2992 ;; error string.
2993 (condition-case err
2994 (progn
2995 (string-match (substring regexp (or start 0) pos) "")
2997 (invalid-regexp
2998 (not (member (cadr err) '("Unmatched [ or [^"
2999 "Unmatched \\{"
3000 "Trailing backslash")))))
3001 ;; An alternative implementation:
3002 ;; (defconst re-context-re
3003 ;; (let* ((harmless-ch "[^\\[]")
3004 ;; (harmless-esc "\\\\[^{]")
3005 ;; (class-harmless-ch "[^][]")
3006 ;; (class-lb-harmless "[^]:]")
3007 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
3008 ;; (class-lb (concat "\\[\\(" class-lb-harmless
3009 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
3010 ;; (class
3011 ;; (concat "\\[^?]?"
3012 ;; "\\(" class-harmless-ch
3013 ;; "\\|" class-lb "\\)*"
3014 ;; "\\[?]")) ; special handling for bare [ at end of re
3015 ;; (braces "\\\\{[0-9,]+\\\\}"))
3016 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
3017 ;; "\\|" class "\\|" braces "\\)*\\'"))
3018 ;; "Matches any prefix that corresponds to a normal subregexp context.")
3019 ;; (string-match re-context-re (substring regexp (or start 0) pos))
3022 ;;;; split-string
3024 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
3025 "The default value of separators for `split-string'.
3027 A regexp matching strings of whitespace. May be locale-dependent
3028 \(as yet unimplemented). Should not match non-breaking spaces.
3030 Warning: binding this to a different value and using it as default is
3031 likely to have undesired semantics.")
3033 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
3034 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
3035 ;; expression leads to the equivalent implementation that if SEPARATORS
3036 ;; is defaulted, OMIT-NULLS is treated as t.
3037 (defun split-string (string &optional separators omit-nulls)
3038 "Split STRING into substrings bounded by matches for SEPARATORS.
3040 The beginning and end of STRING, and each match for SEPARATORS, are
3041 splitting points. The substrings matching SEPARATORS are removed, and
3042 the substrings between the splitting points are collected as a list,
3043 which is returned.
3045 If SEPARATORS is non-nil, it should be a regular expression matching text
3046 which separates, but is not part of, the substrings. If nil it defaults to
3047 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
3048 OMIT-NULLS is forced to t.
3050 If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so
3051 that for the default value of SEPARATORS leading and trailing whitespace
3052 are effectively trimmed). If nil, all zero-length substrings are retained,
3053 which correctly parses CSV format, for example.
3055 Note that the effect of `(split-string STRING)' is the same as
3056 `(split-string STRING split-string-default-separators t)'. In the rare
3057 case that you wish to retain zero-length substrings when splitting on
3058 whitespace, use `(split-string STRING split-string-default-separators)'.
3060 Modifies the match data; use `save-match-data' if necessary."
3061 (let ((keep-nulls (not (if separators omit-nulls t)))
3062 (rexp (or separators split-string-default-separators))
3063 (start 0)
3064 notfirst
3065 (list nil))
3066 (while (and (string-match rexp string
3067 (if (and notfirst
3068 (= start (match-beginning 0))
3069 (< start (length string)))
3070 (1+ start) start))
3071 (< start (length string)))
3072 (setq notfirst t)
3073 (if (or keep-nulls (< start (match-beginning 0)))
3074 (setq list
3075 (cons (substring string start (match-beginning 0))
3076 list)))
3077 (setq start (match-end 0)))
3078 (if (or keep-nulls (< start (length string)))
3079 (setq list
3080 (cons (substring string start)
3081 list)))
3082 (nreverse list)))
3084 (defun combine-and-quote-strings (strings &optional separator)
3085 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
3086 This tries to quote the strings to avoid ambiguity such that
3087 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3088 Only some SEPARATORs will work properly."
3089 (let* ((sep (or separator " "))
3090 (re (concat "[\\\"]" "\\|" (regexp-quote sep))))
3091 (mapconcat
3092 (lambda (str)
3093 (if (string-match re str)
3094 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
3095 str))
3096 strings sep)))
3098 (defun split-string-and-unquote (string &optional separator)
3099 "Split the STRING into a list of strings.
3100 It understands Emacs Lisp quoting within STRING, such that
3101 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
3102 The SEPARATOR regexp defaults to \"\\s-+\"."
3103 (let ((sep (or separator "\\s-+"))
3104 (i (string-match "\"" string)))
3105 (if (null i)
3106 (split-string string sep t) ; no quoting: easy
3107 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
3108 (let ((rfs (read-from-string string i)))
3109 (cons (car rfs)
3110 (split-string-and-unquote (substring string (cdr rfs))
3111 sep)))))))
3114 ;;;; Replacement in strings.
3116 (defun subst-char-in-string (fromchar tochar string &optional inplace)
3117 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
3118 Unless optional argument INPLACE is non-nil, return a new string."
3119 (let ((i (length string))
3120 (newstr (if inplace string (copy-sequence string))))
3121 (while (> i 0)
3122 (setq i (1- i))
3123 (if (eq (aref newstr i) fromchar)
3124 (aset newstr i tochar)))
3125 newstr))
3127 (defun replace-regexp-in-string (regexp rep string &optional
3128 fixedcase literal subexp start)
3129 "Replace all matches for REGEXP with REP in STRING.
3131 Return a new string containing the replacements.
3133 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
3134 arguments with the same names of function `replace-match'. If START
3135 is non-nil, start replacements at that index in STRING.
3137 REP is either a string used as the NEWTEXT arg of `replace-match' or a
3138 function. If it is a function, it is called with the actual text of each
3139 match, and its value is used as the replacement text. When REP is called,
3140 the match-data are the result of matching REGEXP against a substring
3141 of STRING.
3143 To replace only the first match (if any), make REGEXP match up to \\'
3144 and replace a sub-expression, e.g.
3145 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
3146 => \" bar foo\"
3149 ;; To avoid excessive consing from multiple matches in long strings,
3150 ;; don't just call `replace-match' continually. Walk down the
3151 ;; string looking for matches of REGEXP and building up a (reversed)
3152 ;; list MATCHES. This comprises segments of STRING which weren't
3153 ;; matched interspersed with replacements for segments that were.
3154 ;; [For a `large' number of replacements it's more efficient to
3155 ;; operate in a temporary buffer; we can't tell from the function's
3156 ;; args whether to choose the buffer-based implementation, though it
3157 ;; might be reasonable to do so for long enough STRING.]
3158 (let ((l (length string))
3159 (start (or start 0))
3160 matches str mb me)
3161 (save-match-data
3162 (while (and (< start l) (string-match regexp string start))
3163 (setq mb (match-beginning 0)
3164 me (match-end 0))
3165 ;; If we matched the empty string, make sure we advance by one char
3166 (when (= me mb) (setq me (min l (1+ mb))))
3167 ;; Generate a replacement for the matched substring.
3168 ;; Operate only on the substring to minimize string consing.
3169 ;; Set up match data for the substring for replacement;
3170 ;; presumably this is likely to be faster than munging the
3171 ;; match data directly in Lisp.
3172 (string-match regexp (setq str (substring string mb me)))
3173 (setq matches
3174 (cons (replace-match (if (stringp rep)
3176 (funcall rep (match-string 0 str)))
3177 fixedcase literal str subexp)
3178 (cons (substring string start mb) ; unmatched prefix
3179 matches)))
3180 (setq start me))
3181 ;; Reconstruct a string from the pieces.
3182 (setq matches (cons (substring string start l) matches)) ; leftover
3183 (apply #'concat (nreverse matches)))))
3185 ;;;; invisibility specs
3187 (defun add-to-invisibility-spec (element)
3188 "Add ELEMENT to `buffer-invisibility-spec'.
3189 See documentation for `buffer-invisibility-spec' for the kind of elements
3190 that can be added."
3191 (if (eq buffer-invisibility-spec t)
3192 (setq buffer-invisibility-spec (list t)))
3193 (setq buffer-invisibility-spec
3194 (cons element buffer-invisibility-spec)))
3196 (defun remove-from-invisibility-spec (element)
3197 "Remove ELEMENT from `buffer-invisibility-spec'."
3198 (if (consp buffer-invisibility-spec)
3199 (setq buffer-invisibility-spec
3200 (delete element buffer-invisibility-spec))))
3202 ;;;; Syntax tables.
3204 (defmacro with-syntax-table (table &rest body)
3205 "Evaluate BODY with syntax table of current buffer set to TABLE.
3206 The syntax table of the current buffer is saved, BODY is evaluated, and the
3207 saved table is restored, even in case of an abnormal exit.
3208 Value is what BODY returns."
3209 (declare (debug t))
3210 (let ((old-table (make-symbol "table"))
3211 (old-buffer (make-symbol "buffer")))
3212 `(let ((,old-table (syntax-table))
3213 (,old-buffer (current-buffer)))
3214 (unwind-protect
3215 (progn
3216 (set-syntax-table ,table)
3217 ,@body)
3218 (save-current-buffer
3219 (set-buffer ,old-buffer)
3220 (set-syntax-table ,old-table))))))
3222 (defun make-syntax-table (&optional oldtable)
3223 "Return a new syntax table.
3224 Create a syntax table which inherits from OLDTABLE (if non-nil) or
3225 from `standard-syntax-table' otherwise."
3226 (let ((table (make-char-table 'syntax-table nil)))
3227 (set-char-table-parent table (or oldtable (standard-syntax-table)))
3228 table))
3230 (defun syntax-after (pos)
3231 "Return the raw syntax of the char after POS.
3232 If POS is outside the buffer's accessible portion, return nil."
3233 (unless (or (< pos (point-min)) (>= pos (point-max)))
3234 (let ((st (if parse-sexp-lookup-properties
3235 (get-char-property pos 'syntax-table))))
3236 (if (consp st) st
3237 (aref (or st (syntax-table)) (char-after pos))))))
3239 (defun syntax-class (syntax)
3240 "Return the syntax class part of the syntax descriptor SYNTAX.
3241 If SYNTAX is nil, return nil."
3242 (and syntax (logand (car syntax) 65535)))
3244 ;;;; Text clones
3246 (defun text-clone-maintain (ol1 after beg end &optional len)
3247 "Propagate the changes made under the overlay OL1 to the other clones.
3248 This is used on the `modification-hooks' property of text clones."
3249 (when (and after (not undo-in-progress) (overlay-start ol1))
3250 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
3251 (setq beg (max beg (+ (overlay-start ol1) margin)))
3252 (setq end (min end (- (overlay-end ol1) margin)))
3253 (when (<= beg end)
3254 (save-excursion
3255 (when (overlay-get ol1 'text-clone-syntax)
3256 ;; Check content of the clone's text.
3257 (let ((cbeg (+ (overlay-start ol1) margin))
3258 (cend (- (overlay-end ol1) margin)))
3259 (goto-char cbeg)
3260 (save-match-data
3261 (if (not (re-search-forward
3262 (overlay-get ol1 'text-clone-syntax) cend t))
3263 ;; Mark the overlay for deletion.
3264 (overlay-put ol1 'text-clones nil)
3265 (when (< (match-end 0) cend)
3266 ;; Shrink the clone at its end.
3267 (setq end (min end (match-end 0)))
3268 (move-overlay ol1 (overlay-start ol1)
3269 (+ (match-end 0) margin)))
3270 (when (> (match-beginning 0) cbeg)
3271 ;; Shrink the clone at its beginning.
3272 (setq beg (max (match-beginning 0) beg))
3273 (move-overlay ol1 (- (match-beginning 0) margin)
3274 (overlay-end ol1)))))))
3275 ;; Now go ahead and update the clones.
3276 (let ((head (- beg (overlay-start ol1)))
3277 (tail (- (overlay-end ol1) end))
3278 (str (buffer-substring beg end))
3279 (nothing-left t)
3280 (inhibit-modification-hooks t))
3281 (dolist (ol2 (overlay-get ol1 'text-clones))
3282 (let ((oe (overlay-end ol2)))
3283 (unless (or (eq ol1 ol2) (null oe))
3284 (setq nothing-left nil)
3285 (let ((mod-beg (+ (overlay-start ol2) head)))
3286 ;;(overlay-put ol2 'modification-hooks nil)
3287 (goto-char (- (overlay-end ol2) tail))
3288 (unless (> mod-beg (point))
3289 (save-excursion (insert str))
3290 (delete-region mod-beg (point)))
3291 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
3292 ))))
3293 (if nothing-left (delete-overlay ol1))))))))
3295 (defun text-clone-create (start end &optional spreadp syntax)
3296 "Create a text clone of START...END at point.
3297 Text clones are chunks of text that are automatically kept identical:
3298 changes done to one of the clones will be immediately propagated to the other.
3300 The buffer's content at point is assumed to be already identical to
3301 the one between START and END.
3302 If SYNTAX is provided it's a regexp that describes the possible text of
3303 the clones; the clone will be shrunk or killed if necessary to ensure that
3304 its text matches the regexp.
3305 If SPREADP is non-nil it indicates that text inserted before/after the
3306 clone should be incorporated in the clone."
3307 ;; To deal with SPREADP we can either use an overlay with `nil t' along
3308 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
3309 ;; (with a one-char margin at each end) with `t nil'.
3310 ;; We opted for a larger overlay because it behaves better in the case
3311 ;; where the clone is reduced to the empty string (we want the overlay to
3312 ;; stay when the clone's content is the empty string and we want to use
3313 ;; `evaporate' to make sure those overlays get deleted when needed).
3315 (let* ((pt-end (+ (point) (- end start)))
3316 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
3317 0 1))
3318 (end-margin (if (or (not spreadp)
3319 (>= pt-end (point-max))
3320 (>= start (point-max)))
3321 0 1))
3322 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
3323 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
3324 (dups (list ol1 ol2)))
3325 (overlay-put ol1 'modification-hooks '(text-clone-maintain))
3326 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
3327 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
3328 ;;(overlay-put ol1 'face 'underline)
3329 (overlay-put ol1 'evaporate t)
3330 (overlay-put ol1 'text-clones dups)
3332 (overlay-put ol2 'modification-hooks '(text-clone-maintain))
3333 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
3334 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
3335 ;;(overlay-put ol2 'face 'underline)
3336 (overlay-put ol2 'evaporate t)
3337 (overlay-put ol2 'text-clones dups)))
3339 ;;;; Mail user agents.
3341 ;; Here we include just enough for other packages to be able
3342 ;; to define them.
3344 (defun define-mail-user-agent (symbol composefunc sendfunc
3345 &optional abortfunc hookvar)
3346 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3348 SYMBOL can be any Lisp symbol. Its function definition and/or
3349 value as a variable do not matter for this usage; we use only certain
3350 properties on its property list, to encode the rest of the arguments.
3352 COMPOSEFUNC is program callable function that composes an outgoing
3353 mail message buffer. This function should set up the basics of the
3354 buffer without requiring user interaction. It should populate the
3355 standard mail headers, leaving the `to:' and `subject:' headers blank
3356 by default.
3358 COMPOSEFUNC should accept several optional arguments--the same
3359 arguments that `compose-mail' takes. See that function's documentation.
3361 SENDFUNC is the command a user would run to send the message.
3363 Optional ABORTFUNC is the command a user would run to abort the
3364 message. For mail packages that don't have a separate abort function,
3365 this can be `kill-buffer' (the equivalent of omitting this argument).
3367 Optional HOOKVAR is a hook variable that gets run before the message
3368 is actually sent. Callers that use the `mail-user-agent' may
3369 install a hook function temporarily on this hook variable.
3370 If HOOKVAR is nil, `mail-send-hook' is used.
3372 The properties used on SYMBOL are `composefunc', `sendfunc',
3373 `abortfunc', and `hookvar'."
3374 (put symbol 'composefunc composefunc)
3375 (put symbol 'sendfunc sendfunc)
3376 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3377 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3379 ;;;; Progress reporters.
3381 ;; Progress reporter has the following structure:
3383 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
3384 ;; MIN-VALUE
3385 ;; MAX-VALUE
3386 ;; MESSAGE
3387 ;; MIN-CHANGE
3388 ;; MIN-TIME])
3390 ;; This weirdeness is for optimization reasons: we want
3391 ;; `progress-reporter-update' to be as fast as possible, so
3392 ;; `(car reporter)' is better than `(aref reporter 0)'.
3394 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
3395 ;; digits of precision, it doesn't really matter here. On the other
3396 ;; hand, it greatly simplifies the code.
3398 (defsubst progress-reporter-update (reporter value)
3399 "Report progress of an operation in the echo area.
3400 However, if the change since last echo area update is too small
3401 or not enough time has passed, then do nothing (see
3402 `make-progress-reporter' for details).
3404 First parameter, REPORTER, should be the result of a call to
3405 `make-progress-reporter'. Second, VALUE, determines the actual
3406 progress of operation; it must be between MIN-VALUE and MAX-VALUE
3407 as passed to `make-progress-reporter'.
3409 This function is very inexpensive, you may not bother how often
3410 you call it."
3411 (when (>= value (car reporter))
3412 (progress-reporter-do-update reporter value)))
3414 (defun make-progress-reporter (message min-value max-value
3415 &optional current-value
3416 min-change min-time)
3417 "Return progress reporter object to be used with `progress-reporter-update'.
3419 MESSAGE is shown in the echo area. When at least 1% of operation
3420 is complete, the exact percentage will be appended to the
3421 MESSAGE. When you call `progress-reporter-done', word \"done\"
3422 is printed after the MESSAGE. You can change MESSAGE of an
3423 existing progress reporter with `progress-reporter-force-update'.
3425 MIN-VALUE and MAX-VALUE designate starting (0% complete) and
3426 final (100% complete) states of operation. The latter should be
3427 larger; if this is not the case, then simply negate all values.
3428 Optional CURRENT-VALUE specifies the progress by the moment you
3429 call this function. You should omit it or set it to nil in most
3430 cases since it defaults to MIN-VALUE.
3432 Optional MIN-CHANGE determines the minimal change in percents to
3433 report (default is 1%.) Optional MIN-TIME specifies the minimal
3434 time before echo area updates (default is 0.2 seconds.) If
3435 `float-time' function is not present, then time is not tracked
3436 at all. If OS is not capable of measuring fractions of seconds,
3437 then this parameter is effectively rounded up."
3439 (unless min-time
3440 (setq min-time 0.2))
3441 (let ((reporter
3442 (cons min-value ;; Force a call to `message' now
3443 (vector (if (and (fboundp 'float-time)
3444 (>= min-time 0.02))
3445 (float-time) nil)
3446 min-value
3447 max-value
3448 message
3449 (if min-change (max (min min-change 50) 1) 1)
3450 min-time))))
3451 (progress-reporter-update reporter (or current-value min-value))
3452 reporter))
3454 (defun progress-reporter-force-update (reporter value &optional new-message)
3455 "Report progress of an operation in the echo area unconditionally.
3457 First two parameters are the same as for
3458 `progress-reporter-update'. Optional NEW-MESSAGE allows you to
3459 change the displayed message."
3460 (let ((parameters (cdr reporter)))
3461 (when new-message
3462 (aset parameters 3 new-message))
3463 (when (aref parameters 0)
3464 (aset parameters 0 (float-time)))
3465 (progress-reporter-do-update reporter value)))
3467 (defun progress-reporter-do-update (reporter value)
3468 (let* ((parameters (cdr reporter))
3469 (min-value (aref parameters 1))
3470 (max-value (aref parameters 2))
3471 (one-percent (/ (- max-value min-value) 100.0))
3472 (percentage (if (= max-value min-value)
3474 (truncate (/ (- value min-value) one-percent))))
3475 (update-time (aref parameters 0))
3476 (current-time (float-time))
3477 (enough-time-passed
3478 ;; See if enough time has passed since the last update.
3479 (or (not update-time)
3480 (when (>= current-time update-time)
3481 ;; Calculate time for the next update
3482 (aset parameters 0 (+ update-time (aref parameters 5)))))))
3484 ;; Calculate NEXT-UPDATE-VALUE. If we are not going to print
3485 ;; message this time because not enough time has passed, then use
3486 ;; 1 instead of MIN-CHANGE. This makes delays between echo area
3487 ;; updates closer to MIN-TIME.
3488 (setcar reporter
3489 (min (+ min-value (* (+ percentage
3490 (if enough-time-passed
3491 (aref parameters 4) ;; MIN-CHANGE
3493 one-percent))
3494 max-value))
3495 (when (integerp value)
3496 (setcar reporter (ceiling (car reporter))))
3498 ;; Only print message if enough time has passed
3499 (when enough-time-passed
3500 (if (> percentage 0)
3501 (message "%s%d%%" (aref parameters 3) percentage)
3502 (message "%s" (aref parameters 3))))))
3504 (defun progress-reporter-done (reporter)
3505 "Print reporter's message followed by word \"done\" in echo area."
3506 (message "%sdone" (aref (cdr reporter) 3)))
3508 (defmacro dotimes-with-progress-reporter (spec message &rest body)
3509 "Loop a certain number of times and report progress in the echo area.
3510 Evaluate BODY with VAR bound to successive integers running from
3511 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
3512 the return value (nil if RESULT is omitted).
3514 At each iteration MESSAGE followed by progress percentage is
3515 printed in the echo area. After the loop is finished, MESSAGE
3516 followed by word \"done\" is printed. This macro is a
3517 convenience wrapper around `make-progress-reporter' and friends.
3519 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
3520 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
3521 (let ((temp (make-symbol "--dotimes-temp--"))
3522 (temp2 (make-symbol "--dotimes-temp2--"))
3523 (start 0)
3524 (end (nth 1 spec)))
3525 `(let ((,temp ,end)
3526 (,(car spec) ,start)
3527 (,temp2 (make-progress-reporter ,message ,start ,end)))
3528 (while (< ,(car spec) ,temp)
3529 ,@body
3530 (progress-reporter-update ,temp2
3531 (setq ,(car spec) (1+ ,(car spec)))))
3532 (progress-reporter-done ,temp2)
3533 nil ,@(cdr (cdr spec)))))
3536 ;;;; Comparing version strings.
3538 (defvar version-separator "."
3539 "*Specify the string used to separate the version elements.
3541 Usually the separator is \".\", but it can be any other string.")
3544 (defvar version-regexp-alist
3545 '(("^[-_+ ]?a\\(lpha\\)?$" . -3)
3546 ("^[-_+]$" . -3) ; treat "1.2.3-20050920" and "1.2-3" as alpha releases
3547 ("^[-_+ ]cvs$" . -3) ; treat "1.2.3-CVS" as alpha release
3548 ("^[-_+ ]?b\\(eta\\)?$" . -2)
3549 ("^[-_+ ]?\\(pre\\|rc\\)$" . -1))
3550 "*Specify association between non-numeric version part and a priority.
3552 This association is used to handle version string like \"1.0pre2\",
3553 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
3554 non-numeric part to an integer. For example:
3556 String Version Integer List Version
3557 \"1.0pre2\" (1 0 -1 2)
3558 \"1.0PRE2\" (1 0 -1 2)
3559 \"22.8beta3\" (22 8 -2 3)
3560 \"22.8 Beta3\" (22 8 -2 3)
3561 \"0.9alpha1\" (0 9 -3 1)
3562 \"0.9AlphA1\" (0 9 -3 1)
3563 \"0.9 alpha\" (0 9 -3)
3565 Each element has the following form:
3567 (REGEXP . PRIORITY)
3569 Where:
3571 REGEXP regexp used to match non-numeric part of a version string.
3572 It should begin with a `^' anchor and end with a `$' to
3573 prevent false hits. Letter-case is ignored while matching
3574 REGEXP.
3576 PRIORITY negative integer which indicate the non-numeric priority.")
3579 (defun version-to-list (ver)
3580 "Convert version string VER into an integer list.
3582 The version syntax is given by the following EBNF:
3584 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
3586 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
3588 SEPARATOR ::= `version-separator' (which see)
3589 | `version-regexp-alist' (which see).
3591 The NUMBER part is optional if SEPARATOR is a match for an element
3592 in `version-regexp-alist'.
3594 As an example of valid version syntax:
3596 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
3598 As an example of invalid version syntax:
3600 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
3602 As an example of version convertion:
3604 String Version Integer List Version
3605 \"1.0.7.5\" (1 0 7 5)
3606 \"1.0pre2\" (1 0 -1 2)
3607 \"1.0PRE2\" (1 0 -1 2)
3608 \"22.8beta3\" (22 8 -2 3)
3609 \"22.8Beta3\" (22 8 -2 3)
3610 \"0.9alpha1\" (0 9 -3 1)
3611 \"0.9AlphA1\" (0 9 -3 1)
3612 \"0.9alpha\" (0 9 -3)
3614 See documentation for `version-separator' and `version-regexp-alist'."
3615 (or (and (stringp ver) (> (length ver) 0))
3616 (error "Invalid version string: '%s'" ver))
3617 ;; Change .x.y to 0.x.y
3618 (if (and (>= (length ver) (length version-separator))
3619 (string-equal (substring ver 0 (length version-separator))
3620 version-separator))
3621 (setq ver (concat "0" ver)))
3622 (save-match-data
3623 (let ((i 0)
3624 (case-fold-search t) ; ignore case in matching
3625 lst s al)
3626 (while (and (setq s (string-match "[0-9]+" ver i))
3627 (= s i))
3628 ;; handle numeric part
3629 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
3630 lst)
3631 i (match-end 0))
3632 ;; handle non-numeric part
3633 (when (and (setq s (string-match "[^0-9]+" ver i))
3634 (= s i))
3635 (setq s (substring ver i (match-end 0))
3636 i (match-end 0))
3637 ;; handle alpha, beta, pre, etc. separator
3638 (unless (string= s version-separator)
3639 (setq al version-regexp-alist)
3640 (while (and al (not (string-match (caar al) s)))
3641 (setq al (cdr al)))
3642 (or al (error "Invalid version syntax: '%s'" ver))
3643 (setq lst (cons (cdar al) lst)))))
3644 (if (null lst)
3645 (error "Invalid version syntax: '%s'" ver)
3646 (nreverse lst)))))
3649 (defun version-list-< (l1 l2)
3650 "Return t if integer list L1 is lesser than L2.
3652 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3653 etc. That is, the trailing zeroes are irrelevant. Also, integer
3654 list (1) is greater than (1 -1) which is greater than (1 -2)
3655 which is greater than (1 -3)."
3656 (while (and l1 l2 (= (car l1) (car l2)))
3657 (setq l1 (cdr l1)
3658 l2 (cdr l2)))
3659 (cond
3660 ;; l1 not null and l2 not null
3661 ((and l1 l2) (< (car l1) (car l2)))
3662 ;; l1 null and l2 null ==> l1 length = l2 length
3663 ((and (null l1) (null l2)) nil)
3664 ;; l1 not null and l2 null ==> l1 length > l2 length
3665 (l1 (< (version-list-not-zero l1) 0))
3666 ;; l1 null and l2 not null ==> l2 length > l1 length
3667 (t (< 0 (version-list-not-zero l2)))))
3670 (defun version-list-= (l1 l2)
3671 "Return t if integer list L1 is equal to L2.
3673 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3674 etc. That is, the trailing zeroes are irrelevant. Also, integer
3675 list (1) is greater than (1 -1) which is greater than (1 -2)
3676 which is greater than (1 -3)."
3677 (while (and l1 l2 (= (car l1) (car l2)))
3678 (setq l1 (cdr l1)
3679 l2 (cdr l2)))
3680 (cond
3681 ;; l1 not null and l2 not null
3682 ((and l1 l2) nil)
3683 ;; l1 null and l2 null ==> l1 length = l2 length
3684 ((and (null l1) (null l2)))
3685 ;; l1 not null and l2 null ==> l1 length > l2 length
3686 (l1 (zerop (version-list-not-zero l1)))
3687 ;; l1 null and l2 not null ==> l2 length > l1 length
3688 (t (zerop (version-list-not-zero l2)))))
3691 (defun version-list-<= (l1 l2)
3692 "Return t if integer list L1 is lesser than or equal to L2.
3694 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
3695 etc. That is, the trailing zeroes are irrelevant. Also, integer
3696 list (1) is greater than (1 -1) which is greater than (1 -2)
3697 which is greater than (1 -3)."
3698 (while (and l1 l2 (= (car l1) (car l2)))
3699 (setq l1 (cdr l1)
3700 l2 (cdr l2)))
3701 (cond
3702 ;; l1 not null and l2 not null
3703 ((and l1 l2) (< (car l1) (car l2)))
3704 ;; l1 null and l2 null ==> l1 length = l2 length
3705 ((and (null l1) (null l2)))
3706 ;; l1 not null and l2 null ==> l1 length > l2 length
3707 (l1 (<= (version-list-not-zero l1) 0))
3708 ;; l1 null and l2 not null ==> l2 length > l1 length
3709 (t (<= 0 (version-list-not-zero l2)))))
3711 (defun version-list-not-zero (lst)
3712 "Return the first non-zero element of integer list LST.
3714 If all LST elements are zeroes or LST is nil, return zero."
3715 (while (and lst (zerop (car lst)))
3716 (setq lst (cdr lst)))
3717 (if lst
3718 (car lst)
3719 ;; there is no element different of zero
3723 (defun version< (v1 v2)
3724 "Return t if version V1 is lesser than V2.
3726 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3727 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3728 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3729 \"1alpha\"."
3730 (version-list-< (version-to-list v1) (version-to-list v2)))
3733 (defun version<= (v1 v2)
3734 "Return t if version V1 is lesser than or equal to V2.
3736 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3737 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3738 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3739 \"1alpha\"."
3740 (version-list-<= (version-to-list v1) (version-to-list v2)))
3742 (defun version= (v1 v2)
3743 "Return t if version V1 is equal to V2.
3745 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
3746 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
3747 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
3748 \"1alpha\"."
3749 (version-list-= (version-to-list v1) (version-to-list v2)))
3752 ;;; Misc.
3754 ;; The following statement ought to be in print.c, but `provide' can't
3755 ;; be used there.
3756 (when (hash-table-p (car (read-from-string
3757 (prin1-to-string (make-hash-table)))))
3758 (provide 'hashtable-print-readable))
3760 ;; arch-tag: f7e0e6e5-70aa-4897-ae72-7a3511ec40bc
3761 ;;; subr.el ends here