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