Mercurial > emacs
annotate lisp/button.el @ 107500:107889467c87
* Makefile.in (ELCFILES): Add cedet/semantic/imenu.el.
author | Glenn Morris <rgm@gnu.org> |
---|---|
date | Sat, 13 Mar 2010 11:57:29 -0800 |
parents | 1d1d5d9bd884 |
children | 280c8ae2476d 376148b31b5e |
rev | line source |
---|---|
42497 | 1 ;;; button.el --- clickable buttons |
39643 | 2 ;; |
68651
3bd95f4f2941
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
67836
diff
changeset
|
3 ;; Copyright (C) 2001, 2002, 2003, 2004, 2005, |
106815 | 4 ;; 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. |
39643 | 5 ;; |
6 ;; Author: Miles Bader <miles@gnu.org> | |
7 ;; Keywords: extensions | |
8 ;; | |
9 ;; This file is part of GNU Emacs. | |
10 ;; | |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
92948
diff
changeset
|
11 ;; GNU Emacs is free software: you can redistribute it and/or modify |
39643 | 12 ;; it under the terms of the GNU General Public License as published by |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
92948
diff
changeset
|
13 ;; the Free Software Foundation, either version 3 of the License, or |
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
92948
diff
changeset
|
14 ;; (at your option) any later version. |
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
92948
diff
changeset
|
15 |
39643 | 16 ;; GNU Emacs is distributed in the hope that it will be useful, |
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 ;; GNU General Public License for more details. | |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
92948
diff
changeset
|
20 |
39643 | 21 ;; You should have received a copy of the GNU General Public License |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
92948
diff
changeset
|
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
39643 | 23 |
24 ;;; Commentary: | |
25 ;; | |
26 ;; This package defines functions for inserting and manipulating | |
27 ;; clickable buttons in Emacs buffers, such as might be used for help | |
28 ;; hyperlinks, etc. | |
29 ;; | |
30 ;; In some ways it duplicates functionality also offered by the | |
31 ;; `widget' package, but the button package has the advantage that it | |
32 ;; is (1) much faster, (2) much smaller, and (3) much, much, simpler | |
33 ;; (the code, that is, not the interface). | |
34 ;; | |
35 ;; Buttons can either use overlays, in which case the button is | |
36 ;; represented by the overlay itself, or text-properties, in which case | |
37 ;; the button is represented by a marker or buffer-position pointing | |
38 ;; somewhere in the button. In the latter case, no markers into the | |
39 ;; buffer are retained, which is important for speed if there are are | |
40 ;; extremely large numbers of buttons. | |
41 ;; | |
42 ;; Using `define-button-type' to define default properties for buttons | |
43 ;; is not necessary, but it is is encouraged, since doing so makes the | |
44 ;; resulting code clearer and more efficient. | |
45 ;; | |
46 | |
47 ;;; Code: | |
48 | |
49 | |
50 ;; Globals | |
51 | |
60162
82eaf594d12a
(escape-glyph, minibuffer-prompt, button): Add commentary for
Eli Zaretskii <eliz@gnu.org>
parents:
57483
diff
changeset
|
52 ;; Use color for the MS-DOS port because it doesn't support underline. |
77498
9db4aaa87823
(button): Use underline if supported, else fall back to color.
Glenn Morris <rgm@gnu.org>
parents:
77437
diff
changeset
|
53 ;; FIXME if MS-DOS correctly answers the (supports) question, it need |
9db4aaa87823
(button): Use underline if supported, else fall back to color.
Glenn Morris <rgm@gnu.org>
parents:
77437
diff
changeset
|
54 ;; no longer be a special case. |
77437
fa273fd354c2
(button): Inherit from link face on a tty.
Nick Roberts <nickrob@snap.net.nz>
parents:
77431
diff
changeset
|
55 (defface button '((((type pc) (class color)) |
40337
57f029917c77
(button): Special face definition for MS-DOS terminals.
Eli Zaretskii <eliz@gnu.org>
parents:
39917
diff
changeset
|
56 (:foreground "lightblue")) |
77498
9db4aaa87823
(button): Use underline if supported, else fall back to color.
Glenn Morris <rgm@gnu.org>
parents:
77437
diff
changeset
|
57 (((supports :underline t)) :underline t) |
9db4aaa87823
(button): Use underline if supported, else fall back to color.
Glenn Morris <rgm@gnu.org>
parents:
77437
diff
changeset
|
58 (t (:foreground "lightblue"))) |
49001
85b083d06a17
(defface button): Add group.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
42497
diff
changeset
|
59 "Default face used for buttons." |
67836
68ab7e53d86a
(button): Put into group `basic-faces'.
Richard M. Stallman <rms@gnu.org>
parents:
67375
diff
changeset
|
60 :group 'basic-faces) |
39643 | 61 |
62 (defvar button-map | |
63 (let ((map (make-sparse-keymap))) | |
91704 | 64 ;; The following definition needs to avoid using escape sequences that |
65 ;; might get converted to ^M when building loaddefs.el | |
66 (define-key map [(control ?m)] 'push-button) | |
39643 | 67 (define-key map [mouse-2] 'push-button) |
68 map) | |
69 "Keymap used by buttons.") | |
70 | |
71 (defvar button-buffer-map | |
72 (let ((map (make-sparse-keymap))) | |
73 (define-key map [?\t] 'forward-button) | |
67375
77493abd2418
(button-buffer-map): Bind M-TAB to `backward-button'.
Juri Linkov <juri@jurta.org>
parents:
64762
diff
changeset
|
74 (define-key map "\e\t" 'backward-button) |
39643 | 75 (define-key map [backtab] 'backward-button) |
76 map) | |
77 "Keymap useful for buffers containing buttons. | |
78 Mode-specific keymaps may want to use this as their parent keymap.") | |
79 | |
80 ;; Default properties for buttons | |
81 (put 'default-button 'face 'button) | |
82 (put 'default-button 'mouse-face 'highlight) | |
83 (put 'default-button 'keymap button-map) | |
84 (put 'default-button 'type 'button) | |
57483
12ad045f7911
(button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
52401
diff
changeset
|
85 ;; action may be either a function to call, or a marker to go to |
39703
a093c43d935c
(button-nop): Function removed.
Miles Bader <miles@gnu.org>
parents:
39676
diff
changeset
|
86 (put 'default-button 'action 'ignore) |
105870
26baacb565b0
* textmodes/tex-mode.el (tex-alt-dvi-print-command)
Dan Nicolaescu <dann@ics.uci.edu>
parents:
100908
diff
changeset
|
87 (put 'default-button 'help-echo (purecopy "mouse-2, RET: Push this button")) |
39643 | 88 ;; Make overlay buttons go away if their underlying text is deleted. |
89 (put 'default-button 'evaporate t) | |
90 ;; Prevent insertions adjacent to the text-property buttons from | |
91 ;; inheriting its properties. | |
92 (put 'default-button 'rear-nonsticky t) | |
93 | |
39916 | 94 ;; A `category-symbol' property for the default button type |
95 (put 'button 'button-category-symbol 'default-button) | |
96 | |
39643 | 97 |
98 ;; Button types (which can be used to hold default properties for buttons) | |
99 | |
39716
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
100 ;; Because button-type properties are inherited by buttons using the |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
101 ;; special `category' property (implemented by both overlays and |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
102 ;; text-properties), we need to store them on a symbol to which the |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
103 ;; `category' properties can point. Instead of using the symbol that's |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
104 ;; the name of each button-type, however, we use a separate symbol (with |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
105 ;; `-button' appended, and uninterned) to store the properties. This is |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
106 ;; to avoid name clashes. |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
107 |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
108 ;; [this is an internal function] |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
109 (defsubst button-category-symbol (type) |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
110 "Return the symbol used by button-type TYPE to store properties. |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
111 Buttons inherit them by setting their `category' property to that symbol." |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
112 (or (get type 'button-category-symbol) |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
113 (error "Unknown button type `%s'" type))) |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
114 |
39643 | 115 (defun define-button-type (name &rest properties) |
88017
ad6ec43b41bc
(define-button-type): Clarify type of NAME in docstring.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
87649
diff
changeset
|
116 "Define a `button type' called NAME (a symbol). |
39643 | 117 The remaining arguments form a sequence of PROPERTY VALUE pairs, |
118 specifying properties to use as defaults for buttons with this type | |
119 \(a button's type may be set by giving it a `type' property when | |
39917 | 120 creating the button, using the :type keyword argument). |
39716
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
121 |
39917 | 122 In addition, the keyword argument :supertype may be used to specify a |
123 button-type from which NAME inherits its default property values | |
124 \(however, the inheritance happens only when NAME is defined; subsequent | |
125 changes to a supertype are not reflected in its subtypes)." | |
40595
3ba2b666d7e1
(define-button-type): Make sure every user-defined button type has a supertype.
Miles Bader <miles@gnu.org>
parents:
40337
diff
changeset
|
126 (let ((catsym (make-symbol (concat (symbol-name name) "-button"))) |
3ba2b666d7e1
(define-button-type): Make sure every user-defined button type has a supertype.
Miles Bader <miles@gnu.org>
parents:
40337
diff
changeset
|
127 (super-catsym |
3ba2b666d7e1
(define-button-type): Make sure every user-defined button type has a supertype.
Miles Bader <miles@gnu.org>
parents:
40337
diff
changeset
|
128 (button-category-symbol |
39916 | 129 (or (plist-get properties 'supertype) |
40595
3ba2b666d7e1
(define-button-type): Make sure every user-defined button type has a supertype.
Miles Bader <miles@gnu.org>
parents:
40337
diff
changeset
|
130 (plist-get properties :supertype) |
3ba2b666d7e1
(define-button-type): Make sure every user-defined button type has a supertype.
Miles Bader <miles@gnu.org>
parents:
40337
diff
changeset
|
131 'button)))) |
39643 | 132 ;; Provide a link so that it's easy to find the real symbol. |
133 (put name 'button-category-symbol catsym) | |
134 ;; Initialize NAME's properties using the global defaults. | |
39716
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
135 (let ((default-props (symbol-plist super-catsym))) |
39643 | 136 (while default-props |
137 (put catsym (pop default-props) (pop default-props)))) | |
138 ;; Add NAME as the `type' property, which will then be returned as | |
139 ;; the type property of individual buttons. | |
140 (put catsym 'type name) | |
141 ;; Add the properties in PROPERTIES to the real symbol. | |
142 (while properties | |
39916 | 143 (let ((prop (pop properties))) |
144 (when (eq prop :supertype) | |
145 (setq prop 'supertype)) | |
146 (put catsym prop (pop properties)))) | |
40595
3ba2b666d7e1
(define-button-type): Make sure every user-defined button type has a supertype.
Miles Bader <miles@gnu.org>
parents:
40337
diff
changeset
|
147 ;; Make sure there's a `supertype' property |
3ba2b666d7e1
(define-button-type): Make sure every user-defined button type has a supertype.
Miles Bader <miles@gnu.org>
parents:
40337
diff
changeset
|
148 (unless (get catsym 'supertype) |
3ba2b666d7e1
(define-button-type): Make sure every user-defined button type has a supertype.
Miles Bader <miles@gnu.org>
parents:
40337
diff
changeset
|
149 (put catsym 'supertype 'button)) |
39643 | 150 name)) |
151 | |
152 (defun button-type-put (type prop val) | |
153 "Set the button-type TYPE's PROP property to VAL." | |
154 (put (button-category-symbol type) prop val)) | |
155 | |
156 (defun button-type-get (type prop) | |
157 "Get the property of button-type TYPE named PROP." | |
158 (get (button-category-symbol type) prop)) | |
159 | |
39716
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
160 (defun button-type-subtype-p (type supertype) |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
161 "Return t if button-type TYPE is a subtype of SUPERTYPE." |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
162 (or (eq type supertype) |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
163 (and type |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
164 (button-type-subtype-p (button-type-get type 'supertype) |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
165 supertype)))) |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
166 |
39643 | 167 |
168 ;; Button properties and other attributes | |
169 | |
170 (defun button-start (button) | |
171 "Return the position at which BUTTON starts." | |
172 (if (overlayp button) | |
173 (overlay-start button) | |
174 ;; Must be a text-property button. | |
175 (or (previous-single-property-change (1+ button) 'button) | |
176 (point-min)))) | |
177 | |
178 (defun button-end (button) | |
179 "Return the position at which BUTTON ends." | |
180 (if (overlayp button) | |
181 (overlay-end button) | |
182 ;; Must be a text-property button. | |
183 (or (next-single-property-change button 'button) | |
184 (point-max)))) | |
185 | |
186 (defun button-get (button prop) | |
187 "Get the property of button BUTTON named PROP." | |
188 (if (overlayp button) | |
189 (overlay-get button prop) | |
190 ;; Must be a text-property button. | |
191 (get-text-property button prop))) | |
192 | |
193 (defun button-put (button prop val) | |
194 "Set BUTTON's PROP property to VAL." | |
195 ;; Treat some properties specially. | |
39916 | 196 (cond ((memq prop '(type :type)) |
39643 | 197 ;; We translate a `type' property a `category' property, since |
198 ;; that's what's actually used by overlays/text-properties for | |
199 ;; inheriting properties. | |
200 (setq prop 'category) | |
201 (setq val (button-category-symbol val))) | |
202 ((eq prop 'category) | |
203 ;; Disallow updating the `category' property directly. | |
204 (error "Button `category' property may not be set directly"))) | |
205 ;; Add the property. | |
206 (if (overlayp button) | |
207 (overlay-put button prop val) | |
208 ;; Must be a text-property button. | |
209 (put-text-property | |
210 (or (previous-single-property-change (1+ button) 'button) | |
211 (point-min)) | |
212 (or (next-single-property-change button 'button) | |
213 (point-max)) | |
214 prop val))) | |
215 | |
39676
9e8365caa0ee
(button-activate): USE-MOUSE-ACTION is optional.
Miles Bader <miles@gnu.org>
parents:
39668
diff
changeset
|
216 (defsubst button-activate (button &optional use-mouse-action) |
39655
6aeeb8a310af
(next-button, previous-button): Respect `skip' property.
Miles Bader <miles@gnu.org>
parents:
39643
diff
changeset
|
217 "Call BUTTON's action property. |
6aeeb8a310af
(next-button, previous-button): Respect `skip' property.
Miles Bader <miles@gnu.org>
parents:
39643
diff
changeset
|
218 If USE-MOUSE-ACTION is non-nil, invoke the button's mouse-action |
6aeeb8a310af
(next-button, previous-button): Respect `skip' property.
Miles Bader <miles@gnu.org>
parents:
39643
diff
changeset
|
219 instead of its normal action; if the button has no mouse-action, |
6aeeb8a310af
(next-button, previous-button): Respect `skip' property.
Miles Bader <miles@gnu.org>
parents:
39643
diff
changeset
|
220 the normal action is used instead." |
57483
12ad045f7911
(button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
52401
diff
changeset
|
221 (let ((action (or (and use-mouse-action (button-get button 'mouse-action)) |
12ad045f7911
(button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
52401
diff
changeset
|
222 (button-get button 'action)))) |
12ad045f7911
(button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
52401
diff
changeset
|
223 (if (markerp action) |
12ad045f7911
(button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
52401
diff
changeset
|
224 (save-selected-window |
12ad045f7911
(button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
52401
diff
changeset
|
225 (select-window (display-buffer (marker-buffer action))) |
12ad045f7911
(button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
52401
diff
changeset
|
226 (goto-char action) |
12ad045f7911
(button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
52401
diff
changeset
|
227 (recenter 0)) |
12ad045f7911
(button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
52401
diff
changeset
|
228 (funcall action button)))) |
39643 | 229 |
230 (defun button-label (button) | |
231 "Return BUTTON's text label." | |
232 (buffer-substring-no-properties (button-start button) (button-end button))) | |
233 | |
39916 | 234 (defsubst button-type (button) |
39917 | 235 "Return BUTTON's button-type." |
39916 | 236 (button-get button 'type)) |
237 | |
39716
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
238 (defun button-has-type-p (button type) |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
239 "Return t if BUTTON has button-type TYPE, or one of TYPE's subtypes." |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
240 (button-type-subtype-p (button-get button 'type) type)) |
66d3b28583a0
(define-button-type): Respect any `supertype' property.
Miles Bader <miles@gnu.org>
parents:
39703
diff
changeset
|
241 |
39643 | 242 |
243 ;; Creating overlay buttons | |
244 | |
245 (defun make-button (beg end &rest properties) | |
246 "Make a button from BEG to END in the current buffer. | |
247 The remaining arguments form a sequence of PROPERTY VALUE pairs, | |
39917 | 248 specifying properties to add to the button. |
249 In addition, the keyword argument :type may be used to specify a | |
250 button-type from which to inherit other properties; see | |
251 `define-button-type'. | |
39643 | 252 |
253 Also see `make-text-button', `insert-button'." | |
254 (let ((overlay (make-overlay beg end nil t nil))) | |
255 (while properties | |
256 (button-put overlay (pop properties) (pop properties))) | |
257 ;; Put a pointer to the button in the overlay, so it's easy to get | |
258 ;; when we don't actually have a reference to the overlay. | |
259 (overlay-put overlay 'button overlay) | |
260 ;; If the user didn't specify a type, use the default. | |
261 (unless (overlay-get overlay 'category) | |
262 (overlay-put overlay 'category 'default-button)) | |
263 ;; OVERLAY is the button, so return it | |
264 overlay)) | |
265 | |
266 (defun insert-button (label &rest properties) | |
267 "Insert a button with the label LABEL. | |
268 The remaining arguments form a sequence of PROPERTY VALUE pairs, | |
39917 | 269 specifying properties to add to the button. |
270 In addition, the keyword argument :type may be used to specify a | |
271 button-type from which to inherit other properties; see | |
272 `define-button-type'. | |
39643 | 273 |
274 Also see `insert-text-button', `make-button'." | |
275 (apply #'make-button | |
276 (prog1 (point) (insert label)) | |
277 (point) | |
278 properties)) | |
279 | |
280 | |
281 ;; Creating text-property buttons | |
282 | |
283 (defun make-text-button (beg end &rest properties) | |
284 "Make a button from BEG to END in the current buffer. | |
285 The remaining arguments form a sequence of PROPERTY VALUE pairs, | |
39917 | 286 specifying properties to add to the button. |
287 In addition, the keyword argument :type may be used to specify a | |
288 button-type from which to inherit other properties; see | |
289 `define-button-type'. | |
39643 | 290 |
291 This function is like `make-button', except that the button is actually | |
292 part of the text instead of being a property of the buffer. Creating | |
293 large numbers of buttons can also be somewhat faster using | |
294 `make-text-button'. | |
295 | |
95776
dc7fbbea402e
(make-text-button): Allow `start' to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
94678
diff
changeset
|
296 BEG can also be a string, in which case it is made into a button. |
dc7fbbea402e
(make-text-button): Allow `start' to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
94678
diff
changeset
|
297 |
39643 | 298 Also see `insert-text-button'." |
95776
dc7fbbea402e
(make-text-button): Allow `start' to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
94678
diff
changeset
|
299 (let ((object nil) |
dc7fbbea402e
(make-text-button): Allow `start' to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
94678
diff
changeset
|
300 (type-entry |
60339
3cd3e3cf3529
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-145
Miles Bader <miles@gnu.org>
parents:
60162
diff
changeset
|
301 (or (plist-member properties 'type) |
3cd3e3cf3529
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-145
Miles Bader <miles@gnu.org>
parents:
60162
diff
changeset
|
302 (plist-member properties :type)))) |
95776
dc7fbbea402e
(make-text-button): Allow `start' to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
94678
diff
changeset
|
303 (when (stringp beg) |
dc7fbbea402e
(make-text-button): Allow `start' to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
94678
diff
changeset
|
304 (setq object beg beg 0 end (length object))) |
60339
3cd3e3cf3529
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-145
Miles Bader <miles@gnu.org>
parents:
60162
diff
changeset
|
305 ;; Disallow setting the `category' property directly. |
3cd3e3cf3529
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-145
Miles Bader <miles@gnu.org>
parents:
60162
diff
changeset
|
306 (when (plist-get properties 'category) |
3cd3e3cf3529
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-145
Miles Bader <miles@gnu.org>
parents:
60162
diff
changeset
|
307 (error "Button `category' property may not be set directly")) |
3cd3e3cf3529
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-145
Miles Bader <miles@gnu.org>
parents:
60162
diff
changeset
|
308 (if (null type-entry) |
3cd3e3cf3529
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-145
Miles Bader <miles@gnu.org>
parents:
60162
diff
changeset
|
309 ;; The user didn't specify a `type' property, use the default. |
3cd3e3cf3529
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-145
Miles Bader <miles@gnu.org>
parents:
60162
diff
changeset
|
310 (setq properties (cons 'category (cons 'default-button properties))) |
3cd3e3cf3529
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-145
Miles Bader <miles@gnu.org>
parents:
60162
diff
changeset
|
311 ;; The user did specify a `type' property. Translate it into a |
3cd3e3cf3529
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-145
Miles Bader <miles@gnu.org>
parents:
60162
diff
changeset
|
312 ;; `category' property, which is what's actually used by |
3cd3e3cf3529
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-145
Miles Bader <miles@gnu.org>
parents:
60162
diff
changeset
|
313 ;; text-properties for inheritance. |
3cd3e3cf3529
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-145
Miles Bader <miles@gnu.org>
parents:
60162
diff
changeset
|
314 (setcar type-entry 'category) |
3cd3e3cf3529
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-145
Miles Bader <miles@gnu.org>
parents:
60162
diff
changeset
|
315 (setcar (cdr type-entry) |
95776
dc7fbbea402e
(make-text-button): Allow `start' to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
94678
diff
changeset
|
316 (button-category-symbol (car (cdr type-entry))))) |
dc7fbbea402e
(make-text-button): Allow `start' to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
94678
diff
changeset
|
317 ;; Now add all the text properties at once |
dc7fbbea402e
(make-text-button): Allow `start' to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
94678
diff
changeset
|
318 (add-text-properties beg end |
dc7fbbea402e
(make-text-button): Allow `start' to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
94678
diff
changeset
|
319 ;; Each button should have a non-eq `button' |
dc7fbbea402e
(make-text-button): Allow `start' to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
94678
diff
changeset
|
320 ;; property so that next-single-property-change can |
dc7fbbea402e
(make-text-button): Allow `start' to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
94678
diff
changeset
|
321 ;; detect boundaries reliably. |
dc7fbbea402e
(make-text-button): Allow `start' to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
94678
diff
changeset
|
322 (cons 'button (cons (list t) properties)) |
dc7fbbea402e
(make-text-button): Allow `start' to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
94678
diff
changeset
|
323 object) |
dc7fbbea402e
(make-text-button): Allow `start' to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
94678
diff
changeset
|
324 ;; Return something that can be used to get at the button. |
dc7fbbea402e
(make-text-button): Allow `start' to be a string.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
94678
diff
changeset
|
325 beg)) |
39643 | 326 |
327 (defun insert-text-button (label &rest properties) | |
328 "Insert a button with the label LABEL. | |
329 The remaining arguments form a sequence of PROPERTY VALUE pairs, | |
39917 | 330 specifying properties to add to the button. |
331 In addition, the keyword argument :type may be used to specify a | |
332 button-type from which to inherit other properties; see | |
333 `define-button-type'. | |
39643 | 334 |
335 This function is like `insert-button', except that the button is | |
336 actually part of the text instead of being a property of the buffer. | |
337 Creating large numbers of buttons can also be somewhat faster using | |
338 `insert-text-button'. | |
339 | |
340 Also see `make-text-button'." | |
341 (apply #'make-text-button | |
342 (prog1 (point) (insert label)) | |
343 (point) | |
344 properties)) | |
345 | |
346 | |
347 ;; Finding buttons in a buffer | |
348 | |
349 (defun button-at (pos) | |
350 "Return the button at position POS in the current buffer, or nil." | |
351 (let ((button (get-char-property pos 'button))) | |
352 (if (or (overlayp button) (null button)) | |
353 button | |
354 ;; Must be a text-property button; return a marker pointing to it. | |
355 (copy-marker pos t)))) | |
356 | |
39668
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
357 (defun next-button (pos &optional count-current) |
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
358 "Return the next button after position POS in the current buffer. |
39643 | 359 If COUNT-CURRENT is non-nil, count any button at POS in the search, |
39668
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
360 instead of starting at the next button." |
39643 | 361 (unless count-current |
362 ;; Search for the next button boundary. | |
363 (setq pos (next-single-char-property-change pos 'button))) | |
39668
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
364 (and (< pos (point-max)) |
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
365 (or (button-at pos) |
39643 | 366 ;; We must have originally been on a button, and are now in |
367 ;; the inter-button space. Recurse to find a button. | |
39668
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
368 (next-button pos)))) |
39643 | 369 |
39668
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
370 (defun previous-button (pos &optional count-current) |
76869
c93f4d8744d5
(previous-button): Rewrite to account for adjacent buttons.
Chong Yidong <cyd@stupidchicken.com>
parents:
76771
diff
changeset
|
371 "Return the previous button before position POS in the current buffer. |
39643 | 372 If COUNT-CURRENT is non-nil, count any button at POS in the search, |
39668
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
373 instead of starting at the next button." |
76869
c93f4d8744d5
(previous-button): Rewrite to account for adjacent buttons.
Chong Yidong <cyd@stupidchicken.com>
parents:
76771
diff
changeset
|
374 (let ((button (button-at pos))) |
c93f4d8744d5
(previous-button): Rewrite to account for adjacent buttons.
Chong Yidong <cyd@stupidchicken.com>
parents:
76771
diff
changeset
|
375 (if button |
c93f4d8744d5
(previous-button): Rewrite to account for adjacent buttons.
Chong Yidong <cyd@stupidchicken.com>
parents:
76771
diff
changeset
|
376 (if count-current |
c93f4d8744d5
(previous-button): Rewrite to account for adjacent buttons.
Chong Yidong <cyd@stupidchicken.com>
parents:
76771
diff
changeset
|
377 button |
c93f4d8744d5
(previous-button): Rewrite to account for adjacent buttons.
Chong Yidong <cyd@stupidchicken.com>
parents:
76771
diff
changeset
|
378 ;; We started out on a button, so move to its start and look |
c93f4d8744d5
(previous-button): Rewrite to account for adjacent buttons.
Chong Yidong <cyd@stupidchicken.com>
parents:
76771
diff
changeset
|
379 ;; for the previous button boundary. |
c93f4d8744d5
(previous-button): Rewrite to account for adjacent buttons.
Chong Yidong <cyd@stupidchicken.com>
parents:
76771
diff
changeset
|
380 (setq pos (previous-single-char-property-change |
c93f4d8744d5
(previous-button): Rewrite to account for adjacent buttons.
Chong Yidong <cyd@stupidchicken.com>
parents:
76771
diff
changeset
|
381 (button-start button) 'button)) |
c93f4d8744d5
(previous-button): Rewrite to account for adjacent buttons.
Chong Yidong <cyd@stupidchicken.com>
parents:
76771
diff
changeset
|
382 (let ((new-button (button-at pos))) |
c93f4d8744d5
(previous-button): Rewrite to account for adjacent buttons.
Chong Yidong <cyd@stupidchicken.com>
parents:
76771
diff
changeset
|
383 (if new-button |
c93f4d8744d5
(previous-button): Rewrite to account for adjacent buttons.
Chong Yidong <cyd@stupidchicken.com>
parents:
76771
diff
changeset
|
384 ;; We are in a button again; this can happen if there |
c93f4d8744d5
(previous-button): Rewrite to account for adjacent buttons.
Chong Yidong <cyd@stupidchicken.com>
parents:
76771
diff
changeset
|
385 ;; are adjacent buttons (or at bob). |
76870 | 386 (unless (= pos (button-start button)) new-button) |
76869
c93f4d8744d5
(previous-button): Rewrite to account for adjacent buttons.
Chong Yidong <cyd@stupidchicken.com>
parents:
76771
diff
changeset
|
387 ;; We are now in the space between buttons. |
c93f4d8744d5
(previous-button): Rewrite to account for adjacent buttons.
Chong Yidong <cyd@stupidchicken.com>
parents:
76771
diff
changeset
|
388 (previous-button pos)))) |
c93f4d8744d5
(previous-button): Rewrite to account for adjacent buttons.
Chong Yidong <cyd@stupidchicken.com>
parents:
76771
diff
changeset
|
389 ;; We started out in the space between buttons. |
c93f4d8744d5
(previous-button): Rewrite to account for adjacent buttons.
Chong Yidong <cyd@stupidchicken.com>
parents:
76771
diff
changeset
|
390 (setq pos (previous-single-char-property-change pos 'button)) |
c93f4d8744d5
(previous-button): Rewrite to account for adjacent buttons.
Chong Yidong <cyd@stupidchicken.com>
parents:
76771
diff
changeset
|
391 (or (button-at pos) |
c93f4d8744d5
(previous-button): Rewrite to account for adjacent buttons.
Chong Yidong <cyd@stupidchicken.com>
parents:
76771
diff
changeset
|
392 (and (> pos (point-min)) |
c93f4d8744d5
(previous-button): Rewrite to account for adjacent buttons.
Chong Yidong <cyd@stupidchicken.com>
parents:
76771
diff
changeset
|
393 (button-at (1- pos))))))) |
39643 | 394 |
395 | |
396 ;; User commands | |
397 | |
39655
6aeeb8a310af
(next-button, previous-button): Respect `skip' property.
Miles Bader <miles@gnu.org>
parents:
39643
diff
changeset
|
398 (defun push-button (&optional pos use-mouse-action) |
39643 | 399 "Perform the action specified by a button at location POS. |
57483
12ad045f7911
(button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
52401
diff
changeset
|
400 POS may be either a buffer position or a mouse-event. If |
12ad045f7911
(button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
52401
diff
changeset
|
401 USE-MOUSE-ACTION is non-nil, invoke the button's mouse-action |
39655
6aeeb8a310af
(next-button, previous-button): Respect `skip' property.
Miles Bader <miles@gnu.org>
parents:
39643
diff
changeset
|
402 instead of its normal action; if the button has no mouse-action, |
57483
12ad045f7911
(button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
52401
diff
changeset
|
403 the normal action is used instead. The action may be either a |
12ad045f7911
(button-activate): Allow a marker to display as an action.
Daniel Pfeiffer <occitan@esperanto.org>
parents:
52401
diff
changeset
|
404 function to call or a marker to display. |
39643 | 405 POS defaults to point, except when `push-button' is invoked |
406 interactively as the result of a mouse-event, in which case, the | |
407 mouse event is used. | |
408 If there's no button at POS, do nothing and return nil, otherwise | |
409 return t." | |
410 (interactive | |
411 (list (if (integerp last-command-event) (point) last-command-event))) | |
412 (if (and (not (integerp pos)) (eventp pos)) | |
413 ;; POS is a mouse event; switch to the proper window/buffer | |
414 (let ((posn (event-start pos))) | |
415 (with-current-buffer (window-buffer (posn-window posn)) | |
39655
6aeeb8a310af
(next-button, previous-button): Respect `skip' property.
Miles Bader <miles@gnu.org>
parents:
39643
diff
changeset
|
416 (push-button (posn-point posn) t))) |
39643 | 417 ;; POS is just normal position |
418 (let ((button (button-at (or pos (point))))) | |
419 (if (not button) | |
420 nil | |
39655
6aeeb8a310af
(next-button, previous-button): Respect `skip' property.
Miles Bader <miles@gnu.org>
parents:
39643
diff
changeset
|
421 (button-activate button use-mouse-action) |
39643 | 422 t)))) |
423 | |
424 (defun forward-button (n &optional wrap display-message) | |
425 "Move to the Nth next button, or Nth previous button if N is negative. | |
39668
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
426 If N is 0, move to the start of any button at point. |
39643 | 427 If WRAP is non-nil, moving past either end of the buffer continues from the |
428 other end. | |
429 If DISPLAY-MESSAGE is non-nil, the button's help-echo string is displayed. | |
39668
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
430 Any button with a non-nil `skip' property is skipped over. |
39643 | 431 Returns the button found." |
432 (interactive "p\nd\nd") | |
39668
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
433 (let (button) |
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
434 (if (zerop n) |
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
435 ;; Move to start of current button |
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
436 (if (setq button (button-at (point))) |
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
437 (goto-char (button-start button))) |
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
438 ;; Move to Nth next button |
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
439 (let ((iterator (if (> n 0) #'next-button #'previous-button)) |
97184
a9fd3177343b
(forward-button): Avoid infloop.
Chong Yidong <cyd@stupidchicken.com>
parents:
95776
diff
changeset
|
440 (wrap-start (if (> n 0) (point-min) (point-max))) |
a9fd3177343b
(forward-button): Avoid infloop.
Chong Yidong <cyd@stupidchicken.com>
parents:
95776
diff
changeset
|
441 opoint fail) |
39668
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
442 (setq n (abs n)) |
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
443 (setq button t) ; just to start the loop |
97184
a9fd3177343b
(forward-button): Avoid infloop.
Chong Yidong <cyd@stupidchicken.com>
parents:
95776
diff
changeset
|
444 (while (and (null fail) (> n 0) button) |
39668
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
445 (setq button (funcall iterator (point))) |
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
446 (when (and (not button) wrap) |
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
447 (setq button (funcall iterator wrap-start t))) |
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
448 (when button |
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
449 (goto-char (button-start button)) |
97184
a9fd3177343b
(forward-button): Avoid infloop.
Chong Yidong <cyd@stupidchicken.com>
parents:
95776
diff
changeset
|
450 ;; Avoid looping forever (e.g., if all the buttons have |
a9fd3177343b
(forward-button): Avoid infloop.
Chong Yidong <cyd@stupidchicken.com>
parents:
95776
diff
changeset
|
451 ;; the `skip' property). |
a9fd3177343b
(forward-button): Avoid infloop.
Chong Yidong <cyd@stupidchicken.com>
parents:
95776
diff
changeset
|
452 (cond ((null opoint) |
a9fd3177343b
(forward-button): Avoid infloop.
Chong Yidong <cyd@stupidchicken.com>
parents:
95776
diff
changeset
|
453 (setq opoint (point))) |
a9fd3177343b
(forward-button): Avoid infloop.
Chong Yidong <cyd@stupidchicken.com>
parents:
95776
diff
changeset
|
454 ((= opoint (point)) |
a9fd3177343b
(forward-button): Avoid infloop.
Chong Yidong <cyd@stupidchicken.com>
parents:
95776
diff
changeset
|
455 (setq fail t))) |
39668
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
456 (unless (button-get button 'skip) |
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
457 (setq n (1- n))))))) |
39643 | 458 (if (null button) |
459 (error (if wrap "No buttons!" "No more buttons")) | |
460 (let ((msg (and display-message (button-get button 'help-echo)))) | |
461 (when msg | |
462 (message "%s" msg))) | |
463 button))) | |
464 | |
465 (defun backward-button (n &optional wrap display-message) | |
466 "Move to the Nth previous button, or Nth next button if N is negative. | |
39668
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
467 If N is 0, move to the start of any button at point. |
39643 | 468 If WRAP is non-nil, moving past either end of the buffer continues from the |
469 other end. | |
470 If DISPLAY-MESSAGE is non-nil, the button's help-echo string is displayed. | |
39668
1666965880cc
(next-button, previous-button): Remove N and WRAP parameters.
Miles Bader <miles@gnu.org>
parents:
39655
diff
changeset
|
471 Any button with a non-nil `skip' property is skipped over. |
39643 | 472 Returns the button found." |
473 (interactive "p\nd\nd") | |
474 (forward-button (- n) wrap display-message)) | |
475 | |
476 | |
477 (provide 'button) | |
478 | |
83768
4bdc932ccd9a
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
78236
diff
changeset
|
479 ;; arch-tag: 5f2c7627-413b-4097-b282-630f89d9c5e9 |
39643 | 480 ;;; button.el ends here |