1 ;;; menu-bar.el --- define a default menu bar
3 ;; Copyright (C) 1993,94,1995,2000,01,02,2003 Free Software Foundation, Inc.
7 ;; Keywords: internal, mouse
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
26 ;; Avishai Yacobi suggested some menu rearrangements.
34 (defcustom buffers-menu-max-size
10
35 "*Maximum number of entries which may appear on the Buffers menu.
36 If this is 10, then only the ten most-recently-selected buffers are shown.
37 If this is nil, then all buffers are shown.
38 A large number or nil slows down menu responsiveness."
39 :type
'(choice integer
40 (const :tag
"All" nil
))
43 ;; Don't clobber an existing menu-bar keymap, to preserve any menu-bar key
44 ;; definitions made in loaddefs.el.
45 (or (lookup-key global-map
[menu-bar
])
46 (define-key global-map
[menu-bar
] (make-sparse-keymap "menu-bar")))
47 (defvar menu-bar-help-menu
(make-sparse-keymap "Help"))
49 ;; Force Help item to come last, after the major mode's own items.
50 ;; The symbol used to be called `help', but that gets confused with the
52 (setq menu-bar-final-items
'(help-menu))
54 (define-key global-map
[menu-bar help-menu
] (cons "Help" menu-bar-help-menu
))
55 (defvar menu-bar-tools-menu
(make-sparse-keymap "Tools"))
56 (define-key global-map
[menu-bar tools
] (cons "Tools" menu-bar-tools-menu
))
57 ;; This definition is just to show what this looks like.
58 ;; It gets overridden below when menu-bar-update-buffers is called.
59 (define-key global-map
[menu-bar buffer
]
60 (cons "Buffers" (make-sparse-keymap "Buffers")))
61 (defvar menu-bar-options-menu
(make-sparse-keymap "Options"))
62 (define-key global-map
[menu-bar options
]
63 (cons "Options" menu-bar-options-menu
))
64 (defvar menu-bar-edit-menu
(make-sparse-keymap "Edit"))
65 (define-key global-map
[menu-bar edit
] (cons "Edit" menu-bar-edit-menu
))
66 (defvar menu-bar-file-menu
(make-sparse-keymap "File"))
67 (define-key global-map
[menu-bar file
] (cons "File" menu-bar-file-menu
))
69 ;; This alias is for compatibility with 19.28 and before.
70 (defvar menu-bar-files-menu menu-bar-file-menu
)
72 ;; This is referenced by some code below; it is defined in uniquify.el
73 (defvar uniquify-buffer-name-style
)
76 ;; The "File" menu items
77 (define-key menu-bar-file-menu
[exit-emacs
]
78 '(menu-item "Exit Emacs" save-buffers-kill-emacs
79 :help
"Save unsaved buffers, then exit"))
81 (define-key menu-bar-file-menu
[separator-exit
]
84 ;; Don't use delete-frame as event name because that is a special
86 (define-key menu-bar-file-menu
[delete-this-frame
]
87 '(menu-item "Delete Frame" delete-frame
88 :visible
(fboundp 'delete-frame
)
89 :enable
(delete-frame-enabled-p)
90 :help
"Delete currently selected frame"))
91 (define-key menu-bar-file-menu
[make-frame-on-display
]
92 '(menu-item "New Frame on Display..." make-frame-on-display
93 :visible
(fboundp 'make-frame-on-display
)
94 :help
"Open a new frame on another display"))
95 (define-key menu-bar-file-menu
[make-frame
]
96 '(menu-item "New Frame" make-frame-command
97 :visible
(fboundp 'make-frame-command
)
98 :help
"Open a new frame"))
100 (define-key menu-bar-file-menu
[one-window
]
101 '(menu-item "Unsplit Windows" delete-other-windows
102 :enable
(not (one-window-p t nil
))
103 :help
"Make selected window fill its frame"))
105 (define-key menu-bar-file-menu
[split-window
]
106 '(menu-item "Split Window" split-window-vertically
107 :help
"Split selected window in two"))
109 (define-key menu-bar-file-menu
[separator-window
]
112 (define-key menu-bar-file-menu
[ps-print-region
]
113 '(menu-item "Postscript Print Region (B+W)" ps-print-region
115 :help
"Pretty-print marked region in black and white to PostScript printer"))
116 (define-key menu-bar-file-menu
[ps-print-buffer
]
117 '(menu-item "Postscript Print Buffer (B+W)" ps-print-buffer
118 :help
"Pretty-print current buffer in black and white to PostScript printer"))
119 (define-key menu-bar-file-menu
[ps-print-region-faces
]
120 '(menu-item "Postscript Print Region" ps-print-region-with-faces
122 :help
"Pretty-print marked region to PostScript printer"))
123 (define-key menu-bar-file-menu
[ps-print-buffer-faces
]
124 '(menu-item "Postscript Print Buffer" ps-print-buffer-with-faces
125 :help
"Pretty-print current buffer to PostScript printer"))
126 (define-key menu-bar-file-menu
[print-region
]
127 '(menu-item "Print Region" print-region
129 :help
"Print region between mark and current position"))
130 (define-key menu-bar-file-menu
[print-buffer
]
131 '(menu-item "Print Buffer" print-buffer
132 :help
"Print current buffer with page headings"))
134 (define-key menu-bar-file-menu
[separator-print
]
137 (define-key menu-bar-file-menu
[recover-session
]
138 '(menu-item "Recover Crashed Session..." recover-session
139 :enable
(and auto-save-list-file-prefix
141 (file-name-directory auto-save-list-file-prefix
))
143 (file-name-directory auto-save-list-file-prefix
)
147 (file-name-nondirectory
148 auto-save-list-file-prefix
)))
150 :help
"Recover edits from a crashed session"))
151 (define-key menu-bar-file-menu
[revert-buffer
]
152 '(menu-item "Revert Buffer" revert-buffer
153 :enable
(or revert-buffer-function
154 revert-buffer-insert-file-contents-function
155 (and buffer-file-number
156 (or (buffer-modified-p)
157 (not (verify-visited-file-modtime
158 (current-buffer))))))
159 :help
"Re-read current buffer from its file"))
160 (define-key menu-bar-file-menu
[write-file
]
161 '(menu-item "Save Buffer As..." write-file
162 :enable
(not (window-minibuffer-p
163 (frame-selected-window menu-updating-frame
)))
164 :help
"Write current buffer to another file"))
165 (define-key menu-bar-file-menu
[save-buffer
]
166 '(menu-item "Save (current buffer)" save-buffer
167 :enable
(and (buffer-modified-p)
169 (not (window-minibuffer-p
170 (frame-selected-window menu-updating-frame
))))
171 :help
"Save current buffer to its file"))
173 (define-key menu-bar-file-menu
[separator-save
]
176 (define-key menu-bar-file-menu
[kill-buffer
]
177 '(menu-item "Close (current buffer)" kill-this-buffer
178 :enable
(kill-this-buffer-enabled-p)
179 :help
"Discard current buffer"))
180 (define-key menu-bar-file-menu
[insert-file
]
181 '(menu-item "Insert File..." insert-file
182 :enable
(not (window-minibuffer-p
183 (frame-selected-window menu-updating-frame
)))
184 :help
"Insert another file into current buffer"))
185 (define-key menu-bar-file-menu
[dired]
186 '(menu-item "Open Directory..." dired
187 :help "Read a directory, operate on its files"))
188 (define-key menu-bar-file-menu [open-file]
189 '(menu-item "Open File..." find-file-existing
190 :enable (not (window-minibuffer-p
191 (frame-selected-window menu-updating-frame)))
192 :help "Read an existing file into an Emacs buffer"))
193 (define-key menu-bar-file-menu [new-file]
194 '(menu-item "New File..." find-file
195 :enable (not (window-minibuffer-p
196 (frame-selected-window menu-updating-frame)))
197 :help "Read or create a file and edit it"))
200 ;; The "Edit" menu items
202 ;; The "Edit->Search" submenu
203 (defvar menu-bar-last-search-type nil
204 "Type of last non-incremental search command called from the menu.")
206 (defun nonincremental-repeat-search-forward ()
207 "Search forward for the previous search string or regexp."
210 ((and (eq menu-bar-last-search-type 'string)
212 (search-forward (car search-ring)))
213 ((and (eq menu-bar-last-search-type 'regexp)
215 (re-search-forward (car regexp-search-ring)))
217 (error "No previous search"))))
219 (defun nonincremental-repeat-search-backward ()
220 "Search backward for the previous search string or regexp."
223 ((and (eq menu-bar-last-search-type 'string)
225 (search-backward (car search-ring)))
226 ((and (eq menu-bar-last-search-type 'regexp)
228 (re-search-backward (car regexp-search-ring)))
230 (error "No previous search"))))
232 (defun nonincremental-search-forward (string)
233 "Read a string and search for it nonincrementally."
234 (interactive "sSearch for string: ")
235 (setq menu-bar-last-search-type 'string)
236 (if (equal string "")
237 (search-forward (car search-ring))
238 (isearch-update-ring string nil)
239 (search-forward string)))
241 (defun nonincremental-search-backward (string)
242 "Read a string and search backward for it nonincrementally."
243 (interactive "sSearch for string: ")
244 (setq menu-bar-last-search-type 'string)
245 (if (equal string "")
246 (search-backward (car search-ring))
247 (isearch-update-ring string nil)
248 (search-backward string)))
250 (defun nonincremental-re-search-forward (string)
251 "Read a regular expression and search for it nonincrementally."
252 (interactive "sSearch for regexp: ")
253 (setq menu-bar-last-search-type 'regexp)
254 (if (equal string "")
255 (re-search-forward (car regexp-search-ring))
256 (isearch-update-ring string t)
257 (re-search-forward string)))
259 (defun nonincremental-re-search-backward (string)
260 "Read a regular expression and search backward for it nonincrementally."
261 (interactive "sSearch for regexp: ")
262 (setq menu-bar-last-search-type 'regexp)
263 (if (equal string "")
264 (re-search-backward (car regexp-search-ring))
265 (isearch-update-ring string t)
266 (re-search-backward string)))
268 (defvar menu-bar-search-menu (make-sparse-keymap "Search"))
270 ;; The Edit->Search->Incremental Search menu
271 (defvar menu-bar-i-search-menu
272 (make-sparse-keymap "Incremental Search"))
274 (define-key menu-bar-i-search-menu [isearch-backward-regexp]
275 '(menu-item "Backward Regexp..." isearch-backward-regexp
276 :help "Search backwards for a regular expression as you type it"))
277 (define-key menu-bar-i-search-menu [isearch-forward-regexp]
278 '(menu-item "Forward Regexp..." isearch-forward-regexp
279 :help "Search forward for a regular expression as you type it"))
280 (define-key menu-bar-i-search-menu [isearch-backward]
281 '(menu-item "Backward String..." isearch-backward
282 :help "Search backwards for a string as you type it"))
283 (define-key menu-bar-i-search-menu [isearch-forward]
284 '(menu-item "Forward String..." isearch-forward
285 :help "Search forward for a string as you type it"))
288 (define-key menu-bar-search-menu [i-search]
289 (list 'menu-item "Incremental Search" menu-bar-i-search-menu
290 :help "Incremental Search finds partial matches while you type the search string.\nIt is most convenient from the keyboard. Try it!"))
291 (define-key menu-bar-search-menu [separator-tag-isearch]
294 (define-key menu-bar-search-menu [tags-continue]
295 '(menu-item "Continue Tags Search" tags-loop-continue
296 :help "Continue last tags search operation"))
297 (define-key menu-bar-search-menu [tags-srch]
298 '(menu-item "Search tagged files" tags-search
299 :help "Search for a regexp in all tagged files"))
300 (define-key menu-bar-search-menu [separator-tag-search]
303 (define-key menu-bar-search-menu [repeat-search-back]
304 '(menu-item "Repeat Backwards" nonincremental-repeat-search-backward
305 :enable (or (and (eq menu-bar-last-search-type 'string)
307 (and (eq menu-bar-last-search-type 'regexp)
309 :help "Repeat last search backwards"))
310 (define-key menu-bar-search-menu [repeat-search-fwd]
311 '(menu-item "Repeat Forward" nonincremental-repeat-search-forward
312 :enable (or (and (eq menu-bar-last-search-type 'string)
314 (and (eq menu-bar-last-search-type 'regexp)
316 :help "Repeat last search forward"))
317 (define-key menu-bar-search-menu [separator-repeat-search]
320 (define-key menu-bar-search-menu [re-search-backward]
321 '(menu-item "Regexp Backwards..." nonincremental-re-search-backward
322 :help "Search backwards for a regular expression"))
323 (define-key menu-bar-search-menu [re-search-forward]
324 '(menu-item "Regexp Forward..." nonincremental-re-search-forward
325 :help "Search forward for a regular expression"))
327 (define-key menu-bar-search-menu [search-backward]
328 '(menu-item "String Backwards..." nonincremental-search-backward
329 :help "Search backwards for a string"))
330 (define-key menu-bar-search-menu [search-forward]
331 '(menu-item "String Forward..." nonincremental-search-forward
332 :help "Search forward for a string"))
334 ;; The Edit->Replace submenu
336 (defvar menu-bar-replace-menu (make-sparse-keymap "Replace"))
338 (define-key menu-bar-replace-menu [tags-repl-continue]
339 '(menu-item "Continue Replace" tags-loop-continue
340 :help "Continue last tags replace operation"))
341 (define-key menu-bar-replace-menu [tags-repl]
342 '(menu-item "Replace in tagged files" tags-query-replace
343 :help "Interactively replace a regexp in all tagged files"))
344 (define-key menu-bar-replace-menu [separator-replace-tags]
347 (define-key menu-bar-replace-menu [query-replace-regexp]
348 '(menu-item "Replace Regexp..." query-replace-regexp
349 :enable (not buffer-read-only)
350 :help "Replace regular expression interactively, ask about each occurrence"))
351 (define-key menu-bar-replace-menu [query-replace]
352 '(menu-item "Replace String..." query-replace
353 :enable (not buffer-read-only)
354 :help "Replace string interactively, ask about each occurrence"))
356 ;;; Assemble the top-level Edit menu items.
357 (define-key menu-bar-edit-menu [props]
358 '(menu-item "Text Properties" facemenu-menu
359 :help "Change properties of text in region"))
361 (define-key menu-bar-edit-menu [fill]
362 '(menu-item "Fill" fill-region
363 :enable (and mark-active (not buffer-read-only))
365 "Fill text in region to fit between left and right margin"))
367 (define-key menu-bar-edit-menu [separator-bookmark]
370 (define-key menu-bar-edit-menu [bookmark]
371 '(menu-item "Bookmarks" menu-bar-bookmark-map
372 :help "Record positions and jump between them"))
374 (defvar menu-bar-goto-menu (make-sparse-keymap "Go To"))
376 (define-key menu-bar-goto-menu [set-tags-name]
377 '(menu-item "Set Tags File Name" visit-tags-table
378 :help "Tell Tags commands which tag table file to use"))
380 (define-key menu-bar-goto-menu [separator-tag-file]
383 (define-key menu-bar-goto-menu [apropos-tags]
384 '(menu-item "Tags Apropos" tags-apropos
385 :help "Find function/variables whose names match regexp"))
386 (define-key menu-bar-goto-menu [next-tag-otherw]
387 '(menu-item "Next Tag in Other Window"
388 menu-bar-next-tag-other-window
389 :enable (and (boundp 'tags-location-ring)
390 (not (ring-empty-p tags-location-ring)))
391 :help "Find next function/variable matching last tag name in another window"))
393 (defun menu-bar-next-tag-other-window ()
394 "Find the next definition of the tag already specified."
396 (find-tag-other-window nil t))
398 (defun menu-bar-next-tag ()
399 "Find the next definition of the tag already specified."
403 (define-key menu-bar-goto-menu [next-tag]
404 '(menu-item "Find Next Tag"
406 :enable (and (boundp 'tags-location-ring)
407 (not (ring-empty-p tags-location-ring)))
408 :help "Find next function/variable matching last tag name"))
409 (define-key menu-bar-goto-menu [find-tag-otherw]
410 '(menu-item "Find Tag in Other Window..." find-tag-other-window
411 :help "Find function/variable definition in another window"))
412 (define-key menu-bar-goto-menu [find-tag]
413 '(menu-item "Find Tag..." find-tag
414 :help "Find definition of function or variable"))
416 (define-key menu-bar-goto-menu [separator-tags]
419 (define-key menu-bar-goto-menu [end-of-buf]
420 '(menu-item "Goto End of Buffer" end-of-buffer))
421 (define-key menu-bar-goto-menu [beg-of-buf]
422 '(menu-item "Goto Beginning of Buffer" beginning-of-buffer))
423 (define-key menu-bar-goto-menu [go-to-pos]
424 '(menu-item "Goto Buffer Position..." goto-char
425 :help "Read a number N and go to buffer position N"))
426 (define-key menu-bar-goto-menu [go-to-line]
427 '(menu-item "Goto Line..." goto-line
428 :help "Read a line number and go to that line"))
430 (define-key menu-bar-edit-menu [goto]
431 (list 'menu-item "Go To" menu-bar-goto-menu))
433 (define-key menu-bar-edit-menu [replace]
434 (list 'menu-item "Replace" menu-bar-replace-menu))
436 (define-key menu-bar-edit-menu [search]
437 (list 'menu-item "Search" menu-bar-search-menu))
439 (define-key menu-bar-edit-menu [separator-search]
442 (define-key menu-bar-edit-menu [mark-whole-buffer]
443 '(menu-item "Select All" mark-whole-buffer
444 :help "Mark the whole buffer for a subsequent cut/copy."))
445 (define-key menu-bar-edit-menu [clear]
446 '(menu-item "Clear" delete-region
447 :enable (and mark-active
448 (not buffer-read-only)
449 (not (mouse-region-match)))
451 "Delete the text in region between mark and current position"))
452 (defvar yank-menu (cons "Select Yank" nil))
453 (fset 'yank-menu (cons 'keymap yank-menu))
454 (define-key menu-bar-edit-menu [select-paste]
455 '(menu-item "Select and Paste" yank-menu
456 :enable (and (cdr yank-menu) (not buffer-read-only))
457 :help "Paste (yank) text cut or copied earlier"))
458 (define-key menu-bar-edit-menu [paste]
459 '(menu-item "Paste" yank
461 ;; Emacs compiled --without-x doesn't have
462 ;; x-selection-exists-p.
463 (fboundp 'x-selection-exists-p)
464 (x-selection-exists-p) (not buffer-read-only))
465 :help "Paste (yank) text most recently cut/copied"))
466 (define-key menu-bar-edit-menu [copy]
467 '(menu-item "Copy" menu-bar-kill-ring-save
469 :help "Copy text in region between mark and current position"
470 :keys "\\[kill-ring-save]"))
471 (define-key menu-bar-edit-menu [cut]
472 '(menu-item "Cut" kill-region
473 :enable (and mark-active (not buffer-read-only))
475 "Cut (kill) text in region between mark and current position"))
476 (define-key menu-bar-edit-menu [undo]
477 '(menu-item "Undo" undo
478 :enable (and (not buffer-read-only)
479 (not (eq t buffer-undo-list))
480 (if (eq last-command 'undo)
482 (consp buffer-undo-list)))
483 :help "Undo last operation"))
486 (defun menu-bar-kill-ring-save (beg end)
488 (if (mouse-region-match)
489 (message "Selecting a region with the mouse does `copy' automatically")
490 (kill-ring-save beg end)))
492 ;; These are alternative definitions for the cut, paste and copy
493 ;; menu items. Use them if your system expects these to use the clipboard.
495 (put 'clipboard-kill-region 'menu-enable 'mark-active)
496 (put 'clipboard-kill-ring-save 'menu-enable 'mark-active)
497 (put 'clipboard-yank 'menu-enable
498 '(or (and (fboundp 'x-selection-exists-p) (x-selection-exists-p))
499 (x-selection-exists-p 'CLIPBOARD)))
501 (defun clipboard-yank ()
502 "Insert the clipboard contents, or the last stretch of killed text."
504 (let ((x-select-enable-clipboard t))
507 (defun clipboard-kill-ring-save (beg end)
508 "Copy region to kill ring, and save in the X clipboard."
510 (let ((x-select-enable-clipboard t))
511 (kill-ring-save beg end)))
513 (defun clipboard-kill-region (beg end)
514 "Kill the region, and save it in the X clipboard."
516 (let ((x-select-enable-clipboard t))
517 (kill-region beg end)))
519 (defun menu-bar-enable-clipboard ()
520 "Make CUT, PASTE and COPY (keys and menu bar items) use the clipboard.
521 Do the same for the keys of the same name."
523 ;; We can't use constant list structure here because it becomes pure,
524 ;; and because it gets modified with cache data.
525 (define-key menu-bar-edit-menu [paste]
526 (cons "Paste" (cons "Paste text from clipboard" 'clipboard-yank)))
527 (define-key menu-bar-edit-menu [copy]
528 (cons "Copy" (cons "Copy text in region to the clipboard"
529 'clipboard-kill-ring-save)))
530 (define-key menu-bar-edit-menu [cut]
531 (cons "Cut" (cons "Delete text in region and copy it to the clipboard"
532 'clipboard-kill-region)))
534 ;; These are Sun server keysyms for the Cut, Copy and Paste keys
535 ;; (also for XFree86 on Sun keyboard):
536 (define-key global-map [f20] 'clipboard-kill-region)
537 (define-key global-map [f16] 'clipboard-kill-ring-save)
538 (define-key global-map [f18] 'clipboard-yank)
540 (define-key global-map [cut] 'clipboard-kill-region)
541 (define-key global-map [copy] 'clipboard-kill-ring-save)
542 (define-key global-map [paste] 'clipboard-yank))
544 ;; The "Options" menu items
546 (defvar menu-bar-custom-menu (make-sparse-keymap "Customize"))
548 (define-key menu-bar-custom-menu [customize-apropos-groups]
549 '(menu-item "Groups Matching Regexp..." customize-apropos-groups
550 :help "Browse groups whose names match regexp"))
551 (define-key menu-bar-custom-menu [customize-apropos-faces]
552 '(menu-item "Faces Matching Regexp..." customize-apropos-faces
553 :help "Browse faces whose names match regexp"))
554 (define-key menu-bar-custom-menu [customize-apropos-options]
555 '(menu-item "Options Matching Regexp..." customize-apropos-options
556 :help "Browse options whose names match regexp"))
557 (define-key menu-bar-custom-menu [customize-apropos]
558 '(menu-item "Settings Matching Regexp..." customize-apropos
559 :help "Browse customizable settings whose names match regexp"))
560 (define-key menu-bar-custom-menu [separator-1]
562 (define-key menu-bar-custom-menu [customize-group]
563 '(menu-item "Specific Group..." customize-group
564 :help "Customize settings of specific group"))
565 (define-key menu-bar-custom-menu [customize-face]
566 '(menu-item "Specific Face..." customize-face
567 :help "Customize attributes of specific face"))
568 (define-key menu-bar-custom-menu [customize-option]
569 '(menu-item "Specific Option..." customize-option
570 :help "Customize value of specific option"))
571 (define-key menu-bar-custom-menu [separator-2]
573 (define-key menu-bar-custom-menu [customize-changed-options]
574 '(menu-item "New Options..." customize-changed-options
575 :help "Options added or changed in recent Emacs versions"))
576 (define-key menu-bar-custom-menu [customize-saved]
577 '(menu-item "Saved Options" customize-saved
578 :help "Customize previously saved options"))
579 (define-key menu-bar-custom-menu [separator-3]
581 (define-key menu-bar-custom-menu [customize-browse]
582 '(menu-item "Browse Customization Groups" customize-browse
583 :help "Browse all customization groups"))
584 (define-key menu-bar-custom-menu [customize]
585 '(menu-item "Top-level Customization Group" customize
586 :help "The master group called `Emacs'"))
588 ;(defvar menu-bar-preferences-menu (make-sparse-keymap "Preferences"))
590 (defmacro menu-bar-make-mm-toggle (fname doc help &optional props)
591 "Make a menu-item for a global minor mode toggle.
592 FNAME is the minor mode's name (variable and function).
593 DOC is the text to use the menu entry.
594 HELP is the text to use for the tooltip.
595 PROPS are additional properties."
596 `'(menu-item ,doc ,fname
599 :button (:toggle . (and (default-boundp ',fname)
600 (default-value ',fname)))))
602 (defmacro menu-bar-make-toggle (name variable doc message help &rest body)
604 (defun ,name (&optional interactively)
605 ,(concat "Toggle whether to " (downcase (substring help 0 1))
606 (substring help 1) ".\
607 In an interactive call, record this option as a candidate for saving
608 by \"Save Options\" in Custom buffers.")
610 (if ,(if body `(progn . ,body)
612 (custom-load-symbol ',variable)
613 (let ((set (or (get ',variable 'custom-set) 'set-default))
614 (get (or (get ',variable 'custom-get) 'default-value)))
615 (funcall set ',variable (not (funcall get ',variable))))))
616 (message ,message "enabled")
617 (message ,message "disabled"))
618 ;; The function `customize-mark-as-set' must only be called when
619 ;; a variable is set interactively, as the purpose is to mark it as
620 ;; a candidate for "Save Options", and we do not want to save options
621 ;; the user have already set explicitly in his init file.
622 (if interactively (customize-mark-as-set ',variable)))
623 '(menu-item ,doc ,name
625 :button (:toggle . (and (default-boundp ',variable)
626 (default-value ',variable))))))
628 ;;; Assemble all the top-level items of the "Options" menu
629 (define-key menu-bar-options-menu [customize]
630 (list 'menu-item "Customize Emacs" menu-bar-custom-menu
631 :help "Full customization of every Emacs feature"))
633 (defun menu-bar-options-save ()
634 "Save current values of Options menu items using Custom."
636 (let ((need-save nil))
637 ;; These are set with menu-bar-make-mm-toggle, which does not
638 ;; put on a customized-value property.
639 (dolist (elt '(line-number-mode column-number-mode cua-mode show-paren-mode
640 transient-mark-mode global-font-lock-mode))
641 (and (customize-mark-to-save elt)
643 ;; These are set with `customize-set-variable'.
644 (dolist (elt '(scroll-bar-mode
645 debug-on-quit debug-on-error menu-bar-mode tool-bar-mode
646 save-place uniquify-buffer-name-style fringe-mode
647 fringe-indicators case-fold-search
648 display-time-mode auto-compression-mode
649 current-language-environment default-input-method
650 ;; Saving `text-mode-hook' is somewhat questionable,
651 ;; as we might get more than we bargain for, if
652 ;; other code may has added hooks as well.
653 ;; Nonetheless, not saving it would like be confuse
655 ;; -- Per Abrahamsen <abraham@dina.kvl.dk> 2002-02-11.
657 (and (get elt 'customized-value)
658 (customize-mark-to-save elt)
660 ;; Save if we changed anything.
664 (define-key menu-bar-options-menu [save]
665 '(menu-item "Save Options" menu-bar-options-save
666 :help "Save options set from the menu above"))
668 (define-key menu-bar-options-menu [custom-separator]
671 (define-key menu-bar-options-menu [mouse-set-font]
672 '(menu-item "Set Font/Fontset" mouse-set-font
673 :visible (display-multi-font-p)
674 :help "Select a font from list of known fonts/fontsets"))
676 ;; The "Show/Hide" submenu of menu "Options"
678 (defvar menu-bar-showhide-menu (make-sparse-keymap "Show/Hide"))
680 (define-key menu-bar-showhide-menu [column-number-mode]
681 (menu-bar-make-mm-toggle column-number-mode
683 "Show the current column number in the mode line"))
685 (define-key menu-bar-showhide-menu [line-number-mode]
686 (menu-bar-make-mm-toggle line-number-mode
688 "Show the current line number in the mode line"))
690 (define-key menu-bar-showhide-menu [linecolumn-separator]
693 (defun showhide-date-time ()
694 "Toggle whether to show date and time in the mode-line."
696 (if (display-time-mode)
697 (message "Display-time mode enabled.")
698 (message "Display-time mode disabled."))
699 (customize-mark-as-set 'display-time-mode))
701 (define-key menu-bar-showhide-menu [showhide-date-time]
702 '(menu-item "Date, Time and Mail" showhide-date-time
703 :help "Display date, time, mail status in mode line"
704 :button (:toggle . display-time-mode)))
706 (define-key menu-bar-showhide-menu [datetime-separator]
709 (define-key menu-bar-showhide-menu [showhide-speedbar]
710 '(menu-item "Speedbar" speedbar-frame-mode
711 :help "Display a Speedbar quick-navigation frame"
713 . (and (boundp 'speedbar-frame)
714 (frame-live-p (symbol-value 'speedbar-frame))
716 (symbol-value 'speedbar-frame))))))
719 (defvar menu-bar-showhide-fringe-ind-menu (make-sparse-keymap "Indicators"))
721 ;; The real definition is in fringe.el.
722 ;; This is to prevent errors in the :radio conditions below.
723 (setq fringe-indicators nil)
725 (defun menu-bar-showhide-fringe-ind-empty ()
726 "Display empty line indicators in the left or right fringe."
729 (customize-set-variable 'fringe-indicators 'empty))
731 (define-key menu-bar-showhide-fringe-ind-menu [empty]
732 '(menu-item "Empty lines only" menu-bar-showhide-fringe-ind-empty
733 :help "Show empty line indicators in fringe"
734 :visible (display-graphic-p)
735 :button (:radio . (eq fringe-indicators 'empty))))
737 (defun menu-bar-showhide-fringe-ind-mixed ()
738 "Display top and bottom indicators in opposite fringes, arrow in right."
741 (customize-set-variable 'fringe-indicators 'mixed))
743 (define-key menu-bar-showhide-fringe-ind-menu [mixed]
744 '(menu-item "Opposite, arrows right" menu-bar-showhide-fringe-ind-mixed
745 :help "Show top/bottom indicators in opposite fringes, arrows in right"
746 :visible (display-graphic-p)
747 :button (:radio . (eq fringe-indicators 'mixed))))
749 (defun menu-bar-showhide-fringe-ind-box ()
750 "Display top and bottom indicators in opposite fringes."
753 (customize-set-variable 'fringe-indicators 'box))
755 (define-key menu-bar-showhide-fringe-ind-menu [box]
756 '(menu-item "Opposite, no arrows" menu-bar-showhide-fringe-ind-box
757 :help "Show top/bottom indicators in opposite fringes, no arrows"
758 :visible (display-graphic-p)
759 :button (:radio . (eq fringe-indicators 'box))))
761 (defun menu-bar-showhide-fringe-ind-right ()
762 "Display fringe indicators in the right fringe."
765 (customize-set-variable 'fringe-indicators 'right))
767 (define-key menu-bar-showhide-fringe-ind-menu [right]
768 '(menu-item "In right fringe" menu-bar-showhide-fringe-ind-right
769 :help "Show indicators in right fringe"
770 :visible (display-graphic-p)
771 :button (:radio . (eq fringe-indicators 'right))))
773 (defun menu-bar-showhide-fringe-ind-left ()
774 "Display fringe indicators in the left fringe."
777 (customize-set-variable 'fringe-indicators 'left))
779 (define-key menu-bar-showhide-fringe-ind-menu [left]
780 '(menu-item "In left fringe" menu-bar-showhide-fringe-ind-left
781 :help "Show indicators in left fringe"
782 :visible (display-graphic-p)
783 :button (:radio . (eq fringe-indicators 'left))))
785 (defun menu-bar-showhide-fringe-ind-none ()
786 "Do not display any fringe indicators."
789 (customize-set-variable 'fringe-indicators nil))
791 (define-key menu-bar-showhide-fringe-ind-menu [none]
792 '(menu-item "No indicators" menu-bar-showhide-fringe-ind-none
793 :help "Hide all fringe indicators"
794 :visible (display-graphic-p)
795 :button (:radio . (eq fringe-indicators nil))))
799 (defvar menu-bar-showhide-fringe-menu (make-sparse-keymap "Fringe"))
801 (defun menu-bar-showhide-fringe-menu-customize ()
802 "Show customization buffer for `fringe-mode'."
804 (customize-variable 'fringe-mode))
806 (define-key menu-bar-showhide-fringe-menu [customize]
807 '(menu-item "Customize" menu-bar-showhide-fringe-menu-customize
808 :help "Detailed customization of fringe"
809 :visible (display-graphic-p)))
811 (defun menu-bar-showhide-fringe-menu-customize-reset ()
812 "Reset the fringe mode: display fringes on both sides of a window."
814 (customize-set-variable 'fringe-mode nil))
816 (define-key menu-bar-showhide-fringe-menu [showhide-fringe-ind]
817 (list 'menu-item "Indicators" menu-bar-showhide-fringe-ind-menu
818 :visible `(display-graphic-p)
819 :help "Select fringe mode"))
821 ;; The real definition is in fringe.el.
822 ;; This is to prevent errors in the :radio conditions below.
823 (setq fringe-mode nil)
825 (define-key menu-bar-showhide-fringe-menu [default]
826 '(menu-item "Default" menu-bar-showhide-fringe-menu-customize-reset
827 :help "Default width fringe on both left and right side"
828 :visible (display-graphic-p)
829 :button (:radio . (eq fringe-mode nil))))
831 (defun menu-bar-showhide-fringe-menu-customize-left ()
832 "Display fringes only on the left of each window."
835 (customize-set-variable 'fringe-mode '(nil . 0)))
837 (define-key menu-bar-showhide-fringe-menu [left]
838 '(menu-item "On the Left" menu-bar-showhide-fringe-menu-customize-left
839 :help "Fringe only on the left side"
840 :visible (display-graphic-p)
841 :button (:radio . (equal fringe-mode '(nil . 0)))))
843 (defun menu-bar-showhide-fringe-menu-customize-right ()
844 "Display fringes only on the right of each window."
847 (customize-set-variable 'fringe-mode '(0 . nil)))
849 (define-key menu-bar-showhide-fringe-menu [right]
850 '(menu-item "On the Right" menu-bar-showhide-fringe-menu-customize-right
851 :help "Fringe only on the right side"
852 :visible (display-graphic-p)
853 :button (:radio . (equal fringe-mode '(0 . nil)))))
855 (defun menu-bar-showhide-fringe-menu-customize-disable ()
856 "Do not display window fringes."
859 (customize-set-variable 'fringe-mode 0))
861 (define-key menu-bar-showhide-fringe-menu [none]
862 '(menu-item "None" menu-bar-showhide-fringe-menu-customize-disable
863 :help "Turn off fringe"
864 :visible (display-graphic-p)
865 :button (:radio . (eq fringe-mode 0))))
867 (define-key menu-bar-showhide-menu [showhide-fringe]
868 (list 'menu-item "Fringe" menu-bar-showhide-fringe-menu
869 :visible `(display-graphic-p)
870 :help "Select fringe mode"))
872 (defvar menu-bar-showhide-scroll-bar-menu (make-sparse-keymap "Scroll-bar"))
874 (define-key menu-bar-showhide-scroll-bar-menu [right]
875 '(menu-item "On the Right"
876 menu-bar-right-scroll-bar
877 :help "Scroll-bar on the right side"
878 :visible (display-graphic-p)
879 :button (:radio . (eq (cdr (assq 'vertical-scroll-bars
880 (frame-parameters))) 'right))))
881 (defun menu-bar-right-scroll-bar ()
882 "Display scroll bars on the right of each window."
884 (customize-set-variable 'scroll-bar-mode 'right))
886 (define-key menu-bar-showhide-scroll-bar-menu [left]
887 '(menu-item "On the Left"
888 menu-bar-left-scroll-bar
889 :help "Scroll-bar on the left side"
890 :visible (display-graphic-p)
891 :button (:radio . (eq (cdr (assq 'vertical-scroll-bars
892 (frame-parameters))) 'left))))
894 (defun menu-bar-left-scroll-bar ()
895 "Display scroll bars on the left of each window."
897 (customize-set-variable 'scroll-bar-mode 'left))
899 (define-key menu-bar-showhide-scroll-bar-menu [none]
901 menu-bar-no-scroll-bar
902 :help "Turn off scroll-bar"
903 :visible (display-graphic-p)
904 :button (:radio . (eq (cdr (assq 'vertical-scroll-bars
905 (frame-parameters))) nil))))
907 (defun menu-bar-no-scroll-bar ()
908 "Turn off scroll bars."
910 (customize-set-variable 'scroll-bar-mode nil))
912 (define-key menu-bar-showhide-menu [showhide-scroll-bar]
913 (list 'menu-item "Scroll-bar" menu-bar-showhide-scroll-bar-menu
914 :visible `(display-graphic-p)
915 :help "Select scroll-bar mode"))
917 (define-key menu-bar-showhide-menu [menu-bar-mode]
918 '(menu-item "Menu-bar" menu-bar-mode
919 :help "Toggle menu-bar on/off"
920 :button (:toggle . menu-bar-mode)))
922 (define-key menu-bar-showhide-menu [showhide-tool-bar]
923 (list 'menu-item "Tool-bar" 'tool-bar-mode
924 :help "Turn tool-bar on/off"
925 :visible `(display-graphic-p)
926 :button `(:toggle . tool-bar-mode)))
928 (define-key menu-bar-options-menu [showhide]
929 (list 'menu-item "Show/Hide" menu-bar-showhide-menu
930 :help "Toggle on/off various display features"))
932 (define-key menu-bar-options-menu [showhide-separator]
935 (define-key menu-bar-options-menu [mule]
936 ;; It is better not to use backquote here,
937 ;; because that makes a bootstrapping problem
938 ;; if you need to recompile all the Lisp files using interpreted code.
939 (list 'menu-item "Mule (Multilingual Environment)" mule-menu-keymap
940 ;; Most of the MULE menu actually does make sense in unibyte mode,
941 ;; e.g. language selection.
942 ;;; ':visible 'default-enable-multibyte-characters
943 ':help "Default language, encodings, input method"))
944 ;(setq menu-bar-final-items (cons 'mule menu-bar-final-items))
945 ;(define-key menu-bar-options-menu [preferences]
946 ; (list 'menu-item "Preferences" menu-bar-preferences-menu
947 ; :help "Toggle important global options"))
949 (define-key menu-bar-options-menu [mule-separator]
952 (define-key menu-bar-options-menu [debug-on-quit]
953 (menu-bar-make-toggle toggle-debug-on-quit debug-on-quit
954 "Enter Debugger on Quit/C-g" "Debug on Quit %s"
955 "Enter Lisp debugger when C-g is pressed"))
956 (define-key menu-bar-options-menu [debug-on-error]
957 (menu-bar-make-toggle toggle-debug-on-error debug-on-error
958 "Enter Debugger on Error" "Debug on Error %s"
959 "Enter Lisp debugger when an error is signaled"))
960 (define-key menu-bar-options-menu [debugger-separator]
962 (define-key menu-bar-options-menu [toggle-auto-compression]
963 '(menu-item "Automatic File De/compression"
964 auto-compression-mode
965 :help "Transparently decompress compressed files"
966 :button (:toggle . (rassq 'jka-compr-handler
967 file-name-handler-alist))))
969 (define-key menu-bar-options-menu [save-place]
970 (menu-bar-make-toggle toggle-save-place-globally save-place
971 "Save Place in Files between Sessions"
972 "Saving place in files %s"
973 "Visit files of previous session when restarting Emacs"
975 ;; Do it by name, to avoid a free-variable
976 ;; warning during byte compilation.
978 'save-place (not (symbol-value 'save-place)))))
980 (define-key menu-bar-options-menu [uniquify]
981 (menu-bar-make-toggle toggle-uniquify-buffer-names uniquify-buffer-name-style
982 "Use Directory Names in Buffer Names"
983 "Directory name in buffer names (uniquify) %s"
984 "Uniquify buffer names by adding parent directory names"
986 (setq uniquify-buffer-name-style
987 (if (not uniquify-buffer-name-style)
990 (define-key menu-bar-options-menu [edit-options-separator]
992 (define-key menu-bar-options-menu [cua-mode]
993 (menu-bar-make-mm-toggle cua-mode
994 "C-x/C-c/C-v cut and paste (CUA)"
995 "Use C-z/C-x/C-c/C-v keys for undo/cut/copy/paste"))
997 (define-key menu-bar-options-menu [case-fold-search]
998 (menu-bar-make-toggle toggle-case-fold-search case-fold-search
999 "Case-Insensitive Search"
1000 "Case-Insensitive Search %s"
1001 "Ignore letter-case in search"))
1003 (defun menu-bar-text-mode-auto-fill ()
1005 (toggle-text-mode-auto-fill)
1006 ;; This is somewhat questionable, as `text-mode-hook'
1007 ;; might have changed outside customize.
1008 ;; -- Per Abrahamsen <abraham@dina.kvl.dk> 2002-02-11.
1009 (customize-mark-as-set 'text-mode-hook))
1011 (define-key menu-bar-options-menu [auto-fill-mode]
1012 '(menu-item "Word Wrap in Text Modes"
1013 menu-bar-text-mode-auto-fill
1014 :help "Automatically fill text between left and right margins (Auto Fill)"
1015 :button (:toggle . (if (listp text-mode-hook)
1016 (member 'turn-on-auto-fill text-mode-hook)
1017 (eq 'turn-on-auto-fill text-mode-hook)))))
1018 (define-key menu-bar-options-menu [truncate-lines]
1019 '(menu-item "Truncate Long Lines in this Buffer"
1020 toggle-truncate-lines
1021 :help "Truncate long lines on the screen"
1022 :button (:toggle . truncate-lines)))
1024 (define-key menu-bar-options-menu [highlight-separator]
1026 (define-key menu-bar-options-menu [highlight-paren-mode]
1027 (menu-bar-make-mm-toggle show-paren-mode
1028 "Paren Match Highlighting"
1029 "Highlight matching/mismatched parentheses at cursor (Show Paren mode)"))
1030 (define-key menu-bar-options-menu [transient-mark-mode]
1031 (menu-bar-make-mm-toggle transient-mark-mode
1032 "Active Region Highlighting"
1033 "Make text in active region stand out in color (Transient Mark mode)"
1034 (:enable (not cua-mode))))
1035 (define-key menu-bar-options-menu [toggle-global-lazy-font-lock-mode]
1036 (menu-bar-make-mm-toggle global-font-lock-mode
1037 "Syntax Highlighting"
1038 "Colorize text based on language syntax (Global Font Lock mode)"))
1041 ;; The "Tools" menu items
1043 (defun send-mail-item-name ()
1044 (let* ((known-send-mail-commands '((sendmail-user-agent . "sendmail")
1045 (mh-e-user-agent . "MH")
1046 (message-user-agent . "Gnus Message")
1047 (gnus-user-agent . "Gnus")))
1048 (name (assq mail-user-agent known-send-mail-commands)))
1050 (setq name (cdr name))
1051 (setq name (symbol-name mail-user-agent))
1052 (if (string-match "\\(.+\\)-user-agent" name)
1053 (setq name (match-string 1 name))))
1056 (defun read-mail-item-name ()
1057 (let* ((known-rmail-commands '((rmail . "RMAIL")
1060 (known (assq read-mail-command known-rmail-commands)))
1061 (if known (cdr known) (symbol-name read-mail-command))))
1063 (defvar menu-bar-games-menu (make-sparse-keymap "Games"))
1065 (define-key menu-bar-tools-menu [games]
1066 (list 'menu-item "Games" menu-bar-games-menu))
1068 (define-key menu-bar-tools-menu [separator-games]
1071 (define-key menu-bar-games-menu [zone]
1072 '(menu-item "Zone Out" zone
1073 :help "Play tricks with Emacs display when Emacs is idle"))
1074 (define-key menu-bar-games-menu [yow]
1075 '(menu-item "Random Quotation" yow
1076 :help "Display a random Zippy quotation"))
1077 (define-key menu-bar-games-menu [tetris]
1078 '(menu-item "Tetris" tetris))
1079 (define-key menu-bar-games-menu [solitaire]
1080 '(menu-item "Solitaire" solitaire))
1081 (define-key menu-bar-games-menu [snake]
1082 '(menu-item "Snake" snake
1083 :help "Move snake around avoiding collisions"))
1084 (define-key menu-bar-games-menu [mult]
1085 '(menu-item "Multiplication Puzzle" mpuz
1086 :help "Excercise brain with multiplication"))
1087 (define-key menu-bar-games-menu [life]
1088 '(menu-item "Life" life
1089 :help "Watch how John Conway's cellular automaton evolves"))
1090 (define-key menu-bar-games-menu [hanoi]
1091 '(menu-item "Towers of Hanoi" hanoi
1092 :help "Watch Towers-of-Hanoi puzzle solved by Emacs"))
1093 (define-key menu-bar-games-menu [gomoku]
1094 '(menu-item "Gomoku" gomoku
1095 :help "Mark 5 contiguous squares (like tic-tac-toe)"))
1096 (define-key menu-bar-games-menu [black-box]
1097 '(menu-item "Blackbox" blackbox
1098 :help "Find balls in a black box by shooting rays"))
1099 (define-key menu-bar-games-menu [adventure]
1100 '(menu-item "Adventure" dunnet
1101 :help "Dunnet, a text Adventure game for Emacs"))
1102 (define-key menu-bar-games-menu [5x5]
1103 '(menu-item "5x5" 5x5
1104 :help "Fill in all the squares on a 5x5 board"))
1106 (define-key menu-bar-tools-menu [simple-calculator]
1107 '(menu-item "Simple Calculator" calculator
1108 :help "Invoke the Emacs built-in quick calculator"))
1109 (define-key menu-bar-tools-menu [calc]
1110 '(menu-item "Programmable Calculator" calc
1111 :help "Invoke the Emacs built-in full scientific calculator"))
1112 (define-key menu-bar-tools-menu [calendar]
1113 '(menu-item "Display Calendar" calendar))
1115 (define-key menu-bar-tools-menu [separator-net]
1118 (define-key menu-bar-tools-menu [directory-search]
1119 '(menu-item "Directory Search" eudc-tools-menu
1120 :help "Query directory servers via LDAP, CCSO PH/QI or BBDB"))
1121 (define-key menu-bar-tools-menu [compose-mail]
1123 'menu-item `(format "Send Mail (with %s)" (send-mail-item-name))
1125 :visible `(and mail-user-agent (not (eq mail-user-agent 'ignore)))
1126 :help "Send a mail message"))
1127 (define-key menu-bar-tools-menu [rmail]
1129 'menu-item `(format "Read Mail (with %s)" (read-mail-item-name))
1131 :visible `(and read-mail-command (not (eq read-mail-command 'ignore)))
1132 :help "Read your mail and reply to it"))
1134 (defun menu-bar-read-mail ()
1135 "Read mail using `read-mail-command'."
1137 (call-interactively read-mail-command))
1139 (define-key menu-bar-tools-menu [gnus]
1140 '(menu-item "Read Net News (Gnus)" gnus
1141 :help "Read network news groups"))
1143 (define-key menu-bar-tools-menu [separator-vc]
1146 (defvar vc-menu-map (make-sparse-keymap "Version Control"))
1147 (define-key menu-bar-tools-menu [pcl-cvs]
1148 '(menu-item "PCL-CVS" cvs-global-menu
1149 :help "Module-level interface to CVS"))
1150 (define-key menu-bar-tools-menu [vc]
1151 (list 'menu-item "Version Control" vc-menu-map
1152 :help "Interface to RCS, CVS, SCCS"))
1154 (define-key menu-bar-tools-menu [separator-compare]
1157 (define-key menu-bar-tools-menu [ediff-misc]
1158 '(menu-item "Ediff Miscellanea" menu-bar-ediff-misc-menu
1159 :help "Ediff manual, customization, sessions, etc."))
1160 (define-key menu-bar-tools-menu [epatch]
1161 '(menu-item "Apply Patch" menu-bar-epatch-menu))
1162 (define-key menu-bar-tools-menu [ediff-merge]
1163 '(menu-item "Merge" menu-bar-ediff-merge-menu
1164 :help "Merge different revisions of files/directories"))
1165 (define-key menu-bar-tools-menu [compare]
1166 '(menu-item "Compare (Ediff)" menu-bar-ediff-menu
1167 :help "Display differences between files/directories"))
1170 (define-key menu-bar-tools-menu [separator-spell]
1173 (define-key menu-bar-tools-menu [spell]
1174 '(menu-item "Spell Checking" ispell-menu-map))
1176 (define-key menu-bar-tools-menu [separator-prog]
1179 (define-key menu-bar-tools-menu [gdb]
1180 '(menu-item "Debugger (GDB)..." gdb
1181 :help "Debug a program from within Emacs with GDB"))
1182 (define-key menu-bar-tools-menu [shell-on-region]
1183 '(menu-item "Shell Command on Region..." shell-command-on-region
1185 :help "Pass marked region to a shell command"))
1186 (define-key menu-bar-tools-menu [shell]
1187 '(menu-item "Shell Command..." shell-command
1188 :help "Invoke a shell command and catch its output"))
1189 (define-key menu-bar-tools-menu [compile]
1190 '(menu-item "Compile..." compile
1191 :help "Invoke compiler or Make, view compilation errors"))
1192 (define-key menu-bar-tools-menu [grep]
1193 '(menu-item "Search Files (with grep)..." grep
1194 :help "Search files for strings or regexps (with grep)"))
1197 ;; The "Help" menu items
1199 (defvar menu-bar-describe-menu (make-sparse-keymap "Describe"))
1201 (define-key menu-bar-describe-menu [mule-diag]
1202 '(menu-item "Show All of Mule Status" mule-diag
1203 :visible default-enable-multibyte-characters
1204 :help "Display multilingual environment settings"))
1205 (define-key menu-bar-describe-menu [describe-coding-system-briefly]
1206 '(menu-item "Describe Coding System (Briefly)..."
1207 describe-current-coding-system-briefly
1208 :visible default-enable-multibyte-characters))
1209 (define-key menu-bar-describe-menu [describe-coding-system]
1210 '(menu-item "Describe Coding System..." describe-coding-system
1211 :visible default-enable-multibyte-characters))
1212 (define-key menu-bar-describe-menu [describe-input-method]
1213 '(menu-item "Describe Input Method..." describe-input-method
1214 :visible default-enable-multibyte-characters
1215 :help "Keyboard layout for specific input method"))
1216 (define-key menu-bar-describe-menu [describe-language-environment]
1217 (list 'menu-item "Describe Language Environment"
1218 describe-language-environment-map
1219 :help "Show multilingual settings for a specific language"))
1221 (define-key menu-bar-describe-menu [separator-desc-mule]
1224 (define-key menu-bar-describe-menu [list-keybindings]
1225 '(menu-item "List Key Bindings" describe-bindings
1226 :help "Display a list of all current keybindings"))
1227 (define-key menu-bar-describe-menu [describe-current-display-table]
1228 '(menu-item "Describe Display Table" describe-current-display-table
1229 :help "Describe the current display table"))
1230 (define-key menu-bar-describe-menu [describe-face]
1231 '(menu-item "Describe Face..." describe-face
1232 :help "Display the properties of a face"))
1233 (define-key menu-bar-describe-menu [describe-variable]
1234 '(menu-item "Describe Variable..." describe-variable
1235 :help "Display documentation of variable/option"))
1236 (define-key menu-bar-describe-menu [describe-function]
1237 '(menu-item "Describe Function..." describe-function
1238 :help "Display documentation of function/command"))
1239 (define-key menu-bar-describe-menu [describe-key-1]
1240 '(menu-item "Describe Key..." describe-key
1241 ;; Users typically don't identify keys and menu items...
1242 :help "Display documentation of command bound to a \
1243 key (or menu-item)"))
1244 (define-key menu-bar-describe-menu [describe-key]
1245 '(menu-item "What's This? " describe-key
1246 ;; Users typically don't identify keys and menu items...
1247 :help "Display documentation of command bound to a \
1248 key (or menu-item)"))
1249 (define-key menu-bar-describe-menu [describe-mode]
1250 '(menu-item "Describe Buffer Modes" describe-mode
1251 :help "Describe this buffer's major and minor mode"))
1253 (defvar menu-bar-apropos-menu (make-sparse-keymap "Apropos"))
1254 (defun menu-bar-read-lispref ()
1255 "Display the Emacs Lisp Reference manual in Info mode."
1259 (defun menu-bar-read-lispintro ()
1260 "Display the Introduction to Emacs Lisp Programming in Info mode."
1264 (defun search-emacs-glossary ()
1265 "Display the Glossary node of the Emacs manual in Info mode."
1267 (info "(emacs)Glossary"))
1269 (defun emacs-index-search (topic)
1270 "Look up TOPIC in the indices of the Emacs User Manual."
1271 (interactive "sSubject to look up: ")
1275 (defun elisp-index-search (topic)
1276 "Look up TOPIC in the indices of the Emacs Lisp Reference Manual."
1277 (interactive "sSubject to look up: ")
1281 (define-key menu-bar-apropos-menu [apropos-documentation]
1282 '(menu-item "Search Documentation Strings..." apropos-documentation
1284 "Find functions and variables whose doc strings match a regexp"))
1285 (define-key menu-bar-apropos-menu [apropos]
1286 '(menu-item "Find Any Object by Name..." apropos
1287 :help "Find symbols of any kind whose names match a regexp"))
1288 (define-key menu-bar-apropos-menu [apropos-value]
1289 '(menu-item "Find Options by Value..." apropos-value
1290 :help "Find variables whose values match a regexp"))
1291 (define-key menu-bar-apropos-menu [apropos-variables]
1292 '(menu-item "Find Options by Name..." apropos-variable
1293 :help "Find variables whose names match a regexp"))
1294 (define-key menu-bar-apropos-menu [apropos-commands]
1295 '(menu-item "Find Commands by Name..." apropos-command
1296 :help "Find commands whose names match a regexp"))
1297 (define-key menu-bar-apropos-menu [sep1]
1299 (define-key menu-bar-apropos-menu [elisp-index-search]
1300 '(menu-item "Look Up Subject in ELisp Manual..." elisp-index-search
1301 :help "Find description of a subject in Emacs Lisp manual"))
1302 (define-key menu-bar-apropos-menu [emacs-index-search]
1303 '(menu-item "Look Up Subject in User Manual..." emacs-index-search
1304 :help "Find description of a subject in Emacs User manual"))
1305 (define-key menu-bar-apropos-menu [emacs-glossary]
1306 '(menu-item "Emacs Terminology" search-emacs-glossary
1307 :help "Display the Glossary section of the Emacs manual"))
1309 (defvar menu-bar-manuals-menu (make-sparse-keymap "More Manuals"))
1311 (define-key menu-bar-manuals-menu [man]
1312 '(menu-item "Read Man Page..." manual-entry
1313 :help "Man-page docs for external commands and libraries"))
1314 (define-key menu-bar-manuals-menu [sep2]
1316 (define-key menu-bar-manuals-menu [order-emacs-manuals]
1317 '(menu-item "Ordering Manuals" view-order-manuals
1318 :help "How to order manuals from the Free Software Foundation"))
1319 (define-key menu-bar-manuals-menu [info]
1320 '(menu-item "All Other Manuals (Info)" Info-directory
1321 :help "Read any of the installed manuals"))
1322 (define-key menu-bar-manuals-menu [info-elisp]
1323 '(menu-item "Emacs Lisp Reference" menu-bar-read-lispref
1324 :help "Read the Emacs Lisp Reference manual"))
1325 (define-key menu-bar-manuals-menu [info-elintro]
1326 '(menu-item "Introduction to Emacs Lisp" menu-bar-read-lispintro
1327 :help "Read the Introduction to Emacs Lisp Programming"))
1328 (define-key menu-bar-manuals-menu [sep3]
1330 (define-key menu-bar-manuals-menu [command]
1331 '(menu-item "Find Command in Manual" Info-goto-emacs-command-node
1332 :help "Display manual section that describes a command"))
1333 (define-key menu-bar-manuals-menu [key]
1334 '(menu-item "Find Key in Manual" Info-goto-emacs-key-command-node
1335 :help "Display manual section that describes a key"))
1337 (define-key menu-bar-help-menu [eliza]
1338 '(menu-item "Emacs Psychiatrist" doctor
1339 :help "Our doctor will help you feel better"))
1340 (define-key menu-bar-help-menu [sep4]
1342 (define-key menu-bar-help-menu [describe-no-warranty]
1343 '(menu-item "(Non)Warranty" describe-no-warranty
1344 :help "Explain that Emacs has NO WARRANTY"))
1345 (define-key menu-bar-help-menu [describe-copying]
1346 '(menu-item "Copying Conditions" describe-copying
1347 :help "Show the Emacs license (GPL)"))
1348 (define-key menu-bar-help-menu [describe-distribution]
1349 '(menu-item "Getting New Versions" describe-distribution
1350 :help "How to get latest versions of Emacs"))
1351 (define-key menu-bar-help-menu [more]
1352 '(menu-item "Find Extra Packages"
1353 menu-bar-help-extra-packages
1354 :help "Where to find some extra packages and possible updates"))
1355 (defun menu-bar-help-extra-packages ()
1356 "Display help about some additional packages available for Emacs."
1358 (let (enable-local-variables)
1359 (view-file (expand-file-name "MORE.STUFF"
1362 (define-key menu-bar-help-menu [about]
1363 '(menu-item "About Emacs" display-splash-screen
1364 :help "Display version number, copyright info, and basic help"))
1365 (define-key menu-bar-help-menu [sep2]
1367 (define-key menu-bar-help-menu [finder-by-keyword]
1368 '(menu-item "Find Emacs Packages..." finder-by-keyword
1369 :help "Find packages and features by keyword"))
1370 (define-key menu-bar-help-menu [manuals]
1371 (list 'menu-item "More Manuals" menu-bar-manuals-menu
1372 :help "Search and browse on-line manuals"))
1373 (define-key menu-bar-help-menu [emacs-manual]
1374 '(menu-item "Read the Emacs Manual" info-emacs-manual
1375 :help "Full documentation of Emacs features"))
1376 (define-key menu-bar-help-menu [describe]
1377 (list 'menu-item "Describe" menu-bar-describe-menu
1378 :help "Describe commands, variables, keys"))
1379 (define-key menu-bar-help-menu [apropos]
1380 (list 'menu-item "Search Documentation" menu-bar-apropos-menu
1381 :help "Look up terms, find commands, options, etc. (Apropos)"))
1382 (define-key menu-bar-help-menu [sep1]
1384 (define-key menu-bar-help-menu [report-emacs-bug]
1385 '(menu-item "Send Bug Report..." report-emacs-bug
1386 :help "Send e-mail to Emacs maintainers"))
1387 (define-key menu-bar-help-menu [emacs-problems]
1388 '(menu-item "Emacs Known Problems" view-emacs-problems))
1389 (define-key menu-bar-help-menu [emacs-news]
1390 '(menu-item "Emacs News" view-emacs-news
1391 :help "New features of this version"))
1392 (define-key menu-bar-help-menu [emacs-faq]
1393 '(menu-item "Emacs FAQ" view-emacs-FAQ))
1395 (defun help-with-tutorial-spec-language ()
1396 "Use the Emacs tutorial, specifying which language you want."
1398 (help-with-tutorial t))
1400 (define-key menu-bar-help-menu [emacs-tutorial-language-specific]
1401 '(menu-item "Emacs Tutorial (choose language)..."
1402 help-with-tutorial-spec-language
1403 :help "Learn how to use Emacs (choose a language)"))
1404 (define-key menu-bar-help-menu [emacs-tutorial]
1405 '(menu-item "Emacs Tutorial" help-with-tutorial
1406 :help "Learn how to use Emacs"))
1408 (defun kill-this-buffer () ; for the menubar
1409 "Kill the current buffer."
1411 (kill-buffer (current-buffer)))
1413 (defun kill-this-buffer-enabled-p ()
1415 (buffers (buffer-list)))
1417 (or (string-match "^ " (buffer-name (car buffers)))
1418 (setq count (1+ count)))
1419 (setq buffers (cdr buffers)))
1420 (and (not (window-minibuffer-p (frame-selected-window menu-updating-frame)))
1423 (put 'dired 'menu-enable
1424 '(not (window-minibuffer-p (frame-selected-window menu-updating-frame))))
1426 ;; Permit deleting frame if it would leave a visible or iconified frame.
1427 (defun delete-frame-enabled-p ()
1428 "Return non-nil if `delete-frame' should be enabled in the menu bar."
1429 (let ((frames (frame-list))
1432 (if (frame-visible-p (car frames))
1433 (setq count (1+ count)))
1434 (setq frames (cdr frames)))
1437 (defcustom yank-menu-length 20
1438 "*Maximum length to display in the yank-menu."
1442 (defun menu-bar-update-yank-menu (string old)
1443 (let ((front (car (cdr yank-menu)))
1444 (menu-string (if (<= (length string) yank-menu-length)
1447 (substring string 0 (/ yank-menu-length 2))
1449 (substring string (- (/ yank-menu-length 2)))))))
1450 ;; Don't let the menu string be all dashes
1451 ;; because that has a special meaning in a menu.
1452 (if (string-match "\\`-+\\'" menu-string)
1453 (setq menu-string (concat menu-string " ")))
1454 ;; If we're supposed to be extending an existing string, and that
1455 ;; string really is at the front of the menu, then update it in place.
1456 (if (and old (or (eq old (car front))
1457 (string= old (car front))))
1459 (setcar front string)
1460 (setcar (cdr front) menu-string))
1463 (cons string (cons menu-string 'menu-bar-select-yank))
1465 (if (> (length (cdr yank-menu)) kill-ring-max)
1466 (setcdr (nthcdr kill-ring-max yank-menu) nil)))
1468 (put 'menu-bar-select-yank 'apropos-inhibit t)
1469 (defun menu-bar-select-yank ()
1472 (insert last-command-event))
1475 (defcustom buffers-menu-show-directories 'unless-uniquify
1476 "If non-nil, show directories in the Buffers menu for buffers that have them.
1477 The special value `unless-uniquify' means that directories will be shown
1478 unless `uniquify-buffer-name-style' is non-nil (in which case, buffer
1479 names should include enough of a buffer's directory to distinguish it
1480 from other buffers).
1482 Setting this variable directly does not take effect until next time the
1483 Buffers menu is regenerated."
1484 :set (lambda (symbol value)
1486 (menu-bar-update-buffers t))
1487 :initialize 'custom-initialize-default
1488 :type '(choice (const :tag "Never" nil)
1489 (const :tag "Unless uniquify is enabled" unless-uniquify)
1490 (const :tag "Always" t))
1493 (defcustom buffers-menu-show-status t
1494 "If non-nil, show modified/read-only status of buffers in the Buffers menu.
1495 Setting this variable directly does not take effect until next time the
1496 Buffers menu is regenerated."
1497 :set (lambda (symbol value)
1499 (menu-bar-update-buffers t))
1500 :initialize 'custom-initialize-default
1504 (defvar list-buffers-directory nil)
1506 (defvar menu-bar-update-buffers-maxbuf)
1508 (defun menu-bar-select-buffer ()
1510 (switch-to-buffer last-command-event))
1512 (defun menu-bar-select-frame ()
1515 (dolist (f (frame-list))
1516 (when (equal last-command-event (frame-parameter f 'name))
1518 ;; FRAME can be nil when user specifies the selected frame.
1519 (setq frame (or frame (selected-frame)))
1520 (make-frame-visible frame)
1522 (select-frame frame)))
1524 (defun menu-bar-update-buffers-1 (elt)
1525 (let* ((buf (car elt))
1527 (and (if (eq buffers-menu-show-directories 'unless-uniquify)
1528 (or (not (boundp 'uniquify-buffer-name-style))
1529 (null uniquify-buffer-name-style))
1530 buffers-menu-show-directories)
1531 (or (buffer-file-name buf)
1532 (buffer-local-value 'list-buffers-directory buf)))))
1534 (setq file (file-name-directory file)))
1535 (when (and file (> (length file) 20))
1536 (setq file (concat "..." (substring file -17))))
1537 (cons (if buffers-menu-show-status
1538 (let ((mod (if (buffer-modified-p buf) "*" ""))
1539 (ro (if (buffer-local-value 'buffer-read-only buf) "%" "")))
1541 (format "%s %s%s -- %s" (cdr elt) mod ro file)
1542 (format "%s %s%s" (cdr elt) mod ro)))
1544 (format "%s -- %s" (cdr elt) file)
1548 ;; Used to cache the menu entries for commands in the Buffers menu
1549 (defvar menu-bar-buffers-menu-command-entries nil)
1551 (defun menu-bar-update-buffers (&optional force)
1552 ;; If user discards the Buffers item, play along.
1553 (and (lookup-key (current-global-map) [menu-bar buffer])
1554 (or force (frame-or-buffer-changed-p))
1555 (let ((buffers (buffer-list))
1556 (frames (frame-list))
1557 buffers-menu frames-menu)
1558 ;; If requested, list only the N most recently selected buffers.
1559 (if (and (integerp buffers-menu-max-size)
1560 (> buffers-menu-max-size 1))
1561 (if (> (length buffers) buffers-menu-max-size)
1562 (setcdr (nthcdr buffers-menu-max-size buffers) nil)))
1564 ;; Make the menu of buffers proper.
1567 (mapcar 'list buffers))
1568 (menu-bar-update-buffers-maxbuf 0)
1570 ;; Put into each element of buffer-list
1571 ;; the name for actual display,
1572 ;; perhaps truncated in the middle.
1573 (dolist (buf buffer-list)
1574 (let ((name (buffer-name (car buf))))
1576 (if (> (length name) 27)
1577 (concat (substring name 0 12)
1579 (substring name -12))
1581 ;; Compute the maximum length of any name.
1582 (dolist (buf buffer-list)
1583 (unless (eq ?\ (aref (cdr buf) 0))
1584 (setq menu-bar-update-buffers-maxbuf
1585 (max menu-bar-update-buffers-maxbuf
1586 (length (cdr buf))))))
1587 ;; Set ALIST to an alist of the form
1588 ;; ITEM-STRING . BUFFER
1589 (dolist (buf buffer-list)
1590 (unless (eq ?\ (aref (cdr buf) 0))
1591 (push (menu-bar-update-buffers-1 buf) alist)))
1592 ;; Now make the actual list of items, and add
1593 ;; some miscellaneous buffer commands to the end.
1594 (mapcar (lambda (pair)
1595 ;; This is somewhat risque, to use
1596 ;; the buffer name itself as the event
1597 ;; type to define, but it works.
1598 ;; It would not work to use the buffer
1599 ;; since a buffer as an event has its
1601 (nconc (list (buffer-name (cdr pair))
1604 'menu-bar-select-buffer))
1607 ;; Make a Frames menu if we have more than one frame.
1611 (cons "Select Frame"
1615 (list (frame-parameter frame 'name)
1616 (frame-parameter frame 'name)
1618 'menu-bar-select-frame))
1620 ;; Put it after the normal buffers
1623 `((frames-separator "--")
1624 (frames menu-item "Frames" ,frames-menu))))))
1626 ;; Add in some normal commands at the end of the menu. We use
1627 ;; the copy cached in `menu-bar-buffers-menu-command-entries'
1628 ;; if it's been set already. Note that we can't use constant
1629 ;; lists for the menu-entries, because the low-level menu-code
1631 (unless menu-bar-buffers-menu-command-entries
1632 (setq menu-bar-buffers-menu-command-entries
1633 (list '(command-separator "--")
1638 :help "Switch to the \"next\" buffer in a cyclic order")
1643 :help "Switch to the \"previous\" buffer in a cyclic order")
1644 (list 'select-named-buffer
1646 "Select Named Buffer..."
1648 :help "Prompt for a buffer name, and select that buffer in the current window")
1649 (list 'list-all-buffers
1653 :help "Pop up a window listing all emacs buffers"
1656 (nconc buffers-menu menu-bar-buffers-menu-command-entries))
1658 (setq buffers-menu (cons 'keymap (cons "Select Buffer" buffers-menu)))
1659 (define-key (current-global-map) [menu-bar buffer]
1660 ;; Call copy-sequence so the string is not pure.
1661 (cons (copy-sequence "Buffers") buffers-menu)))))
1663 (add-hook 'menu-bar-update-hook 'menu-bar-update-buffers)
1665 (menu-bar-update-buffers)
1667 ;; this version is too slow
1668 ;;(defun format-buffers-menu-line (buffer)
1669 ;; "Returns a string to represent the given buffer in the Buffer menu.
1670 ;;nil means the buffer shouldn't be listed. You can redefine this."
1671 ;; (if (string-match "\\` " (buffer-name buffer))
1674 ;; (set-buffer buffer)
1675 ;; (let ((size (buffer-size)))
1676 ;; (format "%s%s %-19s %6s %-15s %s"
1677 ;; (if (buffer-modified-p) "*" " ")
1678 ;; (if buffer-read-only "%" " ")
1682 ;; (or (buffer-file-name) ""))))))
1684 ;;; Set up a menu bar menu for the minibuffer.
1686 (dolist (map (list minibuffer-local-map
1687 ;; This shouldn't be necessary, but there's a funny
1688 ;; bug in keymap.c that I don't understand yet. -stef
1689 minibuffer-local-completion-map))
1690 (define-key map [menu-bar minibuf]
1691 (cons "Minibuf" (make-sparse-keymap "Minibuf"))))
1693 (let ((map minibuffer-local-completion-map))
1694 (define-key map [menu-bar minibuf ?\?]
1695 (list 'menu-item "List Completions" 'minibuffer-completion-help
1696 :help "Display all possible completions"))
1697 (define-key map [menu-bar minibuf space]
1698 (list 'menu-item "Complete Word" 'minibuffer-complete-word
1699 :help "Complete at most one word"))
1700 (define-key map [menu-bar minibuf tab]
1701 (list 'menu-item "Complete" 'minibuffer-complete
1702 :help "Complete as far as possible")))
1704 (let ((map minibuffer-local-map))
1705 (define-key map [menu-bar minibuf quit]
1706 (list 'menu-item "Quit" 'keyboard-escape-quit
1707 :help "Abort input and exit minibuffer"))
1708 (define-key map [menu-bar minibuf return]
1709 (list 'menu-item "Enter" 'exit-minibuffer
1710 :help "Terminate input and exit minibuffer")))
1713 ;; This comment is taken from toolbar/tool-bar.el near
1714 ;; (put 'tool-bar-mode ...)
1715 ;; We want to pretend the menu bar by standard is on, as this will make
1716 ;; customize consider disabling the menu bar a customization, and save
1717 ;; that. We could do this for real by setting :init-value below, but
1718 ;; that would overwrite disabling the tool bar from X resources.
1719 (put 'menu-bar-mode 'standard-value '(t))
1722 (define-minor-mode menu-bar-mode
1723 "Toggle display of a menu bar on each frame.
1724 This command applies to all frames that exist and frames to be
1725 created in the future.
1726 With a numeric argument, if the argument is positive,
1727 turn on menu bars; otherwise, turn off menu bars."
1731 ;; Make menu-bar-mode and default-frame-alist consistent.
1732 (let ((lines (if menu-bar-mode 1 0)))
1733 ;; Alter existing frames...
1734 (mapc (lambda (frame)
1735 (modify-frame-parameters frame
1736 (list (cons 'menu-bar-lines lines))))
1738 ;; ...and future ones.
1739 (let ((elt (assq 'menu-bar-lines default-frame-alist)))
1742 (add-to-list 'default-frame-alist (cons 'menu-bar-lines lines)))))
1744 ;; Make the message appear when Emacs is idle. We can not call message
1745 ;; directly. The minor-mode message "Menu-bar mode disabled" comes
1746 ;; after this function returns, overwriting any message we do here.
1747 (when (and (interactive-p) (not menu-bar-mode))
1748 (run-with-idle-timer 0 nil 'message
1749 "Menu-bar mode disabled. Use M-x menu-bar-mode to make the menu bar appear."))
1754 ;;; arch-tag: 6e6a3c22-4ec4-4d3d-8190-583f8ef94ced
1755 ;;; menu-bar.el ends here