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