*** empty log message ***
[emacs.git] / lisp / menu-bar.el
blob8201335a4e636b0e5191cc460a79e8e4f38447c1
1 ;;; menu-bar.el --- define a default menu bar
3 ;; Copyright (C) 1993, 1994, 1995, 2000, 2001, 2002 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-files-menu (make-sparse-keymap "File"))
67 (define-key global-map [menu-bar files] (cons "File" menu-bar-files-menu))
69 ;; This alias is for compatibility with 19.28 and before.
70 (defvar menu-bar-file-menu menu-bar-files-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-files-menu [exit-emacs]
78 '(menu-item "Exit Emacs" save-buffers-kill-emacs
79 :help "Save unsaved buffers, then exit"))
81 (define-key menu-bar-files-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-files-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-files-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-files-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-files-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-files-menu [split-window]
106 '(menu-item "Split Window" split-window-vertically
107 :help "Split selected window in two"))
109 (define-key menu-bar-files-menu [separator-window]
110 '(menu-item "--"))
112 (define-key menu-bar-files-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-files-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-files-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-files-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-files-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-files-menu [print-buffer]
131 '(menu-item "Print Buffer" print-buffer
132 :help "Print current buffer with page headings"))
134 (define-key menu-bar-files-menu [separator-print]
135 '(menu-item "--"))
137 (define-key menu-bar-files-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-files-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-name)
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-files-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-files-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-files-menu [separator-save]
174 '(menu-item "--"))
176 (define-key menu-bar-files-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-files-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-files-menu [dired]
186 '(menu-item "Open Directory..." dired
187 :help "Read a directory, operate on its files"))
188 (define-key menu-bar-files-menu [open-file]
189 '(menu-item "Open File..." find-file
190 :enable (not (window-minibuffer-p
191 (frame-selected-window menu-updating-frame)))
192 :help "Read a file into an Emacs buffer"))
195 ;; The "Edit" menu items
196 (defun nonincremental-search-forward (string)
197 "Read a string and search for it nonincrementally."
198 (interactive "sSearch for string: ")
199 (if (equal string "")
200 (search-forward (car search-ring))
201 (isearch-update-ring string nil)
202 (search-forward string)))
204 (defun nonincremental-search-backward (string)
205 "Read a string and search backward for it nonincrementally."
206 (interactive "sSearch for string: ")
207 (if (equal string "")
208 (search-backward (car search-ring))
209 (isearch-update-ring string nil)
210 (search-backward string)))
212 (defun nonincremental-re-search-forward (string)
213 "Read a regular expression and search for it nonincrementally."
214 (interactive "sSearch for regexp: ")
215 (if (equal string "")
216 (re-search-forward (car regexp-search-ring))
217 (isearch-update-ring string t)
218 (re-search-forward string)))
220 (defun nonincremental-re-search-backward (string)
221 "Read a regular expression and search backward for it nonincrementally."
222 (interactive "sSearch for regexp: ")
223 (if (equal string "")
224 (re-search-backward (car regexp-search-ring))
225 (isearch-update-ring string t)
226 (re-search-backward string)))
228 (defun nonincremental-repeat-search-forward ()
229 "Search forward for the previous search string."
230 (interactive)
231 (if (null search-ring)
232 (error "No previous search"))
233 (search-forward (car search-ring)))
235 (defun nonincremental-repeat-search-backward ()
236 "Search backward for the previous search string."
237 (interactive)
238 (if (null search-ring)
239 (error "No previous search"))
240 (search-backward (car search-ring)))
242 (defun nonincremental-repeat-re-search-forward ()
243 "Search forward for the previous regular expression."
244 (interactive)
245 (if (null regexp-search-ring)
246 (error "No previous search"))
247 (re-search-forward (car regexp-search-ring)))
249 (defun nonincremental-repeat-re-search-backward ()
250 "Search backward for the previous regular expression."
251 (interactive)
252 (if (null regexp-search-ring)
253 (error "No previous search"))
254 (re-search-backward (car regexp-search-ring)))
256 (defvar menu-bar-search-menu (make-sparse-keymap "Search"))
257 (defvar menu-bar-adv-search-menu
258 (make-sparse-keymap "Advanced Search/Replace"))
260 (define-key menu-bar-adv-search-menu [tags-continue]
261 '(menu-item "Continue Tags Search/Replace" tags-loop-continue
262 :help "Continue last tags search/replace operation"))
263 (define-key menu-bar-adv-search-menu [tags-repl]
264 '(menu-item "Replace in all tagged files" tags-query-replace
265 :help "Interactively replace a regexp in all tagged files"))
266 (define-key menu-bar-adv-search-menu [tags-srch]
267 '(menu-item "Search in all tagged files" tags-search
268 :help "Search for a regexp in all tagged files"))
270 (define-key menu-bar-adv-search-menu [separator-tag-search]
271 '(menu-item "--"))
273 (define-key menu-bar-adv-search-menu [query-replace-regexp]
274 '(menu-item "Replace Regexp..." query-replace-regexp
275 :enable (not buffer-read-only)
276 :help "Replace regular expression, ask about each occurrence"))
277 (define-key menu-bar-adv-search-menu [repeat-regexp-back]
278 '(menu-item "Repeat Regexp Backwards"
279 nonincremental-repeat-re-search-backward
280 :enable regexp-search-ring
281 :help "Repeat last regular expression search backwards"))
282 (define-key menu-bar-adv-search-menu [repeat-regexp-fwd]
283 '(menu-item "Repeat Regexp" nonincremental-repeat-re-search-forward
284 :enable regexp-search-ring
285 :help "Repeat last regular expression search forward"))
286 (define-key menu-bar-adv-search-menu [re-search-backward]
287 '(menu-item "Search Regexp Backwards..." nonincremental-re-search-backward
288 :help "Search backwards for a regular expression"))
289 (define-key menu-bar-adv-search-menu [re-search-forward]
290 '(menu-item "Search Regexp..." nonincremental-re-search-forward
291 :help "Search forward for a regular expression"))
292 (define-key menu-bar-adv-search-menu [separator-tag-isearch]
293 '(menu-item "--"))
294 (define-key menu-bar-adv-search-menu [isearch-backward]
295 '(menu-item "Incremental Search Backwards..." isearch-backward
296 :help "Search backwards for a string as you type it"))
297 (define-key menu-bar-adv-search-menu [isearch-forward]
298 '(menu-item "Incremental Search..." isearch-forward
299 :help "Search forward for a string as you type it"))
300 (define-key menu-bar-search-menu [re-search]
301 (list 'menu-item "Advanced Search/Replace" menu-bar-adv-search-menu
302 :help "Regexp and Tags search and replace"))
304 (define-key menu-bar-search-menu [query-replace]
305 '(menu-item "Replace..." query-replace
306 :enable (not buffer-read-only)
307 :help "Replace string interactively, ask about each occurrence"))
308 (define-key menu-bar-search-menu [repeat-search-back]
309 '(menu-item "Repeat Backwards" nonincremental-repeat-search-backward
310 :enable search-ring
311 :help "Repeat last search backwards"))
312 (define-key menu-bar-search-menu [repeat-search-fwd]
313 '(menu-item "Repeat Search" nonincremental-repeat-search-forward
314 :enable search-ring
315 :help "Repeat last search forward"))
316 (define-key menu-bar-search-menu [search-backward]
317 '(menu-item "Search Backwards..." nonincremental-search-backward
318 :help "Search backwards for a string"))
319 (define-key menu-bar-search-menu [search-forward]
320 '(menu-item "Search..." nonincremental-search-forward
321 :help "Search forward for a string"))
323 ;;; Assemble the top-level Edit menu items.
324 (define-key menu-bar-edit-menu [props]
325 '(menu-item "Text Properties" facemenu-menu
326 :help "Change properties of text in region"))
328 (define-key menu-bar-edit-menu [fill]
329 '(menu-item "Fill" fill-region
330 :enable (and mark-active (not buffer-read-only))
331 :help
332 "Fill text in region to fit between left and right margin"))
334 (define-key menu-bar-edit-menu [separator-bookmark]
335 '(menu-item "--"))
337 (define-key menu-bar-edit-menu [bookmark]
338 '(menu-item "Bookmarks" menu-bar-bookmark-map
339 :help "Record positions and jump between them"))
341 (defvar menu-bar-goto-menu (make-sparse-keymap "Go To"))
343 (define-key menu-bar-goto-menu [set-tags-name]
344 '(menu-item "Set Tags File Name" visit-tags-table
345 :help "Tell Tags commands which tag table file to use"))
347 (define-key menu-bar-goto-menu [separator-tag-file]
348 '(menu-item "--"))
350 (define-key menu-bar-goto-menu [apropos-tags]
351 '(menu-item "Tags Apropos" tags-apropos
352 :help "Find function/variables whose names match regexp"))
353 (define-key menu-bar-goto-menu [next-tag-otherw]
354 '(menu-item "Next Tag in Other Window"
355 (lambda () (interactive) (find-tag-other-window nil t))
356 :enable (and (boundp 'tags-location-ring)
357 (not (ring-empty-p tags-location-ring)))
358 :help "Find next function/variable matching last tag name in another window"))
359 (define-key menu-bar-goto-menu [next-tag]
360 '(menu-item "Find Next Tag"
361 (lambda () (interactive) (find-tag nil t))
362 :enable (and (boundp 'tags-location-ring)
363 (not (ring-empty-p tags-location-ring)))
364 :help "Find next function/variable matching last tag name"))
365 (define-key menu-bar-goto-menu [find-tag-otherw]
366 '(menu-item "Find Tag in Other Window..." find-tag-other-window
367 :help "Find function/variable definition in another window"))
368 (define-key menu-bar-goto-menu [find-tag]
369 '(menu-item "Find Tag..." find-tag
370 :help "Find definition of function or variable"))
372 (define-key menu-bar-goto-menu [separator-tags]
373 '(menu-item "--"))
375 (define-key menu-bar-goto-menu [end-of-buf]
376 '(menu-item "Goto End of Buffer" end-of-buffer))
377 (define-key menu-bar-goto-menu [beg-of-buf]
378 '(menu-item "Goto Beginning of Buffer" beginning-of-buffer))
379 (define-key menu-bar-goto-menu [go-to-pos]
380 '(menu-item "Goto Buffer Position..." goto-char
381 :help "Read a number N and go to buffer position N"))
382 (define-key menu-bar-goto-menu [go-to-line]
383 '(menu-item "Goto Line..." goto-line
384 :help "Read a line number and go to that line"))
386 (define-key menu-bar-edit-menu [goto]
387 (list 'menu-item "Go To" menu-bar-goto-menu))
389 (define-key menu-bar-edit-menu [search]
390 (list 'menu-item "Search" menu-bar-search-menu))
392 (define-key menu-bar-edit-menu [separator-search]
393 '(menu-item "--"))
395 (define-key menu-bar-edit-menu [mark-whole-buffer]
396 '(menu-item "Select All" mark-whole-buffer
397 :help "Mark the whole buffer for a subsequent cut/copy."))
398 (define-key menu-bar-edit-menu [clear]
399 '(menu-item "Clear" delete-region
400 :enable (and mark-active
401 (not buffer-read-only)
402 (not (mouse-region-match)))
403 :help
404 "Delete the text in region between mark and current position"))
405 (defvar yank-menu (cons "Select Yank" nil))
406 (fset 'yank-menu (cons 'keymap yank-menu))
407 (define-key menu-bar-edit-menu [select-paste]
408 '(menu-item "Select and Paste" yank-menu
409 :enable (and (cdr yank-menu) (not buffer-read-only))
410 :help "Paste (yank) text cut or copied earlier"))
411 (define-key menu-bar-edit-menu [paste]
412 '(menu-item "Paste" yank
413 :enable (and
414 ;; Emacs compiled --without-x doesn't have
415 ;; x-selection-exists-p.
416 (fboundp 'x-selection-exists-p)
417 (x-selection-exists-p) (not buffer-read-only))
418 :help "Paste (yank) text most recently cut/copied"))
419 (define-key menu-bar-edit-menu [copy]
420 '(menu-item "Copy" menu-bar-kill-ring-save
421 :enable mark-active
422 :help "Copy text in region between mark and current position"
423 :keys "\\[kill-ring-save]"))
424 (define-key menu-bar-edit-menu [cut]
425 '(menu-item "Cut" kill-region
426 :enable (and mark-active (not buffer-read-only))
427 :help
428 "Cut (kill) text in region between mark and current position"))
429 (define-key menu-bar-edit-menu [undo]
430 '(menu-item "Undo" undo
431 :enable (and (not buffer-read-only)
432 (not (eq t buffer-undo-list))
433 (if (eq last-command 'undo)
434 pending-undo-list
435 (consp buffer-undo-list)))
436 :help "Undo last operation"))
439 (defun menu-bar-kill-ring-save (beg end)
440 (interactive "r")
441 (if (mouse-region-match)
442 (message "Selecting a region with the mouse does `copy' automatically")
443 (kill-ring-save beg end)))
445 (autoload 'ispell-menu-map "ispell" nil t 'keymap)
447 ;; These are alternative definitions for the cut, paste and copy
448 ;; menu items. Use them if your system expects these to use the clipboard.
450 (put 'clipboard-kill-region 'menu-enable 'mark-active)
451 (put 'clipboard-kill-ring-save 'menu-enable 'mark-active)
452 (put 'clipboard-yank 'menu-enable
453 '(or (and (fboundp 'x-selection-exists-p) (x-selection-exists-p))
454 (x-selection-exists-p 'CLIPBOARD)))
456 (defun clipboard-yank ()
457 "Insert the clipboard contents, or the last stretch of killed text."
458 (interactive)
459 (let ((x-select-enable-clipboard t))
460 (yank)))
462 (defun clipboard-kill-ring-save (beg end)
463 "Copy region to kill ring, and save in the X clipboard."
464 (interactive "r")
465 (let ((x-select-enable-clipboard t))
466 (kill-ring-save beg end)))
468 (defun clipboard-kill-region (beg end)
469 "Kill the region, and save it in the X clipboard."
470 (interactive "r")
471 (let ((x-select-enable-clipboard t))
472 (kill-region beg end)))
474 (defun menu-bar-enable-clipboard ()
475 "Make CUT, PASTE and COPY (keys and menu bar items) use the clipboard.
476 Do the same for the keys of the same name."
477 (interactive)
478 ;; We can't use constant list structure here because it becomes pure,
479 ;; and because it gets modified with cache data.
480 (define-key menu-bar-edit-menu [paste]
481 (cons "Paste" (cons "Paste text from clipboard" 'clipboard-yank)))
482 (define-key menu-bar-edit-menu [copy]
483 (cons "Copy" (cons "Copy text in region to the clipboard"
484 'clipboard-kill-ring-save)))
485 (define-key menu-bar-edit-menu [cut]
486 (cons "Cut" (cons "Delete text in region and copy it to the clipboard"
487 'clipboard-kill-region)))
489 (define-key global-map [f20] 'clipboard-kill-region)
490 (define-key global-map [f16] 'clipboard-kill-ring-save)
491 (define-key global-map [f18] 'clipboard-yank)
492 ;; X11R6 versions
493 (define-key global-map [cut] 'clipboard-kill-region)
494 (define-key global-map [copy] 'clipboard-kill-ring-save)
495 (define-key global-map [paste] 'clipboard-yank))
497 ;; The "Options" menu items
499 (defvar menu-bar-custom-menu (make-sparse-keymap "Customize"))
501 (define-key menu-bar-custom-menu [customize-apropos-groups]
502 '(menu-item "Groups Matching Regexp..." customize-apropos-groups
503 :help "Browse groups whose names match regexp"))
504 (define-key menu-bar-custom-menu [customize-apropos-faces]
505 '(menu-item "Faces Matching Regexp..." customize-apropos-faces
506 :help "Browse faces whose names match regexp"))
507 (define-key menu-bar-custom-menu [customize-apropos-options]
508 '(menu-item "Options Matching Regexp..." customize-apropos-options
509 :help "Browse options whose names match regexp"))
510 (define-key menu-bar-custom-menu [customize-apropos]
511 '(menu-item "Settings Matching Regexp..." customize-apropos
512 :help "Browse customizable settings whose names match regexp"))
513 (define-key menu-bar-custom-menu [separator-1]
514 '("--"))
515 (define-key menu-bar-custom-menu [customize-group]
516 '(menu-item "Specific Group..." customize-group
517 :help "Customize settings of specific group"))
518 (define-key menu-bar-custom-menu [customize-face]
519 '(menu-item "Specific Face..." customize-face
520 :help "Customize attributes of specific face"))
521 (define-key menu-bar-custom-menu [customize-option]
522 '(menu-item "Specific Option..." customize-option
523 :help "Customize value of specific option"))
524 (define-key menu-bar-custom-menu [separator-2]
525 '("--"))
526 (define-key menu-bar-custom-menu [customize-changed-options]
527 '(menu-item "New Options..." customize-changed-options
528 :help "Options added or changed in recent Emacs versions"))
529 (define-key menu-bar-custom-menu [customize-saved]
530 '(menu-item "Saved Options" customize-saved
531 :help "Customize previously saved options"))
532 (define-key menu-bar-custom-menu [separator-3]
533 '("--"))
534 (define-key menu-bar-custom-menu [customize-browse]
535 '(menu-item "Browse Customization Groups" customize-browse
536 :help "Browse all customization groups"))
537 (define-key menu-bar-custom-menu [customize]
538 '(menu-item "Top-level Customization Group" customize
539 :help "The master group called `Emacs'"))
541 ;(defvar menu-bar-preferences-menu (make-sparse-keymap "Preferences"))
543 (defmacro menu-bar-make-toggle (name variable doc message help &optional props &rest body)
544 `(progn
545 (defun ,name ()
546 ,(concat "Toggle whether to " (downcase (substring help 0 1))
547 (substring help 1) ".")
548 (interactive)
549 (if ,(if body `(progn . ,body)
550 `(progn
551 (custom-load-symbol ',variable)
552 (let ((set (or (get ',variable 'custom-set) 'set-default))
553 (get (or (get ',variable 'custom-get) 'default-value)))
554 (funcall set ',variable (not (funcall get ',variable))))))
555 (message ,message "enabled")
556 (message ,message "disabled")))
557 ;; The function `customize-mark-as-set' must only be called when
558 ;; a variable is set interactively, as the purpose is to mark it
559 ;; as a candidate for "Save Options", and we do not want to save
560 ;; options the user have already set explicitly in his init
561 ;; file. Unfortunately, he could very likely call the function
562 ;; defined above there. So we put `customize-mark-as-set' in a
563 ;; lambda expression.
564 ;; -- Per Abrahamsen <abraham@dina.kvl.dk> 2002-02-11.
565 '(menu-item ,doc (lambda ()
566 (interactive)
567 (,name)
568 (customize-mark-as-set ',variable))
569 ,@(if props props)
570 :help ,help
571 :button (:toggle . (and (default-boundp ',variable)
572 (default-value ',variable))))))
574 ;;; Assemble all the top-level items of the "Options" menu
575 (define-key menu-bar-options-menu [customize]
576 (list 'menu-item "Customize Emacs" menu-bar-custom-menu
577 :help "Full customization of every Emacs feature"))
579 (defun menu-bar-options-save ()
580 "Save current values of Options menu items using Custom."
581 (interactive)
582 (let ((need-save nil))
583 ;; These are set with `customize-set-variable'.
584 (dolist (elt '(line-number-mode column-number-mode scroll-bar-mode
585 debug-on-quit debug-on-error menu-bar-mode tool-bar-mode
586 save-place uniquify-buffer-name-style fringe-mode
587 case-fold-search cua-mode show-paren-mode
588 transient-mark-mode global-font-lock-mode
589 display-time-mode auto-compression-mode
590 current-language-environment default-input-method
591 ;; Saving `text-mode-hook' is somewhat questionable,
592 ;; as we might get more than we bargain for, if
593 ;; other code may has added hooks as well.
594 ;; Nonetheless, not saving it would like be confuse
595 ;; more often.
596 ;; -- Per Abrahamsen <abraham@dina.kvl.dk> 2002-02-11.
597 text-mode-hook))
598 (and (get elt 'customized-value)
599 (customize-mark-to-save elt)
600 (setq need-save t)))
601 ;; Save if we changed anything.
602 (when need-save
603 (custom-save-all))))
605 (define-key menu-bar-options-menu [save]
606 '(menu-item "Save Options" menu-bar-options-save
607 :help "Save options set from the menu above"))
609 (define-key menu-bar-options-menu [custom-separator]
610 '("--"))
612 ;; The "Show/Hide" submenu of menu "Options"
614 (defvar menu-bar-showhide-menu (make-sparse-keymap "Show/Hide"))
616 (define-key menu-bar-showhide-menu [column-number-mode]
617 (menu-bar-make-toggle toggle-column-number-mode column-number-mode
618 "Show Column Numbers" "Column number mode %s"
619 "Show the current column number in the mode line"))
621 (define-key menu-bar-showhide-menu [line-number-mode]
622 (menu-bar-make-toggle toggle-line-number-mode line-number-mode
623 "Show Line Numbers" "Line number mode %s"
624 "Show the current line number in the mode line"))
626 (define-key menu-bar-showhide-menu [linecolumn-separator]
627 '("--"))
629 (defun showhide-date-time ()
630 "Toggle whether to show date and time in the mode-line."
631 (interactive)
632 (if (display-time-mode)
633 (message "Display-time mode enabled.")
634 (message "Display-time mode disabled.")))
636 (define-key menu-bar-showhide-menu [showhide-date-time]
637 '(menu-item "Date and Time" (lambda ()
638 (interactive)
639 (showhide-date-time)
640 (customize-mark-as-set 'display-time-mode))
641 :help "Display date and time in the mode line"
642 :button (:toggle . display-time-mode)))
644 (define-key menu-bar-showhide-menu [datetime-separator]
645 '("--"))
647 (define-key menu-bar-showhide-menu [showhide-speedbar]
648 '(menu-item "Speedbar" speedbar-frame-mode
649 :help "Display a Speedbar quick-navigation frame"
650 :button (:toggle
651 . (and (boundp 'speedbar-frame)
652 (frame-live-p (symbol-value 'speedbar-frame))
653 (frame-visible-p
654 (symbol-value 'speedbar-frame))))))
656 (defvar menu-bar-showhide-fringe-menu (make-sparse-keymap "Fringe"))
658 (defun menu-bar-showhide-fringe-menu-customize ()
659 "Show customization buffer for `fringe-mode'."
660 (interactive)
661 (customize-variable 'fringe-mode))
663 (define-key menu-bar-showhide-fringe-menu [customize]
664 '(menu-item "Customize" menu-bar-showhide-fringe-menu-customize
665 :help "Detailed customization of fringe"
666 :visible (display-graphic-p)))
668 (defun menu-bar-showhide-fringe-menu-customize-reset ()
669 "Reset the default fringe mode."
670 (interactive)
671 (customize-set-variable 'fringe-mode nil))
673 (define-key menu-bar-showhide-fringe-menu [default]
674 '(menu-item "Default" menu-bar-showhide-fringe-menu-customize-reset
675 :help "Default width fringe on both left and right side"
676 :visible (display-graphic-p)
677 :button (:radio . (eq fringe-mode nil))))
679 (defun menu-bar-showhide-fringe-menu-customize-left ()
680 "Make fringes appear only on the left."
681 (interactive)
682 (require 'fringe)
683 (customize-set-variable 'fringe-mode '(nil . 0)))
685 (define-key menu-bar-showhide-fringe-menu [left]
686 '(menu-item "On the Left" menu-bar-showhide-fringe-menu-customize-left
687 :help "Fringe only on the left side"
688 :visible (display-graphic-p)
689 :button (:radio . (equal fringe-mode '(nil . 0)))))
691 (defun menu-bar-showhide-fringe-menu-customize-right ()
692 "Make fringes appear only on the right."
693 (interactive)
694 (require 'fringe)
695 (customize-set-variable 'fringe-mode '(0 . nil)))
697 (define-key menu-bar-showhide-fringe-menu [right]
698 '(menu-item "On the Right" menu-bar-showhide-fringe-menu-customize-right
699 :help "Fringe only on the right side"
700 :visible (display-graphic-p)
701 :button (:radio . (equal fringe-mode '(0 . nil)))))
703 (defun menu-bar-showhide-fringe-menu-customize-disable ()
704 "Make fringes disappear."
705 (interactive)
706 (require 'fringe)
707 (customize-set-variable 'fringe-mode 0))
709 (define-key menu-bar-showhide-fringe-menu [none]
710 '(menu-item "None" menu-bar-showhide-fringe-menu-customize-disable
711 :help "Turn off fringe"
712 :visible (display-graphic-p)
713 :button (:radio . (eq fringe-mode 0))))
715 (define-key menu-bar-showhide-menu [showhide-fringe]
716 (list 'menu-item "Fringe" menu-bar-showhide-fringe-menu
717 :visible `(display-graphic-p)
718 :help "Select fringe mode"))
720 (defvar menu-bar-showhide-scroll-bar-menu (make-sparse-keymap "Scroll-bar"))
722 (define-key menu-bar-showhide-scroll-bar-menu [right]
723 '(menu-item "On the Right"
724 (lambda ()
725 (interactive)
726 (customize-set-variable 'scroll-bar-mode 'right))
727 :help "Scroll-bar on the right side"
728 :visible (display-graphic-p)
729 :button (:radio . (eq (cdr (assq 'vertical-scroll-bars
730 (frame-parameters))) 'right))))
732 (define-key menu-bar-showhide-scroll-bar-menu [left]
733 '(menu-item "On the Left"
734 (lambda ()
735 (interactive)
736 (customize-set-variable 'scroll-bar-mode 'left))
737 :help "Scroll-bar on the left side"
738 :visible (display-graphic-p)
739 :button (:radio . (eq (cdr (assq 'vertical-scroll-bars
740 (frame-parameters))) 'left))))
742 (define-key menu-bar-showhide-scroll-bar-menu [none]
743 '(menu-item "None"
744 (lambda ()
745 (interactive)
746 (customize-set-variable 'scroll-bar-mode nil))
747 :help "Turn off scroll-bar"
748 :visible (display-graphic-p)
749 :button (:radio . (eq (cdr (assq 'vertical-scroll-bars
750 (frame-parameters))) nil))))
752 (define-key menu-bar-showhide-menu [showhide-scroll-bar]
753 (list 'menu-item "Scroll-bar" menu-bar-showhide-scroll-bar-menu
754 :visible `(display-graphic-p)
755 :help "Select scroll-bar mode"))
757 (defun showhide-menu-bar ()
758 "Toggle whether to turn menu-bar on/off."
759 (interactive)
760 (menu-bar-mode)
761 (if menu-bar-mode
762 (message "Menu-bar mode enabled.")
763 (message "Menu-bar mode disabled. Use M-x menu-bar-mode to make the menu bar appear."))
764 (customize-mark-as-set 'menu-bar-mode))
766 (define-key menu-bar-showhide-menu [showhide-menu-bar]
767 '(menu-item "Menu-bar" showhide-menu-bar
768 :help "Toggle menu-bar on/off"
769 :button (:toggle . menu-bar-mode)))
771 (defun showhide-toolbar ()
772 "Toggle whether to turn tool-bar on/off."
773 (interactive)
774 (if (tool-bar-mode)
775 (message "Tool-bar mode enabled.")
776 (message "Tool-bar mode disabled."))
777 (customize-mark-as-set 'tool-bar-mode))
779 (define-key menu-bar-showhide-menu [showhide-tool-bar]
780 (list 'menu-item "Tool-bar" 'showhide-toolbar
781 :help "Turn tool-bar on/off"
782 :visible `(display-graphic-p)
783 :button `(:toggle . tool-bar-mode)))
785 (define-key menu-bar-options-menu [showhide]
786 (list 'menu-item "Show/Hide" menu-bar-showhide-menu
787 :help "Toggle on/off various display features"))
789 (define-key menu-bar-options-menu [showhide-separator]
790 '("--"))
792 (define-key menu-bar-options-menu [mule]
793 ;; It is better not to use backquote here,
794 ;; because that makes a bootstrapping problem
795 ;; if you need to recompile all the Lisp files using interpreted code.
796 (list 'menu-item "Mule (Multilingual Environment)" mule-menu-keymap
797 ;; Most of the MULE menu actually does make sense in unibyte mode,
798 ;; e.g. language selection.
799 ;;; ':visible 'default-enable-multibyte-characters
800 ':help "Default language, encodings, input method"))
801 ;(setq menu-bar-final-items (cons 'mule menu-bar-final-items))
802 ;(define-key menu-bar-options-menu [preferences]
803 ; (list 'menu-item "Preferences" menu-bar-preferences-menu
804 ; :help "Toggle important global options"))
806 (define-key menu-bar-options-menu [mule-separator]
807 '("--"))
809 (define-key menu-bar-options-menu [debug-on-quit]
810 (menu-bar-make-toggle toggle-debug-on-quit debug-on-quit
811 "Enter Debugger on Quit/C-g" "Debug on Quit %s"
812 "Enter Lisp debugger when C-g is pressed"))
813 (define-key menu-bar-options-menu [debug-on-error]
814 (menu-bar-make-toggle toggle-debug-on-error debug-on-error
815 "Enter Debugger on Error" "Debug on Error %s"
816 "Enter Lisp debugger when an error is signaled"))
817 (define-key menu-bar-options-menu [debugger-separator]
818 '("--"))
819 (define-key menu-bar-options-menu [toggle-auto-compression]
820 '(menu-item "Automatic File De/compression"
821 (lambda ()
822 (interactive)
823 (auto-compression-mode)
824 (customize-mark-as-set 'auto-compression-mode))
825 :help "Transparently decompress compressed files"
826 :button (:toggle . (rassq 'jka-compr-handler
827 file-name-handler-alist))))
828 (define-key menu-bar-options-menu [save-place]
829 (menu-bar-make-toggle toggle-save-place-globally save-place
830 "Save Place in Files between Sessions"
831 "Saving place in files %s"
832 "Save Emacs state for next session"))
834 (define-key menu-bar-options-menu [uniquify]
835 (menu-bar-make-toggle toggle-uniquify-buffer-names uniquify-buffer-name-style
836 "Use Directory Names in Buffer Names"
837 "Directory name in buffer names (uniquify) %s"
838 "Uniquify buffer names by adding parent directory names"
839 () ; no props
840 (require 'uniquify)
841 (setq uniquify-buffer-name-style
842 (if (not uniquify-buffer-name-style)
843 'forward))))
845 (define-key menu-bar-options-menu [edit-options-separator]
846 '("--"))
847 (define-key menu-bar-options-menu [cua-mode]
848 '(menu-item "CUA-style cut and paste"
849 (lambda ()
850 (interactive)
851 (cua-mode nil)
852 (customize-mark-as-set 'cua-mode)
853 (message "CUA-style cut and paste %s"
854 (if cua-mode "enabled" "disabled")))
855 :help "Use C-z/C-x/C-c/C-v keys for undo/cut/copy/paste"
856 :button (:toggle . cua-mode)))
857 (define-key menu-bar-options-menu [case-fold-search]
858 (menu-bar-make-toggle toggle-case-fold-search case-fold-search
859 "Case-Insensitive Search"
860 "Case-Insensitive Search %s"
861 "Ignore letter-case in search"))
862 (define-key menu-bar-options-menu [auto-fill-mode]
863 '(menu-item "Word Wrap in Text Modes (Auto Fill)"
864 (lambda ()
865 (interactive)
866 (toggle-text-mode-auto-fill)
867 ;; This is somewhat questionable, as `text-mode-hook'
868 ;; might have changed outside customize.
869 ;; -- Per Abrahamsen <abraham@dina.kvl.dk> 2002-02-11.
870 (customize-mark-as-set 'text-mode-hook))
871 :help "Automatically fill text between left and right margins"
872 :button (:toggle . (if (listp text-mode-hook)
873 (member 'turn-on-auto-fill text-mode-hook)
874 (eq 'turn-on-auto-fill text-mode-hook)))))
875 (define-key menu-bar-options-menu [truncate-lines]
876 '(menu-item "Truncate Long Lines in this Buffer"
877 (lambda ()
878 (interactive)
879 (setq truncate-lines (not truncate-lines))
880 (set-buffer-modified-p (buffer-modified-p))
881 (message "Truncate long lines %s"
882 (if truncate-lines "enabled" "disabled")))
883 :help "Truncate long lines on the screen"
884 :button (:toggle . truncate-lines)))
886 (define-key menu-bar-options-menu [highlight-separator]
887 '("--"))
888 (define-key menu-bar-options-menu [highlight-paren-mode]
889 (menu-bar-make-toggle toggle-highlight-paren-mode show-paren-mode
890 "Paren Match Highlighting (Show Paren mode)"
891 "Show Paren mode %s"
892 "Highlight matching/mismatched parentheses at cursor"))
893 (define-key menu-bar-options-menu [transient-mark-mode]
894 (menu-bar-make-toggle toggle-transient-mark-mode transient-mark-mode
895 "Active Region Highlighting (Transient Mark mode)"
896 "Transient Mark mode %s"
897 "Make text in active region stand out in color"
898 (:enable (not cua-mode))))
899 (define-key menu-bar-options-menu [toggle-global-lazy-font-lock-mode]
900 (menu-bar-make-toggle toggle-global-lazy-font-lock-mode global-font-lock-mode
901 "Syntax Highlighting (Global Font Lock mode)"
902 "Global Font Lock mode %s"
903 "Colorize text based on language syntax"))
906 ;; The "Tools" menu items
908 (defun send-mail-item-name ()
909 (let* ((known-send-mail-commands '((sendmail-user-agent . "sendmail")
910 (mh-e-user-agent . "MH")
911 (message-user-agent . "Gnus Message")
912 (gnus-user-agent . "Gnus")))
913 (name (assq mail-user-agent known-send-mail-commands)))
914 (if name
915 (setq name (cdr name))
916 (setq name (symbol-name mail-user-agent))
917 (if (string-match "\\(.+\\)-user-agent" name)
918 (setq name (match-string 1 name))))
919 name))
921 (defun read-mail-item-name ()
922 (let* ((known-rmail-commands '((rmail . "RMAIL")
923 (mh-rmail . "MH")
924 (gnus . "Gnus")))
925 (known (assq read-mail-command known-rmail-commands)))
926 (if known (cdr known) (symbol-name read-mail-command))))
928 (defvar menu-bar-games-menu (make-sparse-keymap "Games"))
930 (define-key menu-bar-tools-menu [games]
931 (list 'menu-item "Games" menu-bar-games-menu))
933 (define-key menu-bar-tools-menu [separator-games]
934 '("--"))
936 (define-key menu-bar-games-menu [zone]
937 '(menu-item "Zone Out" zone
938 :help "Play tricks with Emacs display when Emacs is idle"))
939 (define-key menu-bar-games-menu [yow]
940 '(menu-item "Random Quotation" yow
941 :help "Display a random Zippy quotation"))
942 (define-key menu-bar-games-menu [tetris]
943 '(menu-item "Tetris" tetris))
944 (define-key menu-bar-games-menu [solitaire]
945 '(menu-item "Solitaire" solitaire))
946 (define-key menu-bar-games-menu [snake]
947 '(menu-item "Snake" snake
948 :help "Move snake around avoiding collisions"))
949 (define-key menu-bar-games-menu [mult]
950 '(menu-item "Multiplication Puzzle" mpuz
951 :help "Excercise brain with multiplication"))
952 (define-key menu-bar-games-menu [life]
953 '(menu-item "Life" life
954 :help "Watch how John Conway's cellular automaton evolves"))
955 (define-key menu-bar-games-menu [hanoi]
956 '(menu-item "Towers of Hanoi" hanoi
957 :help "Watch Towers-of-Hanoi puzzle solved by Emacs"))
958 (define-key menu-bar-games-menu [gomoku]
959 '(menu-item "Gomoku" gomoku
960 :help "Mark 5 contiguous squares (like tic-tac-toe)"))
961 (define-key menu-bar-games-menu [black-box]
962 '(menu-item "Blackbox" blackbox
963 :help "Find balls in a black box by shooting rays"))
964 (define-key menu-bar-games-menu [adventure]
965 '(menu-item "Adventure" dunnet
966 :help "Dunnet, a text Adventure game for Emacs"))
967 (define-key menu-bar-games-menu [5x5]
968 '(menu-item "5x5" 5x5
969 :help "Fill in all the squares on a 5x5 board"))
971 (define-key menu-bar-tools-menu [simple-calculator]
972 '(menu-item "Simple Calculator" calculator
973 :help "Invoke the Emacs built-in quick calculator"))
974 (define-key menu-bar-tools-menu [calc]
975 '(menu-item "Programmable Calculator" calc
976 :help "Invoke the Emacs built-in full scientific calculator"))
977 (define-key menu-bar-tools-menu [calendar]
978 '(menu-item "Display Calendar" calendar))
980 (define-key menu-bar-tools-menu [separator-net]
981 '("--"))
983 (define-key menu-bar-tools-menu [directory-search]
984 '(menu-item "Directory Search" eudc-tools-menu
985 :help "Query directory servers via LDAP, CCSO PH/QI or BBDB"))
986 (define-key menu-bar-tools-menu [compose-mail]
987 (list
988 'menu-item `(format "Send Mail (with %s)" (send-mail-item-name))
989 'compose-mail
990 :visible `(and mail-user-agent (not (eq mail-user-agent 'ignore)))
991 :help "Send a mail message"))
992 (define-key menu-bar-tools-menu [rmail]
993 (list
994 'menu-item `(format "Read Mail (with %s)" (read-mail-item-name))
995 (lambda ()
996 (interactive)
997 (call-interactively read-mail-command))
998 :visible `(and read-mail-command (not (eq read-mail-command 'ignore)))
999 :help "Read your mail and reply to it"))
1000 (define-key menu-bar-tools-menu [gnus]
1001 '(menu-item "Read Net News (Gnus)" gnus
1002 :help "Read network news groups"))
1004 (define-key menu-bar-tools-menu [separator-vc]
1005 '("--"))
1007 (defvar vc-menu-map (make-sparse-keymap "Version Control"))
1008 (define-key menu-bar-tools-menu [pcl-cvs]
1009 `(menu-item "PCL-CVS" ,cvs-global-menu
1010 :help "Module-level interface to CVS"))
1011 (define-key menu-bar-tools-menu [vc]
1012 (list 'menu-item "Version Control" vc-menu-map
1013 :help "Interface to RCS, CVS, SCCS"))
1015 (define-key menu-bar-tools-menu [separator-compare]
1016 '("--"))
1018 (define-key menu-bar-tools-menu [ediff-misc]
1019 '(menu-item "Ediff Miscellanea" menu-bar-ediff-misc-menu
1020 :help "Ediff manual, customization, sessions, etc."))
1021 (define-key menu-bar-tools-menu [epatch]
1022 '(menu-item "Apply Patch" menu-bar-epatch-menu))
1023 (define-key menu-bar-tools-menu [ediff-merge]
1024 '(menu-item "Merge" menu-bar-ediff-merge-menu
1025 :help "Merge different revisions of files/directories"))
1026 (define-key menu-bar-tools-menu [compare]
1027 '(menu-item "Compare (Ediff)" menu-bar-ediff-menu
1028 :help "Display differences between files/directories"))
1031 (define-key menu-bar-tools-menu [separator-spell]
1032 '("--"))
1034 (define-key menu-bar-tools-menu [spell]
1035 '(menu-item "Spell Checking" ispell-menu-map))
1037 (define-key menu-bar-tools-menu [separator-prog]
1038 '("--"))
1040 (define-key menu-bar-tools-menu [gdb]
1041 '(menu-item "Debugger (GDB)..." gdb
1042 :help "Debug a program from within Emacs with GDB"))
1043 (define-key menu-bar-tools-menu [shell-on-region]
1044 '(menu-item "Shell Command on Region..." shell-command-on-region
1045 :enable mark-active
1046 :help "Pass marked region to a shell command"))
1047 (define-key menu-bar-tools-menu [shell]
1048 '(menu-item "Shell Command..." shell-command
1049 :help "Invoke a shell command and catch its output"))
1050 (define-key menu-bar-tools-menu [compile]
1051 '(menu-item "Compile..." compile
1052 :help "Invoke compiler or Make, view compilation errors"))
1053 (define-key menu-bar-tools-menu [grep]
1054 '(menu-item "Search Files (Grep)..." grep
1055 :help "Search files for strings or regexps (with Grep)"))
1058 ;; The "Help" menu items
1060 (defvar menu-bar-describe-menu (make-sparse-keymap "Describe"))
1062 (define-key menu-bar-describe-menu [mule-diag]
1063 '(menu-item "Show All of Mule Status" mule-diag
1064 :visible default-enable-multibyte-characters
1065 :help "Display multilingual environment settings"))
1066 (define-key menu-bar-describe-menu [describe-coding-system-briefly]
1067 '(menu-item "Describe Coding System (Briefly)..."
1068 describe-current-coding-system-briefly
1069 :visible default-enable-multibyte-characters))
1070 (define-key menu-bar-describe-menu [describe-coding-system]
1071 '(menu-item "Describe Coding System..." describe-coding-system
1072 :visible default-enable-multibyte-characters))
1073 (define-key menu-bar-describe-menu [describe-input-method]
1074 '(menu-item "Describe Input Method..." describe-input-method
1075 :visible default-enable-multibyte-characters
1076 :help "Keyboard layout for specific input method"))
1077 (define-key menu-bar-describe-menu [describe-language-environment]
1078 (list 'menu-item "Describe Language Environment"
1079 describe-language-environment-map
1080 :help "Show multilingual settings for a specific language"))
1082 (define-key menu-bar-describe-menu [separator-desc-mule]
1083 '("--"))
1085 (define-key menu-bar-describe-menu [list-keybindings]
1086 '(menu-item "List Key Bindings" describe-bindings
1087 :help "Display a list of all current keybindings"))
1088 (define-key menu-bar-describe-menu [describe-current-display-table]
1089 '(menu-item "Describe Display Table" describe-current-display-table
1090 :help "Describe the current display table"))
1091 (define-key menu-bar-describe-menu [describe-face]
1092 '(menu-item "Describe Face..." describe-face
1093 :help "Display the properties of a face"))
1094 (define-key menu-bar-describe-menu [describe-variable]
1095 '(menu-item "Describe Variable..." describe-variable
1096 :help "Display documentation of variable/option"))
1097 (define-key menu-bar-describe-menu [describe-function]
1098 '(menu-item "Describe Function..." describe-function
1099 :help "Display documentation of function/command"))
1100 (define-key menu-bar-describe-menu [describe-key]
1101 '(menu-item "Describe Key..." describe-key
1102 ;; Users typically don't identify keys and menu items...
1103 :help "Display documentation of command bound to a \
1104 key (or menu-item)"))
1105 (define-key menu-bar-describe-menu [describe-mode]
1106 '(menu-item "Describe Buffer Modes" describe-mode
1107 :help "Describe this buffer's major and minor mode"))
1109 (defvar menu-bar-apropos-menu (make-sparse-keymap "Apropos"))
1110 (defun menu-bar-read-lispref ()
1111 "Display the Emacs Lisp Reference manual in Info mode."
1112 (interactive)
1113 (info "elisp"))
1115 (defun menu-bar-read-lispintro ()
1116 "Display the Introduction to Emacs Lisp Programming in Info mode."
1117 (interactive)
1118 (info "eintr"))
1120 (defun menu-bar-read-emacs-man ()
1121 "Display Emacs User Manual in Info mode."
1122 (interactive)
1123 (info "emacs"))
1125 (defun search-emacs-glossary ()
1126 "Display the Glossary node of the Emacs manual in Info mode."
1127 (interactive)
1128 (info "(emacs)Glossary"))
1130 (defun emacs-index-search (topic)
1131 "Look up TOPIC in the indices of the Emacs User Manual."
1132 (interactive "sSubject to look up: ")
1133 (info "emacs")
1134 (Info-index topic))
1136 (defun elisp-index-search (topic)
1137 "Look up TOPIC in the indices of the Emacs Lisp Reference Manual."
1138 (interactive "sSubject to look up: ")
1139 (info "elisp")
1140 (Info-index topic))
1142 (define-key menu-bar-apropos-menu [apropos-documentation]
1143 '(menu-item "Search Documentation Strings..." apropos-documentation
1144 :help
1145 "Find functions and variables whose doc strings match a regexp"))
1146 (define-key menu-bar-apropos-menu [apropos]
1147 '(menu-item "Find Any Object by Name..." apropos
1148 :help "Find symbols of any kind whose names match a regexp"))
1149 (define-key menu-bar-apropos-menu [apropos-value]
1150 '(menu-item "Find Options by Value..." apropos-value
1151 :help "Find variables whose values match a regexp"))
1152 (define-key menu-bar-apropos-menu [apropos-variables]
1153 '(menu-item "Find Options by Name..." apropos-variable
1154 :help "Find variables whose names match a regexp"))
1155 (define-key menu-bar-apropos-menu [apropos-commands]
1156 '(menu-item "Find Commands by Name..." apropos-command
1157 :help "Find commands whose names match a regexp"))
1158 (define-key menu-bar-apropos-menu [sep1]
1159 '("--"))
1160 (define-key menu-bar-apropos-menu [elisp-index-search]
1161 '(menu-item "Look Up Subject in ELisp Manual..." elisp-index-search
1162 :help "Find description of a subject in Emacs Lisp manual"))
1163 (define-key menu-bar-apropos-menu [emacs-index-search]
1164 '(menu-item "Look Up Subject in User Manual..." emacs-index-search
1165 :help "Find description of a subject in Emacs User manual"))
1166 (define-key menu-bar-apropos-menu [emacs-glossary]
1167 '(menu-item "Emacs Terminology" search-emacs-glossary
1168 :help "Display the Glossary section of the Emacs manual"))
1170 (defvar menu-bar-manuals-menu (make-sparse-keymap "More Manuals"))
1172 (define-key menu-bar-manuals-menu [man]
1173 '(menu-item "Read Man Page..." manual-entry
1174 :help "Man-page docs for external commands and libraries"))
1175 (define-key menu-bar-manuals-menu [sep2]
1176 '("--"))
1177 (define-key menu-bar-manuals-menu [order-emacs-manuals]
1178 '(menu-item "Ordering Manuals" view-order-manuals
1179 :help "How to order manuals from the Free Software Foundation"))
1180 (define-key menu-bar-manuals-menu [info]
1181 '(menu-item "All Other Manuals (Info)" Info-directory
1182 :help "Read any of the installed manuals"))
1183 (define-key menu-bar-manuals-menu [info-elisp]
1184 '(menu-item "Emacs Lisp Reference" menu-bar-read-lispref
1185 :help "Read the Emacs Lisp Reference manual"))
1186 (define-key menu-bar-manuals-menu [info-elintro]
1187 '(menu-item "Introduction to Emacs Lisp" menu-bar-read-lispintro
1188 :help "Read the Introduction to Emacs Lisp Programming"))
1189 (define-key menu-bar-manuals-menu [sep3]
1190 '("--"))
1191 (define-key menu-bar-manuals-menu [command]
1192 '(menu-item "Find Command in Manual" Info-goto-emacs-command-node
1193 :help "Display manual section that describes a command"))
1194 (define-key menu-bar-manuals-menu [key]
1195 '(menu-item "Find Key in Manual" Info-goto-emacs-key-command-node
1196 :help "Display manual section that describes a key"))
1198 (define-key menu-bar-help-menu [eliza]
1199 '(menu-item "Emacs Psychiatrist" doctor
1200 :help "Our doctor will help you feel better"))
1201 (define-key menu-bar-help-menu [sep4]
1202 '("--"))
1203 (define-key menu-bar-help-menu [describe-no-warranty]
1204 '(menu-item "(Non)Warranty" describe-no-warranty
1205 :help "Explain that Emacs has NO WARRANTY"))
1206 (define-key menu-bar-help-menu [describe-copying]
1207 '(menu-item "Copying Conditions" describe-copying
1208 :help "Show the Emacs license (GPL)"))
1209 (define-key menu-bar-help-menu [describe-distribution]
1210 '(menu-item "Getting New Versions" describe-distribution
1211 :help "How to get latest versions of Emacs"))
1212 (define-key menu-bar-help-menu [more]
1213 '(menu-item "Find Extra Packages"
1214 (lambda ()
1215 (interactive)
1216 (let (enable-local-variables)
1217 (view-file (expand-file-name "MORE.STUFF"
1218 data-directory))
1219 (goto-address)))
1220 :help "Where to find some extra packages and possible updates"))
1221 (define-key menu-bar-help-menu [about]
1222 '(menu-item "About Emacs" display-splash-screen
1223 :help "Display version number, copyright info, and basic help"))
1224 (define-key menu-bar-help-menu [sep2]
1225 '("--"))
1226 (define-key menu-bar-help-menu [finder-by-keyword]
1227 '(menu-item "Find Emacs Packages..." finder-by-keyword
1228 :help "Find packages and features by keyword"))
1229 (define-key menu-bar-help-menu [manuals]
1230 (list 'menu-item "More Manuals" menu-bar-manuals-menu
1231 :help "Search and browse on-line manuals"))
1232 (define-key menu-bar-help-menu [emacs-manual]
1233 '(menu-item "Read the Emacs Manual" menu-bar-read-emacs-man
1234 :help "Full documentation of Emacs features"))
1235 (define-key menu-bar-help-menu [describe]
1236 (list 'menu-item "Describe" menu-bar-describe-menu
1237 :help "Describe commands, variables, keys"))
1238 (define-key menu-bar-help-menu [apropos]
1239 (list 'menu-item "Search Documentation" menu-bar-apropos-menu
1240 :help "Look up terms, find commands, options, etc. (Apropos)"))
1241 (define-key menu-bar-help-menu [sep1]
1242 '("--"))
1243 (define-key menu-bar-help-menu [report-emacs-bug]
1244 '(menu-item "Send Bug Report..." report-emacs-bug
1245 :help "Send e-mail to Emacs maintainers"))
1246 (define-key menu-bar-help-menu [emacs-problems]
1247 '(menu-item "Emacs Known Problems" view-emacs-problems))
1248 (define-key menu-bar-help-menu [emacs-news]
1249 '(menu-item "Emacs News" view-emacs-news
1250 :help "New features of this version"))
1251 (define-key menu-bar-help-menu [emacs-faq]
1252 '(menu-item "Emacs FAQ" view-emacs-FAQ))
1253 (define-key menu-bar-help-menu [emacs-tutorial-language-specific]
1254 '(menu-item "Emacs Tutorial (choose language)..."
1255 (lambda () (interactive) (help-with-tutorial t))
1256 :help "Learn how to use Emacs (choose a language)"))
1257 (define-key menu-bar-help-menu [emacs-tutorial]
1258 '(menu-item "Emacs Tutorial" help-with-tutorial
1259 :help "Learn how to use Emacs"))
1261 (defun kill-this-buffer () ; for the menubar
1262 "Kill the current buffer."
1263 (interactive)
1264 (kill-buffer (current-buffer)))
1266 (defun kill-this-buffer-enabled-p ()
1267 (let ((count 0)
1268 (buffers (buffer-list)))
1269 (while buffers
1270 (or (string-match "^ " (buffer-name (car buffers)))
1271 (setq count (1+ count)))
1272 (setq buffers (cdr buffers)))
1273 (and (not (window-minibuffer-p (frame-selected-window menu-updating-frame)))
1274 (> count 1))))
1276 (put 'dired 'menu-enable
1277 '(not (window-minibuffer-p (frame-selected-window menu-updating-frame))))
1279 ;; Permit deleting frame if it would leave a visible or iconified frame.
1280 (defun delete-frame-enabled-p ()
1281 "Return non-nil if `delete-frame' should be enabled in the menu bar."
1282 (let ((frames (frame-list))
1283 (count 0))
1284 (while frames
1285 (if (frame-visible-p (car frames))
1286 (setq count (1+ count)))
1287 (setq frames (cdr frames)))
1288 (> count 1)))
1290 (defcustom yank-menu-length 20
1291 "*Maximum length to display in the yank-menu."
1292 :type 'integer
1293 :group 'mouse)
1295 (defun menu-bar-update-yank-menu (string old)
1296 (let ((front (car (cdr yank-menu)))
1297 (menu-string (if (<= (length string) yank-menu-length)
1298 string
1299 (concat
1300 (substring string 0 (/ yank-menu-length 2))
1301 "..."
1302 (substring string (- (/ yank-menu-length 2)))))))
1303 ;; Don't let the menu string be all dashes
1304 ;; because that has a special meaning in a menu.
1305 (if (string-match "\\`-+\\'" menu-string)
1306 (setq menu-string (concat menu-string " ")))
1307 ;; If we're supposed to be extending an existing string, and that
1308 ;; string really is at the front of the menu, then update it in place.
1309 (if (and old (or (eq old (car front))
1310 (string= old (car front))))
1311 (progn
1312 (setcar front string)
1313 (setcar (cdr front) menu-string))
1314 (setcdr yank-menu
1315 (cons
1316 (cons string (cons menu-string 'menu-bar-select-yank))
1317 (cdr yank-menu)))))
1318 (if (> (length (cdr yank-menu)) kill-ring-max)
1319 (setcdr (nthcdr kill-ring-max yank-menu) nil)))
1321 (put 'menu-bar-select-yank 'apropos-inhibit t)
1322 (defun menu-bar-select-yank ()
1323 (interactive "*")
1324 (push-mark (point))
1325 (insert last-command-event))
1328 (defcustom buffers-menu-show-directories 'unless-uniquify
1329 "If non-nil, show directories in the Buffers menu for buffers that have them.
1330 The special value `unless-uniquify' means that directories will be shown
1331 unless `uniquify-buffer-name-style' is non-nil (in which case, buffer
1332 names should include enough of a buffer's directory to distinguish it
1333 from other buffers).
1335 Setting this variable directly does not take effect until next time the
1336 Buffers menu is regenerated."
1337 :set (lambda (symbol value)
1338 (set symbol value)
1339 (menu-bar-update-buffers t))
1340 :initialize 'custom-initialize-default
1341 :type '(choice (const :tag "Never" nil)
1342 (const :tag "Unless uniquify is enabled" unless-uniquify)
1343 (const :tag "Always" t))
1344 :group 'menu)
1346 (defcustom buffers-menu-show-status t
1347 "If non-nil, show modified/read-only status of buffers in the Buffers menu.
1348 Setting this variable directly does not take effect until next time the
1349 Buffers menu is regenerated."
1350 :set (lambda (symbol value)
1351 (set symbol value)
1352 (menu-bar-update-buffers t))
1353 :initialize 'custom-initialize-default
1354 :type 'boolean
1355 :group 'menu)
1357 (defvar list-buffers-directory nil)
1359 (defvar menu-bar-update-buffers-maxbuf)
1361 (defun menu-bar-select-buffer ()
1362 (interactive)
1363 (switch-to-buffer last-command-event))
1365 (defun menu-bar-select-frame ()
1366 (interactive)
1367 (let (frame)
1368 (dolist (f (frame-list))
1369 (when (equal last-command-event (frame-parameter f 'name))
1370 (setq frame f)))
1371 (make-frame-visible frame)
1372 (raise-frame frame)
1373 (select-frame frame)))
1375 (defun menu-bar-update-buffers-1 (elt)
1376 (let* ((buf (car elt))
1377 (file
1378 (and (if (eq buffers-menu-show-directories 'unless-uniquify)
1379 (or (not (boundp 'uniquify-buffer-name-style))
1380 (null uniquify-buffer-name-style))
1381 buffers-menu-show-directories)
1382 (or (buffer-file-name buf)
1383 (buffer-local-value 'list-buffers-directory buf)))))
1384 (when file
1385 (setq file (file-name-directory file)))
1386 (when (and file (> (length file) 20))
1387 (setq file (concat "..." (substring file -17))))
1388 (cons (if buffers-menu-show-status
1389 (let ((mod (if (buffer-modified-p buf) "*" ""))
1390 (ro (if (buffer-local-value 'buffer-read-only buf) "%" "")))
1391 (if file
1392 (format "%s %s%s -- %s" (cdr elt) mod ro file)
1393 (format "%s %s%s" (cdr elt) mod ro)))
1394 (if file
1395 (format "%s -- %s" (cdr elt) file)
1396 (cdr elt)))
1397 buf)))
1399 ;; Used to cache the menu entries for commands in the Buffers menu
1400 (defvar menu-bar-buffers-menu-command-entries nil)
1402 (defun menu-bar-update-buffers (&optional force)
1403 ;; If user discards the Buffers item, play along.
1404 (and (lookup-key (current-global-map) [menu-bar buffer])
1405 (or force (frame-or-buffer-changed-p))
1406 (let ((buffers (buffer-list))
1407 (frames (frame-list))
1408 buffers-menu frames-menu)
1409 ;; If requested, list only the N most recently selected buffers.
1410 (if (and (integerp buffers-menu-max-size)
1411 (> buffers-menu-max-size 1))
1412 (if (> (length buffers) buffers-menu-max-size)
1413 (setcdr (nthcdr buffers-menu-max-size buffers) nil)))
1415 ;; Make the menu of buffers proper.
1416 (setq buffers-menu
1417 (let* ((buffer-list
1418 (mapcar 'list buffers))
1419 (menu-bar-update-buffers-maxbuf 0)
1420 alist)
1421 ;; Put into each element of buffer-list
1422 ;; the name for actual display,
1423 ;; perhaps truncated in the middle.
1424 (dolist (buf buffer-list)
1425 (let ((name (buffer-name (car buf))))
1426 (setcdr buf
1427 (if (> (length name) 27)
1428 (concat (substring name 0 12)
1429 "..."
1430 (substring name -12))
1431 name))))
1432 ;; Compute the maximum length of any name.
1433 (dolist (buf buffer-list)
1434 (unless (eq ?\ (aref (cdr buf) 0))
1435 (setq menu-bar-update-buffers-maxbuf
1436 (max menu-bar-update-buffers-maxbuf
1437 (length (cdr buf))))))
1438 ;; Set ALIST to an alist of the form
1439 ;; ITEM-STRING . BUFFER
1440 (dolist (buf buffer-list)
1441 (unless (eq ?\ (aref (cdr buf) 0))
1442 (push (menu-bar-update-buffers-1 buf) alist)))
1443 ;; Now make the actual list of items, and add
1444 ;; some miscellaneous buffer commands to the end.
1445 (mapcar (lambda (pair)
1446 ;; This is somewhat risque, to use
1447 ;; the buffer name itself as the event
1448 ;; type to define, but it works.
1449 ;; It would not work to use the buffer
1450 ;; since a buffer as an event has its
1451 ;; own meaning.
1452 (nconc (list (buffer-name (cdr pair))
1453 (car pair)
1454 (cons nil nil))
1455 'menu-bar-select-buffer))
1456 (nreverse alist))))
1458 ;; Make a Frames menu if we have more than one frame.
1459 (when (cdr frames)
1460 (let ((frames-menu
1461 (cons 'keymap
1462 (cons "Select Frame"
1463 (mapcar
1464 (lambda (frame)
1465 (nconc
1466 (list (frame-parameter frame 'name)
1467 (frame-parameter frame 'name)
1468 (cons nil nil))
1469 'menu-bar-select-frame))
1470 frames)))))
1471 ;; Put it after the normal buffers
1472 (setq buffers-menu
1473 (nconc buffers-menu
1474 `((frames-separator "--")
1475 (frames menu-item "Frames" ,frames-menu))))))
1477 ;; Add in some normal commands at the end of the menu. We use
1478 ;; the copy cached in `menu-bar-buffers-menu-command-entries'
1479 ;; if it's been set already. Note that we can't use constant
1480 ;; lists for the menu-entries, because the low-level menu-code
1481 ;; modifies them.
1482 (unless menu-bar-buffers-menu-command-entries
1483 (setq menu-bar-buffers-menu-command-entries
1484 (list '(command-separator "--")
1485 (list 'next-buffer
1486 'menu-item
1487 "Next Buffer"
1488 'next-buffer
1489 :help "Switch to the \"next\" buffer in a cyclic order")
1490 (list 'prev-buffer
1491 'menu-item
1492 "Previous Buffer"
1493 'prev-buffer
1494 :help "Switch to the \"previous\" buffer in a cyclic order")
1495 (list 'select-named-buffer
1496 'menu-item
1497 "Select Named Buffer..."
1498 'switch-to-buffer
1499 :help "Prompt for a buffer name, and select that buffer in the current window")
1500 (list 'list-all-buffers
1501 'menu-item
1502 "List All Buffers"
1503 'list-buffers
1504 :help "Pop up a window listing all emacs buffers"
1505 ))))
1506 (setq buffers-menu
1507 (nconc buffers-menu menu-bar-buffers-menu-command-entries))
1509 (setq buffers-menu (cons 'keymap (cons "Select Buffer" buffers-menu)))
1510 (define-key (current-global-map) [menu-bar buffer]
1511 (cons "Buffers" buffers-menu)))))
1513 (add-hook 'menu-bar-update-hook 'menu-bar-update-buffers)
1515 (menu-bar-update-buffers)
1517 ;; this version is too slow
1518 ;;;(defun format-buffers-menu-line (buffer)
1519 ;;; "Returns a string to represent the given buffer in the Buffer menu.
1520 ;;;nil means the buffer shouldn't be listed. You can redefine this."
1521 ;;; (if (string-match "\\` " (buffer-name buffer))
1522 ;;; nil
1523 ;;; (save-excursion
1524 ;;; (set-buffer buffer)
1525 ;;; (let ((size (buffer-size)))
1526 ;;; (format "%s%s %-19s %6s %-15s %s"
1527 ;;; (if (buffer-modified-p) "*" " ")
1528 ;;; (if buffer-read-only "%" " ")
1529 ;;; (buffer-name)
1530 ;;; size
1531 ;;; mode-name
1532 ;;; (or (buffer-file-name) ""))))))
1534 ;;; Set up a menu bar menu for the minibuffer.
1536 (dolist (map (list minibuffer-local-map
1537 ;; This shouldn't be necessary, but there's a funny
1538 ;; bug in keymap.c that I don't understand yet. -stef
1539 minibuffer-local-completion-map))
1540 (define-key map [menu-bar minibuf]
1541 (cons "Minibuf" (make-sparse-keymap "Minibuf"))))
1543 (let ((map minibuffer-local-completion-map))
1544 (define-key map [menu-bar minibuf ?\?]
1545 (list 'menu-item "List Completions" 'minibuffer-completion-help
1546 :help "Display all possible completions"))
1547 (define-key map [menu-bar minibuf space]
1548 (list 'menu-item "Complete Word" 'minibuffer-complete-word
1549 :help "Complete at most one word"))
1550 (define-key map [menu-bar minibuf tab]
1551 (list 'menu-item "Complete" 'minibuffer-complete
1552 :help "Complete as far as possible")))
1554 (let ((map minibuffer-local-map))
1555 (define-key map [menu-bar minibuf quit]
1556 (list 'menu-item "Quit" 'keyboard-escape-quit
1557 :help "Abort input and exit minibuffer"))
1558 (define-key map [menu-bar minibuf return]
1559 (list 'menu-item "Enter" 'exit-minibuffer
1560 :help "Terminate input and exit minibuffer")))
1562 (defcustom menu-bar-mode t
1563 "Toggle display of a menu bar on each frame.
1564 Setting this variable directly does not take effect;
1565 use either \\[customize] or the function `menu-bar-mode'."
1566 :set (lambda (symbol value)
1567 (menu-bar-mode (or value 0)))
1568 :initialize 'custom-initialize-default
1569 :type 'boolean
1570 :group 'frames)
1572 (defun menu-bar-mode (&optional flag)
1573 "Toggle display of a menu bar on each frame.
1574 This command applies to all frames that exist and frames to be
1575 created in the future.
1576 With a numeric argument, if the argument is positive,
1577 turn on menu bars; otherwise, turn off menu bars."
1578 (interactive "P")
1580 ;; Make menu-bar-mode and default-frame-alist consistent.
1581 (let ((default (assq 'menu-bar-lines default-frame-alist)))
1582 (if default
1583 (setq menu-bar-mode (not (eq (cdr default) 0)))
1584 (setq default-frame-alist
1585 (cons (cons 'menu-bar-lines (if menu-bar-mode 1 0))
1586 default-frame-alist))))
1588 ;; Toggle or set the mode, according to FLAG.
1589 (setq menu-bar-mode (if (null flag) (not menu-bar-mode)
1590 (> (prefix-numeric-value flag) 0)))
1592 ;; Apply it to default-frame-alist.
1593 (let ((parameter (assq 'menu-bar-lines default-frame-alist)))
1594 (if (consp parameter)
1595 (setcdr parameter (if menu-bar-mode 1 0))
1596 (setq default-frame-alist
1597 (cons (cons 'menu-bar-lines (if menu-bar-mode 1 0))
1598 default-frame-alist))))
1600 ;; Apply it to existing frames.
1601 (let ((frames (frame-list)))
1602 (while frames
1603 (let ((height (cdr (assq 'height (frame-parameters (car frames))))))
1604 (modify-frame-parameters (car frames)
1605 (list (cons 'menu-bar-lines
1606 (if menu-bar-mode 1 0))))
1607 (modify-frame-parameters (car frames)
1608 (list (cons 'height height))))
1609 (setq frames (cdr frames)))))
1611 (provide 'menu-bar)
1613 ;;; menu-bar.el ends here