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