Commit | Line | Data |
---|---|---|
0c26f463 MB |
1 | ;;; button.el --- Clickable buttons |
2 | ;; | |
3 | ;; Copyright (C) 2001 Free Software Foundation, Inc. | |
4 | ;; | |
5 | ;; Author: Miles Bader <miles@gnu.org> | |
6 | ;; Keywords: extensions | |
7 | ;; | |
8 | ;; This file is part of GNU Emacs. | |
9 | ;; | |
10 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 | ;; it under the terms of the GNU General Public License as published by | |
12 | ;; the Free Software Foundation; either version 2, or (at your option) | |
13 | ;; any later version. | |
14 | ;; | |
15 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | ;; GNU General Public License for more details. | |
19 | ;; | |
20 | ;; You should have received a copy of the GNU General Public License | |
21 | ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
22 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
23 | ;; Boston, MA 02111-1307, USA. | |
24 | ||
25 | ;;; Commentary: | |
26 | ;; | |
27 | ;; This package defines functions for inserting and manipulating | |
28 | ;; clickable buttons in Emacs buffers, such as might be used for help | |
29 | ;; hyperlinks, etc. | |
30 | ;; | |
31 | ;; In some ways it duplicates functionality also offered by the | |
32 | ;; `widget' package, but the button package has the advantage that it | |
33 | ;; is (1) much faster, (2) much smaller, and (3) much, much, simpler | |
34 | ;; (the code, that is, not the interface). | |
35 | ;; | |
36 | ;; Buttons can either use overlays, in which case the button is | |
37 | ;; represented by the overlay itself, or text-properties, in which case | |
38 | ;; the button is represented by a marker or buffer-position pointing | |
39 | ;; somewhere in the button. In the latter case, no markers into the | |
40 | ;; buffer are retained, which is important for speed if there are are | |
41 | ;; extremely large numbers of buttons. | |
42 | ;; | |
43 | ;; Using `define-button-type' to define default properties for buttons | |
44 | ;; is not necessary, but it is is encouraged, since doing so makes the | |
45 | ;; resulting code clearer and more efficient. | |
46 | ;; | |
47 | ||
48 | ;;; Code: | |
49 | ||
50 | \f | |
51 | ;; Globals | |
52 | ||
f2e24189 EZ |
53 | (defface button '((((type pc) (class color)) |
54 | (:foreground "lightblue")) | |
55 | (t :underline t)) | |
0c26f463 MB |
56 | "Default face used for buttons.") |
57 | ||
58 | ;;;###autoload | |
59 | (defvar button-map | |
60 | (let ((map (make-sparse-keymap))) | |
61 | (define-key map "\r" 'push-button) | |
62 | (define-key map [mouse-2] 'push-button) | |
63 | map) | |
64 | "Keymap used by buttons.") | |
65 | ||
66 | ;;;###autoload | |
67 | (defvar button-buffer-map | |
68 | (let ((map (make-sparse-keymap))) | |
69 | (define-key map [?\t] 'forward-button) | |
70 | (define-key map [backtab] 'backward-button) | |
71 | map) | |
72 | "Keymap useful for buffers containing buttons. | |
73 | Mode-specific keymaps may want to use this as their parent keymap.") | |
74 | ||
75 | ;; Default properties for buttons | |
76 | (put 'default-button 'face 'button) | |
77 | (put 'default-button 'mouse-face 'highlight) | |
78 | (put 'default-button 'keymap button-map) | |
79 | (put 'default-button 'type 'button) | |
62dc75c4 | 80 | (put 'default-button 'action 'ignore) |
0c26f463 MB |
81 | (put 'default-button 'help-echo "mouse-2, RET: Push this button") |
82 | ;; Make overlay buttons go away if their underlying text is deleted. | |
83 | (put 'default-button 'evaporate t) | |
84 | ;; Prevent insertions adjacent to the text-property buttons from | |
85 | ;; inheriting its properties. | |
86 | (put 'default-button 'rear-nonsticky t) | |
87 | ;; Text property buttons don't have a `button' property of their own, so | |
88 | ;; they inherit this. | |
89 | (put 'default-button 'button t) | |
90 | ||
530893b2 MB |
91 | ;; A `category-symbol' property for the default button type |
92 | (put 'button 'button-category-symbol 'default-button) | |
93 | ||
0c26f463 MB |
94 | \f |
95 | ;; Button types (which can be used to hold default properties for buttons) | |
96 | ||
ded42dd3 MB |
97 | ;; Because button-type properties are inherited by buttons using the |
98 | ;; special `category' property (implemented by both overlays and | |
99 | ;; text-properties), we need to store them on a symbol to which the | |
100 | ;; `category' properties can point. Instead of using the symbol that's | |
101 | ;; the name of each button-type, however, we use a separate symbol (with | |
102 | ;; `-button' appended, and uninterned) to store the properties. This is | |
103 | ;; to avoid name clashes. | |
104 | ||
105 | ;; [this is an internal function] | |
106 | (defsubst button-category-symbol (type) | |
107 | "Return the symbol used by button-type TYPE to store properties. | |
108 | Buttons inherit them by setting their `category' property to that symbol." | |
109 | (or (get type 'button-category-symbol) | |
110 | (error "Unknown button type `%s'" type))) | |
111 | ||
0c26f463 MB |
112 | ;;;###autoload |
113 | (defun define-button-type (name &rest properties) | |
114 | "Define a `button type' called NAME. | |
115 | The remaining arguments form a sequence of PROPERTY VALUE pairs, | |
116 | specifying properties to use as defaults for buttons with this type | |
117 | \(a button's type may be set by giving it a `type' property when | |
ecdbe16a | 118 | creating the button, using the :type keyword argument). |
ded42dd3 | 119 | |
ecdbe16a MB |
120 | In addition, the keyword argument :supertype may be used to specify a |
121 | button-type from which NAME inherits its default property values | |
122 | \(however, the inheritance happens only when NAME is defined; subsequent | |
123 | changes to a supertype are not reflected in its subtypes)." | |
ded42dd3 | 124 | (let* ((catsym (make-symbol (concat (symbol-name name) "-button"))) |
530893b2 MB |
125 | (supertype |
126 | (or (plist-get properties 'supertype) | |
127 | (plist-get properties :supertype))) | |
ded42dd3 MB |
128 | (super-catsym |
129 | (if supertype (button-category-symbol supertype) 'default-button))) | |
0c26f463 MB |
130 | ;; Provide a link so that it's easy to find the real symbol. |
131 | (put name 'button-category-symbol catsym) | |
132 | ;; Initialize NAME's properties using the global defaults. | |
ded42dd3 | 133 | (let ((default-props (symbol-plist super-catsym))) |
0c26f463 MB |
134 | (while default-props |
135 | (put catsym (pop default-props) (pop default-props)))) | |
136 | ;; Add NAME as the `type' property, which will then be returned as | |
137 | ;; the type property of individual buttons. | |
138 | (put catsym 'type name) | |
139 | ;; Add the properties in PROPERTIES to the real symbol. | |
140 | (while properties | |
530893b2 MB |
141 | (let ((prop (pop properties))) |
142 | (when (eq prop :supertype) | |
143 | (setq prop 'supertype)) | |
144 | (put catsym prop (pop properties)))) | |
0c26f463 MB |
145 | name)) |
146 | ||
0c26f463 MB |
147 | (defun button-type-put (type prop val) |
148 | "Set the button-type TYPE's PROP property to VAL." | |
149 | (put (button-category-symbol type) prop val)) | |
150 | ||
151 | (defun button-type-get (type prop) | |
152 | "Get the property of button-type TYPE named PROP." | |
153 | (get (button-category-symbol type) prop)) | |
154 | ||
ded42dd3 MB |
155 | (defun button-type-subtype-p (type supertype) |
156 | "Return t if button-type TYPE is a subtype of SUPERTYPE." | |
157 | (or (eq type supertype) | |
158 | (and type | |
159 | (button-type-subtype-p (button-type-get type 'supertype) | |
160 | supertype)))) | |
161 | ||
0c26f463 MB |
162 | \f |
163 | ;; Button properties and other attributes | |
164 | ||
165 | (defun button-start (button) | |
166 | "Return the position at which BUTTON starts." | |
167 | (if (overlayp button) | |
168 | (overlay-start button) | |
169 | ;; Must be a text-property button. | |
170 | (or (previous-single-property-change (1+ button) 'button) | |
171 | (point-min)))) | |
172 | ||
173 | (defun button-end (button) | |
174 | "Return the position at which BUTTON ends." | |
175 | (if (overlayp button) | |
176 | (overlay-end button) | |
177 | ;; Must be a text-property button. | |
178 | (or (next-single-property-change button 'button) | |
179 | (point-max)))) | |
180 | ||
181 | (defun button-get (button prop) | |
182 | "Get the property of button BUTTON named PROP." | |
183 | (if (overlayp button) | |
184 | (overlay-get button prop) | |
185 | ;; Must be a text-property button. | |
186 | (get-text-property button prop))) | |
187 | ||
188 | (defun button-put (button prop val) | |
189 | "Set BUTTON's PROP property to VAL." | |
190 | ;; Treat some properties specially. | |
530893b2 | 191 | (cond ((memq prop '(type :type)) |
0c26f463 MB |
192 | ;; We translate a `type' property a `category' property, since |
193 | ;; that's what's actually used by overlays/text-properties for | |
194 | ;; inheriting properties. | |
195 | (setq prop 'category) | |
196 | (setq val (button-category-symbol val))) | |
197 | ((eq prop 'category) | |
198 | ;; Disallow updating the `category' property directly. | |
199 | (error "Button `category' property may not be set directly"))) | |
200 | ;; Add the property. | |
201 | (if (overlayp button) | |
202 | (overlay-put button prop val) | |
203 | ;; Must be a text-property button. | |
204 | (put-text-property | |
205 | (or (previous-single-property-change (1+ button) 'button) | |
206 | (point-min)) | |
207 | (or (next-single-property-change button 'button) | |
208 | (point-max)) | |
209 | prop val))) | |
210 | ||
1e00f720 | 211 | (defsubst button-activate (button &optional use-mouse-action) |
d6bc0bdc MB |
212 | "Call BUTTON's action property. |
213 | If USE-MOUSE-ACTION is non-nil, invoke the button's mouse-action | |
214 | instead of its normal action; if the button has no mouse-action, | |
215 | the normal action is used instead." | |
216 | (funcall (or (and use-mouse-action (button-get button 'mouse-action)) | |
217 | (button-get button 'action)) | |
218 | button)) | |
0c26f463 MB |
219 | |
220 | (defun button-label (button) | |
221 | "Return BUTTON's text label." | |
222 | (buffer-substring-no-properties (button-start button) (button-end button))) | |
223 | ||
530893b2 | 224 | (defsubst button-type (button) |
ecdbe16a | 225 | "Return BUTTON's button-type." |
530893b2 MB |
226 | (button-get button 'type)) |
227 | ||
ded42dd3 MB |
228 | (defun button-has-type-p (button type) |
229 | "Return t if BUTTON has button-type TYPE, or one of TYPE's subtypes." | |
230 | (button-type-subtype-p (button-get button 'type) type)) | |
231 | ||
0c26f463 MB |
232 | \f |
233 | ;; Creating overlay buttons | |
234 | ||
235 | ;;;###autoload | |
236 | (defun make-button (beg end &rest properties) | |
237 | "Make a button from BEG to END in the current buffer. | |
238 | The remaining arguments form a sequence of PROPERTY VALUE pairs, | |
ecdbe16a MB |
239 | specifying properties to add to the button. |
240 | In addition, the keyword argument :type may be used to specify a | |
241 | button-type from which to inherit other properties; see | |
242 | `define-button-type'. | |
0c26f463 MB |
243 | |
244 | Also see `make-text-button', `insert-button'." | |
245 | (let ((overlay (make-overlay beg end nil t nil))) | |
246 | (while properties | |
247 | (button-put overlay (pop properties) (pop properties))) | |
248 | ;; Put a pointer to the button in the overlay, so it's easy to get | |
249 | ;; when we don't actually have a reference to the overlay. | |
250 | (overlay-put overlay 'button overlay) | |
251 | ;; If the user didn't specify a type, use the default. | |
252 | (unless (overlay-get overlay 'category) | |
253 | (overlay-put overlay 'category 'default-button)) | |
254 | ;; OVERLAY is the button, so return it | |
255 | overlay)) | |
256 | ||
257 | ;;;###autoload | |
258 | (defun insert-button (label &rest properties) | |
259 | "Insert a button with the label LABEL. | |
260 | The remaining arguments form a sequence of PROPERTY VALUE pairs, | |
ecdbe16a MB |
261 | specifying properties to add to the button. |
262 | In addition, the keyword argument :type may be used to specify a | |
263 | button-type from which to inherit other properties; see | |
264 | `define-button-type'. | |
0c26f463 MB |
265 | |
266 | Also see `insert-text-button', `make-button'." | |
267 | (apply #'make-button | |
268 | (prog1 (point) (insert label)) | |
269 | (point) | |
270 | properties)) | |
271 | ||
272 | \f | |
273 | ;; Creating text-property buttons | |
274 | ||
275 | ;;;###autoload | |
276 | (defun make-text-button (beg end &rest properties) | |
277 | "Make a button from BEG to END in the current buffer. | |
278 | The remaining arguments form a sequence of PROPERTY VALUE pairs, | |
ecdbe16a MB |
279 | specifying properties to add to the button. |
280 | In addition, the keyword argument :type may be used to specify a | |
281 | button-type from which to inherit other properties; see | |
282 | `define-button-type'. | |
0c26f463 MB |
283 | |
284 | This function is like `make-button', except that the button is actually | |
285 | part of the text instead of being a property of the buffer. Creating | |
286 | large numbers of buttons can also be somewhat faster using | |
287 | `make-text-button'. | |
288 | ||
289 | Also see `insert-text-button'." | |
290 | (let (prop val) | |
291 | (while properties | |
292 | (setq prop (pop properties)) | |
293 | (setq val (pop properties)) | |
294 | ;; Note that all the following code is basically equivalent to | |
295 | ;; `button-put', but we can do it much more efficiently since we | |
296 | ;; already have BEG and END. | |
530893b2 | 297 | (cond ((memq prop '(type :type)) |
0c26f463 MB |
298 | ;; We translate a `type' property into a `category' |
299 | ;; property, since that's what's actually used by | |
300 | ;; text-properties for inheritance. | |
301 | (setq prop 'category) | |
302 | (setq val (button-category-symbol val))) | |
303 | ((eq prop 'category) | |
304 | ;; Disallow setting the `category' property directly. | |
305 | (error "Button `category' property may not be set directly"))) | |
306 | ;; Add the property. | |
307 | (put-text-property beg end prop val))) | |
308 | ;; Return something that can be used to get at the button. | |
309 | beg) | |
310 | ||
311 | ;;;###autoload | |
312 | (defun insert-text-button (label &rest properties) | |
313 | "Insert a button with the label LABEL. | |
314 | The remaining arguments form a sequence of PROPERTY VALUE pairs, | |
ecdbe16a MB |
315 | specifying properties to add to the button. |
316 | In addition, the keyword argument :type may be used to specify a | |
317 | button-type from which to inherit other properties; see | |
318 | `define-button-type'. | |
0c26f463 MB |
319 | |
320 | This function is like `insert-button', except that the button is | |
321 | actually part of the text instead of being a property of the buffer. | |
322 | Creating large numbers of buttons can also be somewhat faster using | |
323 | `insert-text-button'. | |
324 | ||
325 | Also see `make-text-button'." | |
326 | (apply #'make-text-button | |
327 | (prog1 (point) (insert label)) | |
328 | (point) | |
329 | properties)) | |
330 | ||
331 | \f | |
332 | ;; Finding buttons in a buffer | |
333 | ||
334 | (defun button-at (pos) | |
335 | "Return the button at position POS in the current buffer, or nil." | |
336 | (let ((button (get-char-property pos 'button))) | |
337 | (if (or (overlayp button) (null button)) | |
338 | button | |
339 | ;; Must be a text-property button; return a marker pointing to it. | |
340 | (copy-marker pos t)))) | |
341 | ||
fee34a28 MB |
342 | (defun next-button (pos &optional count-current) |
343 | "Return the next button after position POS in the current buffer. | |
0c26f463 | 344 | If COUNT-CURRENT is non-nil, count any button at POS in the search, |
fee34a28 | 345 | instead of starting at the next button." |
0c26f463 MB |
346 | (unless count-current |
347 | ;; Search for the next button boundary. | |
348 | (setq pos (next-single-char-property-change pos 'button))) | |
fee34a28 MB |
349 | (and (< pos (point-max)) |
350 | (or (button-at pos) | |
0c26f463 MB |
351 | ;; We must have originally been on a button, and are now in |
352 | ;; the inter-button space. Recurse to find a button. | |
fee34a28 | 353 | (next-button pos)))) |
0c26f463 | 354 | |
fee34a28 | 355 | (defun previous-button (pos &optional count-current) |
0c26f463 | 356 | "Return the Nth button before position POS in the current buffer. |
0c26f463 | 357 | If COUNT-CURRENT is non-nil, count any button at POS in the search, |
fee34a28 MB |
358 | instead of starting at the next button." |
359 | (unless count-current | |
360 | (setq pos (previous-single-char-property-change pos 'button))) | |
361 | (and (> pos (point-min)) | |
362 | (or (button-at (1- pos)) | |
363 | ;; We must have originally been on a button, and are now in | |
364 | ;; the inter-button space. Recurse to find a button. | |
365 | (previous-button pos)))) | |
0c26f463 MB |
366 | |
367 | \f | |
368 | ;; User commands | |
369 | ||
d6bc0bdc | 370 | (defun push-button (&optional pos use-mouse-action) |
0c26f463 MB |
371 | "Perform the action specified by a button at location POS. |
372 | POS may be either a buffer position or a mouse-event. | |
d6bc0bdc MB |
373 | If USE-MOUSE-ACTION is non-nil, invoke the button's mouse-action |
374 | instead of its normal action; if the button has no mouse-action, | |
375 | the normal action is used instead. | |
0c26f463 MB |
376 | POS defaults to point, except when `push-button' is invoked |
377 | interactively as the result of a mouse-event, in which case, the | |
378 | mouse event is used. | |
379 | If there's no button at POS, do nothing and return nil, otherwise | |
380 | return t." | |
381 | (interactive | |
382 | (list (if (integerp last-command-event) (point) last-command-event))) | |
383 | (if (and (not (integerp pos)) (eventp pos)) | |
384 | ;; POS is a mouse event; switch to the proper window/buffer | |
385 | (let ((posn (event-start pos))) | |
386 | (with-current-buffer (window-buffer (posn-window posn)) | |
d6bc0bdc | 387 | (push-button (posn-point posn) t))) |
0c26f463 MB |
388 | ;; POS is just normal position |
389 | (let ((button (button-at (or pos (point))))) | |
390 | (if (not button) | |
391 | nil | |
d6bc0bdc | 392 | (button-activate button use-mouse-action) |
0c26f463 MB |
393 | t)))) |
394 | ||
395 | (defun forward-button (n &optional wrap display-message) | |
396 | "Move to the Nth next button, or Nth previous button if N is negative. | |
fee34a28 | 397 | If N is 0, move to the start of any button at point. |
0c26f463 MB |
398 | If WRAP is non-nil, moving past either end of the buffer continues from the |
399 | other end. | |
400 | If DISPLAY-MESSAGE is non-nil, the button's help-echo string is displayed. | |
fee34a28 | 401 | Any button with a non-nil `skip' property is skipped over. |
0c26f463 MB |
402 | Returns the button found." |
403 | (interactive "p\nd\nd") | |
fee34a28 MB |
404 | (let (button) |
405 | (if (zerop n) | |
406 | ;; Move to start of current button | |
407 | (if (setq button (button-at (point))) | |
408 | (goto-char (button-start button))) | |
409 | ;; Move to Nth next button | |
410 | (let ((iterator (if (> n 0) #'next-button #'previous-button)) | |
411 | (wrap-start (if (> n 0) (point-min) (point-max)))) | |
412 | (setq n (abs n)) | |
413 | (setq button t) ; just to start the loop | |
414 | (while (and (> n 0) button) | |
415 | (setq button (funcall iterator (point))) | |
416 | (when (and (not button) wrap) | |
417 | (setq button (funcall iterator wrap-start t))) | |
418 | (when button | |
419 | (goto-char (button-start button)) | |
420 | (unless (button-get button 'skip) | |
421 | (setq n (1- n))))))) | |
0c26f463 MB |
422 | (if (null button) |
423 | (error (if wrap "No buttons!" "No more buttons")) | |
0c26f463 MB |
424 | (let ((msg (and display-message (button-get button 'help-echo)))) |
425 | (when msg | |
426 | (message "%s" msg))) | |
427 | button))) | |
428 | ||
429 | (defun backward-button (n &optional wrap display-message) | |
430 | "Move to the Nth previous button, or Nth next button if N is negative. | |
fee34a28 | 431 | If N is 0, move to the start of any button at point. |
0c26f463 MB |
432 | If WRAP is non-nil, moving past either end of the buffer continues from the |
433 | other end. | |
434 | If DISPLAY-MESSAGE is non-nil, the button's help-echo string is displayed. | |
fee34a28 | 435 | Any button with a non-nil `skip' property is skipped over. |
0c26f463 MB |
436 | Returns the button found." |
437 | (interactive "p\nd\nd") | |
438 | (forward-button (- n) wrap display-message)) | |
439 | ||
440 | ||
441 | (provide 'button) | |
442 | ||
443 | ;;; button.el ends here |