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