annotate lisp/subr.el @ 66628:7a2cc9f4b600

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