Add 2013 to yet more FSF copyright years
[emacs.git] / lisp / tmm.el
blob542270a876156f0e54ef2225581993c85c2ddcce
1 ;;; tmm.el --- text mode access to menu-bar
3 ;; Copyright (C) 1994-1996, 2000-2013 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 (if (not not-menu)
169 (map-keymap (lambda (k v) (tmm-get-keymap (cons k v))) menu)
170 (dolist (elt menu)
171 (cond
172 ((stringp elt) (setq gl-str elt))
173 ((listp elt) (tmm-get-keymap elt not-menu))
174 ((vectorp elt)
175 (dotimes (i (length elt))
176 (tmm-get-keymap (cons i (aref elt i)) not-menu))))))
177 ;; Choose an element of tmm-km-list; put it in choice.
178 (if (and not-menu (= 1 (length tmm-km-list)))
179 ;; If this is the top-level of an x-popup-menu menu,
180 ;; and there is just one pane, choose that one silently.
181 ;; This way we only ask the user one question,
182 ;; for which element of that pane.
183 (setq choice (cdr (car tmm-km-list)))
184 (unless tmm-km-list
185 (error "Empty menu reached"))
186 (and tmm-km-list
187 (let ((index-of-default 0))
188 (if tmm-mid-prompt
189 (setq tmm-km-list (tmm-add-shortcuts tmm-km-list))
191 ;; Find the default item's index within the menu bar.
192 ;; We use this to decide the initial minibuffer contents
193 ;; and initial history position.
194 (if default-item
195 (let ((tail menu) visible)
196 (while (and tail
197 (not (eq (car-safe (car tail)) default-item)))
198 ;; Be careful to count only the elements of MENU
199 ;; that actually constitute menu bar items.
200 (if (and (consp (car tail))
201 (or (stringp (car-safe (cdr (car tail))))
202 (and
203 (eq (car-safe (cdr (car tail))) 'menu-item)
204 (progn
205 (setq visible
206 (plist-get
207 (nthcdr 4 (car tail)) :visible))
208 (or (not visible) (eval visible))))))
209 (setq index-of-default (1+ index-of-default)))
210 (setq tail (cdr tail)))))
211 (let ((prompt (concat "^." (regexp-quote tmm-mid-prompt))))
212 (setq history
213 (reverse (delq nil
214 (mapcar
215 (lambda (elt)
216 (if (string-match prompt (car elt))
217 (car elt)))
218 tmm-km-list)))))
219 (setq history-len (length history))
220 (setq history (append history history history history))
221 (setq tmm-c-prompt (nth (- history-len 1 index-of-default) history))
222 (setq out
223 (if default-item
224 (car (nth index-of-default tmm-km-list))
225 (minibuffer-with-setup-hook #'tmm-add-prompt
226 (completing-read
227 (concat gl-str
228 " (up/down to change, PgUp to menu): ")
229 tmm-km-list nil t nil
230 (cons 'history
231 (- (* 2 history-len) index-of-default))))))))
232 (setq choice (cdr (assoc out tmm-km-list)))
233 (and (null choice)
234 (string-prefix-p tmm-c-prompt out)
235 (setq out (substring out (length tmm-c-prompt))
236 choice (cdr (assoc out tmm-km-list))))
237 (and (null choice) out
238 (setq out (try-completion out tmm-km-list)
239 choice (cdr (assoc out tmm-km-list)))))
240 ;; CHOICE is now (STRING . MEANING). Separate the two parts.
241 (setq chosen-string (car choice))
242 (setq choice (cdr choice))
243 (cond (in-popup
244 ;; We just did the inner level of a -popup menu.
245 choice)
246 ;; We just did the outer level. Do the inner level now.
247 (not-menu (tmm-prompt choice t))
248 ;; We just handled a menu keymap and found another keymap.
249 ((keymapp choice)
250 (if (symbolp choice)
251 (setq choice (indirect-function choice)))
252 (condition-case nil
253 (require 'mouse)
254 (error nil))
255 (tmm-prompt choice))
256 ;; We just handled a menu keymap and found a command.
257 (choice
258 (if chosen-string
259 (progn
260 (setq last-command-event chosen-string)
261 (call-interactively choice))
262 choice)))))
264 (defun tmm-add-shortcuts (list)
265 "Add shortcuts to cars of elements of the list.
266 Takes a list of lists with a string as car, returns list with
267 shortcuts added to these cars.
268 Stores a list of all the shortcuts in the free variable `tmm-short-cuts'."
269 (let ((tmm-next-shortcut-digit ?0))
270 (mapcar 'tmm-add-one-shortcut (reverse list))))
272 (defsubst tmm-add-one-shortcut (elt)
273 ;; uses the free vars tmm-next-shortcut-digit and tmm-short-cuts
274 (cond
275 ((eq (cddr elt) 'ignore)
276 (cons (concat " " (make-string (length tmm-mid-prompt) ?\-)
277 (car elt))
278 (cdr elt)))
280 (let* ((str (car elt))
281 (paren (string-match "(" str))
282 (pos 0) (word 0) char)
283 (catch 'done ; ??? is this slow?
284 (while (and (or (not tmm-shortcut-words) ; no limit on words
285 (< word tmm-shortcut-words)) ; try n words
286 (setq pos (string-match "\\w+" str pos)) ; get next word
287 (not (and paren (> pos paren)))) ; don't go past "(binding.."
288 (if (or (= pos 0)
289 (/= (aref str (1- pos)) ?.)) ; avoid file extensions
290 (let ((shortcut-style
291 (if (listp tmm-shortcut-style) ; convert to list
292 tmm-shortcut-style
293 (list tmm-shortcut-style))))
294 (while shortcut-style ; try upcase and downcase variants
295 (setq char (funcall (car shortcut-style) (aref str pos)))
296 (if (not (memq char tmm-short-cuts)) (throw 'done char))
297 (setq shortcut-style (cdr shortcut-style)))))
298 (setq word (1+ word))
299 (setq pos (match-end 0)))
300 (while (<= tmm-next-shortcut-digit ?9) ; no letter shortcut, pick a digit
301 (setq char tmm-next-shortcut-digit)
302 (setq tmm-next-shortcut-digit (1+ tmm-next-shortcut-digit))
303 (if (not (memq char tmm-short-cuts)) (throw 'done char)))
304 (setq char nil))
305 (if char (setq tmm-short-cuts (cons char tmm-short-cuts)))
306 (cons (concat (if char (concat (char-to-string char) tmm-mid-prompt)
307 ;; keep them lined up in columns
308 (make-string (1+ (length tmm-mid-prompt)) ?\s))
309 str)
310 (cdr elt))))))
312 ;; This returns the old map.
313 (defun tmm-define-keys (minibuffer)
314 (let ((map (make-sparse-keymap)))
315 (suppress-keymap map t)
316 (dolist (c tmm-short-cuts)
317 (if (listp tmm-shortcut-style)
318 (define-key map (char-to-string c) 'tmm-shortcut)
319 ;; only one kind of letters are shortcuts, so map both upcase and
320 ;; downcase input to the same
321 (define-key map (char-to-string (downcase c)) 'tmm-shortcut)
322 (define-key map (char-to-string (upcase c)) 'tmm-shortcut)))
323 (if minibuffer
324 (progn
325 (define-key map [pageup] 'tmm-goto-completions)
326 (define-key map [prior] 'tmm-goto-completions)
327 (define-key map "\ev" 'tmm-goto-completions)
328 (define-key map "\C-n" 'next-history-element)
329 (define-key map "\C-p" 'previous-history-element)))
330 (prog1 (current-local-map)
331 (use-local-map (append map (current-local-map))))))
333 (defun tmm-completion-delete-prompt ()
334 (with-current-buffer standard-output
335 (goto-char (point-min))
336 (delete-region (point) (search-forward "Possible completions are:\n"))))
338 (defun tmm-remove-inactive-mouse-face ()
339 "Remove the mouse-face property from inactive menu items."
340 (let ((inhibit-read-only t)
341 (inactive-string
342 (concat " " (make-string (length tmm-mid-prompt) ?\-)))
343 next)
344 (save-excursion
345 (goto-char (point-min))
346 (while (not (eobp))
347 (setq next (next-single-char-property-change (point) 'mouse-face))
348 (when (looking-at inactive-string)
349 (remove-text-properties (point) next '(mouse-face))
350 (add-text-properties (point) next '(face tmm-inactive)))
351 (goto-char next)))
352 (set-buffer-modified-p nil)))
354 (defun tmm-add-prompt ()
355 (unless tmm-c-prompt
356 (error "No active menu entries"))
357 (setq tmm-old-mb-map (tmm-define-keys t))
358 ;; Get window and hide it for electric mode to get correct size
359 (or tmm-completion-prompt
360 (add-hook 'completion-setup-hook
361 'tmm-completion-delete-prompt 'append))
362 (unwind-protect
363 (minibuffer-completion-help)
364 (remove-hook 'completion-setup-hook 'tmm-completion-delete-prompt))
365 (with-current-buffer "*Completions*"
366 (tmm-remove-inactive-mouse-face)
367 (when tmm-completion-prompt
368 (let ((inhibit-read-only t))
369 (goto-char (point-min))
370 (insert tmm-completion-prompt))))
371 (insert tmm-c-prompt))
373 (defun tmm-shortcut ()
374 "Choose the shortcut that the user typed."
375 (interactive)
376 (let ((c last-command-event) s)
377 (if (symbolp tmm-shortcut-style)
378 (setq c (funcall tmm-shortcut-style c)))
379 (if (memq c tmm-short-cuts)
380 (if (equal (buffer-name) "*Completions*")
381 (progn
382 (goto-char (point-min))
383 (re-search-forward
384 (concat "\\(^\\|[ \t]\\)" (char-to-string c) tmm-mid-prompt))
385 (choose-completion))
386 ;; In minibuffer
387 (delete-region (minibuffer-prompt-end) (point-max))
388 (dolist (elt tmm-km-list)
389 (if (string=
390 (substring (car elt) 0
391 (min (1+ (length tmm-mid-prompt))
392 (length (car elt))))
393 (concat (char-to-string c) tmm-mid-prompt))
394 (setq s (car elt))))
395 (insert s)
396 (exit-minibuffer)))))
398 (defun tmm-goto-completions ()
399 "Jump to the completions buffer."
400 (interactive)
401 (let ((prompt-end (minibuffer-prompt-end)))
402 (setq tmm-c-prompt (buffer-substring prompt-end (point-max)))
403 ;; FIXME: Why?
404 (delete-region prompt-end (point-max)))
405 (switch-to-buffer-other-window "*Completions*")
406 (search-forward tmm-c-prompt)
407 (search-backward tmm-c-prompt))
409 (defun tmm-get-keymap (elt &optional in-x-menu)
410 "Prepend (DOCSTRING EVENT BINDING) to free variable `tmm-km-list'.
411 The values are deduced from the argument ELT, that should be an
412 element of keymap, an `x-popup-menu' argument, or an element of
413 `x-popup-menu' argument (when IN-X-MENU is not-nil).
414 This function adds the element only if it is not already present.
415 It uses the free variable `tmm-table-undef' to keep undefined keys."
416 (let (km str plist filter visible enable (event (car elt)))
417 (setq elt (cdr elt))
418 (if (eq elt 'undefined)
419 (setq tmm-table-undef (cons (cons event nil) tmm-table-undef))
420 (unless (assoc event tmm-table-undef)
421 (cond ((if (listp elt)
422 (or (keymapp elt) (eq (car elt) 'lambda))
423 (and (symbolp elt) (fboundp elt)))
424 (setq km elt))
426 ((if (listp (cdr-safe elt))
427 (or (keymapp (cdr-safe elt))
428 (eq (car (cdr-safe elt)) 'lambda))
429 (and (symbolp (cdr-safe elt)) (fboundp (cdr-safe elt))))
430 (setq km (cdr elt))
431 (and (stringp (car elt)) (setq str (car elt))))
433 ((if (listp (cdr-safe (cdr-safe elt)))
434 (or (keymapp (cdr-safe (cdr-safe elt)))
435 (eq (car (cdr-safe (cdr-safe elt))) 'lambda))
436 (and (symbolp (cdr-safe (cdr-safe elt)))
437 (fboundp (cdr-safe (cdr-safe elt)))))
438 (setq km (cddr elt))
439 (and (stringp (car elt)) (setq str (car elt))))
441 ((eq (car-safe elt) 'menu-item)
442 ;; (menu-item TITLE COMMAND KEY ...)
443 (setq plist (cdr-safe (cdr-safe (cdr-safe elt))))
444 (when (consp (car-safe plist))
445 (setq plist (cdr-safe plist)))
446 (setq km (nth 2 elt))
447 (setq str (eval (nth 1 elt)))
448 (setq filter (plist-get plist :filter))
449 (if filter
450 (setq km (funcall filter km)))
451 (setq visible (plist-get plist :visible))
452 (if visible
453 (setq km (and (eval visible) km)))
454 (setq enable (plist-get plist :enable))
455 (if enable
456 (setq km (if (eval enable) km 'ignore))))
458 ((if (listp (cdr-safe (cdr-safe (cdr-safe elt))))
459 (or (keymapp (cdr-safe (cdr-safe (cdr-safe elt))))
460 (eq (car (cdr-safe (cdr-safe (cdr-safe elt)))) 'lambda))
461 (and (symbolp (cdr-safe (cdr-safe (cdr-safe elt))))
462 (fboundp (cdr-safe (cdr-safe (cdr-safe elt))))))
463 ; New style of easy-menu
464 (setq km (cdr (cddr elt)))
465 (and (stringp (car elt)) (setq str (car elt))))
467 ((stringp event) ; x-popup or x-popup element
468 (setq str event)
469 (setq event nil)
470 (setq km (if (or in-x-menu (stringp (car-safe elt)))
471 elt (cons 'keymap elt)))))
472 (unless (or (eq km 'ignore) (null str))
473 (let ((binding (where-is-internal km nil t)))
474 (when binding
475 (setq binding (key-description binding))
476 ;; Try to align the keybindings.
477 (let ((colwidth (min 30 (- (/ (window-width) 2) 10))))
478 (setq str
479 (concat str
480 (make-string (max 2 (- colwidth
481 (string-width str)
482 (string-width binding)))
483 ?\s)
484 binding)))))))
485 (and km (stringp km) (setq str km))
486 ;; Verify that the command is enabled;
487 ;; if not, don't mention it.
488 (when (and km (symbolp km) (get km 'menu-enable))
489 (setq km (if (eval (get km 'menu-enable)) km 'ignore)))
490 (and km str
491 (or (assoc str tmm-km-list)
492 (push (cons str (cons event km)) tmm-km-list))))))
494 (defun tmm-get-keybind (keyseq)
495 "Return the current binding of KEYSEQ, merging prefix definitions.
496 If KEYSEQ is a prefix key that has local and global bindings,
497 we merge them into a single keymap which shows the proper order of the menu.
498 However, for the menu bar itself, the value does not take account
499 of `menu-bar-final-items'."
500 (let (allbind bind minorbind localbind globalbind)
501 (setq bind (key-binding keyseq))
502 ;; If KEYSEQ is a prefix key, then BIND is either nil
503 ;; or a symbol defined as a keymap (which satisfies keymapp).
504 (if (keymapp bind)
505 (setq bind nil))
506 ;; If we have a non-keymap definition, return that.
507 (or bind
508 (progn
509 ;; Otherwise, it is a prefix, so make a list of the subcommands.
510 ;; Make a list of all the bindings in all the keymaps.
511 ;; FIXME: we'd really like to just use `key-binding' now that it
512 ;; returns a keymap that contains really all the bindings under that
513 ;; prefix, but `keyseq' is always [menu-bar], so the desired order of
514 ;; the bindings is difficult to recover.
515 (setq minorbind (mapcar 'cdr (minor-mode-key-binding keyseq)))
516 (setq localbind (local-key-binding keyseq))
517 (setq globalbind (copy-sequence (cdr (global-key-binding keyseq))))
519 ;; If items have been redefined/undefined locally, remove them from
520 ;; the global list.
521 (dolist (minor minorbind)
522 (dolist (item (cdr minor))
523 (setq globalbind (assq-delete-all (car-safe item) globalbind))))
524 (dolist (item (cdr localbind))
525 (setq globalbind (assq-delete-all (car-safe item) globalbind)))
527 (setq globalbind (cons 'keymap globalbind))
528 (setq allbind (cons globalbind (cons localbind minorbind)))
530 ;; Merge all the elements of ALLBIND into one keymap.
531 (dolist (in allbind)
532 (if (and (symbolp in) (keymapp in))
533 (setq in (symbol-function in)))
534 (and in (keymapp in)
535 (setq bind (if (keymapp bind)
536 (nconc bind (copy-sequence (cdr in)))
537 (copy-sequence in)))))
538 ;; Return that keymap.
539 bind))))
541 (provide 'tmm)
543 ;;; tmm.el ends here