annotate lisp/subr.el @ 112266:704fa1a3d5b4

Make last-resort backup file in .emacs.d (Bug#6953). * lisp/files.el (backup-buffer): Make last-resort backup file in .emacs.d. * lisp/subr.el (locate-user-emacs-file): If .emacs.d does not exist, make it with permission 700. * doc/emacs/files.texi (Backup Names): Document the new location of the last-resort backup file.
author Chong Yidong <cyd@stupidchicken.com>
date Fri, 14 Jan 2011 21:32:19 -0500
parents e4c00899294b
children cc0887b67703 106bf56d370e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
658
7cbd4fcd8b0f *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 648
diff changeset
1 ;;; subr.el --- basic lisp subroutines for Emacs
787
3cece0106722 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 779
diff changeset
2
57151
5350f17d0a78 (event-basic-type): Fix mask (extend to 22bits).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57148
diff changeset
3 ;; Copyright (C) 1985, 1986, 1992, 1994, 1995, 1999, 2000, 2001, 2002, 2003,
112218
376148b31b5e Add 2011 to FSF/AIST copyright years.
Glenn Morris <rgm@gnu.org>
parents: 111944
diff changeset
4 ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
111936
0a0aa7fbe2ca Doc fixes.
Glenn Morris <rgm@gnu.org>
parents: 111905
diff changeset
5 ;; Free Software Foundation, Inc.
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
6
45078
829beb9a6a4b Follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 44980
diff changeset
7 ;; Maintainer: FSF
829beb9a6a4b Follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 44980
diff changeset
8 ;; Keywords: internal
829beb9a6a4b Follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 44980
diff changeset
9
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
10 ;; This file is part of GNU Emacs.
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
11
94678
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 94556
diff changeset
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
13 ;; it under the terms of the GNU General Public License as published by
94678
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 94556
diff changeset
14 ;; the Free Software Foundation, either version 3 of the License, or
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 94556
diff changeset
15 ;; (at your option) any later version.
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
16
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
17 ;; GNU Emacs is distributed in the hope that it will be useful,
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
20 ;; GNU General Public License for more details.
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
21
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
22 ;; You should have received a copy of the GNU General Public License
94678
ee5932bf781d Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 94556
diff changeset
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
24
38414
67b464da13ec Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 37070
diff changeset
25 ;;; Commentary:
67b464da13ec Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 37070
diff changeset
26
787
3cece0106722 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 779
diff changeset
27 ;;; Code:
98925
5813cf04cdfe (top-level): Require `cl' when compiling.
Eli Zaretskii <eliz@gnu.org>
parents: 98907
diff changeset
28
18880
1ed40ed8e0c1 (custom-declare-variable-early): New function.
Richard M. Stallman <rms@gnu.org>
parents: 18828
diff changeset
29 (defvar custom-declare-variable-list nil
1ed40ed8e0c1 (custom-declare-variable-early): New function.
Richard M. Stallman <rms@gnu.org>
parents: 18828
diff changeset
30 "Record `defcustom' calls made before `custom.el' is loaded to handle them.
1ed40ed8e0c1 (custom-declare-variable-early): New function.
Richard M. Stallman <rms@gnu.org>
parents: 18828
diff changeset
31 Each element of this list holds the arguments to one call to `defcustom'.")
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
32
19662
791a40c16c0b Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 19584
diff changeset
33 ;; Use this, rather than defcustom, in subr.el and other files loaded
18880
1ed40ed8e0c1 (custom-declare-variable-early): New function.
Richard M. Stallman <rms@gnu.org>
parents: 18828
diff changeset
34 ;; before custom.el.
1ed40ed8e0c1 (custom-declare-variable-early): New function.
Richard M. Stallman <rms@gnu.org>
parents: 18828
diff changeset
35 (defun custom-declare-variable-early (&rest arguments)
1ed40ed8e0c1 (custom-declare-variable-early): New function.
Richard M. Stallman <rms@gnu.org>
parents: 18828
diff changeset
36 (setq custom-declare-variable-list
1ed40ed8e0c1 (custom-declare-variable-early): New function.
Richard M. Stallman <rms@gnu.org>
parents: 18828
diff changeset
37 (cons arguments custom-declare-variable-list)))
44129
444bd245e176 (macro-declaration-function): New function. Set the
Gerd Moellmann <gerd@gnu.org>
parents: 43833
diff changeset
38
87002
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
39 (defmacro declare-function (fn file &optional arglist fileonly)
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
40 "Tell the byte-compiler that function FN is defined, in FILE.
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
41 Optional ARGLIST is the argument list used by the function. The
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
42 FILE argument is not used by the byte-compiler, but by the
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
43 `check-declare' package, which checks that FILE contains a
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
44 definition for FN. ARGLIST is used by both the byte-compiler and
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
45 `check-declare' to check for consistency.
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
46
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
47 FILE can be either a Lisp file (in which case the \".el\"
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
48 extension is optional), or a C file. C files are expanded
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
49 relative to the Emacs \"src/\" directory. Lisp files are
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
50 searched for using `locate-library', and if that fails they are
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
51 expanded relative to the location of the file containing the
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
52 declaration. A FILE with an \"ext:\" prefix is an external file.
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
53 `check-declare' will check such files if they are found, and skip
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
54 them without error if they are not.
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
55
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
56 FILEONLY non-nil means that `check-declare' will only check that
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
57 FILE exists, not that it defines FN. This is intended for
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
58 function-definitions that `check-declare' does not recognize, e.g.
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
59 `defstruct'.
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
60
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
61 To specify a value for FILEONLY without passing an argument list,
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
62 set ARGLIST to `t'. This is necessary because `nil' means an
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
63 empty argument list, rather than an unspecified one.
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
64
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
65 Note that for the purposes of `check-declare', this statement
105317
78728d295b59 (declare-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 105111
diff changeset
66 must be the first non-whitespace on a line.
87002
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
67
100388
a7231893cd7a (declare-function): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 99633
diff changeset
68 For more information, see Info node `(elisp)Declaring Functions'."
87002
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
69 ;; Does nothing - byte-compile-declare-function does the work.
c6a200c4eebd (declare-function): Moved from byte-run.el.
Richard M. Stallman <rms@gnu.org>
parents: 86341
diff changeset
70 nil)
98939
8d3f352dfa8d Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 98925
diff changeset
71
44129
444bd245e176 (macro-declaration-function): New function. Set the
Gerd Moellmann <gerd@gnu.org>
parents: 43833
diff changeset
72
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
73 ;;;; Basic Lisp macros.
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
74
40822
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
75 (defalias 'not 'null)
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
76
53197
61703d3393d6 Add macros `1value' and `noreturn'.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 53181
diff changeset
77 (defmacro noreturn (form)
67899
7c797468d04b (noreturn, 1value): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 67876
diff changeset
78 "Evaluate FORM, expecting it not to return.
7c797468d04b (noreturn, 1value): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 67876
diff changeset
79 If FORM does return, signal an error."
53197
61703d3393d6 Add macros `1value' and `noreturn'.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 53181
diff changeset
80 `(prog1 ,form
61703d3393d6 Add macros `1value' and `noreturn'.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 53181
diff changeset
81 (error "Form marked with `noreturn' did return")))
61703d3393d6 Add macros `1value' and `noreturn'.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 53181
diff changeset
82
61703d3393d6 Add macros `1value' and `noreturn'.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 53181
diff changeset
83 (defmacro 1value (form)
67899
7c797468d04b (noreturn, 1value): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 67876
diff changeset
84 "Evaluate FORM, expecting a constant return value.
7c797468d04b (noreturn, 1value): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 67876
diff changeset
85 This is the global do-nothing version. There is also `testcover-1value'
7c797468d04b (noreturn, 1value): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 67876
diff changeset
86 that complains if FORM ever does return differing values."
53197
61703d3393d6 Add macros `1value' and `noreturn'.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 53181
diff changeset
87 form)
61703d3393d6 Add macros `1value' and `noreturn'.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 53181
diff changeset
88
71726
a36e654643c1 (def-edebug-spec): Moved here.
Richard M. Stallman <rms@gnu.org>
parents: 71151
diff changeset
89 (defmacro def-edebug-spec (symbol spec)
a36e654643c1 (def-edebug-spec): Moved here.
Richard M. Stallman <rms@gnu.org>
parents: 71151
diff changeset
90 "Set the `edebug-form-spec' property of SYMBOL according to SPEC.
103884
dbafc1b9107d (def-edebug-spec): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 103731
diff changeset
91 Both SYMBOL and SPEC are unevaluated. The SPEC can be:
dbafc1b9107d (def-edebug-spec): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 103731
diff changeset
92 0 (instrument no arguments); t (instrument all arguments);
dbafc1b9107d (def-edebug-spec): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 103731
diff changeset
93 a symbol (naming a function with an Edebug specification); or a list.
dbafc1b9107d (def-edebug-spec): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 103731
diff changeset
94 The elements of the list describe the argument types; see
dbafc1b9107d (def-edebug-spec): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 103731
diff changeset
95 \(info \"(elisp)Specification List\") for details."
71726
a36e654643c1 (def-edebug-spec): Moved here.
Richard M. Stallman <rms@gnu.org>
parents: 71151
diff changeset
96 `(put (quote ,symbol) 'edebug-form-spec (quote ,spec)))
a36e654643c1 (def-edebug-spec): Moved here.
Richard M. Stallman <rms@gnu.org>
parents: 71151
diff changeset
97
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
98 (defmacro lambda (&rest cdr)
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
99 "Return a lambda expression.
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
100 A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
101 self-quoting; the result of evaluating the lambda expression is the
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
102 expression itself. The lambda expression may then be treated as a
10178
be0081d9ba76 (lambda): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 10025
diff changeset
103 function, i.e., stored as the function value of a symbol, passed to
63634
ec5194493ae9 (1value, lambda, key-substitution-in-progress): Doc fixes.
Juanma Barranquero <lekktu@gmail.com>
parents: 63605
diff changeset
104 `funcall' or `mapcar', etc.
10178
be0081d9ba76 (lambda): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 10025
diff changeset
105
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
106 ARGS should take the same form as an argument list for a `defun'.
12395
71727759437e (lambda): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12296
diff changeset
107 DOCSTRING is an optional documentation string.
71727759437e (lambda): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12296
diff changeset
108 If present, it should describe how to call the function.
71727759437e (lambda): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12296
diff changeset
109 But documentation strings are usually not useful in nameless functions.
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
110 INTERACTIVE should be a call to the function `interactive', which see.
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
111 It may also be omitted.
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
112 BODY should be a list of Lisp expressions.
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
113
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
114 \(fn ARGS [DOCSTRING] [INTERACTIVE] BODY)"
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
115 ;; Note that this definition should not use backquotes; subr.el should not
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
116 ;; depend on backquote.el.
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
117 (list 'function (cons 'lambda cdr)))
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
118
105068
b97679d5a9af * subr.el: Fix last change to avoid using the `unless' macro, which
Chong Yidong <cyd@stupidchicken.com>
parents: 105060
diff changeset
119 (if (null (featurep 'cl))
b97679d5a9af * subr.el: Fix last change to avoid using the `unless' macro, which
Chong Yidong <cyd@stupidchicken.com>
parents: 105060
diff changeset
120 (progn
105060
78c0a7ca3aaf (push, pop, dolist, dotimes, declare): Don't overwrite CL's
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105027
diff changeset
121 ;; If we reload subr.el after having loaded CL, be careful not to
78c0a7ca3aaf (push, pop, dolist, dotimes, declare): Don't overwrite CL's
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105027
diff changeset
122 ;; overwrite CL's extended definition of `dolist', `dotimes',
78c0a7ca3aaf (push, pop, dolist, dotimes, declare): Don't overwrite CL's
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105027
diff changeset
123 ;; `declare', `push' and `pop'.
25437
95301c74bdd9 Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 25436
diff changeset
124 (defmacro push (newelt listname)
25580
b76f1a72649a (push): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 25469
diff changeset
125 "Add NEWELT to the list stored in the symbol LISTNAME.
25437
95301c74bdd9 Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 25436
diff changeset
126 This is equivalent to (setq LISTNAME (cons NEWELT LISTNAME)).
25436
d24cf1a4dd34 (push, pop): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 25295
diff changeset
127 LISTNAME must be a symbol."
51611
d201fdadadce (looking-back): Handle the case of non-trivial regexps.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 51339
diff changeset
128 (declare (debug (form sexp)))
25469
6762c8a75fd7 (push): Fix typo.
Dave Love <fx@gnu.org>
parents: 25437
diff changeset
129 (list 'setq listname
105060
78c0a7ca3aaf (push, pop, dolist, dotimes, declare): Don't overwrite CL's
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105027
diff changeset
130 (list 'cons newelt listname)))
25436
d24cf1a4dd34 (push, pop): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 25295
diff changeset
131
d24cf1a4dd34 (push, pop): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 25295
diff changeset
132 (defmacro pop (listname)
d24cf1a4dd34 (push, pop): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 25295
diff changeset
133 "Return the first element of LISTNAME's value, and remove it from the list.
d24cf1a4dd34 (push, pop): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 25295
diff changeset
134 LISTNAME must be a symbol whose value is a list.
d24cf1a4dd34 (push, pop): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 25295
diff changeset
135 If the value is nil, `pop' returns nil but does not actually
d24cf1a4dd34 (push, pop): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 25295
diff changeset
136 change the list."
51611
d201fdadadce (looking-back): Handle the case of non-trivial regexps.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 51339
diff changeset
137 (declare (debug (sexp)))
45823
7ec7fff5e571 (pop): Move the call to `car' outside the prog1, as the compiler
Miles Bader <miles@gnu.org>
parents: 45821
diff changeset
138 (list 'car
105060
78c0a7ca3aaf (push, pop, dolist, dotimes, declare): Don't overwrite CL's
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105027
diff changeset
139 (list 'prog1 listname
105068
b97679d5a9af * subr.el: Fix last change to avoid using the `unless' macro, which
Chong Yidong <cyd@stupidchicken.com>
parents: 105060
diff changeset
140 (list 'setq listname (list 'cdr listname)))))
b97679d5a9af * subr.el: Fix last change to avoid using the `unless' macro, which
Chong Yidong <cyd@stupidchicken.com>
parents: 105060
diff changeset
141 ))
25436
d24cf1a4dd34 (push, pop): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 25295
diff changeset
142
16845
adc714dc8e3c (when, unless): Definitions moved from cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 16556
diff changeset
143 (defmacro when (cond &rest body)
76530
5813a2f3af13 (when, unless): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 75748
diff changeset
144 "If COND yields non-nil, do BODY, else return nil.
5813a2f3af13 (when, unless): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 75748
diff changeset
145 When COND yields non-nil, eval BODY forms sequentially and return
5813a2f3af13 (when, unless): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 75748
diff changeset
146 value of last one, or nil if there are none.
5813a2f3af13 (when, unless): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 75748
diff changeset
147
78149
677d96c34c87 (when, unless): Doc fix.
Juanma Barranquero <lekktu@gmail.com>
parents: 78081
diff changeset
148 \(fn COND BODY...)"
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
149 (declare (indent 1) (debug t))
16845
adc714dc8e3c (when, unless): Definitions moved from cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 16556
diff changeset
150 (list 'if cond (cons 'progn body)))
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
151
16845
adc714dc8e3c (when, unless): Definitions moved from cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 16556
diff changeset
152 (defmacro unless (cond &rest body)
76530
5813a2f3af13 (when, unless): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 75748
diff changeset
153 "If COND yields nil, do BODY, else return nil.
5813a2f3af13 (when, unless): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 75748
diff changeset
154 When COND yields nil, eval BODY forms sequentially and return
5813a2f3af13 (when, unless): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 75748
diff changeset
155 value of last one, or nil if there are none.
5813a2f3af13 (when, unless): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 75748
diff changeset
156
78149
677d96c34c87 (when, unless): Doc fix.
Juanma Barranquero <lekktu@gmail.com>
parents: 78081
diff changeset
157 \(fn COND BODY...)"
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
158 (declare (indent 1) (debug t))
16845
adc714dc8e3c (when, unless): Definitions moved from cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 16556
diff changeset
159 (cons 'if (cons cond (cons nil body))))
19491
f5fd22f3462c (caar, cadr, cdar, cddr): Definitions moved here and changed into defsubsts.
Richard M. Stallman <rms@gnu.org>
parents: 19176
diff changeset
160
105068
b97679d5a9af * subr.el: Fix last change to avoid using the `unless' macro, which
Chong Yidong <cyd@stupidchicken.com>
parents: 105060
diff changeset
161 (if (null (featurep 'cl))
b97679d5a9af * subr.el: Fix last change to avoid using the `unless' macro, which
Chong Yidong <cyd@stupidchicken.com>
parents: 105060
diff changeset
162 (progn
105060
78c0a7ca3aaf (push, pop, dolist, dotimes, declare): Don't overwrite CL's
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105027
diff changeset
163 ;; If we reload subr.el after having loaded CL, be careful not to
78c0a7ca3aaf (push, pop, dolist, dotimes, declare): Don't overwrite CL's
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105027
diff changeset
164 ;; overwrite CL's extended definition of `dolist', `dotimes',
78c0a7ca3aaf (push, pop, dolist, dotimes, declare): Don't overwrite CL's
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105027
diff changeset
165 ;; `declare', `push' and `pop'.
72096
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
166 (defvar --dolist-tail-- nil
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
167 "Temporary variable used in `dolist' expansion.")
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
168
27376
674b7f75841e (dolist, dotimes): Moved from cl-macs.el.
Richard M. Stallman <rms@gnu.org>
parents: 27297
diff changeset
169 (defmacro dolist (spec &rest body)
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
170 "Loop over a list.
27376
674b7f75841e (dolist, dotimes): Moved from cl-macs.el.
Richard M. Stallman <rms@gnu.org>
parents: 27297
diff changeset
171 Evaluate BODY with VAR bound to each car from LIST, in turn.
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
172 Then evaluate RESULT to get return value, default nil.
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
173
51817
5e9d88e4fcff (dolist, dotimes): Doc fix.
Markus Rost <rost@math.uni-bielefeld.de>
parents: 51695
diff changeset
174 \(fn (VAR LIST [RESULT]) BODY...)"
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
175 (declare (indent 1) (debug ((symbolp form &optional form) body)))
72096
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
176 ;; It would be cleaner to create an uninterned symbol,
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
177 ;; but that uses a lot more space when many functions in many files
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
178 ;; use dolist.
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
179 (let ((temp '--dolist-tail--))
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
180 `(let ((,temp ,(nth 1 spec))
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
181 ,(car spec))
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
182 (while ,temp
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
183 (setq ,(car spec) (car ,temp))
72096
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
184 ,@body
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
185 (setq ,temp (cdr ,temp)))
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
186 ,@(if (cdr (cdr spec))
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
187 `((setq ,(car spec) nil) ,@(cdr (cdr spec)))))))
27376
674b7f75841e (dolist, dotimes): Moved from cl-macs.el.
Richard M. Stallman <rms@gnu.org>
parents: 27297
diff changeset
188
72096
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
189 (defvar --dotimes-limit-- nil
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
190 "Temporary variable used in `dotimes' expansion.")
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
191
27376
674b7f75841e (dolist, dotimes): Moved from cl-macs.el.
Richard M. Stallman <rms@gnu.org>
parents: 27297
diff changeset
192 (defmacro dotimes (spec &rest body)
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
193 "Loop a certain number of times.
27376
674b7f75841e (dolist, dotimes): Moved from cl-macs.el.
Richard M. Stallman <rms@gnu.org>
parents: 27297
diff changeset
194 Evaluate BODY with VAR bound to successive integers running from 0,
674b7f75841e (dolist, dotimes): Moved from cl-macs.el.
Richard M. Stallman <rms@gnu.org>
parents: 27297
diff changeset
195 inclusive, to COUNT, exclusive. Then evaluate RESULT to get
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
196 the return value (nil if RESULT is omitted).
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
197
51817
5e9d88e4fcff (dolist, dotimes): Doc fix.
Markus Rost <rost@math.uni-bielefeld.de>
parents: 51695
diff changeset
198 \(fn (VAR COUNT [RESULT]) BODY...)"
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
199 (declare (indent 1) (debug dolist))
72096
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
200 ;; It would be cleaner to create an uninterned symbol,
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
201 ;; but that uses a lot more space when many functions in many files
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
202 ;; use dotimes.
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
203 (let ((temp '--dotimes-limit--)
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
204 (start 0)
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
205 (end (nth 1 spec)))
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
206 `(let ((,temp ,end)
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
207 (,(car spec) ,start))
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
208 (while (< ,(car spec) ,temp)
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
209 ,@body
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
210 (setq ,(car spec) (1+ ,(car spec))))
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
211 ,@(cdr (cdr spec)))))
27376
674b7f75841e (dolist, dotimes): Moved from cl-macs.el.
Richard M. Stallman <rms@gnu.org>
parents: 27297
diff changeset
212
53593
39793eabee87 (declare): New macro.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53518
diff changeset
213 (defmacro declare (&rest specs)
39793eabee87 (declare): New macro.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53518
diff changeset
214 "Do not evaluate any arguments and return nil.
39793eabee87 (declare): New macro.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53518
diff changeset
215 Treated as a declaration when used at the right place in a
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
216 `defmacro' form. \(See Info anchor `(elisp)Definition of declare'.)"
105068
b97679d5a9af * subr.el: Fix last change to avoid using the `unless' macro, which
Chong Yidong <cyd@stupidchicken.com>
parents: 105060
diff changeset
217 nil)
b97679d5a9af * subr.el: Fix last change to avoid using the `unless' macro, which
Chong Yidong <cyd@stupidchicken.com>
parents: 105060
diff changeset
218 ))
94703
4520f20e7dd1 (ignore-errors): Move here from cl-macs.el.
Glenn Morris <rgm@gnu.org>
parents: 94678
diff changeset
219
4520f20e7dd1 (ignore-errors): Move here from cl-macs.el.
Glenn Morris <rgm@gnu.org>
parents: 94678
diff changeset
220 (defmacro ignore-errors (&rest body)
4520f20e7dd1 (ignore-errors): Move here from cl-macs.el.
Glenn Morris <rgm@gnu.org>
parents: 94678
diff changeset
221 "Execute BODY; if an error occurs, return nil.
4520f20e7dd1 (ignore-errors): Move here from cl-macs.el.
Glenn Morris <rgm@gnu.org>
parents: 94678
diff changeset
222 Otherwise, return result of last form in BODY."
109917
0266442adf6a * subr.el (ignore-errors): Add debug declaration.
Andreas Schwab <schwab@linux-m68k.org>
parents: 109242
diff changeset
223 (declare (debug t) (indent 0))
94703
4520f20e7dd1 (ignore-errors): Move here from cl-macs.el.
Glenn Morris <rgm@gnu.org>
parents: 94678
diff changeset
224 `(condition-case nil (progn ,@body) (error nil)))
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
225
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
226 ;;;; Basic Lisp functions.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
227
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
228 (defun ignore (&rest ignore)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
229 "Do nothing and return nil.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
230 This function accepts any number of arguments, but ignores them."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
231 (interactive)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
232 nil)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
233
105629
bdfcf9d2baaa (error, sit-for, start-process-shell-command)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105364
diff changeset
234 ;; Signal a compile-error if the first arg is missing.
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
235 (defun error (&rest args)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
236 "Signal an error, making error message by passing all args to `format'.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
237 In Emacs, the convention is that error messages start with a capital
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
238 letter but *do not* end with a period. Please follow this convention
105629
bdfcf9d2baaa (error, sit-for, start-process-shell-command)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105364
diff changeset
239 for the sake of consistency."
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
240 (while t
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
241 (signal 'error (list (apply 'format args)))))
110356
d2f5496377e6 * subr.el (unintern): Declare the obarray arg mandatory.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109943
diff changeset
242 (set-advertised-calling-convention 'error '(string &rest args) "23.1")
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
243
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
244 ;; We put this here instead of in frame.el so that it's defined even on
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
245 ;; systems where frame.el isn't loaded.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
246 (defun frame-configuration-p (object)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
247 "Return non-nil if OBJECT seems to be a frame configuration.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
248 Any list whose car is `frame-configuration' is assumed to be a frame
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
249 configuration."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
250 (and (consp object)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
251 (eq (car object) 'frame-configuration)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
252
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
253 (defun functionp (object)
93735
310118b32104 (functionp): Return nil for special forms.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93721
diff changeset
254 "Non-nil if OBJECT is a function."
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
255 (or (and (symbolp object) (fboundp object)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
256 (condition-case nil
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
257 (setq object (indirect-function object))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
258 (error nil))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
259 (eq (car-safe object) 'autoload)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
260 (not (car-safe (cdr-safe (cdr-safe (cdr-safe (cdr-safe object)))))))
93735
310118b32104 (functionp): Return nil for special forms.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93721
diff changeset
261 (and (subrp object)
310118b32104 (functionp): Return nil for special forms.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93721
diff changeset
262 ;; Filter out special forms.
310118b32104 (functionp): Return nil for special forms.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93721
diff changeset
263 (not (eq 'unevalled (cdr (subr-arity object)))))
310118b32104 (functionp): Return nil for special forms.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93721
diff changeset
264 (byte-code-function-p object)
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
265 (eq (car-safe object) 'lambda)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
266
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
267 ;;;; List functions.
53593
39793eabee87 (declare): New macro.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53518
diff changeset
268
19491
f5fd22f3462c (caar, cadr, cdar, cddr): Definitions moved here and changed into defsubsts.
Richard M. Stallman <rms@gnu.org>
parents: 19176
diff changeset
269 (defsubst caar (x)
f5fd22f3462c (caar, cadr, cdar, cddr): Definitions moved here and changed into defsubsts.
Richard M. Stallman <rms@gnu.org>
parents: 19176
diff changeset
270 "Return the car of the car of X."
f5fd22f3462c (caar, cadr, cdar, cddr): Definitions moved here and changed into defsubsts.
Richard M. Stallman <rms@gnu.org>
parents: 19176
diff changeset
271 (car (car x)))
f5fd22f3462c (caar, cadr, cdar, cddr): Definitions moved here and changed into defsubsts.
Richard M. Stallman <rms@gnu.org>
parents: 19176
diff changeset
272
f5fd22f3462c (caar, cadr, cdar, cddr): Definitions moved here and changed into defsubsts.
Richard M. Stallman <rms@gnu.org>
parents: 19176
diff changeset
273 (defsubst cadr (x)
f5fd22f3462c (caar, cadr, cdar, cddr): Definitions moved here and changed into defsubsts.
Richard M. Stallman <rms@gnu.org>
parents: 19176
diff changeset
274 "Return the car of the cdr of X."
f5fd22f3462c (caar, cadr, cdar, cddr): Definitions moved here and changed into defsubsts.
Richard M. Stallman <rms@gnu.org>
parents: 19176
diff changeset
275 (car (cdr x)))
f5fd22f3462c (caar, cadr, cdar, cddr): Definitions moved here and changed into defsubsts.
Richard M. Stallman <rms@gnu.org>
parents: 19176
diff changeset
276
f5fd22f3462c (caar, cadr, cdar, cddr): Definitions moved here and changed into defsubsts.
Richard M. Stallman <rms@gnu.org>
parents: 19176
diff changeset
277 (defsubst cdar (x)
f5fd22f3462c (caar, cadr, cdar, cddr): Definitions moved here and changed into defsubsts.
Richard M. Stallman <rms@gnu.org>
parents: 19176
diff changeset
278 "Return the cdr of the car of X."
f5fd22f3462c (caar, cadr, cdar, cddr): Definitions moved here and changed into defsubsts.
Richard M. Stallman <rms@gnu.org>
parents: 19176
diff changeset
279 (cdr (car x)))
f5fd22f3462c (caar, cadr, cdar, cddr): Definitions moved here and changed into defsubsts.
Richard M. Stallman <rms@gnu.org>
parents: 19176
diff changeset
280
f5fd22f3462c (caar, cadr, cdar, cddr): Definitions moved here and changed into defsubsts.
Richard M. Stallman <rms@gnu.org>
parents: 19176
diff changeset
281 (defsubst cddr (x)
f5fd22f3462c (caar, cadr, cdar, cddr): Definitions moved here and changed into defsubsts.
Richard M. Stallman <rms@gnu.org>
parents: 19176
diff changeset
282 "Return the cdr of the cdr of X."
f5fd22f3462c (caar, cadr, cdar, cddr): Definitions moved here and changed into defsubsts.
Richard M. Stallman <rms@gnu.org>
parents: 19176
diff changeset
283 (cdr (cdr x)))
19492
892a09772457 (last): New function.
Richard M. Stallman <rms@gnu.org>
parents: 19491
diff changeset
284
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
285 (defun last (list &optional n)
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
286 "Return the last link of LIST. Its car is the last element.
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
287 If LIST is nil, return nil.
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
288 If N is non-nil, return the Nth-to-last link of LIST.
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
289 If N is bigger than the length of LIST, return LIST."
19584
17db1ee36bbb (last): Accept optional second argument.
Richard M. Stallman <rms@gnu.org>
parents: 19492
diff changeset
290 (if n
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
291 (let ((m 0) (p list))
19584
17db1ee36bbb (last): Accept optional second argument.
Richard M. Stallman <rms@gnu.org>
parents: 19492
diff changeset
292 (while (consp p)
17db1ee36bbb (last): Accept optional second argument.
Richard M. Stallman <rms@gnu.org>
parents: 19492
diff changeset
293 (setq m (1+ m) p (cdr p)))
17db1ee36bbb (last): Accept optional second argument.
Richard M. Stallman <rms@gnu.org>
parents: 19492
diff changeset
294 (if (<= n 0) p
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
295 (if (< n m) (nthcdr (- m n) list) list)))
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
296 (while (consp (cdr list))
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
297 (setq list (cdr list)))
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
298 list))
22860
349fa4ee1f27 (assoc-default): New function.
Richard M. Stallman <rms@gnu.org>
parents: 22755
diff changeset
299
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
300 (defun butlast (list &optional n)
56537
69db3634588e (butlast, event-modifiers, event-basic-type): Doc fixes.
John Paul Wallington <jpw@pobox.com>
parents: 56402
diff changeset
301 "Return a copy of LIST with the last N elements removed."
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
302 (if (and n (<= n 0)) list
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
303 (nbutlast (copy-sequence list) n)))
34898
1486728b21f0 (butlast, nbutlast): Moved from cl.el to here.
Kenichi Handa <handa@m17n.org>
parents: 34853
diff changeset
304
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
305 (defun nbutlast (list &optional n)
34898
1486728b21f0 (butlast, nbutlast): Moved from cl.el to here.
Kenichi Handa <handa@m17n.org>
parents: 34853
diff changeset
306 "Modifies LIST to remove the last N elements."
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
307 (let ((m (length list)))
34898
1486728b21f0 (butlast, nbutlast): Moved from cl.el to here.
Kenichi Handa <handa@m17n.org>
parents: 34853
diff changeset
308 (or n (setq n 1))
1486728b21f0 (butlast, nbutlast): Moved from cl.el to here.
Kenichi Handa <handa@m17n.org>
parents: 34853
diff changeset
309 (and (< n m)
1486728b21f0 (butlast, nbutlast): Moved from cl.el to here.
Kenichi Handa <handa@m17n.org>
parents: 34853
diff changeset
310 (progn
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
311 (if (> n 0) (setcdr (nthcdr (- (1- m) n) list) nil))
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
312 list))))
34898
1486728b21f0 (butlast, nbutlast): Moved from cl.el to here.
Kenichi Handa <handa@m17n.org>
parents: 34853
diff changeset
313
53626
ee432d9e3bbd (delete-dups): New function.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53593
diff changeset
314 (defun delete-dups (list)
54016
15b3e94eebd4 (delete-dups): A better implementation from Karl Heuer <kwzh@gnu.org>.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53994
diff changeset
315 "Destructively remove `equal' duplicates from LIST.
15b3e94eebd4 (delete-dups): A better implementation from Karl Heuer <kwzh@gnu.org>.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53994
diff changeset
316 Store the result in LIST and return it. LIST must be a proper list.
15b3e94eebd4 (delete-dups): A better implementation from Karl Heuer <kwzh@gnu.org>.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53994
diff changeset
317 Of several `equal' occurrences of an element in LIST, the first
15b3e94eebd4 (delete-dups): A better implementation from Karl Heuer <kwzh@gnu.org>.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53994
diff changeset
318 one is kept."
53626
ee432d9e3bbd (delete-dups): New function.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53593
diff changeset
319 (let ((tail list))
ee432d9e3bbd (delete-dups): New function.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53593
diff changeset
320 (while tail
54016
15b3e94eebd4 (delete-dups): A better implementation from Karl Heuer <kwzh@gnu.org>.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53994
diff changeset
321 (setcdr tail (delete (car tail) (cdr tail)))
15b3e94eebd4 (delete-dups): A better implementation from Karl Heuer <kwzh@gnu.org>.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53994
diff changeset
322 (setq tail (cdr tail))))
53626
ee432d9e3bbd (delete-dups): New function.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53593
diff changeset
323 list)
ee432d9e3bbd (delete-dups): New function.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53593
diff changeset
324
50449
f85be9da34a2 Adjust number-sequence code
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 50427
diff changeset
325 (defun number-sequence (from &optional to inc)
50415
b040b4e36f5e (number-sequence): New function.
Kenichi Handa <handa@m17n.org>
parents: 50136
diff changeset
326 "Return a sequence of numbers from FROM to TO (both inclusive) as a list.
53174
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
327 INC is the increment used between numbers in the sequence and defaults to 1.
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
328 So, the Nth element of the list is \(+ FROM \(* N INC)) where N counts from
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
329 zero. TO is only included if there is an N for which TO = FROM + N * INC.
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
330 If TO is nil or numerically equal to FROM, return \(FROM).
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
331 If INC is positive and TO is less than FROM, or INC is negative
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
332 and TO is larger than FROM, return nil.
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
333 If INC is zero and TO is neither nil nor numerically equal to
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
334 FROM, signal an error.
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
335
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
336 This function is primarily designed for integer arguments.
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
337 Nevertheless, FROM, TO and INC can be integer or float. However,
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
338 floating point arithmetic is inexact. For instance, depending on
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
339 the machine, it may quite well happen that
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
340 \(number-sequence 0.4 0.6 0.2) returns the one element list \(0.4),
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
341 whereas \(number-sequence 0.4 0.8 0.2) returns a list with three
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
342 elements. Thus, if some of the arguments are floats and one wants
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
343 to make sure that TO is included, one may have to explicitly write
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
344 TO as \(+ FROM \(* N INC)) or use a variable whose value was
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
345 computed with this exact expression. Alternatively, you can,
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
346 of course, also replace TO with a slightly larger value
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
347 \(or a slightly more negative value if INC is negative)."
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
348 (if (or (not to) (= from to))
50449
f85be9da34a2 Adjust number-sequence code
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 50427
diff changeset
349 (list from)
f85be9da34a2 Adjust number-sequence code
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 50427
diff changeset
350 (or inc (setq inc 1))
53174
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
351 (when (zerop inc) (error "The increment can not be zero"))
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
352 (let (seq (n 0) (next from))
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
353 (if (> inc 0)
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
354 (while (<= next to)
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
355 (setq seq (cons next seq)
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
356 n (1+ n)
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
357 next (+ from (* n inc))))
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
358 (while (>= next to)
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
359 (setq seq (cons next seq)
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
360 n (1+ n)
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
361 next (+ from (* n inc)))))
50449
f85be9da34a2 Adjust number-sequence code
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 50427
diff changeset
362 (nreverse seq))))
50415
b040b4e36f5e (number-sequence): New function.
Kenichi Handa <handa@m17n.org>
parents: 50136
diff changeset
363
45690
9d351e5869c8 (copy-list): Moved here from cl.el.
Colin Walters <walters@gnu.org>
parents: 45587
diff changeset
364 (defun copy-tree (tree &optional vecp)
9d351e5869c8 (copy-list): Moved here from cl.el.
Colin Walters <walters@gnu.org>
parents: 45587
diff changeset
365 "Make a copy of TREE.
9d351e5869c8 (copy-list): Moved here from cl.el.
Colin Walters <walters@gnu.org>
parents: 45587
diff changeset
366 If TREE is a cons cell, this recursively copies both its car and its cdr.
45740
4e576724db9f (copy-list): Moved to cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 45690
diff changeset
367 Contrast to `copy-sequence', which copies only along the cdrs. With second
45690
9d351e5869c8 (copy-list): Moved here from cl.el.
Colin Walters <walters@gnu.org>
parents: 45587
diff changeset
368 argument VECP, this copies vectors as well as conses."
9d351e5869c8 (copy-list): Moved here from cl.el.
Colin Walters <walters@gnu.org>
parents: 45587
diff changeset
369 (if (consp tree)
45740
4e576724db9f (copy-list): Moved to cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 45690
diff changeset
370 (let (result)
4e576724db9f (copy-list): Moved to cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 45690
diff changeset
371 (while (consp tree)
4e576724db9f (copy-list): Moved to cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 45690
diff changeset
372 (let ((newcar (car tree)))
4e576724db9f (copy-list): Moved to cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 45690
diff changeset
373 (if (or (consp (car tree)) (and vecp (vectorp (car tree))))
4e576724db9f (copy-list): Moved to cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 45690
diff changeset
374 (setq newcar (copy-tree (car tree) vecp)))
4e576724db9f (copy-list): Moved to cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 45690
diff changeset
375 (push newcar result))
4e576724db9f (copy-list): Moved to cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 45690
diff changeset
376 (setq tree (cdr tree)))
45821
41129d3d126b (copy-tree): Use `nconc' and `nreverse' instead of `nreconc'.
Miles Bader <miles@gnu.org>
parents: 45740
diff changeset
377 (nconc (nreverse result) tree))
45690
9d351e5869c8 (copy-list): Moved here from cl.el.
Colin Walters <walters@gnu.org>
parents: 45587
diff changeset
378 (if (and vecp (vectorp tree))
9d351e5869c8 (copy-list): Moved here from cl.el.
Colin Walters <walters@gnu.org>
parents: 45587
diff changeset
379 (let ((i (length (setq tree (copy-sequence tree)))))
9d351e5869c8 (copy-list): Moved here from cl.el.
Colin Walters <walters@gnu.org>
parents: 45587
diff changeset
380 (while (>= (setq i (1- i)) 0)
45740
4e576724db9f (copy-list): Moved to cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 45690
diff changeset
381 (aset tree i (copy-tree (aref tree i) vecp)))
4e576724db9f (copy-list): Moved to cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 45690
diff changeset
382 tree)
4e576724db9f (copy-list): Moved to cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 45690
diff changeset
383 tree)))
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
384
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
385 ;;;; Various list-search functions.
45690
9d351e5869c8 (copy-list): Moved here from cl.el.
Colin Walters <walters@gnu.org>
parents: 45587
diff changeset
386
22959
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
387 (defun assoc-default (key alist &optional test default)
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
388 "Find object KEY in a pseudo-alist ALIST.
103107
15fc92c2fca6 * subr.el (assoc-default): Doc fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 102983
diff changeset
389 ALIST is a list of conses or objects. Each element
15fc92c2fca6 * subr.el (assoc-default): Doc fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 102983
diff changeset
390 (or the element's car, if it is a cons) is compared with KEY by
15fc92c2fca6 * subr.el (assoc-default): Doc fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 102983
diff changeset
391 calling TEST, with two arguments: (i) the element or its car,
15fc92c2fca6 * subr.el (assoc-default): Doc fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 102983
diff changeset
392 and (ii) KEY.
15fc92c2fca6 * subr.el (assoc-default): Doc fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 102983
diff changeset
393 If that is non-nil, the element matches; then `assoc-default'
15fc92c2fca6 * subr.el (assoc-default): Doc fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 102983
diff changeset
394 returns the element's cdr, if it is a cons, or DEFAULT if the
15fc92c2fca6 * subr.el (assoc-default): Doc fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 102983
diff changeset
395 element is not a cons.
22959
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
396
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
397 If no element matches, the value is nil.
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
398 If TEST is omitted or nil, `equal' is used."
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
399 (let (found (tail alist) value)
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
400 (while (and tail (not found))
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
401 (let ((elt (car tail)))
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
402 (when (funcall (or test 'equal) (if (consp elt) (car elt) elt) key)
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
403 (setq found t value (if (consp elt) (cdr elt) default))))
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
404 (setq tail (cdr tail)))
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
405 value))
25295
737e82c21934 (assoc-ignore-case, assoc-ignore-representation): Moved here from simple.el.
Karl Heuer <kwzh@gnu.org>
parents: 25293
diff changeset
406
93971
2d29453eb5e6 (assoc-ignore-case, assoc-ignore-representation):
Juanma Barranquero <lekktu@gmail.com>
parents: 93825
diff changeset
407 (make-obsolete 'assoc-ignore-case 'assoc-string "22.1")
25295
737e82c21934 (assoc-ignore-case, assoc-ignore-representation): Moved here from simple.el.
Karl Heuer <kwzh@gnu.org>
parents: 25293
diff changeset
408 (defun assoc-ignore-case (key alist)
737e82c21934 (assoc-ignore-case, assoc-ignore-representation): Moved here from simple.el.
Karl Heuer <kwzh@gnu.org>
parents: 25293
diff changeset
409 "Like `assoc', but ignores differences in case and text representation.
737e82c21934 (assoc-ignore-case, assoc-ignore-representation): Moved here from simple.el.
Karl Heuer <kwzh@gnu.org>
parents: 25293
diff changeset
410 KEY must be a string. Upper-case and lower-case letters are treated as equal.
737e82c21934 (assoc-ignore-case, assoc-ignore-representation): Moved here from simple.el.
Karl Heuer <kwzh@gnu.org>
parents: 25293
diff changeset
411 Unibyte strings are converted to multibyte for comparison."
53412
a2bba9e88b95 (assoc-ignore-case, assoc-ignore-representation):
Richard M. Stallman <rms@gnu.org>
parents: 53368
diff changeset
412 (assoc-string key alist t))
25295
737e82c21934 (assoc-ignore-case, assoc-ignore-representation): Moved here from simple.el.
Karl Heuer <kwzh@gnu.org>
parents: 25293
diff changeset
413
93971
2d29453eb5e6 (assoc-ignore-case, assoc-ignore-representation):
Juanma Barranquero <lekktu@gmail.com>
parents: 93825
diff changeset
414 (make-obsolete 'assoc-ignore-representation 'assoc-string "22.1")
25295
737e82c21934 (assoc-ignore-case, assoc-ignore-representation): Moved here from simple.el.
Karl Heuer <kwzh@gnu.org>
parents: 25293
diff changeset
415 (defun assoc-ignore-representation (key alist)
737e82c21934 (assoc-ignore-case, assoc-ignore-representation): Moved here from simple.el.
Karl Heuer <kwzh@gnu.org>
parents: 25293
diff changeset
416 "Like `assoc', but ignores differences in text representation.
47916
0bb8dc016c43 (remq): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 47747
diff changeset
417 KEY must be a string.
25295
737e82c21934 (assoc-ignore-case, assoc-ignore-representation): Moved here from simple.el.
Karl Heuer <kwzh@gnu.org>
parents: 25293
diff changeset
418 Unibyte strings are converted to multibyte for comparison."
53412
a2bba9e88b95 (assoc-ignore-case, assoc-ignore-representation):
Richard M. Stallman <rms@gnu.org>
parents: 53368
diff changeset
419 (assoc-string key alist nil))
28490
9958b6d95bd6 (member-ignore-case): New function.
Gerd Moellmann <gerd@gnu.org>
parents: 28234
diff changeset
420
9958b6d95bd6 (member-ignore-case): New function.
Gerd Moellmann <gerd@gnu.org>
parents: 28234
diff changeset
421 (defun member-ignore-case (elt list)
111936
0a0aa7fbe2ca Doc fixes.
Glenn Morris <rgm@gnu.org>
parents: 111905
diff changeset
422 "Like `member', but ignore differences in case and text representation.
28490
9958b6d95bd6 (member-ignore-case): New function.
Gerd Moellmann <gerd@gnu.org>
parents: 28234
diff changeset
423 ELT must be a string. Upper-case and lower-case letters are treated as equal.
44900
e4975d9c93ff (insert-for-yank): Replace `category' property
Richard M. Stallman <rms@gnu.org>
parents: 44723
diff changeset
424 Unibyte strings are converted to multibyte for comparison.
e4975d9c93ff (insert-for-yank): Replace `category' property
Richard M. Stallman <rms@gnu.org>
parents: 44723
diff changeset
425 Non-strings in LIST are ignored."
e4975d9c93ff (insert-for-yank): Replace `category' property
Richard M. Stallman <rms@gnu.org>
parents: 44723
diff changeset
426 (while (and list
e4975d9c93ff (insert-for-yank): Replace `category' property
Richard M. Stallman <rms@gnu.org>
parents: 44723
diff changeset
427 (not (and (stringp (car list))
e4975d9c93ff (insert-for-yank): Replace `category' property
Richard M. Stallman <rms@gnu.org>
parents: 44723
diff changeset
428 (eq t (compare-strings elt 0 nil (car list) 0 nil t)))))
33978
9aa3fd6779f7 (member-ignore-case): Return the tail of the list who's car matches,
Miles Bader <miles@gnu.org>
parents: 33835
diff changeset
429 (setq list (cdr list)))
9aa3fd6779f7 (member-ignore-case): Return the tail of the list who's car matches,
Miles Bader <miles@gnu.org>
parents: 33835
diff changeset
430 list)
28490
9958b6d95bd6 (member-ignore-case): New function.
Gerd Moellmann <gerd@gnu.org>
parents: 28234
diff changeset
431
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
432 (defun assq-delete-all (key alist)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
433 "Delete from ALIST all elements whose car is `eq' to KEY.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
434 Return the modified alist.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
435 Elements of ALIST that are not conses are ignored."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
436 (while (and (consp (car alist))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
437 (eq (car (car alist)) key))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
438 (setq alist (cdr alist)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
439 (let ((tail alist) tail-cdr)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
440 (while (setq tail-cdr (cdr tail))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
441 (if (and (consp (car tail-cdr))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
442 (eq (car (car tail-cdr)) key))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
443 (setcdr tail (cdr tail-cdr))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
444 (setq tail tail-cdr))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
445 alist)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
446
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
447 (defun rassq-delete-all (value alist)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
448 "Delete from ALIST all elements whose cdr is `eq' to VALUE.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
449 Return the modified alist.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
450 Elements of ALIST that are not conses are ignored."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
451 (while (and (consp (car alist))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
452 (eq (cdr (car alist)) value))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
453 (setq alist (cdr alist)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
454 (let ((tail alist) tail-cdr)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
455 (while (setq tail-cdr (cdr tail))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
456 (if (and (consp (car tail-cdr))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
457 (eq (cdr (car tail-cdr)) value))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
458 (setcdr tail (cdr tail-cdr))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
459 (setq tail tail-cdr))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
460 alist)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
461
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
462 (defun remove (elt seq)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
463 "Return a copy of SEQ with all occurrences of ELT removed.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
464 SEQ must be a list, vector, or string. The comparison is done with `equal'."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
465 (if (nlistp seq)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
466 ;; If SEQ isn't a list, there's no need to copy SEQ because
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
467 ;; `delete' will return a new object.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
468 (delete elt seq)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
469 (delete elt (copy-sequence seq))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
470
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
471 (defun remq (elt list)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
472 "Return LIST with all occurrences of ELT removed.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
473 The comparison is done with `eq'. Contrary to `delq', this does not use
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
474 side-effects, and the argument LIST is not modified."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
475 (if (memq elt list)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
476 (delq elt (copy-sequence list))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
477 list))
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
478
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
479 ;;;; Keymap support.
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
480
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
481 (defmacro kbd (keys)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
482 "Convert KEYS to the internal Emacs key representation.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
483 KEYS should be a string constant in the format used for
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
484 saving keyboard macros (see `edmacro-mode')."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
485 (read-kbd-macro keys))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
486
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
487 (defun undefined ()
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
488 (interactive)
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
489 (ding))
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
490
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
491 ;; Prevent the \{...} documentation construct
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
492 ;; from mentioning keys that run this command.
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
493 (put 'undefined 'suppress-keymap t)
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
494
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
495 (defun suppress-keymap (map &optional nodigits)
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
496 "Make MAP override all normally self-inserting keys to be undefined.
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
497 Normally, as an exception, digits and minus-sign are set to make prefix args,
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
498 but optional second arg NODIGITS non-nil treats them like other chars."
47042
74f8b41068e0 (suppress-keymap): Use command remapping instead of
Kim F. Storm <storm@cua.dk>
parents: 47025
diff changeset
499 (define-key map [remap self-insert-command] 'undefined)
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
500 (or nodigits
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
501 (let (loop)
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
502 (define-key map "-" 'negative-argument)
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
503 ;; Make plain numbers do numeric args.
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
504 (setq loop ?0)
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
505 (while (<= loop ?9)
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
506 (define-key map (char-to-string loop) 'digit-argument)
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
507 (setq loop (1+ loop))))))
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
508
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
509 (defun define-key-after (keymap key definition &optional after)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
510 "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
511 This is like `define-key' except that the binding for KEY is placed
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
512 just after the binding for the event AFTER, instead of at the beginning
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
513 of the map. Note that AFTER must be an event type (like KEY), NOT a command
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
514 \(like DEFINITION).
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
515
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
516 If AFTER is t or omitted, the new binding goes at the end of the keymap.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
517 AFTER should be a single event type--a symbol or a character, not a sequence.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
518
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
519 Bindings are always added before any inherited map.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
520
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
521 The order of bindings in a keymap matters when it is used as a menu."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
522 (unless after (setq after t))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
523 (or (keymapp keymap)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
524 (signal 'wrong-type-argument (list 'keymapp keymap)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
525 (setq key
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
526 (if (<= (length key) 1) (aref key 0)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
527 (setq keymap (lookup-key keymap
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
528 (apply 'vector
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
529 (butlast (mapcar 'identity key)))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
530 (aref key (1- (length key)))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
531 (let ((tail keymap) done inserted)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
532 (while (and (not done) tail)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
533 ;; Delete any earlier bindings for the same key.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
534 (if (eq (car-safe (car (cdr tail))) key)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
535 (setcdr tail (cdr (cdr tail))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
536 ;; If we hit an included map, go down that one.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
537 (if (keymapp (car tail)) (setq tail (car tail)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
538 ;; When we reach AFTER's binding, insert the new binding after.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
539 ;; If we reach an inherited keymap, insert just before that.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
540 ;; If we reach the end of this keymap, insert at the end.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
541 (if (or (and (eq (car-safe (car tail)) after)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
542 (not (eq after t)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
543 (eq (car (cdr tail)) 'keymap)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
544 (null (cdr tail)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
545 (progn
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
546 ;; Stop the scan only if we find a parent keymap.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
547 ;; Keep going past the inserted element
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
548 ;; so we can delete any duplications that come later.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
549 (if (eq (car (cdr tail)) 'keymap)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
550 (setq done t))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
551 ;; Don't insert more than once.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
552 (or inserted
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
553 (setcdr tail (cons (cons key definition) (cdr tail))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
554 (setq inserted t)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
555 (setq tail (cdr tail)))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
556
93204
9f83f0ec5257 * subr.el (map-keymap-sorted): Rename from map-keymap-internal.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93200
diff changeset
557 (defun map-keymap-sorted (function keymap)
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
558 "Implement `map-keymap' with sorting.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
559 Don't call this function; it is for internal use only."
93204
9f83f0ec5257 * subr.el (map-keymap-sorted): Rename from map-keymap-internal.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93200
diff changeset
560 (let (list)
9f83f0ec5257 * subr.el (map-keymap-sorted): Rename from map-keymap-internal.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93200
diff changeset
561 (map-keymap (lambda (a b) (push (cons a b) list))
9f83f0ec5257 * subr.el (map-keymap-sorted): Rename from map-keymap-internal.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93200
diff changeset
562 keymap)
9f83f0ec5257 * subr.el (map-keymap-sorted): Rename from map-keymap-internal.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93200
diff changeset
563 (setq list (sort list
9f83f0ec5257 * subr.el (map-keymap-sorted): Rename from map-keymap-internal.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93200
diff changeset
564 (lambda (a b)
9f83f0ec5257 * subr.el (map-keymap-sorted): Rename from map-keymap-internal.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93200
diff changeset
565 (setq a (car a) b (car b))
9f83f0ec5257 * subr.el (map-keymap-sorted): Rename from map-keymap-internal.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93200
diff changeset
566 (if (integerp a)
9f83f0ec5257 * subr.el (map-keymap-sorted): Rename from map-keymap-internal.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93200
diff changeset
567 (if (integerp b) (< a b)
9f83f0ec5257 * subr.el (map-keymap-sorted): Rename from map-keymap-internal.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93200
diff changeset
568 t)
9f83f0ec5257 * subr.el (map-keymap-sorted): Rename from map-keymap-internal.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93200
diff changeset
569 (if (integerp b) t
9f83f0ec5257 * subr.el (map-keymap-sorted): Rename from map-keymap-internal.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93200
diff changeset
570 ;; string< also accepts symbols.
9f83f0ec5257 * subr.el (map-keymap-sorted): Rename from map-keymap-internal.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93200
diff changeset
571 (string< a b))))))
9f83f0ec5257 * subr.el (map-keymap-sorted): Rename from map-keymap-internal.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93200
diff changeset
572 (dolist (p list)
9f83f0ec5257 * subr.el (map-keymap-sorted): Rename from map-keymap-internal.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93200
diff changeset
573 (funcall function (car p) (cdr p)))))
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
574
93664
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
575 (defun keymap-canonicalize (map)
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
576 "Return an equivalent keymap, without inheritance."
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
577 (let ((bindings ())
100699
ad20c1d5df89 (keymap-canonicalize): Properly preserve keymap prompt.
Andreas Schwab <schwab@suse.de>
parents: 100676
diff changeset
578 (ranges ())
ad20c1d5df89 (keymap-canonicalize): Properly preserve keymap prompt.
Andreas Schwab <schwab@suse.de>
parents: 100676
diff changeset
579 (prompt (keymap-prompt map)))
93664
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
580 (while (keymapp map)
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
581 (setq map (map-keymap-internal
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
582 (lambda (key item)
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
583 (if (consp key)
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
584 ;; Treat char-ranges specially.
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
585 (push (cons key item) ranges)
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
586 (push (cons key item) bindings)))
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
587 map)))
100699
ad20c1d5df89 (keymap-canonicalize): Properly preserve keymap prompt.
Andreas Schwab <schwab@suse.de>
parents: 100676
diff changeset
588 (setq map (funcall (if ranges 'make-keymap 'make-sparse-keymap) prompt))
93664
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
589 (dolist (binding ranges)
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
590 ;; Treat char-ranges specially.
93721
6604d09cf521 *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93664
diff changeset
591 (define-key map (vector (car binding)) (cdr binding)))
93664
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
592 (dolist (binding (prog1 bindings (setq bindings ())))
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
593 (let* ((key (car binding))
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
594 (item (cdr binding))
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
595 (oldbind (assq key bindings)))
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
596 ;; Newer bindings override older.
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
597 (if oldbind (setq bindings (delq oldbind bindings)))
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
598 (when item ;nil bindings just hide older ones.
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
599 (push binding bindings))))
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
600 (nconc map bindings)))
c7dd307b0ec5 * subr.el (keymap-canonicalize): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93396
diff changeset
601
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
602 (put 'keyboard-translate-table 'char-table-extra-slots 0)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
603
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
604 (defun keyboard-translate (from to)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
605 "Translate character FROM to TO at a low level.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
606 This function creates a `keyboard-translate-table' if necessary
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
607 and then modifies one entry in it."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
608 (or (char-table-p keyboard-translate-table)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
609 (setq keyboard-translate-table
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
610 (make-char-table 'keyboard-translate-table nil)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
611 (aset keyboard-translate-table from to))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
612
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
613 ;;;; Key binding commands.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
614
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
615 (defun global-set-key (key command)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
616 "Give KEY a global binding as COMMAND.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
617 COMMAND is the command definition to use; usually it is
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
618 a symbol naming an interactively-callable function.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
619 KEY is a key sequence; noninteractively, it is a string or vector
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
620 of characters or event types, and non-ASCII characters with codes
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
621 above 127 (such as ISO Latin-1) can be included if you use a vector.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
622
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
623 Note that if KEY has a local binding in the current buffer,
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
624 that local binding will continue to shadow any global binding
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
625 that you make with this function."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
626 (interactive "KSet key globally: \nCSet key %s to command: ")
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
627 (or (vectorp key) (stringp key)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
628 (signal 'wrong-type-argument (list 'arrayp key)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
629 (define-key (current-global-map) key command))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
630
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
631 (defun local-set-key (key command)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
632 "Give KEY a local binding as COMMAND.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
633 COMMAND is the command definition to use; usually it is
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
634 a symbol naming an interactively-callable function.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
635 KEY is a key sequence; noninteractively, it is a string or vector
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
636 of characters or event types, and non-ASCII characters with codes
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
637 above 127 (such as ISO Latin-1) can be included if you use a vector.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
638
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
639 The binding goes in the current buffer's local map,
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
640 which in most cases is shared with all other buffers in the same major mode."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
641 (interactive "KSet key locally: \nCSet key %s locally to command: ")
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
642 (let ((map (current-local-map)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
643 (or map
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
644 (use-local-map (setq map (make-sparse-keymap))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
645 (or (vectorp key) (stringp key)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
646 (signal 'wrong-type-argument (list 'arrayp key)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
647 (define-key map key command)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
648
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
649 (defun global-unset-key (key)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
650 "Remove global binding of KEY.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
651 KEY is a string or vector representing a sequence of keystrokes."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
652 (interactive "kUnset key globally: ")
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
653 (global-set-key key nil))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
654
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
655 (defun local-unset-key (key)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
656 "Remove local binding of KEY.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
657 KEY is a string or vector representing a sequence of keystrokes."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
658 (interactive "kUnset key locally: ")
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
659 (if (current-local-map)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
660 (local-set-key key nil))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
661 nil)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
662
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
663 ;;;; substitute-key-definition and its subroutines.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
664
6167
1ad8f8ccdc2b (substitute-key-definition): Avoid infinite recursion.
Karl Heuer <kwzh@gnu.org>
parents: 6039
diff changeset
665 (defvar key-substitution-in-progress nil
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
666 "Used internally by `substitute-key-definition'.")
6167
1ad8f8ccdc2b (substitute-key-definition): Avoid infinite recursion.
Karl Heuer <kwzh@gnu.org>
parents: 6039
diff changeset
667
61967
d9764486d42f (dot, dot-marker, dot-min, dot-max, buffer-flush-undo)
Nick Roberts <nickrob@snap.net.nz>
parents: 61955
diff changeset
668 (defun substitute-key-definition (olddef newdef keymap &optional oldmap prefix)
d9764486d42f (dot, dot-marker, dot-min, dot-max, buffer-flush-undo)
Nick Roberts <nickrob@snap.net.nz>
parents: 61955
diff changeset
669 "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF.
d9764486d42f (dot, dot-marker, dot-min, dot-max, buffer-flush-undo)
Nick Roberts <nickrob@snap.net.nz>
parents: 61955
diff changeset
670 In other words, OLDDEF is replaced with NEWDEF where ever it appears.
d9764486d42f (dot, dot-marker, dot-min, dot-max, buffer-flush-undo)
Nick Roberts <nickrob@snap.net.nz>
parents: 61955
diff changeset
671 Alternatively, if optional fourth argument OLDMAP is specified, we redefine
d9764486d42f (dot, dot-marker, dot-min, dot-max, buffer-flush-undo)
Nick Roberts <nickrob@snap.net.nz>
parents: 61955
diff changeset
672 in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP.
d9764486d42f (dot, dot-marker, dot-min, dot-max, buffer-flush-undo)
Nick Roberts <nickrob@snap.net.nz>
parents: 61955
diff changeset
673
68830
a924d28d2d25 (substitute-key-definition): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 68777
diff changeset
674 If you don't specify OLDMAP, you can usually get the same results
a924d28d2d25 (substitute-key-definition): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 68777
diff changeset
675 in a cleaner way with command remapping, like this:
68848
f038d760daf1 (substitute-key-definition): Doc fix (hide internal argument).
Juanma Barranquero <lekktu@gmail.com>
parents: 68830
diff changeset
676 \(define-key KEYMAP [remap OLDDEF] NEWDEF)
f038d760daf1 (substitute-key-definition): Doc fix (hide internal argument).
Juanma Barranquero <lekktu@gmail.com>
parents: 68830
diff changeset
677 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
28868
e62636f5d724 (substitute-key-definition): Add comment describing
Gerd Moellmann <gerd@gnu.org>
parents: 28863
diff changeset
678 ;; Don't document PREFIX in the doc string because we don't want to
e62636f5d724 (substitute-key-definition): Add comment describing
Gerd Moellmann <gerd@gnu.org>
parents: 28863
diff changeset
679 ;; advertise it. It's meant for recursive calls only. Here's its
e62636f5d724 (substitute-key-definition): Add comment describing
Gerd Moellmann <gerd@gnu.org>
parents: 28863
diff changeset
680 ;; meaning
47916
0bb8dc016c43 (remq): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 47747
diff changeset
681
28868
e62636f5d724 (substitute-key-definition): Add comment describing
Gerd Moellmann <gerd@gnu.org>
parents: 28863
diff changeset
682 ;; If optional argument PREFIX is specified, it should be a key
e62636f5d724 (substitute-key-definition): Add comment describing
Gerd Moellmann <gerd@gnu.org>
parents: 28863
diff changeset
683 ;; prefix, a string. Redefined bindings will then be bound to the
e62636f5d724 (substitute-key-definition): Add comment describing
Gerd Moellmann <gerd@gnu.org>
parents: 28863
diff changeset
684 ;; original key, with PREFIX added at the front.
1176
60e0dc538df3 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 1166
diff changeset
685 (or prefix (setq prefix ""))
60e0dc538df3 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 1166
diff changeset
686 (let* ((scan (or oldmap keymap))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
687 (prefix1 (vconcat prefix [nil]))
6167
1ad8f8ccdc2b (substitute-key-definition): Avoid infinite recursion.
Karl Heuer <kwzh@gnu.org>
parents: 6039
diff changeset
688 (key-substitution-in-progress
1ad8f8ccdc2b (substitute-key-definition): Avoid infinite recursion.
Karl Heuer <kwzh@gnu.org>
parents: 6039
diff changeset
689 (cons scan key-substitution-in-progress)))
1176
60e0dc538df3 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 1166
diff changeset
690 ;; Scan OLDMAP, finding each char or event-symbol that
60e0dc538df3 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 1166
diff changeset
691 ;; has any definition, and act on it with hack-key.
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
692 (map-keymap
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
693 (lambda (char defn)
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
694 (aset prefix1 (length prefix) char)
61967
d9764486d42f (dot, dot-marker, dot-min, dot-max, buffer-flush-undo)
Nick Roberts <nickrob@snap.net.nz>
parents: 61955
diff changeset
695 (substitute-key-definition-key defn olddef newdef prefix1 keymap))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
696 scan)))
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
697
61967
d9764486d42f (dot, dot-marker, dot-min, dot-max, buffer-flush-undo)
Nick Roberts <nickrob@snap.net.nz>
parents: 61955
diff changeset
698 (defun substitute-key-definition-key (defn olddef newdef prefix keymap)
d9764486d42f (dot, dot-marker, dot-min, dot-max, buffer-flush-undo)
Nick Roberts <nickrob@snap.net.nz>
parents: 61955
diff changeset
699 (let (inner-def skipped menu-item)
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
700 ;; Find the actual command name within the binding.
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
701 (if (eq (car-safe defn) 'menu-item)
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
702 (setq menu-item defn defn (nth 2 defn))
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
703 ;; Skip past menu-prompt.
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
704 (while (stringp (car-safe defn))
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
705 (push (pop defn) skipped))
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
706 ;; Skip past cached key-equivalence data for menu items.
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
707 (if (consp (car-safe defn))
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
708 (setq defn (cdr defn))))
61967
d9764486d42f (dot, dot-marker, dot-min, dot-max, buffer-flush-undo)
Nick Roberts <nickrob@snap.net.nz>
parents: 61955
diff changeset
709 (if (or (eq defn olddef)
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
710 ;; Compare with equal if definition is a key sequence.
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
711 ;; That is useful for operating on function-key-map.
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
712 (and (or (stringp defn) (vectorp defn))
61967
d9764486d42f (dot, dot-marker, dot-min, dot-max, buffer-flush-undo)
Nick Roberts <nickrob@snap.net.nz>
parents: 61955
diff changeset
713 (equal defn olddef)))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
714 (define-key keymap prefix
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
715 (if menu-item
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
716 (let ((copy (copy-sequence menu-item)))
61967
d9764486d42f (dot, dot-marker, dot-min, dot-max, buffer-flush-undo)
Nick Roberts <nickrob@snap.net.nz>
parents: 61955
diff changeset
717 (setcar (nthcdr 2 copy) newdef)
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
718 copy)
61967
d9764486d42f (dot, dot-marker, dot-min, dot-max, buffer-flush-undo)
Nick Roberts <nickrob@snap.net.nz>
parents: 61955
diff changeset
719 (nconc (nreverse skipped) newdef)))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
720 ;; Look past a symbol that names a keymap.
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
721 (setq inner-def
68759
0b4b98e12e73 (substitute-key-definition-key): Pass t for NOERROR to
Kim F. Storm <storm@cua.dk>
parents: 68651
diff changeset
722 (or (indirect-function defn t) defn))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
723 ;; For nested keymaps, we use `inner-def' rather than `defn' so as to
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
724 ;; avoid autoloading a keymap. This is mostly done to preserve the
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
725 ;; original non-autoloading behavior of pre-map-keymap times.
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
726 (if (and (keymapp inner-def)
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
727 ;; Avoid recursively scanning
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
728 ;; where KEYMAP does not have a submap.
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
729 (let ((elt (lookup-key keymap prefix)))
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
730 (or (null elt) (natnump elt) (keymapp elt)))
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
731 ;; Avoid recursively rescanning keymap being scanned.
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
732 (not (memq inner-def key-substitution-in-progress)))
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
733 ;; If this one isn't being scanned already, scan it now.
61967
d9764486d42f (dot, dot-marker, dot-min, dot-max, buffer-flush-undo)
Nick Roberts <nickrob@snap.net.nz>
parents: 61955
diff changeset
734 (substitute-key-definition olddef newdef keymap inner-def prefix)))))
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
735
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
736
47916
0bb8dc016c43 (remq): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 47747
diff changeset
737 ;;;; The global keymap tree.
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
738
105060
78c0a7ca3aaf (push, pop, dolist, dotimes, declare): Don't overwrite CL's
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105027
diff changeset
739 ;; global-map, esc-map, and ctl-x-map have their values set up in
78c0a7ca3aaf (push, pop, dolist, dotimes, declare): Don't overwrite CL's
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105027
diff changeset
740 ;; keymap.c; we just give them docstrings here.
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
741
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
742 (defvar global-map nil
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
743 "Default global keymap mapping Emacs keyboard input into commands.
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
744 The value is a keymap which is usually (but not necessarily) Emacs's
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
745 global map.")
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
746
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
747 (defvar esc-map nil
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
748 "Default keymap for ESC (meta) commands.
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
749 The normal global definition of the character ESC indirects to this keymap.")
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
750
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
751 (defvar ctl-x-map nil
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
752 "Default keymap for C-x commands.
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
753 The normal global definition of the character C-x indirects to this keymap.")
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
754
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
755 (defvar ctl-x-4-map (make-sparse-keymap)
41955
241e553840f9 (ctl-x-4-map): Doc fix.
Pavel Janík <Pavel@Janik.cz>
parents: 41618
diff changeset
756 "Keymap for subcommands of C-x 4.")
2569
39ad4eda7fea All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2504
diff changeset
757 (defalias 'ctl-x-4-prefix ctl-x-4-map)
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
758 (define-key ctl-x-map "4" 'ctl-x-4-prefix)
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
759
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
760 (defvar ctl-x-5-map (make-sparse-keymap)
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
761 "Keymap for frame commands.")
2569
39ad4eda7fea All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2504
diff changeset
762 (defalias 'ctl-x-5-prefix ctl-x-5-map)
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
763 (define-key ctl-x-map "5" 'ctl-x-5-prefix)
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
764
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
765
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
766 ;;;; Event manipulation functions.
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
767
104354
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
768 (defconst listify-key-sequence-1 (logior 128 ?\M-\C-@))
3153
4c94c9faf1af (listify-key-sequence): Avoid the constant ?\M-\200.
Richard M. Stallman <rms@gnu.org>
parents: 2963
diff changeset
769
2021
8b9286bffef8 (listify-key-sequence): New function.
Richard M. Stallman <rms@gnu.org>
parents: 1959
diff changeset
770 (defun listify-key-sequence (key)
8b9286bffef8 (listify-key-sequence): New function.
Richard M. Stallman <rms@gnu.org>
parents: 1959
diff changeset
771 "Convert a key sequence to a list of events."
8b9286bffef8 (listify-key-sequence): New function.
Richard M. Stallman <rms@gnu.org>
parents: 1959
diff changeset
772 (if (vectorp key)
8b9286bffef8 (listify-key-sequence): New function.
Richard M. Stallman <rms@gnu.org>
parents: 1959
diff changeset
773 (append key nil)
8b9286bffef8 (listify-key-sequence): New function.
Richard M. Stallman <rms@gnu.org>
parents: 1959
diff changeset
774 (mapcar (function (lambda (c)
8b9286bffef8 (listify-key-sequence): New function.
Richard M. Stallman <rms@gnu.org>
parents: 1959
diff changeset
775 (if (> c 127)
3153
4c94c9faf1af (listify-key-sequence): Avoid the constant ?\M-\200.
Richard M. Stallman <rms@gnu.org>
parents: 2963
diff changeset
776 (logxor c listify-key-sequence-1)
2021
8b9286bffef8 (listify-key-sequence): New function.
Richard M. Stallman <rms@gnu.org>
parents: 1959
diff changeset
777 c)))
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
778 key)))
2021
8b9286bffef8 (listify-key-sequence): New function.
Richard M. Stallman <rms@gnu.org>
parents: 1959
diff changeset
779
2040
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
780 (defsubst eventp (obj)
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
781 "True if the argument is an event object."
55520
30d4272bcc4b (eventp): Be more discriminating with integers.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55502
diff changeset
782 (or (and (integerp obj)
30d4272bcc4b (eventp): Be more discriminating with integers.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55502
diff changeset
783 ;; Filter out integers too large to be events.
30d4272bcc4b (eventp): Be more discriminating with integers.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55502
diff changeset
784 ;; M is the biggest modifier.
30d4272bcc4b (eventp): Be more discriminating with integers.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55502
diff changeset
785 (zerop (logand obj (lognot (1- (lsh ?\M-\^@ 1)))))
89943
4c90ffeb71c5 Revision: miles@gnu.org--gnu-2004/emacs--unicode--0--patch-15
Miles Bader <miles@gnu.org>
parents: 89909 55976
diff changeset
786 (characterp (event-basic-type obj)))
2040
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
787 (and (symbolp obj)
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
788 (get obj 'event-symbol-elements))
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
789 (and (consp obj)
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
790 (symbolp (car obj))
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
791 (get (car obj) 'event-symbol-elements))))
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
792
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
793 (defun event-modifiers (event)
56537
69db3634588e (butlast, event-modifiers, event-basic-type): Doc fixes.
John Paul Wallington <jpw@pobox.com>
parents: 56402
diff changeset
794 "Return a list of symbols representing the modifier keys in event EVENT.
2040
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
795 The elements of the list may include `meta', `control',
4414
3356419b94c1 (add-hook): Change a single function into a list.
Richard M. Stallman <rms@gnu.org>
parents: 4235
diff changeset
796 `shift', `hyper', `super', `alt', `click', `double', `triple', `drag',
56570
059dc717baef (event-modifiers, event-basic-type): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56565
diff changeset
797 and `down'.
059dc717baef (event-modifiers, event-basic-type): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56565
diff changeset
798 EVENT may be an event or an event type. If EVENT is a symbol
059dc717baef (event-modifiers, event-basic-type): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56565
diff changeset
799 that has never been used in an event that has been read as input
059dc717baef (event-modifiers, event-basic-type): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56565
diff changeset
800 in the current Emacs session, then this function can return nil,
059dc717baef (event-modifiers, event-basic-type): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56565
diff changeset
801 even when EVENT actually has modifiers."
2040
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
802 (let ((type event))
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
803 (if (listp type)
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
804 (setq type (car type)))
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
805 (if (symbolp type)
86099
48dc79c663f4 * subr.el (event-modifiers): Use internal-event-symbol-parse-modifiers.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 86017
diff changeset
806 ;; Don't read event-symbol-elements directly since we're not
48dc79c663f4 * subr.el (event-modifiers): Use internal-event-symbol-parse-modifiers.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 86017
diff changeset
807 ;; sure the symbol has already been parsed.
48dc79c663f4 * subr.el (event-modifiers): Use internal-event-symbol-parse-modifiers.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 86017
diff changeset
808 (cdr (internal-event-symbol-parse-modifiers type))
55013
aba8cece2157 (event-modifiers): Fix the criterion for ASCII control chars.
Richard M. Stallman <rms@gnu.org>
parents: 55008
diff changeset
809 (let ((list nil)
aba8cece2157 (event-modifiers): Fix the criterion for ASCII control chars.
Richard M. Stallman <rms@gnu.org>
parents: 55008
diff changeset
810 (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@
aba8cece2157 (event-modifiers): Fix the criterion for ASCII control chars.
Richard M. Stallman <rms@gnu.org>
parents: 55008
diff changeset
811 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
aba8cece2157 (event-modifiers): Fix the criterion for ASCII control chars.
Richard M. Stallman <rms@gnu.org>
parents: 55008
diff changeset
812 (if (not (zerop (logand type ?\M-\^@)))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
813 (push 'meta list))
55013
aba8cece2157 (event-modifiers): Fix the criterion for ASCII control chars.
Richard M. Stallman <rms@gnu.org>
parents: 55008
diff changeset
814 (if (or (not (zerop (logand type ?\C-\^@)))
aba8cece2157 (event-modifiers): Fix the criterion for ASCII control chars.
Richard M. Stallman <rms@gnu.org>
parents: 55008
diff changeset
815 (< char 32))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
816 (push 'control list))
55013
aba8cece2157 (event-modifiers): Fix the criterion for ASCII control chars.
Richard M. Stallman <rms@gnu.org>
parents: 55008
diff changeset
817 (if (or (not (zerop (logand type ?\S-\^@)))
aba8cece2157 (event-modifiers): Fix the criterion for ASCII control chars.
Richard M. Stallman <rms@gnu.org>
parents: 55008
diff changeset
818 (/= char (downcase char)))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
819 (push 'shift list))
10693
0875851842f0 (listify-key-sequence-1, event-modifiers): Don't presume internal bit layout
Karl Heuer <kwzh@gnu.org>
parents: 10681
diff changeset
820 (or (zerop (logand type ?\H-\^@))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
821 (push 'hyper list))
10693
0875851842f0 (listify-key-sequence-1, event-modifiers): Don't presume internal bit layout
Karl Heuer <kwzh@gnu.org>
parents: 10681
diff changeset
822 (or (zerop (logand type ?\s-\^@))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
823 (push 'super list))
10693
0875851842f0 (listify-key-sequence-1, event-modifiers): Don't presume internal bit layout
Karl Heuer <kwzh@gnu.org>
parents: 10681
diff changeset
824 (or (zerop (logand type ?\A-\^@))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
825 (push 'alt list))
2040
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
826 list))))
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
827
2063
2f0555b428c4 (event-basic-type): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2040
diff changeset
828 (defun event-basic-type (event)
56537
69db3634588e (butlast, event-modifiers, event-basic-type): Doc fixes.
John Paul Wallington <jpw@pobox.com>
parents: 56402
diff changeset
829 "Return the basic type of the given event (all modifiers removed).
56570
059dc717baef (event-modifiers, event-basic-type): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56565
diff changeset
830 The value is a printing character (not upper case) or a symbol.
059dc717baef (event-modifiers, event-basic-type): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56565
diff changeset
831 EVENT may be an event or an event type. If EVENT is a symbol
059dc717baef (event-modifiers, event-basic-type): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56565
diff changeset
832 that has never been used in an event that has been read as input
059dc717baef (event-modifiers, event-basic-type): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56565
diff changeset
833 in the current Emacs session, then this function may return nil."
3784
d2df5ca46b39 * subr.el (event-basic-type): Deal with listy events properly.
Jim Blandy <jimb@redhat.com>
parents: 3591
diff changeset
834 (if (consp event)
d2df5ca46b39 * subr.el (event-basic-type): Deal with listy events properly.
Jim Blandy <jimb@redhat.com>
parents: 3591
diff changeset
835 (setq event (car event)))
2063
2f0555b428c4 (event-basic-type): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2040
diff changeset
836 (if (symbolp event)
2f0555b428c4 (event-basic-type): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2040
diff changeset
837 (car (get event 'event-symbol-elements))
62524
b54077faa74a (event-basic-type): Don't get an error.
Richard M. Stallman <rms@gnu.org>
parents: 62501
diff changeset
838 (let* ((base (logand event (1- ?\A-\^@)))
b54077faa74a (event-basic-type): Don't get an error.
Richard M. Stallman <rms@gnu.org>
parents: 62501
diff changeset
839 (uncontrolled (if (< base 32) (logior base 64) base)))
b54077faa74a (event-basic-type): Don't get an error.
Richard M. Stallman <rms@gnu.org>
parents: 62501
diff changeset
840 ;; There are some numbers that are invalid characters and
b54077faa74a (event-basic-type): Don't get an error.
Richard M. Stallman <rms@gnu.org>
parents: 62501
diff changeset
841 ;; cause `downcase' to get an error.
b54077faa74a (event-basic-type): Don't get an error.
Richard M. Stallman <rms@gnu.org>
parents: 62501
diff changeset
842 (condition-case ()
b54077faa74a (event-basic-type): Don't get an error.
Richard M. Stallman <rms@gnu.org>
parents: 62501
diff changeset
843 (downcase uncontrolled)
b54077faa74a (event-basic-type): Don't get an error.
Richard M. Stallman <rms@gnu.org>
parents: 62501
diff changeset
844 (error uncontrolled)))))
2063
2f0555b428c4 (event-basic-type): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2040
diff changeset
845
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
846 (defsubst mouse-movement-p (object)
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
847 "Return non-nil if OBJECT is a mouse movement event."
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
848 (eq (car-safe object) 'mouse-movement))
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
849
94556
8d02ae7cb729 * vc.el (vc-dir-mode-map): Enable mouse bindings.
Sam Steingold <sds@gnu.org>
parents: 94331
diff changeset
850 (defun mouse-event-p (object)
8d02ae7cb729 * vc.el (vc-dir-mode-map): Enable mouse bindings.
Sam Steingold <sds@gnu.org>
parents: 94331
diff changeset
851 "Return non-nil if OBJECT is a mouse click event."
8d02ae7cb729 * vc.el (vc-dir-mode-map): Enable mouse bindings.
Sam Steingold <sds@gnu.org>
parents: 94331
diff changeset
852 ;; is this really correct? maybe remove mouse-movement?
8d02ae7cb729 * vc.el (vc-dir-mode-map): Enable mouse bindings.
Sam Steingold <sds@gnu.org>
parents: 94331
diff changeset
853 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement)))
8d02ae7cb729 * vc.el (vc-dir-mode-map): Enable mouse bindings.
Sam Steingold <sds@gnu.org>
parents: 94331
diff changeset
854
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
855 (defsubst event-start (event)
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
856 "Return the starting position of EVENT.
112262
e4c00899294b * lisp/subr.el (event-start, event-end): Doc fix (Bug#7826).
Chong Yidong <cyd@stupidchicken.com>
parents: 112218
diff changeset
857 EVENT should be a click, drag, or key press event.
e4c00899294b * lisp/subr.el (event-start, event-end): Doc fix (Bug#7826).
Chong Yidong <cyd@stupidchicken.com>
parents: 112218
diff changeset
858 If it is a key press event, the return value has the form
e4c00899294b * lisp/subr.el (event-start, event-end): Doc fix (Bug#7826).
Chong Yidong <cyd@stupidchicken.com>
parents: 112218
diff changeset
859 (WINDOW POS (0 . 0) 0)
e4c00899294b * lisp/subr.el (event-start, event-end): Doc fix (Bug#7826).
Chong Yidong <cyd@stupidchicken.com>
parents: 112218
diff changeset
860 If it is a click or drag event, it has the form
53518
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
861 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
862 IMAGE (DX . DY) (WIDTH . HEIGHT))
112262
e4c00899294b * lisp/subr.el (event-start, event-end): Doc fix (Bug#7826).
Chong Yidong <cyd@stupidchicken.com>
parents: 112218
diff changeset
863 The `posn-' functions access elements of such lists.
e4c00899294b * lisp/subr.el (event-start, event-end): Doc fix (Bug#7826).
Chong Yidong <cyd@stupidchicken.com>
parents: 112218
diff changeset
864 For more information, see Info node `(elisp)Click Events'.
e4c00899294b * lisp/subr.el (event-start, event-end): Doc fix (Bug#7826).
Chong Yidong <cyd@stupidchicken.com>
parents: 112218
diff changeset
865
e4c00899294b * lisp/subr.el (event-start, event-end): Doc fix (Bug#7826).
Chong Yidong <cyd@stupidchicken.com>
parents: 112218
diff changeset
866 If EVENT is a mouse or key press or a mouse click, this is the
e4c00899294b * lisp/subr.el (event-start, event-end): Doc fix (Bug#7826).
Chong Yidong <cyd@stupidchicken.com>
parents: 112218
diff changeset
867 position of the event. If EVENT is a drag, this is the starting
e4c00899294b * lisp/subr.el (event-start, event-end): Doc fix (Bug#7826).
Chong Yidong <cyd@stupidchicken.com>
parents: 112218
diff changeset
868 position of the drag."
45978
a8fbafaa31ad (event-start, event-end, event-click-count):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45823
diff changeset
869 (if (consp event) (nth 1 event)
a8fbafaa31ad (event-start, event-end, event-click-count):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45823
diff changeset
870 (list (selected-window) (point) '(0 . 0) 0)))
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
871
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
872 (defsubst event-end (event)
54866
47cdc4f7ee17 (posn-set-point): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54626
diff changeset
873 "Return the ending location of EVENT.
47cdc4f7ee17 (posn-set-point): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54626
diff changeset
874 EVENT should be a click, drag, or key press event.
112262
e4c00899294b * lisp/subr.el (event-start, event-end): Doc fix (Bug#7826).
Chong Yidong <cyd@stupidchicken.com>
parents: 112218
diff changeset
875 If EVENT is a key press event, the return value has the form
e4c00899294b * lisp/subr.el (event-start, event-end): Doc fix (Bug#7826).
Chong Yidong <cyd@stupidchicken.com>
parents: 112218
diff changeset
876 (WINDOW POS (0 . 0) 0)
e4c00899294b * lisp/subr.el (event-start, event-end): Doc fix (Bug#7826).
Chong Yidong <cyd@stupidchicken.com>
parents: 112218
diff changeset
877 If EVENT is a click event, this function is the same as
e4c00899294b * lisp/subr.el (event-start, event-end): Doc fix (Bug#7826).
Chong Yidong <cyd@stupidchicken.com>
parents: 112218
diff changeset
878 `event-start'. For click and drag events, the return value has
e4c00899294b * lisp/subr.el (event-start, event-end): Doc fix (Bug#7826).
Chong Yidong <cyd@stupidchicken.com>
parents: 112218
diff changeset
879 the form
53518
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
880 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
881 IMAGE (DX . DY) (WIDTH . HEIGHT))
112262
e4c00899294b * lisp/subr.el (event-start, event-end): Doc fix (Bug#7826).
Chong Yidong <cyd@stupidchicken.com>
parents: 112218
diff changeset
882 The `posn-' functions access elements of such lists.
e4c00899294b * lisp/subr.el (event-start, event-end): Doc fix (Bug#7826).
Chong Yidong <cyd@stupidchicken.com>
parents: 112218
diff changeset
883 For more information, see Info node `(elisp)Click Events'.
e4c00899294b * lisp/subr.el (event-start, event-end): Doc fix (Bug#7826).
Chong Yidong <cyd@stupidchicken.com>
parents: 112218
diff changeset
884
e4c00899294b * lisp/subr.el (event-start, event-end): Doc fix (Bug#7826).
Chong Yidong <cyd@stupidchicken.com>
parents: 112218
diff changeset
885 If EVENT is a mouse or key press or a mouse click, this is the
e4c00899294b * lisp/subr.el (event-start, event-end): Doc fix (Bug#7826).
Chong Yidong <cyd@stupidchicken.com>
parents: 112218
diff changeset
886 position of the event. If EVENT is a drag, this is the starting
e4c00899294b * lisp/subr.el (event-start, event-end): Doc fix (Bug#7826).
Chong Yidong <cyd@stupidchicken.com>
parents: 112218
diff changeset
887 position of the drag."
45978
a8fbafaa31ad (event-start, event-end, event-click-count):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45823
diff changeset
888 (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event)
a8fbafaa31ad (event-start, event-end, event-click-count):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45823
diff changeset
889 (list (selected-window) (point) '(0 . 0) 0)))
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
890
4414
3356419b94c1 (add-hook): Change a single function into a list.
Richard M. Stallman <rms@gnu.org>
parents: 4235
diff changeset
891 (defsubst event-click-count (event)
3356419b94c1 (add-hook): Change a single function into a list.
Richard M. Stallman <rms@gnu.org>
parents: 4235
diff changeset
892 "Return the multi-click count of EVENT, a click or drag event.
3356419b94c1 (add-hook): Change a single function into a list.
Richard M. Stallman <rms@gnu.org>
parents: 4235
diff changeset
893 The return value is a positive integer."
45978
a8fbafaa31ad (event-start, event-end, event-click-count):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45823
diff changeset
894 (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1))
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
895
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
896 ;;;; Extracting fields of the positions in an event.
4414
3356419b94c1 (add-hook): Change a single function into a list.
Richard M. Stallman <rms@gnu.org>
parents: 4235
diff changeset
897
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
898 (defsubst posn-window (position)
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
899 "Return the window in POSITION.
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
900 POSITION should be a list of the form returned by the `event-start'
53593
39793eabee87 (declare): New macro.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53518
diff changeset
901 and `event-end' functions."
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
902 (nth 0 position))
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
903
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
904 (defsubst posn-area (position)
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
905 "Return the window area recorded in POSITION, or nil for the text area.
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
906 POSITION should be a list of the form returned by the `event-start'
53593
39793eabee87 (declare): New macro.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53518
diff changeset
907 and `event-end' functions."
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
908 (let ((area (if (consp (nth 1 position))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
909 (car (nth 1 position))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
910 (nth 1 position))))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
911 (and (symbolp area) area)))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
912
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
913 (defsubst posn-point (position)
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
914 "Return the buffer location in POSITION.
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
915 POSITION should be a list of the form returned by the `event-start'
53593
39793eabee87 (declare): New macro.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53518
diff changeset
916 and `event-end' functions."
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
917 (or (nth 5 position)
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
918 (if (consp (nth 1 position))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
919 (car (nth 1 position))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
920 (nth 1 position))))
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
921
54866
47cdc4f7ee17 (posn-set-point): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54626
diff changeset
922 (defun posn-set-point (position)
47cdc4f7ee17 (posn-set-point): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54626
diff changeset
923 "Move point to POSITION.
47cdc4f7ee17 (posn-set-point): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54626
diff changeset
924 Select the corresponding window as well."
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
925 (if (not (windowp (posn-window position)))
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
926 (error "Position not in text area of window"))
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
927 (select-window (posn-window position))
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
928 (if (numberp (posn-point position))
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
929 (goto-char (posn-point position))))
54866
47cdc4f7ee17 (posn-set-point): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54626
diff changeset
930
6039
4eb7f4633370 (posn-x-y): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6005
diff changeset
931 (defsubst posn-x-y (position)
4eb7f4633370 (posn-x-y): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6005
diff changeset
932 "Return the x and y coordinates in POSITION.
111905
0d5ab24d31df Doc fix for posn-* functions (Bug#7471).
Chong Yidong <cyd@stupidchicken.com>
parents: 111615
diff changeset
933 The return value has the form (X . Y), where X and Y are given in
0d5ab24d31df Doc fix for posn-* functions (Bug#7471).
Chong Yidong <cyd@stupidchicken.com>
parents: 111615
diff changeset
934 pixels. POSITION should be a list of the form returned by
0d5ab24d31df Doc fix for posn-* functions (Bug#7471).
Chong Yidong <cyd@stupidchicken.com>
parents: 111615
diff changeset
935 `event-start' and `event-end'."
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
936 (nth 2 position))
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
937
95841
b4e36ff621b3 Add some compiler declarations, for builds without X.
Glenn Morris <rgm@gnu.org>
parents: 95778
diff changeset
938 (declare-function scroll-bar-scale "scroll-bar" (num-denom whole))
b4e36ff621b3 Add some compiler declarations, for builds without X.
Glenn Morris <rgm@gnu.org>
parents: 95778
diff changeset
939
7636
83dba60657ef (posn-col-row): Do something useful for scroll bar event.
Richard M. Stallman <rms@gnu.org>
parents: 7615
diff changeset
940 (defun posn-col-row (position)
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
941 "Return the nominal column and row in POSITION, measured in characters.
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
942 The column and row values are approximations calculated from the x
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
943 and y coordinates in POSITION and the frame's default character width
53593
39793eabee87 (declare): New macro.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53518
diff changeset
944 and height.
7636
83dba60657ef (posn-col-row): Do something useful for scroll bar event.
Richard M. Stallman <rms@gnu.org>
parents: 7615
diff changeset
945 For a scroll-bar event, the result column is 0, and the row
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
946 corresponds to the vertical position of the click in the scroll bar.
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
947 POSITION should be a list of the form returned by the `event-start'
53593
39793eabee87 (declare): New macro.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53518
diff changeset
948 and `event-end' functions."
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
949 (let* ((pair (posn-x-y position))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
950 (window (posn-window position))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
951 (area (posn-area position)))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
952 (cond
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
953 ((null window)
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
954 '(0 . 0))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
955 ((eq area 'vertical-scroll-bar)
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
956 (cons 0 (scroll-bar-scale pair (1- (window-height window)))))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
957 ((eq area 'horizontal-scroll-bar)
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
958 (cons (scroll-bar-scale pair (window-width window)) 0))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
959 (t
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
960 (let* ((frame (if (framep window) window (window-frame window)))
102983
945567648555 * subr.el (posn-col-row): Properly compute line spacing.
Chong Yidong <cyd@stupidchicken.com>
parents: 102658
diff changeset
961 ;; FIXME: This should take line-spacing properties on
945567648555 * subr.el (posn-col-row): Properly compute line spacing.
Chong Yidong <cyd@stupidchicken.com>
parents: 102658
diff changeset
962 ;; newlines into account.
945567648555 * subr.el (posn-col-row): Properly compute line spacing.
Chong Yidong <cyd@stupidchicken.com>
parents: 102658
diff changeset
963 (spacing (when (display-graphic-p frame)
945567648555 * subr.el (posn-col-row): Properly compute line spacing.
Chong Yidong <cyd@stupidchicken.com>
parents: 102658
diff changeset
964 (or (with-current-buffer (window-buffer window)
945567648555 * subr.el (posn-col-row): Properly compute line spacing.
Chong Yidong <cyd@stupidchicken.com>
parents: 102658
diff changeset
965 line-spacing)
945567648555 * subr.el (posn-col-row): Properly compute line spacing.
Chong Yidong <cyd@stupidchicken.com>
parents: 102658
diff changeset
966 (frame-parameter frame 'line-spacing)))))
945567648555 * subr.el (posn-col-row): Properly compute line spacing.
Chong Yidong <cyd@stupidchicken.com>
parents: 102658
diff changeset
967 (cond ((floatp spacing)
945567648555 * subr.el (posn-col-row): Properly compute line spacing.
Chong Yidong <cyd@stupidchicken.com>
parents: 102658
diff changeset
968 (setq spacing (truncate (* spacing
945567648555 * subr.el (posn-col-row): Properly compute line spacing.
Chong Yidong <cyd@stupidchicken.com>
parents: 102658
diff changeset
969 (frame-char-height frame)))))
945567648555 * subr.el (posn-col-row): Properly compute line spacing.
Chong Yidong <cyd@stupidchicken.com>
parents: 102658
diff changeset
970 ((null spacing)
945567648555 * subr.el (posn-col-row): Properly compute line spacing.
Chong Yidong <cyd@stupidchicken.com>
parents: 102658
diff changeset
971 (setq spacing 0)))
945567648555 * subr.el (posn-col-row): Properly compute line spacing.
Chong Yidong <cyd@stupidchicken.com>
parents: 102658
diff changeset
972 (cons (/ (car pair) (frame-char-width frame))
111615
ab9aebf1b099 subr.el (posn-col-row): Pay attention to header line. (Bug#7390)
Eli Zaretskii <eliz@gnu.org>
parents: 110356
diff changeset
973 (- (/ (cdr pair) (+ (frame-char-height frame) spacing))
111944
9dc65348ace1 subr.el (posn-col-row): Evaluate header-line-format in the context of
Eli Zaretskii <eliz@gnu.org>
parents: 111936
diff changeset
974 (if (null (with-current-buffer (window-buffer window)
9dc65348ace1 subr.el (posn-col-row): Evaluate header-line-format in the context of
Eli Zaretskii <eliz@gnu.org>
parents: 111936
diff changeset
975 header-line-format))
9dc65348ace1 subr.el (posn-col-row): Evaluate header-line-format in the context of
Eli Zaretskii <eliz@gnu.org>
parents: 111936
diff changeset
976 0 1))))))))
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
977
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
978 (defun posn-actual-col-row (position)
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
979 "Return the actual column and row in POSITION, measured in characters.
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
980 These are the actual row number in the window and character number in that row.
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
981 Return nil if POSITION does not contain the actual position; in that case
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
982 `posn-col-row' can be used to get approximate values.
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
983 POSITION should be a list of the form returned by the `event-start'
53593
39793eabee87 (declare): New macro.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53518
diff changeset
984 and `event-end' functions."
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
985 (nth 6 position))
6039
4eb7f4633370 (posn-x-y): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6005
diff changeset
986
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
987 (defsubst posn-timestamp (position)
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
988 "Return the timestamp of POSITION.
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
989 POSITION should be a list of the form returned by the `event-start'
53593
39793eabee87 (declare): New macro.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53518
diff changeset
990 and `event-end' functions."
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
991 (nth 3 position))
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
992
53518
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
993 (defsubst posn-string (position)
70229
b85aa1663ba3 (posn-string, posn-image, posn-object): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 69978
diff changeset
994 "Return the string object of POSITION.
b85aa1663ba3 (posn-string, posn-image, posn-object): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 69978
diff changeset
995 Value is a cons (STRING . STRING-POS), or nil if not a string.
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
996 POSITION should be a list of the form returned by the `event-start'
53593
39793eabee87 (declare): New macro.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53518
diff changeset
997 and `event-end' functions."
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
998 (nth 4 position))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
999
53518
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
1000 (defsubst posn-image (position)
70229
b85aa1663ba3 (posn-string, posn-image, posn-object): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 69978
diff changeset
1001 "Return the image object of POSITION.
74085
7e5dd39ae47d (posn-image): Fix typo in docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 73943
diff changeset
1002 Value is a list (image ...), or nil if not an image.
53518
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
1003 POSITION should be a list of the form returned by the `event-start'
53593
39793eabee87 (declare): New macro.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53518
diff changeset
1004 and `event-end' functions."
53518
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
1005 (nth 7 position))
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
1006
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
1007 (defsubst posn-object (position)
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
1008 "Return the object (image or string) of POSITION.
70229
b85aa1663ba3 (posn-string, posn-image, posn-object): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 69978
diff changeset
1009 Value is a list (image ...) for an image object, a cons cell
b85aa1663ba3 (posn-string, posn-image, posn-object): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 69978
diff changeset
1010 \(STRING . STRING-POS) for a string object, and nil for a buffer position.
53518
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
1011 POSITION should be a list of the form returned by the `event-start'
53593
39793eabee87 (declare): New macro.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53518
diff changeset
1012 and `event-end' functions."
53518
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
1013 (or (posn-image position) (posn-string position)))
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
1014
53181
8337e648c2b3 (posn-object-x-y): New defun.
Kim F. Storm <storm@cua.dk>
parents: 53174
diff changeset
1015 (defsubst posn-object-x-y (position)
8337e648c2b3 (posn-object-x-y): New defun.
Kim F. Storm <storm@cua.dk>
parents: 53174
diff changeset
1016 "Return the x and y coordinates relative to the object of POSITION.
111905
0d5ab24d31df Doc fix for posn-* functions (Bug#7471).
Chong Yidong <cyd@stupidchicken.com>
parents: 111615
diff changeset
1017 The return value has the form (DX . DY), where DX and DY are
0d5ab24d31df Doc fix for posn-* functions (Bug#7471).
Chong Yidong <cyd@stupidchicken.com>
parents: 111615
diff changeset
1018 given in pixels. POSITION should be a list of the form returned
0d5ab24d31df Doc fix for posn-* functions (Bug#7471).
Chong Yidong <cyd@stupidchicken.com>
parents: 111615
diff changeset
1019 by `event-start' and `event-end'."
53518
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
1020 (nth 8 position))
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
1021
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
1022 (defsubst posn-object-width-height (position)
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
1023 "Return the pixel width and height of the object of POSITION.
111905
0d5ab24d31df Doc fix for posn-* functions (Bug#7471).
Chong Yidong <cyd@stupidchicken.com>
parents: 111615
diff changeset
1024 The return value has the form (WIDTH . HEIGHT). POSITION should
0d5ab24d31df Doc fix for posn-* functions (Bug#7471).
Chong Yidong <cyd@stupidchicken.com>
parents: 111615
diff changeset
1025 be a list of the form returned by `event-start' and `event-end'."
53518
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
1026 (nth 9 position))
53181
8337e648c2b3 (posn-object-x-y): New defun.
Kim F. Storm <storm@cua.dk>
parents: 53174
diff changeset
1027
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
1028
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1029 ;;;; Obsolescent names for functions.
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1030
105364
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1031 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1032 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1033 (define-obsolete-function-alias 'read-input 'read-string "22.1")
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1034 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1035 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1036 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1037
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1038 (make-obsolete 'char-bytes "now always returns 1." "20.4")
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1039 (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1")
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1040
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1041 (defun insert-string (&rest args)
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1042 "Mocklisp-compatibility insert function.
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1043 Like the function `insert' except that any argument that is a number
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1044 is converted into a string by expressing it in decimal."
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1045 (dolist (el args)
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1046 (insert (if (integerp el) (number-to-string el) el))))
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1047 (make-obsolete 'insert-string 'insert "22.1")
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1048
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1049 (defun makehash (&optional test) (make-hash-table :test (or test 'eql)))
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1050 (make-obsolete 'makehash 'make-hash-table "22.1")
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1051
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1052 ;; These are used by VM and some old programs
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1053 (defalias 'focus-frame 'ignore "")
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1054 (make-obsolete 'focus-frame "it does nothing." "22.1")
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1055 (defalias 'unfocus-frame 'ignore "")
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1056 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1057 (make-obsolete 'make-variable-frame-local
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1058 "explicitly check for a frame-parameter instead." "22.2")
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1059 (make-obsolete 'interactive-p 'called-interactively-p "23.2")
110356
d2f5496377e6 * subr.el (unintern): Declare the obarray arg mandatory.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109943
diff changeset
1060 (set-advertised-calling-convention 'called-interactively-p '(kind) "23.1")
105763
5041ae86859e (all-completions): Declare the 4th arg obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105681
diff changeset
1061 (set-advertised-calling-convention
110356
d2f5496377e6 * subr.el (unintern): Declare the obarray arg mandatory.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109943
diff changeset
1062 'all-completions '(string collection &optional predicate) "23.1")
d2f5496377e6 * subr.el (unintern): Declare the obarray arg mandatory.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109943
diff changeset
1063 (set-advertised-calling-convention 'unintern '(name obarray) "23.3")
105364
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1064
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1065 ;;;; Obsolescence declarations for variables, and aliases.
338d102432df * eval.c (Fcalled_interactively_p): Add `kind' argument.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105317
diff changeset
1066
104626
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1067 ;; Special "default-FOO" variables which contain the default value of
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1068 ;; the "FOO" variable are nasty. Their implementation is brittle, and
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1069 ;; slows down several unrelated variable operations; furthermore, they
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1070 ;; can lead to really odd behavior if you decide to make them
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1071 ;; buffer-local.
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1072
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1073 ;; Not used at all in Emacs, last time I checked:
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1074 (make-obsolete-variable 'default-mode-line-format 'mode-line-format "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1075 (make-obsolete-variable 'default-header-line-format 'header-line-format "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1076 (make-obsolete-variable 'default-line-spacing 'line-spacing "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1077 (make-obsolete-variable 'default-abbrev-mode 'abbrev-mode "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1078 (make-obsolete-variable 'default-ctl-arrow 'ctl-arrow "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1079 (make-obsolete-variable 'default-direction-reversed 'direction-reversed "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1080 (make-obsolete-variable 'default-truncate-lines 'truncate-lines "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1081 (make-obsolete-variable 'default-left-margin 'left-margin "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1082 (make-obsolete-variable 'default-tab-width 'tab-width "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1083 (make-obsolete-variable 'default-case-fold-search 'case-fold-search "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1084 (make-obsolete-variable 'default-left-margin-width 'left-margin-width "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1085 (make-obsolete-variable 'default-right-margin-width 'right-margin-width "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1086 (make-obsolete-variable 'default-left-fringe-width 'left-fringe-width "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1087 (make-obsolete-variable 'default-right-fringe-width 'right-fringe-width "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1088 (make-obsolete-variable 'default-fringes-outside-margins 'fringes-outside-margins "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1089 (make-obsolete-variable 'default-scroll-bar-width 'scroll-bar-width "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1090 (make-obsolete-variable 'default-vertical-scroll-bar 'vertical-scroll-bar "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1091 (make-obsolete-variable 'default-indicate-empty-lines 'indicate-empty-lines "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1092 (make-obsolete-variable 'default-indicate-buffer-boundaries 'indicate-buffer-boundaries "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1093 (make-obsolete-variable 'default-fringe-indicator-alist 'fringe-indicator-alist "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1094 (make-obsolete-variable 'default-fringe-cursor-alist 'fringe-cursor-alist "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1095 (make-obsolete-variable 'default-scroll-up-aggressively 'scroll-up-aggressively "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1096 (make-obsolete-variable 'default-scroll-down-aggressively 'scroll-down-aggressively "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1097 (make-obsolete-variable 'default-fill-column 'fill-column "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1098 (make-obsolete-variable 'default-cursor-type 'cursor-type "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1099 (make-obsolete-variable 'default-buffer-file-type 'buffer-file-type "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1100 (make-obsolete-variable 'default-cursor-in-non-selected-windows 'cursor-in-non-selected-windows "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1101 (make-obsolete-variable 'default-buffer-file-coding-system 'buffer-file-coding-system "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1102 (make-obsolete-variable 'default-major-mode 'major-mode "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1103 (make-obsolete-variable 'default-enable-multibyte-characters
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1104 "use enable-multibyte-characters or set-buffer-multibyte instead" "23.2")
caa79498564a * subr.el (default-mode-line-format, default-header-line-format)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104368
diff changeset
1105
104920
566d2dc55a9d * keyboard.c (Qmenu_alias, Vdefine_key_rebound_commands): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104880
diff changeset
1106 (make-obsolete-variable 'define-key-rebound-commands nil "23.2")
93200
c264aa814b15 (redisplay-end-trigger-functions, window-redisplay-end-trigger)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92948
diff changeset
1107 (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1")
c264aa814b15 (redisplay-end-trigger-functions, window-redisplay-end-trigger)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92948
diff changeset
1108 (make-obsolete 'window-redisplay-end-trigger nil "23.1")
c264aa814b15 (redisplay-end-trigger-functions, window-redisplay-end-trigger)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92948
diff changeset
1109 (make-obsolete 'set-window-redisplay-end-trigger nil "23.1")
c264aa814b15 (redisplay-end-trigger-functions, window-redisplay-end-trigger)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92948
diff changeset
1110
c264aa814b15 (redisplay-end-trigger-functions, window-redisplay-end-trigger)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92948
diff changeset
1111 (make-obsolete 'process-filter-multibyte-p nil "23.1")
c264aa814b15 (redisplay-end-trigger-functions, window-redisplay-end-trigger)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92948
diff changeset
1112 (make-obsolete 'set-process-filter-multibyte nil "23.1")
c264aa814b15 (redisplay-end-trigger-functions, window-redisplay-end-trigger)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 92948
diff changeset
1113
46537
46f175ecf5d4 (unread-command-char, executing-macro, post-command-idle-hook,
Juanma Barranquero <lekktu@gmail.com>
parents: 46532
diff changeset
1114 (make-obsolete-variable 'directory-sep-char "do not use it." "21.1")
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1115 (make-obsolete-variable
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1116 'mode-line-inverse-video
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1117 "use the appropriate faces instead."
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1118 "21.1")
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1119 (make-obsolete-variable
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1120 'unread-command-char
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1121 "use `unread-command-events' instead. That variable is a list of events
74597
ee63ac76eb51 (unread-command-char): Reflow obsolescence info.
Juanma Barranquero <lekktu@gmail.com>
parents: 74242
diff changeset
1122 to reread, so it now uses nil to mean `no event', instead of -1."
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1123 "before 19.15")
46537
46f175ecf5d4 (unread-command-char, executing-macro, post-command-idle-hook,
Juanma Barranquero <lekktu@gmail.com>
parents: 46532
diff changeset
1124
62015
e208ebaf0e17 (executing-macro): Use `define-obsolete-variable-alias'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61996
diff changeset
1125 ;; Lisp manual only updated in 22.1.
e208ebaf0e17 (executing-macro): Use `define-obsolete-variable-alias'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61996
diff changeset
1126 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1127 "before 19.34")
62015
e208ebaf0e17 (executing-macro): Use `define-obsolete-variable-alias'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61996
diff changeset
1128
57778
82ed9ce364a7 (x-lost-selection-hooks, x-sent-selection-hooks): New obsolete aliases
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57689
diff changeset
1129 (defvaralias 'x-lost-selection-hooks 'x-lost-selection-functions)
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1130 (make-obsolete-variable 'x-lost-selection-hooks
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1131 'x-lost-selection-functions "22.1")
57778
82ed9ce364a7 (x-lost-selection-hooks, x-sent-selection-hooks): New obsolete aliases
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57689
diff changeset
1132 (defvaralias 'x-sent-selection-hooks 'x-sent-selection-functions)
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1133 (make-obsolete-variable 'x-sent-selection-hooks
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1134 'x-sent-selection-functions "22.1")
59124
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1135
102032
5ff1f67594ee (translation-table-for-input): Declare obsolete again.
Eli Zaretskii <eliz@gnu.org>
parents: 102010
diff changeset
1136 ;; This was introduced in 21.4 for pre-unicode unification. That
5ff1f67594ee (translation-table-for-input): Declare obsolete again.
Eli Zaretskii <eliz@gnu.org>
parents: 102010
diff changeset
1137 ;; usage was rendered obsolete in 23.1 which uses Unicode internally.
5ff1f67594ee (translation-table-for-input): Declare obsolete again.
Eli Zaretskii <eliz@gnu.org>
parents: 102010
diff changeset
1138 ;; Other uses are possible, so this variable is not _really_ obsolete,
5ff1f67594ee (translation-table-for-input): Declare obsolete again.
Eli Zaretskii <eliz@gnu.org>
parents: 102010
diff changeset
1139 ;; but Stefan insists to mark it so.
5ff1f67594ee (translation-table-for-input): Declare obsolete again.
Eli Zaretskii <eliz@gnu.org>
parents: 102010
diff changeset
1140 (make-obsolete-variable 'translation-table-for-input nil "23.1")
5ff1f67594ee (translation-table-for-input): Declare obsolete again.
Eli Zaretskii <eliz@gnu.org>
parents: 102010
diff changeset
1141
59124
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1142 (defvaralias 'messages-buffer-max-lines 'message-log-max)
100997
0e99f90c4347 (last-input-char, last-command-char): Move here from src/keyboard.c.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
1143
0e99f90c4347 (last-input-char, last-command-char): Move here from src/keyboard.c.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
1144 ;; These aliases exist in Emacs 19.34, and probably before, but were
0e99f90c4347 (last-input-char, last-command-char): Move here from src/keyboard.c.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
1145 ;; only marked as obsolete in 23.1.
101082
a69b4c107ea4 Comment (fix typo).
Glenn Morris <rgm@gnu.org>
parents: 100997
diff changeset
1146 ;; The lisp manual (since at least Emacs 21) describes them as
100997
0e99f90c4347 (last-input-char, last-command-char): Move here from src/keyboard.c.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
1147 ;; existing "for compatibility with Emacs version 18".
0e99f90c4347 (last-input-char, last-command-char): Move here from src/keyboard.c.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
1148 (define-obsolete-variable-alias 'last-input-char 'last-input-event
0e99f90c4347 (last-input-char, last-command-char): Move here from src/keyboard.c.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
1149 "at least 19.34")
0e99f90c4347 (last-input-char, last-command-char): Move here from src/keyboard.c.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
1150 (define-obsolete-variable-alias 'last-command-char 'last-command-event
0e99f90c4347 (last-input-char, last-command-char): Move here from src/keyboard.c.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
1151 "at least 19.34")
0e99f90c4347 (last-input-char, last-command-char): Move here from src/keyboard.c.
Glenn Morris <rgm@gnu.org>
parents: 100908
diff changeset
1152
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1153
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1154 ;;;; Alternate names for functions - these are not being phased out.
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1155
62542
3f80c5cf6771 (send-string, send-region): Remove obsolescence declaration.
Juanma Barranquero <lekktu@gmail.com>
parents: 62524
diff changeset
1156 (defalias 'send-string 'process-send-string)
3f80c5cf6771 (send-string, send-region): Remove obsolescence declaration.
Juanma Barranquero <lekktu@gmail.com>
parents: 62524
diff changeset
1157 (defalias 'send-region 'process-send-region)
2569
39ad4eda7fea All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2504
diff changeset
1158 (defalias 'string= 'string-equal)
39ad4eda7fea All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2504
diff changeset
1159 (defalias 'string< 'string-lessp)
39ad4eda7fea All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2504
diff changeset
1160 (defalias 'move-marker 'set-marker)
39ad4eda7fea All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2504
diff changeset
1161 (defalias 'rplaca 'setcar)
39ad4eda7fea All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2504
diff changeset
1162 (defalias 'rplacd 'setcdr)
3591
507f64624555 Apply typo patches from Paul Eggert.
Jim Blandy <jimb@redhat.com>
parents: 3411
diff changeset
1163 (defalias 'beep 'ding) ;preserve lingual purity
2569
39ad4eda7fea All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2504
diff changeset
1164 (defalias 'indent-to-column 'indent-to)
39ad4eda7fea All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2504
diff changeset
1165 (defalias 'backward-delete-char 'delete-backward-char)
39ad4eda7fea All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2504
diff changeset
1166 (defalias 'search-forward-regexp (symbol-function 're-search-forward))
39ad4eda7fea All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2504
diff changeset
1167 (defalias 'search-backward-regexp (symbol-function 're-search-backward))
39ad4eda7fea All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2504
diff changeset
1168 (defalias 'int-to-string 'number-to-string)
21173
e917eb0d4e01 (save-match-data): store-match-data => set-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 21092
diff changeset
1169 (defalias 'store-match-data 'set-match-data)
100676
5478b71d59c6 * subr.el (chmod): New defalias for set-file-modes.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 100388
diff changeset
1170 (defalias 'chmod 'set-file-modes)
100751
2935e76b69a8 (mkdir): New defalias.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 100699
diff changeset
1171 (defalias 'mkdir 'make-directory)
31563
96b9757bfd45 (add-minor-mode): Use toggle-fun arg.
Dave Love <fx@gnu.org>
parents: 30515
diff changeset
1172 ;; These are the XEmacs names:
25293
fd43e1a99384 (point-at-eol, point-at-bol): New aliases.
Karl Heuer <kwzh@gnu.org>
parents: 25140
diff changeset
1173 (defalias 'point-at-eol 'line-end-position)
fd43e1a99384 (point-at-eol, point-at-bol): New aliases.
Karl Heuer <kwzh@gnu.org>
parents: 25140
diff changeset
1174 (defalias 'point-at-bol 'line-beginning-position)
1903
87f63305319f * subr.el (string-to-int): Make this an alias for
Jim Blandy <jimb@redhat.com>
parents: 1867
diff changeset
1175
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1176 (defalias 'user-original-login-name 'user-login-name)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1177
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
1178
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1179 ;;;; Hook manipulation functions.
388
498bcec1cf3a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 384
diff changeset
1180
9195
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1181 (defun make-local-hook (hook)
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1182 "Make the hook HOOK local to the current buffer.
23786
673204d56938 (make-local-hook): Return the hook variable.
Richard M. Stallman <rms@gnu.org>
parents: 23736
diff changeset
1183 The return value is HOOK.
673204d56938 (make-local-hook): Return the hook variable.
Richard M. Stallman <rms@gnu.org>
parents: 23736
diff changeset
1184
33707
2b9847c18f31 (make-local-hook): Docstring fix.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 32355
diff changeset
1185 You never need to call this function now that `add-hook' does it for you
2b9847c18f31 (make-local-hook): Docstring fix.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 32355
diff changeset
1186 if its LOCAL argument is non-nil.
2b9847c18f31 (make-local-hook): Docstring fix.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 32355
diff changeset
1187
9195
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1188 When a hook is local, its local and global values
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1189 work in concert: running the hook actually runs all the hook
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1190 functions listed in *either* the local value *or* the global value
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1191 of the hook variable.
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1192
39557
fb85410efef7 (define-key-after): Allow `key' to be longer than 1.
Gerd Moellmann <gerd@gnu.org>
parents: 38760
diff changeset
1193 This function works by making t a member of the buffer-local value,
12258
95ebca0a74d8 (make-local-hook): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12108
diff changeset
1194 which acts as a flag to run the hook functions in the default value as
95ebca0a74d8 (make-local-hook): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12108
diff changeset
1195 well. This works for all normal hooks, but does not work for most
95ebca0a74d8 (make-local-hook): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12108
diff changeset
1196 non-normal hooks yet. We will be changing the callers of non-normal
95ebca0a74d8 (make-local-hook): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12108
diff changeset
1197 hooks so that they can handle localness; this has to be done one by
95ebca0a74d8 (make-local-hook): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12108
diff changeset
1198 one.
95ebca0a74d8 (make-local-hook): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12108
diff changeset
1199
95ebca0a74d8 (make-local-hook): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12108
diff changeset
1200 This function does nothing if HOOK is already local in the current
95ebca0a74d8 (make-local-hook): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12108
diff changeset
1201 buffer.
9195
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1202
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1203 Do not use `make-local-variable' to make a hook variable buffer-local."
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1204 (if (local-variable-p hook)
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1205 nil
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1206 (or (boundp hook) (set hook nil))
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1207 (make-local-variable hook)
23786
673204d56938 (make-local-hook): Return the hook variable.
Richard M. Stallman <rms@gnu.org>
parents: 23736
diff changeset
1208 (set hook (list t)))
673204d56938 (make-local-hook): Return the hook variable.
Richard M. Stallman <rms@gnu.org>
parents: 23736
diff changeset
1209 hook)
46052
4d27fe417297 (char-bytes): Fix obsolescence declaration.
Juanma Barranquero <lekktu@gmail.com>
parents: 45978
diff changeset
1210 (make-obsolete 'make-local-hook "not necessary any more." "21.1")
9195
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1211
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1212 (defun add-hook (hook function &optional append local)
4414
3356419b94c1 (add-hook): Change a single function into a list.
Richard M. Stallman <rms@gnu.org>
parents: 4235
diff changeset
1213 "Add to the value of HOOK the function FUNCTION.
3356419b94c1 (add-hook): Change a single function into a list.
Richard M. Stallman <rms@gnu.org>
parents: 4235
diff changeset
1214 FUNCTION is not added if already present.
3356419b94c1 (add-hook): Change a single function into a list.
Richard M. Stallman <rms@gnu.org>
parents: 4235
diff changeset
1215 FUNCTION is added (if necessary) at the beginning of the hook list
3356419b94c1 (add-hook): Change a single function into a list.
Richard M. Stallman <rms@gnu.org>
parents: 4235
diff changeset
1216 unless the optional argument APPEND is non-nil, in which case
3356419b94c1 (add-hook): Change a single function into a list.
Richard M. Stallman <rms@gnu.org>
parents: 4235
diff changeset
1217 FUNCTION is added at the end.
3356419b94c1 (add-hook): Change a single function into a list.
Richard M. Stallman <rms@gnu.org>
parents: 4235
diff changeset
1218
9195
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1219 The optional fourth argument, LOCAL, if non-nil, says to modify
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1220 the hook's buffer-local value rather than its default value.
43435
c7aaafe7f385 (add-hook): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 43158
diff changeset
1221 This makes the hook buffer-local if needed, and it makes t a member
c7aaafe7f385 (add-hook): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 43158
diff changeset
1222 of the buffer-local value. That acts as a flag to run the hook
c7aaafe7f385 (add-hook): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 43158
diff changeset
1223 functions in the default value as well as in the local value.
9195
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1224
4414
3356419b94c1 (add-hook): Change a single function into a list.
Richard M. Stallman <rms@gnu.org>
parents: 4235
diff changeset
1225 HOOK should be a symbol, and FUNCTION may be any valid function. If
3356419b94c1 (add-hook): Change a single function into a list.
Richard M. Stallman <rms@gnu.org>
parents: 4235
diff changeset
1226 HOOK is void, it is first set to nil. If HOOK's value is a single
8959
d33302427a47 (remove-hook, add-hook): Copy existing list before modifying.
Richard M. Stallman <rms@gnu.org>
parents: 8928
diff changeset
1227 function, it is changed to a list of functions."
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
1228 (or (boundp hook) (set hook nil))
9195
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1229 (or (default-boundp hook) (set-default hook nil))
39557
fb85410efef7 (define-key-after): Allow `key' to be longer than 1.
Gerd Moellmann <gerd@gnu.org>
parents: 38760
diff changeset
1230 (if local (unless (local-variable-if-set-p hook)
fb85410efef7 (define-key-after): Allow `key' to be longer than 1.
Gerd Moellmann <gerd@gnu.org>
parents: 38760
diff changeset
1231 (set (make-local-variable hook) (list t)))
28863
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1232 ;; Detect the case where make-local-variable was used on a hook
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1233 ;; and do what we used to do.
52987
ac21698ba968 (add-hook): Fix last change.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52896
diff changeset
1234 (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook)))
28863
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1235 (setq local t)))
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1236 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1237 ;; If the hook value is a single function, turn it into a list.
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1238 (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
28940
2a91228f7aa3 (add-hook): setq hook-value, not set
Sam Steingold <sds@gnu.org>
parents: 28868
diff changeset
1239 (setq hook-value (list hook-value)))
28863
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1240 ;; Do the actual addition if necessary
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1241 (unless (member function hook-value)
105944
a465c7c7e59e * subr.el (add-hook): Purecopy strings.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 105940
diff changeset
1242 (when (stringp function)
a465c7c7e59e * subr.el (add-hook): Purecopy strings.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 105940
diff changeset
1243 (setq function (purecopy function)))
28863
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1244 (setq hook-value
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1245 (if append
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1246 (append hook-value (list function))
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1247 (cons function hook-value))))
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1248 ;; Set the actual variable
87974
97c3cc0a167b (add-hook): Implement `permanent-local-hook' property.
Richard M. Stallman <rms@gnu.org>
parents: 87903
diff changeset
1249 (if local
97c3cc0a167b (add-hook): Implement `permanent-local-hook' property.
Richard M. Stallman <rms@gnu.org>
parents: 87903
diff changeset
1250 (progn
97c3cc0a167b (add-hook): Implement `permanent-local-hook' property.
Richard M. Stallman <rms@gnu.org>
parents: 87903
diff changeset
1251 ;; If HOOK isn't a permanent local,
97c3cc0a167b (add-hook): Implement `permanent-local-hook' property.
Richard M. Stallman <rms@gnu.org>
parents: 87903
diff changeset
1252 ;; but FUNCTION wants to survive a change of modes,
97c3cc0a167b (add-hook): Implement `permanent-local-hook' property.
Richard M. Stallman <rms@gnu.org>
parents: 87903
diff changeset
1253 ;; mark HOOK as partially permanent.
97c3cc0a167b (add-hook): Implement `permanent-local-hook' property.
Richard M. Stallman <rms@gnu.org>
parents: 87903
diff changeset
1254 (and (symbolp function)
97c3cc0a167b (add-hook): Implement `permanent-local-hook' property.
Richard M. Stallman <rms@gnu.org>
parents: 87903
diff changeset
1255 (get function 'permanent-local-hook)
97c3cc0a167b (add-hook): Implement `permanent-local-hook' property.
Richard M. Stallman <rms@gnu.org>
parents: 87903
diff changeset
1256 (not (get hook 'permanent-local))
97c3cc0a167b (add-hook): Implement `permanent-local-hook' property.
Richard M. Stallman <rms@gnu.org>
parents: 87903
diff changeset
1257 (put hook 'permanent-local 'permanent-local-hook))
97c3cc0a167b (add-hook): Implement `permanent-local-hook' property.
Richard M. Stallman <rms@gnu.org>
parents: 87903
diff changeset
1258 (set hook hook-value))
97c3cc0a167b (add-hook): Implement `permanent-local-hook' property.
Richard M. Stallman <rms@gnu.org>
parents: 87903
diff changeset
1259 (set-default hook hook-value))))
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1260
9195
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1261 (defun remove-hook (hook function &optional local)
4964
78c13f3054e5 (remove-hook): New function, analogous to add-hook. This
Richard M. Stallman <rms@gnu.org>
parents: 4767
diff changeset
1262 "Remove from the value of HOOK the function FUNCTION.
78c13f3054e5 (remove-hook): New function, analogous to add-hook. This
Richard M. Stallman <rms@gnu.org>
parents: 4767
diff changeset
1263 HOOK should be a symbol, and FUNCTION may be any valid function. If
78c13f3054e5 (remove-hook): New function, analogous to add-hook. This
Richard M. Stallman <rms@gnu.org>
parents: 4767
diff changeset
1264 FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
9195
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1265 list of hooks to run in HOOK, then nothing is done. See `add-hook'.
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1266
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1267 The optional third argument, LOCAL, if non-nil, says to modify
52896
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1268 the hook's buffer-local value rather than its default value."
28863
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1269 (or (boundp hook) (set hook nil))
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1270 (or (default-boundp hook) (set-default hook nil))
52896
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1271 ;; Do nothing if LOCAL is t but this hook has no local binding.
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1272 (unless (and local (not (local-variable-p hook)))
28863
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1273 ;; Detect the case where make-local-variable was used on a hook
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1274 ;; and do what we used to do.
52896
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1275 (when (and (local-variable-p hook)
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1276 (not (and (consp (symbol-value hook))
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1277 (memq t (symbol-value hook)))))
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1278 (setq local t))
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1279 (let ((hook-value (if local (symbol-value hook) (default-value hook))))
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1280 ;; Remove the function, for both the list and the non-list cases.
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1281 (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda))
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1282 (if (equal hook-value function) (setq hook-value nil))
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1283 (setq hook-value (delete function (copy-sequence hook-value))))
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1284 ;; If the function is on the global hook, we need to shadow it locally
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1285 ;;(when (and local (member function (default-value hook))
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1286 ;; (not (member (cons 'not function) hook-value)))
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1287 ;; (push (cons 'not function) hook-value))
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1288 ;; Set the actual variable
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1289 (if (not local)
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1290 (set-default hook hook-value)
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1291 (if (equal hook-value '(t))
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1292 (kill-local-variable hook)
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1293 (set hook hook-value))))))
9510
f03544494d1c (add-to-list): New function.
Richard M. Stallman <rms@gnu.org>
parents: 9202
diff changeset
1294
72784
3f19250c6e68 (add-to-list): New argument COMPARE-FN.
Richard M. Stallman <rms@gnu.org>
parents: 72138
diff changeset
1295 (defun add-to-list (list-var element &optional append compare-fn)
63797
7f964f8f5c85 (add-to-list, add-to-ordered-list): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63761
diff changeset
1296 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
72784
3f19250c6e68 (add-to-list): New argument COMPARE-FN.
Richard M. Stallman <rms@gnu.org>
parents: 72138
diff changeset
1297 The test for presence of ELEMENT is done with `equal',
3f19250c6e68 (add-to-list): New argument COMPARE-FN.
Richard M. Stallman <rms@gnu.org>
parents: 72138
diff changeset
1298 or with COMPARE-FN if that's non-nil.
32355
6bf2ae19e286 (add-to-list): Add optional argument APPEND.
Miles Bader <miles@gnu.org>
parents: 32131
diff changeset
1299 If ELEMENT is added, it is added at the beginning of the list,
6bf2ae19e286 (add-to-list): Add optional argument APPEND.
Miles Bader <miles@gnu.org>
parents: 32131
diff changeset
1300 unless the optional argument APPEND is non-nil, in which case
6bf2ae19e286 (add-to-list): Add optional argument APPEND.
Miles Bader <miles@gnu.org>
parents: 32131
diff changeset
1301 ELEMENT is added at the end.
24757
f4127409d184 (add-to-list): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 24699
diff changeset
1302
43833
37bc1e73d4b3 (add-to-list): Doc fix.
Pavel Janík <Pavel@Janik.cz>
parents: 43527
diff changeset
1303 The return value is the new value of LIST-VAR.
37bc1e73d4b3 (add-to-list): Doc fix.
Pavel Janík <Pavel@Janik.cz>
parents: 43527
diff changeset
1304
9535
a2908d5da32a (add-to-list): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 9510
diff changeset
1305 If you want to use `add-to-list' on a variable that is not defined
a2908d5da32a (add-to-list): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 9510
diff changeset
1306 until a certain package is loaded, you should put the call to `add-to-list'
a2908d5da32a (add-to-list): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 9510
diff changeset
1307 into a hook function that will be run only after loading the package.
a2908d5da32a (add-to-list): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 9510
diff changeset
1308 `eval-after-load' provides one way to do this. In some cases
a2908d5da32a (add-to-list): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 9510
diff changeset
1309 other hooks, such as major mode hooks, can do the job."
73465
03050ee24abc (add-to-list): Optimize if compare-fn is `eq' or `eql'.
Kim F. Storm <storm@cua.dk>
parents: 73415
diff changeset
1310 (if (cond
73466
c470e5e21c36 (add-to-list): Fix last change--optimize for no compare-fn.
Kim F. Storm <storm@cua.dk>
parents: 73465
diff changeset
1311 ((null compare-fn)
c470e5e21c36 (add-to-list): Fix last change--optimize for no compare-fn.
Kim F. Storm <storm@cua.dk>
parents: 73465
diff changeset
1312 (member element (symbol-value list-var)))
73465
03050ee24abc (add-to-list): Optimize if compare-fn is `eq' or `eql'.
Kim F. Storm <storm@cua.dk>
parents: 73415
diff changeset
1313 ((eq compare-fn 'eq)
03050ee24abc (add-to-list): Optimize if compare-fn is `eq' or `eql'.
Kim F. Storm <storm@cua.dk>
parents: 73415
diff changeset
1314 (memq element (symbol-value list-var)))
03050ee24abc (add-to-list): Optimize if compare-fn is `eq' or `eql'.
Kim F. Storm <storm@cua.dk>
parents: 73415
diff changeset
1315 ((eq compare-fn 'eql)
03050ee24abc (add-to-list): Optimize if compare-fn is `eq' or `eql'.
Kim F. Storm <storm@cua.dk>
parents: 73415
diff changeset
1316 (memql element (symbol-value list-var)))
73466
c470e5e21c36 (add-to-list): Fix last change--optimize for no compare-fn.
Kim F. Storm <storm@cua.dk>
parents: 73465
diff changeset
1317 (t
73555
3f351640d09f (add-to-list): Don't continue checking if a match has
David Kastrup <dak@gnu.org>
parents: 73466
diff changeset
1318 (let ((lst (symbol-value list-var)))
3f351640d09f (add-to-list): Don't continue checking if a match has
David Kastrup <dak@gnu.org>
parents: 73466
diff changeset
1319 (while (and lst
3f351640d09f (add-to-list): Don't continue checking if a match has
David Kastrup <dak@gnu.org>
parents: 73466
diff changeset
1320 (not (funcall compare-fn element (car lst))))
3f351640d09f (add-to-list): Don't continue checking if a match has
David Kastrup <dak@gnu.org>
parents: 73466
diff changeset
1321 (setq lst (cdr lst)))
3f351640d09f (add-to-list): Don't continue checking if a match has
David Kastrup <dak@gnu.org>
parents: 73466
diff changeset
1322 lst)))
21409
3e8b7782f4f5 (add-to-list): Always return updated value of LIST-VAR.
Karl Heuer <kwzh@gnu.org>
parents: 21173
diff changeset
1323 (symbol-value list-var)
32355
6bf2ae19e286 (add-to-list): Add optional argument APPEND.
Miles Bader <miles@gnu.org>
parents: 32131
diff changeset
1324 (set list-var
6bf2ae19e286 (add-to-list): Add optional argument APPEND.
Miles Bader <miles@gnu.org>
parents: 32131
diff changeset
1325 (if append
6bf2ae19e286 (add-to-list): Add optional argument APPEND.
Miles Bader <miles@gnu.org>
parents: 32131
diff changeset
1326 (append (symbol-value list-var) (list element))
6bf2ae19e286 (add-to-list): Add optional argument APPEND.
Miles Bader <miles@gnu.org>
parents: 32131
diff changeset
1327 (cons element (symbol-value list-var))))))
39725
c64d3e3adf5d (symbol-file-load-history-loaded)
Miles Bader <miles@gnu.org>
parents: 39598
diff changeset
1328
63387
5b9f98f257f8 (add-to-ordered-list): New defun.
Kim F. Storm <storm@cua.dk>
parents: 63381
diff changeset
1329
5b9f98f257f8 (add-to-ordered-list): New defun.
Kim F. Storm <storm@cua.dk>
parents: 63381
diff changeset
1330 (defun add-to-ordered-list (list-var element &optional order)
63797
7f964f8f5c85 (add-to-list, add-to-ordered-list): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63761
diff changeset
1331 "Add ELEMENT to the value of LIST-VAR if it isn't there yet.
63605
99743da5284f (add-to-ordered-list): Test membership with eq. Simplify.
Kim F. Storm <storm@cua.dk>
parents: 63472
diff changeset
1332 The test for presence of ELEMENT is done with `eq'.
63387
5b9f98f257f8 (add-to-ordered-list): New defun.
Kim F. Storm <storm@cua.dk>
parents: 63381
diff changeset
1333
5b9f98f257f8 (add-to-ordered-list): New defun.
Kim F. Storm <storm@cua.dk>
parents: 63381
diff changeset
1334 The resulting list is reordered so that the elements are in the
63605
99743da5284f (add-to-ordered-list): Test membership with eq. Simplify.
Kim F. Storm <storm@cua.dk>
parents: 63472
diff changeset
1335 order given by each element's numeric list order. Elements
99743da5284f (add-to-ordered-list): Test membership with eq. Simplify.
Kim F. Storm <storm@cua.dk>
parents: 63472
diff changeset
1336 without a numeric list order are placed at the end of the list.
63387
5b9f98f257f8 (add-to-ordered-list): New defun.
Kim F. Storm <storm@cua.dk>
parents: 63381
diff changeset
1337
63797
7f964f8f5c85 (add-to-list, add-to-ordered-list): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63761
diff changeset
1338 If the third optional argument ORDER is a number (integer or
7f964f8f5c85 (add-to-list, add-to-ordered-list): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63761
diff changeset
1339 float), set the element's list order to the given value. If
7f964f8f5c85 (add-to-list, add-to-ordered-list): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63761
diff changeset
1340 ORDER is nil or omitted, do not change the numeric order of
7f964f8f5c85 (add-to-list, add-to-ordered-list): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63761
diff changeset
1341 ELEMENT. If ORDER has any other value, remove the numeric order
7f964f8f5c85 (add-to-list, add-to-ordered-list): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63761
diff changeset
1342 of ELEMENT if it has one.
63396
18169bc4f438 (add-to-ordered-list): Rework to use list-order property of list-var.
Kim F. Storm <storm@cua.dk>
parents: 63387
diff changeset
1343
63472
a89b059224fb (add-to-ordered-list): Use a weak hash-table to avoid leaks.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63396
diff changeset
1344 The list order for each element is stored in LIST-VAR's
63396
18169bc4f438 (add-to-ordered-list): Rework to use list-order property of list-var.
Kim F. Storm <storm@cua.dk>
parents: 63387
diff changeset
1345 `list-order' property.
63387
5b9f98f257f8 (add-to-ordered-list): New defun.
Kim F. Storm <storm@cua.dk>
parents: 63381
diff changeset
1346
5b9f98f257f8 (add-to-ordered-list): New defun.
Kim F. Storm <storm@cua.dk>
parents: 63381
diff changeset
1347 The return value is the new value of LIST-VAR."
63472
a89b059224fb (add-to-ordered-list): Use a weak hash-table to avoid leaks.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63396
diff changeset
1348 (let ((ordering (get list-var 'list-order)))
a89b059224fb (add-to-ordered-list): Use a weak hash-table to avoid leaks.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63396
diff changeset
1349 (unless ordering
a89b059224fb (add-to-ordered-list): Use a weak hash-table to avoid leaks.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63396
diff changeset
1350 (put list-var 'list-order
a89b059224fb (add-to-ordered-list): Use a weak hash-table to avoid leaks.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63396
diff changeset
1351 (setq ordering (make-hash-table :weakness 'key :test 'eq))))
63396
18169bc4f438 (add-to-ordered-list): Rework to use list-order property of list-var.
Kim F. Storm <storm@cua.dk>
parents: 63387
diff changeset
1352 (when order
63605
99743da5284f (add-to-ordered-list): Test membership with eq. Simplify.
Kim F. Storm <storm@cua.dk>
parents: 63472
diff changeset
1353 (puthash element (and (numberp order) order) ordering))
99743da5284f (add-to-ordered-list): Test membership with eq. Simplify.
Kim F. Storm <storm@cua.dk>
parents: 63472
diff changeset
1354 (unless (memq element (symbol-value list-var))
99743da5284f (add-to-ordered-list): Test membership with eq. Simplify.
Kim F. Storm <storm@cua.dk>
parents: 63472
diff changeset
1355 (set list-var (cons element (symbol-value list-var))))
63396
18169bc4f438 (add-to-ordered-list): Rework to use list-order property of list-var.
Kim F. Storm <storm@cua.dk>
parents: 63387
diff changeset
1356 (set list-var (sort (symbol-value list-var)
18169bc4f438 (add-to-ordered-list): Rework to use list-order property of list-var.
Kim F. Storm <storm@cua.dk>
parents: 63387
diff changeset
1357 (lambda (a b)
63472
a89b059224fb (add-to-ordered-list): Use a weak hash-table to avoid leaks.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63396
diff changeset
1358 (let ((oa (gethash a ordering))
a89b059224fb (add-to-ordered-list): Use a weak hash-table to avoid leaks.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63396
diff changeset
1359 (ob (gethash b ordering)))
63605
99743da5284f (add-to-ordered-list): Test membership with eq. Simplify.
Kim F. Storm <storm@cua.dk>
parents: 63472
diff changeset
1360 (if (and oa ob)
99743da5284f (add-to-ordered-list): Test membership with eq. Simplify.
Kim F. Storm <storm@cua.dk>
parents: 63472
diff changeset
1361 (< oa ob)
99743da5284f (add-to-ordered-list): Test membership with eq. Simplify.
Kim F. Storm <storm@cua.dk>
parents: 63472
diff changeset
1362 oa)))))))
70415
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1363
70678
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1364 (defun add-to-history (history-var newelt &optional maxelt keep-all)
70415
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1365 "Add NEWELT to the history list stored in the variable HISTORY-VAR.
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1366 Return the new history list.
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1367 If MAXELT is non-nil, it specifies the maximum length of the history.
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1368 Otherwise, the maximum history length is the value of the `history-length'
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1369 property on symbol HISTORY-VAR, if set, or the value of the `history-length'
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1370 variable.
70678
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1371 Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil.
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1372 If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1373 if it is empty or a duplicate."
70415
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1374 (unless maxelt
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1375 (setq maxelt (or (get history-var 'history-length)
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1376 history-length)))
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1377 (let ((history (symbol-value history-var))
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1378 tail)
70678
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1379 (when (and (listp history)
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1380 (or keep-all
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1381 (not (stringp newelt))
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1382 (> (length newelt) 0))
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1383 (or keep-all
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1384 (not (equal (car history) newelt))))
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1385 (if history-delete-duplicates
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1386 (delete newelt history))
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1387 (setq history (cons newelt history))
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1388 (when (integerp maxelt)
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1389 (if (= 0 maxelt)
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1390 (setq history nil)
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1391 (setq tail (nthcdr (1- maxelt) history))
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1392 (when (consp tail)
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1393 (setcdr tail nil)))))
70415
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1394 (set history-var history)))
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1395
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1396
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1397 ;;;; Mode hooks.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1398
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1399 (defvar delay-mode-hooks nil
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1400 "If non-nil, `run-mode-hooks' should delay running the hooks.")
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1401 (defvar delayed-mode-hooks nil
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1402 "List of delayed mode hooks waiting to be run.")
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1403 (make-variable-buffer-local 'delayed-mode-hooks)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1404 (put 'delay-mode-hooks 'permanent-local t)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1405
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1406 (defvar after-change-major-mode-hook nil
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1407 "Normal hook run at the very end of major mode functions.")
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1408
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1409 (defun run-mode-hooks (&rest hooks)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1410 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
111936
0a0aa7fbe2ca Doc fixes.
Glenn Morris <rgm@gnu.org>
parents: 111905
diff changeset
1411 Execution is delayed if the variable `delay-mode-hooks' is non-nil.
0a0aa7fbe2ca Doc fixes.
Glenn Morris <rgm@gnu.org>
parents: 111905
diff changeset
1412 Otherwise, runs the mode hooks and then `after-change-major-mode-hook'.
81765
7effaa2c79bd (run-mode-hooks): Docstring improvement.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81646
diff changeset
1413 Major mode functions should use this instead of `run-hooks' when running their
7effaa2c79bd (run-mode-hooks): Docstring improvement.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81646
diff changeset
1414 FOO-mode-hook."
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1415 (if delay-mode-hooks
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1416 ;; Delaying case.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1417 (dolist (hook hooks)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1418 (push hook delayed-mode-hooks))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1419 ;; Normal case, just run the hook as before plus any delayed hooks.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1420 (setq hooks (nconc (nreverse delayed-mode-hooks) hooks))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1421 (setq delayed-mode-hooks nil)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1422 (apply 'run-hooks hooks)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1423 (run-hooks 'after-change-major-mode-hook)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1424
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1425 (defmacro delay-mode-hooks (&rest body)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1426 "Execute BODY, but delay any `run-mode-hooks'.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1427 These hooks will be executed by the first following call to
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1428 `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1429 Only affects hooks run in the current buffer."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1430 (declare (debug t) (indent 0))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1431 `(progn
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1432 (make-local-variable 'delay-mode-hooks)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1433 (let ((delay-mode-hooks t))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1434 ,@body)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1435
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1436 ;; PUBLIC: find if the current mode derives from another.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1437
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1438 (defun derived-mode-p (&rest modes)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1439 "Non-nil if the current major mode is derived from one of MODES.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1440 Uses the `derived-mode-parent' property of the symbol to trace backwards."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1441 (let ((parent major-mode))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1442 (while (and (not (memq parent modes))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1443 (setq parent (get parent 'derived-mode-parent))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1444 parent))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1445
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1446 ;;;; Minor modes.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1447
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1448 ;; If a minor mode is not defined with define-minor-mode,
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1449 ;; add it here explicitly.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1450 ;; isearch-mode is deliberately excluded, since you should
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1451 ;; not call it yourself.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1452 (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1453 overwrite-mode view-mode
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1454 hs-minor-mode)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1455 "List of all minor mode functions.")
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1456
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1457 (defun add-minor-mode (toggle name &optional keymap after toggle-fun)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1458 "Register a new minor mode.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1459
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1460 This is an XEmacs-compatibility function. Use `define-minor-mode' instead.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1461
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1462 TOGGLE is a symbol which is the name of a buffer-local variable that
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1463 is toggled on or off to say whether the minor mode is active or not.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1464
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1465 NAME specifies what will appear in the mode line when the minor mode
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1466 is active. NAME should be either a string starting with a space, or a
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1467 symbol whose value is such a string.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1468
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1469 Optional KEYMAP is the keymap for the minor mode that will be added
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1470 to `minor-mode-map-alist'.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1471
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1472 Optional AFTER specifies that TOGGLE should be added after AFTER
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1473 in `minor-mode-alist'.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1474
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1475 Optional TOGGLE-FUN is an interactive function to toggle the mode.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1476 It defaults to (and should by convention be) TOGGLE.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1477
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1478 If TOGGLE has a non-nil `:included' property, an entry for the mode is
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1479 included in the mode-line minor mode menu.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1480 If TOGGLE has a `:menu-tag', that is used for the menu item's label."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1481 (unless (memq toggle minor-mode-list)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1482 (push toggle minor-mode-list))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1483
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1484 (unless toggle-fun (setq toggle-fun toggle))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1485 (unless (eq toggle-fun toggle)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1486 (put toggle :minor-mode-function toggle-fun))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1487 ;; Add the name to the minor-mode-alist.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1488 (when name
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1489 (let ((existing (assq toggle minor-mode-alist)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1490 (if existing
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1491 (setcdr existing (list name))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1492 (let ((tail minor-mode-alist) found)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1493 (while (and tail (not found))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1494 (if (eq after (caar tail))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1495 (setq found tail)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1496 (setq tail (cdr tail))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1497 (if found
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1498 (let ((rest (cdr found)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1499 (setcdr found nil)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1500 (nconc found (list (list toggle name)) rest))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1501 (setq minor-mode-alist (cons (list toggle name)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1502 minor-mode-alist)))))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1503 ;; Add the toggle to the minor-modes menu if requested.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1504 (when (get toggle :included)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1505 (define-key mode-line-mode-menu
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1506 (vector toggle)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1507 (list 'menu-item
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1508 (concat
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1509 (or (get toggle :menu-tag)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1510 (if (stringp name) name (symbol-name toggle)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1511 (let ((mode-name (if (symbolp name) (symbol-value name))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1512 (if (and (stringp mode-name) (string-match "[^ ]+" mode-name))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1513 (concat " (" (match-string 0 mode-name) ")"))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1514 toggle-fun
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1515 :button (cons :toggle toggle))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1516
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1517 ;; Add the map to the minor-mode-map-alist.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1518 (when keymap
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1519 (let ((existing (assq toggle minor-mode-map-alist)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1520 (if existing
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1521 (setcdr existing keymap)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1522 (let ((tail minor-mode-map-alist) found)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1523 (while (and tail (not found))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1524 (if (eq after (caar tail))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1525 (setq found tail)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1526 (setq tail (cdr tail))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1527 (if found
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1528 (let ((rest (cdr found)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1529 (setcdr found nil)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1530 (nconc found (list (cons toggle keymap)) rest))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1531 (setq minor-mode-map-alist (cons (cons toggle keymap)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1532 minor-mode-map-alist))))))))
39725
c64d3e3adf5d (symbol-file-load-history-loaded)
Miles Bader <miles@gnu.org>
parents: 39598
diff changeset
1533
c64d3e3adf5d (symbol-file-load-history-loaded)
Miles Bader <miles@gnu.org>
parents: 39598
diff changeset
1534 ;;; Load history
c64d3e3adf5d (symbol-file-load-history-loaded)
Miles Bader <miles@gnu.org>
parents: 39598
diff changeset
1535
70267
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1536 ;; (defvar symbol-file-load-history-loaded nil
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1537 ;; "Non-nil means we have loaded the file `fns-VERSION.el' in `exec-directory'.
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1538 ;; That file records the part of `load-history' for preloaded files,
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1539 ;; which is cleared out before dumping to make Emacs smaller.")
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1540
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1541 ;; (defun load-symbol-file-load-history ()
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1542 ;; "Load the file `fns-VERSION.el' in `exec-directory' if not already done.
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1543 ;; That file records the part of `load-history' for preloaded files,
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1544 ;; which is cleared out before dumping to make Emacs smaller."
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1545 ;; (unless symbol-file-load-history-loaded
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1546 ;; (load (expand-file-name
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1547 ;; ;; fns-XX.YY.ZZ.el does not work on DOS filesystem.
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1548 ;; (if (eq system-type 'ms-dos)
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1549 ;; "fns.el"
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1550 ;; (format "fns-%s.el" emacs-version))
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1551 ;; exec-directory)
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1552 ;; ;; The file name fns-%s.el already has a .el extension.
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1553 ;; nil nil t)
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1554 ;; (setq symbol-file-load-history-loaded t)))
39725
c64d3e3adf5d (symbol-file-load-history-loaded)
Miles Bader <miles@gnu.org>
parents: 39598
diff changeset
1555
59124
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1556 (defun symbol-file (symbol &optional type)
98026
1965167a6de7 (symbol-file): Fix doc-string.
Martin Rudalics <rudalics@gmx.at>
parents: 97882
diff changeset
1557 "Return the name of the file that defined SYMBOL.
1965167a6de7 (symbol-file): Fix doc-string.
Martin Rudalics <rudalics@gmx.at>
parents: 97882
diff changeset
1558 The value is normally an absolute file name. It can also be nil,
1965167a6de7 (symbol-file): Fix doc-string.
Martin Rudalics <rudalics@gmx.at>
parents: 97882
diff changeset
1559 if the definition is not associated with any file. If SYMBOL
1965167a6de7 (symbol-file): Fix doc-string.
Martin Rudalics <rudalics@gmx.at>
parents: 97882
diff changeset
1560 specifies an autoloaded function, the value can be a relative
1965167a6de7 (symbol-file): Fix doc-string.
Martin Rudalics <rudalics@gmx.at>
parents: 97882
diff changeset
1561 file name without extension.
1965167a6de7 (symbol-file): Fix doc-string.
Martin Rudalics <rudalics@gmx.at>
parents: 97882
diff changeset
1562
1965167a6de7 (symbol-file): Fix doc-string.
Martin Rudalics <rudalics@gmx.at>
parents: 97882
diff changeset
1563 If TYPE is nil, then any kind of definition is acceptable. If
1965167a6de7 (symbol-file): Fix doc-string.
Martin Rudalics <rudalics@gmx.at>
parents: 97882
diff changeset
1564 TYPE is `defun', `defvar', or `defface', that specifies function
1965167a6de7 (symbol-file): Fix doc-string.
Martin Rudalics <rudalics@gmx.at>
parents: 97882
diff changeset
1565 definition, variable definition, or face definition only."
59124
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1566 (if (and (or (null type) (eq type 'defun))
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1567 (symbolp symbol) (fboundp symbol)
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1568 (eq 'autoload (car-safe (symbol-function symbol))))
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1569 (nth 1 (symbol-function symbol))
47355
9e3ee43b5262 (symbol-file): Also work for autoloaded funcs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47305
diff changeset
1570 (let ((files load-history)
48474
33dafec6a9de (symbol-file): Remove unused variable `functions'.
John Paul Wallington <jpw@pobox.com>
parents: 48077
diff changeset
1571 file)
47355
9e3ee43b5262 (symbol-file): Also work for autoloaded funcs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47305
diff changeset
1572 (while files
59124
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1573 (if (if type
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1574 (if (eq type 'defvar)
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1575 ;; Variables are present just as their names.
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1576 (member symbol (cdr (car files)))
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1577 ;; Other types are represented as (TYPE . NAME).
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1578 (member (cons type symbol) (cdr (car files))))
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1579 ;; We accept all types, so look for variable def
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1580 ;; and then for any other kind.
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1581 (or (member symbol (cdr (car files)))
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1582 (rassq symbol (cdr (car files)))))
47355
9e3ee43b5262 (symbol-file): Also work for autoloaded funcs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47305
diff changeset
1583 (setq file (car (car files)) files nil))
9e3ee43b5262 (symbol-file): Also work for autoloaded funcs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47305
diff changeset
1584 (setq files (cdr files)))
9e3ee43b5262 (symbol-file): Also work for autoloaded funcs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47305
diff changeset
1585 file)))
39725
c64d3e3adf5d (symbol-file-load-history-loaded)
Miles Bader <miles@gnu.org>
parents: 39598
diff changeset
1586
66508
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1587 (defun locate-library (library &optional nosuffix path interactive-call)
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1588 "Show the precise file name of Emacs library LIBRARY.
102010
5a441ce3d28d (locate-library): Doc fix. (Bug#2291)
Eli Zaretskii <eliz@gnu.org>
parents: 101852
diff changeset
1589 LIBRARY should be a relative file name of the library, a string.
5a441ce3d28d (locate-library): Doc fix. (Bug#2291)
Eli Zaretskii <eliz@gnu.org>
parents: 101852
diff changeset
1590 It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is
5a441ce3d28d (locate-library): Doc fix. (Bug#2291)
Eli Zaretskii <eliz@gnu.org>
parents: 101852
diff changeset
1591 nil (which is the default, see below).
66508
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1592 This command searches the directories in `load-path' like `\\[load-library]'
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1593 to find the file that `\\[load-library] RET LIBRARY RET' would load.
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1594 Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1595 to the specified name LIBRARY.
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1596
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1597 If the optional third arg PATH is specified, that list of directories
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1598 is used instead of `load-path'.
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1599
95757
5be5ad6047d1 (locate-library): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 95366
diff changeset
1600 When called from a program, the file name is normally returned as a
66508
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1601 string. When run interactively, the argument INTERACTIVE-CALL is t,
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1602 and the file name is displayed in the echo area."
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1603 (interactive (list (completing-read "Locate library: "
94183
bade431b9780 * finder.el (finder-commentary):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 94013
diff changeset
1604 (apply-partially
bade431b9780 * finder.el (finder-commentary):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 94013
diff changeset
1605 'locate-file-completion-table
bade431b9780 * finder.el (finder-commentary):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 94013
diff changeset
1606 load-path (get-load-suffixes)))
66508
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1607 nil nil
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1608 t))
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1609 (let ((file (locate-file library
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1610 (or path load-path)
69168
6e701396a0ec (locate-library): Use `get-load-suffixes' instead of `load-suffixes'
Luc Teirlinck <teirllm@auburn.edu>
parents: 68848
diff changeset
1611 (append (unless nosuffix (get-load-suffixes))
6e701396a0ec (locate-library): Use `get-load-suffixes' instead of `load-suffixes'
Luc Teirlinck <teirllm@auburn.edu>
parents: 68848
diff changeset
1612 load-file-rep-suffixes))))
66508
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1613 (if interactive-call
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1614 (if file
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1615 (message "Library is file %s" (abbreviate-file-name file))
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1616 (message "No library %s in search path" library)))
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1617 file))
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1618
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
1619
66306
138f9b1d6682 (eval-at-startup): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 66304
diff changeset
1620 ;;;; Specifying things to do later.
138f9b1d6682 (eval-at-startup): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 66304
diff changeset
1621
70879
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1622 (defun load-history-regexp (file)
71037
a0da1a83020d (load-history-regexp): If FILE is relative, insist
Richard M. Stallman <rms@gnu.org>
parents: 70903
diff changeset
1623 "Form a regexp to find FILE in `load-history'.
a0da1a83020d (load-history-regexp): If FILE is relative, insist
Richard M. Stallman <rms@gnu.org>
parents: 70903
diff changeset
1624 FILE, a string, is described in the function `eval-after-load'."
70879
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1625 (if (file-name-absolute-p file)
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1626 (setq file (file-truename file)))
71037
a0da1a83020d (load-history-regexp): If FILE is relative, insist
Richard M. Stallman <rms@gnu.org>
parents: 70903
diff changeset
1627 (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)")
70879
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1628 (regexp-quote file)
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1629 (if (file-name-extension file)
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1630 ""
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1631 ;; Note: regexp-opt can't be used here, since we need to call
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1632 ;; this before Emacs has been fully started. 2006-05-21
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1633 (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?"))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1634 "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|")
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1635 "\\)?\\'"))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1636
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1637 (defun load-history-filename-element (file-regexp)
71037
a0da1a83020d (load-history-regexp): If FILE is relative, insist
Richard M. Stallman <rms@gnu.org>
parents: 70903
diff changeset
1638 "Get the first elt of `load-history' whose car matches FILE-REGEXP.
70879
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1639 Return nil if there isn't one."
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1640 (let* ((loads load-history)
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1641 (load-elt (and loads (car loads))))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1642 (save-match-data
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1643 (while (and loads
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1644 (or (null (car load-elt))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1645 (not (string-match file-regexp (car load-elt)))))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1646 (setq loads (cdr loads)
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1647 load-elt (and loads (car loads)))))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1648 load-elt))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1649
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1650 (defun eval-after-load (file form)
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1651 "Arrange that, if FILE is ever loaded, FORM will be run at that time.
10794
4443f78a2117 (eval-after-load): Run FORM now if FILE's already loaded.
Richard M. Stallman <rms@gnu.org>
parents: 10693
diff changeset
1652 If FILE is already loaded, evaluate FORM right now.
70879
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1653
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1654 If a matching file is loaded again, FORM will be evaluated again.
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1655
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1656 If FILE is a string, it may be either an absolute or a relative file
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1657 name, and may have an extension \(e.g. \".el\") or may lack one, and
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1658 additionally may or may not have an extension denoting a compressed
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1659 format \(e.g. \".gz\").
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1660
71037
a0da1a83020d (load-history-regexp): If FILE is relative, insist
Richard M. Stallman <rms@gnu.org>
parents: 70903
diff changeset
1661 When FILE is absolute, this first converts it to a true name by chasing
a0da1a83020d (load-history-regexp): If FILE is relative, insist
Richard M. Stallman <rms@gnu.org>
parents: 70903
diff changeset
1662 symbolic links. Only a file of this name \(see next paragraph regarding
70879
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1663 extensions) will trigger the evaluation of FORM. When FILE is relative,
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1664 a file whose absolute true name ends in FILE will trigger evaluation.
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1665
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1666 When FILE lacks an extension, a file name with any extension will trigger
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1667 evaluation. Otherwise, its extension must match FILE's. A further
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1668 extension for a compressed format \(e.g. \".gz\") on FILE will not affect
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1669 this name matching.
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1670
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1671 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
103731
4faf5698814a (eval-after-load): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 103485
diff changeset
1672 is evaluated whenever that feature is `provide'd. Note that although
4faf5698814a (eval-after-load): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 103485
diff changeset
1673 provide statements are usually at the end of files, this is not always
4faf5698814a (eval-after-load): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 103485
diff changeset
1674 the case (e.g., sometimes they are at the start to avoid a recursive
4faf5698814a (eval-after-load): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 103485
diff changeset
1675 load error). If your FORM should not be evaluated until the code in
4faf5698814a (eval-after-load): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 103485
diff changeset
1676 FILE has been, do not use the symbol form for FILE in such cases.
70879
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1677
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1678 Usually FILE is just a library name like \"font-lock\" or a feature name
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1679 like 'font-lock.
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1680
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1681 This function makes or adds to an entry on `after-load-alist'."
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1682 ;; Add this FORM into after-load-alist (regardless of whether we'll be
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1683 ;; evaluating it now).
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1684 (let* ((regexp-or-feature
105944
a465c7c7e59e * subr.el (add-hook): Purecopy strings.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 105940
diff changeset
1685 (if (stringp file) (setq file (purecopy (load-history-regexp file))) file))
70879
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1686 (elt (assoc regexp-or-feature after-load-alist)))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1687 (unless elt
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1688 (setq elt (list regexp-or-feature))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1689 (push elt after-load-alist))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1690 ;; Add FORM to the element unless it's already there.
41140
dc77550aede3 (eval-after-load): Make it work with features as well.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40832
diff changeset
1691 (unless (member form (cdr elt))
105944
a465c7c7e59e * subr.el (add-hook): Purecopy strings.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 105940
diff changeset
1692 (nconc elt (purecopy (list form))))
70879
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1693
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1694 ;; Is there an already loaded file whose name (or `provide' name)
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1695 ;; matches FILE?
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1696 (if (if (stringp file)
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1697 (load-history-filename-element regexp-or-feature)
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1698 (featurep file))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1699 (eval form))))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1700
105027
8cbad31101f6 (after-load-functions): New hook.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104978
diff changeset
1701 (defvar after-load-functions nil
8cbad31101f6 (after-load-functions): New hook.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104978
diff changeset
1702 "Special hook run after loading a file.
8cbad31101f6 (after-load-functions): New hook.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104978
diff changeset
1703 Each function there is called with a single argument, the absolute
8cbad31101f6 (after-load-functions): New hook.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104978
diff changeset
1704 name of the file just loaded.")
8cbad31101f6 (after-load-functions): New hook.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104978
diff changeset
1705
70879
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1706 (defun do-after-load-evaluation (abs-file)
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1707 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
104977
1e1816f211ce * lread.c (Fload): Don't output a message after loading an obsolete
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104920
diff changeset
1708 ABS-FILE, a string, should be the absolute true name of a file just loaded.
1e1816f211ce * lread.c (Fload): Don't output a message after loading an obsolete
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104920
diff changeset
1709 This function is called directly from the C code."
1e1816f211ce * lread.c (Fload): Don't output a message after loading an obsolete
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104920
diff changeset
1710 ;; Run the relevant eval-after-load forms.
104737
8224438aa3cd * subr.el (do-after-load-evaluation): Fix last change: use `mapc'
Juanma Barranquero <lekktu@gmail.com>
parents: 104715
diff changeset
1711 (mapc #'(lambda (a-l-element)
8224438aa3cd * subr.el (do-after-load-evaluation): Fix last change: use `mapc'
Juanma Barranquero <lekktu@gmail.com>
parents: 104715
diff changeset
1712 (when (and (stringp (car a-l-element))
8224438aa3cd * subr.el (do-after-load-evaluation): Fix last change: use `mapc'
Juanma Barranquero <lekktu@gmail.com>
parents: 104715
diff changeset
1713 (string-match-p (car a-l-element) abs-file))
8224438aa3cd * subr.el (do-after-load-evaluation): Fix last change: use `mapc'
Juanma Barranquero <lekktu@gmail.com>
parents: 104715
diff changeset
1714 ;; discard the file name regexp
8224438aa3cd * subr.el (do-after-load-evaluation): Fix last change: use `mapc'
Juanma Barranquero <lekktu@gmail.com>
parents: 104715
diff changeset
1715 (mapc #'eval (cdr a-l-element))))
104977
1e1816f211ce * lread.c (Fload): Don't output a message after loading an obsolete
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104920
diff changeset
1716 after-load-alist)
1e1816f211ce * lread.c (Fload): Don't output a message after loading an obsolete
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104920
diff changeset
1717 ;; Complain when the user uses obsolete files.
105027
8cbad31101f6 (after-load-functions): New hook.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104978
diff changeset
1718 (when (string-match-p "/obsolete/[^/]*\\'" abs-file)
104977
1e1816f211ce * lread.c (Fload): Don't output a message after loading an obsolete
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104920
diff changeset
1719 (run-with-timer 0 nil
1e1816f211ce * lread.c (Fload): Don't output a message after loading an obsolete
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104920
diff changeset
1720 (lambda (file)
1e1816f211ce * lread.c (Fload): Don't output a message after loading an obsolete
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104920
diff changeset
1721 (message "Package %s is obsolete!"
1e1816f211ce * lread.c (Fload): Don't output a message after loading an obsolete
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104920
diff changeset
1722 (substring file 0
1e1816f211ce * lread.c (Fload): Don't output a message after loading an obsolete
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104920
diff changeset
1723 (string-match "\\.elc?\\>" file))))
105027
8cbad31101f6 (after-load-functions): New hook.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104978
diff changeset
1724 (file-name-nondirectory abs-file)))
8cbad31101f6 (after-load-functions): New hook.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104978
diff changeset
1725 ;; Finally, run any other hook.
8cbad31101f6 (after-load-functions): New hook.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104978
diff changeset
1726 (run-hook-with-args 'after-load-functions abs-file))
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1727
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1728 (defun eval-next-after-load (file)
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1729 "Read the following input sexp, and run it whenever FILE is loaded.
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1730 This makes or adds to an entry on `after-load-alist'.
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1731 FILE should be the name of a library, with no directory name."
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1732 (eval-after-load file (read)))
105060
78c0a7ca3aaf (push, pop, dolist, dotimes, declare): Don't overwrite CL's
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105027
diff changeset
1733 (make-obsolete 'eval-next-after-load `eval-after-load "23.2")
45587
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1734
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1735 ;;;; Process stuff.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1736
86172
e8cb5c919219 (process-lines): Move here from ../admin/admin.el.
Glenn Morris <rgm@gnu.org>
parents: 86152
diff changeset
1737 (defun process-lines (program &rest args)
e8cb5c919219 (process-lines): Move here from ../admin/admin.el.
Glenn Morris <rgm@gnu.org>
parents: 86152
diff changeset
1738 "Execute PROGRAM with ARGS, returning its output as a list of lines.
e8cb5c919219 (process-lines): Move here from ../admin/admin.el.
Glenn Morris <rgm@gnu.org>
parents: 86152
diff changeset
1739 Signal an error if the program returns with a non-zero exit status."
e8cb5c919219 (process-lines): Move here from ../admin/admin.el.
Glenn Morris <rgm@gnu.org>
parents: 86152
diff changeset
1740 (with-temp-buffer
e8cb5c919219 (process-lines): Move here from ../admin/admin.el.
Glenn Morris <rgm@gnu.org>
parents: 86152
diff changeset
1741 (let ((status (apply 'call-process program nil (current-buffer) nil args)))
e8cb5c919219 (process-lines): Move here from ../admin/admin.el.
Glenn Morris <rgm@gnu.org>
parents: 86152
diff changeset
1742 (unless (eq status 0)
e8cb5c919219 (process-lines): Move here from ../admin/admin.el.
Glenn Morris <rgm@gnu.org>
parents: 86152
diff changeset
1743 (error "%s exited with status %s" program status))
e8cb5c919219 (process-lines): Move here from ../admin/admin.el.
Glenn Morris <rgm@gnu.org>
parents: 86152
diff changeset
1744 (goto-char (point-min))
e8cb5c919219 (process-lines): Move here from ../admin/admin.el.
Glenn Morris <rgm@gnu.org>
parents: 86152
diff changeset
1745 (let (lines)
e8cb5c919219 (process-lines): Move here from ../admin/admin.el.
Glenn Morris <rgm@gnu.org>
parents: 86152
diff changeset
1746 (while (not (eobp))
e8cb5c919219 (process-lines): Move here from ../admin/admin.el.
Glenn Morris <rgm@gnu.org>
parents: 86152
diff changeset
1747 (setq lines (cons (buffer-substring-no-properties
e8cb5c919219 (process-lines): Move here from ../admin/admin.el.
Glenn Morris <rgm@gnu.org>
parents: 86152
diff changeset
1748 (line-beginning-position)
e8cb5c919219 (process-lines): Move here from ../admin/admin.el.
Glenn Morris <rgm@gnu.org>
parents: 86152
diff changeset
1749 (line-end-position))
e8cb5c919219 (process-lines): Move here from ../admin/admin.el.
Glenn Morris <rgm@gnu.org>
parents: 86152
diff changeset
1750 lines))
e8cb5c919219 (process-lines): Move here from ../admin/admin.el.
Glenn Morris <rgm@gnu.org>
parents: 86152
diff changeset
1751 (forward-line 1))
e8cb5c919219 (process-lines): Move here from ../admin/admin.el.
Glenn Morris <rgm@gnu.org>
parents: 86152
diff changeset
1752 (nreverse lines)))))
e8cb5c919219 (process-lines): Move here from ../admin/admin.el.
Glenn Morris <rgm@gnu.org>
parents: 86152
diff changeset
1753
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1754 ;; open-network-stream is a wrapper around make-network-process.
45587
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1755
62372
4560134d21fa (open-network-stream-nowait): Remove.
Kim F. Storm <storm@cua.dk>
parents: 62326
diff changeset
1756 (when (featurep 'make-network-process)
4560134d21fa (open-network-stream-nowait): Remove.
Kim F. Storm <storm@cua.dk>
parents: 62326
diff changeset
1757 (defun open-network-stream (name buffer host service)
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1758 "Open a TCP connection for a service to a host.
45587
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1759 Returns a subprocess-object to represent the connection.
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1760 Input and output work as for subprocesses; `delete-process' closes it.
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
1761
103485
40b49259dd71 Fix previous change, sigh.
Glenn Morris <rgm@gnu.org>
parents: 103484
diff changeset
1762 NAME is the name for the process. It is modified if necessary to make
40b49259dd71 Fix previous change, sigh.
Glenn Morris <rgm@gnu.org>
parents: 103484
diff changeset
1763 it unique.
103484
d0c5be11f069 (open-network-stream): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 103107
diff changeset
1764 BUFFER is the buffer (or buffer name) to associate with the
d0c5be11f069 (open-network-stream): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 103107
diff changeset
1765 process. Process output goes at end of that buffer. BUFFER may
d0c5be11f069 (open-network-stream): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 103107
diff changeset
1766 be nil, meaning that this process is not associated with any buffer.
d0c5be11f069 (open-network-stream): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 103107
diff changeset
1767 HOST is the name or IP address of the host to connect to.
d0c5be11f069 (open-network-stream): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 103107
diff changeset
1768 SERVICE is the name of the service desired, or an integer specifying
d0c5be11f069 (open-network-stream): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 103107
diff changeset
1769 a port number to connect to.
d0c5be11f069 (open-network-stream): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 103107
diff changeset
1770
d0c5be11f069 (open-network-stream): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 103107
diff changeset
1771 This is a wrapper around `make-network-process', and only offers a
d0c5be11f069 (open-network-stream): Doc fix.
Glenn Morris <rgm@gnu.org>
parents: 103107
diff changeset
1772 subset of its functionality."
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1773 (make-network-process :name name :buffer buffer
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1774 :host host :service service)))
45587
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1775
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1776 ;; compatibility
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1777
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1778 (make-obsolete
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1779 'process-kill-without-query
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1780 "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'."
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1781 "22.1")
45587
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1782 (defun process-kill-without-query (process &optional flag)
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1783 "Say no query needed if PROCESS is running when Emacs is exited.
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1784 Optional second argument if non-nil says to require a query.
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
1785 Value is t if a query was formerly required."
45587
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1786 (let ((old (process-query-on-exit-flag process)))
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1787 (set-process-query-on-exit-flag process nil)
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1788 old))
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1789
103970
340cbf291f8a (process-kill-buffer-query-function): New function.
Juri Linkov <juri@jurta.org>
parents: 103884
diff changeset
1790 (defun process-kill-buffer-query-function ()
340cbf291f8a (process-kill-buffer-query-function): New function.
Juri Linkov <juri@jurta.org>
parents: 103884
diff changeset
1791 "Ask before killing a buffer that has a running process."
340cbf291f8a (process-kill-buffer-query-function): New function.
Juri Linkov <juri@jurta.org>
parents: 103884
diff changeset
1792 (let ((process (get-buffer-process (current-buffer))))
340cbf291f8a (process-kill-buffer-query-function): New function.
Juri Linkov <juri@jurta.org>
parents: 103884
diff changeset
1793 (or (not process)
340cbf291f8a (process-kill-buffer-query-function): New function.
Juri Linkov <juri@jurta.org>
parents: 103884
diff changeset
1794 (not (memq (process-status process) '(run stop open listen)))
340cbf291f8a (process-kill-buffer-query-function): New function.
Juri Linkov <juri@jurta.org>
parents: 103884
diff changeset
1795 (not (process-query-on-exit-flag process))
340cbf291f8a (process-kill-buffer-query-function): New function.
Juri Linkov <juri@jurta.org>
parents: 103884
diff changeset
1796 (yes-or-no-p "Buffer has a running process; kill it? "))))
340cbf291f8a (process-kill-buffer-query-function): New function.
Juri Linkov <juri@jurta.org>
parents: 103884
diff changeset
1797
340cbf291f8a (process-kill-buffer-query-function): New function.
Juri Linkov <juri@jurta.org>
parents: 103884
diff changeset
1798 (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function)
340cbf291f8a (process-kill-buffer-query-function): New function.
Juri Linkov <juri@jurta.org>
parents: 103884
diff changeset
1799
49225
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1800 ;; process plist management
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1801
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1802 (defun process-get (process propname)
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1803 "Return the value of PROCESS' PROPNAME property.
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1804 This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'."
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1805 (plist-get (process-plist process) propname))
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1806
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1807 (defun process-put (process propname value)
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1808 "Change PROCESS' PROPNAME property to VALUE.
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1809 It can be retrieved with `(process-get PROCESS PROPNAME)'."
49597
e88404e8f2cf Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49492
diff changeset
1810 (set-process-plist process
49225
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1811 (plist-put (process-plist process) propname value)))
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1812
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1813
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1814 ;;;; Input and display facilities.
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1815
18880
1ed40ed8e0c1 (custom-declare-variable-early): New function.
Richard M. Stallman <rms@gnu.org>
parents: 18828
diff changeset
1816 (defvar read-quoted-char-radix 8
18828
4837387f683c (read-quoted-char): Handle non-character events.
Richard M. Stallman <rms@gnu.org>
parents: 18821
diff changeset
1817 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
18880
1ed40ed8e0c1 (custom-declare-variable-early): New function.
Richard M. Stallman <rms@gnu.org>
parents: 18828
diff changeset
1818 Legitimate radix values are 8, 10 and 16.")
1ed40ed8e0c1 (custom-declare-variable-early): New function.
Richard M. Stallman <rms@gnu.org>
parents: 18828
diff changeset
1819
1ed40ed8e0c1 (custom-declare-variable-early): New function.
Richard M. Stallman <rms@gnu.org>
parents: 18828
diff changeset
1820 (custom-declare-variable-early
47916
0bb8dc016c43 (remq): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 47747
diff changeset
1821 'read-quoted-char-radix 8
18880
1ed40ed8e0c1 (custom-declare-variable-early): New function.
Richard M. Stallman <rms@gnu.org>
parents: 18828
diff changeset
1822 "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'.
18828
4837387f683c (read-quoted-char): Handle non-character events.
Richard M. Stallman <rms@gnu.org>
parents: 18821
diff changeset
1823 Legitimate radix values are 8, 10 and 16."
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1824 :type '(choice (const 8) (const 10) (const 16))
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1825 :group 'editing-basics)
18828
4837387f683c (read-quoted-char): Handle non-character events.
Richard M. Stallman <rms@gnu.org>
parents: 18821
diff changeset
1826
104354
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1827 (defconst read-key-empty-map (make-sparse-keymap))
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1828
105681
fac384c9a868 (read-key-delay): Reduce to 0.01.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105631
diff changeset
1829 (defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully.
104354
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1830
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1831 (defun read-key (&optional prompt)
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1832 "Read a key from the keyboard.
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1833 Contrary to `read-event' this will not return a raw event but instead will
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1834 obey the input decoding and translations usually done by `read-key-sequence'.
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1835 So escape sequences and keyboard encoding are taken into account.
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1836 When there's an ambiguity because the key looks like the prefix of
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1837 some sort of escape sequence, the ambiguity is resolved via `read-key-delay'."
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1838 (let ((overriding-terminal-local-map read-key-empty-map)
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1839 (overriding-local-map nil)
109943
252e1eb2e944 * subr.el (read-key): Don't echo keystrokes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109937
diff changeset
1840 (echo-keystrokes 0)
104354
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1841 (old-global-map (current-global-map))
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1842 (timer (run-with-idle-timer
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1843 ;; Wait long enough that Emacs has the time to receive and
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1844 ;; process all the raw events associated with the single-key.
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1845 ;; But don't wait too long, or the user may find the delay
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1846 ;; annoying (or keep hitting more keys which may then get
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1847 ;; lost or misinterpreted).
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1848 ;; This is only relevant for keys which Emacs perceives as
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1849 ;; "prefixes", such as C-x (because of the C-x 8 map in
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1850 ;; key-translate-table and the C-x @ map in function-key-map)
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1851 ;; or ESC (because of terminal escape sequences in
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1852 ;; input-decode-map).
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1853 read-key-delay t
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1854 (lambda ()
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1855 (let ((keys (this-command-keys-vector)))
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1856 (unless (zerop (length keys))
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1857 ;; `keys' is non-empty, so the user has hit at least
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1858 ;; one key; there's no point waiting any longer, even
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1859 ;; though read-key-sequence thinks we should wait
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1860 ;; for more input to decide how to interpret the
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1861 ;; current input.
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1862 (throw 'read-key keys)))))))
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1863 (unwind-protect
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1864 (progn
109937
9b8e40e0bf3c * lisp/subr.el (read-key): Don't hide the menu-bar entries.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109917
diff changeset
1865 (use-global-map
9b8e40e0bf3c * lisp/subr.el (read-key): Don't hide the menu-bar entries.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109917
diff changeset
1866 (let ((map (make-sparse-keymap)))
9b8e40e0bf3c * lisp/subr.el (read-key): Don't hide the menu-bar entries.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109917
diff changeset
1867 ;; Don't hide the menu-bar and tool-bar entries.
9b8e40e0bf3c * lisp/subr.el (read-key): Don't hide the menu-bar entries.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109917
diff changeset
1868 (define-key map [menu-bar] (lookup-key global-map [menu-bar]))
9b8e40e0bf3c * lisp/subr.el (read-key): Don't hide the menu-bar entries.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109917
diff changeset
1869 (define-key map [tool-bar] (lookup-key global-map [tool-bar]))
9b8e40e0bf3c * lisp/subr.el (read-key): Don't hide the menu-bar entries.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109917
diff changeset
1870 map))
105681
fac384c9a868 (read-key-delay): Reduce to 0.01.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105631
diff changeset
1871 (aref (catch 'read-key (read-key-sequence-vector prompt nil t)) 0))
104354
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1872 (cancel-timer timer)
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1873 (use-global-map old-global-map))))
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
1874
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1875 (defun read-quoted-char (&optional prompt)
18821
83425393d550 (read-quoted-char): Read any number of octal digits,
Richard M. Stallman <rms@gnu.org>
parents: 18044
diff changeset
1876 "Like `read-char', but do not allow quitting.
83425393d550 (read-quoted-char): Read any number of octal digits,
Richard M. Stallman <rms@gnu.org>
parents: 18044
diff changeset
1877 Also, if the first character read is an octal digit,
83425393d550 (read-quoted-char): Read any number of octal digits,
Richard M. Stallman <rms@gnu.org>
parents: 18044
diff changeset
1878 we read any number of octal digits and return the
21008
7111f9cf9392 (read-quoted-char): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 20939
diff changeset
1879 specified character code. Any nondigit terminates the sequence.
18828
4837387f683c (read-quoted-char): Handle non-character events.
Richard M. Stallman <rms@gnu.org>
parents: 18821
diff changeset
1880 If the terminator is RET, it is discarded;
18821
83425393d550 (read-quoted-char): Read any number of octal digits,
Richard M. Stallman <rms@gnu.org>
parents: 18044
diff changeset
1881 any other terminator is used itself as input.
83425393d550 (read-quoted-char): Read any number of octal digits,
Richard M. Stallman <rms@gnu.org>
parents: 18044
diff changeset
1882
21008
7111f9cf9392 (read-quoted-char): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 20939
diff changeset
1883 The optional argument PROMPT specifies a string to use to prompt the user.
7111f9cf9392 (read-quoted-char): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 20939
diff changeset
1884 The variable `read-quoted-char-radix' controls which radix to use
7111f9cf9392 (read-quoted-char): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 20939
diff changeset
1885 for numeric input."
50427
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1886 (let ((message-log-max nil) done (first t) (code 0) char translated)
18821
83425393d550 (read-quoted-char): Read any number of octal digits,
Richard M. Stallman <rms@gnu.org>
parents: 18044
diff changeset
1887 (while (not done)
83425393d550 (read-quoted-char): Read any number of octal digits,
Richard M. Stallman <rms@gnu.org>
parents: 18044
diff changeset
1888 (let ((inhibit-quit first)
12108
f75e47f673f4 (read-quoted-char): Turn on help-form and turn off help-char.
Karl Heuer <kwzh@gnu.org>
parents: 12016
diff changeset
1889 ;; Don't let C-h get the help message--only help function keys.
f75e47f673f4 (read-quoted-char): Turn on help-form and turn off help-char.
Karl Heuer <kwzh@gnu.org>
parents: 12016
diff changeset
1890 (help-char nil)
f75e47f673f4 (read-quoted-char): Turn on help-form and turn off help-char.
Karl Heuer <kwzh@gnu.org>
parents: 12016
diff changeset
1891 (help-form
f75e47f673f4 (read-quoted-char): Turn on help-form and turn off help-char.
Karl Heuer <kwzh@gnu.org>
parents: 12016
diff changeset
1892 "Type the special character you want to use,
18821
83425393d550 (read-quoted-char): Read any number of octal digits,
Richard M. Stallman <rms@gnu.org>
parents: 18044
diff changeset
1893 or the octal character code.
18828
4837387f683c (read-quoted-char): Handle non-character events.
Richard M. Stallman <rms@gnu.org>
parents: 18821
diff changeset
1894 RET terminates the character code and is discarded;
18821
83425393d550 (read-quoted-char): Read any number of octal digits,
Richard M. Stallman <rms@gnu.org>
parents: 18044
diff changeset
1895 any other non-digit terminates the character code and is then used as input."))
47747
399628a16c0a (read-key-auxiliary-map, read-key): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47690
diff changeset
1896 (setq char (read-event (and prompt (format "%s-" prompt)) t))
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1897 (if inhibit-quit (setq quit-flag nil)))
47747
399628a16c0a (read-key-auxiliary-map, read-key): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47690
diff changeset
1898 ;; Translate TAB key into control-I ASCII character, and so on.
399628a16c0a (read-key-auxiliary-map, read-key): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47690
diff changeset
1899 ;; Note: `read-char' does it using the `ascii-character' property.
108661
0706b3de1aa0 Stefan Monnier <monnier@iro.umontreal.ca>
Chong Yidong <cyd@stupidchicken.com>
parents: 107684
diff changeset
1900 ;; We should try and use read-key instead.
0706b3de1aa0 Stefan Monnier <monnier@iro.umontreal.ca>
Chong Yidong <cyd@stupidchicken.com>
parents: 107684
diff changeset
1901 (let ((translation (lookup-key local-function-key-map (vector char))))
109242
b36e6aac8cf2 * lisp/subr.el (read-quoted-char): Fix up last change.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 108675
diff changeset
1902 (setq translated (if (arrayp translation)
b36e6aac8cf2 * lisp/subr.el (read-quoted-char): Fix up last change.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 108675
diff changeset
1903 (aref translation 0)
b36e6aac8cf2 * lisp/subr.el (read-quoted-char): Fix up last change.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 108675
diff changeset
1904 char)))
b36e6aac8cf2 * lisp/subr.el (read-quoted-char): Fix up last change.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 108675
diff changeset
1905 (if (integerp translated)
b36e6aac8cf2 * lisp/subr.el (read-quoted-char): Fix up last change.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 108675
diff changeset
1906 (setq translated (char-resolve-modifiers translated)))
50427
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1907 (cond ((null translated))
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1908 ((not (integerp translated))
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1909 (setq unread-command-events (list char)
18828
4837387f683c (read-quoted-char): Handle non-character events.
Richard M. Stallman <rms@gnu.org>
parents: 18821
diff changeset
1910 done t))
50427
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1911 ((/= (logand translated ?\M-\^@) 0)
19175
3d80c899a15d (read-quoted-char): Fix handling of meta-chars.
Richard M. Stallman <rms@gnu.org>
parents: 19002
diff changeset
1912 ;; Turn a meta-character into a character with the 0200 bit set.
50427
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1913 (setq code (logior (logand translated (lognot ?\M-\^@)) 128)
19175
3d80c899a15d (read-quoted-char): Fix handling of meta-chars.
Richard M. Stallman <rms@gnu.org>
parents: 19002
diff changeset
1914 done t))
105763
5041ae86859e (all-completions): Declare the 4th arg obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105681
diff changeset
1915 ((and (<= ?0 translated)
5041ae86859e (all-completions): Declare the 4th arg obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105681
diff changeset
1916 (< translated (+ ?0 (min 10 read-quoted-char-radix))))
50427
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1917 (setq code (+ (* code read-quoted-char-radix) (- translated ?0)))
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1918 (and prompt (setq prompt (message "%s %c" prompt translated))))
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1919 ((and (<= ?a (downcase translated))
105763
5041ae86859e (all-completions): Declare the 4th arg obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105681
diff changeset
1920 (< (downcase translated)
5041ae86859e (all-completions): Declare the 4th arg obsolete.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105681
diff changeset
1921 (+ ?a -10 (min 36 read-quoted-char-radix))))
19002
f21881dcd27b (read-quoted-char): Consistently downcase letter "digits".
Richard M. Stallman <rms@gnu.org>
parents: 18948
diff changeset
1922 (setq code (+ (* code read-quoted-char-radix)
50427
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1923 (+ 10 (- (downcase translated) ?a))))
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1924 (and prompt (setq prompt (message "%s %c" prompt translated))))
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1925 ((and (not first) (eq translated ?\C-m))
18821
83425393d550 (read-quoted-char): Read any number of octal digits,
Richard M. Stallman <rms@gnu.org>
parents: 18044
diff changeset
1926 (setq done t))
83425393d550 (read-quoted-char): Read any number of octal digits,
Richard M. Stallman <rms@gnu.org>
parents: 18044
diff changeset
1927 ((not first)
50427
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1928 (setq unread-command-events (list char)
18821
83425393d550 (read-quoted-char): Read any number of octal digits,
Richard M. Stallman <rms@gnu.org>
parents: 18044
diff changeset
1929 done t))
50427
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1930 (t (setq code translated
18821
83425393d550 (read-quoted-char): Read any number of octal digits,
Richard M. Stallman <rms@gnu.org>
parents: 18044
diff changeset
1931 done t)))
83425393d550 (read-quoted-char): Read any number of octal digits,
Richard M. Stallman <rms@gnu.org>
parents: 18044
diff changeset
1932 (setq first nil))
19175
3d80c899a15d (read-quoted-char): Fix handling of meta-chars.
Richard M. Stallman <rms@gnu.org>
parents: 19002
diff changeset
1933 code))
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1934
57789
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1935 (defun read-passwd (prompt &optional confirm default)
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1936 "Read a password, prompting with PROMPT, and return it.
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1937 If optional CONFIRM is non-nil, read the password twice to make sure.
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1938 Optional DEFAULT is a default password to use instead of empty input.
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1939
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1940 This function echoes `.' for each character that the user types.
99629
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
1941
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
1942 The user ends with RET, LFD, or ESC. DEL or C-h rubs out.
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
1943 C-y yanks the current kill. C-u kills line.
57789
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1944 C-g quits; if `inhibit-quit' was non-nil around this function,
70901
cc60343f8fd6 (with-local-quit): When handling `quit' signal,
Richard M. Stallman <rms@gnu.org>
parents: 70897
diff changeset
1945 then it returns nil if the user types C-g, but quit-flag remains set.
57789
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1946
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1947 Once the caller uses the password, it can erase the password
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1948 by doing (clear-string STRING)."
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1949 (with-local-quit
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1950 (if confirm
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1951 (let (success)
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1952 (while (not success)
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1953 (let ((first (read-passwd prompt nil default))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1954 (second (read-passwd "Confirm password: " nil default)))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1955 (if (equal first second)
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1956 (progn
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1957 (and (arrayp second) (clear-string second))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1958 (setq success first))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1959 (and (arrayp first) (clear-string first))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1960 (and (arrayp second) (clear-string second))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1961 (message "Password not repeated accurately; please start over")
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1962 (sit-for 1))))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1963 success)
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1964 (let ((pass nil)
70897
b08d75867f7f (read-passwd): Copy PROMPT before changing its properties.
Richard M. Stallman <rms@gnu.org>
parents: 70879
diff changeset
1965 ;; Copy it so that add-text-properties won't modify
b08d75867f7f (read-passwd): Copy PROMPT before changing its properties.
Richard M. Stallman <rms@gnu.org>
parents: 70879
diff changeset
1966 ;; the object that was passed in by the caller.
b08d75867f7f (read-passwd): Copy PROMPT before changing its properties.
Richard M. Stallman <rms@gnu.org>
parents: 70879
diff changeset
1967 (prompt (copy-sequence prompt))
57789
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1968 (c 0)
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1969 (echo-keystrokes 0)
69978
cb54ae454387 (read-passwd): Bind `message-log-max' to nil.
Romain Francoise <romain@orebokech.com>
parents: 69830
diff changeset
1970 (cursor-in-echo-area t)
99632
73ea1a22b6f4 (read-passwd): Use read-event instead of read-char-exclusive.
Chong Yidong <cyd@stupidchicken.com>
parents: 99629
diff changeset
1971 (message-log-max nil)
73ea1a22b6f4 (read-passwd): Use read-event instead of read-char-exclusive.
Chong Yidong <cyd@stupidchicken.com>
parents: 99629
diff changeset
1972 (stop-keys (list 'return ?\r ?\n ?\e))
73ea1a22b6f4 (read-passwd): Use read-event instead of read-char-exclusive.
Chong Yidong <cyd@stupidchicken.com>
parents: 99629
diff changeset
1973 (rubout-keys (list 'backspace ?\b ?\177)))
67012
6b634736fd83 (read-passwd): Fontify the prompt as we do with other prompts.
Eli Zaretskii <eliz@gnu.org>
parents: 66508
diff changeset
1974 (add-text-properties 0 (length prompt)
6b634736fd83 (read-passwd): Fontify the prompt as we do with other prompts.
Eli Zaretskii <eliz@gnu.org>
parents: 66508
diff changeset
1975 minibuffer-prompt-properties prompt)
57789
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1976 (while (progn (message "%s%s"
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1977 prompt
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1978 (make-string (length pass) ?.))
104368
f700ef41d26c (read-passwd): Use read-key so keypad keys work as well.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104354
diff changeset
1979 (setq c (read-key))
99632
73ea1a22b6f4 (read-passwd): Use read-event instead of read-char-exclusive.
Chong Yidong <cyd@stupidchicken.com>
parents: 99629
diff changeset
1980 (not (memq c stop-keys)))
57789
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1981 (clear-this-command-keys)
99632
73ea1a22b6f4 (read-passwd): Use read-event instead of read-char-exclusive.
Chong Yidong <cyd@stupidchicken.com>
parents: 99629
diff changeset
1982 (cond ((memq c rubout-keys) ; rubout
73ea1a22b6f4 (read-passwd): Use read-event instead of read-char-exclusive.
Chong Yidong <cyd@stupidchicken.com>
parents: 99629
diff changeset
1983 (when (> (length pass) 0)
73ea1a22b6f4 (read-passwd): Use read-event instead of read-char-exclusive.
Chong Yidong <cyd@stupidchicken.com>
parents: 99629
diff changeset
1984 (let ((new-pass (substring pass 0 -1)))
73ea1a22b6f4 (read-passwd): Use read-event instead of read-char-exclusive.
Chong Yidong <cyd@stupidchicken.com>
parents: 99629
diff changeset
1985 (and (arrayp pass) (clear-string pass))
73ea1a22b6f4 (read-passwd): Use read-event instead of read-char-exclusive.
Chong Yidong <cyd@stupidchicken.com>
parents: 99629
diff changeset
1986 (setq pass new-pass))))
104368
f700ef41d26c (read-passwd): Use read-key so keypad keys work as well.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104354
diff changeset
1987 ((eq c ?\C-g) (keyboard-quit))
99632
73ea1a22b6f4 (read-passwd): Use read-event instead of read-char-exclusive.
Chong Yidong <cyd@stupidchicken.com>
parents: 99629
diff changeset
1988 ((not (numberp c)))
73ea1a22b6f4 (read-passwd): Use read-event instead of read-char-exclusive.
Chong Yidong <cyd@stupidchicken.com>
parents: 99629
diff changeset
1989 ((= c ?\C-u) ; kill line
99629
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
1990 (and (arrayp pass) (clear-string pass))
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
1991 (setq pass ""))
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
1992 ((= c ?\C-y) ; yank
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
1993 (let* ((str (condition-case nil
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
1994 (current-kill 0)
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
1995 (error nil)))
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
1996 new-pass)
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
1997 (when str
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
1998 (setq new-pass
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
1999 (concat pass
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
2000 (substring-no-properties str)))
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
2001 (and (arrayp pass) (clear-string pass))
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
2002 (setq c ?\0)
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
2003 (setq pass new-pass))))
99632
73ea1a22b6f4 (read-passwd): Use read-event instead of read-char-exclusive.
Chong Yidong <cyd@stupidchicken.com>
parents: 99629
diff changeset
2004 ((characterp c) ; insert char
99629
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
2005 (let* ((new-char (char-to-string c))
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
2006 (new-pass (concat pass new-char)))
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
2007 (and (arrayp pass) (clear-string pass))
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
2008 (clear-string new-char)
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
2009 (setq c ?\0)
a1ebcf06b544 (read-passwd): Yank current kill if the user enters C-y.
Chong Yidong <cyd@stupidchicken.com>
parents: 99365
diff changeset
2010 (setq pass new-pass)))))
57789
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
2011 (message nil)
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
2012 (or pass default "")))))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
2013
54570
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
2014 ;; This should be used by `call-interactively' for `n' specs.
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
2015 (defun read-number (prompt &optional default)
77359
d57bf0ca865e (read-number): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 77092
diff changeset
2016 "Read a numeric value in the minibuffer, prompting with PROMPT.
d57bf0ca865e (read-number): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 77092
diff changeset
2017 DEFAULT specifies a default value to return if the user just types RET.
d57bf0ca865e (read-number): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 77092
diff changeset
2018 The value of DEFAULT is inserted into PROMPT."
54570
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
2019 (let ((n nil))
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
2020 (when default
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
2021 (setq prompt
55891
3c32f5d8430f Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-363
Miles Bader <miles@gnu.org>
parents: 55884
diff changeset
2022 (if (string-match "\\(\\):[ \t]*\\'" prompt)
3c32f5d8430f Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-363
Miles Bader <miles@gnu.org>
parents: 55884
diff changeset
2023 (replace-match (format " (default %s)" default) t t prompt 1)
3c32f5d8430f Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-363
Miles Bader <miles@gnu.org>
parents: 55884
diff changeset
2024 (replace-regexp-in-string "[ \t]*\\'"
3c32f5d8430f Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-363
Miles Bader <miles@gnu.org>
parents: 55884
diff changeset
2025 (format " (default %s) " default)
55976
bb7bcfc53d76 (insert-buffer-substring-no-properties, insert-buffer-substring-as-yank):
Juanma Barranquero <lekktu@gmail.com>
parents: 55891
diff changeset
2026 prompt t t))))
54570
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
2027 (while
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
2028 (progn
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
2029 (let ((str (read-from-minibuffer prompt nil nil nil nil
55008
f5cafaedbab0 (read-number): Check whether `default' is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54887
diff changeset
2030 (and default
f5cafaedbab0 (read-number): Check whether `default' is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54887
diff changeset
2031 (number-to-string default)))))
77423
954d7a5a16f6 (read-number): Catch errors.
Richard M. Stallman <rms@gnu.org>
parents: 77359
diff changeset
2032 (condition-case nil
954d7a5a16f6 (read-number): Catch errors.
Richard M. Stallman <rms@gnu.org>
parents: 77359
diff changeset
2033 (setq n (cond
954d7a5a16f6 (read-number): Catch errors.
Richard M. Stallman <rms@gnu.org>
parents: 77359
diff changeset
2034 ((zerop (length str)) default)
954d7a5a16f6 (read-number): Catch errors.
Richard M. Stallman <rms@gnu.org>
parents: 77359
diff changeset
2035 ((stringp str) (read str))))
954d7a5a16f6 (read-number): Catch errors.
Richard M. Stallman <rms@gnu.org>
parents: 77359
diff changeset
2036 (error nil)))
54570
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
2037 (unless (numberp n)
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
2038 (message "Please enter a number.")
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
2039 (sit-for 1)
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
2040 t)))
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
2041 n))
71763
bedc73f663be * subr.el (sit-for): New function.
Chong Yidong <cyd@stupidchicken.com>
parents: 71726
diff changeset
2042
bedc73f663be * subr.el (sit-for): New function.
Chong Yidong <cyd@stupidchicken.com>
parents: 71726
diff changeset
2043 (defun sit-for (seconds &optional nodisp obsolete)
bedc73f663be * subr.el (sit-for): New function.
Chong Yidong <cyd@stupidchicken.com>
parents: 71726
diff changeset
2044 "Perform redisplay, then wait for SECONDS seconds or until input is available.
bedc73f663be * subr.el (sit-for): New function.
Chong Yidong <cyd@stupidchicken.com>
parents: 71726
diff changeset
2045 SECONDS may be a floating-point value.
bedc73f663be * subr.el (sit-for): New function.
Chong Yidong <cyd@stupidchicken.com>
parents: 71726
diff changeset
2046 \(On operating systems that do not support waiting for fractions of a
bedc73f663be * subr.el (sit-for): New function.
Chong Yidong <cyd@stupidchicken.com>
parents: 71726
diff changeset
2047 second, floating-point values are rounded down to the nearest integer.)
bedc73f663be * subr.el (sit-for): New function.
Chong Yidong <cyd@stupidchicken.com>
parents: 71726
diff changeset
2048
bedc73f663be * subr.el (sit-for): New function.
Chong Yidong <cyd@stupidchicken.com>
parents: 71726
diff changeset
2049 If optional arg NODISP is t, don't redisplay, just wait for input.
bedc73f663be * subr.el (sit-for): New function.
Chong Yidong <cyd@stupidchicken.com>
parents: 71726
diff changeset
2050 Redisplay does not happen if input is available before it starts.
bedc73f663be * subr.el (sit-for): New function.
Chong Yidong <cyd@stupidchicken.com>
parents: 71726
diff changeset
2051
bedc73f663be * subr.el (sit-for): New function.
Chong Yidong <cyd@stupidchicken.com>
parents: 71726
diff changeset
2052 Value is t if waited the full time with no input arriving, and nil otherwise.
bedc73f663be * subr.el (sit-for): New function.
Chong Yidong <cyd@stupidchicken.com>
parents: 71726
diff changeset
2053
71775
dbb73e0b716b (sit-for): Doc fix. Specify normal arg list using fn-form.
Kim F. Storm <storm@cua.dk>
parents: 71763
diff changeset
2054 An obsolete, but still supported form is
71763
bedc73f663be * subr.el (sit-for): New function.
Chong Yidong <cyd@stupidchicken.com>
parents: 71726
diff changeset
2055 \(sit-for SECONDS &optional MILLISECONDS NODISP)
71775
dbb73e0b716b (sit-for): Doc fix. Specify normal arg list using fn-form.
Kim F. Storm <storm@cua.dk>
parents: 71763
diff changeset
2056 where the optional arg MILLISECONDS specifies an additional wait period,
71763
bedc73f663be * subr.el (sit-for): New function.
Chong Yidong <cyd@stupidchicken.com>
parents: 71726
diff changeset
2057 in milliseconds; this was useful when Emacs was built without
105629
bdfcf9d2baaa (error, sit-for, start-process-shell-command)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105364
diff changeset
2058 floating point support."
80173
0fade0cf2913 (sit-for): Fix obsolete form for nil second argument.
Glenn Morris <rgm@gnu.org>
parents: 80023
diff changeset
2059 (if (numberp nodisp)
0fade0cf2913 (sit-for): Fix obsolete form for nil second argument.
Glenn Morris <rgm@gnu.org>
parents: 80023
diff changeset
2060 (setq seconds (+ seconds (* 1e-3 nodisp))
0fade0cf2913 (sit-for): Fix obsolete form for nil second argument.
Glenn Morris <rgm@gnu.org>
parents: 80023
diff changeset
2061 nodisp obsolete)
0fade0cf2913 (sit-for): Fix obsolete form for nil second argument.
Glenn Morris <rgm@gnu.org>
parents: 80023
diff changeset
2062 (if obsolete (setq nodisp obsolete)))
72817
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
2063 (cond
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
2064 (noninteractive
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
2065 (sleep-for seconds)
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
2066 t)
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
2067 ((input-pending-p)
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
2068 nil)
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
2069 ((<= seconds 0)
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
2070 (or nodisp (redisplay)))
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
2071 (t
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
2072 (or nodisp (redisplay))
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
2073 (let ((read (read-event nil nil seconds)))
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
2074 (or (null read)
73465
03050ee24abc (add-to-list): Optimize if compare-fn is `eq' or `eql'.
Kim F. Storm <storm@cua.dk>
parents: 73415
diff changeset
2075 (progn
03050ee24abc (add-to-list): Optimize if compare-fn is `eq' or `eql'.
Kim F. Storm <storm@cua.dk>
parents: 73415
diff changeset
2076 ;; If last command was a prefix arg, e.g. C-u, push this event onto
03050ee24abc (add-to-list): Optimize if compare-fn is `eq' or `eql'.
Kim F. Storm <storm@cua.dk>
parents: 73415
diff changeset
2077 ;; unread-command-events as (t . EVENT) so it will be added to
03050ee24abc (add-to-list): Optimize if compare-fn is `eq' or `eql'.
Kim F. Storm <storm@cua.dk>
parents: 73415
diff changeset
2078 ;; this-command-keys by read-key-sequence.
03050ee24abc (add-to-list): Optimize if compare-fn is `eq' or `eql'.
Kim F. Storm <storm@cua.dk>
parents: 73415
diff changeset
2079 (if (eq overriding-terminal-local-map universal-argument-map)
03050ee24abc (add-to-list): Optimize if compare-fn is `eq' or `eql'.
Kim F. Storm <storm@cua.dk>
parents: 73415
diff changeset
2080 (setq read (cons t read)))
03050ee24abc (add-to-list): Optimize if compare-fn is `eq' or `eql'.
Kim F. Storm <storm@cua.dk>
parents: 73415
diff changeset
2081 (push read unread-command-events)
03050ee24abc (add-to-list): Optimize if compare-fn is `eq' or `eql'.
Kim F. Storm <storm@cua.dk>
parents: 73415
diff changeset
2082 nil))))))
110356
d2f5496377e6 * subr.el (unintern): Declare the obarray arg mandatory.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109943
diff changeset
2083 (set-advertised-calling-convention 'sit-for '(seconds &optional nodisp) "22.1")
20472
79ea90039b23 (read-password): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20410
diff changeset
2084
44668
52222efc9d4d (insert-for-yank): New function.
Richard M. Stallman <rms@gnu.org>
parents: 44473
diff changeset
2085 ;;; Atomic change groups.
52222efc9d4d (insert-for-yank): New function.
Richard M. Stallman <rms@gnu.org>
parents: 44473
diff changeset
2086
43126
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2087 (defmacro atomic-change-group (&rest body)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2088 "Perform BODY as an atomic change group.
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2089 This means that if BODY exits abnormally,
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2090 all of its changes to the current buffer are undone.
46783
a4e9eb2530cb (atomic-change-group): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 46537
diff changeset
2091 This works regardless of whether undo is enabled in the buffer.
43126
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2092
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2093 This mechanism is transparent to ordinary use of undo;
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2094 if undo is enabled in the buffer and BODY succeeds, the
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2095 user can undo the change normally."
67274
a69df0269000 (atomic-change-group): Add edebug and indentation spec.
John Paul Wallington <jpw@pobox.com>
parents: 67012
diff changeset
2096 (declare (indent 0) (debug t))
43126
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2097 (let ((handle (make-symbol "--change-group-handle--"))
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2098 (success (make-symbol "--change-group-success--")))
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2099 `(let ((,handle (prepare-change-group))
79824
e9adfbf7d96e (atomic-change-group): Prevent undo list truncation.
Richard M. Stallman <rms@gnu.org>
parents: 79721
diff changeset
2100 ;; Don't truncate any undo data in the middle of this.
e9adfbf7d96e (atomic-change-group): Prevent undo list truncation.
Richard M. Stallman <rms@gnu.org>
parents: 79721
diff changeset
2101 (undo-outer-limit nil)
e9adfbf7d96e (atomic-change-group): Prevent undo list truncation.
Richard M. Stallman <rms@gnu.org>
parents: 79721
diff changeset
2102 (undo-limit most-positive-fixnum)
e9adfbf7d96e (atomic-change-group): Prevent undo list truncation.
Richard M. Stallman <rms@gnu.org>
parents: 79721
diff changeset
2103 (undo-strong-limit most-positive-fixnum)
43126
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2104 (,success nil))
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2105 (unwind-protect
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2106 (progn
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2107 ;; This is inside the unwind-protect because
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2108 ;; it enables undo if that was disabled; we need
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2109 ;; to make sure that it gets disabled again.
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2110 (activate-change-group ,handle)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2111 ,@body
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2112 (setq ,success t))
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2113 ;; Either of these functions will disable undo
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2114 ;; if it was disabled before.
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2115 (if ,success
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2116 (accept-change-group ,handle)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2117 (cancel-change-group ,handle))))))
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2118
51068
4441e202a6f4 (prepare-change-group): Reinstate BUFFER arg; make it work.
Richard M. Stallman <rms@gnu.org>
parents: 51062
diff changeset
2119 (defun prepare-change-group (&optional buffer)
43126
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2120 "Return a handle for the current buffer's state, for a change group.
51068
4441e202a6f4 (prepare-change-group): Reinstate BUFFER arg; make it work.
Richard M. Stallman <rms@gnu.org>
parents: 51062
diff changeset
2121 If you specify BUFFER, make a handle for BUFFER's state instead.
43126
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2122
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2123 Pass the handle to `activate-change-group' afterward to initiate
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2124 the actual changes of the change group.
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2125
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2126 To finish the change group, call either `accept-change-group' or
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2127 `cancel-change-group' passing the same handle as argument. Call
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2128 `accept-change-group' to accept the changes in the group as final;
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2129 call `cancel-change-group' to undo them all. You should use
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2130 `unwind-protect' to make sure the group is always finished. The call
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2131 to `activate-change-group' should be inside the `unwind-protect'.
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2132 Once you finish the group, don't use the handle again--don't try to
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2133 finish the same group twice. For a simple example of correct use, see
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2134 the source code of `atomic-change-group'.
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2135
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2136 The handle records only the specified buffer. To make a multibuffer
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2137 change group, call this function once for each buffer you want to
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2138 cover, then use `nconc' to combine the returned values, like this:
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2139
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2140 (nconc (prepare-change-group buffer-1)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2141 (prepare-change-group buffer-2))
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2142
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2143 You can then activate that multibuffer change group with a single
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2144 call to `activate-change-group' and finish it with a single call
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2145 to `accept-change-group' or `cancel-change-group'."
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2146
51068
4441e202a6f4 (prepare-change-group): Reinstate BUFFER arg; make it work.
Richard M. Stallman <rms@gnu.org>
parents: 51062
diff changeset
2147 (if buffer
4441e202a6f4 (prepare-change-group): Reinstate BUFFER arg; make it work.
Richard M. Stallman <rms@gnu.org>
parents: 51062
diff changeset
2148 (list (cons buffer (with-current-buffer buffer buffer-undo-list)))
4441e202a6f4 (prepare-change-group): Reinstate BUFFER arg; make it work.
Richard M. Stallman <rms@gnu.org>
parents: 51062
diff changeset
2149 (list (cons (current-buffer) buffer-undo-list))))
43126
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2150
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2151 (defun activate-change-group (handle)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2152 "Activate a change group made with `prepare-change-group' (which see)."
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2153 (dolist (elt handle)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2154 (with-current-buffer (car elt)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2155 (if (eq buffer-undo-list t)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2156 (setq buffer-undo-list nil)))))
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2157
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2158 (defun accept-change-group (handle)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2159 "Finish a change group made with `prepare-change-group' (which see).
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2160 This finishes the change group by accepting its changes as final."
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2161 (dolist (elt handle)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2162 (with-current-buffer (car elt)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2163 (if (eq elt t)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2164 (setq buffer-undo-list t)))))
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2165
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2166 (defun cancel-change-group (handle)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2167 "Finish a change group made with `prepare-change-group' (which see).
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2168 This finishes the change group by reverting all of its changes."
80023
ac327929a12c (cancel-change-group): Improve last fix.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 80022
diff changeset
2169 (dolist (elt handle)
ac327929a12c (cancel-change-group): Improve last fix.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 80022
diff changeset
2170 (with-current-buffer (car elt)
ac327929a12c (cancel-change-group): Improve last fix.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 80022
diff changeset
2171 (setq elt (cdr elt))
98071
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2172 (save-restriction
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2173 ;; Widen buffer temporarily so if the buffer was narrowed within
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2174 ;; the body of `atomic-change-group' all changes can be undone.
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2175 (widen)
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2176 (let ((old-car
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2177 (if (consp elt) (car elt)))
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2178 (old-cdr
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2179 (if (consp elt) (cdr elt))))
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2180 ;; Temporarily truncate the undo log at ELT.
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2181 (when (consp elt)
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2182 (setcar elt nil) (setcdr elt nil))
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2183 (unless (eq last-command 'undo) (undo-start))
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2184 ;; Make sure there's no confusion.
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2185 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2186 (error "Undoing to some unrelated state"))
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2187 ;; Undo it all.
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2188 (save-excursion
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2189 (while (listp pending-undo-list) (undo-more 1)))
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2190 ;; Reset the modified cons cell ELT to its original content.
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2191 (when (consp elt)
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2192 (setcar elt old-car)
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2193 (setcdr elt old-cdr))
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2194 ;; Revert the undo info to what it was when we grabbed the state.
c94db6d7eda9 (cancel-change-group): Widen buffer temporarily when
Martin Rudalics <rudalics@gmx.at>
parents: 98026
diff changeset
2195 (setq buffer-undo-list elt))))))
43126
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
2196
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2197 ;;;; Display-related functions.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2198
44285
30505fab0350 (redraw-modeline): Define alias.
Richard M. Stallman <rms@gnu.org>
parents: 44251
diff changeset
2199 ;; For compatibility.
30505fab0350 (redraw-modeline): Define alias.
Richard M. Stallman <rms@gnu.org>
parents: 44251
diff changeset
2200 (defalias 'redraw-modeline 'force-mode-line-update)
30505fab0350 (redraw-modeline): Define alias.
Richard M. Stallman <rms@gnu.org>
parents: 44251
diff changeset
2201
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
2202 (defun force-mode-line-update (&optional all)
52858
b4112065d679 (force-mode-line-update): Fix docstring.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
2203 "Force redisplay of the current buffer's mode line and header line.
b4112065d679 (force-mode-line-update): Fix docstring.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
2204 With optional non-nil ALL, force redisplay of all mode lines and
b4112065d679 (force-mode-line-update): Fix docstring.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
2205 header lines. This function also forces recomputation of the
b4112065d679 (force-mode-line-update): Fix docstring.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
2206 menu bar menus and the frame title."
104354
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
2207 (if all (with-current-buffer (other-buffer)))
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
2208 (set-buffer-modified-p (buffer-modified-p)))
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
2209
41618
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2210 (defun momentary-string-display (string pos &optional exit-char message)
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
2211 "Momentarily display STRING in the buffer at POS.
55187
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
2212 Display remains until next event is input.
75063
394073868e11 (momentary-string-display): After moving point, set POS variable to it to avoid
Juanma Barranquero <lekktu@gmail.com>
parents: 74597
diff changeset
2213 If POS is a marker, only its position is used; its buffer is ignored.
55187
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
2214 Optional third arg EXIT-CHAR can be a character, event or event
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
2215 description list. EXIT-CHAR defaults to SPC. If the input is
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
2216 EXIT-CHAR it is swallowed; otherwise it is then available as
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
2217 input (as a command if nothing else).
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
2218 Display MESSAGE (optional fourth arg) in the echo area.
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
2219 If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there."
74242
f4d1181a38c2 (momentary-string-display): "?\ " -> "?\s".
Juanma Barranquero <lekktu@gmail.com>
parents: 74085
diff changeset
2220 (or exit-char (setq exit-char ?\s))
95778
c9b3cb8a81ec (momentary-string-display): Use an overlay.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 95757
diff changeset
2221 (let ((ol (make-overlay pos pos))
107329
4e1ca27d938e Close bug#5670 with patch from ª©?tª£?pªª¢Ân Nª£?mec <stepnem at gmail.com>.
Glenn Morris <rgm@gnu.org>
parents: 107201
diff changeset
2222 (str (copy-sequence string)))
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
2223 (unwind-protect
95778
c9b3cb8a81ec (momentary-string-display): Use an overlay.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 95757
diff changeset
2224 (progn
c9b3cb8a81ec (momentary-string-display): Use an overlay.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 95757
diff changeset
2225 (save-excursion
107329
4e1ca27d938e Close bug#5670 with patch from ª©?tª£?pªª¢Ân Nª£?mec <stepnem at gmail.com>.
Glenn Morris <rgm@gnu.org>
parents: 107201
diff changeset
2226 (overlay-put ol 'after-string str)
95778
c9b3cb8a81ec (momentary-string-display): Use an overlay.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 95757
diff changeset
2227 (goto-char pos)
c9b3cb8a81ec (momentary-string-display): Use an overlay.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 95757
diff changeset
2228 ;; To avoid trouble with out-of-bounds position
c9b3cb8a81ec (momentary-string-display): Use an overlay.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 95757
diff changeset
2229 (setq pos (point))
107329
4e1ca27d938e Close bug#5670 with patch from ª©?tª£?pªª¢Ân Nª£?mec <stepnem at gmail.com>.
Glenn Morris <rgm@gnu.org>
parents: 107201
diff changeset
2230 ;; If the string end is off screen, recenter now.
95778
c9b3cb8a81ec (momentary-string-display): Use an overlay.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 95757
diff changeset
2231 (if (<= (window-end nil t) pos)
c9b3cb8a81ec (momentary-string-display): Use an overlay.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 95757
diff changeset
2232 (recenter (/ (window-height) 2))))
c9b3cb8a81ec (momentary-string-display): Use an overlay.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 95757
diff changeset
2233 (message (or message "Type %s to continue editing.")
c9b3cb8a81ec (momentary-string-display): Use an overlay.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 95757
diff changeset
2234 (single-key-description exit-char))
108675
e3df298f4131 Fix for momentary-string-display (Bug#6238).
Chong Yidong <cyd@stupidchicken.com>
parents: 108661
diff changeset
2235 (let ((event (read-event)))
e3df298f4131 Fix for momentary-string-display (Bug#6238).
Chong Yidong <cyd@stupidchicken.com>
parents: 108661
diff changeset
2236 ;; `exit-char' can be an event, or an event description list.
e3df298f4131 Fix for momentary-string-display (Bug#6238).
Chong Yidong <cyd@stupidchicken.com>
parents: 108661
diff changeset
2237 (or (eq event exit-char)
e3df298f4131 Fix for momentary-string-display (Bug#6238).
Chong Yidong <cyd@stupidchicken.com>
parents: 108661
diff changeset
2238 (eq event (event-convert-list exit-char))
e3df298f4131 Fix for momentary-string-display (Bug#6238).
Chong Yidong <cyd@stupidchicken.com>
parents: 108661
diff changeset
2239 (setq unread-command-events (list event)))))
95778
c9b3cb8a81ec (momentary-string-display): Use an overlay.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 95757
diff changeset
2240 (delete-overlay ol))))
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
2241
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
2242
41618
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2243 ;;;; Overlay operations
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2244
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2245 (defun copy-overlay (o)
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2246 "Return a copy of overlay O."
107132
6429fc34756a * subr.el (copy-overlay): Handle deleted overlays.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 106815
diff changeset
2247 (let ((o1 (if (overlay-buffer o)
6429fc34756a * subr.el (copy-overlay): Handle deleted overlays.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 106815
diff changeset
2248 (make-overlay (overlay-start o) (overlay-end o)
6429fc34756a * subr.el (copy-overlay): Handle deleted overlays.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 106815
diff changeset
2249 ;; FIXME: there's no easy way to find the
6429fc34756a * subr.el (copy-overlay): Handle deleted overlays.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 106815
diff changeset
2250 ;; insertion-type of the two markers.
6429fc34756a * subr.el (copy-overlay): Handle deleted overlays.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 106815
diff changeset
2251 (overlay-buffer o))
6429fc34756a * subr.el (copy-overlay): Handle deleted overlays.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 106815
diff changeset
2252 (let ((o1 (make-overlay (point-min) (point-min))))
6429fc34756a * subr.el (copy-overlay): Handle deleted overlays.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 106815
diff changeset
2253 (delete-overlay o1)
107133
a0d4034e4be0 (copy-overlay): Damn typo.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 107132
diff changeset
2254 o1)))
41618
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2255 (props (overlay-properties o)))
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2256 (while props
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2257 (overlay-put o1 (pop props) (pop props)))
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2258 o1))
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2259
55202
4c64ee838f41 * subr.el (remove-overlays): Make arguments optional.
Masatake YAMATO <jet@gyve.org>
parents: 55187
diff changeset
2260 (defun remove-overlays (&optional beg end name val)
41618
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2261 "Clear BEG and END of overlays whose property NAME has value VAL.
55477
e191e6d1554e (remove-overlays, read-passwd): Fix docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55406
diff changeset
2262 Overlays might be moved and/or split.
e191e6d1554e (remove-overlays, read-passwd): Fix docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55406
diff changeset
2263 BEG and END default respectively to the beginning and end of buffer."
73829
201aa7c21cab (remove-overlays): Call overlay-recenter.
Richard M. Stallman <rms@gnu.org>
parents: 73555
diff changeset
2264 ;; This speeds up the loops over overlays.
55202
4c64ee838f41 * subr.el (remove-overlays): Make arguments optional.
Masatake YAMATO <jet@gyve.org>
parents: 55187
diff changeset
2265 (unless beg (setq beg (point-min)))
4c64ee838f41 * subr.el (remove-overlays): Make arguments optional.
Masatake YAMATO <jet@gyve.org>
parents: 55187
diff changeset
2266 (unless end (setq end (point-max)))
73943
882d43d66c71 (remove-overlays): Fix last change.
Richard M. Stallman <rms@gnu.org>
parents: 73831
diff changeset
2267 (overlay-recenter end)
41618
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2268 (if (< end beg)
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2269 (setq beg (prog1 end (setq end beg))))
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2270 (save-excursion
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2271 (dolist (o (overlays-in beg end))
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2272 (when (eq (overlay-get o name) val)
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2273 ;; Either push this overlay outside beg...end
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2274 ;; or split it to exclude beg...end
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2275 ;; or delete it entirely (if it is contained in beg...end).
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2276 (if (< (overlay-start o) beg)
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2277 (if (> (overlay-end o) end)
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2278 (progn
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2279 (move-overlay (copy-overlay o)
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2280 (overlay-start o) beg)
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2281 (move-overlay o end (overlay-end o)))
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2282 (move-overlay o (overlay-start o) beg))
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2283 (if (> (overlay-end o) end)
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2284 (move-overlay o end (overlay-end o))
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2285 (delete-overlay o)))))))
42917
ec2db12c7670 (copy-without-properties): New function.
Richard M. Stallman <rms@gnu.org>
parents: 42266
diff changeset
2286
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
2287 ;;;; Miscellanea.
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
2288
20846
985a277c9b9a (suspend-hook, suspend-resume-hook): New defvars.
Richard M. Stallman <rms@gnu.org>
parents: 20687
diff changeset
2289 (defvar suspend-hook nil
985a277c9b9a (suspend-hook, suspend-resume-hook): New defvars.
Richard M. Stallman <rms@gnu.org>
parents: 20687
diff changeset
2290 "Normal hook run by `suspend-emacs', before suspending.")
985a277c9b9a (suspend-hook, suspend-resume-hook): New defvars.
Richard M. Stallman <rms@gnu.org>
parents: 20687
diff changeset
2291
985a277c9b9a (suspend-hook, suspend-resume-hook): New defvars.
Richard M. Stallman <rms@gnu.org>
parents: 20687
diff changeset
2292 (defvar suspend-resume-hook nil
985a277c9b9a (suspend-hook, suspend-resume-hook): New defvars.
Richard M. Stallman <rms@gnu.org>
parents: 20687
diff changeset
2293 "Normal hook run by `suspend-emacs', after Emacs is continued.")
985a277c9b9a (suspend-hook, suspend-resume-hook): New defvars.
Richard M. Stallman <rms@gnu.org>
parents: 20687
diff changeset
2294
42083
981f93cc55d1 (temp-buffer-show-hook, temp-buffer-setup-hook): Add defvars.
Richard M. Stallman <rms@gnu.org>
parents: 42076
diff changeset
2295 (defvar temp-buffer-show-hook nil
981f93cc55d1 (temp-buffer-show-hook, temp-buffer-setup-hook): Add defvars.
Richard M. Stallman <rms@gnu.org>
parents: 42076
diff changeset
2296 "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer.
981f93cc55d1 (temp-buffer-show-hook, temp-buffer-setup-hook): Add defvars.
Richard M. Stallman <rms@gnu.org>
parents: 42076
diff changeset
2297 When the hook runs, the temporary buffer is current, and the window it
97625
cd9442c3d522 (temp-buffer-show-hook): Doc fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 97142
diff changeset
2298 was displayed in is selected.")
42083
981f93cc55d1 (temp-buffer-show-hook, temp-buffer-setup-hook): Add defvars.
Richard M. Stallman <rms@gnu.org>
parents: 42076
diff changeset
2299
981f93cc55d1 (temp-buffer-show-hook, temp-buffer-setup-hook): Add defvars.
Richard M. Stallman <rms@gnu.org>
parents: 42076
diff changeset
2300 (defvar temp-buffer-setup-hook nil
981f93cc55d1 (temp-buffer-show-hook, temp-buffer-setup-hook): Add defvars.
Richard M. Stallman <rms@gnu.org>
parents: 42076
diff changeset
2301 "Normal hook run by `with-output-to-temp-buffer' at the start.
981f93cc55d1 (temp-buffer-show-hook, temp-buffer-setup-hook): Add defvars.
Richard M. Stallman <rms@gnu.org>
parents: 42076
diff changeset
2302 When the hook runs, the temporary buffer is current.
981f93cc55d1 (temp-buffer-show-hook, temp-buffer-setup-hook): Add defvars.
Richard M. Stallman <rms@gnu.org>
parents: 42076
diff changeset
2303 This hook is normally set up with a function to put the buffer in Help
981f93cc55d1 (temp-buffer-show-hook, temp-buffer-setup-hook): Add defvars.
Richard M. Stallman <rms@gnu.org>
parents: 42076
diff changeset
2304 mode.")
981f93cc55d1 (temp-buffer-show-hook, temp-buffer-setup-hook): Add defvars.
Richard M. Stallman <rms@gnu.org>
parents: 42076
diff changeset
2305
10254
1ac3c8fea14a (font-lock-defaults): Add defvar.
Richard M. Stallman <rms@gnu.org>
parents: 10178
diff changeset
2306 ;; Avoid compiler warnings about this variable,
1ac3c8fea14a (font-lock-defaults): Add defvar.
Richard M. Stallman <rms@gnu.org>
parents: 10178
diff changeset
2307 ;; which has a special meaning on certain system types.
1ac3c8fea14a (font-lock-defaults): Add defvar.
Richard M. Stallman <rms@gnu.org>
parents: 10178
diff changeset
2308 (defvar buffer-file-type nil
1ac3c8fea14a (font-lock-defaults): Add defvar.
Richard M. Stallman <rms@gnu.org>
parents: 10178
diff changeset
2309 "Non-nil if the visited file is a binary file.
1ac3c8fea14a (font-lock-defaults): Add defvar.
Richard M. Stallman <rms@gnu.org>
parents: 10178
diff changeset
2310 This variable is meaningful on MS-DOG and Windows NT.
1ac3c8fea14a (font-lock-defaults): Add defvar.
Richard M. Stallman <rms@gnu.org>
parents: 10178
diff changeset
2311 On those systems, it is automatically local in every buffer.
1ac3c8fea14a (font-lock-defaults): Add defvar.
Richard M. Stallman <rms@gnu.org>
parents: 10178
diff changeset
2312 On other systems, this variable is normally always nil.")
68492
f4d24a8eaed1 (toplevel): Define `cl-assertion-failed' condition here because the
John Paul Wallington <jpw@pobox.com>
parents: 68400
diff changeset
2313
f4d24a8eaed1 (toplevel): Define `cl-assertion-failed' condition here because the
John Paul Wallington <jpw@pobox.com>
parents: 68400
diff changeset
2314 ;; The `assert' macro from the cl package signals
f4d24a8eaed1 (toplevel): Define `cl-assertion-failed' condition here because the
John Paul Wallington <jpw@pobox.com>
parents: 68400
diff changeset
2315 ;; `cl-assertion-failed' at runtime so always define it.
f4d24a8eaed1 (toplevel): Define `cl-assertion-failed' condition here because the
John Paul Wallington <jpw@pobox.com>
parents: 68400
diff changeset
2316 (put 'cl-assertion-failed 'error-conditions '(error))
105939
a0f778f4a995 * term/x-win.el (x-gtk-stock-map):
Dan Nicolaescu <dann@ics.uci.edu>
parents: 105763
diff changeset
2317 (put 'cl-assertion-failed 'error-message (purecopy "Assertion failed"))
68492
f4d24a8eaed1 (toplevel): Define `cl-assertion-failed' condition here because the
John Paul Wallington <jpw@pobox.com>
parents: 68400
diff changeset
2318
81338
62535fec6ee1 (user-emacs-directory): New defconst.
Chong Yidong <cyd@stupidchicken.com>
parents: 77423
diff changeset
2319 (defconst user-emacs-directory
62535fec6ee1 (user-emacs-directory): New defconst.
Chong Yidong <cyd@stupidchicken.com>
parents: 77423
diff changeset
2320 (if (eq system-type 'ms-dos)
62535fec6ee1 (user-emacs-directory): New defconst.
Chong Yidong <cyd@stupidchicken.com>
parents: 77423
diff changeset
2321 ;; MS-DOS cannot have initial dot.
62535fec6ee1 (user-emacs-directory): New defconst.
Chong Yidong <cyd@stupidchicken.com>
parents: 77423
diff changeset
2322 "~/_emacs.d/"
62535fec6ee1 (user-emacs-directory): New defconst.
Chong Yidong <cyd@stupidchicken.com>
parents: 77423
diff changeset
2323 "~/.emacs.d/")
62535fec6ee1 (user-emacs-directory): New defconst.
Chong Yidong <cyd@stupidchicken.com>
parents: 77423
diff changeset
2324 "Directory beneath which additional per-user Emacs-specific files are placed.
62535fec6ee1 (user-emacs-directory): New defconst.
Chong Yidong <cyd@stupidchicken.com>
parents: 77423
diff changeset
2325 Various programs in Emacs store information in this directory.
99106
814d2d823dd7 New function `locate-user-emacs-file'.
Juanma Barranquero <lekktu@gmail.com>
parents: 98949
diff changeset
2326 Note that this should end with a directory separator.
814d2d823dd7 New function `locate-user-emacs-file'.
Juanma Barranquero <lekktu@gmail.com>
parents: 98949
diff changeset
2327 See also `locate-user-emacs-file'.")
814d2d823dd7 New function `locate-user-emacs-file'.
Juanma Barranquero <lekktu@gmail.com>
parents: 98949
diff changeset
2328
814d2d823dd7 New function `locate-user-emacs-file'.
Juanma Barranquero <lekktu@gmail.com>
parents: 98949
diff changeset
2329 (defun locate-user-emacs-file (new-name &optional old-name)
814d2d823dd7 New function `locate-user-emacs-file'.
Juanma Barranquero <lekktu@gmail.com>
parents: 98949
diff changeset
2330 "Return an absolute per-user Emacs-specific file name.
814d2d823dd7 New function `locate-user-emacs-file'.
Juanma Barranquero <lekktu@gmail.com>
parents: 98949
diff changeset
2331 If OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME.
814d2d823dd7 New function `locate-user-emacs-file'.
Juanma Barranquero <lekktu@gmail.com>
parents: 98949
diff changeset
2332 Else return NEW-NAME in `user-emacs-directory', creating the
814d2d823dd7 New function `locate-user-emacs-file'.
Juanma Barranquero <lekktu@gmail.com>
parents: 98949
diff changeset
2333 directory if it does not exist."
814d2d823dd7 New function `locate-user-emacs-file'.
Juanma Barranquero <lekktu@gmail.com>
parents: 98949
diff changeset
2334 (convert-standard-filename
814d2d823dd7 New function `locate-user-emacs-file'.
Juanma Barranquero <lekktu@gmail.com>
parents: 98949
diff changeset
2335 (let* ((home (concat "~" (or init-file-user "")))
814d2d823dd7 New function `locate-user-emacs-file'.
Juanma Barranquero <lekktu@gmail.com>
parents: 98949
diff changeset
2336 (at-home (and old-name (expand-file-name old-name home))))
814d2d823dd7 New function `locate-user-emacs-file'.
Juanma Barranquero <lekktu@gmail.com>
parents: 98949
diff changeset
2337 (if (and at-home (file-readable-p at-home))
814d2d823dd7 New function `locate-user-emacs-file'.
Juanma Barranquero <lekktu@gmail.com>
parents: 98949
diff changeset
2338 at-home
99184
fc215de0bf93 * subr.el (locate-user-emacs-file): Simplify. Don't create
Juanma Barranquero <lekktu@gmail.com>
parents: 99124
diff changeset
2339 ;; Make sure `user-emacs-directory' exists,
fc215de0bf93 * subr.el (locate-user-emacs-file): Simplify. Don't create
Juanma Barranquero <lekktu@gmail.com>
parents: 99124
diff changeset
2340 ;; unless we're in batch mode or dumping Emacs
fc215de0bf93 * subr.el (locate-user-emacs-file): Simplify. Don't create
Juanma Barranquero <lekktu@gmail.com>
parents: 99124
diff changeset
2341 (or noninteractive
fc215de0bf93 * subr.el (locate-user-emacs-file): Simplify. Don't create
Juanma Barranquero <lekktu@gmail.com>
parents: 99124
diff changeset
2342 purify-flag
112266
704fa1a3d5b4 Make last-resort backup file in .emacs.d (Bug#6953).
Chong Yidong <cyd@stupidchicken.com>
parents: 112262
diff changeset
2343 (file-accessible-directory-p
704fa1a3d5b4 Make last-resort backup file in .emacs.d (Bug#6953).
Chong Yidong <cyd@stupidchicken.com>
parents: 112262
diff changeset
2344 (directory-file-name user-emacs-directory))
704fa1a3d5b4 Make last-resort backup file in .emacs.d (Bug#6953).
Chong Yidong <cyd@stupidchicken.com>
parents: 112262
diff changeset
2345 (let ((umask (default-file-modes)))
704fa1a3d5b4 Make last-resort backup file in .emacs.d (Bug#6953).
Chong Yidong <cyd@stupidchicken.com>
parents: 112262
diff changeset
2346 (unwind-protect
704fa1a3d5b4 Make last-resort backup file in .emacs.d (Bug#6953).
Chong Yidong <cyd@stupidchicken.com>
parents: 112262
diff changeset
2347 (progn
704fa1a3d5b4 Make last-resort backup file in .emacs.d (Bug#6953).
Chong Yidong <cyd@stupidchicken.com>
parents: 112262
diff changeset
2348 (set-default-file-modes ?\700)
704fa1a3d5b4 Make last-resort backup file in .emacs.d (Bug#6953).
Chong Yidong <cyd@stupidchicken.com>
parents: 112262
diff changeset
2349 (make-directory user-emacs-directory))
704fa1a3d5b4 Make last-resort backup file in .emacs.d (Bug#6953).
Chong Yidong <cyd@stupidchicken.com>
parents: 112262
diff changeset
2350 (set-default-file-modes umask))))
104354
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
2351 (abbreviate-file-name
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
2352 (expand-file-name new-name user-emacs-directory))))))
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2353
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2354 ;;;; Misc. useful functions.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2355
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2356 (defun find-tag-default ()
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2357 "Determine default tag to search for, based on text at point.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2358 If there is no plausible default, return nil."
88001
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2359 (let (from to bound)
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2360 (when (or (progn
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2361 ;; Look at text around `point'.
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2362 (save-excursion
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2363 (skip-syntax-backward "w_") (setq from (point)))
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2364 (save-excursion
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2365 (skip-syntax-forward "w_") (setq to (point)))
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2366 (> to from))
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2367 ;; Look between `line-beginning-position' and `point'.
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2368 (save-excursion
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2369 (and (setq bound (line-beginning-position))
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2370 (skip-syntax-backward "^w_" bound)
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2371 (> (setq to (point)) bound)
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2372 (skip-syntax-backward "w_")
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2373 (setq from (point))))
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2374 ;; Look between `point' and `line-end-position'.
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2375 (save-excursion
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2376 (and (setq bound (line-end-position))
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2377 (skip-syntax-forward "^w_" bound)
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2378 (< (setq from (point)) bound)
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2379 (skip-syntax-forward "w_")
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2380 (setq to (point)))))
6cd236e3935c (find-tag-default): Simplify using exclusively
Martin Rudalics <rudalics@gmx.at>
parents: 87974
diff changeset
2381 (buffer-substring-no-properties from to))))
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2382
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2383 (defun play-sound (sound)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2384 "SOUND is a list of the form `(sound KEYWORD VALUE...)'.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2385 The following keywords are recognized:
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2386
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2387 :file FILE - read sound data from FILE. If FILE isn't an
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2388 absolute file name, it is searched in `data-directory'.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2389
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2390 :data DATA - read sound data from string DATA.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2391
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2392 Exactly one of :file or :data must be present.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2393
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2394 :volume VOL - set volume to VOL. VOL must an integer in the
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2395 range 0..100 or a float in the range 0..1.0. If not specified,
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2396 don't change the volume setting of the sound device.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2397
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2398 :device DEVICE - play sound on DEVICE. If not specified,
101142
1df37db69e4d * subr.el (play-sound): Doc fix. (Bug#250)
Juanma Barranquero <lekktu@gmail.com>
parents: 101082
diff changeset
2399 a system-dependent default device name is used.
1df37db69e4d * subr.el (play-sound): Doc fix. (Bug#250)
Juanma Barranquero <lekktu@gmail.com>
parents: 101082
diff changeset
2400
1df37db69e4d * subr.el (play-sound): Doc fix. (Bug#250)
Juanma Barranquero <lekktu@gmail.com>
parents: 101082
diff changeset
2401 Note: :data and :device are currently not supported on Windows."
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2402 (if (fboundp 'play-sound-internal)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2403 (play-sound-internal sound)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2404 (error "This Emacs binary lacks sound support")))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2405
86221
d6b46513e321 (w32-shell-dos-semantics): Declare as function.
Glenn Morris <rgm@gnu.org>
parents: 86172
diff changeset
2406 (declare-function w32-shell-dos-semantics "w32-fns" nil)
d6b46513e321 (w32-shell-dos-semantics): Declare as function.
Glenn Morris <rgm@gnu.org>
parents: 86172
diff changeset
2407
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2408 (defun shell-quote-argument (argument)
101142
1df37db69e4d * subr.el (play-sound): Doc fix. (Bug#250)
Juanma Barranquero <lekktu@gmail.com>
parents: 101082
diff changeset
2409 "Quote ARGUMENT for passing as argument to an inferior shell."
73125
c637565b16e8 (shell-quote-argument): Use DOS logic for Windows shells with DOS semantics.
Jason Rumney <jasonr@gnu.org>
parents: 73028
diff changeset
2410 (if (or (eq system-type 'ms-dos)
c637565b16e8 (shell-quote-argument): Use DOS logic for Windows shells with DOS semantics.
Jason Rumney <jasonr@gnu.org>
parents: 73028
diff changeset
2411 (and (eq system-type 'windows-nt) (w32-shell-dos-semantics)))
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2412 ;; Quote using double quotes, but escape any existing quotes in
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2413 ;; the argument with backslashes.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2414 (let ((result "")
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2415 (start 0)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2416 end)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2417 (if (or (null (string-match "[^\"]" argument))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2418 (< (match-end 0) (length argument)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2419 (while (string-match "[\"]" argument start)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2420 (setq end (match-beginning 0)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2421 result (concat result (substring argument start end)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2422 "\\" (substring argument end (1+ end)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2423 start (1+ end))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2424 (concat "\"" result (substring argument start) "\""))
73125
c637565b16e8 (shell-quote-argument): Use DOS logic for Windows shells with DOS semantics.
Jason Rumney <jasonr@gnu.org>
parents: 73028
diff changeset
2425 (if (equal argument "")
c637565b16e8 (shell-quote-argument): Use DOS logic for Windows shells with DOS semantics.
Jason Rumney <jasonr@gnu.org>
parents: 73028
diff changeset
2426 "''"
c637565b16e8 (shell-quote-argument): Use DOS logic for Windows shells with DOS semantics.
Jason Rumney <jasonr@gnu.org>
parents: 73028
diff changeset
2427 ;; Quote everything except POSIX filename characters.
c637565b16e8 (shell-quote-argument): Use DOS logic for Windows shells with DOS semantics.
Jason Rumney <jasonr@gnu.org>
parents: 73028
diff changeset
2428 ;; This should be safe enough even for really weird shells.
c637565b16e8 (shell-quote-argument): Use DOS logic for Windows shells with DOS semantics.
Jason Rumney <jasonr@gnu.org>
parents: 73028
diff changeset
2429 (let ((result "") (start 0) end)
c637565b16e8 (shell-quote-argument): Use DOS logic for Windows shells with DOS semantics.
Jason Rumney <jasonr@gnu.org>
parents: 73028
diff changeset
2430 (while (string-match "[^-0-9a-zA-Z_./]" argument start)
c637565b16e8 (shell-quote-argument): Use DOS logic for Windows shells with DOS semantics.
Jason Rumney <jasonr@gnu.org>
parents: 73028
diff changeset
2431 (setq end (match-beginning 0)
c637565b16e8 (shell-quote-argument): Use DOS logic for Windows shells with DOS semantics.
Jason Rumney <jasonr@gnu.org>
parents: 73028
diff changeset
2432 result (concat result (substring argument start end)
c637565b16e8 (shell-quote-argument): Use DOS logic for Windows shells with DOS semantics.
Jason Rumney <jasonr@gnu.org>
parents: 73028
diff changeset
2433 "\\" (substring argument end (1+ end)))
c637565b16e8 (shell-quote-argument): Use DOS logic for Windows shells with DOS semantics.
Jason Rumney <jasonr@gnu.org>
parents: 73028
diff changeset
2434 start (1+ end)))
c637565b16e8 (shell-quote-argument): Use DOS logic for Windows shells with DOS semantics.
Jason Rumney <jasonr@gnu.org>
parents: 73028
diff changeset
2435 (concat result (substring argument start))))))
69830
196122ba0b05 * subr.el (string-or-null-p): New function.
Reiner Steib <Reiner.Steib@gmx.de>
parents: 69168
diff changeset
2436
196122ba0b05 * subr.el (string-or-null-p): New function.
Reiner Steib <Reiner.Steib@gmx.de>
parents: 69168
diff changeset
2437 (defun string-or-null-p (object)
196122ba0b05 * subr.el (string-or-null-p): New function.
Reiner Steib <Reiner.Steib@gmx.de>
parents: 69168
diff changeset
2438 "Return t if OBJECT is a string or nil.
196122ba0b05 * subr.el (string-or-null-p): New function.
Reiner Steib <Reiner.Steib@gmx.de>
parents: 69168
diff changeset
2439 Otherwise, return nil."
196122ba0b05 * subr.el (string-or-null-p): New function.
Reiner Steib <Reiner.Steib@gmx.de>
parents: 69168
diff changeset
2440 (or (stringp object) (null object)))
196122ba0b05 * subr.el (string-or-null-p): New function.
Reiner Steib <Reiner.Steib@gmx.de>
parents: 69168
diff changeset
2441
70267
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
2442 (defun booleanp (object)
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
2443 "Return non-nil if OBJECT is one of the two canonical boolean values: t or nil."
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
2444 (memq object '(nil t)))
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
2445
70552
1121231ccc23 Revision: emacs@sv.gnu.org/emacs--devo--0--patch-271
Miles Bader <miles@gnu.org>
parents: 70547
diff changeset
2446 (defun field-at-pos (pos)
101142
1df37db69e4d * subr.el (play-sound): Doc fix. (Bug#250)
Juanma Barranquero <lekktu@gmail.com>
parents: 101082
diff changeset
2447 "Return the field at position POS, taking stickiness etc into account."
70547
e184fae4f7dd (field-at-point): New function.
Nick Roberts <nickrob@snap.net.nz>
parents: 70512
diff changeset
2448 (let ((raw-field (get-char-property (field-beginning pos) 'field)))
e184fae4f7dd (field-at-point): New function.
Nick Roberts <nickrob@snap.net.nz>
parents: 70512
diff changeset
2449 (if (eq raw-field 'boundary)
e184fae4f7dd (field-at-point): New function.
Nick Roberts <nickrob@snap.net.nz>
parents: 70512
diff changeset
2450 (get-char-property (1- (field-end pos)) 'field)
e184fae4f7dd (field-at-point): New function.
Nick Roberts <nickrob@snap.net.nz>
parents: 70512
diff changeset
2451 raw-field)))
e184fae4f7dd (field-at-point): New function.
Nick Roberts <nickrob@snap.net.nz>
parents: 70512
diff changeset
2452
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2453
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2454 ;;;; Support for yanking and text properties.
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
2455
44668
52222efc9d4d (insert-for-yank): New function.
Richard M. Stallman <rms@gnu.org>
parents: 44473
diff changeset
2456 (defvar yank-excluded-properties)
52222efc9d4d (insert-for-yank): New function.
Richard M. Stallman <rms@gnu.org>
parents: 44473
diff changeset
2457
44980
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2458 (defun remove-yank-excluded-properties (start end)
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2459 "Remove `yank-excluded-properties' between START and END positions.
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2460 Replaces `category' properties with their defined properties."
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2461 (let ((inhibit-read-only t))
107201
79d3f11c8368 subr.el (remove-yank-excluded-properties): Explain in a comment why `category'
Eli Zaretskii <eliz@gnu.org>
parents: 107133
diff changeset
2462 ;; Replace any `category' property with the properties it stands
79d3f11c8368 subr.el (remove-yank-excluded-properties): Explain in a comment why `category'
Eli Zaretskii <eliz@gnu.org>
parents: 107133
diff changeset
2463 ;; for. This is to remove `mouse-face' properties that are placed
79d3f11c8368 subr.el (remove-yank-excluded-properties): Explain in a comment why `category'
Eli Zaretskii <eliz@gnu.org>
parents: 107133
diff changeset
2464 ;; on categories in *Help* buffers' buttons. See
79d3f11c8368 subr.el (remove-yank-excluded-properties): Explain in a comment why `category'
Eli Zaretskii <eliz@gnu.org>
parents: 107133
diff changeset
2465 ;; http://lists.gnu.org/archive/html/emacs-devel/2002-04/msg00648.html
79d3f11c8368 subr.el (remove-yank-excluded-properties): Explain in a comment why `category'
Eli Zaretskii <eliz@gnu.org>
parents: 107133
diff changeset
2466 ;; for the details.
44980
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2467 (unless (memq yank-excluded-properties '(t nil))
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2468 (save-excursion
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2469 (goto-char start)
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2470 (while (< (point) end)
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2471 (let ((cat (get-text-property (point) 'category))
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2472 run-end)
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2473 (setq run-end
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2474 (next-single-property-change (point) 'category nil end))
47675
cb548fe4bcdb (remove-yank-excluded-properties): Fix bugs in handling of category properties.
Richard M. Stallman <rms@gnu.org>
parents: 47652
diff changeset
2475 (when cat
cb548fe4bcdb (remove-yank-excluded-properties): Fix bugs in handling of category properties.
Richard M. Stallman <rms@gnu.org>
parents: 47652
diff changeset
2476 (let (run-end2 original)
cb548fe4bcdb (remove-yank-excluded-properties): Fix bugs in handling of category properties.
Richard M. Stallman <rms@gnu.org>
parents: 47652
diff changeset
2477 (remove-list-of-text-properties (point) run-end '(category))
cb548fe4bcdb (remove-yank-excluded-properties): Fix bugs in handling of category properties.
Richard M. Stallman <rms@gnu.org>
parents: 47652
diff changeset
2478 (while (< (point) run-end)
cb548fe4bcdb (remove-yank-excluded-properties): Fix bugs in handling of category properties.
Richard M. Stallman <rms@gnu.org>
parents: 47652
diff changeset
2479 (setq run-end2 (next-property-change (point) nil run-end))
cb548fe4bcdb (remove-yank-excluded-properties): Fix bugs in handling of category properties.
Richard M. Stallman <rms@gnu.org>
parents: 47652
diff changeset
2480 (setq original (text-properties-at (point)))
cb548fe4bcdb (remove-yank-excluded-properties): Fix bugs in handling of category properties.
Richard M. Stallman <rms@gnu.org>
parents: 47652
diff changeset
2481 (set-text-properties (point) run-end2 (symbol-plist cat))
cb548fe4bcdb (remove-yank-excluded-properties): Fix bugs in handling of category properties.
Richard M. Stallman <rms@gnu.org>
parents: 47652
diff changeset
2482 (add-text-properties (point) run-end2 original)
cb548fe4bcdb (remove-yank-excluded-properties): Fix bugs in handling of category properties.
Richard M. Stallman <rms@gnu.org>
parents: 47652
diff changeset
2483 (goto-char run-end2))))
cb548fe4bcdb (remove-yank-excluded-properties): Fix bugs in handling of category properties.
Richard M. Stallman <rms@gnu.org>
parents: 47652
diff changeset
2484 (goto-char run-end)))))
44980
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2485 (if (eq yank-excluded-properties t)
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2486 (set-text-properties start end nil)
47675
cb548fe4bcdb (remove-yank-excluded-properties): Fix bugs in handling of category properties.
Richard M. Stallman <rms@gnu.org>
parents: 47652
diff changeset
2487 (remove-list-of-text-properties start end yank-excluded-properties))))
44980
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2488
49310
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2489 (defvar yank-undo-function)
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2490
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2491 (defun insert-for-yank (string)
53368
6dab9150c9e0 (insert-for-yank): Call insert-for-yank-1 repetitively
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53197
diff changeset
2492 "Calls `insert-for-yank-1' repetitively for each `yank-handler' segment.
6dab9150c9e0 (insert-for-yank): Call insert-for-yank-1 repetitively
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53197
diff changeset
2493
6dab9150c9e0 (insert-for-yank): Call insert-for-yank-1 repetitively
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53197
diff changeset
2494 See `insert-for-yank-1' for more details."
6dab9150c9e0 (insert-for-yank): Call insert-for-yank-1 repetitively
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53197
diff changeset
2495 (let (to)
6dab9150c9e0 (insert-for-yank): Call insert-for-yank-1 repetitively
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53197
diff changeset
2496 (while (setq to (next-single-property-change 0 'yank-handler string))
6dab9150c9e0 (insert-for-yank): Call insert-for-yank-1 repetitively
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53197
diff changeset
2497 (insert-for-yank-1 (substring string 0 to))
6dab9150c9e0 (insert-for-yank): Call insert-for-yank-1 repetitively
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53197
diff changeset
2498 (setq string (substring string to))))
6dab9150c9e0 (insert-for-yank): Call insert-for-yank-1 repetitively
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53197
diff changeset
2499 (insert-for-yank-1 string))
6dab9150c9e0 (insert-for-yank): Call insert-for-yank-1 repetitively
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53197
diff changeset
2500
6dab9150c9e0 (insert-for-yank): Call insert-for-yank-1 repetitively
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53197
diff changeset
2501 (defun insert-for-yank-1 (string)
49310
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2502 "Insert STRING at point, stripping some text properties.
53368
6dab9150c9e0 (insert-for-yank): Call insert-for-yank-1 repetitively
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53197
diff changeset
2503
49310
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2504 Strip text properties from the inserted text according to
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2505 `yank-excluded-properties'. Otherwise just like (insert STRING).
44723
f5b7b7055a64 (insert-buffer-substring-no-properties): New function.
Kim F. Storm <storm@cua.dk>
parents: 44668
diff changeset
2506
49363
7bf92531d421 Tiny doc fixes.
Kim F. Storm <storm@cua.dk>
parents: 49318
diff changeset
2507 If STRING has a non-nil `yank-handler' property on the first character,
63258
bd20f5cf580f (insert-for-yank-1): Fix spellings in docstrings.
Juanma Barranquero <lekktu@gmail.com>
parents: 63151
diff changeset
2508 the normal insert behavior is modified in various ways. The value of
65014
3aa61588445b (insert-for-yank-1): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 64792
diff changeset
2509 the yank-handler property must be a list with one to four elements
49492
a144c40bb984 (insert-for-yank): Remove COMMAND element from yank handler.
Kim F. Storm <storm@cua.dk>
parents: 49363
diff changeset
2510 with the following format: (FUNCTION PARAM NOEXCLUDE UNDO).
49310
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2511 When FUNCTION is present and non-nil, it is called instead of `insert'
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2512 to insert the string. FUNCTION takes one argument--the object to insert.
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2513 If PARAM is present and non-nil, it replaces STRING as the object
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2514 passed to FUNCTION (or `insert'); for example, if FUNCTION is
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2515 `yank-rectangle', PARAM may be a list of strings to insert as a
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2516 rectangle.
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2517 If NOEXCLUDE is present and non-nil, the normal removal of the
111936
0a0aa7fbe2ca Doc fixes.
Glenn Morris <rgm@gnu.org>
parents: 111905
diff changeset
2518 `yank-excluded-properties' is not performed; instead FUNCTION is
49310
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2519 responsible for removing those properties. This may be necessary
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2520 if FUNCTION adjusts point before or after inserting the object.
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2521 If UNDO is present and non-nil, it is a function that will be called
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2522 by `yank-pop' to undo the insertion of the current object. It is
49597
e88404e8f2cf Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49492
diff changeset
2523 called with two arguments, the start and end of the current region.
49492
a144c40bb984 (insert-for-yank): Remove COMMAND element from yank handler.
Kim F. Storm <storm@cua.dk>
parents: 49363
diff changeset
2524 FUNCTION may set `yank-undo-function' to override the UNDO value."
49318
63a122cc4286 (insert-for-yank): Set yank-undo-function after calling FUNCTION,
Kim F. Storm <storm@cua.dk>
parents: 49313
diff changeset
2525 (let* ((handler (and (stringp string)
63a122cc4286 (insert-for-yank): Set yank-undo-function after calling FUNCTION,
Kim F. Storm <storm@cua.dk>
parents: 49313
diff changeset
2526 (get-text-property 0 'yank-handler string)))
63a122cc4286 (insert-for-yank): Set yank-undo-function after calling FUNCTION,
Kim F. Storm <storm@cua.dk>
parents: 49313
diff changeset
2527 (param (or (nth 1 handler) string))
73153
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2528 (opoint (point))
75748
8c99ad9fd6c0 (insert-for-yank-1): Prevent read-only properties from interfering
Chong Yidong <cyd@stupidchicken.com>
parents: 75347
diff changeset
2529 (inhibit-read-only inhibit-read-only)
73153
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2530 end)
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2531
49318
63a122cc4286 (insert-for-yank): Set yank-undo-function after calling FUNCTION,
Kim F. Storm <storm@cua.dk>
parents: 49313
diff changeset
2532 (setq yank-undo-function t)
63a122cc4286 (insert-for-yank): Set yank-undo-function after calling FUNCTION,
Kim F. Storm <storm@cua.dk>
parents: 49313
diff changeset
2533 (if (nth 0 handler) ;; FUNCTION
63a122cc4286 (insert-for-yank): Set yank-undo-function after calling FUNCTION,
Kim F. Storm <storm@cua.dk>
parents: 49313
diff changeset
2534 (funcall (car handler) param)
49310
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2535 (insert param))
73153
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2536 (setq end (point))
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2537
75748
8c99ad9fd6c0 (insert-for-yank-1): Prevent read-only properties from interfering
Chong Yidong <cyd@stupidchicken.com>
parents: 75347
diff changeset
2538 ;; Prevent read-only properties from interfering with the
8c99ad9fd6c0 (insert-for-yank-1): Prevent read-only properties from interfering
Chong Yidong <cyd@stupidchicken.com>
parents: 75347
diff changeset
2539 ;; following text property changes.
8c99ad9fd6c0 (insert-for-yank-1): Prevent read-only properties from interfering
Chong Yidong <cyd@stupidchicken.com>
parents: 75347
diff changeset
2540 (setq inhibit-read-only t)
8c99ad9fd6c0 (insert-for-yank-1): Prevent read-only properties from interfering
Chong Yidong <cyd@stupidchicken.com>
parents: 75347
diff changeset
2541
73153
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2542 ;; What should we do with `font-lock-face' properties?
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2543 (if font-lock-defaults
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2544 ;; No, just wipe them.
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2545 (remove-list-of-text-properties opoint end '(font-lock-face))
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2546 ;; Convert them to `face'.
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2547 (save-excursion
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2548 (goto-char opoint)
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2549 (while (< (point) end)
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2550 (let ((face (get-text-property (point) 'font-lock-face))
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2551 run-end)
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2552 (setq run-end
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2553 (next-single-property-change (point) 'font-lock-face nil end))
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2554 (when face
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2555 (remove-text-properties (point) run-end '(font-lock-face nil))
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2556 (put-text-property (point) run-end 'face face))
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2557 (goto-char run-end)))))
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2558
49318
63a122cc4286 (insert-for-yank): Set yank-undo-function after calling FUNCTION,
Kim F. Storm <storm@cua.dk>
parents: 49313
diff changeset
2559 (unless (nth 2 handler) ;; NOEXCLUDE
49310
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2560 (remove-yank-excluded-properties opoint (point)))
73415
56ea5a847db0 (insert-for-yank-1): If last inserted char has properties,
Richard M. Stallman <rms@gnu.org>
parents: 73357
diff changeset
2561
56ea5a847db0 (insert-for-yank-1): If last inserted char has properties,
Richard M. Stallman <rms@gnu.org>
parents: 73357
diff changeset
2562 ;; If last inserted char has properties, mark them as rear-nonsticky.
56ea5a847db0 (insert-for-yank-1): If last inserted char has properties,
Richard M. Stallman <rms@gnu.org>
parents: 73357
diff changeset
2563 (if (and (> end opoint)
56ea5a847db0 (insert-for-yank-1): If last inserted char has properties,
Richard M. Stallman <rms@gnu.org>
parents: 73357
diff changeset
2564 (text-properties-at (1- end)))
56ea5a847db0 (insert-for-yank-1): If last inserted char has properties,
Richard M. Stallman <rms@gnu.org>
parents: 73357
diff changeset
2565 (put-text-property (1- end) end 'rear-nonsticky t))
56ea5a847db0 (insert-for-yank-1): If last inserted char has properties,
Richard M. Stallman <rms@gnu.org>
parents: 73357
diff changeset
2566
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
2567 (if (eq yank-undo-function t) ;; not set by FUNCTION
49318
63a122cc4286 (insert-for-yank): Set yank-undo-function after calling FUNCTION,
Kim F. Storm <storm@cua.dk>
parents: 49313
diff changeset
2568 (setq yank-undo-function (nth 3 handler))) ;; UNDO
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
2569 (if (nth 4 handler) ;; COMMAND
49318
63a122cc4286 (insert-for-yank): Set yank-undo-function after calling FUNCTION,
Kim F. Storm <storm@cua.dk>
parents: 49313
diff changeset
2570 (setq this-command (nth 4 handler)))))
49597
e88404e8f2cf Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49492
diff changeset
2571
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
2572 (defun insert-buffer-substring-no-properties (buffer &optional start end)
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
2573 "Insert before point a substring of BUFFER, without text properties.
44723
f5b7b7055a64 (insert-buffer-substring-no-properties): New function.
Kim F. Storm <storm@cua.dk>
parents: 44668
diff changeset
2574 BUFFER may be a buffer or a buffer name.
55976
bb7bcfc53d76 (insert-buffer-substring-no-properties, insert-buffer-substring-as-yank):
Juanma Barranquero <lekktu@gmail.com>
parents: 55891
diff changeset
2575 Arguments START and END are character positions specifying the substring.
bb7bcfc53d76 (insert-buffer-substring-no-properties, insert-buffer-substring-as-yank):
Juanma Barranquero <lekktu@gmail.com>
parents: 55891
diff changeset
2576 They default to the values of (point-min) and (point-max) in BUFFER."
44723
f5b7b7055a64 (insert-buffer-substring-no-properties): New function.
Kim F. Storm <storm@cua.dk>
parents: 44668
diff changeset
2577 (let ((opoint (point)))
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
2578 (insert-buffer-substring buffer start end)
44723
f5b7b7055a64 (insert-buffer-substring-no-properties): New function.
Kim F. Storm <storm@cua.dk>
parents: 44668
diff changeset
2579 (let ((inhibit-read-only t))
f5b7b7055a64 (insert-buffer-substring-no-properties): New function.
Kim F. Storm <storm@cua.dk>
parents: 44668
diff changeset
2580 (set-text-properties opoint (point) nil))))
f5b7b7055a64 (insert-buffer-substring-no-properties): New function.
Kim F. Storm <storm@cua.dk>
parents: 44668
diff changeset
2581
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
2582 (defun insert-buffer-substring-as-yank (buffer &optional start end)
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
2583 "Insert before point a part of BUFFER, stripping some text properties.
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
2584 BUFFER may be a buffer or a buffer name.
55976
bb7bcfc53d76 (insert-buffer-substring-no-properties, insert-buffer-substring-as-yank):
Juanma Barranquero <lekktu@gmail.com>
parents: 55891
diff changeset
2585 Arguments START and END are character positions specifying the substring.
bb7bcfc53d76 (insert-buffer-substring-no-properties, insert-buffer-substring-as-yank):
Juanma Barranquero <lekktu@gmail.com>
parents: 55891
diff changeset
2586 They default to the values of (point-min) and (point-max) in BUFFER.
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
2587 Strip text properties from the inserted text according to
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
2588 `yank-excluded-properties'."
52379
541533296a1d Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 52132
diff changeset
2589 ;; Since the buffer text should not normally have yank-handler properties,
541533296a1d Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 52132
diff changeset
2590 ;; there is no need to handle them here.
44723
f5b7b7055a64 (insert-buffer-substring-no-properties): New function.
Kim F. Storm <storm@cua.dk>
parents: 44668
diff changeset
2591 (let ((opoint (point)))
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
2592 (insert-buffer-substring buffer start end)
44980
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2593 (remove-yank-excluded-properties opoint (point))))
44723
f5b7b7055a64 (insert-buffer-substring-no-properties): New function.
Kim F. Storm <storm@cua.dk>
parents: 44668
diff changeset
2594
44668
52222efc9d4d (insert-for-yank): New function.
Richard M. Stallman <rms@gnu.org>
parents: 44473
diff changeset
2595
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2596 ;;;; Synchronous shell commands.
44668
52222efc9d4d (insert-for-yank): New function.
Richard M. Stallman <rms@gnu.org>
parents: 44473
diff changeset
2597
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
2598 (defun start-process-shell-command (name buffer &rest args)
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
2599 "Start a program in a subprocess. Return the process object for it.
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
2600 NAME is name for process. It is modified if necessary to make it unique.
55502
75efe89a09b7 (start-process-shell-command): Fix docstring. Put usage info in a format usable
Juanma Barranquero <lekktu@gmail.com>
parents: 55477
diff changeset
2601 BUFFER is the buffer (or buffer name) to associate with the process.
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
2602 Process output goes at end of that buffer, unless you specify
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
2603 an output stream or filter function to handle the output.
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
2604 BUFFER may be also nil, meaning that this process is not associated
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
2605 with any buffer
104354
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
2606 COMMAND is the shell command to run.
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
2607
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
2608 An old calling convention accepted any number of arguments after COMMAND,
7d0f4f179b3d * subr.el (listify-key-sequence-1): Use normal syntax since those
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104215
diff changeset
2609 which were just concatenated to COMMAND. This is still supported but strongly
105629
bdfcf9d2baaa (error, sit-for, start-process-shell-command)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105364
diff changeset
2610 discouraged."
10025
3b058e13d177 (start-process-shell-command): Don't use `exec'--
Richard M. Stallman <rms@gnu.org>
parents: 9986
diff changeset
2611 ;; We used to use `exec' to replace the shell with the command,
3b058e13d177 (start-process-shell-command): Don't use `exec'--
Richard M. Stallman <rms@gnu.org>
parents: 9986
diff changeset
2612 ;; but that failed to handle (...) and semicolon, etc.
97142
c3512b2085a0 * bitmaps/README:
Dan Nicolaescu <dann@ics.uci.edu>
parents: 96361
diff changeset
2613 (start-process name buffer shell-file-name shell-command-switch
c3512b2085a0 * bitmaps/README:
Dan Nicolaescu <dann@ics.uci.edu>
parents: 96361
diff changeset
2614 (mapconcat 'identity args " ")))
105631
7cea65998c1f * subr.el (error, sit-for, start-process-shell-command)
Juanma Barranquero <lekktu@gmail.com>
parents: 105629
diff changeset
2615 (set-advertised-calling-convention 'start-process-shell-command
110356
d2f5496377e6 * subr.el (unintern): Declare the obarray arg mandatory.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109943
diff changeset
2616 '(name buffer command) "23.1")
105631
7cea65998c1f * subr.el (error, sit-for, start-process-shell-command)
Juanma Barranquero <lekktu@gmail.com>
parents: 105629
diff changeset
2617
82094
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2618 (defun start-file-process-shell-command (name buffer &rest args)
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2619 "Start a program in a subprocess. Return the process object for it.
105629
bdfcf9d2baaa (error, sit-for, start-process-shell-command)
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105364
diff changeset
2620 Similar to `start-process-shell-command', but calls `start-file-process'."
82094
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2621 (start-file-process
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2622 name buffer
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2623 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2624 (if (file-remote-p default-directory) "-c" shell-command-switch)
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2625 (mapconcat 'identity args " ")))
105631
7cea65998c1f * subr.el (error, sit-for, start-process-shell-command)
Juanma Barranquero <lekktu@gmail.com>
parents: 105629
diff changeset
2626 (set-advertised-calling-convention 'start-file-process-shell-command
110356
d2f5496377e6 * subr.el (unintern): Declare the obarray arg mandatory.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 109943
diff changeset
2627 '(name buffer command) "23.1")
82094
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2628
39598
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2629 (defun call-process-shell-command (command &optional infile buffer display
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2630 &rest args)
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2631 "Execute the shell command COMMAND synchronously in separate process.
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2632 The remaining arguments are optional.
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2633 The program's input comes from file INFILE (nil means `/dev/null').
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2634 Insert output in BUFFER before point; t means current buffer;
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2635 nil for BUFFER means discard it; 0 means discard and don't wait.
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2636 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2637 REAL-BUFFER says what to do with standard output, as above,
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2638 while STDERR-FILE says what to do with standard error in the child.
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2639 STDERR-FILE may be nil (discard standard error output),
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2640 t (mix it with ordinary output), or a file name string.
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2641
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2642 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2643 Remaining arguments are strings passed as additional arguments for COMMAND.
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2644 Wildcards and redirection are handled as usual in the shell.
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2645
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2646 If BUFFER is 0, `call-process-shell-command' returns immediately with value nil.
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2647 Otherwise it waits for COMMAND to terminate and returns a numeric exit
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2648 status or a signal description string.
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2649 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
97142
c3512b2085a0 * bitmaps/README:
Dan Nicolaescu <dann@ics.uci.edu>
parents: 96361
diff changeset
2650 ;; We used to use `exec' to replace the shell with the command,
c3512b2085a0 * bitmaps/README:
Dan Nicolaescu <dann@ics.uci.edu>
parents: 96361
diff changeset
2651 ;; but that failed to handle (...) and semicolon, etc.
c3512b2085a0 * bitmaps/README:
Dan Nicolaescu <dann@ics.uci.edu>
parents: 96361
diff changeset
2652 (call-process shell-file-name
c3512b2085a0 * bitmaps/README:
Dan Nicolaescu <dann@ics.uci.edu>
parents: 96361
diff changeset
2653 infile buffer display
c3512b2085a0 * bitmaps/README:
Dan Nicolaescu <dann@ics.uci.edu>
parents: 96361
diff changeset
2654 shell-command-switch
c3512b2085a0 * bitmaps/README:
Dan Nicolaescu <dann@ics.uci.edu>
parents: 96361
diff changeset
2655 (mapconcat 'identity (cons command args) " ")))
82094
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2656
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2657 (defun process-file-shell-command (command &optional infile buffer display
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2658 &rest args)
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2659 "Process files synchronously in a separate process.
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2660 Similar to `call-process-shell-command', but calls `process-file'."
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2661 (process-file
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2662 (if (file-remote-p default-directory) "/bin/sh" shell-file-name)
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2663 infile buffer display
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2664 (if (file-remote-p default-directory) "-c" shell-command-switch)
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2665 (mapconcat 'identity (cons command args) " ")))
16359
18cc78dc8b18 (with-temp-file): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16333
diff changeset
2666
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2667 ;;;; Lisp macros to do various things temporarily.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2668
99124
a96e658622b6 (with-current-buffer): Rename buffer argument to buffer-or-name.
Martin Rudalics <rudalics@gmx.at>
parents: 99106
diff changeset
2669 (defmacro with-current-buffer (buffer-or-name &rest body)
a96e658622b6 (with-current-buffer): Rename buffer argument to buffer-or-name.
Martin Rudalics <rudalics@gmx.at>
parents: 99106
diff changeset
2670 "Execute the forms in BODY with BUFFER-OR-NAME temporarily current.
a96e658622b6 (with-current-buffer): Rename buffer argument to buffer-or-name.
Martin Rudalics <rudalics@gmx.at>
parents: 99106
diff changeset
2671 BUFFER-OR-NAME must be a buffer or the name of an existing buffer.
a96e658622b6 (with-current-buffer): Rename buffer argument to buffer-or-name.
Martin Rudalics <rudalics@gmx.at>
parents: 99106
diff changeset
2672 The value returned is the value of the last form in BODY. See
a96e658622b6 (with-current-buffer): Rename buffer argument to buffer-or-name.
Martin Rudalics <rudalics@gmx.at>
parents: 99106
diff changeset
2673 also `with-temp-buffer'."
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2674 (declare (indent 1) (debug t))
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2675 `(save-current-buffer
99124
a96e658622b6 (with-current-buffer): Rename buffer argument to buffer-or-name.
Martin Rudalics <rudalics@gmx.at>
parents: 99106
diff changeset
2676 (set-buffer ,buffer-or-name)
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2677 ,@body))
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2678
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2679 (defmacro with-selected-window (window &rest body)
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2680 "Execute the forms in BODY with WINDOW as the selected window.
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2681 The value returned is the value of the last form in BODY.
63761
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2682
99327
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2683 This macro saves and restores the selected window, as well as the
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2684 selected window of each frame. It does not change the order of
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2685 recently selected windows. If the previously selected window of
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2686 some frame is no longer live at the end of BODY, that frame's
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2687 selected window is left alone. If the selected window is no
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2688 longer live, then whatever window is selected at the end of BODY
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2689 remains selected.
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2690
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2691 This macro uses `save-current-buffer' to save and restore the
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2692 current buffer, since otherwise its normal operation could
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2693 potentially make a different buffer current. It does not alter
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2694 the buffer list ordering."
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2695 (declare (indent 1) (debug t))
55828
af9432138635 (with-selected-window): Undo previous change.
Richard M. Stallman <rms@gnu.org>
parents: 55812
diff changeset
2696 ;; Most of this code is a copy of save-selected-window.
af9432138635 (with-selected-window): Undo previous change.
Richard M. Stallman <rms@gnu.org>
parents: 55812
diff changeset
2697 `(let ((save-selected-window-window (selected-window))
af9432138635 (with-selected-window): Undo previous change.
Richard M. Stallman <rms@gnu.org>
parents: 55812
diff changeset
2698 ;; It is necessary to save all of these, because calling
af9432138635 (with-selected-window): Undo previous change.
Richard M. Stallman <rms@gnu.org>
parents: 55812
diff changeset
2699 ;; select-window changes frame-selected-window for whatever
af9432138635 (with-selected-window): Undo previous change.
Richard M. Stallman <rms@gnu.org>
parents: 55812
diff changeset
2700 ;; frame that window is in.
af9432138635 (with-selected-window): Undo previous change.
Richard M. Stallman <rms@gnu.org>
parents: 55812
diff changeset
2701 (save-selected-window-alist
af9432138635 (with-selected-window): Undo previous change.
Richard M. Stallman <rms@gnu.org>
parents: 55812
diff changeset
2702 (mapcar (lambda (frame) (list frame (frame-selected-window frame)))
af9432138635 (with-selected-window): Undo previous change.
Richard M. Stallman <rms@gnu.org>
parents: 55812
diff changeset
2703 (frame-list))))
63761
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2704 (save-current-buffer
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2705 (unwind-protect
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2706 (progn (select-window ,window 'norecord)
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2707 ,@body)
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2708 (dolist (elt save-selected-window-alist)
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2709 (and (frame-live-p (car elt))
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2710 (window-live-p (cadr elt))
99327
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2711 (set-frame-selected-window (car elt) (cadr elt) 'norecord)))
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2712 (when (window-live-p save-selected-window-window)
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2713 (select-window save-selected-window-window 'norecord))))))
16277
bbddbc86b82b (with-current-buffer): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 15983
diff changeset
2714
83128
2ccd88cfde01 New control structure: with-selected-frame.
Karoly Lorentey <lorentey@elte.hu>
parents: 55520
diff changeset
2715 (defmacro with-selected-frame (frame &rest body)
2ccd88cfde01 New control structure: with-selected-frame.
Karoly Lorentey <lorentey@elte.hu>
parents: 55520
diff changeset
2716 "Execute the forms in BODY with FRAME as the selected frame.
2ccd88cfde01 New control structure: with-selected-frame.
Karoly Lorentey <lorentey@elte.hu>
parents: 55520
diff changeset
2717 The value returned is the value of the last form in BODY.
99327
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2718
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2719 This macro neither changes the order of recently selected windows
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2720 nor the buffer list."
83128
2ccd88cfde01 New control structure: with-selected-frame.
Karoly Lorentey <lorentey@elte.hu>
parents: 55520
diff changeset
2721 (declare (indent 1) (debug t))
83488
f47495b26508 Fix ediff problems. (Reported by Dan Nicolaescu.)
Karoly Lorentey <lorentey@elte.hu>
parents: 83483
diff changeset
2722 (let ((old-frame (make-symbol "old-frame"))
f47495b26508 Fix ediff problems. (Reported by Dan Nicolaescu.)
Karoly Lorentey <lorentey@elte.hu>
parents: 83483
diff changeset
2723 (old-buffer (make-symbol "old-buffer")))
f47495b26508 Fix ediff problems. (Reported by Dan Nicolaescu.)
Karoly Lorentey <lorentey@elte.hu>
parents: 83483
diff changeset
2724 `(let ((,old-frame (selected-frame))
f47495b26508 Fix ediff problems. (Reported by Dan Nicolaescu.)
Karoly Lorentey <lorentey@elte.hu>
parents: 83483
diff changeset
2725 (,old-buffer (current-buffer)))
f47495b26508 Fix ediff problems. (Reported by Dan Nicolaescu.)
Karoly Lorentey <lorentey@elte.hu>
parents: 83483
diff changeset
2726 (unwind-protect
99327
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2727 (progn (select-frame ,frame 'norecord)
83488
f47495b26508 Fix ediff problems. (Reported by Dan Nicolaescu.)
Karoly Lorentey <lorentey@elte.hu>
parents: 83483
diff changeset
2728 ,@body)
99327
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2729 (when (frame-live-p ,old-frame)
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2730 (select-frame ,old-frame 'norecord))
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2731 (when (buffer-live-p ,old-buffer)
d646820f5ba2 (with-selected-window): Call set-frame-selected-window
Martin Rudalics <rudalics@gmx.at>
parents: 99184
diff changeset
2732 (set-buffer ,old-buffer))))))
83128
2ccd88cfde01 New control structure: with-selected-frame.
Karoly Lorentey <lorentey@elte.hu>
parents: 55520
diff changeset
2733
23736
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2734 (defmacro with-temp-file (file &rest body)
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2735 "Create a new buffer, evaluate BODY there, and write the buffer to FILE.
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2736 The value returned is the value of the last form in BODY.
16379
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2737 See also `with-temp-buffer'."
51611
d201fdadadce (looking-back): Handle the case of non-trivial regexps.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 51339
diff changeset
2738 (declare (debug t))
16359
18cc78dc8b18 (with-temp-file): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16333
diff changeset
2739 (let ((temp-file (make-symbol "temp-file"))
16379
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2740 (temp-buffer (make-symbol "temp-buffer")))
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2741 `(let ((,temp-file ,file)
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2742 (,temp-buffer
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2743 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2744 (unwind-protect
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2745 (prog1
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2746 (with-current-buffer ,temp-buffer
23736
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2747 ,@body)
16379
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2748 (with-current-buffer ,temp-buffer
95366
52e3cee99f90 * progmodes/flymake.el (flymake-save-buffer-in-file):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 94703
diff changeset
2749 (write-region nil nil ,temp-file nil 0)))
16379
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2750 (and (buffer-name ,temp-buffer)
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2751 (kill-buffer ,temp-buffer))))))
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2752
23736
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2753 (defmacro with-temp-message (message &rest body)
24011
f36caedebd5f Doc fix.
Simon Marshall <simon@gnu.org>
parents: 24000
diff changeset
2754 "Display MESSAGE temporarily if non-nil while BODY is evaluated.
23736
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2755 The original message is restored to the echo area after BODY has finished.
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2756 The value returned is the value of the last form in BODY.
24011
f36caedebd5f Doc fix.
Simon Marshall <simon@gnu.org>
parents: 24000
diff changeset
2757 MESSAGE is written to the message log buffer if `message-log-max' is non-nil.
f36caedebd5f Doc fix.
Simon Marshall <simon@gnu.org>
parents: 24000
diff changeset
2758 If MESSAGE is nil, the echo area and message log buffer are unchanged.
f36caedebd5f Doc fix.
Simon Marshall <simon@gnu.org>
parents: 24000
diff changeset
2759 Use a MESSAGE of \"\" to temporarily clear the echo area."
51611
d201fdadadce (looking-back): Handle the case of non-trivial regexps.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 51339
diff changeset
2760 (declare (debug t))
24000
2de7db40964d (with-temp-message): Don't display MESSAGE if nil.
Simon Marshall <simon@gnu.org>
parents: 23907
diff changeset
2761 (let ((current-message (make-symbol "current-message"))
2de7db40964d (with-temp-message): Don't display MESSAGE if nil.
Simon Marshall <simon@gnu.org>
parents: 23907
diff changeset
2762 (temp-message (make-symbol "with-temp-message")))
2de7db40964d (with-temp-message): Don't display MESSAGE if nil.
Simon Marshall <simon@gnu.org>
parents: 23907
diff changeset
2763 `(let ((,temp-message ,message)
2de7db40964d (with-temp-message): Don't display MESSAGE if nil.
Simon Marshall <simon@gnu.org>
parents: 23907
diff changeset
2764 (,current-message))
23736
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2765 (unwind-protect
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2766 (progn
24000
2de7db40964d (with-temp-message): Don't display MESSAGE if nil.
Simon Marshall <simon@gnu.org>
parents: 23907
diff changeset
2767 (when ,temp-message
2de7db40964d (with-temp-message): Don't display MESSAGE if nil.
Simon Marshall <simon@gnu.org>
parents: 23907
diff changeset
2768 (setq ,current-message (current-message))
24699
1ce8c890309e (with-temp-message): Fix the other call to message to use %s.
Karl Heuer <kwzh@gnu.org>
parents: 24385
diff changeset
2769 (message "%s" ,temp-message))
23736
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2770 ,@body)
42076
d6765861f6ea (with-temp-message): At the end, always discard
Richard M. Stallman <rms@gnu.org>
parents: 41975
diff changeset
2771 (and ,temp-message
d6765861f6ea (with-temp-message): At the end, always discard
Richard M. Stallman <rms@gnu.org>
parents: 41975
diff changeset
2772 (if ,current-message
d6765861f6ea (with-temp-message): At the end, always discard
Richard M. Stallman <rms@gnu.org>
parents: 41975
diff changeset
2773 (message "%s" ,current-message)
d6765861f6ea (with-temp-message): At the end, always discard
Richard M. Stallman <rms@gnu.org>
parents: 41975
diff changeset
2774 (message nil)))))))
23736
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2775
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2776 (defmacro with-temp-buffer (&rest body)
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2777 "Create a temporary buffer, and evaluate BODY there like `progn'.
16379
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2778 See also `with-temp-file' and `with-output-to-string'."
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2779 (declare (indent 0) (debug t))
16379
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2780 (let ((temp-buffer (make-symbol "temp-buffer")))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
2781 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
93396
c15f559a5ada (with-temp-buffer): Assume kill-buffer can change current-buffer.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93204
diff changeset
2782 ;; FIXME: kill-buffer can change current-buffer in some odd cases.
c15f559a5ada (with-temp-buffer): Assume kill-buffer can change current-buffer.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93204
diff changeset
2783 (with-current-buffer ,temp-buffer
c15f559a5ada (with-temp-buffer): Assume kill-buffer can change current-buffer.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93204
diff changeset
2784 (unwind-protect
c15f559a5ada (with-temp-buffer): Assume kill-buffer can change current-buffer.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93204
diff changeset
2785 (progn ,@body)
c15f559a5ada (with-temp-buffer): Assume kill-buffer can change current-buffer.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93204
diff changeset
2786 (and (buffer-name ,temp-buffer)
c15f559a5ada (with-temp-buffer): Assume kill-buffer can change current-buffer.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93204
diff changeset
2787 (kill-buffer ,temp-buffer)))))))
16379
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2788
104880
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2789 (defmacro with-silent-modifications (&rest body)
111936
0a0aa7fbe2ca Doc fixes.
Glenn Morris <rgm@gnu.org>
parents: 111905
diff changeset
2790 "Execute BODY, pretending it does not modify the buffer.
104880
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2791 If BODY performs real modifications to the buffer's text, other
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2792 than cosmetic ones, undo data may become corrupted.
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2793 Typically used around modifications of text-properties which do not really
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2794 affect the buffer's content."
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2795 (declare (debug t) (indent 0))
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2796 (let ((modified (make-symbol "modified")))
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2797 `(let* ((,modified (buffer-modified-p))
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2798 (buffer-undo-list t)
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2799 (inhibit-read-only t)
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2800 (inhibit-modification-hooks t)
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2801 deactivate-mark
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2802 ;; Avoid setting and removing file locks and checking
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2803 ;; buffer's uptodate-ness w.r.t the underlying file.
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2804 buffer-file-name
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2805 buffer-file-truename)
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2806 (unwind-protect
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2807 (progn
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2808 ,@body)
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2809 (unless ,modified
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2810 (restore-buffer-modified-p nil))))))
02bf3383a22f (with-silent-modifications): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 104737
diff changeset
2811
16311
a56a8c6f2d8f (with-output-to-string): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16294
diff changeset
2812 (defmacro with-output-to-string (&rest body)
a56a8c6f2d8f (with-output-to-string): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16294
diff changeset
2813 "Execute BODY, return the text it sent to `standard-output', as a string."
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2814 (declare (indent 0) (debug t))
16379
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2815 `(let ((standard-output
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2816 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
98315
5053145089c9 (with-output-to-string): Make sure that the temporary buffer gets
Romain Francoise <romain@orebokech.com>
parents: 98071
diff changeset
2817 (unwind-protect
5053145089c9 (with-output-to-string): Make sure that the temporary buffer gets
Romain Francoise <romain@orebokech.com>
parents: 98071
diff changeset
2818 (progn
5053145089c9 (with-output-to-string): Make sure that the temporary buffer gets
Romain Francoise <romain@orebokech.com>
parents: 98071
diff changeset
2819 (let ((standard-output standard-output))
5053145089c9 (with-output-to-string): Make sure that the temporary buffer gets
Romain Francoise <romain@orebokech.com>
parents: 98071
diff changeset
2820 ,@body)
5053145089c9 (with-output-to-string): Make sure that the temporary buffer gets
Romain Francoise <romain@orebokech.com>
parents: 98071
diff changeset
2821 (with-current-buffer standard-output
5053145089c9 (with-output-to-string): Make sure that the temporary buffer gets
Romain Francoise <romain@orebokech.com>
parents: 98071
diff changeset
2822 (buffer-string)))
5053145089c9 (with-output-to-string): Make sure that the temporary buffer gets
Romain Francoise <romain@orebokech.com>
parents: 98071
diff changeset
2823 (kill-buffer standard-output))))
16549
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2824
40822
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
2825 (defmacro with-local-quit (&rest body)
56565
1bef61b14e78 (with-local-quit): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 56537
diff changeset
2826 "Execute BODY, allowing quits to terminate BODY but not escape further.
57547
5d572f497d32 (with-local-quit): Return nil if there's a quit.
Richard M. Stallman <rms@gnu.org>
parents: 57523
diff changeset
2827 When a quit terminates BODY, `with-local-quit' returns nil but
70903
fe6029063ab4 (with-local-quit): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 70901
diff changeset
2828 requests another quit. That quit will be processed as soon as quitting
fe6029063ab4 (with-local-quit): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 70901
diff changeset
2829 is allowed once again. (Immediately, if `inhibit-quit' is nil.)"
48475
4bdcb09d9f25 (symbol-file): Accept a non-atomic `function' arg.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 48474
diff changeset
2830 (declare (debug t) (indent 0))
40822
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
2831 `(condition-case nil
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
2832 (let ((inhibit-quit nil))
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
2833 ,@body)
70901
cc60343f8fd6 (with-local-quit): When handling `quit' signal,
Richard M. Stallman <rms@gnu.org>
parents: 70897
diff changeset
2834 (quit (setq quit-flag t)
cc60343f8fd6 (with-local-quit): When handling `quit' signal,
Richard M. Stallman <rms@gnu.org>
parents: 70897
diff changeset
2835 ;; This call is to give a chance to handle quit-flag
cc60343f8fd6 (with-local-quit): When handling `quit' signal,
Richard M. Stallman <rms@gnu.org>
parents: 70897
diff changeset
2836 ;; in case inhibit-quit is nil.
cc60343f8fd6 (with-local-quit): When handling `quit' signal,
Richard M. Stallman <rms@gnu.org>
parents: 70897
diff changeset
2837 ;; Without this, it will not be handled until the next function
cc60343f8fd6 (with-local-quit): When handling `quit' signal,
Richard M. Stallman <rms@gnu.org>
parents: 70897
diff changeset
2838 ;; call, and that might allow it to exit thru a condition-case
cc60343f8fd6 (with-local-quit): When handling `quit' signal,
Richard M. Stallman <rms@gnu.org>
parents: 70897
diff changeset
2839 ;; that intends to handle the quit signal next time.
cc60343f8fd6 (with-local-quit): When handling `quit' signal,
Richard M. Stallman <rms@gnu.org>
parents: 70897
diff changeset
2840 (eval '(ignore nil)))))
40822
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
2841
58934
ee02b41be7da (while-no-input): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 58800
diff changeset
2842 (defmacro while-no-input (&rest body)
ee02b41be7da (while-no-input): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 58800
diff changeset
2843 "Execute BODY only as long as there's no pending input.
ee02b41be7da (while-no-input): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 58800
diff changeset
2844 If input arrives, that ends the execution of BODY,
64792
f309b64476da (while-no-input): Return t if there is input.
Richard M. Stallman <rms@gnu.org>
parents: 64762
diff changeset
2845 and `while-no-input' returns t. Quitting makes it return nil.
f309b64476da (while-no-input): Return t if there is input.
Richard M. Stallman <rms@gnu.org>
parents: 64762
diff changeset
2846 If BODY finishes, `while-no-input' returns whatever value BODY produced."
58934
ee02b41be7da (while-no-input): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 58800
diff changeset
2847 (declare (debug t) (indent 0))
ee02b41be7da (while-no-input): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 58800
diff changeset
2848 (let ((catch-sym (make-symbol "input")))
ee02b41be7da (while-no-input): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 58800
diff changeset
2849 `(with-local-quit
ee02b41be7da (while-no-input): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 58800
diff changeset
2850 (catch ',catch-sym
ee02b41be7da (while-no-input): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 58800
diff changeset
2851 (let ((throw-on-input ',catch-sym))
72817
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
2852 (or (input-pending-p)
92621
f32191b4080d (while-no-input): Don't splice BODY directly into the `or' form.
Johan Bockgård <bojohan@gnu.org>
parents: 92498
diff changeset
2853 (progn ,@body)))))))
58934
ee02b41be7da (while-no-input): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 58800
diff changeset
2854
81803
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2855 (defmacro condition-case-no-debug (var bodyform &rest handlers)
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2856 "Like `condition-case' except that it does not catch anything when debugging.
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2857 More specifically if `debug-on-error' is set, then it does not catch any signal."
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2858 (declare (debug condition-case) (indent 2))
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2859 (let ((bodysym (make-symbol "body")))
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2860 `(let ((,bodysym (lambda () ,bodyform)))
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2861 (if debug-on-error
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2862 (funcall ,bodysym)
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2863 (condition-case ,var
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2864 (funcall ,bodysym)
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2865 ,@handlers)))))
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2866
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2867 (defmacro with-demoted-errors (&rest body)
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2868 "Run BODY and demote any errors to simple messages.
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2869 If `debug-on-error' is non-nil, run BODY without catching its errors.
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2870 This is to be used around code which is not expected to signal an error
96361
a99299e4d2de American English spelling fix.
Glenn Morris <rgm@gnu.org>
parents: 95841
diff changeset
2871 but which should be robust in the unexpected case that an error is signaled."
81803
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2872 (declare (debug t) (indent 0))
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2873 (let ((err (make-symbol "err")))
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2874 `(condition-case-no-debug ,err
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2875 (progn ,@body)
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2876 (error (message "Error: %s" ,err) nil))))
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2877
16549
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2878 (defmacro combine-after-change-calls (&rest body)
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2879 "Execute BODY, but don't call the after-change functions till the end.
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2880 If BODY makes changes in the buffer, they are recorded
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2881 and the functions on `after-change-functions' are called several times
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2882 when BODY is finished.
17146
b8536e42d4ef (combine-after-change-calls): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 16845
diff changeset
2883 The return value is the value of the last form in BODY.
16549
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2884
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2885 If `before-change-functions' is non-nil, then calls to the after-change
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2886 functions can't be deferred, so in that case this macro has no effect.
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2887
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2888 Do not alter `after-change-functions' or `before-change-functions'
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2889 in BODY."
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2890 (declare (indent 0) (debug t))
16549
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2891 `(unwind-protect
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2892 (let ((combine-after-change-calls t))
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2893 . ,body)
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2894 (combine-after-change-execute)))
76939
1b8e8619079e * subr.el (with-case-table): New macro.
Chong Yidong <cyd@stupidchicken.com>
parents: 76583
diff changeset
2895
1b8e8619079e * subr.el (with-case-table): New macro.
Chong Yidong <cyd@stupidchicken.com>
parents: 76583
diff changeset
2896 (defmacro with-case-table (table &rest body)
1b8e8619079e * subr.el (with-case-table): New macro.
Chong Yidong <cyd@stupidchicken.com>
parents: 76583
diff changeset
2897 "Execute the forms in BODY with TABLE as the current case table.
1b8e8619079e * subr.el (with-case-table): New macro.
Chong Yidong <cyd@stupidchicken.com>
parents: 76583
diff changeset
2898 The value returned is the value of the last form in BODY."
1b8e8619079e * subr.el (with-case-table): New macro.
Chong Yidong <cyd@stupidchicken.com>
parents: 76583
diff changeset
2899 (declare (indent 1) (debug t))
76960
85841d693997 (with-case-table): Use `make-symbol' to avoid variable capture.
John Paul Wallington <jpw@pobox.com>
parents: 76939
diff changeset
2900 (let ((old-case-table (make-symbol "table"))
85841d693997 (with-case-table): Use `make-symbol' to avoid variable capture.
John Paul Wallington <jpw@pobox.com>
parents: 76939
diff changeset
2901 (old-buffer (make-symbol "buffer")))
85841d693997 (with-case-table): Use `make-symbol' to avoid variable capture.
John Paul Wallington <jpw@pobox.com>
parents: 76939
diff changeset
2902 `(let ((,old-case-table (current-case-table))
85841d693997 (with-case-table): Use `make-symbol' to avoid variable capture.
John Paul Wallington <jpw@pobox.com>
parents: 76939
diff changeset
2903 (,old-buffer (current-buffer)))
85841d693997 (with-case-table): Use `make-symbol' to avoid variable capture.
John Paul Wallington <jpw@pobox.com>
parents: 76939
diff changeset
2904 (unwind-protect
85841d693997 (with-case-table): Use `make-symbol' to avoid variable capture.
John Paul Wallington <jpw@pobox.com>
parents: 76939
diff changeset
2905 (progn (set-case-table ,table)
85841d693997 (with-case-table): Use `make-symbol' to avoid variable capture.
John Paul Wallington <jpw@pobox.com>
parents: 76939
diff changeset
2906 ,@body)
85841d693997 (with-case-table): Use `make-symbol' to avoid variable capture.
John Paul Wallington <jpw@pobox.com>
parents: 76939
diff changeset
2907 (with-current-buffer ,old-buffer
85841d693997 (with-case-table): Use `make-symbol' to avoid variable capture.
John Paul Wallington <jpw@pobox.com>
parents: 76939
diff changeset
2908 (set-case-table ,old-case-table))))))
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2909
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2910 ;;; Matching and match data.
44668
52222efc9d4d (insert-for-yank): New function.
Richard M. Stallman <rms@gnu.org>
parents: 44473
diff changeset
2911
15955
32d772cba2c1 (save-match-data): Use save-match-data-internal
Richard M. Stallman <rms@gnu.org>
parents: 15894
diff changeset
2912 (defvar save-match-data-internal)
32d772cba2c1 (save-match-data): Use save-match-data-internal
Richard M. Stallman <rms@gnu.org>
parents: 15894
diff changeset
2913
32d772cba2c1 (save-match-data): Use save-match-data-internal
Richard M. Stallman <rms@gnu.org>
parents: 15894
diff changeset
2914 ;; We use save-match-data-internal as the local variable because
32d772cba2c1 (save-match-data): Use save-match-data-internal
Richard M. Stallman <rms@gnu.org>
parents: 15894
diff changeset
2915 ;; that works ok in practice (people should not use that variable elsewhere).
32d772cba2c1 (save-match-data): Use save-match-data-internal
Richard M. Stallman <rms@gnu.org>
parents: 15894
diff changeset
2916 ;; We used to use an uninterned symbol; the compiler handles that properly
32d772cba2c1 (save-match-data): Use save-match-data-internal
Richard M. Stallman <rms@gnu.org>
parents: 15894
diff changeset
2917 ;; now, but it generates slower code.
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
2918 (defmacro save-match-data (&rest body)
43527
d51d403fd80a (save-match-data): Doc fix.
Juanma Barranquero <lekktu@gmail.com>
parents: 43498
diff changeset
2919 "Execute the BODY forms, restoring the global value of the match data.
d51d403fd80a (save-match-data): Doc fix.
Juanma Barranquero <lekktu@gmail.com>
parents: 43498
diff changeset
2920 The value returned is the value of the last form in BODY."
26084
804cba424b64 Fix bootstrapping problems.
Paul Eggert <eggert@twinsun.com>
parents: 26002
diff changeset
2921 ;; It is better not to use backquote here,
804cba424b64 Fix bootstrapping problems.
Paul Eggert <eggert@twinsun.com>
parents: 26002
diff changeset
2922 ;; because that makes a bootstrapping problem
804cba424b64 Fix bootstrapping problems.
Paul Eggert <eggert@twinsun.com>
parents: 26002
diff changeset
2923 ;; if you need to recompile all the Lisp files using interpreted code.
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2924 (declare (indent 0) (debug t))
26084
804cba424b64 Fix bootstrapping problems.
Paul Eggert <eggert@twinsun.com>
parents: 26002
diff changeset
2925 (list 'let
804cba424b64 Fix bootstrapping problems.
Paul Eggert <eggert@twinsun.com>
parents: 26002
diff changeset
2926 '((save-match-data-internal (match-data)))
804cba424b64 Fix bootstrapping problems.
Paul Eggert <eggert@twinsun.com>
parents: 26002
diff changeset
2927 (list 'unwind-protect
804cba424b64 Fix bootstrapping problems.
Paul Eggert <eggert@twinsun.com>
parents: 26002
diff changeset
2928 (cons 'progn body)
63664
f29e9a430d73 (save-match-data): Add comment about using evaporate arg
Kim F. Storm <storm@cua.dk>
parents: 63634
diff changeset
2929 ;; It is safe to free (evaporate) markers immediately here,
f29e9a430d73 (save-match-data): Add comment about using evaporate arg
Kim F. Storm <storm@cua.dk>
parents: 63634
diff changeset
2930 ;; as Lisp programs should not copy from save-match-data-internal.
63151
cb45242e9d82 (save-match-data): Add RESEAT arg `evaporate' to
Kim F. Storm <storm@cua.dk>
parents: 62861
diff changeset
2931 '(set-match-data save-match-data-internal 'evaporate))))
144
535ec1aa78ef *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 114
diff changeset
2932
11115
9414f249cd8b Changed match-string to defun, but still return nil (no error) if no match.
Simon Marshall <simon@gnu.org>
parents: 11101
diff changeset
2933 (defun match-string (num &optional string)
11101
67231dca5f32 Change to macro, and return nil if there was no match at the specified depth.
Simon Marshall <simon@gnu.org>
parents: 11087
diff changeset
2934 "Return string of text matched by last search.
67231dca5f32 Change to macro, and return nil if there was no match at the specified depth.
Simon Marshall <simon@gnu.org>
parents: 11087
diff changeset
2935 NUM specifies which parenthesized expression in the last regexp.
67231dca5f32 Change to macro, and return nil if there was no match at the specified depth.
Simon Marshall <simon@gnu.org>
parents: 11087
diff changeset
2936 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
67231dca5f32 Change to macro, and return nil if there was no match at the specified depth.
Simon Marshall <simon@gnu.org>
parents: 11087
diff changeset
2937 Zero means the entire text matched by the whole regexp or whole string.
67231dca5f32 Change to macro, and return nil if there was no match at the specified depth.
Simon Marshall <simon@gnu.org>
parents: 11087
diff changeset
2938 STRING should be given if the last search was by `string-match' on STRING."
11115
9414f249cd8b Changed match-string to defun, but still return nil (no error) if no match.
Simon Marshall <simon@gnu.org>
parents: 11101
diff changeset
2939 (if (match-beginning num)
9414f249cd8b Changed match-string to defun, but still return nil (no error) if no match.
Simon Marshall <simon@gnu.org>
parents: 11101
diff changeset
2940 (if string
9414f249cd8b Changed match-string to defun, but still return nil (no error) if no match.
Simon Marshall <simon@gnu.org>
parents: 11101
diff changeset
2941 (substring string (match-beginning num) (match-end num))
9414f249cd8b Changed match-string to defun, but still return nil (no error) if no match.
Simon Marshall <simon@gnu.org>
parents: 11101
diff changeset
2942 (buffer-substring (match-beginning num) (match-end num)))))
10560
fd09d51dfd77 (match-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 10368
diff changeset
2943
20491
d884af34ba47 (match-string-no-properties): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20476
diff changeset
2944 (defun match-string-no-properties (num &optional string)
d884af34ba47 (match-string-no-properties): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20476
diff changeset
2945 "Return string of text matched by last search, without text properties.
d884af34ba47 (match-string-no-properties): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20476
diff changeset
2946 NUM specifies which parenthesized expression in the last regexp.
d884af34ba47 (match-string-no-properties): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20476
diff changeset
2947 Value is nil if NUMth pair didn't match, or there were less than NUM pairs.
d884af34ba47 (match-string-no-properties): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20476
diff changeset
2948 Zero means the entire text matched by the whole regexp or whole string.
d884af34ba47 (match-string-no-properties): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20476
diff changeset
2949 STRING should be given if the last search was by `string-match' on STRING."
d884af34ba47 (match-string-no-properties): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20476
diff changeset
2950 (if (match-beginning num)
d884af34ba47 (match-string-no-properties): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20476
diff changeset
2951 (if string
53994
342806d7b32b (match-string-no-properties): Use substring-no-properties.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53626
diff changeset
2952 (substring-no-properties string (match-beginning num)
342806d7b32b (match-string-no-properties): Use substring-no-properties.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53626
diff changeset
2953 (match-end num))
20491
d884af34ba47 (match-string-no-properties): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20476
diff changeset
2954 (buffer-substring-no-properties (match-beginning num)
d884af34ba47 (match-string-no-properties): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20476
diff changeset
2955 (match-end num)))))
d884af34ba47 (match-string-no-properties): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20476
diff changeset
2956
86017
484f09d924cf (match-substitute-replacement): New function.
Juri Linkov <juri@jurta.org>
parents: 85688
diff changeset
2957
484f09d924cf (match-substitute-replacement): New function.
Juri Linkov <juri@jurta.org>
parents: 85688
diff changeset
2958 (defun match-substitute-replacement (replacement
484f09d924cf (match-substitute-replacement): New function.
Juri Linkov <juri@jurta.org>
parents: 85688
diff changeset
2959 &optional fixedcase literal string subexp)
484f09d924cf (match-substitute-replacement): New function.
Juri Linkov <juri@jurta.org>
parents: 85688
diff changeset
2960 "Return REPLACEMENT as it will be inserted by `replace-match'.
484f09d924cf (match-substitute-replacement): New function.
Juri Linkov <juri@jurta.org>
parents: 85688
diff changeset
2961 In other words, all back-references in the form `\\&' and `\\N'
484f09d924cf (match-substitute-replacement): New function.
Juri Linkov <juri@jurta.org>
parents: 85688
diff changeset
2962 are substituted with actual strings matched by the last search.
484f09d924cf (match-substitute-replacement): New function.
Juri Linkov <juri@jurta.org>
parents: 85688
diff changeset
2963 Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same
484f09d924cf (match-substitute-replacement): New function.
Juri Linkov <juri@jurta.org>
parents: 85688
diff changeset
2964 meaning as for `replace-match'."
484f09d924cf (match-substitute-replacement): New function.
Juri Linkov <juri@jurta.org>
parents: 85688
diff changeset
2965 (let ((match (match-string 0 string)))
484f09d924cf (match-substitute-replacement): New function.
Juri Linkov <juri@jurta.org>
parents: 85688
diff changeset
2966 (save-match-data
484f09d924cf (match-substitute-replacement): New function.
Juri Linkov <juri@jurta.org>
parents: 85688
diff changeset
2967 (set-match-data (mapcar (lambda (x)
484f09d924cf (match-substitute-replacement): New function.
Juri Linkov <juri@jurta.org>
parents: 85688
diff changeset
2968 (if (numberp x)
484f09d924cf (match-substitute-replacement): New function.
Juri Linkov <juri@jurta.org>
parents: 85688
diff changeset
2969 (- x (match-beginning 0))
484f09d924cf (match-substitute-replacement): New function.
Juri Linkov <juri@jurta.org>
parents: 85688
diff changeset
2970 x))
484f09d924cf (match-substitute-replacement): New function.
Juri Linkov <juri@jurta.org>
parents: 85688
diff changeset
2971 (match-data t)))
484f09d924cf (match-substitute-replacement): New function.
Juri Linkov <juri@jurta.org>
parents: 85688
diff changeset
2972 (replace-match replacement fixedcase literal match subexp))))
484f09d924cf (match-substitute-replacement): New function.
Juri Linkov <juri@jurta.org>
parents: 85688
diff changeset
2973
484f09d924cf (match-substitute-replacement): New function.
Juri Linkov <juri@jurta.org>
parents: 85688
diff changeset
2974
62861
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2975 (defun looking-back (regexp &optional limit greedy)
51611
d201fdadadce (looking-back): Handle the case of non-trivial regexps.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 51339
diff changeset
2976 "Return non-nil if text before point matches regular expression REGEXP.
57523
a2d6c6e6486a (looking-back): Return only t or nil.
Richard M. Stallman <rms@gnu.org>
parents: 57480
diff changeset
2977 Like `looking-at' except matches before point, and is slower.
72096
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
2978 LIMIT if non-nil speeds up the search by specifying a minimum
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
2979 starting position, to avoid checking matches that would start
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
2980 before LIMIT.
62861
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2981
99356
d0975c52c7cc (looking-back): Doc fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 99327
diff changeset
2982 If GREEDY is non-nil, extend the match backwards as far as
d0975c52c7cc (looking-back): Doc fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 99327
diff changeset
2983 possible, stopping when a single additional previous character
d0975c52c7cc (looking-back): Doc fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 99327
diff changeset
2984 cannot be part of a match for REGEXP. When the match is
99365
a105d0ab85f3 (looking-back): Fix doc-string typo.
Martin Rudalics <rudalics@gmx.at>
parents: 99356
diff changeset
2985 extended, its starting position is allowed to occur before
99356
d0975c52c7cc (looking-back): Doc fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 99327
diff changeset
2986 LIMIT."
62861
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2987 (let ((start (point))
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2988 (pos
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2989 (save-excursion
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2990 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2991 (point)))))
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2992 (if (and greedy pos)
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2993 (save-restriction
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2994 (narrow-to-region (point-min) start)
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2995 (while (and (> pos (point-min))
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2996 (save-excursion
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2997 (goto-char pos)
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2998 (backward-char 1)
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2999 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
3000 (setq pos (1- pos)))
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
3001 (save-excursion
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
3002 (goto-char pos)
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
3003 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
3004 (not (null pos))))
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
3005
81783
f1d802f34413 (looking-at-p, string-match-p): New functions.
Richard M. Stallman <rms@gnu.org>
parents: 81765
diff changeset
3006 (defsubst looking-at-p (regexp)
f1d802f34413 (looking-at-p, string-match-p): New functions.
Richard M. Stallman <rms@gnu.org>
parents: 81765
diff changeset
3007 "\
f1d802f34413 (looking-at-p, string-match-p): New functions.
Richard M. Stallman <rms@gnu.org>
parents: 81765
diff changeset
3008 Same as `looking-at' except this function does not change the match data."
f1d802f34413 (looking-at-p, string-match-p): New functions.
Richard M. Stallman <rms@gnu.org>
parents: 81765
diff changeset
3009 (let ((inhibit-changing-match-data t))
f1d802f34413 (looking-at-p, string-match-p): New functions.
Richard M. Stallman <rms@gnu.org>
parents: 81765
diff changeset
3010 (looking-at regexp)))
f1d802f34413 (looking-at-p, string-match-p): New functions.
Richard M. Stallman <rms@gnu.org>
parents: 81765
diff changeset
3011
f1d802f34413 (looking-at-p, string-match-p): New functions.
Richard M. Stallman <rms@gnu.org>
parents: 81765
diff changeset
3012 (defsubst string-match-p (regexp string &optional start)
f1d802f34413 (looking-at-p, string-match-p): New functions.
Richard M. Stallman <rms@gnu.org>
parents: 81765
diff changeset
3013 "\
f1d802f34413 (looking-at-p, string-match-p): New functions.
Richard M. Stallman <rms@gnu.org>
parents: 81765
diff changeset
3014 Same as `string-match' except this function does not change the match data."
f1d802f34413 (looking-at-p, string-match-p): New functions.
Richard M. Stallman <rms@gnu.org>
parents: 81765
diff changeset
3015 (let ((inhibit-changing-match-data t))
f1d802f34413 (looking-at-p, string-match-p): New functions.
Richard M. Stallman <rms@gnu.org>
parents: 81765
diff changeset
3016 (string-match regexp string start)))
f1d802f34413 (looking-at-p, string-match-p): New functions.
Richard M. Stallman <rms@gnu.org>
parents: 81765
diff changeset
3017
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3018 (defun subregexp-context-p (regexp pos &optional start)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3019 "Return non-nil if POS is in a normal subregexp context in REGEXP.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3020 A subregexp context is one where a sub-regexp can appear.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3021 A non-subregexp context is for example within brackets, or within a
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3022 repetition bounds operator `\\=\\{...\\}', or right after a `\\'.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3023 If START is non-nil, it should be a position in REGEXP, smaller
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3024 than POS, and known to be in a subregexp context."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3025 ;; Here's one possible implementation, with the great benefit that it
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3026 ;; reuses the regexp-matcher's own parser, so it understands all the
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3027 ;; details of the syntax. A disadvantage is that it needs to match the
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3028 ;; error string.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3029 (condition-case err
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3030 (progn
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3031 (string-match (substring regexp (or start 0) pos) "")
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3032 t)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3033 (invalid-regexp
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3034 (not (member (cadr err) '("Unmatched [ or [^"
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3035 "Unmatched \\{"
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3036 "Trailing backslash")))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3037 ;; An alternative implementation:
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3038 ;; (defconst re-context-re
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3039 ;; (let* ((harmless-ch "[^\\[]")
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3040 ;; (harmless-esc "\\\\[^{]")
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3041 ;; (class-harmless-ch "[^][]")
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3042 ;; (class-lb-harmless "[^]:]")
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3043 ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?")
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3044 ;; (class-lb (concat "\\[\\(" class-lb-harmless
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3045 ;; "\\|" class-lb-colon-maybe-charclass "\\)"))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3046 ;; (class
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3047 ;; (concat "\\[^?]?"
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3048 ;; "\\(" class-harmless-ch
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3049 ;; "\\|" class-lb "\\)*"
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3050 ;; "\\[?]")) ; special handling for bare [ at end of re
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3051 ;; (braces "\\\\{[0-9,]+\\\\}"))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3052 ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3053 ;; "\\|" class "\\|" braces "\\)*\\'"))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3054 ;; "Matches any prefix that corresponds to a normal subregexp context.")
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3055 ;; (string-match re-context-re (substring regexp (or start 0) pos))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3056 )
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3057
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3058 ;;;; split-string
51339
14976a545668 (looking-back): New function to check for regular expression before point.
Juanma Barranquero <lekktu@gmail.com>
parents: 51148
diff changeset
3059
51148
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3060 (defconst split-string-default-separators "[ \f\t\n\r\v]+"
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3061 "The default value of separators for `split-string'.
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3062
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3063 A regexp matching strings of whitespace. May be locale-dependent
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3064 \(as yet unimplemented). Should not match non-breaking spaces.
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3065
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3066 Warning: binding this to a different value and using it as default is
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3067 likely to have undesired semantics.")
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3068
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3069 ;; The specification says that if both SEPARATORS and OMIT-NULLS are
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3070 ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3071 ;; expression leads to the equivalent implementation that if SEPARATORS
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3072 ;; is defaulted, OMIT-NULLS is treated as t.
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3073 (defun split-string (string &optional separators omit-nulls)
57006
a806a6bbc178 (split-string): Docfix.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 56826
diff changeset
3074 "Split STRING into substrings bounded by matches for SEPARATORS.
51148
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3075
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3076 The beginning and end of STRING, and each match for SEPARATORS, are
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3077 splitting points. The substrings matching SEPARATORS are removed, and
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3078 the substrings between the splitting points are collected as a list,
16314
c72b7ee606a3 (split-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16311
diff changeset
3079 which is returned.
51148
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3080
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3081 If SEPARATORS is non-nil, it should be a regular expression matching text
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3082 which separates, but is not part of, the substrings. If nil it defaults to
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3083 `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3084 OMIT-NULLS is forced to t.
20476
f213a5906ea6 (split-string): Handle empty matches reasonably.
Richard M. Stallman <rms@gnu.org>
parents: 20472
diff changeset
3085
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
3086 If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so
51148
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3087 that for the default value of SEPARATORS leading and trailing whitespace
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3088 are effectively trimmed). If nil, all zero-length substrings are retained,
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3089 which correctly parses CSV format, for example.
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3090
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3091 Note that the effect of `(split-string STRING)' is the same as
75124
f4fe3d3016b1 (split-string): Remove spurious ")" from doc string.
Eli Zaretskii <eliz@gnu.org>
parents: 75106
diff changeset
3092 `(split-string STRING split-string-default-separators t)'. In the rare
51148
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3093 case that you wish to retain zero-length substrings when splitting on
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3094 whitespace, use `(split-string STRING split-string-default-separators)'.
27810
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3095
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3096 Modifies the match data; use `save-match-data' if necessary."
51148
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3097 (let ((keep-nulls (not (if separators omit-nulls t)))
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3098 (rexp (or separators split-string-default-separators))
16314
c72b7ee606a3 (split-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16311
diff changeset
3099 (start 0)
20476
f213a5906ea6 (split-string): Handle empty matches reasonably.
Richard M. Stallman <rms@gnu.org>
parents: 20472
diff changeset
3100 notfirst
16314
c72b7ee606a3 (split-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16311
diff changeset
3101 (list nil))
20476
f213a5906ea6 (split-string): Handle empty matches reasonably.
Richard M. Stallman <rms@gnu.org>
parents: 20472
diff changeset
3102 (while (and (string-match rexp string
f213a5906ea6 (split-string): Handle empty matches reasonably.
Richard M. Stallman <rms@gnu.org>
parents: 20472
diff changeset
3103 (if (and notfirst
f213a5906ea6 (split-string): Handle empty matches reasonably.
Richard M. Stallman <rms@gnu.org>
parents: 20472
diff changeset
3104 (= start (match-beginning 0))
f213a5906ea6 (split-string): Handle empty matches reasonably.
Richard M. Stallman <rms@gnu.org>
parents: 20472
diff changeset
3105 (< start (length string)))
f213a5906ea6 (split-string): Handle empty matches reasonably.
Richard M. Stallman <rms@gnu.org>
parents: 20472
diff changeset
3106 (1+ start) start))
51148
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3107 (< start (length string)))
20476
f213a5906ea6 (split-string): Handle empty matches reasonably.
Richard M. Stallman <rms@gnu.org>
parents: 20472
diff changeset
3108 (setq notfirst t)
51148
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3109 (if (or keep-nulls (< start (match-beginning 0)))
16314
c72b7ee606a3 (split-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16311
diff changeset
3110 (setq list
c72b7ee606a3 (split-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16311
diff changeset
3111 (cons (substring string start (match-beginning 0))
c72b7ee606a3 (split-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16311
diff changeset
3112 list)))
c72b7ee606a3 (split-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16311
diff changeset
3113 (setq start (match-end 0)))
51148
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
3114 (if (or keep-nulls (< start (length string)))
16314
c72b7ee606a3 (split-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16311
diff changeset
3115 (setq list
c72b7ee606a3 (split-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16311
diff changeset
3116 (cons (substring string start)
c72b7ee606a3 (split-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16311
diff changeset
3117 list)))
c72b7ee606a3 (split-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16311
diff changeset
3118 (nreverse list)))
78081
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
3119
78530
1532be3afc8a (combine-and-quote-strings): Renamed from strings->string.
Richard M. Stallman <rms@gnu.org>
parents: 78236
diff changeset
3120 (defun combine-and-quote-strings (strings &optional separator)
78081
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
3121 "Concatenate the STRINGS, adding the SEPARATOR (default \" \").
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
3122 This tries to quote the strings to avoid ambiguity such that
78530
1532be3afc8a (combine-and-quote-strings): Renamed from strings->string.
Richard M. Stallman <rms@gnu.org>
parents: 78236
diff changeset
3123 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
78081
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
3124 Only some SEPARATORs will work properly."
93825
f0bcbdcf1d54 (combine-and-quote-strings): Also quote strings that contain the separator.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93735
diff changeset
3125 (let* ((sep (or separator " "))
f0bcbdcf1d54 (combine-and-quote-strings): Also quote strings that contain the separator.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93735
diff changeset
3126 (re (concat "[\\\"]" "\\|" (regexp-quote sep))))
78081
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
3127 (mapconcat
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
3128 (lambda (str)
93825
f0bcbdcf1d54 (combine-and-quote-strings): Also quote strings that contain the separator.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 93735
diff changeset
3129 (if (string-match re str)
78081
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
3130 (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"")
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
3131 str))
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
3132 strings sep)))
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
3133
78530
1532be3afc8a (combine-and-quote-strings): Renamed from strings->string.
Richard M. Stallman <rms@gnu.org>
parents: 78236
diff changeset
3134 (defun split-string-and-unquote (string &optional separator)
78081
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
3135 "Split the STRING into a list of strings.
78530
1532be3afc8a (combine-and-quote-strings): Renamed from strings->string.
Richard M. Stallman <rms@gnu.org>
parents: 78236
diff changeset
3136 It understands Emacs Lisp quoting within STRING, such that
1532be3afc8a (combine-and-quote-strings): Renamed from strings->string.
Richard M. Stallman <rms@gnu.org>
parents: 78236
diff changeset
3137 (split-string-and-unquote (combine-and-quote-strings strs)) == strs
78081
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
3138 The SEPARATOR regexp defaults to \"\\s-+\"."
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
3139 (let ((sep (or separator "\\s-+"))
98942
24d03d4e9afe (split-string-and-unquote): Simplify regexp.
Andreas Schwab <schwab@suse.de>
parents: 98939
diff changeset
3140 (i (string-match "\"" string)))
78530
1532be3afc8a (combine-and-quote-strings): Renamed from strings->string.
Richard M. Stallman <rms@gnu.org>
parents: 78236
diff changeset
3141 (if (null i)
1532be3afc8a (combine-and-quote-strings): Renamed from strings->string.
Richard M. Stallman <rms@gnu.org>
parents: 78236
diff changeset
3142 (split-string string sep t) ; no quoting: easy
78081
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
3143 (append (unless (eq i 0) (split-string (substring string 0 i) sep t))
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
3144 (let ((rfs (read-from-string string i)))
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
3145 (cons (car rfs)
78530
1532be3afc8a (combine-and-quote-strings): Renamed from strings->string.
Richard M. Stallman <rms@gnu.org>
parents: 78236
diff changeset
3146 (split-string-and-unquote (substring string (cdr rfs))
1532be3afc8a (combine-and-quote-strings): Renamed from strings->string.
Richard M. Stallman <rms@gnu.org>
parents: 78236
diff changeset
3147 sep)))))))
78081
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
3148
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3149
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3150 ;;;; Replacement in strings.
24089
70954a8be49b (subst-char-in-string): New function.
Andrew Innes <andrewi@gnu.org>
parents: 24011
diff changeset
3151
70954a8be49b (subst-char-in-string): New function.
Andrew Innes <andrewi@gnu.org>
parents: 24011
diff changeset
3152 (defun subst-char-in-string (fromchar tochar string &optional inplace)
70954a8be49b (subst-char-in-string): New function.
Andrew Innes <andrewi@gnu.org>
parents: 24011
diff changeset
3153 "Replace FROMCHAR with TOCHAR in STRING each time it occurs.
70954a8be49b (subst-char-in-string): New function.
Andrew Innes <andrewi@gnu.org>
parents: 24011
diff changeset
3154 Unless optional argument INPLACE is non-nil, return a new string."
33835
1b1555d26963 Undoing the changes erroneously committed just before.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 33833
diff changeset
3155 (let ((i (length string))
1b1555d26963 Undoing the changes erroneously committed just before.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 33833
diff changeset
3156 (newstr (if inplace string (copy-sequence string))))
1b1555d26963 Undoing the changes erroneously committed just before.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 33833
diff changeset
3157 (while (> i 0)
1b1555d26963 Undoing the changes erroneously committed just before.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 33833
diff changeset
3158 (setq i (1- i))
1b1555d26963 Undoing the changes erroneously committed just before.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 33833
diff changeset
3159 (if (eq (aref newstr i) fromchar)
1b1555d26963 Undoing the changes erroneously committed just before.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 33833
diff changeset
3160 (aset newstr i tochar)))
1b1555d26963 Undoing the changes erroneously committed just before.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 33833
diff changeset
3161 newstr))
27810
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3162
28148
0f14966fe791 (replace-regexp-in-string): Renamed from
Dave Love <fx@gnu.org>
parents: 28065
diff changeset
3163 (defun replace-regexp-in-string (regexp rep string &optional
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
3164 fixedcase literal subexp start)
27810
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3165 "Replace all matches for REGEXP with REP in STRING.
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3166
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3167 Return a new string containing the replacements.
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3168
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3169 Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3170 arguments with the same names of function `replace-match'. If START
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3171 is non-nil, start replacements at that index in STRING.
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3172
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3173 REP is either a string used as the NEWTEXT arg of `replace-match' or a
65058
de7df04c6d6b (replace-regexp-in-string): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 65014
diff changeset
3174 function. If it is a function, it is called with the actual text of each
de7df04c6d6b (replace-regexp-in-string): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 65014
diff changeset
3175 match, and its value is used as the replacement text. When REP is called,
de7df04c6d6b (replace-regexp-in-string): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 65014
diff changeset
3176 the match-data are the result of matching REGEXP against a substring
de7df04c6d6b (replace-regexp-in-string): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 65014
diff changeset
3177 of STRING.
27810
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3178
28148
0f14966fe791 (replace-regexp-in-string): Renamed from
Dave Love <fx@gnu.org>
parents: 28065
diff changeset
3179 To replace only the first match (if any), make REGEXP match up to \\'
0f14966fe791 (replace-regexp-in-string): Renamed from
Dave Love <fx@gnu.org>
parents: 28065
diff changeset
3180 and replace a sub-expression, e.g.
48077
69077a78e52f (replace-regexp-in-string): Doc fix.
Andreas Schwab <schwab@suse.de>
parents: 47916
diff changeset
3181 (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1)
28148
0f14966fe791 (replace-regexp-in-string): Renamed from
Dave Love <fx@gnu.org>
parents: 28065
diff changeset
3182 => \" bar foo\"
0f14966fe791 (replace-regexp-in-string): Renamed from
Dave Love <fx@gnu.org>
parents: 28065
diff changeset
3183 "
27810
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3184
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3185 ;; To avoid excessive consing from multiple matches in long strings,
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3186 ;; don't just call `replace-match' continually. Walk down the
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3187 ;; string looking for matches of REGEXP and building up a (reversed)
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3188 ;; list MATCHES. This comprises segments of STRING which weren't
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3189 ;; matched interspersed with replacements for segments that were.
39557
fb85410efef7 (define-key-after): Allow `key' to be longer than 1.
Gerd Moellmann <gerd@gnu.org>
parents: 38760
diff changeset
3190 ;; [For a `large' number of replacements it's more efficient to
27810
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3191 ;; operate in a temporary buffer; we can't tell from the function's
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3192 ;; args whether to choose the buffer-based implementation, though it
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3193 ;; might be reasonable to do so for long enough STRING.]
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3194 (let ((l (length string))
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3195 (start (or start 0))
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3196 matches str mb me)
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3197 (save-match-data
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3198 (while (and (< start l) (string-match regexp string start))
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3199 (setq mb (match-beginning 0)
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3200 me (match-end 0))
28065
093dcd5f39b2 (replace-regexps-in-string): Properly handle the case where
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 27908
diff changeset
3201 ;; If we matched the empty string, make sure we advance by one char
093dcd5f39b2 (replace-regexps-in-string): Properly handle the case where
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 27908
diff changeset
3202 (when (= me mb) (setq me (min l (1+ mb))))
093dcd5f39b2 (replace-regexps-in-string): Properly handle the case where
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 27908
diff changeset
3203 ;; Generate a replacement for the matched substring.
093dcd5f39b2 (replace-regexps-in-string): Properly handle the case where
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 27908
diff changeset
3204 ;; Operate only on the substring to minimize string consing.
093dcd5f39b2 (replace-regexps-in-string): Properly handle the case where
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 27908
diff changeset
3205 ;; Set up match data for the substring for replacement;
093dcd5f39b2 (replace-regexps-in-string): Properly handle the case where
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 27908
diff changeset
3206 ;; presumably this is likely to be faster than munging the
093dcd5f39b2 (replace-regexps-in-string): Properly handle the case where
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 27908
diff changeset
3207 ;; match data directly in Lisp.
093dcd5f39b2 (replace-regexps-in-string): Properly handle the case where
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 27908
diff changeset
3208 (string-match regexp (setq str (substring string mb me)))
093dcd5f39b2 (replace-regexps-in-string): Properly handle the case where
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 27908
diff changeset
3209 (setq matches
093dcd5f39b2 (replace-regexps-in-string): Properly handle the case where
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 27908
diff changeset
3210 (cons (replace-match (if (stringp rep)
093dcd5f39b2 (replace-regexps-in-string): Properly handle the case where
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 27908
diff changeset
3211 rep
093dcd5f39b2 (replace-regexps-in-string): Properly handle the case where
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 27908
diff changeset
3212 (funcall rep (match-string 0 str)))
093dcd5f39b2 (replace-regexps-in-string): Properly handle the case where
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 27908
diff changeset
3213 fixedcase literal str subexp)
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
3214 (cons (substring string start mb) ; unmatched prefix
28065
093dcd5f39b2 (replace-regexps-in-string): Properly handle the case where
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 27908
diff changeset
3215 matches)))
093dcd5f39b2 (replace-regexps-in-string): Properly handle the case where
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 27908
diff changeset
3216 (setq start me))
27810
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3217 ;; Reconstruct a string from the pieces.
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3218 (setq matches (cons (substring string start l) matches)) ; leftover
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
3219 (apply #'concat (nreverse matches)))))
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3220
106232
f44541b1d13c (string-prefix-p): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105950
diff changeset
3221 (defun string-prefix-p (str1 str2 &optional ignore-case)
f44541b1d13c (string-prefix-p): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105950
diff changeset
3222 "Return non-nil if STR1 is a prefix of STR2.
f44541b1d13c (string-prefix-p): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105950
diff changeset
3223 If IGNORE-CASE is non-nil, the comparison is done without paying attention
f44541b1d13c (string-prefix-p): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105950
diff changeset
3224 to case differences."
f44541b1d13c (string-prefix-p): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105950
diff changeset
3225 (eq t (compare-strings str1 nil nil
f44541b1d13c (string-prefix-p): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105950
diff changeset
3226 str2 0 (length str1) ignore-case)))
f44541b1d13c (string-prefix-p): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 105950
diff changeset
3227
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3228 ;;;; invisibility specs
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3229
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3230 (defun add-to-invisibility-spec (element)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3231 "Add ELEMENT to `buffer-invisibility-spec'.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3232 See documentation for `buffer-invisibility-spec' for the kind of elements
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3233 that can be added."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3234 (if (eq buffer-invisibility-spec t)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3235 (setq buffer-invisibility-spec (list t)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3236 (setq buffer-invisibility-spec
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3237 (cons element buffer-invisibility-spec)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3238
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3239 (defun remove-from-invisibility-spec (element)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3240 "Remove ELEMENT from `buffer-invisibility-spec'."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3241 (if (consp buffer-invisibility-spec)
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
3242 (setq buffer-invisibility-spec
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
3243 (delete element buffer-invisibility-spec))))
16359
18cc78dc8b18 (with-temp-file): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16333
diff changeset
3244
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3245 ;;;; Syntax tables.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3246
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3247 (defmacro with-syntax-table (table &rest body)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3248 "Evaluate BODY with syntax table of current buffer set to TABLE.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3249 The syntax table of the current buffer is saved, BODY is evaluated, and the
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3250 saved table is restored, even in case of an abnormal exit.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3251 Value is what BODY returns."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3252 (declare (debug t))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3253 (let ((old-table (make-symbol "table"))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3254 (old-buffer (make-symbol "buffer")))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3255 `(let ((,old-table (syntax-table))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3256 (,old-buffer (current-buffer)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3257 (unwind-protect
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3258 (progn
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3259 (set-syntax-table ,table)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3260 ,@body)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3261 (save-current-buffer
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3262 (set-buffer ,old-buffer)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3263 (set-syntax-table ,old-table))))))
5385
53077bf7c718 (shell-quote-argument): New function.
Richard M. Stallman <rms@gnu.org>
parents: 5302
diff changeset
3264
5844
445de172c217 (make-syntax-table): Behave like copy-syntax-table if an argument is given,
Karl Heuer <kwzh@gnu.org>
parents: 5460
diff changeset
3265 (defun make-syntax-table (&optional oldtable)
5421
a248a39fa4b8 (make-syntax-table): New function; no longer an alias
Richard M. Stallman <rms@gnu.org>
parents: 5385
diff changeset
3266 "Return a new syntax table.
40822
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
3267 Create a syntax table which inherits from OLDTABLE (if non-nil) or
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
3268 from `standard-syntax-table' otherwise."
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
3269 (let ((table (make-char-table 'syntax-table nil)))
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
3270 (set-char-table-parent table (or oldtable (standard-syntax-table)))
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
3271 table))
17146
b8536e42d4ef (combine-after-change-calls): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 16845
diff changeset
3272
47355
9e3ee43b5262 (symbol-file): Also work for autoloaded funcs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47305
diff changeset
3273 (defun syntax-after (pos)
61798
994a6fb78d4c (syntax-after): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 61716
diff changeset
3274 "Return the raw syntax of the char after POS.
994a6fb78d4c (syntax-after): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 61716
diff changeset
3275 If POS is outside the buffer's accessible portion, return nil."
47355
9e3ee43b5262 (symbol-file): Also work for autoloaded funcs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47305
diff changeset
3276 (unless (or (< pos (point-min)) (>= pos (point-max)))
58416
28906724d6e3 (syntax-after): Undo last change.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 58272
diff changeset
3277 (let ((st (if parse-sexp-lookup-properties
28906724d6e3 (syntax-after): Undo last change.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 58272
diff changeset
3278 (get-char-property pos 'syntax-table))))
28906724d6e3 (syntax-after): Undo last change.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 58272
diff changeset
3279 (if (consp st) st
28906724d6e3 (syntax-after): Undo last change.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 58272
diff changeset
3280 (aref (or st (syntax-table)) (char-after pos))))))
47355
9e3ee43b5262 (symbol-file): Also work for autoloaded funcs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47305
diff changeset
3281
61669
c95f35bea727 (syntax-class): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 60764
diff changeset
3282 (defun syntax-class (syntax)
61798
994a6fb78d4c (syntax-after): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 61716
diff changeset
3283 "Return the syntax class part of the syntax descriptor SYNTAX.
994a6fb78d4c (syntax-after): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 61716
diff changeset
3284 If SYNTAX is nil, return nil."
994a6fb78d4c (syntax-after): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 61716
diff changeset
3285 (and syntax (logand (car syntax) 65535)))
10825
4dba26c66bf5 (global_set_key, local_set_key, global_unset_key)
Richard M. Stallman <rms@gnu.org>
parents: 10794
diff changeset
3286
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3287 ;;;; Text clones
40282
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3288
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3289 (defun text-clone-maintain (ol1 after beg end &optional len)
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3290 "Propagate the changes made under the overlay OL1 to the other clones.
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3291 This is used on the `modification-hooks' property of text clones."
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3292 (when (and after (not undo-in-progress) (overlay-start ol1))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3293 (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0)))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3294 (setq beg (max beg (+ (overlay-start ol1) margin)))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3295 (setq end (min end (- (overlay-end ol1) margin)))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3296 (when (<= beg end)
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3297 (save-excursion
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3298 (when (overlay-get ol1 'text-clone-syntax)
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3299 ;; Check content of the clone's text.
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3300 (let ((cbeg (+ (overlay-start ol1) margin))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3301 (cend (- (overlay-end ol1) margin)))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3302 (goto-char cbeg)
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3303 (save-match-data
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3304 (if (not (re-search-forward
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3305 (overlay-get ol1 'text-clone-syntax) cend t))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3306 ;; Mark the overlay for deletion.
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3307 (overlay-put ol1 'text-clones nil)
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3308 (when (< (match-end 0) cend)
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3309 ;; Shrink the clone at its end.
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3310 (setq end (min end (match-end 0)))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3311 (move-overlay ol1 (overlay-start ol1)
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3312 (+ (match-end 0) margin)))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3313 (when (> (match-beginning 0) cbeg)
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3314 ;; Shrink the clone at its beginning.
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3315 (setq beg (max (match-beginning 0) beg))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3316 (move-overlay ol1 (- (match-beginning 0) margin)
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3317 (overlay-end ol1)))))))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3318 ;; Now go ahead and update the clones.
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3319 (let ((head (- beg (overlay-start ol1)))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3320 (tail (- (overlay-end ol1) end))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3321 (str (buffer-substring beg end))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3322 (nothing-left t)
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3323 (inhibit-modification-hooks t))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3324 (dolist (ol2 (overlay-get ol1 'text-clones))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3325 (let ((oe (overlay-end ol2)))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3326 (unless (or (eq ol1 ol2) (null oe))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3327 (setq nothing-left nil)
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3328 (let ((mod-beg (+ (overlay-start ol2) head)))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3329 ;;(overlay-put ol2 'modification-hooks nil)
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3330 (goto-char (- (overlay-end ol2) tail))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3331 (unless (> mod-beg (point))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3332 (save-excursion (insert str))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3333 (delete-region mod-beg (point)))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3334 ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3335 ))))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3336 (if nothing-left (delete-overlay ol1))))))))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3337
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3338 (defun text-clone-create (start end &optional spreadp syntax)
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3339 "Create a text clone of START...END at point.
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3340 Text clones are chunks of text that are automatically kept identical:
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3341 changes done to one of the clones will be immediately propagated to the other.
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3342
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3343 The buffer's content at point is assumed to be already identical to
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3344 the one between START and END.
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3345 If SYNTAX is provided it's a regexp that describes the possible text of
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3346 the clones; the clone will be shrunk or killed if necessary to ensure that
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3347 its text matches the regexp.
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3348 If SPREADP is non-nil it indicates that text inserted before/after the
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3349 clone should be incorporated in the clone."
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3350 ;; To deal with SPREADP we can either use an overlay with `nil t' along
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3351 ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3352 ;; (with a one-char margin at each end) with `t nil'.
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3353 ;; We opted for a larger overlay because it behaves better in the case
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3354 ;; where the clone is reduced to the empty string (we want the overlay to
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3355 ;; stay when the clone's content is the empty string and we want to use
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3356 ;; `evaporate' to make sure those overlays get deleted when needed).
47916
0bb8dc016c43 (remq): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 47747
diff changeset
3357 ;;
40282
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3358 (let* ((pt-end (+ (point) (- end start)))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3359 (start-margin (if (or (not spreadp) (bobp) (<= start (point-min)))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3360 0 1))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3361 (end-margin (if (or (not spreadp)
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3362 (>= pt-end (point-max))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3363 (>= start (point-max)))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3364 0 1))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3365 (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3366 (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3367 (dups (list ol1 ol2)))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3368 (overlay-put ol1 'modification-hooks '(text-clone-maintain))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3369 (when spreadp (overlay-put ol1 'text-clone-spreadp t))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3370 (when syntax (overlay-put ol1 'text-clone-syntax syntax))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3371 ;;(overlay-put ol1 'face 'underline)
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3372 (overlay-put ol1 'evaporate t)
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3373 (overlay-put ol1 'text-clones dups)
47916
0bb8dc016c43 (remq): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 47747
diff changeset
3374 ;;
40282
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3375 (overlay-put ol2 'modification-hooks '(text-clone-maintain))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3376 (when spreadp (overlay-put ol2 'text-clone-spreadp t))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3377 (when syntax (overlay-put ol2 'text-clone-syntax syntax))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3378 ;;(overlay-put ol2 'face 'underline)
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3379 (overlay-put ol2 'evaporate t)
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3380 (overlay-put ol2 'text-clones dups)))
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3381
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3382 ;;;; Mail user agents.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3383
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3384 ;; Here we include just enough for other packages to be able
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3385 ;; to define them.
44422
5f7f8b191a8c (play-sound): Move here from simple.el.
Pavel Janík <Pavel@Janik.cz>
parents: 44285
diff changeset
3386
47406
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3387 (defun define-mail-user-agent (symbol composefunc sendfunc
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3388 &optional abortfunc hookvar)
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3389 "Define a symbol to identify a mail-sending package for `mail-user-agent'.
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3390
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3391 SYMBOL can be any Lisp symbol. Its function definition and/or
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3392 value as a variable do not matter for this usage; we use only certain
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3393 properties on its property list, to encode the rest of the arguments.
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3394
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3395 COMPOSEFUNC is program callable function that composes an outgoing
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3396 mail message buffer. This function should set up the basics of the
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3397 buffer without requiring user interaction. It should populate the
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3398 standard mail headers, leaving the `to:' and `subject:' headers blank
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3399 by default.
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3400
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3401 COMPOSEFUNC should accept several optional arguments--the same
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3402 arguments that `compose-mail' takes. See that function's documentation.
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3403
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3404 SENDFUNC is the command a user would run to send the message.
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3405
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3406 Optional ABORTFUNC is the command a user would run to abort the
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3407 message. For mail packages that don't have a separate abort function,
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3408 this can be `kill-buffer' (the equivalent of omitting this argument).
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3409
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3410 Optional HOOKVAR is a hook variable that gets run before the message
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3411 is actually sent. Callers that use the `mail-user-agent' may
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3412 install a hook function temporarily on this hook variable.
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3413 If HOOKVAR is nil, `mail-send-hook' is used.
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3414
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3415 The properties used on SYMBOL are `composefunc', `sendfunc',
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3416 `abortfunc', and `hookvar'."
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3417 (put symbol 'composefunc composefunc)
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3418 (put symbol 'sendfunc sendfunc)
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3419 (put symbol 'abortfunc (or abortfunc 'kill-buffer))
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3420 (put symbol 'hookvar (or hookvar 'mail-send-hook)))
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3421
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3422 ;;;; Progress reporters.
57384
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3423
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3424 ;; Progress reporter has the following structure:
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3425 ;;
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3426 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3427 ;; MIN-VALUE
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3428 ;; MAX-VALUE
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3429 ;; MESSAGE
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3430 ;; MIN-CHANGE
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3431 ;; MIN-TIME])
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3432 ;;
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3433 ;; This weirdeness is for optimization reasons: we want
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3434 ;; `progress-reporter-update' to be as fast as possible, so
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3435 ;; `(car reporter)' is better than `(aref reporter 0)'.
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3436 ;;
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3437 ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3438 ;; digits of precision, it doesn't really matter here. On the other
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3439 ;; hand, it greatly simplifies the code.
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3440
57408
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3441 (defsubst progress-reporter-update (reporter value)
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3442 "Report progress of an operation in the echo area.
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3443 However, if the change since last echo area update is too small
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3444 or not enough time has passed, then do nothing (see
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3445 `make-progress-reporter' for details).
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3446
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3447 First parameter, REPORTER, should be the result of a call to
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3448 `make-progress-reporter'. Second, VALUE, determines the actual
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3449 progress of operation; it must be between MIN-VALUE and MAX-VALUE
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3450 as passed to `make-progress-reporter'.
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3451
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3452 This function is very inexpensive, you may not bother how often
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3453 you call it."
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3454 (when (>= value (car reporter))
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3455 (progress-reporter-do-update reporter value)))
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3456
57384
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3457 (defun make-progress-reporter (message min-value max-value
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3458 &optional current-value
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3459 min-change min-time)
59648
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3460 "Return progress reporter object to be used with `progress-reporter-update'.
57384
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3461
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3462 MESSAGE is shown in the echo area. When at least 1% of operation
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3463 is complete, the exact percentage will be appended to the
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3464 MESSAGE. When you call `progress-reporter-done', word \"done\"
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3465 is printed after the MESSAGE. You can change MESSAGE of an
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3466 existing progress reporter with `progress-reporter-force-update'.
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3467
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3468 MIN-VALUE and MAX-VALUE designate starting (0% complete) and
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3469 final (100% complete) states of operation. The latter should be
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3470 larger; if this is not the case, then simply negate all values.
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3471 Optional CURRENT-VALUE specifies the progress by the moment you
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3472 call this function. You should omit it or set it to nil in most
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3473 cases since it defaults to MIN-VALUE.
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3474
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3475 Optional MIN-CHANGE determines the minimal change in percents to
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3476 report (default is 1%.) Optional MIN-TIME specifies the minimal
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3477 time before echo area updates (default is 0.2 seconds.) If
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3478 `float-time' function is not present, then time is not tracked
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3479 at all. If OS is not capable of measuring fractions of seconds,
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3480 then this parameter is effectively rounded up."
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3481
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3482 (unless min-time
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3483 (setq min-time 0.2))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3484 (let ((reporter
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3485 (cons min-value ;; Force a call to `message' now
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3486 (vector (if (and (fboundp 'float-time)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3487 (>= min-time 0.02))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3488 (float-time) nil)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3489 min-value
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3490 max-value
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3491 message
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3492 (if min-change (max (min min-change 50) 1) 1)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3493 min-time))))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3494 (progress-reporter-update reporter (or current-value min-value))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3495 reporter))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3496
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3497 (defun progress-reporter-force-update (reporter value &optional new-message)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3498 "Report progress of an operation in the echo area unconditionally.
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3499
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3500 First two parameters are the same as for
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3501 `progress-reporter-update'. Optional NEW-MESSAGE allows you to
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3502 change the displayed message."
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3503 (let ((parameters (cdr reporter)))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3504 (when new-message
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3505 (aset parameters 3 new-message))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3506 (when (aref parameters 0)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3507 (aset parameters 0 (float-time)))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3508 (progress-reporter-do-update reporter value)))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3509
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3510 (defun progress-reporter-do-update (reporter value)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3511 (let* ((parameters (cdr reporter))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3512 (min-value (aref parameters 1))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3513 (max-value (aref parameters 2))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3514 (one-percent (/ (- max-value min-value) 100.0))
60764
7fd2729eec90 (progress-reporter-do-update): When `min-value' is equal
Juri Linkov <juri@jurta.org>
parents: 60646
diff changeset
3515 (percentage (if (= max-value min-value)
7fd2729eec90 (progress-reporter-do-update): When `min-value' is equal
Juri Linkov <juri@jurta.org>
parents: 60646
diff changeset
3516 0
7fd2729eec90 (progress-reporter-do-update): When `min-value' is equal
Juri Linkov <juri@jurta.org>
parents: 60646
diff changeset
3517 (truncate (/ (- value min-value) one-percent))))
57384
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3518 (update-time (aref parameters 0))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3519 (current-time (float-time))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3520 (enough-time-passed
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3521 ;; See if enough time has passed since the last update.
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3522 (or (not update-time)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3523 (when (>= current-time update-time)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3524 ;; Calculate time for the next update
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3525 (aset parameters 0 (+ update-time (aref parameters 5)))))))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3526 ;;
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3527 ;; Calculate NEXT-UPDATE-VALUE. If we are not going to print
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3528 ;; message this time because not enough time has passed, then use
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3529 ;; 1 instead of MIN-CHANGE. This makes delays between echo area
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3530 ;; updates closer to MIN-TIME.
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3531 (setcar reporter
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3532 (min (+ min-value (* (+ percentage
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3533 (if enough-time-passed
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3534 (aref parameters 4) ;; MIN-CHANGE
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3535 1))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3536 one-percent))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3537 max-value))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3538 (when (integerp value)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3539 (setcar reporter (ceiling (car reporter))))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3540 ;;
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3541 ;; Only print message if enough time has passed
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3542 (when enough-time-passed
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3543 (if (> percentage 0)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3544 (message "%s%d%%" (aref parameters 3) percentage)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3545 (message "%s" (aref parameters 3))))))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3546
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3547 (defun progress-reporter-done (reporter)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3548 "Print reporter's message followed by word \"done\" in echo area."
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3549 (message "%sdone" (aref (cdr reporter) 3)))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3550
59648
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3551 (defmacro dotimes-with-progress-reporter (spec message &rest body)
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3552 "Loop a certain number of times and report progress in the echo area.
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3553 Evaluate BODY with VAR bound to successive integers running from
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3554 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3555 the return value (nil if RESULT is omitted).
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3556
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3557 At each iteration MESSAGE followed by progress percentage is
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3558 printed in the echo area. After the loop is finished, MESSAGE
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3559 followed by word \"done\" is printed. This macro is a
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3560 convenience wrapper around `make-progress-reporter' and friends.
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3561
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3562 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3563 (declare (indent 2) (debug ((symbolp form &optional form) form body)))
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3564 (let ((temp (make-symbol "--dotimes-temp--"))
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3565 (temp2 (make-symbol "--dotimes-temp2--"))
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3566 (start 0)
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3567 (end (nth 1 spec)))
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3568 `(let ((,temp ,end)
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3569 (,(car spec) ,start)
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3570 (,temp2 (make-progress-reporter ,message ,start ,end)))
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3571 (while (< ,(car spec) ,temp)
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3572 ,@body
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3573 (progress-reporter-update ,temp2
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3574 (setq ,(car spec) (1+ ,(car spec)))))
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3575 (progress-reporter-done ,temp2)
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3576 nil ,@(cdr (cdr spec)))))
65150
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3577
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3578
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3579 ;;;; Comparing version strings.
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3580
105950
e411fa8e0abf * progmodes/grep.el (grep-regexp-alist):
Dan Nicolaescu <dann@ics.uci.edu>
parents: 105944
diff changeset
3581 (defconst version-separator "."
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3582 "*Specify the string used to separate the version elements.
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3583
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3584 Usually the separator is \".\", but it can be any other string.")
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3585
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3586
105950
e411fa8e0abf * progmodes/grep.el (grep-regexp-alist):
Dan Nicolaescu <dann@ics.uci.edu>
parents: 105944
diff changeset
3587 (defconst version-regexp-alist
67541
f9d4913b40bc (version-regexp-alist): Allow space as separator before
Kim F. Storm <storm@cua.dk>
parents: 67274
diff changeset
3588 '(("^[-_+ ]?a\\(lpha\\)?$" . -3)
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
3589 ("^[-_+]$" . -3) ; treat "1.2.3-20050920" and "1.2-3" as alpha releases
73028
66a5ba8082a9 Adjust comment
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 72817
diff changeset
3590 ("^[-_+ ]cvs$" . -3) ; treat "1.2.3-CVS" as alpha release
67541
f9d4913b40bc (version-regexp-alist): Allow space as separator before
Kim F. Storm <storm@cua.dk>
parents: 67274
diff changeset
3591 ("^[-_+ ]?b\\(eta\\)?$" . -2)
f9d4913b40bc (version-regexp-alist): Allow space as separator before
Kim F. Storm <storm@cua.dk>
parents: 67274
diff changeset
3592 ("^[-_+ ]?\\(pre\\|rc\\)$" . -1))
107684
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3593 "*Specify association between non-numeric version and its priority.
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3594
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3595 This association is used to handle version string like \"1.0pre2\",
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3596 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
107684
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3597 non-numeric part of a version string to an integer. For example:
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3598
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3599 String Version Integer List Version
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3600 \"1.0pre2\" (1 0 -1 2)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3601 \"1.0PRE2\" (1 0 -1 2)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3602 \"22.8beta3\" (22 8 -2 3)
67541
f9d4913b40bc (version-regexp-alist): Allow space as separator before
Kim F. Storm <storm@cua.dk>
parents: 67274
diff changeset
3603 \"22.8 Beta3\" (22 8 -2 3)
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3604 \"0.9alpha1\" (0 9 -3 1)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3605 \"0.9AlphA1\" (0 9 -3 1)
67541
f9d4913b40bc (version-regexp-alist): Allow space as separator before
Kim F. Storm <storm@cua.dk>
parents: 67274
diff changeset
3606 \"0.9 alpha\" (0 9 -3)
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3607
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3608 Each element has the following form:
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3609
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3610 (REGEXP . PRIORITY)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3611
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3612 Where:
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3613
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3614 REGEXP regexp used to match non-numeric part of a version string.
107684
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3615 It should begin with the `^' anchor and end with a `$' to
65668
bbff73cbd15c (version-regexp-alist): Extend valid syntax for version strings:
Eli Zaretskii <eliz@gnu.org>
parents: 65150
diff changeset
3616 prevent false hits. Letter-case is ignored while matching
bbff73cbd15c (version-regexp-alist): Extend valid syntax for version strings:
Eli Zaretskii <eliz@gnu.org>
parents: 65150
diff changeset
3617 REGEXP.
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3618
107684
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3619 PRIORITY a negative integer specifying non-numeric priority of REGEXP.")
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3620
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3621
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3622 (defun version-to-list (ver)
107684
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3623 "Convert version string VER into a list of integers.
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3624
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3625 The version syntax is given by the following EBNF:
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3626
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3627 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3628
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3629 NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+.
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3630
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3631 SEPARATOR ::= `version-separator' (which see)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3632 | `version-regexp-alist' (which see).
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3633
65668
bbff73cbd15c (version-regexp-alist): Extend valid syntax for version strings:
Eli Zaretskii <eliz@gnu.org>
parents: 65150
diff changeset
3634 The NUMBER part is optional if SEPARATOR is a match for an element
bbff73cbd15c (version-regexp-alist): Extend valid syntax for version strings:
Eli Zaretskii <eliz@gnu.org>
parents: 65150
diff changeset
3635 in `version-regexp-alist'.
bbff73cbd15c (version-regexp-alist): Extend valid syntax for version strings:
Eli Zaretskii <eliz@gnu.org>
parents: 65150
diff changeset
3636
107684
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3637 Examples of valid version syntax:
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3638
65668
bbff73cbd15c (version-regexp-alist): Extend valid syntax for version strings:
Eli Zaretskii <eliz@gnu.org>
parents: 65150
diff changeset
3639 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3640
107684
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3641 Examples of invalid version syntax:
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3642
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3643 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3644
107684
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3645 Examples of version conversion:
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3646
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3647 Version String Version as a List of Integers
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3648 \"1.0.7.5\" (1 0 7 5)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3649 \"1.0pre2\" (1 0 -1 2)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3650 \"1.0PRE2\" (1 0 -1 2)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3651 \"22.8beta3\" (22 8 -2 3)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3652 \"22.8Beta3\" (22 8 -2 3)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3653 \"0.9alpha1\" (0 9 -3 1)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3654 \"0.9AlphA1\" (0 9 -3 1)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3655 \"0.9alpha\" (0 9 -3)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3656
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3657 See documentation for `version-separator' and `version-regexp-alist'."
67541
f9d4913b40bc (version-regexp-alist): Allow space as separator before
Kim F. Storm <storm@cua.dk>
parents: 67274
diff changeset
3658 (or (and (stringp ver) (> (length ver) 0))
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3659 (error "Invalid version string: '%s'" ver))
67541
f9d4913b40bc (version-regexp-alist): Allow space as separator before
Kim F. Storm <storm@cua.dk>
parents: 67274
diff changeset
3660 ;; Change .x.y to 0.x.y
f9d4913b40bc (version-regexp-alist): Allow space as separator before
Kim F. Storm <storm@cua.dk>
parents: 67274
diff changeset
3661 (if (and (>= (length ver) (length version-separator))
f9d4913b40bc (version-regexp-alist): Allow space as separator before
Kim F. Storm <storm@cua.dk>
parents: 67274
diff changeset
3662 (string-equal (substring ver 0 (length version-separator))
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
3663 version-separator))
67541
f9d4913b40bc (version-regexp-alist): Allow space as separator before
Kim F. Storm <storm@cua.dk>
parents: 67274
diff changeset
3664 (setq ver (concat "0" ver)))
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3665 (save-match-data
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3666 (let ((i 0)
65668
bbff73cbd15c (version-regexp-alist): Extend valid syntax for version strings:
Eli Zaretskii <eliz@gnu.org>
parents: 65150
diff changeset
3667 (case-fold-search t) ; ignore case in matching
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3668 lst s al)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3669 (while (and (setq s (string-match "[0-9]+" ver i))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3670 (= s i))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3671 ;; handle numeric part
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3672 (setq lst (cons (string-to-number (substring ver i (match-end 0)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3673 lst)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3674 i (match-end 0))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3675 ;; handle non-numeric part
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3676 (when (and (setq s (string-match "[^0-9]+" ver i))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3677 (= s i))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3678 (setq s (substring ver i (match-end 0))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3679 i (match-end 0))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3680 ;; handle alpha, beta, pre, etc. separator
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3681 (unless (string= s version-separator)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3682 (setq al version-regexp-alist)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3683 (while (and al (not (string-match (caar al) s)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3684 (setq al (cdr al)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3685 (or al (error "Invalid version syntax: '%s'" ver))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3686 (setq lst (cons (cdar al) lst)))))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3687 (if (null lst)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3688 (error "Invalid version syntax: '%s'" ver)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3689 (nreverse lst)))))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3690
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3691
65150
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3692 (defun version-list-< (l1 l2)
107684
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3693 "Return t if L1, a list specification of a version, is lower than L2.
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3694
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3695 Note that a version specified by the list (1) is equal to (1 0),
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3696 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3697 Also, a version given by the list (1) is higher than (1 -1), which in
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3698 turn is higher than (1 -2), which is higher than (1 -3)."
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3699 (while (and l1 l2 (= (car l1) (car l2)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3700 (setq l1 (cdr l1)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3701 l2 (cdr l2)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3702 (cond
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3703 ;; l1 not null and l2 not null
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3704 ((and l1 l2) (< (car l1) (car l2)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3705 ;; l1 null and l2 null ==> l1 length = l2 length
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3706 ((and (null l1) (null l2)) nil)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3707 ;; l1 not null and l2 null ==> l1 length > l2 length
65150
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3708 (l1 (< (version-list-not-zero l1) 0))
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3709 ;; l1 null and l2 not null ==> l2 length > l1 length
65150
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3710 (t (< 0 (version-list-not-zero l2)))))
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3711
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3712
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3713 (defun version-list-= (l1 l2)
107684
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3714 "Return t if L1, a list specification of a version, is equal to L2.
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3715
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3716 Note that a version specified by the list (1) is equal to (1 0),
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3717 \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant.
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3718 Also, a version given by the list (1) is higher than (1 -1), which in
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3719 turn is higher than (1 -2), which is higher than (1 -3)."
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3720 (while (and l1 l2 (= (car l1) (car l2)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3721 (setq l1 (cdr l1)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3722 l2 (cdr l2)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3723 (cond
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3724 ;; l1 not null and l2 not null
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3725 ((and l1 l2) nil)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3726 ;; l1 null and l2 null ==> l1 length = l2 length
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3727 ((and (null l1) (null l2)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3728 ;; l1 not null and l2 null ==> l1 length > l2 length
65150
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3729 (l1 (zerop (version-list-not-zero l1)))
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3730 ;; l1 null and l2 not null ==> l2 length > l1 length
65150
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3731 (t (zerop (version-list-not-zero l2)))))
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3732
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3733
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3734 (defun version-list-<= (l1 l2)
107684
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3735 "Return t if L1, a list specification of a version, is lower or equal to L2.
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3736
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3737 Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0),
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3738 etc. That is, the trailing zeroes are irrelevant. Also, integer
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3739 list (1) is greater than (1 -1) which is greater than (1 -2)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3740 which is greater than (1 -3)."
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3741 (while (and l1 l2 (= (car l1) (car l2)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3742 (setq l1 (cdr l1)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3743 l2 (cdr l2)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3744 (cond
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3745 ;; l1 not null and l2 not null
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3746 ((and l1 l2) (< (car l1) (car l2)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3747 ;; l1 null and l2 null ==> l1 length = l2 length
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3748 ((and (null l1) (null l2)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3749 ;; l1 not null and l2 null ==> l1 length > l2 length
65150
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3750 (l1 (<= (version-list-not-zero l1) 0))
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3751 ;; l1 null and l2 not null ==> l2 length > l1 length
65150
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3752 (t (<= 0 (version-list-not-zero l2)))))
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3753
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3754 (defun version-list-not-zero (lst)
107684
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3755 "Return the first non-zero element of LST, which is a list of integers.
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3756
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3757 If all LST elements are zeros or LST is nil, return zero."
65150
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3758 (while (and lst (zerop (car lst)))
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3759 (setq lst (cdr lst)))
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3760 (if lst
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3761 (car lst)
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3762 ;; there is no element different of zero
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3763 0))
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3764
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3765
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3766 (defun version< (v1 v2)
107684
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3767 "Return t if version V1 is lower (older) than V2.
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3768
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3769 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
107684
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3770 etc. That is, the trailing \".0\"s are insignificant. Also, version
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3771 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3772 which is higher than \"1alpha\"."
65150
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3773 (version-list-< (version-to-list v1) (version-to-list v2)))
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3774
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3775
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3776 (defun version<= (v1 v2)
107684
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3777 "Return t if version V1 is lower (older) than or equal to V2.
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3778
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3779 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
107684
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3780 etc. That is, the trailing \".0\"s are insignificant.. Also, version
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3781 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3782 which is higher than \"1alpha\"."
65150
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3783 (version-list-<= (version-to-list v1) (version-to-list v2)))
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3784
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3785 (defun version= (v1 v2)
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3786 "Return t if version V1 is equal to V2.
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3787
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3788 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
107684
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3789 etc. That is, the trailing \".0\"s are insignificant.. Also, version
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3790 string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\",
1d43618b7e72 Fix doc strings of version-* functions and variables.
Eli Zaretskii <eliz@gnu.org>
parents: 107329
diff changeset
3791 which is higher than \"1alpha\"."
65150
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3792 (version-list-= (version-to-list v1) (version-to-list v2)))
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3793
104215
eec5a3966960 * subr.el: Provide hashtable-print-readable.
Chong Yidong <cyd@stupidchicken.com>
parents: 103970
diff changeset
3794
eec5a3966960 * subr.el: Provide hashtable-print-readable.
Chong Yidong <cyd@stupidchicken.com>
parents: 103970
diff changeset
3795 ;;; Misc.
105940
f7147d70f6ef * subr.el (menu-bar-separator): New defconst.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 105939
diff changeset
3796 (defconst menu-bar-separator '("--")
f7147d70f6ef * subr.el (menu-bar-separator): New defconst.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 105939
diff changeset
3797 "Separator for menus.")
104215
eec5a3966960 * subr.el: Provide hashtable-print-readable.
Chong Yidong <cyd@stupidchicken.com>
parents: 103970
diff changeset
3798
eec5a3966960 * subr.el: Provide hashtable-print-readable.
Chong Yidong <cyd@stupidchicken.com>
parents: 103970
diff changeset
3799 ;; The following statement ought to be in print.c, but `provide' can't
eec5a3966960 * subr.el: Provide hashtable-print-readable.
Chong Yidong <cyd@stupidchicken.com>
parents: 103970
diff changeset
3800 ;; be used there.
111936
0a0aa7fbe2ca Doc fixes.
Glenn Morris <rgm@gnu.org>
parents: 111905
diff changeset
3801 ;; http://lists.gnu.org/archive/html/emacs-devel/2009-08/msg00236.html
104215
eec5a3966960 * subr.el: Provide hashtable-print-readable.
Chong Yidong <cyd@stupidchicken.com>
parents: 103970
diff changeset
3802 (when (hash-table-p (car (read-from-string
eec5a3966960 * subr.el: Provide hashtable-print-readable.
Chong Yidong <cyd@stupidchicken.com>
parents: 103970
diff changeset
3803 (prin1-to-string (make-hash-table)))))
eec5a3966960 * subr.el: Provide hashtable-print-readable.
Chong Yidong <cyd@stupidchicken.com>
parents: 103970
diff changeset
3804 (provide 'hashtable-print-readable))
eec5a3966960 * subr.el: Provide hashtable-print-readable.
Chong Yidong <cyd@stupidchicken.com>
parents: 103970
diff changeset
3805
787
3cece0106722 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 779
diff changeset
3806 ;;; subr.el ends here