(menu-bar-file-menu): Make this the real name
[emacs.git] / lisp / menu-bar.el
blob597e77b6165f8b2a4726890d657d7d7e4f70a40d
1 ;;; menu-bar.el --- define a default menu bar
3 ;; Copyright (C) 1993,94,1995,2000,01,02,2003 Free Software Foundation, Inc.
5 ;; Author: RMS
6 ;; Maintainer: FSF
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)
14 ;; any later version.
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.
28 ;;; Commentary:
30 ;;; Code:
32 ;;; User options:
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))
41 :group 'mouse)
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
51 ;; help key.
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]
82 '("--"))
84 ;; Don't use delete-frame as event name because that is a special
85 ;; event.
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]
110 '(menu-item "--"))
112 (define-key menu-bar-file-menu [ps-print-region]
113 '(menu-item "Postscript Print Region (B+W)" ps-print-region
114 :enable mark-active
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
121 :enable mark-active
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
128 :enable mark-active
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]
135 '(menu-item "--"))
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
140 (file-directory-p
141 (file-name-directory auto-save-list-file-prefix))
142 (directory-files
143 (file-name-directory auto-save-list-file-prefix)
145 (concat "\\`"
146 (regexp-quote
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)
168 (buffer-file-name)
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]
174 '(menu-item "--"))
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."
208 (interactive)
209 (cond
210 ((and (eq menu-bar-last-search-type 'string)
211 search-ring)
212 (search-forward (car search-ring)))
213 ((and (eq menu-bar-last-search-type 'regexp)
214 regexp-search-ring)
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."
221 (interactive)
222 (cond
223 ((and (eq menu-bar-last-search-type 'string)
224 search-ring)
225 (search-backward (car search-ring)))
226 ((and (eq menu-bar-last-search-type 'regexp)
227 regexp-search-ring)
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]
292 '(menu-item "--"))
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]
301 '(menu-item "--"))
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)
306 search-ring)
307 (and (eq menu-bar-last-search-type 'regexp)
308 regexp-search-ring))
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)
313 search-ring)
314 (and (eq menu-bar-last-search-type 'regexp)
315 regexp-search-ring))
316 :help "Repeat last search forward"))
317 (define-key menu-bar-search-menu [separator-repeat-search]
318 '(menu-item "--"))
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]
345 '(menu-item "--"))
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))
364 :help
365 "Fill text in region to fit between left and right margin"))
367 (define-key menu-bar-edit-menu [separator-bookmark]
368 '(menu-item "--"))
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]
381 '(menu-item "--"))
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."
395 (interactive)
396 (find-tag-other-window nil t))
398 (defun menu-bar-next-tag ()
399 "Find the next definition of the tag already specified."
400 (interactive)
401 (find-tag nil t))
403 (define-key menu-bar-goto-menu [next-tag]
404 '(menu-item "Find Next Tag"
405 menu-bar-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]
417 '(menu-item "--"))
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]
440 '(menu-item "--"))
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)))
450 :help
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
460 :enable (and
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
468 :enable mark-active
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))
474 :help
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)
481 pending-undo-list
482 (consp buffer-undo-list)))
483 :help "Undo last operation"))
486 (defun menu-bar-kill-ring-save (beg end)
487 (interactive "r")
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."
503 (interactive)
504 (let ((x-select-enable-clipboard t))
505 (yank)))
507 (defun clipboard-kill-ring-save (beg end)
508 "Copy region to kill ring, and save in the X clipboard."
509 (interactive "r")
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."
515 (interactive "r")
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."
522 (interactive)
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)
539 ;; X11R6 versions:
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]
561 '("--"))
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]
572 '("--"))
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]
580 '("--"))
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
597 ,@(if props props)
598 :help ,help
599 :button (:toggle . (and (default-boundp ',fname)
600 (default-value ',fname)))))
602 (defmacro menu-bar-make-toggle (name variable doc message help &rest body)
603 `(progn
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.")
609 (interactive "p")
610 (if ,(if body `(progn . ,body)
611 `(progn
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
624 :help ,help
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."
635 (interactive)
636 (let ((need-save nil))
637 ;; These are set with `customize-set-variable'.
638 (dolist (elt '(line-number-mode column-number-mode scroll-bar-mode
639 debug-on-quit debug-on-error menu-bar-mode tool-bar-mode
640 save-place uniquify-buffer-name-style fringe-mode
641 case-fold-search cua-mode show-paren-mode
642 transient-mark-mode global-font-lock-mode
643 display-time-mode auto-compression-mode
644 current-language-environment default-input-method
645 ;; Saving `text-mode-hook' is somewhat questionable,
646 ;; as we might get more than we bargain for, if
647 ;; other code may has added hooks as well.
648 ;; Nonetheless, not saving it would like be confuse
649 ;; more often.
650 ;; -- Per Abrahamsen <abraham@dina.kvl.dk> 2002-02-11.
651 text-mode-hook))
652 (and (get elt 'customized-value)
653 (customize-mark-to-save elt)
654 (setq need-save t)))
655 ;; Save if we changed anything.
656 (when need-save
657 (custom-save-all))))
659 (define-key menu-bar-options-menu [save]
660 '(menu-item "Save Options" menu-bar-options-save
661 :help "Save options set from the menu above"))
663 (define-key menu-bar-options-menu [custom-separator]
664 '("--"))
666 (define-key menu-bar-options-menu [mouse-set-font]
667 '(menu-item "Set Font/Fontset" mouse-set-font
668 :visible (display-multi-font-p)
669 :help "Select a font from list of known fonts/fontsets"))
671 ;; The "Show/Hide" submenu of menu "Options"
673 (defvar menu-bar-showhide-menu (make-sparse-keymap "Show/Hide"))
675 (define-key menu-bar-showhide-menu [column-number-mode]
676 (menu-bar-make-mm-toggle column-number-mode
677 "Column Numbers"
678 "Show the current column number in the mode line"))
680 (define-key menu-bar-showhide-menu [line-number-mode]
681 (menu-bar-make-mm-toggle line-number-mode
682 "Line Numbers"
683 "Show the current line number in the mode line"))
685 (define-key menu-bar-showhide-menu [linecolumn-separator]
686 '("--"))
688 (defun showhide-date-time ()
689 "Toggle whether to show date and time in the mode-line."
690 (interactive)
691 (if (display-time-mode)
692 (message "Display-time mode enabled.")
693 (message "Display-time mode disabled."))
694 (customize-mark-as-set 'display-time-mode))
696 (define-key menu-bar-showhide-menu [showhide-date-time]
697 '(menu-item "Date, Time and Mail" showhide-date-time
698 :help "Display date, time, mail status in mode line"
699 :button (:toggle . display-time-mode)))
701 (define-key menu-bar-showhide-menu [datetime-separator]
702 '("--"))
704 (define-key menu-bar-showhide-menu [showhide-speedbar]
705 '(menu-item "Speedbar" speedbar-frame-mode
706 :help "Display a Speedbar quick-navigation frame"
707 :button (:toggle
708 . (and (boundp 'speedbar-frame)
709 (frame-live-p (symbol-value 'speedbar-frame))
710 (frame-visible-p
711 (symbol-value 'speedbar-frame))))))
713 (defvar menu-bar-showhide-fringe-menu (make-sparse-keymap "Fringe"))
715 (defun menu-bar-showhide-fringe-menu-customize ()
716 "Show customization buffer for `fringe-mode'."
717 (interactive)
718 (customize-variable 'fringe-mode))
720 (define-key menu-bar-showhide-fringe-menu [customize]
721 '(menu-item "Customize" menu-bar-showhide-fringe-menu-customize
722 :help "Detailed customization of fringe"
723 :visible (display-graphic-p)))
725 (defun menu-bar-showhide-fringe-menu-customize-reset ()
726 "Reset the fringe mode: display fringes on both sides of a window."
727 (interactive)
728 (customize-set-variable 'fringe-mode nil))
730 ;; The real definition is in fringe.el.
731 ;; This is to prevent errors in the :radio conditions below.
732 (setq fringe-mode nil)
734 (define-key menu-bar-showhide-fringe-menu [default]
735 '(menu-item "Default" menu-bar-showhide-fringe-menu-customize-reset
736 :help "Default width fringe on both left and right side"
737 :visible (display-graphic-p)
738 :button (:radio . (eq fringe-mode nil))))
740 (defun menu-bar-showhide-fringe-menu-customize-left ()
741 "Display fringes only on the left of each window."
742 (interactive)
743 (require 'fringe)
744 (customize-set-variable 'fringe-mode '(nil . 0)))
746 (define-key menu-bar-showhide-fringe-menu [left]
747 '(menu-item "On the Left" menu-bar-showhide-fringe-menu-customize-left
748 :help "Fringe only on the left side"
749 :visible (display-graphic-p)
750 :button (:radio . (equal fringe-mode '(nil . 0)))))
752 (defun menu-bar-showhide-fringe-menu-customize-right ()
753 "Display fringes only on the right of each window."
754 (interactive)
755 (require 'fringe)
756 (customize-set-variable 'fringe-mode '(0 . nil)))
758 (define-key menu-bar-showhide-fringe-menu [right]
759 '(menu-item "On the Right" menu-bar-showhide-fringe-menu-customize-right
760 :help "Fringe only on the right side"
761 :visible (display-graphic-p)
762 :button (:radio . (equal fringe-mode '(0 . nil)))))
764 (defun menu-bar-showhide-fringe-menu-customize-disable ()
765 "Do not display window fringes."
766 (interactive)
767 (require 'fringe)
768 (customize-set-variable 'fringe-mode 0))
770 (define-key menu-bar-showhide-fringe-menu [none]
771 '(menu-item "None" menu-bar-showhide-fringe-menu-customize-disable
772 :help "Turn off fringe"
773 :visible (display-graphic-p)
774 :button (:radio . (eq fringe-mode 0))))
776 (define-key menu-bar-showhide-menu [showhide-fringe]
777 (list 'menu-item "Fringe" menu-bar-showhide-fringe-menu
778 :visible `(display-graphic-p)
779 :help "Select fringe mode"))
781 (defvar menu-bar-showhide-scroll-bar-menu (make-sparse-keymap "Scroll-bar"))
783 (define-key menu-bar-showhide-scroll-bar-menu [right]
784 '(menu-item "On the Right"
785 menu-bar-right-scroll-bar
786 :help "Scroll-bar on the right side"
787 :visible (display-graphic-p)
788 :button (:radio . (eq (cdr (assq 'vertical-scroll-bars
789 (frame-parameters))) 'right))))
790 (defun menu-bar-right-scroll-bar ()
791 "Display scroll bars on the right of each window."
792 (interactive)
793 (customize-set-variable 'scroll-bar-mode 'right))
795 (define-key menu-bar-showhide-scroll-bar-menu [left]
796 '(menu-item "On the Left"
797 menu-bar-left-scroll-bar
798 :help "Scroll-bar on the left side"
799 :visible (display-graphic-p)
800 :button (:radio . (eq (cdr (assq 'vertical-scroll-bars
801 (frame-parameters))) 'left))))
803 (defun menu-bar-left-scroll-bar ()
804 "Display scroll bars on the left of each window."
805 (interactive)
806 (customize-set-variable 'scroll-bar-mode 'left))
808 (define-key menu-bar-showhide-scroll-bar-menu [none]
809 '(menu-item "None"
810 menu-bar-no-scroll-bar
811 :help "Turn off scroll-bar"
812 :visible (display-graphic-p)
813 :button (:radio . (eq (cdr (assq 'vertical-scroll-bars
814 (frame-parameters))) nil))))
816 (defun menu-bar-no-scroll-bar ()
817 "Turn off scroll bars."
818 (interactive)
819 (customize-set-variable 'scroll-bar-mode nil))
821 (define-key menu-bar-showhide-menu [showhide-scroll-bar]
822 (list 'menu-item "Scroll-bar" menu-bar-showhide-scroll-bar-menu
823 :visible `(display-graphic-p)
824 :help "Select scroll-bar mode"))
826 (define-key menu-bar-showhide-menu [menu-bar-mode]
827 '(menu-item "Menu-bar" menu-bar-mode
828 :help "Toggle menu-bar on/off"
829 :button (:toggle . menu-bar-mode)))
831 (define-key menu-bar-showhide-menu [showhide-tool-bar]
832 (list 'menu-item "Tool-bar" 'tool-bar-mode
833 :help "Turn tool-bar on/off"
834 :visible `(display-graphic-p)
835 :button `(:toggle . tool-bar-mode)))
837 (define-key menu-bar-options-menu [showhide]
838 (list 'menu-item "Show/Hide" menu-bar-showhide-menu
839 :help "Toggle on/off various display features"))
841 (define-key menu-bar-options-menu [showhide-separator]
842 '("--"))
844 (define-key menu-bar-options-menu [mule]
845 ;; It is better not to use backquote here,
846 ;; because that makes a bootstrapping problem
847 ;; if you need to recompile all the Lisp files using interpreted code.
848 (list 'menu-item "Mule (Multilingual Environment)" mule-menu-keymap
849 ;; Most of the MULE menu actually does make sense in unibyte mode,
850 ;; e.g. language selection.
851 ;;; ':visible 'default-enable-multibyte-characters
852 ':help "Default language, encodings, input method"))
853 ;(setq menu-bar-final-items (cons 'mule menu-bar-final-items))
854 ;(define-key menu-bar-options-menu [preferences]
855 ; (list 'menu-item "Preferences" menu-bar-preferences-menu
856 ; :help "Toggle important global options"))
858 (define-key menu-bar-options-menu [mule-separator]
859 '("--"))
861 (define-key menu-bar-options-menu [debug-on-quit]
862 (menu-bar-make-toggle toggle-debug-on-quit debug-on-quit
863 "Enter Debugger on Quit/C-g" "Debug on Quit %s"
864 "Enter Lisp debugger when C-g is pressed"))
865 (define-key menu-bar-options-menu [debug-on-error]
866 (menu-bar-make-toggle toggle-debug-on-error debug-on-error
867 "Enter Debugger on Error" "Debug on Error %s"
868 "Enter Lisp debugger when an error is signaled"))
869 (define-key menu-bar-options-menu [debugger-separator]
870 '("--"))
871 (define-key menu-bar-options-menu [toggle-auto-compression]
872 '(menu-item "Automatic File De/compression"
873 auto-compression-mode
874 :help "Transparently decompress compressed files"
875 :button (:toggle . (rassq 'jka-compr-handler
876 file-name-handler-alist))))
878 (define-key menu-bar-options-menu [save-place]
879 (menu-bar-make-toggle toggle-save-place-globally save-place
880 "Save Place in Files between Sessions"
881 "Saving place in files %s"
882 "Visit files of previous session when restarting Emacs"
883 (require 'saveplace)
884 ;; Do it by name, to avoid a free-variable
885 ;; warning during byte compilation.
886 (set-default
887 'save-place (not (symbol-value 'save-place)))))
889 (define-key menu-bar-options-menu [uniquify]
890 (menu-bar-make-toggle toggle-uniquify-buffer-names uniquify-buffer-name-style
891 "Use Directory Names in Buffer Names"
892 "Directory name in buffer names (uniquify) %s"
893 "Uniquify buffer names by adding parent directory names"
894 (require 'uniquify)
895 (setq uniquify-buffer-name-style
896 (if (not uniquify-buffer-name-style)
897 'forward))))
899 (define-key menu-bar-options-menu [edit-options-separator]
900 '("--"))
901 (define-key menu-bar-options-menu [cua-mode]
902 (menu-bar-make-mm-toggle cua-mode
903 "C-x/C-c/C-v cut and paste (CUA)"
904 "Use C-z/C-x/C-c/C-v keys for undo/cut/copy/paste"))
906 (define-key menu-bar-options-menu [case-fold-search]
907 (menu-bar-make-toggle toggle-case-fold-search case-fold-search
908 "Case-Insensitive Search"
909 "Case-Insensitive Search %s"
910 "Ignore letter-case in search"))
912 (defun menu-bar-text-mode-auto-fill ()
913 (interactive)
914 (toggle-text-mode-auto-fill)
915 ;; This is somewhat questionable, as `text-mode-hook'
916 ;; might have changed outside customize.
917 ;; -- Per Abrahamsen <abraham@dina.kvl.dk> 2002-02-11.
918 (customize-mark-as-set 'text-mode-hook))
920 (define-key menu-bar-options-menu [auto-fill-mode]
921 '(menu-item "Word Wrap in Text Modes"
922 menu-bar-text-mode-auto-fill
923 :help "Automatically fill text between left and right margins (Auto Fill)"
924 :button (:toggle . (if (listp text-mode-hook)
925 (member 'turn-on-auto-fill text-mode-hook)
926 (eq 'turn-on-auto-fill text-mode-hook)))))
927 (define-key menu-bar-options-menu [truncate-lines]
928 '(menu-item "Truncate Long Lines in this Buffer"
929 toggle-truncate-lines
930 :help "Truncate long lines on the screen"
931 :button (:toggle . truncate-lines)))
933 (define-key menu-bar-options-menu [highlight-separator]
934 '("--"))
935 (define-key menu-bar-options-menu [highlight-paren-mode]
936 (menu-bar-make-mm-toggle show-paren-mode
937 "Paren Match Highlighting"
938 "Highlight matching/mismatched parentheses at cursor (Show Paren mode)"))
939 (define-key menu-bar-options-menu [transient-mark-mode]
940 (menu-bar-make-mm-toggle transient-mark-mode
941 "Active Region Highlighting"
942 "Make text in active region stand out in color (Transient Mark mode)"
943 (:enable (not cua-mode))))
944 (define-key menu-bar-options-menu [toggle-global-lazy-font-lock-mode]
945 (menu-bar-make-mm-toggle global-font-lock-mode
946 "Syntax Highlighting"
947 "Colorize text based on language syntax (Global Font Lock mode)"))
950 ;; The "Tools" menu items
952 (defun send-mail-item-name ()
953 (let* ((known-send-mail-commands '((sendmail-user-agent . "sendmail")
954 (mh-e-user-agent . "MH")
955 (message-user-agent . "Gnus Message")
956 (gnus-user-agent . "Gnus")))
957 (name (assq mail-user-agent known-send-mail-commands)))
958 (if name
959 (setq name (cdr name))
960 (setq name (symbol-name mail-user-agent))
961 (if (string-match "\\(.+\\)-user-agent" name)
962 (setq name (match-string 1 name))))
963 name))
965 (defun read-mail-item-name ()
966 (let* ((known-rmail-commands '((rmail . "RMAIL")
967 (mh-rmail . "MH")
968 (gnus . "Gnus")))
969 (known (assq read-mail-command known-rmail-commands)))
970 (if known (cdr known) (symbol-name read-mail-command))))
972 (defvar menu-bar-games-menu (make-sparse-keymap "Games"))
974 (define-key menu-bar-tools-menu [games]
975 (list 'menu-item "Games" menu-bar-games-menu))
977 (define-key menu-bar-tools-menu [separator-games]
978 '("--"))
980 (define-key menu-bar-games-menu [zone]
981 '(menu-item "Zone Out" zone
982 :help "Play tricks with Emacs display when Emacs is idle"))
983 (define-key menu-bar-games-menu [yow]
984 '(menu-item "Random Quotation" yow
985 :help "Display a random Zippy quotation"))
986 (define-key menu-bar-games-menu [tetris]
987 '(menu-item "Tetris" tetris))
988 (define-key menu-bar-games-menu [solitaire]
989 '(menu-item "Solitaire" solitaire))
990 (define-key menu-bar-games-menu [snake]
991 '(menu-item "Snake" snake
992 :help "Move snake around avoiding collisions"))
993 (define-key menu-bar-games-menu [mult]
994 '(menu-item "Multiplication Puzzle" mpuz
995 :help "Excercise brain with multiplication"))
996 (define-key menu-bar-games-menu [life]
997 '(menu-item "Life" life
998 :help "Watch how John Conway's cellular automaton evolves"))
999 (define-key menu-bar-games-menu [hanoi]
1000 '(menu-item "Towers of Hanoi" hanoi
1001 :help "Watch Towers-of-Hanoi puzzle solved by Emacs"))
1002 (define-key menu-bar-games-menu [gomoku]
1003 '(menu-item "Gomoku" gomoku
1004 :help "Mark 5 contiguous squares (like tic-tac-toe)"))
1005 (define-key menu-bar-games-menu [black-box]
1006 '(menu-item "Blackbox" blackbox
1007 :help "Find balls in a black box by shooting rays"))
1008 (define-key menu-bar-games-menu [adventure]
1009 '(menu-item "Adventure" dunnet
1010 :help "Dunnet, a text Adventure game for Emacs"))
1011 (define-key menu-bar-games-menu [5x5]
1012 '(menu-item "5x5" 5x5
1013 :help "Fill in all the squares on a 5x5 board"))
1015 (define-key menu-bar-tools-menu [simple-calculator]
1016 '(menu-item "Simple Calculator" calculator
1017 :help "Invoke the Emacs built-in quick calculator"))
1018 (define-key menu-bar-tools-menu [calc]
1019 '(menu-item "Programmable Calculator" calc
1020 :help "Invoke the Emacs built-in full scientific calculator"))
1021 (define-key menu-bar-tools-menu [calendar]
1022 '(menu-item "Display Calendar" calendar))
1024 (define-key menu-bar-tools-menu [separator-net]
1025 '("--"))
1027 (define-key menu-bar-tools-menu [directory-search]
1028 '(menu-item "Directory Search" eudc-tools-menu
1029 :help "Query directory servers via LDAP, CCSO PH/QI or BBDB"))
1030 (define-key menu-bar-tools-menu [compose-mail]
1031 (list
1032 'menu-item `(format "Send Mail (with %s)" (send-mail-item-name))
1033 'compose-mail
1034 :visible `(and mail-user-agent (not (eq mail-user-agent 'ignore)))
1035 :help "Send a mail message"))
1036 (define-key menu-bar-tools-menu [rmail]
1037 (list
1038 'menu-item `(format "Read Mail (with %s)" (read-mail-item-name))
1039 'menu-bar-read-mail
1040 :visible `(and read-mail-command (not (eq read-mail-command 'ignore)))
1041 :help "Read your mail and reply to it"))
1043 (defun menu-bar-read-mail ()
1044 "Read mail using `read-mail-command'."
1045 (interactive)
1046 (call-interactively read-mail-command))
1048 (define-key menu-bar-tools-menu [gnus]
1049 '(menu-item "Read Net News (Gnus)" gnus
1050 :help "Read network news groups"))
1052 (define-key menu-bar-tools-menu [separator-vc]
1053 '("--"))
1055 (defvar vc-menu-map (make-sparse-keymap "Version Control"))
1056 (define-key menu-bar-tools-menu [pcl-cvs]
1057 '(menu-item "PCL-CVS" cvs-global-menu
1058 :help "Module-level interface to CVS"))
1059 (define-key menu-bar-tools-menu [vc]
1060 (list 'menu-item "Version Control" vc-menu-map
1061 :help "Interface to RCS, CVS, SCCS"))
1063 (define-key menu-bar-tools-menu [separator-compare]
1064 '("--"))
1066 (define-key menu-bar-tools-menu [ediff-misc]
1067 '(menu-item "Ediff Miscellanea" menu-bar-ediff-misc-menu
1068 :help "Ediff manual, customization, sessions, etc."))
1069 (define-key menu-bar-tools-menu [epatch]
1070 '(menu-item "Apply Patch" menu-bar-epatch-menu))
1071 (define-key menu-bar-tools-menu [ediff-merge]
1072 '(menu-item "Merge" menu-bar-ediff-merge-menu
1073 :help "Merge different revisions of files/directories"))
1074 (define-key menu-bar-tools-menu [compare]
1075 '(menu-item "Compare (Ediff)" menu-bar-ediff-menu
1076 :help "Display differences between files/directories"))
1079 (define-key menu-bar-tools-menu [separator-spell]
1080 '("--"))
1082 (define-key menu-bar-tools-menu [spell]
1083 '(menu-item "Spell Checking" ispell-menu-map))
1085 (define-key menu-bar-tools-menu [separator-prog]
1086 '("--"))
1088 (define-key menu-bar-tools-menu [gdb]
1089 '(menu-item "Debugger (GDB)..." gdb
1090 :help "Debug a program from within Emacs with GDB"))
1091 (define-key menu-bar-tools-menu [shell-on-region]
1092 '(menu-item "Shell Command on Region..." shell-command-on-region
1093 :enable mark-active
1094 :help "Pass marked region to a shell command"))
1095 (define-key menu-bar-tools-menu [shell]
1096 '(menu-item "Shell Command..." shell-command
1097 :help "Invoke a shell command and catch its output"))
1098 (define-key menu-bar-tools-menu [compile]
1099 '(menu-item "Compile..." compile
1100 :help "Invoke compiler or Make, view compilation errors"))
1101 (define-key menu-bar-tools-menu [grep]
1102 '(menu-item "Search Files (with grep)..." grep
1103 :help "Search files for strings or regexps (with grep)"))
1106 ;; The "Help" menu items
1108 (defvar menu-bar-describe-menu (make-sparse-keymap "Describe"))
1110 (define-key menu-bar-describe-menu [mule-diag]
1111 '(menu-item "Show All of Mule Status" mule-diag
1112 :visible default-enable-multibyte-characters
1113 :help "Display multilingual environment settings"))
1114 (define-key menu-bar-describe-menu [describe-coding-system-briefly]
1115 '(menu-item "Describe Coding System (Briefly)..."
1116 describe-current-coding-system-briefly
1117 :visible default-enable-multibyte-characters))
1118 (define-key menu-bar-describe-menu [describe-coding-system]
1119 '(menu-item "Describe Coding System..." describe-coding-system
1120 :visible default-enable-multibyte-characters))
1121 (define-key menu-bar-describe-menu [describe-input-method]
1122 '(menu-item "Describe Input Method..." describe-input-method
1123 :visible default-enable-multibyte-characters
1124 :help "Keyboard layout for specific input method"))
1125 (define-key menu-bar-describe-menu [describe-language-environment]
1126 (list 'menu-item "Describe Language Environment"
1127 describe-language-environment-map
1128 :help "Show multilingual settings for a specific language"))
1130 (define-key menu-bar-describe-menu [separator-desc-mule]
1131 '("--"))
1133 (define-key menu-bar-describe-menu [list-keybindings]
1134 '(menu-item "List Key Bindings" describe-bindings
1135 :help "Display a list of all current keybindings"))
1136 (define-key menu-bar-describe-menu [describe-current-display-table]
1137 '(menu-item "Describe Display Table" describe-current-display-table
1138 :help "Describe the current display table"))
1139 (define-key menu-bar-describe-menu [describe-face]
1140 '(menu-item "Describe Face..." describe-face
1141 :help "Display the properties of a face"))
1142 (define-key menu-bar-describe-menu [describe-variable]
1143 '(menu-item "Describe Variable..." describe-variable
1144 :help "Display documentation of variable/option"))
1145 (define-key menu-bar-describe-menu [describe-function]
1146 '(menu-item "Describe Function..." describe-function
1147 :help "Display documentation of function/command"))
1148 (define-key menu-bar-describe-menu [describe-key-1]
1149 '(menu-item "Describe Key..." describe-key
1150 ;; Users typically don't identify keys and menu items...
1151 :help "Display documentation of command bound to a \
1152 key (or menu-item)"))
1153 (define-key menu-bar-describe-menu [describe-key]
1154 '(menu-item "What's This? " describe-key
1155 ;; Users typically don't identify keys and menu items...
1156 :help "Display documentation of command bound to a \
1157 key (or menu-item)"))
1158 (define-key menu-bar-describe-menu [describe-mode]
1159 '(menu-item "Describe Buffer Modes" describe-mode
1160 :help "Describe this buffer's major and minor mode"))
1162 (defvar menu-bar-apropos-menu (make-sparse-keymap "Apropos"))
1163 (defun menu-bar-read-lispref ()
1164 "Display the Emacs Lisp Reference manual in Info mode."
1165 (interactive)
1166 (info "elisp"))
1168 (defun menu-bar-read-lispintro ()
1169 "Display the Introduction to Emacs Lisp Programming in Info mode."
1170 (interactive)
1171 (info "eintr"))
1173 (defun search-emacs-glossary ()
1174 "Display the Glossary node of the Emacs manual in Info mode."
1175 (interactive)
1176 (info "(emacs)Glossary"))
1178 (defun emacs-index-search (topic)
1179 "Look up TOPIC in the indices of the Emacs User Manual."
1180 (interactive "sSubject to look up: ")
1181 (info "emacs")
1182 (Info-index topic))
1184 (defun elisp-index-search (topic)
1185 "Look up TOPIC in the indices of the Emacs Lisp Reference Manual."
1186 (interactive "sSubject to look up: ")
1187 (info "elisp")
1188 (Info-index topic))
1190 (define-key menu-bar-apropos-menu [apropos-documentation]
1191 '(menu-item "Search Documentation Strings..." apropos-documentation
1192 :help
1193 "Find functions and variables whose doc strings match a regexp"))
1194 (define-key menu-bar-apropos-menu [apropos]
1195 '(menu-item "Find Any Object by Name..." apropos
1196 :help "Find symbols of any kind whose names match a regexp"))
1197 (define-key menu-bar-apropos-menu [apropos-value]
1198 '(menu-item "Find Options by Value..." apropos-value
1199 :help "Find variables whose values match a regexp"))
1200 (define-key menu-bar-apropos-menu [apropos-variables]
1201 '(menu-item "Find Options by Name..." apropos-variable
1202 :help "Find variables whose names match a regexp"))
1203 (define-key menu-bar-apropos-menu [apropos-commands]
1204 '(menu-item "Find Commands by Name..." apropos-command
1205 :help "Find commands whose names match a regexp"))
1206 (define-key menu-bar-apropos-menu [sep1]
1207 '("--"))
1208 (define-key menu-bar-apropos-menu [elisp-index-search]
1209 '(menu-item "Look Up Subject in ELisp Manual..." elisp-index-search
1210 :help "Find description of a subject in Emacs Lisp manual"))
1211 (define-key menu-bar-apropos-menu [emacs-index-search]
1212 '(menu-item "Look Up Subject in User Manual..." emacs-index-search
1213 :help "Find description of a subject in Emacs User manual"))
1214 (define-key menu-bar-apropos-menu [emacs-glossary]
1215 '(menu-item "Emacs Terminology" search-emacs-glossary
1216 :help "Display the Glossary section of the Emacs manual"))
1218 (defvar menu-bar-manuals-menu (make-sparse-keymap "More Manuals"))
1220 (define-key menu-bar-manuals-menu [man]
1221 '(menu-item "Read Man Page..." manual-entry
1222 :help "Man-page docs for external commands and libraries"))
1223 (define-key menu-bar-manuals-menu [sep2]
1224 '("--"))
1225 (define-key menu-bar-manuals-menu [order-emacs-manuals]
1226 '(menu-item "Ordering Manuals" view-order-manuals
1227 :help "How to order manuals from the Free Software Foundation"))
1228 (define-key menu-bar-manuals-menu [info]
1229 '(menu-item "All Other Manuals (Info)" Info-directory
1230 :help "Read any of the installed manuals"))
1231 (define-key menu-bar-manuals-menu [info-elisp]
1232 '(menu-item "Emacs Lisp Reference" menu-bar-read-lispref
1233 :help "Read the Emacs Lisp Reference manual"))
1234 (define-key menu-bar-manuals-menu [info-elintro]
1235 '(menu-item "Introduction to Emacs Lisp" menu-bar-read-lispintro
1236 :help "Read the Introduction to Emacs Lisp Programming"))
1237 (define-key menu-bar-manuals-menu [sep3]
1238 '("--"))
1239 (define-key menu-bar-manuals-menu [command]
1240 '(menu-item "Find Command in Manual" Info-goto-emacs-command-node
1241 :help "Display manual section that describes a command"))
1242 (define-key menu-bar-manuals-menu [key]
1243 '(menu-item "Find Key in Manual" Info-goto-emacs-key-command-node
1244 :help "Display manual section that describes a key"))
1246 (define-key menu-bar-help-menu [eliza]
1247 '(menu-item "Emacs Psychiatrist" doctor
1248 :help "Our doctor will help you feel better"))
1249 (define-key menu-bar-help-menu [sep4]
1250 '("--"))
1251 (define-key menu-bar-help-menu [describe-no-warranty]
1252 '(menu-item "(Non)Warranty" describe-no-warranty
1253 :help "Explain that Emacs has NO WARRANTY"))
1254 (define-key menu-bar-help-menu [describe-copying]
1255 '(menu-item "Copying Conditions" describe-copying
1256 :help "Show the Emacs license (GPL)"))
1257 (define-key menu-bar-help-menu [describe-distribution]
1258 '(menu-item "Getting New Versions" describe-distribution
1259 :help "How to get latest versions of Emacs"))
1260 (define-key menu-bar-help-menu [more]
1261 '(menu-item "Find Extra Packages"
1262 menu-bar-help-extra-packages
1263 :help "Where to find some extra packages and possible updates"))
1264 (defun menu-bar-help-extra-packages ()
1265 "Display help about some additional packages available for Emacs."
1266 (interactive)
1267 (let (enable-local-variables)
1268 (view-file (expand-file-name "MORE.STUFF"
1269 data-directory))
1270 (goto-address)))
1271 (define-key menu-bar-help-menu [about]
1272 '(menu-item "About Emacs" display-splash-screen
1273 :help "Display version number, copyright info, and basic help"))
1274 (define-key menu-bar-help-menu [sep2]
1275 '("--"))
1276 (define-key menu-bar-help-menu [finder-by-keyword]
1277 '(menu-item "Find Emacs Packages..." finder-by-keyword
1278 :help "Find packages and features by keyword"))
1279 (define-key menu-bar-help-menu [manuals]
1280 (list 'menu-item "More Manuals" menu-bar-manuals-menu
1281 :help "Search and browse on-line manuals"))
1282 (define-key menu-bar-help-menu [emacs-manual]
1283 '(menu-item "Read the Emacs Manual" info-emacs-manual
1284 :help "Full documentation of Emacs features"))
1285 (define-key menu-bar-help-menu [describe]
1286 (list 'menu-item "Describe" menu-bar-describe-menu
1287 :help "Describe commands, variables, keys"))
1288 (define-key menu-bar-help-menu [apropos]
1289 (list 'menu-item "Search Documentation" menu-bar-apropos-menu
1290 :help "Look up terms, find commands, options, etc. (Apropos)"))
1291 (define-key menu-bar-help-menu [sep1]
1292 '("--"))
1293 (define-key menu-bar-help-menu [report-emacs-bug]
1294 '(menu-item "Send Bug Report..." report-emacs-bug
1295 :help "Send e-mail to Emacs maintainers"))
1296 (define-key menu-bar-help-menu [emacs-problems]
1297 '(menu-item "Emacs Known Problems" view-emacs-problems))
1298 (define-key menu-bar-help-menu [emacs-news]
1299 '(menu-item "Emacs News" view-emacs-news
1300 :help "New features of this version"))
1301 (define-key menu-bar-help-menu [emacs-faq]
1302 '(menu-item "Emacs FAQ" view-emacs-FAQ))
1304 (defun help-with-tutorial-spec-language ()
1305 "Use the Emacs tutorial, specifying which language you want."
1306 (interactive)
1307 (help-with-tutorial t))
1309 (define-key menu-bar-help-menu [emacs-tutorial-language-specific]
1310 '(menu-item "Emacs Tutorial (choose language)..."
1311 help-with-tutorial-spec-language
1312 :help "Learn how to use Emacs (choose a language)"))
1313 (define-key menu-bar-help-menu [emacs-tutorial]
1314 '(menu-item "Emacs Tutorial" help-with-tutorial
1315 :help "Learn how to use Emacs"))
1317 (defun kill-this-buffer () ; for the menubar
1318 "Kill the current buffer."
1319 (interactive)
1320 (kill-buffer (current-buffer)))
1322 (defun kill-this-buffer-enabled-p ()
1323 (let ((count 0)
1324 (buffers (buffer-list)))
1325 (while buffers
1326 (or (string-match "^ " (buffer-name (car buffers)))
1327 (setq count (1+ count)))
1328 (setq buffers (cdr buffers)))
1329 (and (not (window-minibuffer-p (frame-selected-window menu-updating-frame)))
1330 (> count 1))))
1332 (put 'dired 'menu-enable
1333 '(not (window-minibuffer-p (frame-selected-window menu-updating-frame))))
1335 ;; Permit deleting frame if it would leave a visible or iconified frame.
1336 (defun delete-frame-enabled-p ()
1337 "Return non-nil if `delete-frame' should be enabled in the menu bar."
1338 (let ((frames (frame-list))
1339 (count 0))
1340 (while frames
1341 (if (frame-visible-p (car frames))
1342 (setq count (1+ count)))
1343 (setq frames (cdr frames)))
1344 (> count 1)))
1346 (defcustom yank-menu-length 20
1347 "*Maximum length to display in the yank-menu."
1348 :type 'integer
1349 :group 'mouse)
1351 (defun menu-bar-update-yank-menu (string old)
1352 (let ((front (car (cdr yank-menu)))
1353 (menu-string (if (<= (length string) yank-menu-length)
1354 string
1355 (concat
1356 (substring string 0 (/ yank-menu-length 2))
1357 "..."
1358 (substring string (- (/ yank-menu-length 2)))))))
1359 ;; Don't let the menu string be all dashes
1360 ;; because that has a special meaning in a menu.
1361 (if (string-match "\\`-+\\'" menu-string)
1362 (setq menu-string (concat menu-string " ")))
1363 ;; If we're supposed to be extending an existing string, and that
1364 ;; string really is at the front of the menu, then update it in place.
1365 (if (and old (or (eq old (car front))
1366 (string= old (car front))))
1367 (progn
1368 (setcar front string)
1369 (setcar (cdr front) menu-string))
1370 (setcdr yank-menu
1371 (cons
1372 (cons string (cons menu-string 'menu-bar-select-yank))
1373 (cdr yank-menu)))))
1374 (if (> (length (cdr yank-menu)) kill-ring-max)
1375 (setcdr (nthcdr kill-ring-max yank-menu) nil)))
1377 (put 'menu-bar-select-yank 'apropos-inhibit t)
1378 (defun menu-bar-select-yank ()
1379 (interactive "*")
1380 (push-mark (point))
1381 (insert last-command-event))
1384 (defcustom buffers-menu-show-directories 'unless-uniquify
1385 "If non-nil, show directories in the Buffers menu for buffers that have them.
1386 The special value `unless-uniquify' means that directories will be shown
1387 unless `uniquify-buffer-name-style' is non-nil (in which case, buffer
1388 names should include enough of a buffer's directory to distinguish it
1389 from other buffers).
1391 Setting this variable directly does not take effect until next time the
1392 Buffers menu is regenerated."
1393 :set (lambda (symbol value)
1394 (set symbol value)
1395 (menu-bar-update-buffers t))
1396 :initialize 'custom-initialize-default
1397 :type '(choice (const :tag "Never" nil)
1398 (const :tag "Unless uniquify is enabled" unless-uniquify)
1399 (const :tag "Always" t))
1400 :group 'menu)
1402 (defcustom buffers-menu-show-status t
1403 "If non-nil, show modified/read-only status of buffers in the Buffers menu.
1404 Setting this variable directly does not take effect until next time the
1405 Buffers menu is regenerated."
1406 :set (lambda (symbol value)
1407 (set symbol value)
1408 (menu-bar-update-buffers t))
1409 :initialize 'custom-initialize-default
1410 :type 'boolean
1411 :group 'menu)
1413 (defvar list-buffers-directory nil)
1415 (defvar menu-bar-update-buffers-maxbuf)
1417 (defun menu-bar-select-buffer ()
1418 (interactive)
1419 (switch-to-buffer last-command-event))
1421 (defun menu-bar-select-frame ()
1422 (interactive)
1423 (let (frame)
1424 (dolist (f (frame-list))
1425 (when (equal last-command-event (frame-parameter f 'name))
1426 (setq frame f)))
1427 (make-frame-visible frame)
1428 (raise-frame frame)
1429 (select-frame frame)))
1431 (defun menu-bar-update-buffers-1 (elt)
1432 (let* ((buf (car elt))
1433 (file
1434 (and (if (eq buffers-menu-show-directories 'unless-uniquify)
1435 (or (not (boundp 'uniquify-buffer-name-style))
1436 (null uniquify-buffer-name-style))
1437 buffers-menu-show-directories)
1438 (or (buffer-file-name buf)
1439 (buffer-local-value 'list-buffers-directory buf)))))
1440 (when file
1441 (setq file (file-name-directory file)))
1442 (when (and file (> (length file) 20))
1443 (setq file (concat "..." (substring file -17))))
1444 (cons (if buffers-menu-show-status
1445 (let ((mod (if (buffer-modified-p buf) "*" ""))
1446 (ro (if (buffer-local-value 'buffer-read-only buf) "%" "")))
1447 (if file
1448 (format "%s %s%s -- %s" (cdr elt) mod ro file)
1449 (format "%s %s%s" (cdr elt) mod ro)))
1450 (if file
1451 (format "%s -- %s" (cdr elt) file)
1452 (cdr elt)))
1453 buf)))
1455 ;; Used to cache the menu entries for commands in the Buffers menu
1456 (defvar menu-bar-buffers-menu-command-entries nil)
1458 (defun menu-bar-update-buffers (&optional force)
1459 ;; If user discards the Buffers item, play along.
1460 (and (lookup-key (current-global-map) [menu-bar buffer])
1461 (or force (frame-or-buffer-changed-p))
1462 (let ((buffers (buffer-list))
1463 (frames (frame-list))
1464 buffers-menu frames-menu)
1465 ;; If requested, list only the N most recently selected buffers.
1466 (if (and (integerp buffers-menu-max-size)
1467 (> buffers-menu-max-size 1))
1468 (if (> (length buffers) buffers-menu-max-size)
1469 (setcdr (nthcdr buffers-menu-max-size buffers) nil)))
1471 ;; Make the menu of buffers proper.
1472 (setq buffers-menu
1473 (let* ((buffer-list
1474 (mapcar 'list buffers))
1475 (menu-bar-update-buffers-maxbuf 0)
1476 alist)
1477 ;; Put into each element of buffer-list
1478 ;; the name for actual display,
1479 ;; perhaps truncated in the middle.
1480 (dolist (buf buffer-list)
1481 (let ((name (buffer-name (car buf))))
1482 (setcdr buf
1483 (if (> (length name) 27)
1484 (concat (substring name 0 12)
1485 "..."
1486 (substring name -12))
1487 name))))
1488 ;; Compute the maximum length of any name.
1489 (dolist (buf buffer-list)
1490 (unless (eq ?\ (aref (cdr buf) 0))
1491 (setq menu-bar-update-buffers-maxbuf
1492 (max menu-bar-update-buffers-maxbuf
1493 (length (cdr buf))))))
1494 ;; Set ALIST to an alist of the form
1495 ;; ITEM-STRING . BUFFER
1496 (dolist (buf buffer-list)
1497 (unless (eq ?\ (aref (cdr buf) 0))
1498 (push (menu-bar-update-buffers-1 buf) alist)))
1499 ;; Now make the actual list of items, and add
1500 ;; some miscellaneous buffer commands to the end.
1501 (mapcar (lambda (pair)
1502 ;; This is somewhat risque, to use
1503 ;; the buffer name itself as the event
1504 ;; type to define, but it works.
1505 ;; It would not work to use the buffer
1506 ;; since a buffer as an event has its
1507 ;; own meaning.
1508 (nconc (list (buffer-name (cdr pair))
1509 (car pair)
1510 (cons nil nil))
1511 'menu-bar-select-buffer))
1512 (nreverse alist))))
1514 ;; Make a Frames menu if we have more than one frame.
1515 (when (cdr frames)
1516 (let ((frames-menu
1517 (cons 'keymap
1518 (cons "Select Frame"
1519 (mapcar
1520 (lambda (frame)
1521 (nconc
1522 (list (frame-parameter frame 'name)
1523 (frame-parameter frame 'name)
1524 (cons nil nil))
1525 'menu-bar-select-frame))
1526 frames)))))
1527 ;; Put it after the normal buffers
1528 (setq buffers-menu
1529 (nconc buffers-menu
1530 `((frames-separator "--")
1531 (frames menu-item "Frames" ,frames-menu))))))
1533 ;; Add in some normal commands at the end of the menu. We use
1534 ;; the copy cached in `menu-bar-buffers-menu-command-entries'
1535 ;; if it's been set already. Note that we can't use constant
1536 ;; lists for the menu-entries, because the low-level menu-code
1537 ;; modifies them.
1538 (unless menu-bar-buffers-menu-command-entries
1539 (setq menu-bar-buffers-menu-command-entries
1540 (list '(command-separator "--")
1541 (list 'next-buffer
1542 'menu-item
1543 "Next Buffer"
1544 'next-buffer
1545 :help "Switch to the \"next\" buffer in a cyclic order")
1546 (list 'prev-buffer
1547 'menu-item
1548 "Previous Buffer"
1549 'prev-buffer
1550 :help "Switch to the \"previous\" buffer in a cyclic order")
1551 (list 'select-named-buffer
1552 'menu-item
1553 "Select Named Buffer..."
1554 'switch-to-buffer
1555 :help "Prompt for a buffer name, and select that buffer in the current window")
1556 (list 'list-all-buffers
1557 'menu-item
1558 "List All Buffers"
1559 'list-buffers
1560 :help "Pop up a window listing all emacs buffers"
1561 ))))
1562 (setq buffers-menu
1563 (nconc buffers-menu menu-bar-buffers-menu-command-entries))
1565 (setq buffers-menu (cons 'keymap (cons "Select Buffer" buffers-menu)))
1566 (define-key (current-global-map) [menu-bar buffer]
1567 ;; Call copy-sequence so the string is not pure.
1568 (cons (copy-sequence "Buffers") buffers-menu)))))
1570 (add-hook 'menu-bar-update-hook 'menu-bar-update-buffers)
1572 (menu-bar-update-buffers)
1574 ;; this version is too slow
1575 ;;(defun format-buffers-menu-line (buffer)
1576 ;; "Returns a string to represent the given buffer in the Buffer menu.
1577 ;;nil means the buffer shouldn't be listed. You can redefine this."
1578 ;; (if (string-match "\\` " (buffer-name buffer))
1579 ;; nil
1580 ;; (save-excursion
1581 ;; (set-buffer buffer)
1582 ;; (let ((size (buffer-size)))
1583 ;; (format "%s%s %-19s %6s %-15s %s"
1584 ;; (if (buffer-modified-p) "*" " ")
1585 ;; (if buffer-read-only "%" " ")
1586 ;; (buffer-name)
1587 ;; size
1588 ;; mode-name
1589 ;; (or (buffer-file-name) ""))))))
1591 ;;; Set up a menu bar menu for the minibuffer.
1593 (dolist (map (list minibuffer-local-map
1594 ;; This shouldn't be necessary, but there's a funny
1595 ;; bug in keymap.c that I don't understand yet. -stef
1596 minibuffer-local-completion-map))
1597 (define-key map [menu-bar minibuf]
1598 (cons "Minibuf" (make-sparse-keymap "Minibuf"))))
1600 (let ((map minibuffer-local-completion-map))
1601 (define-key map [menu-bar minibuf ?\?]
1602 (list 'menu-item "List Completions" 'minibuffer-completion-help
1603 :help "Display all possible completions"))
1604 (define-key map [menu-bar minibuf space]
1605 (list 'menu-item "Complete Word" 'minibuffer-complete-word
1606 :help "Complete at most one word"))
1607 (define-key map [menu-bar minibuf tab]
1608 (list 'menu-item "Complete" 'minibuffer-complete
1609 :help "Complete as far as possible")))
1611 (let ((map minibuffer-local-map))
1612 (define-key map [menu-bar minibuf quit]
1613 (list 'menu-item "Quit" 'keyboard-escape-quit
1614 :help "Abort input and exit minibuffer"))
1615 (define-key map [menu-bar minibuf return]
1616 (list 'menu-item "Enter" 'exit-minibuffer
1617 :help "Terminate input and exit minibuffer")))
1619 ;;;###autoload
1620 ;; This comment is taken from toolbar/tool-bar.el near
1621 ;; (put 'tool-bar-mode ...)
1622 ;; We want to pretend the menu bar by standard is on, as this will make
1623 ;; customize consider disabling the menu bar a customization, and save
1624 ;; that. We could do this for real by setting :init-value below, but
1625 ;; that would overwrite disabling the tool bar from X resources.
1626 (put 'menu-bar-mode 'standard-value '(t))
1628 ;;;###autoload
1629 (define-minor-mode menu-bar-mode
1630 "Toggle display of a menu bar on each frame.
1631 This command applies to all frames that exist and frames to be
1632 created in the future.
1633 With a numeric argument, if the argument is positive,
1634 turn on menu bars; otherwise, turn off menu bars."
1635 :init-value nil
1636 :global t
1637 :group 'frames
1638 ;; Make menu-bar-mode and default-frame-alist consistent.
1639 (let ((lines (if menu-bar-mode 1 0)))
1640 ;; Alter existing frames...
1641 (mapc (lambda (frame)
1642 (modify-frame-parameters frame
1643 (list (cons 'menu-bar-lines lines))))
1644 (frame-list))
1645 ;; ...and future ones.
1646 (let ((elt (assq 'menu-bar-lines default-frame-alist)))
1647 (if elt
1648 (setcdr elt lines)
1649 (add-to-list 'default-frame-alist (cons 'menu-bar-lines lines)))))
1651 ;; Make the message appear when Emacs is idle. We can not call message
1652 ;; directly. The minor-mode message "Menu-bar mode disabled" comes
1653 ;; after this function returns, overwriting any message we do here.
1654 (when (and (interactive-p) (not menu-bar-mode))
1655 (run-with-idle-timer 0 nil 'message
1656 "Menu-bar mode disabled. Use M-x menu-bar-mode to make the menu bar appear."))
1657 menu-bar-mode)
1659 (provide 'menu-bar)
1661 ;;; arch-tag: 6e6a3c22-4ec4-4d3d-8190-583f8ef94ced
1662 ;;; menu-bar.el ends here