1 ;;; tmm.el --- text mode access to menu-bar
3 ;; Copyright (C) 1994, 1995, 1996, 2000, 2001, 2002
4 ;; Free Software Foundation, Inc.
6 ;; Author: Ilya Zakharevich <ilya@math.mps.ohio-state.edu>
8 ;; Keywords: convenience
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
29 ;; This package provides text mode access to the menu bar.
36 "Text mode access to menu-bar."
40 ;;; The following will be localized, added only to pacify the compiler.
41 (defvar tmm-short-cuts
)
42 (defvar tmm-old-mb-map nil
)
43 (defvar tmm-old-comp-map
)
46 (defvar tmm-next-shortcut-digit
)
47 (defvar tmm-table-undef
)
49 ;;;###autoload (define-key global-map "\M-`" 'tmm-menubar)
50 ;;;###autoload (define-key global-map [f10] 'tmm-menubar)
51 ;;;###autoload (define-key global-map [menu-bar mouse-1] 'tmm-menubar-mouse)
54 (defun tmm-menubar (&optional x-position
)
55 "Text-mode emulation of looking and choosing from a menubar.
56 See the documentation for `tmm-prompt'.
57 X-POSITION, if non-nil, specifies a horizontal position within the menu bar;
58 we make that menu bar item (the one at that position) the default choice."
60 (run-hooks 'menu-bar-update-hook
)
61 ;; Obey menu-bar-final-items; put those items last.
62 (let ((menu-bar (tmm-get-keybind [menu-bar
]))
64 (let ((list menu-bar-final-items
))
66 (let ((item (car list
)))
67 ;; ITEM is the name of an item that we want to put last.
68 ;; Find it in MENU-BAR and move it to the end.
69 (let ((this-one (assq item menu-bar
)))
70 (setq menu-bar
(append (delq this-one menu-bar
)
72 (setq list
(cdr list
))))
77 (while (and tail
(< column x-position
))
78 (setq this-one
(car tail
))
79 (if (and (consp (car tail
))
80 (consp (cdr (car tail
)))
81 (stringp (nth 1 (car tail
))))
82 (setq column
(+ column
83 (length (nth 1 (car tail
)))
85 (setq tail
(cdr tail
)))
86 (setq menu-bar-item
(car this-one
))))
87 (tmm-prompt menu-bar nil menu-bar-item
)))
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'."
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."
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
))
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
)
126 (repeat (choice (const downcase
) (const upcase
))))
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
))
137 (defun tmm-prompt (menu &optional in-popup default-item
)
138 "Text-mode emulation of calling the bindings in keymap.
139 Creates a text-mode menu of possible choices. You can access the elements
140 in the menu in two ways:
141 *) via history mechanism from minibuffer;
142 *) Or via completion-buffer that is automatically shown.
143 The last alternative is currently a hack, you cannot use mouse reliably.
145 MENU is like the MENU argument to `x-popup-menu': either a
146 keymap or an alist of alists.
147 DEFAULT-ITEM, if non-nil, specifies an initial default choice.
148 Its value should be an event that has a binding in MENU."
149 ;; If the optional argument IN-POPUP is t,
150 ;; then MENU is an alist of elements of the form (STRING . VALUE).
151 ;; That is used for recursive calls only.
152 (let ((gl-str "Menu bar") ;; The menu bar itself is not a menu keymap
153 ; so it doesn't have a name.
154 tmm-km-list out history history-len tmm-table-undef tmm-c-prompt
155 tmm-old-mb-map tmm-old-comp-map tmm-short-cuts
157 (not-menu (not (keymapp menu
))))
158 (run-hooks 'activate-menubar-hook
)
159 ;; Compute tmm-km-list from MENU.
160 ;; tmm-km-list is an alist of (STRING . MEANING).
161 ;; It has no other elements.
162 ;; The order of elements in tmm-km-list is the order of the menu bar.
166 (and (listp elt
) (tmm-get-keymap elt not-menu
))))
168 ;; Choose an element of tmm-km-list; put it in choice.
169 (if (and not-menu
(= 1 (length tmm-km-list
)))
170 ;; If this is the top-level of an x-popup-menu menu,
171 ;; and there is just one pane, choose that one silently.
172 ;; This way we only ask the user one question,
173 ;; for which element of that pane.
174 (setq choice
(cdr (car tmm-km-list
)))
176 (error "Empty menu reached"))
178 (let ((index-of-default 0))
180 (setq tmm-km-list
(tmm-add-shortcuts tmm-km-list
))
182 ;; Find the default item's index within the menu bar.
183 ;; We use this to decide the initial minibuffer contents
184 ;; and initial history position.
188 (not (eq (car-safe (car tail
)) default-item
)))
189 ;; Be careful to count only the elements of MENU
190 ;; that actually constitute menu bar items.
191 (if (and (consp (car tail
))
192 (or (stringp (car-safe (cdr (car tail
))))
193 (eq (car-safe (cdr (car tail
))) 'menu-item
)))
194 (setq index-of-default
(1+ index-of-default
)))
195 (setq tail
(cdr tail
)))))
196 (setq history
(reverse (mapcar 'car tmm-km-list
)))
197 (setq history-len
(length history
))
198 (setq history
(append history history history history
))
199 (setq tmm-c-prompt
(nth (- history-len
1 index-of-default
) history
))
200 (add-hook 'minibuffer-setup-hook
'tmm-add-prompt
)
205 (concat gl-str
" (up/down to change, PgUp to menu): ")
206 tmm-km-list nil t nil
207 (cons 'history
(- (* 2 history-len
) index-of-default
))))
209 (remove-hook 'minibuffer-setup-hook
'tmm-add-prompt
)
210 (if (get-buffer "*Completions*")
212 (set-buffer "*Completions*")
213 (use-local-map tmm-old-comp-map
)
214 (bury-buffer (current-buffer)))))
216 (setq choice
(cdr (assoc out tmm-km-list
)))
218 (> (length out
) (length tmm-c-prompt
))
219 (string= (substring out
0 (length tmm-c-prompt
)) tmm-c-prompt
)
220 (setq out
(substring out
(length tmm-c-prompt
))
221 choice
(cdr (assoc out tmm-km-list
))))
222 (and (null choice
) out
223 (setq out
(try-completion out tmm-km-list
)
224 choice
(cdr (assoc out tmm-km-list
)))))
225 ;; CHOICE is now (STRING . MEANING). Separate the two parts.
226 (setq chosen-string
(car choice
))
227 (setq choice
(cdr choice
))
229 ;; We just did the inner level of a -popup menu.
231 ;; We just did the outer level. Do the inner level now.
232 (not-menu (tmm-prompt choice t
))
233 ;; We just handled a menu keymap and found another keymap.
236 (setq choice
(indirect-function choice
)))
241 (x-popup-menu nil choice
) ; Get the shortcuts
244 ;; We just handled a menu keymap and found a command.
248 (setq last-command-event chosen-string
)
249 (call-interactively choice
))
252 (defun tmm-add-shortcuts (list)
253 "Adds shortcuts to cars of elements of the list.
254 Takes a list of lists with a string as car, returns list with
255 shortcuts added to these cars.
256 Stores a list of all the shortcuts in the free variable `tmm-short-cuts'."
257 (let ((tmm-next-shortcut-digit ?
0))
258 (mapcar 'tmm-add-one-shortcut
(reverse list
))))
260 (defsubst tmm-add-one-shortcut
(elt)
261 ;; uses the free vars tmm-next-shortcut-digit and tmm-short-cuts
262 (let* ((str (car elt
))
263 (paren (string-match "(" str
))
264 (pos 0) (word 0) char
)
265 (catch 'done
; ??? is this slow?
266 (while (and (or (not tmm-shortcut-words
) ; no limit on words
267 (< word tmm-shortcut-words
)) ; try n words
268 (setq pos
(string-match "\\w+" str pos
)) ; get next word
269 (not (and paren
(> pos paren
)))) ; don't go past "(binding.."
271 (/= (aref str
(1- pos
)) ?.
)) ; avoid file extensions
272 (let ((shortcut-style
273 (if (listp tmm-shortcut-style
) ; convert to list
275 (list tmm-shortcut-style
))))
276 (while shortcut-style
; try upcase and downcase variants
277 (setq char
(funcall (car shortcut-style
) (aref str pos
)))
278 (if (not (memq char tmm-short-cuts
)) (throw 'done char
))
279 (setq shortcut-style
(cdr shortcut-style
)))))
280 (setq word
(1+ word
))
281 (setq pos
(match-end 0)))
282 (while (<= tmm-next-shortcut-digit ?
9) ; no letter shortcut, pick a digit
283 (setq char tmm-next-shortcut-digit
)
284 (setq tmm-next-shortcut-digit
(1+ tmm-next-shortcut-digit
))
285 (if (not (memq char tmm-short-cuts
)) (throw 'done char
)))
287 (if char
(setq tmm-short-cuts
(cons char tmm-short-cuts
)))
288 (cons (concat (if char
(concat (char-to-string char
) tmm-mid-prompt
)
289 ;; keep them lined up in columns
290 (make-string (1+ (length tmm-mid-prompt
)) ?\
))
294 ;; This returns the old map.
295 (defun tmm-define-keys (minibuffer)
296 (let ((map (make-sparse-keymap)))
297 (suppress-keymap map t
)
300 (if (listp tmm-shortcut-style
)
301 (define-key map
(char-to-string c
) 'tmm-shortcut
)
302 ;; only one kind of letters are shortcuts, so map both upcase and
303 ;; downcase input to the same
304 (define-key map
(char-to-string (downcase c
)) 'tmm-shortcut
)
305 (define-key map
(char-to-string (upcase c
)) 'tmm-shortcut
)))
309 (define-key map
[pageup] 'tmm-goto-completions)
310 (define-key map [prior] 'tmm-goto-completions)
311 (define-key map "\ev" 'tmm-goto-completions)
312 (define-key map "\C-n" 'next-history-element)
313 (define-key map "\C-p" 'previous-history-element)))
314 (prog1 (current-local-map)
315 (use-local-map (append map (current-local-map))))))
317 (defun tmm-completion-delete-prompt ()
318 (set-buffer standard-output)
320 (delete-region 1 (search-forward "Possible completions are:\n")))
322 (defun tmm-add-prompt ()
323 (remove-hook 'minibuffer-setup-hook 'tmm-add-prompt)
324 (add-hook 'minibuffer-exit-hook 'tmm-delete-map nil t)
325 (let ((win (selected-window)))
326 (setq tmm-old-mb-map (tmm-define-keys t))
327 ;; Get window and hide it for electric mode to get correct size
328 (save-window-excursion
330 (mapcar 'car minibuffer-completion-table)))
331 (or tmm-completion-prompt
332 (add-hook 'completion-setup-hook
333 'tmm-completion-delete-prompt 'append))
334 (with-output-to-temp-buffer "*Completions*"
335 (display-completion-list completions))
336 (remove-hook 'completion-setup-hook 'tmm-completion-delete-prompt))
337 (when tmm-completion-prompt
338 (set-buffer "*Completions*")
339 (let ((buffer-read-only nil))
340 (goto-char (point-min))
341 (insert tmm-completion-prompt))))
342 (save-selected-window
343 (other-window 1) ; Electric-pop-up-window does
344 ; not work in minibuffer
345 (Electric-pop-up-window "*Completions*")
346 (with-current-buffer "*Completions*"
347 (setq tmm-old-comp-map (tmm-define-keys nil))))
349 (insert tmm-c-prompt)))
351 (defun tmm-delete-map ()
352 (remove-hook 'minibuffer-exit-hook 'tmm-delete-map t)
354 (use-local-map tmm-old-mb-map)))
356 (defun tmm-shortcut ()
357 "Choose the shortcut that the user typed."
359 (let ((c last-command-char) s)
360 (if (symbolp tmm-shortcut-style)
361 (setq c (funcall tmm-shortcut-style c)))
362 (if (memq c tmm-short-cuts)
363 (if (equal (buffer-name) "*Completions*")
365 (beginning-of-buffer)
367 (concat "\\(^\\|[ \t]\\)" (char-to-string c) tmm-mid-prompt))
370 (delete-region (minibuffer-prompt-end) (point-max))
373 (substring (car elt) 0
374 (min (1+ (length tmm-mid-prompt))
376 (concat (char-to-string c) tmm-mid-prompt))
380 (exit-minibuffer)))))
382 (defun tmm-goto-completions ()
384 (let ((prompt-end (minibuffer-prompt-end)))
385 (setq tmm-c-prompt (buffer-substring prompt-end (point-max)))
386 (delete-region prompt-end (point-max)))
387 (switch-to-buffer-other-window "*Completions*")
388 (search-forward tmm-c-prompt)
389 (search-backward tmm-c-prompt))
391 (defun tmm-get-keymap (elt &optional in-x-menu)
392 "Prepends (DOCSTRING EVENT BINDING) to free variable `tmm-km-list'.
393 The values are deduced from the argument ELT, that should be an
394 element of keymap, an `x-popup-menu' argument, or an element of
395 `x-popup-menu' argument (when IN-X-MENU is not-nil).
396 This function adds the element only if it is not already present.
397 It uses the free variable `tmm-table-undef' to keep undefined keys."
398 (let (km str cache plist filter visible (event (car elt)))
400 (if (eq elt 'undefined)
401 (setq tmm-table-undef (cons (cons event nil) tmm-table-undef))
402 (unless (assoc event tmm-table-undef)
403 (cond ((if (listp elt)
404 (or (keymapp elt) (eq (car elt) 'lambda))
408 ((if (listp (cdr-safe elt))
409 (or (keymapp (cdr-safe elt))
410 (eq (car (cdr-safe elt)) 'lambda))
411 (fboundp (cdr-safe elt)))
413 (and (stringp (car elt)) (setq str (car elt))))
415 ((if (listp (cdr-safe (cdr-safe elt)))
416 (or (keymapp (cdr-safe (cdr-safe elt)))
417 (eq (car (cdr-safe (cdr-safe elt))) 'lambda))
418 (fboundp (cdr-safe (cdr-safe elt))))
419 (setq km (cdr (cdr elt)))
420 (and (stringp (car elt)) (setq str (car elt)))
422 (stringp (cdr (car (cdr elt)))) ; keyseq cache
423 (setq cache (cdr (car (cdr elt))))
424 cache (setq str (concat str cache))))
426 ((eq (car-safe elt) 'menu-item)
427 ;; (menu-item TITLE COMMAND KEY ...)
428 (setq plist (cdr-safe (cdr-safe (cdr-safe elt))))
429 (when (consp (car-safe plist))
430 (setq plist (cdr-safe plist)))
431 (setq km (nth 2 elt))
432 (setq str (eval (nth 1 elt)))
433 (setq filter (plist-get plist :filter))
435 (setq km (funcall filter km)))
436 (setq visible (plist-get plist :visible))
438 (setq km (and (eval visible) km)))
441 (stringp (cdr (nth 3 elt))) ; keyseq cache
442 (setq cache (cdr (nth 3 elt)))
444 (setq str (concat str cache))))
446 ((if (listp (cdr-safe (cdr-safe (cdr-safe elt))))
447 (or (keymapp (cdr-safe (cdr-safe (cdr-safe elt))))
448 (eq (car (cdr-safe (cdr-safe (cdr-safe elt)))) 'lambda))
449 (fboundp (cdr-safe (cdr-safe (cdr-safe elt)))))
450 ; New style of easy-menu
451 (setq km (cdr (cdr (cdr elt))))
452 (and (stringp (car elt)) (setq str (car elt)))
454 (stringp (cdr (car (cdr (cdr elt))))) ; keyseq cache
455 (setq cache (cdr (car (cdr (cdr elt)))))
456 cache (setq str (concat str cache))))
458 ((stringp event) ; x-popup or x-popup element
459 (if (or in-x-menu (stringp (car-safe elt)))
460 (setq str event event nil km elt)
461 (setq str event event nil km (cons 'keymap elt))
463 (and km (stringp km) (setq str km))
464 ;; Verify that the command is enabled;
465 ;; if not, don't mention it.
466 (when (and km (symbolp km) (get km 'menu-enable))
467 (unless (eval (get km 'menu-enable))
470 (or (assoc str tmm-km-list)
471 (push (cons str (cons event km)) tmm-km-list))))))
473 (defun tmm-get-keybind (keyseq)
474 "Return the current binding of KEYSEQ, merging prefix definitions.
475 If KEYSEQ is a prefix key that has local and global bindings,
476 we merge them into a single keymap which shows the proper order of the menu.
477 However, for the menu bar itself, the value does not take account
478 of `menu-bar-final-items'."
480 (setq bind (key-binding keyseq))
481 ;; If KEYSEQ is a prefix key, then BIND is either nil
482 ;; or a symbol defined as a keymap (which satisfies keymapp).
485 ;; If we have a non-keymap definition, return that.
488 ;; Otherwise, it is a prefix, so make a list of the subcommands.
489 ;; Make a list of all the bindings in all the keymaps.
490 (setq allbind (mapcar 'cdr (minor-mode-key-binding keyseq)))
491 (setq allbind (cons (local-key-binding keyseq) allbind))
492 (setq allbind (cons (global-key-binding keyseq) allbind))
493 ;; Merge all the elements of ALLBIND into one keymap.
495 (if (and (symbolp in) (keymapp in))
496 (setq in (symbol-function in)))
499 (setq bind (nconc bind (copy-sequence (cdr in))))
500 (setq bind (copy-sequence in)))))
502 ;; Return that keymap.
505 (add-hook 'calendar-load-hook (lambda () (require 'cal-menu)))
509 ;;; arch-tag: e7ddbdb6-4b95-4da3-afbe-ad6063d112f4