* loading.texi: Add `define-type' entry for load-history
[emacs.git] / lisp / menu-bar.el
blobf9dde5748c27c9d9f18bc8d3eb44c8bb9a54fad8
1 ;;; menu-bar.el --- define a default menu bar
3 ;; Copyright (C) 1993-1995, 2000-2016 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 <http://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-regexp-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 (defvar gui-select-enable-clipboard)
535 (defun clipboard-yank ()
536 "Insert the clipboard contents, or the last stretch of killed text."
537 (interactive "*")
538 (let ((gui-select-enable-clipboard t))
539 (yank)))
541 (defun clipboard-kill-ring-save (beg end &optional region)
542 "Copy region to kill ring, and save in the GUI's clipboard."
543 (interactive "r\np")
544 (let ((gui-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 (interactive "r\np")
550 (let ((gui-select-enable-clipboard t))
551 (kill-region beg end region)))
553 (defun menu-bar-enable-clipboard ()
554 "Make CUT, PASTE and COPY (keys and menu bar items) use the clipboard.
555 Do the same for the keys of the same name."
556 (interactive)
557 ;; These are Sun server keysyms for the Cut, Copy and Paste keys
558 ;; (also for XFree86 on Sun keyboard):
559 (define-key global-map [f20] 'clipboard-kill-region)
560 (define-key global-map [f16] 'clipboard-kill-ring-save)
561 (define-key global-map [f18] 'clipboard-yank)
562 ;; X11R6 versions:
563 (define-key global-map [cut] 'clipboard-kill-region)
564 (define-key global-map [copy] 'clipboard-kill-ring-save)
565 (define-key global-map [paste] 'clipboard-yank))
567 ;; The "Options" menu items
569 (defvar menu-bar-custom-menu
570 (let ((menu (make-sparse-keymap "Customize")))
572 (bindings--define-key menu [customize-apropos-faces]
573 '(menu-item "Faces Matching..." customize-apropos-faces
574 :help "Browse faces matching a regexp or word list"))
575 (bindings--define-key menu [customize-apropos-options]
576 '(menu-item "Options Matching..." customize-apropos-options
577 :help "Browse options matching a regexp or word list"))
578 (bindings--define-key menu [customize-apropos]
579 '(menu-item "All Settings Matching..." customize-apropos
580 :help "Browse customizable settings matching a regexp or word list"))
581 (bindings--define-key menu [separator-1]
582 menu-bar-separator)
583 (bindings--define-key menu [customize-group]
584 '(menu-item "Specific Group..." customize-group
585 :help "Customize settings of specific group"))
586 (bindings--define-key menu [customize-face]
587 '(menu-item "Specific Face..." customize-face
588 :help "Customize attributes of specific face"))
589 (bindings--define-key menu [customize-option]
590 '(menu-item "Specific Option..." customize-option
591 :help "Customize value of specific option"))
592 (bindings--define-key menu [separator-2]
593 menu-bar-separator)
594 (bindings--define-key menu [customize-changed-options]
595 '(menu-item "New Options..." customize-changed-options
596 :help "Options added or changed in recent Emacs versions"))
597 (bindings--define-key menu [customize-saved]
598 '(menu-item "Saved Options" customize-saved
599 :help "Customize previously saved options"))
600 (bindings--define-key menu [separator-3]
601 menu-bar-separator)
602 (bindings--define-key menu [customize-browse]
603 '(menu-item "Browse Customization Groups" customize-browse
604 :help "Browse all customization groups"))
605 (bindings--define-key menu [customize]
606 '(menu-item "Top-level Customization Group" customize
607 :help "The master group called `Emacs'"))
608 (bindings--define-key menu [customize-themes]
609 '(menu-item "Custom Themes" customize-themes
610 :help "Choose a pre-defined customization theme"))
611 menu))
612 ;(defvar menu-bar-preferences-menu (make-sparse-keymap "Preferences"))
614 (defmacro menu-bar-make-mm-toggle (fname doc help &optional props)
615 "Make a menu-item for a global minor mode toggle.
616 FNAME is the minor mode's name (variable and function).
617 DOC is the text to use for the menu entry.
618 HELP is the text to use for the tooltip.
619 PROPS are additional properties."
620 `'(menu-item ,doc ,fname
621 ,@props
622 :help ,help
623 :button (:toggle . (and (default-boundp ',fname)
624 (default-value ',fname)))))
626 (defmacro menu-bar-make-toggle (name variable doc message help &rest body)
627 `(progn
628 (defun ,name (&optional interactively)
629 ,(concat "Toggle whether to " (downcase (substring help 0 1))
630 (substring help 1) ".
631 In an interactive call, record this option as a candidate for saving
632 by \"Save Options\" in Custom buffers.")
633 (interactive "p")
634 (if ,(if body `(progn . ,body)
635 `(progn
636 (custom-load-symbol ',variable)
637 (let ((set (or (get ',variable 'custom-set) 'set-default))
638 (get (or (get ',variable 'custom-get) 'default-value)))
639 (funcall set ',variable (not (funcall get ',variable))))))
640 (message ,message "enabled globally")
641 (message ,message "disabled globally"))
642 ;; The function `customize-mark-as-set' must only be called when
643 ;; a variable is set interactively, as the purpose is to mark it as
644 ;; a candidate for "Save Options", and we do not want to save options
645 ;; the user have already set explicitly in his init file.
646 (if interactively (customize-mark-as-set ',variable)))
647 '(menu-item ,doc ,name
648 :help ,help
649 :button (:toggle . (and (default-boundp ',variable)
650 (default-value ',variable))))))
652 ;; Function for setting/saving default font.
654 (defun menu-set-font ()
655 "Interactively select a font and make it the default on all frames.
657 The selected font will be the default on both the existing and future frames."
658 (interactive)
659 (set-frame-font (if (fboundp 'x-select-font)
660 (x-select-font)
661 (mouse-select-font))
662 nil t))
664 (defun menu-bar-options-save ()
665 "Save current values of Options menu items using Custom."
666 (interactive)
667 (let ((need-save nil))
668 ;; These are set with menu-bar-make-mm-toggle, which does not
669 ;; put on a customized-value property.
670 (dolist (elt '(line-number-mode column-number-mode size-indication-mode
671 cua-mode show-paren-mode transient-mark-mode
672 blink-cursor-mode display-time-mode display-battery-mode
673 ;; These are set by other functions that don't set
674 ;; the customized state. Having them here has the
675 ;; side-effect that turning them off via X
676 ;; resources acts like having customized them, but
677 ;; that seems harmless.
678 menu-bar-mode tool-bar-mode))
679 ;; FIXME ? It's a little annoying that running this command
680 ;; always loads cua-base, paren, time, and battery, even if they
681 ;; have not been customized in any way. (Due to custom-load-symbol.)
682 (and (customize-mark-to-save elt)
683 (setq need-save t)))
684 ;; These are set with `customize-set-variable'.
685 (dolist (elt '(scroll-bar-mode
686 debug-on-quit debug-on-error
687 ;; Somehow this works, when tool-bar and menu-bar don't.
688 tooltip-mode window-divider-mode
689 save-place uniquify-buffer-name-style fringe-mode
690 indicate-empty-lines indicate-buffer-boundaries
691 case-fold-search font-use-system-font
692 current-language-environment default-input-method
693 ;; Saving `text-mode-hook' is somewhat questionable,
694 ;; as we might get more than we bargain for, if
695 ;; other code may has added hooks as well.
696 ;; Nonetheless, not saving it would like be confuse
697 ;; more often.
698 ;; -- Per Abrahamsen <abraham@dina.kvl.dk> 2002-02-11.
699 text-mode-hook tool-bar-position))
700 (and (get elt 'customized-value)
701 (customize-mark-to-save elt)
702 (setq need-save t)))
703 (when (get 'default 'customized-face)
704 (put 'default 'saved-face (get 'default 'customized-face))
705 (put 'default 'customized-face nil)
706 (setq need-save t))
707 ;; Save if we changed anything.
708 (when need-save
709 (custom-save-all))))
712 ;;; Assemble all the top-level items of the "Options" menu
714 ;; The "Show/Hide" submenu of menu "Options"
716 (defun menu-bar-window-divider-customize ()
717 "Show customization buffer for `window-divider' group."
718 (interactive)
719 (customize-group 'window-divider))
721 (defun menu-bar-bottom-and-right-window-divider ()
722 "Display dividers on the bottom and right of each window."
723 (interactive)
724 (customize-set-variable 'window-divider-default-places t)
725 (window-divider-mode 1))
727 (defun menu-bar-right-window-divider ()
728 "Display dividers only on the right of each window."
729 (interactive)
730 (customize-set-variable 'window-divider-default-places 'right-only)
731 (window-divider-mode 1))
733 (defun menu-bar-bottom-window-divider ()
734 "Display dividers only at the bottom of each window."
735 (interactive)
736 (customize-set-variable 'window-divider-default-places 'bottom-only)
737 (window-divider-mode 1))
739 (defun menu-bar-no-window-divider ()
740 "Do not display window dividers."
741 (interactive)
742 (window-divider-mode -1))
744 ;; For the radio buttons below we check whether the respective dividers
745 ;; are displayed on the selected frame. This is not fully congruent
746 ;; with `window-divider-mode' but makes the menu entries work also when
747 ;; dividers are displayed by manipulating frame parameters directly.
748 (defvar menu-bar-showhide-window-divider-menu
749 (let ((menu (make-sparse-keymap "Window Divider")))
750 (bindings--define-key menu [customize]
751 '(menu-item "Customize" menu-bar-window-divider-customize
752 :help "Customize window dividers"
753 :visible (memq (window-system) '(x w32))))
755 (bindings--define-key menu [bottom-and-right]
756 '(menu-item "Bottom and Right"
757 menu-bar-bottom-and-right-window-divider
758 :help "Display window divider on the bottom and right of each window"
759 :visible (memq (window-system) '(x w32))
760 :button (:radio
761 . (and (window-divider-width-valid-p
762 (cdr (assq 'bottom-divider-width
763 (frame-parameters))))
764 (window-divider-width-valid-p
765 (cdr (assq 'right-divider-width
766 (frame-parameters))))))))
767 (bindings--define-key menu [right-only]
768 '(menu-item "Right Only"
769 menu-bar-right-window-divider
770 :help "Display window divider on the right of each window only"
771 :visible (memq (window-system) '(x w32))
772 :button (:radio
773 . (and (not (window-divider-width-valid-p
774 (cdr (assq 'bottom-divider-width
775 (frame-parameters)))))
776 (window-divider-width-valid-p
777 (cdr (assq 'right-divider-width
778 (frame-parameters))))))))
779 (bindings--define-key menu [bottom-only]
780 '(menu-item "Bottom Only"
781 menu-bar-bottom-window-divider
782 :help "Display window divider on the bottom of each window only"
783 :visible (memq (window-system) '(x w32))
784 :button (:radio
785 . (and (window-divider-width-valid-p
786 (cdr (assq 'bottom-divider-width
787 (frame-parameters))))
788 (not (window-divider-width-valid-p
789 (cdr (assq 'right-divider-width
790 (frame-parameters)))))))))
791 (bindings--define-key menu [no-divider]
792 '(menu-item "None"
793 menu-bar-no-window-divider
794 :help "Do not display window dividers"
795 :visible (memq (window-system) '(x w32))
796 :button (:radio
797 . (and (not (window-divider-width-valid-p
798 (cdr (assq 'bottom-divider-width
799 (frame-parameters)))))
800 (not (window-divider-width-valid-p
801 (cdr (assq 'right-divider-width
802 (frame-parameters)))))))))
803 menu))
805 (defun menu-bar-showhide-fringe-ind-customize ()
806 "Show customization buffer for `indicate-buffer-boundaries'."
807 (interactive)
808 (customize-variable 'indicate-buffer-boundaries))
810 (defun menu-bar-showhide-fringe-ind-mixed ()
811 "Display top and bottom indicators in opposite fringes, arrows in right."
812 (interactive)
813 (customize-set-variable 'indicate-buffer-boundaries
814 '((t . right) (top . left))))
816 (defun menu-bar-showhide-fringe-ind-box ()
817 "Display top and bottom indicators in opposite fringes."
818 (interactive)
819 (customize-set-variable 'indicate-buffer-boundaries
820 '((top . left) (bottom . right))))
822 (defun menu-bar-showhide-fringe-ind-right ()
823 "Display buffer boundaries and arrows in the right fringe."
824 (interactive)
825 (customize-set-variable 'indicate-buffer-boundaries 'right))
827 (defun menu-bar-showhide-fringe-ind-left ()
828 "Display buffer boundaries and arrows in the left fringe."
829 (interactive)
830 (customize-set-variable 'indicate-buffer-boundaries 'left))
832 (defun menu-bar-showhide-fringe-ind-none ()
833 "Do not display any buffer boundary indicators."
834 (interactive)
835 (customize-set-variable 'indicate-buffer-boundaries nil))
837 (defvar menu-bar-showhide-fringe-ind-menu
838 (let ((menu (make-sparse-keymap "Buffer boundaries")))
840 (bindings--define-key menu [customize]
841 '(menu-item "Other (Customize)"
842 menu-bar-showhide-fringe-ind-customize
843 :help "Additional choices available through Custom buffer"
844 :visible (display-graphic-p)
845 :button (:radio . (not (member indicate-buffer-boundaries
846 '(nil left right
847 ((top . left) (bottom . right))
848 ((t . right) (top . left))))))))
850 (bindings--define-key menu [mixed]
851 '(menu-item "Opposite, Arrows Right" menu-bar-showhide-fringe-ind-mixed
852 :help
853 "Show top/bottom indicators in opposite fringes, arrows in right"
854 :visible (display-graphic-p)
855 :button (:radio . (equal indicate-buffer-boundaries
856 '((t . right) (top . left))))))
858 (bindings--define-key menu [box]
859 '(menu-item "Opposite, No Arrows" menu-bar-showhide-fringe-ind-box
860 :help "Show top/bottom indicators in opposite fringes, no arrows"
861 :visible (display-graphic-p)
862 :button (:radio . (equal indicate-buffer-boundaries
863 '((top . left) (bottom . right))))))
865 (bindings--define-key menu [right]
866 '(menu-item "In Right Fringe" menu-bar-showhide-fringe-ind-right
867 :help "Show buffer boundaries and arrows in right fringe"
868 :visible (display-graphic-p)
869 :button (:radio . (eq indicate-buffer-boundaries 'right))))
871 (bindings--define-key menu [left]
872 '(menu-item "In Left Fringe" menu-bar-showhide-fringe-ind-left
873 :help "Show buffer boundaries and arrows in left fringe"
874 :visible (display-graphic-p)
875 :button (:radio . (eq indicate-buffer-boundaries 'left))))
877 (bindings--define-key menu [none]
878 '(menu-item "No Indicators" menu-bar-showhide-fringe-ind-none
879 :help "Hide all buffer boundary indicators and arrows"
880 :visible (display-graphic-p)
881 :button (:radio . (eq indicate-buffer-boundaries nil))))
882 menu))
884 (defun menu-bar-showhide-fringe-menu-customize ()
885 "Show customization buffer for `fringe-mode'."
886 (interactive)
887 (customize-variable 'fringe-mode))
889 (defun menu-bar-showhide-fringe-menu-customize-reset ()
890 "Reset the fringe mode: display fringes on both sides of a window."
891 (interactive)
892 (customize-set-variable 'fringe-mode nil))
894 (defun menu-bar-showhide-fringe-menu-customize-right ()
895 "Display fringes only on the right of each window."
896 (interactive)
897 (require 'fringe)
898 (customize-set-variable 'fringe-mode '(0 . nil)))
900 (defun menu-bar-showhide-fringe-menu-customize-left ()
901 "Display fringes only on the left of each window."
902 (interactive)
903 (require 'fringe)
904 (customize-set-variable 'fringe-mode '(nil . 0)))
906 (defun menu-bar-showhide-fringe-menu-customize-disable ()
907 "Do not display window fringes."
908 (interactive)
909 (require 'fringe)
910 (customize-set-variable 'fringe-mode 0))
912 (defvar menu-bar-showhide-fringe-menu
913 (let ((menu (make-sparse-keymap "Fringe")))
915 (bindings--define-key menu [showhide-fringe-ind]
916 `(menu-item "Buffer Boundaries" ,menu-bar-showhide-fringe-ind-menu
917 :visible (display-graphic-p)
918 :help "Indicate buffer boundaries in fringe"))
920 (bindings--define-key menu [indicate-empty-lines]
921 (menu-bar-make-toggle toggle-indicate-empty-lines indicate-empty-lines
922 "Empty Line Indicators"
923 "Indicating of empty lines %s"
924 "Indicate trailing empty lines in fringe, globally"))
926 (bindings--define-key menu [customize]
927 '(menu-item "Customize Fringe" menu-bar-showhide-fringe-menu-customize
928 :help "Detailed customization of fringe"
929 :visible (display-graphic-p)))
931 (bindings--define-key menu [default]
932 '(menu-item "Default" menu-bar-showhide-fringe-menu-customize-reset
933 :help "Default width fringe on both left and right side"
934 :visible (display-graphic-p)
935 :button (:radio . (eq fringe-mode nil))))
937 (bindings--define-key menu [right]
938 '(menu-item "On the Right" menu-bar-showhide-fringe-menu-customize-right
939 :help "Fringe only on the right side"
940 :visible (display-graphic-p)
941 :button (:radio . (equal fringe-mode '(0 . nil)))))
943 (bindings--define-key menu [left]
944 '(menu-item "On the Left" menu-bar-showhide-fringe-menu-customize-left
945 :help "Fringe only on the left side"
946 :visible (display-graphic-p)
947 :button (:radio . (equal fringe-mode '(nil . 0)))))
949 (bindings--define-key menu [none]
950 '(menu-item "None" menu-bar-showhide-fringe-menu-customize-disable
951 :help "Turn off fringe"
952 :visible (display-graphic-p)
953 :button (:radio . (eq fringe-mode 0))))
954 menu))
956 (defun menu-bar-right-scroll-bar ()
957 "Display scroll bars on the right of each window."
958 (interactive)
959 (customize-set-variable 'scroll-bar-mode 'right))
961 (defun menu-bar-left-scroll-bar ()
962 "Display scroll bars on the left of each window."
963 (interactive)
964 (customize-set-variable 'scroll-bar-mode 'left))
966 (defun menu-bar-no-scroll-bar ()
967 "Turn off scroll bars."
968 (interactive)
969 (customize-set-variable 'scroll-bar-mode nil))
971 (defun menu-bar-horizontal-scroll-bar ()
972 "Display horizontal scroll bars on each window."
973 (interactive)
974 (customize-set-variable 'horizontal-scroll-bar-mode t))
976 (defun menu-bar-no-horizontal-scroll-bar ()
977 "Turn off horizontal scroll bars."
978 (interactive)
979 (customize-set-variable 'horizontal-scroll-bar-mode nil))
981 (defvar menu-bar-showhide-scroll-bar-menu
982 (let ((menu (make-sparse-keymap "Scroll-bar")))
983 (bindings--define-key menu [horizontal]
984 '(menu-item "Horizontal"
985 menu-bar-horizontal-scroll-bar
986 :help "Horizontal scroll bar"
987 :visible (horizontal-scroll-bars-available-p)
988 :button (:radio . (cdr (assq 'horizontal-scroll-bars
989 (frame-parameters))))))
991 (bindings--define-key menu [none-horizontal]
992 '(menu-item "None-horizontal"
993 menu-bar-no-horizontal-scroll-bar
994 :help "Turn off horizontal scroll bars"
995 :visible (horizontal-scroll-bars-available-p)
996 :button (:radio . (not (cdr (assq 'horizontal-scroll-bars
997 (frame-parameters)))))))
999 (bindings--define-key menu [right]
1000 '(menu-item "On the Right"
1001 menu-bar-right-scroll-bar
1002 :help "Scroll-bar on the right side"
1003 :visible (display-graphic-p)
1004 :button (:radio . (eq (cdr (assq 'vertical-scroll-bars
1005 (frame-parameters)))
1006 'right))))
1008 (bindings--define-key menu [left]
1009 '(menu-item "On the Left"
1010 menu-bar-left-scroll-bar
1011 :help "Scroll-bar on the left side"
1012 :visible (display-graphic-p)
1013 :button (:radio . (eq (cdr (assq 'vertical-scroll-bars
1014 (frame-parameters)))
1015 'left))))
1017 (bindings--define-key menu [none]
1018 '(menu-item "None"
1019 menu-bar-no-scroll-bar
1020 :help "Turn off scroll-bar"
1021 :visible (display-graphic-p)
1022 :button (:radio . (eq (cdr (assq 'vertical-scroll-bars
1023 (frame-parameters)))
1024 nil))))
1025 menu))
1027 (defun menu-bar-frame-for-menubar ()
1028 "Return the frame suitable for updating the menu bar."
1029 (or (and (framep menu-updating-frame)
1030 menu-updating-frame)
1031 (selected-frame)))
1033 (defun menu-bar-positive-p (val)
1034 "Return non-nil if VAL is a positive number."
1035 (and (numberp val)
1036 (> val 0)))
1038 (defun menu-bar-set-tool-bar-position (position)
1039 (customize-set-variable 'tool-bar-mode t)
1040 (customize-set-variable 'tool-bar-position position))
1041 (defun menu-bar-showhide-tool-bar-menu-customize-disable ()
1042 "Do not display tool bars."
1043 (interactive)
1044 (customize-set-variable 'tool-bar-mode nil))
1045 (defun menu-bar-showhide-tool-bar-menu-customize-enable-left ()
1046 "Display tool bars on the left side."
1047 (interactive)
1048 (menu-bar-set-tool-bar-position 'left))
1049 (defun menu-bar-showhide-tool-bar-menu-customize-enable-right ()
1050 "Display tool bars on the right side."
1051 (interactive)
1052 (menu-bar-set-tool-bar-position 'right))
1053 (defun menu-bar-showhide-tool-bar-menu-customize-enable-top ()
1054 "Display tool bars on the top side."
1055 (interactive)
1056 (menu-bar-set-tool-bar-position 'top))
1057 (defun menu-bar-showhide-tool-bar-menu-customize-enable-bottom ()
1058 "Display tool bars on the bottom side."
1059 (interactive)
1060 (menu-bar-set-tool-bar-position 'bottom))
1062 (when (featurep 'move-toolbar)
1063 (defvar menu-bar-showhide-tool-bar-menu
1064 (let ((menu (make-sparse-keymap "Tool-bar")))
1066 (bindings--define-key menu [showhide-tool-bar-left]
1067 '(menu-item "On the Left"
1068 menu-bar-showhide-tool-bar-menu-customize-enable-left
1069 :help "Tool-bar at the left side"
1070 :visible (display-graphic-p)
1071 :button
1072 (:radio . (and tool-bar-mode
1073 (eq (frame-parameter
1074 (menu-bar-frame-for-menubar)
1075 'tool-bar-position)
1076 'left)))))
1078 (bindings--define-key menu [showhide-tool-bar-right]
1079 '(menu-item "On the Right"
1080 menu-bar-showhide-tool-bar-menu-customize-enable-right
1081 :help "Tool-bar at the right side"
1082 :visible (display-graphic-p)
1083 :button
1084 (:radio . (and tool-bar-mode
1085 (eq (frame-parameter
1086 (menu-bar-frame-for-menubar)
1087 'tool-bar-position)
1088 'right)))))
1090 (bindings--define-key menu [showhide-tool-bar-bottom]
1091 '(menu-item "On the Bottom"
1092 menu-bar-showhide-tool-bar-menu-customize-enable-bottom
1093 :help "Tool-bar at the bottom"
1094 :visible (display-graphic-p)
1095 :button
1096 (:radio . (and tool-bar-mode
1097 (eq (frame-parameter
1098 (menu-bar-frame-for-menubar)
1099 'tool-bar-position)
1100 'bottom)))))
1102 (bindings--define-key menu [showhide-tool-bar-top]
1103 '(menu-item "On the Top"
1104 menu-bar-showhide-tool-bar-menu-customize-enable-top
1105 :help "Tool-bar at the top"
1106 :visible (display-graphic-p)
1107 :button
1108 (:radio . (and tool-bar-mode
1109 (eq (frame-parameter
1110 (menu-bar-frame-for-menubar)
1111 'tool-bar-position)
1112 'top)))))
1114 (bindings--define-key menu [showhide-tool-bar-none]
1115 '(menu-item "None"
1116 menu-bar-showhide-tool-bar-menu-customize-disable
1117 :help "Turn tool-bar off"
1118 :visible (display-graphic-p)
1119 :button (:radio . (eq tool-bar-mode nil))))
1120 menu)))
1122 (defvar menu-bar-showhide-menu
1123 (let ((menu (make-sparse-keymap "Show/Hide")))
1125 (bindings--define-key menu [column-number-mode]
1126 (menu-bar-make-mm-toggle column-number-mode
1127 "Column Numbers"
1128 "Show the current column number in the mode line"))
1130 (bindings--define-key menu [line-number-mode]
1131 (menu-bar-make-mm-toggle line-number-mode
1132 "Line Numbers"
1133 "Show the current line number in the mode line"))
1135 (bindings--define-key menu [size-indication-mode]
1136 (menu-bar-make-mm-toggle size-indication-mode
1137 "Size Indication"
1138 "Show the size of the buffer in the mode line"))
1140 (bindings--define-key menu [linecolumn-separator]
1141 menu-bar-separator)
1143 (bindings--define-key menu [showhide-battery]
1144 (menu-bar-make-mm-toggle display-battery-mode
1145 "Battery Status"
1146 "Display battery status information in mode line"))
1148 (bindings--define-key menu [showhide-date-time]
1149 (menu-bar-make-mm-toggle display-time-mode
1150 "Time, Load and Mail"
1151 "Display time, system load averages and \
1152 mail status in mode line"))
1154 (bindings--define-key menu [datetime-separator]
1155 menu-bar-separator)
1157 (bindings--define-key menu [showhide-speedbar]
1158 '(menu-item "Speedbar" speedbar-frame-mode
1159 :help "Display a Speedbar quick-navigation frame"
1160 :button (:toggle
1161 . (and (boundp 'speedbar-frame)
1162 (frame-live-p (symbol-value 'speedbar-frame))
1163 (frame-visible-p
1164 (symbol-value 'speedbar-frame))))))
1166 (bindings--define-key menu [showhide-window-divider]
1167 `(menu-item "Window Divider" ,menu-bar-showhide-window-divider-menu
1168 :visible (memq (window-system) '(x w32))))
1170 (bindings--define-key menu [showhide-fringe]
1171 `(menu-item "Fringe" ,menu-bar-showhide-fringe-menu
1172 :visible (display-graphic-p)))
1174 (bindings--define-key menu [showhide-scroll-bar]
1175 `(menu-item "Scroll-bar" ,menu-bar-showhide-scroll-bar-menu
1176 :visible (display-graphic-p)))
1178 (bindings--define-key menu [showhide-tooltip-mode]
1179 '(menu-item "Tooltips" tooltip-mode
1180 :help "Turn tooltips on/off"
1181 :visible (and (display-graphic-p) (fboundp 'x-show-tip))
1182 :button (:toggle . tooltip-mode)))
1184 (bindings--define-key menu [menu-bar-mode]
1185 '(menu-item "Menu-bar" toggle-menu-bar-mode-from-frame
1186 :help "Turn menu-bar on/off"
1187 :button
1188 (:toggle . (menu-bar-positive-p
1189 (frame-parameter (menu-bar-frame-for-menubar)
1190 'menu-bar-lines)))))
1192 (if (and (boundp 'menu-bar-showhide-tool-bar-menu)
1193 (keymapp menu-bar-showhide-tool-bar-menu))
1194 (bindings--define-key menu [showhide-tool-bar]
1195 `(menu-item "Tool-bar" ,menu-bar-showhide-tool-bar-menu
1196 :visible (display-graphic-p)))
1197 ;; else not tool bar that can move.
1198 (bindings--define-key menu [showhide-tool-bar]
1199 '(menu-item "Tool-bar" toggle-tool-bar-mode-from-frame
1200 :help "Turn tool-bar on/off"
1201 :visible (display-graphic-p)
1202 :button
1203 (:toggle . (menu-bar-positive-p
1204 (frame-parameter (menu-bar-frame-for-menubar)
1205 'tool-bar-lines))))))
1206 menu))
1208 (defvar menu-bar-line-wrapping-menu
1209 (let ((menu (make-sparse-keymap "Line Wrapping")))
1211 (bindings--define-key menu [word-wrap]
1212 `(menu-item "Word Wrap (Visual Line mode)"
1213 ,(lambda ()
1214 (interactive)
1215 (unless visual-line-mode
1216 (visual-line-mode 1))
1217 (message "Visual-Line mode enabled"))
1218 :help "Wrap long lines at word boundaries"
1219 :button (:radio
1220 . (and (null truncate-lines)
1221 (not (truncated-partial-width-window-p))
1222 word-wrap))
1223 :visible (menu-bar-menu-frame-live-and-visible-p)))
1225 (bindings--define-key menu [truncate]
1226 `(menu-item "Truncate Long Lines"
1227 ,(lambda ()
1228 (interactive)
1229 (if visual-line-mode (visual-line-mode 0))
1230 (setq word-wrap nil)
1231 (toggle-truncate-lines 1))
1232 :help "Truncate long lines at window edge"
1233 :button (:radio . (or truncate-lines
1234 (truncated-partial-width-window-p)))
1235 :visible (menu-bar-menu-frame-live-and-visible-p)
1236 :enable (not (truncated-partial-width-window-p))))
1238 (bindings--define-key menu [window-wrap]
1239 `(menu-item "Wrap at Window Edge"
1240 ,(lambda () (interactive)
1241 (if visual-line-mode (visual-line-mode 0))
1242 (setq word-wrap nil)
1243 (if truncate-lines (toggle-truncate-lines -1)))
1244 :help "Wrap long lines at window edge"
1245 :button (:radio
1246 . (and (null truncate-lines)
1247 (not (truncated-partial-width-window-p))
1248 (not word-wrap)))
1249 :visible (menu-bar-menu-frame-live-and-visible-p)
1250 :enable (not (truncated-partial-width-window-p))))
1251 menu))
1253 (defvar menu-bar-options-menu
1254 (let ((menu (make-sparse-keymap "Options")))
1255 (bindings--define-key menu [customize]
1256 `(menu-item "Customize Emacs" ,menu-bar-custom-menu))
1258 (bindings--define-key menu [package]
1259 '(menu-item "Manage Emacs Packages" package-list-packages
1260 :help "Install or uninstall additional Emacs packages"))
1262 (bindings--define-key menu [save]
1263 '(menu-item "Save Options" menu-bar-options-save
1264 :help "Save options set from the menu above"))
1266 (bindings--define-key menu [custom-separator]
1267 menu-bar-separator)
1269 (bindings--define-key menu [menu-set-font]
1270 '(menu-item "Set Default Font..." menu-set-font
1271 :visible (display-multi-font-p)
1272 :help "Select a default font"))
1274 (if (featurep 'system-font-setting)
1275 (bindings--define-key menu [menu-system-font]
1276 (menu-bar-make-toggle
1277 toggle-use-system-font font-use-system-font
1278 "Use System Font"
1279 "Use system font: %s"
1280 "Use the monospaced font defined by the system")))
1282 (bindings--define-key menu [showhide]
1283 `(menu-item "Show/Hide" ,menu-bar-showhide-menu))
1285 (bindings--define-key menu [showhide-separator]
1286 menu-bar-separator)
1288 (bindings--define-key menu [mule]
1289 ;; It is better not to use backquote here,
1290 ;; because that makes a bootstrapping problem
1291 ;; if you need to recompile all the Lisp files using interpreted code.
1292 `(menu-item "Multilingual Environment" ,mule-menu-keymap
1293 ;; Most of the MULE menu actually does make sense in
1294 ;; unibyte mode, e.g. language selection.
1295 ;; :visible '(default-value 'enable-multibyte-characters)
1297 ;;(setq menu-bar-final-items (cons 'mule menu-bar-final-items))
1298 ;;(bindings--define-key menu [preferences]
1299 ;; `(menu-item "Preferences" ,menu-bar-preferences-menu
1300 ;; :help "Toggle important global options"))
1302 (bindings--define-key menu [mule-separator]
1303 menu-bar-separator)
1305 (bindings--define-key menu [debug-on-quit]
1306 (menu-bar-make-toggle toggle-debug-on-quit debug-on-quit
1307 "Enter Debugger on Quit/C-g" "Debug on Quit %s"
1308 "Enter Lisp debugger when C-g is pressed"))
1309 (bindings--define-key menu [debug-on-error]
1310 (menu-bar-make-toggle toggle-debug-on-error debug-on-error
1311 "Enter Debugger on Error" "Debug on Error %s"
1312 "Enter Lisp debugger when an error is signaled"))
1313 (bindings--define-key menu [debugger-separator]
1314 menu-bar-separator)
1316 (bindings--define-key menu [blink-cursor-mode]
1317 (menu-bar-make-mm-toggle
1318 blink-cursor-mode
1319 "Blink Cursor"
1320 "Whether the cursor blinks (Blink Cursor mode)"))
1321 (bindings--define-key menu [cursor-separator]
1322 menu-bar-separator)
1324 (bindings--define-key menu [save-place]
1325 (menu-bar-make-toggle
1326 toggle-save-place-globally save-place
1327 "Save Place in Files between Sessions"
1328 "Saving place in files %s"
1329 "Visit files of previous session when restarting Emacs"
1330 (require 'saveplace)
1331 ;; Do it by name, to avoid a free-variable
1332 ;; warning during byte compilation.
1333 (set-default
1334 'save-place (not (symbol-value 'save-place)))))
1336 (bindings--define-key menu [uniquify]
1337 (menu-bar-make-toggle
1338 toggle-uniquify-buffer-names uniquify-buffer-name-style
1339 "Use Directory Names in Buffer Names"
1340 "Directory name in buffer names (uniquify) %s"
1341 "Uniquify buffer names by adding parent directory names"
1342 (setq uniquify-buffer-name-style
1343 (if (not uniquify-buffer-name-style)
1344 'post-forward-angle-brackets))))
1346 (bindings--define-key menu [edit-options-separator]
1347 menu-bar-separator)
1348 (bindings--define-key menu [cua-mode]
1349 (menu-bar-make-mm-toggle
1350 cua-mode
1351 "Use CUA Keys (Cut/Paste with C-x/C-c/C-v)"
1352 "Use C-z/C-x/C-c/C-v keys for undo/cut/copy/paste"
1353 (:visible (or (not (boundp 'cua-enable-cua-keys))
1354 cua-enable-cua-keys))))
1356 (bindings--define-key menu [cua-emulation-mode]
1357 (menu-bar-make-mm-toggle
1358 cua-mode
1359 "Shift movement mark region (CUA)"
1360 "Use shifted movement keys to set and extend the region"
1361 (:visible (and (boundp 'cua-enable-cua-keys)
1362 (not cua-enable-cua-keys)))))
1364 (bindings--define-key menu [case-fold-search]
1365 (menu-bar-make-toggle
1366 toggle-case-fold-search case-fold-search
1367 "Ignore Case for Search"
1368 "Case-Insensitive Search %s"
1369 "Ignore letter-case in search commands"))
1371 (bindings--define-key menu [line-wrapping]
1372 `(menu-item "Line Wrapping in This Buffer"
1373 ,menu-bar-line-wrapping-menu))
1376 (bindings--define-key menu [highlight-separator]
1377 menu-bar-separator)
1378 (bindings--define-key menu [highlight-paren-mode]
1379 (menu-bar-make-mm-toggle
1380 show-paren-mode
1381 "Highlight Matching Parentheses"
1382 "Highlight matching/mismatched parentheses at cursor (Show Paren mode)"))
1383 (bindings--define-key menu [transient-mark-mode]
1384 (menu-bar-make-mm-toggle
1385 transient-mark-mode
1386 "Highlight Active Region"
1387 "Make text in active region stand out in color (Transient Mark mode)"
1388 (:enable (not cua-mode))))
1389 menu))
1392 ;; The "Tools" menu items
1394 (defvar menu-bar-games-menu
1395 (let ((menu (make-sparse-keymap "Games")))
1397 (bindings--define-key menu [zone]
1398 '(menu-item "Zone Out" zone
1399 :help "Play tricks with Emacs display when Emacs is idle"))
1400 (bindings--define-key menu [tetris]
1401 '(menu-item "Tetris" tetris
1402 :help "Falling blocks game"))
1403 (bindings--define-key menu [solitaire]
1404 '(menu-item "Solitaire" solitaire
1405 :help "Get rid of all the stones"))
1406 (bindings--define-key menu [snake]
1407 '(menu-item "Snake" snake
1408 :help "Move snake around avoiding collisions"))
1409 (bindings--define-key menu [pong]
1410 '(menu-item "Pong" pong
1411 :help "Bounce the ball to your opponent"))
1412 (bindings--define-key menu [mult]
1413 '(menu-item "Multiplication Puzzle" mpuz
1414 :help "Exercise brain with multiplication"))
1415 (bindings--define-key menu [life]
1416 '(menu-item "Life" life
1417 :help "Watch how John Conway's cellular automaton evolves"))
1418 (bindings--define-key menu [hanoi]
1419 '(menu-item "Towers of Hanoi" hanoi
1420 :help "Watch Towers-of-Hanoi puzzle solved by Emacs"))
1421 (bindings--define-key menu [gomoku]
1422 '(menu-item "Gomoku" gomoku
1423 :help "Mark 5 contiguous squares (like tic-tac-toe)"))
1424 (bindings--define-key menu [bubbles]
1425 '(menu-item "Bubbles" bubbles
1426 :help "Remove all bubbles using the fewest moves"))
1427 (bindings--define-key menu [black-box]
1428 '(menu-item "Blackbox" blackbox
1429 :help "Find balls in a black box by shooting rays"))
1430 (bindings--define-key menu [adventure]
1431 '(menu-item "Adventure" dunnet
1432 :help "Dunnet, a text Adventure game for Emacs"))
1433 (bindings--define-key menu [5x5]
1434 '(menu-item "5x5" 5x5
1435 :help "Fill in all the squares on a 5x5 board"))
1436 menu))
1438 (defvar menu-bar-encryption-decryption-menu
1439 (let ((menu (make-sparse-keymap "Encryption/Decryption")))
1440 (bindings--define-key menu [insert-keys]
1441 '(menu-item "Insert Keys" epa-insert-keys
1442 :help "Insert public keys after the current point"))
1444 (bindings--define-key menu [export-keys]
1445 '(menu-item "Export Keys" epa-export-keys
1446 :help "Export public keys to a file"))
1448 (bindings--define-key menu [import-keys-region]
1449 '(menu-item "Import Keys from Region" epa-import-keys-region
1450 :help "Import public keys from the current region"))
1452 (bindings--define-key menu [import-keys]
1453 '(menu-item "Import Keys from File..." epa-import-keys
1454 :help "Import public keys from a file"))
1456 (bindings--define-key menu [list-keys]
1457 '(menu-item "List Keys" epa-list-keys
1458 :help "Browse your public keyring"))
1460 (bindings--define-key menu [separator-keys]
1461 menu-bar-separator)
1463 (bindings--define-key menu [sign-region]
1464 '(menu-item "Sign Region" epa-sign-region
1465 :help "Create digital signature of the current region"))
1467 (bindings--define-key menu [verify-region]
1468 '(menu-item "Verify Region" epa-verify-region
1469 :help "Verify digital signature of the current region"))
1471 (bindings--define-key menu [encrypt-region]
1472 '(menu-item "Encrypt Region" epa-encrypt-region
1473 :help "Encrypt the current region"))
1475 (bindings--define-key menu [decrypt-region]
1476 '(menu-item "Decrypt Region" epa-decrypt-region
1477 :help "Decrypt the current region"))
1479 (bindings--define-key menu [separator-file]
1480 menu-bar-separator)
1482 (bindings--define-key menu [sign-file]
1483 '(menu-item "Sign File..." epa-sign-file
1484 :help "Create digital signature of a file"))
1486 (bindings--define-key menu [verify-file]
1487 '(menu-item "Verify File..." epa-verify-file
1488 :help "Verify digital signature of a file"))
1490 (bindings--define-key menu [encrypt-file]
1491 '(menu-item "Encrypt File..." epa-encrypt-file
1492 :help "Encrypt a file"))
1494 (bindings--define-key menu [decrypt-file]
1495 '(menu-item "Decrypt File..." epa-decrypt-file
1496 :help "Decrypt a file"))
1498 menu))
1500 (defun menu-bar-read-mail ()
1501 "Read mail using `read-mail-command'."
1502 (interactive)
1503 (call-interactively read-mail-command))
1505 (defvar menu-bar-tools-menu
1506 (let ((menu (make-sparse-keymap "Tools")))
1508 (bindings--define-key menu [games]
1509 `(menu-item "Games" ,menu-bar-games-menu))
1511 (bindings--define-key menu [separator-games]
1512 menu-bar-separator)
1514 (bindings--define-key menu [encryption-decryption]
1515 `(menu-item "Encryption/Decryption"
1516 ,menu-bar-encryption-decryption-menu))
1518 (bindings--define-key menu [separator-encryption-decryption]
1519 menu-bar-separator)
1521 (bindings--define-key menu [simple-calculator]
1522 '(menu-item "Simple Calculator" calculator
1523 :help "Invoke the Emacs built-in quick calculator"))
1524 (bindings--define-key menu [calc]
1525 '(menu-item "Programmable Calculator" calc
1526 :help "Invoke the Emacs built-in full scientific calculator"))
1527 (bindings--define-key menu [calendar]
1528 '(menu-item "Calendar" calendar
1529 :help "Invoke the Emacs built-in calendar"))
1531 (bindings--define-key menu [separator-net]
1532 menu-bar-separator)
1534 (bindings--define-key menu [browse-web]
1535 '(menu-item "Browse the Web..." browse-web))
1536 (bindings--define-key menu [directory-search]
1537 '(menu-item "Directory Search" eudc-tools-menu))
1538 (bindings--define-key menu [compose-mail]
1539 '(menu-item "Compose New Mail" compose-mail
1540 :visible (and mail-user-agent (not (eq mail-user-agent 'ignore)))
1541 :help "Start writing a new mail message"))
1542 (bindings--define-key menu [rmail]
1543 '(menu-item "Read Mail" menu-bar-read-mail
1544 :visible (and read-mail-command
1545 (not (eq read-mail-command 'ignore)))
1546 :help "Read your mail"))
1548 (bindings--define-key menu [gnus]
1549 '(menu-item "Read Net News" gnus
1550 :help "Read network news groups"))
1552 (bindings--define-key menu [separator-vc]
1553 menu-bar-separator)
1555 (bindings--define-key menu [vc] nil) ;Create the place for the VC menu.
1557 (bindings--define-key menu [separator-compare]
1558 menu-bar-separator)
1560 (bindings--define-key menu [epatch]
1561 '(menu-item "Apply Patch" menu-bar-epatch-menu))
1562 (bindings--define-key menu [ediff-merge]
1563 '(menu-item "Merge" menu-bar-ediff-merge-menu))
1564 (bindings--define-key menu [compare]
1565 '(menu-item "Compare (Ediff)" menu-bar-ediff-menu))
1567 (bindings--define-key menu [separator-spell]
1568 menu-bar-separator)
1570 (bindings--define-key menu [spell]
1571 '(menu-item "Spell Checking" ispell-menu-map))
1573 (bindings--define-key menu [separator-prog]
1574 menu-bar-separator)
1576 (bindings--define-key menu [semantic]
1577 '(menu-item "Source Code Parsers (Semantic)"
1578 semantic-mode
1579 :help "Toggle automatic parsing in source code buffers (Semantic mode)"
1580 :button (:toggle . (bound-and-true-p semantic-mode))))
1582 (bindings--define-key menu [ede]
1583 '(menu-item "Project Support (EDE)"
1584 global-ede-mode
1585 :help "Toggle the Emacs Development Environment (Global EDE mode)"
1586 :button (:toggle . (bound-and-true-p global-ede-mode))))
1588 (bindings--define-key menu [gdb]
1589 '(menu-item "Debugger (GDB)..." gdb
1590 :help "Debug a program from within Emacs with GDB"))
1591 (bindings--define-key menu [shell-on-region]
1592 '(menu-item "Shell Command on Region..." shell-command-on-region
1593 :enable mark-active
1594 :help "Pass marked region to a shell command"))
1595 (bindings--define-key menu [shell]
1596 '(menu-item "Shell Command..." shell-command
1597 :help "Invoke a shell command and catch its output"))
1598 (bindings--define-key menu [compile]
1599 '(menu-item "Compile..." compile
1600 :help "Invoke compiler or Make, view compilation errors"))
1601 (bindings--define-key menu [grep]
1602 '(menu-item "Search Files (Grep)..." grep
1603 :help "Search files for strings or regexps (with Grep)"))
1604 menu))
1606 ;; The "Help" menu items
1608 (defvar menu-bar-describe-menu
1609 (let ((menu (make-sparse-keymap "Describe")))
1611 (bindings--define-key menu [mule-diag]
1612 '(menu-item "Show All of Mule Status" mule-diag
1613 :visible (default-value 'enable-multibyte-characters)
1614 :help "Display multilingual environment settings"))
1615 (bindings--define-key menu [describe-coding-system-briefly]
1616 '(menu-item "Describe Coding System (Briefly)"
1617 describe-current-coding-system-briefly
1618 :visible (default-value 'enable-multibyte-characters)))
1619 (bindings--define-key menu [describe-coding-system]
1620 '(menu-item "Describe Coding System..." describe-coding-system
1621 :visible (default-value 'enable-multibyte-characters)))
1622 (bindings--define-key menu [describe-input-method]
1623 '(menu-item "Describe Input Method..." describe-input-method
1624 :visible (default-value 'enable-multibyte-characters)
1625 :help "Keyboard layout for specific input method"))
1626 (bindings--define-key menu [describe-language-environment]
1627 `(menu-item "Describe Language Environment"
1628 ,describe-language-environment-map))
1630 (bindings--define-key menu [separator-desc-mule]
1631 menu-bar-separator)
1633 (bindings--define-key menu [list-keybindings]
1634 '(menu-item "List Key Bindings" describe-bindings
1635 :help "Display all current key bindings (keyboard shortcuts)"))
1636 (bindings--define-key menu [describe-current-display-table]
1637 '(menu-item "Describe Display Table" describe-current-display-table
1638 :help "Describe the current display table"))
1639 (bindings--define-key menu [describe-package]
1640 '(menu-item "Describe Package..." describe-package
1641 :help "Display documentation of a Lisp package"))
1642 (bindings--define-key menu [describe-face]
1643 '(menu-item "Describe Face..." describe-face
1644 :help "Display the properties of a face"))
1645 (bindings--define-key menu [describe-variable]
1646 '(menu-item "Describe Variable..." describe-variable
1647 :help "Display documentation of variable/option"))
1648 (bindings--define-key menu [describe-function]
1649 '(menu-item "Describe Function..." describe-function
1650 :help "Display documentation of function/command"))
1651 (bindings--define-key menu [describe-key-1]
1652 '(menu-item "Describe Key or Mouse Operation..." describe-key
1653 ;; Users typically don't identify keys and menu items...
1654 :help "Display documentation of command bound to a \
1655 key, a click, or a menu-item"))
1656 (bindings--define-key menu [describe-mode]
1657 '(menu-item "Describe Buffer Modes" describe-mode
1658 :help "Describe this buffer's major and minor mode"))
1659 menu))
1661 (defun menu-bar-read-lispref ()
1662 "Display the Emacs Lisp Reference manual in Info mode."
1663 (interactive)
1664 (info "elisp"))
1666 (defun menu-bar-read-lispintro ()
1667 "Display the Introduction to Emacs Lisp Programming in Info mode."
1668 (interactive)
1669 (info "eintr"))
1671 (defun search-emacs-glossary ()
1672 "Display the Glossary node of the Emacs manual in Info mode."
1673 (interactive)
1674 (info "(emacs)Glossary"))
1676 (defun emacs-index-search (topic)
1677 "Look up TOPIC in the indices of the Emacs User Manual."
1678 (interactive "sSubject to look up: ")
1679 (info "emacs")
1680 (Info-index topic))
1682 (defun elisp-index-search (topic)
1683 "Look up TOPIC in the indices of the Emacs Lisp Reference Manual."
1684 (interactive "sSubject to look up: ")
1685 (info "elisp")
1686 (Info-index topic))
1688 (defvar menu-bar-search-documentation-menu
1689 (let ((menu (make-sparse-keymap "Search Documentation")))
1691 (bindings--define-key menu [search-documentation-strings]
1692 '(menu-item "Search Documentation Strings..." apropos-documentation
1693 :help
1694 "Find functions and variables whose doc strings match a regexp"))
1695 (bindings--define-key menu [find-any-object-by-name]
1696 '(menu-item "Find Any Object by Name..." apropos
1697 :help "Find symbols of any kind whose names match a regexp"))
1698 (bindings--define-key menu [find-option-by-value]
1699 '(menu-item "Find Options by Value..." apropos-value
1700 :help "Find variables whose values match a regexp"))
1701 (bindings--define-key menu [find-options-by-name]
1702 '(menu-item "Find Options by Name..." apropos-user-option
1703 :help "Find user options whose names match a regexp"))
1704 (bindings--define-key menu [find-commands-by-name]
1705 '(menu-item "Find Commands by Name..." apropos-command
1706 :help "Find commands whose names match a regexp"))
1707 (bindings--define-key menu [sep1]
1708 menu-bar-separator)
1709 (bindings--define-key menu [lookup-command-in-manual]
1710 '(menu-item "Look Up Command in User Manual..." Info-goto-emacs-command-node
1711 :help "Display manual section that describes a command"))
1712 (bindings--define-key menu [lookup-key-in-manual]
1713 '(menu-item "Look Up Key in User Manual..." Info-goto-emacs-key-command-node
1714 :help "Display manual section that describes a key"))
1715 (bindings--define-key menu [lookup-subject-in-elisp-manual]
1716 '(menu-item "Look Up Subject in ELisp Manual..." elisp-index-search
1717 :help "Find description of a subject in Emacs Lisp manual"))
1718 (bindings--define-key menu [lookup-subject-in-emacs-manual]
1719 '(menu-item "Look Up Subject in User Manual..." emacs-index-search
1720 :help "Find description of a subject in Emacs User manual"))
1721 (bindings--define-key menu [emacs-terminology]
1722 '(menu-item "Emacs Terminology" search-emacs-glossary
1723 :help "Display the Glossary section of the Emacs manual"))
1724 menu))
1726 (defvar menu-bar-manuals-menu
1727 (let ((menu (make-sparse-keymap "More Manuals")))
1729 (bindings--define-key menu [man]
1730 '(menu-item "Read Man Page..." manual-entry
1731 :help "Man-page docs for external commands and libraries"))
1732 (bindings--define-key menu [sep2]
1733 menu-bar-separator)
1734 (bindings--define-key menu [order-emacs-manuals]
1735 '(menu-item "Ordering Manuals" view-order-manuals
1736 :help "How to order manuals from the Free Software Foundation"))
1737 (bindings--define-key menu [lookup-subject-in-all-manuals]
1738 '(menu-item "Lookup Subject in all Manuals..." info-apropos
1739 :help "Find description of a subject in all installed manuals"))
1740 (bindings--define-key menu [other-manuals]
1741 '(menu-item "All Other Manuals (Info)" Info-directory
1742 :help "Read any of the installed manuals"))
1743 (bindings--define-key menu [emacs-lisp-reference]
1744 '(menu-item "Emacs Lisp Reference" menu-bar-read-lispref
1745 :help "Read the Emacs Lisp Reference manual"))
1746 (bindings--define-key menu [emacs-lisp-intro]
1747 '(menu-item "Introduction to Emacs Lisp" menu-bar-read-lispintro
1748 :help "Read the Introduction to Emacs Lisp Programming"))
1749 menu))
1751 (defun help-with-tutorial-spec-language ()
1752 "Use the Emacs tutorial, specifying which language you want."
1753 (interactive)
1754 (help-with-tutorial t))
1756 (defvar menu-bar-help-menu
1757 (let ((menu (make-sparse-keymap "Help")))
1758 (bindings--define-key menu [about-gnu-project]
1759 '(menu-item "About GNU" describe-gnu-project
1760 :help "About the GNU System, GNU Project, and GNU/Linux"))
1761 (bindings--define-key menu [about-emacs]
1762 '(menu-item "About Emacs" about-emacs
1763 :help "Display version number, copyright info, and basic help"))
1764 (bindings--define-key menu [sep4]
1765 menu-bar-separator)
1766 (bindings--define-key menu [describe-no-warranty]
1767 '(menu-item "(Non)Warranty" describe-no-warranty
1768 :help "Explain that Emacs has NO WARRANTY"))
1769 (bindings--define-key menu [describe-copying]
1770 '(menu-item "Copying Conditions" describe-copying
1771 :help "Show the Emacs license (GPL)"))
1772 (bindings--define-key menu [getting-new-versions]
1773 '(menu-item "Getting New Versions" describe-distribution
1774 :help "How to get the latest version of Emacs"))
1775 (bindings--define-key menu [sep2]
1776 menu-bar-separator)
1777 (bindings--define-key menu [external-packages]
1778 '(menu-item "Finding Extra Packages" view-external-packages
1779 :help "How to get more Lisp packages for use in Emacs"))
1780 (bindings--define-key menu [find-emacs-packages]
1781 '(menu-item "Search Built-in Packages" finder-by-keyword
1782 :help "Find built-in packages and features by keyword"))
1783 (bindings--define-key menu [more-manuals]
1784 `(menu-item "More Manuals" ,menu-bar-manuals-menu))
1785 (bindings--define-key menu [emacs-manual]
1786 '(menu-item "Read the Emacs Manual" info-emacs-manual
1787 :help "Full documentation of Emacs features"))
1788 (bindings--define-key menu [describe]
1789 `(menu-item "Describe" ,menu-bar-describe-menu))
1790 (bindings--define-key menu [search-documentation]
1791 `(menu-item "Search Documentation" ,menu-bar-search-documentation-menu))
1792 (bindings--define-key menu [sep1]
1793 menu-bar-separator)
1794 (bindings--define-key menu [emacs-psychotherapist]
1795 '(menu-item "Emacs Psychotherapist" doctor
1796 :help "Our doctor will help you feel better"))
1797 (bindings--define-key menu [send-emacs-bug-report]
1798 '(menu-item "Send Bug Report..." report-emacs-bug
1799 :help "Send e-mail to Emacs maintainers"))
1800 (bindings--define-key menu [emacs-manual-bug]
1801 '(menu-item "How to Report a Bug" info-emacs-bug
1802 :help "Read about how to report an Emacs bug"))
1803 (bindings--define-key menu [emacs-known-problems]
1804 '(menu-item "Emacs Known Problems" view-emacs-problems
1805 :help "Read about known problems with Emacs"))
1806 (bindings--define-key menu [emacs-news]
1807 '(menu-item "Emacs News" view-emacs-news
1808 :help "New features of this version"))
1809 (bindings--define-key menu [emacs-faq]
1810 '(menu-item "Emacs FAQ" view-emacs-FAQ
1811 :help "Frequently asked (and answered) questions about Emacs"))
1813 (bindings--define-key menu [emacs-tutorial-language-specific]
1814 '(menu-item "Emacs Tutorial (choose language)..."
1815 help-with-tutorial-spec-language
1816 :help "Learn how to use Emacs (choose a language)"))
1817 (bindings--define-key menu [emacs-tutorial]
1818 '(menu-item "Emacs Tutorial" help-with-tutorial
1819 :help "Learn how to use Emacs"))
1821 ;; In OS X it's in the app menu already.
1822 ;; FIXME? There already is an "About Emacs" (sans ...) entry in the Help menu.
1823 (and (featurep 'ns)
1824 (not (eq system-type 'darwin))
1825 (bindings--define-key menu [info-panel]
1826 '(menu-item "About Emacs..." ns-do-emacs-info-panel)))
1827 menu))
1829 (bindings--define-key global-map [menu-bar tools]
1830 (cons "Tools" menu-bar-tools-menu))
1831 (bindings--define-key global-map [menu-bar buffer]
1832 (cons "Buffers" global-buffers-menu-map))
1833 (bindings--define-key global-map [menu-bar options]
1834 (cons "Options" menu-bar-options-menu))
1835 (bindings--define-key global-map [menu-bar edit]
1836 (cons "Edit" menu-bar-edit-menu))
1837 (bindings--define-key global-map [menu-bar file]
1838 (cons "File" menu-bar-file-menu))
1839 (bindings--define-key global-map [menu-bar help-menu]
1840 (cons (purecopy "Help") menu-bar-help-menu))
1842 (defun menu-bar-menu-frame-live-and-visible-p ()
1843 "Return non-nil if the menu frame is alive and visible.
1844 The menu frame is the frame for which we are updating the menu."
1845 (let ((menu-frame (or menu-updating-frame (selected-frame))))
1846 (and (frame-live-p menu-frame)
1847 (frame-visible-p menu-frame))))
1849 (defun menu-bar-non-minibuffer-window-p ()
1850 "Return non-nil if the menu frame's selected window is no minibuffer window.
1851 Return nil if the menu frame is dead or its selected window is a
1852 minibuffer window. The menu frame is the frame for which we are
1853 updating the menu."
1854 (let ((menu-frame (or menu-updating-frame (selected-frame))))
1855 (and (frame-live-p menu-frame)
1856 (not (window-minibuffer-p
1857 (frame-selected-window menu-frame))))))
1859 (defun kill-this-buffer () ; for the menu bar
1860 "Kill the current buffer.
1861 When called in the minibuffer, get out of the minibuffer
1862 using `abort-recursive-edit'."
1863 (interactive)
1864 (cond
1865 ;; Don't do anything when `menu-frame' is not alive or visible
1866 ;; (Bug#8184).
1867 ((not (menu-bar-menu-frame-live-and-visible-p)))
1868 ((menu-bar-non-minibuffer-window-p)
1869 (kill-buffer (current-buffer)))
1871 (abort-recursive-edit))))
1873 (defun kill-this-buffer-enabled-p ()
1874 "Return non-nil if the `kill-this-buffer' menu item should be enabled."
1875 (or (not (menu-bar-non-minibuffer-window-p))
1876 (let (found-1)
1877 ;; Instead of looping over entire buffer list, stop once we've
1878 ;; found two "killable" buffers (Bug#8184).
1879 (catch 'found-2
1880 (dolist (buffer (buffer-list))
1881 (unless (string-match-p "^ " (buffer-name buffer))
1882 (if (not found-1)
1883 (setq found-1 t)
1884 (throw 'found-2 t))))))))
1886 (put 'dired 'menu-enable '(menu-bar-non-minibuffer-window-p))
1888 ;; Permit deleting frame if it would leave a visible or iconified frame.
1889 (defun delete-frame-enabled-p ()
1890 "Return non-nil if `delete-frame' should be enabled in the menu bar."
1891 (let ((frames (frame-list))
1892 (count 0))
1893 (while frames
1894 (if (frame-visible-p (car frames))
1895 (setq count (1+ count)))
1896 (setq frames (cdr frames)))
1897 (> count 1)))
1899 (defcustom yank-menu-length 20
1900 "Maximum length to display in the yank-menu."
1901 :type 'integer
1902 :group 'menu)
1904 (defun menu-bar-update-yank-menu (string old)
1905 (let ((front (car (cdr yank-menu)))
1906 (menu-string (if (<= (length string) yank-menu-length)
1907 string
1908 (concat
1909 (substring string 0 (/ yank-menu-length 2))
1910 "..."
1911 (substring string (- (/ yank-menu-length 2)))))))
1912 ;; Don't let the menu string be all dashes
1913 ;; because that has a special meaning in a menu.
1914 (if (string-match "\\`-+\\'" menu-string)
1915 (setq menu-string (concat menu-string " ")))
1916 ;; If we're supposed to be extending an existing string, and that
1917 ;; string really is at the front of the menu, then update it in place.
1918 (if (and old (or (eq old (car front))
1919 (string= old (car front))))
1920 (progn
1921 (setcar front string)
1922 (setcar (cdr front) menu-string))
1923 (setcdr yank-menu
1924 (cons
1925 (cons string (cons menu-string 'menu-bar-select-yank))
1926 (cdr yank-menu)))))
1927 (if (> (length (cdr yank-menu)) kill-ring-max)
1928 (setcdr (nthcdr kill-ring-max yank-menu) nil)))
1930 (put 'menu-bar-select-yank 'apropos-inhibit t)
1931 (defun menu-bar-select-yank ()
1932 "Insert the stretch of previously-killed text selected from menu.
1933 The menu shows all the killed text sequences stored in `kill-ring'."
1934 (interactive "*")
1935 (push-mark (point))
1936 (insert last-command-event))
1939 ;;; Buffers Menu
1941 (defcustom buffers-menu-max-size 10
1942 "Maximum number of entries which may appear on the Buffers menu.
1943 If this is 10, then only the ten most-recently-selected buffers are shown.
1944 If this is nil, then all buffers are shown.
1945 A large number or nil slows down menu responsiveness."
1946 :type '(choice integer
1947 (const :tag "All" nil))
1948 :group 'menu)
1950 (defcustom buffers-menu-buffer-name-length 30
1951 "Maximum length of the buffer name on the Buffers menu.
1952 If this is a number, then buffer names are truncated to this length.
1953 If this is nil, then buffer names are shown in full.
1954 A large number or nil makes the menu too wide."
1955 :type '(choice integer
1956 (const :tag "Full length" nil))
1957 :group 'menu)
1959 (defcustom buffers-menu-show-directories 'unless-uniquify
1960 "If non-nil, show directories in the Buffers menu for buffers that have them.
1961 The special value `unless-uniquify' means that directories will be shown
1962 unless `uniquify-buffer-name-style' is non-nil (in which case, buffer
1963 names should include enough of a buffer's directory to distinguish it
1964 from other buffers).
1966 Setting this variable directly does not take effect until next time the
1967 Buffers menu is regenerated."
1968 :set (lambda (symbol value)
1969 (set symbol value)
1970 (menu-bar-update-buffers t))
1971 :initialize 'custom-initialize-default
1972 :type '(choice (const :tag "Never" nil)
1973 (const :tag "Unless uniquify is enabled" unless-uniquify)
1974 (const :tag "Always" t))
1975 :group 'menu)
1977 (defcustom buffers-menu-show-status t
1978 "If non-nil, show modified/read-only status of buffers in the Buffers menu.
1979 Setting this variable directly does not take effect until next time the
1980 Buffers menu is regenerated."
1981 :set (lambda (symbol value)
1982 (set symbol value)
1983 (menu-bar-update-buffers t))
1984 :initialize 'custom-initialize-default
1985 :type 'boolean
1986 :group 'menu)
1988 (defvar list-buffers-directory nil
1989 "String to display in buffer listings for buffers not visiting a file.")
1990 (make-variable-buffer-local 'list-buffers-directory)
1992 (defun menu-bar-select-buffer ()
1993 (interactive)
1994 (switch-to-buffer last-command-event))
1996 (defun menu-bar-select-frame (frame)
1997 (make-frame-visible frame)
1998 (raise-frame frame)
1999 (select-frame frame))
2001 (defun menu-bar-update-buffers-1 (elt)
2002 (let* ((buf (car elt))
2003 (file
2004 (and (if (eq buffers-menu-show-directories 'unless-uniquify)
2005 (or (not (boundp 'uniquify-buffer-name-style))
2006 (null uniquify-buffer-name-style))
2007 buffers-menu-show-directories)
2008 (or (buffer-file-name buf)
2009 (buffer-local-value 'list-buffers-directory buf)))))
2010 (when file
2011 (setq file (file-name-directory file)))
2012 (when (and file (> (length file) 20))
2013 (setq file (concat "..." (substring file -17))))
2014 (cons (if buffers-menu-show-status
2015 (let ((mod (if (buffer-modified-p buf) "*" ""))
2016 (ro (if (buffer-local-value 'buffer-read-only buf) "%" "")))
2017 (if file
2018 (format "%s %s%s -- %s" (cdr elt) mod ro file)
2019 (format "%s %s%s" (cdr elt) mod ro)))
2020 (if file
2021 (format "%s -- %s" (cdr elt) file)
2022 (cdr elt)))
2023 buf)))
2025 ;; Used to cache the menu entries for commands in the Buffers menu
2026 (defvar menu-bar-buffers-menu-command-entries nil)
2028 (defvar menu-bar-select-buffer-function 'switch-to-buffer
2029 "Function to select the buffer chosen from the `Buffers' menu-bar menu.
2030 It must accept a buffer as its only required argument.")
2032 (defun menu-bar-buffer-vector (alist)
2033 ;; turn ((name . buffer) ...) into a menu
2034 (let ((buffers-vec (make-vector (length alist) nil))
2035 (i (length alist)))
2036 (dolist (pair alist)
2037 (setq i (1- i))
2038 (aset buffers-vec i
2039 (cons (car pair)
2040 `(lambda ()
2041 (interactive)
2042 (funcall menu-bar-select-buffer-function ,(cdr pair))))))
2043 buffers-vec))
2045 (defun menu-bar-update-buffers (&optional force)
2046 ;; If user discards the Buffers item, play along.
2047 (and (lookup-key (current-global-map) [menu-bar buffer])
2048 (or force (frame-or-buffer-changed-p))
2049 (let ((buffers (buffer-list))
2050 (frames (frame-list))
2051 buffers-menu)
2053 ;; Make the menu of buffers proper.
2054 (setq buffers-menu
2055 (let ((i 0)
2056 (limit (if (and (integerp buffers-menu-max-size)
2057 (> buffers-menu-max-size 1))
2058 buffers-menu-max-size most-positive-fixnum))
2059 alist)
2060 ;; Put into each element of buffer-list
2061 ;; the name for actual display,
2062 ;; perhaps truncated in the middle.
2063 (while buffers
2064 (let* ((buf (pop buffers))
2065 (name (buffer-name buf)))
2066 (unless (eq ?\s (aref name 0))
2067 (push (menu-bar-update-buffers-1
2068 (cons buf
2069 (if (and (integerp buffers-menu-buffer-name-length)
2070 (> (length name) buffers-menu-buffer-name-length))
2071 (concat
2072 (substring
2073 name 0 (/ buffers-menu-buffer-name-length 2))
2074 "..."
2075 (substring
2076 name (- (/ buffers-menu-buffer-name-length 2))))
2077 name)
2079 alist)
2080 ;; If requested, list only the N most recently
2081 ;; selected buffers.
2082 (when (= limit (setq i (1+ i)))
2083 (setq buffers nil)))))
2084 (list (menu-bar-buffer-vector alist))))
2086 ;; Make a Frames menu if we have more than one frame.
2087 (when (cdr frames)
2088 (let* ((frames-vec (make-vector (length frames) nil))
2089 (frames-menu
2090 (cons 'keymap
2091 (list "Select Frame" frames-vec)))
2092 (i 0))
2093 (dolist (frame frames)
2094 (aset frames-vec i
2095 (cons
2096 (frame-parameter frame 'name)
2097 `(lambda ()
2098 (interactive) (menu-bar-select-frame ,frame))))
2099 (setq i (1+ i)))
2100 ;; Put it after the normal buffers
2101 (setq buffers-menu
2102 (nconc buffers-menu
2103 `((frames-separator "--")
2104 (frames menu-item "Frames" ,frames-menu))))))
2106 ;; Add in some normal commands at the end of the menu. We use
2107 ;; the copy cached in `menu-bar-buffers-menu-command-entries'
2108 ;; if it's been set already. Note that we can't use constant
2109 ;; lists for the menu-entries, because the low-level menu-code
2110 ;; modifies them.
2111 (unless menu-bar-buffers-menu-command-entries
2112 (setq menu-bar-buffers-menu-command-entries
2113 (list '(command-separator "--")
2114 (list 'next-buffer
2115 'menu-item
2116 "Next Buffer"
2117 'next-buffer
2118 :help "Switch to the \"next\" buffer in a cyclic order")
2119 (list 'previous-buffer
2120 'menu-item
2121 "Previous Buffer"
2122 'previous-buffer
2123 :help "Switch to the \"previous\" buffer in a cyclic order")
2124 (list 'select-named-buffer
2125 'menu-item
2126 "Select Named Buffer..."
2127 'switch-to-buffer
2128 :help "Prompt for a buffer name, and select that buffer in the current window")
2129 (list 'list-all-buffers
2130 'menu-item
2131 "List All Buffers"
2132 'list-buffers
2133 :help "Pop up a window listing all Emacs buffers"
2134 ))))
2135 (setq buffers-menu
2136 (nconc buffers-menu menu-bar-buffers-menu-command-entries))
2138 ;; We used to "(define-key (current-global-map) [menu-bar buffer]"
2139 ;; but that did not do the right thing when the [menu-bar buffer]
2140 ;; entry above had been moved (e.g. to a parent keymap).
2141 (setcdr global-buffers-menu-map (cons "Buffers" buffers-menu)))))
2143 (add-hook 'menu-bar-update-hook 'menu-bar-update-buffers)
2145 (menu-bar-update-buffers)
2147 ;; this version is too slow
2148 ;;(defun format-buffers-menu-line (buffer)
2149 ;; "Returns a string to represent the given buffer in the Buffer menu.
2150 ;;nil means the buffer shouldn't be listed. You can redefine this."
2151 ;; (if (string-match "\\` " (buffer-name buffer))
2152 ;; nil
2153 ;; (with-current-buffer buffer
2154 ;; (let ((size (buffer-size)))
2155 ;; (format "%s%s %-19s %6s %-15s %s"
2156 ;; (if (buffer-modified-p) "*" " ")
2157 ;; (if buffer-read-only "%" " ")
2158 ;; (buffer-name)
2159 ;; size
2160 ;; mode-name
2161 ;; (or (buffer-file-name) ""))))))
2163 ;;; Set up a menu bar menu for the minibuffer.
2165 (dolist (map (list minibuffer-local-map
2166 ;; This shouldn't be necessary, but there's a funny
2167 ;; bug in keymap.c that I don't understand yet. -stef
2168 minibuffer-local-completion-map))
2169 (bindings--define-key map [menu-bar minibuf]
2170 (cons "Minibuf" (make-sparse-keymap "Minibuf"))))
2172 (let ((map minibuffer-local-completion-map))
2173 (bindings--define-key map [menu-bar minibuf ?\?]
2174 '(menu-item "List Completions" minibuffer-completion-help
2175 :help "Display all possible completions"))
2176 (bindings--define-key map [menu-bar minibuf space]
2177 '(menu-item "Complete Word" minibuffer-complete-word
2178 :help "Complete at most one word"))
2179 (bindings--define-key map [menu-bar minibuf tab]
2180 '(menu-item "Complete" minibuffer-complete
2181 :help "Complete as far as possible")))
2183 (let ((map minibuffer-local-map))
2184 (bindings--define-key map [menu-bar minibuf quit]
2185 '(menu-item "Quit" abort-recursive-edit
2186 :help "Abort input and exit minibuffer"))
2187 (bindings--define-key map [menu-bar minibuf return]
2188 '(menu-item "Enter" exit-minibuffer
2189 :key-sequence "\r"
2190 :help "Terminate input and exit minibuffer"))
2191 (bindings--define-key map [menu-bar minibuf isearch-forward]
2192 '(menu-item "Isearch History Forward" isearch-forward
2193 :help "Incrementally search minibuffer history forward"))
2194 (bindings--define-key map [menu-bar minibuf isearch-backward]
2195 '(menu-item "Isearch History Backward" isearch-backward
2196 :help "Incrementally search minibuffer history backward"))
2197 (bindings--define-key map [menu-bar minibuf next]
2198 '(menu-item "Next History Item" next-history-element
2199 :help "Put next minibuffer history element in the minibuffer"))
2200 (bindings--define-key map [menu-bar minibuf previous]
2201 '(menu-item "Previous History Item" previous-history-element
2202 :help "Put previous minibuffer history element in the minibuffer")))
2204 (define-minor-mode menu-bar-mode
2205 "Toggle display of a menu bar on each frame (Menu Bar mode).
2206 With a prefix argument ARG, enable Menu Bar mode if ARG is
2207 positive, and disable it otherwise. If called from Lisp, enable
2208 Menu Bar mode if ARG is omitted or nil.
2210 This command applies to all frames that exist and frames to be
2211 created in the future."
2212 :init-value t
2213 :global t
2214 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
2215 :variable menu-bar-mode
2217 ;; Turn the menu-bars on all frames on or off.
2218 (let ((val (if menu-bar-mode 1 0)))
2219 (dolist (frame (frame-list))
2220 (set-frame-parameter frame 'menu-bar-lines val))
2221 ;; If the user has given `default-frame-alist' a `menu-bar-lines'
2222 ;; parameter, replace it.
2223 (if (assq 'menu-bar-lines default-frame-alist)
2224 (setq default-frame-alist
2225 (cons (cons 'menu-bar-lines val)
2226 (assq-delete-all 'menu-bar-lines
2227 default-frame-alist)))))
2228 ;; Make the message appear when Emacs is idle. We can not call message
2229 ;; directly. The minor-mode message "Menu-bar mode disabled" comes
2230 ;; after this function returns, overwriting any message we do here.
2231 (when (and (called-interactively-p 'interactive) (not menu-bar-mode))
2232 (run-with-idle-timer 0 nil 'message
2233 "Menu-bar mode disabled. Use M-x menu-bar-mode to make the menu bar appear.")))
2235 ;;;###autoload
2236 ;; (This does not work right unless it comes after the above definition.)
2237 ;; This comment is taken from tool-bar.el near
2238 ;; (put 'tool-bar-mode ...)
2239 ;; We want to pretend the menu bar by standard is on, as this will make
2240 ;; customize consider disabling the menu bar a customization, and save
2241 ;; that. We could do this for real by setting :init-value above, but
2242 ;; that would overwrite disabling the menu bar from X resources.
2243 (put 'menu-bar-mode 'standard-value '(t))
2245 (defun toggle-menu-bar-mode-from-frame (&optional arg)
2246 "Toggle menu bar on or off, based on the status of the current frame.
2247 See `menu-bar-mode' for more information."
2248 (interactive (list (or current-prefix-arg 'toggle)))
2249 (if (eq arg 'toggle)
2250 (menu-bar-mode
2251 (if (menu-bar-positive-p
2252 (frame-parameter (menu-bar-frame-for-menubar) 'menu-bar-lines))
2253 0 1))
2254 (menu-bar-mode arg)))
2256 (declare-function x-menu-bar-open "term/x-win" (&optional frame))
2257 (declare-function w32-menu-bar-open "term/w32-win" (&optional frame))
2259 (defun lookup-key-ignore-too-long (map key)
2260 "Call `lookup-key' and convert numeric values to nil."
2261 (let ((binding (lookup-key map key)))
2262 (if (numberp binding) ; `too long'
2264 binding)))
2266 (defun popup-menu (menu &optional position prefix from-menu-bar)
2267 "Popup the given menu and call the selected option.
2268 MENU can be a keymap, an easymenu-style menu or a list of keymaps as for
2269 `x-popup-menu'.
2270 The menu is shown at the place where POSITION specifies.
2271 For the form of POSITION, see `popup-menu-normalize-position'.
2272 PREFIX is the prefix argument (if any) to pass to the command.
2273 FROM-MENU-BAR, if non-nil, means we are dropping one of menu-bar's menus."
2274 (let* ((map (cond
2275 ((keymapp menu) menu)
2276 ((and (listp menu) (keymapp (car menu))) menu)
2277 (t (let* ((map (easy-menu-create-menu (car menu) (cdr menu)))
2278 (filter (when (symbolp map)
2279 (plist-get (get map 'menu-prop) :filter))))
2280 (if filter (funcall filter (symbol-function map)) map)))))
2281 (frame (selected-frame))
2282 event cmd)
2283 (if from-menu-bar
2284 (let* ((xy (posn-x-y position))
2285 (menu-symbol (menu-bar-menu-at-x-y (car xy) (cdr xy))))
2286 (setq position (list menu-symbol (list frame '(menu-bar)
2287 xy 0))))
2288 (setq position (popup-menu-normalize-position position)))
2289 ;; The looping behavior was taken from lmenu's popup-menu-popup
2290 (while (and map (setq event
2291 ;; map could be a prefix key, in which case
2292 ;; we need to get its function cell
2293 ;; definition.
2294 (x-popup-menu position (indirect-function map))))
2295 ;; Strangely x-popup-menu returns a list.
2296 ;; mouse-major-mode-menu was using a weird:
2297 ;; (key-binding (apply 'vector (append '(menu-bar) menu-prefix events)))
2298 (setq cmd
2299 (cond
2300 ((and from-menu-bar
2301 (consp event)
2302 (numberp (car event))
2303 (numberp (cdr event)))
2304 (let ((x (car event))
2305 (y (cdr event))
2306 menu-symbol)
2307 (setq menu-symbol (menu-bar-menu-at-x-y x y))
2308 (setq position (list menu-symbol (list frame '(menu-bar)
2309 event 0)))
2310 (setq map
2311 (key-binding (vector 'menu-bar menu-symbol)))))
2312 ((and (not (keymapp map)) (listp map))
2313 ;; We were given a list of keymaps. Search them all
2314 ;; in sequence until a first binding is found.
2315 (let ((mouse-click (apply 'vector event))
2316 binding)
2317 (while (and map (null binding))
2318 (setq binding (lookup-key-ignore-too-long (car map) mouse-click))
2319 (setq map (cdr map)))
2320 binding))
2322 ;; We were given a single keymap.
2323 (lookup-key map (apply 'vector event)))))
2324 ;; Clear out echoing, which perhaps shows a prefix arg.
2325 (message "")
2326 ;; Maybe try again but with the submap.
2327 (setq map (if (keymapp cmd) cmd)))
2328 ;; If the user did not cancel by refusing to select,
2329 ;; and if the result is a command, run it.
2330 (when (and (null map) (commandp cmd))
2331 (setq prefix-arg prefix)
2332 ;; `setup-specified-language-environment', for instance,
2333 ;; expects this to be set from a menu keymap.
2334 (setq last-command-event (car (last event)))
2335 ;; mouse-major-mode-menu was using `command-execute' instead.
2336 (call-interactively cmd))))
2338 (defun popup-menu-normalize-position (position)
2339 "Convert the POSITION to the form which `popup-menu' expects internally.
2340 POSITION can be an event, a posn- value, a value having the
2341 form ((XOFFSET YOFFSET) WINDOW), or nil.
2342 If nil, the current mouse position is used, or nil if there is no mouse."
2343 (pcase position
2344 ;; nil -> mouse cursor position
2345 (`nil
2346 (let ((mp (mouse-pixel-position)))
2347 (list (list (cadr mp) (cddr mp)) (car mp))))
2348 ;; Value returned from `event-end' or `posn-at-point'.
2349 ((pred posnp)
2350 (let ((xy (posn-x-y position)))
2351 (list (list (car xy) (cdr xy))
2352 (posn-window position))))
2353 ;; Event.
2354 ((pred eventp)
2355 (popup-menu-normalize-position (event-end position)))
2356 (_ position)))
2358 (defcustom tty-menu-open-use-tmm nil
2359 "If non-nil, \\[menu-bar-open] on a TTY will invoke `tmm-menubar'.
2361 If nil, \\[menu-bar-open] will drop down the menu corresponding to the
2362 first (leftmost) menu-bar item; you can select other items by typing
2363 \\[forward-char], \\[backward-char], \\[right-char] and \\[left-char]."
2364 :type '(choice (const :tag "F10 drops down TTY menus" nil)
2365 (const :tag "F10 invokes tmm-menubar" t))
2366 :group 'display
2367 :version "24.4")
2369 (defvar tty-menu--initial-menu-x 1
2370 "X coordinate of the first menu-bar menu dropped by F10.
2372 This is meant to be used only for debugging TTY menus.")
2374 (defun menu-bar-open (&optional frame)
2375 "Start key navigation of the menu bar in FRAME.
2377 This function decides which method to use to access the menu
2378 depending on FRAME's terminal device. On X displays, it calls
2379 `x-menu-bar-open'; on Windows, `w32-menu-bar-open'; otherwise it
2380 calls either `popup-menu' or `tmm-menubar' depending on whether
2381 `tty-menu-open-use-tmm' is nil or not.
2383 If FRAME is nil or not given, use the selected frame."
2384 (interactive)
2385 (let ((type (framep (or frame (selected-frame)))))
2386 (cond
2387 ((eq type 'x) (x-menu-bar-open frame))
2388 ((eq type 'w32) (w32-menu-bar-open frame))
2389 ((and (null tty-menu-open-use-tmm)
2390 (not (zerop (or (frame-parameter nil 'menu-bar-lines) 0))))
2391 ;; Make sure the menu bar is up to date. One situation where
2392 ;; this is important is when this function is invoked by name
2393 ;; via M-x, in which case the menu bar includes the "Minibuf"
2394 ;; menu item that should be removed when we exit the minibuffer.
2395 (force-mode-line-update)
2396 (redisplay)
2397 (let* ((x tty-menu--initial-menu-x)
2398 (menu (menu-bar-menu-at-x-y x 0 frame)))
2399 (popup-menu (or
2400 (lookup-key-ignore-too-long
2401 global-map (vector 'menu-bar menu))
2402 (lookup-key-ignore-too-long
2403 (current-local-map) (vector 'menu-bar menu))
2404 (cdar (minor-mode-key-binding (vector 'menu-bar menu)))
2405 (mouse-menu-bar-map))
2406 (posn-at-x-y x 0 nil t) nil t)))
2407 (t (with-selected-frame (or frame (selected-frame))
2408 (tmm-menubar))))))
2410 (global-set-key [f10] 'menu-bar-open)
2412 (defun buffer-menu-open ()
2413 "Start key navigation of the buffer menu.
2414 This is the keyboard interface to \\[mouse-buffer-menu]."
2415 (interactive)
2416 (popup-menu (mouse-buffer-menu-keymap)
2417 (posn-at-x-y 0 0 nil t)))
2419 (global-set-key [C-f10] 'buffer-menu-open)
2421 (defun mouse-buffer-menu-keymap ()
2422 (let* ((menu (mouse-buffer-menu-map))
2423 (km (make-sparse-keymap (pop menu))))
2424 (dolist (item (nreverse menu))
2425 (let* ((name (pop item)))
2426 (define-key km (vector (intern name))
2427 (list name 'keymap name
2428 (menu-bar-buffer-vector item)))))
2429 km))
2431 (defvar tty-menu-navigation-map
2432 (let ((map (make-sparse-keymap)))
2433 ;; The next line is disabled because it breaks interpretation of
2434 ;; escape sequences, produced by TTY arrow keys, as tty-menu-*
2435 ;; commands. Instead, we explicitly bind some keys to
2436 ;; tty-menu-exit.
2437 ;;(define-key map [t] 'tty-menu-exit)
2439 ;; The tty-menu-* are just symbols interpreted by term.c, they are
2440 ;; not real commands.
2441 (dolist (bind '((keyboard-quit . tty-menu-exit)
2442 (keyboard-escape-quit . tty-menu-exit)
2443 ;; The following two will need to be revised if we ever
2444 ;; support a right-to-left menu bar.
2445 (forward-char . tty-menu-next-menu)
2446 (backward-char . tty-menu-prev-menu)
2447 (right-char . tty-menu-next-menu)
2448 (left-char . tty-menu-prev-menu)
2449 (next-line . tty-menu-next-item)
2450 (previous-line . tty-menu-prev-item)
2451 (newline . tty-menu-select)
2452 (newline-and-indent . tty-menu-select)
2453 (menu-bar-open . tty-menu-exit)))
2454 (substitute-key-definition (car bind) (cdr bind)
2455 map (current-global-map)))
2457 ;; The bindings of menu-bar items are so that clicking on the menu
2458 ;; bar when a menu is already shown pops down that menu.
2459 (define-key map [menu-bar t] 'tty-menu-exit)
2461 (define-key map [?\C-r] 'tty-menu-select)
2462 (define-key map [?\C-j] 'tty-menu-select)
2463 (define-key map [return] 'tty-menu-select)
2464 (define-key map [linefeed] 'tty-menu-select)
2465 (define-key map [mouse-1] 'tty-menu-select)
2466 (define-key map [drag-mouse-1] 'tty-menu-select)
2467 (define-key map [mouse-2] 'tty-menu-select)
2468 (define-key map [drag-mouse-2] 'tty-menu-select)
2469 (define-key map [mouse-3] 'tty-menu-select)
2470 (define-key map [drag-mouse-3] 'tty-menu-select)
2471 (define-key map [wheel-down] 'tty-menu-next-item)
2472 (define-key map [wheel-up] 'tty-menu-prev-item)
2473 (define-key map [wheel-left] 'tty-menu-prev-menu)
2474 (define-key map [wheel-right] 'tty-menu-next-menu)
2475 ;; The following 4 bindings are for those whose text-mode mouse
2476 ;; lack the wheel.
2477 (define-key map [S-mouse-1] 'tty-menu-next-item)
2478 (define-key map [S-drag-mouse-1] 'tty-menu-next-item)
2479 (define-key map [S-mouse-2] 'tty-menu-prev-item)
2480 (define-key map [S-drag-mouse-2] 'tty-menu-prev-item)
2481 (define-key map [S-mouse-3] 'tty-menu-prev-item)
2482 (define-key map [S-drag-mouse-3] 'tty-menu-prev-item)
2483 (define-key map [header-line mouse-1] 'tty-menu-select)
2484 (define-key map [header-line drag-mouse-1] 'tty-menu-select)
2485 ;; The down-mouse events must be bound to tty-menu-ignore, so that
2486 ;; only releasing the mouse button pops up the menu.
2487 (define-key map [mode-line down-mouse-1] 'tty-menu-ignore)
2488 (define-key map [mode-line down-mouse-2] 'tty-menu-ignore)
2489 (define-key map [mode-line down-mouse-3] 'tty-menu-ignore)
2490 (define-key map [mode-line C-down-mouse-1] 'tty-menu-ignore)
2491 (define-key map [mode-line C-down-mouse-2] 'tty-menu-ignore)
2492 (define-key map [mode-line C-down-mouse-3] 'tty-menu-ignore)
2493 (define-key map [down-mouse-1] 'tty-menu-ignore)
2494 (define-key map [C-down-mouse-1] 'tty-menu-ignore)
2495 (define-key map [C-down-mouse-2] 'tty-menu-ignore)
2496 (define-key map [C-down-mouse-3] 'tty-menu-ignore)
2497 (define-key map [mouse-movement] 'tty-menu-mouse-movement)
2498 map)
2499 "Keymap used while processing TTY menus.")
2501 (provide 'menu-bar)
2503 ;;; menu-bar.el ends here