;;; button.el --- clickable buttons
;;
;; Copyright (C) 2001, 2002, 2003, 2004, 2005,
-;; 2006, 2007 Free Software Foundation, Inc.
+;; 2006, 2007, 2008 Free Software Foundation, Inc.
;;
;; Author: Miles Bader <miles@gnu.org>
;; Keywords: extensions
;;
;; This file is part of GNU Emacs.
;;
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 2, or (at your option)
-;; any later version.
-;;
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
-;;
+
;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING. If not, write to the
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;;
;; Globals
;; Use color for the MS-DOS port because it doesn't support underline.
+;; FIXME if MS-DOS correctly answers the (supports) question, it need
+;; no longer be a special case.
(defface button '((((type pc) (class color))
(:foreground "lightblue"))
- (t :underline t))
+ (((supports :underline t)) :underline t)
+ (t (:foreground "lightblue")))
"Default face used for buttons."
:group 'basic-faces)
-;;;###autoload
(defvar button-map
(let ((map (make-sparse-keymap)))
- (define-key map "\r" 'push-button)
+ ;; The following definition needs to avoid using escape sequences that
+ ;; might get converted to ^M when building loaddefs.el
+ (define-key map [(control ?m)] 'push-button)
(define-key map [mouse-2] 'push-button)
map)
"Keymap used by buttons.")
-;;;###autoload
(defvar button-buffer-map
(let ((map (make-sparse-keymap)))
(define-key map [?\t] 'forward-button)
;; Prevent insertions adjacent to the text-property buttons from
;; inheriting its properties.
(put 'default-button 'rear-nonsticky t)
-;; Text property buttons don't have a `button' property of their own, so
-;; they inherit this.
-(put 'default-button 'button t)
;; A `category-symbol' property for the default button type
(put 'button 'button-category-symbol 'default-button)
(or (get type 'button-category-symbol)
(error "Unknown button type `%s'" type)))
-;;;###autoload
(defun define-button-type (name &rest properties)
- "Define a `button type' called NAME.
+ "Define a `button type' called NAME (a symbol).
The remaining arguments form a sequence of PROPERTY VALUE pairs,
specifying properties to use as defaults for buttons with this type
\(a button's type may be set by giving it a `type' property when
\f
;; Creating overlay buttons
-;;;###autoload
(defun make-button (beg end &rest properties)
"Make a button from BEG to END in the current buffer.
The remaining arguments form a sequence of PROPERTY VALUE pairs,
;; OVERLAY is the button, so return it
overlay))
-;;;###autoload
(defun insert-button (label &rest properties)
"Insert a button with the label LABEL.
The remaining arguments form a sequence of PROPERTY VALUE pairs,
\f
;; Creating text-property buttons
-;;;###autoload
(defun make-text-button (beg end &rest properties)
"Make a button from BEG to END in the current buffer.
The remaining arguments form a sequence of PROPERTY VALUE pairs,
large numbers of buttons can also be somewhat faster using
`make-text-button'.
+BEG can also be a string, in which case it is made into a button.
+
Also see `insert-text-button'."
- (let ((type-entry
+ (let ((object nil)
+ (type-entry
(or (plist-member properties 'type)
(plist-member properties :type))))
+ (when (stringp beg)
+ (setq object beg beg 0 end (length object)))
;; Disallow setting the `category' property directly.
(when (plist-get properties 'category)
(error "Button `category' property may not be set directly"))
;; text-properties for inheritance.
(setcar type-entry 'category)
(setcar (cdr type-entry)
- (button-category-symbol (car (cdr type-entry))))))
- ;; Now add all the text properties at once
- (add-text-properties beg end properties)
- ;; Return something that can be used to get at the button.
- beg)
+ (button-category-symbol (car (cdr type-entry)))))
+ ;; Now add all the text properties at once
+ (add-text-properties beg end
+ ;; Each button should have a non-eq `button'
+ ;; property so that next-single-property-change can
+ ;; detect boundaries reliably.
+ (cons 'button (cons (list t) properties))
+ object)
+ ;; Return something that can be used to get at the button.
+ beg))
-;;;###autoload
(defun insert-text-button (label &rest properties)
"Insert a button with the label LABEL.
The remaining arguments form a sequence of PROPERTY VALUE pairs,
(next-button pos))))
(defun previous-button (pos &optional count-current)
- "Return the Nth button before position POS in the current buffer.
+ "Return the previous button before position POS in the current buffer.
If COUNT-CURRENT is non-nil, count any button at POS in the search,
instead of starting at the next button."
- (unless count-current
- (setq pos (previous-single-char-property-change pos 'button)))
- (and (> pos (point-min))
- (or (button-at (1- pos))
- ;; We must have originally been on a button, and are now in
- ;; the inter-button space. Recurse to find a button.
- (previous-button pos))))
+ (let ((button (button-at pos)))
+ (if button
+ (if count-current
+ button
+ ;; We started out on a button, so move to its start and look
+ ;; for the previous button boundary.
+ (setq pos (previous-single-char-property-change
+ (button-start button) 'button))
+ (let ((new-button (button-at pos)))
+ (if new-button
+ ;; We are in a button again; this can happen if there
+ ;; are adjacent buttons (or at bob).
+ (unless (= pos (button-start button)) new-button)
+ ;; We are now in the space between buttons.
+ (previous-button pos))))
+ ;; We started out in the space between buttons.
+ (setq pos (previous-single-char-property-change pos 'button))
+ (or (button-at pos)
+ (and (> pos (point-min))
+ (button-at (1- pos)))))))
\f
;; User commands
(goto-char (button-start button)))
;; Move to Nth next button
(let ((iterator (if (> n 0) #'next-button #'previous-button))
- (wrap-start (if (> n 0) (point-min) (point-max))))
+ (wrap-start (if (> n 0) (point-min) (point-max)))
+ opoint fail)
(setq n (abs n))
(setq button t) ; just to start the loop
- (while (and (> n 0) button)
+ (while (and (null fail) (> n 0) button)
(setq button (funcall iterator (point)))
(when (and (not button) wrap)
(setq button (funcall iterator wrap-start t)))
(when button
(goto-char (button-start button))
+ ;; Avoid looping forever (e.g., if all the buttons have
+ ;; the `skip' property).
+ (cond ((null opoint)
+ (setq opoint (point)))
+ ((= opoint (point))
+ (setq fail t)))
(unless (button-get button 'skip)
(setq n (1- n)))))))
(if (null button)
(provide 'button)
-;;; arch-tag: 5f2c7627-413b-4097-b282-630f89d9c5e9
+;; arch-tag: 5f2c7627-413b-4097-b282-630f89d9c5e9
;;; button.el ends here