lisp/wid-browse.el

   1 ;;; wid-browse.el --- functions for browsing widgets
   2 ;;
   3 ;; Copyright (C) 1997, 2001, 2002, 2003, 2004, 2005,
   4 ;;   2006, 2007, 2008 Free Software Foundation, Inc.
   5 ;;
   6 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
   7 ;; Keywords: extensions
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 3, or (at your option)
  14 ;; any later version.
  15
  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.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  24 ;; Boston, MA 02110-1301, USA.
  25
  26 ;;; Commentary:
  27 ;;
  28 ;; Widget browser.  See `widget.el'.
  29
  30 ;;; Code:
  31
  32 (require 'easymenu)
  33 (require 'custom)
  34 (require 'wid-edit)
  35 (eval-when-compile (require 'cl))
  36
  37 (defgroup widget-browse nil
  38   "Customization support for browsing widgets."
  39   :group 'widgets)
  40
  41 ;;; The Mode.
  42
  43 (defvar widget-browse-mode-map
  44   (let ((map (make-sparse-keymap)))
  45     (set-keymap-parent map widget-keymap)
  46     (define-key map "q" 'bury-buffer)
  47     map)
  48   "Keymap for `widget-browse-mode'.")
  49
  50 (easy-menu-define widget-browse-mode-customize-menu
  51     widget-browse-mode-map
  52   "Menu used in widget browser buffers."
  53   (customize-menu-create 'widgets))
  54
  55 (easy-menu-define widget-browse-mode-menu
  56     widget-browse-mode-map
  57   "Menu used in widget browser buffers."
  58   '("Widget"
  59     ["Browse" widget-browse t]
  60     ["Browse At" widget-browse-at t]))
  61
  62 (defcustom widget-browse-mode-hook nil
  63   "Hook called when entering widget-browse-mode."
  64   :type 'hook
  65   :group 'widget-browse)
  66
  67 (defun widget-browse-mode ()
  68   "Major mode for widget browser buffers.
  69
  70 The following commands are available:
  71
  72 \\[widget-forward]              Move to next button or editable field.
  73 \\[widget-backward]             Move to previous button or editable field.
  74 \\[widget-button-click]         Activate button under the mouse pointer.
  75 \\[widget-button-press]         Activate button under point.
  76
  77 Entry to this mode calls the value of `widget-browse-mode-hook'
  78 if that value is non-nil."
  79   (kill-all-local-variables)
  80   (setq major-mode 'widget-browse-mode
  81         mode-name "Widget")
  82   (use-local-map widget-browse-mode-map)
  83   (easy-menu-add widget-browse-mode-customize-menu)
  84   (easy-menu-add widget-browse-mode-menu)
  85   (run-mode-hooks 'widget-browse-mode-hook))
  86
  87 (put 'widget-browse-mode 'mode-class 'special)
  88
  89 ;;; Commands.
  90
  91 ;;;###autoload
  92 (defun widget-browse-at (pos)
  93   "Browse the widget under point."
  94   (interactive "d")
  95   (let* ((field (get-char-property pos 'field))
  96          (button (get-char-property pos 'button))
  97          (doc (get-char-property pos 'widget-doc))
  98          (text (cond (field "This is an editable text area.")
  99                      (button "This is an active area.")
 100                      (doc "This is documentation text.")
 101                      (t "This is unidentified text.")))
 102          (widget (or field button doc)))
 103     (when widget
 104       (widget-browse widget))
 105     (message text)))
 106
 107 (defvar widget-browse-history nil)
 108
 109 ;;;###autoload
 110 (defun widget-browse (widget)
 111   "Create a widget browser for WIDGET."
 112   (interactive (list (completing-read "Widget: "
 113                                       obarray
 114                                       (lambda (symbol)
 115                                         (get symbol 'widget-type))
 116                                       t nil 'widget-browse-history)))
 117   (if (stringp widget)
 118       (setq widget (intern widget)))
 119   (unless (if (symbolp widget)
 120               (get widget 'widget-type)
 121             (and (consp widget)
 122                  (get (widget-type widget) 'widget-type)))
 123     (error "Not a widget"))
 124   ;; Create the buffer.
 125   (if (symbolp widget)
 126       (let ((buffer (format "*Browse %s Widget*" widget)))
 127         (kill-buffer (get-buffer-create buffer))
 128         (switch-to-buffer (get-buffer-create buffer)))
 129     (kill-buffer (get-buffer-create "*Browse Widget*"))
 130     (switch-to-buffer (get-buffer-create "*Browse Widget*")))
 131   (widget-browse-mode)
 132
 133   ;; Quick way to get out.
 134 ;;  (widget-create 'push-button
 135 ;;               :action (lambda (widget &optional event)
 136 ;;                         (bury-buffer))
 137 ;;               "Quit")
 138 ;;  (widget-insert "\n")
 139
 140   ;; Top text indicating whether it is a class or object browser.
 141   (if (listp widget)
 142       (widget-insert "Widget object browser.\n\nClass: ")
 143     (widget-insert "Widget class browser.\n\n")
 144     (widget-create 'widget-browse
 145                    :format "%[%v%]\n%d"
 146                    :doc (get widget 'widget-documentation)
 147                    widget)
 148     (unless (eq (preceding-char) ?\n)
 149       (widget-insert "\n"))
 150     (widget-insert "\nSuper: ")
 151     (setq widget (get widget 'widget-type)))
 152
 153   ;; Now show the attributes.
 154   (let ((name (car widget))
 155         (items (cdr widget))
 156         key value printer)
 157     (widget-create 'widget-browse
 158                    :format "%[%v%]"
 159                    name)
 160     (widget-insert "\n")
 161     (while items
 162       (setq key (nth 0 items)
 163             value (nth 1 items)
 164             printer (or (get key 'widget-keyword-printer)
 165                         'widget-browse-sexp)
 166             items (cdr (cdr items)))
 167       (widget-insert "\n" (symbol-name key) "\n\t")
 168       (funcall printer widget key value)
 169       (widget-insert "\n")))
 170   (widget-setup)
 171   (goto-char (point-min)))
 172
 173 ;;;###autoload
 174 (defun widget-browse-other-window (&optional widget)
 175   "Show widget browser for WIDGET in other window."
 176   (interactive)
 177   (let ((window (selected-window)))
 178     (switch-to-buffer-other-window "*Browse Widget*")
 179     (if widget
 180         (widget-browse widget)
 181       (call-interactively 'widget-browse))
 182     (select-window window)))
 183
 184
 185 ;;; The `widget-browse' Widget.
 186
 187 (define-widget 'widget-browse 'push-button
 188   "Button for creating a widget browser.
 189 The :value of the widget shuld be the widget to be browsed."
 190   :format "%[[%v]%]"
 191   :value-create 'widget-browse-value-create
 192   :action 'widget-browse-action)
 193
 194 (defun widget-browse-action (widget &optional event)
 195   ;; Create widget browser for WIDGET's :value.
 196   (widget-browse (widget-get widget :value)))
 197
 198 (defun widget-browse-value-create (widget)
 199   ;; Insert type name.
 200   (let ((value (widget-get widget :value)))
 201     (cond ((symbolp value)
 202            (insert (symbol-name value)))
 203           ((consp value)
 204            (insert (symbol-name (widget-type value))))
 205           (t
 206            (insert "strange")))))
 207
 208 ;;; Keyword Printer Functions.
 209
 210 (defun widget-browse-widget (widget key value)
 211   "Insert description of WIDGET's KEY VALUE.
 212 VALUE is assumed to be a widget."
 213   (widget-create 'widget-browse value))
 214
 215 (defun widget-browse-widgets (widget key value)
 216   "Insert description of WIDGET's KEY VALUE.
 217 VALUE is assumed to be a list of widgets."
 218   (while value
 219     (widget-create 'widget-browse
 220                    (car value))
 221     (setq value (cdr value))
 222     (when value
 223       (widget-insert " "))))
 224
 225 (defun widget-browse-sexp (widget key value)
 226   "Insert description of WIDGET's KEY VALUE.
 227 Nothing is assumed about value."
 228   (let ((pp (condition-case signal
 229                 (pp-to-string value)
 230               (error (prin1-to-string signal)))))
 231     (when (string-match "\n\\'" pp)
 232       (setq pp (substring pp 0 (1- (length pp)))))
 233     (if (cond ((string-match "\n" pp)
 234                nil)
 235               ((> (length pp) (- (window-width) (current-column)))
 236                nil)
 237               (t t))
 238         (widget-insert pp)
 239       (widget-create 'push-button
 240                      :tag "show"
 241                      :action (lambda (widget &optional event)
 242                                (with-output-to-temp-buffer
 243                                    "*Pp Eval Output*"
 244                                  (princ (widget-get widget :value))))
 245                      pp))))
 246
 247 (defun widget-browse-sexps (widget key value)
 248   "Insert description of WIDGET's KEY VALUE.
 249 VALUE is assumed to be a list of widgets."
 250   (let ((target (current-column)))
 251     (while value
 252       (widget-browse-sexp widget key (car value))
 253       (setq value (cdr value))
 254       (when value
 255         (widget-insert "\n" (make-string target ?\ ))))))
 256
 257 ;;; Keyword Printers.
 258
 259 (put :parent 'widget-keyword-printer 'widget-browse-widget)
 260 (put :children 'widget-keyword-printer 'widget-browse-widgets)
 261 (put :buttons 'widget-keyword-printer 'widget-browse-widgets)
 262 (put :button 'widget-keyword-printer 'widget-browse-widget)
 263 (put :args 'widget-keyword-printer 'widget-browse-sexps)
 264
 265 ;;; Widget Minor Mode.
 266
 267 (defvar widget-minor-mode-map
 268   (let ((map (make-sparse-keymap)))
 269     (set-keymap-parent map widget-keymap)
 270     map)
 271   "Keymap used in Widget Minor Mode.")
 272
 273 ;;;###autoload
 274 (define-minor-mode widget-minor-mode
 275   "Togle minor mode for traversing widgets.
 276 With arg, turn widget mode on if and only if arg is positive."
 277   :lighter " Widget")
 278
 279 ;;; The End:
 280
 281 (provide 'wid-browse)
 282
 283 ;; arch-tag: d5ffb18f-8984-4735-8502-edf70456db21
 284 ;;; wid-browse.el ends here