annotate lisp/subr.el @ 84420:6f67f3d1d0cb

*** empty log message ***
author Juri Linkov <juri@jurta.org>
date Sun, 09 Sep 2007 12:28:36 +0000
parents 5b644ae74c91
children b210bba3f477 14c4a6aac623
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,
75347
e3694f1cb928 Add 2007 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 75175
diff changeset
4 ;; 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
5
45078
829beb9a6a4b Follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 44980
diff changeset
6 ;; Maintainer: FSF
829beb9a6a4b Follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 44980
diff changeset
7 ;; Keywords: internal
829beb9a6a4b Follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 44980
diff changeset
8
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
9 ;; This file is part of GNU Emacs.
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
10
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
12 ;; it under the terms of the GNU General Public License as published by
78236
9355f9b7bbff Switch license to GPLv3 or later.
Glenn Morris <rgm@gnu.org>
parents: 78149
diff changeset
13 ;; the Free Software Foundation; either version 3, or (at your option)
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
14 ;; any later version.
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
15
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
16 ;; GNU Emacs is distributed in the hope that it will be useful,
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
19 ;; GNU General Public License for more details.
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
20
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
21 ;; You should have received a copy of the GNU General Public License
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 13936
diff changeset
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
64091
6fb026ad601f Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 63797
diff changeset
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
6fb026ad601f Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 63797
diff changeset
24 ;; Boston, MA 02110-1301, USA.
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
25
38414
67b464da13ec Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 37070
diff changeset
26 ;;; Commentary:
67b464da13ec Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 37070
diff changeset
27
787
3cece0106722 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 779
diff changeset
28 ;;; Code:
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
444bd245e176 (macro-declaration-function): New function. Set the
Gerd Moellmann <gerd@gnu.org>
parents: 43833
diff changeset
39
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
40 ;;;; Basic Lisp macros.
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
41
40822
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
42 (defalias 'not 'null)
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
43
53197
61703d3393d6 Add macros `1value' and `noreturn'.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 53181
diff changeset
44 (defmacro noreturn (form)
67899
7c797468d04b (noreturn, 1value): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 67876
diff changeset
45 "Evaluate FORM, expecting it not to return.
7c797468d04b (noreturn, 1value): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 67876
diff changeset
46 If FORM does return, signal an error."
53197
61703d3393d6 Add macros `1value' and `noreturn'.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 53181
diff changeset
47 `(prog1 ,form
61703d3393d6 Add macros `1value' and `noreturn'.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 53181
diff changeset
48 (error "Form marked with `noreturn' did return")))
61703d3393d6 Add macros `1value' and `noreturn'.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 53181
diff changeset
49
61703d3393d6 Add macros `1value' and `noreturn'.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 53181
diff changeset
50 (defmacro 1value (form)
67899
7c797468d04b (noreturn, 1value): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 67876
diff changeset
51 "Evaluate FORM, expecting a constant return value.
7c797468d04b (noreturn, 1value): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 67876
diff changeset
52 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
53 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
54 form)
61703d3393d6 Add macros `1value' and `noreturn'.
Jonathan Yavner <jyavner@member.fsf.org>
parents: 53181
diff changeset
55
71726
a36e654643c1 (def-edebug-spec): Moved here.
Richard M. Stallman <rms@gnu.org>
parents: 71151
diff changeset
56 (defmacro def-edebug-spec (symbol spec)
a36e654643c1 (def-edebug-spec): Moved here.
Richard M. Stallman <rms@gnu.org>
parents: 71151
diff changeset
57 "Set the `edebug-form-spec' property of SYMBOL according to SPEC.
76565
f74d08623001 (def-edebug-spec): Fix typo in docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 76530
diff changeset
58 Both SYMBOL and SPEC are unevaluated. The SPEC can be 0, t, a symbol
71726
a36e654643c1 (def-edebug-spec): Moved here.
Richard M. Stallman <rms@gnu.org>
parents: 71151
diff changeset
59 \(naming a function), or a list."
a36e654643c1 (def-edebug-spec): Moved here.
Richard M. Stallman <rms@gnu.org>
parents: 71151
diff changeset
60 `(put (quote ,symbol) 'edebug-form-spec (quote ,spec)))
a36e654643c1 (def-edebug-spec): Moved here.
Richard M. Stallman <rms@gnu.org>
parents: 71151
diff changeset
61
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
62 (defmacro lambda (&rest cdr)
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
63 "Return a lambda expression.
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
64 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
65 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
66 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
67 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
68 `funcall' or `mapcar', etc.
10178
be0081d9ba76 (lambda): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 10025
diff changeset
69
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
70 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
71 DOCSTRING is an optional documentation string.
71727759437e (lambda): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12296
diff changeset
72 If present, it should describe how to call the function.
71727759437e (lambda): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12296
diff changeset
73 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
74 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
75 It may also be omitted.
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
76 BODY should be a list of Lisp expressions.
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
77
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
78 \(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
79 ;; 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
80 ;; depend on backquote.el.
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
81 (list 'function (cons 'lambda cdr)))
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
82
25437
95301c74bdd9 Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 25436
diff changeset
83 (defmacro push (newelt listname)
25580
b76f1a72649a (push): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 25469
diff changeset
84 "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
85 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
86 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
87 (declare (debug (form sexp)))
25469
6762c8a75fd7 (push): Fix typo.
Dave Love <fx@gnu.org>
parents: 25437
diff changeset
88 (list 'setq listname
6762c8a75fd7 (push): Fix typo.
Dave Love <fx@gnu.org>
parents: 25437
diff changeset
89 (list 'cons newelt listname)))
25436
d24cf1a4dd34 (push, pop): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 25295
diff changeset
90
d24cf1a4dd34 (push, pop): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 25295
diff changeset
91 (defmacro pop (listname)
d24cf1a4dd34 (push, pop): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 25295
diff changeset
92 "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
93 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
94 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
95 change the list."
51611
d201fdadadce (looking-back): Handle the case of non-trivial regexps.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 51339
diff changeset
96 (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
97 (list 'car
7ec7fff5e571 (pop): Move the call to `car' outside the prog1, as the compiler
Miles Bader <miles@gnu.org>
parents: 45821
diff changeset
98 (list 'prog1 listname
7ec7fff5e571 (pop): Move the call to `car' outside the prog1, as the compiler
Miles Bader <miles@gnu.org>
parents: 45821
diff changeset
99 (list 'setq listname (list 'cdr listname)))))
25436
d24cf1a4dd34 (push, pop): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 25295
diff changeset
100
16845
adc714dc8e3c (when, unless): Definitions moved from cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 16556
diff changeset
101 (defmacro when (cond &rest body)
76530
5813a2f3af13 (when, unless): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 75748
diff changeset
102 "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
103 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
104 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
105
78149
677d96c34c87 (when, unless): Doc fix.
Juanma Barranquero <lekktu@gmail.com>
parents: 78081
diff changeset
106 \(fn COND BODY...)"
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
107 (declare (indent 1) (debug t))
16845
adc714dc8e3c (when, unless): Definitions moved from cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 16556
diff changeset
108 (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
109
16845
adc714dc8e3c (when, unless): Definitions moved from cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 16556
diff changeset
110 (defmacro unless (cond &rest body)
76530
5813a2f3af13 (when, unless): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 75748
diff changeset
111 "If COND yields nil, do BODY, else return nil.
5813a2f3af13 (when, unless): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 75748
diff changeset
112 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
113 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
114
78149
677d96c34c87 (when, unless): Doc fix.
Juanma Barranquero <lekktu@gmail.com>
parents: 78081
diff changeset
115 \(fn COND BODY...)"
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
116 (declare (indent 1) (debug t))
16845
adc714dc8e3c (when, unless): Definitions moved from cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 16556
diff changeset
117 (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
118
72096
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
119 (defvar --dolist-tail-- nil
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
120 "Temporary variable used in `dolist' expansion.")
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
121
27376
674b7f75841e (dolist, dotimes): Moved from cl-macs.el.
Richard M. Stallman <rms@gnu.org>
parents: 27297
diff changeset
122 (defmacro dolist (spec &rest body)
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
123 "Loop over a list.
27376
674b7f75841e (dolist, dotimes): Moved from cl-macs.el.
Richard M. Stallman <rms@gnu.org>
parents: 27297
diff changeset
124 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
125 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
126
51817
5e9d88e4fcff (dolist, dotimes): Doc fix.
Markus Rost <rost@math.uni-bielefeld.de>
parents: 51695
diff changeset
127 \(fn (VAR LIST [RESULT]) BODY...)"
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
128 (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
129 ;; 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
130 ;; 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
131 ;; use dolist.
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
132 (let ((temp '--dolist-tail--))
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
133 `(let ((,temp ,(nth 1 spec))
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
134 ,(car spec))
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
135 (while ,temp
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
136 (setq ,(car spec) (car ,temp))
72096
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
137 ,@body
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
138 (setq ,temp (cdr ,temp)))
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
139 ,@(if (cdr (cdr spec))
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
140 `((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
141
72096
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
142 (defvar --dotimes-limit-- nil
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
143 "Temporary variable used in `dotimes' expansion.")
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
144
27376
674b7f75841e (dolist, dotimes): Moved from cl-macs.el.
Richard M. Stallman <rms@gnu.org>
parents: 27297
diff changeset
145 (defmacro dotimes (spec &rest body)
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
146 "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
147 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
148 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
149 the return value (nil if RESULT is omitted).
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
150
51817
5e9d88e4fcff (dolist, dotimes): Doc fix.
Markus Rost <rost@math.uni-bielefeld.de>
parents: 51695
diff changeset
151 \(fn (VAR COUNT [RESULT]) BODY...)"
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
152 (declare (indent 1) (debug dolist))
72096
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
153 ;; 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
154 ;; 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
155 ;; use dotimes.
74ec3b24ac69 (dolist, dotimes): Use interned symbols for iteration.
Richard M. Stallman <rms@gnu.org>
parents: 71961
diff changeset
156 (let ((temp '--dotimes-limit--)
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
157 (start 0)
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
158 (end (nth 1 spec)))
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
159 `(let ((,temp ,end)
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
160 (,(car spec) ,start))
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
161 (while (< ,(car spec) ,temp)
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
162 ,@body
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
163 (setq ,(car spec) (1+ ,(car spec))))
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
164 ,@(cdr (cdr spec)))))
27376
674b7f75841e (dolist, dotimes): Moved from cl-macs.el.
Richard M. Stallman <rms@gnu.org>
parents: 27297
diff changeset
165
53593
39793eabee87 (declare): New macro.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53518
diff changeset
166 (defmacro declare (&rest specs)
39793eabee87 (declare): New macro.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53518
diff changeset
167 "Do not evaluate any arguments and return nil.
39793eabee87 (declare): New macro.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53518
diff changeset
168 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
169 `defmacro' form. \(See Info anchor `(elisp)Definition of declare'.)"
53593
39793eabee87 (declare): New macro.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53518
diff changeset
170 nil)
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
171
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
172 ;;;; 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
173
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
174 (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
175 "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
176 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
177 (interactive)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
178 nil)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
179
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
180 (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
181 "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
182 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
183 letter but *do not* end with a period. Please follow this convention
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
184 for the sake of consistency."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
185 (while t
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
186 (signal 'error (list (apply 'format args)))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
187
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
188 ;; 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
189 ;; 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
190 (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
191 "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
192 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
193 configuration."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
194 (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
195 (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
196
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
197 (defun functionp (object)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
198 "Non-nil if OBJECT is any kind of function or a special form.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
199 Also non-nil if OBJECT is a symbol and its function definition is
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
200 \(recursively) a function or special form. This does not include
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
201 macros."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
202 (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
203 (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
204 (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
205 (error nil))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
206 (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
207 (not (car-safe (cdr-safe (cdr-safe (cdr-safe (cdr-safe object)))))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
208 (subrp object) (byte-code-function-p object)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
209 (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
210
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
211 ;;;; List functions.
53593
39793eabee87 (declare): New macro.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53518
diff changeset
212
19491
f5fd22f3462c (caar, cadr, cdar, cddr): Definitions moved here and changed into defsubsts.
Richard M. Stallman <rms@gnu.org>
parents: 19176
diff changeset
213 (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
214 "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
215 (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
216
f5fd22f3462c (caar, cadr, cdar, cddr): Definitions moved here and changed into defsubsts.
Richard M. Stallman <rms@gnu.org>
parents: 19176
diff changeset
217 (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
218 "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
219 (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
220
f5fd22f3462c (caar, cadr, cdar, cddr): Definitions moved here and changed into defsubsts.
Richard M. Stallman <rms@gnu.org>
parents: 19176
diff changeset
221 (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
222 "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
223 (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
224
f5fd22f3462c (caar, cadr, cdar, cddr): Definitions moved here and changed into defsubsts.
Richard M. Stallman <rms@gnu.org>
parents: 19176
diff changeset
225 (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
226 "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
227 (cdr (cdr x)))
19492
892a09772457 (last): New function.
Richard M. Stallman <rms@gnu.org>
parents: 19491
diff changeset
228
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
229 (defun last (list &optional n)
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
230 "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
231 If LIST is nil, return nil.
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
232 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
233 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
234 (if n
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
235 (let ((m 0) (p list))
19584
17db1ee36bbb (last): Accept optional second argument.
Richard M. Stallman <rms@gnu.org>
parents: 19492
diff changeset
236 (while (consp p)
17db1ee36bbb (last): Accept optional second argument.
Richard M. Stallman <rms@gnu.org>
parents: 19492
diff changeset
237 (setq m (1+ m) p (cdr p)))
17db1ee36bbb (last): Accept optional second argument.
Richard M. Stallman <rms@gnu.org>
parents: 19492
diff changeset
238 (if (<= n 0) p
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
239 (if (< n m) (nthcdr (- m n) list) list)))
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
240 (while (consp (cdr list))
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
241 (setq list (cdr list)))
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
242 list))
22860
349fa4ee1f27 (assoc-default): New function.
Richard M. Stallman <rms@gnu.org>
parents: 22755
diff changeset
243
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
244 (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
245 "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
246 (if (and n (<= n 0)) list
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
247 (nbutlast (copy-sequence list) n)))
34898
1486728b21f0 (butlast, nbutlast): Moved from cl.el to here.
Kenichi Handa <handa@m17n.org>
parents: 34853
diff changeset
248
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
249 (defun nbutlast (list &optional n)
34898
1486728b21f0 (butlast, nbutlast): Moved from cl.el to here.
Kenichi Handa <handa@m17n.org>
parents: 34853
diff changeset
250 "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
251 (let ((m (length list)))
34898
1486728b21f0 (butlast, nbutlast): Moved from cl.el to here.
Kenichi Handa <handa@m17n.org>
parents: 34853
diff changeset
252 (or n (setq n 1))
1486728b21f0 (butlast, nbutlast): Moved from cl.el to here.
Kenichi Handa <handa@m17n.org>
parents: 34853
diff changeset
253 (and (< n m)
1486728b21f0 (butlast, nbutlast): Moved from cl.el to here.
Kenichi Handa <handa@m17n.org>
parents: 34853
diff changeset
254 (progn
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
255 (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
256 list))))
34898
1486728b21f0 (butlast, nbutlast): Moved from cl.el to here.
Kenichi Handa <handa@m17n.org>
parents: 34853
diff changeset
257
53626
ee432d9e3bbd (delete-dups): New function.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53593
diff changeset
258 (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
259 "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
260 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
261 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
262 one is kept."
53626
ee432d9e3bbd (delete-dups): New function.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53593
diff changeset
263 (let ((tail list))
ee432d9e3bbd (delete-dups): New function.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53593
diff changeset
264 (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
265 (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
266 (setq tail (cdr tail))))
53626
ee432d9e3bbd (delete-dups): New function.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53593
diff changeset
267 list)
ee432d9e3bbd (delete-dups): New function.
Luc Teirlinck <teirllm@auburn.edu>
parents: 53593
diff changeset
268
50449
f85be9da34a2 Adjust number-sequence code
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 50427
diff changeset
269 (defun number-sequence (from &optional to inc)
50415
b040b4e36f5e (number-sequence): New function.
Kenichi Handa <handa@m17n.org>
parents: 50136
diff changeset
270 "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
271 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
272 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
273 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
274 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
275 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
276 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
277 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
278 FROM, signal an error.
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
279
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
280 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
281 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
282 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
283 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
284 \(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
285 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
286 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
287 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
288 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
289 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
290 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
291 \(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
292 (if (or (not to) (= from to))
50449
f85be9da34a2 Adjust number-sequence code
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 50427
diff changeset
293 (list from)
f85be9da34a2 Adjust number-sequence code
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 50427
diff changeset
294 (or inc (setq inc 1))
53174
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
295 (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
296 (let (seq (n 0) (next from))
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
297 (if (> inc 0)
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
298 (while (<= next to)
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
299 (setq seq (cons next seq)
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
300 n (1+ n)
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
301 next (+ from (* n inc))))
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
302 (while (>= next to)
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
303 (setq seq (cons next seq)
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
304 n (1+ n)
5f50db6e04c6 (number-sequence): Improve handling of floating point arguments
Luc Teirlinck <teirllm@auburn.edu>
parents: 53132
diff changeset
305 next (+ from (* n inc)))))
50449
f85be9da34a2 Adjust number-sequence code
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 50427
diff changeset
306 (nreverse seq))))
50415
b040b4e36f5e (number-sequence): New function.
Kenichi Handa <handa@m17n.org>
parents: 50136
diff changeset
307
45690
9d351e5869c8 (copy-list): Moved here from cl.el.
Colin Walters <walters@gnu.org>
parents: 45587
diff changeset
308 (defun copy-tree (tree &optional vecp)
9d351e5869c8 (copy-list): Moved here from cl.el.
Colin Walters <walters@gnu.org>
parents: 45587
diff changeset
309 "Make a copy of TREE.
9d351e5869c8 (copy-list): Moved here from cl.el.
Colin Walters <walters@gnu.org>
parents: 45587
diff changeset
310 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
311 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
312 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
313 (if (consp tree)
45740
4e576724db9f (copy-list): Moved to cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 45690
diff changeset
314 (let (result)
4e576724db9f (copy-list): Moved to cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 45690
diff changeset
315 (while (consp tree)
4e576724db9f (copy-list): Moved to cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 45690
diff changeset
316 (let ((newcar (car tree)))
4e576724db9f (copy-list): Moved to cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 45690
diff changeset
317 (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
318 (setq newcar (copy-tree (car tree) vecp)))
4e576724db9f (copy-list): Moved to cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 45690
diff changeset
319 (push newcar result))
4e576724db9f (copy-list): Moved to cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 45690
diff changeset
320 (setq tree (cdr tree)))
45821
41129d3d126b (copy-tree): Use `nconc' and `nreverse' instead of `nreconc'.
Miles Bader <miles@gnu.org>
parents: 45740
diff changeset
321 (nconc (nreverse result) tree))
45690
9d351e5869c8 (copy-list): Moved here from cl.el.
Colin Walters <walters@gnu.org>
parents: 45587
diff changeset
322 (if (and vecp (vectorp tree))
9d351e5869c8 (copy-list): Moved here from cl.el.
Colin Walters <walters@gnu.org>
parents: 45587
diff changeset
323 (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
324 (while (>= (setq i (1- i)) 0)
45740
4e576724db9f (copy-list): Moved to cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 45690
diff changeset
325 (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
326 tree)
4e576724db9f (copy-list): Moved to cl.el.
Richard M. Stallman <rms@gnu.org>
parents: 45690
diff changeset
327 tree)))
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
328
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
329 ;;;; Various list-search functions.
45690
9d351e5869c8 (copy-list): Moved here from cl.el.
Colin Walters <walters@gnu.org>
parents: 45587
diff changeset
330
22959
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
331 (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
332 "Find object KEY in a pseudo-alist ALIST.
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
333 ALIST is a list of conses or objects. Each element (or the element's car,
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
334 if it is a cons) is compared with KEY by evaluating (TEST (car elt) KEY).
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
335 If that is non-nil, the element matches;
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
336 then `assoc-default' returns the element's cdr, if it is a cons,
22860
349fa4ee1f27 (assoc-default): New function.
Richard M. Stallman <rms@gnu.org>
parents: 22755
diff changeset
337 or DEFAULT if the element is not a cons.
22959
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
338
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
339 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
340 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
341 (let (found (tail alist) value)
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
342 (while (and tail (not found))
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
343 (let ((elt (car tail)))
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
344 (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
345 (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
346 (setq tail (cdr tail)))
73a21b5f9bd8 (assoc-default): Rewrite not to use dolist.
Richard M. Stallman <rms@gnu.org>
parents: 22860
diff changeset
347 value))
25295
737e82c21934 (assoc-ignore-case, assoc-ignore-representation): Moved here from simple.el.
Karl Heuer <kwzh@gnu.org>
parents: 25293
diff changeset
348
53412
a2bba9e88b95 (assoc-ignore-case, assoc-ignore-representation):
Richard M. Stallman <rms@gnu.org>
parents: 53368
diff changeset
349 (make-obsolete 'assoc-ignore-case 'assoc-string)
25295
737e82c21934 (assoc-ignore-case, assoc-ignore-representation): Moved here from simple.el.
Karl Heuer <kwzh@gnu.org>
parents: 25293
diff changeset
350 (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
351 "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
352 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
353 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
354 (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
355
53412
a2bba9e88b95 (assoc-ignore-case, assoc-ignore-representation):
Richard M. Stallman <rms@gnu.org>
parents: 53368
diff changeset
356 (make-obsolete 'assoc-ignore-representation 'assoc-string)
25295
737e82c21934 (assoc-ignore-case, assoc-ignore-representation): Moved here from simple.el.
Karl Heuer <kwzh@gnu.org>
parents: 25293
diff changeset
357 (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
358 "Like `assoc', but ignores differences in text representation.
47916
0bb8dc016c43 (remq): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 47747
diff changeset
359 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
360 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
361 (assoc-string key alist nil))
28490
9958b6d95bd6 (member-ignore-case): New function.
Gerd Moellmann <gerd@gnu.org>
parents: 28234
diff changeset
362
9958b6d95bd6 (member-ignore-case): New function.
Gerd Moellmann <gerd@gnu.org>
parents: 28234
diff changeset
363 (defun member-ignore-case (elt list)
9958b6d95bd6 (member-ignore-case): New function.
Gerd Moellmann <gerd@gnu.org>
parents: 28234
diff changeset
364 "Like `member', but ignores differences in case and text representation.
9958b6d95bd6 (member-ignore-case): New function.
Gerd Moellmann <gerd@gnu.org>
parents: 28234
diff changeset
365 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
366 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
367 Non-strings in LIST are ignored."
e4975d9c93ff (insert-for-yank): Replace `category' property
Richard M. Stallman <rms@gnu.org>
parents: 44723
diff changeset
368 (while (and list
e4975d9c93ff (insert-for-yank): Replace `category' property
Richard M. Stallman <rms@gnu.org>
parents: 44723
diff changeset
369 (not (and (stringp (car list))
e4975d9c93ff (insert-for-yank): Replace `category' property
Richard M. Stallman <rms@gnu.org>
parents: 44723
diff changeset
370 (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
371 (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
372 list)
28490
9958b6d95bd6 (member-ignore-case): New function.
Gerd Moellmann <gerd@gnu.org>
parents: 28234
diff changeset
373
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
374 (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
375 "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
376 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
377 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
378 (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
379 (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
380 (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
381 (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
382 (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
383 (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
384 (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
385 (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
386 (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
387 alist)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
388
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
389 (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
390 "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
391 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
392 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
393 (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
394 (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
395 (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
396 (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
397 (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
398 (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
399 (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
400 (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
401 (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
402 alist)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
403
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
404 (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
405 "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
406 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
407 (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
408 ;; 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
409 ;; `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
410 (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
411 (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
412
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
413 (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
414 "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
415 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
416 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
417 (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
418 (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
419 list))
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
420
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
421 ;;;; Keymap support.
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
422
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
423 (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
424 "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
425 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
426 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
427 (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
428
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
429 (defun undefined ()
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
430 (interactive)
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
431 (ding))
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
432
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
433 ;; 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
434 ;; from mentioning keys that run this command.
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
435 (put 'undefined 'suppress-keymap t)
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
436
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
437 (defun suppress-keymap (map &optional nodigits)
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
438 "Make MAP override all normally self-inserting keys to be undefined.
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
439 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
440 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
441 (define-key map [remap self-insert-command] 'undefined)
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
442 (or nodigits
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
443 (let (loop)
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
444 (define-key map "-" 'negative-argument)
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
445 ;; Make plain numbers do numeric args.
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
446 (setq loop ?0)
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
447 (while (<= loop ?9)
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
448 (define-key map (char-to-string loop) 'digit-argument)
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
449 (setq loop (1+ loop))))))
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
450
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
451 (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
452 "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
453 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
454 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
455 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
456 \(like DEFINITION).
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
457
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
458 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
459 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
460
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
461 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
462
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
463 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
464 (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
465 (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
466 (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
467 (setq key
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
468 (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
469 (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
470 (apply 'vector
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
471 (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
472 (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
473 (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
474 (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
475 ;; 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
476 (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
477 (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
478 ;; 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
479 (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
480 ;; 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
481 ;; 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
482 ;; 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
483 (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
484 (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
485 (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
486 (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
487 (progn
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
488 ;; 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
489 ;; 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
490 ;; 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
491 (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
492 (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
493 ;; 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
494 (or inserted
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
495 (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
496 (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
497 (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
498
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
499 (defun map-keymap-internal (function keymap &optional sort-first)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
500 "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
501 Don't call this function; it is for internal use only."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
502 (if sort-first
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
503 (let (list)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
504 (map-keymap (lambda (a b) (push (cons a b) list))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
505 keymap)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
506 (setq list (sort list
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
507 (lambda (a b)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
508 (setq a (car a) b (car b))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
509 (if (integerp a)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
510 (if (integerp b) (< a b)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
511 t)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
512 (if (integerp b) t
81803
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
513 ;; string< also accepts symbols.
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
514 (string< a b))))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
515 (dolist (p list)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
516 (funcall function (car p) (cdr p))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
517 (map-keymap function keymap)))
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 (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
520
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
521 (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
522 "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
523 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
524 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
525 (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
526 (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
527 (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
528 (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
529
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
530 ;;;; 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
531
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
532 (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
533 "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
534 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
535 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
536 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
537 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
538 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
539
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
540 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
541 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
542 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
543 (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
544 (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
545 (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
546 (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
547
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
548 (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
549 "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
550 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
551 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
552 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
553 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
554 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
555
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
556 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
557 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
558 (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
559 (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
560 (or map
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
561 (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
562 (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
563 (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
564 (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
565
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
566 (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
567 "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
568 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
569 (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
570 (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
571
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
572 (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
573 "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
574 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
575 (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
576 (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
577 (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
578 nil)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
579
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
580 ;;;; 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
581
6167
1ad8f8ccdc2b (substitute-key-definition): Avoid infinite recursion.
Karl Heuer <kwzh@gnu.org>
parents: 6039
diff changeset
582 (defvar key-substitution-in-progress nil
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
583 "Used internally by `substitute-key-definition'.")
6167
1ad8f8ccdc2b (substitute-key-definition): Avoid infinite recursion.
Karl Heuer <kwzh@gnu.org>
parents: 6039
diff changeset
584
61967
d9764486d42f (dot, dot-marker, dot-min, dot-max, buffer-flush-undo)
Nick Roberts <nickrob@snap.net.nz>
parents: 61955
diff changeset
585 (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
586 "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
587 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
588 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
589 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
590
68830
a924d28d2d25 (substitute-key-definition): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 68777
diff changeset
591 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
592 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
593 \(define-key KEYMAP [remap OLDDEF] NEWDEF)
f038d760daf1 (substitute-key-definition): Doc fix (hide internal argument).
Juanma Barranquero <lekktu@gmail.com>
parents: 68830
diff changeset
594 \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)"
28868
e62636f5d724 (substitute-key-definition): Add comment describing
Gerd Moellmann <gerd@gnu.org>
parents: 28863
diff changeset
595 ;; 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
596 ;; 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
597 ;; meaning
47916
0bb8dc016c43 (remq): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 47747
diff changeset
598
28868
e62636f5d724 (substitute-key-definition): Add comment describing
Gerd Moellmann <gerd@gnu.org>
parents: 28863
diff changeset
599 ;; 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
600 ;; 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
601 ;; original key, with PREFIX added at the front.
1176
60e0dc538df3 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 1166
diff changeset
602 (or prefix (setq prefix ""))
60e0dc538df3 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 1166
diff changeset
603 (let* ((scan (or oldmap keymap))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
604 (prefix1 (vconcat prefix [nil]))
6167
1ad8f8ccdc2b (substitute-key-definition): Avoid infinite recursion.
Karl Heuer <kwzh@gnu.org>
parents: 6039
diff changeset
605 (key-substitution-in-progress
1ad8f8ccdc2b (substitute-key-definition): Avoid infinite recursion.
Karl Heuer <kwzh@gnu.org>
parents: 6039
diff changeset
606 (cons scan key-substitution-in-progress)))
1176
60e0dc538df3 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 1166
diff changeset
607 ;; Scan OLDMAP, finding each char or event-symbol that
60e0dc538df3 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 1166
diff changeset
608 ;; 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
609 (map-keymap
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
610 (lambda (char defn)
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
611 (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
612 (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
613 scan)))
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
614
61967
d9764486d42f (dot, dot-marker, dot-min, dot-max, buffer-flush-undo)
Nick Roberts <nickrob@snap.net.nz>
parents: 61955
diff changeset
615 (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
616 (let (inner-def skipped menu-item)
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
617 ;; 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
618 (if (eq (car-safe defn) 'menu-item)
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
619 (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
620 ;; Skip past menu-prompt.
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
621 (while (stringp (car-safe defn))
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
622 (push (pop defn) skipped))
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
623 ;; 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
624 (if (consp (car-safe defn))
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
625 (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
626 (if (or (eq defn olddef)
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
627 ;; 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
628 ;; 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
629 (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
630 (equal defn olddef)))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
631 (define-key keymap prefix
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
632 (if menu-item
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
633 (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
634 (setcar (nthcdr 2 copy) newdef)
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
635 copy)
61967
d9764486d42f (dot, dot-marker, dot-min, dot-max, buffer-flush-undo)
Nick Roberts <nickrob@snap.net.nz>
parents: 61955
diff changeset
636 (nconc (nreverse skipped) newdef)))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
637 ;; 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
638 (setq inner-def
68759
0b4b98e12e73 (substitute-key-definition-key): Pass t for NOERROR to
Kim F. Storm <storm@cua.dk>
parents: 68651
diff changeset
639 (or (indirect-function defn t) defn))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
640 ;; 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
641 ;; 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
642 ;; 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
643 (if (and (keymapp inner-def)
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
644 ;; Avoid recursively scanning
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
645 ;; where KEYMAP does not have a submap.
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
646 (let ((elt (lookup-key keymap prefix)))
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
647 (or (null elt) (natnump elt) (keymapp elt)))
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
648 ;; Avoid recursively rescanning keymap being scanned.
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
649 (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
650 ;; 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
651 (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
652
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
653
47916
0bb8dc016c43 (remq): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 47747
diff changeset
654 ;;;; The global keymap tree.
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
655
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
656 ;;; global-map, esc-map, and ctl-x-map have their values set up in
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
657 ;;; keymap.c; we just give them docstrings here.
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
658
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
659 (defvar global-map nil
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
660 "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
661 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
662 global map.")
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
663
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
664 (defvar esc-map nil
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
665 "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
666 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
667
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
668 (defvar ctl-x-map nil
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
669 "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
670 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
671
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
672 (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
673 "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
674 (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
675 (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
676
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
677 (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
678 "Keymap for frame commands.")
2569
39ad4eda7fea All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2504
diff changeset
679 (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
680 (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
681
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
682
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
683 ;;;; Event manipulation functions.
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
684
10693
0875851842f0 (listify-key-sequence-1, event-modifiers): Don't presume internal bit layout
Karl Heuer <kwzh@gnu.org>
parents: 10681
diff changeset
685 ;; The call to `read' is to ensure that the value is computed at load time
0875851842f0 (listify-key-sequence-1, event-modifiers): Don't presume internal bit layout
Karl Heuer <kwzh@gnu.org>
parents: 10681
diff changeset
686 ;; and not compiled into the .elc file. The value is negative on most
0875851842f0 (listify-key-sequence-1, event-modifiers): Don't presume internal bit layout
Karl Heuer <kwzh@gnu.org>
parents: 10681
diff changeset
687 ;; machines, but not on all!
0875851842f0 (listify-key-sequence-1, event-modifiers): Don't presume internal bit layout
Karl Heuer <kwzh@gnu.org>
parents: 10681
diff changeset
688 (defconst listify-key-sequence-1 (logior 128 (read "?\\M-\\^@")))
3153
4c94c9faf1af (listify-key-sequence): Avoid the constant ?\M-\200.
Richard M. Stallman <rms@gnu.org>
parents: 2963
diff changeset
689
2021
8b9286bffef8 (listify-key-sequence): New function.
Richard M. Stallman <rms@gnu.org>
parents: 1959
diff changeset
690 (defun listify-key-sequence (key)
8b9286bffef8 (listify-key-sequence): New function.
Richard M. Stallman <rms@gnu.org>
parents: 1959
diff changeset
691 "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
692 (if (vectorp key)
8b9286bffef8 (listify-key-sequence): New function.
Richard M. Stallman <rms@gnu.org>
parents: 1959
diff changeset
693 (append key nil)
8b9286bffef8 (listify-key-sequence): New function.
Richard M. Stallman <rms@gnu.org>
parents: 1959
diff changeset
694 (mapcar (function (lambda (c)
8b9286bffef8 (listify-key-sequence): New function.
Richard M. Stallman <rms@gnu.org>
parents: 1959
diff changeset
695 (if (> c 127)
3153
4c94c9faf1af (listify-key-sequence): Avoid the constant ?\M-\200.
Richard M. Stallman <rms@gnu.org>
parents: 2963
diff changeset
696 (logxor c listify-key-sequence-1)
2021
8b9286bffef8 (listify-key-sequence): New function.
Richard M. Stallman <rms@gnu.org>
parents: 1959
diff changeset
697 c)))
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
698 key)))
2021
8b9286bffef8 (listify-key-sequence): New function.
Richard M. Stallman <rms@gnu.org>
parents: 1959
diff changeset
699
2040
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
700 (defsubst eventp (obj)
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
701 "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
702 (or (and (integerp obj)
30d4272bcc4b (eventp): Be more discriminating with integers.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55502
diff changeset
703 ;; 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
704 ;; M is the biggest modifier.
30d4272bcc4b (eventp): Be more discriminating with integers.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55502
diff changeset
705 (zerop (logand obj (lognot (1- (lsh ?\M-\^@ 1)))))
30d4272bcc4b (eventp): Be more discriminating with integers.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55502
diff changeset
706 (char-valid-p (event-basic-type obj)))
2040
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
707 (and (symbolp obj)
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
708 (get obj 'event-symbol-elements))
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
709 (and (consp obj)
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
710 (symbolp (car obj))
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
711 (get (car obj) 'event-symbol-elements))))
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
712
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
713 (defun event-modifiers (event)
56537
69db3634588e (butlast, event-modifiers, event-basic-type): Doc fixes.
John Paul Wallington <jpw@pobox.com>
parents: 56402
diff changeset
714 "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
715 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
716 `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
717 and `down'.
059dc717baef (event-modifiers, event-basic-type): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56565
diff changeset
718 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
719 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
720 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
721 even when EVENT actually has modifiers."
2040
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
722 (let ((type event))
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
723 (if (listp type)
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
724 (setq type (car type)))
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
725 (if (symbolp type)
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
726 (cdr (get type 'event-symbol-elements))
55013
aba8cece2157 (event-modifiers): Fix the criterion for ASCII control chars.
Richard M. Stallman <rms@gnu.org>
parents: 55008
diff changeset
727 (let ((list nil)
aba8cece2157 (event-modifiers): Fix the criterion for ASCII control chars.
Richard M. Stallman <rms@gnu.org>
parents: 55008
diff changeset
728 (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
729 ?\H-\^@ ?\s-\^@ ?\A-\^@)))))
aba8cece2157 (event-modifiers): Fix the criterion for ASCII control chars.
Richard M. Stallman <rms@gnu.org>
parents: 55008
diff changeset
730 (if (not (zerop (logand type ?\M-\^@)))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
731 (push 'meta list))
55013
aba8cece2157 (event-modifiers): Fix the criterion for ASCII control chars.
Richard M. Stallman <rms@gnu.org>
parents: 55008
diff changeset
732 (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
733 (< char 32))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
734 (push 'control list))
55013
aba8cece2157 (event-modifiers): Fix the criterion for ASCII control chars.
Richard M. Stallman <rms@gnu.org>
parents: 55008
diff changeset
735 (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
736 (/= char (downcase char)))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
737 (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
738 (or (zerop (logand type ?\H-\^@))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
739 (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
740 (or (zerop (logand type ?\s-\^@))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
741 (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
742 (or (zerop (logand type ?\A-\^@))
57480
db7d00351c33 (substitute-key-definition-key): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57438
diff changeset
743 (push 'alt list))
2040
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
744 list))))
aa926beb4caa (event-modifiers): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2033
diff changeset
745
2063
2f0555b428c4 (event-basic-type): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2040
diff changeset
746 (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
747 "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
748 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
749 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
750 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
751 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
752 (if (consp event)
d2df5ca46b39 * subr.el (event-basic-type): Deal with listy events properly.
Jim Blandy <jimb@redhat.com>
parents: 3591
diff changeset
753 (setq event (car event)))
2063
2f0555b428c4 (event-basic-type): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2040
diff changeset
754 (if (symbolp event)
2f0555b428c4 (event-basic-type): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2040
diff changeset
755 (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
756 (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
757 (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
758 ;; 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
759 ;; 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
760 (condition-case ()
b54077faa74a (event-basic-type): Don't get an error.
Richard M. Stallman <rms@gnu.org>
parents: 62501
diff changeset
761 (downcase uncontrolled)
b54077faa74a (event-basic-type): Don't get an error.
Richard M. Stallman <rms@gnu.org>
parents: 62501
diff changeset
762 (error uncontrolled)))))
2063
2f0555b428c4 (event-basic-type): New function.
Richard M. Stallman <rms@gnu.org>
parents: 2040
diff changeset
763
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
764 (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
765 "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
766 (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
767
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
768 (defsubst event-start (event)
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
769 "Return the starting position of EVENT.
54866
47cdc4f7ee17 (posn-set-point): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54626
diff changeset
770 If EVENT is a mouse or key press or a mouse click, this returns the location
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
771 of the event.
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
772 If EVENT is a drag, this returns the drag's starting position.
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
773 The return value is of the form
53518
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
774 (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
775 IMAGE (DX . DY) (WIDTH . HEIGHT))
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
776 The `posn-' functions access elements of such lists."
45978
a8fbafaa31ad (event-start, event-end, event-click-count):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45823
diff changeset
777 (if (consp event) (nth 1 event)
a8fbafaa31ad (event-start, event-end, event-click-count):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45823
diff changeset
778 (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
779
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
780 (defsubst event-end (event)
54866
47cdc4f7ee17 (posn-set-point): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54626
diff changeset
781 "Return the ending location of EVENT.
47cdc4f7ee17 (posn-set-point): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54626
diff changeset
782 EVENT should be a click, drag, or key press event.
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
783 If EVENT is a click event, this function is the same as `event-start'.
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
784 The return value is of the form
53518
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
785 (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
786 IMAGE (DX . DY) (WIDTH . HEIGHT))
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
787 The `posn-' functions access elements of such lists."
45978
a8fbafaa31ad (event-start, event-end, event-click-count):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 45823
diff changeset
788 (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
789 (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
790
4414
3356419b94c1 (add-hook): Change a single function into a list.
Richard M. Stallman <rms@gnu.org>
parents: 4235
diff changeset
791 (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
792 "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
793 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
794 (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
795
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
796 ;;;; 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
797
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
798 (defsubst posn-window (position)
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
799 "Return the window in POSITION.
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
800 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
801 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
802 (nth 0 position))
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
803
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
804 (defsubst posn-area (position)
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
805 "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
806 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
807 and `event-end' functions."
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
808 (let ((area (if (consp (nth 1 position))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
809 (car (nth 1 position))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
810 (nth 1 position))))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
811 (and (symbolp area) area)))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
812
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
813 (defsubst posn-point (position)
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
814 "Return the buffer location in POSITION.
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
815 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
816 and `event-end' functions."
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
817 (or (nth 5 position)
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
818 (if (consp (nth 1 position))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
819 (car (nth 1 position))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
820 (nth 1 position))))
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
821
54866
47cdc4f7ee17 (posn-set-point): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54626
diff changeset
822 (defun posn-set-point (position)
47cdc4f7ee17 (posn-set-point): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54626
diff changeset
823 "Move point to POSITION.
47cdc4f7ee17 (posn-set-point): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54626
diff changeset
824 Select the corresponding window as well."
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
825 (if (not (windowp (posn-window position)))
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
826 (error "Position not in text area of window"))
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
827 (select-window (posn-window position))
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
828 (if (numberp (posn-point position))
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
829 (goto-char (posn-point position))))
54866
47cdc4f7ee17 (posn-set-point): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54626
diff changeset
830
6039
4eb7f4633370 (posn-x-y): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6005
diff changeset
831 (defsubst posn-x-y (position)
4eb7f4633370 (posn-x-y): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6005
diff changeset
832 "Return the x and y coordinates in POSITION.
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
833 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
834 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
835 (nth 2 position))
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
836
7636
83dba60657ef (posn-col-row): Do something useful for scroll bar event.
Richard M. Stallman <rms@gnu.org>
parents: 7615
diff changeset
837 (defun posn-col-row (position)
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
838 "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
839 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
840 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
841 and height.
7636
83dba60657ef (posn-col-row): Do something useful for scroll bar event.
Richard M. Stallman <rms@gnu.org>
parents: 7615
diff changeset
842 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
843 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
844 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
845 and `event-end' functions."
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
846 (let* ((pair (posn-x-y position))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
847 (window (posn-window position))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
848 (area (posn-area position)))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
849 (cond
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
850 ((null window)
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
851 '(0 . 0))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
852 ((eq area 'vertical-scroll-bar)
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
853 (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
854 ((eq area 'horizontal-scroll-bar)
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
855 (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
856 (t
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
857 (let* ((frame (if (framep window) window (window-frame window)))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
858 (x (/ (car pair) (frame-char-width frame)))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
859 (y (/ (cdr pair) (+ (frame-char-height frame)
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
860 (or (frame-parameter frame 'line-spacing)
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
861 default-line-spacing
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
862 0)))))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
863 (cons x y))))))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
864
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
865 (defun posn-actual-col-row (position)
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
866 "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
867 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
868 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
869 `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
870 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
871 and `event-end' functions."
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
872 (nth 6 position))
6039
4eb7f4633370 (posn-x-y): New function.
Richard M. Stallman <rms@gnu.org>
parents: 6005
diff changeset
873
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
874 (defsubst posn-timestamp (position)
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
875 "Return the timestamp of POSITION.
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
876 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
877 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
878 (nth 3 position))
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
879
53518
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
880 (defsubst posn-string (position)
70229
b85aa1663ba3 (posn-string, posn-image, posn-object): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 69978
diff changeset
881 "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
882 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
883 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
884 and `event-end' functions."
53132
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
885 (nth 4 position))
20c6299bd4df (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53063
diff changeset
886
53518
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
887 (defsubst posn-image (position)
70229
b85aa1663ba3 (posn-string, posn-image, posn-object): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 69978
diff changeset
888 "Return the image object of POSITION.
74085
7e5dd39ae47d (posn-image): Fix typo in docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 73943
diff changeset
889 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
890 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
891 and `event-end' functions."
53518
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
892 (nth 7 position))
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
893
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
894 (defsubst posn-object (position)
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
895 "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
896 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
897 \(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
898 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
899 and `event-end' functions."
53518
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
900 (or (posn-image position) (posn-string position)))
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
901
53181
8337e648c2b3 (posn-object-x-y): New defun.
Kim F. Storm <storm@cua.dk>
parents: 53174
diff changeset
902 (defsubst posn-object-x-y (position)
8337e648c2b3 (posn-object-x-y): New defun.
Kim F. Storm <storm@cua.dk>
parents: 53174
diff changeset
903 "Return the x and y coordinates relative to the object of POSITION.
8337e648c2b3 (posn-object-x-y): New defun.
Kim F. Storm <storm@cua.dk>
parents: 53174
diff changeset
904 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
905 and `event-end' functions."
53518
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
906 (nth 8 position))
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
907
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
908 (defsubst posn-object-width-height (position)
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
909 "Return the pixel width and height of the object of POSITION.
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
910 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
911 and `event-end' functions."
53518
21599196e26a (event-start, event-end): Doc fix.
Kim F. Storm <storm@cua.dk>
parents: 53485
diff changeset
912 (nth 9 position))
53181
8337e648c2b3 (posn-object-x-y): New defun.
Kim F. Storm <storm@cua.dk>
parents: 53174
diff changeset
913
2071
8f410f56d98f (posn-timestamp, posn-col-row, posn-point, posn-window):
Richard M. Stallman <rms@gnu.org>
parents: 2063
diff changeset
914
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
915 ;;;; Obsolescent names for functions.
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
916
62542
3f80c5cf6771 (send-string, send-region): Remove obsolescence declaration.
Juanma Barranquero <lekktu@gmail.com>
parents: 62524
diff changeset
917 (define-obsolete-function-alias 'window-dot 'window-point "22.1")
3f80c5cf6771 (send-string, send-region): Remove obsolescence declaration.
Juanma Barranquero <lekktu@gmail.com>
parents: 62524
diff changeset
918 (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1")
3f80c5cf6771 (send-string, send-region): Remove obsolescence declaration.
Juanma Barranquero <lekktu@gmail.com>
parents: 62524
diff changeset
919 (define-obsolete-function-alias 'read-input 'read-string "22.1")
3f80c5cf6771 (send-string, send-region): Remove obsolescence declaration.
Juanma Barranquero <lekktu@gmail.com>
parents: 62524
diff changeset
920 (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1")
3f80c5cf6771 (send-string, send-region): Remove obsolescence declaration.
Juanma Barranquero <lekktu@gmail.com>
parents: 62524
diff changeset
921 (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1")
3f80c5cf6771 (send-string, send-region): Remove obsolescence declaration.
Juanma Barranquero <lekktu@gmail.com>
parents: 62524
diff changeset
922 (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1")
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
923
47652
a5316596929f (read-key-auxiliary-map): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47406
diff changeset
924 (make-obsolete 'char-bytes "now always returns 1." "20.4")
20605
95e051979faf (sref): Defined.
Richard M. Stallman <rms@gnu.org>
parents: 20491
diff changeset
925
42266
75bbe9d566d9 (insert-string): Moved from mocklisp.c, reimplemented in Lisp. Obsoleted.
Pavel Janík <Pavel@Janik.cz>
parents: 42083
diff changeset
926 (defun insert-string (&rest args)
75bbe9d566d9 (insert-string): Moved from mocklisp.c, reimplemented in Lisp. Obsoleted.
Pavel Janík <Pavel@Janik.cz>
parents: 42083
diff changeset
927 "Mocklisp-compatibility insert function.
75bbe9d566d9 (insert-string): Moved from mocklisp.c, reimplemented in Lisp. Obsoleted.
Pavel Janík <Pavel@Janik.cz>
parents: 42083
diff changeset
928 Like the function `insert' except that any argument that is a number
75bbe9d566d9 (insert-string): Moved from mocklisp.c, reimplemented in Lisp. Obsoleted.
Pavel Janík <Pavel@Janik.cz>
parents: 42083
diff changeset
929 is converted into a string by expressing it in decimal."
75bbe9d566d9 (insert-string): Moved from mocklisp.c, reimplemented in Lisp. Obsoleted.
Pavel Janík <Pavel@Janik.cz>
parents: 42083
diff changeset
930 (dolist (el args)
75bbe9d566d9 (insert-string): Moved from mocklisp.c, reimplemented in Lisp. Obsoleted.
Pavel Janík <Pavel@Janik.cz>
parents: 42083
diff changeset
931 (insert (if (integerp el) (number-to-string el) el))))
59996
aac0a33f5772 Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents: 59648
diff changeset
932 (make-obsolete 'insert-string 'insert "22.1")
62430
a25a4c4602a4 Slight reorganization of some obsolete declarations; deleted comment no longer
Juanma Barranquero <lekktu@gmail.com>
parents: 62380
diff changeset
933
46219
56b79cbf05d2 (insert-string): Update the obsolete info.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 46148
diff changeset
934 (defun makehash (&optional test) (make-hash-table :test (or test 'eql)))
59996
aac0a33f5772 Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents: 59648
diff changeset
935 (make-obsolete 'makehash 'make-hash-table "22.1")
42266
75bbe9d566d9 (insert-string): Moved from mocklisp.c, reimplemented in Lisp. Obsoleted.
Pavel Janík <Pavel@Janik.cz>
parents: 42083
diff changeset
936
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
937 ;; Some programs still use this as a function.
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
938 (defun baud-rate ()
46052
4d27fe417297 (char-bytes): Fix obsolescence declaration.
Juanma Barranquero <lekktu@gmail.com>
parents: 45978
diff changeset
939 "Return the value of the `baud-rate' variable."
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
940 baud-rate)
62430
a25a4c4602a4 Slight reorganization of some obsolete declarations; deleted comment no longer
Juanma Barranquero <lekktu@gmail.com>
parents: 62380
diff changeset
941 (make-obsolete 'baud-rate "use the `baud-rate' variable instead." "before 19.15")
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
942
62608
ad7518f065e5 (focus-frame, unfocus-frame): Revert deletion on 2005-05-01.
Juanma Barranquero <lekktu@gmail.com>
parents: 62542
diff changeset
943 ;; These are used by VM and some old programs
ad7518f065e5 (focus-frame, unfocus-frame): Revert deletion on 2005-05-01.
Juanma Barranquero <lekktu@gmail.com>
parents: 62542
diff changeset
944 (defalias 'focus-frame 'ignore "")
ad7518f065e5 (focus-frame, unfocus-frame): Revert deletion on 2005-05-01.
Juanma Barranquero <lekktu@gmail.com>
parents: 62542
diff changeset
945 (make-obsolete 'focus-frame "it does nothing." "22.1")
ad7518f065e5 (focus-frame, unfocus-frame): Revert deletion on 2005-05-01.
Juanma Barranquero <lekktu@gmail.com>
parents: 62542
diff changeset
946 (defalias 'unfocus-frame 'ignore "")
ad7518f065e5 (focus-frame, unfocus-frame): Revert deletion on 2005-05-01.
Juanma Barranquero <lekktu@gmail.com>
parents: 62542
diff changeset
947 (make-obsolete 'unfocus-frame "it does nothing." "22.1")
ad7518f065e5 (focus-frame, unfocus-frame): Revert deletion on 2005-05-01.
Juanma Barranquero <lekktu@gmail.com>
parents: 62542
diff changeset
948
46537
46f175ecf5d4 (unread-command-char, executing-macro, post-command-idle-hook,
Juanma Barranquero <lekktu@gmail.com>
parents: 46532
diff changeset
949
59124
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
950 ;;;; Obsolescence declarations for variables, and aliases.
46537
46f175ecf5d4 (unread-command-char, executing-macro, post-command-idle-hook,
Juanma Barranquero <lekktu@gmail.com>
parents: 46532
diff changeset
951
46f175ecf5d4 (unread-command-char, executing-macro, post-command-idle-hook,
Juanma Barranquero <lekktu@gmail.com>
parents: 46532
diff changeset
952 (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
953 (make-obsolete-variable
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
954 'mode-line-inverse-video
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
955 "use the appropriate faces instead."
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
956 "21.1")
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
957 (make-obsolete-variable
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
958 'unread-command-char
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
959 "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
960 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
961 "before 19.15")
46537
46f175ecf5d4 (unread-command-char, executing-macro, post-command-idle-hook,
Juanma Barranquero <lekktu@gmail.com>
parents: 46532
diff changeset
962
62015
e208ebaf0e17 (executing-macro): Use `define-obsolete-variable-alias'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61996
diff changeset
963 ;; Lisp manual only updated in 22.1.
e208ebaf0e17 (executing-macro): Use `define-obsolete-variable-alias'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61996
diff changeset
964 (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
965 "before 19.34")
62015
e208ebaf0e17 (executing-macro): Use `define-obsolete-variable-alias'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61996
diff changeset
966
57778
82ed9ce364a7 (x-lost-selection-hooks, x-sent-selection-hooks): New obsolete aliases
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57689
diff changeset
967 (defvaralias 'x-lost-selection-hooks 'x-lost-selection-functions)
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
968 (make-obsolete-variable 'x-lost-selection-hooks
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
969 '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
970 (defvaralias 'x-sent-selection-hooks 'x-sent-selection-functions)
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
971 (make-obsolete-variable 'x-sent-selection-hooks
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
972 '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
973
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
974 (defvaralias 'messages-buffer-max-lines 'message-log-max)
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
975
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
976 ;;;; 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
977
62542
3f80c5cf6771 (send-string, send-region): Remove obsolescence declaration.
Juanma Barranquero <lekktu@gmail.com>
parents: 62524
diff changeset
978 (defalias 'send-string 'process-send-string)
3f80c5cf6771 (send-string, send-region): Remove obsolescence declaration.
Juanma Barranquero <lekktu@gmail.com>
parents: 62524
diff changeset
979 (defalias 'send-region 'process-send-region)
2569
39ad4eda7fea All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2504
diff changeset
980 (defalias 'string= 'string-equal)
39ad4eda7fea All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2504
diff changeset
981 (defalias 'string< 'string-lessp)
39ad4eda7fea All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2504
diff changeset
982 (defalias 'move-marker 'set-marker)
39ad4eda7fea All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2504
diff changeset
983 (defalias 'rplaca 'setcar)
39ad4eda7fea All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2504
diff changeset
984 (defalias 'rplacd 'setcdr)
3591
507f64624555 Apply typo patches from Paul Eggert.
Jim Blandy <jimb@redhat.com>
parents: 3411
diff changeset
985 (defalias 'beep 'ding) ;preserve lingual purity
2569
39ad4eda7fea All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2504
diff changeset
986 (defalias 'indent-to-column 'indent-to)
39ad4eda7fea All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2504
diff changeset
987 (defalias 'backward-delete-char 'delete-backward-char)
39ad4eda7fea All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2504
diff changeset
988 (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
989 (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
990 (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
991 (defalias 'store-match-data 'set-match-data)
47078
6e9df2174ee2 (make-variable-frame-localizable): New alias for `make-variable-frame-local'.
Juanma Barranquero <lekktu@gmail.com>
parents: 47042
diff changeset
992 (defalias 'make-variable-frame-localizable 'make-variable-frame-local)
31563
96b9757bfd45 (add-minor-mode): Use toggle-fun arg.
Dave Love <fx@gnu.org>
parents: 30515
diff changeset
993 ;; These are the XEmacs names:
25293
fd43e1a99384 (point-at-eol, point-at-bol): New aliases.
Karl Heuer <kwzh@gnu.org>
parents: 25140
diff changeset
994 (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
995 (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
996
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
997 (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
998
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
999
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1000 ;;;; Hook manipulation functions.
388
498bcec1cf3a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 384
diff changeset
1001
9195
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1002 (defun make-local-hook (hook)
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1003 "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
1004 The return value is HOOK.
673204d56938 (make-local-hook): Return the hook variable.
Richard M. Stallman <rms@gnu.org>
parents: 23736
diff changeset
1005
33707
2b9847c18f31 (make-local-hook): Docstring fix.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 32355
diff changeset
1006 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
1007 if its LOCAL argument is non-nil.
2b9847c18f31 (make-local-hook): Docstring fix.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 32355
diff changeset
1008
9195
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1009 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
1010 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
1011 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
1012 of the hook variable.
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1013
39557
fb85410efef7 (define-key-after): Allow `key' to be longer than 1.
Gerd Moellmann <gerd@gnu.org>
parents: 38760
diff changeset
1014 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
1015 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
1016 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
1017 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
1018 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
1019 one.
95ebca0a74d8 (make-local-hook): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12108
diff changeset
1020
95ebca0a74d8 (make-local-hook): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 12108
diff changeset
1021 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
1022 buffer.
9195
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1023
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1024 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
1025 (if (local-variable-p hook)
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1026 nil
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1027 (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
1028 (make-local-variable hook)
23786
673204d56938 (make-local-hook): Return the hook variable.
Richard M. Stallman <rms@gnu.org>
parents: 23736
diff changeset
1029 (set hook (list t)))
673204d56938 (make-local-hook): Return the hook variable.
Richard M. Stallman <rms@gnu.org>
parents: 23736
diff changeset
1030 hook)
46052
4d27fe417297 (char-bytes): Fix obsolescence declaration.
Juanma Barranquero <lekktu@gmail.com>
parents: 45978
diff changeset
1031 (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
1032
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1033 (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
1034 "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
1035 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
1036 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
1037 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
1038 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
1039
9195
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1040 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
1041 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
1042 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
1043 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
1044 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
1045
4414
3356419b94c1 (add-hook): Change a single function into a list.
Richard M. Stallman <rms@gnu.org>
parents: 4235
diff changeset
1046 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
1047 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
1048 function, it is changed to a list of functions."
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
1049 (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
1050 (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
1051 (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
1052 (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
1053 ;; 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
1054 ;; and do what we used to do.
52987
ac21698ba968 (add-hook): Fix last change.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52896
diff changeset
1055 (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
1056 (setq local t)))
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1057 (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
1058 ;; 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
1059 (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
1060 (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
1061 ;; 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
1062 (unless (member function hook-value)
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1063 (setq hook-value
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1064 (if append
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1065 (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
1066 (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
1067 ;; Set the actual variable
6430ce03c28a (add-hook, remove-hook): Make hook buffer-local if needed..
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 28811
diff changeset
1068 (if local (set hook hook-value) (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
1069
9195
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1070 (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
1071 "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
1072 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
1073 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
1074 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
1075
70b00615cb75 (add-hook): Initialize default value and local value.
Richard M. Stallman <rms@gnu.org>
parents: 8959
diff changeset
1076 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
1077 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
1078 (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
1079 (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
1080 ;; 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
1081 (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
1082 ;; 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
1083 ;; 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
1084 (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
1085 (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
1086 (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
1087 (setq local t))
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1088 (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
1089 ;; 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
1090 (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
1091 (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
1092 (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
1093 ;; 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
1094 ;;(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
1095 ;; (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
1096 ;; (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
1097 ;; 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
1098 (if (not local)
f992824e67f0 (add-hook): Correctly detect when make-local-hook was used.
Richard M. Stallman <rms@gnu.org>
parents: 52858
diff changeset
1099 (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
1100 (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
1101 (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
1102 (set hook hook-value))))))
9510
f03544494d1c (add-to-list): New function.
Richard M. Stallman <rms@gnu.org>
parents: 9202
diff changeset
1103
72784
3f19250c6e68 (add-to-list): New argument COMPARE-FN.
Richard M. Stallman <rms@gnu.org>
parents: 72138
diff changeset
1104 (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
1105 "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
1106 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
1107 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
1108 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
1109 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
1110 ELEMENT is added at the end.
24757
f4127409d184 (add-to-list): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 24699
diff changeset
1111
43833
37bc1e73d4b3 (add-to-list): Doc fix.
Pavel Janík <Pavel@Janik.cz>
parents: 43527
diff changeset
1112 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
1113
9535
a2908d5da32a (add-to-list): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 9510
diff changeset
1114 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
1115 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
1116 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
1117 `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
1118 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
1119 (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
1120 ((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
1121 (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
1122 ((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
1123 (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
1124 ((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
1125 (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
1126 (t
73555
3f351640d09f (add-to-list): Don't continue checking if a match has
David Kastrup <dak@gnu.org>
parents: 73466
diff changeset
1127 (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
1128 (while (and lst
3f351640d09f (add-to-list): Don't continue checking if a match has
David Kastrup <dak@gnu.org>
parents: 73466
diff changeset
1129 (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
1130 (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
1131 lst)))
21409
3e8b7782f4f5 (add-to-list): Always return updated value of LIST-VAR.
Karl Heuer <kwzh@gnu.org>
parents: 21173
diff changeset
1132 (symbol-value list-var)
32355
6bf2ae19e286 (add-to-list): Add optional argument APPEND.
Miles Bader <miles@gnu.org>
parents: 32131
diff changeset
1133 (set list-var
6bf2ae19e286 (add-to-list): Add optional argument APPEND.
Miles Bader <miles@gnu.org>
parents: 32131
diff changeset
1134 (if append
6bf2ae19e286 (add-to-list): Add optional argument APPEND.
Miles Bader <miles@gnu.org>
parents: 32131
diff changeset
1135 (append (symbol-value list-var) (list element))
6bf2ae19e286 (add-to-list): Add optional argument APPEND.
Miles Bader <miles@gnu.org>
parents: 32131
diff changeset
1136 (cons element (symbol-value list-var))))))
39725
c64d3e3adf5d (symbol-file-load-history-loaded)
Miles Bader <miles@gnu.org>
parents: 39598
diff changeset
1137
63387
5b9f98f257f8 (add-to-ordered-list): New defun.
Kim F. Storm <storm@cua.dk>
parents: 63381
diff changeset
1138
5b9f98f257f8 (add-to-ordered-list): New defun.
Kim F. Storm <storm@cua.dk>
parents: 63381
diff changeset
1139 (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
1140 "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
1141 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
1142
5b9f98f257f8 (add-to-ordered-list): New defun.
Kim F. Storm <storm@cua.dk>
parents: 63381
diff changeset
1143 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
1144 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
1145 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
1146
63797
7f964f8f5c85 (add-to-list, add-to-ordered-list): Doc fixes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63761
diff changeset
1147 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
1148 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
1149 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
1150 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
1151 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
1152
63472
a89b059224fb (add-to-ordered-list): Use a weak hash-table to avoid leaks.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63396
diff changeset
1153 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
1154 `list-order' property.
63387
5b9f98f257f8 (add-to-ordered-list): New defun.
Kim F. Storm <storm@cua.dk>
parents: 63381
diff changeset
1155
5b9f98f257f8 (add-to-ordered-list): New defun.
Kim F. Storm <storm@cua.dk>
parents: 63381
diff changeset
1156 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
1157 (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
1158 (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
1159 (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
1160 (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
1161 (when order
63605
99743da5284f (add-to-ordered-list): Test membership with eq. Simplify.
Kim F. Storm <storm@cua.dk>
parents: 63472
diff changeset
1162 (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
1163 (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
1164 (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
1165 (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
1166 (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
1167 (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
1168 (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
1169 (if (and oa ob)
99743da5284f (add-to-ordered-list): Test membership with eq. Simplify.
Kim F. Storm <storm@cua.dk>
parents: 63472
diff changeset
1170 (< oa ob)
99743da5284f (add-to-ordered-list): Test membership with eq. Simplify.
Kim F. Storm <storm@cua.dk>
parents: 63472
diff changeset
1171 oa)))))))
70415
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1172
70678
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1173 (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
1174 "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
1175 Return the new history list.
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1176 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
1177 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
1178 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
1179 variable.
70678
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1180 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
1181 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
1182 if it is empty or a duplicate."
70415
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1183 (unless maxelt
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1184 (setq maxelt (or (get history-var 'history-length)
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1185 history-length)))
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1186 (let ((history (symbol-value history-var))
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1187 tail)
70678
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1188 (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
1189 (or keep-all
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1190 (not (stringp newelt))
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1191 (> (length newelt) 0))
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1192 (or keep-all
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1193 (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
1194 (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
1195 (delete newelt history))
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1196 (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
1197 (when (integerp maxelt)
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1198 (if (= 0 maxelt)
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1199 (setq history nil)
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1200 (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
1201 (when (consp tail)
a561e5346aa8 (add-to-history): Add KEEP-ALL arg and align functionality
Kim F. Storm <storm@cua.dk>
parents: 70552
diff changeset
1202 (setcdr tail nil)))))
70415
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1203 (set history-var history)))
72f273a616c1 (add-to-history): New function.
Kim F. Storm <storm@cua.dk>
parents: 70267
diff changeset
1204
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1205
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1206 ;;;; Mode hooks.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1207
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1208 (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
1209 "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
1210 (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
1211 "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
1212 (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
1213 (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
1214
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1215 (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
1216 "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
1217
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1218 (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
1219 "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1220 Execution is delayed if `delay-mode-hooks' is non-nil.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1221 If `delay-mode-hooks' is nil, run `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
1222 after running the mode hooks.
81765
7effaa2c79bd (run-mode-hooks): Docstring improvement.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81646
diff changeset
1223 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
1224 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
1225 (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
1226 ;; Delaying case.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1227 (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
1228 (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
1229 ;; 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
1230 (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
1231 (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
1232 (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
1233 (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
1234
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1235 (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
1236 "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
1237 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
1238 `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
1239 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
1240 (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
1241 `(progn
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1242 (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
1243 (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
1244 ,@body)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1245
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1246 ;; 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
1247
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1248 (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
1249 "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
1250 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
1251 (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
1252 (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
1253 (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
1254 parent))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1255
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1256 ;;;; Minor modes.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1257
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1258 ;; 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
1259 ;; 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
1260 ;; 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
1261 ;; 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
1262 (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
1263 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
1264 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
1265 "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
1266
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1267 (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
1268 "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
1269
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1270 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
1271
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1272 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
1273 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
1274
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1275 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
1276 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
1277 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
1278
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1279 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
1280 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
1281
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1282 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
1283 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
1284
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1285 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
1286 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
1287
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1288 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
1289 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
1290 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
1291 (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
1292 (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
1293
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1294 (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
1295 (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
1296 (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
1297 ;; 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
1298 (when name
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1299 (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
1300 (if existing
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1301 (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
1302 (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
1303 (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
1304 (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
1305 (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
1306 (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
1307 (if found
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1308 (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
1309 (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
1310 (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
1311 (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
1312 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
1313 ;; 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
1314 (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
1315 (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
1316 (vector toggle)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1317 (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
1318 (concat
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1319 (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
1320 (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
1321 (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
1322 (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
1323 (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
1324 toggle-fun
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1325 :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
1326
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1327 ;; 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
1328 (when keymap
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1329 (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
1330 (if existing
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1331 (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
1332 (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
1333 (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
1334 (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
1335 (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
1336 (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
1337 (if found
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1338 (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
1339 (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
1340 (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
1341 (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
1342 minor-mode-map-alist))))))))
39725
c64d3e3adf5d (symbol-file-load-history-loaded)
Miles Bader <miles@gnu.org>
parents: 39598
diff changeset
1343
c64d3e3adf5d (symbol-file-load-history-loaded)
Miles Bader <miles@gnu.org>
parents: 39598
diff changeset
1344 ;;; Load history
c64d3e3adf5d (symbol-file-load-history-loaded)
Miles Bader <miles@gnu.org>
parents: 39598
diff changeset
1345
70267
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1346 ;; (defvar symbol-file-load-history-loaded nil
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1347 ;; "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
1348 ;; 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
1349 ;; which is cleared out before dumping to make Emacs smaller.")
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1350
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1351 ;; (defun load-symbol-file-load-history ()
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1352 ;; "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
1353 ;; 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
1354 ;; which is cleared out before dumping to make Emacs smaller."
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1355 ;; (unless symbol-file-load-history-loaded
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1356 ;; (load (expand-file-name
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1357 ;; ;; 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
1358 ;; (if (eq system-type 'ms-dos)
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1359 ;; "fns.el"
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1360 ;; (format "fns-%s.el" emacs-version))
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1361 ;; exec-directory)
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1362 ;; ;; 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
1363 ;; nil nil t)
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
1364 ;; (setq symbol-file-load-history-loaded t)))
39725
c64d3e3adf5d (symbol-file-load-history-loaded)
Miles Bader <miles@gnu.org>
parents: 39598
diff changeset
1365
59124
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1366 (defun symbol-file (symbol &optional type)
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1367 "Return the input source in which SYMBOL was defined.
66286
366f80f966cb (symbol-file): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 65668
diff changeset
1368 The value is an absolute file name.
59124
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1369 It can also be nil, if the definition is not associated with any file.
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1370
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1371 If TYPE is nil, then any kind of definition is acceptable.
59161
0d5e992b6c18 Fix doc in previous change.
Richard M. Stallman <rms@gnu.org>
parents: 59124
diff changeset
1372 If TYPE is `defun' or `defvar', that specifies function
62326
fd364cee20ef (symbol-file): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 62015
diff changeset
1373 definition only or variable definition only.
fd364cee20ef (symbol-file): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 62015
diff changeset
1374 `defface' specifies a face definition only."
59124
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1375 (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
1376 (symbolp symbol) (fboundp symbol)
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1377 (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
1378 (nth 1 (symbol-function symbol))
47355
9e3ee43b5262 (symbol-file): Also work for autoloaded funcs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47305
diff changeset
1379 (let ((files load-history)
48474
33dafec6a9de (symbol-file): Remove unused variable `functions'.
John Paul Wallington <jpw@pobox.com>
parents: 48077
diff changeset
1380 file)
47355
9e3ee43b5262 (symbol-file): Also work for autoloaded funcs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47305
diff changeset
1381 (while files
59124
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1382 (if (if type
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1383 (if (eq type 'defvar)
f38536b30f3a (messages-buffer-max-lines): Alias for message-log-max.
Richard M. Stallman <rms@gnu.org>
parents: 58934
diff changeset
1384 ;; 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
1385 (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
1386 ;; 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
1387 (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
1388 ;; 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
1389 ;; 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
1390 (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
1391 (rassq symbol (cdr (car files)))))
47355
9e3ee43b5262 (symbol-file): Also work for autoloaded funcs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47305
diff changeset
1392 (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
1393 (setq files (cdr files)))
9e3ee43b5262 (symbol-file): Also work for autoloaded funcs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47305
diff changeset
1394 file)))
39725
c64d3e3adf5d (symbol-file-load-history-loaded)
Miles Bader <miles@gnu.org>
parents: 39598
diff changeset
1395
66508
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1396 ;;;###autoload
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1397 (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
1398 "Show the precise file name of Emacs library LIBRARY.
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1399 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
1400 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
1401 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
1402 to the specified name LIBRARY.
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1403
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1404 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
1405 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
1406
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1407 When called from a program, the file name is normaly returned as a
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1408 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
1409 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
1410 (interactive (list (completing-read "Locate library: "
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1411 'locate-file-completion
69168
6e701396a0ec (locate-library): Use `get-load-suffixes' instead of `load-suffixes'
Luc Teirlinck <teirllm@auburn.edu>
parents: 68848
diff changeset
1412 (cons 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
1413 nil nil
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1414 t))
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1415 (let ((file (locate-file library
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1416 (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
1417 (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
1418 load-file-rep-suffixes))))
66508
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1419 (if interactive-call
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1420 (if file
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1421 (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
1422 (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
1423 file))
ecdadc99bf8c * subr.el (locate-library): Move from help-fns.el.
Romain Francoise <romain@orebokech.com>
parents: 66315
diff changeset
1424
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
1425
66306
138f9b1d6682 (eval-at-startup): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 66304
diff changeset
1426 ;;;; Specifying things to do later.
138f9b1d6682 (eval-at-startup): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 66304
diff changeset
1427
138f9b1d6682 (eval-at-startup): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 66304
diff changeset
1428 (defmacro eval-at-startup (&rest body)
138f9b1d6682 (eval-at-startup): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 66304
diff changeset
1429 "Make arrangements to evaluate BODY when Emacs starts up.
138f9b1d6682 (eval-at-startup): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 66304
diff changeset
1430 If this is run after Emacs startup, evaluate BODY immediately.
138f9b1d6682 (eval-at-startup): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 66304
diff changeset
1431 Always returns nil.
138f9b1d6682 (eval-at-startup): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 66304
diff changeset
1432
138f9b1d6682 (eval-at-startup): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 66304
diff changeset
1433 This works by adding a function to `before-init-hook'.
138f9b1d6682 (eval-at-startup): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 66304
diff changeset
1434 That function's doc string says which file created it."
138f9b1d6682 (eval-at-startup): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 66304
diff changeset
1435 `(progn
138f9b1d6682 (eval-at-startup): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 66304
diff changeset
1436 (if command-line-processed
138f9b1d6682 (eval-at-startup): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 66304
diff changeset
1437 (progn . ,body)
138f9b1d6682 (eval-at-startup): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 66304
diff changeset
1438 (add-hook 'before-init-hook
138f9b1d6682 (eval-at-startup): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 66304
diff changeset
1439 '(lambda () ,(concat "From " (or load-file-name "no file"))
138f9b1d6682 (eval-at-startup): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 66304
diff changeset
1440 . ,body)
138f9b1d6682 (eval-at-startup): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 66304
diff changeset
1441 t))
138f9b1d6682 (eval-at-startup): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 66304
diff changeset
1442 nil))
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1443
70879
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1444 (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
1445 "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
1446 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
1447 (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
1448 (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
1449 (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
1450 (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
1451 (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
1452 ""
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1453 ;; 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
1454 ;; 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
1455 (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
1456 "\\(" (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
1457 "\\)?\\'"))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1458
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1459 (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
1460 "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
1461 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
1462 (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
1463 (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
1464 (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
1465 (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
1466 (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
1467 (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
1468 (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
1469 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
1470 load-elt))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1471
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1472 (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
1473 "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
1474 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
1475
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1476 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
1477
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1478 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
1479 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
1480 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
1481 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
1482
71037
a0da1a83020d (load-history-regexp): If FILE is relative, insist
Richard M. Stallman <rms@gnu.org>
parents: 70903
diff changeset
1483 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
1484 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
1485 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
1486 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
1487
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1488 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
1489 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
1490 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
1491 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
1492
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1493 Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1494 is evaluated whenever that feature is `provide'd.
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1495
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1496 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
1497 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
1498
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1499 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
1500 ;; 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
1501 ;; 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
1502 (let* ((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
1503 (if (stringp file) (load-history-regexp file) file))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1504 (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
1505 (unless elt
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1506 (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
1507 (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
1508 ;; 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
1509 (unless (member form (cdr elt))
70879
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1510 (nconc elt (list form)))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1511
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1512 ;; 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
1513 ;; matches FILE?
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1514 (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
1515 (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
1516 (featurep file))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1517 (eval form))))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1518
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1519 (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
1520 "Evaluate all `eval-after-load' forms, if any, for ABS-FILE.
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1521 ABS-FILE, a string, should be the absolute true name of a file just loaded."
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1522 (let ((after-load-elts 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
1523 a-l-element file-elements file-element form)
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1524 (while after-load-elts
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1525 (setq a-l-element (car after-load-elts)
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1526 after-load-elts (cdr after-load-elts))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1527 (when (and (stringp (car a-l-element))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1528 (string-match (car a-l-element) abs-file))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1529 (while (setq a-l-element (cdr a-l-element)) ; discard the file name
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1530 (setq form (car a-l-element))
238e43ed886e startup.el (command-line): For names of preloaded files, don't append
Alan Mackenzie <acm@muc.de>
parents: 70678
diff changeset
1531 (eval form))))))
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1532
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1533 (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
1534 "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
1535 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
1536 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
1537 (eval-after-load file (read)))
45587
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1538
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1539 ;;;; Process stuff.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1540
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1541 ;; 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
1542
62372
4560134d21fa (open-network-stream-nowait): Remove.
Kim F. Storm <storm@cua.dk>
parents: 62326
diff changeset
1543 (when (featurep 'make-network-process)
4560134d21fa (open-network-stream-nowait): Remove.
Kim F. Storm <storm@cua.dk>
parents: 62326
diff changeset
1544 (defun open-network-stream (name buffer host service)
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1545 "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
1546 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
1547 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
1548
45587
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1549 Args are NAME BUFFER HOST SERVICE.
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1550 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
1551 BUFFER is the buffer (or buffer name) to associate with the process.
45587
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1552 Process output goes at end of that buffer, unless you specify
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1553 an output stream or filter function to handle the output.
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1554 BUFFER may be also nil, meaning that this process is not associated
55502
75efe89a09b7 (start-process-shell-command): Fix docstring. Put usage info in a format usable
Juanma Barranquero <lekktu@gmail.com>
parents: 55477
diff changeset
1555 with any buffer.
75efe89a09b7 (start-process-shell-command): Fix docstring. Put usage info in a format usable
Juanma Barranquero <lekktu@gmail.com>
parents: 55477
diff changeset
1556 HOST is name of the host to connect to, or its IP address.
75efe89a09b7 (start-process-shell-command): Fix docstring. Put usage info in a format usable
Juanma Barranquero <lekktu@gmail.com>
parents: 55477
diff changeset
1557 SERVICE is name of the service desired, or an integer specifying
75efe89a09b7 (start-process-shell-command): Fix docstring. Put usage info in a format usable
Juanma Barranquero <lekktu@gmail.com>
parents: 55477
diff changeset
1558 a port number to connect to."
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1559 (make-network-process :name name :buffer buffer
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1560 :host host :service service)))
45587
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1561
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1562 ;; compatibility
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1563
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1564 (make-obsolete
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1565 'process-kill-without-query
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1566 "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
1567 "22.1")
45587
02df8e2ff88b (open-network-stream, open-network-stream-nowait)
Richard M. Stallman <rms@gnu.org>
parents: 45246
diff changeset
1568 (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
1569 "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
1570 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
1571 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
1572 (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
1573 (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
1574 old))
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1575
49225
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1576 ;; process plist management
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1577
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1578 (defun process-get (process propname)
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1579 "Return the value of PROCESS' PROPNAME property.
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1580 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
1581 (plist-get (process-plist process) propname))
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1582
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1583 (defun process-put (process propname value)
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1584 "Change PROCESS' PROPNAME property to VALUE.
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1585 It can be retrieved with `(process-get PROCESS PROPNAME)'."
49597
e88404e8f2cf Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49492
diff changeset
1586 (set-process-plist process
49225
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1587 (plist-put (process-plist process) propname value)))
50cb245b2072 (process-put, process-get): New functions.
Kim F. Storm <storm@cua.dk>
parents: 48935
diff changeset
1588
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1589
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1590 ;;;; Input and display facilities.
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1591
18880
1ed40ed8e0c1 (custom-declare-variable-early): New function.
Richard M. Stallman <rms@gnu.org>
parents: 18828
diff changeset
1592 (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
1593 "*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
1594 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
1595
1ed40ed8e0c1 (custom-declare-variable-early): New function.
Richard M. Stallman <rms@gnu.org>
parents: 18828
diff changeset
1596 (custom-declare-variable-early
47916
0bb8dc016c43 (remq): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 47747
diff changeset
1597 'read-quoted-char-radix 8
18880
1ed40ed8e0c1 (custom-declare-variable-early): New function.
Richard M. Stallman <rms@gnu.org>
parents: 18828
diff changeset
1598 "*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
1599 Legitimate radix values are 8, 10 and 16."
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1600 :type '(choice (const 8) (const 10) (const 16))
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
1601 :group 'editing-basics)
18828
4837387f683c (read-quoted-char): Handle non-character events.
Richard M. Stallman <rms@gnu.org>
parents: 18821
diff changeset
1602
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1603 (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
1604 "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
1605 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
1606 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
1607 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
1608 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
1609 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
1610
21008
7111f9cf9392 (read-quoted-char): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 20939
diff changeset
1611 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
1612 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
1613 for numeric input."
50427
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1614 (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
1615 (while (not done)
83425393d550 (read-quoted-char): Read any number of octal digits,
Richard M. Stallman <rms@gnu.org>
parents: 18044
diff changeset
1616 (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
1617 ;; 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
1618 (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
1619 (help-form
f75e47f673f4 (read-quoted-char): Turn on help-form and turn off help-char.
Karl Heuer <kwzh@gnu.org>
parents: 12016
diff changeset
1620 "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
1621 or the octal character code.
18828
4837387f683c (read-quoted-char): Handle non-character events.
Richard M. Stallman <rms@gnu.org>
parents: 18821
diff changeset
1622 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
1623 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
1624 (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
1625 (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
1626 ;; 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
1627 ;; Note: `read-char' does it using the `ascii-character' property.
399628a16c0a (read-key-auxiliary-map, read-key): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47690
diff changeset
1628 ;; We could try and use read-key-sequence instead, but then C-q ESC
399628a16c0a (read-key-auxiliary-map, read-key): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47690
diff changeset
1629 ;; or C-q C-x might not return immediately since ESC or C-x might be
399628a16c0a (read-key-auxiliary-map, read-key): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47690
diff changeset
1630 ;; bound to some prefix in function-key-map or key-translation-map.
50427
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1631 (setq translated char)
83394
7d093d9d4479 Fix semantics of terminal-local variables. Remove `terminal-local-value' hack.
Karoly Lorentey <lorentey@elte.hu>
parents: 83392
diff changeset
1632 (let ((translation (lookup-key local-function-key-map (vector char))))
50427
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1633 (if (arrayp translation)
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1634 (setq translated (aref translation 0))))
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1635 (cond ((null translated))
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1636 ((not (integerp translated))
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1637 (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
1638 done t))
50427
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1639 ((/= (logand translated ?\M-\^@) 0)
19175
3d80c899a15d (read-quoted-char): Fix handling of meta-chars.
Richard M. Stallman <rms@gnu.org>
parents: 19002
diff changeset
1640 ;; 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
1641 (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
1642 done t))
50427
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1643 ((and (<= ?0 translated) (< translated (+ ?0 (min 10 read-quoted-char-radix))))
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1644 (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
1645 (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
1646 ((and (<= ?a (downcase translated))
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
1647 (< (downcase translated) (+ ?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
1648 (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
1649 (+ 10 (- (downcase translated) ?a))))
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1650 (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
1651 ((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
1652 (setq done t))
83425393d550 (read-quoted-char): Read any number of octal digits,
Richard M. Stallman <rms@gnu.org>
parents: 18044
diff changeset
1653 ((not first)
50427
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1654 (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
1655 done t))
50427
6ce9db7934cb (read-quoted-char): Remember the input char
Richard M. Stallman <rms@gnu.org>
parents: 50417
diff changeset
1656 (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
1657 done t)))
83425393d550 (read-quoted-char): Read any number of octal digits,
Richard M. Stallman <rms@gnu.org>
parents: 18044
diff changeset
1658 (setq first nil))
19175
3d80c899a15d (read-quoted-char): Fix handling of meta-chars.
Richard M. Stallman <rms@gnu.org>
parents: 19002
diff changeset
1659 code))
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1660
57789
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1661 (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
1662 "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
1663 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
1664 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
1665
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1666 This function echoes `.' for each character that the user types.
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1667 The user ends with RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line.
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1668 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
1669 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
1670
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1671 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
1672 by doing (clear-string STRING)."
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1673 (with-local-quit
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1674 (if confirm
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1675 (let (success)
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1676 (while (not success)
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1677 (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
1678 (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
1679 (if (equal first second)
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1680 (progn
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1681 (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
1682 (setq success first))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1683 (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
1684 (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
1685 (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
1686 (sit-for 1))))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1687 success)
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1688 (let ((pass nil)
70897
b08d75867f7f (read-passwd): Copy PROMPT before changing its properties.
Richard M. Stallman <rms@gnu.org>
parents: 70879
diff changeset
1689 ;; 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
1690 ;; 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
1691 (prompt (copy-sequence prompt))
57789
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1692 (c 0)
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1693 (echo-keystrokes 0)
69978
cb54ae454387 (read-passwd): Bind `message-log-max' to nil.
Romain Francoise <romain@orebokech.com>
parents: 69830
diff changeset
1694 (cursor-in-echo-area t)
cb54ae454387 (read-passwd): Bind `message-log-max' to nil.
Romain Francoise <romain@orebokech.com>
parents: 69830
diff changeset
1695 (message-log-max nil))
67012
6b634736fd83 (read-passwd): Fontify the prompt as we do with other prompts.
Eli Zaretskii <eliz@gnu.org>
parents: 66508
diff changeset
1696 (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
1697 minibuffer-prompt-properties prompt)
57789
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1698 (while (progn (message "%s%s"
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1699 prompt
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1700 (make-string (length pass) ?.))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1701 (setq c (read-char-exclusive nil t))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1702 (and (/= c ?\r) (/= c ?\n) (/= c ?\e)))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1703 (clear-this-command-keys)
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1704 (if (= c ?\C-u)
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1705 (progn
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1706 (and (arrayp pass) (clear-string pass))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1707 (setq pass ""))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1708 (if (and (/= c ?\b) (/= c ?\177))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1709 (let* ((new-char (char-to-string c))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1710 (new-pass (concat pass new-char)))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1711 (and (arrayp pass) (clear-string pass))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1712 (clear-string new-char)
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1713 (setq c ?\0)
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1714 (setq pass new-pass))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1715 (if (> (length pass) 0)
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1716 (let ((new-pass (substring pass 0 -1)))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1717 (and (arrayp pass) (clear-string pass))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1718 (setq pass new-pass))))))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1719 (message nil)
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1720 (or pass default "")))))
6a6fe71c779d subr.el (read-passwd): Move back from password.el.
Simon Josefsson <jas@extundo.com>
parents: 57778
diff changeset
1721
54570
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
1722 ;; 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
1723 (defun read-number (prompt &optional default)
77359
d57bf0ca865e (read-number): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 77092
diff changeset
1724 "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
1725 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
1726 The value of DEFAULT is inserted into PROMPT."
54570
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
1727 (let ((n nil))
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
1728 (when default
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
1729 (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
1730 (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
1731 (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
1732 (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
1733 (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
1734 prompt t t))))
54570
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
1735 (while
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
1736 (progn
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
1737 (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
1738 (and default
f5cafaedbab0 (read-number): Check whether `default' is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54887
diff changeset
1739 (number-to-string default)))))
77423
954d7a5a16f6 (read-number): Catch errors.
Richard M. Stallman <rms@gnu.org>
parents: 77359
diff changeset
1740 (condition-case nil
954d7a5a16f6 (read-number): Catch errors.
Richard M. Stallman <rms@gnu.org>
parents: 77359
diff changeset
1741 (setq n (cond
954d7a5a16f6 (read-number): Catch errors.
Richard M. Stallman <rms@gnu.org>
parents: 77359
diff changeset
1742 ((zerop (length str)) default)
954d7a5a16f6 (read-number): Catch errors.
Richard M. Stallman <rms@gnu.org>
parents: 77359
diff changeset
1743 ((stringp str) (read str))))
954d7a5a16f6 (read-number): Catch errors.
Richard M. Stallman <rms@gnu.org>
parents: 77359
diff changeset
1744 (error nil)))
54570
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
1745 (unless (numberp n)
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
1746 (message "Please enter a number.")
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
1747 (sit-for 1)
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
1748 t)))
cf58c77ee000 (read-number): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54016
diff changeset
1749 n))
71763
bedc73f663be * subr.el (sit-for): New function.
Chong Yidong <cyd@stupidchicken.com>
parents: 71726
diff changeset
1750
bedc73f663be * subr.el (sit-for): New function.
Chong Yidong <cyd@stupidchicken.com>
parents: 71726
diff changeset
1751 (defun sit-for (seconds &optional nodisp obsolete)
bedc73f663be * subr.el (sit-for): New function.
Chong Yidong <cyd@stupidchicken.com>
parents: 71726
diff changeset
1752 "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
1753 SECONDS may be a floating-point value.
bedc73f663be * subr.el (sit-for): New function.
Chong Yidong <cyd@stupidchicken.com>
parents: 71726
diff changeset
1754 \(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
1755 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
1756
bedc73f663be * subr.el (sit-for): New function.
Chong Yidong <cyd@stupidchicken.com>
parents: 71726
diff changeset
1757 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
1758 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
1759
bedc73f663be * subr.el (sit-for): New function.
Chong Yidong <cyd@stupidchicken.com>
parents: 71726
diff changeset
1760 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
1761
71775
dbb73e0b716b (sit-for): Doc fix. Specify normal arg list using fn-form.
Kim F. Storm <storm@cua.dk>
parents: 71763
diff changeset
1762 An obsolete, but still supported form is
71763
bedc73f663be * subr.el (sit-for): New function.
Chong Yidong <cyd@stupidchicken.com>
parents: 71726
diff changeset
1763 \(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
1764 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
1765 in milliseconds; this was useful when Emacs was built without
71775
dbb73e0b716b (sit-for): Doc fix. Specify normal arg list using fn-form.
Kim F. Storm <storm@cua.dk>
parents: 71763
diff changeset
1766 floating point support.
dbb73e0b716b (sit-for): Doc fix. Specify normal arg list using fn-form.
Kim F. Storm <storm@cua.dk>
parents: 71763
diff changeset
1767
dbb73e0b716b (sit-for): Doc fix. Specify normal arg list using fn-form.
Kim F. Storm <storm@cua.dk>
parents: 71763
diff changeset
1768 \(fn SECONDS &optional NODISP)"
72817
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
1769 (when (or obsolete (numberp nodisp))
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
1770 (setq seconds (+ seconds (* 1e-3 nodisp)))
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
1771 (setq nodisp obsolete))
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
1772 (cond
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
1773 (noninteractive
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
1774 (sleep-for seconds)
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
1775 t)
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
1776 ((input-pending-p)
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
1777 nil)
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
1778 ((<= seconds 0)
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
1779 (or nodisp (redisplay)))
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
1780 (t
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
1781 (or nodisp (redisplay))
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
1782 (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
1783 (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
1784 (progn
03050ee24abc (add-to-list): Optimize if compare-fn is `eq' or `eql'.
Kim F. Storm <storm@cua.dk>
parents: 73415
diff changeset
1785 ;; 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
1786 ;; 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
1787 ;; 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
1788 (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
1789 (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
1790 (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
1791 nil))))))
20472
79ea90039b23 (read-password): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20410
diff changeset
1792
44668
52222efc9d4d (insert-for-yank): New function.
Richard M. Stallman <rms@gnu.org>
parents: 44473
diff changeset
1793 ;;; Atomic change groups.
52222efc9d4d (insert-for-yank): New function.
Richard M. Stallman <rms@gnu.org>
parents: 44473
diff changeset
1794
43126
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1795 (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
1796 "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
1797 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
1798 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
1799 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
1800
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1801 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
1802 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
1803 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
1804 (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
1805 (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
1806 (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
1807 `(let ((,handle (prepare-change-group))
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1808 (,success nil))
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1809 (unwind-protect
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1810 (progn
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1811 ;; 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
1812 ;; 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
1813 ;; 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
1814 (activate-change-group ,handle)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1815 ,@body
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1816 (setq ,success t))
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1817 ;; 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
1818 ;; 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
1819 (if ,success
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1820 (accept-change-group ,handle)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1821 (cancel-change-group ,handle))))))
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1822
51068
4441e202a6f4 (prepare-change-group): Reinstate BUFFER arg; make it work.
Richard M. Stallman <rms@gnu.org>
parents: 51062
diff changeset
1823 (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
1824 "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
1825 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
1826
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1827 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
1828 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
1829
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1830 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
1831 `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
1832 `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
1833 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
1834 `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
1835 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
1836 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
1837 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
1838 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
1839
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1840 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
1841 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
1842 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
1843
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1844 (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
1845 (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
1846
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1847 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
1848 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
1849 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
1850
51068
4441e202a6f4 (prepare-change-group): Reinstate BUFFER arg; make it work.
Richard M. Stallman <rms@gnu.org>
parents: 51062
diff changeset
1851 (if buffer
4441e202a6f4 (prepare-change-group): Reinstate BUFFER arg; make it work.
Richard M. Stallman <rms@gnu.org>
parents: 51062
diff changeset
1852 (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
1853 (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
1854
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1855 (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
1856 "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
1857 (dolist (elt handle)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1858 (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
1859 (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
1860 (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
1861
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1862 (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
1863 "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
1864 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
1865 (dolist (elt handle)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1866 (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
1867 (if (eq elt t)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1868 (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
1869
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1870 (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
1871 "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
1872 This finishes the change group by reverting all of its changes."
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1873 (dolist (elt handle)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1874 (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
1875 (setq elt (cdr elt))
47916
0bb8dc016c43 (remq): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 47747
diff changeset
1876 (let ((old-car
43126
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1877 (if (consp elt) (car elt)))
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1878 (old-cdr
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1879 (if (consp elt) (cdr elt))))
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1880 ;; Temporarily truncate the undo log at ELT.
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1881 (when (consp elt)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1882 (setcar elt nil) (setcdr elt nil))
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1883 (unless (eq last-command 'undo) (undo-start))
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1884 ;; Make sure there's no confusion.
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1885 (when (and (consp elt) (not (eq elt (last pending-undo-list))))
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1886 (error "Undoing to some unrelated state"))
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1887 ;; Undo it all.
67917
15149da0b974 (cancel-change-group): Add listp around pending-undo-list.
Juri Linkov <juri@jurta.org>
parents: 67899
diff changeset
1888 (while (listp pending-undo-list) (undo-more 1))
43126
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1889 ;; Reset the modified cons cell ELT to its original content.
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1890 (when (consp elt)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1891 (setcar elt old-car)
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1892 (setcdr elt old-cdr))
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1893 ;; Revert the undo info to what it was when we grabbed the state.
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1894 (setq buffer-undo-list elt)))))
6f39ff1c6d8f (atomic-change-group, prepare-change-group, activate-change-group)
Richard M. Stallman <rms@gnu.org>
parents: 42941
diff changeset
1895
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
1896 ;;;; 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
1897
44285
30505fab0350 (redraw-modeline): Define alias.
Richard M. Stallman <rms@gnu.org>
parents: 44251
diff changeset
1898 ;; For compatibility.
30505fab0350 (redraw-modeline): Define alias.
Richard M. Stallman <rms@gnu.org>
parents: 44251
diff changeset
1899 (defalias 'redraw-modeline 'force-mode-line-update)
30505fab0350 (redraw-modeline): Define alias.
Richard M. Stallman <rms@gnu.org>
parents: 44251
diff changeset
1900
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1901 (defun force-mode-line-update (&optional all)
52858
b4112065d679 (force-mode-line-update): Fix docstring.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
1902 "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
1903 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
1904 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
1905 menu bar menus and the frame title."
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1906 (if all (save-excursion (set-buffer (other-buffer))))
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1907 (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
1908
41618
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
1909 (defun momentary-string-display (string pos &optional exit-char message)
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
1910 "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
1911 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
1912 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
1913 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
1914 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
1915 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
1916 input (as a command if nothing else).
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
1917 Display MESSAGE (optional fourth arg) in the echo area.
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
1918 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
1919 (or exit-char (setq exit-char ?\s))
76583
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1920 (let ((inhibit-read-only t)
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1921 ;; Don't modify the undo list at all.
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1922 (buffer-undo-list t)
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1923 (modified (buffer-modified-p))
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1924 (name buffer-file-name)
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1925 insert-end)
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
1926 (unwind-protect
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
1927 (progn
75175
c6f5de1b0b6e (momentary-string-display): Use save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 75124
diff changeset
1928 (save-excursion
76583
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1929 (goto-char pos)
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1930 ;; To avoid trouble with out-of-bounds position
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1931 (setq pos (point))
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1932 ;; defeat file locking... don't try this at home, kids!
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1933 (setq buffer-file-name nil)
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1934 (insert-before-markers string)
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1935 (setq insert-end (point))
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1936 ;; If the message end is off screen, recenter now.
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1937 (if (< (window-end nil t) insert-end)
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1938 (recenter (/ (window-height) 2)))
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1939 ;; If that pushed message start off the screen,
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1940 ;; scroll to start it at the top of the screen.
75175
c6f5de1b0b6e (momentary-string-display): Use save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 75124
diff changeset
1941 (move-to-window-line 0)
c6f5de1b0b6e (momentary-string-display): Use save-excursion.
Richard M. Stallman <rms@gnu.org>
parents: 75124
diff changeset
1942 (if (> (point) pos)
76583
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1943 (progn
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1944 (goto-char pos)
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1945 (recenter 0))))
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
1946 (message (or message "Type %s to continue editing.")
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
1947 (single-key-description exit-char))
55187
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
1948 (let (char)
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
1949 (if (integerp exit-char)
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
1950 (condition-case nil
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
1951 (progn
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
1952 (setq char (read-char))
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
1953 (or (eq char exit-char)
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
1954 (setq unread-command-events (list char))))
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
1955 (error
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
1956 ;; `exit-char' is a character, hence it differs
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
1957 ;; from char, which is an event.
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
1958 (setq unread-command-events (list char))))
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
1959 ;; `exit-char' can be an event, or an event description
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
1960 ;; list.
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
1961 (setq char (read-event))
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
1962 (or (eq char exit-char)
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
1963 (eq char (event-convert-list exit-char))
1bc853c54243 (momentary-string-display): Support EXIT-CHAR that is
Eli Zaretskii <eliz@gnu.org>
parents: 55013
diff changeset
1964 (setq unread-command-events (list char))))))
76583
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1965 (if insert-end
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1966 (save-excursion
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1967 (delete-region pos insert-end)))
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1968 (setq buffer-file-name name)
8693ff852e51 Revert 2007-01-04 change by Kevin Rodgers due to lack of legal papers.
Chong Yidong <cyd@stupidchicken.com>
parents: 76565
diff changeset
1969 (set-buffer-modified-p modified))))
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
1970
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
1971
41618
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
1972 ;;;; Overlay operations
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
1973
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
1974 (defun copy-overlay (o)
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
1975 "Return a copy of overlay O."
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
1976 (let ((o1 (make-overlay (overlay-start o) (overlay-end o)
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
1977 ;; FIXME: there's no easy way to find the
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
1978 ;; insertion-type of the two markers.
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
1979 (overlay-buffer o)))
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
1980 (props (overlay-properties o)))
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
1981 (while props
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
1982 (overlay-put o1 (pop props) (pop props)))
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
1983 o1))
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
1984
55202
4c64ee838f41 * subr.el (remove-overlays): Make arguments optional.
Masatake YAMATO <jet@gyve.org>
parents: 55187
diff changeset
1985 (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
1986 "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
1987 Overlays might be moved and/or split.
e191e6d1554e (remove-overlays, read-passwd): Fix docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55406
diff changeset
1988 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
1989 ;; 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
1990 (unless beg (setq beg (point-min)))
4c64ee838f41 * subr.el (remove-overlays): Make arguments optional.
Masatake YAMATO <jet@gyve.org>
parents: 55187
diff changeset
1991 (unless end (setq end (point-max)))
73943
882d43d66c71 (remove-overlays): Fix last change.
Richard M. Stallman <rms@gnu.org>
parents: 73831
diff changeset
1992 (overlay-recenter end)
41618
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
1993 (if (< end beg)
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
1994 (setq beg (prog1 end (setq end beg))))
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
1995 (save-excursion
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
1996 (dolist (o (overlays-in beg end))
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
1997 (when (eq (overlay-get o name) val)
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
1998 ;; Either push this overlay outside beg...end
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
1999 ;; or split it to exclude beg...end
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2000 ;; 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
2001 (if (< (overlay-start o) beg)
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2002 (if (> (overlay-end o) end)
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2003 (progn
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2004 (move-overlay (copy-overlay o)
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2005 (overlay-start o) beg)
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2006 (move-overlay o end (overlay-end o)))
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2007 (move-overlay o (overlay-start o) beg))
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2008 (if (> (overlay-end o) end)
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2009 (move-overlay o end (overlay-end o))
812e52cc5162 (copy-overlay, remove-overlays): New funs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41187
diff changeset
2010 (delete-overlay o)))))))
42917
ec2db12c7670 (copy-without-properties): New function.
Richard M. Stallman <rms@gnu.org>
parents: 42266
diff changeset
2011
2504
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
2012 ;;;; Miscellanea.
181eef669324 * subr.el (overlay-start, overlay-end, overlay-buffer): New
Jim Blandy <jimb@redhat.com>
parents: 2428
diff changeset
2013
20846
985a277c9b9a (suspend-hook, suspend-resume-hook): New defvars.
Richard M. Stallman <rms@gnu.org>
parents: 20687
diff changeset
2014 (defvar suspend-hook nil
985a277c9b9a (suspend-hook, suspend-resume-hook): New defvars.
Richard M. Stallman <rms@gnu.org>
parents: 20687
diff changeset
2015 "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
2016
985a277c9b9a (suspend-hook, suspend-resume-hook): New defvars.
Richard M. Stallman <rms@gnu.org>
parents: 20687
diff changeset
2017 (defvar suspend-resume-hook nil
985a277c9b9a (suspend-hook, suspend-resume-hook): New defvars.
Richard M. Stallman <rms@gnu.org>
parents: 20687
diff changeset
2018 "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
2019
42083
981f93cc55d1 (temp-buffer-show-hook, temp-buffer-setup-hook): Add defvars.
Richard M. Stallman <rms@gnu.org>
parents: 42076
diff changeset
2020 (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
2021 "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
2022 When the hook runs, the temporary buffer is current, and the window it
981f93cc55d1 (temp-buffer-show-hook, temp-buffer-setup-hook): Add defvars.
Richard M. Stallman <rms@gnu.org>
parents: 42076
diff changeset
2023 was displayed in is selected. This hook is normally set up with a
981f93cc55d1 (temp-buffer-show-hook, temp-buffer-setup-hook): Add defvars.
Richard M. Stallman <rms@gnu.org>
parents: 42076
diff changeset
2024 function to make the buffer read only, and find function names and
981f93cc55d1 (temp-buffer-show-hook, temp-buffer-setup-hook): Add defvars.
Richard M. Stallman <rms@gnu.org>
parents: 42076
diff changeset
2025 variable names in it, provided the major mode is still Help mode.")
981f93cc55d1 (temp-buffer-show-hook, temp-buffer-setup-hook): Add defvars.
Richard M. Stallman <rms@gnu.org>
parents: 42076
diff changeset
2026
981f93cc55d1 (temp-buffer-show-hook, temp-buffer-setup-hook): Add defvars.
Richard M. Stallman <rms@gnu.org>
parents: 42076
diff changeset
2027 (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
2028 "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
2029 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
2030 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
2031 mode.")
981f93cc55d1 (temp-buffer-show-hook, temp-buffer-setup-hook): Add defvars.
Richard M. Stallman <rms@gnu.org>
parents: 42076
diff changeset
2032
10254
1ac3c8fea14a (font-lock-defaults): Add defvar.
Richard M. Stallman <rms@gnu.org>
parents: 10178
diff changeset
2033 ;; Avoid compiler warnings about this variable,
1ac3c8fea14a (font-lock-defaults): Add defvar.
Richard M. Stallman <rms@gnu.org>
parents: 10178
diff changeset
2034 ;; 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
2035 (defvar buffer-file-type nil
1ac3c8fea14a (font-lock-defaults): Add defvar.
Richard M. Stallman <rms@gnu.org>
parents: 10178
diff changeset
2036 "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
2037 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
2038 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
2039 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
2040
f4d24a8eaed1 (toplevel): Define `cl-assertion-failed' condition here because the
John Paul Wallington <jpw@pobox.com>
parents: 68400
diff changeset
2041 ;; 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
2042 ;; `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
2043 (put 'cl-assertion-failed 'error-conditions '(error))
f4d24a8eaed1 (toplevel): Define `cl-assertion-failed' condition here because the
John Paul Wallington <jpw@pobox.com>
parents: 68400
diff changeset
2044 (put 'cl-assertion-failed 'error-message "Assertion failed")
f4d24a8eaed1 (toplevel): Define `cl-assertion-failed' condition here because the
John Paul Wallington <jpw@pobox.com>
parents: 68400
diff changeset
2045
81338
62535fec6ee1 (user-emacs-directory): New defconst.
Chong Yidong <cyd@stupidchicken.com>
parents: 77423
diff changeset
2046 (defconst user-emacs-directory
62535fec6ee1 (user-emacs-directory): New defconst.
Chong Yidong <cyd@stupidchicken.com>
parents: 77423
diff changeset
2047 (if (eq system-type 'ms-dos)
62535fec6ee1 (user-emacs-directory): New defconst.
Chong Yidong <cyd@stupidchicken.com>
parents: 77423
diff changeset
2048 ;; MS-DOS cannot have initial dot.
62535fec6ee1 (user-emacs-directory): New defconst.
Chong Yidong <cyd@stupidchicken.com>
parents: 77423
diff changeset
2049 "~/_emacs.d/"
62535fec6ee1 (user-emacs-directory): New defconst.
Chong Yidong <cyd@stupidchicken.com>
parents: 77423
diff changeset
2050 "~/.emacs.d/")
62535fec6ee1 (user-emacs-directory): New defconst.
Chong Yidong <cyd@stupidchicken.com>
parents: 77423
diff changeset
2051 "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
2052 Various programs in Emacs store information in this directory.
62535fec6ee1 (user-emacs-directory): New defconst.
Chong Yidong <cyd@stupidchicken.com>
parents: 77423
diff changeset
2053 Note that this should end with a directory separator.")
62535fec6ee1 (user-emacs-directory): New defconst.
Chong Yidong <cyd@stupidchicken.com>
parents: 77423
diff changeset
2054
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2055
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2056 ;;;; 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
2057
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2058 (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
2059 "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
2060 If there is no plausible default, return nil."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2061 (save-excursion
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2062 (while (looking-at "\\sw\\|\\s_")
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2063 (forward-char 1))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2064 (if (or (re-search-backward "\\sw\\|\\s_"
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2065 (save-excursion (beginning-of-line) (point))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2066 t)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2067 (re-search-forward "\\(\\sw\\|\\s_\\)+"
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2068 (save-excursion (end-of-line) (point))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2069 t))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2070 (progn
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2071 (goto-char (match-end 0))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2072 (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
2073 (buffer-substring-no-properties
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2074 (point)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2075 (progn (forward-sexp -1)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2076 (while (looking-at "\\s'")
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2077 (forward-char 1))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2078 (point)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2079 (error nil)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2080 nil)))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2081
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2082 (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
2083 "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
2084 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
2085
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2086 :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
2087 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
2088
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2089 :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
2090
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2091 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
2092
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2093 :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
2094 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
2095 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
2096
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2097 :device DEVICE - play sound on DEVICE. 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
2098 a system-dependent default device name is used."
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2099 (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
2100 (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
2101 (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
2102
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2103 (defun shell-quote-argument (argument)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2104 "Quote an 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
2105 (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
2106 (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
2107 ;; 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
2108 ;; 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
2109 (let ((result "")
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2110 (start 0)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2111 end)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2112 (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
2113 (< (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
2114 (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
2115 (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
2116 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
2117 "\\" (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
2118 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
2119 (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
2120 (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
2121 "''"
c637565b16e8 (shell-quote-argument): Use DOS logic for Windows shells with DOS semantics.
Jason Rumney <jasonr@gnu.org>
parents: 73028
diff changeset
2122 ;; 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
2123 ;; 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
2124 (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
2125 (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
2126 (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
2127 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
2128 "\\" (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
2129 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
2130 (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
2131
196122ba0b05 * subr.el (string-or-null-p): New function.
Reiner Steib <Reiner.Steib@gmx.de>
parents: 69168
diff changeset
2132 (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
2133 "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
2134 Otherwise, return nil."
196122ba0b05 * subr.el (string-or-null-p): New function.
Reiner Steib <Reiner.Steib@gmx.de>
parents: 69168
diff changeset
2135 (or (stringp object) (null object)))
196122ba0b05 * subr.el (string-or-null-p): New function.
Reiner Steib <Reiner.Steib@gmx.de>
parents: 69168
diff changeset
2136
70267
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
2137 (defun booleanp (object)
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
2138 "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
2139 (memq object '(nil t)))
a2c45c9f7e1f (booleanp): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 70229
diff changeset
2140
70552
1121231ccc23 Revision: emacs@sv.gnu.org/emacs--devo--0--patch-271
Miles Bader <miles@gnu.org>
parents: 70547
diff changeset
2141 (defun field-at-pos (pos)
70547
e184fae4f7dd (field-at-point): New function.
Nick Roberts <nickrob@snap.net.nz>
parents: 70512
diff changeset
2142 "Return the field at position POS, taking stickiness etc into account"
e184fae4f7dd (field-at-point): New function.
Nick Roberts <nickrob@snap.net.nz>
parents: 70512
diff changeset
2143 (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
2144 (if (eq raw-field 'boundary)
e184fae4f7dd (field-at-point): New function.
Nick Roberts <nickrob@snap.net.nz>
parents: 70512
diff changeset
2145 (get-char-property (1- (field-end pos)) 'field)
e184fae4f7dd (field-at-point): New function.
Nick Roberts <nickrob@snap.net.nz>
parents: 70512
diff changeset
2146 raw-field)))
e184fae4f7dd (field-at-point): New function.
Nick Roberts <nickrob@snap.net.nz>
parents: 70512
diff changeset
2147
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2148
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2149 ;;;; 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
2150
44668
52222efc9d4d (insert-for-yank): New function.
Richard M. Stallman <rms@gnu.org>
parents: 44473
diff changeset
2151 (defvar yank-excluded-properties)
52222efc9d4d (insert-for-yank): New function.
Richard M. Stallman <rms@gnu.org>
parents: 44473
diff changeset
2152
44980
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2153 (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
2154 "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
2155 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
2156 (let ((inhibit-read-only t))
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2157 ;; Replace any `category' property with the properties it stands for.
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2158 (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
2159 (save-excursion
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2160 (goto-char start)
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2161 (while (< (point) end)
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2162 (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
2163 run-end)
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2164 (setq run-end
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2165 (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
2166 (when cat
cb548fe4bcdb (remove-yank-excluded-properties): Fix bugs in handling of category properties.
Richard M. Stallman <rms@gnu.org>
parents: 47652
diff changeset
2167 (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
2168 (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
2169 (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
2170 (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
2171 (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
2172 (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
2173 (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
2174 (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
2175 (goto-char run-end)))))
44980
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2176 (if (eq yank-excluded-properties t)
5eb4aa56b278 (remove-yank-excluded-properties): New helper function.
Kim F. Storm <storm@cua.dk>
parents: 44945
diff changeset
2177 (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
2178 (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
2179
49310
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2180 (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
2181
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2182 (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
2183 "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
2184
6dab9150c9e0 (insert-for-yank): Call insert-for-yank-1 repetitively
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53197
diff changeset
2185 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
2186 (let (to)
6dab9150c9e0 (insert-for-yank): Call insert-for-yank-1 repetitively
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53197
diff changeset
2187 (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
2188 (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
2189 (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
2190 (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
2191
6dab9150c9e0 (insert-for-yank): Call insert-for-yank-1 repetitively
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53197
diff changeset
2192 (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
2193 "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
2194
49310
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2195 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
2196 `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
2197
49363
7bf92531d421 Tiny doc fixes.
Kim F. Storm <storm@cua.dk>
parents: 49318
diff changeset
2198 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
2199 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
2200 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
2201 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
2202 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
2203 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
2204 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
2205 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
2206 `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
2207 rectangle.
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2208 If NOEXCLUDE is present and non-nil, the normal removal of the
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2209 yank-excluded-properties is not performed; instead FUNCTION is
32fe2d888907 (insert-for-yank): Arg list changed; now only accepts one
Kim F. Storm <storm@cua.dk>
parents: 49225
diff changeset
2210 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
2211 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
2212 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
2213 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
2214 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
2215 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
2216 (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
2217 (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
2218 (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
2219 (opoint (point))
75748
8c99ad9fd6c0 (insert-for-yank-1): Prevent read-only properties from interfering
Chong Yidong <cyd@stupidchicken.com>
parents: 75347
diff changeset
2220 (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
2221 end)
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2222
49318
63a122cc4286 (insert-for-yank): Set yank-undo-function after calling FUNCTION,
Kim F. Storm <storm@cua.dk>
parents: 49313
diff changeset
2223 (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
2224 (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
2225 (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
2226 (insert param))
73153
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2227 (setq end (point))
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2228
75748
8c99ad9fd6c0 (insert-for-yank-1): Prevent read-only properties from interfering
Chong Yidong <cyd@stupidchicken.com>
parents: 75347
diff changeset
2229 ;; 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
2230 ;; following text property changes.
8c99ad9fd6c0 (insert-for-yank-1): Prevent read-only properties from interfering
Chong Yidong <cyd@stupidchicken.com>
parents: 75347
diff changeset
2231 (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
2232
73153
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2233 ;; 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
2234 (if font-lock-defaults
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2235 ;; No, just wipe them.
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2236 (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
2237 ;; Convert them to `face'.
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2238 (save-excursion
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2239 (goto-char opoint)
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2240 (while (< (point) end)
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2241 (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
2242 run-end)
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2243 (setq run-end
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2244 (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
2245 (when face
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2246 (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
2247 (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
2248 (goto-char run-end)))))
d18b30d3454b (insert-for-yank-1): Handle `font-lock-face' specially.
Richard M. Stallman <rms@gnu.org>
parents: 73125
diff changeset
2249
49318
63a122cc4286 (insert-for-yank): Set yank-undo-function after calling FUNCTION,
Kim F. Storm <storm@cua.dk>
parents: 49313
diff changeset
2250 (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
2251 (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
2252
56ea5a847db0 (insert-for-yank-1): If last inserted char has properties,
Richard M. Stallman <rms@gnu.org>
parents: 73357
diff changeset
2253 ;; 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
2254 (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
2255 (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
2256 (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
2257
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
2258 (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
2259 (setq yank-undo-function (nth 3 handler))) ;; UNDO
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
2260 (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
2261 (setq this-command (nth 4 handler)))))
49597
e88404e8f2cf Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49492
diff changeset
2262
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
2263 (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
2264 "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
2265 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
2266 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
2267 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
2268 (let ((opoint (point)))
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
2269 (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
2270 (let ((inhibit-read-only t))
f5b7b7055a64 (insert-buffer-substring-no-properties): New function.
Kim F. Storm <storm@cua.dk>
parents: 44668
diff changeset
2271 (set-text-properties opoint (point) nil))))
f5b7b7055a64 (insert-buffer-substring-no-properties): New function.
Kim F. Storm <storm@cua.dk>
parents: 44668
diff changeset
2272
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
2273 (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
2274 "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
2275 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
2276 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
2277 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
2278 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
2279 `yank-excluded-properties'."
52379
541533296a1d Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 52132
diff changeset
2280 ;; Since the buffer text should not normally have yank-handler properties,
541533296a1d Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 52132
diff changeset
2281 ;; 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
2282 (let ((opoint (point)))
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
2283 (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
2284 (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
2285
44668
52222efc9d4d (insert-for-yank): New function.
Richard M. Stallman <rms@gnu.org>
parents: 44473
diff changeset
2286
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2287 ;;;; Synchronous shell commands.
44668
52222efc9d4d (insert-for-yank): New function.
Richard M. Stallman <rms@gnu.org>
parents: 44473
diff changeset
2288
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
2289 (defun start-process-shell-command (name buffer &rest args)
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
2290 "Start a program in a subprocess. Return the process object for it.
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
2291 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
2292 BUFFER is the buffer (or buffer name) to associate with the process.
114
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
2293 Process output goes at end of that buffer, unless you specify
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
2294 an output stream or filter function to handle the output.
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
2295 BUFFER may be also nil, meaning that this process is not associated
899728e6052a Initial revision
David Lawrence <tale@gnu.org>
parents:
diff changeset
2296 with any buffer
55502
75efe89a09b7 (start-process-shell-command): Fix docstring. Put usage info in a format usable
Juanma Barranquero <lekktu@gmail.com>
parents: 55477
diff changeset
2297 COMMAND is the name of a shell command.
73357
d62e39d56ebb (start-process-shell-command): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 73153
diff changeset
2298 Remaining arguments are the arguments for the command; they are all
d62e39d56ebb (start-process-shell-command): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 73153
diff changeset
2299 spliced together with blanks separating between each two of them, before
d62e39d56ebb (start-process-shell-command): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 73153
diff changeset
2300 passing the command to the shell.
55502
75efe89a09b7 (start-process-shell-command): Fix docstring. Put usage info in a format usable
Juanma Barranquero <lekktu@gmail.com>
parents: 55477
diff changeset
2301 Wildcards and redirection are handled as usual in the shell.
75efe89a09b7 (start-process-shell-command): Fix docstring. Put usage info in a format usable
Juanma Barranquero <lekktu@gmail.com>
parents: 55477
diff changeset
2302
75efe89a09b7 (start-process-shell-command): Fix docstring. Put usage info in a format usable
Juanma Barranquero <lekktu@gmail.com>
parents: 55477
diff changeset
2303 \(fn NAME BUFFER COMMAND &rest COMMAND-ARGS)"
9822
248462096d25 (start-process-shell-command): Don't use exec on windows-nt.
Karl Heuer <kwzh@gnu.org>
parents: 9535
diff changeset
2304 (cond
248462096d25 (start-process-shell-command): Don't use exec on windows-nt.
Karl Heuer <kwzh@gnu.org>
parents: 9535
diff changeset
2305 ((eq system-type 'vax-vms)
248462096d25 (start-process-shell-command): Don't use exec on windows-nt.
Karl Heuer <kwzh@gnu.org>
parents: 9535
diff changeset
2306 (apply 'start-process name buffer args))
10025
3b058e13d177 (start-process-shell-command): Don't use `exec'--
Richard M. Stallman <rms@gnu.org>
parents: 9986
diff changeset
2307 ;; 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
2308 ;; but that failed to handle (...) and semicolon, etc.
9822
248462096d25 (start-process-shell-command): Don't use exec on windows-nt.
Karl Heuer <kwzh@gnu.org>
parents: 9535
diff changeset
2309 (t
248462096d25 (start-process-shell-command): Don't use exec on windows-nt.
Karl Heuer <kwzh@gnu.org>
parents: 9535
diff changeset
2310 (start-process name buffer shell-file-name shell-command-switch
10025
3b058e13d177 (start-process-shell-command): Don't use `exec'--
Richard M. Stallman <rms@gnu.org>
parents: 9986
diff changeset
2311 (mapconcat 'identity args " ")))))
39598
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2312
82094
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2313 (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
2314 "Start a program in a subprocess. Return the process object for it.
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2315 Similar to `start-process-shell-command', but calls `start-file-process'."
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2316 (start-file-process
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2317 name buffer
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2318 (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
2319 (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
2320 (mapconcat 'identity args " ")))
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2321
39598
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2322 (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
2323 &rest args)
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2324 "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
2325 The remaining arguments are optional.
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2326 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
2327 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
2328 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
2329 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
2330 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
2331 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
2332 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
2333 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
2334
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2335 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
2336 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
2337 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
2338
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2339 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
2340 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
2341 status or a signal description string.
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2342 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again."
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2343 (cond
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2344 ((eq system-type 'vax-vms)
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2345 (apply 'call-process command infile buffer display args))
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2346 ;; We used to use `exec' to replace the shell with the command,
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2347 ;; but that failed to handle (...) and semicolon, etc.
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2348 (t
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2349 (call-process shell-file-name
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2350 infile buffer display
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2351 shell-command-switch
67884544e4c8 (call-process-shell-command): New function.
Miles Bader <miles@gnu.org>
parents: 39557
diff changeset
2352 (mapconcat 'identity (cons command args) " ")))))
82094
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2353
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2354 (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
2355 &rest args)
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2356 "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
2357 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
2358 (process-file
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2359 (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
2360 infile buffer display
76546b143f2d * subr.el (start-file-process-shell-command)
Michael Albinus <michael.albinus@gmx.de>
parents: 81863
diff changeset
2361 (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
2362 (mapconcat 'identity (cons command args) " ")))
16359
18cc78dc8b18 (with-temp-file): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16333
diff changeset
2363
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2364 ;;;; 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
2365
16277
bbddbc86b82b (with-current-buffer): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 15983
diff changeset
2366 (defmacro with-current-buffer (buffer &rest body)
71151
207dba45f18e (with-current-buffer): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 71078
diff changeset
2367 "Execute the forms in BODY with BUFFER temporarily current.
71078
e917fe503f6c (with-current-buffer): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 71037
diff changeset
2368 BUFFER can be a buffer or a buffer name.
16379
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2369 The value returned is the value of the last form in BODY.
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2370 See also `with-temp-buffer'."
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2371 (declare (indent 1) (debug t))
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2372 `(save-current-buffer
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2373 (set-buffer ,buffer)
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2374 ,@body))
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2375
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2376 (defmacro with-selected-window (window &rest body)
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2377 "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
2378 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
2379
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2380 This macro saves and restores the current buffer, since otherwise
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2381 its normal operation could potentially make a different
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2382 buffer current. It does not alter the buffer list ordering.
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2383
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2384 This macro saves and restores the selected window, as well as
56402
78189fca7611 (with-selected-window): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56398
diff changeset
2385 the selected window in each frame. If the previously selected
78189fca7611 (with-selected-window): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56398
diff changeset
2386 window of some frame is no longer live at the end of BODY, that
78189fca7611 (with-selected-window): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56398
diff changeset
2387 frame's selected window is left alone. If the selected window is
78189fca7611 (with-selected-window): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56398
diff changeset
2388 no longer live, then whatever window is selected at the end of
78189fca7611 (with-selected-window): Doc fix.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56398
diff changeset
2389 BODY remains selected.
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2390 See also `with-temp-buffer'."
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2391 (declare (indent 1) (debug t))
55828
af9432138635 (with-selected-window): Undo previous change.
Richard M. Stallman <rms@gnu.org>
parents: 55812
diff changeset
2392 ;; 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
2393 `(let ((save-selected-window-window (selected-window))
af9432138635 (with-selected-window): Undo previous change.
Richard M. Stallman <rms@gnu.org>
parents: 55812
diff changeset
2394 ;; 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
2395 ;; 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
2396 ;; frame that window is in.
af9432138635 (with-selected-window): Undo previous change.
Richard M. Stallman <rms@gnu.org>
parents: 55812
diff changeset
2397 (save-selected-window-alist
af9432138635 (with-selected-window): Undo previous change.
Richard M. Stallman <rms@gnu.org>
parents: 55812
diff changeset
2398 (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
2399 (frame-list))))
63761
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2400 (save-current-buffer
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2401 (unwind-protect
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2402 (progn (select-window ,window 'norecord)
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2403 ,@body)
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2404 (dolist (elt save-selected-window-alist)
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2405 (and (frame-live-p (car elt))
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2406 (window-live-p (cadr elt))
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2407 (set-frame-selected-window (car elt) (cadr elt))))
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2408 (if (window-live-p save-selected-window-window)
f14d5e7e60e1 (with-selected-window): Use save-current-buffer.
Richard M. Stallman <rms@gnu.org>
parents: 63664
diff changeset
2409 (select-window save-selected-window-window 'norecord))))))
16277
bbddbc86b82b (with-current-buffer): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 15983
diff changeset
2410
83128
2ccd88cfde01 New control structure: with-selected-frame.
Karoly Lorentey <lorentey@elte.hu>
parents: 55520
diff changeset
2411 (defmacro with-selected-frame (frame &rest body)
2ccd88cfde01 New control structure: with-selected-frame.
Karoly Lorentey <lorentey@elte.hu>
parents: 55520
diff changeset
2412 "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
2413 The value returned is the value of the last form in BODY.
2ccd88cfde01 New control structure: with-selected-frame.
Karoly Lorentey <lorentey@elte.hu>
parents: 55520
diff changeset
2414 See also `with-temp-buffer'."
2ccd88cfde01 New control structure: with-selected-frame.
Karoly Lorentey <lorentey@elte.hu>
parents: 55520
diff changeset
2415 (declare (indent 1) (debug t))
83488
f47495b26508 Fix ediff problems. (Reported by Dan Nicolaescu.)
Karoly Lorentey <lorentey@elte.hu>
parents: 83483
diff changeset
2416 (let ((old-frame (make-symbol "old-frame"))
f47495b26508 Fix ediff problems. (Reported by Dan Nicolaescu.)
Karoly Lorentey <lorentey@elte.hu>
parents: 83483
diff changeset
2417 (old-buffer (make-symbol "old-buffer")))
f47495b26508 Fix ediff problems. (Reported by Dan Nicolaescu.)
Karoly Lorentey <lorentey@elte.hu>
parents: 83483
diff changeset
2418 `(let ((,old-frame (selected-frame))
f47495b26508 Fix ediff problems. (Reported by Dan Nicolaescu.)
Karoly Lorentey <lorentey@elte.hu>
parents: 83483
diff changeset
2419 (,old-buffer (current-buffer)))
f47495b26508 Fix ediff problems. (Reported by Dan Nicolaescu.)
Karoly Lorentey <lorentey@elte.hu>
parents: 83483
diff changeset
2420 (unwind-protect
f47495b26508 Fix ediff problems. (Reported by Dan Nicolaescu.)
Karoly Lorentey <lorentey@elte.hu>
parents: 83483
diff changeset
2421 (progn (select-frame ,frame)
f47495b26508 Fix ediff problems. (Reported by Dan Nicolaescu.)
Karoly Lorentey <lorentey@elte.hu>
parents: 83483
diff changeset
2422 ,@body)
f47495b26508 Fix ediff problems. (Reported by Dan Nicolaescu.)
Karoly Lorentey <lorentey@elte.hu>
parents: 83483
diff changeset
2423 (if (frame-live-p ,old-frame)
f47495b26508 Fix ediff problems. (Reported by Dan Nicolaescu.)
Karoly Lorentey <lorentey@elte.hu>
parents: 83483
diff changeset
2424 (select-frame ,old-frame))
f47495b26508 Fix ediff problems. (Reported by Dan Nicolaescu.)
Karoly Lorentey <lorentey@elte.hu>
parents: 83483
diff changeset
2425 (if (buffer-live-p ,old-buffer)
f47495b26508 Fix ediff problems. (Reported by Dan Nicolaescu.)
Karoly Lorentey <lorentey@elte.hu>
parents: 83483
diff changeset
2426 (set-buffer ,old-buffer))))))
83128
2ccd88cfde01 New control structure: with-selected-frame.
Karoly Lorentey <lorentey@elte.hu>
parents: 55520
diff changeset
2427
23736
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2428 (defmacro with-temp-file (file &rest body)
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2429 "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
2430 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
2431 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
2432 (declare (debug t))
16359
18cc78dc8b18 (with-temp-file): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16333
diff changeset
2433 (let ((temp-file (make-symbol "temp-file"))
16379
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2434 (temp-buffer (make-symbol "temp-buffer")))
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2435 `(let ((,temp-file ,file)
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2436 (,temp-buffer
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2437 (get-buffer-create (generate-new-buffer-name " *temp file*"))))
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2438 (unwind-protect
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2439 (prog1
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2440 (with-current-buffer ,temp-buffer
23736
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2441 ,@body)
16379
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2442 (with-current-buffer ,temp-buffer
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2443 (widen)
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2444 (write-region (point-min) (point-max) ,temp-file nil 0)))
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2445 (and (buffer-name ,temp-buffer)
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2446 (kill-buffer ,temp-buffer))))))
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2447
23736
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2448 (defmacro with-temp-message (message &rest body)
24011
f36caedebd5f Doc fix.
Simon Marshall <simon@gnu.org>
parents: 24000
diff changeset
2449 "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
2450 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
2451 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
2452 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
2453 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
2454 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
2455 (declare (debug t))
24000
2de7db40964d (with-temp-message): Don't display MESSAGE if nil.
Simon Marshall <simon@gnu.org>
parents: 23907
diff changeset
2456 (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
2457 (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
2458 `(let ((,temp-message ,message)
2de7db40964d (with-temp-message): Don't display MESSAGE if nil.
Simon Marshall <simon@gnu.org>
parents: 23907
diff changeset
2459 (,current-message))
23736
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2460 (unwind-protect
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2461 (progn
24000
2de7db40964d (with-temp-message): Don't display MESSAGE if nil.
Simon Marshall <simon@gnu.org>
parents: 23907
diff changeset
2462 (when ,temp-message
2de7db40964d (with-temp-message): Don't display MESSAGE if nil.
Simon Marshall <simon@gnu.org>
parents: 23907
diff changeset
2463 (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
2464 (message "%s" ,temp-message))
23736
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2465 ,@body)
42076
d6765861f6ea (with-temp-message): At the end, always discard
Richard M. Stallman <rms@gnu.org>
parents: 41975
diff changeset
2466 (and ,temp-message
d6765861f6ea (with-temp-message): At the end, always discard
Richard M. Stallman <rms@gnu.org>
parents: 41975
diff changeset
2467 (if ,current-message
d6765861f6ea (with-temp-message): At the end, always discard
Richard M. Stallman <rms@gnu.org>
parents: 41975
diff changeset
2468 (message "%s" ,current-message)
d6765861f6ea (with-temp-message): At the end, always discard
Richard M. Stallman <rms@gnu.org>
parents: 41975
diff changeset
2469 (message nil)))))))
23736
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2470
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2471 (defmacro with-temp-buffer (&rest body)
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2472 "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
2473 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
2474 (declare (indent 0) (debug t))
16379
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2475 (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
2476 `(let ((,temp-buffer (generate-new-buffer " *temp*")))
16379
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2477 (unwind-protect
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2478 (with-current-buffer ,temp-buffer
23736
a1b85478a209 Added with-temp-message.
Simon Marshall <simon@gnu.org>
parents: 23437
diff changeset
2479 ,@body)
16379
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2480 (and (buffer-name ,temp-buffer)
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2481 (kill-buffer ,temp-buffer))))))
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2482
16311
a56a8c6f2d8f (with-output-to-string): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16294
diff changeset
2483 (defmacro with-output-to-string (&rest body)
a56a8c6f2d8f (with-output-to-string): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16294
diff changeset
2484 "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
2485 (declare (indent 0) (debug t))
16379
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2486 `(let ((standard-output
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2487 (get-buffer-create (generate-new-buffer-name " *string-output*"))))
16311
a56a8c6f2d8f (with-output-to-string): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16294
diff changeset
2488 (let ((standard-output standard-output))
a56a8c6f2d8f (with-output-to-string): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16294
diff changeset
2489 ,@body)
16379
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2490 (with-current-buffer standard-output
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2491 (prog1
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2492 (buffer-string)
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2493 (kill-buffer nil)))))
16549
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2494
40822
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
2495 (defmacro with-local-quit (&rest body)
56565
1bef61b14e78 (with-local-quit): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 56537
diff changeset
2496 "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
2497 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
2498 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
2499 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
2500 (declare (debug t) (indent 0))
40822
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
2501 `(condition-case nil
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
2502 (let ((inhibit-quit nil))
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
2503 ,@body)
70901
cc60343f8fd6 (with-local-quit): When handling `quit' signal,
Richard M. Stallman <rms@gnu.org>
parents: 70897
diff changeset
2504 (quit (setq quit-flag t)
cc60343f8fd6 (with-local-quit): When handling `quit' signal,
Richard M. Stallman <rms@gnu.org>
parents: 70897
diff changeset
2505 ;; 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
2506 ;; in case inhibit-quit is nil.
cc60343f8fd6 (with-local-quit): When handling `quit' signal,
Richard M. Stallman <rms@gnu.org>
parents: 70897
diff changeset
2507 ;; 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
2508 ;; 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
2509 ;; 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
2510 (eval '(ignore nil)))))
40822
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
2511
58934
ee02b41be7da (while-no-input): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 58800
diff changeset
2512 (defmacro while-no-input (&rest body)
ee02b41be7da (while-no-input): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 58800
diff changeset
2513 "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
2514 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
2515 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
2516 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
2517 (declare (debug t) (indent 0))
ee02b41be7da (while-no-input): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 58800
diff changeset
2518 (let ((catch-sym (make-symbol "input")))
ee02b41be7da (while-no-input): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 58800
diff changeset
2519 `(with-local-quit
ee02b41be7da (while-no-input): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 58800
diff changeset
2520 (catch ',catch-sym
ee02b41be7da (while-no-input): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 58800
diff changeset
2521 (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
2522 (or (input-pending-p)
b70548506872 (sit-for): Rework to use input-pending-p and cond.
Kim F. Storm <storm@cua.dk>
parents: 72784
diff changeset
2523 ,@body))))))
58934
ee02b41be7da (while-no-input): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 58800
diff changeset
2524
81803
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2525 (defmacro condition-case-no-debug (var bodyform &rest handlers)
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2526 "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
2527 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
2528 (declare (debug condition-case) (indent 2))
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2529 (let ((bodysym (make-symbol "body")))
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2530 `(let ((,bodysym (lambda () ,bodyform)))
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2531 (if debug-on-error
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2532 (funcall ,bodysym)
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2533 (condition-case ,var
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2534 (funcall ,bodysym)
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2535 ,@handlers)))))
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2536
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2537 (defmacro with-demoted-errors (&rest body)
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2538 "Run BODY and demote any errors to simple messages.
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2539 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
2540 This is to be used around code which is not expected to signal an error
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2541 but which should be robust in the unexpected case that an error is signalled."
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2542 (declare (debug t) (indent 0))
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2543 (let ((err (make-symbol "err")))
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2544 `(condition-case-no-debug ,err
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2545 (progn ,@body)
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2546 (error (message "Error: %s" ,err) nil))))
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2547
16549
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2548 (defmacro combine-after-change-calls (&rest body)
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2549 "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
2550 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
2551 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
2552 when BODY is finished.
17146
b8536e42d4ef (combine-after-change-calls): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 16845
diff changeset
2553 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
2554
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2555 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
2556 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
2557
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2558 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
2559 in BODY."
51051
b39d8ed2d159 (with-selected-window): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 50694
diff changeset
2560 (declare (indent 0) (debug t))
16549
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2561 `(unwind-protect
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2562 (let ((combine-after-change-calls t))
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2563 . ,body)
30ddd0e52ace (combine-after-change-calls): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16437
diff changeset
2564 (combine-after-change-execute)))
76939
1b8e8619079e * subr.el (with-case-table): New macro.
Chong Yidong <cyd@stupidchicken.com>
parents: 76583
diff changeset
2565
1b8e8619079e * subr.el (with-case-table): New macro.
Chong Yidong <cyd@stupidchicken.com>
parents: 76583
diff changeset
2566 (defmacro with-case-table (table &rest body)
1b8e8619079e * subr.el (with-case-table): New macro.
Chong Yidong <cyd@stupidchicken.com>
parents: 76583
diff changeset
2567 "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
2568 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
2569 (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
2570 (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
2571 (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
2572 `(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
2573 (,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
2574 (unwind-protect
85841d693997 (with-case-table): Use `make-symbol' to avoid variable capture.
John Paul Wallington <jpw@pobox.com>
parents: 76939
diff changeset
2575 (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
2576 ,@body)
85841d693997 (with-case-table): Use `make-symbol' to avoid variable capture.
John Paul Wallington <jpw@pobox.com>
parents: 76939
diff changeset
2577 (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
2578 (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
2579
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2580 ;;;; Constructing completion tables.
51695
3e0f0ad2d93d (lazy-completion-table, dynamic-completion-table): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 51611
diff changeset
2581
81803
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2582 (defun complete-with-action (action table string pred)
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2583 "Perform completion ACTION.
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2584 STRING is the string to complete.
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2585 TABLE is the completion table, which should not be a function.
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2586 PRED is a completion predicate.
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2587 ACTION can be one of nil, t or `lambda'."
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2588 ;; (assert (not (functionp table)))
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2589 (funcall
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2590 (cond
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2591 ((null action) 'try-completion)
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2592 ((eq action t) 'all-completions)
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2593 (t 'test-completion))
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2594 string table pred))
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2595
51695
3e0f0ad2d93d (lazy-completion-table, dynamic-completion-table): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 51611
diff changeset
2596 (defmacro dynamic-completion-table (fun)
3e0f0ad2d93d (lazy-completion-table, dynamic-completion-table): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 51611
diff changeset
2597 "Use function FUN as a dynamic completion table.
3e0f0ad2d93d (lazy-completion-table, dynamic-completion-table): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 51611
diff changeset
2598 FUN is called with one argument, the string for which completion is required,
3e0f0ad2d93d (lazy-completion-table, dynamic-completion-table): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 51611
diff changeset
2599 and it should return an alist containing all the intended possible
51980
b7fa62a1a49d (with-selected-window): Copy code form save-selected-window
Richard M. Stallman <rms@gnu.org>
parents: 51817
diff changeset
2600 completions. This alist may be a full list of possible completions so that FUN
b7fa62a1a49d (with-selected-window): Copy code form save-selected-window
Richard M. Stallman <rms@gnu.org>
parents: 51817
diff changeset
2601 can ignore the value of its argument. If completion is performed in the
51695
3e0f0ad2d93d (lazy-completion-table, dynamic-completion-table): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 51611
diff changeset
2602 minibuffer, FUN will be called in the buffer from which the minibuffer was
51980
b7fa62a1a49d (with-selected-window): Copy code form save-selected-window
Richard M. Stallman <rms@gnu.org>
parents: 51817
diff changeset
2603 entered.
b7fa62a1a49d (with-selected-window): Copy code form save-selected-window
Richard M. Stallman <rms@gnu.org>
parents: 51817
diff changeset
2604
b7fa62a1a49d (with-selected-window): Copy code form save-selected-window
Richard M. Stallman <rms@gnu.org>
parents: 51817
diff changeset
2605 The result of the `dynamic-completion-table' form is a function
b7fa62a1a49d (with-selected-window): Copy code form save-selected-window
Richard M. Stallman <rms@gnu.org>
parents: 51817
diff changeset
2606 that can be used as the ALIST argument to `try-completion' and
b7fa62a1a49d (with-selected-window): Copy code form save-selected-window
Richard M. Stallman <rms@gnu.org>
parents: 51817
diff changeset
2607 `all-completion'. See Info node `(elisp)Programmed Completion'."
63381
23b1ef64a00e (complete-in-turn): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63258
diff changeset
2608 (declare (debug (lambda-expr)))
51695
3e0f0ad2d93d (lazy-completion-table, dynamic-completion-table): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 51611
diff changeset
2609 (let ((win (make-symbol "window"))
3e0f0ad2d93d (lazy-completion-table, dynamic-completion-table): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 51611
diff changeset
2610 (string (make-symbol "string"))
3e0f0ad2d93d (lazy-completion-table, dynamic-completion-table): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 51611
diff changeset
2611 (predicate (make-symbol "predicate"))
3e0f0ad2d93d (lazy-completion-table, dynamic-completion-table): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 51611
diff changeset
2612 (mode (make-symbol "mode")))
3e0f0ad2d93d (lazy-completion-table, dynamic-completion-table): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 51611
diff changeset
2613 `(lambda (,string ,predicate ,mode)
3e0f0ad2d93d (lazy-completion-table, dynamic-completion-table): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 51611
diff changeset
2614 (with-current-buffer (let ((,win (minibuffer-selected-window)))
3e0f0ad2d93d (lazy-completion-table, dynamic-completion-table): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 51611
diff changeset
2615 (if (window-live-p ,win) (window-buffer ,win)
3e0f0ad2d93d (lazy-completion-table, dynamic-completion-table): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 51611
diff changeset
2616 (current-buffer)))
81803
f7d2bfbd3abc *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 81783
diff changeset
2617 (complete-with-action ,mode (,fun ,string) ,string ,predicate)))))
51695
3e0f0ad2d93d (lazy-completion-table, dynamic-completion-table): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 51611
diff changeset
2618
67818
5a83c9ee8aa6 (lazy-completion-table): Remove argument `args'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 67651
diff changeset
2619 (defmacro lazy-completion-table (var fun)
5a83c9ee8aa6 (lazy-completion-table): Remove argument `args'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 67651
diff changeset
2620 ;; We used to have `&rest args' where `args' were evaluated late (at the
5a83c9ee8aa6 (lazy-completion-table): Remove argument `args'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 67651
diff changeset
2621 ;; time of the call to `fun'), which was counter intuitive. But to get
5a83c9ee8aa6 (lazy-completion-table): Remove argument `args'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 67651
diff changeset
2622 ;; them to be evaluated early, we have to either use lexical-let (which is
5a83c9ee8aa6 (lazy-completion-table): Remove argument `args'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 67651
diff changeset
2623 ;; not available in subr.el) or use `(lambda (,str) ...) which prevents the use
5a83c9ee8aa6 (lazy-completion-table): Remove argument `args'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 67651
diff changeset
2624 ;; of lexical-let in the callers.
5a83c9ee8aa6 (lazy-completion-table): Remove argument `args'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 67651
diff changeset
2625 ;; So we just removed the argument. Callers can then simply use either of:
5a83c9ee8aa6 (lazy-completion-table): Remove argument `args'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 67651
diff changeset
2626 ;; (lazy-completion-table var (lambda () (fun x y)))
5a83c9ee8aa6 (lazy-completion-table): Remove argument `args'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 67651
diff changeset
2627 ;; or
5a83c9ee8aa6 (lazy-completion-table): Remove argument `args'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 67651
diff changeset
2628 ;; (lazy-completion-table var `(lambda () (fun ',x ',y)))
5a83c9ee8aa6 (lazy-completion-table): Remove argument `args'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 67651
diff changeset
2629 ;; or
5a83c9ee8aa6 (lazy-completion-table): Remove argument `args'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 67651
diff changeset
2630 ;; (lexical-let ((x x)) ((y y))
5a83c9ee8aa6 (lazy-completion-table): Remove argument `args'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 67651
diff changeset
2631 ;; (lazy-completion-table var (lambda () (fun x y))))
5a83c9ee8aa6 (lazy-completion-table): Remove argument `args'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 67651
diff changeset
2632 ;; depending on the behavior they want.
51695
3e0f0ad2d93d (lazy-completion-table, dynamic-completion-table): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 51611
diff changeset
2633 "Initialize variable VAR as a lazy completion table.
67876
d3f449ec33bd (lazy-completion-table): Correct typo in docstring.
Luc Teirlinck <teirllm@auburn.edu>
parents: 67818
diff changeset
2634 If the completion table VAR is used for the first time (e.g., by passing VAR
67818
5a83c9ee8aa6 (lazy-completion-table): Remove argument `args'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 67651
diff changeset
2635 as an argument to `try-completion'), the function FUN is called with no
5a83c9ee8aa6 (lazy-completion-table): Remove argument `args'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 67651
diff changeset
2636 arguments. FUN must return the completion table that will be stored in VAR.
51980
b7fa62a1a49d (with-selected-window): Copy code form save-selected-window
Richard M. Stallman <rms@gnu.org>
parents: 51817
diff changeset
2637 If completion is requested in the minibuffer, FUN will be called in the buffer
b7fa62a1a49d (with-selected-window): Copy code form save-selected-window
Richard M. Stallman <rms@gnu.org>
parents: 51817
diff changeset
2638 from which the minibuffer was entered. The return value of
68400
d2b4af1c4fef (lazy-completion-table): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 67917
diff changeset
2639 `lazy-completion-table' must be used to initialize the value of VAR.
d2b4af1c4fef (lazy-completion-table): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 67917
diff changeset
2640
d2b4af1c4fef (lazy-completion-table): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 67917
diff changeset
2641 You should give VAR a non-nil `risky-local-variable' property."
67818
5a83c9ee8aa6 (lazy-completion-table): Remove argument `args'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 67651
diff changeset
2642 (declare (debug (symbol lambda-expr)))
51695
3e0f0ad2d93d (lazy-completion-table, dynamic-completion-table): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 51611
diff changeset
2643 (let ((str (make-symbol "string")))
3e0f0ad2d93d (lazy-completion-table, dynamic-completion-table): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 51611
diff changeset
2644 `(dynamic-completion-table
3e0f0ad2d93d (lazy-completion-table, dynamic-completion-table): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 51611
diff changeset
2645 (lambda (,str)
67651
915b73d58795 (lazy-completion-table): Don't be fooled if the var holds
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 67541
diff changeset
2646 (when (functionp ,var)
67818
5a83c9ee8aa6 (lazy-completion-table): Remove argument `args'.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 67651
diff changeset
2647 (setq ,var (,fun)))
51695
3e0f0ad2d93d (lazy-completion-table, dynamic-completion-table): New macros.
Richard M. Stallman <rms@gnu.org>
parents: 51611
diff changeset
2648 ,var))))
63381
23b1ef64a00e (complete-in-turn): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63258
diff changeset
2649
23b1ef64a00e (complete-in-turn): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63258
diff changeset
2650 (defmacro complete-in-turn (a b)
23b1ef64a00e (complete-in-turn): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63258
diff changeset
2651 "Create a completion table that first tries completion in A and then in B.
23b1ef64a00e (complete-in-turn): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63258
diff changeset
2652 A and B should not be costly (or side-effecting) expressions."
23b1ef64a00e (complete-in-turn): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63258
diff changeset
2653 (declare (debug (def-form def-form)))
23b1ef64a00e (complete-in-turn): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63258
diff changeset
2654 `(lambda (string predicate mode)
23b1ef64a00e (complete-in-turn): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63258
diff changeset
2655 (cond
23b1ef64a00e (complete-in-turn): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63258
diff changeset
2656 ((eq mode t)
23b1ef64a00e (complete-in-turn): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63258
diff changeset
2657 (or (all-completions string ,a predicate)
23b1ef64a00e (complete-in-turn): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63258
diff changeset
2658 (all-completions string ,b predicate)))
23b1ef64a00e (complete-in-turn): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63258
diff changeset
2659 ((eq mode nil)
23b1ef64a00e (complete-in-turn): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63258
diff changeset
2660 (or (try-completion string ,a predicate)
23b1ef64a00e (complete-in-turn): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63258
diff changeset
2661 (try-completion string ,b predicate)))
23b1ef64a00e (complete-in-turn): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63258
diff changeset
2662 (t
23b1ef64a00e (complete-in-turn): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63258
diff changeset
2663 (or (test-completion string ,a predicate)
23b1ef64a00e (complete-in-turn): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 63258
diff changeset
2664 (test-completion string ,b predicate))))))
16379
dcc3625f52e2 (with-current-buffer): Minor cleanup.
Erik Naggum <erik@naggum.no>
parents: 16359
diff changeset
2665
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2666 ;;; Matching and match data.
44668
52222efc9d4d (insert-for-yank): New function.
Richard M. Stallman <rms@gnu.org>
parents: 44473
diff changeset
2667
15955
32d772cba2c1 (save-match-data): Use save-match-data-internal
Richard M. Stallman <rms@gnu.org>
parents: 15894
diff changeset
2668 (defvar save-match-data-internal)
32d772cba2c1 (save-match-data): Use save-match-data-internal
Richard M. Stallman <rms@gnu.org>
parents: 15894
diff changeset
2669
32d772cba2c1 (save-match-data): Use save-match-data-internal
Richard M. Stallman <rms@gnu.org>
parents: 15894
diff changeset
2670 ;; 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
2671 ;; 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
2672 ;; 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
2673 ;; 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
2674 (defmacro save-match-data (&rest body)
43527
d51d403fd80a (save-match-data): Doc fix.
Juanma Barranquero <lekktu@gmail.com>
parents: 43498
diff changeset
2675 "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
2676 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
2677 ;; It is better not to use backquote here,
804cba424b64 Fix bootstrapping problems.
Paul Eggert <eggert@twinsun.com>
parents: 26002
diff changeset
2678 ;; because that makes a bootstrapping problem
804cba424b64 Fix bootstrapping problems.
Paul Eggert <eggert@twinsun.com>
parents: 26002
diff changeset
2679 ;; 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
2680 (declare (indent 0) (debug t))
26084
804cba424b64 Fix bootstrapping problems.
Paul Eggert <eggert@twinsun.com>
parents: 26002
diff changeset
2681 (list 'let
804cba424b64 Fix bootstrapping problems.
Paul Eggert <eggert@twinsun.com>
parents: 26002
diff changeset
2682 '((save-match-data-internal (match-data)))
804cba424b64 Fix bootstrapping problems.
Paul Eggert <eggert@twinsun.com>
parents: 26002
diff changeset
2683 (list 'unwind-protect
804cba424b64 Fix bootstrapping problems.
Paul Eggert <eggert@twinsun.com>
parents: 26002
diff changeset
2684 (cons 'progn body)
63664
f29e9a430d73 (save-match-data): Add comment about using evaporate arg
Kim F. Storm <storm@cua.dk>
parents: 63634
diff changeset
2685 ;; 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
2686 ;; 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
2687 '(set-match-data save-match-data-internal 'evaporate))))
144
535ec1aa78ef *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 114
diff changeset
2688
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
2689 (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
2690 "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
2691 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
2692 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
2693 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
2694 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
2695 (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
2696 (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
2697 (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
2698 (buffer-substring (match-beginning num) (match-end num)))))
10560
fd09d51dfd77 (match-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 10368
diff changeset
2699
20491
d884af34ba47 (match-string-no-properties): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20476
diff changeset
2700 (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
2701 "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
2702 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
2703 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
2704 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
2705 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
2706 (if (match-beginning num)
d884af34ba47 (match-string-no-properties): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20476
diff changeset
2707 (if string
53994
342806d7b32b (match-string-no-properties): Use substring-no-properties.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53626
diff changeset
2708 (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
2709 (match-end num))
20491
d884af34ba47 (match-string-no-properties): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20476
diff changeset
2710 (buffer-substring-no-properties (match-beginning num)
d884af34ba47 (match-string-no-properties): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20476
diff changeset
2711 (match-end num)))))
d884af34ba47 (match-string-no-properties): New function.
Richard M. Stallman <rms@gnu.org>
parents: 20476
diff changeset
2712
62861
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2713 (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
2714 "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
2715 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
2716 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
2717 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
2718 before LIMIT.
62861
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2719
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2720 If GREEDY is non-nil, extend the match backwards as far as possible,
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2721 stopping when a single additional previous character cannot be part
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2722 of a match for REGEXP."
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2723 (let ((start (point))
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2724 (pos
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2725 (save-excursion
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2726 (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t)
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2727 (point)))))
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2728 (if (and greedy pos)
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2729 (save-restriction
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2730 (narrow-to-region (point-min) start)
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2731 (while (and (> pos (point-min))
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2732 (save-excursion
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2733 (goto-char pos)
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2734 (backward-char 1)
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2735 (looking-at (concat "\\(?:" regexp "\\)\\'"))))
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2736 (setq pos (1- pos)))
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2737 (save-excursion
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2738 (goto-char pos)
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2739 (looking-at (concat "\\(?:" regexp "\\)\\'")))))
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2740 (not (null pos))))
0d5825b4e125 (looking-back): New argument GREEDY.
Richard M. Stallman <rms@gnu.org>
parents: 62710
diff changeset
2741
81783
f1d802f34413 (looking-at-p, string-match-p): New functions.
Richard M. Stallman <rms@gnu.org>
parents: 81765
diff changeset
2742 (defsubst looking-at-p (regexp)
f1d802f34413 (looking-at-p, string-match-p): New functions.
Richard M. Stallman <rms@gnu.org>
parents: 81765
diff changeset
2743 "\
f1d802f34413 (looking-at-p, string-match-p): New functions.
Richard M. Stallman <rms@gnu.org>
parents: 81765
diff changeset
2744 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
2745 (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
2746 (looking-at regexp)))
f1d802f34413 (looking-at-p, string-match-p): New functions.
Richard M. Stallman <rms@gnu.org>
parents: 81765
diff changeset
2747
f1d802f34413 (looking-at-p, string-match-p): New functions.
Richard M. Stallman <rms@gnu.org>
parents: 81765
diff changeset
2748 (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
2749 "\
f1d802f34413 (looking-at-p, string-match-p): New functions.
Richard M. Stallman <rms@gnu.org>
parents: 81765
diff changeset
2750 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
2751 (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
2752 (string-match regexp string start)))
f1d802f34413 (looking-at-p, string-match-p): New functions.
Richard M. Stallman <rms@gnu.org>
parents: 81765
diff changeset
2753
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2754 (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
2755 "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
2756 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
2757 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
2758 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
2759 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
2760 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
2761 ;; 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
2762 ;; 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
2763 ;; 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
2764 ;; error string.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2765 (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
2766 (progn
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2767 (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
2768 t)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2769 (invalid-regexp
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2770 (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
2771 "Unmatched \\{"
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2772 "Trailing backslash")))))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2773 ;; 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
2774 ;; (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
2775 ;; (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
2776 ;; (harmless-esc "\\\\[^{]")
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2777 ;; (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
2778 ;; (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
2779 ;; (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
2780 ;; (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
2781 ;; "\\|" 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
2782 ;; (class
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2783 ;; (concat "\\[^?]?"
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2784 ;; "\\(" 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
2785 ;; "\\|" class-lb "\\)*"
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2786 ;; "\\[?]")) ; 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
2787 ;; (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
2788 ;; (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
2789 ;; "\\|" class "\\|" braces "\\)*\\'"))
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2790 ;; "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
2791 ;; (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
2792 )
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2793
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2794 ;;;; split-string
51339
14976a545668 (looking-back): New function to check for regular expression before point.
Juanma Barranquero <lekktu@gmail.com>
parents: 51148
diff changeset
2795
51148
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
2796 (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
2797 "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
2798
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
2799 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
2800 \(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
2801
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
2802 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
2803 likely to have undesired semantics.")
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
2804
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
2805 ;; 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
2806 ;; 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
2807 ;; 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
2808 ;; 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
2809 (defun split-string (string &optional separators omit-nulls)
57006
a806a6bbc178 (split-string): Docfix.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 56826
diff changeset
2810 "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
2811
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
2812 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
2813 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
2814 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
2815 which is returned.
51148
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
2816
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
2817 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
2818 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
2819 `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
2820 OMIT-NULLS is forced to t.
20476
f213a5906ea6 (split-string): Handle empty matches reasonably.
Richard M. Stallman <rms@gnu.org>
parents: 20472
diff changeset
2821
55406
3b27c2f86c7a (lambda): Add arglist description to docstring.
Juanma Barranquero <lekktu@gmail.com>
parents: 55232
diff changeset
2822 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
2823 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
2824 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
2825 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
2826
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
2827 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
2828 `(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
2829 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
2830 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
2831
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
2832 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
2833 (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
2834 (rexp (or separators split-string-default-separators))
16314
c72b7ee606a3 (split-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16311
diff changeset
2835 (start 0)
20476
f213a5906ea6 (split-string): Handle empty matches reasonably.
Richard M. Stallman <rms@gnu.org>
parents: 20472
diff changeset
2836 notfirst
16314
c72b7ee606a3 (split-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16311
diff changeset
2837 (list nil))
20476
f213a5906ea6 (split-string): Handle empty matches reasonably.
Richard M. Stallman <rms@gnu.org>
parents: 20472
diff changeset
2838 (while (and (string-match rexp string
f213a5906ea6 (split-string): Handle empty matches reasonably.
Richard M. Stallman <rms@gnu.org>
parents: 20472
diff changeset
2839 (if (and notfirst
f213a5906ea6 (split-string): Handle empty matches reasonably.
Richard M. Stallman <rms@gnu.org>
parents: 20472
diff changeset
2840 (= start (match-beginning 0))
f213a5906ea6 (split-string): Handle empty matches reasonably.
Richard M. Stallman <rms@gnu.org>
parents: 20472
diff changeset
2841 (< start (length string)))
f213a5906ea6 (split-string): Handle empty matches reasonably.
Richard M. Stallman <rms@gnu.org>
parents: 20472
diff changeset
2842 (1+ start) start))
51148
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
2843 (< start (length string)))
20476
f213a5906ea6 (split-string): Handle empty matches reasonably.
Richard M. Stallman <rms@gnu.org>
parents: 20472
diff changeset
2844 (setq notfirst t)
51148
f59aeee43725 (split-string): Implement specification that splitting on explicit separators
Juanma Barranquero <lekktu@gmail.com>
parents: 51068
diff changeset
2845 (if (or keep-nulls (< start (match-beginning 0)))
16314
c72b7ee606a3 (split-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16311
diff changeset
2846 (setq list
c72b7ee606a3 (split-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16311
diff changeset
2847 (cons (substring string start (match-beginning 0))
c72b7ee606a3 (split-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16311
diff changeset
2848 list)))
c72b7ee606a3 (split-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16311
diff changeset
2849 (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
2850 (if (or keep-nulls (< start (length string)))
16314
c72b7ee606a3 (split-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16311
diff changeset
2851 (setq list
c72b7ee606a3 (split-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16311
diff changeset
2852 (cons (substring string start)
c72b7ee606a3 (split-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16311
diff changeset
2853 list)))
c72b7ee606a3 (split-string): New function.
Richard M. Stallman <rms@gnu.org>
parents: 16311
diff changeset
2854 (nreverse list)))
78081
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
2855
78530
1532be3afc8a (combine-and-quote-strings): Renamed from strings->string.
Richard M. Stallman <rms@gnu.org>
parents: 78236
diff changeset
2856 (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
2857 "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
2858 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
2859 (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
2860 Only some SEPARATORs will work properly."
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
2861 (let ((sep (or separator " ")))
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
2862 (mapconcat
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
2863 (lambda (str)
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
2864 (if (string-match "[\\\"]" str)
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
2865 (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
2866 str))
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
2867 strings sep)))
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
2868
78530
1532be3afc8a (combine-and-quote-strings): Renamed from strings->string.
Richard M. Stallman <rms@gnu.org>
parents: 78236
diff changeset
2869 (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
2870 "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
2871 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
2872 (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
2873 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
2874 (let ((sep (or separator "\\s-+"))
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
2875 (i (string-match "[\"]" string)))
78530
1532be3afc8a (combine-and-quote-strings): Renamed from strings->string.
Richard M. Stallman <rms@gnu.org>
parents: 78236
diff changeset
2876 (if (null i)
1532be3afc8a (combine-and-quote-strings): Renamed from strings->string.
Richard M. Stallman <rms@gnu.org>
parents: 78236
diff changeset
2877 (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
2878 (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
2879 (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
2880 (cons (car rfs)
78530
1532be3afc8a (combine-and-quote-strings): Renamed from strings->string.
Richard M. Stallman <rms@gnu.org>
parents: 78236
diff changeset
2881 (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
2882 sep)))))))
78081
d53cb34bfd32 * pcvs-util.el (cvs-strings->string, cvs-string->strings):
Nick Roberts <nickrob@snap.net.nz>
parents: 77423
diff changeset
2883
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2884
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2885 ;;;; Replacement in strings.
24089
70954a8be49b (subst-char-in-string): New function.
Andrew Innes <andrewi@gnu.org>
parents: 24011
diff changeset
2886
70954a8be49b (subst-char-in-string): New function.
Andrew Innes <andrewi@gnu.org>
parents: 24011
diff changeset
2887 (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
2888 "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
2889 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
2890 (let ((i (length string))
1b1555d26963 Undoing the changes erroneously committed just before.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 33833
diff changeset
2891 (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
2892 (while (> i 0)
1b1555d26963 Undoing the changes erroneously committed just before.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 33833
diff changeset
2893 (setq i (1- i))
1b1555d26963 Undoing the changes erroneously committed just before.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 33833
diff changeset
2894 (if (eq (aref newstr i) fromchar)
1b1555d26963 Undoing the changes erroneously committed just before.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 33833
diff changeset
2895 (aset newstr i tochar)))
1b1555d26963 Undoing the changes erroneously committed just before.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 33833
diff changeset
2896 newstr))
27810
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
2897
28148
0f14966fe791 (replace-regexp-in-string): Renamed from
Dave Love <fx@gnu.org>
parents: 28065
diff changeset
2898 (defun replace-regexp-in-string (regexp rep string &optional
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
2899 fixedcase literal subexp start)
27810
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
2900 "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
2901
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
2902 Return a new string containing the replacements.
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
2903
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
2904 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
2905 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
2906 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
2907
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
2908 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
2909 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
2910 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
2911 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
2912 of STRING.
27810
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
2913
28148
0f14966fe791 (replace-regexp-in-string): Renamed from
Dave Love <fx@gnu.org>
parents: 28065
diff changeset
2914 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
2915 and replace a sub-expression, e.g.
48077
69077a78e52f (replace-regexp-in-string): Doc fix.
Andreas Schwab <schwab@suse.de>
parents: 47916
diff changeset
2916 (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
2917 => \" bar foo\"
0f14966fe791 (replace-regexp-in-string): Renamed from
Dave Love <fx@gnu.org>
parents: 28065
diff changeset
2918 "
27810
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
2919
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
2920 ;; 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
2921 ;; 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
2922 ;; 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
2923 ;; 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
2924 ;; 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
2925 ;; [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
2926 ;; 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
2927 ;; 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
2928 ;; 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
2929 (let ((l (length string))
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
2930 (start (or start 0))
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
2931 matches str mb me)
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
2932 (save-match-data
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
2933 (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
2934 (setq mb (match-beginning 0)
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
2935 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
2936 ;; 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
2937 (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
2938 ;; 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
2939 ;; 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
2940 ;; 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
2941 ;; 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
2942 ;; 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
2943 (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
2944 (setq matches
093dcd5f39b2 (replace-regexps-in-string): Properly handle the case where
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 27908
diff changeset
2945 (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
2946 rep
093dcd5f39b2 (replace-regexps-in-string): Properly handle the case where
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 27908
diff changeset
2947 (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
2948 fixedcase literal str subexp)
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
2949 (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
2950 matches)))
093dcd5f39b2 (replace-regexps-in-string): Properly handle the case where
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 27908
diff changeset
2951 (setq start me))
27810
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
2952 ;; Reconstruct a string from the pieces.
1d7650c95e0a (when, unless, split-string): Doc fix.
Dave Love <fx@gnu.org>
parents: 27482
diff changeset
2953 (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
2954 (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
2955
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2956 ;;;; invisibility specs
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2957
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2958 (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
2959 "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
2960 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
2961 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
2962 (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
2963 (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
2964 (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
2965 (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
2966
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2967 (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
2968 "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
2969 (if (consp buffer-invisibility-spec)
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
2970 (setq buffer-invisibility-spec
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
2971 (delete element buffer-invisibility-spec))))
16359
18cc78dc8b18 (with-temp-file): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 16333
diff changeset
2972
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2973 ;;;; Syntax tables.
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2974
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2975 (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
2976 "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
2977 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
2978 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
2979 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
2980 (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
2981 (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
2982 (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
2983 `(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
2984 (,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
2985 (unwind-protect
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2986 (progn
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2987 (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
2988 ,@body)
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
2989 (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
2990 (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
2991 (set-syntax-table ,old-table))))))
5385
53077bf7c718 (shell-quote-argument): New function.
Richard M. Stallman <rms@gnu.org>
parents: 5302
diff changeset
2992
5844
445de172c217 (make-syntax-table): Behave like copy-syntax-table if an argument is given,
Karl Heuer <kwzh@gnu.org>
parents: 5460
diff changeset
2993 (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
2994 "Return a new syntax table.
40822
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
2995 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
2996 from `standard-syntax-table' otherwise."
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
2997 (let ((table (make-char-table 'syntax-table nil)))
b10e7d6fb95b (with-local-quit): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 40282
diff changeset
2998 (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
2999 table))
17146
b8536e42d4ef (combine-after-change-calls): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 16845
diff changeset
3000
47355
9e3ee43b5262 (symbol-file): Also work for autoloaded funcs.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47305
diff changeset
3001 (defun syntax-after (pos)
61798
994a6fb78d4c (syntax-after): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 61716
diff changeset
3002 "Return the raw syntax of the char after POS.
994a6fb78d4c (syntax-after): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 61716
diff changeset
3003 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
3004 (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
3005 (let ((st (if parse-sexp-lookup-properties
28906724d6e3 (syntax-after): Undo last change.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 58272
diff changeset
3006 (get-char-property pos 'syntax-table))))
28906724d6e3 (syntax-after): Undo last change.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 58272
diff changeset
3007 (if (consp st) st
28906724d6e3 (syntax-after): Undo last change.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 58272
diff changeset
3008 (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
3009
61669
c95f35bea727 (syntax-class): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 60764
diff changeset
3010 (defun syntax-class (syntax)
61798
994a6fb78d4c (syntax-after): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 61716
diff changeset
3011 "Return the syntax class part of the syntax descriptor SYNTAX.
994a6fb78d4c (syntax-after): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 61716
diff changeset
3012 If SYNTAX is nil, return nil."
994a6fb78d4c (syntax-after): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 61716
diff changeset
3013 (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
3014
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3015 ;;;; 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
3016
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3017 (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
3018 "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
3019 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
3020 (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
3021 (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
3022 (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
3023 (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
3024 (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
3025 (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
3026 (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
3027 ;; 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
3028 (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
3029 (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
3030 (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
3031 (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
3032 (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
3033 (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
3034 ;; 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
3035 (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
3036 (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
3037 ;; 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
3038 (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
3039 (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
3040 (+ (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
3041 (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
3042 ;; 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
3043 (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
3044 (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
3045 (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
3046 ;; 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
3047 (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
3048 (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
3049 (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
3050 (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
3051 (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
3052 (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
3053 (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
3054 (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
3055 (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
3056 (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
3057 ;;(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
3058 (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
3059 (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
3060 (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
3061 (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
3062 ;;(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
3063 ))))
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3064 (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
3065
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3066 (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
3067 "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
3068 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
3069 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
3070
7f05eff77ea2 (delay-mode-hooks, delayed-mode-hooks, run-mode-hooks): New vars and functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 39725
diff changeset
3071 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
3072 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
3073 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
3074 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
3075 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
3076 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
3077 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
3078 ;; 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
3079 ;; 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
3080 ;; (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
3081 ;; 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
3082 ;; 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
3083 ;; 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
3084 ;; `evaporate' to make sure those overlays get deleted when needed).
47916
0bb8dc016c43 (remq): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 47747
diff changeset
3085 ;;
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
3086 (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
3087 (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
3088 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
3089 (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
3090 (>= 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
3091 (>= 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
3092 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
3093 (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
3094 (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
3095 (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
3096 (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
3097 (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
3098 (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
3099 ;;(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
3100 (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
3101 (overlay-put ol1 'text-clones dups)
47916
0bb8dc016c43 (remq): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 47747
diff changeset
3102 ;;
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
3103 (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
3104 (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
3105 (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
3106 ;;(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
3107 (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
3108 (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
3109
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3110 ;;;; 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
3111
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3112 ;; 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
3113 ;; to define them.
44422
5f7f8b191a8c (play-sound): Move here from simple.el.
Pavel Janík <Pavel@Janik.cz>
parents: 44285
diff changeset
3114
47406
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3115 (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
3116 &optional abortfunc hookvar)
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3117 "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
3118
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3119 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
3120 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
3121 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
3122
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3123 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
3124 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
3125 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
3126 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
3127 by default.
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3128
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3129 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
3130 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
3131
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3132 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
3133
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3134 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
3135 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
3136 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
3137
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3138 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
3139 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
3140 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
3141 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
3142
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3143 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
3144 `abortfunc', and `hookvar'."
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3145 (put symbol 'composefunc composefunc)
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3146 (put symbol 'sendfunc sendfunc)
fbd7a9a8682c (define-mail-user-agent): Moved from simple.el.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47355
diff changeset
3147 (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
3148 (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
3149
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3150 ;;;; Progress reporters.
57384
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3151
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3152 ;; Progress reporter has the following structure:
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3153 ;;
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3154 ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3155 ;; MIN-VALUE
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3156 ;; MAX-VALUE
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3157 ;; MESSAGE
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3158 ;; MIN-CHANGE
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3159 ;; MIN-TIME])
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3160 ;;
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3161 ;; This weirdeness is for optimization reasons: we want
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3162 ;; `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
3163 ;; `(car reporter)' is better than `(aref reporter 0)'.
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3164 ;;
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3165 ;; 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
3166 ;; 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
3167 ;; hand, it greatly simplifies the code.
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3168
57408
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3169 (defsubst progress-reporter-update (reporter value)
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3170 "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
3171 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
3172 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
3173 `make-progress-reporter' for details).
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3174
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3175 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
3176 `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
3177 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
3178 as passed to `make-progress-reporter'.
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3179
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3180 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
3181 you call it."
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3182 (when (>= value (car reporter))
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3183 (progress-reporter-do-update reporter value)))
601c087f45f6 (progress-reporter-update): Define before first usage.
Kim F. Storm <storm@cua.dk>
parents: 57384
diff changeset
3184
57384
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3185 (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
3186 &optional current-value
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3187 min-change min-time)
59648
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3188 "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
3189
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3190 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
3191 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
3192 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
3193 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
3194 existing progress reporter with `progress-reporter-force-update'.
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3195
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3196 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
3197 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
3198 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
3199 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
3200 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
3201 cases since it defaults to MIN-VALUE.
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3202
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3203 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
3204 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
3205 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
3206 `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
3207 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
3208 then this parameter is effectively rounded up."
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3209
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3210 (unless min-time
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3211 (setq min-time 0.2))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3212 (let ((reporter
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3213 (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
3214 (vector (if (and (fboundp 'float-time)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3215 (>= min-time 0.02))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3216 (float-time) nil)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3217 min-value
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3218 max-value
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3219 message
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3220 (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
3221 min-time))))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3222 (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
3223 reporter))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3224
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3225 (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
3226 "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
3227
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3228 First two parameters are the same as for
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3229 `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
3230 change the displayed message."
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3231 (let ((parameters (cdr reporter)))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3232 (when new-message
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3233 (aset parameters 3 new-message))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3234 (when (aref parameters 0)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3235 (aset parameters 0 (float-time)))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3236 (progress-reporter-do-update reporter value)))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3237
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3238 (defun progress-reporter-do-update (reporter value)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3239 (let* ((parameters (cdr reporter))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3240 (min-value (aref parameters 1))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3241 (max-value (aref parameters 2))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3242 (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
3243 (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
3244 0
7fd2729eec90 (progress-reporter-do-update): When `min-value' is equal
Juri Linkov <juri@jurta.org>
parents: 60646
diff changeset
3245 (truncate (/ (- value min-value) one-percent))))
57384
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3246 (update-time (aref parameters 0))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3247 (current-time (float-time))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3248 (enough-time-passed
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3249 ;; 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
3250 (or (not update-time)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3251 (when (>= current-time update-time)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3252 ;; Calculate time for the next update
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3253 (aset parameters 0 (+ update-time (aref parameters 5)))))))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3254 ;;
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3255 ;; 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
3256 ;; 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
3257 ;; 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
3258 ;; updates closer to MIN-TIME.
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3259 (setcar reporter
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3260 (min (+ min-value (* (+ percentage
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3261 (if enough-time-passed
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3262 (aref parameters 4) ;; MIN-CHANGE
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3263 1))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3264 one-percent))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3265 max-value))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3266 (when (integerp value)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3267 (setcar reporter (ceiling (car reporter))))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3268 ;;
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3269 ;; Only print message if enough time has passed
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3270 (when enough-time-passed
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3271 (if (> percentage 0)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3272 (message "%s%d%%" (aref parameters 3) percentage)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3273 (message "%s" (aref parameters 3))))))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3274
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3275 (defun progress-reporter-done (reporter)
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3276 "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
3277 (message "%sdone" (aref (cdr reporter) 3)))
78290fa43da5 (make-progress-reporter, progress-reporter-update)
Eli Zaretskii <eliz@gnu.org>
parents: 57215
diff changeset
3278
59648
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3279 (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
3280 "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
3281 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
3282 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
3283 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
3284
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3285 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
3286 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
3287 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
3288 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
3289
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3290 \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)"
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3291 (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
3292 (let ((temp (make-symbol "--dotimes-temp--"))
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3293 (temp2 (make-symbol "--dotimes-temp2--"))
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3294 (start 0)
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3295 (end (nth 1 spec)))
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3296 `(let ((,temp ,end)
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3297 (,(car spec) ,start)
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3298 (,temp2 (make-progress-reporter ,message ,start ,end)))
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3299 (while (< ,(car spec) ,temp)
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3300 ,@body
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3301 (progress-reporter-update ,temp2
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3302 (setq ,(car spec) (1+ ,(car spec)))))
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3303 (progress-reporter-done ,temp2)
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3304 nil ,@(cdr (cdr spec)))))
65150
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3305
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3306
66304
f754be327a7e Much rearrangement of functions and division into pages. No code changes.
Richard M. Stallman <rms@gnu.org>
parents: 66286
diff changeset
3307 ;;;; Comparing version strings.
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3308
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3309 (defvar version-separator "."
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3310 "*Specify the string used to separate the version elements.
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3311
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3312 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
3313
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3314
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3315 (defvar version-regexp-alist
67541
f9d4913b40bc (version-regexp-alist): Allow space as separator before
Kim F. Storm <storm@cua.dk>
parents: 67274
diff changeset
3316 '(("^[-_+ ]?a\\(lpha\\)?$" . -3)
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
3317 ("^[-_+]$" . -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
3318 ("^[-_+ ]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
3319 ("^[-_+ ]?b\\(eta\\)?$" . -2)
f9d4913b40bc (version-regexp-alist): Allow space as separator before
Kim F. Storm <storm@cua.dk>
parents: 67274
diff changeset
3320 ("^[-_+ ]?\\(pre\\|rc\\)$" . -1))
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3321 "*Specify association between non-numeric version part and a priority.
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3322
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3323 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
3324 \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3325 non-numeric part to an integer. For example:
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3326
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3327 String Version Integer List Version
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3328 \"1.0pre2\" (1 0 -1 2)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3329 \"1.0PRE2\" (1 0 -1 2)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3330 \"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
3331 \"22.8 Beta3\" (22 8 -2 3)
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3332 \"0.9alpha1\" (0 9 -3 1)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3333 \"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
3334 \"0.9 alpha\" (0 9 -3)
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3335
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3336 Each element has the following form:
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3337
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3338 (REGEXP . PRIORITY)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3339
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3340 Where:
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3341
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3342 REGEXP regexp used to match non-numeric part of a version string.
65668
bbff73cbd15c (version-regexp-alist): Extend valid syntax for version strings:
Eli Zaretskii <eliz@gnu.org>
parents: 65150
diff changeset
3343 It should begin with a `^' anchor and end with a `$' to
bbff73cbd15c (version-regexp-alist): Extend valid syntax for version strings:
Eli Zaretskii <eliz@gnu.org>
parents: 65150
diff changeset
3344 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
3345 REGEXP.
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3346
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3347 PRIORITY negative integer which indicate the non-numeric priority.")
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3348
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3349
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3350 (defun version-to-list (ver)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3351 "Convert version string VER into an integer list.
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3352
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3353 The version syntax is given by the following EBNF:
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3354
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3355 VERSION ::= NUMBER ( SEPARATOR NUMBER )*.
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3356
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3357 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
3358
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3359 SEPARATOR ::= `version-separator' (which see)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3360 | `version-regexp-alist' (which see).
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3361
65668
bbff73cbd15c (version-regexp-alist): Extend valid syntax for version strings:
Eli Zaretskii <eliz@gnu.org>
parents: 65150
diff changeset
3362 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
3363 in `version-regexp-alist'.
bbff73cbd15c (version-regexp-alist): Extend valid syntax for version strings:
Eli Zaretskii <eliz@gnu.org>
parents: 65150
diff changeset
3364
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3365 As an example of valid version syntax:
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3366
65668
bbff73cbd15c (version-regexp-alist): Extend valid syntax for version strings:
Eli Zaretskii <eliz@gnu.org>
parents: 65150
diff changeset
3367 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
3368
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3369 As an example of invalid version syntax:
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3370
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3371 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
3372
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3373 As an example of version convertion:
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3374
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3375 String Version Integer List Version
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3376 \"1.0.7.5\" (1 0 7 5)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3377 \"1.0pre2\" (1 0 -1 2)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3378 \"1.0PRE2\" (1 0 -1 2)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3379 \"22.8beta3\" (22 8 -2 3)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3380 \"22.8Beta3\" (22 8 -2 3)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3381 \"0.9alpha1\" (0 9 -3 1)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3382 \"0.9AlphA1\" (0 9 -3 1)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3383 \"0.9alpha\" (0 9 -3)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3384
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3385 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
3386 (or (and (stringp ver) (> (length ver) 0))
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3387 (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
3388 ;; 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
3389 (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
3390 (string-equal (substring ver 0 (length version-separator))
77092
055a54275ec3 Fix indentation.
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 76960
diff changeset
3391 version-separator))
67541
f9d4913b40bc (version-regexp-alist): Allow space as separator before
Kim F. Storm <storm@cua.dk>
parents: 67274
diff changeset
3392 (setq ver (concat "0" ver)))
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3393 (save-match-data
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3394 (let ((i 0)
65668
bbff73cbd15c (version-regexp-alist): Extend valid syntax for version strings:
Eli Zaretskii <eliz@gnu.org>
parents: 65150
diff changeset
3395 (case-fold-search t) ; ignore case in matching
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3396 lst s al)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3397 (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
3398 (= s i))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3399 ;; handle numeric part
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3400 (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
3401 lst)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3402 i (match-end 0))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3403 ;; handle non-numeric part
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3404 (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
3405 (= s i))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3406 (setq s (substring ver i (match-end 0))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3407 i (match-end 0))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3408 ;; handle alpha, beta, pre, etc. separator
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3409 (unless (string= s version-separator)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3410 (setq al version-regexp-alist)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3411 (while (and al (not (string-match (caar al) s)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3412 (setq al (cdr al)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3413 (or al (error "Invalid version syntax: '%s'" ver))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3414 (setq lst (cons (cdar al) lst)))))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3415 (if (null lst)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3416 (error "Invalid version syntax: '%s'" ver)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3417 (nreverse lst)))))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3418
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3419
65150
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3420 (defun version-list-< (l1 l2)
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3421 "Return t if integer list L1 is lesser than L2.
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3422
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3423 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
3424 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
3425 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
3426 which is greater than (1 -3)."
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3427 (while (and l1 l2 (= (car l1) (car l2)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3428 (setq l1 (cdr l1)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3429 l2 (cdr l2)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3430 (cond
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3431 ;; l1 not null and l2 not null
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3432 ((and l1 l2) (< (car l1) (car l2)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3433 ;; l1 null and l2 null ==> l1 length = l2 length
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3434 ((and (null l1) (null l2)) nil)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3435 ;; 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
3436 (l1 (< (version-list-not-zero l1) 0))
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3437 ;; 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
3438 (t (< 0 (version-list-not-zero l2)))))
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3439
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3440
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3441 (defun version-list-= (l1 l2)
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3442 "Return t if integer list L1 is equal to L2.
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3443
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3444 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
3445 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
3446 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
3447 which is greater than (1 -3)."
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3448 (while (and l1 l2 (= (car l1) (car l2)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3449 (setq l1 (cdr l1)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3450 l2 (cdr l2)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3451 (cond
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3452 ;; l1 not null and l2 not null
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3453 ((and l1 l2) nil)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3454 ;; l1 null and l2 null ==> l1 length = l2 length
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3455 ((and (null l1) (null l2)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3456 ;; 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
3457 (l1 (zerop (version-list-not-zero l1)))
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3458 ;; 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
3459 (t (zerop (version-list-not-zero l2)))))
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3460
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3461
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3462 (defun version-list-<= (l1 l2)
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3463 "Return t if integer list L1 is lesser than or equal to L2.
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3464
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3465 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
3466 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
3467 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
3468 which is greater than (1 -3)."
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3469 (while (and l1 l2 (= (car l1) (car l2)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3470 (setq l1 (cdr l1)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3471 l2 (cdr l2)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3472 (cond
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3473 ;; l1 not null and l2 not null
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3474 ((and l1 l2) (< (car l1) (car l2)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3475 ;; l1 null and l2 null ==> l1 length = l2 length
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3476 ((and (null l1) (null l2)))
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3477 ;; 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
3478 (l1 (<= (version-list-not-zero l1) 0))
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3479 ;; 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
3480 (t (<= 0 (version-list-not-zero l2)))))
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3481
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3482 (defun version-list-not-zero (lst)
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3483 "Return the first non-zero element of integer list LST.
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3484
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3485 If all LST elements are zeroes or LST is nil, return zero."
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3486 (while (and lst (zerop (car lst)))
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3487 (setq lst (cdr lst)))
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3488 (if lst
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3489 (car lst)
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3490 ;; there is no element different of zero
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3491 0))
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3492
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3493
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3494 (defun version< (v1 v2)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3495 "Return t if version V1 is lesser than V2.
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3496
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3497 Note that version string \"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
3498 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3499 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3500 \"1alpha\"."
65150
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3501 (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
3502
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3503
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3504 (defun version<= (v1 v2)
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3505 "Return t if version V1 is lesser than or equal to V2.
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3506
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3507 Note that version string \"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
3508 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3509 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3510 \"1alpha\"."
65150
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3511 (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
3512
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3513 (defun version= (v1 v2)
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3514 "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
3515
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3516 Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\",
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3517 etc. That is, the trailing \".0\"s are irrelevant. Also, version string \"1\"
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3518 is greater than \"1pre\" which is greater than \"1beta\" which is greater than
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3519 \"1alpha\"."
6d566cf5ad51 (version-list-<, version-list-<=, version-list-=)
Kim F. Storm <storm@cua.dk>
parents: 65114
diff changeset
3520 (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
3521
65105
aad2616355a4 version string comparison
Vinicius Jose Latorre <viniciusjl@ig.com.br>
parents: 65058
diff changeset
3522
59648
3054e8b6e73e (dotimes-with-progress-reporter): New macro.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 59161
diff changeset
3523
57151
5350f17d0a78 (event-basic-type): Fix mask (extend to 22bits).
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57148
diff changeset
3524 ;; arch-tag: f7e0e6e5-70aa-4897-ae72-7a3511ec40bc
787
3cece0106722 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 779
diff changeset
3525 ;;; subr.el ends here