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