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