Commit | Line | Data |
---|---|---|
c88ab9ce | 1 | ;;; subr.el --- basic lisp subroutines for Emacs |
630cc463 | 2 | |
a8a64811 | 3 | ;; Copyright (C) 1985, 1986, 1992, 1994, 1995, 1999, 2000, 2001, 2002, 2003, |
114f9c96 | 4 | ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. |
be9b65ac | 5 | |
30764597 PJ |
6 | ;; Maintainer: FSF |
7 | ;; Keywords: internal | |
8 | ||
be9b65ac DL |
9 | ;; This file is part of GNU Emacs. |
10 | ||
eb3fa2cf | 11 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
be9b65ac | 12 | ;; it under the terms of the GNU General Public License as published by |
eb3fa2cf GM |
13 | ;; the Free Software Foundation, either version 3 of the License, or |
14 | ;; (at your option) any later version. | |
be9b65ac DL |
15 | |
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | ;; GNU General Public License for more details. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
eb3fa2cf | 22 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
be9b65ac | 23 | |
60370d40 PJ |
24 | ;;; Commentary: |
25 | ||
630cc463 | 26 | ;;; Code: |
d0fc47ed | 27 | |
77a5664f RS |
28 | (defvar custom-declare-variable-list nil |
29 | "Record `defcustom' calls made before `custom.el' is loaded to handle them. | |
30 | Each element of this list holds the arguments to one call to `defcustom'.") | |
31 | ||
68e3e5f5 | 32 | ;; Use this, rather than defcustom, in subr.el and other files loaded |
77a5664f RS |
33 | ;; before custom.el. |
34 | (defun custom-declare-variable-early (&rest arguments) | |
35 | (setq custom-declare-variable-list | |
36 | (cons arguments custom-declare-variable-list))) | |
2c642c03 | 37 | |
708bb6f8 RS |
38 | (defmacro declare-function (fn file &optional arglist fileonly) |
39 | "Tell the byte-compiler that function FN is defined, in FILE. | |
40 | Optional ARGLIST is the argument list used by the function. The | |
41 | FILE argument is not used by the byte-compiler, but by the | |
42 | `check-declare' package, which checks that FILE contains a | |
43 | definition for FN. ARGLIST is used by both the byte-compiler and | |
44 | `check-declare' to check for consistency. | |
45 | ||
46 | FILE can be either a Lisp file (in which case the \".el\" | |
47 | extension is optional), or a C file. C files are expanded | |
48 | relative to the Emacs \"src/\" directory. Lisp files are | |
49 | searched for using `locate-library', and if that fails they are | |
50 | expanded relative to the location of the file containing the | |
51 | declaration. A FILE with an \"ext:\" prefix is an external file. | |
52 | `check-declare' will check such files if they are found, and skip | |
53 | them without error if they are not. | |
54 | ||
55 | FILEONLY non-nil means that `check-declare' will only check that | |
56 | FILE exists, not that it defines FN. This is intended for | |
57 | function-definitions that `check-declare' does not recognize, e.g. | |
58 | `defstruct'. | |
59 | ||
60 | To specify a value for FILEONLY without passing an argument list, | |
61 | set ARGLIST to `t'. This is necessary because `nil' means an | |
62 | empty argument list, rather than an unspecified one. | |
63 | ||
64 | Note that for the purposes of `check-declare', this statement | |
a4d2c321 | 65 | must be the first non-whitespace on a line. |
708bb6f8 | 66 | |
83031738 | 67 | For more information, see Info node `(elisp)Declaring Functions'." |
708bb6f8 RS |
68 | ;; Does nothing - byte-compile-declare-function does the work. |
69 | nil) | |
e224699a | 70 | |
2c642c03 | 71 | \f |
c4f484f2 | 72 | ;;;; Basic Lisp macros. |
9a5336ae | 73 | |
0764e16f SM |
74 | (defalias 'not 'null) |
75 | ||
6b61353c | 76 | (defmacro noreturn (form) |
70c6db6c LT |
77 | "Evaluate FORM, expecting it not to return. |
78 | If FORM does return, signal an error." | |
6b61353c KH |
79 | `(prog1 ,form |
80 | (error "Form marked with `noreturn' did return"))) | |
81 | ||
82 | (defmacro 1value (form) | |
70c6db6c LT |
83 | "Evaluate FORM, expecting a constant return value. |
84 | This is the global do-nothing version. There is also `testcover-1value' | |
85 | that complains if FORM ever does return differing values." | |
6b61353c KH |
86 | form) |
87 | ||
8285ccd2 RS |
88 | (defmacro def-edebug-spec (symbol spec) |
89 | "Set the `edebug-form-spec' property of SYMBOL according to SPEC. | |
e32721f5 GM |
90 | Both SYMBOL and SPEC are unevaluated. The SPEC can be: |
91 | 0 (instrument no arguments); t (instrument all arguments); | |
92 | a symbol (naming a function with an Edebug specification); or a list. | |
93 | The elements of the list describe the argument types; see | |
94 | \(info \"(elisp)Specification List\") for details." | |
8285ccd2 RS |
95 | `(put (quote ,symbol) 'edebug-form-spec (quote ,spec))) |
96 | ||
9a5336ae JB |
97 | (defmacro lambda (&rest cdr) |
98 | "Return a lambda expression. | |
99 | A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is | |
100 | self-quoting; the result of evaluating the lambda expression is the | |
101 | expression itself. The lambda expression may then be treated as a | |
bec0d7f9 | 102 | function, i.e., stored as the function value of a symbol, passed to |
265b3f2a | 103 | `funcall' or `mapcar', etc. |
bec0d7f9 | 104 | |
9a5336ae | 105 | ARGS should take the same form as an argument list for a `defun'. |
8fd68088 RS |
106 | DOCSTRING is an optional documentation string. |
107 | If present, it should describe how to call the function. | |
108 | But documentation strings are usually not useful in nameless functions. | |
9a5336ae JB |
109 | INTERACTIVE should be a call to the function `interactive', which see. |
110 | It may also be omitted. | |
a478f3e1 JB |
111 | BODY should be a list of Lisp expressions. |
112 | ||
113 | \(fn ARGS [DOCSTRING] [INTERACTIVE] BODY)" | |
9a5336ae JB |
114 | ;; Note that this definition should not use backquotes; subr.el should not |
115 | ;; depend on backquote.el. | |
116 | (list 'function (cons 'lambda cdr))) | |
117 | ||
a69c67e8 CY |
118 | (if (null (featurep 'cl)) |
119 | (progn | |
354f0faf SM |
120 | ;; If we reload subr.el after having loaded CL, be careful not to |
121 | ;; overwrite CL's extended definition of `dolist', `dotimes', | |
122 | ;; `declare', `push' and `pop'. | |
1be152fc | 123 | (defmacro push (newelt listname) |
fa65505b | 124 | "Add NEWELT to the list stored in the symbol LISTNAME. |
1be152fc | 125 | This is equivalent to (setq LISTNAME (cons NEWELT LISTNAME)). |
d270117a | 126 | LISTNAME must be a symbol." |
f30e0cd8 | 127 | (declare (debug (form sexp))) |
22d85d00 | 128 | (list 'setq listname |
354f0faf | 129 | (list 'cons newelt listname))) |
d270117a RS |
130 | |
131 | (defmacro pop (listname) | |
132 | "Return the first element of LISTNAME's value, and remove it from the list. | |
133 | LISTNAME must be a symbol whose value is a list. | |
134 | If the value is nil, `pop' returns nil but does not actually | |
135 | change the list." | |
f30e0cd8 | 136 | (declare (debug (sexp))) |
54993fa4 | 137 | (list 'car |
354f0faf | 138 | (list 'prog1 listname |
a69c67e8 CY |
139 | (list 'setq listname (list 'cdr listname))))) |
140 | )) | |
d270117a | 141 | |
debff3c3 | 142 | (defmacro when (cond &rest body) |
7f67eea0 KS |
143 | "If COND yields non-nil, do BODY, else return nil. |
144 | When COND yields non-nil, eval BODY forms sequentially and return | |
145 | value of last one, or nil if there are none. | |
146 | ||
ebc3ae14 | 147 | \(fn COND BODY...)" |
d47f7515 | 148 | (declare (indent 1) (debug t)) |
debff3c3 | 149 | (list 'if cond (cons 'progn body))) |
9a5336ae | 150 | |
debff3c3 | 151 | (defmacro unless (cond &rest body) |
7f67eea0 KS |
152 | "If COND yields nil, do BODY, else return nil. |
153 | When COND yields nil, eval BODY forms sequentially and return | |
154 | value of last one, or nil if there are none. | |
155 | ||
ebc3ae14 | 156 | \(fn COND BODY...)" |
d47f7515 | 157 | (declare (indent 1) (debug t)) |
debff3c3 | 158 | (cons 'if (cons cond (cons nil body)))) |
d370591d | 159 | |
a69c67e8 CY |
160 | (if (null (featurep 'cl)) |
161 | (progn | |
354f0faf SM |
162 | ;; If we reload subr.el after having loaded CL, be careful not to |
163 | ;; overwrite CL's extended definition of `dolist', `dotimes', | |
164 | ;; `declare', `push' and `pop'. | |
01d16e16 RS |
165 | (defvar --dolist-tail-- nil |
166 | "Temporary variable used in `dolist' expansion.") | |
167 | ||
a0b0756a | 168 | (defmacro dolist (spec &rest body) |
d47f7515 | 169 | "Loop over a list. |
a0b0756a | 170 | Evaluate BODY with VAR bound to each car from LIST, in turn. |
d47f7515 SM |
171 | Then evaluate RESULT to get return value, default nil. |
172 | ||
d775d486 | 173 | \(fn (VAR LIST [RESULT]) BODY...)" |
d47f7515 | 174 | (declare (indent 1) (debug ((symbolp form &optional form) body))) |
01d16e16 RS |
175 | ;; It would be cleaner to create an uninterned symbol, |
176 | ;; but that uses a lot more space when many functions in many files | |
177 | ;; use dolist. | |
178 | (let ((temp '--dolist-tail--)) | |
d47f7515 SM |
179 | `(let ((,temp ,(nth 1 spec)) |
180 | ,(car spec)) | |
181 | (while ,temp | |
182 | (setq ,(car spec) (car ,temp)) | |
01d16e16 RS |
183 | ,@body |
184 | (setq ,temp (cdr ,temp))) | |
d47f7515 SM |
185 | ,@(if (cdr (cdr spec)) |
186 | `((setq ,(car spec) nil) ,@(cdr (cdr spec))))))) | |
a0b0756a | 187 | |
01d16e16 RS |
188 | (defvar --dotimes-limit-- nil |
189 | "Temporary variable used in `dotimes' expansion.") | |
190 | ||
a0b0756a | 191 | (defmacro dotimes (spec &rest body) |
d47f7515 | 192 | "Loop a certain number of times. |
a0b0756a RS |
193 | Evaluate BODY with VAR bound to successive integers running from 0, |
194 | inclusive, to COUNT, exclusive. Then evaluate RESULT to get | |
d47f7515 SM |
195 | the return value (nil if RESULT is omitted). |
196 | ||
d775d486 | 197 | \(fn (VAR COUNT [RESULT]) BODY...)" |
d47f7515 | 198 | (declare (indent 1) (debug dolist)) |
01d16e16 RS |
199 | ;; It would be cleaner to create an uninterned symbol, |
200 | ;; but that uses a lot more space when many functions in many files | |
201 | ;; use dotimes. | |
202 | (let ((temp '--dotimes-limit--) | |
d47f7515 SM |
203 | (start 0) |
204 | (end (nth 1 spec))) | |
205 | `(let ((,temp ,end) | |
206 | (,(car spec) ,start)) | |
207 | (while (< ,(car spec) ,temp) | |
208 | ,@body | |
209 | (setq ,(car spec) (1+ ,(car spec)))) | |
210 | ,@(cdr (cdr spec))))) | |
a0b0756a | 211 | |
6b61353c KH |
212 | (defmacro declare (&rest specs) |
213 | "Do not evaluate any arguments and return nil. | |
214 | Treated as a declaration when used at the right place in a | |
a478f3e1 | 215 | `defmacro' form. \(See Info anchor `(elisp)Definition of declare'.)" |
a69c67e8 CY |
216 | nil) |
217 | )) | |
6b5de136 GM |
218 | |
219 | (defmacro ignore-errors (&rest body) | |
220 | "Execute BODY; if an error occurs, return nil. | |
221 | Otherwise, return result of last form in BODY." | |
222 | `(condition-case nil (progn ,@body) (error nil))) | |
c4f484f2 RS |
223 | \f |
224 | ;;;; Basic Lisp functions. | |
225 | ||
226 | (defun ignore (&rest ignore) | |
227 | "Do nothing and return nil. | |
228 | This function accepts any number of arguments, but ignores them." | |
229 | (interactive) | |
230 | nil) | |
231 | ||
fd6c5134 | 232 | ;; Signal a compile-error if the first arg is missing. |
c4f484f2 RS |
233 | (defun error (&rest args) |
234 | "Signal an error, making error message by passing all args to `format'. | |
235 | In Emacs, the convention is that error messages start with a capital | |
236 | letter but *do not* end with a period. Please follow this convention | |
fd6c5134 | 237 | for the sake of consistency." |
c4f484f2 RS |
238 | (while t |
239 | (signal 'error (list (apply 'format args))))) | |
f3ed9aca | 240 | (set-advertised-calling-convention 'error '(string &rest args)) |
c4f484f2 RS |
241 | |
242 | ;; We put this here instead of in frame.el so that it's defined even on | |
243 | ;; systems where frame.el isn't loaded. | |
244 | (defun frame-configuration-p (object) | |
245 | "Return non-nil if OBJECT seems to be a frame configuration. | |
246 | Any list whose car is `frame-configuration' is assumed to be a frame | |
247 | configuration." | |
248 | (and (consp object) | |
249 | (eq (car object) 'frame-configuration))) | |
250 | ||
251 | (defun functionp (object) | |
fc944cd4 | 252 | "Non-nil if OBJECT is a function." |
c4f484f2 RS |
253 | (or (and (symbolp object) (fboundp object) |
254 | (condition-case nil | |
255 | (setq object (indirect-function object)) | |
256 | (error nil)) | |
257 | (eq (car-safe object) 'autoload) | |
258 | (not (car-safe (cdr-safe (cdr-safe (cdr-safe (cdr-safe object))))))) | |
fc944cd4 SM |
259 | (and (subrp object) |
260 | ;; Filter out special forms. | |
261 | (not (eq 'unevalled (cdr (subr-arity object))))) | |
262 | (byte-code-function-p object) | |
c4f484f2 | 263 | (eq (car-safe object) 'lambda))) |
c4f484f2 RS |
264 | \f |
265 | ;;;; List functions. | |
6b61353c | 266 | |
d370591d RS |
267 | (defsubst caar (x) |
268 | "Return the car of the car of X." | |
269 | (car (car x))) | |
270 | ||
271 | (defsubst cadr (x) | |
272 | "Return the car of the cdr of X." | |
273 | (car (cdr x))) | |
274 | ||
275 | (defsubst cdar (x) | |
276 | "Return the cdr of the car of X." | |
277 | (cdr (car x))) | |
278 | ||
279 | (defsubst cddr (x) | |
280 | "Return the cdr of the cdr of X." | |
281 | (cdr (cdr x))) | |
e8c32c99 | 282 | |
a478f3e1 JB |
283 | (defun last (list &optional n) |
284 | "Return the last link of LIST. Its car is the last element. | |
285 | If LIST is nil, return nil. | |
286 | If N is non-nil, return the Nth-to-last link of LIST. | |
287 | If N is bigger than the length of LIST, return LIST." | |
369fba5f | 288 | (if n |
a478f3e1 | 289 | (let ((m 0) (p list)) |
369fba5f RS |
290 | (while (consp p) |
291 | (setq m (1+ m) p (cdr p))) | |
292 | (if (<= n 0) p | |
a478f3e1 JB |
293 | (if (< n m) (nthcdr (- m n) list) list))) |
294 | (while (consp (cdr list)) | |
295 | (setq list (cdr list))) | |
296 | list)) | |
526d204e | 297 | |
a478f3e1 | 298 | (defun butlast (list &optional n) |
a3111ae4 | 299 | "Return a copy of LIST with the last N elements removed." |
a478f3e1 JB |
300 | (if (and n (<= n 0)) list |
301 | (nbutlast (copy-sequence list) n))) | |
1c1c65de | 302 | |
a478f3e1 | 303 | (defun nbutlast (list &optional n) |
1c1c65de | 304 | "Modifies LIST to remove the last N elements." |
a478f3e1 | 305 | (let ((m (length list))) |
1c1c65de KH |
306 | (or n (setq n 1)) |
307 | (and (< n m) | |
308 | (progn | |
a478f3e1 JB |
309 | (if (> n 0) (setcdr (nthcdr (- (1- m) n) list) nil)) |
310 | list)))) | |
1c1c65de | 311 | |
6b61353c KH |
312 | (defun delete-dups (list) |
313 | "Destructively remove `equal' duplicates from LIST. | |
314 | Store the result in LIST and return it. LIST must be a proper list. | |
315 | Of several `equal' occurrences of an element in LIST, the first | |
316 | one is kept." | |
317 | (let ((tail list)) | |
318 | (while tail | |
319 | (setcdr tail (delete (car tail) (cdr tail))) | |
320 | (setq tail (cdr tail)))) | |
321 | list) | |
322 | ||
0ed2c9b6 | 323 | (defun number-sequence (from &optional to inc) |
abd9177a | 324 | "Return a sequence of numbers from FROM to TO (both inclusive) as a list. |
6b61353c KH |
325 | INC is the increment used between numbers in the sequence and defaults to 1. |
326 | So, the Nth element of the list is \(+ FROM \(* N INC)) where N counts from | |
327 | zero. TO is only included if there is an N for which TO = FROM + N * INC. | |
328 | If TO is nil or numerically equal to FROM, return \(FROM). | |
329 | If INC is positive and TO is less than FROM, or INC is negative | |
330 | and TO is larger than FROM, return nil. | |
331 | If INC is zero and TO is neither nil nor numerically equal to | |
332 | FROM, signal an error. | |
333 | ||
334 | This function is primarily designed for integer arguments. | |
335 | Nevertheless, FROM, TO and INC can be integer or float. However, | |
336 | floating point arithmetic is inexact. For instance, depending on | |
337 | the machine, it may quite well happen that | |
338 | \(number-sequence 0.4 0.6 0.2) returns the one element list \(0.4), | |
339 | whereas \(number-sequence 0.4 0.8 0.2) returns a list with three | |
340 | elements. Thus, if some of the arguments are floats and one wants | |
341 | to make sure that TO is included, one may have to explicitly write | |
342 | TO as \(+ FROM \(* N INC)) or use a variable whose value was | |
343 | computed with this exact expression. Alternatively, you can, | |
344 | of course, also replace TO with a slightly larger value | |
345 | \(or a slightly more negative value if INC is negative)." | |
346 | (if (or (not to) (= from to)) | |
0ed2c9b6 VJL |
347 | (list from) |
348 | (or inc (setq inc 1)) | |
6b61353c KH |
349 | (when (zerop inc) (error "The increment can not be zero")) |
350 | (let (seq (n 0) (next from)) | |
351 | (if (> inc 0) | |
352 | (while (<= next to) | |
353 | (setq seq (cons next seq) | |
354 | n (1+ n) | |
355 | next (+ from (* n inc)))) | |
356 | (while (>= next to) | |
357 | (setq seq (cons next seq) | |
358 | n (1+ n) | |
359 | next (+ from (* n inc))))) | |
0ed2c9b6 | 360 | (nreverse seq)))) |
abd9177a | 361 | |
a176c9eb CW |
362 | (defun copy-tree (tree &optional vecp) |
363 | "Make a copy of TREE. | |
364 | If TREE is a cons cell, this recursively copies both its car and its cdr. | |
cfebd4db | 365 | Contrast to `copy-sequence', which copies only along the cdrs. With second |
a176c9eb CW |
366 | argument VECP, this copies vectors as well as conses." |
367 | (if (consp tree) | |
cfebd4db RS |
368 | (let (result) |
369 | (while (consp tree) | |
370 | (let ((newcar (car tree))) | |
371 | (if (or (consp (car tree)) (and vecp (vectorp (car tree)))) | |
372 | (setq newcar (copy-tree (car tree) vecp))) | |
373 | (push newcar result)) | |
374 | (setq tree (cdr tree))) | |
68b08950 | 375 | (nconc (nreverse result) tree)) |
a176c9eb CW |
376 | (if (and vecp (vectorp tree)) |
377 | (let ((i (length (setq tree (copy-sequence tree))))) | |
378 | (while (>= (setq i (1- i)) 0) | |
cfebd4db RS |
379 | (aset tree i (copy-tree (aref tree i) vecp))) |
380 | tree) | |
381 | tree))) | |
c4f484f2 RS |
382 | \f |
383 | ;;;; Various list-search functions. | |
a176c9eb | 384 | |
8a288450 RS |
385 | (defun assoc-default (key alist &optional test default) |
386 | "Find object KEY in a pseudo-alist ALIST. | |
753bc4f6 CY |
387 | ALIST is a list of conses or objects. Each element |
388 | (or the element's car, if it is a cons) is compared with KEY by | |
389 | calling TEST, with two arguments: (i) the element or its car, | |
390 | and (ii) KEY. | |
391 | If that is non-nil, the element matches; then `assoc-default' | |
392 | returns the element's cdr, if it is a cons, or DEFAULT if the | |
393 | element is not a cons. | |
8a288450 RS |
394 | |
395 | If no element matches, the value is nil. | |
396 | If TEST is omitted or nil, `equal' is used." | |
397 | (let (found (tail alist) value) | |
398 | (while (and tail (not found)) | |
399 | (let ((elt (car tail))) | |
400 | (when (funcall (or test 'equal) (if (consp elt) (car elt) elt) key) | |
401 | (setq found t value (if (consp elt) (cdr elt) default)))) | |
402 | (setq tail (cdr tail))) | |
403 | value)) | |
98aae5f6 | 404 | |
2b69ccfd | 405 | (make-obsolete 'assoc-ignore-case 'assoc-string "22.1") |
98aae5f6 KH |
406 | (defun assoc-ignore-case (key alist) |
407 | "Like `assoc', but ignores differences in case and text representation. | |
408 | KEY must be a string. Upper-case and lower-case letters are treated as equal. | |
409 | Unibyte strings are converted to multibyte for comparison." | |
6b61353c | 410 | (assoc-string key alist t)) |
98aae5f6 | 411 | |
2b69ccfd | 412 | (make-obsolete 'assoc-ignore-representation 'assoc-string "22.1") |
98aae5f6 KH |
413 | (defun assoc-ignore-representation (key alist) |
414 | "Like `assoc', but ignores differences in text representation. | |
264ef586 | 415 | KEY must be a string. |
98aae5f6 | 416 | Unibyte strings are converted to multibyte for comparison." |
6b61353c | 417 | (assoc-string key alist nil)) |
cbbc3205 GM |
418 | |
419 | (defun member-ignore-case (elt list) | |
420 | "Like `member', but ignores differences in case and text representation. | |
421 | ELT must be a string. Upper-case and lower-case letters are treated as equal. | |
d86a3084 RS |
422 | Unibyte strings are converted to multibyte for comparison. |
423 | Non-strings in LIST are ignored." | |
424 | (while (and list | |
425 | (not (and (stringp (car list)) | |
426 | (eq t (compare-strings elt 0 nil (car list) 0 nil t))))) | |
242c13e8 MB |
427 | (setq list (cdr list))) |
428 | list) | |
cbbc3205 | 429 | |
c4f484f2 RS |
430 | (defun assq-delete-all (key alist) |
431 | "Delete from ALIST all elements whose car is `eq' to KEY. | |
432 | Return the modified alist. | |
433 | Elements of ALIST that are not conses are ignored." | |
434 | (while (and (consp (car alist)) | |
435 | (eq (car (car alist)) key)) | |
436 | (setq alist (cdr alist))) | |
437 | (let ((tail alist) tail-cdr) | |
438 | (while (setq tail-cdr (cdr tail)) | |
439 | (if (and (consp (car tail-cdr)) | |
440 | (eq (car (car tail-cdr)) key)) | |
441 | (setcdr tail (cdr tail-cdr)) | |
442 | (setq tail tail-cdr)))) | |
443 | alist) | |
444 | ||
445 | (defun rassq-delete-all (value alist) | |
446 | "Delete from ALIST all elements whose cdr is `eq' to VALUE. | |
447 | Return the modified alist. | |
448 | Elements of ALIST that are not conses are ignored." | |
449 | (while (and (consp (car alist)) | |
450 | (eq (cdr (car alist)) value)) | |
451 | (setq alist (cdr alist))) | |
452 | (let ((tail alist) tail-cdr) | |
453 | (while (setq tail-cdr (cdr tail)) | |
454 | (if (and (consp (car tail-cdr)) | |
455 | (eq (cdr (car tail-cdr)) value)) | |
456 | (setcdr tail (cdr tail-cdr)) | |
457 | (setq tail tail-cdr)))) | |
458 | alist) | |
459 | ||
460 | (defun remove (elt seq) | |
461 | "Return a copy of SEQ with all occurrences of ELT removed. | |
462 | SEQ must be a list, vector, or string. The comparison is done with `equal'." | |
463 | (if (nlistp seq) | |
464 | ;; If SEQ isn't a list, there's no need to copy SEQ because | |
465 | ;; `delete' will return a new object. | |
466 | (delete elt seq) | |
467 | (delete elt (copy-sequence seq)))) | |
468 | ||
469 | (defun remq (elt list) | |
470 | "Return LIST with all occurrences of ELT removed. | |
471 | The comparison is done with `eq'. Contrary to `delq', this does not use | |
472 | side-effects, and the argument LIST is not modified." | |
473 | (if (memq elt list) | |
474 | (delq elt (copy-sequence list)) | |
475 | list)) | |
9a5336ae | 476 | \f |
9a5336ae | 477 | ;;;; Keymap support. |
be9b65ac | 478 | |
c4f484f2 RS |
479 | (defmacro kbd (keys) |
480 | "Convert KEYS to the internal Emacs key representation. | |
481 | KEYS should be a string constant in the format used for | |
482 | saving keyboard macros (see `edmacro-mode')." | |
483 | (read-kbd-macro keys)) | |
484 | ||
be9b65ac DL |
485 | (defun undefined () |
486 | (interactive) | |
487 | (ding)) | |
488 | ||
c4f484f2 RS |
489 | ;; Prevent the \{...} documentation construct |
490 | ;; from mentioning keys that run this command. | |
be9b65ac DL |
491 | (put 'undefined 'suppress-keymap t) |
492 | ||
493 | (defun suppress-keymap (map &optional nodigits) | |
494 | "Make MAP override all normally self-inserting keys to be undefined. | |
495 | Normally, as an exception, digits and minus-sign are set to make prefix args, | |
496 | but optional second arg NODIGITS non-nil treats them like other chars." | |
098ba983 | 497 | (define-key map [remap self-insert-command] 'undefined) |
be9b65ac DL |
498 | (or nodigits |
499 | (let (loop) | |
500 | (define-key map "-" 'negative-argument) | |
501 | ;; Make plain numbers do numeric args. | |
502 | (setq loop ?0) | |
503 | (while (<= loop ?9) | |
504 | (define-key map (char-to-string loop) 'digit-argument) | |
505 | (setq loop (1+ loop)))))) | |
506 | ||
4ced66fd | 507 | (defun define-key-after (keymap key definition &optional after) |
4434d61b RS |
508 | "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding. |
509 | This is like `define-key' except that the binding for KEY is placed | |
510 | just after the binding for the event AFTER, instead of at the beginning | |
c34a9d34 RS |
511 | of the map. Note that AFTER must be an event type (like KEY), NOT a command |
512 | \(like DEFINITION). | |
513 | ||
4ced66fd | 514 | If AFTER is t or omitted, the new binding goes at the end of the keymap. |
08b1f8a1 | 515 | AFTER should be a single event type--a symbol or a character, not a sequence. |
c34a9d34 | 516 | |
4ced66fd | 517 | Bindings are always added before any inherited map. |
c34a9d34 | 518 | |
4ced66fd DL |
519 | The order of bindings in a keymap matters when it is used as a menu." |
520 | (unless after (setq after t)) | |
4434d61b RS |
521 | (or (keymapp keymap) |
522 | (signal 'wrong-type-argument (list 'keymapp keymap))) | |
08b1f8a1 GM |
523 | (setq key |
524 | (if (<= (length key) 1) (aref key 0) | |
525 | (setq keymap (lookup-key keymap | |
526 | (apply 'vector | |
527 | (butlast (mapcar 'identity key))))) | |
528 | (aref key (1- (length key))))) | |
529 | (let ((tail keymap) done inserted) | |
4434d61b RS |
530 | (while (and (not done) tail) |
531 | ;; Delete any earlier bindings for the same key. | |
08b1f8a1 | 532 | (if (eq (car-safe (car (cdr tail))) key) |
4434d61b | 533 | (setcdr tail (cdr (cdr tail)))) |
08b1f8a1 GM |
534 | ;; If we hit an included map, go down that one. |
535 | (if (keymapp (car tail)) (setq tail (car tail))) | |
4434d61b RS |
536 | ;; When we reach AFTER's binding, insert the new binding after. |
537 | ;; If we reach an inherited keymap, insert just before that. | |
113d28a8 | 538 | ;; If we reach the end of this keymap, insert at the end. |
c34a9d34 RS |
539 | (if (or (and (eq (car-safe (car tail)) after) |
540 | (not (eq after t))) | |
113d28a8 RS |
541 | (eq (car (cdr tail)) 'keymap) |
542 | (null (cdr tail))) | |
4434d61b | 543 | (progn |
113d28a8 RS |
544 | ;; Stop the scan only if we find a parent keymap. |
545 | ;; Keep going past the inserted element | |
546 | ;; so we can delete any duplications that come later. | |
547 | (if (eq (car (cdr tail)) 'keymap) | |
548 | (setq done t)) | |
549 | ;; Don't insert more than once. | |
550 | (or inserted | |
08b1f8a1 | 551 | (setcdr tail (cons (cons key definition) (cdr tail)))) |
113d28a8 | 552 | (setq inserted t))) |
4434d61b RS |
553 | (setq tail (cdr tail))))) |
554 | ||
a10cca6c | 555 | (defun map-keymap-sorted (function keymap) |
14694a59 RS |
556 | "Implement `map-keymap' with sorting. |
557 | Don't call this function; it is for internal use only." | |
a10cca6c SM |
558 | (let (list) |
559 | (map-keymap (lambda (a b) (push (cons a b) list)) | |
560 | keymap) | |
561 | (setq list (sort list | |
562 | (lambda (a b) | |
563 | (setq a (car a) b (car b)) | |
564 | (if (integerp a) | |
565 | (if (integerp b) (< a b) | |
566 | t) | |
567 | (if (integerp b) t | |
568 | ;; string< also accepts symbols. | |
569 | (string< a b)))))) | |
570 | (dolist (p list) | |
571 | (funcall function (car p) (cdr p))))) | |
51fa3961 | 572 | |
00f7c5ed SM |
573 | (defun keymap-canonicalize (map) |
574 | "Return an equivalent keymap, without inheritance." | |
575 | (let ((bindings ()) | |
c099a588 AS |
576 | (ranges ()) |
577 | (prompt (keymap-prompt map))) | |
00f7c5ed SM |
578 | (while (keymapp map) |
579 | (setq map (map-keymap-internal | |
580 | (lambda (key item) | |
581 | (if (consp key) | |
582 | ;; Treat char-ranges specially. | |
583 | (push (cons key item) ranges) | |
584 | (push (cons key item) bindings))) | |
585 | map))) | |
c099a588 | 586 | (setq map (funcall (if ranges 'make-keymap 'make-sparse-keymap) prompt)) |
00f7c5ed SM |
587 | (dolist (binding ranges) |
588 | ;; Treat char-ranges specially. | |
64981d1a | 589 | (define-key map (vector (car binding)) (cdr binding))) |
00f7c5ed SM |
590 | (dolist (binding (prog1 bindings (setq bindings ()))) |
591 | (let* ((key (car binding)) | |
592 | (item (cdr binding)) | |
593 | (oldbind (assq key bindings))) | |
594 | ;; Newer bindings override older. | |
595 | (if oldbind (setq bindings (delq oldbind bindings))) | |
596 | (when item ;nil bindings just hide older ones. | |
597 | (push binding bindings)))) | |
598 | (nconc map bindings))) | |
599 | ||
8bed5e3d RS |
600 | (put 'keyboard-translate-table 'char-table-extra-slots 0) |
601 | ||
9a5336ae JB |
602 | (defun keyboard-translate (from to) |
603 | "Translate character FROM to TO at a low level. | |
604 | This function creates a `keyboard-translate-table' if necessary | |
605 | and then modifies one entry in it." | |
8bed5e3d RS |
606 | (or (char-table-p keyboard-translate-table) |
607 | (setq keyboard-translate-table | |
608 | (make-char-table 'keyboard-translate-table nil))) | |
9a5336ae | 609 | (aset keyboard-translate-table from to)) |
9a5336ae | 610 | \f |
c4f484f2 | 611 | ;;;; Key binding commands. |
9a5336ae | 612 | |
c4f484f2 RS |
613 | (defun global-set-key (key command) |
614 | "Give KEY a global binding as COMMAND. | |
615 | COMMAND is the command definition to use; usually it is | |
616 | a symbol naming an interactively-callable function. | |
617 | KEY is a key sequence; noninteractively, it is a string or vector | |
618 | of characters or event types, and non-ASCII characters with codes | |
619 | above 127 (such as ISO Latin-1) can be included if you use a vector. | |
9a5336ae | 620 | |
c4f484f2 RS |
621 | Note that if KEY has a local binding in the current buffer, |
622 | that local binding will continue to shadow any global binding | |
623 | that you make with this function." | |
624 | (interactive "KSet key globally: \nCSet key %s to command: ") | |
625 | (or (vectorp key) (stringp key) | |
626 | (signal 'wrong-type-argument (list 'arrayp key))) | |
627 | (define-key (current-global-map) key command)) | |
9a5336ae | 628 | |
c4f484f2 RS |
629 | (defun local-set-key (key command) |
630 | "Give KEY a local binding as COMMAND. | |
631 | COMMAND is the command definition to use; usually it is | |
632 | a symbol naming an interactively-callable function. | |
633 | KEY is a key sequence; noninteractively, it is a string or vector | |
634 | of characters or event types, and non-ASCII characters with codes | |
635 | above 127 (such as ISO Latin-1) can be included if you use a vector. | |
9a5336ae | 636 | |
c4f484f2 RS |
637 | The binding goes in the current buffer's local map, |
638 | which in most cases is shared with all other buffers in the same major mode." | |
639 | (interactive "KSet key locally: \nCSet key %s locally to command: ") | |
640 | (let ((map (current-local-map))) | |
641 | (or map | |
642 | (use-local-map (setq map (make-sparse-keymap)))) | |
643 | (or (vectorp key) (stringp key) | |
644 | (signal 'wrong-type-argument (list 'arrayp key))) | |
645 | (define-key map key command))) | |
9a5336ae | 646 | |
c4f484f2 RS |
647 | (defun global-unset-key (key) |
648 | "Remove global binding of KEY. | |
649 | KEY is a string or vector representing a sequence of keystrokes." | |
650 | (interactive "kUnset key globally: ") | |
651 | (global-set-key key nil)) | |
9a5336ae | 652 | |
c4f484f2 RS |
653 | (defun local-unset-key (key) |
654 | "Remove local binding of KEY. | |
655 | KEY is a string or vector representing a sequence of keystrokes." | |
656 | (interactive "kUnset key locally: ") | |
657 | (if (current-local-map) | |
658 | (local-set-key key nil)) | |
659 | nil) | |
660 | \f | |
661 | ;;;; substitute-key-definition and its subroutines. | |
662 | ||
663 | (defvar key-substitution-in-progress nil | |
c8227332 | 664 | "Used internally by `substitute-key-definition'.") |
c4f484f2 RS |
665 | |
666 | (defun substitute-key-definition (olddef newdef keymap &optional oldmap prefix) | |
667 | "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF. | |
668 | In other words, OLDDEF is replaced with NEWDEF where ever it appears. | |
669 | Alternatively, if optional fourth argument OLDMAP is specified, we redefine | |
670 | in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP. | |
671 | ||
fda11e85 RS |
672 | If you don't specify OLDMAP, you can usually get the same results |
673 | in a cleaner way with command remapping, like this: | |
50d16788 JB |
674 | \(define-key KEYMAP [remap OLDDEF] NEWDEF) |
675 | \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)" | |
c4f484f2 RS |
676 | ;; Don't document PREFIX in the doc string because we don't want to |
677 | ;; advertise it. It's meant for recursive calls only. Here's its | |
678 | ;; meaning | |
679 | ||
680 | ;; If optional argument PREFIX is specified, it should be a key | |
681 | ;; prefix, a string. Redefined bindings will then be bound to the | |
682 | ;; original key, with PREFIX added at the front. | |
683 | (or prefix (setq prefix "")) | |
684 | (let* ((scan (or oldmap keymap)) | |
685 | (prefix1 (vconcat prefix [nil])) | |
686 | (key-substitution-in-progress | |
687 | (cons scan key-substitution-in-progress))) | |
688 | ;; Scan OLDMAP, finding each char or event-symbol that | |
689 | ;; has any definition, and act on it with hack-key. | |
690 | (map-keymap | |
691 | (lambda (char defn) | |
692 | (aset prefix1 (length prefix) char) | |
693 | (substitute-key-definition-key defn olddef newdef prefix1 keymap)) | |
694 | scan))) | |
695 | ||
696 | (defun substitute-key-definition-key (defn olddef newdef prefix keymap) | |
697 | (let (inner-def skipped menu-item) | |
698 | ;; Find the actual command name within the binding. | |
699 | (if (eq (car-safe defn) 'menu-item) | |
700 | (setq menu-item defn defn (nth 2 defn)) | |
701 | ;; Skip past menu-prompt. | |
702 | (while (stringp (car-safe defn)) | |
703 | (push (pop defn) skipped)) | |
704 | ;; Skip past cached key-equivalence data for menu items. | |
705 | (if (consp (car-safe defn)) | |
706 | (setq defn (cdr defn)))) | |
707 | (if (or (eq defn olddef) | |
708 | ;; Compare with equal if definition is a key sequence. | |
709 | ;; That is useful for operating on function-key-map. | |
710 | (and (or (stringp defn) (vectorp defn)) | |
711 | (equal defn olddef))) | |
712 | (define-key keymap prefix | |
713 | (if menu-item | |
714 | (let ((copy (copy-sequence menu-item))) | |
715 | (setcar (nthcdr 2 copy) newdef) | |
716 | copy) | |
717 | (nconc (nreverse skipped) newdef))) | |
718 | ;; Look past a symbol that names a keymap. | |
719 | (setq inner-def | |
cf25c647 | 720 | (or (indirect-function defn t) defn)) |
c4f484f2 RS |
721 | ;; For nested keymaps, we use `inner-def' rather than `defn' so as to |
722 | ;; avoid autoloading a keymap. This is mostly done to preserve the | |
723 | ;; original non-autoloading behavior of pre-map-keymap times. | |
724 | (if (and (keymapp inner-def) | |
725 | ;; Avoid recursively scanning | |
726 | ;; where KEYMAP does not have a submap. | |
727 | (let ((elt (lookup-key keymap prefix))) | |
728 | (or (null elt) (natnump elt) (keymapp elt))) | |
729 | ;; Avoid recursively rescanning keymap being scanned. | |
730 | (not (memq inner-def key-substitution-in-progress))) | |
731 | ;; If this one isn't being scanned already, scan it now. | |
732 | (substitute-key-definition olddef newdef keymap inner-def prefix))))) | |
9a5336ae JB |
733 | |
734 | \f | |
264ef586 | 735 | ;;;; The global keymap tree. |
9a5336ae | 736 | |
354f0faf SM |
737 | ;; global-map, esc-map, and ctl-x-map have their values set up in |
738 | ;; keymap.c; we just give them docstrings here. | |
9a5336ae JB |
739 | |
740 | (defvar global-map nil | |
741 | "Default global keymap mapping Emacs keyboard input into commands. | |
742 | The value is a keymap which is usually (but not necessarily) Emacs's | |
743 | global map.") | |
744 | ||
745 | (defvar esc-map nil | |
746 | "Default keymap for ESC (meta) commands. | |
747 | The normal global definition of the character ESC indirects to this keymap.") | |
748 | ||
749 | (defvar ctl-x-map nil | |
750 | "Default keymap for C-x commands. | |
751 | The normal global definition of the character C-x indirects to this keymap.") | |
752 | ||
753 | (defvar ctl-x-4-map (make-sparse-keymap) | |
03eeb110 | 754 | "Keymap for subcommands of C-x 4.") |
059184dd | 755 | (defalias 'ctl-x-4-prefix ctl-x-4-map) |
9a5336ae JB |
756 | (define-key ctl-x-map "4" 'ctl-x-4-prefix) |
757 | ||
758 | (defvar ctl-x-5-map (make-sparse-keymap) | |
759 | "Keymap for frame commands.") | |
059184dd | 760 | (defalias 'ctl-x-5-prefix ctl-x-5-map) |
9a5336ae JB |
761 | (define-key ctl-x-map "5" 'ctl-x-5-prefix) |
762 | ||
0f03054a | 763 | \f |
9a5336ae JB |
764 | ;;;; Event manipulation functions. |
765 | ||
03a74b84 | 766 | (defconst listify-key-sequence-1 (logior 128 ?\M-\C-@)) |
114137b8 | 767 | |
cde6d7e3 RS |
768 | (defun listify-key-sequence (key) |
769 | "Convert a key sequence to a list of events." | |
770 | (if (vectorp key) | |
771 | (append key nil) | |
772 | (mapcar (function (lambda (c) | |
773 | (if (> c 127) | |
114137b8 | 774 | (logxor c listify-key-sequence-1) |
cde6d7e3 | 775 | c))) |
d47f7515 | 776 | key))) |
cde6d7e3 | 777 | |
53e5a4e8 RS |
778 | (defsubst eventp (obj) |
779 | "True if the argument is an event object." | |
7a2937ce SM |
780 | (or (and (integerp obj) |
781 | ;; Filter out integers too large to be events. | |
782 | ;; M is the biggest modifier. | |
783 | (zerop (logand obj (lognot (1- (lsh ?\M-\^@ 1))))) | |
327719ee | 784 | (characterp (event-basic-type obj))) |
53e5a4e8 RS |
785 | (and (symbolp obj) |
786 | (get obj 'event-symbol-elements)) | |
787 | (and (consp obj) | |
788 | (symbolp (car obj)) | |
789 | (get (car obj) 'event-symbol-elements)))) | |
790 | ||
791 | (defun event-modifiers (event) | |
a3111ae4 | 792 | "Return a list of symbols representing the modifier keys in event EVENT. |
53e5a4e8 | 793 | The elements of the list may include `meta', `control', |
32295976 | 794 | `shift', `hyper', `super', `alt', `click', `double', `triple', `drag', |
0e91dc92 LT |
795 | and `down'. |
796 | EVENT may be an event or an event type. If EVENT is a symbol | |
797 | that has never been used in an event that has been read as input | |
798 | in the current Emacs session, then this function can return nil, | |
799 | even when EVENT actually has modifiers." | |
53e5a4e8 RS |
800 | (let ((type event)) |
801 | (if (listp type) | |
802 | (setq type (car type))) | |
803 | (if (symbolp type) | |
58da34c7 SM |
804 | ;; Don't read event-symbol-elements directly since we're not |
805 | ;; sure the symbol has already been parsed. | |
806 | (cdr (internal-event-symbol-parse-modifiers type)) | |
5572c97f RS |
807 | (let ((list nil) |
808 | (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@ | |
809 | ?\H-\^@ ?\s-\^@ ?\A-\^@))))) | |
810 | (if (not (zerop (logand type ?\M-\^@))) | |
9166dbf6 | 811 | (push 'meta list)) |
5572c97f RS |
812 | (if (or (not (zerop (logand type ?\C-\^@))) |
813 | (< char 32)) | |
9166dbf6 | 814 | (push 'control list)) |
5572c97f RS |
815 | (if (or (not (zerop (logand type ?\S-\^@))) |
816 | (/= char (downcase char))) | |
9166dbf6 | 817 | (push 'shift list)) |
da16e648 | 818 | (or (zerop (logand type ?\H-\^@)) |
9166dbf6 | 819 | (push 'hyper list)) |
da16e648 | 820 | (or (zerop (logand type ?\s-\^@)) |
9166dbf6 | 821 | (push 'super list)) |
da16e648 | 822 | (or (zerop (logand type ?\A-\^@)) |
9166dbf6 | 823 | (push 'alt list)) |
53e5a4e8 RS |
824 | list)))) |
825 | ||
d63de416 | 826 | (defun event-basic-type (event) |
a3111ae4 | 827 | "Return the basic type of the given event (all modifiers removed). |
0e91dc92 LT |
828 | The value is a printing character (not upper case) or a symbol. |
829 | EVENT may be an event or an event type. If EVENT is a symbol | |
830 | that has never been used in an event that has been read as input | |
831 | in the current Emacs session, then this function may return nil." | |
2b0f4ba5 JB |
832 | (if (consp event) |
833 | (setq event (car event))) | |
d63de416 RS |
834 | (if (symbolp event) |
835 | (car (get event 'event-symbol-elements)) | |
9aca2476 RS |
836 | (let* ((base (logand event (1- ?\A-\^@))) |
837 | (uncontrolled (if (< base 32) (logior base 64) base))) | |
838 | ;; There are some numbers that are invalid characters and | |
839 | ;; cause `downcase' to get an error. | |
840 | (condition-case () | |
841 | (downcase uncontrolled) | |
842 | (error uncontrolled))))) | |
d63de416 | 843 | |
0f03054a RS |
844 | (defsubst mouse-movement-p (object) |
845 | "Return non-nil if OBJECT is a mouse movement event." | |
9166dbf6 | 846 | (eq (car-safe object) 'mouse-movement)) |
0f03054a | 847 | |
5ad4f91c SS |
848 | (defun mouse-event-p (object) |
849 | "Return non-nil if OBJECT is a mouse click event." | |
850 | ;; is this really correct? maybe remove mouse-movement? | |
851 | (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement))) | |
852 | ||
0f03054a RS |
853 | (defsubst event-start (event) |
854 | "Return the starting position of EVENT. | |
6b61353c | 855 | If EVENT is a mouse or key press or a mouse click, this returns the location |
0f03054a RS |
856 | of the event. |
857 | If EVENT is a drag, this returns the drag's starting position. | |
858 | The return value is of the form | |
6b61353c KH |
859 | (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW) |
860 | IMAGE (DX . DY) (WIDTH . HEIGHT)) | |
0f03054a | 861 | The `posn-' functions access elements of such lists." |
5ef6a86d SM |
862 | (if (consp event) (nth 1 event) |
863 | (list (selected-window) (point) '(0 . 0) 0))) | |
0f03054a RS |
864 | |
865 | (defsubst event-end (event) | |
6b61353c KH |
866 | "Return the ending location of EVENT. |
867 | EVENT should be a click, drag, or key press event. | |
0f03054a RS |
868 | If EVENT is a click event, this function is the same as `event-start'. |
869 | The return value is of the form | |
6b61353c KH |
870 | (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW) |
871 | IMAGE (DX . DY) (WIDTH . HEIGHT)) | |
0f03054a | 872 | The `posn-' functions access elements of such lists." |
5ef6a86d SM |
873 | (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event) |
874 | (list (selected-window) (point) '(0 . 0) 0))) | |
0f03054a | 875 | |
32295976 RS |
876 | (defsubst event-click-count (event) |
877 | "Return the multi-click count of EVENT, a click or drag event. | |
878 | The return value is a positive integer." | |
5ef6a86d | 879 | (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1)) |
c4f484f2 RS |
880 | \f |
881 | ;;;; Extracting fields of the positions in an event. | |
32295976 | 882 | |
0f03054a RS |
883 | (defsubst posn-window (position) |
884 | "Return the window in POSITION. | |
6b61353c KH |
885 | POSITION should be a list of the form returned by the `event-start' |
886 | and `event-end' functions." | |
0f03054a RS |
887 | (nth 0 position)) |
888 | ||
6b61353c KH |
889 | (defsubst posn-area (position) |
890 | "Return the window area recorded in POSITION, or nil for the text area. | |
891 | POSITION should be a list of the form returned by the `event-start' | |
892 | and `event-end' functions." | |
893 | (let ((area (if (consp (nth 1 position)) | |
894 | (car (nth 1 position)) | |
895 | (nth 1 position)))) | |
896 | (and (symbolp area) area))) | |
897 | ||
0f03054a RS |
898 | (defsubst posn-point (position) |
899 | "Return the buffer location in POSITION. | |
6b61353c KH |
900 | POSITION should be a list of the form returned by the `event-start' |
901 | and `event-end' functions." | |
902 | (or (nth 5 position) | |
903 | (if (consp (nth 1 position)) | |
904 | (car (nth 1 position)) | |
905 | (nth 1 position)))) | |
906 | ||
907 | (defun posn-set-point (position) | |
908 | "Move point to POSITION. | |
909 | Select the corresponding window as well." | |
c8227332 VJL |
910 | (if (not (windowp (posn-window position))) |
911 | (error "Position not in text area of window")) | |
912 | (select-window (posn-window position)) | |
913 | (if (numberp (posn-point position)) | |
914 | (goto-char (posn-point position)))) | |
0f03054a | 915 | |
e55c21be RS |
916 | (defsubst posn-x-y (position) |
917 | "Return the x and y coordinates in POSITION. | |
6b61353c KH |
918 | POSITION should be a list of the form returned by the `event-start' |
919 | and `event-end' functions." | |
0f03054a RS |
920 | (nth 2 position)) |
921 | ||
aa360da1 GM |
922 | (declare-function scroll-bar-scale "scroll-bar" (num-denom whole)) |
923 | ||
ed627e08 | 924 | (defun posn-col-row (position) |
6b61353c KH |
925 | "Return the nominal column and row in POSITION, measured in characters. |
926 | The column and row values are approximations calculated from the x | |
927 | and y coordinates in POSITION and the frame's default character width | |
928 | and height. | |
ed627e08 | 929 | For a scroll-bar event, the result column is 0, and the row |
6b61353c KH |
930 | corresponds to the vertical position of the click in the scroll bar. |
931 | POSITION should be a list of the form returned by the `event-start' | |
932 | and `event-end' functions." | |
933 | (let* ((pair (posn-x-y position)) | |
934 | (window (posn-window position)) | |
935 | (area (posn-area position))) | |
936 | (cond | |
937 | ((null window) | |
938 | '(0 . 0)) | |
939 | ((eq area 'vertical-scroll-bar) | |
940 | (cons 0 (scroll-bar-scale pair (1- (window-height window))))) | |
941 | ((eq area 'horizontal-scroll-bar) | |
942 | (cons (scroll-bar-scale pair (window-width window)) 0)) | |
943 | (t | |
944 | (let* ((frame (if (framep window) window (window-frame window))) | |
7beba943 CY |
945 | ;; FIXME: This should take line-spacing properties on |
946 | ;; newlines into account. | |
947 | (spacing (when (display-graphic-p frame) | |
948 | (or (with-current-buffer (window-buffer window) | |
949 | line-spacing) | |
950 | (frame-parameter frame 'line-spacing))))) | |
951 | (cond ((floatp spacing) | |
952 | (setq spacing (truncate (* spacing | |
953 | (frame-char-height frame))))) | |
954 | ((null spacing) | |
955 | (setq spacing 0))) | |
956 | (cons (/ (car pair) (frame-char-width frame)) | |
957 | (/ (cdr pair) (+ (frame-char-height frame) spacing)))))))) | |
6b61353c KH |
958 | |
959 | (defun posn-actual-col-row (position) | |
960 | "Return the actual column and row in POSITION, measured in characters. | |
961 | These are the actual row number in the window and character number in that row. | |
962 | Return nil if POSITION does not contain the actual position; in that case | |
963 | `posn-col-row' can be used to get approximate values. | |
964 | POSITION should be a list of the form returned by the `event-start' | |
965 | and `event-end' functions." | |
966 | (nth 6 position)) | |
e55c21be | 967 | |
0f03054a RS |
968 | (defsubst posn-timestamp (position) |
969 | "Return the timestamp of POSITION. | |
6b61353c KH |
970 | POSITION should be a list of the form returned by the `event-start' |
971 | and `event-end' functions." | |
0f03054a | 972 | (nth 3 position)) |
9a5336ae | 973 | |
6b61353c | 974 | (defsubst posn-string (position) |
79a09c9c KS |
975 | "Return the string object of POSITION. |
976 | Value is a cons (STRING . STRING-POS), or nil if not a string. | |
6b61353c KH |
977 | POSITION should be a list of the form returned by the `event-start' |
978 | and `event-end' functions." | |
979 | (nth 4 position)) | |
980 | ||
981 | (defsubst posn-image (position) | |
79a09c9c | 982 | "Return the image object of POSITION. |
0c3f75f6 | 983 | Value is a list (image ...), or nil if not an image. |
6b61353c KH |
984 | POSITION should be a list of the form returned by the `event-start' |
985 | and `event-end' functions." | |
986 | (nth 7 position)) | |
987 | ||
988 | (defsubst posn-object (position) | |
989 | "Return the object (image or string) of POSITION. | |
79a09c9c KS |
990 | Value is a list (image ...) for an image object, a cons cell |
991 | \(STRING . STRING-POS) for a string object, and nil for a buffer position. | |
6b61353c KH |
992 | POSITION should be a list of the form returned by the `event-start' |
993 | and `event-end' functions." | |
994 | (or (posn-image position) (posn-string position))) | |
995 | ||
996 | (defsubst posn-object-x-y (position) | |
997 | "Return the x and y coordinates relative to the object of POSITION. | |
998 | POSITION should be a list of the form returned by the `event-start' | |
999 | and `event-end' functions." | |
1000 | (nth 8 position)) | |
1001 | ||
1002 | (defsubst posn-object-width-height (position) | |
1003 | "Return the pixel width and height of the object of POSITION. | |
1004 | POSITION should be a list of the form returned by the `event-start' | |
1005 | and `event-end' functions." | |
1006 | (nth 9 position)) | |
1007 | ||
0f03054a | 1008 | \f |
9a5336ae JB |
1009 | ;;;; Obsolescent names for functions. |
1010 | ||
9d28c33e SM |
1011 | (define-obsolete-function-alias 'window-dot 'window-point "22.1") |
1012 | (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1") | |
1013 | (define-obsolete-function-alias 'read-input 'read-string "22.1") | |
1014 | (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1") | |
1015 | (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1") | |
1016 | (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1") | |
1017 | ||
1018 | (make-obsolete 'char-bytes "now always returns 1." "20.4") | |
1019 | (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1") | |
1020 | ||
1021 | (defun insert-string (&rest args) | |
1022 | "Mocklisp-compatibility insert function. | |
1023 | Like the function `insert' except that any argument that is a number | |
1024 | is converted into a string by expressing it in decimal." | |
1025 | (dolist (el args) | |
1026 | (insert (if (integerp el) (number-to-string el) el)))) | |
1027 | (make-obsolete 'insert-string 'insert "22.1") | |
1028 | ||
1029 | (defun makehash (&optional test) (make-hash-table :test (or test 'eql))) | |
1030 | (make-obsolete 'makehash 'make-hash-table "22.1") | |
1031 | ||
1032 | ;; These are used by VM and some old programs | |
1033 | (defalias 'focus-frame 'ignore "") | |
1034 | (make-obsolete 'focus-frame "it does nothing." "22.1") | |
1035 | (defalias 'unfocus-frame 'ignore "") | |
1036 | (make-obsolete 'unfocus-frame "it does nothing." "22.1") | |
1037 | (make-obsolete 'make-variable-frame-local | |
1038 | "explicitly check for a frame-parameter instead." "22.2") | |
1039 | (make-obsolete 'interactive-p 'called-interactively-p "23.2") | |
1040 | (set-advertised-calling-convention 'called-interactively-p '(kind)) | |
4fcc3d32 SM |
1041 | (set-advertised-calling-convention |
1042 | 'all-completions '(string collection &optional predicate)) | |
9d28c33e SM |
1043 | \f |
1044 | ;;;; Obsolescence declarations for variables, and aliases. | |
1045 | ||
4e3b4528 SM |
1046 | ;; Special "default-FOO" variables which contain the default value of |
1047 | ;; the "FOO" variable are nasty. Their implementation is brittle, and | |
1048 | ;; slows down several unrelated variable operations; furthermore, they | |
1049 | ;; can lead to really odd behavior if you decide to make them | |
1050 | ;; buffer-local. | |
1051 | ||
1052 | ;; Not used at all in Emacs, last time I checked: | |
1053 | (make-obsolete-variable 'default-mode-line-format 'mode-line-format "23.2") | |
1054 | (make-obsolete-variable 'default-header-line-format 'header-line-format "23.2") | |
1055 | (make-obsolete-variable 'default-line-spacing 'line-spacing "23.2") | |
1056 | (make-obsolete-variable 'default-abbrev-mode 'abbrev-mode "23.2") | |
1057 | (make-obsolete-variable 'default-ctl-arrow 'ctl-arrow "23.2") | |
1058 | (make-obsolete-variable 'default-direction-reversed 'direction-reversed "23.2") | |
1059 | (make-obsolete-variable 'default-truncate-lines 'truncate-lines "23.2") | |
1060 | (make-obsolete-variable 'default-left-margin 'left-margin "23.2") | |
1061 | (make-obsolete-variable 'default-tab-width 'tab-width "23.2") | |
1062 | (make-obsolete-variable 'default-case-fold-search 'case-fold-search "23.2") | |
1063 | (make-obsolete-variable 'default-left-margin-width 'left-margin-width "23.2") | |
1064 | (make-obsolete-variable 'default-right-margin-width 'right-margin-width "23.2") | |
1065 | (make-obsolete-variable 'default-left-fringe-width 'left-fringe-width "23.2") | |
1066 | (make-obsolete-variable 'default-right-fringe-width 'right-fringe-width "23.2") | |
1067 | (make-obsolete-variable 'default-fringes-outside-margins 'fringes-outside-margins "23.2") | |
1068 | (make-obsolete-variable 'default-scroll-bar-width 'scroll-bar-width "23.2") | |
1069 | (make-obsolete-variable 'default-vertical-scroll-bar 'vertical-scroll-bar "23.2") | |
1070 | (make-obsolete-variable 'default-indicate-empty-lines 'indicate-empty-lines "23.2") | |
1071 | (make-obsolete-variable 'default-indicate-buffer-boundaries 'indicate-buffer-boundaries "23.2") | |
1072 | (make-obsolete-variable 'default-fringe-indicator-alist 'fringe-indicator-alist "23.2") | |
1073 | (make-obsolete-variable 'default-fringe-cursor-alist 'fringe-cursor-alist "23.2") | |
1074 | (make-obsolete-variable 'default-scroll-up-aggressively 'scroll-up-aggressively "23.2") | |
1075 | (make-obsolete-variable 'default-scroll-down-aggressively 'scroll-down-aggressively "23.2") | |
1076 | (make-obsolete-variable 'default-fill-column 'fill-column "23.2") | |
1077 | (make-obsolete-variable 'default-cursor-type 'cursor-type "23.2") | |
1078 | (make-obsolete-variable 'default-buffer-file-type 'buffer-file-type "23.2") | |
1079 | (make-obsolete-variable 'default-cursor-in-non-selected-windows 'cursor-in-non-selected-windows "23.2") | |
1080 | (make-obsolete-variable 'default-buffer-file-coding-system 'buffer-file-coding-system "23.2") | |
1081 | (make-obsolete-variable 'default-major-mode 'major-mode "23.2") | |
1082 | (make-obsolete-variable 'default-enable-multibyte-characters | |
1083 | "use enable-multibyte-characters or set-buffer-multibyte instead" "23.2") | |
1084 | ||
50d4ba39 | 1085 | (make-obsolete-variable 'define-key-rebound-commands nil "23.2") |
379ec02c SM |
1086 | (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1") |
1087 | (make-obsolete 'window-redisplay-end-trigger nil "23.1") | |
1088 | (make-obsolete 'set-window-redisplay-end-trigger nil "23.1") | |
1089 | ||
1090 | (make-obsolete 'process-filter-multibyte-p nil "23.1") | |
1091 | (make-obsolete 'set-process-filter-multibyte nil "23.1") | |
1092 | ||
bd292357 | 1093 | (make-obsolete-variable 'directory-sep-char "do not use it." "21.1") |
c8227332 VJL |
1094 | (make-obsolete-variable |
1095 | 'mode-line-inverse-video | |
1096 | "use the appropriate faces instead." | |
1097 | "21.1") | |
1098 | (make-obsolete-variable | |
1099 | 'unread-command-char | |
1100 | "use `unread-command-events' instead. That variable is a list of events | |
304bbefc | 1101 | to reread, so it now uses nil to mean `no event', instead of -1." |
c8227332 | 1102 | "before 19.15") |
bd292357 | 1103 | |
8ee7e9db LT |
1104 | ;; Lisp manual only updated in 22.1. |
1105 | (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro | |
c8227332 | 1106 | "before 19.34") |
8ee7e9db | 1107 | |
0ecd53f8 | 1108 | (defvaralias 'x-lost-selection-hooks 'x-lost-selection-functions) |
c8227332 VJL |
1109 | (make-obsolete-variable 'x-lost-selection-hooks |
1110 | 'x-lost-selection-functions "22.1") | |
0ecd53f8 | 1111 | (defvaralias 'x-sent-selection-hooks 'x-sent-selection-functions) |
c8227332 VJL |
1112 | (make-obsolete-variable 'x-sent-selection-hooks |
1113 | 'x-sent-selection-functions "22.1") | |
9e247d24 | 1114 | |
b46957e2 EZ |
1115 | ;; This was introduced in 21.4 for pre-unicode unification. That |
1116 | ;; usage was rendered obsolete in 23.1 which uses Unicode internally. | |
1117 | ;; Other uses are possible, so this variable is not _really_ obsolete, | |
1118 | ;; but Stefan insists to mark it so. | |
1119 | (make-obsolete-variable 'translation-table-for-input nil "23.1") | |
1120 | ||
9e247d24 | 1121 | (defvaralias 'messages-buffer-max-lines 'message-log-max) |
d293848d GM |
1122 | |
1123 | ;; These aliases exist in Emacs 19.34, and probably before, but were | |
1124 | ;; only marked as obsolete in 23.1. | |
fb2bae29 | 1125 | ;; The lisp manual (since at least Emacs 21) describes them as |
d293848d GM |
1126 | ;; existing "for compatibility with Emacs version 18". |
1127 | (define-obsolete-variable-alias 'last-input-char 'last-input-event | |
1128 | "at least 19.34") | |
1129 | (define-obsolete-variable-alias 'last-command-char 'last-command-event | |
1130 | "at least 19.34") | |
1131 | ||
9a5336ae JB |
1132 | \f |
1133 | ;;;; Alternate names for functions - these are not being phased out. | |
1134 | ||
a18ff988 JB |
1135 | (defalias 'send-string 'process-send-string) |
1136 | (defalias 'send-region 'process-send-region) | |
059184dd ER |
1137 | (defalias 'string= 'string-equal) |
1138 | (defalias 'string< 'string-lessp) | |
1139 | (defalias 'move-marker 'set-marker) | |
059184dd ER |
1140 | (defalias 'rplaca 'setcar) |
1141 | (defalias 'rplacd 'setcdr) | |
eb8c3be9 | 1142 | (defalias 'beep 'ding) ;preserve lingual purity |
059184dd ER |
1143 | (defalias 'indent-to-column 'indent-to) |
1144 | (defalias 'backward-delete-char 'delete-backward-char) | |
1145 | (defalias 'search-forward-regexp (symbol-function 're-search-forward)) | |
1146 | (defalias 'search-backward-regexp (symbol-function 're-search-backward)) | |
1147 | (defalias 'int-to-string 'number-to-string) | |
024ae2c6 | 1148 | (defalias 'store-match-data 'set-match-data) |
e6979067 | 1149 | (defalias 'chmod 'set-file-modes) |
53374291 | 1150 | (defalias 'mkdir 'make-directory) |
d6c22d46 | 1151 | ;; These are the XEmacs names: |
475fb2fb KH |
1152 | (defalias 'point-at-eol 'line-end-position) |
1153 | (defalias 'point-at-bol 'line-beginning-position) | |
37f6661a | 1154 | |
c4f484f2 RS |
1155 | (defalias 'user-original-login-name 'user-login-name) |
1156 | ||
be9b65ac | 1157 | \f |
9a5336ae | 1158 | ;;;; Hook manipulation functions. |
be9b65ac | 1159 | |
0e4d378b RS |
1160 | (defun make-local-hook (hook) |
1161 | "Make the hook HOOK local to the current buffer. | |
71c78f01 RS |
1162 | The return value is HOOK. |
1163 | ||
c344cf32 SM |
1164 | You never need to call this function now that `add-hook' does it for you |
1165 | if its LOCAL argument is non-nil. | |
1166 | ||
0e4d378b RS |
1167 | When a hook is local, its local and global values |
1168 | work in concert: running the hook actually runs all the hook | |
1169 | functions listed in *either* the local value *or* the global value | |
1170 | of the hook variable. | |
1171 | ||
08b1f8a1 | 1172 | This function works by making t a member of the buffer-local value, |
7dd1926e RS |
1173 | which acts as a flag to run the hook functions in the default value as |
1174 | well. This works for all normal hooks, but does not work for most | |
1175 | non-normal hooks yet. We will be changing the callers of non-normal | |
1176 | hooks so that they can handle localness; this has to be done one by | |
1177 | one. | |
1178 | ||
1179 | This function does nothing if HOOK is already local in the current | |
1180 | buffer. | |
0e4d378b RS |
1181 | |
1182 | Do not use `make-local-variable' to make a hook variable buffer-local." | |
1183 | (if (local-variable-p hook) | |
1184 | nil | |
1185 | (or (boundp hook) (set hook nil)) | |
1186 | (make-local-variable hook) | |
71c78f01 RS |
1187 | (set hook (list t))) |
1188 | hook) | |
8eb93953 | 1189 | (make-obsolete 'make-local-hook "not necessary any more." "21.1") |
0e4d378b RS |
1190 | |
1191 | (defun add-hook (hook function &optional append local) | |
32295976 RS |
1192 | "Add to the value of HOOK the function FUNCTION. |
1193 | FUNCTION is not added if already present. | |
1194 | FUNCTION is added (if necessary) at the beginning of the hook list | |
1195 | unless the optional argument APPEND is non-nil, in which case | |
1196 | FUNCTION is added at the end. | |
1197 | ||
0e4d378b RS |
1198 | The optional fourth argument, LOCAL, if non-nil, says to modify |
1199 | the hook's buffer-local value rather than its default value. | |
61a3d8c4 RS |
1200 | This makes the hook buffer-local if needed, and it makes t a member |
1201 | of the buffer-local value. That acts as a flag to run the hook | |
1202 | functions in the default value as well as in the local value. | |
0e4d378b | 1203 | |
32295976 RS |
1204 | HOOK should be a symbol, and FUNCTION may be any valid function. If |
1205 | HOOK is void, it is first set to nil. If HOOK's value is a single | |
aa09b5ca | 1206 | function, it is changed to a list of functions." |
be9b65ac | 1207 | (or (boundp hook) (set hook nil)) |
0e4d378b | 1208 | (or (default-boundp hook) (set-default hook nil)) |
08b1f8a1 GM |
1209 | (if local (unless (local-variable-if-set-p hook) |
1210 | (set (make-local-variable hook) (list t))) | |
8947a5e2 SM |
1211 | ;; Detect the case where make-local-variable was used on a hook |
1212 | ;; and do what we used to do. | |
1213 | (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook))) | |
1214 | (setq local t))) | |
1215 | (let ((hook-value (if local (symbol-value hook) (default-value hook)))) | |
1216 | ;; If the hook value is a single function, turn it into a list. | |
1217 | (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda)) | |
2248c40d | 1218 | (setq hook-value (list hook-value))) |
8947a5e2 SM |
1219 | ;; Do the actual addition if necessary |
1220 | (unless (member function hook-value) | |
ff917d63 DN |
1221 | (when (stringp function) |
1222 | (setq function (purecopy function))) | |
8947a5e2 SM |
1223 | (setq hook-value |
1224 | (if append | |
1225 | (append hook-value (list function)) | |
1226 | (cons function hook-value)))) | |
1227 | ;; Set the actual variable | |
35310461 RS |
1228 | (if local |
1229 | (progn | |
1230 | ;; If HOOK isn't a permanent local, | |
1231 | ;; but FUNCTION wants to survive a change of modes, | |
1232 | ;; mark HOOK as partially permanent. | |
1233 | (and (symbolp function) | |
1234 | (get function 'permanent-local-hook) | |
1235 | (not (get hook 'permanent-local)) | |
1236 | (put hook 'permanent-local 'permanent-local-hook)) | |
1237 | (set hook hook-value)) | |
1238 | (set-default hook hook-value)))) | |
0e4d378b RS |
1239 | |
1240 | (defun remove-hook (hook function &optional local) | |
24980d16 RS |
1241 | "Remove from the value of HOOK the function FUNCTION. |
1242 | HOOK should be a symbol, and FUNCTION may be any valid function. If | |
1243 | FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the | |
0e4d378b RS |
1244 | list of hooks to run in HOOK, then nothing is done. See `add-hook'. |
1245 | ||
1246 | The optional third argument, LOCAL, if non-nil, says to modify | |
6b61353c | 1247 | the hook's buffer-local value rather than its default value." |
8947a5e2 SM |
1248 | (or (boundp hook) (set hook nil)) |
1249 | (or (default-boundp hook) (set-default hook nil)) | |
6b61353c KH |
1250 | ;; Do nothing if LOCAL is t but this hook has no local binding. |
1251 | (unless (and local (not (local-variable-p hook))) | |
8947a5e2 SM |
1252 | ;; Detect the case where make-local-variable was used on a hook |
1253 | ;; and do what we used to do. | |
6b61353c KH |
1254 | (when (and (local-variable-p hook) |
1255 | (not (and (consp (symbol-value hook)) | |
1256 | (memq t (symbol-value hook))))) | |
1257 | (setq local t)) | |
1258 | (let ((hook-value (if local (symbol-value hook) (default-value hook)))) | |
1259 | ;; Remove the function, for both the list and the non-list cases. | |
1260 | (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda)) | |
1261 | (if (equal hook-value function) (setq hook-value nil)) | |
1262 | (setq hook-value (delete function (copy-sequence hook-value)))) | |
1263 | ;; If the function is on the global hook, we need to shadow it locally | |
1264 | ;;(when (and local (member function (default-value hook)) | |
1265 | ;; (not (member (cons 'not function) hook-value))) | |
1266 | ;; (push (cons 'not function) hook-value)) | |
1267 | ;; Set the actual variable | |
1268 | (if (not local) | |
1269 | (set-default hook hook-value) | |
1270 | (if (equal hook-value '(t)) | |
1271 | (kill-local-variable hook) | |
1272 | (set hook hook-value)))))) | |
6e3af630 | 1273 | |
62e197b1 | 1274 | (defun add-to-list (list-var element &optional append compare-fn) |
4072ef25 | 1275 | "Add ELEMENT to the value of LIST-VAR if it isn't there yet. |
62e197b1 RS |
1276 | The test for presence of ELEMENT is done with `equal', |
1277 | or with COMPARE-FN if that's non-nil. | |
c8bfa689 MB |
1278 | If ELEMENT is added, it is added at the beginning of the list, |
1279 | unless the optional argument APPEND is non-nil, in which case | |
1280 | ELEMENT is added at the end. | |
508bcbca | 1281 | |
daebae3d PJ |
1282 | The return value is the new value of LIST-VAR. |
1283 | ||
8851c1f0 RS |
1284 | If you want to use `add-to-list' on a variable that is not defined |
1285 | until a certain package is loaded, you should put the call to `add-to-list' | |
1286 | into a hook function that will be run only after loading the package. | |
1287 | `eval-after-load' provides one way to do this. In some cases | |
1288 | other hooks, such as major mode hooks, can do the job." | |
fb1a5d8a | 1289 | (if (cond |
78bdfbf3 | 1290 | ((null compare-fn) |
62e197b1 | 1291 | (member element (symbol-value list-var))) |
fb1a5d8a KS |
1292 | ((eq compare-fn 'eq) |
1293 | (memq element (symbol-value list-var))) | |
1294 | ((eq compare-fn 'eql) | |
1295 | (memql element (symbol-value list-var))) | |
78bdfbf3 | 1296 | (t |
2d1dd54d DK |
1297 | (let ((lst (symbol-value list-var))) |
1298 | (while (and lst | |
1299 | (not (funcall compare-fn element (car lst)))) | |
1300 | (setq lst (cdr lst))) | |
1301 | lst))) | |
15171a06 | 1302 | (symbol-value list-var) |
c8bfa689 MB |
1303 | (set list-var |
1304 | (if append | |
1305 | (append (symbol-value list-var) (list element)) | |
1306 | (cons element (symbol-value list-var)))))) | |
448a0170 | 1307 | |
cbbd0b5a KS |
1308 | |
1309 | (defun add-to-ordered-list (list-var element &optional order) | |
4072ef25 | 1310 | "Add ELEMENT to the value of LIST-VAR if it isn't there yet. |
ef1eef06 | 1311 | The test for presence of ELEMENT is done with `eq'. |
cbbd0b5a KS |
1312 | |
1313 | The resulting list is reordered so that the elements are in the | |
ef1eef06 KS |
1314 | order given by each element's numeric list order. Elements |
1315 | without a numeric list order are placed at the end of the list. | |
cbbd0b5a | 1316 | |
4072ef25 LT |
1317 | If the third optional argument ORDER is a number (integer or |
1318 | float), set the element's list order to the given value. If | |
1319 | ORDER is nil or omitted, do not change the numeric order of | |
1320 | ELEMENT. If ORDER has any other value, remove the numeric order | |
1321 | of ELEMENT if it has one. | |
8da6c2f8 | 1322 | |
219fd6cf | 1323 | The list order for each element is stored in LIST-VAR's |
8da6c2f8 | 1324 | `list-order' property. |
cbbd0b5a KS |
1325 | |
1326 | The return value is the new value of LIST-VAR." | |
219fd6cf SM |
1327 | (let ((ordering (get list-var 'list-order))) |
1328 | (unless ordering | |
1329 | (put list-var 'list-order | |
1330 | (setq ordering (make-hash-table :weakness 'key :test 'eq)))) | |
8da6c2f8 | 1331 | (when order |
ef1eef06 KS |
1332 | (puthash element (and (numberp order) order) ordering)) |
1333 | (unless (memq element (symbol-value list-var)) | |
1334 | (set list-var (cons element (symbol-value list-var)))) | |
8da6c2f8 KS |
1335 | (set list-var (sort (symbol-value list-var) |
1336 | (lambda (a b) | |
219fd6cf SM |
1337 | (let ((oa (gethash a ordering)) |
1338 | (ob (gethash b ordering))) | |
ef1eef06 KS |
1339 | (if (and oa ob) |
1340 | (< oa ob) | |
1341 | oa))))))) | |
6b04bd6e | 1342 | |
d7494911 | 1343 | (defun add-to-history (history-var newelt &optional maxelt keep-all) |
6b04bd6e KS |
1344 | "Add NEWELT to the history list stored in the variable HISTORY-VAR. |
1345 | Return the new history list. | |
1346 | If MAXELT is non-nil, it specifies the maximum length of the history. | |
1347 | Otherwise, the maximum history length is the value of the `history-length' | |
1348 | property on symbol HISTORY-VAR, if set, or the value of the `history-length' | |
1349 | variable. | |
d7494911 KS |
1350 | Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil. |
1351 | If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even | |
1352 | if it is empty or a duplicate." | |
6b04bd6e KS |
1353 | (unless maxelt |
1354 | (setq maxelt (or (get history-var 'history-length) | |
1355 | history-length))) | |
1356 | (let ((history (symbol-value history-var)) | |
1357 | tail) | |
d7494911 KS |
1358 | (when (and (listp history) |
1359 | (or keep-all | |
1360 | (not (stringp newelt)) | |
1361 | (> (length newelt) 0)) | |
1362 | (or keep-all | |
1363 | (not (equal (car history) newelt)))) | |
1364 | (if history-delete-duplicates | |
1365 | (delete newelt history)) | |
1366 | (setq history (cons newelt history)) | |
1367 | (when (integerp maxelt) | |
1368 | (if (= 0 maxelt) | |
1369 | (setq history nil) | |
1370 | (setq tail (nthcdr (1- maxelt) history)) | |
1371 | (when (consp tail) | |
1372 | (setcdr tail nil))))) | |
6b04bd6e KS |
1373 | (set history-var history))) |
1374 | ||
c4f484f2 RS |
1375 | \f |
1376 | ;;;; Mode hooks. | |
1377 | ||
1378 | (defvar delay-mode-hooks nil | |
1379 | "If non-nil, `run-mode-hooks' should delay running the hooks.") | |
1380 | (defvar delayed-mode-hooks nil | |
1381 | "List of delayed mode hooks waiting to be run.") | |
1382 | (make-variable-buffer-local 'delayed-mode-hooks) | |
1383 | (put 'delay-mode-hooks 'permanent-local t) | |
cbbd0b5a | 1384 | |
c4f484f2 RS |
1385 | (defvar after-change-major-mode-hook nil |
1386 | "Normal hook run at the very end of major mode functions.") | |
1387 | ||
1388 | (defun run-mode-hooks (&rest hooks) | |
1389 | "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS. | |
1390 | Execution is delayed if `delay-mode-hooks' is non-nil. | |
1391 | If `delay-mode-hooks' is nil, run `after-change-major-mode-hook' | |
1392 | after running the mode hooks. | |
337a64d1 SM |
1393 | Major mode functions should use this instead of `run-hooks' when running their |
1394 | FOO-mode-hook." | |
c4f484f2 RS |
1395 | (if delay-mode-hooks |
1396 | ;; Delaying case. | |
1397 | (dolist (hook hooks) | |
1398 | (push hook delayed-mode-hooks)) | |
1399 | ;; Normal case, just run the hook as before plus any delayed hooks. | |
1400 | (setq hooks (nconc (nreverse delayed-mode-hooks) hooks)) | |
1401 | (setq delayed-mode-hooks nil) | |
1402 | (apply 'run-hooks hooks) | |
1403 | (run-hooks 'after-change-major-mode-hook))) | |
1404 | ||
1405 | (defmacro delay-mode-hooks (&rest body) | |
1406 | "Execute BODY, but delay any `run-mode-hooks'. | |
1407 | These hooks will be executed by the first following call to | |
1408 | `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form. | |
1409 | Only affects hooks run in the current buffer." | |
1410 | (declare (debug t) (indent 0)) | |
1411 | `(progn | |
1412 | (make-local-variable 'delay-mode-hooks) | |
1413 | (let ((delay-mode-hooks t)) | |
1414 | ,@body))) | |
1415 | ||
1416 | ;; PUBLIC: find if the current mode derives from another. | |
1417 | ||
1418 | (defun derived-mode-p (&rest modes) | |
1419 | "Non-nil if the current major mode is derived from one of MODES. | |
1420 | Uses the `derived-mode-parent' property of the symbol to trace backwards." | |
1421 | (let ((parent major-mode)) | |
1422 | (while (and (not (memq parent modes)) | |
1423 | (setq parent (get parent 'derived-mode-parent)))) | |
1424 | parent)) | |
1425 | \f | |
1426 | ;;;; Minor modes. | |
1427 | ||
1428 | ;; If a minor mode is not defined with define-minor-mode, | |
1429 | ;; add it here explicitly. | |
1430 | ;; isearch-mode is deliberately excluded, since you should | |
1431 | ;; not call it yourself. | |
1432 | (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode | |
1433 | overwrite-mode view-mode | |
1434 | hs-minor-mode) | |
1435 | "List of all minor mode functions.") | |
1436 | ||
1437 | (defun add-minor-mode (toggle name &optional keymap after toggle-fun) | |
1438 | "Register a new minor mode. | |
1439 | ||
1440 | This is an XEmacs-compatibility function. Use `define-minor-mode' instead. | |
1441 | ||
1442 | TOGGLE is a symbol which is the name of a buffer-local variable that | |
1443 | is toggled on or off to say whether the minor mode is active or not. | |
1444 | ||
1445 | NAME specifies what will appear in the mode line when the minor mode | |
1446 | is active. NAME should be either a string starting with a space, or a | |
1447 | symbol whose value is such a string. | |
1448 | ||
1449 | Optional KEYMAP is the keymap for the minor mode that will be added | |
1450 | to `minor-mode-map-alist'. | |
1451 | ||
1452 | Optional AFTER specifies that TOGGLE should be added after AFTER | |
1453 | in `minor-mode-alist'. | |
1454 | ||
1455 | Optional TOGGLE-FUN is an interactive function to toggle the mode. | |
1456 | It defaults to (and should by convention be) TOGGLE. | |
1457 | ||
1458 | If TOGGLE has a non-nil `:included' property, an entry for the mode is | |
1459 | included in the mode-line minor mode menu. | |
1460 | If TOGGLE has a `:menu-tag', that is used for the menu item's label." | |
1461 | (unless (memq toggle minor-mode-list) | |
1462 | (push toggle minor-mode-list)) | |
1463 | ||
1464 | (unless toggle-fun (setq toggle-fun toggle)) | |
1465 | (unless (eq toggle-fun toggle) | |
1466 | (put toggle :minor-mode-function toggle-fun)) | |
1467 | ;; Add the name to the minor-mode-alist. | |
1468 | (when name | |
1469 | (let ((existing (assq toggle minor-mode-alist))) | |
1470 | (if existing | |
1471 | (setcdr existing (list name)) | |
1472 | (let ((tail minor-mode-alist) found) | |
1473 | (while (and tail (not found)) | |
1474 | (if (eq after (caar tail)) | |
1475 | (setq found tail) | |
1476 | (setq tail (cdr tail)))) | |
1477 | (if found | |
1478 | (let ((rest (cdr found))) | |
1479 | (setcdr found nil) | |
1480 | (nconc found (list (list toggle name)) rest)) | |
1481 | (setq minor-mode-alist (cons (list toggle name) | |
1482 | minor-mode-alist))))))) | |
1483 | ;; Add the toggle to the minor-modes menu if requested. | |
1484 | (when (get toggle :included) | |
1485 | (define-key mode-line-mode-menu | |
1486 | (vector toggle) | |
1487 | (list 'menu-item | |
1488 | (concat | |
1489 | (or (get toggle :menu-tag) | |
1490 | (if (stringp name) name (symbol-name toggle))) | |
1491 | (let ((mode-name (if (symbolp name) (symbol-value name)))) | |
1492 | (if (and (stringp mode-name) (string-match "[^ ]+" mode-name)) | |
1493 | (concat " (" (match-string 0 mode-name) ")")))) | |
1494 | toggle-fun | |
1495 | :button (cons :toggle toggle)))) | |
cbbd0b5a | 1496 | |
c4f484f2 RS |
1497 | ;; Add the map to the minor-mode-map-alist. |
1498 | (when keymap | |
1499 | (let ((existing (assq toggle minor-mode-map-alist))) | |
1500 | (if existing | |
1501 | (setcdr existing keymap) | |
1502 | (let ((tail minor-mode-map-alist) found) | |
1503 | (while (and tail (not found)) | |
1504 | (if (eq after (caar tail)) | |
1505 | (setq found tail) | |
1506 | (setq tail (cdr tail)))) | |
1507 | (if found | |
1508 | (let ((rest (cdr found))) | |
1509 | (setcdr found nil) | |
1510 | (nconc found (list (cons toggle keymap)) rest)) | |
1511 | (setq minor-mode-map-alist (cons (cons toggle keymap) | |
1512 | minor-mode-map-alist)))))))) | |
448a0170 MB |
1513 | \f |
1514 | ;;; Load history | |
1515 | ||
26715e1b SM |
1516 | ;; (defvar symbol-file-load-history-loaded nil |
1517 | ;; "Non-nil means we have loaded the file `fns-VERSION.el' in `exec-directory'. | |
1518 | ;; That file records the part of `load-history' for preloaded files, | |
1519 | ;; which is cleared out before dumping to make Emacs smaller.") | |
1520 | ||
1521 | ;; (defun load-symbol-file-load-history () | |
1522 | ;; "Load the file `fns-VERSION.el' in `exec-directory' if not already done. | |
1523 | ;; That file records the part of `load-history' for preloaded files, | |
1524 | ;; which is cleared out before dumping to make Emacs smaller." | |
1525 | ;; (unless symbol-file-load-history-loaded | |
1526 | ;; (load (expand-file-name | |
1527 | ;; ;; fns-XX.YY.ZZ.el does not work on DOS filesystem. | |
1528 | ;; (if (eq system-type 'ms-dos) | |
1529 | ;; "fns.el" | |
1530 | ;; (format "fns-%s.el" emacs-version)) | |
1531 | ;; exec-directory) | |
1532 | ;; ;; The file name fns-%s.el already has a .el extension. | |
1533 | ;; nil nil t) | |
1534 | ;; (setq symbol-file-load-history-loaded t))) | |
448a0170 | 1535 | |
9e247d24 | 1536 | (defun symbol-file (symbol &optional type) |
37fda77e MR |
1537 | "Return the name of the file that defined SYMBOL. |
1538 | The value is normally an absolute file name. It can also be nil, | |
1539 | if the definition is not associated with any file. If SYMBOL | |
1540 | specifies an autoloaded function, the value can be a relative | |
1541 | file name without extension. | |
1542 | ||
1543 | If TYPE is nil, then any kind of definition is acceptable. If | |
1544 | TYPE is `defun', `defvar', or `defface', that specifies function | |
1545 | definition, variable definition, or face definition only." | |
9e247d24 RS |
1546 | (if (and (or (null type) (eq type 'defun)) |
1547 | (symbolp symbol) (fboundp symbol) | |
1548 | (eq 'autoload (car-safe (symbol-function symbol)))) | |
1549 | (nth 1 (symbol-function symbol)) | |
e9f13a95 | 1550 | (let ((files load-history) |
cb21744e | 1551 | file) |
e9f13a95 | 1552 | (while files |
9e247d24 RS |
1553 | (if (if type |
1554 | (if (eq type 'defvar) | |
1555 | ;; Variables are present just as their names. | |
1556 | (member symbol (cdr (car files))) | |
1557 | ;; Other types are represented as (TYPE . NAME). | |
1558 | (member (cons type symbol) (cdr (car files)))) | |
1559 | ;; We accept all types, so look for variable def | |
1560 | ;; and then for any other kind. | |
1561 | (or (member symbol (cdr (car files))) | |
1562 | (rassq symbol (cdr (car files))))) | |
e9f13a95 SM |
1563 | (setq file (car (car files)) files nil)) |
1564 | (setq files (cdr files))) | |
1565 | file))) | |
448a0170 | 1566 | |
059a552c RF |
1567 | (defun locate-library (library &optional nosuffix path interactive-call) |
1568 | "Show the precise file name of Emacs library LIBRARY. | |
c9ae6ddd EZ |
1569 | LIBRARY should be a relative file name of the library, a string. |
1570 | It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is | |
1571 | nil (which is the default, see below). | |
059a552c RF |
1572 | This command searches the directories in `load-path' like `\\[load-library]' |
1573 | to find the file that `\\[load-library] RET LIBRARY RET' would load. | |
1574 | Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes' | |
1575 | to the specified name LIBRARY. | |
1576 | ||
1577 | If the optional third arg PATH is specified, that list of directories | |
1578 | is used instead of `load-path'. | |
1579 | ||
3ac9d254 | 1580 | When called from a program, the file name is normally returned as a |
059a552c RF |
1581 | string. When run interactively, the argument INTERACTIVE-CALL is t, |
1582 | and the file name is displayed in the echo area." | |
1583 | (interactive (list (completing-read "Locate library: " | |
6a021917 SM |
1584 | (apply-partially |
1585 | 'locate-file-completion-table | |
1586 | load-path (get-load-suffixes))) | |
059a552c RF |
1587 | nil nil |
1588 | t)) | |
1589 | (let ((file (locate-file library | |
1590 | (or path load-path) | |
667b73dc LT |
1591 | (append (unless nosuffix (get-load-suffixes)) |
1592 | load-file-rep-suffixes)))) | |
059a552c RF |
1593 | (if interactive-call |
1594 | (if file | |
1595 | (message "Library is file %s" (abbreviate-file-name file)) | |
1596 | (message "No library %s in search path" library))) | |
1597 | file)) | |
1598 | ||
be9b65ac | 1599 | \f |
adbe2d11 RS |
1600 | ;;;; Specifying things to do later. |
1601 | ||
33d74677 | 1602 | (defun load-history-regexp (file) |
0988217a RS |
1603 | "Form a regexp to find FILE in `load-history'. |
1604 | FILE, a string, is described in the function `eval-after-load'." | |
33d74677 AM |
1605 | (if (file-name-absolute-p file) |
1606 | (setq file (file-truename file))) | |
0988217a | 1607 | (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)") |
33d74677 AM |
1608 | (regexp-quote file) |
1609 | (if (file-name-extension file) | |
1610 | "" | |
1611 | ;; Note: regexp-opt can't be used here, since we need to call | |
1612 | ;; this before Emacs has been fully started. 2006-05-21 | |
1613 | (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?")) | |
1614 | "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|") | |
1615 | "\\)?\\'")) | |
1616 | ||
1617 | (defun load-history-filename-element (file-regexp) | |
0988217a | 1618 | "Get the first elt of `load-history' whose car matches FILE-REGEXP. |
33d74677 AM |
1619 | Return nil if there isn't one." |
1620 | (let* ((loads load-history) | |
1621 | (load-elt (and loads (car loads)))) | |
1622 | (save-match-data | |
1623 | (while (and loads | |
1624 | (or (null (car load-elt)) | |
1625 | (not (string-match file-regexp (car load-elt))))) | |
1626 | (setq loads (cdr loads) | |
1627 | load-elt (and loads (car loads))))) | |
1628 | load-elt)) | |
1629 | ||
9a5336ae JB |
1630 | (defun eval-after-load (file form) |
1631 | "Arrange that, if FILE is ever loaded, FORM will be run at that time. | |
90914938 | 1632 | If FILE is already loaded, evaluate FORM right now. |
33d74677 AM |
1633 | |
1634 | If a matching file is loaded again, FORM will be evaluated again. | |
1635 | ||
1636 | If FILE is a string, it may be either an absolute or a relative file | |
1637 | name, and may have an extension \(e.g. \".el\") or may lack one, and | |
1638 | additionally may or may not have an extension denoting a compressed | |
1639 | format \(e.g. \".gz\"). | |
1640 | ||
0988217a RS |
1641 | When FILE is absolute, this first converts it to a true name by chasing |
1642 | symbolic links. Only a file of this name \(see next paragraph regarding | |
33d74677 AM |
1643 | extensions) will trigger the evaluation of FORM. When FILE is relative, |
1644 | a file whose absolute true name ends in FILE will trigger evaluation. | |
1645 | ||
1646 | When FILE lacks an extension, a file name with any extension will trigger | |
1647 | evaluation. Otherwise, its extension must match FILE's. A further | |
1648 | extension for a compressed format \(e.g. \".gz\") on FILE will not affect | |
1649 | this name matching. | |
1650 | ||
1651 | Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM | |
f176290e GM |
1652 | is evaluated whenever that feature is `provide'd. Note that although |
1653 | provide statements are usually at the end of files, this is not always | |
1654 | the case (e.g., sometimes they are at the start to avoid a recursive | |
1655 | load error). If your FORM should not be evaluated until the code in | |
1656 | FILE has been, do not use the symbol form for FILE in such cases. | |
33d74677 AM |
1657 | |
1658 | Usually FILE is just a library name like \"font-lock\" or a feature name | |
1659 | like 'font-lock. | |
1660 | ||
1661 | This function makes or adds to an entry on `after-load-alist'." | |
1662 | ;; Add this FORM into after-load-alist (regardless of whether we'll be | |
1663 | ;; evaluating it now). | |
1664 | (let* ((regexp-or-feature | |
ff917d63 | 1665 | (if (stringp file) (setq file (purecopy (load-history-regexp file))) file)) |
33d74677 AM |
1666 | (elt (assoc regexp-or-feature after-load-alist))) |
1667 | (unless elt | |
1668 | (setq elt (list regexp-or-feature)) | |
1669 | (push elt after-load-alist)) | |
1670 | ;; Add FORM to the element unless it's already there. | |
a2d7836f | 1671 | (unless (member form (cdr elt)) |
ff917d63 | 1672 | (nconc elt (purecopy (list form)))) |
33d74677 AM |
1673 | |
1674 | ;; Is there an already loaded file whose name (or `provide' name) | |
1675 | ;; matches FILE? | |
1676 | (if (if (stringp file) | |
1677 | (load-history-filename-element regexp-or-feature) | |
1678 | (featurep file)) | |
1679 | (eval form)))) | |
1680 | ||
838ff458 SM |
1681 | (defvar after-load-functions nil |
1682 | "Special hook run after loading a file. | |
1683 | Each function there is called with a single argument, the absolute | |
1684 | name of the file just loaded.") | |
1685 | ||
33d74677 AM |
1686 | (defun do-after-load-evaluation (abs-file) |
1687 | "Evaluate all `eval-after-load' forms, if any, for ABS-FILE. | |
5766c380 SM |
1688 | ABS-FILE, a string, should be the absolute true name of a file just loaded. |
1689 | This function is called directly from the C code." | |
1690 | ;; Run the relevant eval-after-load forms. | |
060c08b5 JB |
1691 | (mapc #'(lambda (a-l-element) |
1692 | (when (and (stringp (car a-l-element)) | |
1693 | (string-match-p (car a-l-element) abs-file)) | |
1694 | ;; discard the file name regexp | |
1695 | (mapc #'eval (cdr a-l-element)))) | |
5766c380 SM |
1696 | after-load-alist) |
1697 | ;; Complain when the user uses obsolete files. | |
838ff458 | 1698 | (when (string-match-p "/obsolete/[^/]*\\'" abs-file) |
5766c380 SM |
1699 | (run-with-timer 0 nil |
1700 | (lambda (file) | |
1701 | (message "Package %s is obsolete!" | |
1702 | (substring file 0 | |
1703 | (string-match "\\.elc?\\>" file)))) | |
838ff458 SM |
1704 | (file-name-nondirectory abs-file))) |
1705 | ;; Finally, run any other hook. | |
1706 | (run-hook-with-args 'after-load-functions abs-file)) | |
9a5336ae JB |
1707 | |
1708 | (defun eval-next-after-load (file) | |
1709 | "Read the following input sexp, and run it whenever FILE is loaded. | |
1710 | This makes or adds to an entry on `after-load-alist'. | |
1711 | FILE should be the name of a library, with no directory name." | |
1712 | (eval-after-load file (read))) | |
354f0faf | 1713 | (make-obsolete 'eval-next-after-load `eval-after-load "23.2") |
7aaacaff | 1714 | \f |
c4f484f2 RS |
1715 | ;;;; Process stuff. |
1716 | ||
d43c8d03 GM |
1717 | (defun process-lines (program &rest args) |
1718 | "Execute PROGRAM with ARGS, returning its output as a list of lines. | |
1719 | Signal an error if the program returns with a non-zero exit status." | |
1720 | (with-temp-buffer | |
1721 | (let ((status (apply 'call-process program nil (current-buffer) nil args))) | |
1722 | (unless (eq status 0) | |
1723 | (error "%s exited with status %s" program status)) | |
1724 | (goto-char (point-min)) | |
1725 | (let (lines) | |
1726 | (while (not (eobp)) | |
1727 | (setq lines (cons (buffer-substring-no-properties | |
1728 | (line-beginning-position) | |
1729 | (line-end-position)) | |
1730 | lines)) | |
1731 | (forward-line 1)) | |
1732 | (nreverse lines))))) | |
1733 | ||
c4f484f2 | 1734 | ;; open-network-stream is a wrapper around make-network-process. |
7aaacaff | 1735 | |
149d2fd3 KS |
1736 | (when (featurep 'make-network-process) |
1737 | (defun open-network-stream (name buffer host service) | |
c8227332 | 1738 | "Open a TCP connection for a service to a host. |
7aaacaff RS |
1739 | Returns a subprocess-object to represent the connection. |
1740 | Input and output work as for subprocesses; `delete-process' closes it. | |
a478f3e1 | 1741 | |
00b9254c GM |
1742 | NAME is the name for the process. It is modified if necessary to make |
1743 | it unique. | |
6ec6d6f4 GM |
1744 | BUFFER is the buffer (or buffer name) to associate with the |
1745 | process. Process output goes at end of that buffer. BUFFER may | |
1746 | be nil, meaning that this process is not associated with any buffer. | |
1747 | HOST is the name or IP address of the host to connect to. | |
1748 | SERVICE is the name of the service desired, or an integer specifying | |
1749 | a port number to connect to. | |
1750 | ||
1751 | This is a wrapper around `make-network-process', and only offers a | |
1752 | subset of its functionality." | |
c8227332 VJL |
1753 | (make-network-process :name name :buffer buffer |
1754 | :host host :service service))) | |
7aaacaff RS |
1755 | |
1756 | ;; compatibility | |
1757 | ||
c8227332 VJL |
1758 | (make-obsolete |
1759 | 'process-kill-without-query | |
1760 | "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'." | |
1761 | "22.1") | |
7aaacaff RS |
1762 | (defun process-kill-without-query (process &optional flag) |
1763 | "Say no query needed if PROCESS is running when Emacs is exited. | |
1764 | Optional second argument if non-nil says to require a query. | |
a478f3e1 | 1765 | Value is t if a query was formerly required." |
7aaacaff RS |
1766 | (let ((old (process-query-on-exit-flag process))) |
1767 | (set-process-query-on-exit-flag process nil) | |
1768 | old)) | |
9a5336ae | 1769 | |
d842b103 JL |
1770 | (defun process-kill-buffer-query-function () |
1771 | "Ask before killing a buffer that has a running process." | |
1772 | (let ((process (get-buffer-process (current-buffer)))) | |
1773 | (or (not process) | |
1774 | (not (memq (process-status process) '(run stop open listen))) | |
1775 | (not (process-query-on-exit-flag process)) | |
1776 | (yes-or-no-p "Buffer has a running process; kill it? ")))) | |
1777 | ||
1778 | (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function) | |
1779 | ||
34368d12 KS |
1780 | ;; process plist management |
1781 | ||
1782 | (defun process-get (process propname) | |
1783 | "Return the value of PROCESS' PROPNAME property. | |
1784 | This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'." | |
1785 | (plist-get (process-plist process) propname)) | |
1786 | ||
1787 | (defun process-put (process propname value) | |
1788 | "Change PROCESS' PROPNAME property to VALUE. | |
1789 | It can be retrieved with `(process-get PROCESS PROPNAME)'." | |
f1180544 | 1790 | (set-process-plist process |
34368d12 KS |
1791 | (plist-put (process-plist process) propname value))) |
1792 | ||
9a5336ae JB |
1793 | \f |
1794 | ;;;; Input and display facilities. | |
1795 | ||
77a5664f | 1796 | (defvar read-quoted-char-radix 8 |
1ba764de | 1797 | "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'. |
77a5664f RS |
1798 | Legitimate radix values are 8, 10 and 16.") |
1799 | ||
1800 | (custom-declare-variable-early | |
264ef586 | 1801 | 'read-quoted-char-radix 8 |
77a5664f | 1802 | "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'. |
1ba764de | 1803 | Legitimate radix values are 8, 10 and 16." |
c8227332 VJL |
1804 | :type '(choice (const 8) (const 10) (const 16)) |
1805 | :group 'editing-basics) | |
1ba764de | 1806 | |
03a74b84 SM |
1807 | (defconst read-key-empty-map (make-sparse-keymap)) |
1808 | ||
79bd5ba1 | 1809 | (defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully. |
03a74b84 SM |
1810 | |
1811 | (defun read-key (&optional prompt) | |
1812 | "Read a key from the keyboard. | |
1813 | Contrary to `read-event' this will not return a raw event but instead will | |
1814 | obey the input decoding and translations usually done by `read-key-sequence'. | |
1815 | So escape sequences and keyboard encoding are taken into account. | |
1816 | When there's an ambiguity because the key looks like the prefix of | |
1817 | some sort of escape sequence, the ambiguity is resolved via `read-key-delay'." | |
1818 | (let ((overriding-terminal-local-map read-key-empty-map) | |
1819 | (overriding-local-map nil) | |
1820 | (old-global-map (current-global-map)) | |
1821 | (timer (run-with-idle-timer | |
1822 | ;; Wait long enough that Emacs has the time to receive and | |
1823 | ;; process all the raw events associated with the single-key. | |
1824 | ;; But don't wait too long, or the user may find the delay | |
1825 | ;; annoying (or keep hitting more keys which may then get | |
1826 | ;; lost or misinterpreted). | |
1827 | ;; This is only relevant for keys which Emacs perceives as | |
1828 | ;; "prefixes", such as C-x (because of the C-x 8 map in | |
1829 | ;; key-translate-table and the C-x @ map in function-key-map) | |
1830 | ;; or ESC (because of terminal escape sequences in | |
1831 | ;; input-decode-map). | |
1832 | read-key-delay t | |
1833 | (lambda () | |
1834 | (let ((keys (this-command-keys-vector))) | |
1835 | (unless (zerop (length keys)) | |
1836 | ;; `keys' is non-empty, so the user has hit at least | |
1837 | ;; one key; there's no point waiting any longer, even | |
1838 | ;; though read-key-sequence thinks we should wait | |
1839 | ;; for more input to decide how to interpret the | |
1840 | ;; current input. | |
1841 | (throw 'read-key keys))))))) | |
1842 | (unwind-protect | |
1843 | (progn | |
1844 | (use-global-map read-key-empty-map) | |
79bd5ba1 | 1845 | (aref (catch 'read-key (read-key-sequence-vector prompt nil t)) 0)) |
03a74b84 SM |
1846 | (cancel-timer timer) |
1847 | (use-global-map old-global-map)))) | |
1848 | ||
9a5336ae | 1849 | (defun read-quoted-char (&optional prompt) |
2444730b RS |
1850 | "Like `read-char', but do not allow quitting. |
1851 | Also, if the first character read is an octal digit, | |
1852 | we read any number of octal digits and return the | |
569b03f2 | 1853 | specified character code. Any nondigit terminates the sequence. |
1ba764de | 1854 | If the terminator is RET, it is discarded; |
2444730b RS |
1855 | any other terminator is used itself as input. |
1856 | ||
569b03f2 RS |
1857 | The optional argument PROMPT specifies a string to use to prompt the user. |
1858 | The variable `read-quoted-char-radix' controls which radix to use | |
1859 | for numeric input." | |
c83256a0 | 1860 | (let ((message-log-max nil) done (first t) (code 0) char translated) |
2444730b RS |
1861 | (while (not done) |
1862 | (let ((inhibit-quit first) | |
42e636f0 KH |
1863 | ;; Don't let C-h get the help message--only help function keys. |
1864 | (help-char nil) | |
1865 | (help-form | |
1866 | "Type the special character you want to use, | |
2444730b | 1867 | or the octal character code. |
1ba764de | 1868 | RET terminates the character code and is discarded; |
2444730b | 1869 | any other non-digit terminates the character code and is then used as input.")) |
3f0161d0 | 1870 | (setq char (read-event (and prompt (format "%s-" prompt)) t)) |
9a5336ae | 1871 | (if inhibit-quit (setq quit-flag nil))) |
3f0161d0 SM |
1872 | ;; Translate TAB key into control-I ASCII character, and so on. |
1873 | ;; Note: `read-char' does it using the `ascii-character' property. | |
1874 | ;; We could try and use read-key-sequence instead, but then C-q ESC | |
1875 | ;; or C-q C-x might not return immediately since ESC or C-x might be | |
1876 | ;; bound to some prefix in function-key-map or key-translation-map. | |
e4c3c588 KH |
1877 | (setq translated |
1878 | (if (integerp char) | |
c41bd0ec | 1879 | (char-resolve-modifiers char) |
e4c3c588 | 1880 | char)) |
c40bb1ba | 1881 | (let ((translation (lookup-key local-function-key-map (vector char)))) |
c83256a0 RS |
1882 | (if (arrayp translation) |
1883 | (setq translated (aref translation 0)))) | |
1884 | (cond ((null translated)) | |
1885 | ((not (integerp translated)) | |
1886 | (setq unread-command-events (list char) | |
1ba764de | 1887 | done t)) |
c83256a0 | 1888 | ((/= (logand translated ?\M-\^@) 0) |
bf896a1b | 1889 | ;; Turn a meta-character into a character with the 0200 bit set. |
c83256a0 | 1890 | (setq code (logior (logand translated (lognot ?\M-\^@)) 128) |
bf896a1b | 1891 | done t)) |
4fcc3d32 SM |
1892 | ((and (<= ?0 translated) |
1893 | (< translated (+ ?0 (min 10 read-quoted-char-radix)))) | |
c83256a0 RS |
1894 | (setq code (+ (* code read-quoted-char-radix) (- translated ?0))) |
1895 | (and prompt (setq prompt (message "%s %c" prompt translated)))) | |
1896 | ((and (<= ?a (downcase translated)) | |
4fcc3d32 SM |
1897 | (< (downcase translated) |
1898 | (+ ?a -10 (min 36 read-quoted-char-radix)))) | |
92304bc8 | 1899 | (setq code (+ (* code read-quoted-char-radix) |
c83256a0 RS |
1900 | (+ 10 (- (downcase translated) ?a)))) |
1901 | (and prompt (setq prompt (message "%s %c" prompt translated)))) | |
1902 | ((and (not first) (eq translated ?\C-m)) | |
2444730b RS |
1903 | (setq done t)) |
1904 | ((not first) | |
c83256a0 | 1905 | (setq unread-command-events (list char) |
2444730b | 1906 | done t)) |
c83256a0 | 1907 | (t (setq code translated |
2444730b RS |
1908 | done t))) |
1909 | (setq first nil)) | |
bf896a1b | 1910 | code)) |
9a5336ae | 1911 | |
266725f1 SJ |
1912 | (defun read-passwd (prompt &optional confirm default) |
1913 | "Read a password, prompting with PROMPT, and return it. | |
1914 | If optional CONFIRM is non-nil, read the password twice to make sure. | |
1915 | Optional DEFAULT is a default password to use instead of empty input. | |
1916 | ||
1917 | This function echoes `.' for each character that the user types. | |
08640de5 CY |
1918 | |
1919 | The user ends with RET, LFD, or ESC. DEL or C-h rubs out. | |
1920 | C-y yanks the current kill. C-u kills line. | |
266725f1 | 1921 | C-g quits; if `inhibit-quit' was non-nil around this function, |
113fe928 | 1922 | then it returns nil if the user types C-g, but quit-flag remains set. |
266725f1 SJ |
1923 | |
1924 | Once the caller uses the password, it can erase the password | |
1925 | by doing (clear-string STRING)." | |
1926 | (with-local-quit | |
1927 | (if confirm | |
1928 | (let (success) | |
1929 | (while (not success) | |
1930 | (let ((first (read-passwd prompt nil default)) | |
1931 | (second (read-passwd "Confirm password: " nil default))) | |
1932 | (if (equal first second) | |
1933 | (progn | |
1934 | (and (arrayp second) (clear-string second)) | |
1935 | (setq success first)) | |
1936 | (and (arrayp first) (clear-string first)) | |
1937 | (and (arrayp second) (clear-string second)) | |
1938 | (message "Password not repeated accurately; please start over") | |
1939 | (sit-for 1)))) | |
1940 | success) | |
1941 | (let ((pass nil) | |
870560eb RS |
1942 | ;; Copy it so that add-text-properties won't modify |
1943 | ;; the object that was passed in by the caller. | |
1944 | (prompt (copy-sequence prompt)) | |
266725f1 SJ |
1945 | (c 0) |
1946 | (echo-keystrokes 0) | |
7c447c3f | 1947 | (cursor-in-echo-area t) |
d4a263ba CY |
1948 | (message-log-max nil) |
1949 | (stop-keys (list 'return ?\r ?\n ?\e)) | |
1950 | (rubout-keys (list 'backspace ?\b ?\177))) | |
a4b1de6e EZ |
1951 | (add-text-properties 0 (length prompt) |
1952 | minibuffer-prompt-properties prompt) | |
266725f1 SJ |
1953 | (while (progn (message "%s%s" |
1954 | prompt | |
1955 | (make-string (length pass) ?.)) | |
4fd15622 | 1956 | (setq c (read-key)) |
d4a263ba | 1957 | (not (memq c stop-keys))) |
266725f1 | 1958 | (clear-this-command-keys) |
d4a263ba CY |
1959 | (cond ((memq c rubout-keys) ; rubout |
1960 | (when (> (length pass) 0) | |
1961 | (let ((new-pass (substring pass 0 -1))) | |
1962 | (and (arrayp pass) (clear-string pass)) | |
1963 | (setq pass new-pass)))) | |
4fd15622 | 1964 | ((eq c ?\C-g) (keyboard-quit)) |
d4a263ba CY |
1965 | ((not (numberp c))) |
1966 | ((= c ?\C-u) ; kill line | |
08640de5 CY |
1967 | (and (arrayp pass) (clear-string pass)) |
1968 | (setq pass "")) | |
1969 | ((= c ?\C-y) ; yank | |
1970 | (let* ((str (condition-case nil | |
1971 | (current-kill 0) | |
1972 | (error nil))) | |
1973 | new-pass) | |
1974 | (when str | |
1975 | (setq new-pass | |
1976 | (concat pass | |
1977 | (substring-no-properties str))) | |
1978 | (and (arrayp pass) (clear-string pass)) | |
1979 | (setq c ?\0) | |
1980 | (setq pass new-pass)))) | |
d4a263ba | 1981 | ((characterp c) ; insert char |
08640de5 CY |
1982 | (let* ((new-char (char-to-string c)) |
1983 | (new-pass (concat pass new-char))) | |
1984 | (and (arrayp pass) (clear-string pass)) | |
1985 | (clear-string new-char) | |
1986 | (setq c ?\0) | |
08640de5 | 1987 | (setq pass new-pass))))) |
266725f1 SJ |
1988 | (message nil) |
1989 | (or pass default ""))))) | |
1990 | ||
6b61353c KH |
1991 | ;; This should be used by `call-interactively' for `n' specs. |
1992 | (defun read-number (prompt &optional default) | |
3238cde3 RS |
1993 | "Read a numeric value in the minibuffer, prompting with PROMPT. |
1994 | DEFAULT specifies a default value to return if the user just types RET. | |
1995 | The value of DEFAULT is inserted into PROMPT." | |
6b61353c KH |
1996 | (let ((n nil)) |
1997 | (when default | |
1998 | (setq prompt | |
2d14d61e MB |
1999 | (if (string-match "\\(\\):[ \t]*\\'" prompt) |
2000 | (replace-match (format " (default %s)" default) t t prompt 1) | |
2001 | (replace-regexp-in-string "[ \t]*\\'" | |
2002 | (format " (default %s) " default) | |
f8cf33b1 | 2003 | prompt t t)))) |
6b61353c KH |
2004 | (while |
2005 | (progn | |
2006 | (let ((str (read-from-minibuffer prompt nil nil nil nil | |
c7863346 SM |
2007 | (and default |
2008 | (number-to-string default))))) | |
219f06f7 RS |
2009 | (condition-case nil |
2010 | (setq n (cond | |
2011 | ((zerop (length str)) default) | |
2012 | ((stringp str) (read str)))) | |
2013 | (error nil))) | |
6b61353c KH |
2014 | (unless (numberp n) |
2015 | (message "Please enter a number.") | |
2016 | (sit-for 1) | |
2017 | t))) | |
2018 | n)) | |
0369eb85 CY |
2019 | |
2020 | (defun sit-for (seconds &optional nodisp obsolete) | |
2021 | "Perform redisplay, then wait for SECONDS seconds or until input is available. | |
2022 | SECONDS may be a floating-point value. | |
2023 | \(On operating systems that do not support waiting for fractions of a | |
2024 | second, floating-point values are rounded down to the nearest integer.) | |
2025 | ||
2026 | If optional arg NODISP is t, don't redisplay, just wait for input. | |
2027 | Redisplay does not happen if input is available before it starts. | |
0369eb85 CY |
2028 | |
2029 | Value is t if waited the full time with no input arriving, and nil otherwise. | |
2030 | ||
d8120806 | 2031 | An obsolete, but still supported form is |
0369eb85 | 2032 | \(sit-for SECONDS &optional MILLISECONDS NODISP) |
d8120806 | 2033 | where the optional arg MILLISECONDS specifies an additional wait period, |
0369eb85 | 2034 | in milliseconds; this was useful when Emacs was built without |
fd6c5134 | 2035 | floating point support." |
000b06df GM |
2036 | (if (numberp nodisp) |
2037 | (setq seconds (+ seconds (* 1e-3 nodisp)) | |
2038 | nodisp obsolete) | |
2039 | (if obsolete (setq nodisp obsolete))) | |
790e0ef7 KS |
2040 | (cond |
2041 | (noninteractive | |
2042 | (sleep-for seconds) | |
2043 | t) | |
2044 | ((input-pending-p) | |
2045 | nil) | |
2046 | ((<= seconds 0) | |
2047 | (or nodisp (redisplay))) | |
2048 | (t | |
2049 | (or nodisp (redisplay)) | |
2050 | (let ((read (read-event nil nil seconds))) | |
2051 | (or (null read) | |
fb1a5d8a KS |
2052 | (progn |
2053 | ;; If last command was a prefix arg, e.g. C-u, push this event onto | |
2054 | ;; unread-command-events as (t . EVENT) so it will be added to | |
2055 | ;; this-command-keys by read-key-sequence. | |
2056 | (if (eq overriding-terminal-local-map universal-argument-map) | |
2057 | (setq read (cons t read))) | |
2058 | (push read unread-command-events) | |
2059 | nil)))))) | |
f3ed9aca | 2060 | (set-advertised-calling-convention 'sit-for '(seconds &optional nodisp)) |
e0e4cb7a | 2061 | \f |
2493767e RS |
2062 | ;;; Atomic change groups. |
2063 | ||
69cae2d4 RS |
2064 | (defmacro atomic-change-group (&rest body) |
2065 | "Perform BODY as an atomic change group. | |
2066 | This means that if BODY exits abnormally, | |
2067 | all of its changes to the current buffer are undone. | |
b9ab4064 | 2068 | This works regardless of whether undo is enabled in the buffer. |
69cae2d4 RS |
2069 | |
2070 | This mechanism is transparent to ordinary use of undo; | |
2071 | if undo is enabled in the buffer and BODY succeeds, the | |
2072 | user can undo the change normally." | |
6273dc68 | 2073 | (declare (indent 0) (debug t)) |
69cae2d4 RS |
2074 | (let ((handle (make-symbol "--change-group-handle--")) |
2075 | (success (make-symbol "--change-group-success--"))) | |
2076 | `(let ((,handle (prepare-change-group)) | |
cf191706 RS |
2077 | ;; Don't truncate any undo data in the middle of this. |
2078 | (undo-outer-limit nil) | |
2079 | (undo-limit most-positive-fixnum) | |
2080 | (undo-strong-limit most-positive-fixnum) | |
69cae2d4 RS |
2081 | (,success nil)) |
2082 | (unwind-protect | |
2083 | (progn | |
2084 | ;; This is inside the unwind-protect because | |
2085 | ;; it enables undo if that was disabled; we need | |
2086 | ;; to make sure that it gets disabled again. | |
2087 | (activate-change-group ,handle) | |
2088 | ,@body | |
2089 | (setq ,success t)) | |
2090 | ;; Either of these functions will disable undo | |
2091 | ;; if it was disabled before. | |
2092 | (if ,success | |
2093 | (accept-change-group ,handle) | |
2094 | (cancel-change-group ,handle)))))) | |
2095 | ||
62ea1306 | 2096 | (defun prepare-change-group (&optional buffer) |
69cae2d4 | 2097 | "Return a handle for the current buffer's state, for a change group. |
62ea1306 | 2098 | If you specify BUFFER, make a handle for BUFFER's state instead. |
69cae2d4 RS |
2099 | |
2100 | Pass the handle to `activate-change-group' afterward to initiate | |
2101 | the actual changes of the change group. | |
2102 | ||
2103 | To finish the change group, call either `accept-change-group' or | |
2104 | `cancel-change-group' passing the same handle as argument. Call | |
2105 | `accept-change-group' to accept the changes in the group as final; | |
2106 | call `cancel-change-group' to undo them all. You should use | |
2107 | `unwind-protect' to make sure the group is always finished. The call | |
2108 | to `activate-change-group' should be inside the `unwind-protect'. | |
2109 | Once you finish the group, don't use the handle again--don't try to | |
2110 | finish the same group twice. For a simple example of correct use, see | |
2111 | the source code of `atomic-change-group'. | |
2112 | ||
2113 | The handle records only the specified buffer. To make a multibuffer | |
2114 | change group, call this function once for each buffer you want to | |
2115 | cover, then use `nconc' to combine the returned values, like this: | |
2116 | ||
2117 | (nconc (prepare-change-group buffer-1) | |
2118 | (prepare-change-group buffer-2)) | |
2119 | ||
2120 | You can then activate that multibuffer change group with a single | |
2121 | call to `activate-change-group' and finish it with a single call | |
2122 | to `accept-change-group' or `cancel-change-group'." | |
2123 | ||
62ea1306 RS |
2124 | (if buffer |
2125 | (list (cons buffer (with-current-buffer buffer buffer-undo-list))) | |
2126 | (list (cons (current-buffer) buffer-undo-list)))) | |
69cae2d4 RS |
2127 | |
2128 | (defun activate-change-group (handle) | |
2129 | "Activate a change group made with `prepare-change-group' (which see)." | |
2130 | (dolist (elt handle) | |
2131 | (with-current-buffer (car elt) | |
2132 | (if (eq buffer-undo-list t) | |
2133 | (setq buffer-undo-list nil))))) | |
2134 | ||
2135 | (defun accept-change-group (handle) | |
2136 | "Finish a change group made with `prepare-change-group' (which see). | |
2137 | This finishes the change group by accepting its changes as final." | |
2138 | (dolist (elt handle) | |
2139 | (with-current-buffer (car elt) | |
2140 | (if (eq elt t) | |
2141 | (setq buffer-undo-list t))))) | |
2142 | ||
2143 | (defun cancel-change-group (handle) | |
2144 | "Finish a change group made with `prepare-change-group' (which see). | |
2145 | This finishes the change group by reverting all of its changes." | |
2146 | (dolist (elt handle) | |
2147 | (with-current-buffer (car elt) | |
2148 | (setq elt (cdr elt)) | |
d21cba62 MR |
2149 | (save-restriction |
2150 | ;; Widen buffer temporarily so if the buffer was narrowed within | |
2151 | ;; the body of `atomic-change-group' all changes can be undone. | |
2152 | (widen) | |
2153 | (let ((old-car | |
2154 | (if (consp elt) (car elt))) | |
2155 | (old-cdr | |
2156 | (if (consp elt) (cdr elt)))) | |
2157 | ;; Temporarily truncate the undo log at ELT. | |
2158 | (when (consp elt) | |
2159 | (setcar elt nil) (setcdr elt nil)) | |
2160 | (unless (eq last-command 'undo) (undo-start)) | |
2161 | ;; Make sure there's no confusion. | |
2162 | (when (and (consp elt) (not (eq elt (last pending-undo-list)))) | |
2163 | (error "Undoing to some unrelated state")) | |
2164 | ;; Undo it all. | |
2165 | (save-excursion | |
2166 | (while (listp pending-undo-list) (undo-more 1))) | |
2167 | ;; Reset the modified cons cell ELT to its original content. | |
2168 | (when (consp elt) | |
2169 | (setcar elt old-car) | |
2170 | (setcdr elt old-cdr)) | |
2171 | ;; Revert the undo info to what it was when we grabbed the state. | |
2172 | (setq buffer-undo-list elt)))))) | |
69cae2d4 | 2173 | \f |
c4f484f2 RS |
2174 | ;;;; Display-related functions. |
2175 | ||
a9d956be RS |
2176 | ;; For compatibility. |
2177 | (defalias 'redraw-modeline 'force-mode-line-update) | |
2178 | ||
9a5336ae | 2179 | (defun force-mode-line-update (&optional all) |
6b61353c KH |
2180 | "Force redisplay of the current buffer's mode line and header line. |
2181 | With optional non-nil ALL, force redisplay of all mode lines and | |
2182 | header lines. This function also forces recomputation of the | |
2183 | menu bar menus and the frame title." | |
03a74b84 | 2184 | (if all (with-current-buffer (other-buffer))) |
9a5336ae JB |
2185 | (set-buffer-modified-p (buffer-modified-p))) |
2186 | ||
aa3b4ded | 2187 | (defun momentary-string-display (string pos &optional exit-char message) |
be9b65ac | 2188 | "Momentarily display STRING in the buffer at POS. |
12092fb3 | 2189 | Display remains until next event is input. |
dbf284be | 2190 | If POS is a marker, only its position is used; its buffer is ignored. |
12092fb3 EZ |
2191 | Optional third arg EXIT-CHAR can be a character, event or event |
2192 | description list. EXIT-CHAR defaults to SPC. If the input is | |
2193 | EXIT-CHAR it is swallowed; otherwise it is then available as | |
2194 | input (as a command if nothing else). | |
be9b65ac DL |
2195 | Display MESSAGE (optional fourth arg) in the echo area. |
2196 | If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there." | |
b754307b | 2197 | (or exit-char (setq exit-char ?\s)) |
f70c4736 SM |
2198 | (let ((ol (make-overlay pos pos)) |
2199 | (message (copy-sequence string))) | |
be9b65ac | 2200 | (unwind-protect |
f70c4736 SM |
2201 | (progn |
2202 | (save-excursion | |
2203 | (overlay-put ol 'after-string message) | |
2204 | (goto-char pos) | |
2205 | ;; To avoid trouble with out-of-bounds position | |
2206 | (setq pos (point)) | |
2207 | ;; If the message end is off screen, recenter now. | |
2208 | (if (<= (window-end nil t) pos) | |
2209 | (recenter (/ (window-height) 2)))) | |
2210 | (message (or message "Type %s to continue editing.") | |
2211 | (single-key-description exit-char)) | |
2212 | (let (char) | |
2213 | (if (integerp exit-char) | |
2214 | (condition-case nil | |
2215 | (progn | |
2216 | (setq char (read-char)) | |
2217 | (or (eq char exit-char) | |
2218 | (setq unread-command-events (list char)))) | |
2219 | (error | |
2220 | ;; `exit-char' is a character, hence it differs | |
2221 | ;; from char, which is an event. | |
2222 | (setq unread-command-events (list char)))) | |
2223 | ;; `exit-char' can be an event, or an event description list. | |
2224 | (setq char (read-event)) | |
2225 | (or (eq char exit-char) | |
2226 | (eq char (event-convert-list exit-char)) | |
2227 | (setq unread-command-events (list char)))))) | |
2228 | (delete-overlay ol)))) | |
be9b65ac | 2229 | |
9a5336ae | 2230 | \f |
aa3b4ded SM |
2231 | ;;;; Overlay operations |
2232 | ||
2233 | (defun copy-overlay (o) | |
2234 | "Return a copy of overlay O." | |
48b1e7cf SM |
2235 | (let ((o1 (if (overlay-buffer o) |
2236 | (make-overlay (overlay-start o) (overlay-end o) | |
2237 | ;; FIXME: there's no easy way to find the | |
2238 | ;; insertion-type of the two markers. | |
2239 | (overlay-buffer o)) | |
2240 | (let ((o1 (make-overlay (point-min) (point-min)))) | |
2241 | (delete-overlay o1) | |
2242 | o1)))) | |
aa3b4ded SM |
2243 | (props (overlay-properties o))) |
2244 | (while props | |
2245 | (overlay-put o1 (pop props) (pop props))) | |
2246 | o1)) | |
2247 | ||
f24485f1 | 2248 | (defun remove-overlays (&optional beg end name val) |
aa3b4ded | 2249 | "Clear BEG and END of overlays whose property NAME has value VAL. |
cba61075 JB |
2250 | Overlays might be moved and/or split. |
2251 | BEG and END default respectively to the beginning and end of buffer." | |
d6f5ac10 | 2252 | ;; This speeds up the loops over overlays. |
f24485f1 MY |
2253 | (unless beg (setq beg (point-min))) |
2254 | (unless end (setq end (point-max))) | |
ee6bb693 | 2255 | (overlay-recenter end) |
aa3b4ded SM |
2256 | (if (< end beg) |
2257 | (setq beg (prog1 end (setq end beg)))) | |
2258 | (save-excursion | |
2259 | (dolist (o (overlays-in beg end)) | |
2260 | (when (eq (overlay-get o name) val) | |
2261 | ;; Either push this overlay outside beg...end | |
2262 | ;; or split it to exclude beg...end | |
2263 | ;; or delete it entirely (if it is contained in beg...end). | |
2264 | (if (< (overlay-start o) beg) | |
2265 | (if (> (overlay-end o) end) | |
2266 | (progn | |
2267 | (move-overlay (copy-overlay o) | |
2268 | (overlay-start o) beg) | |
2269 | (move-overlay o end (overlay-end o))) | |
2270 | (move-overlay o (overlay-start o) beg)) | |
2271 | (if (> (overlay-end o) end) | |
2272 | (move-overlay o end (overlay-end o)) | |
2273 | (delete-overlay o))))))) | |
c5802acf | 2274 | \f |
9a5336ae JB |
2275 | ;;;; Miscellanea. |
2276 | ||
4fb17037 RS |
2277 | (defvar suspend-hook nil |
2278 | "Normal hook run by `suspend-emacs', before suspending.") | |
2279 | ||
2280 | (defvar suspend-resume-hook nil | |
2281 | "Normal hook run by `suspend-emacs', after Emacs is continued.") | |
2282 | ||
784bc7cd RS |
2283 | (defvar temp-buffer-show-hook nil |
2284 | "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer. | |
2285 | When the hook runs, the temporary buffer is current, and the window it | |
5247a8e6 | 2286 | was displayed in is selected.") |
784bc7cd RS |
2287 | |
2288 | (defvar temp-buffer-setup-hook nil | |
2289 | "Normal hook run by `with-output-to-temp-buffer' at the start. | |
2290 | When the hook runs, the temporary buffer is current. | |
2291 | This hook is normally set up with a function to put the buffer in Help | |
2292 | mode.") | |
2293 | ||
448b61c9 RS |
2294 | ;; Avoid compiler warnings about this variable, |
2295 | ;; which has a special meaning on certain system types. | |
2296 | (defvar buffer-file-type nil | |
2297 | "Non-nil if the visited file is a binary file. | |
2298 | This variable is meaningful on MS-DOG and Windows NT. | |
2299 | On those systems, it is automatically local in every buffer. | |
2300 | On other systems, this variable is normally always nil.") | |
28ac46f8 JPW |
2301 | |
2302 | ;; The `assert' macro from the cl package signals | |
2303 | ;; `cl-assertion-failed' at runtime so always define it. | |
2304 | (put 'cl-assertion-failed 'error-conditions '(error)) | |
6bdad9ae | 2305 | (put 'cl-assertion-failed 'error-message (purecopy "Assertion failed")) |
28ac46f8 | 2306 | |
d8869c65 CY |
2307 | (defconst user-emacs-directory |
2308 | (if (eq system-type 'ms-dos) | |
2309 | ;; MS-DOS cannot have initial dot. | |
2310 | "~/_emacs.d/" | |
2311 | "~/.emacs.d/") | |
2312 | "Directory beneath which additional per-user Emacs-specific files are placed. | |
2313 | Various programs in Emacs store information in this directory. | |
d6c180c4 JB |
2314 | Note that this should end with a directory separator. |
2315 | See also `locate-user-emacs-file'.") | |
2316 | ||
2317 | (defun locate-user-emacs-file (new-name &optional old-name) | |
2318 | "Return an absolute per-user Emacs-specific file name. | |
2319 | If OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME. | |
2320 | Else return NEW-NAME in `user-emacs-directory', creating the | |
2321 | directory if it does not exist." | |
2322 | (convert-standard-filename | |
2323 | (let* ((home (concat "~" (or init-file-user ""))) | |
2324 | (at-home (and old-name (expand-file-name old-name home)))) | |
2325 | (if (and at-home (file-readable-p at-home)) | |
2326 | at-home | |
2bea2795 JB |
2327 | ;; Make sure `user-emacs-directory' exists, |
2328 | ;; unless we're in batch mode or dumping Emacs | |
2329 | (or noninteractive | |
2330 | purify-flag | |
2331 | (file-accessible-directory-p (directory-file-name user-emacs-directory)) | |
2332 | (make-directory user-emacs-directory)) | |
03a74b84 SM |
2333 | (abbreviate-file-name |
2334 | (expand-file-name new-name user-emacs-directory)))))) | |
d8869c65 | 2335 | |
c4f484f2 RS |
2336 | \f |
2337 | ;;;; Misc. useful functions. | |
448b61c9 | 2338 | |
c4f484f2 RS |
2339 | (defun find-tag-default () |
2340 | "Determine default tag to search for, based on text at point. | |
2341 | If there is no plausible default, return nil." | |
9db3bfae MR |
2342 | (let (from to bound) |
2343 | (when (or (progn | |
2344 | ;; Look at text around `point'. | |
2345 | (save-excursion | |
2346 | (skip-syntax-backward "w_") (setq from (point))) | |
2347 | (save-excursion | |
2348 | (skip-syntax-forward "w_") (setq to (point))) | |
2349 | (> to from)) | |
2350 | ;; Look between `line-beginning-position' and `point'. | |
2351 | (save-excursion | |
2352 | (and (setq bound (line-beginning-position)) | |
2353 | (skip-syntax-backward "^w_" bound) | |
2354 | (> (setq to (point)) bound) | |
2355 | (skip-syntax-backward "w_") | |
2356 | (setq from (point)))) | |
2357 | ;; Look between `point' and `line-end-position'. | |
2358 | (save-excursion | |
2359 | (and (setq bound (line-end-position)) | |
2360 | (skip-syntax-forward "^w_" bound) | |
2361 | (< (setq from (point)) bound) | |
2362 | (skip-syntax-forward "w_") | |
2363 | (setq to (point))))) | |
2364 | (buffer-substring-no-properties from to)))) | |
a860d25f | 2365 | |
c4f484f2 RS |
2366 | (defun play-sound (sound) |
2367 | "SOUND is a list of the form `(sound KEYWORD VALUE...)'. | |
2368 | The following keywords are recognized: | |
9a5336ae | 2369 | |
c4f484f2 RS |
2370 | :file FILE - read sound data from FILE. If FILE isn't an |
2371 | absolute file name, it is searched in `data-directory'. | |
9a5336ae | 2372 | |
c4f484f2 RS |
2373 | :data DATA - read sound data from string DATA. |
2374 | ||
2375 | Exactly one of :file or :data must be present. | |
2376 | ||
2377 | :volume VOL - set volume to VOL. VOL must an integer in the | |
2378 | range 0..100 or a float in the range 0..1.0. If not specified, | |
2379 | don't change the volume setting of the sound device. | |
9a5336ae | 2380 | |
c4f484f2 | 2381 | :device DEVICE - play sound on DEVICE. If not specified, |
d7f90d6c JB |
2382 | a system-dependent default device name is used. |
2383 | ||
2384 | Note: :data and :device are currently not supported on Windows." | |
c4f484f2 RS |
2385 | (if (fboundp 'play-sound-internal) |
2386 | (play-sound-internal sound) | |
2387 | (error "This Emacs binary lacks sound support"))) | |
9a5336ae | 2388 | |
0ef97535 GM |
2389 | (declare-function w32-shell-dos-semantics "w32-fns" nil) |
2390 | ||
c4f484f2 | 2391 | (defun shell-quote-argument (argument) |
d7f90d6c | 2392 | "Quote ARGUMENT for passing as argument to an inferior shell." |
4bbf6b41 JR |
2393 | (if (or (eq system-type 'ms-dos) |
2394 | (and (eq system-type 'windows-nt) (w32-shell-dos-semantics))) | |
c4f484f2 RS |
2395 | ;; Quote using double quotes, but escape any existing quotes in |
2396 | ;; the argument with backslashes. | |
2397 | (let ((result "") | |
2398 | (start 0) | |
2399 | end) | |
2400 | (if (or (null (string-match "[^\"]" argument)) | |
2401 | (< (match-end 0) (length argument))) | |
2402 | (while (string-match "[\"]" argument start) | |
2403 | (setq end (match-beginning 0) | |
2404 | result (concat result (substring argument start end) | |
2405 | "\\" (substring argument end (1+ end))) | |
2406 | start (1+ end)))) | |
2407 | (concat "\"" result (substring argument start) "\"")) | |
4bbf6b41 JR |
2408 | (if (equal argument "") |
2409 | "''" | |
2410 | ;; Quote everything except POSIX filename characters. | |
2411 | ;; This should be safe enough even for really weird shells. | |
2412 | (let ((result "") (start 0) end) | |
2413 | (while (string-match "[^-0-9a-zA-Z_./]" argument start) | |
2414 | (setq end (match-beginning 0) | |
2415 | result (concat result (substring argument start end) | |
2416 | "\\" (substring argument end (1+ end))) | |
2417 | start (1+ end))) | |
2418 | (concat result (substring argument start)))))) | |
3e457225 RS |
2419 | |
2420 | (defun string-or-null-p (object) | |
2421 | "Return t if OBJECT is a string or nil. | |
2422 | Otherwise, return nil." | |
2423 | (or (stringp object) (null object))) | |
2424 | ||
26715e1b SM |
2425 | (defun booleanp (object) |
2426 | "Return non-nil if OBJECT is one of the two canonical boolean values: t or nil." | |
2427 | (memq object '(nil t))) | |
2428 | ||
1627b55f | 2429 | (defun field-at-pos (pos) |
d7f90d6c | 2430 | "Return the field at position POS, taking stickiness etc into account." |
1ecaae6c NR |
2431 | (let ((raw-field (get-char-property (field-beginning pos) 'field))) |
2432 | (if (eq raw-field 'boundary) | |
2433 | (get-char-property (1- (field-end pos)) 'field) | |
2434 | raw-field))) | |
2435 | ||
c4f484f2 RS |
2436 | \f |
2437 | ;;;; Support for yanking and text properties. | |
9a5336ae | 2438 | |
2493767e RS |
2439 | (defvar yank-excluded-properties) |
2440 | ||
8ed59ad5 KS |
2441 | (defun remove-yank-excluded-properties (start end) |
2442 | "Remove `yank-excluded-properties' between START and END positions. | |
2443 | Replaces `category' properties with their defined properties." | |
2444 | (let ((inhibit-read-only t)) | |
2445 | ;; Replace any `category' property with the properties it stands for. | |
2446 | (unless (memq yank-excluded-properties '(t nil)) | |
2447 | (save-excursion | |
2448 | (goto-char start) | |
2449 | (while (< (point) end) | |
2450 | (let ((cat (get-text-property (point) 'category)) | |
2451 | run-end) | |
8ed59ad5 KS |
2452 | (setq run-end |
2453 | (next-single-property-change (point) 'category nil end)) | |
ebaa3349 RS |
2454 | (when cat |
2455 | (let (run-end2 original) | |
2456 | (remove-list-of-text-properties (point) run-end '(category)) | |
2457 | (while (< (point) run-end) | |
2458 | (setq run-end2 (next-property-change (point) nil run-end)) | |
2459 | (setq original (text-properties-at (point))) | |
2460 | (set-text-properties (point) run-end2 (symbol-plist cat)) | |
2461 | (add-text-properties (point) run-end2 original) | |
2462 | (goto-char run-end2)))) | |
2463 | (goto-char run-end))))) | |
8ed59ad5 KS |
2464 | (if (eq yank-excluded-properties t) |
2465 | (set-text-properties start end nil) | |
ebaa3349 | 2466 | (remove-list-of-text-properties start end yank-excluded-properties)))) |
8ed59ad5 | 2467 | |
e0e80ec9 KS |
2468 | (defvar yank-undo-function) |
2469 | ||
2470 | (defun insert-for-yank (string) | |
6b61353c KH |
2471 | "Calls `insert-for-yank-1' repetitively for each `yank-handler' segment. |
2472 | ||
2473 | See `insert-for-yank-1' for more details." | |
2474 | (let (to) | |
2475 | (while (setq to (next-single-property-change 0 'yank-handler string)) | |
2476 | (insert-for-yank-1 (substring string 0 to)) | |
2477 | (setq string (substring string to)))) | |
2478 | (insert-for-yank-1 string)) | |
2479 | ||
2480 | (defun insert-for-yank-1 (string) | |
e0e80ec9 | 2481 | "Insert STRING at point, stripping some text properties. |
6b61353c | 2482 | |
e0e80ec9 KS |
2483 | Strip text properties from the inserted text according to |
2484 | `yank-excluded-properties'. Otherwise just like (insert STRING). | |
2485 | ||
374d3fe7 | 2486 | If STRING has a non-nil `yank-handler' property on the first character, |
cc295a82 | 2487 | the normal insert behavior is modified in various ways. The value of |
fbe13428 | 2488 | the yank-handler property must be a list with one to four elements |
9dd10e25 | 2489 | with the following format: (FUNCTION PARAM NOEXCLUDE UNDO). |
e0e80ec9 KS |
2490 | When FUNCTION is present and non-nil, it is called instead of `insert' |
2491 | to insert the string. FUNCTION takes one argument--the object to insert. | |
2492 | If PARAM is present and non-nil, it replaces STRING as the object | |
2493 | passed to FUNCTION (or `insert'); for example, if FUNCTION is | |
2494 | `yank-rectangle', PARAM may be a list of strings to insert as a | |
2495 | rectangle. | |
2496 | If NOEXCLUDE is present and non-nil, the normal removal of the | |
2497 | yank-excluded-properties is not performed; instead FUNCTION is | |
2498 | responsible for removing those properties. This may be necessary | |
2499 | if FUNCTION adjusts point before or after inserting the object. | |
2500 | If UNDO is present and non-nil, it is a function that will be called | |
2501 | by `yank-pop' to undo the insertion of the current object. It is | |
f1180544 | 2502 | called with two arguments, the start and end of the current region. |
9dd10e25 | 2503 | FUNCTION may set `yank-undo-function' to override the UNDO value." |
57596fb6 KS |
2504 | (let* ((handler (and (stringp string) |
2505 | (get-text-property 0 'yank-handler string))) | |
2506 | (param (or (nth 1 handler) string)) | |
4f0f29aa | 2507 | (opoint (point)) |
029fd82c | 2508 | (inhibit-read-only inhibit-read-only) |
4f0f29aa RS |
2509 | end) |
2510 | ||
57596fb6 KS |
2511 | (setq yank-undo-function t) |
2512 | (if (nth 0 handler) ;; FUNCTION | |
2513 | (funcall (car handler) param) | |
e0e80ec9 | 2514 | (insert param)) |
4f0f29aa RS |
2515 | (setq end (point)) |
2516 | ||
029fd82c CY |
2517 | ;; Prevent read-only properties from interfering with the |
2518 | ;; following text property changes. | |
2519 | (setq inhibit-read-only t) | |
2520 | ||
4f0f29aa RS |
2521 | ;; What should we do with `font-lock-face' properties? |
2522 | (if font-lock-defaults | |
2523 | ;; No, just wipe them. | |
2524 | (remove-list-of-text-properties opoint end '(font-lock-face)) | |
2525 | ;; Convert them to `face'. | |
2526 | (save-excursion | |
2527 | (goto-char opoint) | |
2528 | (while (< (point) end) | |
2529 | (let ((face (get-text-property (point) 'font-lock-face)) | |
2530 | run-end) | |
2531 | (setq run-end | |
2532 | (next-single-property-change (point) 'font-lock-face nil end)) | |
2533 | (when face | |
2534 | (remove-text-properties (point) run-end '(font-lock-face nil)) | |
2535 | (put-text-property (point) run-end 'face face)) | |
2536 | (goto-char run-end))))) | |
2537 | ||
57596fb6 | 2538 | (unless (nth 2 handler) ;; NOEXCLUDE |
e0e80ec9 | 2539 | (remove-yank-excluded-properties opoint (point))) |
631890d8 RS |
2540 | |
2541 | ;; If last inserted char has properties, mark them as rear-nonsticky. | |
2542 | (if (and (> end opoint) | |
2543 | (text-properties-at (1- end))) | |
2544 | (put-text-property (1- end) end 'rear-nonsticky t)) | |
2545 | ||
c8227332 | 2546 | (if (eq yank-undo-function t) ;; not set by FUNCTION |
57596fb6 | 2547 | (setq yank-undo-function (nth 3 handler))) ;; UNDO |
c8227332 | 2548 | (if (nth 4 handler) ;; COMMAND |
57596fb6 | 2549 | (setq this-command (nth 4 handler))))) |
f1180544 | 2550 | |
a478f3e1 JB |
2551 | (defun insert-buffer-substring-no-properties (buffer &optional start end) |
2552 | "Insert before point a substring of BUFFER, without text properties. | |
3b8690f6 | 2553 | BUFFER may be a buffer or a buffer name. |
f8cf33b1 JB |
2554 | Arguments START and END are character positions specifying the substring. |
2555 | They default to the values of (point-min) and (point-max) in BUFFER." | |
3b8690f6 | 2556 | (let ((opoint (point))) |
a478f3e1 | 2557 | (insert-buffer-substring buffer start end) |
3b8690f6 KS |
2558 | (let ((inhibit-read-only t)) |
2559 | (set-text-properties opoint (point) nil)))) | |
2560 | ||
a478f3e1 JB |
2561 | (defun insert-buffer-substring-as-yank (buffer &optional start end) |
2562 | "Insert before point a part of BUFFER, stripping some text properties. | |
2563 | BUFFER may be a buffer or a buffer name. | |
f8cf33b1 JB |
2564 | Arguments START and END are character positions specifying the substring. |
2565 | They default to the values of (point-min) and (point-max) in BUFFER. | |
a478f3e1 JB |
2566 | Strip text properties from the inserted text according to |
2567 | `yank-excluded-properties'." | |
6b61353c KH |
2568 | ;; Since the buffer text should not normally have yank-handler properties, |
2569 | ;; there is no need to handle them here. | |
3b8690f6 | 2570 | (let ((opoint (point))) |
a478f3e1 | 2571 | (insert-buffer-substring buffer start end) |
8ed59ad5 | 2572 | (remove-yank-excluded-properties opoint (point)))) |
3b8690f6 | 2573 | |
2493767e | 2574 | \f |
c4f484f2 | 2575 | ;;;; Synchronous shell commands. |
2493767e | 2576 | |
be9b65ac DL |
2577 | (defun start-process-shell-command (name buffer &rest args) |
2578 | "Start a program in a subprocess. Return the process object for it. | |
be9b65ac | 2579 | NAME is name for process. It is modified if necessary to make it unique. |
54ce7cbf | 2580 | BUFFER is the buffer (or buffer name) to associate with the process. |
be9b65ac DL |
2581 | Process output goes at end of that buffer, unless you specify |
2582 | an output stream or filter function to handle the output. | |
2583 | BUFFER may be also nil, meaning that this process is not associated | |
2584 | with any buffer | |
03a74b84 SM |
2585 | COMMAND is the shell command to run. |
2586 | ||
2587 | An old calling convention accepted any number of arguments after COMMAND, | |
2588 | which were just concatenated to COMMAND. This is still supported but strongly | |
fd6c5134 | 2589 | discouraged." |
b59f6d7a RS |
2590 | ;; We used to use `exec' to replace the shell with the command, |
2591 | ;; but that failed to handle (...) and semicolon, etc. | |
7c2fb837 DN |
2592 | (start-process name buffer shell-file-name shell-command-switch |
2593 | (mapconcat 'identity args " "))) | |
f3ed9aca | 2594 | (set-advertised-calling-convention 'start-process-shell-command |
fd6c5134 | 2595 | '(name buffer command)) |
f3ed9aca | 2596 | |
a9e11582 MA |
2597 | (defun start-file-process-shell-command (name buffer &rest args) |
2598 | "Start a program in a subprocess. Return the process object for it. | |
fd6c5134 | 2599 | Similar to `start-process-shell-command', but calls `start-file-process'." |
a9e11582 MA |
2600 | (start-file-process |
2601 | name buffer | |
2602 | (if (file-remote-p default-directory) "/bin/sh" shell-file-name) | |
2603 | (if (file-remote-p default-directory) "-c" shell-command-switch) | |
2604 | (mapconcat 'identity args " "))) | |
f3ed9aca JB |
2605 | (set-advertised-calling-convention 'start-file-process-shell-command |
2606 | '(name buffer command)) | |
a9e11582 | 2607 | |
93aca633 MB |
2608 | (defun call-process-shell-command (command &optional infile buffer display |
2609 | &rest args) | |
2610 | "Execute the shell command COMMAND synchronously in separate process. | |
2611 | The remaining arguments are optional. | |
2612 | The program's input comes from file INFILE (nil means `/dev/null'). | |
2613 | Insert output in BUFFER before point; t means current buffer; | |
2614 | nil for BUFFER means discard it; 0 means discard and don't wait. | |
2615 | BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case, | |
2616 | REAL-BUFFER says what to do with standard output, as above, | |
2617 | while STDERR-FILE says what to do with standard error in the child. | |
2618 | STDERR-FILE may be nil (discard standard error output), | |
2619 | t (mix it with ordinary output), or a file name string. | |
2620 | ||
2621 | Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted. | |
2622 | Remaining arguments are strings passed as additional arguments for COMMAND. | |
2623 | Wildcards and redirection are handled as usual in the shell. | |
2624 | ||
2625 | If BUFFER is 0, `call-process-shell-command' returns immediately with value nil. | |
2626 | Otherwise it waits for COMMAND to terminate and returns a numeric exit | |
2627 | status or a signal description string. | |
2628 | If you quit, the process is killed with SIGINT, or SIGKILL if you quit again." | |
7c2fb837 DN |
2629 | ;; We used to use `exec' to replace the shell with the command, |
2630 | ;; but that failed to handle (...) and semicolon, etc. | |
2631 | (call-process shell-file-name | |
2632 | infile buffer display | |
2633 | shell-command-switch | |
2634 | (mapconcat 'identity (cons command args) " "))) | |
a9e11582 MA |
2635 | |
2636 | (defun process-file-shell-command (command &optional infile buffer display | |
2637 | &rest args) | |
2638 | "Process files synchronously in a separate process. | |
2639 | Similar to `call-process-shell-command', but calls `process-file'." | |
2640 | (process-file | |
2641 | (if (file-remote-p default-directory) "/bin/sh" shell-file-name) | |
2642 | infile buffer display | |
2643 | (if (file-remote-p default-directory) "-c" shell-command-switch) | |
2644 | (mapconcat 'identity (cons command args) " "))) | |
a7ed4c2a | 2645 | \f |
c4f484f2 RS |
2646 | ;;;; Lisp macros to do various things temporarily. |
2647 | ||
83f57f49 MR |
2648 | (defmacro with-current-buffer (buffer-or-name &rest body) |
2649 | "Execute the forms in BODY with BUFFER-OR-NAME temporarily current. | |
2650 | BUFFER-OR-NAME must be a buffer or the name of an existing buffer. | |
2651 | The value returned is the value of the last form in BODY. See | |
2652 | also `with-temp-buffer'." | |
d47f7515 SM |
2653 | (declare (indent 1) (debug t)) |
2654 | `(save-current-buffer | |
83f57f49 | 2655 | (set-buffer ,buffer-or-name) |
d47f7515 SM |
2656 | ,@body)) |
2657 | ||
2658 | (defmacro with-selected-window (window &rest body) | |
2659 | "Execute the forms in BODY with WINDOW as the selected window. | |
2660 | The value returned is the value of the last form in BODY. | |
4c6d1e16 | 2661 | |
a5094f72 MR |
2662 | This macro saves and restores the selected window, as well as the |
2663 | selected window of each frame. It does not change the order of | |
2664 | recently selected windows. If the previously selected window of | |
2665 | some frame is no longer live at the end of BODY, that frame's | |
2666 | selected window is left alone. If the selected window is no | |
2667 | longer live, then whatever window is selected at the end of BODY | |
2668 | remains selected. | |
2669 | ||
2670 | This macro uses `save-current-buffer' to save and restore the | |
2671 | current buffer, since otherwise its normal operation could | |
2672 | potentially make a different buffer current. It does not alter | |
2673 | the buffer list ordering." | |
d47f7515 | 2674 | (declare (indent 1) (debug t)) |
4df623c0 RS |
2675 | ;; Most of this code is a copy of save-selected-window. |
2676 | `(let ((save-selected-window-window (selected-window)) | |
3f71ad3a RS |
2677 | ;; It is necessary to save all of these, because calling |
2678 | ;; select-window changes frame-selected-window for whatever | |
2679 | ;; frame that window is in. | |
4df623c0 RS |
2680 | (save-selected-window-alist |
2681 | (mapcar (lambda (frame) (list frame (frame-selected-window frame))) | |
2682 | (frame-list)))) | |
4c6d1e16 RS |
2683 | (save-current-buffer |
2684 | (unwind-protect | |
2685 | (progn (select-window ,window 'norecord) | |
2686 | ,@body) | |
2687 | (dolist (elt save-selected-window-alist) | |
2688 | (and (frame-live-p (car elt)) | |
2689 | (window-live-p (cadr elt)) | |
a5094f72 MR |
2690 | (set-frame-selected-window (car elt) (cadr elt) 'norecord))) |
2691 | (when (window-live-p save-selected-window-window) | |
2692 | (select-window save-selected-window-window 'norecord)))))) | |
a7f284ec | 2693 | |
c3e242d3 KL |
2694 | (defmacro with-selected-frame (frame &rest body) |
2695 | "Execute the forms in BODY with FRAME as the selected frame. | |
2696 | The value returned is the value of the last form in BODY. | |
a5094f72 MR |
2697 | |
2698 | This macro neither changes the order of recently selected windows | |
2699 | nor the buffer list." | |
c3e242d3 | 2700 | (declare (indent 1) (debug t)) |
632210dd KL |
2701 | (let ((old-frame (make-symbol "old-frame")) |
2702 | (old-buffer (make-symbol "old-buffer"))) | |
2703 | `(let ((,old-frame (selected-frame)) | |
2704 | (,old-buffer (current-buffer))) | |
2705 | (unwind-protect | |
a5094f72 | 2706 | (progn (select-frame ,frame 'norecord) |
632210dd | 2707 | ,@body) |
a5094f72 MR |
2708 | (when (frame-live-p ,old-frame) |
2709 | (select-frame ,old-frame 'norecord)) | |
2710 | (when (buffer-live-p ,old-buffer) | |
2711 | (set-buffer ,old-buffer)))))) | |
c3e242d3 | 2712 | |
e5bb8a8c SM |
2713 | (defmacro with-temp-file (file &rest body) |
2714 | "Create a new buffer, evaluate BODY there, and write the buffer to FILE. | |
2715 | The value returned is the value of the last form in BODY. | |
a2fdb55c | 2716 | See also `with-temp-buffer'." |
f30e0cd8 | 2717 | (declare (debug t)) |
a7ed4c2a | 2718 | (let ((temp-file (make-symbol "temp-file")) |
a2fdb55c EN |
2719 | (temp-buffer (make-symbol "temp-buffer"))) |
2720 | `(let ((,temp-file ,file) | |
2721 | (,temp-buffer | |
2722 | (get-buffer-create (generate-new-buffer-name " *temp file*")))) | |
2723 | (unwind-protect | |
2724 | (prog1 | |
2725 | (with-current-buffer ,temp-buffer | |
e5bb8a8c | 2726 | ,@body) |
a2fdb55c | 2727 | (with-current-buffer ,temp-buffer |
ab1d3835 | 2728 | (write-region nil nil ,temp-file nil 0))) |
a2fdb55c EN |
2729 | (and (buffer-name ,temp-buffer) |
2730 | (kill-buffer ,temp-buffer)))))) | |
2731 | ||
e5bb8a8c | 2732 | (defmacro with-temp-message (message &rest body) |
a600effe | 2733 | "Display MESSAGE temporarily if non-nil while BODY is evaluated. |
e5bb8a8c SM |
2734 | The original message is restored to the echo area after BODY has finished. |
2735 | The value returned is the value of the last form in BODY. | |
a600effe SM |
2736 | MESSAGE is written to the message log buffer if `message-log-max' is non-nil. |
2737 | If MESSAGE is nil, the echo area and message log buffer are unchanged. | |
2738 | Use a MESSAGE of \"\" to temporarily clear the echo area." | |
f30e0cd8 | 2739 | (declare (debug t)) |
110201c8 SM |
2740 | (let ((current-message (make-symbol "current-message")) |
2741 | (temp-message (make-symbol "with-temp-message"))) | |
2742 | `(let ((,temp-message ,message) | |
2743 | (,current-message)) | |
e5bb8a8c SM |
2744 | (unwind-protect |
2745 | (progn | |
110201c8 SM |
2746 | (when ,temp-message |
2747 | (setq ,current-message (current-message)) | |
aadf7ff3 | 2748 | (message "%s" ,temp-message)) |
e5bb8a8c | 2749 | ,@body) |
cad84646 RS |
2750 | (and ,temp-message |
2751 | (if ,current-message | |
2752 | (message "%s" ,current-message) | |
2753 | (message nil))))))) | |
e5bb8a8c SM |
2754 | |
2755 | (defmacro with-temp-buffer (&rest body) | |
2756 | "Create a temporary buffer, and evaluate BODY there like `progn'. | |
a2fdb55c | 2757 | See also `with-temp-file' and `with-output-to-string'." |
d47f7515 | 2758 | (declare (indent 0) (debug t)) |
a2fdb55c | 2759 | (let ((temp-buffer (make-symbol "temp-buffer"))) |
9166dbf6 | 2760 | `(let ((,temp-buffer (generate-new-buffer " *temp*"))) |
4a5e1832 SM |
2761 | ;; FIXME: kill-buffer can change current-buffer in some odd cases. |
2762 | (with-current-buffer ,temp-buffer | |
2763 | (unwind-protect | |
2764 | (progn ,@body) | |
2765 | (and (buffer-name ,temp-buffer) | |
2766 | (kill-buffer ,temp-buffer))))))) | |
a2fdb55c | 2767 | |
83a5aac5 SM |
2768 | (defmacro with-silent-modifications (&rest body) |
2769 | "Execute BODY, pretending it does not modifies the buffer. | |
2770 | If BODY performs real modifications to the buffer's text, other | |
2771 | than cosmetic ones, undo data may become corrupted. | |
2772 | Typically used around modifications of text-properties which do not really | |
2773 | affect the buffer's content." | |
2774 | (declare (debug t) (indent 0)) | |
2775 | (let ((modified (make-symbol "modified"))) | |
2776 | `(let* ((,modified (buffer-modified-p)) | |
2777 | (buffer-undo-list t) | |
2778 | (inhibit-read-only t) | |
2779 | (inhibit-modification-hooks t) | |
2780 | deactivate-mark | |
2781 | ;; Avoid setting and removing file locks and checking | |
2782 | ;; buffer's uptodate-ness w.r.t the underlying file. | |
2783 | buffer-file-name | |
2784 | buffer-file-truename) | |
2785 | (unwind-protect | |
2786 | (progn | |
2787 | ,@body) | |
2788 | (unless ,modified | |
2789 | (restore-buffer-modified-p nil)))))) | |
2790 | ||
5db7925d RS |
2791 | (defmacro with-output-to-string (&rest body) |
2792 | "Execute BODY, return the text it sent to `standard-output', as a string." | |
d47f7515 | 2793 | (declare (indent 0) (debug t)) |
a2fdb55c EN |
2794 | `(let ((standard-output |
2795 | (get-buffer-create (generate-new-buffer-name " *string-output*")))) | |
86ec740e RF |
2796 | (unwind-protect |
2797 | (progn | |
2798 | (let ((standard-output standard-output)) | |
2799 | ,@body) | |
2800 | (with-current-buffer standard-output | |
2801 | (buffer-string))) | |
2802 | (kill-buffer standard-output)))) | |
2ec9c94e | 2803 | |
0764e16f | 2804 | (defmacro with-local-quit (&rest body) |
53a7160c | 2805 | "Execute BODY, allowing quits to terminate BODY but not escape further. |
b9308c61 | 2806 | When a quit terminates BODY, `with-local-quit' returns nil but |
60f7e8b6 RS |
2807 | requests another quit. That quit will be processed as soon as quitting |
2808 | is allowed once again. (Immediately, if `inhibit-quit' is nil.)" | |
12320833 | 2809 | (declare (debug t) (indent 0)) |
0764e16f SM |
2810 | `(condition-case nil |
2811 | (let ((inhibit-quit nil)) | |
2812 | ,@body) | |
113fe928 RS |
2813 | (quit (setq quit-flag t) |
2814 | ;; This call is to give a chance to handle quit-flag | |
2815 | ;; in case inhibit-quit is nil. | |
2816 | ;; Without this, it will not be handled until the next function | |
2817 | ;; call, and that might allow it to exit thru a condition-case | |
2818 | ;; that intends to handle the quit signal next time. | |
2819 | (eval '(ignore nil))))) | |
0764e16f | 2820 | |
c2b53d7b RS |
2821 | (defmacro while-no-input (&rest body) |
2822 | "Execute BODY only as long as there's no pending input. | |
2823 | If input arrives, that ends the execution of BODY, | |
83047ee3 RS |
2824 | and `while-no-input' returns t. Quitting makes it return nil. |
2825 | If BODY finishes, `while-no-input' returns whatever value BODY produced." | |
c2b53d7b RS |
2826 | (declare (debug t) (indent 0)) |
2827 | (let ((catch-sym (make-symbol "input"))) | |
2828 | `(with-local-quit | |
2829 | (catch ',catch-sym | |
2830 | (let ((throw-on-input ',catch-sym)) | |
790e0ef7 | 2831 | (or (input-pending-p) |
ff7d73ac | 2832 | (progn ,@body))))))) |
c2b53d7b | 2833 | |
47ccb993 SM |
2834 | (defmacro condition-case-no-debug (var bodyform &rest handlers) |
2835 | "Like `condition-case' except that it does not catch anything when debugging. | |
2836 | More specifically if `debug-on-error' is set, then it does not catch any signal." | |
2837 | (declare (debug condition-case) (indent 2)) | |
2838 | (let ((bodysym (make-symbol "body"))) | |
2839 | `(let ((,bodysym (lambda () ,bodyform))) | |
2840 | (if debug-on-error | |
2841 | (funcall ,bodysym) | |
2842 | (condition-case ,var | |
2843 | (funcall ,bodysym) | |
2844 | ,@handlers))))) | |
2845 | ||
2846 | (defmacro with-demoted-errors (&rest body) | |
2847 | "Run BODY and demote any errors to simple messages. | |
2848 | If `debug-on-error' is non-nil, run BODY without catching its errors. | |
2849 | This is to be used around code which is not expected to signal an error | |
04bf5b65 | 2850 | but which should be robust in the unexpected case that an error is signaled." |
47ccb993 SM |
2851 | (declare (debug t) (indent 0)) |
2852 | (let ((err (make-symbol "err"))) | |
2853 | `(condition-case-no-debug ,err | |
2854 | (progn ,@body) | |
2855 | (error (message "Error: %s" ,err) nil)))) | |
2856 | ||
2ec9c94e RS |
2857 | (defmacro combine-after-change-calls (&rest body) |
2858 | "Execute BODY, but don't call the after-change functions till the end. | |
2859 | If BODY makes changes in the buffer, they are recorded | |
2860 | and the functions on `after-change-functions' are called several times | |
2861 | when BODY is finished. | |
31aa282e | 2862 | The return value is the value of the last form in BODY. |
2ec9c94e RS |
2863 | |
2864 | If `before-change-functions' is non-nil, then calls to the after-change | |
2865 | functions can't be deferred, so in that case this macro has no effect. | |
2866 | ||
2867 | Do not alter `after-change-functions' or `before-change-functions' | |
2868 | in BODY." | |
d47f7515 | 2869 | (declare (indent 0) (debug t)) |
2ec9c94e RS |
2870 | `(unwind-protect |
2871 | (let ((combine-after-change-calls t)) | |
2872 | . ,body) | |
2873 | (combine-after-change-execute))) | |
6a978be3 CY |
2874 | |
2875 | (defmacro with-case-table (table &rest body) | |
2876 | "Execute the forms in BODY with TABLE as the current case table. | |
2877 | The value returned is the value of the last form in BODY." | |
2878 | (declare (indent 1) (debug t)) | |
8d6fd8d4 JPW |
2879 | (let ((old-case-table (make-symbol "table")) |
2880 | (old-buffer (make-symbol "buffer"))) | |
2881 | `(let ((,old-case-table (current-case-table)) | |
2882 | (,old-buffer (current-buffer))) | |
2883 | (unwind-protect | |
2884 | (progn (set-case-table ,table) | |
2885 | ,@body) | |
2886 | (with-current-buffer ,old-buffer | |
2887 | (set-case-table ,old-case-table)))))) | |
c4f484f2 | 2888 | \f |
c4f484f2 | 2889 | ;;; Matching and match data. |
2493767e | 2890 | |
c7ca41e6 RS |
2891 | (defvar save-match-data-internal) |
2892 | ||
2893 | ;; We use save-match-data-internal as the local variable because | |
2894 | ;; that works ok in practice (people should not use that variable elsewhere). | |
2895 | ;; We used to use an uninterned symbol; the compiler handles that properly | |
2896 | ;; now, but it generates slower code. | |
9a5336ae | 2897 | (defmacro save-match-data (&rest body) |
e4d03691 JB |
2898 | "Execute the BODY forms, restoring the global value of the match data. |
2899 | The value returned is the value of the last form in BODY." | |
64ed733a PE |
2900 | ;; It is better not to use backquote here, |
2901 | ;; because that makes a bootstrapping problem | |
2902 | ;; if you need to recompile all the Lisp files using interpreted code. | |
d47f7515 | 2903 | (declare (indent 0) (debug t)) |
64ed733a PE |
2904 | (list 'let |
2905 | '((save-match-data-internal (match-data))) | |
2906 | (list 'unwind-protect | |
2907 | (cons 'progn body) | |
d1fab151 KS |
2908 | ;; It is safe to free (evaporate) markers immediately here, |
2909 | ;; as Lisp programs should not copy from save-match-data-internal. | |
a0ef72df | 2910 | '(set-match-data save-match-data-internal 'evaporate)))) |
993713ce | 2911 | |
cd323f89 | 2912 | (defun match-string (num &optional string) |
993713ce SM |
2913 | "Return string of text matched by last search. |
2914 | NUM specifies which parenthesized expression in the last regexp. | |
2915 | Value is nil if NUMth pair didn't match, or there were less than NUM pairs. | |
2916 | Zero means the entire text matched by the whole regexp or whole string. | |
2917 | STRING should be given if the last search was by `string-match' on STRING." | |
cd323f89 SM |
2918 | (if (match-beginning num) |
2919 | (if string | |
2920 | (substring string (match-beginning num) (match-end num)) | |
2921 | (buffer-substring (match-beginning num) (match-end num))))) | |
58f950b4 | 2922 | |
bb760c71 RS |
2923 | (defun match-string-no-properties (num &optional string) |
2924 | "Return string of text matched by last search, without text properties. | |
2925 | NUM specifies which parenthesized expression in the last regexp. | |
2926 | Value is nil if NUMth pair didn't match, or there were less than NUM pairs. | |
2927 | Zero means the entire text matched by the whole regexp or whole string. | |
2928 | STRING should be given if the last search was by `string-match' on STRING." | |
2929 | (if (match-beginning num) | |
2930 | (if string | |
6b61353c KH |
2931 | (substring-no-properties string (match-beginning num) |
2932 | (match-end num)) | |
bb760c71 RS |
2933 | (buffer-substring-no-properties (match-beginning num) |
2934 | (match-end num))))) | |
2935 | ||
8c2e721a JL |
2936 | |
2937 | (defun match-substitute-replacement (replacement | |
2938 | &optional fixedcase literal string subexp) | |
2939 | "Return REPLACEMENT as it will be inserted by `replace-match'. | |
2940 | In other words, all back-references in the form `\\&' and `\\N' | |
2941 | are substituted with actual strings matched by the last search. | |
2942 | Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same | |
2943 | meaning as for `replace-match'." | |
2944 | (let ((match (match-string 0 string))) | |
2945 | (save-match-data | |
2946 | (set-match-data (mapcar (lambda (x) | |
2947 | (if (numberp x) | |
2948 | (- x (match-beginning 0)) | |
2949 | x)) | |
2950 | (match-data t))) | |
2951 | (replace-match replacement fixedcase literal match subexp)))) | |
2952 | ||
2953 | ||
46065dd4 | 2954 | (defun looking-back (regexp &optional limit greedy) |
f30e0cd8 | 2955 | "Return non-nil if text before point matches regular expression REGEXP. |
991b32c3 | 2956 | Like `looking-at' except matches before point, and is slower. |
01d16e16 RS |
2957 | LIMIT if non-nil speeds up the search by specifying a minimum |
2958 | starting position, to avoid checking matches that would start | |
2959 | before LIMIT. | |
46065dd4 | 2960 | |
cde27dd2 CY |
2961 | If GREEDY is non-nil, extend the match backwards as far as |
2962 | possible, stopping when a single additional previous character | |
2963 | cannot be part of a match for REGEXP. When the match is | |
3dcde186 | 2964 | extended, its starting position is allowed to occur before |
cde27dd2 | 2965 | LIMIT." |
46065dd4 RS |
2966 | (let ((start (point)) |
2967 | (pos | |
2968 | (save-excursion | |
2969 | (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t) | |
2970 | (point))))) | |
2971 | (if (and greedy pos) | |
2972 | (save-restriction | |
2973 | (narrow-to-region (point-min) start) | |
2974 | (while (and (> pos (point-min)) | |
2975 | (save-excursion | |
2976 | (goto-char pos) | |
2977 | (backward-char 1) | |
2978 | (looking-at (concat "\\(?:" regexp "\\)\\'")))) | |
2979 | (setq pos (1- pos))) | |
2980 | (save-excursion | |
2981 | (goto-char pos) | |
2982 | (looking-at (concat "\\(?:" regexp "\\)\\'"))))) | |
2983 | (not (null pos)))) | |
2984 | ||
45595a4f RS |
2985 | (defsubst looking-at-p (regexp) |
2986 | "\ | |
2987 | Same as `looking-at' except this function does not change the match data." | |
2988 | (let ((inhibit-changing-match-data t)) | |
2989 | (looking-at regexp))) | |
2990 | ||
2991 | (defsubst string-match-p (regexp string &optional start) | |
2992 | "\ | |
2993 | Same as `string-match' except this function does not change the match data." | |
2994 | (let ((inhibit-changing-match-data t)) | |
2995 | (string-match regexp string start))) | |
2996 | ||
c4f484f2 RS |
2997 | (defun subregexp-context-p (regexp pos &optional start) |
2998 | "Return non-nil if POS is in a normal subregexp context in REGEXP. | |
2999 | A subregexp context is one where a sub-regexp can appear. | |
3000 | A non-subregexp context is for example within brackets, or within a | |
3001 | repetition bounds operator `\\=\\{...\\}', or right after a `\\'. | |
3002 | If START is non-nil, it should be a position in REGEXP, smaller | |
3003 | than POS, and known to be in a subregexp context." | |
3004 | ;; Here's one possible implementation, with the great benefit that it | |
3005 | ;; reuses the regexp-matcher's own parser, so it understands all the | |
3006 | ;; details of the syntax. A disadvantage is that it needs to match the | |
3007 | ;; error string. | |
3008 | (condition-case err | |
3009 | (progn | |
3010 | (string-match (substring regexp (or start 0) pos) "") | |
3011 | t) | |
3012 | (invalid-regexp | |
3013 | (not (member (cadr err) '("Unmatched [ or [^" | |
3014 | "Unmatched \\{" | |
3015 | "Trailing backslash"))))) | |
3016 | ;; An alternative implementation: | |
3017 | ;; (defconst re-context-re | |
3018 | ;; (let* ((harmless-ch "[^\\[]") | |
3019 | ;; (harmless-esc "\\\\[^{]") | |
3020 | ;; (class-harmless-ch "[^][]") | |
3021 | ;; (class-lb-harmless "[^]:]") | |
3022 | ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?") | |
3023 | ;; (class-lb (concat "\\[\\(" class-lb-harmless | |
3024 | ;; "\\|" class-lb-colon-maybe-charclass "\\)")) | |
3025 | ;; (class | |
3026 | ;; (concat "\\[^?]?" | |
3027 | ;; "\\(" class-harmless-ch | |
3028 | ;; "\\|" class-lb "\\)*" | |
3029 | ;; "\\[?]")) ; special handling for bare [ at end of re | |
3030 | ;; (braces "\\\\{[0-9,]+\\\\}")) | |
3031 | ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc | |
3032 | ;; "\\|" class "\\|" braces "\\)*\\'")) | |
3033 | ;; "Matches any prefix that corresponds to a normal subregexp context.") | |
3034 | ;; (string-match re-context-re (substring regexp (or start 0) pos)) | |
3035 | ) | |
3036 | \f | |
3037 | ;;;; split-string | |
498535fb | 3038 | |
6a646626 JB |
3039 | (defconst split-string-default-separators "[ \f\t\n\r\v]+" |
3040 | "The default value of separators for `split-string'. | |
3041 | ||
3042 | A regexp matching strings of whitespace. May be locale-dependent | |
3043 | \(as yet unimplemented). Should not match non-breaking spaces. | |
3044 | ||
3045 | Warning: binding this to a different value and using it as default is | |
3046 | likely to have undesired semantics.") | |
3047 | ||
3048 | ;; The specification says that if both SEPARATORS and OMIT-NULLS are | |
3049 | ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical | |
3050 | ;; expression leads to the equivalent implementation that if SEPARATORS | |
3051 | ;; is defaulted, OMIT-NULLS is treated as t. | |
3052 | (defun split-string (string &optional separators omit-nulls) | |
203998e5 | 3053 | "Split STRING into substrings bounded by matches for SEPARATORS. |
6a646626 JB |
3054 | |
3055 | The beginning and end of STRING, and each match for SEPARATORS, are | |
3056 | splitting points. The substrings matching SEPARATORS are removed, and | |
3057 | the substrings between the splitting points are collected as a list, | |
edce3654 | 3058 | which is returned. |
b222b786 | 3059 | |
6a646626 JB |
3060 | If SEPARATORS is non-nil, it should be a regular expression matching text |
3061 | which separates, but is not part of, the substrings. If nil it defaults to | |
3062 | `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and | |
3063 | OMIT-NULLS is forced to t. | |
3064 | ||
a478f3e1 | 3065 | If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so |
6a646626 JB |
3066 | that for the default value of SEPARATORS leading and trailing whitespace |
3067 | are effectively trimmed). If nil, all zero-length substrings are retained, | |
3068 | which correctly parses CSV format, for example. | |
3069 | ||
3070 | Note that the effect of `(split-string STRING)' is the same as | |
55e45419 | 3071 | `(split-string STRING split-string-default-separators t)'. In the rare |
6a646626 JB |
3072 | case that you wish to retain zero-length substrings when splitting on |
3073 | whitespace, use `(split-string STRING split-string-default-separators)'. | |
b021ef18 DL |
3074 | |
3075 | Modifies the match data; use `save-match-data' if necessary." | |
6a646626 JB |
3076 | (let ((keep-nulls (not (if separators omit-nulls t))) |
3077 | (rexp (or separators split-string-default-separators)) | |
edce3654 | 3078 | (start 0) |
b222b786 | 3079 | notfirst |
edce3654 | 3080 | (list nil)) |
b222b786 RS |
3081 | (while (and (string-match rexp string |
3082 | (if (and notfirst | |
3083 | (= start (match-beginning 0)) | |
3084 | (< start (length string))) | |
3085 | (1+ start) start)) | |
6a646626 | 3086 | (< start (length string))) |
b222b786 | 3087 | (setq notfirst t) |
6a646626 | 3088 | (if (or keep-nulls (< start (match-beginning 0))) |
edce3654 RS |
3089 | (setq list |
3090 | (cons (substring string start (match-beginning 0)) | |
3091 | list))) | |
3092 | (setq start (match-end 0))) | |
6a646626 | 3093 | (if (or keep-nulls (< start (length string))) |
edce3654 RS |
3094 | (setq list |
3095 | (cons (substring string start) | |
3096 | list))) | |
3097 | (nreverse list))) | |
0b93ff3a | 3098 | |
e80b3849 | 3099 | (defun combine-and-quote-strings (strings &optional separator) |
0b93ff3a NR |
3100 | "Concatenate the STRINGS, adding the SEPARATOR (default \" \"). |
3101 | This tries to quote the strings to avoid ambiguity such that | |
e80b3849 | 3102 | (split-string-and-unquote (combine-and-quote-strings strs)) == strs |
0b93ff3a | 3103 | Only some SEPARATORs will work properly." |
9f2bd2e7 SM |
3104 | (let* ((sep (or separator " ")) |
3105 | (re (concat "[\\\"]" "\\|" (regexp-quote sep)))) | |
0b93ff3a NR |
3106 | (mapconcat |
3107 | (lambda (str) | |
9f2bd2e7 | 3108 | (if (string-match re str) |
0b93ff3a NR |
3109 | (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"") |
3110 | str)) | |
3111 | strings sep))) | |
3112 | ||
e80b3849 | 3113 | (defun split-string-and-unquote (string &optional separator) |
0b93ff3a | 3114 | "Split the STRING into a list of strings. |
e80b3849 RS |
3115 | It understands Emacs Lisp quoting within STRING, such that |
3116 | (split-string-and-unquote (combine-and-quote-strings strs)) == strs | |
0b93ff3a NR |
3117 | The SEPARATOR regexp defaults to \"\\s-+\"." |
3118 | (let ((sep (or separator "\\s-+")) | |
d551d20d | 3119 | (i (string-match "\"" string))) |
e80b3849 RS |
3120 | (if (null i) |
3121 | (split-string string sep t) ; no quoting: easy | |
0b93ff3a NR |
3122 | (append (unless (eq i 0) (split-string (substring string 0 i) sep t)) |
3123 | (let ((rfs (read-from-string string i))) | |
3124 | (cons (car rfs) | |
e80b3849 RS |
3125 | (split-string-and-unquote (substring string (cdr rfs)) |
3126 | sep))))))) | |
0b93ff3a | 3127 | |
c4f484f2 RS |
3128 | \f |
3129 | ;;;; Replacement in strings. | |
1ccaea52 AI |
3130 | |
3131 | (defun subst-char-in-string (fromchar tochar string &optional inplace) | |
3132 | "Replace FROMCHAR with TOCHAR in STRING each time it occurs. | |
3133 | Unless optional argument INPLACE is non-nil, return a new string." | |
e6e71807 SM |
3134 | (let ((i (length string)) |
3135 | (newstr (if inplace string (copy-sequence string)))) | |
3136 | (while (> i 0) | |
3137 | (setq i (1- i)) | |
3138 | (if (eq (aref newstr i) fromchar) | |
3139 | (aset newstr i tochar))) | |
3140 | newstr)) | |
b021ef18 | 3141 | |
1697159c | 3142 | (defun replace-regexp-in-string (regexp rep string &optional |
c8227332 | 3143 | fixedcase literal subexp start) |
b021ef18 DL |
3144 | "Replace all matches for REGEXP with REP in STRING. |
3145 | ||
3146 | Return a new string containing the replacements. | |
3147 | ||
3148 | Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the | |
3149 | arguments with the same names of function `replace-match'. If START | |
3150 | is non-nil, start replacements at that index in STRING. | |
3151 | ||
3152 | REP is either a string used as the NEWTEXT arg of `replace-match' or a | |
23bb94bb RS |
3153 | function. If it is a function, it is called with the actual text of each |
3154 | match, and its value is used as the replacement text. When REP is called, | |
3155 | the match-data are the result of matching REGEXP against a substring | |
3156 | of STRING. | |
b021ef18 | 3157 | |
1697159c DL |
3158 | To replace only the first match (if any), make REGEXP match up to \\' |
3159 | and replace a sub-expression, e.g. | |
c9bcb507 | 3160 | (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1) |
1697159c DL |
3161 | => \" bar foo\" |
3162 | " | |
b021ef18 DL |
3163 | |
3164 | ;; To avoid excessive consing from multiple matches in long strings, | |
3165 | ;; don't just call `replace-match' continually. Walk down the | |
3166 | ;; string looking for matches of REGEXP and building up a (reversed) | |
3167 | ;; list MATCHES. This comprises segments of STRING which weren't | |
3168 | ;; matched interspersed with replacements for segments that were. | |
08b1f8a1 | 3169 | ;; [For a `large' number of replacements it's more efficient to |
b021ef18 DL |
3170 | ;; operate in a temporary buffer; we can't tell from the function's |
3171 | ;; args whether to choose the buffer-based implementation, though it | |
3172 | ;; might be reasonable to do so for long enough STRING.] | |
3173 | (let ((l (length string)) | |
3174 | (start (or start 0)) | |
3175 | matches str mb me) | |
3176 | (save-match-data | |
3177 | (while (and (< start l) (string-match regexp string start)) | |
3178 | (setq mb (match-beginning 0) | |
3179 | me (match-end 0)) | |
a9853251 SM |
3180 | ;; If we matched the empty string, make sure we advance by one char |
3181 | (when (= me mb) (setq me (min l (1+ mb)))) | |
3182 | ;; Generate a replacement for the matched substring. | |
3183 | ;; Operate only on the substring to minimize string consing. | |
3184 | ;; Set up match data for the substring for replacement; | |
3185 | ;; presumably this is likely to be faster than munging the | |
3186 | ;; match data directly in Lisp. | |
3187 | (string-match regexp (setq str (substring string mb me))) | |
3188 | (setq matches | |
3189 | (cons (replace-match (if (stringp rep) | |
3190 | rep | |
3191 | (funcall rep (match-string 0 str))) | |
3192 | fixedcase literal str subexp) | |
c8227332 | 3193 | (cons (substring string start mb) ; unmatched prefix |
a9853251 SM |
3194 | matches))) |
3195 | (setq start me)) | |
b021ef18 DL |
3196 | ;; Reconstruct a string from the pieces. |
3197 | (setq matches (cons (substring string start l) matches)) ; leftover | |
3198 | (apply #'concat (nreverse matches))))) | |
a7ed4c2a | 3199 | \f |
cb190d7d SM |
3200 | (defun string-prefix-p (str1 str2 &optional ignore-case) |
3201 | "Return non-nil if STR1 is a prefix of STR2. | |
3202 | If IGNORE-CASE is non-nil, the comparison is done without paying attention | |
3203 | to case differences." | |
3204 | (eq t (compare-strings str1 nil nil | |
3205 | str2 0 (length str1) ignore-case))) | |
3206 | \f | |
c4f484f2 | 3207 | ;;;; invisibility specs |
df8e73e1 | 3208 | |
c4f484f2 RS |
3209 | (defun add-to-invisibility-spec (element) |
3210 | "Add ELEMENT to `buffer-invisibility-spec'. | |
3211 | See documentation for `buffer-invisibility-spec' for the kind of elements | |
3212 | that can be added." | |
3213 | (if (eq buffer-invisibility-spec t) | |
3214 | (setq buffer-invisibility-spec (list t))) | |
3215 | (setq buffer-invisibility-spec | |
3216 | (cons element buffer-invisibility-spec))) | |
3217 | ||
3218 | (defun remove-from-invisibility-spec (element) | |
3219 | "Remove ELEMENT from `buffer-invisibility-spec'." | |
3220 | (if (consp buffer-invisibility-spec) | |
c8227332 VJL |
3221 | (setq buffer-invisibility-spec |
3222 | (delete element buffer-invisibility-spec)))) | |
a7ed4c2a | 3223 | \f |
c4f484f2 RS |
3224 | ;;;; Syntax tables. |
3225 | ||
3226 | (defmacro with-syntax-table (table &rest body) | |
3227 | "Evaluate BODY with syntax table of current buffer set to TABLE. | |
3228 | The syntax table of the current buffer is saved, BODY is evaluated, and the | |
3229 | saved table is restored, even in case of an abnormal exit. | |
3230 | Value is what BODY returns." | |
3231 | (declare (debug t)) | |
3232 | (let ((old-table (make-symbol "table")) | |
3233 | (old-buffer (make-symbol "buffer"))) | |
3234 | `(let ((,old-table (syntax-table)) | |
3235 | (,old-buffer (current-buffer))) | |
3236 | (unwind-protect | |
3237 | (progn | |
3238 | (set-syntax-table ,table) | |
3239 | ,@body) | |
3240 | (save-current-buffer | |
3241 | (set-buffer ,old-buffer) | |
3242 | (set-syntax-table ,old-table)))))) | |
8af7df60 | 3243 | |
297d863b | 3244 | (defun make-syntax-table (&optional oldtable) |
984f718a | 3245 | "Return a new syntax table. |
0764e16f SM |
3246 | Create a syntax table which inherits from OLDTABLE (if non-nil) or |
3247 | from `standard-syntax-table' otherwise." | |
3248 | (let ((table (make-char-table 'syntax-table nil))) | |
3249 | (set-char-table-parent table (or oldtable (standard-syntax-table))) | |
3250 | table)) | |
31aa282e | 3251 | |
e9f13a95 | 3252 | (defun syntax-after (pos) |
9d1ffd5a EZ |
3253 | "Return the raw syntax of the char after POS. |
3254 | If POS is outside the buffer's accessible portion, return nil." | |
e9f13a95 | 3255 | (unless (or (< pos (point-min)) (>= pos (point-max))) |
d8ac3d27 SM |
3256 | (let ((st (if parse-sexp-lookup-properties |
3257 | (get-char-property pos 'syntax-table)))) | |
3258 | (if (consp st) st | |
3259 | (aref (or st (syntax-table)) (char-after pos)))))) | |
e9f13a95 | 3260 | |
cdd8dc28 | 3261 | (defun syntax-class (syntax) |
9d1ffd5a EZ |
3262 | "Return the syntax class part of the syntax descriptor SYNTAX. |
3263 | If SYNTAX is nil, return nil." | |
3264 | (and syntax (logand (car syntax) 65535))) | |
2493767e | 3265 | \f |
c4f484f2 | 3266 | ;;;; Text clones |
a13fe4c5 SM |
3267 | |
3268 | (defun text-clone-maintain (ol1 after beg end &optional len) | |
3269 | "Propagate the changes made under the overlay OL1 to the other clones. | |
3270 | This is used on the `modification-hooks' property of text clones." | |
3271 | (when (and after (not undo-in-progress) (overlay-start ol1)) | |
3272 | (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0))) | |
3273 | (setq beg (max beg (+ (overlay-start ol1) margin))) | |
3274 | (setq end (min end (- (overlay-end ol1) margin))) | |
3275 | (when (<= beg end) | |
3276 | (save-excursion | |
3277 | (when (overlay-get ol1 'text-clone-syntax) | |
3278 | ;; Check content of the clone's text. | |
3279 | (let ((cbeg (+ (overlay-start ol1) margin)) | |
3280 | (cend (- (overlay-end ol1) margin))) | |
3281 | (goto-char cbeg) | |
3282 | (save-match-data | |
3283 | (if (not (re-search-forward | |
3284 | (overlay-get ol1 'text-clone-syntax) cend t)) | |
3285 | ;; Mark the overlay for deletion. | |
3286 | (overlay-put ol1 'text-clones nil) | |
3287 | (when (< (match-end 0) cend) | |
3288 | ;; Shrink the clone at its end. | |
3289 | (setq end (min end (match-end 0))) | |
3290 | (move-overlay ol1 (overlay-start ol1) | |
3291 | (+ (match-end 0) margin))) | |
3292 | (when (> (match-beginning 0) cbeg) | |
3293 | ;; Shrink the clone at its beginning. | |
3294 | (setq beg (max (match-beginning 0) beg)) | |
3295 | (move-overlay ol1 (- (match-beginning 0) margin) | |
3296 | (overlay-end ol1))))))) | |
3297 | ;; Now go ahead and update the clones. | |
3298 | (let ((head (- beg (overlay-start ol1))) | |
3299 | (tail (- (overlay-end ol1) end)) | |
3300 | (str (buffer-substring beg end)) | |
3301 | (nothing-left t) | |
3302 | (inhibit-modification-hooks t)) | |
3303 | (dolist (ol2 (overlay-get ol1 'text-clones)) | |
3304 | (let ((oe (overlay-end ol2))) | |
3305 | (unless (or (eq ol1 ol2) (null oe)) | |
3306 | (setq nothing-left nil) | |
3307 | (let ((mod-beg (+ (overlay-start ol2) head))) | |
3308 | ;;(overlay-put ol2 'modification-hooks nil) | |
3309 | (goto-char (- (overlay-end ol2) tail)) | |
3310 | (unless (> mod-beg (point)) | |
3311 | (save-excursion (insert str)) | |
3312 | (delete-region mod-beg (point))) | |
3313 | ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain)) | |
3314 | )))) | |
3315 | (if nothing-left (delete-overlay ol1)))))))) | |
3316 | ||
3317 | (defun text-clone-create (start end &optional spreadp syntax) | |
3318 | "Create a text clone of START...END at point. | |
3319 | Text clones are chunks of text that are automatically kept identical: | |
3320 | changes done to one of the clones will be immediately propagated to the other. | |
3321 | ||
3322 | The buffer's content at point is assumed to be already identical to | |
3323 | the one between START and END. | |
3324 | If SYNTAX is provided it's a regexp that describes the possible text of | |
3325 | the clones; the clone will be shrunk or killed if necessary to ensure that | |
3326 | its text matches the regexp. | |
3327 | If SPREADP is non-nil it indicates that text inserted before/after the | |
3328 | clone should be incorporated in the clone." | |
3329 | ;; To deal with SPREADP we can either use an overlay with `nil t' along | |
3330 | ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay | |
3331 | ;; (with a one-char margin at each end) with `t nil'. | |
3332 | ;; We opted for a larger overlay because it behaves better in the case | |
3333 | ;; where the clone is reduced to the empty string (we want the overlay to | |
3334 | ;; stay when the clone's content is the empty string and we want to use | |
3335 | ;; `evaporate' to make sure those overlays get deleted when needed). | |
264ef586 | 3336 | ;; |
a13fe4c5 SM |
3337 | (let* ((pt-end (+ (point) (- end start))) |
3338 | (start-margin (if (or (not spreadp) (bobp) (<= start (point-min))) | |
3339 | 0 1)) | |
3340 | (end-margin (if (or (not spreadp) | |
3341 | (>= pt-end (point-max)) | |
3342 | (>= start (point-max))) | |
3343 | 0 1)) | |
3344 | (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t)) | |
3345 | (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t)) | |
3346 | (dups (list ol1 ol2))) | |
3347 | (overlay-put ol1 'modification-hooks '(text-clone-maintain)) | |
3348 | (when spreadp (overlay-put ol1 'text-clone-spreadp t)) | |
3349 | (when syntax (overlay-put ol1 'text-clone-syntax syntax)) | |
3350 | ;;(overlay-put ol1 'face 'underline) | |
3351 | (overlay-put ol1 'evaporate t) | |
3352 | (overlay-put ol1 'text-clones dups) | |
264ef586 | 3353 | ;; |
a13fe4c5 SM |
3354 | (overlay-put ol2 'modification-hooks '(text-clone-maintain)) |
3355 | (when spreadp (overlay-put ol2 'text-clone-spreadp t)) | |
3356 | (when syntax (overlay-put ol2 'text-clone-syntax syntax)) | |
3357 | ;;(overlay-put ol2 'face 'underline) | |
3358 | (overlay-put ol2 'evaporate t) | |
3359 | (overlay-put ol2 'text-clones dups))) | |
c4f484f2 RS |
3360 | \f |
3361 | ;;;; Mail user agents. | |
27c079eb | 3362 | |
c4f484f2 RS |
3363 | ;; Here we include just enough for other packages to be able |
3364 | ;; to define them. | |
324cd947 | 3365 | |
27c079eb SM |
3366 | (defun define-mail-user-agent (symbol composefunc sendfunc |
3367 | &optional abortfunc hookvar) | |
3368 | "Define a symbol to identify a mail-sending package for `mail-user-agent'. | |
3369 | ||
3370 | SYMBOL can be any Lisp symbol. Its function definition and/or | |
3371 | value as a variable do not matter for this usage; we use only certain | |
3372 | properties on its property list, to encode the rest of the arguments. | |
3373 | ||
3374 | COMPOSEFUNC is program callable function that composes an outgoing | |
3375 | mail message buffer. This function should set up the basics of the | |
3376 | buffer without requiring user interaction. It should populate the | |
3377 | standard mail headers, leaving the `to:' and `subject:' headers blank | |
3378 | by default. | |
3379 | ||
3380 | COMPOSEFUNC should accept several optional arguments--the same | |
3381 | arguments that `compose-mail' takes. See that function's documentation. | |
3382 | ||
3383 | SENDFUNC is the command a user would run to send the message. | |
3384 | ||
3385 | Optional ABORTFUNC is the command a user would run to abort the | |
3386 | message. For mail packages that don't have a separate abort function, | |
3387 | this can be `kill-buffer' (the equivalent of omitting this argument). | |
3388 | ||
3389 | Optional HOOKVAR is a hook variable that gets run before the message | |
3390 | is actually sent. Callers that use the `mail-user-agent' may | |
3391 | install a hook function temporarily on this hook variable. | |
3392 | If HOOKVAR is nil, `mail-send-hook' is used. | |
3393 | ||
3394 | The properties used on SYMBOL are `composefunc', `sendfunc', | |
3395 | `abortfunc', and `hookvar'." | |
3396 | (put symbol 'composefunc composefunc) | |
3397 | (put symbol 'sendfunc sendfunc) | |
3398 | (put symbol 'abortfunc (or abortfunc 'kill-buffer)) | |
3399 | (put symbol 'hookvar (or hookvar 'mail-send-hook))) | |
c4f484f2 RS |
3400 | \f |
3401 | ;;;; Progress reporters. | |
b4329caa EZ |
3402 | |
3403 | ;; Progress reporter has the following structure: | |
3404 | ;; | |
3405 | ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME | |
3406 | ;; MIN-VALUE | |
3407 | ;; MAX-VALUE | |
3408 | ;; MESSAGE | |
3409 | ;; MIN-CHANGE | |
3410 | ;; MIN-TIME]) | |
3411 | ;; | |
3412 | ;; This weirdeness is for optimization reasons: we want | |
3413 | ;; `progress-reporter-update' to be as fast as possible, so | |
3414 | ;; `(car reporter)' is better than `(aref reporter 0)'. | |
3415 | ;; | |
3416 | ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple | |
3417 | ;; digits of precision, it doesn't really matter here. On the other | |
3418 | ;; hand, it greatly simplifies the code. | |
3419 | ||
c85152fc KS |
3420 | (defsubst progress-reporter-update (reporter value) |
3421 | "Report progress of an operation in the echo area. | |
3422 | However, if the change since last echo area update is too small | |
3423 | or not enough time has passed, then do nothing (see | |
3424 | `make-progress-reporter' for details). | |
3425 | ||
3426 | First parameter, REPORTER, should be the result of a call to | |
3427 | `make-progress-reporter'. Second, VALUE, determines the actual | |
3428 | progress of operation; it must be between MIN-VALUE and MAX-VALUE | |
3429 | as passed to `make-progress-reporter'. | |
3430 | ||
3431 | This function is very inexpensive, you may not bother how often | |
3432 | you call it." | |
3433 | (when (>= value (car reporter)) | |
3434 | (progress-reporter-do-update reporter value))) | |
3435 | ||
b4329caa EZ |
3436 | (defun make-progress-reporter (message min-value max-value |
3437 | &optional current-value | |
3438 | min-change min-time) | |
aa56124a | 3439 | "Return progress reporter object to be used with `progress-reporter-update'. |
b4329caa EZ |
3440 | |
3441 | MESSAGE is shown in the echo area. When at least 1% of operation | |
3442 | is complete, the exact percentage will be appended to the | |
3443 | MESSAGE. When you call `progress-reporter-done', word \"done\" | |
3444 | is printed after the MESSAGE. You can change MESSAGE of an | |
3445 | existing progress reporter with `progress-reporter-force-update'. | |
3446 | ||
3447 | MIN-VALUE and MAX-VALUE designate starting (0% complete) and | |
3448 | final (100% complete) states of operation. The latter should be | |
3449 | larger; if this is not the case, then simply negate all values. | |
3450 | Optional CURRENT-VALUE specifies the progress by the moment you | |
3451 | call this function. You should omit it or set it to nil in most | |
3452 | cases since it defaults to MIN-VALUE. | |
3453 | ||
3454 | Optional MIN-CHANGE determines the minimal change in percents to | |
3455 | report (default is 1%.) Optional MIN-TIME specifies the minimal | |
3456 | time before echo area updates (default is 0.2 seconds.) If | |
3457 | `float-time' function is not present, then time is not tracked | |
3458 | at all. If OS is not capable of measuring fractions of seconds, | |
3459 | then this parameter is effectively rounded up." | |
3460 | ||
3461 | (unless min-time | |
3462 | (setq min-time 0.2)) | |
3463 | (let ((reporter | |
3464 | (cons min-value ;; Force a call to `message' now | |
3465 | (vector (if (and (fboundp 'float-time) | |
3466 | (>= min-time 0.02)) | |
3467 | (float-time) nil) | |
3468 | min-value | |
3469 | max-value | |
3470 | message | |
3471 | (if min-change (max (min min-change 50) 1) 1) | |
3472 | min-time)))) | |
3473 | (progress-reporter-update reporter (or current-value min-value)) | |
3474 | reporter)) | |
3475 | ||
b4329caa EZ |
3476 | (defun progress-reporter-force-update (reporter value &optional new-message) |
3477 | "Report progress of an operation in the echo area unconditionally. | |
3478 | ||
3479 | First two parameters are the same as for | |
3480 | `progress-reporter-update'. Optional NEW-MESSAGE allows you to | |
3481 | change the displayed message." | |
3482 | (let ((parameters (cdr reporter))) | |
3483 | (when new-message | |
3484 | (aset parameters 3 new-message)) | |
3485 | (when (aref parameters 0) | |
3486 | (aset parameters 0 (float-time))) | |
3487 | (progress-reporter-do-update reporter value))) | |
3488 | ||
3489 | (defun progress-reporter-do-update (reporter value) | |
3490 | (let* ((parameters (cdr reporter)) | |
3491 | (min-value (aref parameters 1)) | |
3492 | (max-value (aref parameters 2)) | |
3493 | (one-percent (/ (- max-value min-value) 100.0)) | |
fe6b1dbd JL |
3494 | (percentage (if (= max-value min-value) |
3495 | 0 | |
3496 | (truncate (/ (- value min-value) one-percent)))) | |
b4329caa EZ |
3497 | (update-time (aref parameters 0)) |
3498 | (current-time (float-time)) | |
3499 | (enough-time-passed | |
3500 | ;; See if enough time has passed since the last update. | |
3501 | (or (not update-time) | |
3502 | (when (>= current-time update-time) | |
3503 | ;; Calculate time for the next update | |
3504 | (aset parameters 0 (+ update-time (aref parameters 5))))))) | |
3505 | ;; | |
3506 | ;; Calculate NEXT-UPDATE-VALUE. If we are not going to print | |
3507 | ;; message this time because not enough time has passed, then use | |
3508 | ;; 1 instead of MIN-CHANGE. This makes delays between echo area | |
3509 | ;; updates closer to MIN-TIME. | |
3510 | (setcar reporter | |
3511 | (min (+ min-value (* (+ percentage | |
3512 | (if enough-time-passed | |
3513 | (aref parameters 4) ;; MIN-CHANGE | |
3514 | 1)) | |
3515 | one-percent)) | |
3516 | max-value)) | |
3517 | (when (integerp value) | |
3518 | (setcar reporter (ceiling (car reporter)))) | |
3519 | ;; | |
3520 | ;; Only print message if enough time has passed | |
3521 | (when enough-time-passed | |
3522 | (if (> percentage 0) | |
3523 | (message "%s%d%%" (aref parameters 3) percentage) | |
3524 | (message "%s" (aref parameters 3)))))) | |
3525 | ||
3526 | (defun progress-reporter-done (reporter) | |
3527 | "Print reporter's message followed by word \"done\" in echo area." | |
3528 | (message "%sdone" (aref (cdr reporter) 3))) | |
3529 | ||
aa56124a SM |
3530 | (defmacro dotimes-with-progress-reporter (spec message &rest body) |
3531 | "Loop a certain number of times and report progress in the echo area. | |
3532 | Evaluate BODY with VAR bound to successive integers running from | |
3533 | 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get | |
3534 | the return value (nil if RESULT is omitted). | |
3535 | ||
3536 | At each iteration MESSAGE followed by progress percentage is | |
3537 | printed in the echo area. After the loop is finished, MESSAGE | |
3538 | followed by word \"done\" is printed. This macro is a | |
3539 | convenience wrapper around `make-progress-reporter' and friends. | |
3540 | ||
3541 | \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)" | |
3542 | (declare (indent 2) (debug ((symbolp form &optional form) form body))) | |
3543 | (let ((temp (make-symbol "--dotimes-temp--")) | |
3544 | (temp2 (make-symbol "--dotimes-temp2--")) | |
3545 | (start 0) | |
3546 | (end (nth 1 spec))) | |
3547 | `(let ((,temp ,end) | |
3548 | (,(car spec) ,start) | |
3549 | (,temp2 (make-progress-reporter ,message ,start ,end))) | |
3550 | (while (< ,(car spec) ,temp) | |
3551 | ,@body | |
3552 | (progress-reporter-update ,temp2 | |
3553 | (setq ,(car spec) (1+ ,(car spec))))) | |
3554 | (progress-reporter-done ,temp2) | |
3555 | nil ,@(cdr (cdr spec))))) | |
ca548b00 | 3556 | |
e9454757 | 3557 | \f |
c4f484f2 | 3558 | ;;;; Comparing version strings. |
e9454757 | 3559 | |
2f7f4bee | 3560 | (defconst version-separator "." |
e9454757 VJL |
3561 | "*Specify the string used to separate the version elements. |
3562 | ||
3563 | Usually the separator is \".\", but it can be any other string.") | |
3564 | ||
3565 | ||
2f7f4bee | 3566 | (defconst version-regexp-alist |
c71abb54 | 3567 | '(("^[-_+ ]?a\\(lpha\\)?$" . -3) |
c8227332 | 3568 | ("^[-_+]$" . -3) ; treat "1.2.3-20050920" and "1.2-3" as alpha releases |
0aad54a5 | 3569 | ("^[-_+ ]cvs$" . -3) ; treat "1.2.3-CVS" as alpha release |
c71abb54 KS |
3570 | ("^[-_+ ]?b\\(eta\\)?$" . -2) |
3571 | ("^[-_+ ]?\\(pre\\|rc\\)$" . -1)) | |
e9454757 VJL |
3572 | "*Specify association between non-numeric version part and a priority. |
3573 | ||
3574 | This association is used to handle version string like \"1.0pre2\", | |
3575 | \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the | |
3576 | non-numeric part to an integer. For example: | |
3577 | ||
3578 | String Version Integer List Version | |
3579 | \"1.0pre2\" (1 0 -1 2) | |
3580 | \"1.0PRE2\" (1 0 -1 2) | |
3581 | \"22.8beta3\" (22 8 -2 3) | |
c71abb54 | 3582 | \"22.8 Beta3\" (22 8 -2 3) |
e9454757 VJL |
3583 | \"0.9alpha1\" (0 9 -3 1) |
3584 | \"0.9AlphA1\" (0 9 -3 1) | |
c71abb54 | 3585 | \"0.9 alpha\" (0 9 -3) |
e9454757 VJL |
3586 | |
3587 | Each element has the following form: | |
3588 | ||
3589 | (REGEXP . PRIORITY) | |
3590 | ||
3591 | Where: | |
3592 | ||
3593 | REGEXP regexp used to match non-numeric part of a version string. | |
d74a5c91 EZ |
3594 | It should begin with a `^' anchor and end with a `$' to |
3595 | prevent false hits. Letter-case is ignored while matching | |
3596 | REGEXP. | |
e9454757 VJL |
3597 | |
3598 | PRIORITY negative integer which indicate the non-numeric priority.") | |
3599 | ||
3600 | ||
3601 | (defun version-to-list (ver) | |
3602 | "Convert version string VER into an integer list. | |
3603 | ||
3604 | The version syntax is given by the following EBNF: | |
3605 | ||
3606 | VERSION ::= NUMBER ( SEPARATOR NUMBER )*. | |
3607 | ||
3608 | NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+. | |
3609 | ||
3610 | SEPARATOR ::= `version-separator' (which see) | |
3611 | | `version-regexp-alist' (which see). | |
3612 | ||
d74a5c91 EZ |
3613 | The NUMBER part is optional if SEPARATOR is a match for an element |
3614 | in `version-regexp-alist'. | |
3615 | ||
e9454757 VJL |
3616 | As an example of valid version syntax: |
3617 | ||
d74a5c91 | 3618 | 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta |
e9454757 VJL |
3619 | |
3620 | As an example of invalid version syntax: | |
3621 | ||
3622 | 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5 | |
3623 | ||
3624 | As an example of version convertion: | |
3625 | ||
3626 | String Version Integer List Version | |
3627 | \"1.0.7.5\" (1 0 7 5) | |
3628 | \"1.0pre2\" (1 0 -1 2) | |
3629 | \"1.0PRE2\" (1 0 -1 2) | |
3630 | \"22.8beta3\" (22 8 -2 3) | |
3631 | \"22.8Beta3\" (22 8 -2 3) | |
3632 | \"0.9alpha1\" (0 9 -3 1) | |
3633 | \"0.9AlphA1\" (0 9 -3 1) | |
3634 | \"0.9alpha\" (0 9 -3) | |
3635 | ||
3636 | See documentation for `version-separator' and `version-regexp-alist'." | |
c71abb54 | 3637 | (or (and (stringp ver) (> (length ver) 0)) |
e9454757 | 3638 | (error "Invalid version string: '%s'" ver)) |
c71abb54 KS |
3639 | ;; Change .x.y to 0.x.y |
3640 | (if (and (>= (length ver) (length version-separator)) | |
3641 | (string-equal (substring ver 0 (length version-separator)) | |
c8227332 | 3642 | version-separator)) |
c71abb54 | 3643 | (setq ver (concat "0" ver))) |
e9454757 VJL |
3644 | (save-match-data |
3645 | (let ((i 0) | |
d74a5c91 | 3646 | (case-fold-search t) ; ignore case in matching |
e9454757 VJL |
3647 | lst s al) |
3648 | (while (and (setq s (string-match "[0-9]+" ver i)) | |
3649 | (= s i)) | |
3650 | ;; handle numeric part | |
3651 | (setq lst (cons (string-to-number (substring ver i (match-end 0))) | |
3652 | lst) | |
3653 | i (match-end 0)) | |
3654 | ;; handle non-numeric part | |
3655 | (when (and (setq s (string-match "[^0-9]+" ver i)) | |
3656 | (= s i)) | |
3657 | (setq s (substring ver i (match-end 0)) | |
3658 | i (match-end 0)) | |
3659 | ;; handle alpha, beta, pre, etc. separator | |
3660 | (unless (string= s version-separator) | |
3661 | (setq al version-regexp-alist) | |
3662 | (while (and al (not (string-match (caar al) s))) | |
3663 | (setq al (cdr al))) | |
3664 | (or al (error "Invalid version syntax: '%s'" ver)) | |
3665 | (setq lst (cons (cdar al) lst))))) | |
3666 | (if (null lst) | |
3667 | (error "Invalid version syntax: '%s'" ver) | |
3668 | (nreverse lst))))) | |
3669 | ||
3670 | ||
ca548b00 | 3671 | (defun version-list-< (l1 l2) |
e9454757 VJL |
3672 | "Return t if integer list L1 is lesser than L2. |
3673 | ||
3674 | Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0), | |
3675 | etc. That is, the trailing zeroes are irrelevant. Also, integer | |
3676 | list (1) is greater than (1 -1) which is greater than (1 -2) | |
3677 | which is greater than (1 -3)." | |
3678 | (while (and l1 l2 (= (car l1) (car l2))) | |
3679 | (setq l1 (cdr l1) | |
3680 | l2 (cdr l2))) | |
3681 | (cond | |
3682 | ;; l1 not null and l2 not null | |
3683 | ((and l1 l2) (< (car l1) (car l2))) | |
3684 | ;; l1 null and l2 null ==> l1 length = l2 length | |
3685 | ((and (null l1) (null l2)) nil) | |
3686 | ;; l1 not null and l2 null ==> l1 length > l2 length | |
ca548b00 | 3687 | (l1 (< (version-list-not-zero l1) 0)) |
e9454757 | 3688 | ;; l1 null and l2 not null ==> l2 length > l1 length |
ca548b00 | 3689 | (t (< 0 (version-list-not-zero l2))))) |
e9454757 VJL |
3690 | |
3691 | ||
ca548b00 | 3692 | (defun version-list-= (l1 l2) |
e9454757 VJL |
3693 | "Return t if integer list L1 is equal to L2. |
3694 | ||
3695 | Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0), | |
3696 | etc. That is, the trailing zeroes are irrelevant. Also, integer | |
3697 | list (1) is greater than (1 -1) which is greater than (1 -2) | |
3698 | which is greater than (1 -3)." | |
3699 | (while (and l1 l2 (= (car l1) (car l2))) | |
3700 | (setq l1 (cdr l1) | |
3701 | l2 (cdr l2))) | |
3702 | (cond | |
3703 | ;; l1 not null and l2 not null | |
3704 | ((and l1 l2) nil) | |
3705 | ;; l1 null and l2 null ==> l1 length = l2 length | |
3706 | ((and (null l1) (null l2))) | |
3707 | ;; l1 not null and l2 null ==> l1 length > l2 length | |
ca548b00 | 3708 | (l1 (zerop (version-list-not-zero l1))) |
e9454757 | 3709 | ;; l1 null and l2 not null ==> l2 length > l1 length |
ca548b00 | 3710 | (t (zerop (version-list-not-zero l2))))) |
e9454757 VJL |
3711 | |
3712 | ||
ca548b00 | 3713 | (defun version-list-<= (l1 l2) |
e9454757 VJL |
3714 | "Return t if integer list L1 is lesser than or equal to L2. |
3715 | ||
3716 | Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0), | |
3717 | etc. That is, the trailing zeroes are irrelevant. Also, integer | |
3718 | list (1) is greater than (1 -1) which is greater than (1 -2) | |
3719 | which is greater than (1 -3)." | |
3720 | (while (and l1 l2 (= (car l1) (car l2))) | |
3721 | (setq l1 (cdr l1) | |
3722 | l2 (cdr l2))) | |
3723 | (cond | |
3724 | ;; l1 not null and l2 not null | |
3725 | ((and l1 l2) (< (car l1) (car l2))) | |
3726 | ;; l1 null and l2 null ==> l1 length = l2 length | |
3727 | ((and (null l1) (null l2))) | |
3728 | ;; l1 not null and l2 null ==> l1 length > l2 length | |
ca548b00 | 3729 | (l1 (<= (version-list-not-zero l1) 0)) |
e9454757 | 3730 | ;; l1 null and l2 not null ==> l2 length > l1 length |
ca548b00 | 3731 | (t (<= 0 (version-list-not-zero l2))))) |
e9454757 | 3732 | |
ca548b00 KS |
3733 | (defun version-list-not-zero (lst) |
3734 | "Return the first non-zero element of integer list LST. | |
e9454757 | 3735 | |
ca548b00 KS |
3736 | If all LST elements are zeroes or LST is nil, return zero." |
3737 | (while (and lst (zerop (car lst))) | |
3738 | (setq lst (cdr lst))) | |
3739 | (if lst | |
3740 | (car lst) | |
3741 | ;; there is no element different of zero | |
3742 | 0)) | |
e9454757 VJL |
3743 | |
3744 | ||
3745 | (defun version< (v1 v2) | |
3746 | "Return t if version V1 is lesser than V2. | |
3747 | ||
3748 | Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\", | |
3749 | etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\" | |
3750 | is greater than \"1pre\" which is greater than \"1beta\" which is greater than | |
3751 | \"1alpha\"." | |
ca548b00 | 3752 | (version-list-< (version-to-list v1) (version-to-list v2))) |
e9454757 VJL |
3753 | |
3754 | ||
3755 | (defun version<= (v1 v2) | |
3756 | "Return t if version V1 is lesser than or equal to V2. | |
3757 | ||
3758 | Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\", | |
3759 | etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\" | |
3760 | is greater than \"1pre\" which is greater than \"1beta\" which is greater than | |
3761 | \"1alpha\"." | |
ca548b00 | 3762 | (version-list-<= (version-to-list v1) (version-to-list v2))) |
e9454757 | 3763 | |
ca548b00 KS |
3764 | (defun version= (v1 v2) |
3765 | "Return t if version V1 is equal to V2. | |
e9454757 | 3766 | |
ca548b00 KS |
3767 | Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\", |
3768 | etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\" | |
3769 | is greater than \"1pre\" which is greater than \"1beta\" which is greater than | |
3770 | \"1alpha\"." | |
3771 | (version-list-= (version-to-list v1) (version-to-list v2))) | |
e9454757 | 3772 | |
18d433a7 CY |
3773 | \f |
3774 | ;;; Misc. | |
a3c20c83 DN |
3775 | (defconst menu-bar-separator '("--") |
3776 | "Separator for menus.") | |
18d433a7 CY |
3777 | |
3778 | ;; The following statement ought to be in print.c, but `provide' can't | |
3779 | ;; be used there. | |
3780 | (when (hash-table-p (car (read-from-string | |
3781 | (prin1-to-string (make-hash-table))))) | |
3782 | (provide 'hashtable-print-readable)) | |
3783 | ||
a8a64811 | 3784 | ;; arch-tag: f7e0e6e5-70aa-4897-ae72-7a3511ec40bc |
630cc463 | 3785 | ;;; subr.el ends here |