Don't use the abbreviation "win" to refer to Windows (Bug#10421).
[emacs.git] / lisp / tmm.el
blob4bc1c9af99a072394713e43cdbc5763eabdf7d88
1 ;;; tmm.el --- text mode access to menu-bar
3 ;; Copyright (C) 1994-1996, 2000-2012 Free Software Foundation, Inc.
5 ;; Author: Ilya Zakharevich <ilya@math.mps.ohio-state.edu>
6 ;; Maintainer: FSF
7 ;; Keywords: convenience
9 ;; This file is part of GNU Emacs.
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 of the License, or
14 ;; (at your option) any later version.
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.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; This package provides text mode access to the menu bar.
28 ;;; Code:
30 (require 'electric)
32 (defgroup tmm nil
33 "Text mode access to menu-bar."
34 :prefix "tmm-"
35 :group 'menu)
37 ;;; The following will be localized, added only to pacify the compiler.
38 (defvar tmm-short-cuts)
39 (defvar tmm-old-mb-map nil)
40 (defvar tmm-c-prompt nil)
41 (defvar tmm-km-list)
42 (defvar tmm-next-shortcut-digit)
43 (defvar tmm-table-undef)
45 ;;;###autoload (define-key global-map "\M-`" 'tmm-menubar)
46 ;;;###autoload (define-key global-map [menu-bar mouse-1] 'tmm-menubar-mouse)
48 ;;;###autoload
49 (defun tmm-menubar (&optional x-position)
50 "Text-mode emulation of looking and choosing from a menubar.
51 See the documentation for `tmm-prompt'.
52 X-POSITION, if non-nil, specifies a horizontal position within the menu bar;
53 we make that menu bar item (the one at that position) the default choice."
54 (interactive)
55 (run-hooks 'menu-bar-update-hook)
56 ;; Obey menu-bar-final-items; put those items last.
57 (let ((menu-bar (tmm-get-keybind [menu-bar]))
58 menu-bar-item)
59 (let ((list menu-bar-final-items))
60 (while list
61 (let ((item (car list)))
62 ;; ITEM is the name of an item that we want to put last.
63 ;; Find it in MENU-BAR and move it to the end.
64 (let ((this-one (assq item menu-bar)))
65 (setq menu-bar (append (delq this-one menu-bar)
66 (list this-one)))))
67 (setq list (cdr list))))
68 (if x-position
69 (let ((tail menu-bar) (column 0)
70 this-one name visible)
71 (while (and tail (<= column x-position))
72 (setq this-one (car tail))
73 (if (and (consp this-one)
74 (consp (cdr this-one))
75 (setq name ;simple menu
76 (cond ((stringp (nth 1 this-one))
77 (nth 1 this-one))
78 ;extended menu
79 ((stringp (nth 2 this-one))
80 (setq visible (plist-get
81 (nthcdr 4 this-one) :visible))
82 (unless (and visible (not (eval visible)))
83 (nth 2 this-one))))))
84 (setq column (+ column (length name) 1)))
85 (setq tail (cdr tail)))
86 (setq menu-bar-item (car this-one))))
87 (tmm-prompt menu-bar nil menu-bar-item)))
89 ;;;###autoload
90 (defun tmm-menubar-mouse (event)
91 "Text-mode emulation of looking and choosing from a menubar.
92 This command is used when you click the mouse in the menubar
93 on a console which has no window system but does have a mouse.
94 See the documentation for `tmm-prompt'."
95 (interactive "e")
96 (tmm-menubar (car (posn-x-y (event-start event)))))
98 (defcustom tmm-mid-prompt "==>"
99 "String to insert between shortcut and menu item.
100 If nil, there will be no shortcuts. It should not consist only of spaces,
101 or else the correct item might not be found in the `*Completions*' buffer."
102 :type 'string
103 :group 'tmm)
105 (defvar tmm-mb-map nil
106 "A place to store minibuffer map.")
108 (defcustom tmm-completion-prompt
109 "Press PageUp key to reach this buffer from the minibuffer.
110 Alternatively, you can use Up/Down keys (or your History keys) to change
111 the item in the minibuffer, and press RET when you are done, or press the
112 marked letters to pick up your choice. Type C-g or ESC ESC ESC to cancel.
114 "Help text to insert on the top of the completion buffer.
115 To save space, you can set this to nil,
116 in which case the standard introduction text is deleted too."
117 :type '(choice string (const nil))
118 :group 'tmm)
120 (defcustom tmm-shortcut-style '(downcase upcase)
121 "What letters to use as menu shortcuts.
122 Must be either one of the symbols `downcase' or `upcase',
123 or else a list of the two in the order you prefer."
124 :type '(choice (const downcase)
125 (const upcase)
126 (repeat (choice (const downcase) (const upcase))))
127 :group 'tmm)
129 (defcustom tmm-shortcut-words 2
130 "How many successive words to try for shortcuts, nil means all.
131 If you use only one of `downcase' or `upcase' for `tmm-shortcut-style',
132 specify nil for this variable."
133 :type '(choice integer (const nil))
134 :group 'tmm)
136 (defface tmm-inactive
137 '((t :inherit shadow))
138 "Face used for inactive menu items."
139 :group 'tmm)
141 ;;;###autoload
142 (defun tmm-prompt (menu &optional in-popup default-item)
143 "Text-mode emulation of calling the bindings in keymap.
144 Creates a text-mode menu of possible choices. You can access the elements
145 in the menu in two ways:
146 *) via history mechanism from minibuffer;
147 *) Or via completion-buffer that is automatically shown.
148 The last alternative is currently a hack, you cannot use mouse reliably.
150 MENU is like the MENU argument to `x-popup-menu': either a
151 keymap or an alist of alists.
152 DEFAULT-ITEM, if non-nil, specifies an initial default choice.
153 Its value should be an event that has a binding in MENU."
154 ;; If the optional argument IN-POPUP is t,
155 ;; then MENU is an alist of elements of the form (STRING . VALUE).
156 ;; That is used for recursive calls only.
157 (let ((gl-str "Menu bar") ;; The menu bar itself is not a menu keymap
158 ; so it doesn't have a name.
159 tmm-km-list out history history-len tmm-table-undef tmm-c-prompt
160 tmm-old-mb-map tmm-short-cuts
161 chosen-string choice
162 (not-menu (not (keymapp menu))))
163 (run-hooks 'activate-menubar-hook)
164 ;; Compute tmm-km-list from MENU.
165 ;; tmm-km-list is an alist of (STRING . MEANING).
166 ;; It has no other elements.
167 ;; The order of elements in tmm-km-list is the order of the menu bar.
168 (dolist (elt menu)
169 (cond
170 ((stringp elt) (setq gl-str elt))
171 ((listp elt) (tmm-get-keymap elt not-menu))
172 ((vectorp elt)
173 (dotimes (i (length elt))
174 (tmm-get-keymap (cons i (aref elt i)) not-menu)))))
175 ;; Choose an element of tmm-km-list; put it in choice.
176 (if (and not-menu (= 1 (length tmm-km-list)))
177 ;; If this is the top-level of an x-popup-menu menu,
178 ;; and there is just one pane, choose that one silently.
179 ;; This way we only ask the user one question,
180 ;; for which element of that pane.
181 (setq choice (cdr (car tmm-km-list)))
182 (unless tmm-km-list
183 (error "Empty menu reached"))
184 (and tmm-km-list
185 (let ((index-of-default 0))
186 (if tmm-mid-prompt
187 (setq tmm-km-list (tmm-add-shortcuts tmm-km-list))
189 ;; Find the default item's index within the menu bar.
190 ;; We use this to decide the initial minibuffer contents
191 ;; and initial history position.
192 (if default-item
193 (let ((tail menu) visible)
194 (while (and tail
195 (not (eq (car-safe (car tail)) default-item)))
196 ;; Be careful to count only the elements of MENU
197 ;; that actually constitute menu bar items.
198 (if (and (consp (car tail))
199 (or (stringp (car-safe (cdr (car tail))))
200 (and
201 (eq (car-safe (cdr (car tail))) 'menu-item)
202 (progn
203 (setq visible
204 (plist-get
205 (nthcdr 4 (car tail)) :visible))
206 (or (not visible) (eval visible))))))
207 (setq index-of-default (1+ index-of-default)))
208 (setq tail (cdr tail)))))
209 (let ((prompt (concat "^." (regexp-quote tmm-mid-prompt))))
210 (setq history
211 (reverse (delq nil
212 (mapcar
213 (lambda (elt)
214 (if (string-match prompt (car elt))
215 (car elt)))
216 tmm-km-list)))))
217 (setq history-len (length history))
218 (setq history (append history history history history))
219 (setq tmm-c-prompt (nth (- history-len 1 index-of-default) history))
220 (setq out
221 (if default-item
222 (car (nth index-of-default tmm-km-list))
223 (minibuffer-with-setup-hook #'tmm-add-prompt
224 (completing-read
225 (concat gl-str
226 " (up/down to change, PgUp to menu): ")
227 tmm-km-list nil t nil
228 (cons 'history
229 (- (* 2 history-len) index-of-default))))))))
230 (setq choice (cdr (assoc out tmm-km-list)))
231 (and (null choice)
232 (string-prefix-p tmm-c-prompt out)
233 (setq out (substring out (length tmm-c-prompt))
234 choice (cdr (assoc out tmm-km-list))))
235 (and (null choice) out
236 (setq out (try-completion out tmm-km-list)
237 choice (cdr (assoc out tmm-km-list)))))
238 ;; CHOICE is now (STRING . MEANING). Separate the two parts.
239 (setq chosen-string (car choice))
240 (setq choice (cdr choice))
241 (cond (in-popup
242 ;; We just did the inner level of a -popup menu.
243 choice)
244 ;; We just did the outer level. Do the inner level now.
245 (not-menu (tmm-prompt choice t))
246 ;; We just handled a menu keymap and found another keymap.
247 ((keymapp choice)
248 (if (symbolp choice)
249 (setq choice (indirect-function choice)))
250 (condition-case nil
251 (require 'mouse)
252 (error nil))
253 (tmm-prompt choice))
254 ;; We just handled a menu keymap and found a command.
255 (choice
256 (if chosen-string
257 (progn
258 (setq last-command-event chosen-string)
259 (call-interactively choice))
260 choice)))))
262 (defun tmm-add-shortcuts (list)
263 "Add shortcuts to cars of elements of the list.
264 Takes a list of lists with a string as car, returns list with
265 shortcuts added to these cars.
266 Stores a list of all the shortcuts in the free variable `tmm-short-cuts'."
267 (let ((tmm-next-shortcut-digit ?0))
268 (mapcar 'tmm-add-one-shortcut (reverse list))))
270 (defsubst tmm-add-one-shortcut (elt)
271 ;; uses the free vars tmm-next-shortcut-digit and tmm-short-cuts
272 (cond
273 ((eq (cddr elt) 'ignore)
274 (cons (concat " " (make-string (length tmm-mid-prompt) ?\-)
275 (car elt))
276 (cdr elt)))
278 (let* ((str (car elt))
279 (paren (string-match "(" str))
280 (pos 0) (word 0) char)
281 (catch 'done ; ??? is this slow?
282 (while (and (or (not tmm-shortcut-words) ; no limit on words
283 (< word tmm-shortcut-words)) ; try n words
284 (setq pos (string-match "\\w+" str pos)) ; get next word
285 (not (and paren (> pos paren)))) ; don't go past "(binding.."
286 (if (or (= pos 0)
287 (/= (aref str (1- pos)) ?.)) ; avoid file extensions
288 (let ((shortcut-style
289 (if (listp tmm-shortcut-style) ; convert to list
290 tmm-shortcut-style
291 (list tmm-shortcut-style))))
292 (while shortcut-style ; try upcase and downcase variants
293 (setq char (funcall (car shortcut-style) (aref str pos)))
294 (if (not (memq char tmm-short-cuts)) (throw 'done char))
295 (setq shortcut-style (cdr shortcut-style)))))
296 (setq word (1+ word))
297 (setq pos (match-end 0)))
298 (while (<= tmm-next-shortcut-digit ?9) ; no letter shortcut, pick a digit
299 (setq char tmm-next-shortcut-digit)
300 (setq tmm-next-shortcut-digit (1+ tmm-next-shortcut-digit))
301 (if (not (memq char tmm-short-cuts)) (throw 'done char)))
302 (setq char nil))
303 (if char (setq tmm-short-cuts (cons char tmm-short-cuts)))
304 (cons (concat (if char (concat (char-to-string char) tmm-mid-prompt)
305 ;; keep them lined up in columns
306 (make-string (1+ (length tmm-mid-prompt)) ?\s))
307 str)
308 (cdr elt))))))
310 ;; This returns the old map.
311 (defun tmm-define-keys (minibuffer)
312 (let ((map (make-sparse-keymap)))
313 (suppress-keymap map t)
314 (dolist (c tmm-short-cuts)
315 (if (listp tmm-shortcut-style)
316 (define-key map (char-to-string c) 'tmm-shortcut)
317 ;; only one kind of letters are shortcuts, so map both upcase and
318 ;; downcase input to the same
319 (define-key map (char-to-string (downcase c)) 'tmm-shortcut)
320 (define-key map (char-to-string (upcase c)) 'tmm-shortcut)))
321 (if minibuffer
322 (progn
323 (define-key map [pageup] 'tmm-goto-completions)
324 (define-key map [prior] 'tmm-goto-completions)
325 (define-key map "\ev" 'tmm-goto-completions)
326 (define-key map "\C-n" 'next-history-element)
327 (define-key map "\C-p" 'previous-history-element)))
328 (prog1 (current-local-map)
329 (use-local-map (append map (current-local-map))))))
331 (defun tmm-completion-delete-prompt ()
332 (with-current-buffer standard-output
333 (goto-char (point-min))
334 (delete-region (point) (search-forward "Possible completions are:\n"))))
336 (defun tmm-remove-inactive-mouse-face ()
337 "Remove the mouse-face property from inactive menu items."
338 (let ((inhibit-read-only t)
339 (inactive-string
340 (concat " " (make-string (length tmm-mid-prompt) ?\-)))
341 next)
342 (save-excursion
343 (goto-char (point-min))
344 (while (not (eobp))
345 (setq next (next-single-char-property-change (point) 'mouse-face))
346 (when (looking-at inactive-string)
347 (remove-text-properties (point) next '(mouse-face))
348 (add-text-properties (point) next '(face tmm-inactive)))
349 (goto-char next)))
350 (set-buffer-modified-p nil)))
352 (defun tmm-add-prompt ()
353 (unless tmm-c-prompt
354 (error "No active menu entries"))
355 (setq tmm-old-mb-map (tmm-define-keys t))
356 ;; Get window and hide it for electric mode to get correct size
357 (or tmm-completion-prompt
358 (add-hook 'completion-setup-hook
359 'tmm-completion-delete-prompt 'append))
360 (unwind-protect
361 (minibuffer-completion-help)
362 (remove-hook 'completion-setup-hook 'tmm-completion-delete-prompt))
363 (with-current-buffer "*Completions*"
364 (tmm-remove-inactive-mouse-face)
365 (when tmm-completion-prompt
366 (let ((inhibit-read-only t))
367 (goto-char (point-min))
368 (insert tmm-completion-prompt))))
369 (insert tmm-c-prompt))
371 (defun tmm-shortcut ()
372 "Choose the shortcut that the user typed."
373 (interactive)
374 (let ((c last-command-event) s)
375 (if (symbolp tmm-shortcut-style)
376 (setq c (funcall tmm-shortcut-style c)))
377 (if (memq c tmm-short-cuts)
378 (if (equal (buffer-name) "*Completions*")
379 (progn
380 (goto-char (point-min))
381 (re-search-forward
382 (concat "\\(^\\|[ \t]\\)" (char-to-string c) tmm-mid-prompt))
383 (choose-completion))
384 ;; In minibuffer
385 (delete-region (minibuffer-prompt-end) (point-max))
386 (dolist (elt tmm-km-list)
387 (if (string=
388 (substring (car elt) 0
389 (min (1+ (length tmm-mid-prompt))
390 (length (car elt))))
391 (concat (char-to-string c) tmm-mid-prompt))
392 (setq s (car elt))))
393 (insert s)
394 (exit-minibuffer)))))
396 (defun tmm-goto-completions ()
397 "Jump to the completions buffer."
398 (interactive)
399 (let ((prompt-end (minibuffer-prompt-end)))
400 (setq tmm-c-prompt (buffer-substring prompt-end (point-max)))
401 ;; FIXME: Why?
402 (delete-region prompt-end (point-max)))
403 (switch-to-buffer-other-window "*Completions*")
404 (search-forward tmm-c-prompt)
405 (search-backward tmm-c-prompt))
407 (defun tmm-get-keymap (elt &optional in-x-menu)
408 "Prepend (DOCSTRING EVENT BINDING) to free variable `tmm-km-list'.
409 The values are deduced from the argument ELT, that should be an
410 element of keymap, an `x-popup-menu' argument, or an element of
411 `x-popup-menu' argument (when IN-X-MENU is not-nil).
412 This function adds the element only if it is not already present.
413 It uses the free variable `tmm-table-undef' to keep undefined keys."
414 (let (km str plist filter visible enable (event (car elt)))
415 (setq elt (cdr elt))
416 (if (eq elt 'undefined)
417 (setq tmm-table-undef (cons (cons event nil) tmm-table-undef))
418 (unless (assoc event tmm-table-undef)
419 (cond ((if (listp elt)
420 (or (keymapp elt) (eq (car elt) 'lambda))
421 (and (symbolp elt) (fboundp elt)))
422 (setq km elt))
424 ((if (listp (cdr-safe elt))
425 (or (keymapp (cdr-safe elt))
426 (eq (car (cdr-safe elt)) 'lambda))
427 (and (symbolp (cdr-safe elt)) (fboundp (cdr-safe elt))))
428 (setq km (cdr elt))
429 (and (stringp (car elt)) (setq str (car elt))))
431 ((if (listp (cdr-safe (cdr-safe elt)))
432 (or (keymapp (cdr-safe (cdr-safe elt)))
433 (eq (car (cdr-safe (cdr-safe elt))) 'lambda))
434 (and (symbolp (cdr-safe (cdr-safe elt)))
435 (fboundp (cdr-safe (cdr-safe elt)))))
436 (setq km (cddr elt))
437 (and (stringp (car elt)) (setq str (car elt))))
439 ((eq (car-safe elt) 'menu-item)
440 ;; (menu-item TITLE COMMAND KEY ...)
441 (setq plist (cdr-safe (cdr-safe (cdr-safe elt))))
442 (when (consp (car-safe plist))
443 (setq plist (cdr-safe plist)))
444 (setq km (nth 2 elt))
445 (setq str (eval (nth 1 elt)))
446 (setq filter (plist-get plist :filter))
447 (if filter
448 (setq km (funcall filter km)))
449 (setq visible (plist-get plist :visible))
450 (if visible
451 (setq km (and (eval visible) km)))
452 (setq enable (plist-get plist :enable))
453 (if enable
454 (setq km (if (eval enable) km 'ignore))))
456 ((if (listp (cdr-safe (cdr-safe (cdr-safe elt))))
457 (or (keymapp (cdr-safe (cdr-safe (cdr-safe elt))))
458 (eq (car (cdr-safe (cdr-safe (cdr-safe elt)))) 'lambda))
459 (and (symbolp (cdr-safe (cdr-safe (cdr-safe elt))))
460 (fboundp (cdr-safe (cdr-safe (cdr-safe elt))))))
461 ; New style of easy-menu
462 (setq km (cdr (cddr elt)))
463 (and (stringp (car elt)) (setq str (car elt))))
465 ((stringp event) ; x-popup or x-popup element
466 (if (or in-x-menu (stringp (car-safe elt)))
467 (setq str event event nil km elt)
468 (setq str event event nil km (cons 'keymap elt)))))
469 (unless (or (eq km 'ignore) (null str))
470 (let ((binding (where-is-internal km nil t)))
471 (when binding
472 (setq binding (key-description binding))
473 ;; Try to align the keybindings.
474 (let ((colwidth (min 30 (- (/ (window-width) 2) 10))))
475 (setq str
476 (concat str
477 (make-string (max 2 (- colwidth
478 (string-width str)
479 (string-width binding)))
480 ?\s)
481 binding)))))))
482 (and km (stringp km) (setq str km))
483 ;; Verify that the command is enabled;
484 ;; if not, don't mention it.
485 (when (and km (symbolp km) (get km 'menu-enable))
486 (setq km (if (eval (get km 'menu-enable)) km 'ignore)))
487 (and km str
488 (or (assoc str tmm-km-list)
489 (push (cons str (cons event km)) tmm-km-list))))))
491 (defun tmm-get-keybind (keyseq)
492 "Return the current binding of KEYSEQ, merging prefix definitions.
493 If KEYSEQ is a prefix key that has local and global bindings,
494 we merge them into a single keymap which shows the proper order of the menu.
495 However, for the menu bar itself, the value does not take account
496 of `menu-bar-final-items'."
497 (let (allbind bind minorbind localbind globalbind)
498 (setq bind (key-binding keyseq))
499 ;; If KEYSEQ is a prefix key, then BIND is either nil
500 ;; or a symbol defined as a keymap (which satisfies keymapp).
501 (if (keymapp bind)
502 (setq bind nil))
503 ;; If we have a non-keymap definition, return that.
504 (or bind
505 (progn
506 ;; Otherwise, it is a prefix, so make a list of the subcommands.
507 ;; Make a list of all the bindings in all the keymaps.
508 ;; FIXME: we'd really like to just use `key-binding' now that it
509 ;; returns a keymap that contains really all the bindings under that
510 ;; prefix, but `keyseq' is always [menu-bar], so the desired order of
511 ;; the bindings is difficult to recover.
512 (setq minorbind (mapcar 'cdr (minor-mode-key-binding keyseq)))
513 (setq localbind (local-key-binding keyseq))
514 (setq globalbind (copy-sequence (cdr (global-key-binding keyseq))))
516 ;; If items have been redefined/undefined locally, remove them from
517 ;; the global list.
518 (dolist (minor minorbind)
519 (dolist (item (cdr minor))
520 (setq globalbind (assq-delete-all (car-safe item) globalbind))))
521 (dolist (item (cdr localbind))
522 (setq globalbind (assq-delete-all (car-safe item) globalbind)))
524 (setq globalbind (cons 'keymap globalbind))
525 (setq allbind (cons globalbind (cons localbind minorbind)))
527 ;; Merge all the elements of ALLBIND into one keymap.
528 (dolist (in allbind)
529 (if (and (symbolp in) (keymapp in))
530 (setq in (symbol-function in)))
531 (and in (keymapp in)
532 (setq bind (if (keymapp bind)
533 (nconc bind (copy-sequence (cdr in)))
534 (copy-sequence in)))))
535 ;; Return that keymap.
536 bind))))
538 (provide 'tmm)
540 ;;; tmm.el ends here