wid-browse.el 8.32 KB
Newer Older
1
;;; wid-browse.el --- functions for browsing widgets
Per Abrahamsen's avatar
Per Abrahamsen committed
2
;;
Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1997, 2001-2020 Free Software Foundation, Inc.
Per Abrahamsen's avatar
Per Abrahamsen committed
4 5 6
;;
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
;; Keywords: extensions
7
;; Package: emacs
Per Abrahamsen's avatar
Per Abrahamsen committed
8

Per Abrahamsen's avatar
Per Abrahamsen committed
9 10
;; This file is part of GNU Emacs.

11
;; GNU Emacs is free software: you can redistribute it and/or modify
Per Abrahamsen's avatar
Per Abrahamsen committed
12
;; it under the terms of the GNU General Public License as published by
13 14
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Per Abrahamsen's avatar
Per Abrahamsen committed
15 16 17 18 19 20 21

;; 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
22
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
Per Abrahamsen's avatar
Per Abrahamsen committed
23

Per Abrahamsen's avatar
Per Abrahamsen committed
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
;;; Commentary:
;;
;; Widget browser.  See `widget.el'.

;;; Code:

(require 'easymenu)
(require 'custom)
(require 'wid-edit)

(defgroup widget-browse nil
  "Customization support for browsing widgets."
  :group 'widgets)

;;; The Mode.

40 41 42 43 44
(defvar widget-browse-mode-map
  (let ((map (make-sparse-keymap)))
    (set-keymap-parent map widget-keymap)
    (define-key map "q" 'bury-buffer)
    map)
Per Abrahamsen's avatar
Per Abrahamsen committed
45
  "Keymap for `widget-browse-mode'.")
46 47

(easy-menu-define widget-browse-mode-customize-menu
Per Abrahamsen's avatar
Per Abrahamsen committed
48 49 50
    widget-browse-mode-map
  "Menu used in widget browser buffers."
  (customize-menu-create 'widgets))
Per Abrahamsen's avatar
Per Abrahamsen committed
51

52
(easy-menu-define widget-browse-mode-menu
Per Abrahamsen's avatar
Per Abrahamsen committed
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
    widget-browse-mode-map
  "Menu used in widget browser buffers."
  '("Widget"
    ["Browse" widget-browse t]
    ["Browse At" widget-browse-at t]))

(defcustom widget-browse-mode-hook nil
  "Hook called when entering widget-browse-mode."
  :type 'hook
  :group 'widget-browse)

(defun widget-browse-mode ()
  "Major mode for widget browser buffers.

The following commands are available:

\\[widget-forward]		Move to next button or editable field.
\\[widget-backward]		Move to previous button or editable field.
\\[widget-button-click]		Activate button under the mouse pointer.
\\[widget-button-press]		Activate button under point.

Entry to this mode calls the value of `widget-browse-mode-hook'
if that value is non-nil."
  (kill-all-local-variables)
  (setq major-mode 'widget-browse-mode
	mode-name "Widget")
  (use-local-map widget-browse-mode-map)
Per Abrahamsen's avatar
Per Abrahamsen committed
80
  (easy-menu-add widget-browse-mode-customize-menu)
Per Abrahamsen's avatar
Per Abrahamsen committed
81
  (easy-menu-add widget-browse-mode-menu)
82
  (run-mode-hooks 'widget-browse-mode-hook))
Per Abrahamsen's avatar
Per Abrahamsen committed
83

84 85
(put 'widget-browse-mode 'mode-class 'special)

Per Abrahamsen's avatar
Per Abrahamsen committed
86 87 88 89 90 91
;;; Commands.

;;;###autoload
(defun widget-browse-at (pos)
  "Browse the widget under point."
  (interactive "d")
92 93 94 95 96
  (let* ((field (or
                 ;; See comments in `widget-specify-field' to know why we
                 ;; need this.
                 (get-char-property pos 'real-field)
                 (get-char-property pos 'field)))
Per Abrahamsen's avatar
Per Abrahamsen committed
97 98
	 (button (get-char-property pos 'button))
	 (doc (get-char-property pos 'widget-doc))
Per Abrahamsen's avatar
Per Abrahamsen committed
99 100 101 102 103 104 105 106 107 108 109
	 (text (cond (field "This is an editable text area.")
		     (button "This is an active area.")
		     (doc "This is documentation text.")
		     (t "This is unidentified text.")))
	 (widget (or field button doc)))
    (when widget
      (widget-browse widget))
    (message text)))

(defvar widget-browse-history nil)

Per Abrahamsen's avatar
Per Abrahamsen committed
110
;;;###autoload
Per Abrahamsen's avatar
Per Abrahamsen committed
111 112
(defun widget-browse (widget)
  "Create a widget browser for WIDGET."
113
  (interactive (list (completing-read "Widget: "
Per Abrahamsen's avatar
Per Abrahamsen committed
114 115 116 117 118 119 120 121 122 123
				      obarray
				      (lambda (symbol)
					(get symbol 'widget-type))
				      t nil 'widget-browse-history)))
  (if (stringp widget)
      (setq widget (intern widget)))
  (unless (if (symbolp widget)
	      (get widget 'widget-type)
	    (and (consp widget)
		 (get (widget-type widget) 'widget-type)))
124
    (error "Not a widget"))
Per Abrahamsen's avatar
Per Abrahamsen committed
125 126 127 128 129 130 131 132
  ;; Create the buffer.
  (if (symbolp widget)
      (let ((buffer (format "*Browse %s Widget*" widget)))
	(kill-buffer (get-buffer-create buffer))
	(switch-to-buffer (get-buffer-create buffer)))
    (kill-buffer (get-buffer-create "*Browse Widget*"))
    (switch-to-buffer (get-buffer-create "*Browse Widget*")))
  (widget-browse-mode)
133

Per Abrahamsen's avatar
Per Abrahamsen committed
134
  ;; Quick way to get out.
Per Abrahamsen's avatar
Per Abrahamsen committed
135 136 137 138 139
;;  (widget-create 'push-button
;;		 :action (lambda (widget &optional event)
;;			   (bury-buffer))
;;		 "Quit")
;;  (widget-insert "\n")
Per Abrahamsen's avatar
Per Abrahamsen committed
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173

  ;; Top text indicating whether it is a class or object browser.
  (if (listp widget)
      (widget-insert "Widget object browser.\n\nClass: ")
    (widget-insert "Widget class browser.\n\n")
    (widget-create 'widget-browse
		   :format "%[%v%]\n%d"
		   :doc (get widget 'widget-documentation)
		   widget)
    (unless (eq (preceding-char) ?\n)
      (widget-insert "\n"))
    (widget-insert "\nSuper: ")
    (setq widget (get widget 'widget-type)))

  ;; Now show the attributes.
  (let ((name (car widget))
	(items (cdr widget))
	key value printer)
    (widget-create 'widget-browse
		   :format "%[%v%]"
		   name)
    (widget-insert "\n")
    (while items
      (setq key (nth 0 items)
	    value (nth 1 items)
	    printer (or (get key 'widget-keyword-printer)
			'widget-browse-sexp)
	    items (cdr (cdr items)))
      (widget-insert "\n" (symbol-name key) "\n\t")
      (funcall printer widget key value)
      (widget-insert "\n")))
  (widget-setup)
  (goto-char (point-min)))

Per Abrahamsen's avatar
Per Abrahamsen committed
174 175 176 177 178 179 180 181 182 183 184 185
;;;###autoload
(defun widget-browse-other-window (&optional widget)
  "Show widget browser for WIDGET in other window."
  (interactive)
  (let ((window (selected-window)))
    (switch-to-buffer-other-window "*Browse Widget*")
    (if widget
	(widget-browse widget)
      (call-interactively 'widget-browse))
    (select-window window)))


Per Abrahamsen's avatar
Per Abrahamsen committed
186 187 188 189 190 191 192 193 194
;;; The `widget-browse' Widget.

(define-widget 'widget-browse 'push-button
  "Button for creating a widget browser.
The :value of the widget shuld be the widget to be browsed."
  :format "%[[%v]%]"
  :value-create 'widget-browse-value-create
  :action 'widget-browse-action)

195
(defun widget-browse-action (widget &optional _event)
196
  ;; Create widget browser for WIDGET's :value.
Per Abrahamsen's avatar
Per Abrahamsen committed
197 198 199 200 201 202 203 204 205 206 207 208 209 210
  (widget-browse (widget-get widget :value)))

(defun widget-browse-value-create (widget)
  ;; Insert type name.
  (let ((value (widget-get widget :value)))
    (cond ((symbolp value)
	   (insert (symbol-name value)))
	  ((consp value)
	   (insert (symbol-name (widget-type value))))
	  (t
	   (insert "strange")))))

;;; Keyword Printer Functions.

211
(defun widget-browse-widget (_widget _key value)
Per Abrahamsen's avatar
Per Abrahamsen committed
212 213 214 215
  "Insert description of WIDGET's KEY VALUE.
VALUE is assumed to be a widget."
  (widget-create 'widget-browse value))

216
(defun widget-browse-widgets (_widget _key value)
Per Abrahamsen's avatar
Per Abrahamsen committed
217 218 219 220 221 222 223 224 225
  "Insert description of WIDGET's KEY VALUE.
VALUE is assumed to be a list of widgets."
  (while value
    (widget-create 'widget-browse
		   (car value))
    (setq value (cdr value))
    (when value
      (widget-insert " "))))

226
(defun widget-browse-sexp (_widget _key value)
Per Abrahamsen's avatar
Per Abrahamsen committed
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
  "Insert description of WIDGET's KEY VALUE.
Nothing is assumed about value."
  (let ((pp (condition-case signal
		(pp-to-string value)
	      (error (prin1-to-string signal)))))
    (when (string-match "\n\\'" pp)
      (setq pp (substring pp 0 (1- (length pp)))))
    (if (cond ((string-match "\n" pp)
	       nil)
	      ((> (length pp) (- (window-width) (current-column)))
	       nil)
	      (t t))
	(widget-insert pp)
      (widget-create 'push-button
		     :tag "show"
242
		     :action (lambda (widget &optional _event)
Per Abrahamsen's avatar
Per Abrahamsen committed
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
			       (with-output-to-temp-buffer
				   "*Pp Eval Output*"
				 (princ (widget-get widget :value))))
		     pp))))

(defun widget-browse-sexps (widget key value)
  "Insert description of WIDGET's KEY VALUE.
VALUE is assumed to be a list of widgets."
  (let ((target (current-column)))
    (while value
      (widget-browse-sexp widget key (car value))
      (setq value (cdr value))
      (when value
	(widget-insert "\n" (make-string target ?\ ))))))

;;; Keyword Printers.

(put :parent 'widget-keyword-printer 'widget-browse-widget)
(put :children 'widget-keyword-printer 'widget-browse-widgets)
(put :buttons 'widget-keyword-printer 'widget-browse-widgets)
(put :button 'widget-keyword-printer 'widget-browse-widget)
(put :args 'widget-keyword-printer 'widget-browse-sexps)

Per Abrahamsen's avatar
Per Abrahamsen committed
266 267
;;; Widget Minor Mode.

268 269 270 271
(defvar widget-minor-mode-map
  (let ((map (make-sparse-keymap)))
    (set-keymap-parent map widget-keymap)
    map)
Per Abrahamsen's avatar
Per Abrahamsen committed
272 273 274
  "Keymap used in Widget Minor Mode.")

;;;###autoload
275
(define-minor-mode widget-minor-mode
276
  "Minor mode for traversing widgets."
277
  :lighter " Widget")
Per Abrahamsen's avatar
Per Abrahamsen committed
278

Per Abrahamsen's avatar
Per Abrahamsen committed
279 280 281 282
;;; The End:

(provide 'wid-browse)

283
;;; wid-browse.el ends here