Allow 'browse-url-emacs' to fetch URL in the selected window
[emacs.git] / lisp / menu-bar.el
blob25e016247b38a38b28b71320062ee2e46c4e7120
1 ;;; menu-bar.el --- define a default menu bar
3 ;; Copyright (C) 1993-1995, 2000-2018 Free Software Foundation, Inc.
5 ;; Author: Richard M. Stallman
6 ;; Maintainer: emacs-devel@gnu.org
7 ;; Keywords: internal, mouse
8 ;; Package: emacs
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 3 of the License, or
15 ;; (at your option) any later version.
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. If not, see <https://www.gnu.org/licenses/>.
25 ;; Avishai Yacobi suggested some menu rearrangements.
27 ;;; Commentary:
29 ;;; Code:
31 ;; This is referenced by some code below; it is defined in uniquify.el
32 (defvar uniquify-buffer-name-style)
34 ;; From emulation/cua-base.el; used below
35 (defvar cua-enable-cua-keys)
38 ;; Don't clobber an existing menu-bar keymap, to preserve any menu-bar key
39 ;; definitions made in loaddefs.el.
40 (or (lookup-key global-map [menu-bar])
41 (define-key global-map [menu-bar] (make-sparse-keymap "menu-bar")))
43 ;; Force Help item to come last, after the major mode's own items.
44 ;; The symbol used to be called `help', but that gets confused with the
45 ;; help key.
46 (setq menu-bar-final-items '(help-menu))
48 ;; This definition is just to show what this looks like.
49 ;; It gets modified in place when menu-bar-update-buffers is called.
50 (defvar global-buffers-menu-map (make-sparse-keymap "Buffers"))
52 ;; Only declared obsolete (and only made a proper alias) in 23.3.
53 (define-obsolete-variable-alias
54 'menu-bar-files-menu 'menu-bar-file-menu "22.1")
55 (defvar menu-bar-file-menu
56 (let ((menu (make-sparse-keymap "File")))
58 ;; The "File" menu items
59 (bindings--define-key menu [exit-emacs]
60 '(menu-item "Quit" save-buffers-kill-terminal
61 :help "Save unsaved buffers, then exit"))
63 (bindings--define-key menu [separator-exit]
64 menu-bar-separator)
66 ;; Don't use delete-frame as event name because that is a special
67 ;; event.
68 (bindings--define-key menu [delete-this-frame]
69 '(menu-item "Delete Frame" delete-frame
70 :visible (fboundp 'delete-frame)
71 :enable (delete-frame-enabled-p)
72 :help "Delete currently selected frame"))
73 (bindings--define-key menu [make-frame-on-display]
74 '(menu-item "New Frame on Display..." make-frame-on-display
75 :visible (fboundp 'make-frame-on-display)
76 :help "Open a new frame on another display"))
77 (bindings--define-key menu [make-frame]
78 '(menu-item "New Frame" make-frame-command
79 :visible (fboundp 'make-frame-command)
80 :help "Open a new frame"))
82 (bindings--define-key menu [separator-frame]
83 menu-bar-separator)
85 (bindings--define-key menu [one-window]
86 '(menu-item "Remove Other Windows" delete-other-windows
87 :enable (not (one-window-p t nil))
88 :help "Make selected window fill whole frame"))
90 (bindings--define-key menu [new-window-on-right]
91 '(menu-item "New Window on Right" split-window-right
92 :enable (and (menu-bar-menu-frame-live-and-visible-p)
93 (menu-bar-non-minibuffer-window-p))
94 :help "Make new window on right of selected one"))
96 (bindings--define-key menu [new-window-below]
97 '(menu-item "New Window Below" split-window-below
98 :enable (and (menu-bar-menu-frame-live-and-visible-p)
99 (menu-bar-non-minibuffer-window-p))
100 :help "Make new window below selected one"))
102 (bindings--define-key menu [separator-window]
103 menu-bar-separator)
105 (bindings--define-key menu [ps-print-region]
106 '(menu-item "PostScript Print Region (B+W)" ps-print-region
107 :enable mark-active
108 :help "Pretty-print marked region in black and white to PostScript printer"))
109 (bindings--define-key menu [ps-print-buffer]
110 '(menu-item "PostScript Print Buffer (B+W)" ps-print-buffer
111 :enable (menu-bar-menu-frame-live-and-visible-p)
112 :help "Pretty-print current buffer in black and white to PostScript printer"))
113 (bindings--define-key menu [ps-print-region-faces]
114 '(menu-item "PostScript Print Region"
115 ps-print-region-with-faces
116 :enable mark-active
117 :help "Pretty-print marked region to PostScript printer"))
118 (bindings--define-key menu [ps-print-buffer-faces]
119 '(menu-item "PostScript Print Buffer"
120 ps-print-buffer-with-faces
121 :enable (menu-bar-menu-frame-live-and-visible-p)
122 :help "Pretty-print current buffer to PostScript printer"))
123 (bindings--define-key menu [print-region]
124 '(menu-item "Print Region" print-region
125 :enable mark-active
126 :help "Print region between mark and current position"))
127 (bindings--define-key menu [print-buffer]
128 '(menu-item "Print Buffer" print-buffer
129 :enable (menu-bar-menu-frame-live-and-visible-p)
130 :help "Print current buffer with page headings"))
132 (bindings--define-key menu [separator-print]
133 menu-bar-separator)
135 (bindings--define-key menu [recover-session]
136 '(menu-item "Recover Crashed Session" recover-session
137 :enable
138 (and auto-save-list-file-prefix
139 (file-directory-p
140 (file-name-directory auto-save-list-file-prefix))
141 (directory-files
142 (file-name-directory auto-save-list-file-prefix)
144 (concat "\\`"
145 (regexp-quote
146 (file-name-nondirectory
147 auto-save-list-file-prefix)))
149 :help "Recover edits from a crashed session"))
150 (bindings--define-key menu [revert-buffer]
151 '(menu-item "Revert Buffer" revert-buffer
152 :enable (or (not (eq revert-buffer-function
153 'revert-buffer--default))
154 (not (eq
155 revert-buffer-insert-file-contents-function
156 'revert-buffer-insert-file-contents--default-function))
157 (and buffer-file-number
158 (or (buffer-modified-p)
159 (not (verify-visited-file-modtime
160 (current-buffer))))))
161 :help "Re-read current buffer from its file"))
162 (bindings--define-key menu [write-file]
163 '(menu-item "Save As..." write-file
164 :enable (and (menu-bar-menu-frame-live-and-visible-p)
165 (menu-bar-non-minibuffer-window-p))
166 :help "Write current buffer to another file"))
167 (bindings--define-key menu [save-buffer]
168 '(menu-item "Save" save-buffer
169 :enable (and (buffer-modified-p)
170 (buffer-file-name)
171 (menu-bar-non-minibuffer-window-p))
172 :help "Save current buffer to its file"))
174 (bindings--define-key menu [separator-save]
175 menu-bar-separator)
178 (bindings--define-key menu [kill-buffer]
179 '(menu-item "Close" kill-this-buffer
180 :enable (kill-this-buffer-enabled-p)
181 :help "Discard (kill) current buffer"))
182 (bindings--define-key menu [insert-file]
183 '(menu-item "Insert File..." insert-file
184 :enable (menu-bar-non-minibuffer-window-p)
185 :help "Insert another file into current buffer"))
186 (bindings--define-key menu [dired]
187 '(menu-item "Open Directory..." dired
188 :enable (menu-bar-non-minibuffer-window-p)
189 :help "Read a directory, to operate on its files"))
190 (bindings--define-key menu [open-file]
191 '(menu-item "Open File..." menu-find-file-existing
192 :enable (menu-bar-non-minibuffer-window-p)
193 :help "Read an existing file into an Emacs buffer"))
194 (bindings--define-key menu [new-file]
195 '(menu-item "Visit New File..." find-file
196 :enable (menu-bar-non-minibuffer-window-p)
197 :help "Specify a new file's name, to edit the file"))
199 menu))
201 (defun menu-find-file-existing ()
202 "Edit the existing file FILENAME."
203 (interactive)
204 (let* ((mustmatch (not (and (fboundp 'x-uses-old-gtk-dialog)
205 (x-uses-old-gtk-dialog))))
206 (filename (car (find-file-read-args "Find file: " mustmatch))))
207 (if mustmatch
208 (find-file-existing filename)
209 (find-file filename))))
211 ;; The "Edit->Search" submenu
212 (defvar menu-bar-last-search-type nil
213 "Type of last non-incremental search command called from the menu.")
215 (defun nonincremental-repeat-search-forward ()
216 "Search forward for the previous search string or regexp."
217 (interactive)
218 (cond
219 ((and (eq menu-bar-last-search-type 'string)
220 search-ring)
221 (nonincremental-search-forward))
222 ((and (eq menu-bar-last-search-type 'regexp)
223 regexp-search-ring)
224 (re-search-forward (car regexp-search-ring)))
226 (error "No previous search"))))
228 (defun nonincremental-repeat-search-backward ()
229 "Search backward for the previous search string or regexp."
230 (interactive)
231 (cond
232 ((and (eq menu-bar-last-search-type 'string)
233 search-ring)
234 (nonincremental-search-backward))
235 ((and (eq menu-bar-last-search-type 'regexp)
236 regexp-search-ring)
237 (re-search-backward (car regexp-search-ring)))
239 (error "No previous search"))))
241 (defun nonincremental-search-forward (&optional string backward)
242 "Read a string and search for it nonincrementally."
243 (interactive "sSearch for string: ")
244 (setq menu-bar-last-search-type 'string)
245 ;; Ideally, this whole command would be equivalent to `C-s RET'.
246 (let ((isearch-forward (not backward))
247 (isearch-regexp-function search-default-mode)
248 (isearch-regexp nil))
249 (if (or (equal string "") (not string))
250 (funcall (isearch-search-fun-default) (car search-ring))
251 (isearch-update-ring string nil)
252 (funcall (isearch-search-fun-default) string))))
254 (defun nonincremental-search-backward (&optional string)
255 "Read a string and search backward for it nonincrementally."
256 (interactive "sSearch backwards for string: ")
257 (nonincremental-search-forward string 'backward))
259 (defun nonincremental-re-search-forward (string)
260 "Read a regular expression and search for it nonincrementally."
261 (interactive "sSearch for regexp: ")
262 (setq menu-bar-last-search-type 'regexp)
263 (if (equal string "")
264 (re-search-forward (car regexp-search-ring))
265 (isearch-update-ring string t)
266 (re-search-forward string)))
268 (defun nonincremental-re-search-backward (string)
269 "Read a regular expression and search backward for it nonincrementally."
270 (interactive "sSearch for regexp: ")
271 (setq menu-bar-last-search-type 'regexp)
272 (if (equal string "")
273 (re-search-backward (car regexp-search-ring))
274 (isearch-update-ring string t)
275 (re-search-backward string)))
277 ;; The Edit->Search->Incremental Search menu
278 (defvar menu-bar-i-search-menu
279 (let ((menu (make-sparse-keymap "Incremental Search")))
280 (bindings--define-key menu [isearch-backward-regexp]
281 '(menu-item "Backward Regexp..." isearch-backward-regexp
282 :help "Search backwards for a regular expression as you type it"))
283 (bindings--define-key menu [isearch-forward-regexp]
284 '(menu-item "Forward Regexp..." isearch-forward-regexp
285 :help "Search forward for a regular expression as you type it"))
286 (bindings--define-key menu [isearch-backward]
287 '(menu-item "Backward String..." isearch-backward
288 :help "Search backwards for a string as you type it"))
289 (bindings--define-key menu [isearch-forward]
290 '(menu-item "Forward String..." isearch-forward
291 :help "Search forward for a string as you type it"))
292 menu))
294 (defvar menu-bar-search-menu
295 (let ((menu (make-sparse-keymap "Search")))
297 (bindings--define-key menu [i-search]
298 `(menu-item "Incremental Search" ,menu-bar-i-search-menu))
299 (bindings--define-key menu [separator-tag-isearch]
300 menu-bar-separator)
302 (bindings--define-key menu [tags-continue]
303 '(menu-item "Continue Tags Search" tags-loop-continue
304 :help "Continue last tags search operation"))
305 (bindings--define-key menu [tags-srch]
306 '(menu-item "Search Tagged Files..." tags-search
307 :help "Search for a regexp in all tagged files"))
308 (bindings--define-key menu [separator-tag-search] menu-bar-separator)
310 (bindings--define-key menu [repeat-search-back]
311 '(menu-item "Repeat Backwards"
312 nonincremental-repeat-search-backward
313 :enable (or (and (eq menu-bar-last-search-type 'string)
314 search-ring)
315 (and (eq menu-bar-last-search-type 'regexp)
316 regexp-search-ring))
317 :help "Repeat last search backwards"))
318 (bindings--define-key menu [repeat-search-fwd]
319 '(menu-item "Repeat Forward"
320 nonincremental-repeat-search-forward
321 :enable (or (and (eq menu-bar-last-search-type 'string)
322 search-ring)
323 (and (eq menu-bar-last-search-type 'regexp)
324 regexp-search-ring))
325 :help "Repeat last search forward"))
326 (bindings--define-key menu [separator-repeat-search]
327 menu-bar-separator)
329 (bindings--define-key menu [re-search-backward]
330 '(menu-item "Regexp Backwards..."
331 nonincremental-re-search-backward
332 :help "Search backwards for a regular expression"))
333 (bindings--define-key menu [re-search-forward]
334 '(menu-item "Regexp Forward..."
335 nonincremental-re-search-forward
336 :help "Search forward for a regular expression"))
338 (bindings--define-key menu [search-backward]
339 '(menu-item "String Backwards..."
340 nonincremental-search-backward
341 :help "Search backwards for a string"))
342 (bindings--define-key menu [search-forward]
343 '(menu-item "String Forward..." nonincremental-search-forward
344 :help "Search forward for a string"))
345 menu))
347 ;; The Edit->Replace submenu
349 (defvar menu-bar-replace-menu
350 (let ((menu (make-sparse-keymap "Replace")))
351 (bindings--define-key menu [tags-repl-continue]
352 '(menu-item "Continue Replace" tags-loop-continue
353 :help "Continue last tags replace operation"))
354 (bindings--define-key menu [tags-repl]
355 '(menu-item "Replace in Tagged Files..." tags-query-replace
356 :help "Interactively replace a regexp in all tagged files"))
357 (bindings--define-key menu [separator-replace-tags]
358 menu-bar-separator)
360 (bindings--define-key menu [query-replace-regexp]
361 '(menu-item "Replace Regexp..." query-replace-regexp
362 :enable (not buffer-read-only)
363 :help "Replace regular expression interactively, ask about each occurrence"))
364 (bindings--define-key menu [query-replace]
365 '(menu-item "Replace String..." query-replace
366 :enable (not buffer-read-only)
367 :help "Replace string interactively, ask about each occurrence"))
368 menu))
370 ;;; Assemble the top-level Edit menu items.
371 (defvar menu-bar-goto-menu
372 (let ((menu (make-sparse-keymap "Go To")))
374 (bindings--define-key menu [set-tags-name]
375 '(menu-item "Set Tags File Name..." visit-tags-table
376 :visible (menu-bar-goto-uses-etags-p)
377 :help "Tell navigation commands which tag table file to use"))
379 (bindings--define-key menu [separator-tag-file]
380 '(menu-item "--" nil :visible (menu-bar-goto-uses-etags-p)))
382 (bindings--define-key menu [xref-pop]
383 '(menu-item "Back" xref-pop-marker-stack
384 :visible (and (featurep 'xref)
385 (not (xref-marker-stack-empty-p)))
386 :help "Back to the position of the last search"))
388 (bindings--define-key menu [xref-apropos]
389 '(menu-item "Find Apropos..." xref-find-apropos
390 :help "Find function/variables whose names match regexp"))
392 (bindings--define-key menu [xref-find-otherw]
393 '(menu-item "Find Definition in Other Window..."
394 xref-find-definitions-other-window
395 :help "Find function/variable definition in another window"))
396 (bindings--define-key menu [xref-find-def]
397 '(menu-item "Find Definition..." xref-find-definitions
398 :help "Find definition of function or variable"))
400 (bindings--define-key menu [separator-xref]
401 menu-bar-separator)
403 (bindings--define-key menu [end-of-buf]
404 '(menu-item "Goto End of Buffer" end-of-buffer))
405 (bindings--define-key menu [beg-of-buf]
406 '(menu-item "Goto Beginning of Buffer" beginning-of-buffer))
407 (bindings--define-key menu [go-to-pos]
408 '(menu-item "Goto Buffer Position..." goto-char
409 :help "Read a number N and go to buffer position N"))
410 (bindings--define-key menu [go-to-line]
411 '(menu-item "Goto Line..." goto-line
412 :help "Read a line number and go to that line"))
413 menu))
415 (defun menu-bar-goto-uses-etags-p ()
416 (or (not (boundp 'xref-backend-functions))
417 (eq (car xref-backend-functions) 'etags--xref-backend)))
419 (defvar yank-menu (cons (purecopy "Select Yank") nil))
420 (fset 'yank-menu (cons 'keymap yank-menu))
422 (defvar menu-bar-edit-menu
423 (let ((menu (make-sparse-keymap "Edit")))
425 (bindings--define-key menu [props]
426 `(menu-item "Text Properties" facemenu-menu))
428 ;; ns-win.el said: Add spell for platform consistency.
429 (if (featurep 'ns)
430 (bindings--define-key menu [spell]
431 `(menu-item "Spell" ispell-menu-map)))
433 (bindings--define-key menu [fill]
434 `(menu-item "Fill" fill-region
435 :enable (and mark-active (not buffer-read-only))
436 :help
437 "Fill text in region to fit between left and right margin"))
439 (bindings--define-key menu [separator-bookmark]
440 menu-bar-separator)
442 (bindings--define-key menu [bookmark]
443 `(menu-item "Bookmarks" menu-bar-bookmark-map))
445 (bindings--define-key menu [goto]
446 `(menu-item "Go To" ,menu-bar-goto-menu))
448 (bindings--define-key menu [replace]
449 `(menu-item "Replace" ,menu-bar-replace-menu))
451 (bindings--define-key menu [search]
452 `(menu-item "Search" ,menu-bar-search-menu))
454 (bindings--define-key menu [separator-search]
455 menu-bar-separator)
457 (bindings--define-key menu [mark-whole-buffer]
458 '(menu-item "Select All" mark-whole-buffer
459 :help "Mark the whole buffer for a subsequent cut/copy"))
460 (bindings--define-key menu [clear]
461 '(menu-item "Clear" delete-region
462 :enable (and mark-active
463 (not buffer-read-only))
464 :help
465 "Delete the text in region between mark and current position"))
468 (bindings--define-key menu (if (featurep 'ns) [select-paste]
469 [paste-from-menu])
470 ;; ns-win.el said: Change text to be more consistent with
471 ;; surrounding menu items `paste', etc."
472 `(menu-item ,(if (featurep 'ns) "Select and Paste" "Paste from Kill Menu")
473 yank-menu
474 :enable (and (cdr yank-menu) (not buffer-read-only))
475 :help "Choose a string from the kill ring and paste it"))
476 (bindings--define-key menu [paste]
477 `(menu-item "Paste" yank
478 :enable (funcall
479 ',(lambda ()
480 (and (or
481 (gui-backend-selection-exists-p 'CLIPBOARD)
482 (if (featurep 'ns) ; like paste-from-menu
483 (cdr yank-menu)
484 kill-ring))
485 (not buffer-read-only))))
486 :help "Paste (yank) text most recently cut/copied"))
487 (bindings--define-key menu [copy]
488 ;; ns-win.el said: Substitute a Copy function that works better
489 ;; under X (for GNUstep).
490 `(menu-item "Copy" ,(if (featurep 'ns)
491 'ns-copy-including-secondary
492 'kill-ring-save)
493 :enable mark-active
494 :help "Copy text in region between mark and current position"
495 :keys ,(if (featurep 'ns)
496 "\\[ns-copy-including-secondary]"
497 "\\[kill-ring-save]")))
498 (bindings--define-key menu [cut]
499 '(menu-item "Cut" kill-region
500 :enable (and mark-active (not buffer-read-only))
501 :help
502 "Cut (kill) text in region between mark and current position"))
503 ;; ns-win.el said: Separate undo from cut/paste section.
504 (if (featurep 'ns)
505 (bindings--define-key menu [separator-undo] menu-bar-separator))
507 (bindings--define-key menu [undo]
508 '(menu-item "Undo" undo
509 :enable (and (not buffer-read-only)
510 (not (eq t buffer-undo-list))
511 (if (eq last-command 'undo)
512 (listp pending-undo-list)
513 (consp buffer-undo-list)))
514 :help "Undo last operation"))
516 menu))
518 (define-obsolete-function-alias
519 'menu-bar-kill-ring-save 'kill-ring-save "24.1")
521 ;; These are alternative definitions for the cut, paste and copy
522 ;; menu items. Use them if your system expects these to use the clipboard.
524 (put 'clipboard-kill-region 'menu-enable
525 '(and mark-active (not buffer-read-only)))
526 (put 'clipboard-kill-ring-save 'menu-enable 'mark-active)
527 (put 'clipboard-yank 'menu-enable
528 `(funcall ',(lambda ()
529 (and (or (gui-backend-selection-exists-p 'PRIMARY)
530 (gui-backend-selection-exists-p 'CLIPBOARD))
531 (not buffer-read-only)))))
533 (defun clipboard-yank ()
534 "Insert the clipboard contents, or the last stretch of killed text."
535 (interactive "*")
536 (let ((select-enable-clipboard t))
537 (yank)))
539 (defun clipboard-kill-ring-save (beg end &optional region)
540 "Copy region to kill ring, and save in the GUI's clipboard.
541 If the optional argument REGION is non-nil, the function ignores
542 BEG and END, and saves the current region instead."
543 (interactive "r\np")
544 (let ((select-enable-clipboard t))
545 (kill-ring-save beg end region)))
547 (defun clipboard-kill-region (beg end &optional region)
548 "Kill the region, and save it in the GUI's clipboard.
549 If the optional argument REGION is non-nil, the function ignores
550 BEG and END, and kills the current region instead."
551 (interactive "r\np")
552 (let ((select-enable-clipboard t))
553 (kill-region beg end region)))
555 (defun menu-bar-enable-clipboard ()
556 "Make CUT, PASTE and COPY (keys and menu bar items) use the clipboard.
557 Do the same for the keys of the same name."
558 (interactive)
559 ;; These are Sun server keysyms for the Cut, Copy and Paste keys
560 ;; (also for XFree86 on Sun keyboard):
561 (define-key global-map [f20] 'clipboard-kill-region)
562 (define-key global-map [f16] 'clipboard-kill-ring-save)
563 (define-key global-map [f18] 'clipboard-yank)
564 ;; X11R6 versions:
565 (define-key global-map [cut] 'clipboard-kill-region)
566 (define-key global-map [copy] 'clipboard-kill-ring-save)
567 (define-key global-map [paste] 'clipboard-yank))
569 ;; The "Options" menu items
571 (defvar menu-bar-custom-menu
572 (let ((menu (make-sparse-keymap "Customize")))
574 (bindings--define-key menu [customize-apropos-faces]
575 '(menu-item "Faces Matching..." customize-apropos-faces
576 :help "Browse faces matching a regexp or word list"))
577 (bindings--define-key menu [customize-apropos-options]
578 '(menu-item "Options Matching..." customize-apropos-options
579 :help "Browse options matching a regexp or word list"))
580 (bindings--define-key menu [customize-apropos]
581 '(menu-item "All Settings Matching..." customize-apropos
582 :help "Browse customizable settings matching a regexp or word list"))
583 (bindings--define-key menu [separator-1]
584 menu-bar-separator)
585 (bindings--define-key menu [customize-group]
586 '(menu-item "Specific Group..." customize-group
587 :help "Customize settings of specific group"))
588 (bindings--define-key menu [customize-face]
589 '(menu-item "Specific Face..." customize-face
590 :help "Customize attributes of specific face"))
591 (bindings--define-key menu [customize-option]
592 '(menu-item "Specific Option..." customize-option
593 :help "Customize value of specific option"))
594 (bindings--define-key menu [separator-2]
595 menu-bar-separator)
596 (bindings--define-key menu [customize-changed-options]
597 '(menu-item "New Options..." customize-changed-options
598 :help "Options added or changed in recent Emacs versions"))
599 (bindings--define-key menu [customize-saved]
600 '(menu-item "Saved Options" customize-saved
601 :help "Customize previously saved options"))
602 (bindings--define-key menu [separator-3]
603 menu-bar-separator)
604 (bindings--define-key menu [customize-browse]
605 '(menu-item "Browse Customization Groups" customize-browse
606 :help "Browse all customization groups"))
607 (bindings--define-key menu [customize]
608 '(menu-item "Top-level Customization Group" customize
609 :help "The master group called `Emacs'"))
610 (bindings--define-key menu [customize-themes]
611 '(menu-item "Custom Themes" customize-themes
612 :help "Choose a pre-defined customization theme"))
613 menu))
614 ;(defvar menu-bar-preferences-menu (make-sparse-keymap "Preferences"))
616 (defmacro menu-bar-make-mm-toggle (fname doc help &optional props)
617 "Make a menu-item for a global minor mode toggle.
618 FNAME is the minor mode's name (variable and function).
619 DOC is the text to use for the menu entry.
620 HELP is the text to use for the tooltip.
621 PROPS are additional properties."
622 `'(menu-item ,doc ,fname
623 ,@props
624 :help ,help
625 :button (:toggle . (and (default-boundp ',fname)
626 (default-value ',fname)))))
628 (defmacro menu-bar-make-toggle (name variable doc message help &rest body)
629 `(progn
630 (defun ,name (&optional interactively)
631 ,(concat "Toggle whether to " (downcase (substring help 0 1))
632 (substring help 1) ".
633 In an interactive call, record this option as a candidate for saving
634 by \"Save Options\" in Custom buffers.")
635 (interactive "p")
636 (if ,(if body `(progn . ,body)
637 `(progn
638 (custom-load-symbol ',variable)
639 (let ((set (or (get ',variable 'custom-set) 'set-default))
640 (get (or (get ',variable 'custom-get) 'default-value)))
641 (funcall set ',variable (not (funcall get ',variable))))))
642 (message ,message "enabled globally")
643 (message ,message "disabled globally"))
644 ;; The function `customize-mark-as-set' must only be called when
645 ;; a variable is set interactively, as the purpose is to mark it as
646 ;; a candidate for "Save Options", and we do not want to save options
647 ;; the user have already set explicitly in his init file.
648 (if interactively (customize-mark-as-set ',variable)))
649 '(menu-item ,doc ,name
650 :help ,help
651 :button (:toggle . (and (default-boundp ',variable)
652 (default-value ',variable))))))
654 ;; Function for setting/saving default font.
656 (defun menu-set-font ()
657 "Interactively select a font and make it the default on all frames.
659 The selected font will be the default on both the existing and future frames."
660 (interactive)
661 (set-frame-font (if (fboundp 'x-select-font)
662 (x-select-font)
663 (mouse-select-font))
664 nil t))
666 (defun menu-bar-options-save ()
667 "Save current values of Options menu items using Custom."
668 (interactive)
669 (let ((need-save nil))
670 ;; These are set with menu-bar-make-mm-toggle, which does not
671 ;; put on a customized-value property.
672 (dolist (elt '(global-display-line-numbers-mode display-line-numbers-type
673 line-number-mode column-number-mode size-indication-mode
674 cua-mode show-paren-mode transient-mark-mode
675 blink-cursor-mode display-time-mode display-battery-mode
676 ;; These are set by other functions that don't set
677 ;; the customized state. Having them here has the
678 ;; side-effect that turning them off via X
679 ;; resources acts like having customized them, but
680 ;; that seems harmless.
681 menu-bar-mode tool-bar-mode))
682 ;; FIXME ? It's a little annoying that running this command
683 ;; always loads cua-base, paren, time, and battery, even if they
684 ;; have not been customized in any way. (Due to custom-load-symbol.)
685 (and (customize-mark-to-save elt)
686 (setq need-save t)))
687 ;; These are set with `customize-set-variable'.
688 (dolist (elt '(scroll-bar-mode
689 debug-on-quit debug-on-error
690 ;; Somehow this works, when tool-bar and menu-bar don't.
691 tooltip-mode window-divider-mode
692 save-place uniquify-buffer-name-style fringe-mode
693 indicate-empty-lines indicate-buffer-boundaries
694 case-fold-search font-use-system-font
695 current-language-environment default-input-method
696 ;; Saving `text-mode-hook' is somewhat questionable,
697 ;; as we might get more than we bargain for, if
698 ;; other code may has added hooks as well.
699 ;; Nonetheless, not saving it would like be confuse
700 ;; more often.
701 ;; -- Per Abrahamsen <abraham@dina.kvl.dk> 2002-02-11.
702 text-mode-hook tool-bar-position))
703 (and (get elt 'customized-value)
704 (customize-mark-to-save elt)
705 (setq need-save t)))
706 (when (get 'default 'customized-face)
707 (put 'default 'saved-face (get 'default 'customized-face))
708 (put 'default 'customized-face nil)
709 (setq need-save t))
710 ;; Save if we changed anything.
711 (when need-save
712 (custom-save-all))))
715 ;;; Assemble all the top-level items of the "Options" menu
717 ;; The "Show/Hide" submenu of menu "Options"
719 (defun menu-bar-window-divider-customize ()
720 "Show customization buffer for `window-divider' group."
721 (interactive)
722 (customize-group 'window-divider))
724 (defun menu-bar-bottom-and-right-window-divider ()
725 "Display dividers on the bottom and right of each window."
726 (interactive)
727 (customize-set-variable 'window-divider-default-places t)
728 (window-divider-mode 1))
730 (defun menu-bar-right-window-divider ()
731 "Display dividers only on the right of each window."
732 (interactive)
733 (customize-set-variable 'window-divider-default-places 'right-only)
734 (window-divider-mode 1))
736 (defun menu-bar-bottom-window-divider ()
737 "Display dividers only at the bottom of each window."
738 (interactive)
739 (customize-set-variable 'window-divider-default-places 'bottom-only)
740 (window-divider-mode 1))
742 (defun menu-bar-no-window-divider ()
743 "Do not display window dividers."
744 (interactive)
745 (window-divider-mode -1))
747 ;; For the radio buttons below we check whether the respective dividers
748 ;; are displayed on the selected frame. This is not fully congruent
749 ;; with `window-divider-mode' but makes the menu entries work also when
750 ;; dividers are displayed by manipulating frame parameters directly.
751 (defvar menu-bar-showhide-window-divider-menu
752 (let ((menu (make-sparse-keymap "Window Divider")))
753 (bindings--define-key menu [customize]
754 '(menu-item "Customize" menu-bar-window-divider-customize
755 :help "Customize window dividers"
756 :visible (memq (window-system) '(x w32))))
758 (bindings--define-key menu [bottom-and-right]
759 '(menu-item "Bottom and Right"
760 menu-bar-bottom-and-right-window-divider
761 :help "Display window divider on the bottom and right of each window"
762 :visible (memq (window-system) '(x w32))
763 :button (:radio
764 . (and (window-divider-width-valid-p
765 (cdr (assq 'bottom-divider-width
766 (frame-parameters))))
767 (window-divider-width-valid-p
768 (cdr (assq 'right-divider-width
769 (frame-parameters))))))))
770 (bindings--define-key menu [right-only]
771 '(menu-item "Right Only"
772 menu-bar-right-window-divider
773 :help "Display window divider on the right of each window only"
774 :visible (memq (window-system) '(x w32))
775 :button (:radio
776 . (and (not (window-divider-width-valid-p
777 (cdr (assq 'bottom-divider-width
778 (frame-parameters)))))
779 (window-divider-width-valid-p
780 (cdr (assq 'right-divider-width
781 (frame-parameters))))))))
782 (bindings--define-key menu [bottom-only]
783 '(menu-item "Bottom Only"
784 menu-bar-bottom-window-divider
785 :help "Display window divider on the bottom of each window only"
786 :visible (memq (window-system) '(x w32))
787 :button (:radio
788 . (and (window-divider-width-valid-p
789 (cdr (assq 'bottom-divider-width
790 (frame-parameters))))
791 (not (window-divider-width-valid-p
792 (cdr (assq 'right-divider-width
793 (frame-parameters)))))))))
794 (bindings--define-key menu [no-divider]
795 '(menu-item "None"
796 menu-bar-no-window-divider
797 :help "Do not display window dividers"
798 :visible (memq (window-system) '(x w32))
799 :button (:radio
800 . (and (not (window-divider-width-valid-p
801 (cdr (assq 'bottom-divider-width
802 (frame-parameters)))))
803 (not (window-divider-width-valid-p
804 (cdr (assq 'right-divider-width
805 (frame-parameters)))))))))
806 menu))
808 (defun menu-bar-showhide-fringe-ind-customize ()
809 "Show customization buffer for `indicate-buffer-boundaries'."
810 (interactive)
811 (customize-variable 'indicate-buffer-boundaries))
813 (defun menu-bar-showhide-fringe-ind-mixed ()
814 "Display top and bottom indicators in opposite fringes, arrows in right."
815 (interactive)
816 (customize-set-variable 'indicate-buffer-boundaries
817 '((t . right) (top . left))))
819 (defun menu-bar-showhide-fringe-ind-box ()
820 "Display top and bottom indicators in opposite fringes."
821 (interactive)
822 (customize-set-variable 'indicate-buffer-boundaries
823 '((top . left) (bottom . right))))
825 (defun menu-bar-showhide-fringe-ind-right ()
826 "Display buffer boundaries and arrows in the right fringe."
827 (interactive)
828 (customize-set-variable 'indicate-buffer-boundaries 'right))
830 (defun menu-bar-showhide-fringe-ind-left ()
831 "Display buffer boundaries and arrows in the left fringe."
832 (interactive)
833 (customize-set-variable 'indicate-buffer-boundaries 'left))
835 (defun menu-bar-showhide-fringe-ind-none ()
836 "Do not display any buffer boundary indicators."
837 (interactive)
838 (customize-set-variable 'indicate-buffer-boundaries nil))
840 (defvar menu-bar-showhide-fringe-ind-menu
841 (let ((menu (make-sparse-keymap "Buffer boundaries")))
843 (bindings--define-key menu [customize]
844 '(menu-item "Other (Customize)"
845 menu-bar-showhide-fringe-ind-customize
846 :help "Additional choices available through Custom buffer"
847 :visible (display-graphic-p)
848 :button (:radio . (not (member indicate-buffer-boundaries
849 '(nil left right
850 ((top . left) (bottom . right))
851 ((t . right) (top . left))))))))
853 (bindings--define-key menu [mixed]
854 '(menu-item "Opposite, Arrows Right" menu-bar-showhide-fringe-ind-mixed
855 :help
856 "Show top/bottom indicators in opposite fringes, arrows in right"
857 :visible (display-graphic-p)
858 :button (:radio . (equal indicate-buffer-boundaries
859 '((t . right) (top . left))))))
861 (bindings--define-key menu [box]
862 '(menu-item "Opposite, No Arrows" menu-bar-showhide-fringe-ind-box
863 :help "Show top/bottom indicators in opposite fringes, no arrows"
864 :visible (display-graphic-p)
865 :button (:radio . (equal indicate-buffer-boundaries
866 '((top . left) (bottom . right))))))
868 (bindings--define-key menu [right]
869 '(menu-item "In Right Fringe" menu-bar-showhide-fringe-ind-right
870 :help "Show buffer boundaries and arrows in right fringe"
871 :visible (display-graphic-p)
872 :button (:radio . (eq indicate-buffer-boundaries 'right))))
874 (bindings--define-key menu [left]
875 '(menu-item "In Left Fringe" menu-bar-showhide-fringe-ind-left
876 :help "Show buffer boundaries and arrows in left fringe"
877 :visible (display-graphic-p)
878 :button (:radio . (eq indicate-buffer-boundaries 'left))))
880 (bindings--define-key menu [none]
881 '(menu-item "No Indicators" menu-bar-showhide-fringe-ind-none
882 :help "Hide all buffer boundary indicators and arrows"
883 :visible (display-graphic-p)
884 :button (:radio . (eq indicate-buffer-boundaries nil))))
885 menu))
887 (defun menu-bar-showhide-fringe-menu-customize ()
888 "Show customization buffer for `fringe-mode'."
889 (interactive)
890 (customize-variable 'fringe-mode))
892 (defun menu-bar-showhide-fringe-menu-customize-reset ()
893 "Reset the fringe mode: display fringes on both sides of a window."
894 (interactive)
895 (customize-set-variable 'fringe-mode nil))
897 (defun menu-bar-showhide-fringe-menu-customize-right ()
898 "Display fringes only on the right of each window."
899 (interactive)
900 (require 'fringe)
901 (customize-set-variable 'fringe-mode '(0 . nil)))
903 (defun menu-bar-showhide-fringe-menu-customize-left ()
904 "Display fringes only on the left of each window."
905 (interactive)
906 (require 'fringe)
907 (customize-set-variable 'fringe-mode '(nil . 0)))
909 (defun menu-bar-showhide-fringe-menu-customize-disable ()
910 "Do not display window fringes."
911 (interactive)
912 (require 'fringe)
913 (customize-set-variable 'fringe-mode 0))
915 (defvar menu-bar-showhide-fringe-menu
916 (let ((menu (make-sparse-keymap "Fringe")))
918 (bindings--define-key menu [showhide-fringe-ind]
919 `(menu-item "Buffer Boundaries" ,menu-bar-showhide-fringe-ind-menu
920 :visible (display-graphic-p)
921 :help "Indicate buffer boundaries in fringe"))
923 (bindings--define-key menu [indicate-empty-lines]
924 (menu-bar-make-toggle toggle-indicate-empty-lines indicate-empty-lines
925 "Empty Line Indicators"
926 "Indicating of empty lines %s"
927 "Indicate trailing empty lines in fringe, globally"))
929 (bindings--define-key menu [customize]
930 '(menu-item "Customize Fringe" menu-bar-showhide-fringe-menu-customize
931 :help "Detailed customization of fringe"
932 :visible (display-graphic-p)))
934 (bindings--define-key menu [default]
935 '(menu-item "Default" menu-bar-showhide-fringe-menu-customize-reset
936 :help "Default width fringe on both left and right side"
937 :visible (display-graphic-p)
938 :button (:radio . (eq fringe-mode nil))))
940 (bindings--define-key menu [right]
941 '(menu-item "On the Right" menu-bar-showhide-fringe-menu-customize-right
942 :help "Fringe only on the right side"
943 :visible (display-graphic-p)
944 :button (:radio . (equal fringe-mode '(0 . nil)))))
946 (bindings--define-key menu [left]
947 '(menu-item "On the Left" menu-bar-showhide-fringe-menu-customize-left
948 :help "Fringe only on the left side"
949 :visible (display-graphic-p)
950 :button (:radio . (equal fringe-mode '(nil . 0)))))
952 (bindings--define-key menu [none]
953 '(menu-item "None" menu-bar-showhide-fringe-menu-customize-disable
954 :help "Turn off fringe"
955 :visible (display-graphic-p)
956 :button (:radio . (eq fringe-mode 0))))
957 menu))
959 (defun menu-bar-right-scroll-bar ()
960 "Display scroll bars on the right of each window."
961 (interactive)
962 (customize-set-variable 'scroll-bar-mode 'right))
964 (defun menu-bar-left-scroll-bar ()
965 "Display scroll bars on the left of each window."
966 (interactive)
967 (customize-set-variable 'scroll-bar-mode 'left))
969 (defun menu-bar-no-scroll-bar ()
970 "Turn off scroll bars."
971 (interactive)
972 (customize-set-variable 'scroll-bar-mode nil))
974 (defvar menu-bar-showhide-scroll-bar-menu
975 (let ((menu (make-sparse-keymap "Scroll Bar")))
977 (bindings--define-key menu [horizontal]
978 (menu-bar-make-mm-toggle horizontal-scroll-bar-mode
979 "Horizontal"
980 "Horizontal scroll bar"))
982 (bindings--define-key menu [scrollbar-separator]
983 menu-bar-separator)
985 (bindings--define-key menu [right]
986 '(menu-item "On the Right" menu-bar-right-scroll-bar
987 :help "Scroll bar on the right side"
988 :visible (display-graphic-p)
989 :button (:radio . (and scroll-bar-mode
990 (eq (frame-parameter
991 nil 'vertical-scroll-bars)
992 'right)))))
994 (bindings--define-key menu [left]
995 '(menu-item "On the Left" menu-bar-left-scroll-bar
996 :help "Scroll bar on the left side"
997 :visible (display-graphic-p)
998 :button (:radio . (and scroll-bar-mode
999 (eq (frame-parameter
1000 nil 'vertical-scroll-bars)
1001 'left)))))
1003 (bindings--define-key menu [none]
1004 '(menu-item "No Vertical Scroll Bar" menu-bar-no-scroll-bar
1005 :help "Turn off vertical scroll bar"
1006 :visible (display-graphic-p)
1007 :button (:radio . (eq scroll-bar-mode nil))))
1008 menu))
1010 (defun menu-bar-frame-for-menubar ()
1011 "Return the frame suitable for updating the menu bar."
1012 (or (and (framep menu-updating-frame)
1013 menu-updating-frame)
1014 (selected-frame)))
1016 (defun menu-bar-positive-p (val)
1017 "Return non-nil if VAL is a positive number."
1018 (and (numberp val)
1019 (> val 0)))
1021 (defun menu-bar-set-tool-bar-position (position)
1022 (customize-set-variable 'tool-bar-mode t)
1023 (customize-set-variable 'tool-bar-position position))
1024 (defun menu-bar-showhide-tool-bar-menu-customize-disable ()
1025 "Do not display tool bars."
1026 (interactive)
1027 (customize-set-variable 'tool-bar-mode nil))
1028 (defun menu-bar-showhide-tool-bar-menu-customize-enable-left ()
1029 "Display tool bars on the left side."
1030 (interactive)
1031 (menu-bar-set-tool-bar-position 'left))
1032 (defun menu-bar-showhide-tool-bar-menu-customize-enable-right ()
1033 "Display tool bars on the right side."
1034 (interactive)
1035 (menu-bar-set-tool-bar-position 'right))
1036 (defun menu-bar-showhide-tool-bar-menu-customize-enable-top ()
1037 "Display tool bars on the top side."
1038 (interactive)
1039 (menu-bar-set-tool-bar-position 'top))
1040 (defun menu-bar-showhide-tool-bar-menu-customize-enable-bottom ()
1041 "Display tool bars on the bottom side."
1042 (interactive)
1043 (menu-bar-set-tool-bar-position 'bottom))
1045 (when (featurep 'move-toolbar)
1046 (defvar menu-bar-showhide-tool-bar-menu
1047 (let ((menu (make-sparse-keymap "Tool Bar")))
1049 (bindings--define-key menu [showhide-tool-bar-left]
1050 '(menu-item "On the Left"
1051 menu-bar-showhide-tool-bar-menu-customize-enable-left
1052 :help "Tool bar at the left side"
1053 :visible (display-graphic-p)
1054 :button
1055 (:radio . (and tool-bar-mode
1056 (frame-parameter
1057 (menu-bar-frame-for-menubar)
1058 'tool-bar-position)
1059 'left))))
1061 (bindings--define-key menu [showhide-tool-bar-right]
1062 '(menu-item "On the Right"
1063 menu-bar-showhide-tool-bar-menu-customize-enable-right
1064 :help "Tool bar at the right side"
1065 :visible (display-graphic-p)
1066 :button
1067 (:radio . (and tool-bar-mode
1068 (eq (frame-parameter
1069 (menu-bar-frame-for-menubar)
1070 'tool-bar-position)
1071 'right)))))
1073 (bindings--define-key menu [showhide-tool-bar-bottom]
1074 '(menu-item "On the Bottom"
1075 menu-bar-showhide-tool-bar-menu-customize-enable-bottom
1076 :help "Tool bar at the bottom"
1077 :visible (display-graphic-p)
1078 :button
1079 (:radio . (and tool-bar-mode
1080 (eq (frame-parameter
1081 (menu-bar-frame-for-menubar)
1082 'tool-bar-position)
1083 'bottom)))))
1085 (bindings--define-key menu [showhide-tool-bar-top]
1086 '(menu-item "On the Top"
1087 menu-bar-showhide-tool-bar-menu-customize-enable-top
1088 :help "Tool bar at the top"
1089 :visible (display-graphic-p)
1090 :button
1091 (:radio . (and tool-bar-mode
1092 (eq (frame-parameter
1093 (menu-bar-frame-for-menubar)
1094 'tool-bar-position)
1095 'top)))))
1097 (bindings--define-key menu [showhide-tool-bar-none]
1098 '(menu-item "None"
1099 menu-bar-showhide-tool-bar-menu-customize-disable
1100 :help "Turn tool bar off"
1101 :visible (display-graphic-p)
1102 :button (:radio . (eq tool-bar-mode nil))))
1103 menu)))
1105 (defvar display-line-numbers-type)
1106 (defun menu-bar-display-line-numbers-mode (type)
1107 (setq display-line-numbers-type type)
1108 (if global-display-line-numbers-mode
1109 (global-display-line-numbers-mode)
1110 (display-line-numbers-mode)))
1112 (defvar menu-bar-showhide-line-numbers-menu
1113 (let ((menu (make-sparse-keymap "Line Numbers")))
1115 (bindings--define-key menu [visual]
1116 `(menu-item "Visual Line Numbers"
1117 ,(lambda ()
1118 (interactive)
1119 (menu-bar-display-line-numbers-mode 'visual)
1120 (message "Visual line numbers enabled"))
1121 :help "Enable visual line numbers"
1122 :button (:radio . (eq display-line-numbers 'visual))
1123 :visible (menu-bar-menu-frame-live-and-visible-p)))
1125 (bindings--define-key menu [relative]
1126 `(menu-item "Relative Line Numbers"
1127 ,(lambda ()
1128 (interactive)
1129 (menu-bar-display-line-numbers-mode 'relative)
1130 (message "Relative line numbers enabled"))
1131 :help "Enable relative line numbers"
1132 :button (:radio . (eq display-line-numbers 'relative))
1133 :visible (menu-bar-menu-frame-live-and-visible-p)))
1135 (bindings--define-key menu [absolute]
1136 `(menu-item "Absolute Line Numbers"
1137 ,(lambda ()
1138 (interactive)
1139 (menu-bar-display-line-numbers-mode t)
1140 (setq display-line-numbers t)
1141 (message "Absolute line numbers enabled"))
1142 :help "Enable absolute line numbers"
1143 :button (:radio . (eq display-line-numbers t))
1144 :visible (menu-bar-menu-frame-live-and-visible-p)))
1146 (bindings--define-key menu [none]
1147 `(menu-item "No Line Numbers"
1148 ,(lambda ()
1149 (interactive)
1150 (menu-bar-display-line-numbers-mode nil)
1151 (message "Line numbers disabled"))
1152 :help "Disable line numbers"
1153 :button (:radio . (null display-line-numbers))
1154 :visible (menu-bar-menu-frame-live-and-visible-p)))
1156 (bindings--define-key menu [global]
1157 (menu-bar-make-mm-toggle global-display-line-numbers-mode
1158 "Global Line Numbers Mode"
1159 "Set line numbers globally"))
1160 menu))
1162 (defvar menu-bar-showhide-menu
1163 (let ((menu (make-sparse-keymap "Show/Hide")))
1165 (bindings--define-key menu [display-line-numbers]
1166 `(menu-item "Line Numbers for All Lines"
1167 ,menu-bar-showhide-line-numbers-menu))
1169 (bindings--define-key menu [column-number-mode]
1170 (menu-bar-make-mm-toggle column-number-mode
1171 "Column Numbers in Mode Line"
1172 "Show the current column number in the mode line"))
1174 (bindings--define-key menu [line-number-mode]
1175 (menu-bar-make-mm-toggle line-number-mode
1176 "Line Numbers in Mode Line"
1177 "Show the current line number in the mode line"))
1179 (bindings--define-key menu [size-indication-mode]
1180 (menu-bar-make-mm-toggle size-indication-mode
1181 "Size Indication"
1182 "Show the size of the buffer in the mode line"))
1184 (bindings--define-key menu [linecolumn-separator]
1185 menu-bar-separator)
1187 (bindings--define-key menu [showhide-battery]
1188 (menu-bar-make-mm-toggle display-battery-mode
1189 "Battery Status"
1190 "Display battery status information in mode line"))
1192 (bindings--define-key menu [showhide-date-time]
1193 (menu-bar-make-mm-toggle display-time-mode
1194 "Time, Load and Mail"
1195 "Display time, system load averages and \
1196 mail status in mode line"))
1198 (bindings--define-key menu [datetime-separator]
1199 menu-bar-separator)
1201 (bindings--define-key menu [showhide-speedbar]
1202 '(menu-item "Speedbar" speedbar-frame-mode
1203 :help "Display a Speedbar quick-navigation frame"
1204 :button (:toggle
1205 . (and (boundp 'speedbar-frame)
1206 (frame-live-p (symbol-value 'speedbar-frame))
1207 (frame-visible-p
1208 (symbol-value 'speedbar-frame))))))
1210 (bindings--define-key menu [showhide-window-divider]
1211 `(menu-item "Window Divider" ,menu-bar-showhide-window-divider-menu
1212 :visible (memq (window-system) '(x w32))))
1214 (bindings--define-key menu [showhide-fringe]
1215 `(menu-item "Fringe" ,menu-bar-showhide-fringe-menu
1216 :visible (display-graphic-p)))
1218 (bindings--define-key menu [showhide-scroll-bar]
1219 `(menu-item "Scroll Bar" ,menu-bar-showhide-scroll-bar-menu
1220 :visible (display-graphic-p)))
1222 (bindings--define-key menu [showhide-tooltip-mode]
1223 '(menu-item "Tooltips" tooltip-mode
1224 :help "Turn tooltips on/off"
1225 :visible (and (display-graphic-p) (fboundp 'x-show-tip))
1226 :button (:toggle . tooltip-mode)))
1228 (bindings--define-key menu [menu-bar-mode]
1229 '(menu-item "Menu Bar" toggle-menu-bar-mode-from-frame
1230 :help "Turn menu bar on/off"
1231 :button
1232 (:toggle . (menu-bar-positive-p
1233 (frame-parameter (menu-bar-frame-for-menubar)
1234 'menu-bar-lines)))))
1236 (if (and (boundp 'menu-bar-showhide-tool-bar-menu)
1237 (keymapp menu-bar-showhide-tool-bar-menu))
1238 (bindings--define-key menu [showhide-tool-bar]
1239 `(menu-item "Tool Bar" ,menu-bar-showhide-tool-bar-menu
1240 :visible (display-graphic-p)))
1241 ;; else not tool bar that can move.
1242 (bindings--define-key menu [showhide-tool-bar]
1243 '(menu-item "Tool Bar" toggle-tool-bar-mode-from-frame
1244 :help "Turn tool bar on/off"
1245 :visible (display-graphic-p)
1246 :button
1247 (:toggle . (menu-bar-positive-p
1248 (frame-parameter (menu-bar-frame-for-menubar)
1249 'tool-bar-lines))))))
1250 menu))
1252 (defvar menu-bar-line-wrapping-menu
1253 (let ((menu (make-sparse-keymap "Line Wrapping")))
1255 (bindings--define-key menu [word-wrap]
1256 `(menu-item "Word Wrap (Visual Line mode)"
1257 ,(lambda ()
1258 (interactive)
1259 (unless visual-line-mode
1260 (visual-line-mode 1))
1261 (message "Visual-Line mode enabled"))
1262 :help "Wrap long lines at word boundaries"
1263 :button (:radio
1264 . (and (null truncate-lines)
1265 (not (truncated-partial-width-window-p))
1266 word-wrap))
1267 :visible (menu-bar-menu-frame-live-and-visible-p)))
1269 (bindings--define-key menu [truncate]
1270 `(menu-item "Truncate Long Lines"
1271 ,(lambda ()
1272 (interactive)
1273 (if visual-line-mode (visual-line-mode 0))
1274 (setq word-wrap nil)
1275 (toggle-truncate-lines 1))
1276 :help "Truncate long lines at window edge"
1277 :button (:radio . (or truncate-lines
1278 (truncated-partial-width-window-p)))
1279 :visible (menu-bar-menu-frame-live-and-visible-p)
1280 :enable (not (truncated-partial-width-window-p))))
1282 (bindings--define-key menu [window-wrap]
1283 `(menu-item "Wrap at Window Edge"
1284 ,(lambda () (interactive)
1285 (if visual-line-mode (visual-line-mode 0))
1286 (setq word-wrap nil)
1287 (if truncate-lines (toggle-truncate-lines -1)))
1288 :help "Wrap long lines at window edge"
1289 :button (:radio
1290 . (and (null truncate-lines)
1291 (not (truncated-partial-width-window-p))
1292 (not word-wrap)))
1293 :visible (menu-bar-menu-frame-live-and-visible-p)
1294 :enable (not (truncated-partial-width-window-p))))
1295 menu))
1297 (defvar menu-bar-search-options-menu
1298 (let ((menu (make-sparse-keymap "Search Options")))
1300 (dolist (x '((char-fold-to-regexp "Fold Characters" "Character folding")
1301 (isearch-symbol-regexp "Whole Symbols" "Whole symbol")
1302 (word-search-regexp "Whole Words" "Whole word")))
1303 (bindings--define-key menu (vector (nth 0 x))
1304 `(menu-item ,(nth 1 x)
1305 (lambda ()
1306 (interactive)
1307 (setq search-default-mode #',(nth 0 x))
1308 (message ,(format "%s search enabled" (nth 2 x))))
1309 :help ,(format "Enable %s search" (downcase (nth 2 x)))
1310 :button (:radio . (eq search-default-mode #',(nth 0 x))))))
1312 (bindings--define-key menu [regexp-search]
1313 '(menu-item "Regular Expression"
1314 (lambda ()
1315 (interactive)
1316 (setq search-default-mode t)
1317 (message "Regular-expression search enabled"))
1318 :help "Enable regular-expression search"
1319 :button (:radio . (eq search-default-mode t))))
1321 (bindings--define-key menu [regular-search]
1322 '(menu-item "Literal Search"
1323 (lambda ()
1324 (interactive)
1325 (when search-default-mode
1326 (setq search-default-mode nil)
1327 (when (symbolp search-default-mode)
1328 (message "Literal search enabled"))))
1329 :help "Disable special search modes"
1330 :button (:radio . (not search-default-mode))))
1332 (bindings--define-key menu [custom-separator]
1333 menu-bar-separator)
1334 (bindings--define-key menu [case-fold-search]
1335 (menu-bar-make-toggle
1336 toggle-case-fold-search case-fold-search
1337 "Ignore Case"
1338 "Case-Insensitive Search %s"
1339 "Ignore letter-case in search commands"))
1341 menu))
1343 (defvar menu-bar-options-menu
1344 (let ((menu (make-sparse-keymap "Options")))
1345 (bindings--define-key menu [customize]
1346 `(menu-item "Customize Emacs" ,menu-bar-custom-menu))
1348 (bindings--define-key menu [package]
1349 '(menu-item "Manage Emacs Packages" package-list-packages
1350 :help "Install or uninstall additional Emacs packages"))
1352 (bindings--define-key menu [save]
1353 '(menu-item "Save Options" menu-bar-options-save
1354 :help "Save options set from the menu above"))
1356 (bindings--define-key menu [custom-separator]
1357 menu-bar-separator)
1359 (bindings--define-key menu [menu-set-font]
1360 '(menu-item "Set Default Font..." menu-set-font
1361 :visible (display-multi-font-p)
1362 :help "Select a default font"))
1364 (if (featurep 'system-font-setting)
1365 (bindings--define-key menu [menu-system-font]
1366 (menu-bar-make-toggle
1367 toggle-use-system-font font-use-system-font
1368 "Use System Font"
1369 "Use system font: %s"
1370 "Use the monospaced font defined by the system")))
1372 (bindings--define-key menu [showhide]
1373 `(menu-item "Show/Hide" ,menu-bar-showhide-menu))
1375 (bindings--define-key menu [showhide-separator]
1376 menu-bar-separator)
1378 (bindings--define-key menu [mule]
1379 ;; It is better not to use backquote here,
1380 ;; because that makes a bootstrapping problem
1381 ;; if you need to recompile all the Lisp files using interpreted code.
1382 `(menu-item "Multilingual Environment" ,mule-menu-keymap))
1383 ;;(setq menu-bar-final-items (cons 'mule menu-bar-final-items))
1384 ;;(bindings--define-key menu [preferences]
1385 ;; `(menu-item "Preferences" ,menu-bar-preferences-menu
1386 ;; :help "Toggle important global options"))
1388 (bindings--define-key menu [mule-separator]
1389 menu-bar-separator)
1391 (bindings--define-key menu [debug-on-quit]
1392 (menu-bar-make-toggle toggle-debug-on-quit debug-on-quit
1393 "Enter Debugger on Quit/C-g" "Debug on Quit %s"
1394 "Enter Lisp debugger when C-g is pressed"))
1395 (bindings--define-key menu [debug-on-error]
1396 (menu-bar-make-toggle toggle-debug-on-error debug-on-error
1397 "Enter Debugger on Error" "Debug on Error %s"
1398 "Enter Lisp debugger when an error is signaled"))
1399 (bindings--define-key menu [debugger-separator]
1400 menu-bar-separator)
1402 (bindings--define-key menu [blink-cursor-mode]
1403 (menu-bar-make-mm-toggle
1404 blink-cursor-mode
1405 "Blink Cursor"
1406 "Whether the cursor blinks (Blink Cursor mode)"))
1407 (bindings--define-key menu [cursor-separator]
1408 menu-bar-separator)
1410 (bindings--define-key menu [save-place]
1411 (menu-bar-make-toggle
1412 toggle-save-place-globally save-place
1413 "Save Place in Files between Sessions"
1414 "Saving place in files %s"
1415 "Visit files of previous session when restarting Emacs"
1416 (require 'saveplace)
1417 ;; Do it by name, to avoid a free-variable
1418 ;; warning during byte compilation.
1419 (set-default
1420 'save-place (not (symbol-value 'save-place)))))
1422 (bindings--define-key menu [uniquify]
1423 (menu-bar-make-toggle
1424 toggle-uniquify-buffer-names uniquify-buffer-name-style
1425 "Use Directory Names in Buffer Names"
1426 "Directory name in buffer names (uniquify) %s"
1427 "Uniquify buffer names by adding parent directory names"
1428 (setq uniquify-buffer-name-style
1429 (if (not uniquify-buffer-name-style)
1430 'post-forward-angle-brackets))))
1432 (bindings--define-key menu [edit-options-separator]
1433 menu-bar-separator)
1434 (bindings--define-key menu [cua-mode]
1435 (menu-bar-make-mm-toggle
1436 cua-mode
1437 "Use CUA Keys (Cut/Paste with C-x/C-c/C-v)"
1438 "Use C-z/C-x/C-c/C-v keys for undo/cut/copy/paste"
1439 (:visible (or (not (boundp 'cua-enable-cua-keys))
1440 cua-enable-cua-keys))))
1442 (bindings--define-key menu [cua-emulation-mode]
1443 (menu-bar-make-mm-toggle
1444 cua-mode
1445 "Shift movement mark region (CUA)"
1446 "Use shifted movement keys to set and extend the region"
1447 (:visible (and (boundp 'cua-enable-cua-keys)
1448 (not cua-enable-cua-keys)))))
1450 (bindings--define-key menu [search-options]
1451 `(menu-item "Default Search Options"
1452 ,menu-bar-search-options-menu))
1454 (bindings--define-key menu [line-wrapping]
1455 `(menu-item "Line Wrapping in This Buffer"
1456 ,menu-bar-line-wrapping-menu))
1459 (bindings--define-key menu [highlight-separator]
1460 menu-bar-separator)
1461 (bindings--define-key menu [highlight-paren-mode]
1462 (menu-bar-make-mm-toggle
1463 show-paren-mode
1464 "Highlight Matching Parentheses"
1465 "Highlight matching/mismatched parentheses at cursor (Show Paren mode)"))
1466 (bindings--define-key menu [transient-mark-mode]
1467 (menu-bar-make-mm-toggle
1468 transient-mark-mode
1469 "Highlight Active Region"
1470 "Make text in active region stand out in color (Transient Mark mode)"
1471 (:enable (not cua-mode))))
1472 menu))
1475 ;; The "Tools" menu items
1477 (defvar menu-bar-games-menu
1478 (let ((menu (make-sparse-keymap "Games")))
1480 (bindings--define-key menu [zone]
1481 '(menu-item "Zone Out" zone
1482 :help "Play tricks with Emacs display when Emacs is idle"))
1483 (bindings--define-key menu [tetris]
1484 '(menu-item "Tetris" tetris
1485 :help "Falling blocks game"))
1486 (bindings--define-key menu [solitaire]
1487 '(menu-item "Solitaire" solitaire
1488 :help "Get rid of all the stones"))
1489 (bindings--define-key menu [snake]
1490 '(menu-item "Snake" snake
1491 :help "Move snake around avoiding collisions"))
1492 (bindings--define-key menu [pong]
1493 '(menu-item "Pong" pong
1494 :help "Bounce the ball to your opponent"))
1495 (bindings--define-key menu [mult]
1496 '(menu-item "Multiplication Puzzle" mpuz
1497 :help "Exercise brain with multiplication"))
1498 (bindings--define-key menu [life]
1499 '(menu-item "Life" life
1500 :help "Watch how John Conway's cellular automaton evolves"))
1501 (bindings--define-key menu [hanoi]
1502 '(menu-item "Towers of Hanoi" hanoi
1503 :help "Watch Towers-of-Hanoi puzzle solved by Emacs"))
1504 (bindings--define-key menu [gomoku]
1505 '(menu-item "Gomoku" gomoku
1506 :help "Mark 5 contiguous squares (like tic-tac-toe)"))
1507 (bindings--define-key menu [bubbles]
1508 '(menu-item "Bubbles" bubbles
1509 :help "Remove all bubbles using the fewest moves"))
1510 (bindings--define-key menu [black-box]
1511 '(menu-item "Blackbox" blackbox
1512 :help "Find balls in a black box by shooting rays"))
1513 (bindings--define-key menu [adventure]
1514 '(menu-item "Adventure" dunnet
1515 :help "Dunnet, a text Adventure game for Emacs"))
1516 (bindings--define-key menu [5x5]
1517 '(menu-item "5x5" 5x5
1518 :help "Fill in all the squares on a 5x5 board"))
1519 menu))
1521 (defvar menu-bar-encryption-decryption-menu
1522 (let ((menu (make-sparse-keymap "Encryption/Decryption")))
1523 (bindings--define-key menu [insert-keys]
1524 '(menu-item "Insert Keys" epa-insert-keys
1525 :help "Insert public keys after the current point"))
1527 (bindings--define-key menu [export-keys]
1528 '(menu-item "Export Keys" epa-export-keys
1529 :help "Export public keys to a file"))
1531 (bindings--define-key menu [import-keys-region]
1532 '(menu-item "Import Keys from Region" epa-import-keys-region
1533 :help "Import public keys from the current region"))
1535 (bindings--define-key menu [import-keys]
1536 '(menu-item "Import Keys from File..." epa-import-keys
1537 :help "Import public keys from a file"))
1539 (bindings--define-key menu [list-keys]
1540 '(menu-item "List Keys" epa-list-keys
1541 :help "Browse your public keyring"))
1543 (bindings--define-key menu [separator-keys]
1544 menu-bar-separator)
1546 (bindings--define-key menu [sign-region]
1547 '(menu-item "Sign Region" epa-sign-region
1548 :help "Create digital signature of the current region"))
1550 (bindings--define-key menu [verify-region]
1551 '(menu-item "Verify Region" epa-verify-region
1552 :help "Verify digital signature of the current region"))
1554 (bindings--define-key menu [encrypt-region]
1555 '(menu-item "Encrypt Region" epa-encrypt-region
1556 :help "Encrypt the current region"))
1558 (bindings--define-key menu [decrypt-region]
1559 '(menu-item "Decrypt Region" epa-decrypt-region
1560 :help "Decrypt the current region"))
1562 (bindings--define-key menu [separator-file]
1563 menu-bar-separator)
1565 (bindings--define-key menu [sign-file]
1566 '(menu-item "Sign File..." epa-sign-file
1567 :help "Create digital signature of a file"))
1569 (bindings--define-key menu [verify-file]
1570 '(menu-item "Verify File..." epa-verify-file
1571 :help "Verify digital signature of a file"))
1573 (bindings--define-key menu [encrypt-file]
1574 '(menu-item "Encrypt File..." epa-encrypt-file
1575 :help "Encrypt a file"))
1577 (bindings--define-key menu [decrypt-file]
1578 '(menu-item "Decrypt File..." epa-decrypt-file
1579 :help "Decrypt a file"))
1581 menu))
1583 (defun menu-bar-read-mail ()
1584 "Read mail using `read-mail-command'."
1585 (interactive)
1586 (call-interactively read-mail-command))
1588 (defvar menu-bar-tools-menu
1589 (let ((menu (make-sparse-keymap "Tools")))
1591 (bindings--define-key menu [games]
1592 `(menu-item "Games" ,menu-bar-games-menu))
1594 (bindings--define-key menu [separator-games]
1595 menu-bar-separator)
1597 (bindings--define-key menu [encryption-decryption]
1598 `(menu-item "Encryption/Decryption"
1599 ,menu-bar-encryption-decryption-menu))
1601 (bindings--define-key menu [separator-encryption-decryption]
1602 menu-bar-separator)
1604 (bindings--define-key menu [simple-calculator]
1605 '(menu-item "Simple Calculator" calculator
1606 :help "Invoke the Emacs built-in quick calculator"))
1607 (bindings--define-key menu [calc]
1608 '(menu-item "Programmable Calculator" calc
1609 :help "Invoke the Emacs built-in full scientific calculator"))
1610 (bindings--define-key menu [calendar]
1611 '(menu-item "Calendar" calendar
1612 :help "Invoke the Emacs built-in calendar"))
1614 (bindings--define-key menu [separator-net]
1615 menu-bar-separator)
1617 (bindings--define-key menu [browse-web]
1618 '(menu-item "Browse the Web..." browse-web))
1619 (bindings--define-key menu [directory-search]
1620 '(menu-item "Directory Servers" eudc-tools-menu))
1621 (bindings--define-key menu [compose-mail]
1622 '(menu-item "Compose New Mail" compose-mail
1623 :visible (and mail-user-agent (not (eq mail-user-agent 'ignore)))
1624 :help "Start writing a new mail message"))
1625 (bindings--define-key menu [rmail]
1626 '(menu-item "Read Mail" menu-bar-read-mail
1627 :visible (and read-mail-command
1628 (not (eq read-mail-command 'ignore)))
1629 :help "Read your mail"))
1631 (bindings--define-key menu [gnus]
1632 '(menu-item "Read Net News" gnus
1633 :help "Read network news groups"))
1635 (bindings--define-key menu [separator-vc]
1636 menu-bar-separator)
1638 (bindings--define-key menu [vc] nil) ;Create the place for the VC menu.
1640 (bindings--define-key menu [separator-compare]
1641 menu-bar-separator)
1643 (bindings--define-key menu [epatch]
1644 '(menu-item "Apply Patch" menu-bar-epatch-menu))
1645 (bindings--define-key menu [ediff-merge]
1646 '(menu-item "Merge" menu-bar-ediff-merge-menu))
1647 (bindings--define-key menu [compare]
1648 '(menu-item "Compare (Ediff)" menu-bar-ediff-menu))
1650 (bindings--define-key menu [separator-spell]
1651 menu-bar-separator)
1653 (bindings--define-key menu [spell]
1654 '(menu-item "Spell Checking" ispell-menu-map))
1656 (bindings--define-key menu [separator-prog]
1657 menu-bar-separator)
1659 (bindings--define-key menu [semantic]
1660 '(menu-item "Source Code Parsers (Semantic)"
1661 semantic-mode
1662 :help "Toggle automatic parsing in source code buffers (Semantic mode)"
1663 :button (:toggle . (bound-and-true-p semantic-mode))))
1665 (bindings--define-key menu [ede]
1666 '(menu-item "Project Support (EDE)"
1667 global-ede-mode
1668 :help "Toggle the Emacs Development Environment (Global EDE mode)"
1669 :button (:toggle . (bound-and-true-p global-ede-mode))))
1671 (bindings--define-key menu [gdb]
1672 '(menu-item "Debugger (GDB)..." gdb
1673 :help "Debug a program from within Emacs with GDB"))
1674 (bindings--define-key menu [shell-on-region]
1675 '(menu-item "Shell Command on Region..." shell-command-on-region
1676 :enable mark-active
1677 :help "Pass marked region to a shell command"))
1678 (bindings--define-key menu [shell]
1679 '(menu-item "Shell Command..." shell-command
1680 :help "Invoke a shell command and catch its output"))
1681 (bindings--define-key menu [compile]
1682 '(menu-item "Compile..." compile
1683 :help "Invoke compiler or Make, view compilation errors"))
1684 (bindings--define-key menu [grep]
1685 '(menu-item "Search Files (Grep)..." grep
1686 :help "Search files for strings or regexps (with Grep)"))
1687 menu))
1689 ;; The "Help" menu items
1691 (defvar menu-bar-describe-menu
1692 (let ((menu (make-sparse-keymap "Describe")))
1694 (bindings--define-key menu [mule-diag]
1695 '(menu-item "Show All of Mule Status" mule-diag
1696 :help "Display multilingual environment settings"))
1697 (bindings--define-key menu [describe-coding-system-briefly]
1698 '(menu-item "Describe Coding System (Briefly)"
1699 describe-current-coding-system-briefly))
1700 (bindings--define-key menu [describe-coding-system]
1701 '(menu-item "Describe Coding System..." describe-coding-system))
1702 (bindings--define-key menu [describe-input-method]
1703 '(menu-item "Describe Input Method..." describe-input-method
1704 :help "Keyboard layout for specific input method"))
1705 (bindings--define-key menu [describe-language-environment]
1706 `(menu-item "Describe Language Environment"
1707 ,describe-language-environment-map))
1709 (bindings--define-key menu [separator-desc-mule]
1710 menu-bar-separator)
1712 (bindings--define-key menu [list-keybindings]
1713 '(menu-item "List Key Bindings" describe-bindings
1714 :help "Display all current key bindings (keyboard shortcuts)"))
1715 (bindings--define-key menu [describe-current-display-table]
1716 '(menu-item "Describe Display Table" describe-current-display-table
1717 :help "Describe the current display table"))
1718 (bindings--define-key menu [describe-package]
1719 '(menu-item "Describe Package..." describe-package
1720 :help "Display documentation of a Lisp package"))
1721 (bindings--define-key menu [describe-face]
1722 '(menu-item "Describe Face..." describe-face
1723 :help "Display the properties of a face"))
1724 (bindings--define-key menu [describe-variable]
1725 '(menu-item "Describe Variable..." describe-variable
1726 :help "Display documentation of variable/option"))
1727 (bindings--define-key menu [describe-function]
1728 '(menu-item "Describe Function..." describe-function
1729 :help "Display documentation of function/command"))
1730 (bindings--define-key menu [describe-key-1]
1731 '(menu-item "Describe Key or Mouse Operation..." describe-key
1732 ;; Users typically don't identify keys and menu items...
1733 :help "Display documentation of command bound to a \
1734 key, a click, or a menu-item"))
1735 (bindings--define-key menu [describe-mode]
1736 '(menu-item "Describe Buffer Modes" describe-mode
1737 :help "Describe this buffer's major and minor mode"))
1738 menu))
1740 (defun menu-bar-read-lispref ()
1741 "Display the Emacs Lisp Reference manual in Info mode."
1742 (interactive)
1743 (info "elisp"))
1745 (defun menu-bar-read-lispintro ()
1746 "Display the Introduction to Emacs Lisp Programming in Info mode."
1747 (interactive)
1748 (info "eintr"))
1750 (defun search-emacs-glossary ()
1751 "Display the Glossary node of the Emacs manual in Info mode."
1752 (interactive)
1753 (info "(emacs)Glossary"))
1755 (defun emacs-index-search (topic)
1756 "Look up TOPIC in the indices of the Emacs User Manual."
1757 (interactive "sSubject to look up: ")
1758 (info "emacs")
1759 (Info-index topic))
1761 (defun elisp-index-search (topic)
1762 "Look up TOPIC in the indices of the Emacs Lisp Reference Manual."
1763 (interactive "sSubject to look up: ")
1764 (info "elisp")
1765 (Info-index topic))
1767 (defvar menu-bar-search-documentation-menu
1768 (let ((menu (make-sparse-keymap "Search Documentation")))
1770 (bindings--define-key menu [search-documentation-strings]
1771 '(menu-item "Search Documentation Strings..." apropos-documentation
1772 :help
1773 "Find functions and variables whose doc strings match a regexp"))
1774 (bindings--define-key menu [find-any-object-by-name]
1775 '(menu-item "Find Any Object by Name..." apropos
1776 :help "Find symbols of any kind whose names match a regexp"))
1777 (bindings--define-key menu [find-option-by-value]
1778 '(menu-item "Find Options by Value..." apropos-value
1779 :help "Find variables whose values match a regexp"))
1780 (bindings--define-key menu [find-options-by-name]
1781 '(menu-item "Find Options by Name..." apropos-user-option
1782 :help "Find user options whose names match a regexp"))
1783 (bindings--define-key menu [find-commands-by-name]
1784 '(menu-item "Find Commands by Name..." apropos-command
1785 :help "Find commands whose names match a regexp"))
1786 (bindings--define-key menu [sep1]
1787 menu-bar-separator)
1788 (bindings--define-key menu [lookup-command-in-manual]
1789 '(menu-item "Look Up Command in User Manual..." Info-goto-emacs-command-node
1790 :help "Display manual section that describes a command"))
1791 (bindings--define-key menu [lookup-key-in-manual]
1792 '(menu-item "Look Up Key in User Manual..." Info-goto-emacs-key-command-node
1793 :help "Display manual section that describes a key"))
1794 (bindings--define-key menu [lookup-subject-in-elisp-manual]
1795 '(menu-item "Look Up Subject in ELisp Manual..." elisp-index-search
1796 :help "Find description of a subject in Emacs Lisp manual"))
1797 (bindings--define-key menu [lookup-subject-in-emacs-manual]
1798 '(menu-item "Look Up Subject in User Manual..." emacs-index-search
1799 :help "Find description of a subject in Emacs User manual"))
1800 (bindings--define-key menu [emacs-terminology]
1801 '(menu-item "Emacs Terminology" search-emacs-glossary
1802 :help "Display the Glossary section of the Emacs manual"))
1803 menu))
1805 (defvar menu-bar-manuals-menu
1806 (let ((menu (make-sparse-keymap "More Manuals")))
1808 (bindings--define-key menu [man]
1809 '(menu-item "Read Man Page..." manual-entry
1810 :help "Man-page docs for external commands and libraries"))
1811 (bindings--define-key menu [sep2]
1812 menu-bar-separator)
1813 (bindings--define-key menu [order-emacs-manuals]
1814 '(menu-item "Ordering Manuals" view-order-manuals
1815 :help "How to order manuals from the Free Software Foundation"))
1816 (bindings--define-key menu [lookup-subject-in-all-manuals]
1817 '(menu-item "Lookup Subject in all Manuals..." info-apropos
1818 :help "Find description of a subject in all installed manuals"))
1819 (bindings--define-key menu [other-manuals]
1820 '(menu-item "All Other Manuals (Info)" Info-directory
1821 :help "Read any of the installed manuals"))
1822 (bindings--define-key menu [emacs-lisp-reference]
1823 '(menu-item "Emacs Lisp Reference" menu-bar-read-lispref
1824 :help "Read the Emacs Lisp Reference manual"))
1825 (bindings--define-key menu [emacs-lisp-intro]
1826 '(menu-item "Introduction to Emacs Lisp" menu-bar-read-lispintro
1827 :help "Read the Introduction to Emacs Lisp Programming"))
1828 menu))
1830 (defun help-with-tutorial-spec-language ()
1831 "Use the Emacs tutorial, specifying which language you want."
1832 (interactive)
1833 (help-with-tutorial t))
1835 (defvar menu-bar-help-menu
1836 (let ((menu (make-sparse-keymap "Help")))
1837 (bindings--define-key menu [about-gnu-project]
1838 '(menu-item "About GNU" describe-gnu-project
1839 :help "About the GNU System, GNU Project, and GNU/Linux"))
1840 (bindings--define-key menu [about-emacs]
1841 '(menu-item "About Emacs" about-emacs
1842 :help "Display version number, copyright info, and basic help"))
1843 (bindings--define-key menu [sep4]
1844 menu-bar-separator)
1845 (bindings--define-key menu [describe-no-warranty]
1846 '(menu-item "(Non)Warranty" describe-no-warranty
1847 :help "Explain that Emacs has NO WARRANTY"))
1848 (bindings--define-key menu [describe-copying]
1849 '(menu-item "Copying Conditions" describe-copying
1850 :help "Show the Emacs license (GPL)"))
1851 (bindings--define-key menu [getting-new-versions]
1852 '(menu-item "Getting New Versions" describe-distribution
1853 :help "How to get the latest version of Emacs"))
1854 (bindings--define-key menu [sep2]
1855 menu-bar-separator)
1856 (bindings--define-key menu [external-packages]
1857 '(menu-item "Finding Extra Packages" view-external-packages
1858 :help "How to get more Lisp packages for use in Emacs"))
1859 (bindings--define-key menu [find-emacs-packages]
1860 '(menu-item "Search Built-in Packages" finder-by-keyword
1861 :help "Find built-in packages and features by keyword"))
1862 (bindings--define-key menu [more-manuals]
1863 `(menu-item "More Manuals" ,menu-bar-manuals-menu))
1864 (bindings--define-key menu [emacs-manual]
1865 '(menu-item "Read the Emacs Manual" info-emacs-manual
1866 :help "Full documentation of Emacs features"))
1867 (bindings--define-key menu [describe]
1868 `(menu-item "Describe" ,menu-bar-describe-menu))
1869 (bindings--define-key menu [search-documentation]
1870 `(menu-item "Search Documentation" ,menu-bar-search-documentation-menu))
1871 (bindings--define-key menu [sep1]
1872 menu-bar-separator)
1873 (bindings--define-key menu [emacs-psychotherapist]
1874 '(menu-item "Emacs Psychotherapist" doctor
1875 :help "Our doctor will help you feel better"))
1876 (bindings--define-key menu [send-emacs-bug-report]
1877 '(menu-item "Send Bug Report..." report-emacs-bug
1878 :help "Send e-mail to Emacs maintainers"))
1879 (bindings--define-key menu [emacs-manual-bug]
1880 '(menu-item "How to Report a Bug" info-emacs-bug
1881 :help "Read about how to report an Emacs bug"))
1882 (bindings--define-key menu [emacs-known-problems]
1883 '(menu-item "Emacs Known Problems" view-emacs-problems
1884 :help "Read about known problems with Emacs"))
1885 (bindings--define-key menu [emacs-news]
1886 '(menu-item "Emacs News" view-emacs-news
1887 :help "New features of this version"))
1888 (bindings--define-key menu [emacs-faq]
1889 '(menu-item "Emacs FAQ" view-emacs-FAQ
1890 :help "Frequently asked (and answered) questions about Emacs"))
1892 (bindings--define-key menu [emacs-tutorial-language-specific]
1893 '(menu-item "Emacs Tutorial (choose language)..."
1894 help-with-tutorial-spec-language
1895 :help "Learn how to use Emacs (choose a language)"))
1896 (bindings--define-key menu [emacs-tutorial]
1897 '(menu-item "Emacs Tutorial" help-with-tutorial
1898 :help "Learn how to use Emacs"))
1900 ;; In macOS it's in the app menu already.
1901 ;; FIXME? There already is an "About Emacs" (sans ...) entry in the Help menu.
1902 (and (featurep 'ns)
1903 (not (eq system-type 'darwin))
1904 (bindings--define-key menu [info-panel]
1905 '(menu-item "About Emacs..." ns-do-emacs-info-panel)))
1906 menu))
1908 (bindings--define-key global-map [menu-bar tools]
1909 (cons "Tools" menu-bar-tools-menu))
1910 (bindings--define-key global-map [menu-bar buffer]
1911 (cons "Buffers" global-buffers-menu-map))
1912 (bindings--define-key global-map [menu-bar options]
1913 (cons "Options" menu-bar-options-menu))
1914 (bindings--define-key global-map [menu-bar edit]
1915 (cons "Edit" menu-bar-edit-menu))
1916 (bindings--define-key global-map [menu-bar file]
1917 (cons "File" menu-bar-file-menu))
1918 (bindings--define-key global-map [menu-bar help-menu]
1919 (cons (purecopy "Help") menu-bar-help-menu))
1921 (defun menu-bar-menu-frame-live-and-visible-p ()
1922 "Return non-nil if the menu frame is alive and visible.
1923 The menu frame is the frame for which we are updating the menu."
1924 (let ((menu-frame (or menu-updating-frame (selected-frame))))
1925 (and (frame-live-p menu-frame)
1926 (frame-visible-p menu-frame))))
1928 (defun menu-bar-non-minibuffer-window-p ()
1929 "Return non-nil if the menu frame's selected window is no minibuffer window.
1930 Return nil if the menu frame is dead or its selected window is a
1931 minibuffer window. The menu frame is the frame for which we are
1932 updating the menu."
1933 (let ((menu-frame (or menu-updating-frame (selected-frame))))
1934 (and (frame-live-p menu-frame)
1935 (not (window-minibuffer-p
1936 (frame-selected-window menu-frame))))))
1938 (defun kill-this-buffer () ; for the menu bar
1939 "Kill the current buffer.
1940 When called in the minibuffer, get out of the minibuffer
1941 using `abort-recursive-edit'.
1943 This command can be reliably invoked only from the menu bar,
1944 otherwise it could decide to silently do nothing."
1945 (interactive)
1946 (cond
1947 ;; Don't do anything when `menu-frame' is not alive or visible
1948 ;; (Bug#8184).
1949 ((not (menu-bar-menu-frame-live-and-visible-p)))
1950 ((menu-bar-non-minibuffer-window-p)
1951 (kill-buffer (current-buffer)))
1953 (abort-recursive-edit))))
1955 (defun kill-this-buffer-enabled-p ()
1956 "Return non-nil if the `kill-this-buffer' menu item should be enabled."
1957 (or (not (menu-bar-non-minibuffer-window-p))
1958 (let (found-1)
1959 ;; Instead of looping over entire buffer list, stop once we've
1960 ;; found two "killable" buffers (Bug#8184).
1961 (catch 'found-2
1962 (dolist (buffer (buffer-list))
1963 (unless (string-match-p "^ " (buffer-name buffer))
1964 (if (not found-1)
1965 (setq found-1 t)
1966 (throw 'found-2 t))))))))
1968 (put 'dired 'menu-enable '(menu-bar-non-minibuffer-window-p))
1970 ;; Permit deleting frame if it would leave a visible or iconified frame.
1971 (defun delete-frame-enabled-p ()
1972 "Return non-nil if `delete-frame' should be enabled in the menu bar."
1973 (let ((frames (frame-list))
1974 (count 0))
1975 (while frames
1976 (if (frame-visible-p (car frames))
1977 (setq count (1+ count)))
1978 (setq frames (cdr frames)))
1979 (> count 1)))
1981 (defcustom yank-menu-length 20
1982 "Maximum length to display in the yank-menu."
1983 :type 'integer
1984 :group 'menu)
1986 (defun menu-bar-update-yank-menu (string old)
1987 (let ((front (car (cdr yank-menu)))
1988 (menu-string (if (<= (length string) yank-menu-length)
1989 string
1990 (concat
1991 (substring string 0 (/ yank-menu-length 2))
1992 "..."
1993 (substring string (- (/ yank-menu-length 2)))))))
1994 ;; Don't let the menu string be all dashes
1995 ;; because that has a special meaning in a menu.
1996 (if (string-match "\\`-+\\'" menu-string)
1997 (setq menu-string (concat menu-string " ")))
1998 ;; If we're supposed to be extending an existing string, and that
1999 ;; string really is at the front of the menu, then update it in place.
2000 (if (and old (or (eq old (car front))
2001 (string= old (car front))))
2002 (progn
2003 (setcar front string)
2004 (setcar (cdr front) menu-string))
2005 (setcdr yank-menu
2006 (cons
2007 (cons string (cons menu-string 'menu-bar-select-yank))
2008 (cdr yank-menu)))))
2009 (if (> (length (cdr yank-menu)) kill-ring-max)
2010 (setcdr (nthcdr kill-ring-max yank-menu) nil)))
2012 (put 'menu-bar-select-yank 'apropos-inhibit t)
2013 (defun menu-bar-select-yank ()
2014 "Insert the stretch of previously-killed text selected from menu.
2015 The menu shows all the killed text sequences stored in `kill-ring'."
2016 (interactive "*")
2017 (push-mark)
2018 (insert last-command-event))
2021 ;;; Buffers Menu
2023 (defcustom buffers-menu-max-size 10
2024 "Maximum number of entries which may appear on the Buffers menu.
2025 If this is 10, then only the ten most-recently-selected buffers are shown.
2026 If this is nil, then all buffers are shown.
2027 A large number or nil slows down menu responsiveness."
2028 :type '(choice integer
2029 (const :tag "All" nil))
2030 :group 'menu)
2032 (defcustom buffers-menu-buffer-name-length 30
2033 "Maximum length of the buffer name on the Buffers menu.
2034 If this is a number, then buffer names are truncated to this length.
2035 If this is nil, then buffer names are shown in full.
2036 A large number or nil makes the menu too wide."
2037 :type '(choice integer
2038 (const :tag "Full length" nil))
2039 :group 'menu)
2041 (defcustom buffers-menu-show-directories 'unless-uniquify
2042 "If non-nil, show directories in the Buffers menu for buffers that have them.
2043 The special value `unless-uniquify' means that directories will be shown
2044 unless `uniquify-buffer-name-style' is non-nil (in which case, buffer
2045 names should include enough of a buffer's directory to distinguish it
2046 from other buffers).
2048 Setting this variable directly does not take effect until next time the
2049 Buffers menu is regenerated."
2050 :set (lambda (symbol value)
2051 (set symbol value)
2052 (menu-bar-update-buffers t))
2053 :initialize 'custom-initialize-default
2054 :type '(choice (const :tag "Never" nil)
2055 (const :tag "Unless uniquify is enabled" unless-uniquify)
2056 (const :tag "Always" t))
2057 :group 'menu)
2059 (defcustom buffers-menu-show-status t
2060 "If non-nil, show modified/read-only status of buffers in the Buffers menu.
2061 Setting this variable directly does not take effect until next time the
2062 Buffers menu is regenerated."
2063 :set (lambda (symbol value)
2064 (set symbol value)
2065 (menu-bar-update-buffers t))
2066 :initialize 'custom-initialize-default
2067 :type 'boolean
2068 :group 'menu)
2070 (defvar list-buffers-directory nil
2071 "String to display in buffer listings for buffers not visiting a file.")
2072 (make-variable-buffer-local 'list-buffers-directory)
2074 (defun menu-bar-select-buffer ()
2075 (interactive)
2076 (switch-to-buffer last-command-event))
2078 (defun menu-bar-select-frame (frame)
2079 (make-frame-visible frame)
2080 (raise-frame frame)
2081 (select-frame frame))
2083 (defun menu-bar-update-buffers-1 (elt)
2084 (let* ((buf (car elt))
2085 (file
2086 (and (if (eq buffers-menu-show-directories 'unless-uniquify)
2087 (or (not (boundp 'uniquify-buffer-name-style))
2088 (null uniquify-buffer-name-style))
2089 buffers-menu-show-directories)
2090 (or (buffer-file-name buf)
2091 (buffer-local-value 'list-buffers-directory buf)))))
2092 (when file
2093 (setq file (file-name-directory file)))
2094 (when (and file (> (length file) 20))
2095 (setq file (concat "..." (substring file -17))))
2096 (cons (if buffers-menu-show-status
2097 (let ((mod (if (buffer-modified-p buf) "*" ""))
2098 (ro (if (buffer-local-value 'buffer-read-only buf) "%" "")))
2099 (if file
2100 (format "%s %s%s -- %s" (cdr elt) mod ro file)
2101 (format "%s %s%s" (cdr elt) mod ro)))
2102 (if file
2103 (format "%s -- %s" (cdr elt) file)
2104 (cdr elt)))
2105 buf)))
2107 ;; Used to cache the menu entries for commands in the Buffers menu
2108 (defvar menu-bar-buffers-menu-command-entries nil)
2110 (defvar menu-bar-select-buffer-function 'switch-to-buffer
2111 "Function to select the buffer chosen from the `Buffers' menu-bar menu.
2112 It must accept a buffer as its only required argument.")
2114 (defun menu-bar-buffer-vector (alist)
2115 ;; turn ((name . buffer) ...) into a menu
2116 (let ((buffers-vec (make-vector (length alist) nil))
2117 (i (length alist)))
2118 (dolist (pair alist)
2119 (setq i (1- i))
2120 (aset buffers-vec i
2121 (cons (car pair)
2122 `(lambda ()
2123 (interactive)
2124 (funcall menu-bar-select-buffer-function ,(cdr pair))))))
2125 buffers-vec))
2127 (defun menu-bar-update-buffers (&optional force)
2128 ;; If user discards the Buffers item, play along.
2129 (and (lookup-key (current-global-map) [menu-bar buffer])
2130 (or force (frame-or-buffer-changed-p))
2131 (let ((buffers (buffer-list))
2132 (frames (frame-list))
2133 buffers-menu)
2135 ;; Make the menu of buffers proper.
2136 (setq buffers-menu
2137 (let ((i 0)
2138 (limit (if (and (integerp buffers-menu-max-size)
2139 (> buffers-menu-max-size 1))
2140 buffers-menu-max-size most-positive-fixnum))
2141 alist)
2142 ;; Put into each element of buffer-list
2143 ;; the name for actual display,
2144 ;; perhaps truncated in the middle.
2145 (while buffers
2146 (let* ((buf (pop buffers))
2147 (name (buffer-name buf)))
2148 (unless (eq ?\s (aref name 0))
2149 (push (menu-bar-update-buffers-1
2150 (cons buf
2151 (if (and (integerp buffers-menu-buffer-name-length)
2152 (> (length name) buffers-menu-buffer-name-length))
2153 (concat
2154 (substring
2155 name 0 (/ buffers-menu-buffer-name-length 2))
2156 "..."
2157 (substring
2158 name (- (/ buffers-menu-buffer-name-length 2))))
2159 name)
2161 alist)
2162 ;; If requested, list only the N most recently
2163 ;; selected buffers.
2164 (when (= limit (setq i (1+ i)))
2165 (setq buffers nil)))))
2166 (list (menu-bar-buffer-vector alist))))
2168 ;; Make a Frames menu if we have more than one frame.
2169 (when (cdr frames)
2170 (let* ((frames-vec (make-vector (length frames) nil))
2171 (frames-menu
2172 (cons 'keymap
2173 (list "Select Frame" frames-vec)))
2174 (i 0))
2175 (dolist (frame frames)
2176 (aset frames-vec i
2177 (cons
2178 (frame-parameter frame 'name)
2179 `(lambda ()
2180 (interactive) (menu-bar-select-frame ,frame))))
2181 (setq i (1+ i)))
2182 ;; Put it after the normal buffers
2183 (setq buffers-menu
2184 (nconc buffers-menu
2185 `((frames-separator "--")
2186 (frames menu-item "Frames" ,frames-menu))))))
2188 ;; Add in some normal commands at the end of the menu. We use
2189 ;; the copy cached in `menu-bar-buffers-menu-command-entries'
2190 ;; if it's been set already. Note that we can't use constant
2191 ;; lists for the menu-entries, because the low-level menu-code
2192 ;; modifies them.
2193 (unless menu-bar-buffers-menu-command-entries
2194 (setq menu-bar-buffers-menu-command-entries
2195 (list '(command-separator "--")
2196 (list 'next-buffer
2197 'menu-item
2198 "Next Buffer"
2199 'next-buffer
2200 :help "Switch to the \"next\" buffer in a cyclic order")
2201 (list 'previous-buffer
2202 'menu-item
2203 "Previous Buffer"
2204 'previous-buffer
2205 :help "Switch to the \"previous\" buffer in a cyclic order")
2206 (list 'select-named-buffer
2207 'menu-item
2208 "Select Named Buffer..."
2209 'switch-to-buffer
2210 :help "Prompt for a buffer name, and select that buffer in the current window")
2211 (list 'list-all-buffers
2212 'menu-item
2213 "List All Buffers"
2214 'list-buffers
2215 :help "Pop up a window listing all Emacs buffers"
2216 ))))
2217 (setq buffers-menu
2218 (nconc buffers-menu menu-bar-buffers-menu-command-entries))
2220 ;; We used to "(define-key (current-global-map) [menu-bar buffer]"
2221 ;; but that did not do the right thing when the [menu-bar buffer]
2222 ;; entry above had been moved (e.g. to a parent keymap).
2223 (setcdr global-buffers-menu-map (cons "Buffers" buffers-menu)))))
2225 (add-hook 'menu-bar-update-hook 'menu-bar-update-buffers)
2227 (menu-bar-update-buffers)
2229 ;; this version is too slow
2230 ;;(defun format-buffers-menu-line (buffer)
2231 ;; "Returns a string to represent the given buffer in the Buffer menu.
2232 ;;nil means the buffer shouldn't be listed. You can redefine this."
2233 ;; (if (string-match "\\` " (buffer-name buffer))
2234 ;; nil
2235 ;; (with-current-buffer buffer
2236 ;; (let ((size (buffer-size)))
2237 ;; (format "%s%s %-19s %6s %-15s %s"
2238 ;; (if (buffer-modified-p) "*" " ")
2239 ;; (if buffer-read-only "%" " ")
2240 ;; (buffer-name)
2241 ;; size
2242 ;; mode-name
2243 ;; (or (buffer-file-name) ""))))))
2245 ;;; Set up a menu bar menu for the minibuffer.
2247 (dolist (map (list minibuffer-local-map
2248 ;; This shouldn't be necessary, but there's a funny
2249 ;; bug in keymap.c that I don't understand yet. -stef
2250 minibuffer-local-completion-map))
2251 (bindings--define-key map [menu-bar minibuf]
2252 (cons "Minibuf" (make-sparse-keymap "Minibuf"))))
2254 (let ((map minibuffer-local-completion-map))
2255 (bindings--define-key map [menu-bar minibuf ?\?]
2256 '(menu-item "List Completions" minibuffer-completion-help
2257 :help "Display all possible completions"))
2258 (bindings--define-key map [menu-bar minibuf space]
2259 '(menu-item "Complete Word" minibuffer-complete-word
2260 :help "Complete at most one word"))
2261 (bindings--define-key map [menu-bar minibuf tab]
2262 '(menu-item "Complete" minibuffer-complete
2263 :help "Complete as far as possible")))
2265 (let ((map minibuffer-local-map))
2266 (bindings--define-key map [menu-bar minibuf quit]
2267 '(menu-item "Quit" abort-recursive-edit
2268 :help "Abort input and exit minibuffer"))
2269 (bindings--define-key map [menu-bar minibuf return]
2270 '(menu-item "Enter" exit-minibuffer
2271 :key-sequence "\r"
2272 :help "Terminate input and exit minibuffer"))
2273 (bindings--define-key map [menu-bar minibuf isearch-forward]
2274 '(menu-item "Isearch History Forward" isearch-forward
2275 :help "Incrementally search minibuffer history forward"))
2276 (bindings--define-key map [menu-bar minibuf isearch-backward]
2277 '(menu-item "Isearch History Backward" isearch-backward
2278 :help "Incrementally search minibuffer history backward"))
2279 (bindings--define-key map [menu-bar minibuf next]
2280 '(menu-item "Next History Item" next-history-element
2281 :help "Put next minibuffer history element in the minibuffer"))
2282 (bindings--define-key map [menu-bar minibuf previous]
2283 '(menu-item "Previous History Item" previous-history-element
2284 :help "Put previous minibuffer history element in the minibuffer")))
2286 (define-minor-mode menu-bar-mode
2287 "Toggle display of a menu bar on each frame (Menu Bar mode).
2288 With a prefix argument ARG, enable Menu Bar mode if ARG is
2289 positive, and disable it otherwise. If called from Lisp, also
2290 enable Menu Bar mode if ARG is omitted or nil.
2292 This command applies to all frames that exist and frames to be
2293 created in the future."
2294 :init-value t
2295 :global t
2296 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
2297 :variable menu-bar-mode
2299 ;; Turn the menu-bars on all frames on or off.
2300 (let ((val (if menu-bar-mode 1 0)))
2301 (dolist (frame (frame-list))
2302 (set-frame-parameter frame 'menu-bar-lines val))
2303 ;; If the user has given `default-frame-alist' a `menu-bar-lines'
2304 ;; parameter, replace it.
2305 (if (assq 'menu-bar-lines default-frame-alist)
2306 (setq default-frame-alist
2307 (cons (cons 'menu-bar-lines val)
2308 (assq-delete-all 'menu-bar-lines
2309 default-frame-alist)))))
2310 ;; Make the message appear when Emacs is idle. We can not call message
2311 ;; directly. The minor-mode message "Menu Bar mode disabled" comes
2312 ;; after this function returns, overwriting any message we do here.
2313 (when (and (called-interactively-p 'interactive) (not menu-bar-mode))
2314 (run-with-idle-timer 0 nil 'message
2315 "Menu Bar mode disabled. Use M-x menu-bar-mode to make the menu bar appear.")))
2317 ;;;###autoload
2318 ;; (This does not work right unless it comes after the above definition.)
2319 ;; This comment is taken from tool-bar.el near
2320 ;; (put 'tool-bar-mode ...)
2321 ;; We want to pretend the menu bar by standard is on, as this will make
2322 ;; customize consider disabling the menu bar a customization, and save
2323 ;; that. We could do this for real by setting :init-value above, but
2324 ;; that would overwrite disabling the menu bar from X resources.
2325 (put 'menu-bar-mode 'standard-value '(t))
2327 (defun toggle-menu-bar-mode-from-frame (&optional arg)
2328 "Toggle menu bar on or off, based on the status of the current frame.
2329 See `menu-bar-mode' for more information."
2330 (interactive (list (or current-prefix-arg 'toggle)))
2331 (if (eq arg 'toggle)
2332 (menu-bar-mode
2333 (if (menu-bar-positive-p
2334 (frame-parameter (menu-bar-frame-for-menubar) 'menu-bar-lines))
2335 0 1))
2336 (menu-bar-mode arg)))
2338 (declare-function x-menu-bar-open "term/x-win" (&optional frame))
2339 (declare-function w32-menu-bar-open "term/w32-win" (&optional frame))
2341 (defun lookup-key-ignore-too-long (map key)
2342 "Call `lookup-key' and convert numeric values to nil."
2343 (let ((binding (lookup-key map key)))
2344 (if (numberp binding) ; `too long'
2346 binding)))
2348 (defun popup-menu (menu &optional position prefix from-menu-bar)
2349 "Popup the given menu and call the selected option.
2350 MENU can be a keymap, an easymenu-style menu or a list of keymaps as for
2351 `x-popup-menu'.
2352 The menu is shown at the place where POSITION specifies.
2353 For the form of POSITION, see `popup-menu-normalize-position'.
2354 PREFIX is the prefix argument (if any) to pass to the command.
2355 FROM-MENU-BAR, if non-nil, means we are dropping one of menu-bar's menus."
2356 (let* ((map (cond
2357 ((keymapp menu) menu)
2358 ((and (listp menu) (keymapp (car menu))) menu)
2359 (t (let* ((map (easy-menu-create-menu (car menu) (cdr menu)))
2360 (filter (when (symbolp map)
2361 (plist-get (get map 'menu-prop) :filter))))
2362 (if filter (funcall filter (symbol-function map)) map)))))
2363 (frame (selected-frame))
2364 event cmd)
2365 (if from-menu-bar
2366 (let* ((xy (posn-x-y position))
2367 (menu-symbol (menu-bar-menu-at-x-y (car xy) (cdr xy))))
2368 (setq position (list menu-symbol (list frame '(menu-bar)
2369 xy 0))))
2370 (setq position (popup-menu-normalize-position position)))
2371 ;; The looping behavior was taken from lmenu's popup-menu-popup
2372 (while (and map (setq event
2373 ;; map could be a prefix key, in which case
2374 ;; we need to get its function cell
2375 ;; definition.
2376 (x-popup-menu position (indirect-function map))))
2377 ;; Strangely x-popup-menu returns a list.
2378 ;; mouse-major-mode-menu was using a weird:
2379 ;; (key-binding (apply 'vector (append '(menu-bar) menu-prefix events)))
2380 (setq cmd
2381 (cond
2382 ((and from-menu-bar
2383 (consp event)
2384 (numberp (car event))
2385 (numberp (cdr event)))
2386 (let ((x (car event))
2387 (y (cdr event))
2388 menu-symbol)
2389 (setq menu-symbol (menu-bar-menu-at-x-y x y))
2390 (setq position (list menu-symbol (list frame '(menu-bar)
2391 event 0)))
2392 (setq map
2393 (key-binding (vector 'menu-bar menu-symbol)))))
2394 ((and (not (keymapp map)) (listp map))
2395 ;; We were given a list of keymaps. Search them all
2396 ;; in sequence until a first binding is found.
2397 (let ((mouse-click (apply 'vector event))
2398 binding)
2399 (while (and map (null binding))
2400 (setq binding (lookup-key-ignore-too-long (car map) mouse-click))
2401 (setq map (cdr map)))
2402 binding))
2404 ;; We were given a single keymap.
2405 (lookup-key map (apply 'vector event)))))
2406 ;; Clear out echoing, which perhaps shows a prefix arg.
2407 (message "")
2408 ;; Maybe try again but with the submap.
2409 (setq map (if (keymapp cmd) cmd)))
2410 ;; If the user did not cancel by refusing to select,
2411 ;; and if the result is a command, run it.
2412 (when (and (null map) (commandp cmd))
2413 (setq prefix-arg prefix)
2414 ;; `setup-specified-language-environment', for instance,
2415 ;; expects this to be set from a menu keymap.
2416 (setq last-command-event (car (last event)))
2417 ;; mouse-major-mode-menu was using `command-execute' instead.
2418 (call-interactively cmd))))
2420 (defun popup-menu-normalize-position (position)
2421 "Convert the POSITION to the form which `popup-menu' expects internally.
2422 POSITION can be an event, a posn- value, a value having the
2423 form ((XOFFSET YOFFSET) WINDOW), or nil.
2424 If nil, the current mouse position is used, or nil if there is no mouse."
2425 (pcase position
2426 ;; nil -> mouse cursor position
2427 (`nil
2428 (let ((mp (mouse-pixel-position)))
2429 (list (list (cadr mp) (cddr mp)) (car mp))))
2430 ;; Value returned from `event-end' or `posn-at-point'.
2431 ((pred posnp)
2432 (let ((xy (posn-x-y position)))
2433 (list (list (car xy) (cdr xy))
2434 (posn-window position))))
2435 ;; Event.
2436 ((pred eventp)
2437 (popup-menu-normalize-position (event-end position)))
2438 (_ position)))
2440 (defcustom tty-menu-open-use-tmm nil
2441 "If non-nil, \\[menu-bar-open] on a TTY will invoke `tmm-menubar'.
2443 If nil, \\[menu-bar-open] will drop down the menu corresponding to the
2444 first (leftmost) menu-bar item; you can select other items by typing
2445 \\[forward-char], \\[backward-char], \\[right-char] and \\[left-char]."
2446 :type '(choice (const :tag "F10 drops down TTY menus" nil)
2447 (const :tag "F10 invokes tmm-menubar" t))
2448 :group 'display
2449 :version "24.4")
2451 (defvar tty-menu--initial-menu-x 1
2452 "X coordinate of the first menu-bar menu dropped by F10.
2454 This is meant to be used only for debugging TTY menus.")
2456 (defun menu-bar-open (&optional frame)
2457 "Start key navigation of the menu bar in FRAME.
2459 This function decides which method to use to access the menu
2460 depending on FRAME's terminal device. On X displays, it calls
2461 `x-menu-bar-open'; on Windows, `w32-menu-bar-open'; otherwise it
2462 calls either `popup-menu' or `tmm-menubar' depending on whether
2463 `tty-menu-open-use-tmm' is nil or not.
2465 If FRAME is nil or not given, use the selected frame."
2466 (interactive)
2467 (let ((type (framep (or frame (selected-frame)))))
2468 (cond
2469 ((eq type 'x) (x-menu-bar-open frame))
2470 ((eq type 'w32) (w32-menu-bar-open frame))
2471 ((and (null tty-menu-open-use-tmm)
2472 (not (zerop (or (frame-parameter nil 'menu-bar-lines) 0))))
2473 ;; Make sure the menu bar is up to date. One situation where
2474 ;; this is important is when this function is invoked by name
2475 ;; via M-x, in which case the menu bar includes the "Minibuf"
2476 ;; menu item that should be removed when we exit the minibuffer.
2477 (force-mode-line-update)
2478 (redisplay)
2479 (let* ((x tty-menu--initial-menu-x)
2480 (menu (menu-bar-menu-at-x-y x 0 frame)))
2481 (popup-menu (or
2482 (lookup-key-ignore-too-long
2483 global-map (vector 'menu-bar menu))
2484 (lookup-key-ignore-too-long
2485 (current-local-map) (vector 'menu-bar menu))
2486 (cdar (minor-mode-key-binding (vector 'menu-bar menu)))
2487 (mouse-menu-bar-map))
2488 (posn-at-x-y x 0 nil t) nil t)))
2489 (t (with-selected-frame (or frame (selected-frame))
2490 (tmm-menubar))))))
2492 (global-set-key [f10] 'menu-bar-open)
2494 (defun buffer-menu-open ()
2495 "Start key navigation of the buffer menu.
2496 This is the keyboard interface to \\[mouse-buffer-menu]."
2497 (interactive)
2498 (popup-menu (mouse-buffer-menu-keymap)
2499 (posn-at-x-y 0 0 nil t)))
2501 (global-set-key [C-f10] 'buffer-menu-open)
2503 (defun mouse-buffer-menu-keymap ()
2504 (let* ((menu (mouse-buffer-menu-map))
2505 (km (make-sparse-keymap (pop menu))))
2506 (dolist (item (nreverse menu))
2507 (let* ((name (pop item)))
2508 (define-key km (vector (intern name))
2509 (list name 'keymap name
2510 (menu-bar-buffer-vector item)))))
2511 km))
2513 (defvar tty-menu-navigation-map
2514 (let ((map (make-sparse-keymap)))
2515 ;; The next line is disabled because it breaks interpretation of
2516 ;; escape sequences, produced by TTY arrow keys, as tty-menu-*
2517 ;; commands. Instead, we explicitly bind some keys to
2518 ;; tty-menu-exit.
2519 ;;(define-key map [t] 'tty-menu-exit)
2521 ;; The tty-menu-* are just symbols interpreted by term.c, they are
2522 ;; not real commands.
2523 (dolist (bind '((keyboard-quit . tty-menu-exit)
2524 (keyboard-escape-quit . tty-menu-exit)
2525 ;; The following two will need to be revised if we ever
2526 ;; support a right-to-left menu bar.
2527 (forward-char . tty-menu-next-menu)
2528 (backward-char . tty-menu-prev-menu)
2529 (right-char . tty-menu-next-menu)
2530 (left-char . tty-menu-prev-menu)
2531 (next-line . tty-menu-next-item)
2532 (previous-line . tty-menu-prev-item)
2533 (newline . tty-menu-select)
2534 (newline-and-indent . tty-menu-select)
2535 (menu-bar-open . tty-menu-exit)))
2536 (substitute-key-definition (car bind) (cdr bind)
2537 map (current-global-map)))
2539 ;; The bindings of menu-bar items are so that clicking on the menu
2540 ;; bar when a menu is already shown pops down that menu.
2541 (define-key map [menu-bar t] 'tty-menu-exit)
2543 (define-key map [?\C-r] 'tty-menu-select)
2544 (define-key map [?\C-j] 'tty-menu-select)
2545 (define-key map [return] 'tty-menu-select)
2546 (define-key map [linefeed] 'tty-menu-select)
2547 (define-key map [mouse-1] 'tty-menu-select)
2548 (define-key map [drag-mouse-1] 'tty-menu-select)
2549 (define-key map [mouse-2] 'tty-menu-select)
2550 (define-key map [drag-mouse-2] 'tty-menu-select)
2551 (define-key map [mouse-3] 'tty-menu-select)
2552 (define-key map [drag-mouse-3] 'tty-menu-select)
2553 (define-key map [wheel-down] 'tty-menu-next-item)
2554 (define-key map [wheel-up] 'tty-menu-prev-item)
2555 (define-key map [wheel-left] 'tty-menu-prev-menu)
2556 (define-key map [wheel-right] 'tty-menu-next-menu)
2557 ;; The following 4 bindings are for those whose text-mode mouse
2558 ;; lack the wheel.
2559 (define-key map [S-mouse-1] 'tty-menu-next-item)
2560 (define-key map [S-drag-mouse-1] 'tty-menu-next-item)
2561 (define-key map [S-mouse-2] 'tty-menu-prev-item)
2562 (define-key map [S-drag-mouse-2] 'tty-menu-prev-item)
2563 (define-key map [S-mouse-3] 'tty-menu-prev-item)
2564 (define-key map [S-drag-mouse-3] 'tty-menu-prev-item)
2565 (define-key map [header-line mouse-1] 'tty-menu-select)
2566 (define-key map [header-line drag-mouse-1] 'tty-menu-select)
2567 ;; The down-mouse events must be bound to tty-menu-ignore, so that
2568 ;; only releasing the mouse button pops up the menu.
2569 (define-key map [mode-line down-mouse-1] 'tty-menu-ignore)
2570 (define-key map [mode-line down-mouse-2] 'tty-menu-ignore)
2571 (define-key map [mode-line down-mouse-3] 'tty-menu-ignore)
2572 (define-key map [mode-line C-down-mouse-1] 'tty-menu-ignore)
2573 (define-key map [mode-line C-down-mouse-2] 'tty-menu-ignore)
2574 (define-key map [mode-line C-down-mouse-3] 'tty-menu-ignore)
2575 (define-key map [down-mouse-1] 'tty-menu-ignore)
2576 (define-key map [C-down-mouse-1] 'tty-menu-ignore)
2577 (define-key map [C-down-mouse-2] 'tty-menu-ignore)
2578 (define-key map [C-down-mouse-3] 'tty-menu-ignore)
2579 (define-key map [mouse-movement] 'tty-menu-mouse-movement)
2580 map)
2581 "Keymap used while processing TTY menus.")
2583 (provide 'menu-bar)
2585 ;;; menu-bar.el ends here