* calendar/todo-mode.el (todo-set-top-priorities): Fix logic to
[bpt/emacs.git] / lisp / subr.el
CommitLineData
bfa3acd6 1;;; subr.el --- basic lisp subroutines for Emacs -*- coding: utf-8; lexical-binding:t -*-
630cc463 2
ba318903 3;; Copyright (C) 1985-1986, 1992, 1994-1995, 1999-2014 Free Software
ab422c4d 4;; Foundation, Inc.
be9b65ac 5
34dc21db 6;; Maintainer: emacs-devel@gnu.org
30764597 7;; Keywords: internal
bd78fa1d 8;; Package: emacs
30764597 9
be9b65ac
DL
10;; This file is part of GNU Emacs.
11
eb3fa2cf 12;; GNU Emacs is free software: you can redistribute it and/or modify
be9b65ac 13;; it under the terms of the GNU General Public License as published by
eb3fa2cf
GM
14;; the Free Software Foundation, either version 3 of the License, or
15;; (at your option) any later version.
be9b65ac
DL
16
17;; GNU Emacs is distributed in the hope that it will be useful,
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
21
22;; You should have received a copy of the GNU General Public License
eb3fa2cf 23;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
be9b65ac 24
60370d40
PJ
25;;; Commentary:
26
630cc463 27;;; Code:
d0fc47ed 28
2ee3d7f0
SM
29;; Beware: while this file has tag `utf-8', before it's compiled, it gets
30;; loaded as "raw-text", so non-ASCII chars won't work right during bootstrap.
31
bfa3acd6 32(defmacro declare-function (_fn _file &optional _arglist _fileonly)
708bb6f8 33 "Tell the byte-compiler that function FN is defined, in FILE.
fa6bc6fd
JB
34Optional ARGLIST is the argument list used by the function.
35The FILE argument is not used by the byte-compiler, but by the
708bb6f8 36`check-declare' package, which checks that FILE contains a
fa6bc6fd
JB
37definition for FN. ARGLIST is used by both the byte-compiler
38and `check-declare' to check for consistency.
708bb6f8
RS
39
40FILE can be either a Lisp file (in which case the \".el\"
41extension is optional), or a C file. C files are expanded
42relative to the Emacs \"src/\" directory. Lisp files are
43searched for using `locate-library', and if that fails they are
44expanded relative to the location of the file containing the
45declaration. A FILE with an \"ext:\" prefix is an external file.
46`check-declare' will check such files if they are found, and skip
47them without error if they are not.
48
49FILEONLY non-nil means that `check-declare' will only check that
50FILE exists, not that it defines FN. This is intended for
51function-definitions that `check-declare' does not recognize, e.g.
52`defstruct'.
53
54To specify a value for FILEONLY without passing an argument list,
3fa173b4 55set ARGLIST to t. This is necessary because nil means an
708bb6f8
RS
56empty argument list, rather than an unspecified one.
57
58Note that for the purposes of `check-declare', this statement
a4d2c321 59must be the first non-whitespace on a line.
708bb6f8 60
83031738 61For more information, see Info node `(elisp)Declaring Functions'."
708bb6f8
RS
62 ;; Does nothing - byte-compile-declare-function does the work.
63 nil)
e224699a 64
2c642c03 65\f
c4f484f2 66;;;; Basic Lisp macros.
9a5336ae 67
0764e16f
SM
68(defalias 'not 'null)
69
6b61353c 70(defmacro noreturn (form)
70c6db6c
LT
71 "Evaluate FORM, expecting it not to return.
72If FORM does return, signal an error."
2de39f08 73 (declare (debug t))
6b61353c
KH
74 `(prog1 ,form
75 (error "Form marked with `noreturn' did return")))
76
77(defmacro 1value (form)
70c6db6c
LT
78 "Evaluate FORM, expecting a constant return value.
79This is the global do-nothing version. There is also `testcover-1value'
80that complains if FORM ever does return differing values."
2de39f08 81 (declare (debug t))
6b61353c
KH
82 form)
83
8285ccd2
RS
84(defmacro def-edebug-spec (symbol spec)
85 "Set the `edebug-form-spec' property of SYMBOL according to SPEC.
e32721f5
GM
86Both SYMBOL and SPEC are unevaluated. The SPEC can be:
870 (instrument no arguments); t (instrument all arguments);
88a symbol (naming a function with an Edebug specification); or a list.
89The elements of the list describe the argument types; see
2b1e1a22 90Info node `(elisp)Specification List' for details."
8285ccd2
RS
91 `(put (quote ,symbol) 'edebug-form-spec (quote ,spec)))
92
9a5336ae
JB
93(defmacro lambda (&rest cdr)
94 "Return a lambda expression.
95A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
96self-quoting; the result of evaluating the lambda expression is the
97expression itself. The lambda expression may then be treated as a
bec0d7f9 98function, i.e., stored as the function value of a symbol, passed to
265b3f2a 99`funcall' or `mapcar', etc.
bec0d7f9 100
9a5336ae 101ARGS should take the same form as an argument list for a `defun'.
8fd68088
RS
102DOCSTRING is an optional documentation string.
103 If present, it should describe how to call the function.
104 But documentation strings are usually not useful in nameless functions.
9a5336ae
JB
105INTERACTIVE should be a call to the function `interactive', which see.
106It may also be omitted.
a478f3e1
JB
107BODY should be a list of Lisp expressions.
108
109\(fn ARGS [DOCSTRING] [INTERACTIVE] BODY)"
a179e3f7
SM
110 (declare (doc-string 2) (indent defun)
111 (debug (&define lambda-list
112 [&optional stringp]
113 [&optional ("interactive" interactive)]
114 def-body)))
9a5336ae
JB
115 ;; Note that this definition should not use backquotes; subr.el should not
116 ;; depend on backquote.el.
117 (list 'function (cons 'lambda cdr)))
118
f95e9344
SM
119(defmacro setq-local (var val)
120 "Set variable VAR to value VAL in current buffer."
121 ;; Can't use backquote here, it's too early in the bootstrap.
122 (list 'set (list 'make-local-variable (list 'quote var)) val))
123
124(defmacro defvar-local (var val &optional docstring)
125 "Define VAR as a buffer-local variable with default value VAL.
126Like `defvar' but additionally marks the variable as being automatically
127buffer-local wherever it is set."
8bba5a75 128 (declare (debug defvar) (doc-string 3))
f95e9344
SM
129 ;; Can't use backquote here, it's too early in the bootstrap.
130 (list 'progn (list 'defvar var val docstring)
131 (list 'make-variable-buffer-local (list 'quote var))))
132
2ec42da9
SM
133(defun apply-partially (fun &rest args)
134 "Return a function that is a partial application of FUN to ARGS.
135ARGS is a list of the first N arguments to pass to FUN.
136The result is a new function which does the same as FUN, except that
137the first N arguments are fixed at the values with which this function
138was called."
f488fb65 139 `(closure (t) (&rest args)
2ec42da9
SM
140 (apply ',fun ,@(mapcar (lambda (arg) `',arg) args) args)))
141
2ee3d7f0
SM
142(defmacro push (newelt place)
143 "Add NEWELT to the list stored in the generalized variable PLACE.
144This is morally equivalent to (setf PLACE (cons NEWELT PLACE)),
145except that PLACE is only evaluated once (after NEWELT)."
146 (declare (debug (form gv-place)))
147 (if (symbolp place)
148 ;; Important special case, to avoid triggering GV too early in
149 ;; the bootstrap.
150 (list 'setq place
151 (list 'cons newelt place))
152 (require 'macroexp)
153 (macroexp-let2 macroexp-copyable-p v newelt
154 (gv-letplace (getter setter) place
155 (funcall setter `(cons ,v ,getter))))))
156
157(defmacro pop (place)
158 "Return the first element of PLACE's value, and remove it from the list.
159PLACE must be a generalized variable whose value is a list.
d270117a
RS
160If the value is nil, `pop' returns nil but does not actually
161change the list."
2ee3d7f0 162 (declare (debug (gv-place)))
c0458e0b
SM
163 ;; We use `car-safe' here instead of `car' because the behavior is the same
164 ;; (if it's not a cons cell, the `cdr' would have signaled an error already),
165 ;; but `car-safe' is total, so the byte-compiler can safely remove it if the
166 ;; result is not used.
167 `(car-safe
168 ,(if (symbolp place)
169 ;; So we can use `pop' in the bootstrap before `gv' can be used.
170 (list 'prog1 place (list 'setq place (list 'cdr place)))
171 (gv-letplace (getter setter) place
172 `(prog1 ,getter ,(funcall setter `(cdr ,getter)))))))
d270117a 173
debff3c3 174(defmacro when (cond &rest body)
7f67eea0
KS
175 "If COND yields non-nil, do BODY, else return nil.
176When COND yields non-nil, eval BODY forms sequentially and return
177value of last one, or nil if there are none.
178
ebc3ae14 179\(fn COND BODY...)"
d47f7515 180 (declare (indent 1) (debug t))
debff3c3 181 (list 'if cond (cons 'progn body)))
9a5336ae 182
debff3c3 183(defmacro unless (cond &rest body)
7f67eea0
KS
184 "If COND yields nil, do BODY, else return nil.
185When COND yields nil, eval BODY forms sequentially and return
186value of last one, or nil if there are none.
187
ebc3ae14 188\(fn COND BODY...)"
d47f7515 189 (declare (indent 1) (debug t))
debff3c3 190 (cons 'if (cons cond (cons nil body))))
d370591d 191
a0b0756a 192(defmacro dolist (spec &rest body)
d47f7515 193 "Loop over a list.
a0b0756a 194Evaluate BODY with VAR bound to each car from LIST, in turn.
d47f7515
SM
195Then evaluate RESULT to get return value, default nil.
196
d775d486 197\(fn (VAR LIST [RESULT]) BODY...)"
d47f7515 198 (declare (indent 1) (debug ((symbolp form &optional form) body)))
01d16e16
RS
199 ;; It would be cleaner to create an uninterned symbol,
200 ;; but that uses a lot more space when many functions in many files
201 ;; use dolist.
ca105506 202 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
01d16e16 203 (let ((temp '--dolist-tail--))
f488fb65
SM
204 ;; This is not a reliable test, but it does not matter because both
205 ;; semantics are acceptable, tho one is slightly faster with dynamic
206 ;; scoping and the other is slightly faster (and has cleaner semantics)
207 ;; with lexical scoping.
208 (if lexical-binding
209 `(let ((,temp ,(nth 1 spec)))
210 (while ,temp
211 (let ((,(car spec) (car ,temp)))
212 ,@body
213 (setq ,temp (cdr ,temp))))
da03ef8a 214 ,@(cdr (cdr spec)))
f488fb65
SM
215 `(let ((,temp ,(nth 1 spec))
216 ,(car spec))
217 (while ,temp
218 (setq ,(car spec) (car ,temp))
219 ,@body
220 (setq ,temp (cdr ,temp)))
221 ,@(if (cdr (cdr spec))
222 `((setq ,(car spec) nil) ,@(cdr (cdr spec))))))))
01d16e16 223
a0b0756a 224(defmacro dotimes (spec &rest body)
d47f7515 225 "Loop a certain number of times.
a0b0756a
RS
226Evaluate BODY with VAR bound to successive integers running from 0,
227inclusive, to COUNT, exclusive. Then evaluate RESULT to get
d47f7515
SM
228the return value (nil if RESULT is omitted).
229
d775d486 230\(fn (VAR COUNT [RESULT]) BODY...)"
d47f7515 231 (declare (indent 1) (debug dolist))
01d16e16
RS
232 ;; It would be cleaner to create an uninterned symbol,
233 ;; but that uses a lot more space when many functions in many files
234 ;; use dotimes.
f488fb65 235 ;; FIXME: This cost disappears in byte-compiled lexical-binding files.
01d16e16 236 (let ((temp '--dotimes-limit--)
d47f7515
SM
237 (start 0)
238 (end (nth 1 spec)))
f488fb65
SM
239 ;; This is not a reliable test, but it does not matter because both
240 ;; semantics are acceptable, tho one is slightly faster with dynamic
241 ;; scoping and the other has cleaner semantics.
242 (if lexical-binding
243 (let ((counter '--dotimes-counter--))
244 `(let ((,temp ,end)
245 (,counter ,start))
246 (while (< ,counter ,temp)
247 (let ((,(car spec) ,counter))
248 ,@body)
249 (setq ,counter (1+ ,counter)))
250 ,@(if (cddr spec)
251 ;; FIXME: This let often leads to "unused var" warnings.
252 `((let ((,(car spec) ,counter)) ,@(cddr spec))))))
253 `(let ((,temp ,end)
254 (,(car spec) ,start))
255 (while (< ,(car spec) ,temp)
256 ,@body
257 (setq ,(car spec) (1+ ,(car spec))))
258 ,@(cdr (cdr spec))))))
a0b0756a 259
06b60517 260(defmacro declare (&rest _specs)
863666eb
CY
261 "Do not evaluate any arguments, and return nil.
262If a `declare' form appears as the first form in the body of a
263`defun' or `defmacro' form, SPECS specifies various additional
264information about the function or macro; these go into effect
265during the evaluation of the `defun' or `defmacro' form.
266
267The possible values of SPECS are specified by
268`defun-declarations-alist' and `macro-declarations-alist'."
36cec983 269 ;; FIXME: edebug spec should pay attention to defun-declarations-alist.
a69c67e8 270 nil)
6b5de136
GM
271
272(defmacro ignore-errors (&rest body)
273 "Execute BODY; if an error occurs, return nil.
d02e58f8
LL
274Otherwise, return result of last form in BODY.
275See also `with-demoted-errors' that does something similar
276without silencing all errors."
7467d0a8 277 (declare (debug t) (indent 0))
6b5de136 278 `(condition-case nil (progn ,@body) (error nil)))
c4f484f2
RS
279\f
280;;;; Basic Lisp functions.
281
06b60517 282(defun ignore (&rest _ignore)
c4f484f2
RS
283 "Do nothing and return nil.
284This function accepts any number of arguments, but ignores them."
285 (interactive)
286 nil)
287
fd6c5134 288;; Signal a compile-error if the first arg is missing.
c4f484f2
RS
289(defun error (&rest args)
290 "Signal an error, making error message by passing all args to `format'.
291In Emacs, the convention is that error messages start with a capital
292letter but *do not* end with a period. Please follow this convention
fd6c5134 293for the sake of consistency."
328a8179 294 (declare (advertised-calling-convention (string &rest args) "23.1"))
53b39e89 295 (signal 'error (list (apply 'format args))))
c4f484f2 296
71873e2b
SM
297(defun user-error (format &rest args)
298 "Signal a pilot error, making error message by passing all args to `format'.
299In Emacs, the convention is that error messages start with a capital
300letter but *do not* end with a period. Please follow this convention
301for the sake of consistency.
302This is just like `error' except that `user-error's are expected to be the
303result of an incorrect manipulation on the part of the user, rather than the
304result of an actual problem."
53b39e89 305 (signal 'user-error (list (apply #'format format args))))
71873e2b 306
54bd972f
SM
307(defun define-error (name message &optional parent)
308 "Define NAME as a new error signal.
309MESSAGE is a string that will be output to the echo area if such an error
310is signaled without being caught by a `condition-case'.
311PARENT is either a signal or a list of signals from which it inherits.
312Defaults to `error'."
313 (unless parent (setq parent 'error))
314 (let ((conditions
315 (if (consp parent)
316 (apply #'nconc
317 (mapcar (lambda (parent)
318 (cons parent
319 (or (get parent 'error-conditions)
320 (error "Unknown signal `%s'" parent))))
321 parent))
322 (cons parent (get parent 'error-conditions)))))
323 (put name 'error-conditions
324 (delete-dups (copy-sequence (cons name conditions))))
325 (when message (put name 'error-message message))))
326
c4f484f2
RS
327;; We put this here instead of in frame.el so that it's defined even on
328;; systems where frame.el isn't loaded.
329(defun frame-configuration-p (object)
330 "Return non-nil if OBJECT seems to be a frame configuration.
331Any list whose car is `frame-configuration' is assumed to be a frame
332configuration."
333 (and (consp object)
334 (eq (car object) 'frame-configuration)))
c4f484f2
RS
335\f
336;;;; List functions.
6b61353c 337
d370591d
RS
338(defsubst caar (x)
339 "Return the car of the car of X."
340 (car (car x)))
341
342(defsubst cadr (x)
343 "Return the car of the cdr of X."
344 (car (cdr x)))
345
346(defsubst cdar (x)
347 "Return the cdr of the car of X."
348 (cdr (car x)))
349
350(defsubst cddr (x)
351 "Return the cdr of the cdr of X."
352 (cdr (cdr x)))
e8c32c99 353
a478f3e1
JB
354(defun last (list &optional n)
355 "Return the last link of LIST. Its car is the last element.
356If LIST is nil, return nil.
357If N is non-nil, return the Nth-to-last link of LIST.
358If N is bigger than the length of LIST, return LIST."
369fba5f 359 (if n
10e4702a 360 (and (>= n 0)
88f427d5 361 (let ((m (safe-length list)))
35744400
IS
362 (if (< n m) (nthcdr (- m n) list) list)))
363 (and list
88f427d5 364 (nthcdr (1- (safe-length list)) list))))
526d204e 365
a478f3e1 366(defun butlast (list &optional n)
79278d03
LI
367 "Return a copy of LIST with the last N elements removed.
368If N is omitted or nil, the last element is removed from the
369copy."
a478f3e1
JB
370 (if (and n (<= n 0)) list
371 (nbutlast (copy-sequence list) n)))
1c1c65de 372
a478f3e1 373(defun nbutlast (list &optional n)
79278d03
LI
374 "Modifies LIST to remove the last N elements.
375If N is omitted or nil, remove the last element."
a478f3e1 376 (let ((m (length list)))
1c1c65de
KH
377 (or n (setq n 1))
378 (and (< n m)
379 (progn
a478f3e1
JB
380 (if (> n 0) (setcdr (nthcdr (- (1- m) n) list) nil))
381 list))))
1c1c65de 382
6b61353c
KH
383(defun delete-dups (list)
384 "Destructively remove `equal' duplicates from LIST.
385Store the result in LIST and return it. LIST must be a proper list.
386Of several `equal' occurrences of an element in LIST, the first
387one is kept."
388 (let ((tail list))
389 (while tail
390 (setcdr tail (delete (car tail) (cdr tail)))
391 (setq tail (cdr tail))))
392 list)
393
c7a8fcac
LL
394;; See http://lists.gnu.org/archive/html/emacs-devel/2013-05/msg00204.html
395(defun delete-consecutive-dups (list &optional circular)
396 "Destructively remove `equal' consecutive duplicates from LIST.
397First and last elements are considered consecutive if CIRCULAR is
398non-nil."
399 (let ((tail list) last)
400 (while (consp tail)
401 (if (equal (car tail) (cadr tail))
402 (setcdr tail (cddr tail))
403 (setq last (car tail)
404 tail (cdr tail))))
405 (if (and circular
406 (cdr list)
407 (equal last (car list)))
408 (nbutlast list)
409 list)))
410
0ed2c9b6 411(defun number-sequence (from &optional to inc)
abd9177a 412 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
6b61353c 413INC is the increment used between numbers in the sequence and defaults to 1.
fa6bc6fd 414So, the Nth element of the list is (+ FROM (* N INC)) where N counts from
6b61353c 415zero. TO is only included if there is an N for which TO = FROM + N * INC.
fa6bc6fd 416If TO is nil or numerically equal to FROM, return (FROM).
6b61353c
KH
417If INC is positive and TO is less than FROM, or INC is negative
418and TO is larger than FROM, return nil.
419If INC is zero and TO is neither nil nor numerically equal to
420FROM, signal an error.
421
422This function is primarily designed for integer arguments.
423Nevertheless, FROM, TO and INC can be integer or float. However,
424floating point arithmetic is inexact. For instance, depending on
425the machine, it may quite well happen that
fa6bc6fd
JB
426\(number-sequence 0.4 0.6 0.2) returns the one element list (0.4),
427whereas (number-sequence 0.4 0.8 0.2) returns a list with three
6b61353c
KH
428elements. Thus, if some of the arguments are floats and one wants
429to make sure that TO is included, one may have to explicitly write
fa6bc6fd 430TO as (+ FROM (* N INC)) or use a variable whose value was
6b61353c
KH
431computed with this exact expression. Alternatively, you can,
432of course, also replace TO with a slightly larger value
433\(or a slightly more negative value if INC is negative)."
434 (if (or (not to) (= from to))
0ed2c9b6
VJL
435 (list from)
436 (or inc (setq inc 1))
6b61353c
KH
437 (when (zerop inc) (error "The increment can not be zero"))
438 (let (seq (n 0) (next from))
439 (if (> inc 0)
440 (while (<= next to)
441 (setq seq (cons next seq)
442 n (1+ n)
443 next (+ from (* n inc))))
444 (while (>= next to)
445 (setq seq (cons next seq)
446 n (1+ n)
447 next (+ from (* n inc)))))
0ed2c9b6 448 (nreverse seq))))
abd9177a 449
a176c9eb
CW
450(defun copy-tree (tree &optional vecp)
451 "Make a copy of TREE.
452If TREE is a cons cell, this recursively copies both its car and its cdr.
cfebd4db 453Contrast to `copy-sequence', which copies only along the cdrs. With second
a176c9eb
CW
454argument VECP, this copies vectors as well as conses."
455 (if (consp tree)
cfebd4db
RS
456 (let (result)
457 (while (consp tree)
458 (let ((newcar (car tree)))
459 (if (or (consp (car tree)) (and vecp (vectorp (car tree))))
460 (setq newcar (copy-tree (car tree) vecp)))
461 (push newcar result))
462 (setq tree (cdr tree)))
68b08950 463 (nconc (nreverse result) tree))
a176c9eb
CW
464 (if (and vecp (vectorp tree))
465 (let ((i (length (setq tree (copy-sequence tree)))))
466 (while (>= (setq i (1- i)) 0)
cfebd4db
RS
467 (aset tree i (copy-tree (aref tree i) vecp)))
468 tree)
469 tree)))
c4f484f2
RS
470\f
471;;;; Various list-search functions.
a176c9eb 472
8a288450
RS
473(defun assoc-default (key alist &optional test default)
474 "Find object KEY in a pseudo-alist ALIST.
753bc4f6
CY
475ALIST is a list of conses or objects. Each element
476 (or the element's car, if it is a cons) is compared with KEY by
477 calling TEST, with two arguments: (i) the element or its car,
478 and (ii) KEY.
479If that is non-nil, the element matches; then `assoc-default'
480 returns the element's cdr, if it is a cons, or DEFAULT if the
481 element is not a cons.
8a288450
RS
482
483If no element matches, the value is nil.
484If TEST is omitted or nil, `equal' is used."
485 (let (found (tail alist) value)
486 (while (and tail (not found))
487 (let ((elt (car tail)))
488 (when (funcall (or test 'equal) (if (consp elt) (car elt) elt) key)
489 (setq found t value (if (consp elt) (cdr elt) default))))
490 (setq tail (cdr tail)))
491 value))
98aae5f6
KH
492
493(defun assoc-ignore-case (key alist)
494 "Like `assoc', but ignores differences in case and text representation.
495KEY must be a string. Upper-case and lower-case letters are treated as equal.
496Unibyte strings are converted to multibyte for comparison."
59f7af81 497 (declare (obsolete assoc-string "22.1"))
6b61353c 498 (assoc-string key alist t))
98aae5f6
KH
499
500(defun assoc-ignore-representation (key alist)
501 "Like `assoc', but ignores differences in text representation.
264ef586 502KEY must be a string.
98aae5f6 503Unibyte strings are converted to multibyte for comparison."
59f7af81 504 (declare (obsolete assoc-string "22.1"))
6b61353c 505 (assoc-string key alist nil))
cbbc3205
GM
506
507(defun member-ignore-case (elt list)
5612fd08 508 "Like `member', but ignore differences in case and text representation.
cbbc3205 509ELT must be a string. Upper-case and lower-case letters are treated as equal.
d86a3084
RS
510Unibyte strings are converted to multibyte for comparison.
511Non-strings in LIST are ignored."
512 (while (and list
513 (not (and (stringp (car list))
514 (eq t (compare-strings elt 0 nil (car list) 0 nil t)))))
242c13e8
MB
515 (setq list (cdr list)))
516 list)
cbbc3205 517
c4f484f2
RS
518(defun assq-delete-all (key alist)
519 "Delete from ALIST all elements whose car is `eq' to KEY.
520Return the modified alist.
521Elements of ALIST that are not conses are ignored."
522 (while (and (consp (car alist))
523 (eq (car (car alist)) key))
524 (setq alist (cdr alist)))
525 (let ((tail alist) tail-cdr)
526 (while (setq tail-cdr (cdr tail))
527 (if (and (consp (car tail-cdr))
528 (eq (car (car tail-cdr)) key))
529 (setcdr tail (cdr tail-cdr))
530 (setq tail tail-cdr))))
531 alist)
532
533(defun rassq-delete-all (value alist)
534 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
535Return the modified alist.
536Elements of ALIST that are not conses are ignored."
537 (while (and (consp (car alist))
538 (eq (cdr (car alist)) value))
539 (setq alist (cdr alist)))
540 (let ((tail alist) tail-cdr)
541 (while (setq tail-cdr (cdr tail))
542 (if (and (consp (car tail-cdr))
543 (eq (cdr (car tail-cdr)) value))
544 (setcdr tail (cdr tail-cdr))
545 (setq tail tail-cdr))))
546 alist)
547
548(defun remove (elt seq)
549 "Return a copy of SEQ with all occurrences of ELT removed.
550SEQ must be a list, vector, or string. The comparison is done with `equal'."
551 (if (nlistp seq)
552 ;; If SEQ isn't a list, there's no need to copy SEQ because
553 ;; `delete' will return a new object.
554 (delete elt seq)
555 (delete elt (copy-sequence seq))))
556
557(defun remq (elt list)
558 "Return LIST with all occurrences of ELT removed.
559The comparison is done with `eq'. Contrary to `delq', this does not use
560side-effects, and the argument LIST is not modified."
7f9b7c53 561 (while (and (eq elt (car list)) (setq list (cdr list))))
c4f484f2
RS
562 (if (memq elt list)
563 (delq elt (copy-sequence list))
564 list))
9a5336ae 565\f
9a5336ae 566;;;; Keymap support.
be9b65ac 567
ed8bd4d7
SM
568(defun kbd (keys)
569 "Convert KEYS to the internal Emacs key representation.
570KEYS should be a string constant in the format used for
571saving keyboard macros (see `edmacro-mode')."
572 ;; Don't use a defalias, since the `pure' property is only true for
573 ;; the calling convention of `kbd'.
574 (read-kbd-macro keys))
f95e9344 575(put 'kbd 'pure t)
c4f484f2 576
be9b65ac 577(defun undefined ()
3fa173b4 578 "Beep to tell the user this binding is undefined."
be9b65ac 579 (interactive)
4c9797cb
SM
580 (ding)
581 (message "%s is undefined" (key-description (this-single-command-keys)))
582 (setq defining-kbd-macro nil)
583 (force-mode-line-update)
584 ;; If this is a down-mouse event, don't reset prefix-arg;
585 ;; pass it to the command run by the up event.
586 (setq prefix-arg
587 (when (memq 'down (event-modifiers last-command-event))
588 current-prefix-arg)))
be9b65ac 589
c4f484f2
RS
590;; Prevent the \{...} documentation construct
591;; from mentioning keys that run this command.
be9b65ac
DL
592(put 'undefined 'suppress-keymap t)
593
594(defun suppress-keymap (map &optional nodigits)
595 "Make MAP override all normally self-inserting keys to be undefined.
596Normally, as an exception, digits and minus-sign are set to make prefix args,
597but optional second arg NODIGITS non-nil treats them like other chars."
098ba983 598 (define-key map [remap self-insert-command] 'undefined)
be9b65ac
DL
599 (or nodigits
600 (let (loop)
601 (define-key map "-" 'negative-argument)
602 ;; Make plain numbers do numeric args.
603 (setq loop ?0)
604 (while (<= loop ?9)
605 (define-key map (char-to-string loop) 'digit-argument)
606 (setq loop (1+ loop))))))
607
640c8776
SM
608(defun make-composed-keymap (maps &optional parent)
609 "Construct a new keymap composed of MAPS and inheriting from PARENT.
610When looking up a key in the returned map, the key is looked in each
611keymap of MAPS in turn until a binding is found.
612If no binding is found in MAPS, the lookup continues in PARENT, if non-nil.
613As always with keymap inheritance, a nil binding in MAPS overrides
614any corresponding binding in PARENT, but it does not override corresponding
615bindings in other keymaps of MAPS.
616MAPS can be a list of keymaps or a single keymap.
617PARENT if non-nil should be a keymap."
618 `(keymap
619 ,@(if (keymapp maps) (list maps) maps)
620 ,@parent))
621
4ced66fd 622(defun define-key-after (keymap key definition &optional after)
4434d61b
RS
623 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
624This is like `define-key' except that the binding for KEY is placed
625just after the binding for the event AFTER, instead of at the beginning
c34a9d34
RS
626of the map. Note that AFTER must be an event type (like KEY), NOT a command
627\(like DEFINITION).
628
4ced66fd 629If AFTER is t or omitted, the new binding goes at the end of the keymap.
08b1f8a1 630AFTER should be a single event type--a symbol or a character, not a sequence.
c34a9d34 631
4ced66fd 632Bindings are always added before any inherited map.
c34a9d34 633
0181e193
LMI
634The order of bindings in a keymap only matters when it is used as
635a menu, so this function is not useful for non-menu keymaps."
4ced66fd 636 (unless after (setq after t))
4434d61b
RS
637 (or (keymapp keymap)
638 (signal 'wrong-type-argument (list 'keymapp keymap)))
08b1f8a1
GM
639 (setq key
640 (if (<= (length key) 1) (aref key 0)
641 (setq keymap (lookup-key keymap
642 (apply 'vector
643 (butlast (mapcar 'identity key)))))
644 (aref key (1- (length key)))))
645 (let ((tail keymap) done inserted)
4434d61b
RS
646 (while (and (not done) tail)
647 ;; Delete any earlier bindings for the same key.
08b1f8a1 648 (if (eq (car-safe (car (cdr tail))) key)
4434d61b 649 (setcdr tail (cdr (cdr tail))))
08b1f8a1
GM
650 ;; If we hit an included map, go down that one.
651 (if (keymapp (car tail)) (setq tail (car tail)))
4434d61b
RS
652 ;; When we reach AFTER's binding, insert the new binding after.
653 ;; If we reach an inherited keymap, insert just before that.
113d28a8 654 ;; If we reach the end of this keymap, insert at the end.
c34a9d34
RS
655 (if (or (and (eq (car-safe (car tail)) after)
656 (not (eq after t)))
113d28a8
RS
657 (eq (car (cdr tail)) 'keymap)
658 (null (cdr tail)))
4434d61b 659 (progn
113d28a8
RS
660 ;; Stop the scan only if we find a parent keymap.
661 ;; Keep going past the inserted element
662 ;; so we can delete any duplications that come later.
663 (if (eq (car (cdr tail)) 'keymap)
664 (setq done t))
665 ;; Don't insert more than once.
666 (or inserted
08b1f8a1 667 (setcdr tail (cons (cons key definition) (cdr tail))))
113d28a8 668 (setq inserted t)))
4434d61b
RS
669 (setq tail (cdr tail)))))
670
a10cca6c 671(defun map-keymap-sorted (function keymap)
14694a59
RS
672 "Implement `map-keymap' with sorting.
673Don't call this function; it is for internal use only."
a10cca6c
SM
674 (let (list)
675 (map-keymap (lambda (a b) (push (cons a b) list))
676 keymap)
677 (setq list (sort list
678 (lambda (a b)
679 (setq a (car a) b (car b))
680 (if (integerp a)
681 (if (integerp b) (< a b)
682 t)
683 (if (integerp b) t
684 ;; string< also accepts symbols.
685 (string< a b))))))
686 (dolist (p list)
687 (funcall function (car p) (cdr p)))))
51fa3961 688
3349e122
SM
689(defun keymap--menu-item-binding (val)
690 "Return the binding part of a menu-item."
691 (cond
692 ((not (consp val)) val) ;Not a menu-item.
693 ((eq 'menu-item (car val))
694 (let* ((binding (nth 2 val))
695 (plist (nthcdr 3 val))
696 (filter (plist-get plist :filter)))
697 (if filter (funcall filter binding)
698 binding)))
699 ((and (consp (cdr val)) (stringp (cadr val)))
700 (cddr val))
701 ((stringp (car val))
702 (cdr val))
703 (t val))) ;Not a menu-item either.
704
705(defun keymap--menu-item-with-binding (item binding)
706 "Build a menu-item like ITEM but with its binding changed to BINDING."
707 (cond
08e1d82c 708 ((not (consp item)) binding) ;Not a menu-item.
3349e122
SM
709 ((eq 'menu-item (car item))
710 (setq item (copy-sequence item))
711 (let ((tail (nthcdr 2 item)))
712 (setcar tail binding)
713 ;; Remove any potential filter.
714 (if (plist-get (cdr tail) :filter)
715 (setcdr tail (plist-put (cdr tail) :filter nil))))
716 item)
717 ((and (consp (cdr item)) (stringp (cadr item)))
718 (cons (car item) (cons (cadr item) binding)))
719 (t (cons (car item) binding))))
720
721(defun keymap--merge-bindings (val1 val2)
722 "Merge bindings VAL1 and VAL2."
723 (let ((map1 (keymap--menu-item-binding val1))
724 (map2 (keymap--menu-item-binding val2)))
725 (if (not (and (keymapp map1) (keymapp map2)))
726 ;; There's nothing to merge: val1 takes precedence.
727 val1
728 (let ((map (list 'keymap map1 map2))
729 (item (if (keymapp val1) (if (keymapp val2) nil val2) val1)))
730 (keymap--menu-item-with-binding item map)))))
731
00f7c5ed 732(defun keymap-canonicalize (map)
3349e122
SM
733 "Return a simpler equivalent keymap.
734This resolves inheritance and redefinitions. The returned keymap
735should behave identically to a copy of KEYMAP w.r.t `lookup-key'
736and use in active keymaps and menus.
737Subkeymaps may be modified but are not canonicalized."
738 ;; FIXME: Problem with the difference between a nil binding
739 ;; that hides a binding in an inherited map and a nil binding that's ignored
740 ;; to let some further binding visible. Currently a nil binding hides all.
741 ;; FIXME: we may want to carefully (re)order elements in case they're
742 ;; menu-entries.
00f7c5ed 743 (let ((bindings ())
c099a588
AS
744 (ranges ())
745 (prompt (keymap-prompt map)))
00f7c5ed 746 (while (keymapp map)
3349e122 747 (setq map (map-keymap ;; -internal
00f7c5ed
SM
748 (lambda (key item)
749 (if (consp key)
750 ;; Treat char-ranges specially.
751 (push (cons key item) ranges)
752 (push (cons key item) bindings)))
753 map)))
3349e122 754 ;; Create the new map.
c099a588 755 (setq map (funcall (if ranges 'make-keymap 'make-sparse-keymap) prompt))
00f7c5ed 756 (dolist (binding ranges)
3349e122 757 ;; Treat char-ranges specially. FIXME: need to merge as well.
64981d1a 758 (define-key map (vector (car binding)) (cdr binding)))
3349e122 759 ;; Process the bindings starting from the end.
00f7c5ed
SM
760 (dolist (binding (prog1 bindings (setq bindings ())))
761 (let* ((key (car binding))
00f7c5ed 762 (oldbind (assq key bindings)))
3349e122
SM
763 (push (if (not oldbind)
764 ;; The normal case: no duplicate bindings.
765 binding
766 ;; This is the second binding for this key.
767 (setq bindings (delq oldbind bindings))
768 (cons key (keymap--merge-bindings (cdr binding)
769 (cdr oldbind))))
770 bindings)))
00f7c5ed
SM
771 (nconc map bindings)))
772
8bed5e3d
RS
773(put 'keyboard-translate-table 'char-table-extra-slots 0)
774
9a5336ae 775(defun keyboard-translate (from to)
9aeb25a6 776 "Translate character FROM to TO on the current terminal.
9a5336ae
JB
777This function creates a `keyboard-translate-table' if necessary
778and then modifies one entry in it."
8bed5e3d
RS
779 (or (char-table-p keyboard-translate-table)
780 (setq keyboard-translate-table
781 (make-char-table 'keyboard-translate-table nil)))
9a5336ae 782 (aset keyboard-translate-table from to))
9a5336ae 783\f
c4f484f2 784;;;; Key binding commands.
9a5336ae 785
c4f484f2
RS
786(defun global-set-key (key command)
787 "Give KEY a global binding as COMMAND.
788COMMAND is the command definition to use; usually it is
789a symbol naming an interactively-callable function.
790KEY is a key sequence; noninteractively, it is a string or vector
791of characters or event types, and non-ASCII characters with codes
792above 127 (such as ISO Latin-1) can be included if you use a vector.
9a5336ae 793
c4f484f2
RS
794Note that if KEY has a local binding in the current buffer,
795that local binding will continue to shadow any global binding
796that you make with this function."
797 (interactive "KSet key globally: \nCSet key %s to command: ")
798 (or (vectorp key) (stringp key)
799 (signal 'wrong-type-argument (list 'arrayp key)))
800 (define-key (current-global-map) key command))
9a5336ae 801
c4f484f2
RS
802(defun local-set-key (key command)
803 "Give KEY a local binding as COMMAND.
804COMMAND is the command definition to use; usually it is
805a symbol naming an interactively-callable function.
806KEY is a key sequence; noninteractively, it is a string or vector
807of characters or event types, and non-ASCII characters with codes
808above 127 (such as ISO Latin-1) can be included if you use a vector.
9a5336ae 809
fa6bc6fd
JB
810The binding goes in the current buffer's local map, which in most
811cases is shared with all other buffers in the same major mode."
c4f484f2
RS
812 (interactive "KSet key locally: \nCSet key %s locally to command: ")
813 (let ((map (current-local-map)))
814 (or map
815 (use-local-map (setq map (make-sparse-keymap))))
816 (or (vectorp key) (stringp key)
817 (signal 'wrong-type-argument (list 'arrayp key)))
818 (define-key map key command)))
9a5336ae 819
c4f484f2
RS
820(defun global-unset-key (key)
821 "Remove global binding of KEY.
822KEY is a string or vector representing a sequence of keystrokes."
823 (interactive "kUnset key globally: ")
824 (global-set-key key nil))
9a5336ae 825
c4f484f2
RS
826(defun local-unset-key (key)
827 "Remove local binding of KEY.
828KEY is a string or vector representing a sequence of keystrokes."
829 (interactive "kUnset key locally: ")
830 (if (current-local-map)
831 (local-set-key key nil))
832 nil)
833\f
834;;;; substitute-key-definition and its subroutines.
835
836(defvar key-substitution-in-progress nil
c8227332 837 "Used internally by `substitute-key-definition'.")
c4f484f2
RS
838
839(defun substitute-key-definition (olddef newdef keymap &optional oldmap prefix)
840 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
841In other words, OLDDEF is replaced with NEWDEF where ever it appears.
842Alternatively, if optional fourth argument OLDMAP is specified, we redefine
843in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
844
fda11e85
RS
845If you don't specify OLDMAP, you can usually get the same results
846in a cleaner way with command remapping, like this:
fa6bc6fd 847 (define-key KEYMAP [remap OLDDEF] NEWDEF)
50d16788 848\n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
c4f484f2
RS
849 ;; Don't document PREFIX in the doc string because we don't want to
850 ;; advertise it. It's meant for recursive calls only. Here's its
851 ;; meaning
852
853 ;; If optional argument PREFIX is specified, it should be a key
854 ;; prefix, a string. Redefined bindings will then be bound to the
855 ;; original key, with PREFIX added at the front.
856 (or prefix (setq prefix ""))
857 (let* ((scan (or oldmap keymap))
858 (prefix1 (vconcat prefix [nil]))
859 (key-substitution-in-progress
860 (cons scan key-substitution-in-progress)))
861 ;; Scan OLDMAP, finding each char or event-symbol that
862 ;; has any definition, and act on it with hack-key.
863 (map-keymap
864 (lambda (char defn)
865 (aset prefix1 (length prefix) char)
866 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
867 scan)))
868
869(defun substitute-key-definition-key (defn olddef newdef prefix keymap)
870 (let (inner-def skipped menu-item)
871 ;; Find the actual command name within the binding.
872 (if (eq (car-safe defn) 'menu-item)
873 (setq menu-item defn defn (nth 2 defn))
874 ;; Skip past menu-prompt.
875 (while (stringp (car-safe defn))
876 (push (pop defn) skipped))
877 ;; Skip past cached key-equivalence data for menu items.
878 (if (consp (car-safe defn))
879 (setq defn (cdr defn))))
880 (if (or (eq defn olddef)
881 ;; Compare with equal if definition is a key sequence.
882 ;; That is useful for operating on function-key-map.
883 (and (or (stringp defn) (vectorp defn))
884 (equal defn olddef)))
885 (define-key keymap prefix
886 (if menu-item
887 (let ((copy (copy-sequence menu-item)))
888 (setcar (nthcdr 2 copy) newdef)
889 copy)
890 (nconc (nreverse skipped) newdef)))
891 ;; Look past a symbol that names a keymap.
892 (setq inner-def
cf25c647 893 (or (indirect-function defn t) defn))
c4f484f2
RS
894 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
895 ;; avoid autoloading a keymap. This is mostly done to preserve the
896 ;; original non-autoloading behavior of pre-map-keymap times.
897 (if (and (keymapp inner-def)
898 ;; Avoid recursively scanning
899 ;; where KEYMAP does not have a submap.
900 (let ((elt (lookup-key keymap prefix)))
901 (or (null elt) (natnump elt) (keymapp elt)))
902 ;; Avoid recursively rescanning keymap being scanned.
903 (not (memq inner-def key-substitution-in-progress)))
904 ;; If this one isn't being scanned already, scan it now.
905 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
9a5336ae
JB
906
907\f
264ef586 908;;;; The global keymap tree.
9a5336ae 909
354f0faf
SM
910;; global-map, esc-map, and ctl-x-map have their values set up in
911;; keymap.c; we just give them docstrings here.
9a5336ae
JB
912
913(defvar global-map nil
914 "Default global keymap mapping Emacs keyboard input into commands.
915The value is a keymap which is usually (but not necessarily) Emacs's
916global map.")
917
918(defvar esc-map nil
919 "Default keymap for ESC (meta) commands.
920The normal global definition of the character ESC indirects to this keymap.")
921
922(defvar ctl-x-map nil
923 "Default keymap for C-x commands.
924The normal global definition of the character C-x indirects to this keymap.")
925
926(defvar ctl-x-4-map (make-sparse-keymap)
03eeb110 927 "Keymap for subcommands of C-x 4.")
059184dd 928(defalias 'ctl-x-4-prefix ctl-x-4-map)
9a5336ae
JB
929(define-key ctl-x-map "4" 'ctl-x-4-prefix)
930
931(defvar ctl-x-5-map (make-sparse-keymap)
932 "Keymap for frame commands.")
059184dd 933(defalias 'ctl-x-5-prefix ctl-x-5-map)
9a5336ae
JB
934(define-key ctl-x-map "5" 'ctl-x-5-prefix)
935
0f03054a 936\f
9a5336ae
JB
937;;;; Event manipulation functions.
938
03a74b84 939(defconst listify-key-sequence-1 (logior 128 ?\M-\C-@))
114137b8 940
cde6d7e3
RS
941(defun listify-key-sequence (key)
942 "Convert a key sequence to a list of events."
943 (if (vectorp key)
944 (append key nil)
945 (mapcar (function (lambda (c)
946 (if (> c 127)
114137b8 947 (logxor c listify-key-sequence-1)
cde6d7e3 948 c)))
d47f7515 949 key)))
cde6d7e3 950
e1894109 951(defun eventp (obj)
53e5a4e8 952 "True if the argument is an event object."
e1894109
SM
953 (when obj
954 (or (integerp obj)
955 (and (symbolp obj) obj (not (keywordp obj)))
956 (and (consp obj) (symbolp (car obj))))))
53e5a4e8
RS
957
958(defun event-modifiers (event)
a3111ae4 959 "Return a list of symbols representing the modifier keys in event EVENT.
53e5a4e8 960The elements of the list may include `meta', `control',
32295976 961`shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
0e91dc92
LT
962and `down'.
963EVENT may be an event or an event type. If EVENT is a symbol
964that has never been used in an event that has been read as input
b1a4f8e1
SM
965in the current Emacs session, then this function may fail to include
966the `click' modifier."
53e5a4e8
RS
967 (let ((type event))
968 (if (listp type)
969 (setq type (car type)))
970 (if (symbolp type)
58da34c7
SM
971 ;; Don't read event-symbol-elements directly since we're not
972 ;; sure the symbol has already been parsed.
973 (cdr (internal-event-symbol-parse-modifiers type))
5572c97f
RS
974 (let ((list nil)
975 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
976 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
977 (if (not (zerop (logand type ?\M-\^@)))
9166dbf6 978 (push 'meta list))
5572c97f
RS
979 (if (or (not (zerop (logand type ?\C-\^@)))
980 (< char 32))
9166dbf6 981 (push 'control list))
5572c97f
RS
982 (if (or (not (zerop (logand type ?\S-\^@)))
983 (/= char (downcase char)))
9166dbf6 984 (push 'shift list))
da16e648 985 (or (zerop (logand type ?\H-\^@))
9166dbf6 986 (push 'hyper list))
da16e648 987 (or (zerop (logand type ?\s-\^@))
9166dbf6 988 (push 'super list))
da16e648 989 (or (zerop (logand type ?\A-\^@))
9166dbf6 990 (push 'alt list))
53e5a4e8
RS
991 list))))
992
d63de416 993(defun event-basic-type (event)
a3111ae4 994 "Return the basic type of the given event (all modifiers removed).
0e91dc92
LT
995The value is a printing character (not upper case) or a symbol.
996EVENT may be an event or an event type. If EVENT is a symbol
997that has never been used in an event that has been read as input
998in the current Emacs session, then this function may return nil."
2b0f4ba5
JB
999 (if (consp event)
1000 (setq event (car event)))
d63de416
RS
1001 (if (symbolp event)
1002 (car (get event 'event-symbol-elements))
9aca2476
RS
1003 (let* ((base (logand event (1- ?\A-\^@)))
1004 (uncontrolled (if (< base 32) (logior base 64) base)))
1005 ;; There are some numbers that are invalid characters and
1006 ;; cause `downcase' to get an error.
1007 (condition-case ()
1008 (downcase uncontrolled)
1009 (error uncontrolled)))))
d63de416 1010
0f03054a
RS
1011(defsubst mouse-movement-p (object)
1012 "Return non-nil if OBJECT is a mouse movement event."
9166dbf6 1013 (eq (car-safe object) 'mouse-movement))
0f03054a 1014
5ad4f91c
SS
1015(defun mouse-event-p (object)
1016 "Return non-nil if OBJECT is a mouse click event."
1017 ;; is this really correct? maybe remove mouse-movement?
1018 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement)))
1019
e1894109 1020(defun event-start (event)
0f03054a 1021 "Return the starting position of EVENT.
41015524
LI
1022EVENT should be a mouse click, drag, or key press event. If
1023EVENT is nil, the value of `posn-at-point' is used instead.
d6d5fdf8
LI
1024
1025The following accessor functions are used to access the elements
1026of the position:
1027
1028`posn-window': The window the event is in.
1029`posn-area': A symbol identifying the area the event occurred in,
1030or nil if the event occurred in the text area.
1031`posn-point': The buffer position of the event.
2baa4c05 1032`posn-x-y': The pixel-based coordinates of the event.
d6d5fdf8
LI
1033`posn-col-row': The estimated column and row corresponding to the
1034position of the event.
1035`posn-actual-col-row': The actual column and row corresponding to the
1036position of the event.
1037`posn-string': The string object of the event, which is either
1038nil or (STRING . POSITION)'.
1039`posn-image': The image object of the event, if any.
1040`posn-object': The image or string object of the event, if any.
1041`posn-timestamp': The time the event occurred, in milliseconds.
1042
1043For more information, see Info node `(elisp)Click Events'."
5ef6a86d 1044 (if (consp event) (nth 1 event)
e1894109
SM
1045 (or (posn-at-point)
1046 (list (selected-window) (point) '(0 . 0) 0))))
0f03054a 1047
e1894109 1048(defun event-end (event)
d6d5fdf8 1049 "Return the ending position of EVENT.
6b61353c 1050EVENT should be a click, drag, or key press event.
d6d5fdf8
LI
1051
1052See `event-start' for a description of the value returned."
5ef6a86d 1053 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
e1894109
SM
1054 (or (posn-at-point)
1055 (list (selected-window) (point) '(0 . 0) 0))))
0f03054a 1056
32295976
RS
1057(defsubst event-click-count (event)
1058 "Return the multi-click count of EVENT, a click or drag event.
1059The return value is a positive integer."
5ef6a86d 1060 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
c4f484f2
RS
1061\f
1062;;;; Extracting fields of the positions in an event.
32295976 1063
e1894109
SM
1064(defun posnp (obj)
1065 "Return non-nil if OBJ appears to be a valid `posn' object."
1066 (and (windowp (car-safe obj))
1067 (atom (car-safe (setq obj (cdr obj)))) ;AREA-OR-POS.
1068 (integerp (car-safe (car-safe (setq obj (cdr obj))))) ;XOFFSET.
1069 (integerp (car-safe (cdr obj))))) ;TIMESTAMP.
1070
0f03054a
RS
1071(defsubst posn-window (position)
1072 "Return the window in POSITION.
6b61353c
KH
1073POSITION should be a list of the form returned by the `event-start'
1074and `event-end' functions."
0f03054a
RS
1075 (nth 0 position))
1076
6b61353c
KH
1077(defsubst posn-area (position)
1078 "Return the window area recorded in POSITION, or nil for the text area.
1079POSITION should be a list of the form returned by the `event-start'
1080and `event-end' functions."
1081 (let ((area (if (consp (nth 1 position))
1082 (car (nth 1 position))
1083 (nth 1 position))))
1084 (and (symbolp area) area)))
1085
9a1ff164 1086(defun posn-point (position)
0f03054a 1087 "Return the buffer location in POSITION.
6b61353c 1088POSITION should be a list of the form returned by the `event-start'
9a1ff164
SM
1089and `event-end' functions.
1090Returns nil if POSITION does not correspond to any buffer location (e.g.
1091a click on a scroll bar)."
6b61353c 1092 (or (nth 5 position)
9a1ff164
SM
1093 (let ((pt (nth 1 position)))
1094 (or (car-safe pt)
1095 ;; Apparently this can also be `vertical-scroll-bar' (bug#13979).
1096 (if (integerp pt) pt)))))
6b61353c
KH
1097
1098(defun posn-set-point (position)
1099 "Move point to POSITION.
1100Select the corresponding window as well."
c8227332
VJL
1101 (if (not (windowp (posn-window position)))
1102 (error "Position not in text area of window"))
1103 (select-window (posn-window position))
1104 (if (numberp (posn-point position))
1105 (goto-char (posn-point position))))
0f03054a 1106
e55c21be
RS
1107(defsubst posn-x-y (position)
1108 "Return the x and y coordinates in POSITION.
74194465
CY
1109The return value has the form (X . Y), where X and Y are given in
1110pixels. POSITION should be a list of the form returned by
1111`event-start' and `event-end'."
0f03054a
RS
1112 (nth 2 position))
1113
aa360da1
GM
1114(declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
1115
ed627e08 1116(defun posn-col-row (position)
6b61353c
KH
1117 "Return the nominal column and row in POSITION, measured in characters.
1118The column and row values are approximations calculated from the x
1119and y coordinates in POSITION and the frame's default character width
859488bf 1120and default line height, including spacing.
ed627e08 1121For a scroll-bar event, the result column is 0, and the row
6b61353c
KH
1122corresponds to the vertical position of the click in the scroll bar.
1123POSITION should be a list of the form returned by the `event-start'
1124and `event-end' functions."
1125 (let* ((pair (posn-x-y position))
1126 (window (posn-window position))
1127 (area (posn-area position)))
1128 (cond
1129 ((null window)
1130 '(0 . 0))
1131 ((eq area 'vertical-scroll-bar)
1132 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
1133 ((eq area 'horizontal-scroll-bar)
1134 (cons (scroll-bar-scale pair (window-width window)) 0))
1135 (t
1136 (let* ((frame (if (framep window) window (window-frame window)))
7beba943
CY
1137 ;; FIXME: This should take line-spacing properties on
1138 ;; newlines into account.
1139 (spacing (when (display-graphic-p frame)
1140 (or (with-current-buffer (window-buffer window)
1141 line-spacing)
1142 (frame-parameter frame 'line-spacing)))))
1143 (cond ((floatp spacing)
1144 (setq spacing (truncate (* spacing
1145 (frame-char-height frame)))))
1146 ((null spacing)
1147 (setq spacing 0)))
1148 (cons (/ (car pair) (frame-char-width frame))
e68afd74 1149 (- (/ (cdr pair) (+ (frame-char-height frame) spacing))
11aad4e9
EZ
1150 (if (null (with-current-buffer (window-buffer window)
1151 header-line-format))
1152 0 1))))))))
6b61353c
KH
1153
1154(defun posn-actual-col-row (position)
1155 "Return the actual column and row in POSITION, measured in characters.
1156These are the actual row number in the window and character number in that row.
1157Return nil if POSITION does not contain the actual position; in that case
1158`posn-col-row' can be used to get approximate values.
1159POSITION should be a list of the form returned by the `event-start'
1160and `event-end' functions."
1161 (nth 6 position))
e55c21be 1162
0f03054a
RS
1163(defsubst posn-timestamp (position)
1164 "Return the timestamp of POSITION.
6b61353c
KH
1165POSITION should be a list of the form returned by the `event-start'
1166and `event-end' functions."
0f03054a 1167 (nth 3 position))
9a5336ae 1168
9a1ff164 1169(defun posn-string (position)
79a09c9c
KS
1170 "Return the string object of POSITION.
1171Value is a cons (STRING . STRING-POS), or nil if not a string.
6b61353c
KH
1172POSITION should be a list of the form returned by the `event-start'
1173and `event-end' functions."
9a1ff164
SM
1174 (let ((x (nth 4 position)))
1175 ;; Apparently this can also be `handle' or `below-handle' (bug#13979).
1176 (when (consp x) x)))
6b61353c
KH
1177
1178(defsubst posn-image (position)
79a09c9c 1179 "Return the image object of POSITION.
0c3f75f6 1180Value is a list (image ...), or nil if not an image.
6b61353c
KH
1181POSITION should be a list of the form returned by the `event-start'
1182and `event-end' functions."
1183 (nth 7 position))
1184
1185(defsubst posn-object (position)
1186 "Return the object (image or string) of POSITION.
79a09c9c
KS
1187Value is a list (image ...) for an image object, a cons cell
1188\(STRING . STRING-POS) for a string object, and nil for a buffer position.
6b61353c
KH
1189POSITION should be a list of the form returned by the `event-start'
1190and `event-end' functions."
1191 (or (posn-image position) (posn-string position)))
1192
1193(defsubst posn-object-x-y (position)
1194 "Return the x and y coordinates relative to the object of POSITION.
74194465
CY
1195The return value has the form (DX . DY), where DX and DY are
1196given in pixels. POSITION should be a list of the form returned
1197by `event-start' and `event-end'."
6b61353c
KH
1198 (nth 8 position))
1199
1200(defsubst posn-object-width-height (position)
1201 "Return the pixel width and height of the object of POSITION.
74194465
CY
1202The return value has the form (WIDTH . HEIGHT). POSITION should
1203be a list of the form returned by `event-start' and `event-end'."
6b61353c
KH
1204 (nth 9 position))
1205
0f03054a 1206\f
9a5336ae
JB
1207;;;; Obsolescent names for functions.
1208
9d28c33e
SM
1209(define-obsolete-function-alias 'window-dot 'window-point "22.1")
1210(define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
1211(define-obsolete-function-alias 'read-input 'read-string "22.1")
1212(define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
1213(define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
1214(define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
1215
9d28c33e 1216(make-obsolete 'forward-point "use (+ (point) N) instead." "23.1")
2a1e2476 1217(make-obsolete 'buffer-has-markers-at nil "24.3")
9d28c33e
SM
1218
1219(defun insert-string (&rest args)
1220 "Mocklisp-compatibility insert function.
1221Like the function `insert' except that any argument that is a number
1222is converted into a string by expressing it in decimal."
59f7af81 1223 (declare (obsolete insert "22.1"))
9d28c33e
SM
1224 (dolist (el args)
1225 (insert (if (integerp el) (number-to-string el) el))))
9d28c33e 1226
59f7af81
CY
1227(defun makehash (&optional test)
1228 (declare (obsolete make-hash-table "22.1"))
1229 (make-hash-table :test (or test 'eql)))
9d28c33e 1230
89561f72
PE
1231(defun log10 (x)
1232 "Return (log X 10), the log base 10 of X."
1233 (declare (obsolete log "24.4"))
1234 (log x 10))
1235
9d28c33e
SM
1236;; These are used by VM and some old programs
1237(defalias 'focus-frame 'ignore "")
1238(make-obsolete 'focus-frame "it does nothing." "22.1")
1239(defalias 'unfocus-frame 'ignore "")
1240(make-obsolete 'unfocus-frame "it does nothing." "22.1")
1241(make-obsolete 'make-variable-frame-local
1242 "explicitly check for a frame-parameter instead." "22.2")
4fcc3d32 1243(set-advertised-calling-convention
f3a30a50
SM
1244 'all-completions '(string collection &optional predicate) "23.1")
1245(set-advertised-calling-convention 'unintern '(name obarray) "23.3")
2a1e2476 1246(set-advertised-calling-convention 'redirect-frame-focus '(frame focus-frame) "24.3")
328a8179
SM
1247(set-advertised-calling-convention 'decode-char '(ch charset) "21.4")
1248(set-advertised-calling-convention 'encode-char '(ch charset) "21.4")
9d28c33e
SM
1249\f
1250;;;; Obsolescence declarations for variables, and aliases.
1251
4e3b4528
SM
1252;; Special "default-FOO" variables which contain the default value of
1253;; the "FOO" variable are nasty. Their implementation is brittle, and
1254;; slows down several unrelated variable operations; furthermore, they
1255;; can lead to really odd behavior if you decide to make them
1256;; buffer-local.
1257
1258;; Not used at all in Emacs, last time I checked:
1259(make-obsolete-variable 'default-mode-line-format 'mode-line-format "23.2")
1260(make-obsolete-variable 'default-header-line-format 'header-line-format "23.2")
1261(make-obsolete-variable 'default-line-spacing 'line-spacing "23.2")
1262(make-obsolete-variable 'default-abbrev-mode 'abbrev-mode "23.2")
1263(make-obsolete-variable 'default-ctl-arrow 'ctl-arrow "23.2")
4e3b4528
SM
1264(make-obsolete-variable 'default-truncate-lines 'truncate-lines "23.2")
1265(make-obsolete-variable 'default-left-margin 'left-margin "23.2")
1266(make-obsolete-variable 'default-tab-width 'tab-width "23.2")
1267(make-obsolete-variable 'default-case-fold-search 'case-fold-search "23.2")
1268(make-obsolete-variable 'default-left-margin-width 'left-margin-width "23.2")
1269(make-obsolete-variable 'default-right-margin-width 'right-margin-width "23.2")
1270(make-obsolete-variable 'default-left-fringe-width 'left-fringe-width "23.2")
1271(make-obsolete-variable 'default-right-fringe-width 'right-fringe-width "23.2")
1272(make-obsolete-variable 'default-fringes-outside-margins 'fringes-outside-margins "23.2")
1273(make-obsolete-variable 'default-scroll-bar-width 'scroll-bar-width "23.2")
1274(make-obsolete-variable 'default-vertical-scroll-bar 'vertical-scroll-bar "23.2")
1275(make-obsolete-variable 'default-indicate-empty-lines 'indicate-empty-lines "23.2")
1276(make-obsolete-variable 'default-indicate-buffer-boundaries 'indicate-buffer-boundaries "23.2")
1277(make-obsolete-variable 'default-fringe-indicator-alist 'fringe-indicator-alist "23.2")
1278(make-obsolete-variable 'default-fringe-cursor-alist 'fringe-cursor-alist "23.2")
1279(make-obsolete-variable 'default-scroll-up-aggressively 'scroll-up-aggressively "23.2")
1280(make-obsolete-variable 'default-scroll-down-aggressively 'scroll-down-aggressively "23.2")
1281(make-obsolete-variable 'default-fill-column 'fill-column "23.2")
1282(make-obsolete-variable 'default-cursor-type 'cursor-type "23.2")
4e3b4528
SM
1283(make-obsolete-variable 'default-cursor-in-non-selected-windows 'cursor-in-non-selected-windows "23.2")
1284(make-obsolete-variable 'default-buffer-file-coding-system 'buffer-file-coding-system "23.2")
1285(make-obsolete-variable 'default-major-mode 'major-mode "23.2")
1286(make-obsolete-variable 'default-enable-multibyte-characters
1287 "use enable-multibyte-characters or set-buffer-multibyte instead" "23.2")
1288
50d4ba39 1289(make-obsolete-variable 'define-key-rebound-commands nil "23.2")
379ec02c 1290(make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
78f64af0
SM
1291(make-obsolete-variable 'deferred-action-list 'post-command-hook "24.1")
1292(make-obsolete-variable 'deferred-action-function 'post-command-hook "24.1")
379ec02c
SM
1293(make-obsolete 'window-redisplay-end-trigger nil "23.1")
1294(make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
1295
1296(make-obsolete 'process-filter-multibyte-p nil "23.1")
1297(make-obsolete 'set-process-filter-multibyte nil "23.1")
1298
8ee7e9db
LT
1299;; Lisp manual only updated in 22.1.
1300(define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
c8227332 1301 "before 19.34")
8ee7e9db 1302
d1069532
SM
1303(define-obsolete-variable-alias 'x-lost-selection-hooks
1304 'x-lost-selection-functions "22.1")
1305(define-obsolete-variable-alias 'x-sent-selection-hooks
1306 'x-sent-selection-functions "22.1")
9e247d24 1307
b46957e2
EZ
1308;; This was introduced in 21.4 for pre-unicode unification. That
1309;; usage was rendered obsolete in 23.1 which uses Unicode internally.
1310;; Other uses are possible, so this variable is not _really_ obsolete,
1311;; but Stefan insists to mark it so.
1312(make-obsolete-variable 'translation-table-for-input nil "23.1")
1313
9e247d24 1314(defvaralias 'messages-buffer-max-lines 'message-log-max)
9a5336ae
JB
1315\f
1316;;;; Alternate names for functions - these are not being phased out.
1317
a18ff988
JB
1318(defalias 'send-string 'process-send-string)
1319(defalias 'send-region 'process-send-region)
059184dd
ER
1320(defalias 'string= 'string-equal)
1321(defalias 'string< 'string-lessp)
1322(defalias 'move-marker 'set-marker)
059184dd
ER
1323(defalias 'rplaca 'setcar)
1324(defalias 'rplacd 'setcdr)
eb8c3be9 1325(defalias 'beep 'ding) ;preserve lingual purity
059184dd
ER
1326(defalias 'indent-to-column 'indent-to)
1327(defalias 'backward-delete-char 'delete-backward-char)
1328(defalias 'search-forward-regexp (symbol-function 're-search-forward))
1329(defalias 'search-backward-regexp (symbol-function 're-search-backward))
1330(defalias 'int-to-string 'number-to-string)
024ae2c6 1331(defalias 'store-match-data 'set-match-data)
e6979067 1332(defalias 'chmod 'set-file-modes)
53374291 1333(defalias 'mkdir 'make-directory)
d6c22d46 1334;; These are the XEmacs names:
475fb2fb
KH
1335(defalias 'point-at-eol 'line-end-position)
1336(defalias 'point-at-bol 'line-beginning-position)
37f6661a 1337
c4f484f2
RS
1338(defalias 'user-original-login-name 'user-login-name)
1339
be9b65ac 1340\f
9a5336ae 1341;;;; Hook manipulation functions.
be9b65ac 1342
0e4d378b 1343(defun add-hook (hook function &optional append local)
32295976
RS
1344 "Add to the value of HOOK the function FUNCTION.
1345FUNCTION is not added if already present.
1346FUNCTION is added (if necessary) at the beginning of the hook list
1347unless the optional argument APPEND is non-nil, in which case
1348FUNCTION is added at the end.
1349
0e4d378b 1350The optional fourth argument, LOCAL, if non-nil, says to modify
465c5fc8
LMI
1351the hook's buffer-local value rather than its global value.
1352This makes the hook buffer-local, and it makes t a member of the
1353buffer-local value. That acts as a flag to run the hook
1354functions of the global value as well as in the local value.
0e4d378b 1355
32295976
RS
1356HOOK should be a symbol, and FUNCTION may be any valid function. If
1357HOOK is void, it is first set to nil. If HOOK's value is a single
aa09b5ca 1358function, it is changed to a list of functions."
be9b65ac 1359 (or (boundp hook) (set hook nil))
0e4d378b 1360 (or (default-boundp hook) (set-default hook nil))
08b1f8a1
GM
1361 (if local (unless (local-variable-if-set-p hook)
1362 (set (make-local-variable hook) (list t)))
8947a5e2
SM
1363 ;; Detect the case where make-local-variable was used on a hook
1364 ;; and do what we used to do.
1365 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
1366 (setq local t)))
1367 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1368 ;; If the hook value is a single function, turn it into a list.
9f25cb77 1369 (when (or (not (listp hook-value)) (functionp hook-value))
2248c40d 1370 (setq hook-value (list hook-value)))
8947a5e2
SM
1371 ;; Do the actual addition if necessary
1372 (unless (member function hook-value)
ff917d63
DN
1373 (when (stringp function)
1374 (setq function (purecopy function)))
8947a5e2
SM
1375 (setq hook-value
1376 (if append
1377 (append hook-value (list function))
1378 (cons function hook-value))))
1379 ;; Set the actual variable
35310461
RS
1380 (if local
1381 (progn
1382 ;; If HOOK isn't a permanent local,
1383 ;; but FUNCTION wants to survive a change of modes,
1384 ;; mark HOOK as partially permanent.
1385 (and (symbolp function)
1386 (get function 'permanent-local-hook)
1387 (not (get hook 'permanent-local))
1388 (put hook 'permanent-local 'permanent-local-hook))
1389 (set hook hook-value))
1390 (set-default hook hook-value))))
0e4d378b
RS
1391
1392(defun remove-hook (hook function &optional local)
24980d16
RS
1393 "Remove from the value of HOOK the function FUNCTION.
1394HOOK should be a symbol, and FUNCTION may be any valid function. If
1395FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
0e4d378b
RS
1396list of hooks to run in HOOK, then nothing is done. See `add-hook'.
1397
1398The optional third argument, LOCAL, if non-nil, says to modify
6b61353c 1399the hook's buffer-local value rather than its default value."
8947a5e2
SM
1400 (or (boundp hook) (set hook nil))
1401 (or (default-boundp hook) (set-default hook nil))
6b61353c
KH
1402 ;; Do nothing if LOCAL is t but this hook has no local binding.
1403 (unless (and local (not (local-variable-p hook)))
8947a5e2
SM
1404 ;; Detect the case where make-local-variable was used on a hook
1405 ;; and do what we used to do.
6b61353c
KH
1406 (when (and (local-variable-p hook)
1407 (not (and (consp (symbol-value hook))
1408 (memq t (symbol-value hook)))))
1409 (setq local t))
1410 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
1411 ;; Remove the function, for both the list and the non-list cases.
1412 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
1413 (if (equal hook-value function) (setq hook-value nil))
1414 (setq hook-value (delete function (copy-sequence hook-value))))
1415 ;; If the function is on the global hook, we need to shadow it locally
1416 ;;(when (and local (member function (default-value hook))
1417 ;; (not (member (cons 'not function) hook-value)))
1418 ;; (push (cons 'not function) hook-value))
1419 ;; Set the actual variable
1420 (if (not local)
1421 (set-default hook hook-value)
1422 (if (equal hook-value '(t))
1423 (kill-local-variable hook)
1424 (set hook hook-value))))))
6e3af630 1425
ba83908c
SM
1426(defmacro letrec (binders &rest body)
1427 "Bind variables according to BINDERS then eval BODY.
1428The value of the last form in BODY is returned.
1429Each element of BINDERS is a list (SYMBOL VALUEFORM) which binds
1430SYMBOL to the value of VALUEFORM.
1431All symbols are bound before the VALUEFORMs are evalled."
1432 ;; Only useful in lexical-binding mode.
1433 ;; As a special-form, we could implement it more efficiently (and cleanly,
1434 ;; making the vars actually unbound during evaluation of the binders).
1435 (declare (debug let) (indent 1))
1436 `(let ,(mapcar #'car binders)
1437 ,@(mapcar (lambda (binder) `(setq ,@binder)) binders)
1438 ,@body))
1439
b1f6fa26
CY
1440(defmacro with-wrapper-hook (hook args &rest body)
1441 "Run BODY, using wrapper functions from HOOK with additional ARGS.
1442HOOK is an abnormal hook. Each hook function in HOOK \"wraps\"
1443around the preceding ones, like a set of nested `around' advices.
1444
1445Each hook function should accept an argument list consisting of a
1446function FUN, followed by the additional arguments in ARGS.
1447
c7291ad9
GM
1448The first hook function in HOOK is passed a FUN that, if it is called
1449with arguments ARGS, performs BODY (i.e., the default operation).
1450The FUN passed to each successive hook function is defined based
1451on the preceding hook functions; if called with arguments ARGS,
1452it does what the `with-wrapper-hook' call would do if the
1453preceding hook functions were the only ones present in HOOK.
1454
1455Each hook function may call its FUN argument as many times as it wishes,
1456including never. In that case, such a hook function acts to replace
1457the default definition altogether, and any preceding hook functions.
1458Of course, a subsequent hook function may do the same thing.
1459
1460Each hook function definition is used to construct the FUN passed
b1f6fa26
CY
1461to the next hook function, if any. The last (or \"outermost\")
1462FUN is then called once."
d36ed1c8 1463 (declare (indent 2) (debug (form sexp body))
84fc911d 1464 (obsolete "use a <foo>-function variable modified by `add-function'."
d36ed1c8 1465 "24.4"))
ba83908c
SM
1466 ;; We need those two gensyms because CL's lexical scoping is not available
1467 ;; for function arguments :-(
1468 (let ((funs (make-symbol "funs"))
1469 (global (make-symbol "global"))
1470 (argssym (make-symbol "args"))
1471 (runrestofhook (make-symbol "runrestofhook")))
1472 ;; Since the hook is a wrapper, the loop has to be done via
1473 ;; recursion: a given hook function will call its parameter in order to
1474 ;; continue looping.
1475 `(letrec ((,runrestofhook
1476 (lambda (,funs ,global ,argssym)
1477 ;; `funs' holds the functions left on the hook and `global'
1478 ;; holds the functions left on the global part of the hook
1479 ;; (in case the hook is local).
1480 (if (consp ,funs)
1481 (if (eq t (car ,funs))
1482 (funcall ,runrestofhook
1483 (append ,global (cdr ,funs)) nil ,argssym)
1484 (apply (car ,funs)
1485 (apply-partially
1486 (lambda (,funs ,global &rest ,argssym)
1487 (funcall ,runrestofhook ,funs ,global ,argssym))
1488 (cdr ,funs) ,global)
1489 ,argssym))
1490 ;; Once there are no more functions on the hook, run
1491 ;; the original body.
1492 (apply (lambda ,args ,@body) ,argssym)))))
b1f6fa26 1493 (funcall ,runrestofhook ,hook
ba83908c 1494 ;; The global part of the hook, if any.
b1f6fa26
CY
1495 ,(if (symbolp hook)
1496 `(if (local-variable-p ',hook)
1497 (default-value ',hook)))
ba83908c
SM
1498 (list ,@args)))))
1499
62e197b1 1500(defun add-to-list (list-var element &optional append compare-fn)
4072ef25 1501 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
1bde5c3b
LI
1502The test for presence of ELEMENT is done with `equal', or with
1503COMPARE-FN if that's non-nil.
c8bfa689
MB
1504If ELEMENT is added, it is added at the beginning of the list,
1505unless the optional argument APPEND is non-nil, in which case
1506ELEMENT is added at the end.
508bcbca 1507
daebae3d
PJ
1508The return value is the new value of LIST-VAR.
1509
bfa3acd6 1510This is handy to add some elements to configuration variables,
1bde5c3b
LI
1511but please do not abuse it in Elisp code, where you are usually
1512better off using `push' or `cl-pushnew'.
1513
1514If you want to use `add-to-list' on a variable that is not
1515defined until a certain package is loaded, you should put the
1516call to `add-to-list' into a hook function that will be run only
1517after loading the package. `eval-after-load' provides one way to
1518do this. In some cases other hooks, such as major mode hooks,
1519can do the job."
bfa3acd6
SM
1520 (declare
1521 (compiler-macro
1522 (lambda (exp)
1523 ;; FIXME: Something like this could be used for `set' as well.
1524 (if (or (not (eq 'quote (car-safe list-var)))
1525 (special-variable-p (cadr list-var))
c43a8618 1526 (not (macroexp-const-p append)))
bfa3acd6
SM
1527 exp
1528 (let* ((sym (cadr list-var))
c43a8618 1529 (append (eval append))
bfa3acd6
SM
1530 (msg (format "`add-to-list' can't use lexical var `%s'; use `push' or `cl-pushnew'"
1531 sym))
1532 ;; Big ugly hack so we only output a warning during
1533 ;; byte-compilation, and so we can use
1534 ;; byte-compile-not-lexical-var-p to silence the warning
1535 ;; when a defvar has been seen but not yet executed.
1536 (warnfun (lambda ()
1537 ;; FIXME: We should also emit a warning for let-bound
1538 ;; variables with dynamic binding.
1539 (when (assq sym byte-compile--lexical-environment)
1540 (byte-compile-log-warning msg t :error))))
1541 (code
c43a8618 1542 (macroexp-let2 macroexp-copyable-p x element
37241f62
SM
1543 `(if ,(if compare-fn
1544 (progn
1545 (require 'cl-lib)
1546 `(cl-member ,x ,sym :test ,compare-fn))
1547 ;; For bootstrapping reasons, don't rely on
1548 ;; cl--compiler-macro-member for the base case.
1549 `(member ,x ,sym))
1550 ,sym
c43a8618
SM
1551 ,(if append
1552 `(setq ,sym (append ,sym (list ,x)))
1553 `(push ,x ,sym))))))
bfa3acd6
SM
1554 (if (not (macroexp--compiling-p))
1555 code
1556 `(progn
1557 (macroexp--funcall-if-compiled ',warnfun)
1558 ,code)))))))
fb1a5d8a 1559 (if (cond
78bdfbf3 1560 ((null compare-fn)
62e197b1 1561 (member element (symbol-value list-var)))
fb1a5d8a
KS
1562 ((eq compare-fn 'eq)
1563 (memq element (symbol-value list-var)))
1564 ((eq compare-fn 'eql)
1565 (memql element (symbol-value list-var)))
78bdfbf3 1566 (t
2d1dd54d
DK
1567 (let ((lst (symbol-value list-var)))
1568 (while (and lst
1569 (not (funcall compare-fn element (car lst))))
1570 (setq lst (cdr lst)))
1571 lst)))
15171a06 1572 (symbol-value list-var)
c8bfa689
MB
1573 (set list-var
1574 (if append
1575 (append (symbol-value list-var) (list element))
1576 (cons element (symbol-value list-var))))))
448a0170 1577
cbbd0b5a
KS
1578
1579(defun add-to-ordered-list (list-var element &optional order)
4072ef25 1580 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
ef1eef06 1581The test for presence of ELEMENT is done with `eq'.
cbbd0b5a
KS
1582
1583The resulting list is reordered so that the elements are in the
ef1eef06
KS
1584order given by each element's numeric list order. Elements
1585without a numeric list order are placed at the end of the list.
cbbd0b5a 1586
4072ef25
LT
1587If the third optional argument ORDER is a number (integer or
1588float), set the element's list order to the given value. If
1589ORDER is nil or omitted, do not change the numeric order of
1590ELEMENT. If ORDER has any other value, remove the numeric order
1591of ELEMENT if it has one.
8da6c2f8 1592
219fd6cf 1593The list order for each element is stored in LIST-VAR's
8da6c2f8 1594`list-order' property.
cbbd0b5a
KS
1595
1596The return value is the new value of LIST-VAR."
219fd6cf
SM
1597 (let ((ordering (get list-var 'list-order)))
1598 (unless ordering
1599 (put list-var 'list-order
1600 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
8da6c2f8 1601 (when order
ef1eef06
KS
1602 (puthash element (and (numberp order) order) ordering))
1603 (unless (memq element (symbol-value list-var))
1604 (set list-var (cons element (symbol-value list-var))))
8da6c2f8
KS
1605 (set list-var (sort (symbol-value list-var)
1606 (lambda (a b)
219fd6cf
SM
1607 (let ((oa (gethash a ordering))
1608 (ob (gethash b ordering)))
ef1eef06
KS
1609 (if (and oa ob)
1610 (< oa ob)
1611 oa)))))))
6b04bd6e 1612
d7494911 1613(defun add-to-history (history-var newelt &optional maxelt keep-all)
6b04bd6e
KS
1614 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
1615Return the new history list.
1616If MAXELT is non-nil, it specifies the maximum length of the history.
1617Otherwise, the maximum history length is the value of the `history-length'
1618property on symbol HISTORY-VAR, if set, or the value of the `history-length'
1619variable.
d7494911
KS
1620Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
1621If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
1622if it is empty or a duplicate."
6b04bd6e
KS
1623 (unless maxelt
1624 (setq maxelt (or (get history-var 'history-length)
1625 history-length)))
1626 (let ((history (symbol-value history-var))
1627 tail)
d7494911
KS
1628 (when (and (listp history)
1629 (or keep-all
1630 (not (stringp newelt))
1631 (> (length newelt) 0))
1632 (or keep-all
1633 (not (equal (car history) newelt))))
1634 (if history-delete-duplicates
1715f2db 1635 (setq history (delete newelt history)))
d7494911
KS
1636 (setq history (cons newelt history))
1637 (when (integerp maxelt)
1638 (if (= 0 maxelt)
1639 (setq history nil)
1640 (setq tail (nthcdr (1- maxelt) history))
1641 (when (consp tail)
1642 (setcdr tail nil)))))
6b04bd6e
KS
1643 (set history-var history)))
1644
c4f484f2
RS
1645\f
1646;;;; Mode hooks.
1647
1648(defvar delay-mode-hooks nil
1649 "If non-nil, `run-mode-hooks' should delay running the hooks.")
1650(defvar delayed-mode-hooks nil
1651 "List of delayed mode hooks waiting to be run.")
1652(make-variable-buffer-local 'delayed-mode-hooks)
1653(put 'delay-mode-hooks 'permanent-local t)
cbbd0b5a 1654
15de15c6
CY
1655(defvar change-major-mode-after-body-hook nil
1656 "Normal hook run in major mode functions, before the mode hooks.")
1657
c4f484f2
RS
1658(defvar after-change-major-mode-hook nil
1659 "Normal hook run at the very end of major mode functions.")
1660
1661(defun run-mode-hooks (&rest hooks)
1662 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
12f381b7
GM
1663If the variable `delay-mode-hooks' is non-nil, does not run any hooks,
1664just adds the HOOKS to the list `delayed-mode-hooks'.
1665Otherwise, runs hooks in the sequence: `change-major-mode-after-body-hook',
1666`delayed-mode-hooks' (in reverse order), HOOKS, and finally
1667`after-change-major-mode-hook'. Major mode functions should use
1668this instead of `run-hooks' when running their FOO-mode-hook."
c4f484f2
RS
1669 (if delay-mode-hooks
1670 ;; Delaying case.
1671 (dolist (hook hooks)
1672 (push hook delayed-mode-hooks))
1673 ;; Normal case, just run the hook as before plus any delayed hooks.
1674 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
1675 (setq delayed-mode-hooks nil)
15de15c6 1676 (apply 'run-hooks (cons 'change-major-mode-after-body-hook hooks))
c4f484f2
RS
1677 (run-hooks 'after-change-major-mode-hook)))
1678
1679(defmacro delay-mode-hooks (&rest body)
1680 "Execute BODY, but delay any `run-mode-hooks'.
1681These hooks will be executed by the first following call to
1682`run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
1683Only affects hooks run in the current buffer."
1684 (declare (debug t) (indent 0))
1685 `(progn
1686 (make-local-variable 'delay-mode-hooks)
1687 (let ((delay-mode-hooks t))
1688 ,@body)))
1689
1690;; PUBLIC: find if the current mode derives from another.
1691
1692(defun derived-mode-p (&rest modes)
1693 "Non-nil if the current major mode is derived from one of MODES.
1694Uses the `derived-mode-parent' property of the symbol to trace backwards."
1695 (let ((parent major-mode))
1696 (while (and (not (memq parent modes))
1697 (setq parent (get parent 'derived-mode-parent))))
1698 parent))
1699\f
1700;;;; Minor modes.
1701
1702;; If a minor mode is not defined with define-minor-mode,
1703;; add it here explicitly.
1704;; isearch-mode is deliberately excluded, since you should
1705;; not call it yourself.
1706(defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
1707 overwrite-mode view-mode
1708 hs-minor-mode)
1709 "List of all minor mode functions.")
1710
1711(defun add-minor-mode (toggle name &optional keymap after toggle-fun)
1712 "Register a new minor mode.
1713
1714This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
1715
1716TOGGLE is a symbol which is the name of a buffer-local variable that
1717is toggled on or off to say whether the minor mode is active or not.
1718
1719NAME specifies what will appear in the mode line when the minor mode
1720is active. NAME should be either a string starting with a space, or a
1721symbol whose value is such a string.
1722
1723Optional KEYMAP is the keymap for the minor mode that will be added
1724to `minor-mode-map-alist'.
1725
1726Optional AFTER specifies that TOGGLE should be added after AFTER
1727in `minor-mode-alist'.
1728
1729Optional TOGGLE-FUN is an interactive function to toggle the mode.
1730It defaults to (and should by convention be) TOGGLE.
1731
1732If TOGGLE has a non-nil `:included' property, an entry for the mode is
1733included in the mode-line minor mode menu.
1734If TOGGLE has a `:menu-tag', that is used for the menu item's label."
1735 (unless (memq toggle minor-mode-list)
1736 (push toggle minor-mode-list))
1737
1738 (unless toggle-fun (setq toggle-fun toggle))
1739 (unless (eq toggle-fun toggle)
1740 (put toggle :minor-mode-function toggle-fun))
1741 ;; Add the name to the minor-mode-alist.
1742 (when name
1743 (let ((existing (assq toggle minor-mode-alist)))
1744 (if existing
1745 (setcdr existing (list name))
1746 (let ((tail minor-mode-alist) found)
1747 (while (and tail (not found))
1748 (if (eq after (caar tail))
1749 (setq found tail)
1750 (setq tail (cdr tail))))
1751 (if found
1752 (let ((rest (cdr found)))
1753 (setcdr found nil)
1754 (nconc found (list (list toggle name)) rest))
365f8d85 1755 (push (list toggle name) minor-mode-alist))))))
c4f484f2
RS
1756 ;; Add the toggle to the minor-modes menu if requested.
1757 (when (get toggle :included)
1758 (define-key mode-line-mode-menu
1759 (vector toggle)
1760 (list 'menu-item
1761 (concat
1762 (or (get toggle :menu-tag)
1763 (if (stringp name) name (symbol-name toggle)))
1764 (let ((mode-name (if (symbolp name) (symbol-value name))))
1765 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
1766 (concat " (" (match-string 0 mode-name) ")"))))
1767 toggle-fun
1768 :button (cons :toggle toggle))))
cbbd0b5a 1769
c4f484f2
RS
1770 ;; Add the map to the minor-mode-map-alist.
1771 (when keymap
1772 (let ((existing (assq toggle minor-mode-map-alist)))
1773 (if existing
1774 (setcdr existing keymap)
1775 (let ((tail minor-mode-map-alist) found)
1776 (while (and tail (not found))
1777 (if (eq after (caar tail))
1778 (setq found tail)
1779 (setq tail (cdr tail))))
1780 (if found
1781 (let ((rest (cdr found)))
1782 (setcdr found nil)
1783 (nconc found (list (cons toggle keymap)) rest))
365f8d85 1784 (push (cons toggle keymap) minor-mode-map-alist)))))))
448a0170 1785\f
781b4af6 1786;;;; Load history
448a0170 1787
7abaf5cc
SM
1788(defsubst autoloadp (object)
1789 "Non-nil if OBJECT is an autoload."
1790 (eq 'autoload (car-safe object)))
1791
1792;; (defun autoload-type (object)
1793;; "Returns the type of OBJECT or `function' or `command' if the type is nil.
1794;; OBJECT should be an autoload object."
1795;; (when (autoloadp object)
1796;; (let ((type (nth 3 object)))
1797;; (cond ((null type) (if (nth 2 object) 'command 'function))
1798;; ((eq 'keymap t) 'macro)
1799;; (type)))))
1800
1801;; (defalias 'autoload-file #'cadr
1802;; "Return the name of the file from which AUTOLOAD will be loaded.
1803;; \n\(fn AUTOLOAD)")
1804
9e247d24 1805(defun symbol-file (symbol &optional type)
37fda77e
MR
1806 "Return the name of the file that defined SYMBOL.
1807The value is normally an absolute file name. It can also be nil,
1808if the definition is not associated with any file. If SYMBOL
1809specifies an autoloaded function, the value can be a relative
1810file name without extension.
1811
1812If TYPE is nil, then any kind of definition is acceptable. If
1813TYPE is `defun', `defvar', or `defface', that specifies function
1814definition, variable definition, or face definition only."
9e247d24 1815 (if (and (or (null type) (eq type 'defun))
6bdd9204 1816 (symbolp symbol)
7abaf5cc 1817 (autoloadp (symbol-function symbol)))
9e247d24 1818 (nth 1 (symbol-function symbol))
e9f13a95 1819 (let ((files load-history)
cb21744e 1820 file)
e9f13a95 1821 (while files
9e247d24
RS
1822 (if (if type
1823 (if (eq type 'defvar)
1824 ;; Variables are present just as their names.
1825 (member symbol (cdr (car files)))
1826 ;; Other types are represented as (TYPE . NAME).
1827 (member (cons type symbol) (cdr (car files))))
1828 ;; We accept all types, so look for variable def
1829 ;; and then for any other kind.
1830 (or (member symbol (cdr (car files)))
1831 (rassq symbol (cdr (car files)))))
e9f13a95
SM
1832 (setq file (car (car files)) files nil))
1833 (setq files (cdr files)))
1834 file)))
448a0170 1835
059a552c
RF
1836(defun locate-library (library &optional nosuffix path interactive-call)
1837 "Show the precise file name of Emacs library LIBRARY.
c9ae6ddd
EZ
1838LIBRARY should be a relative file name of the library, a string.
1839It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is
1840nil (which is the default, see below).
059a552c
RF
1841This command searches the directories in `load-path' like `\\[load-library]'
1842to find the file that `\\[load-library] RET LIBRARY RET' would load.
1843Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
1844to the specified name LIBRARY.
1845
1846If the optional third arg PATH is specified, that list of directories
1847is used instead of `load-path'.
1848
3ac9d254 1849When called from a program, the file name is normally returned as a
059a552c
RF
1850string. When run interactively, the argument INTERACTIVE-CALL is t,
1851and the file name is displayed in the echo area."
1852 (interactive (list (completing-read "Locate library: "
6a021917
SM
1853 (apply-partially
1854 'locate-file-completion-table
1855 load-path (get-load-suffixes)))
059a552c
RF
1856 nil nil
1857 t))
1858 (let ((file (locate-file library
1859 (or path load-path)
667b73dc
LT
1860 (append (unless nosuffix (get-load-suffixes))
1861 load-file-rep-suffixes))))
059a552c
RF
1862 (if interactive-call
1863 (if file
1864 (message "Library is file %s" (abbreviate-file-name file))
1865 (message "No library %s in search path" library)))
1866 file))
1867
be9b65ac 1868\f
c4f484f2
RS
1869;;;; Process stuff.
1870
d43c8d03
GM
1871(defun process-lines (program &rest args)
1872 "Execute PROGRAM with ARGS, returning its output as a list of lines.
1873Signal an error if the program returns with a non-zero exit status."
1874 (with-temp-buffer
1875 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
1876 (unless (eq status 0)
1877 (error "%s exited with status %s" program status))
1878 (goto-char (point-min))
1879 (let (lines)
1880 (while (not (eobp))
1881 (setq lines (cons (buffer-substring-no-properties
1882 (line-beginning-position)
1883 (line-end-position))
1884 lines))
1885 (forward-line 1))
1886 (nreverse lines)))))
1887
b96e6cde 1888(defun process-live-p (process)
bcd54f83
LMI
1889 "Returns non-nil if PROCESS is alive.
1890A process is considered alive if its status is `run', `open',
0518b057
LL
1891`listen', `connect' or `stop'. Value is nil if PROCESS is not a
1892process."
1893 (and (processp process)
1894 (memq (process-status process)
1895 '(run open listen connect stop))))
bcd54f83 1896
7aaacaff
RS
1897;; compatibility
1898
c8227332
VJL
1899(make-obsolete
1900 'process-kill-without-query
1901 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
1902 "22.1")
06b60517 1903(defun process-kill-without-query (process &optional _flag)
7aaacaff
RS
1904 "Say no query needed if PROCESS is running when Emacs is exited.
1905Optional second argument if non-nil says to require a query.
a478f3e1 1906Value is t if a query was formerly required."
7aaacaff
RS
1907 (let ((old (process-query-on-exit-flag process)))
1908 (set-process-query-on-exit-flag process nil)
1909 old))
9a5336ae 1910
d842b103
JL
1911(defun process-kill-buffer-query-function ()
1912 "Ask before killing a buffer that has a running process."
1913 (let ((process (get-buffer-process (current-buffer))))
1914 (or (not process)
1915 (not (memq (process-status process) '(run stop open listen)))
1916 (not (process-query-on-exit-flag process))
da9fcb93
LMI
1917 (yes-or-no-p
1918 (format "Buffer %S has a running process; kill it? "
1919 (buffer-name (current-buffer)))))))
d842b103
JL
1920
1921(add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function)
1922
34368d12
KS
1923;; process plist management
1924
1925(defun process-get (process propname)
1926 "Return the value of PROCESS' PROPNAME property.
1927This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
1928 (plist-get (process-plist process) propname))
1929
1930(defun process-put (process propname value)
1931 "Change PROCESS' PROPNAME property to VALUE.
1932It can be retrieved with `(process-get PROCESS PROPNAME)'."
f1180544 1933 (set-process-plist process
34368d12
KS
1934 (plist-put (process-plist process) propname value)))
1935
9a5336ae
JB
1936\f
1937;;;; Input and display facilities.
1938
03a74b84
SM
1939(defconst read-key-empty-map (make-sparse-keymap))
1940
79bd5ba1 1941(defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully.
03a74b84
SM
1942
1943(defun read-key (&optional prompt)
1944 "Read a key from the keyboard.
1945Contrary to `read-event' this will not return a raw event but instead will
1946obey the input decoding and translations usually done by `read-key-sequence'.
1947So escape sequences and keyboard encoding are taken into account.
1948When there's an ambiguity because the key looks like the prefix of
1949some sort of escape sequence, the ambiguity is resolved via `read-key-delay'."
088be6fb
SM
1950 ;; This overriding-terminal-local-map binding also happens to
1951 ;; disable quail's input methods, so although read-key-sequence
1952 ;; always inherits the input method, in practice read-key does not
1953 ;; inherit the input method (at least not if it's based on quail).
bfa3acd6
SM
1954 (let ((overriding-terminal-local-map nil)
1955 (overriding-local-map read-key-empty-map)
3ff78624 1956 (echo-keystrokes 0)
03a74b84
SM
1957 (old-global-map (current-global-map))
1958 (timer (run-with-idle-timer
1959 ;; Wait long enough that Emacs has the time to receive and
1960 ;; process all the raw events associated with the single-key.
1961 ;; But don't wait too long, or the user may find the delay
1962 ;; annoying (or keep hitting more keys which may then get
1963 ;; lost or misinterpreted).
1964 ;; This is only relevant for keys which Emacs perceives as
1965 ;; "prefixes", such as C-x (because of the C-x 8 map in
1966 ;; key-translate-table and the C-x @ map in function-key-map)
1967 ;; or ESC (because of terminal escape sequences in
1968 ;; input-decode-map).
1969 read-key-delay t
1970 (lambda ()
1971 (let ((keys (this-command-keys-vector)))
1972 (unless (zerop (length keys))
1973 ;; `keys' is non-empty, so the user has hit at least
1974 ;; one key; there's no point waiting any longer, even
1975 ;; though read-key-sequence thinks we should wait
1976 ;; for more input to decide how to interpret the
1977 ;; current input.
1978 (throw 'read-key keys)))))))
1979 (unwind-protect
1980 (progn
186e86db
SM
1981 (use-global-map
1982 (let ((map (make-sparse-keymap)))
1983 ;; Don't hide the menu-bar and tool-bar entries.
1984 (define-key map [menu-bar] (lookup-key global-map [menu-bar]))
c5bb7569
CY
1985 (define-key map [tool-bar]
1986 ;; This hack avoids evaluating the :filter (Bug#9922).
1987 (or (cdr (assq 'tool-bar global-map))
1988 (lookup-key global-map [tool-bar])))
186e86db 1989 map))
79bd5ba1 1990 (aref (catch 'read-key (read-key-sequence-vector prompt nil t)) 0))
03a74b84
SM
1991 (cancel-timer timer)
1992 (use-global-map old-global-map))))
1993
795b1482
SM
1994(defvar read-passwd-map
1995 ;; BEWARE: `defconst' would purecopy it, breaking the sharing with
1996 ;; minibuffer-local-map along the way!
d39109c3
SM
1997 (let ((map (make-sparse-keymap)))
1998 (set-keymap-parent map minibuffer-local-map)
1999 (define-key map "\C-u" #'delete-minibuffer-contents) ;bug#12570
2000 map)
2001 "Keymap used while reading passwords.")
2002
266725f1
SJ
2003(defun read-passwd (prompt &optional confirm default)
2004 "Read a password, prompting with PROMPT, and return it.
2005If optional CONFIRM is non-nil, read the password twice to make sure.
2006Optional DEFAULT is a default password to use instead of empty input.
2007
2008This function echoes `.' for each character that the user types.
64c35331 2009Note that in batch mode, the input is not hidden!
08640de5 2010
266725f1
SJ
2011Once the caller uses the password, it can erase the password
2012by doing (clear-string STRING)."
088be6fb
SM
2013 (if confirm
2014 (let (success)
2015 (while (not success)
2016 (let ((first (read-passwd prompt nil default))
2017 (second (read-passwd "Confirm password: " nil default)))
2018 (if (equal first second)
2019 (progn
2020 (and (arrayp second) (clear-string second))
2021 (setq success first))
2022 (and (arrayp first) (clear-string first))
2023 (and (arrayp second) (clear-string second))
2024 (message "Password not repeated accurately; please start over")
2025 (sit-for 1))))
2026 success)
99d27583
SM
2027 (let ((hide-chars-fun
2028 (lambda (beg end _len)
2029 (clear-this-command-keys)
2030 (setq beg (min end (max (minibuffer-prompt-end)
2031 beg)))
2032 (dotimes (i (- end beg))
2033 (put-text-property (+ i beg) (+ 1 i beg)
2034 'display (string ?.)))))
2035 minibuf)
088be6fb
SM
2036 (minibuffer-with-setup-hook
2037 (lambda ()
2038 (setq minibuf (current-buffer))
2039 ;; Turn off electricity.
795b1482
SM
2040 (setq-local post-self-insert-hook nil)
2041 (setq-local buffer-undo-list t)
2042 (setq-local select-active-regions nil)
d39109c3 2043 (use-local-map read-passwd-map)
258ab3bc 2044 (setq-local inhibit-modification-hooks nil) ;bug#15501.
d64643b4 2045 (setq-local show-paren-mode nil) ;bug#16091.
99d27583 2046 (add-hook 'after-change-functions hide-chars-fun nil 'local))
088be6fb 2047 (unwind-protect
d39109c3 2048 (let ((enable-recursive-minibuffers t))
64c35331
GM
2049 (read-string
2050 (if noninteractive
2051 (format "%s[INPUT WILL NOT BE HIDDEN!] " prompt) ; bug#17839
2052 prompt)
2053 nil t default)) ; t = "no history"
088be6fb 2054 (when (buffer-live-p minibuf)
99d27583
SM
2055 (with-current-buffer minibuf
2056 ;; Not sure why but it seems that there might be cases where the
2057 ;; minibuffer is not always properly reset later on, so undo
2058 ;; whatever we've done here (bug#11392).
2059 (remove-hook 'after-change-functions hide-chars-fun 'local)
2060 (kill-local-variable 'post-self-insert-hook)
2061 ;; And of course, don't keep the sensitive data around.
2062 (erase-buffer))))))))
266725f1 2063
6b61353c 2064(defun read-number (prompt &optional default)
3238cde3
RS
2065 "Read a numeric value in the minibuffer, prompting with PROMPT.
2066DEFAULT specifies a default value to return if the user just types RET.
0208ede7
JL
2067The value of DEFAULT is inserted into PROMPT.
2068This function is used by the `interactive' code letter `n'."
a5dcc929
JL
2069 (let ((n nil)
2070 (default1 (if (consp default) (car default) default)))
2071 (when default1
6b61353c 2072 (setq prompt
2d14d61e 2073 (if (string-match "\\(\\):[ \t]*\\'" prompt)
a5dcc929 2074 (replace-match (format " (default %s)" default1) t t prompt 1)
2d14d61e 2075 (replace-regexp-in-string "[ \t]*\\'"
a5dcc929 2076 (format " (default %s) " default1)
f8cf33b1 2077 prompt t t))))
6b61353c
KH
2078 (while
2079 (progn
a5dcc929
JL
2080 (let ((str (read-from-minibuffer
2081 prompt nil nil nil nil
2082 (when default
2083 (if (consp default)
2084 (mapcar 'number-to-string (delq nil default))
2085 (number-to-string default))))))
219f06f7
RS
2086 (condition-case nil
2087 (setq n (cond
a5dcc929 2088 ((zerop (length str)) default1)
e5271cf2 2089 ((stringp str) (read str))))
219f06f7 2090 (error nil)))
6b61353c
KH
2091 (unless (numberp n)
2092 (message "Please enter a number.")
2093 (sit-for 1)
2094 t)))
2095 n))
0369eb85 2096
3ef01959
CY
2097(defun read-char-choice (prompt chars &optional inhibit-keyboard-quit)
2098 "Read and return one of CHARS, prompting for PROMPT.
2099Any input that is not one of CHARS is ignored.
2100
2101If optional argument INHIBIT-KEYBOARD-QUIT is non-nil, ignore
2102keyboard-quit events while waiting for a valid input."
2103 (unless (consp chars)
2104 (error "Called `read-char-choice' without valid char choices"))
03ea5b87 2105 (let (char done show-help (helpbuf " *Char Help*"))
49c5410a 2106 (let ((cursor-in-echo-area t)
145823ec
CY
2107 (executing-kbd-macro executing-kbd-macro)
2108 (esc-flag nil))
03ea5b87
GM
2109 (save-window-excursion ; in case we call help-form-show
2110 (while (not done)
2111 (unless (get-text-property 0 'face prompt)
2112 (setq prompt (propertize prompt 'face 'minibuffer-prompt)))
2113 (setq char (let ((inhibit-quit inhibit-keyboard-quit))
2114 (read-key prompt)))
647ab967 2115 (and show-help (buffer-live-p (get-buffer helpbuf))
03ea5b87
GM
2116 (kill-buffer helpbuf))
2117 (cond
2118 ((not (numberp char)))
2119 ;; If caller has set help-form, that's enough.
2120 ;; They don't explicitly have to add help-char to chars.
2121 ((and help-form
2122 (eq char help-char)
2123 (setq show-help t)
2124 (help-form-show)))
2125 ((memq char chars)
2126 (setq done t))
2127 ((and executing-kbd-macro (= char -1))
2128 ;; read-event returns -1 if we are in a kbd macro and
2129 ;; there are no more events in the macro. Attempt to
2130 ;; get an event interactively.
2131 (setq executing-kbd-macro nil))
145823ec
CY
2132 ((not inhibit-keyboard-quit)
2133 (cond
2134 ((and (null esc-flag) (eq char ?\e))
2135 (setq esc-flag t))
2136 ((memq char '(?\C-g ?\e))
2137 (keyboard-quit))))))))
49c5410a 2138 ;; Display the question with the answer. But without cursor-in-echo-area.
3ef01959
CY
2139 (message "%s%s" prompt (char-to-string char))
2140 char))
2141
0369eb85
CY
2142(defun sit-for (seconds &optional nodisp obsolete)
2143 "Perform redisplay, then wait for SECONDS seconds or until input is available.
2144SECONDS may be a floating-point value.
2145\(On operating systems that do not support waiting for fractions of a
2146second, floating-point values are rounded down to the nearest integer.)
2147
2148If optional arg NODISP is t, don't redisplay, just wait for input.
2149Redisplay does not happen if input is available before it starts.
0369eb85
CY
2150
2151Value is t if waited the full time with no input arriving, and nil otherwise.
2152
d8120806 2153An obsolete, but still supported form is
0369eb85 2154\(sit-for SECONDS &optional MILLISECONDS NODISP)
d8120806 2155where the optional arg MILLISECONDS specifies an additional wait period,
0369eb85 2156in milliseconds; this was useful when Emacs was built without
fd6c5134 2157floating point support."
321e1a9c 2158 (declare (advertised-calling-convention (seconds &optional nodisp) "22.1"))
b701ac49
SM
2159 ;; This used to be implemented in C until the following discussion:
2160 ;; http://lists.gnu.org/archive/html/emacs-devel/2006-07/msg00401.html
2161 ;; Then it was moved to C using an implementation based on an idle timer,
2162 ;; which was then replaced by the use of read-event.
000b06df
GM
2163 (if (numberp nodisp)
2164 (setq seconds (+ seconds (* 1e-3 nodisp))
2165 nodisp obsolete)
2166 (if obsolete (setq nodisp obsolete)))
790e0ef7
KS
2167 (cond
2168 (noninteractive
2169 (sleep-for seconds)
2170 t)
ef566920 2171 ((input-pending-p t)
790e0ef7
KS
2172 nil)
2173 ((<= seconds 0)
2174 (or nodisp (redisplay)))
2175 (t
2176 (or nodisp (redisplay))
321e1a9c
SM
2177 ;; FIXME: we should not read-event here at all, because it's much too
2178 ;; difficult to reliably "undo" a read-event by pushing it onto
2179 ;; unread-command-events.
2f8165f4
SM
2180 ;; For bug#14782, we need read-event to do the keyboard-coding-system
2181 ;; decoding (hence non-nil as second arg under POSIX ttys).
2182 ;; For bug#15614, we need read-event not to inherit-input-method.
2183 ;; So we temporarily suspend input-method-function.
2184 (let ((read (let ((input-method-function nil))
2185 (read-event nil t seconds))))
790e0ef7 2186 (or (null read)
fb1a5d8a
KS
2187 (progn
2188 ;; If last command was a prefix arg, e.g. C-u, push this event onto
2189 ;; unread-command-events as (t . EVENT) so it will be added to
2190 ;; this-command-keys by read-key-sequence.
2191 (if (eq overriding-terminal-local-map universal-argument-map)
2192 (setq read (cons t read)))
2193 (push read unread-command-events)
2194 nil))))))
8c51d2a2 2195
d2f3e9f8 2196;; Behind display-popup-menus-p test.
cc0f2ece 2197(declare-function x-popup-dialog "menu.c" (position contents &optional header))
d2f3e9f8 2198
9aea757b 2199(defun y-or-n-p (prompt)
8c51d2a2 2200 "Ask user a \"y or n\" question. Return t if answer is \"y\".
9aea757b
CY
2201PROMPT is the string to display to ask the question. It should
2202end in a space; `y-or-n-p' adds \"(y or n) \" to it.
3d91e302 2203
011474aa
CY
2204No confirmation of the answer is requested; a single character is
2205enough. SPC also means yes, and DEL means no.
2206
2207To be precise, this function translates user input into responses
2208by consulting the bindings in `query-replace-map'; see the
2209documentation of that variable for more information. In this
2210case, the useful bindings are `act', `skip', `recenter',
2211`scroll-up', `scroll-down', and `quit'.
2212An `act' response means yes, and a `skip' response means no.
2213A `quit' response means to invoke `keyboard-quit'.
2214If the user enters `recenter', `scroll-up', or `scroll-down'
2215responses, perform the requested window recentering or scrolling
2216and ask again.
8c51d2a2
CY
2217
2218Under a windowing system a dialog box will be used if `last-nonmenu-event'
2219is nil and `use-dialog-box' is non-nil."
2220 ;; ¡Beware! when I tried to edebug this code, Emacs got into a weird state
2221 ;; where all the keys were unbound (i.e. it somehow got triggered
2222 ;; within read-key, apparently). I had to kill it.
298520df
JB
2223 (let ((answer 'recenter)
2224 (padded (lambda (prompt &optional dialog)
2225 (let ((l (length prompt)))
2226 (concat prompt
2227 (if (or (zerop l) (eq ?\s (aref prompt (1- l))))
2228 "" " ")
2229 (if dialog "" "(y or n) "))))))
aa4de341
CY
2230 (cond
2231 (noninteractive
298520df 2232 (setq prompt (funcall padded prompt))
aa4de341
CY
2233 (let ((temp-prompt prompt))
2234 (while (not (memq answer '(act skip)))
2235 (let ((str (read-string temp-prompt)))
2236 (cond ((member str '("y" "Y")) (setq answer 'act))
2237 ((member str '("n" "N")) (setq answer 'skip))
2238 (t (setq temp-prompt (concat "Please answer y or n. "
2239 prompt))))))))
2240 ((and (display-popup-menus-p)
2241 (listp last-nonmenu-event)
2242 use-dialog-box)
298520df
JB
2243 (setq prompt (funcall padded prompt t)
2244 answer (x-popup-dialog t `(,prompt ("Yes" . act) ("No" . skip)))))
aa4de341 2245 (t
298520df 2246 (setq prompt (funcall padded prompt))
8c51d2a2 2247 (while
011474aa
CY
2248 (let* ((scroll-actions '(recenter scroll-up scroll-down
2249 scroll-other-window scroll-other-window-down))
2250 (key
8c51d2a2
CY
2251 (let ((cursor-in-echo-area t))
2252 (when minibuffer-auto-raise
2253 (raise-frame (window-frame (minibuffer-window))))
011474aa 2254 (read-key (propertize (if (memq answer scroll-actions)
8c51d2a2
CY
2255 prompt
2256 (concat "Please answer y or n. "
2257 prompt))
2258 'face 'minibuffer-prompt)))))
2259 (setq answer (lookup-key query-replace-map (vector key) t))
2260 (cond
011474aa
CY
2261 ((memq answer '(skip act)) nil)
2262 ((eq answer 'recenter)
2263 (recenter) t)
2264 ((eq answer 'scroll-up)
2265 (ignore-errors (scroll-up-command)) t)
2266 ((eq answer 'scroll-down)
2267 (ignore-errors (scroll-down-command)) t)
2268 ((eq answer 'scroll-other-window)
2269 (ignore-errors (scroll-other-window)) t)
2270 ((eq answer 'scroll-other-window-down)
2271 (ignore-errors (scroll-other-window-down)) t)
2272 ((or (memq answer '(exit-prefix quit)) (eq key ?\e))
2273 (signal 'quit nil) t)
2274 (t t)))
8c51d2a2 2275 (ding)
aa4de341 2276 (discard-input))))
8c51d2a2
CY
2277 (let ((ret (eq answer 'act)))
2278 (unless noninteractive
298520df 2279 (message "%s%c" prompt (if ret ?y ?n)))
8c51d2a2
CY
2280 ret)))
2281
e0e4cb7a 2282\f
2493767e
RS
2283;;; Atomic change groups.
2284
69cae2d4
RS
2285(defmacro atomic-change-group (&rest body)
2286 "Perform BODY as an atomic change group.
2287This means that if BODY exits abnormally,
2288all of its changes to the current buffer are undone.
b9ab4064 2289This works regardless of whether undo is enabled in the buffer.
69cae2d4
RS
2290
2291This mechanism is transparent to ordinary use of undo;
2292if undo is enabled in the buffer and BODY succeeds, the
2293user can undo the change normally."
6273dc68 2294 (declare (indent 0) (debug t))
69cae2d4
RS
2295 (let ((handle (make-symbol "--change-group-handle--"))
2296 (success (make-symbol "--change-group-success--")))
2297 `(let ((,handle (prepare-change-group))
cf191706
RS
2298 ;; Don't truncate any undo data in the middle of this.
2299 (undo-outer-limit nil)
2300 (undo-limit most-positive-fixnum)
2301 (undo-strong-limit most-positive-fixnum)
69cae2d4
RS
2302 (,success nil))
2303 (unwind-protect
2304 (progn
2305 ;; This is inside the unwind-protect because
2306 ;; it enables undo if that was disabled; we need
2307 ;; to make sure that it gets disabled again.
2308 (activate-change-group ,handle)
2309 ,@body
2310 (setq ,success t))
2311 ;; Either of these functions will disable undo
2312 ;; if it was disabled before.
2313 (if ,success
2314 (accept-change-group ,handle)
2315 (cancel-change-group ,handle))))))
2316
62ea1306 2317(defun prepare-change-group (&optional buffer)
69cae2d4 2318 "Return a handle for the current buffer's state, for a change group.
62ea1306 2319If you specify BUFFER, make a handle for BUFFER's state instead.
69cae2d4
RS
2320
2321Pass the handle to `activate-change-group' afterward to initiate
2322the actual changes of the change group.
2323
2324To finish the change group, call either `accept-change-group' or
2325`cancel-change-group' passing the same handle as argument. Call
2326`accept-change-group' to accept the changes in the group as final;
2327call `cancel-change-group' to undo them all. You should use
2328`unwind-protect' to make sure the group is always finished. The call
2329to `activate-change-group' should be inside the `unwind-protect'.
2330Once you finish the group, don't use the handle again--don't try to
2331finish the same group twice. For a simple example of correct use, see
2332the source code of `atomic-change-group'.
2333
2334The handle records only the specified buffer. To make a multibuffer
2335change group, call this function once for each buffer you want to
2336cover, then use `nconc' to combine the returned values, like this:
2337
2338 (nconc (prepare-change-group buffer-1)
2339 (prepare-change-group buffer-2))
2340
2341You can then activate that multibuffer change group with a single
2342call to `activate-change-group' and finish it with a single call
2343to `accept-change-group' or `cancel-change-group'."
2344
62ea1306
RS
2345 (if buffer
2346 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
2347 (list (cons (current-buffer) buffer-undo-list))))
69cae2d4
RS
2348
2349(defun activate-change-group (handle)
2350 "Activate a change group made with `prepare-change-group' (which see)."
2351 (dolist (elt handle)
2352 (with-current-buffer (car elt)
2353 (if (eq buffer-undo-list t)
2354 (setq buffer-undo-list nil)))))
2355
2356(defun accept-change-group (handle)
2357 "Finish a change group made with `prepare-change-group' (which see).
2358This finishes the change group by accepting its changes as final."
2359 (dolist (elt handle)
2360 (with-current-buffer (car elt)
7511ded8 2361 (if (eq (cdr elt) t)
69cae2d4
RS
2362 (setq buffer-undo-list t)))))
2363
2364(defun cancel-change-group (handle)
2365 "Finish a change group made with `prepare-change-group' (which see).
2366This finishes the change group by reverting all of its changes."
2367 (dolist (elt handle)
2368 (with-current-buffer (car elt)
2369 (setq elt (cdr elt))
d21cba62
MR
2370 (save-restriction
2371 ;; Widen buffer temporarily so if the buffer was narrowed within
2372 ;; the body of `atomic-change-group' all changes can be undone.
2373 (widen)
2374 (let ((old-car
2375 (if (consp elt) (car elt)))
2376 (old-cdr
2377 (if (consp elt) (cdr elt))))
2378 ;; Temporarily truncate the undo log at ELT.
2379 (when (consp elt)
2380 (setcar elt nil) (setcdr elt nil))
2381 (unless (eq last-command 'undo) (undo-start))
2382 ;; Make sure there's no confusion.
2383 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
2384 (error "Undoing to some unrelated state"))
2385 ;; Undo it all.
2386 (save-excursion
2387 (while (listp pending-undo-list) (undo-more 1)))
2388 ;; Reset the modified cons cell ELT to its original content.
2389 (when (consp elt)
2390 (setcar elt old-car)
2391 (setcdr elt old-cdr))
2392 ;; Revert the undo info to what it was when we grabbed the state.
2393 (setq buffer-undo-list elt))))))
69cae2d4 2394\f
c4f484f2
RS
2395;;;; Display-related functions.
2396
a9d956be 2397;; For compatibility.
37269466 2398(define-obsolete-function-alias 'redraw-modeline
2a1e2476 2399 'force-mode-line-update "24.3")
a9d956be 2400
aa3b4ded 2401(defun momentary-string-display (string pos &optional exit-char message)
be9b65ac 2402 "Momentarily display STRING in the buffer at POS.
12092fb3 2403Display remains until next event is input.
dbf284be 2404If POS is a marker, only its position is used; its buffer is ignored.
12092fb3
EZ
2405Optional third arg EXIT-CHAR can be a character, event or event
2406description list. EXIT-CHAR defaults to SPC. If the input is
2407EXIT-CHAR it is swallowed; otherwise it is then available as
2408input (as a command if nothing else).
be9b65ac
DL
2409Display MESSAGE (optional fourth arg) in the echo area.
2410If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
b754307b 2411 (or exit-char (setq exit-char ?\s))
f70c4736 2412 (let ((ol (make-overlay pos pos))
bc91aee9 2413 (str (copy-sequence string)))
be9b65ac 2414 (unwind-protect
f70c4736
SM
2415 (progn
2416 (save-excursion
bc91aee9 2417 (overlay-put ol 'after-string str)
f70c4736
SM
2418 (goto-char pos)
2419 ;; To avoid trouble with out-of-bounds position
2420 (setq pos (point))
bc91aee9 2421 ;; If the string end is off screen, recenter now.
f70c4736
SM
2422 (if (<= (window-end nil t) pos)
2423 (recenter (/ (window-height) 2))))
2424 (message (or message "Type %s to continue editing.")
2425 (single-key-description exit-char))
321e1a9c 2426 (let ((event (read-key)))
fe40dc63
JB
2427 ;; `exit-char' can be an event, or an event description list.
2428 (or (eq event exit-char)
2429 (eq event (event-convert-list exit-char))
321e1a9c
SM
2430 (setq unread-command-events
2431 (append (this-single-command-raw-keys))))))
f70c4736 2432 (delete-overlay ol))))
be9b65ac 2433
9a5336ae 2434\f
aa3b4ded
SM
2435;;;; Overlay operations
2436
2437(defun copy-overlay (o)
2438 "Return a copy of overlay O."
48b1e7cf
SM
2439 (let ((o1 (if (overlay-buffer o)
2440 (make-overlay (overlay-start o) (overlay-end o)
2441 ;; FIXME: there's no easy way to find the
2442 ;; insertion-type of the two markers.
2443 (overlay-buffer o))
2444 (let ((o1 (make-overlay (point-min) (point-min))))
2445 (delete-overlay o1)
28f0b072 2446 o1)))
aa3b4ded
SM
2447 (props (overlay-properties o)))
2448 (while props
2449 (overlay-put o1 (pop props) (pop props)))
2450 o1))
2451
f24485f1 2452(defun remove-overlays (&optional beg end name val)
aa3b4ded 2453 "Clear BEG and END of overlays whose property NAME has value VAL.
cba61075
JB
2454Overlays might be moved and/or split.
2455BEG and END default respectively to the beginning and end of buffer."
d6f5ac10 2456 ;; This speeds up the loops over overlays.
f24485f1
MY
2457 (unless beg (setq beg (point-min)))
2458 (unless end (setq end (point-max)))
ee6bb693 2459 (overlay-recenter end)
aa3b4ded
SM
2460 (if (< end beg)
2461 (setq beg (prog1 end (setq end beg))))
2462 (save-excursion
2463 (dolist (o (overlays-in beg end))
2464 (when (eq (overlay-get o name) val)
2465 ;; Either push this overlay outside beg...end
2466 ;; or split it to exclude beg...end
2467 ;; or delete it entirely (if it is contained in beg...end).
2468 (if (< (overlay-start o) beg)
2469 (if (> (overlay-end o) end)
2470 (progn
2471 (move-overlay (copy-overlay o)
2472 (overlay-start o) beg)
2473 (move-overlay o end (overlay-end o)))
2474 (move-overlay o (overlay-start o) beg))
2475 (if (> (overlay-end o) end)
2476 (move-overlay o end (overlay-end o))
2477 (delete-overlay o)))))))
c5802acf 2478\f
9a5336ae
JB
2479;;;; Miscellanea.
2480
4fb17037
RS
2481(defvar suspend-hook nil
2482 "Normal hook run by `suspend-emacs', before suspending.")
2483
2484(defvar suspend-resume-hook nil
2485 "Normal hook run by `suspend-emacs', after Emacs is continued.")
2486
784bc7cd
RS
2487(defvar temp-buffer-show-hook nil
2488 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
2489When the hook runs, the temporary buffer is current, and the window it
5247a8e6 2490was displayed in is selected.")
784bc7cd
RS
2491
2492(defvar temp-buffer-setup-hook nil
2493 "Normal hook run by `with-output-to-temp-buffer' at the start.
2494When the hook runs, the temporary buffer is current.
2495This hook is normally set up with a function to put the buffer in Help
2496mode.")
2497
d8869c65
CY
2498(defconst user-emacs-directory
2499 (if (eq system-type 'ms-dos)
2500 ;; MS-DOS cannot have initial dot.
2501 "~/_emacs.d/"
2502 "~/.emacs.d/")
2503 "Directory beneath which additional per-user Emacs-specific files are placed.
2504Various programs in Emacs store information in this directory.
d6c180c4
JB
2505Note that this should end with a directory separator.
2506See also `locate-user-emacs-file'.")
c4f484f2
RS
2507\f
2508;;;; Misc. useful functions.
448b61c9 2509
e5c2edf7
CY
2510(defsubst buffer-narrowed-p ()
2511 "Return non-nil if the current buffer is narrowed."
2512 (/= (- (point-max) (point-min)) (buffer-size)))
2513
e5e4a942
JL
2514(defun find-tag-default-bounds ()
2515 "Determine the boundaries of the default tag, based on text at point.
2516Return a cons cell with the beginning and end of the found tag.
c4f484f2 2517If there is no plausible default, return nil."
9db3bfae
MR
2518 (let (from to bound)
2519 (when (or (progn
2520 ;; Look at text around `point'.
2521 (save-excursion
2522 (skip-syntax-backward "w_") (setq from (point)))
2523 (save-excursion
2524 (skip-syntax-forward "w_") (setq to (point)))
2525 (> to from))
2526 ;; Look between `line-beginning-position' and `point'.
2527 (save-excursion
2528 (and (setq bound (line-beginning-position))
2529 (skip-syntax-backward "^w_" bound)
2530 (> (setq to (point)) bound)
2531 (skip-syntax-backward "w_")
2532 (setq from (point))))
2533 ;; Look between `point' and `line-end-position'.
2534 (save-excursion
2535 (and (setq bound (line-end-position))
2536 (skip-syntax-forward "^w_" bound)
2537 (< (setq from (point)) bound)
2538 (skip-syntax-forward "w_")
2539 (setq to (point)))))
e5e4a942
JL
2540 (cons from to))))
2541
2542(defun find-tag-default ()
2543 "Determine default tag to search for, based on text at point.
2544If there is no plausible default, return nil."
2545 (let ((bounds (find-tag-default-bounds)))
2546 (when bounds
2547 (buffer-substring-no-properties (car bounds) (cdr bounds)))))
a860d25f 2548
eb1a6e15
J
2549(defun find-tag-default-as-regexp ()
2550 "Return regexp that matches the default tag at point.
2551If there is no tag at point, return nil.
2552
48c6afa6 2553When in a major mode that does not provide its own
eb1a6e15
J
2554`find-tag-default-function', return a regexp that matches the
2555symbol at point exactly."
24da7273
JL
2556 (let ((tag (funcall (or find-tag-default-function
2557 (get major-mode 'find-tag-default-function)
2558 'find-tag-default))))
2559 (if tag (regexp-quote tag))))
2560
2561(defun find-tag-default-as-symbol-regexp ()
2562 "Return regexp that matches the default tag at point as symbol.
2563If there is no tag at point, return nil.
2564
2565When in a major mode that does not provide its own
2566`find-tag-default-function', return a regexp that matches the
2567symbol at point exactly."
2568 (let ((tag-regexp (find-tag-default-as-regexp)))
2569 (if (and tag-regexp
2570 (eq (or find-tag-default-function
2571 (get major-mode 'find-tag-default-function)
2572 'find-tag-default)
2573 'find-tag-default))
2574 (format "\\_<%s\\_>" tag-regexp)
2575 tag-regexp)))
eb1a6e15 2576
c4f484f2
RS
2577(defun play-sound (sound)
2578 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
2579The following keywords are recognized:
9a5336ae 2580
c4f484f2
RS
2581 :file FILE - read sound data from FILE. If FILE isn't an
2582absolute file name, it is searched in `data-directory'.
9a5336ae 2583
c4f484f2
RS
2584 :data DATA - read sound data from string DATA.
2585
2586Exactly one of :file or :data must be present.
2587
2588 :volume VOL - set volume to VOL. VOL must an integer in the
2589range 0..100 or a float in the range 0..1.0. If not specified,
2590don't change the volume setting of the sound device.
9a5336ae 2591
c4f484f2 2592 :device DEVICE - play sound on DEVICE. If not specified,
d7f90d6c
JB
2593a system-dependent default device name is used.
2594
2595Note: :data and :device are currently not supported on Windows."
c4f484f2
RS
2596 (if (fboundp 'play-sound-internal)
2597 (play-sound-internal sound)
2598 (error "This Emacs binary lacks sound support")))
9a5336ae 2599
0ef97535
GM
2600(declare-function w32-shell-dos-semantics "w32-fns" nil)
2601
c4f484f2 2602(defun shell-quote-argument (argument)
d7f90d6c 2603 "Quote ARGUMENT for passing as argument to an inferior shell."
8f91bf93
DC
2604 (cond
2605 ((eq system-type 'ms-dos)
2606 ;; Quote using double quotes, but escape any existing quotes in
2607 ;; the argument with backslashes.
2608 (let ((result "")
2609 (start 0)
2610 end)
2611 (if (or (null (string-match "[^\"]" argument))
2612 (< (match-end 0) (length argument)))
2613 (while (string-match "[\"]" argument start)
2614 (setq end (match-beginning 0)
2615 result (concat result (substring argument start end)
2616 "\\" (substring argument end (1+ end)))
2617 start (1+ end))))
2618 (concat "\"" result (substring argument start) "\"")))
2619
2620 ((and (eq system-type 'windows-nt) (w32-shell-dos-semantics))
638f053a 2621
8f91bf93
DC
2622 ;; First, quote argument so that CommandLineToArgvW will
2623 ;; understand it. See
2624 ;; http://msdn.microsoft.com/en-us/library/17w5ykft%28v=vs.85%29.aspx
2625 ;; After we perform that level of quoting, escape shell
2626 ;; metacharacters so that cmd won't mangle our argument. If the
2627 ;; argument contains no double quote characters, we can just
2628 ;; surround it with double quotes. Otherwise, we need to prefix
2629 ;; each shell metacharacter with a caret.
2630
2631 (setq argument
2632 ;; escape backslashes at end of string
2633 (replace-regexp-in-string
2634 "\\(\\\\*\\)$"
2635 "\\1\\1"
2636 ;; escape backslashes and quotes in string body
2637 (replace-regexp-in-string
2638 "\\(\\\\*\\)\""
2639 "\\1\\1\\\\\""
2640 argument)))
2641
2a782793 2642 (if (string-match "[%!\"]" argument)
8f91bf93
DC
2643 (concat
2644 "^\""
2645 (replace-regexp-in-string
2646 "\\([%!()\"<>&|^]\\)"
2647 "^\\1"
2648 argument)
2649 "^\"")
2650 (concat "\"" argument "\"")))
2651
2652 (t
4bbf6b41
JR
2653 (if (equal argument "")
2654 "''"
2655 ;; Quote everything except POSIX filename characters.
2656 ;; This should be safe enough even for really weird shells.
8f91bf93
DC
2657 (replace-regexp-in-string
2658 "\n" "'\n'"
2659 (replace-regexp-in-string "[^-0-9a-zA-Z_./\n]" "\\\\\\&" argument))))
2660 ))
3e457225
RS
2661
2662(defun string-or-null-p (object)
2663 "Return t if OBJECT is a string or nil.
2664Otherwise, return nil."
2665 (or (stringp object) (null object)))
2666
26715e1b 2667(defun booleanp (object)
ac6ca7ba
KR
2668 "Return t if OBJECT is one of the two canonical boolean values: t or nil.
2669Otherwise, return nil."
2670 (and (memq object '(nil t)) t))
26715e1b 2671
231d8498
SM
2672(defun special-form-p (object)
2673 "Non-nil if and only if OBJECT is a special form."
2674 (if (and (symbolp object) (fboundp object))
96c052a5 2675 (setq object (indirect-function object t)))
231d8498
SM
2676 (and (subrp object) (eq (cdr (subr-arity object)) 'unevalled)))
2677
671d5c16
SM
2678(defun macrop (object)
2679 "Non-nil if and only if OBJECT is a macro."
2680 (let ((def (indirect-function object t)))
2681 (when (consp def)
2682 (or (eq 'macro (car def))
400a3178 2683 (and (autoloadp def) (memq (nth 4 def) '(macro t)))))))
671d5c16 2684
1627b55f 2685(defun field-at-pos (pos)
d7f90d6c 2686 "Return the field at position POS, taking stickiness etc into account."
1ecaae6c
NR
2687 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
2688 (if (eq raw-field 'boundary)
2689 (get-char-property (1- (field-end pos)) 'field)
2690 raw-field)))
2691
7f3f739f
LL
2692(defun sha1 (object &optional start end binary)
2693 "Return the SHA1 (Secure Hash Algorithm) of an OBJECT.
2694OBJECT is either a string or a buffer. Optional arguments START and
2695END are character positions specifying which portion of OBJECT for
2696computing the hash. If BINARY is non-nil, return a string in binary
2697form."
2698 (secure-hash 'sha1 object start end binary))
2699
a3eda656
SM
2700(defalias 'function-put #'put
2701 ;; This is only really used in Emacs>24.4, but we add it to 24.4 already, so
2702 ;; as to ease the pain when people use future autoload files that contain
2703 ;; function-put.
2704 "Set function F's property PROP to VALUE.
2705The namespace for PROP is shared with symbols.
2706So far, F can only be a symbol, not a lambda expression.")
2707
7abaf5cc
SM
2708(defun function-get (f prop &optional autoload)
2709 "Return the value of property PROP of function F.
3c98c962
SM
2710If AUTOLOAD is non-nil and F is autoloaded, try to autoload it
2711in the hope that it will set PROP. If AUTOLOAD is `macro', only do it
2712if it's an autoloaded macro."
7abaf5cc
SM
2713 (let ((val nil))
2714 (while (and (symbolp f)
2715 (null (setq val (get f prop)))
2716 (fboundp f))
2717 (let ((fundef (symbol-function f)))
2718 (if (and autoload (autoloadp fundef)
3c98c962
SM
2719 (not (equal fundef
2720 (autoload-do-load fundef f
2721 (if (eq autoload 'macro)
2722 'macro)))))
7abaf5cc
SM
2723 nil ;Re-try `get' on the same `f'.
2724 (setq f fundef))))
2725 val))
c4f484f2
RS
2726\f
2727;;;; Support for yanking and text properties.
3472b6c6 2728;; Why here in subr.el rather than in simple.el? --Stef
9a5336ae 2729
2170b1bd 2730(defvar yank-handled-properties)
2493767e
RS
2731(defvar yank-excluded-properties)
2732
8ed59ad5 2733(defun remove-yank-excluded-properties (start end)
2170b1bd
CY
2734 "Process text properties between START and END, inserted for a `yank'.
2735Perform the handling specified by `yank-handled-properties', then
2736remove properties specified by `yank-excluded-properties'."
8ed59ad5 2737 (let ((inhibit-read-only t))
2170b1bd
CY
2738 (dolist (handler yank-handled-properties)
2739 (let ((prop (car handler))
2740 (fun (cdr handler))
2741 (run-start start))
2742 (while (< run-start end)
2743 (let ((value (get-text-property run-start prop))
2744 (run-end (next-single-property-change
2745 run-start prop nil end)))
2746 (funcall fun value run-start run-end)
2747 (setq run-start run-end)))))
8ed59ad5
KS
2748 (if (eq yank-excluded-properties t)
2749 (set-text-properties start end nil)
ebaa3349 2750 (remove-list-of-text-properties start end yank-excluded-properties))))
8ed59ad5 2751
e0e80ec9
KS
2752(defvar yank-undo-function)
2753
2754(defun insert-for-yank (string)
3fa173b4 2755 "Call `insert-for-yank-1' repetitively for each `yank-handler' segment.
6b61353c
KH
2756
2757See `insert-for-yank-1' for more details."
2758 (let (to)
2759 (while (setq to (next-single-property-change 0 'yank-handler string))
2760 (insert-for-yank-1 (substring string 0 to))
2761 (setq string (substring string to))))
2762 (insert-for-yank-1 string))
2763
2764(defun insert-for-yank-1 (string)
2170b1bd
CY
2765 "Insert STRING at point for the `yank' command.
2766This function is like `insert', except it honors the variables
2767`yank-handled-properties' and `yank-excluded-properties', and the
2768`yank-handler' text property.
2769
2770Properties listed in `yank-handled-properties' are processed,
2771then those listed in `yank-excluded-properties' are discarded.
2772
2773If STRING has a non-nil `yank-handler' property on its first
2774character, the normal insert behavior is altered. The value of
2775the `yank-handler' property must be a list of one to four
2776elements, of the form (FUNCTION PARAM NOEXCLUDE UNDO).
2777FUNCTION, if non-nil, should be a function of one argument, an
2778 object to insert; it is called instead of `insert'.
2779PARAM, if present and non-nil, replaces STRING as the argument to
2780 FUNCTION or `insert'; e.g. if FUNCTION is `yank-rectangle', PARAM
2781 may be a list of strings to insert as a rectangle.
2782If NOEXCLUDE is present and non-nil, the normal removal of
5612fd08 2783 `yank-excluded-properties' is not performed; instead FUNCTION is
2170b1bd
CY
2784 responsible for the removal. This may be necessary if FUNCTION
2785 adjusts point before or after inserting the object.
2786UNDO, if present and non-nil, should be a function to be called
e0e80ec9 2787 by `yank-pop' to undo the insertion of the current object. It is
2170b1bd
CY
2788 given two arguments, the start and end of the region. FUNCTION
2789 may set `yank-undo-function' to override UNDO."
57596fb6
KS
2790 (let* ((handler (and (stringp string)
2791 (get-text-property 0 'yank-handler string)))
2792 (param (or (nth 1 handler) string))
4f0f29aa 2793 (opoint (point))
029fd82c 2794 (inhibit-read-only inhibit-read-only)
4f0f29aa
RS
2795 end)
2796
57596fb6 2797 (setq yank-undo-function t)
2170b1bd 2798 (if (nth 0 handler) ; FUNCTION
57596fb6 2799 (funcall (car handler) param)
e0e80ec9 2800 (insert param))
4f0f29aa
RS
2801 (setq end (point))
2802
029fd82c
CY
2803 ;; Prevent read-only properties from interfering with the
2804 ;; following text property changes.
2805 (setq inhibit-read-only t)
2806
2170b1bd
CY
2807 (unless (nth 2 handler) ; NOEXCLUDE
2808 (remove-yank-excluded-properties opoint end))
631890d8
RS
2809
2810 ;; If last inserted char has properties, mark them as rear-nonsticky.
2811 (if (and (> end opoint)
2812 (text-properties-at (1- end)))
2813 (put-text-property (1- end) end 'rear-nonsticky t))
2814
2170b1bd
CY
2815 (if (eq yank-undo-function t) ; not set by FUNCTION
2816 (setq yank-undo-function (nth 3 handler))) ; UNDO
2817 (if (nth 4 handler) ; COMMAND
57596fb6 2818 (setq this-command (nth 4 handler)))))
f1180544 2819
a478f3e1
JB
2820(defun insert-buffer-substring-no-properties (buffer &optional start end)
2821 "Insert before point a substring of BUFFER, without text properties.
3b8690f6 2822BUFFER may be a buffer or a buffer name.
f8cf33b1
JB
2823Arguments START and END are character positions specifying the substring.
2824They default to the values of (point-min) and (point-max) in BUFFER."
3b8690f6 2825 (let ((opoint (point)))
a478f3e1 2826 (insert-buffer-substring buffer start end)
3b8690f6
KS
2827 (let ((inhibit-read-only t))
2828 (set-text-properties opoint (point) nil))))
2829
a478f3e1
JB
2830(defun insert-buffer-substring-as-yank (buffer &optional start end)
2831 "Insert before point a part of BUFFER, stripping some text properties.
2832BUFFER may be a buffer or a buffer name.
f8cf33b1
JB
2833Arguments START and END are character positions specifying the substring.
2834They default to the values of (point-min) and (point-max) in BUFFER.
05b621a6
CY
2835Before insertion, process text properties according to
2836`yank-handled-properties' and `yank-excluded-properties'."
6b61353c
KH
2837 ;; Since the buffer text should not normally have yank-handler properties,
2838 ;; there is no need to handle them here.
3b8690f6 2839 (let ((opoint (point)))
a478f3e1 2840 (insert-buffer-substring buffer start end)
8ed59ad5 2841 (remove-yank-excluded-properties opoint (point))))
3b8690f6 2842
2170b1bd
CY
2843(defun yank-handle-font-lock-face-property (face start end)
2844 "If `font-lock-defaults' is nil, apply FACE as a `face' property.
2845START and END denote the start and end of the text to act on.
2846Do nothing if FACE is nil."
2847 (and face
2848 (null font-lock-defaults)
2849 (put-text-property start end 'face face)))
2850
2851;; This removes `mouse-face' properties in *Help* buffer buttons:
2852;; http://lists.gnu.org/archive/html/emacs-devel/2002-04/msg00648.html
2853(defun yank-handle-category-property (category start end)
2854 "Apply property category CATEGORY's properties between START and END."
2855 (when category
2856 (let ((start2 start))
2857 (while (< start2 end)
2858 (let ((end2 (next-property-change start2 nil end))
2859 (original (text-properties-at start2)))
2860 (set-text-properties start2 end2 (symbol-plist category))
2861 (add-text-properties start2 end2 original)
2862 (setq start2 end2))))))
2863
2493767e 2864\f
c4f484f2 2865;;;; Synchronous shell commands.
2493767e 2866
be9b65ac
DL
2867(defun start-process-shell-command (name buffer &rest args)
2868 "Start a program in a subprocess. Return the process object for it.
be9b65ac 2869NAME is name for process. It is modified if necessary to make it unique.
54ce7cbf 2870BUFFER is the buffer (or buffer name) to associate with the process.
be9b65ac
DL
2871 Process output goes at end of that buffer, unless you specify
2872 an output stream or filter function to handle the output.
2873 BUFFER may be also nil, meaning that this process is not associated
2874 with any buffer
03a74b84
SM
2875COMMAND is the shell command to run.
2876
2877An old calling convention accepted any number of arguments after COMMAND,
2878which were just concatenated to COMMAND. This is still supported but strongly
fd6c5134 2879discouraged."
b59f6d7a
RS
2880 ;; We used to use `exec' to replace the shell with the command,
2881 ;; but that failed to handle (...) and semicolon, etc.
7c2fb837
DN
2882 (start-process name buffer shell-file-name shell-command-switch
2883 (mapconcat 'identity args " ")))
f3ed9aca 2884(set-advertised-calling-convention 'start-process-shell-command
f3a30a50 2885 '(name buffer command) "23.1")
f3ed9aca 2886
a9e11582
MA
2887(defun start-file-process-shell-command (name buffer &rest args)
2888 "Start a program in a subprocess. Return the process object for it.
fd6c5134 2889Similar to `start-process-shell-command', but calls `start-file-process'."
a9e11582
MA
2890 (start-file-process
2891 name buffer
2892 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2893 (if (file-remote-p default-directory) "-c" shell-command-switch)
2894 (mapconcat 'identity args " ")))
f3ed9aca 2895(set-advertised-calling-convention 'start-file-process-shell-command
f3a30a50 2896 '(name buffer command) "23.1")
a9e11582 2897
93aca633
MB
2898(defun call-process-shell-command (command &optional infile buffer display
2899 &rest args)
2900 "Execute the shell command COMMAND synchronously in separate process.
2901The remaining arguments are optional.
2902The program's input comes from file INFILE (nil means `/dev/null').
2903Insert output in BUFFER before point; t means current buffer;
2904 nil for BUFFER means discard it; 0 means discard and don't wait.
2905BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
2906REAL-BUFFER says what to do with standard output, as above,
2907while STDERR-FILE says what to do with standard error in the child.
2908STDERR-FILE may be nil (discard standard error output),
2909t (mix it with ordinary output), or a file name string.
2910
2911Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
2912Remaining arguments are strings passed as additional arguments for COMMAND.
2913Wildcards and redirection are handled as usual in the shell.
2914
2915If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
2916Otherwise it waits for COMMAND to terminate and returns a numeric exit
2917status or a signal description string.
2918If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
7c2fb837
DN
2919 ;; We used to use `exec' to replace the shell with the command,
2920 ;; but that failed to handle (...) and semicolon, etc.
2921 (call-process shell-file-name
2922 infile buffer display
2923 shell-command-switch
2924 (mapconcat 'identity (cons command args) " ")))
a9e11582
MA
2925
2926(defun process-file-shell-command (command &optional infile buffer display
2927 &rest args)
2928 "Process files synchronously in a separate process.
2929Similar to `call-process-shell-command', but calls `process-file'."
2930 (process-file
2931 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
2932 infile buffer display
2933 (if (file-remote-p default-directory) "-c" shell-command-switch)
2934 (mapconcat 'identity (cons command args) " ")))
a7ed4c2a 2935\f
c4f484f2
RS
2936;;;; Lisp macros to do various things temporarily.
2937
83f57f49
MR
2938(defmacro with-current-buffer (buffer-or-name &rest body)
2939 "Execute the forms in BODY with BUFFER-OR-NAME temporarily current.
2940BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
2941The value returned is the value of the last form in BODY. See
2942also `with-temp-buffer'."
d47f7515
SM
2943 (declare (indent 1) (debug t))
2944 `(save-current-buffer
83f57f49 2945 (set-buffer ,buffer-or-name)
d47f7515
SM
2946 ,@body))
2947
89660017 2948(defun internal--before-with-selected-window (window)
1439443b
SM
2949 (let ((other-frame (window-frame window)))
2950 (list window (selected-window)
2951 ;; Selecting a window on another frame also changes that
2952 ;; frame's frame-selected-window. We must save&restore it.
2953 (unless (eq (selected-frame) other-frame)
2954 (frame-selected-window other-frame))
2955 ;; Also remember the top-frame if on ttys.
2956 (unless (eq (selected-frame) other-frame)
2957 (tty-top-frame other-frame)))))
2958
89660017 2959(defun internal--after-with-selected-window (state)
1439443b
SM
2960 ;; First reset frame-selected-window.
2961 (when (window-live-p (nth 2 state))
2962 ;; We don't use set-frame-selected-window because it does not
2963 ;; pass the `norecord' argument to Fselect_window.
2964 (select-window (nth 2 state) 'norecord)
2965 (and (frame-live-p (nth 3 state))
2966 (not (eq (tty-top-frame) (nth 3 state)))
2967 (select-frame (nth 3 state) 'norecord)))
2968 ;; Then reset the actual selected-window.
7d806b1e
DU
2969 (when (window-live-p (nth 1 state))
2970 (select-window (nth 1 state) 'norecord)))
1439443b 2971
d47f7515
SM
2972(defmacro with-selected-window (window &rest body)
2973 "Execute the forms in BODY with WINDOW as the selected window.
2974The value returned is the value of the last form in BODY.
4c6d1e16 2975
a5094f72
MR
2976This macro saves and restores the selected window, as well as the
2977selected window of each frame. It does not change the order of
2978recently selected windows. If the previously selected window of
2979some frame is no longer live at the end of BODY, that frame's
2980selected window is left alone. If the selected window is no
2981longer live, then whatever window is selected at the end of BODY
2982remains selected.
2983
2984This macro uses `save-current-buffer' to save and restore the
2985current buffer, since otherwise its normal operation could
2986potentially make a different buffer current. It does not alter
2987the buffer list ordering."
d47f7515 2988 (declare (indent 1) (debug t))
1439443b 2989 `(let ((save-selected-window--state
89660017 2990 (internal--before-with-selected-window ,window)))
4c6d1e16
RS
2991 (save-current-buffer
2992 (unwind-protect
1439443b 2993 (progn (select-window (car save-selected-window--state) 'norecord)
4c6d1e16 2994 ,@body)
89660017 2995 (internal--after-with-selected-window save-selected-window--state)))))
a7f284ec 2996
c3e242d3
KL
2997(defmacro with-selected-frame (frame &rest body)
2998 "Execute the forms in BODY with FRAME as the selected frame.
2999The value returned is the value of the last form in BODY.
a5094f72 3000
4e5d086d
LMI
3001This macro saves and restores the selected frame, and changes the
3002order of neither the recently selected windows nor the buffers in
3003the buffer list."
c3e242d3 3004 (declare (indent 1) (debug t))
632210dd
KL
3005 (let ((old-frame (make-symbol "old-frame"))
3006 (old-buffer (make-symbol "old-buffer")))
3007 `(let ((,old-frame (selected-frame))
3008 (,old-buffer (current-buffer)))
3009 (unwind-protect
a5094f72 3010 (progn (select-frame ,frame 'norecord)
632210dd 3011 ,@body)
a5094f72
MR
3012 (when (frame-live-p ,old-frame)
3013 (select-frame ,old-frame 'norecord))
3014 (when (buffer-live-p ,old-buffer)
3015 (set-buffer ,old-buffer))))))
c3e242d3 3016
e0f57e65 3017(defmacro save-window-excursion (&rest body)
2cc775f9 3018 "Execute BODY, then restore previous window configuration.
d3760c4b
CY
3019This macro saves the window configuration on the selected frame,
3020executes BODY, then calls `set-window-configuration' to restore
3021the saved window configuration. The return value is the last
3022form in BODY. The window configuration is also restored if BODY
3023exits nonlocally.
e0f57e65
SM
3024
3025BEWARE: Most uses of this macro introduce bugs.
3026E.g. it should not be used to try and prevent some code from opening
3027a new window, since that window may sometimes appear in another frame,
3028in which case `save-window-excursion' cannot help."
3029 (declare (indent 0) (debug t))
3030 (let ((c (make-symbol "wconfig")))
3031 `(let ((,c (current-window-configuration)))
3032 (unwind-protect (progn ,@body)
3033 (set-window-configuration ,c)))))
3034
4ff5b1b2 3035(defun internal-temp-output-buffer-show (buffer)
43bf5e8e
MR
3036 "Internal function for `with-output-to-temp-buffer'."
3037 (with-current-buffer buffer
3038 (set-buffer-modified-p nil)
3039 (goto-char (point-min)))
3040
3041 (if temp-buffer-show-function
3042 (funcall temp-buffer-show-function buffer)
3043 (with-current-buffer buffer
3044 (let* ((window
3045 (let ((window-combination-limit
3046 ;; When `window-combination-limit' equals
3047 ;; `temp-buffer' or `temp-buffer-resize' and
3048 ;; `temp-buffer-resize-mode' is enabled in this
3049 ;; buffer bind it to t so resizing steals space
3050 ;; preferably from the window that was split.
3051 (if (or (eq window-combination-limit 'temp-buffer)
3052 (and (eq window-combination-limit
3053 'temp-buffer-resize)
3054 temp-buffer-resize-mode))
3055 t
3056 window-combination-limit)))
3057 (display-buffer buffer)))
3058 (frame (and window (window-frame window))))
3059 (when window
3060 (unless (eq frame (selected-frame))
3061 (make-frame-visible frame))
3062 (setq minibuffer-scroll-window window)
3063 (set-window-hscroll window 0)
3064 ;; Don't try this with NOFORCE non-nil!
3065 (set-window-start window (point-min) t)
735135f9 3066 ;; This should not be necessary.
43bf5e8e
MR
3067 (set-window-point window (point-min))
3068 ;; Run `temp-buffer-show-hook', with the chosen window selected.
3069 (with-selected-window window
3070 (run-hooks 'temp-buffer-show-hook))))))
3071 ;; Return nil.
3072 nil)
3073
95f0501e 3074;; Doc is very similar to with-temp-buffer-window.
3e21b6a7
SM
3075(defmacro with-output-to-temp-buffer (bufname &rest body)
3076 "Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer.
3077
3078This construct makes buffer BUFNAME empty before running BODY.
3079It does not make the buffer current for BODY.
3080Instead it binds `standard-output' to that buffer, so that output
3081generated with `prin1' and similar functions in BODY goes into
3082the buffer.
3083
a239d4e9 3084At the end of BODY, this marks buffer BUFNAME unmodified and displays
3e21b6a7
SM
3085it in a window, but does not select it. The normal way to do this is
3086by calling `display-buffer', then running `temp-buffer-show-hook'.
3087However, if `temp-buffer-show-function' is non-nil, it calls that
3088function instead (and does not run `temp-buffer-show-hook'). The
3089function gets one argument, the buffer to display.
3090
3091The return value of `with-output-to-temp-buffer' is the value of the
3092last form in BODY. If BODY does not finish normally, the buffer
3093BUFNAME is not displayed.
3094
3095This runs the hook `temp-buffer-setup-hook' before BODY,
3096with the buffer BUFNAME temporarily current. It runs the hook
3097`temp-buffer-show-hook' after displaying buffer BUFNAME, with that
3098buffer temporarily current, and the window that was used to display it
3099temporarily selected. But it doesn't run `temp-buffer-show-hook'
95f0501e
GM
3100if it uses `temp-buffer-show-function'.
3101
3102See the related form `with-temp-buffer-window'."
2462470b 3103 (declare (debug t))
3e21b6a7
SM
3104 (let ((old-dir (make-symbol "old-dir"))
3105 (buf (make-symbol "buf")))
9dba2c64
SM
3106 `(let* ((,old-dir default-directory)
3107 (,buf
3108 (with-current-buffer (get-buffer-create ,bufname)
3109 (prog1 (current-buffer)
3110 (kill-all-local-variables)
3111 ;; FIXME: delete_all_overlays
3112 (setq default-directory ,old-dir)
3113 (setq buffer-read-only nil)
3114 (setq buffer-file-name nil)
3115 (setq buffer-undo-list t)
3116 (let ((inhibit-read-only t)
3117 (inhibit-modification-hooks t))
3118 (erase-buffer)
3119 (run-hooks 'temp-buffer-setup-hook)))))
3120 (standard-output ,buf))
3121 (prog1 (progn ,@body)
4ff5b1b2 3122 (internal-temp-output-buffer-show ,buf)))))
3e21b6a7 3123
e5bb8a8c
SM
3124(defmacro with-temp-file (file &rest body)
3125 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
3126The value returned is the value of the last form in BODY.
a2fdb55c 3127See also `with-temp-buffer'."
f291fe60 3128 (declare (indent 1) (debug t))
a7ed4c2a 3129 (let ((temp-file (make-symbol "temp-file"))
a2fdb55c
EN
3130 (temp-buffer (make-symbol "temp-buffer")))
3131 `(let ((,temp-file ,file)
3132 (,temp-buffer
3133 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
3134 (unwind-protect
3135 (prog1
3136 (with-current-buffer ,temp-buffer
e5bb8a8c 3137 ,@body)
a2fdb55c 3138 (with-current-buffer ,temp-buffer
ab1d3835 3139 (write-region nil nil ,temp-file nil 0)))
a2fdb55c
EN
3140 (and (buffer-name ,temp-buffer)
3141 (kill-buffer ,temp-buffer))))))
3142
e5bb8a8c 3143(defmacro with-temp-message (message &rest body)
a600effe 3144 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
e5bb8a8c
SM
3145The original message is restored to the echo area after BODY has finished.
3146The value returned is the value of the last form in BODY.
a600effe
SM
3147MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
3148If MESSAGE is nil, the echo area and message log buffer are unchanged.
3149Use a MESSAGE of \"\" to temporarily clear the echo area."
f291fe60 3150 (declare (debug t) (indent 1))
110201c8
SM
3151 (let ((current-message (make-symbol "current-message"))
3152 (temp-message (make-symbol "with-temp-message")))
3153 `(let ((,temp-message ,message)
3154 (,current-message))
e5bb8a8c
SM
3155 (unwind-protect
3156 (progn
110201c8
SM
3157 (when ,temp-message
3158 (setq ,current-message (current-message))
aadf7ff3 3159 (message "%s" ,temp-message))
e5bb8a8c 3160 ,@body)
cad84646
RS
3161 (and ,temp-message
3162 (if ,current-message
3163 (message "%s" ,current-message)
3164 (message nil)))))))
e5bb8a8c
SM
3165
3166(defmacro with-temp-buffer (&rest body)
3167 "Create a temporary buffer, and evaluate BODY there like `progn'.
a2fdb55c 3168See also `with-temp-file' and `with-output-to-string'."
d47f7515 3169 (declare (indent 0) (debug t))
a2fdb55c 3170 (let ((temp-buffer (make-symbol "temp-buffer")))
9166dbf6 3171 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
4a5e1832
SM
3172 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
3173 (with-current-buffer ,temp-buffer
3174 (unwind-protect
3175 (progn ,@body)
3176 (and (buffer-name ,temp-buffer)
3177 (kill-buffer ,temp-buffer)))))))
a2fdb55c 3178
83a5aac5 3179(defmacro with-silent-modifications (&rest body)
f291fe60 3180 "Execute BODY, pretending it does not modify the buffer.
83a5aac5
SM
3181If BODY performs real modifications to the buffer's text, other
3182than cosmetic ones, undo data may become corrupted.
a28e4607
LMI
3183
3184This macro will run BODY normally, but doesn't count its buffer
3185modifications as being buffer modifications. This affects things
fa6bc6fd 3186like `buffer-modified-p', checking whether the file is locked by
a28e4607
LMI
3187someone else, running buffer modification hooks, and other things
3188of that nature.
3189
3190Typically used around modifications of text-properties which do
3191not really affect the buffer's content."
83a5aac5
SM
3192 (declare (debug t) (indent 0))
3193 (let ((modified (make-symbol "modified")))
3194 `(let* ((,modified (buffer-modified-p))
3195 (buffer-undo-list t)
3196 (inhibit-read-only t)
3197 (inhibit-modification-hooks t)
3198 deactivate-mark
3199 ;; Avoid setting and removing file locks and checking
3200 ;; buffer's uptodate-ness w.r.t the underlying file.
3201 buffer-file-name
3202 buffer-file-truename)
3203 (unwind-protect
3204 (progn
3205 ,@body)
3206 (unless ,modified
3207 (restore-buffer-modified-p nil))))))
3208
5db7925d
RS
3209(defmacro with-output-to-string (&rest body)
3210 "Execute BODY, return the text it sent to `standard-output', as a string."
d47f7515 3211 (declare (indent 0) (debug t))
a2fdb55c
EN
3212 `(let ((standard-output
3213 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
86ec740e
RF
3214 (unwind-protect
3215 (progn
3216 (let ((standard-output standard-output))
3217 ,@body)
3218 (with-current-buffer standard-output
3219 (buffer-string)))
3220 (kill-buffer standard-output))))
2ec9c94e 3221
0764e16f 3222(defmacro with-local-quit (&rest body)
53a7160c 3223 "Execute BODY, allowing quits to terminate BODY but not escape further.
b9308c61 3224When a quit terminates BODY, `with-local-quit' returns nil but
60f7e8b6
RS
3225requests another quit. That quit will be processed as soon as quitting
3226is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
12320833 3227 (declare (debug t) (indent 0))
0764e16f
SM
3228 `(condition-case nil
3229 (let ((inhibit-quit nil))
3230 ,@body)
113fe928
RS
3231 (quit (setq quit-flag t)
3232 ;; This call is to give a chance to handle quit-flag
3233 ;; in case inhibit-quit is nil.
3234 ;; Without this, it will not be handled until the next function
3235 ;; call, and that might allow it to exit thru a condition-case
3236 ;; that intends to handle the quit signal next time.
3237 (eval '(ignore nil)))))
0764e16f 3238
c2b53d7b
RS
3239(defmacro while-no-input (&rest body)
3240 "Execute BODY only as long as there's no pending input.
3241If input arrives, that ends the execution of BODY,
83047ee3
RS
3242and `while-no-input' returns t. Quitting makes it return nil.
3243If BODY finishes, `while-no-input' returns whatever value BODY produced."
c2b53d7b
RS
3244 (declare (debug t) (indent 0))
3245 (let ((catch-sym (make-symbol "input")))
3246 `(with-local-quit
3247 (catch ',catch-sym
3248 (let ((throw-on-input ',catch-sym))
790e0ef7 3249 (or (input-pending-p)
ff7d73ac 3250 (progn ,@body)))))))
c2b53d7b 3251
1be3ca5a 3252(defmacro condition-case-unless-debug (var bodyform &rest handlers)
e5b5a34d
SM
3253 "Like `condition-case' except that it does not prevent debugging.
3254More specifically if `debug-on-error' is set then the debugger will be invoked
3255even if this catches the signal."
47ccb993 3256 (declare (debug condition-case) (indent 2))
e5b5a34d
SM
3257 `(condition-case ,var
3258 ,bodyform
3259 ,@(mapcar (lambda (handler)
3260 `((debug ,@(if (listp (car handler)) (car handler)
3261 (list (car handler))))
3262 ,@(cdr handler)))
3263 handlers)))
47ccb993 3264
1be3ca5a
LL
3265(define-obsolete-function-alias 'condition-case-no-debug
3266 'condition-case-unless-debug "24.1")
3267
8c27f5ff 3268(defmacro with-demoted-errors (format &rest body)
47ccb993 3269 "Run BODY and demote any errors to simple messages.
1e548e40
GM
3270FORMAT is a string passed to `message' to format any error message.
3271It should contain a single %-sequence; e.g., \"Error: %S\".
3272
47ccb993
SM
3273If `debug-on-error' is non-nil, run BODY without catching its errors.
3274This is to be used around code which is not expected to signal an error
8c27f5ff 3275but which should be robust in the unexpected case that an error is signaled.
1e548e40 3276
8c27f5ff
SM
3277For backward compatibility, if FORMAT is not a constant string, it
3278is assumed to be part of BODY, in which case the message format
3279used is \"Error: %S\"."
3280 (declare (debug t) (indent 1))
3281 (let ((err (make-symbol "err"))
3282 (format (if (and (stringp format) body) format
3283 (prog1 "Error: %S"
3284 (if format (push format body))))))
1be3ca5a 3285 `(condition-case-unless-debug ,err
8c27f5ff
SM
3286 ,(macroexp-progn body)
3287 (error (message ,format ,err) nil))))
47ccb993 3288
2ec9c94e
RS
3289(defmacro combine-after-change-calls (&rest body)
3290 "Execute BODY, but don't call the after-change functions till the end.
3291If BODY makes changes in the buffer, they are recorded
3292and the functions on `after-change-functions' are called several times
3293when BODY is finished.
31aa282e 3294The return value is the value of the last form in BODY.
2ec9c94e
RS
3295
3296If `before-change-functions' is non-nil, then calls to the after-change
3297functions can't be deferred, so in that case this macro has no effect.
3298
3299Do not alter `after-change-functions' or `before-change-functions'
3300in BODY."
d47f7515 3301 (declare (indent 0) (debug t))
2ec9c94e
RS
3302 `(unwind-protect
3303 (let ((combine-after-change-calls t))
3304 . ,body)
3305 (combine-after-change-execute)))
6a978be3
CY
3306
3307(defmacro with-case-table (table &rest body)
3308 "Execute the forms in BODY with TABLE as the current case table.
3309The value returned is the value of the last form in BODY."
3310 (declare (indent 1) (debug t))
8d6fd8d4
JPW
3311 (let ((old-case-table (make-symbol "table"))
3312 (old-buffer (make-symbol "buffer")))
3313 `(let ((,old-case-table (current-case-table))
3314 (,old-buffer (current-buffer)))
3315 (unwind-protect
3316 (progn (set-case-table ,table)
3317 ,@body)
3318 (with-current-buffer ,old-buffer
3319 (set-case-table ,old-case-table))))))
c4f484f2 3320\f
c4f484f2 3321;;; Matching and match data.
2493767e 3322
c7ca41e6
RS
3323(defvar save-match-data-internal)
3324
3325;; We use save-match-data-internal as the local variable because
3326;; that works ok in practice (people should not use that variable elsewhere).
3327;; We used to use an uninterned symbol; the compiler handles that properly
3328;; now, but it generates slower code.
9a5336ae 3329(defmacro save-match-data (&rest body)
e4d03691
JB
3330 "Execute the BODY forms, restoring the global value of the match data.
3331The value returned is the value of the last form in BODY."
64ed733a
PE
3332 ;; It is better not to use backquote here,
3333 ;; because that makes a bootstrapping problem
3334 ;; if you need to recompile all the Lisp files using interpreted code.
d47f7515 3335 (declare (indent 0) (debug t))
64ed733a
PE
3336 (list 'let
3337 '((save-match-data-internal (match-data)))
3338 (list 'unwind-protect
3339 (cons 'progn body)
d1fab151
KS
3340 ;; It is safe to free (evaporate) markers immediately here,
3341 ;; as Lisp programs should not copy from save-match-data-internal.
a0ef72df 3342 '(set-match-data save-match-data-internal 'evaporate))))
993713ce 3343
cd323f89 3344(defun match-string (num &optional string)
993713ce
SM
3345 "Return string of text matched by last search.
3346NUM specifies which parenthesized expression in the last regexp.
3347 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3348Zero means the entire text matched by the whole regexp or whole string.
91054f8f
LMI
3349STRING should be given if the last search was by `string-match' on STRING.
3350If STRING is nil, the current buffer should be the same buffer
3351the search/match was performed in."
cd323f89
SM
3352 (if (match-beginning num)
3353 (if string
3354 (substring string (match-beginning num) (match-end num))
3355 (buffer-substring (match-beginning num) (match-end num)))))
58f950b4 3356
bb760c71
RS
3357(defun match-string-no-properties (num &optional string)
3358 "Return string of text matched by last search, without text properties.
3359NUM specifies which parenthesized expression in the last regexp.
3360 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
3361Zero means the entire text matched by the whole regexp or whole string.
91054f8f
LMI
3362STRING should be given if the last search was by `string-match' on STRING.
3363If STRING is nil, the current buffer should be the same buffer
3364the search/match was performed in."
bb760c71
RS
3365 (if (match-beginning num)
3366 (if string
6b61353c
KH
3367 (substring-no-properties string (match-beginning num)
3368 (match-end num))
bb760c71
RS
3369 (buffer-substring-no-properties (match-beginning num)
3370 (match-end num)))))
3371
8c2e721a
JL
3372
3373(defun match-substitute-replacement (replacement
3374 &optional fixedcase literal string subexp)
3375 "Return REPLACEMENT as it will be inserted by `replace-match'.
3376In other words, all back-references in the form `\\&' and `\\N'
3377are substituted with actual strings matched by the last search.
3378Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
3379meaning as for `replace-match'."
3380 (let ((match (match-string 0 string)))
3381 (save-match-data
3382 (set-match-data (mapcar (lambda (x)
3383 (if (numberp x)
3384 (- x (match-beginning 0))
3385 x))
3386 (match-data t)))
3387 (replace-match replacement fixedcase literal match subexp))))
3388
3389
46065dd4 3390(defun looking-back (regexp &optional limit greedy)
f30e0cd8 3391 "Return non-nil if text before point matches regular expression REGEXP.
991b32c3 3392Like `looking-at' except matches before point, and is slower.
01d16e16
RS
3393LIMIT if non-nil speeds up the search by specifying a minimum
3394starting position, to avoid checking matches that would start
3395before LIMIT.
46065dd4 3396
cde27dd2
CY
3397If GREEDY is non-nil, extend the match backwards as far as
3398possible, stopping when a single additional previous character
3399cannot be part of a match for REGEXP. When the match is
3dcde186 3400extended, its starting position is allowed to occur before
6cfe977d
XF
3401LIMIT.
3402
3403As a general recommendation, try to avoid using `looking-back'
3404wherever possible, since it is slow."
46065dd4
RS
3405 (let ((start (point))
3406 (pos
3407 (save-excursion
3408 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
3409 (point)))))
3410 (if (and greedy pos)
3411 (save-restriction
3412 (narrow-to-region (point-min) start)
3413 (while (and (> pos (point-min))
3414 (save-excursion
3415 (goto-char pos)
3416 (backward-char 1)
3417 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
3418 (setq pos (1- pos)))
3419 (save-excursion
3420 (goto-char pos)
3421 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
3422 (not (null pos))))
3423
45595a4f
RS
3424(defsubst looking-at-p (regexp)
3425 "\
3426Same as `looking-at' except this function does not change the match data."
3427 (let ((inhibit-changing-match-data t))
3428 (looking-at regexp)))
3429
3430(defsubst string-match-p (regexp string &optional start)
3431 "\
3432Same as `string-match' except this function does not change the match data."
3433 (let ((inhibit-changing-match-data t))
3434 (string-match regexp string start)))
3435
c4f484f2
RS
3436(defun subregexp-context-p (regexp pos &optional start)
3437 "Return non-nil if POS is in a normal subregexp context in REGEXP.
3438A subregexp context is one where a sub-regexp can appear.
3439A non-subregexp context is for example within brackets, or within a
3440repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
3441If START is non-nil, it should be a position in REGEXP, smaller
3442than POS, and known to be in a subregexp context."
3443 ;; Here's one possible implementation, with the great benefit that it
3444 ;; reuses the regexp-matcher's own parser, so it understands all the
3445 ;; details of the syntax. A disadvantage is that it needs to match the
3446 ;; error string.
3447 (condition-case err
3448 (progn
3449 (string-match (substring regexp (or start 0) pos) "")
3450 t)
3451 (invalid-regexp
3452 (not (member (cadr err) '("Unmatched [ or [^"
3453 "Unmatched \\{"
3454 "Trailing backslash")))))
3455 ;; An alternative implementation:
3456 ;; (defconst re-context-re
3457 ;; (let* ((harmless-ch "[^\\[]")
3458 ;; (harmless-esc "\\\\[^{]")
3459 ;; (class-harmless-ch "[^][]")
3460 ;; (class-lb-harmless "[^]:]")
3461 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
3462 ;; (class-lb (concat "\\[\\(" class-lb-harmless
3463 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
3464 ;; (class
3465 ;; (concat "\\[^?]?"
3466 ;; "\\(" class-harmless-ch
3467 ;; "\\|" class-lb "\\)*"
3468 ;; "\\[?]")) ; special handling for bare [ at end of re
3469 ;; (braces "\\\\{[0-9,]+\\\\}"))
3470 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
3471 ;; "\\|" class "\\|" braces "\\)*\\'"))
3472 ;; "Matches any prefix that corresponds to a normal subregexp context.")
3473 ;; (string-match re-context-re (substring regexp (or start 0) pos))
3474 )
3475\f
3476;;;; split-string
498535fb 3477
6a646626
JB
3478(defconst split-string-default-separators "[ \f\t\n\r\v]+"
3479 "The default value of separators for `split-string'.
3480
3481A regexp matching strings of whitespace. May be locale-dependent
3482\(as yet unimplemented). Should not match non-breaking spaces.
3483
3484Warning: binding this to a different value and using it as default is
3485likely to have undesired semantics.")
3486
3487;; The specification says that if both SEPARATORS and OMIT-NULLS are
3488;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
3489;; expression leads to the equivalent implementation that if SEPARATORS
3490;; is defaulted, OMIT-NULLS is treated as t.
77c92cb9 3491(defun split-string (string &optional separators omit-nulls trim)
203998e5 3492 "Split STRING into substrings bounded by matches for SEPARATORS.
6a646626
JB
3493
3494The beginning and end of STRING, and each match for SEPARATORS, are
3495splitting points. The substrings matching SEPARATORS are removed, and
3496the substrings between the splitting points are collected as a list,
edce3654 3497which is returned.
b222b786 3498
6a646626
JB
3499If SEPARATORS is non-nil, it should be a regular expression matching text
3500which separates, but is not part of, the substrings. If nil it defaults to
3501`split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
3502OMIT-NULLS is forced to t.
3503
fa6bc6fd 3504If OMIT-NULLS is t, zero-length substrings are omitted from the list (so
6a646626
JB
3505that for the default value of SEPARATORS leading and trailing whitespace
3506are effectively trimmed). If nil, all zero-length substrings are retained,
3507which correctly parses CSV format, for example.
3508
77c92cb9
RS
3509If TRIM is non-nil, it should be a regular expression to match
3510text to trim from the beginning and end of each substring. If trimming
3511makes the substring empty, it is treated as null.
3512
3513If you want to trim whitespace from the substrings, the reliably correct
3514way is using TRIM. Making SEPARATORS match that whitespace gives incorrect
3515results when there is whitespace at the start or end of STRING. If you
3516see such calls to `split-string', please fix them.
3517
6a646626 3518Note that the effect of `(split-string STRING)' is the same as
55e45419 3519`(split-string STRING split-string-default-separators t)'. In the rare
6a646626
JB
3520case that you wish to retain zero-length substrings when splitting on
3521whitespace, use `(split-string STRING split-string-default-separators)'.
b021ef18
DL
3522
3523Modifies the match data; use `save-match-data' if necessary."
77c92cb9
RS
3524 (let* ((keep-nulls (not (if separators omit-nulls t)))
3525 (rexp (or separators split-string-default-separators))
3526 (start 0)
3527 this-start this-end
3528 notfirst
3529 (list nil)
3530 (push-one
3531 ;; Push the substring in range THIS-START to THIS-END
3532 ;; onto LIST, trimming it and perhaps discarding it.
3533 (lambda ()
3534 (when trim
3535 ;; Discard the trim from start of this substring.
3536 (let ((tem (string-match trim string this-start)))
3537 (and (eq tem this-start)
3538 (setq this-start (match-end 0)))))
3539
3540 (when (or keep-nulls (< this-start this-end))
3541 (let ((this (substring string this-start this-end)))
3542
3543 ;; Discard the trim from end of this substring.
3544 (when trim
3545 (let ((tem (string-match (concat trim "\\'") this 0)))
3546 (and tem (< tem (length this))
3547 (setq this (substring this 0 tem)))))
3548
3549 ;; Trimming could make it empty; check again.
3550 (when (or keep-nulls (> (length this) 0))
3551 (push this list)))))))
3552
b222b786
RS
3553 (while (and (string-match rexp string
3554 (if (and notfirst
3555 (= start (match-beginning 0))
3556 (< start (length string)))
3557 (1+ start) start))
6a646626 3558 (< start (length string)))
b222b786 3559 (setq notfirst t)
77c92cb9
RS
3560 (setq this-start start this-end (match-beginning 0)
3561 start (match-end 0))
3562
3563 (funcall push-one))
3564
3565 ;; Handle the substring at the end of STRING.
3566 (setq this-start start this-end (length string))
3567 (funcall push-one)
3568
edce3654 3569 (nreverse list)))
0b93ff3a 3570
e80b3849 3571(defun combine-and-quote-strings (strings &optional separator)
0b93ff3a
NR
3572 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
3573This tries to quote the strings to avoid ambiguity such that
e80b3849 3574 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
0b93ff3a 3575Only some SEPARATORs will work properly."
9f2bd2e7
SM
3576 (let* ((sep (or separator " "))
3577 (re (concat "[\\\"]" "\\|" (regexp-quote sep))))
0b93ff3a
NR
3578 (mapconcat
3579 (lambda (str)
9f2bd2e7 3580 (if (string-match re str)
0b93ff3a
NR
3581 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
3582 str))
3583 strings sep)))
3584
e80b3849 3585(defun split-string-and-unquote (string &optional separator)
0b93ff3a 3586 "Split the STRING into a list of strings.
e80b3849
RS
3587It understands Emacs Lisp quoting within STRING, such that
3588 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
0b93ff3a
NR
3589The SEPARATOR regexp defaults to \"\\s-+\"."
3590 (let ((sep (or separator "\\s-+"))
d551d20d 3591 (i (string-match "\"" string)))
e80b3849
RS
3592 (if (null i)
3593 (split-string string sep t) ; no quoting: easy
0b93ff3a
NR
3594 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
3595 (let ((rfs (read-from-string string i)))
3596 (cons (car rfs)
e80b3849
RS
3597 (split-string-and-unquote (substring string (cdr rfs))
3598 sep)))))))
0b93ff3a 3599
c4f484f2
RS
3600\f
3601;;;; Replacement in strings.
1ccaea52
AI
3602
3603(defun subst-char-in-string (fromchar tochar string &optional inplace)
3604 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
3605Unless optional argument INPLACE is non-nil, return a new string."
e6e71807
SM
3606 (let ((i (length string))
3607 (newstr (if inplace string (copy-sequence string))))
3608 (while (> i 0)
3609 (setq i (1- i))
3610 (if (eq (aref newstr i) fromchar)
3611 (aset newstr i tochar)))
3612 newstr))
b021ef18 3613
1697159c 3614(defun replace-regexp-in-string (regexp rep string &optional
c8227332 3615 fixedcase literal subexp start)
b021ef18
DL
3616 "Replace all matches for REGEXP with REP in STRING.
3617
3618Return a new string containing the replacements.
3619
3620Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
3621arguments with the same names of function `replace-match'. If START
3622is non-nil, start replacements at that index in STRING.
3623
3624REP is either a string used as the NEWTEXT arg of `replace-match' or a
23bb94bb
RS
3625function. If it is a function, it is called with the actual text of each
3626match, and its value is used as the replacement text. When REP is called,
3fa173b4 3627the match data are the result of matching REGEXP against a substring
23bb94bb 3628of STRING.
b021ef18 3629
1697159c
DL
3630To replace only the first match (if any), make REGEXP match up to \\'
3631and replace a sub-expression, e.g.
c9bcb507 3632 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
088be6fb 3633 => \" bar foo\""
b021ef18
DL
3634
3635 ;; To avoid excessive consing from multiple matches in long strings,
3636 ;; don't just call `replace-match' continually. Walk down the
3637 ;; string looking for matches of REGEXP and building up a (reversed)
3638 ;; list MATCHES. This comprises segments of STRING which weren't
3639 ;; matched interspersed with replacements for segments that were.
08b1f8a1 3640 ;; [For a `large' number of replacements it's more efficient to
b021ef18
DL
3641 ;; operate in a temporary buffer; we can't tell from the function's
3642 ;; args whether to choose the buffer-based implementation, though it
3643 ;; might be reasonable to do so for long enough STRING.]
3644 (let ((l (length string))
3645 (start (or start 0))
3646 matches str mb me)
3647 (save-match-data
3648 (while (and (< start l) (string-match regexp string start))
3649 (setq mb (match-beginning 0)
3650 me (match-end 0))
a9853251
SM
3651 ;; If we matched the empty string, make sure we advance by one char
3652 (when (= me mb) (setq me (min l (1+ mb))))
3653 ;; Generate a replacement for the matched substring.
3654 ;; Operate only on the substring to minimize string consing.
3655 ;; Set up match data for the substring for replacement;
3656 ;; presumably this is likely to be faster than munging the
3657 ;; match data directly in Lisp.
3658 (string-match regexp (setq str (substring string mb me)))
3659 (setq matches
3660 (cons (replace-match (if (stringp rep)
3661 rep
3662 (funcall rep (match-string 0 str)))
3663 fixedcase literal str subexp)
c8227332 3664 (cons (substring string start mb) ; unmatched prefix
a9853251
SM
3665 matches)))
3666 (setq start me))
b021ef18
DL
3667 ;; Reconstruct a string from the pieces.
3668 (setq matches (cons (substring string start l) matches)) ; leftover
3669 (apply #'concat (nreverse matches)))))
a7ed4c2a 3670\f
cb190d7d
SM
3671(defun string-prefix-p (str1 str2 &optional ignore-case)
3672 "Return non-nil if STR1 is a prefix of STR2.
3673If IGNORE-CASE is non-nil, the comparison is done without paying attention
3674to case differences."
3675 (eq t (compare-strings str1 nil nil
3676 str2 0 (length str1) ignore-case)))
3e26a4a2 3677
41ce6f70
BB
3678(defun string-suffix-p (suffix string &optional ignore-case)
3679 "Return non-nil if SUFFIX is a suffix of STRING.
3680If IGNORE-CASE is non-nil, the comparison is done without paying
3681attention to case differences."
3682 (let ((start-pos (- (length string) (length suffix))))
3683 (and (>= start-pos 0)
3684 (eq t (compare-strings suffix nil nil
3685 string start-pos nil ignore-case)))))
3686
f635daa1 3687(defun bidi-string-mark-left-to-right (str)
9ccaaa4b 3688 "Return a string that can be safely inserted in left-to-right text.
9ccaaa4b 3689
f635daa1
CY
3690Normally, inserting a string with right-to-left (RTL) script into
3691a buffer may cause some subsequent text to be displayed as part
3692of the RTL segment (usually this affects punctuation characters).
3693This function returns a string which displays as STR but forces
3694subsequent text to be displayed as left-to-right.
9ccaaa4b 3695
f635daa1
CY
3696If STR contains any RTL character, this function returns a string
3697consisting of STR followed by an invisible left-to-right mark
3698\(LRM) character. Otherwise, it returns STR."
3e26a4a2
CY
3699 (unless (stringp str)
3700 (signal 'wrong-type-argument (list 'stringp str)))
f635daa1
CY
3701 (if (string-match "\\cR" str)
3702 (concat str (propertize (string ?\x200e) 'invisible t))
3703 str))
cb190d7d 3704\f
781b4af6
SM
3705;;;; Specifying things to do later.
3706
3707(defun load-history-regexp (file)
3708 "Form a regexp to find FILE in `load-history'.
3709FILE, a string, is described in the function `eval-after-load'."
3710 (if (file-name-absolute-p file)
3711 (setq file (file-truename file)))
3712 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
3713 (regexp-quote file)
3714 (if (file-name-extension file)
3715 ""
3716 ;; Note: regexp-opt can't be used here, since we need to call
3717 ;; this before Emacs has been fully started. 2006-05-21
3718 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
3719 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
3720 "\\)?\\'"))
3721
3722(defun load-history-filename-element (file-regexp)
3723 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
3724Return nil if there isn't one."
3725 (let* ((loads load-history)
3726 (load-elt (and loads (car loads))))
3727 (save-match-data
3728 (while (and loads
3729 (or (null (car load-elt))
3730 (not (string-match file-regexp (car load-elt)))))
3731 (setq loads (cdr loads)
3732 load-elt (and loads (car loads)))))
3733 load-elt))
3734
3735(put 'eval-after-load 'lisp-indent-function 1)
3736(defun eval-after-load (file form)
3737 "Arrange that if FILE is loaded, FORM will be run immediately afterwards.
3738If FILE is already loaded, evaluate FORM right now.
de0503df
SM
3739FORM can be an Elisp expression (in which case it's passed to `eval'),
3740or a function (in which case it's passed to `funcall' with no argument).
781b4af6
SM
3741
3742If a matching file is loaded again, FORM will be evaluated again.
3743
3744If FILE is a string, it may be either an absolute or a relative file
fa6bc6fd 3745name, and may have an extension (e.g. \".el\") or may lack one, and
781b4af6 3746additionally may or may not have an extension denoting a compressed
fa6bc6fd 3747format (e.g. \".gz\").
781b4af6
SM
3748
3749When FILE is absolute, this first converts it to a true name by chasing
fa6bc6fd 3750symbolic links. Only a file of this name (see next paragraph regarding
781b4af6
SM
3751extensions) will trigger the evaluation of FORM. When FILE is relative,
3752a file whose absolute true name ends in FILE will trigger evaluation.
3753
3754When FILE lacks an extension, a file name with any extension will trigger
3755evaluation. Otherwise, its extension must match FILE's. A further
fa6bc6fd 3756extension for a compressed format (e.g. \".gz\") on FILE will not affect
781b4af6
SM
3757this name matching.
3758
3759Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
3760is evaluated at the end of any file that `provide's this feature.
3761If the feature is provided when evaluating code not associated with a
3762file, FORM is evaluated immediately after the provide statement.
3763
3764Usually FILE is just a library name like \"font-lock\" or a feature name
3765like 'font-lock.
3766
3767This function makes or adds to an entry on `after-load-alist'."
de0503df
SM
3768 (declare (compiler-macro
3769 (lambda (whole)
3770 (if (eq 'quote (car-safe form))
3771 ;; Quote with lambda so the compiler can look inside.
3772 `(eval-after-load ,file (lambda () ,(nth 1 form)))
3773 whole))))
781b4af6
SM
3774 ;; Add this FORM into after-load-alist (regardless of whether we'll be
3775 ;; evaluating it now).
3776 (let* ((regexp-or-feature
3777 (if (stringp file)
3778 (setq file (purecopy (load-history-regexp file)))
3779 file))
de0503df
SM
3780 (elt (assoc regexp-or-feature after-load-alist))
3781 (func
3782 (if (functionp form) form
3783 ;; Try to use the "current" lexical/dynamic mode for `form'.
3784 (eval `(lambda () ,form) lexical-binding))))
781b4af6
SM
3785 (unless elt
3786 (setq elt (list regexp-or-feature))
3787 (push elt after-load-alist))
781b4af6
SM
3788 ;; Is there an already loaded file whose name (or `provide' name)
3789 ;; matches FILE?
3790 (prog1 (if (if (stringp file)
3791 (load-history-filename-element regexp-or-feature)
3792 (featurep file))
de0503df
SM
3793 (funcall func))
3794 (let ((delayed-func
3795 (if (not (symbolp regexp-or-feature)) func
3796 ;; For features, the after-load-alist elements get run when
3797 ;; `provide' is called rather than at the end of the file.
3798 ;; So add an indirection to make sure that `func' is really run
3799 ;; "after-load" in case the provide call happens early.
3800 (lambda ()
3801 (if (not load-file-name)
3802 ;; Not being provided from a file, run func right now.
3803 (funcall func)
bf1e6ae8
SM
3804 (let ((lfn load-file-name)
3805 ;; Don't use letrec, because equal (in
3806 ;; add/remove-hook) would get trapped in a cycle.
3807 (fun (make-symbol "eval-after-load-helper")))
3808 (fset fun (lambda (file)
3809 (when (equal file lfn)
3810 (remove-hook 'after-load-functions fun)
3811 (funcall func))))
39eb0cb5 3812 (add-hook 'after-load-functions fun 'append)))))))
de0503df
SM
3813 ;; Add FORM to the element unless it's already there.
3814 (unless (member delayed-func (cdr elt))
3815 (nconc elt (list delayed-func)))))))
3816
3817(defmacro with-eval-after-load (file &rest body)
3818 "Execute BODY after FILE is loaded.
3819FILE is normally a feature name, but it can also be a file name,
3820in case that file does not provide any feature."
3821 (declare (indent 1) (debug t))
3822 `(eval-after-load ,file (lambda () ,@body)))
781b4af6
SM
3823
3824(defvar after-load-functions nil
3825 "Special hook run after loading a file.
3826Each function there is called with a single argument, the absolute
3827name of the file just loaded.")
3828
3829(defun do-after-load-evaluation (abs-file)
3830 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
3831ABS-FILE, a string, should be the absolute true name of a file just loaded.
3832This function is called directly from the C code."
3833 ;; Run the relevant eval-after-load forms.
de0503df
SM
3834 (dolist (a-l-element after-load-alist)
3835 (when (and (stringp (car a-l-element))
3836 (string-match-p (car a-l-element) abs-file))
3837 ;; discard the file name regexp
3838 (mapc #'funcall (cdr a-l-element))))
781b4af6
SM
3839 ;; Complain when the user uses obsolete files.
3840 (when (string-match-p "/obsolete/[^/]*\\'" abs-file)
44915370
GM
3841 ;; Maybe we should just use display-warning? This seems yucky...
3842 (let* ((file (file-name-nondirectory abs-file))
3843 (msg (format "Package %s is obsolete!"
3844 (substring file 0
3845 (string-match "\\.elc?\\>" file)))))
3846 ;; Cribbed from cl--compiling-file.
3847 (if (and (boundp 'byte-compile--outbuffer)
3848 (bufferp (symbol-value 'byte-compile--outbuffer))
3849 (equal (buffer-name (symbol-value 'byte-compile--outbuffer))
3850 " *Compiler Output*"))
3851 ;; Don't warn about obsolete files using other obsolete files.
3852 (unless (and (stringp byte-compile-current-file)
3853 (string-match-p "/obsolete/[^/]*\\'"
3854 (expand-file-name
3855 byte-compile-current-file
3856 byte-compile-root-dir)))
3857 (byte-compile-log-warning msg))
3858 (run-with-timer 0 nil
3859 (lambda (msg)
3860 (message "%s" msg)) msg))))
3861
781b4af6
SM
3862 ;; Finally, run any other hook.
3863 (run-hook-with-args 'after-load-functions abs-file))
3864
3865(defun eval-next-after-load (file)
3866 "Read the following input sexp, and run it whenever FILE is loaded.
3867This makes or adds to an entry on `after-load-alist'.
3868FILE should be the name of a library, with no directory name."
3869 (declare (obsolete eval-after-load "23.2"))
3870 (eval-after-load file (read)))
3871
d77974bf 3872\f
781b4af6
SM
3873(defun display-delayed-warnings ()
3874 "Display delayed warnings from `delayed-warnings-list'.
3875Used from `delayed-warnings-hook' (which see)."
3876 (dolist (warning (nreverse delayed-warnings-list))
3877 (apply 'display-warning warning))
3878 (setq delayed-warnings-list nil))
3879
3880(defun collapse-delayed-warnings ()
3881 "Remove duplicates from `delayed-warnings-list'.
3882Collapse identical adjacent warnings into one (plus count).
3883Used from `delayed-warnings-hook' (which see)."
3884 (let ((count 1)
3885 collapsed warning)
3886 (while delayed-warnings-list
3887 (setq warning (pop delayed-warnings-list))
3888 (if (equal warning (car delayed-warnings-list))
3889 (setq count (1+ count))
3890 (when (> count 1)
3891 (setcdr warning (cons (format "%s [%d times]" (cadr warning) count)
3892 (cddr warning)))
3893 (setq count 1))
3894 (push warning collapsed)))
3895 (setq delayed-warnings-list (nreverse collapsed))))
3896
3897;; At present this is only used for Emacs internals.
3898;; Ref http://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00085.html
3899(defvar delayed-warnings-hook '(collapse-delayed-warnings
3900 display-delayed-warnings)
3901 "Normal hook run to process and display delayed warnings.
3902By default, this hook contains functions to consolidate the
3903warnings listed in `delayed-warnings-list', display them, and set
3904`delayed-warnings-list' back to nil.")
3905
d77974bf
JB
3906(defun delay-warning (type message &optional level buffer-name)
3907 "Display a delayed warning.
3908Aside from going through `delayed-warnings-list', this is equivalent
3909to `display-warning'."
3910 (push (list type message level buffer-name) delayed-warnings-list))
3911
781b4af6 3912\f
c4f484f2 3913;;;; invisibility specs
df8e73e1 3914
c4f484f2
RS
3915(defun add-to-invisibility-spec (element)
3916 "Add ELEMENT to `buffer-invisibility-spec'.
3917See documentation for `buffer-invisibility-spec' for the kind of elements
3918that can be added."
3919 (if (eq buffer-invisibility-spec t)
3920 (setq buffer-invisibility-spec (list t)))
3921 (setq buffer-invisibility-spec
3922 (cons element buffer-invisibility-spec)))
3923
3924(defun remove-from-invisibility-spec (element)
3925 "Remove ELEMENT from `buffer-invisibility-spec'."
3926 (if (consp buffer-invisibility-spec)
c8227332
VJL
3927 (setq buffer-invisibility-spec
3928 (delete element buffer-invisibility-spec))))
a7ed4c2a 3929\f
c4f484f2
RS
3930;;;; Syntax tables.
3931
3932(defmacro with-syntax-table (table &rest body)
3933 "Evaluate BODY with syntax table of current buffer set to TABLE.
3934The syntax table of the current buffer is saved, BODY is evaluated, and the
3935saved table is restored, even in case of an abnormal exit.
3936Value is what BODY returns."
f291fe60 3937 (declare (debug t) (indent 1))
c4f484f2
RS
3938 (let ((old-table (make-symbol "table"))
3939 (old-buffer (make-symbol "buffer")))
3940 `(let ((,old-table (syntax-table))
3941 (,old-buffer (current-buffer)))
3942 (unwind-protect
3943 (progn
3944 (set-syntax-table ,table)
3945 ,@body)
3946 (save-current-buffer
3947 (set-buffer ,old-buffer)
3948 (set-syntax-table ,old-table))))))
8af7df60 3949
297d863b 3950(defun make-syntax-table (&optional oldtable)
984f718a 3951 "Return a new syntax table.
0764e16f
SM
3952Create a syntax table which inherits from OLDTABLE (if non-nil) or
3953from `standard-syntax-table' otherwise."
3954 (let ((table (make-char-table 'syntax-table nil)))
3955 (set-char-table-parent table (or oldtable (standard-syntax-table)))
3956 table))
31aa282e 3957
e9f13a95 3958(defun syntax-after (pos)
6dcef6ec 3959 "Return the raw syntax descriptor for the char after POS.
9d1ffd5a 3960If POS is outside the buffer's accessible portion, return nil."
e9f13a95 3961 (unless (or (< pos (point-min)) (>= pos (point-max)))
d8ac3d27
SM
3962 (let ((st (if parse-sexp-lookup-properties
3963 (get-char-property pos 'syntax-table))))
3964 (if (consp st) st
3965 (aref (or st (syntax-table)) (char-after pos))))))
e9f13a95 3966
cdd8dc28 3967(defun syntax-class (syntax)
6dcef6ec
CY
3968 "Return the code for the syntax class described by SYNTAX.
3969
3970SYNTAX should be a raw syntax descriptor; the return value is a
3971integer which encodes the corresponding syntax class. See Info
3972node `(elisp)Syntax Table Internals' for a list of codes.
3973
9d1ffd5a
EZ
3974If SYNTAX is nil, return nil."
3975 (and syntax (logand (car syntax) 65535)))
2493767e 3976\f
0b938190
TZ
3977;; Utility motion commands
3978
3979;; Whitespace
3980
3981(defun forward-whitespace (arg)
3982 "Move point to the end of the next sequence of whitespace chars.
3983Each such sequence may be a single newline, or a sequence of
3984consecutive space and/or tab characters.
3985With prefix argument ARG, do it ARG times if positive, or move
3986backwards ARG times if negative."
3987 (interactive "^p")
3988 (if (natnump arg)
3989 (re-search-forward "[ \t]+\\|\n" nil 'move arg)
3990 (while (< arg 0)
3991 (if (re-search-backward "[ \t]+\\|\n" nil 'move)
3992 (or (eq (char-after (match-beginning 0)) ?\n)
3993 (skip-chars-backward " \t")))
3994 (setq arg (1+ arg)))))
3995
3996;; Symbols
3997
3998(defun forward-symbol (arg)
3999 "Move point to the next position that is the end of a symbol.
4000A symbol is any sequence of characters that are in either the
4001word constituent or symbol constituent syntax class.
4002With prefix argument ARG, do it ARG times if positive, or move
4003backwards ARG times if negative."
4004 (interactive "^p")
4005 (if (natnump arg)
4006 (re-search-forward "\\(\\sw\\|\\s_\\)+" nil 'move arg)
4007 (while (< arg 0)
4008 (if (re-search-backward "\\(\\sw\\|\\s_\\)+" nil 'move)
4009 (skip-syntax-backward "w_"))
4010 (setq arg (1+ arg)))))
4011
4012;; Syntax blocks
4013
4014(defun forward-same-syntax (&optional arg)
4015 "Move point past all characters with the same syntax class.
4016With prefix argument ARG, do it ARG times if positive, or move
4017backwards ARG times if negative."
4018 (interactive "^p")
4019 (or arg (setq arg 1))
4020 (while (< arg 0)
4021 (skip-syntax-backward
4022 (char-to-string (char-syntax (char-before))))
4023 (setq arg (1+ arg)))
4024 (while (> arg 0)
4025 (skip-syntax-forward (char-to-string (char-syntax (char-after))))
4026 (setq arg (1- arg))))
4027
4028\f
c4f484f2 4029;;;; Text clones
a13fe4c5 4030
671d5c16
SM
4031(defvar text-clone--maintaining nil)
4032
4033(defun text-clone--maintain (ol1 after beg end &optional _len)
a13fe4c5
SM
4034 "Propagate the changes made under the overlay OL1 to the other clones.
4035This is used on the `modification-hooks' property of text clones."
671d5c16
SM
4036 (when (and after (not undo-in-progress)
4037 (not text-clone--maintaining)
4038 (overlay-start ol1))
a13fe4c5
SM
4039 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
4040 (setq beg (max beg (+ (overlay-start ol1) margin)))
4041 (setq end (min end (- (overlay-end ol1) margin)))
4042 (when (<= beg end)
4043 (save-excursion
4044 (when (overlay-get ol1 'text-clone-syntax)
4045 ;; Check content of the clone's text.
4046 (let ((cbeg (+ (overlay-start ol1) margin))
4047 (cend (- (overlay-end ol1) margin)))
4048 (goto-char cbeg)
4049 (save-match-data
4050 (if (not (re-search-forward
4051 (overlay-get ol1 'text-clone-syntax) cend t))
4052 ;; Mark the overlay for deletion.
454eb095 4053 (setq end cbeg)
a13fe4c5
SM
4054 (when (< (match-end 0) cend)
4055 ;; Shrink the clone at its end.
4056 (setq end (min end (match-end 0)))
4057 (move-overlay ol1 (overlay-start ol1)
4058 (+ (match-end 0) margin)))
4059 (when (> (match-beginning 0) cbeg)
4060 ;; Shrink the clone at its beginning.
4061 (setq beg (max (match-beginning 0) beg))
4062 (move-overlay ol1 (- (match-beginning 0) margin)
4063 (overlay-end ol1)))))))
4064 ;; Now go ahead and update the clones.
4065 (let ((head (- beg (overlay-start ol1)))
4066 (tail (- (overlay-end ol1) end))
4067 (str (buffer-substring beg end))
4068 (nothing-left t)
671d5c16 4069 (text-clone--maintaining t))
a13fe4c5
SM
4070 (dolist (ol2 (overlay-get ol1 'text-clones))
4071 (let ((oe (overlay-end ol2)))
4072 (unless (or (eq ol1 ol2) (null oe))
4073 (setq nothing-left nil)
4074 (let ((mod-beg (+ (overlay-start ol2) head)))
4075 ;;(overlay-put ol2 'modification-hooks nil)
4076 (goto-char (- (overlay-end ol2) tail))
4077 (unless (> mod-beg (point))
4078 (save-excursion (insert str))
4079 (delete-region mod-beg (point)))
671d5c16 4080 ;;(overlay-put ol2 'modification-hooks '(text-clone--maintain))
a13fe4c5
SM
4081 ))))
4082 (if nothing-left (delete-overlay ol1))))))))
4083
4084(defun text-clone-create (start end &optional spreadp syntax)
4085 "Create a text clone of START...END at point.
4086Text clones are chunks of text that are automatically kept identical:
4087changes done to one of the clones will be immediately propagated to the other.
4088
4089The buffer's content at point is assumed to be already identical to
4090the one between START and END.
4091If SYNTAX is provided it's a regexp that describes the possible text of
4092the clones; the clone will be shrunk or killed if necessary to ensure that
4093its text matches the regexp.
4094If SPREADP is non-nil it indicates that text inserted before/after the
4095clone should be incorporated in the clone."
4096 ;; To deal with SPREADP we can either use an overlay with `nil t' along
4097 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
4098 ;; (with a one-char margin at each end) with `t nil'.
4099 ;; We opted for a larger overlay because it behaves better in the case
4100 ;; where the clone is reduced to the empty string (we want the overlay to
4101 ;; stay when the clone's content is the empty string and we want to use
4102 ;; `evaporate' to make sure those overlays get deleted when needed).
264ef586 4103 ;;
a13fe4c5
SM
4104 (let* ((pt-end (+ (point) (- end start)))
4105 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
4106 0 1))
4107 (end-margin (if (or (not spreadp)
4108 (>= pt-end (point-max))
4109 (>= start (point-max)))
4110 0 1))
671d5c16 4111 ;; FIXME: Reuse overlays at point to extend dups!
a13fe4c5
SM
4112 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
4113 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
4114 (dups (list ol1 ol2)))
671d5c16 4115 (overlay-put ol1 'modification-hooks '(text-clone--maintain))
a13fe4c5
SM
4116 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
4117 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
4118 ;;(overlay-put ol1 'face 'underline)
4119 (overlay-put ol1 'evaporate t)
4120 (overlay-put ol1 'text-clones dups)
264ef586 4121 ;;
671d5c16 4122 (overlay-put ol2 'modification-hooks '(text-clone--maintain))
a13fe4c5
SM
4123 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
4124 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
4125 ;;(overlay-put ol2 'face 'underline)
4126 (overlay-put ol2 'evaporate t)
4127 (overlay-put ol2 'text-clones dups)))
c4f484f2
RS
4128\f
4129;;;; Mail user agents.
27c079eb 4130
c4f484f2
RS
4131;; Here we include just enough for other packages to be able
4132;; to define them.
324cd947 4133
27c079eb
SM
4134(defun define-mail-user-agent (symbol composefunc sendfunc
4135 &optional abortfunc hookvar)
4136 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
4137
4138SYMBOL can be any Lisp symbol. Its function definition and/or
4139value as a variable do not matter for this usage; we use only certain
4140properties on its property list, to encode the rest of the arguments.
4141
4142COMPOSEFUNC is program callable function that composes an outgoing
4143mail message buffer. This function should set up the basics of the
4144buffer without requiring user interaction. It should populate the
4145standard mail headers, leaving the `to:' and `subject:' headers blank
4146by default.
4147
4148COMPOSEFUNC should accept several optional arguments--the same
4149arguments that `compose-mail' takes. See that function's documentation.
4150
4151SENDFUNC is the command a user would run to send the message.
4152
4153Optional ABORTFUNC is the command a user would run to abort the
4154message. For mail packages that don't have a separate abort function,
4155this can be `kill-buffer' (the equivalent of omitting this argument).
4156
4157Optional HOOKVAR is a hook variable that gets run before the message
4158is actually sent. Callers that use the `mail-user-agent' may
4159install a hook function temporarily on this hook variable.
4160If HOOKVAR is nil, `mail-send-hook' is used.
4161
4162The properties used on SYMBOL are `composefunc', `sendfunc',
4163`abortfunc', and `hookvar'."
4164 (put symbol 'composefunc composefunc)
4165 (put symbol 'sendfunc sendfunc)
4166 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
4167 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
c4f484f2 4168\f
23ba2705
SM
4169(defvar called-interactively-p-functions nil
4170 "Special hook called to skip special frames in `called-interactively-p'.
4171The functions are called with 3 arguments: (I FRAME1 FRAME2),
4172where FRAME1 is a \"current frame\", FRAME2 is the next frame,
4173I is the index of the frame after FRAME2. It should return nil
4174if those frames don't seem special and otherwise, it should return
4175the number of frames to skip (minus 1).")
4176
31dca772
R
4177(defconst internal--call-interactively (symbol-function 'call-interactively))
4178
23ba2705
SM
4179(defun called-interactively-p (&optional kind)
4180 "Return t if the containing function was called by `call-interactively'.
4181If KIND is `interactive', then only return t if the call was made
4182interactively by the user, i.e. not in `noninteractive' mode nor
4183when `executing-kbd-macro'.
4184If KIND is `any', on the other hand, it will return t for any kind of
4185interactive call, including being called as the binding of a key or
4186from a keyboard macro, even in `noninteractive' mode.
4187
4188This function is very brittle, it may fail to return the intended result when
4189the code is debugged, advised, or instrumented in some form. Some macros and
4190special forms (such as `condition-case') may also sometimes wrap their bodies
4191in a `lambda', so any call to `called-interactively-p' from those bodies will
4192indicate whether that lambda (rather than the surrounding function) was called
4193interactively.
4194
4195Instead of using this function, it is cleaner and more reliable to give your
4196function an extra optional argument whose `interactive' spec specifies
4197non-nil unconditionally (\"p\" is a good way to do this), or via
4198\(not (or executing-kbd-macro noninteractive)).
4199
4200The only known proper use of `interactive' for KIND is in deciding
4201whether to display a helpful message, or how to display it. If you're
4202thinking of using it for any other purpose, it is quite likely that
4203you're making a mistake. Think: what do you want to do when the
4204command is called from a keyboard macro?"
4205 (declare (advertised-calling-convention (kind) "23.1"))
4206 (when (not (and (eq kind 'interactive)
4207 (or executing-kbd-macro noninteractive)))
4208 (let* ((i 1) ;; 0 is the called-interactively-p frame.
4209 frame nextframe
4210 (get-next-frame
4211 (lambda ()
4212 (setq frame nextframe)
56ea7291 4213 (setq nextframe (backtrace-frame i 'called-interactively-p))
23ba2705
SM
4214 ;; (message "Frame %d = %S" i nextframe)
4215 (setq i (1+ i)))))
4216 (funcall get-next-frame) ;; Get the first frame.
4217 (while
4218 ;; FIXME: The edebug and advice handling should be made modular and
4219 ;; provided directly by edebug.el and nadvice.el.
4220 (progn
4221 ;; frame =(backtrace-frame i-2)
4222 ;; nextframe=(backtrace-frame i-1)
4223 (funcall get-next-frame)
4224 ;; `pcase' would be a fairly good fit here, but it sometimes moves
4225 ;; branches within local functions, which then messes up the
4226 ;; `backtrace-frame' data we get,
4227 (or
4228 ;; Skip special forms (from non-compiled code).
4229 (and frame (null (car frame)))
4230 ;; Skip also `interactive-p' (because we don't want to know if
4231 ;; interactive-p was called interactively but if it's caller was)
4232 ;; and `byte-code' (idem; this appears in subexpressions of things
4233 ;; like condition-case, which are wrapped in a separate bytecode
4234 ;; chunk).
4235 ;; FIXME: For lexical-binding code, this is much worse,
4236 ;; because the frames look like "byte-code -> funcall -> #[...]",
4237 ;; which is not a reliable signature.
4238 (memq (nth 1 frame) '(interactive-p 'byte-code))
4239 ;; Skip package-specific stack-frames.
4240 (let ((skip (run-hook-with-args-until-success
4241 'called-interactively-p-functions
4242 i frame nextframe)))
4243 (pcase skip
4244 (`nil nil)
4245 (`0 t)
4246 (_ (setq i (+ i skip -1)) (funcall get-next-frame)))))))
4247 ;; Now `frame' should be "the function from which we were called".
4248 (pcase (cons frame nextframe)
4249 ;; No subr calls `interactive-p', so we can rule that out.
4250 (`((,_ ,(pred (lambda (f) (subrp (indirect-function f)))) . ,_) . ,_) nil)
31dca772
R
4251 ;; In case #<subr call-interactively> without going through the
4252 ;; `call-interactively' symbol (bug#3984).
4253 (`(,_ . (t ,(pred (eq internal--call-interactively)) . ,_)) t)
23ba2705
SM
4254 (`(,_ . (t call-interactively . ,_)) t)))))
4255
4256(defun interactive-p ()
4257 "Return t if the containing function was run directly by user input.
4258This means that the function was called with `call-interactively'
4259\(which includes being called as the binding of a key)
4260and input is currently coming from the keyboard (not a keyboard macro),
4261and Emacs is not running in batch mode (`noninteractive' is nil).
4262
4263The only known proper use of `interactive-p' is in deciding whether to
4264display a helpful message, or how to display it. If you're thinking
4265of using it for any other purpose, it is quite likely that you're
4266making a mistake. Think: what do you want to do when the command is
4267called from a keyboard macro or in batch mode?
4268
4269To test whether your function was called with `call-interactively',
4270either (i) add an extra optional argument and give it an `interactive'
4271spec that specifies non-nil unconditionally (such as \"p\"); or (ii)
4272use `called-interactively-p'."
4273 (declare (obsolete called-interactively-p "23.2"))
4274 (called-interactively-p 'interactive))
4275
c23d55f4
VS
4276(defun internal-push-keymap (keymap symbol)
4277 (let ((map (symbol-value symbol)))
4278 (unless (memq keymap map)
4279 (unless (memq 'add-keymap-witness (symbol-value symbol))
4280 (setq map (make-composed-keymap nil (symbol-value symbol)))
4281 (push 'add-keymap-witness (cdr map))
4282 (set symbol map))
4283 (push keymap (cdr map)))))
4284
4285(defun internal-pop-keymap (keymap symbol)
4286 (let ((map (symbol-value symbol)))
4287 (when (memq keymap map)
4288 (setf (cdr map) (delq keymap (cdr map))))
4289 (let ((tail (cddr map)))
4290 (and (or (null tail) (keymapp tail))
4291 (eq 'add-keymap-witness (nth 1 map))
4292 (set symbol tail)))))
4293
c8d89778
LL
4294(define-obsolete-function-alias
4295 'set-temporary-overlay-map 'set-transient-map "24.4")
4296
8cd22a08
CY
4297(defun set-transient-map (map &optional keep-pred on-exit)
4298 "Set MAP as a temporary keymap taking precedence over other keymaps.
4299Normally, MAP is used only once, to look up the very next key.
4300However, if the optional argument KEEP-PRED is t, MAP stays
4301active if a key from MAP is used. KEEP-PRED can also be a
4302function of no arguments: if it returns non-nil, then MAP stays
4303active.
4304
4305Optional arg ON-EXIT, if non-nil, specifies a function that is
4306called, with no arguments, after MAP is deactivated.
4307
ec00f20f
SM
4308This uses `overriding-terminal-local-map' which takes precedence over all other
4309keymaps. As usual, if no match for a key is found in MAP, the normal key
4310lookup sequence then continues."
8cd22a08 4311 (let ((clearfun (make-symbol "clear-transient-map")))
bf1e6ae8
SM
4312 ;; Don't use letrec, because equal (in add/remove-hook) would get trapped
4313 ;; in a cycle.
4314 (fset clearfun
4315 (lambda ()
8cd22a08 4316 (with-demoted-errors "set-transient-map PCH: %S"
ec00f20f 4317 (unless (cond
8889b935 4318 ((null keep-pred) nil)
ec00f20f
SM
4319 ((not (eq map (cadr overriding-terminal-local-map)))
4320 ;; There's presumably some other transient-map in
4321 ;; effect. Wait for that one to terminate before we
4322 ;; remove ourselves.
4323 ;; For example, if isearch and C-u both use transient
4324 ;; maps, then the lifetime of the C-u should be nested
4325 ;; within isearch's, so the pre-command-hook of
4326 ;; isearch should be suspended during the C-u one so
4327 ;; we don't exit isearch just because we hit 1 after
4328 ;; C-u and that 1 exits isearch whereas it doesn't
4329 ;; exit C-u.
4330 t)
ec00f20f
SM
4331 ((eq t keep-pred)
4332 (eq this-command
4333 (lookup-key map (this-command-keys-vector))))
4334 (t (funcall keep-pred)))
258ab3bc
SM
4335 (internal-pop-keymap map 'overriding-terminal-local-map)
4336 (remove-hook 'pre-command-hook clearfun)
4337 (when on-exit (funcall on-exit))))))
c23d55f4
VS
4338 (add-hook 'pre-command-hook clearfun)
4339 (internal-push-keymap map 'overriding-terminal-local-map)))
f95e9344 4340
c4f484f2 4341;;;; Progress reporters.
b4329caa
EZ
4342
4343;; Progress reporter has the following structure:
4344;;
4345;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
4346;; MIN-VALUE
4347;; MAX-VALUE
4348;; MESSAGE
4349;; MIN-CHANGE
4350;; MIN-TIME])
4351;;
ee7683eb 4352;; This weirdness is for optimization reasons: we want
b4329caa
EZ
4353;; `progress-reporter-update' to be as fast as possible, so
4354;; `(car reporter)' is better than `(aref reporter 0)'.
4355;;
4356;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
4357;; digits of precision, it doesn't really matter here. On the other
4358;; hand, it greatly simplifies the code.
4359
9326ba26 4360(defsubst progress-reporter-update (reporter &optional value)
c85152fc 4361 "Report progress of an operation in the echo area.
9326ba26
CY
4362REPORTER should be the result of a call to `make-progress-reporter'.
4363
4364If REPORTER is a numerical progress reporter---i.e. if it was
4365 made using non-nil MIN-VALUE and MAX-VALUE arguments to
4366 `make-progress-reporter'---then VALUE should be a number between
4367 MIN-VALUE and MAX-VALUE.
c85152fc 4368
9326ba26 4369If REPORTER is a non-numerical reporter, VALUE should be nil.
b4329caa 4370
9326ba26
CY
4371This function is relatively inexpensive. If the change since
4372last update is too small or insufficient time has passed, it does
4373nothing."
4374 (when (or (not (numberp value)) ; For pulsing reporter
4375 (>= value (car reporter))) ; For numerical reporter
4376 (progress-reporter-do-update reporter value)))
4377
4378(defun make-progress-reporter (message &optional min-value max-value
4379 current-value min-change min-time)
4380 "Return progress reporter object for use with `progress-reporter-update'.
4381
4382MESSAGE is shown in the echo area, with a status indicator
4383appended to the end. When you call `progress-reporter-done', the
4384word \"done\" is printed after the MESSAGE. You can change the
4385MESSAGE of an existing progress reporter by calling
4386`progress-reporter-force-update'.
4387
4388MIN-VALUE and MAX-VALUE, if non-nil, are starting (0% complete)
4389and final (100% complete) states of operation; the latter should
4390be larger. In this case, the status message shows the percentage
4391progress.
4392
4393If MIN-VALUE and/or MAX-VALUE is omitted or nil, the status
4394message shows a \"spinning\", non-numeric indicator.
4395
4396Optional CURRENT-VALUE is the initial progress; the default is
4397MIN-VALUE.
4398Optional MIN-CHANGE is the minimal change in percents to report;
4399the default is 1%.
4400CURRENT-VALUE and MIN-CHANGE do not have any effect if MIN-VALUE
4401and/or MAX-VALUE are nil.
4402
4403Optional MIN-TIME specifies the minimum interval time between
4404echo area updates (default is 0.2 seconds.) If the function
4405`float-time' is not present, time is not tracked at all. If the
4406OS is not capable of measuring fractions of seconds, this
4407parameter is effectively rounded up."
ea9fafe0
SM
4408 (when (string-match "[[:alnum:]]\\'" message)
4409 (setq message (concat message "...")))
b4329caa
EZ
4410 (unless min-time
4411 (setq min-time 0.2))
4412 (let ((reporter
9326ba26
CY
4413 ;; Force a call to `message' now
4414 (cons (or min-value 0)
b4329caa
EZ
4415 (vector (if (and (fboundp 'float-time)
4416 (>= min-time 0.02))
4417 (float-time) nil)
4418 min-value
4419 max-value
4420 message
4421 (if min-change (max (min min-change 50) 1) 1)
4422 min-time))))
4423 (progress-reporter-update reporter (or current-value min-value))
4424 reporter))
4425
9326ba26 4426(defun progress-reporter-force-update (reporter &optional value new-message)
b4329caa
EZ
4427 "Report progress of an operation in the echo area unconditionally.
4428
9326ba26
CY
4429The first two arguments are the same as in `progress-reporter-update'.
4430NEW-MESSAGE, if non-nil, sets a new message for the reporter."
b4329caa
EZ
4431 (let ((parameters (cdr reporter)))
4432 (when new-message
4433 (aset parameters 3 new-message))
4434 (when (aref parameters 0)
4435 (aset parameters 0 (float-time)))
4436 (progress-reporter-do-update reporter value)))
4437
9326ba26
CY
4438(defvar progress-reporter--pulse-characters ["-" "\\" "|" "/"]
4439 "Characters to use for pulsing progress reporters.")
4440
b4329caa
EZ
4441(defun progress-reporter-do-update (reporter value)
4442 (let* ((parameters (cdr reporter))
9326ba26 4443 (update-time (aref parameters 0))
b4329caa
EZ
4444 (min-value (aref parameters 1))
4445 (max-value (aref parameters 2))
9326ba26 4446 (text (aref parameters 3))
b4329caa
EZ
4447 (current-time (float-time))
4448 (enough-time-passed
4449 ;; See if enough time has passed since the last update.
4450 (or (not update-time)
4451 (when (>= current-time update-time)
4452 ;; Calculate time for the next update
4453 (aset parameters 0 (+ update-time (aref parameters 5)))))))
9326ba26
CY
4454 (cond ((and min-value max-value)
4455 ;; Numerical indicator
4456 (let* ((one-percent (/ (- max-value min-value) 100.0))
4457 (percentage (if (= max-value min-value)
4458 0
4459 (truncate (/ (- value min-value)
4460 one-percent)))))
4461 ;; Calculate NEXT-UPDATE-VALUE. If we are not printing
4462 ;; message because not enough time has passed, use 1
4463 ;; instead of MIN-CHANGE. This makes delays between echo
4464 ;; area updates closer to MIN-TIME.
4465 (setcar reporter
4466 (min (+ min-value (* (+ percentage
4467 (if enough-time-passed
4468 ;; MIN-CHANGE
4469 (aref parameters 4)
4470 1))
4471 one-percent))
4472 max-value))
4473 (when (integerp value)
4474 (setcar reporter (ceiling (car reporter))))
4475 ;; Only print message if enough time has passed
4476 (when enough-time-passed
4477 (if (> percentage 0)
4478 (message "%s%d%%" text percentage)
4479 (message "%s" text)))))
4480 ;; Pulsing indicator
4481 (enough-time-passed
4482 (let ((index (mod (1+ (car reporter)) 4))
4483 (message-log-max nil))
4484 (setcar reporter index)
4485 (message "%s %s"
4486 text
4487 (aref progress-reporter--pulse-characters
4488 index)))))))
b4329caa
EZ
4489
4490(defun progress-reporter-done (reporter)
4491 "Print reporter's message followed by word \"done\" in echo area."
4492 (message "%sdone" (aref (cdr reporter) 3)))
4493
aa56124a
SM
4494(defmacro dotimes-with-progress-reporter (spec message &rest body)
4495 "Loop a certain number of times and report progress in the echo area.
4496Evaluate BODY with VAR bound to successive integers running from
44970, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
4498the return value (nil if RESULT is omitted).
4499
4500At each iteration MESSAGE followed by progress percentage is
4501printed in the echo area. After the loop is finished, MESSAGE
4502followed by word \"done\" is printed. This macro is a
4503convenience wrapper around `make-progress-reporter' and friends.
4504
4505\(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
4506 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
4507 (let ((temp (make-symbol "--dotimes-temp--"))
4508 (temp2 (make-symbol "--dotimes-temp2--"))
4509 (start 0)
4510 (end (nth 1 spec)))
4511 `(let ((,temp ,end)
4512 (,(car spec) ,start)
4513 (,temp2 (make-progress-reporter ,message ,start ,end)))
4514 (while (< ,(car spec) ,temp)
4515 ,@body
4516 (progress-reporter-update ,temp2
4517 (setq ,(car spec) (1+ ,(car spec)))))
4518 (progress-reporter-done ,temp2)
4519 nil ,@(cdr (cdr spec)))))
ca548b00 4520
e9454757 4521\f
c4f484f2 4522;;;; Comparing version strings.
e9454757 4523
2f7f4bee 4524(defconst version-separator "."
b29f5b7b 4525 "Specify the string used to separate the version elements.
e9454757
VJL
4526
4527Usually the separator is \".\", but it can be any other string.")
4528
4529
2f7f4bee 4530(defconst version-regexp-alist
0d5363c4
BB
4531 '(("^[-_+ ]?snapshot$" . -4)
4532 ;; treat "1.2.3-20050920" and "1.2-3" as snapshot releases
4533 ("^[-_+]$" . -4)
4534 ;; treat "1.2.3-CVS" as snapshot release
4535 ("^[-_+ ]?\\(cvs\\|git\\|bzr\\|svn\\|hg\\|darcs\\)$" . -4)
4536 ("^[-_+ ]?alpha$" . -3)
4537 ("^[-_+ ]?beta$" . -2)
a3fed6ff 4538 ("^[-_+ ]?\\(pre\\|rc\\)$" . -1))
b29f5b7b 4539 "Specify association between non-numeric version and its priority.
e9454757
VJL
4540
4541This association is used to handle version string like \"1.0pre2\",
4542\"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
94785022 4543non-numeric part of a version string to an integer. For example:
e9454757
VJL
4544
4545 String Version Integer List Version
684d71c6
BB
4546 \"0.9snapshot\" (0 9 -4)
4547 \"1.0-git\" (1 0 -4)
e9454757
VJL
4548 \"1.0pre2\" (1 0 -1 2)
4549 \"1.0PRE2\" (1 0 -1 2)
4550 \"22.8beta3\" (22 8 -2 3)
c71abb54 4551 \"22.8 Beta3\" (22 8 -2 3)
e9454757
VJL
4552 \"0.9alpha1\" (0 9 -3 1)
4553 \"0.9AlphA1\" (0 9 -3 1)
c71abb54 4554 \"0.9 alpha\" (0 9 -3)
e9454757
VJL
4555
4556Each element has the following form:
4557
4558 (REGEXP . PRIORITY)
4559
4560Where:
4561
4562REGEXP regexp used to match non-numeric part of a version string.
94785022 4563 It should begin with the `^' anchor and end with a `$' to
d74a5c91
EZ
4564 prevent false hits. Letter-case is ignored while matching
4565 REGEXP.
e9454757 4566
94785022 4567PRIORITY a negative integer specifying non-numeric priority of REGEXP.")
e9454757
VJL
4568
4569
4570(defun version-to-list (ver)
94785022 4571 "Convert version string VER into a list of integers.
e9454757
VJL
4572
4573The version syntax is given by the following EBNF:
4574
4575 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
4576
4577 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
4578
4579 SEPARATOR ::= `version-separator' (which see)
4580 | `version-regexp-alist' (which see).
4581
d74a5c91
EZ
4582The NUMBER part is optional if SEPARATOR is a match for an element
4583in `version-regexp-alist'.
4584
94785022 4585Examples of valid version syntax:
e9454757 4586
d74a5c91 4587 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
e9454757 4588
94785022 4589Examples of invalid version syntax:
e9454757
VJL
4590
4591 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
4592
94785022 4593Examples of version conversion:
e9454757 4594
94785022 4595 Version String Version as a List of Integers
e9454757
VJL
4596 \"1.0.7.5\" (1 0 7 5)
4597 \"1.0pre2\" (1 0 -1 2)
4598 \"1.0PRE2\" (1 0 -1 2)
4599 \"22.8beta3\" (22 8 -2 3)
4600 \"22.8Beta3\" (22 8 -2 3)
4601 \"0.9alpha1\" (0 9 -3 1)
4602 \"0.9AlphA1\" (0 9 -3 1)
4603 \"0.9alpha\" (0 9 -3)
684d71c6
BB
4604 \"0.9snapshot\" (0 9 -4)
4605 \"1.0-git\" (1 0 -4)
e9454757
VJL
4606
4607See documentation for `version-separator' and `version-regexp-alist'."
c71abb54 4608 (or (and (stringp ver) (> (length ver) 0))
e9454757 4609 (error "Invalid version string: '%s'" ver))
c71abb54
KS
4610 ;; Change .x.y to 0.x.y
4611 (if (and (>= (length ver) (length version-separator))
4612 (string-equal (substring ver 0 (length version-separator))
c8227332 4613 version-separator))
c71abb54 4614 (setq ver (concat "0" ver)))
e9454757
VJL
4615 (save-match-data
4616 (let ((i 0)
d74a5c91 4617 (case-fold-search t) ; ignore case in matching
e9454757
VJL
4618 lst s al)
4619 (while (and (setq s (string-match "[0-9]+" ver i))
4620 (= s i))
4621 ;; handle numeric part
4622 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
4623 lst)
4624 i (match-end 0))
4625 ;; handle non-numeric part
4626 (when (and (setq s (string-match "[^0-9]+" ver i))
4627 (= s i))
4628 (setq s (substring ver i (match-end 0))
4629 i (match-end 0))
4630 ;; handle alpha, beta, pre, etc. separator
4631 (unless (string= s version-separator)
4632 (setq al version-regexp-alist)
4633 (while (and al (not (string-match (caar al) s)))
4634 (setq al (cdr al)))
e2046ecf
CY
4635 (cond (al
4636 (push (cdar al) lst))
b29f5b7b 4637 ;; Convert 22.3a to 22.3.1, 22.3b to 22.3.2, etc.
e2046ecf
CY
4638 ((string-match "^[-_+ ]?\\([a-zA-Z]\\)$" s)
4639 (push (- (aref (downcase (match-string 1 s)) 0) ?a -1)
4640 lst))
4641 (t (error "Invalid version syntax: '%s'" ver))))))
e9454757
VJL
4642 (if (null lst)
4643 (error "Invalid version syntax: '%s'" ver)
4644 (nreverse lst)))))
4645
4646
ca548b00 4647(defun version-list-< (l1 l2)
94785022 4648 "Return t if L1, a list specification of a version, is lower than L2.
e9454757 4649
94785022
EZ
4650Note that a version specified by the list (1) is equal to (1 0),
4651\(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4652Also, a version given by the list (1) is higher than (1 -1), which in
4653turn is higher than (1 -2), which is higher than (1 -3)."
e9454757
VJL
4654 (while (and l1 l2 (= (car l1) (car l2)))
4655 (setq l1 (cdr l1)
4656 l2 (cdr l2)))
4657 (cond
4658 ;; l1 not null and l2 not null
4659 ((and l1 l2) (< (car l1) (car l2)))
4660 ;; l1 null and l2 null ==> l1 length = l2 length
4661 ((and (null l1) (null l2)) nil)
4662 ;; l1 not null and l2 null ==> l1 length > l2 length
ca548b00 4663 (l1 (< (version-list-not-zero l1) 0))
e9454757 4664 ;; l1 null and l2 not null ==> l2 length > l1 length
ca548b00 4665 (t (< 0 (version-list-not-zero l2)))))
e9454757
VJL
4666
4667
ca548b00 4668(defun version-list-= (l1 l2)
94785022 4669 "Return t if L1, a list specification of a version, is equal to L2.
e9454757 4670
94785022
EZ
4671Note that a version specified by the list (1) is equal to (1 0),
4672\(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
4673Also, a version given by the list (1) is higher than (1 -1), which in
4674turn is higher than (1 -2), which is higher than (1 -3)."
e9454757
VJL
4675 (while (and l1 l2 (= (car l1) (car l2)))
4676 (setq l1 (cdr l1)
4677 l2 (cdr l2)))
4678 (cond
4679 ;; l1 not null and l2 not null
4680 ((and l1 l2) nil)
4681 ;; l1 null and l2 null ==> l1 length = l2 length
4682 ((and (null l1) (null l2)))
4683 ;; l1 not null and l2 null ==> l1 length > l2 length
ca548b00 4684 (l1 (zerop (version-list-not-zero l1)))
e9454757 4685 ;; l1 null and l2 not null ==> l2 length > l1 length
ca548b00 4686 (t (zerop (version-list-not-zero l2)))))
e9454757
VJL
4687
4688
ca548b00 4689(defun version-list-<= (l1 l2)
94785022 4690 "Return t if L1, a list specification of a version, is lower or equal to L2.
e9454757
VJL
4691
4692Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
b29f5b7b 4693etc. That is, the trailing zeroes are insignificant. Also, integer
e9454757
VJL
4694list (1) is greater than (1 -1) which is greater than (1 -2)
4695which is greater than (1 -3)."
4696 (while (and l1 l2 (= (car l1) (car l2)))
4697 (setq l1 (cdr l1)
4698 l2 (cdr l2)))
4699 (cond
4700 ;; l1 not null and l2 not null
4701 ((and l1 l2) (< (car l1) (car l2)))
4702 ;; l1 null and l2 null ==> l1 length = l2 length
4703 ((and (null l1) (null l2)))
4704 ;; l1 not null and l2 null ==> l1 length > l2 length
ca548b00 4705 (l1 (<= (version-list-not-zero l1) 0))
e9454757 4706 ;; l1 null and l2 not null ==> l2 length > l1 length
ca548b00 4707 (t (<= 0 (version-list-not-zero l2)))))
e9454757 4708
ca548b00 4709(defun version-list-not-zero (lst)
94785022 4710 "Return the first non-zero element of LST, which is a list of integers.
e9454757 4711
94785022 4712If all LST elements are zeros or LST is nil, return zero."
ca548b00
KS
4713 (while (and lst (zerop (car lst)))
4714 (setq lst (cdr lst)))
4715 (if lst
4716 (car lst)
4717 ;; there is no element different of zero
4718 0))
e9454757
VJL
4719
4720
4721(defun version< (v1 v2)
94785022 4722 "Return t if version V1 is lower (older) than V2.
e9454757
VJL
4723
4724Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
94785022
EZ
4725etc. That is, the trailing \".0\"s are insignificant. Also, version
4726string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
46b0a07f
BB
4727which is higher than \"1alpha\", which is higher than \"1snapshot\".
4728Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions."
ca548b00 4729 (version-list-< (version-to-list v1) (version-to-list v2)))
e9454757 4730
e9454757 4731(defun version<= (v1 v2)
94785022 4732 "Return t if version V1 is lower (older) than or equal to V2.
e9454757
VJL
4733
4734Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
b29f5b7b 4735etc. That is, the trailing \".0\"s are insignificant. Also, version
94785022 4736string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
46b0a07f
BB
4737which is higher than \"1alpha\", which is higher than \"1snapshot\".
4738Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions."
ca548b00 4739 (version-list-<= (version-to-list v1) (version-to-list v2)))
e9454757 4740
ca548b00
KS
4741(defun version= (v1 v2)
4742 "Return t if version V1 is equal to V2.
e9454757 4743
ca548b00 4744Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
b29f5b7b 4745etc. That is, the trailing \".0\"s are insignificant. Also, version
94785022 4746string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
46b0a07f
BB
4747which is higher than \"1alpha\", which is higher than \"1snapshot\".
4748Also, \"-GIT\", \"-CVS\" and \"-NNN\" are treated as snapshot versions."
ca548b00 4749 (version-list-= (version-to-list v1) (version-to-list v2)))
e9454757 4750
18d433a7
CY
4751\f
4752;;; Misc.
a3c20c83
DN
4753(defconst menu-bar-separator '("--")
4754 "Separator for menus.")
18d433a7
CY
4755
4756;; The following statement ought to be in print.c, but `provide' can't
4757;; be used there.
5612fd08 4758;; http://lists.gnu.org/archive/html/emacs-devel/2009-08/msg00236.html
18d433a7
CY
4759(when (hash-table-p (car (read-from-string
4760 (prin1-to-string (make-hash-table)))))
4761 (provide 'hashtable-print-readable))
4762
629ecae3
EZ
4763;; This is used in lisp/Makefile.in and in leim/Makefile.in to
4764;; generate file names for autoloads, custom-deps, and finder-data.
bc1dd793 4765(defun unmsys--file-name (file)
a052ef3b 4766 "Produce the canonical file name for FILE from its MSYS form.
1c0977a9
EZ
4767
4768On systems other than MS-Windows, just returns FILE.
4769On MS-Windows, converts /d/foo/bar form of file names
4770passed by MSYS Make into d:/foo/bar that Emacs can grok.
4771
a052ef3b 4772This function is called from lisp/Makefile and leim/Makefile."
1c0977a9
EZ
4773 (when (and (eq system-type 'windows-nt)
4774 (string-match "\\`/[a-zA-Z]/" file))
4775 (setq file (concat (substring file 1 2) ":" (substring file 2))))
4776 file)
4777
4778
630cc463 4779;;; subr.el ends here