mirrored from git://git.sv.gnu.org/emacs.git
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
Copy pathwid-browse.el
243 lines (199 loc) · 7.27 KB
/
wid-browse.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
;;; wid-browse.el --- functions for browsing widgets -*- lexical-binding: t -*-
;; Copyright (C) 1997-2025 Free Software Foundation, Inc.
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
;; Keywords: extensions
;; Package: emacs
;; This file is part of GNU Emacs.
;; 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 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. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; Widget browser. See `widget.el'.
;;; Code:
(require 'wid-edit)
(defgroup widget-browse nil
"Customization support for browsing widgets."
:group 'widgets)
;;; The Mode.
(defvar-keymap widget-browse-mode-map
:doc "Keymap for `widget-browse-mode'."
:parent widget-keymap
"q" #'bury-buffer)
(easy-menu-define widget-browse-mode-customize-menu
widget-browse-mode-map
"Menu used in widget browser buffers."
(customize-menu-create 'widgets))
(easy-menu-define widget-browse-mode-menu
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 run after entering `widget-browse-mode'."
:type 'hook)
(define-derived-mode widget-browse-mode special-mode "Widget Browse"
"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.")
(put 'widget-browse-mode 'mode-class 'special)
;;; Commands.
;;;###autoload
(defun widget-browse-at (pos)
"Browse the widget under point."
(interactive "d")
(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)))
(button (get-char-property pos 'button))
(doc (get-char-property pos 'widget-doc))
(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)
;;;###autoload
(defun widget-browse (widget)
"Create a widget browser for WIDGET."
(interactive (list (completing-read "Widget: "
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)))
(error "Not a widget"))
;; 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)
;; 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)))
;;;###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)))
;;; The `widget-browse' Widget.
(define-widget 'widget-browse 'push-button
"Button for creating a widget browser.
The :value of the widget should be the widget to be browsed."
:format "%[[%v]%]"
:value-create 'widget-browse-value-create
:action 'widget-browse-action)
(defun widget-browse-action (widget &optional _event)
"Create widget browser for :value of WIDGET."
(widget-browse (widget-get widget :value)))
(defun widget-browse-value-create (widget)
"Insert type name for WIDGET."
(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.
(defun widget-browse-widget (_widget _key value)
"Insert description of WIDGET's KEY VALUE.
VALUE is assumed to be a widget."
(widget-create 'widget-browse value))
(defun widget-browse-widgets (_widget _key value)
"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 " "))))
(defun widget-browse-sexp (_widget _key value)
"Insert description of WIDGET's KEY VALUE.
Nothing is assumed about value."
(require 'pp)
(declare-function pp-insert-short-sexp "pp" (sexp &optional width))
(widget--allow-insertion
(pp-insert-short-sexp value)))
(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)
;;; Widget Minor Mode.
(defvar-keymap widget-minor-mode-map
:doc "Keymap used in Widget Minor Mode."
:parent widget-keymap)
;;;###autoload
(define-minor-mode widget-minor-mode
"Minor mode for traversing widgets."
:lighter " Widget")
(provide 'wid-browse)
;;; wid-browse.el ends here