lisp/menu-bar.el

   1 ;;; menu-bar.el --- define a default menu bar
   2
   3 ;; Copyright (C) 1993, 1994, 1995, 2000, 2001, 2002 Free Software Foundation, Inc.
   4
   5 ;; Author: RMS
   6 ;; Maintainer: FSF
   7 ;; Keywords: internal, mouse
   8
   9 ;; This file is part of GNU Emacs.
  10
  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.
  15
  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.
  20
  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.
  25
  26 ;; Avishai Yacobi suggested some menu rearrangements.
  27
  28 ;;; Commentary:
  29
  30 ;;; Code:
  31
  32 ;;; User options:
  33
  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)
  42
  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"))
  48
  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))
  53
  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))
  68
  69 ;; This alias is for compatibility with 19.28 and before.
  70 (defvar menu-bar-file-menu menu-bar-files-menu)
  71 \f
  72 ;; The "File" menu items
  73 (define-key menu-bar-files-menu [exit-emacs]
  74   '(menu-item "Exit Emacs" save-buffers-kill-emacs
  75               :help "Save unsaved buffers, then exit"))
  76
  77 (define-key menu-bar-files-menu [separator-exit]
  78   '("--"))
  79
  80 ;; Don't use delete-frame as event name because that is a special
  81 ;; event.
  82 (define-key menu-bar-files-menu [delete-this-frame]
  83   '(menu-item "Delete Frame" delete-frame
  84               :visible (fboundp 'delete-frame)
  85               :enable (delete-frame-enabled-p)
  86               :help "Delete currently selected frame"))
  87 (define-key menu-bar-files-menu [make-frame-on-display]
  88   '(menu-item "New Frame on Display..." make-frame-on-display
  89               :visible (fboundp 'make-frame-on-display)
  90               :help "Open a new frame on another display"))
  91 (define-key menu-bar-files-menu [make-frame]
  92   '(menu-item "New Frame" make-frame-command
  93               :visible (fboundp 'make-frame-command)
  94               :help "Open a new frame"))
  95
  96 (define-key menu-bar-files-menu [one-window]
  97   '(menu-item "Unsplit Windows" delete-other-windows
  98               :enable (not (one-window-p t nil))
  99               :help "Make selected window fill its frame"))
 100
 101 (define-key menu-bar-files-menu [split-window]
 102   '(menu-item "Split Window" split-window-vertically
 103               :help "Split selected window in two"))
 104
 105 (define-key menu-bar-files-menu [separator-window]
 106   '(menu-item "--"))
 107
 108 (define-key menu-bar-files-menu [ps-print-region]
 109   '(menu-item "Postscript Print Region (B+W)" ps-print-region
 110               :enable mark-active
 111               :help "Pretty-print marked region in black and white to PostScript printer"))
 112 (define-key menu-bar-files-menu [ps-print-buffer]
 113   '(menu-item "Postscript Print Buffer (B+W)" ps-print-buffer
 114               :help "Pretty-print current buffer in black and white to PostScript printer"))
 115 (define-key menu-bar-files-menu [ps-print-region-faces]
 116   '(menu-item "Postscript Print Region" ps-print-region-with-faces
 117               :enable mark-active
 118               :help "Pretty-print marked region to PostScript printer"))
 119 (define-key menu-bar-files-menu [ps-print-buffer-faces]
 120   '(menu-item "Postscript Print Buffer" ps-print-buffer-with-faces
 121               :help "Pretty-print current buffer to PostScript printer"))
 122 (define-key menu-bar-files-menu [print-region]
 123   '(menu-item "Print Region" print-region
 124               :enable mark-active
 125               :help "Print region between mark and current position"))
 126 (define-key menu-bar-files-menu [print-buffer]
 127   '(menu-item "Print Buffer" print-buffer
 128               :help "Print current buffer with page headings"))
 129
 130 (define-key menu-bar-files-menu [separator-print]
 131   '(menu-item "--"))
 132
 133 (define-key menu-bar-files-menu [recover-session]
 134   '(menu-item "Recover Crashed Session..." recover-session
 135               :enable (and auto-save-list-file-prefix
 136                            (file-directory-p
 137                             (file-name-directory auto-save-list-file-prefix))
 138                            (directory-files
 139                             (file-name-directory auto-save-list-file-prefix)
 140                             nil
 141                             (concat "\\`"
 142                                     (regexp-quote
 143                                      (file-name-nondirectory
 144                                       auto-save-list-file-prefix)))
 145                             t))
 146               :help "Recover edits from a crashed session"))
 147 (define-key menu-bar-files-menu [revert-buffer]
 148   '(menu-item "Revert Buffer" revert-buffer
 149               :enable (or revert-buffer-function
 150                           revert-buffer-insert-file-contents-function
 151                           (and (buffer-file-name)
 152                                (or (buffer-modified-p)
 153                                    (not (verify-visited-file-modtime
 154                                          (current-buffer))))))
 155               :help "Re-read current buffer from its file"))
 156 (define-key menu-bar-files-menu [write-file]
 157   '(menu-item "Save Buffer As..." write-file
 158               :enable (not (window-minibuffer-p
 159                             (frame-selected-window menu-updating-frame)))
 160               :help "Write current buffer to another file"))
 161 (define-key menu-bar-files-menu [save-buffer]
 162   '(menu-item "Save (current buffer)" save-buffer
 163               :enable (and (buffer-modified-p)
 164                            (buffer-file-name)
 165                            (not (window-minibuffer-p
 166                                  (frame-selected-window menu-updating-frame))))
 167               :help "Save current buffer to its file"))
 168
 169 (define-key menu-bar-files-menu [separator-save]
 170   '(menu-item "--"))
 171
 172 (define-key menu-bar-files-menu [kill-buffer]
 173   '(menu-item "Close (current buffer)" kill-this-buffer
 174               :enable (kill-this-buffer-enabled-p)
 175               :help "Discard current buffer"))
 176 (define-key menu-bar-files-menu [insert-file]
 177   '(menu-item "Insert File..." insert-file
 178               :enable (not (window-minibuffer-p
 179                             (frame-selected-window menu-updating-frame)))
 180               :help "Insert another file into current buffer"))
 181 (define-key menu-bar-files-menu [dired]
 182   '(menu-item "Open Directory..." dired
 183               :help "Read a directory, operate on its files"))
 184 (define-key menu-bar-files-menu [open-file]
 185   '(menu-item "Open File..." find-file
 186               :enable (not (window-minibuffer-p
 187                             (frame-selected-window menu-updating-frame)))
 188               :help "Read a file into an Emacs buffer"))
 189
 190 \f
 191 ;; The "Edit" menu items
 192 (defun nonincremental-search-forward (string)
 193   "Read a string and search for it nonincrementally."
 194   (interactive "sSearch for string: ")
 195   (if (equal string "")
 196       (search-forward (car search-ring))
 197     (isearch-update-ring string nil)
 198     (search-forward string)))
 199
 200 (defun nonincremental-search-backward (string)
 201   "Read a string and search backward for it nonincrementally."
 202   (interactive "sSearch for string: ")
 203   (if (equal string "")
 204       (search-backward (car search-ring))
 205     (isearch-update-ring string nil)
 206     (search-backward string)))
 207
 208 (defun nonincremental-re-search-forward (string)
 209   "Read a regular expression and search for it nonincrementally."
 210   (interactive "sSearch for regexp: ")
 211   (if (equal string "")
 212       (re-search-forward (car regexp-search-ring))
 213     (isearch-update-ring string t)
 214     (re-search-forward string)))
 215
 216 (defun nonincremental-re-search-backward (string)
 217   "Read a regular expression and search backward for it nonincrementally."
 218   (interactive "sSearch for regexp: ")
 219   (if (equal string "")
 220       (re-search-backward (car regexp-search-ring))
 221     (isearch-update-ring string t)
 222     (re-search-backward string)))
 223
 224 (defun nonincremental-repeat-search-forward ()
 225   "Search forward for the previous search string."
 226   (interactive)
 227   (if (null search-ring)
 228       (error "No previous search"))
 229   (search-forward (car search-ring)))
 230
 231 (defun nonincremental-repeat-search-backward ()
 232   "Search backward for the previous search string."
 233   (interactive)
 234   (if (null search-ring)
 235       (error "No previous search"))
 236   (search-backward (car search-ring)))
 237
 238 (defun nonincremental-repeat-re-search-forward ()
 239   "Search forward for the previous regular expression."
 240   (interactive)
 241   (if (null regexp-search-ring)
 242       (error "No previous search"))
 243   (re-search-forward (car regexp-search-ring)))
 244
 245 (defun nonincremental-repeat-re-search-backward ()
 246   "Search backward for the previous regular expression."
 247   (interactive)
 248   (if (null regexp-search-ring)
 249       (error "No previous search"))
 250   (re-search-backward (car regexp-search-ring)))
 251
 252 (defvar menu-bar-search-menu (make-sparse-keymap "Search"))
 253 (defvar menu-bar-adv-search-menu
 254   (make-sparse-keymap "Advanced Search/Replace"))
 255
 256 (define-key menu-bar-adv-search-menu [tags-continue]
 257   '(menu-item "Continue Tags Search/Replace" tags-loop-continue
 258               :help "Continue last tags search/replace operation"))
 259 (define-key menu-bar-adv-search-menu [tags-repl]
 260   '(menu-item "Replace in all tagged files" tags-query-replace
 261               :help "Interactively replace a regexp in all tagged files"))
 262 (define-key menu-bar-adv-search-menu [tags-srch]
 263   '(menu-item "Search in all tagged files" tags-search
 264               :help "Search for a regexp in all tagged files"))
 265
 266 (define-key menu-bar-adv-search-menu [separator-tag-search]
 267   '(menu-item "--"))
 268
 269 (define-key menu-bar-adv-search-menu [query-replace-regexp]
 270   '(menu-item "Replace Regexp..." query-replace-regexp
 271               :enable (not buffer-read-only)
 272               :help "Replace regular expression, ask about each occurrence"))
 273 (define-key menu-bar-adv-search-menu [repeat-regexp-back]
 274   '(menu-item "Repeat Regexp Backwards"
 275               nonincremental-repeat-re-search-backward
 276               :enable regexp-search-ring
 277               :help "Repeat last regular expression search backwards"))
 278 (define-key menu-bar-adv-search-menu [repeat-regexp-fwd]
 279   '(menu-item "Repeat Regexp" nonincremental-repeat-re-search-forward
 280               :enable regexp-search-ring
 281               :help "Repeat last regular expression search forward"))
 282 (define-key menu-bar-adv-search-menu [re-search-backward]
 283   '(menu-item "Search Regexp Backwards..." nonincremental-re-search-backward
 284               :help "Search backwards for a regular expression"))
 285 (define-key menu-bar-adv-search-menu [re-search-forward]
 286   '(menu-item "Search Regexp..." nonincremental-re-search-forward
 287               :help "Search forward for a regular expression"))
 288 (define-key menu-bar-search-menu [re-search]
 289   (list 'menu-item "Advanced Search/Replace" menu-bar-adv-search-menu
 290               :help "Regexp and Tags search and replace"))
 291
 292 (define-key menu-bar-search-menu [query-replace]
 293   '(menu-item "Replace..." query-replace
 294               :enable (not buffer-read-only)
 295               :help "Replace string interactively, ask about each occurrence"))
 296 (define-key menu-bar-search-menu [repeat-search-back]
 297   '(menu-item "Repeat Backwards" nonincremental-repeat-search-backward
 298               :enable search-ring
 299               :help "Repeat last search backwards"))
 300 (define-key menu-bar-search-menu [repeat-search-fwd]
 301   '(menu-item "Repeat Search" nonincremental-repeat-search-forward
 302               :enable search-ring
 303               :help "Repeat last search forward"))
 304 (define-key menu-bar-search-menu [search-backward]
 305   '(menu-item "Search Backwards..." nonincremental-search-backward
 306               :help "Search backwards for a string"))
 307 (define-key menu-bar-search-menu [search-forward]
 308   '(menu-item "Search..." nonincremental-search-forward
 309               :help "Search forward for a string"))
 310
 311 ;;; Assemble the top-level Edit menu items.
 312 (define-key menu-bar-edit-menu [props]
 313   '(menu-item "Text Properties" facemenu-menu
 314               :help "Change properties of text in region"))
 315
 316 (define-key menu-bar-edit-menu [fill]
 317   '(menu-item "Fill" fill-region
 318               :enable (and mark-active (not buffer-read-only))
 319               :help
 320               "Fill text in region to fit between left and right margin"))
 321
 322 (define-key menu-bar-edit-menu [separator-bookmark]
 323   '(menu-item "--"))
 324
 325 (define-key menu-bar-edit-menu [bookmark]
 326   '(menu-item "Bookmarks" menu-bar-bookmark-map
 327               :help "Record positions and jump between them"))
 328
 329 (defvar menu-bar-goto-menu (make-sparse-keymap "Go To"))
 330
 331 (define-key menu-bar-goto-menu [set-tags-name]
 332   '(menu-item "Set Tags File Name" visit-tags-table
 333               :help "Tell Tags commands which tag table file to use"))
 334
 335 (define-key menu-bar-goto-menu [separator-tag-file]
 336   '(menu-item "--"))
 337
 338 (define-key menu-bar-goto-menu [apropos-tags]
 339   '(menu-item "Tags Apropos" tags-apropos
 340               :help "Find function/variables whose names match regexp"))
 341 (define-key menu-bar-goto-menu [next-tag-otherw]
 342   '(menu-item "Next Tag in Other Window"
 343               (function (lambda () (find-tag-other-window nil t)))
 344               :enable (and (boundp 'tags-location-ring)
 345                            (not (ring-empty-p tags-location-ring)))
 346               :help "Find next function/variable matching last tag name in another window"))
 347 (define-key menu-bar-goto-menu [next-tag]
 348   '(menu-item "Find Next Tag"
 349               (function (lambda () (find-tag nil t)))
 350               :enable (and (boundp 'tags-location-ring)
 351                            (not (ring-empty-p tags-location-ring)))
 352               :help "Find next function/variable matching last tag name"))
 353 (define-key menu-bar-goto-menu [find-tag-otherw]
 354   '(menu-item "Find Tag in Other Window..." find-tag-other-window
 355               :help "Find function/variable definition in another window"))
 356 (define-key menu-bar-goto-menu [find-tag]
 357   '(menu-item "Find Tag..." find-tag
 358               :help "Find definition of function or variable"))
 359
 360 (define-key menu-bar-goto-menu [separator-tags]
 361   '(menu-item "--"))
 362
 363 (define-key menu-bar-goto-menu [end-of-buf]
 364   '(menu-item "Goto End of Buffer" end-of-buffer))
 365 (define-key menu-bar-goto-menu [beg-of-buf]
 366   '(menu-item "Goto Beginning of Buffer" beginning-of-buffer))
 367 (define-key menu-bar-goto-menu [go-to-pos]
 368   '(menu-item "Goto Buffer Position..." goto-char
 369               :help "Read a number N and go to buffer position N"))
 370 (define-key menu-bar-goto-menu [go-to-line]
 371   '(menu-item "Goto Line..." goto-line
 372               :help "Read a line number and go to that line"))
 373
 374 (define-key menu-bar-edit-menu [goto]
 375   (list 'menu-item "Go To" menu-bar-goto-menu))
 376
 377 (define-key menu-bar-edit-menu [search]
 378   (list 'menu-item "Search" menu-bar-search-menu))
 379
 380 (define-key menu-bar-edit-menu [separator-search]
 381   '(menu-item "--"))
 382
 383 (define-key menu-bar-edit-menu [mark-whole-buffer]
 384   '(menu-item "Select All" mark-whole-buffer
 385               :help "Mark the whole buffer for a subsequent cut/copy."))
 386 (define-key menu-bar-edit-menu [clear]
 387   '(menu-item "Clear" delete-region
 388               :enable (and mark-active
 389                            (not buffer-read-only)
 390                            (not (mouse-region-match)))
 391               :help
 392               "Delete the text in region between mark and current position"))
 393 (defvar yank-menu (cons "Select Yank" nil))
 394 (fset 'yank-menu (cons 'keymap yank-menu))
 395 (define-key menu-bar-edit-menu [select-paste]
 396   '(menu-item "Select and Paste" yank-menu
 397               :enable (and (cdr yank-menu) (not buffer-read-only))
 398               :help "Paste (yank) text cut or copied earlier"))
 399 (define-key menu-bar-edit-menu [paste]
 400   '(menu-item "Paste" yank
 401               :enable (and
 402                        ;; Emacs compiled --without-x doesn't have
 403                        ;; x-selection-exists-p.
 404                        (fboundp 'x-selection-exists-p)
 405                        (x-selection-exists-p) (not buffer-read-only))
 406               :help "Paste (yank) text most recently cut/copied"))
 407 (define-key menu-bar-edit-menu [copy]
 408   '(menu-item "Copy" menu-bar-kill-ring-save
 409               :enable mark-active
 410               :help "Copy text in region between mark and current position"
 411               :keys "\\[kill-ring-save]"))
 412 (define-key menu-bar-edit-menu [cut]
 413   '(menu-item "Cut" kill-region
 414               :enable (and mark-active (not buffer-read-only))
 415               :help
 416               "Cut (kill) text in region between mark and current position"))
 417 (define-key menu-bar-edit-menu [undo]
 418   '(menu-item "Undo" undo
 419               :enable (and (not buffer-read-only)
 420                            (not (eq t buffer-undo-list))
 421                            (if (eq last-command 'undo)
 422                                pending-undo-list
 423                              (consp buffer-undo-list)))
 424               :help "Undo last operation"))
 425
 426
 427 (defun menu-bar-kill-ring-save (beg end)
 428   (interactive "r")
 429   (if (mouse-region-match)
 430       (message "Selecting a region with the mouse does `copy' automatically")
 431     (kill-ring-save beg end)))
 432
 433 (autoload 'ispell-menu-map "ispell" nil t 'keymap)
 434
 435 ;; These are alternative definitions for the cut, paste and copy
 436 ;; menu items.  Use them if your system expects these to use the clipboard.
 437
 438 (put 'clipboard-kill-region 'menu-enable 'mark-active)
 439 (put 'clipboard-kill-ring-save 'menu-enable 'mark-active)
 440 (put 'clipboard-yank 'menu-enable
 441      '(or (and (fboundp 'x-selection-exists-p) (x-selection-exists-p))
 442           (x-selection-exists-p 'CLIPBOARD)))
 443
 444 (defun clipboard-yank ()
 445   "Insert the clipboard contents, or the last stretch of killed text."
 446   (interactive)
 447   (let ((x-select-enable-clipboard t))
 448     (yank)))
 449
 450 (defun clipboard-kill-ring-save (beg end)
 451   "Copy region to kill ring, and save in the X clipboard."
 452   (interactive "r")
 453   (let ((x-select-enable-clipboard t))
 454     (kill-ring-save beg end)))
 455
 456 (defun clipboard-kill-region (beg end)
 457   "Kill the region, and save it in the X clipboard."
 458   (interactive "r")
 459   (let ((x-select-enable-clipboard t))
 460     (kill-region beg end)))
 461
 462 (defun menu-bar-enable-clipboard ()
 463   "Make CUT, PASTE and COPY (keys and menu bar items) use the clipboard.
 464 Do the same for the keys of the same name."
 465   (interactive)
 466   ;; We can't use constant list structure here because it becomes pure,
 467   ;; and because it gets modified with cache data.
 468   (define-key menu-bar-edit-menu [paste]
 469     (cons "Paste" (cons "Paste text from clipboard" 'clipboard-yank)))
 470   (define-key menu-bar-edit-menu [copy]
 471     (cons "Copy" (cons "Copy text in region to the clipboard"
 472                        'clipboard-kill-ring-save)))
 473   (define-key menu-bar-edit-menu [cut]
 474     (cons "Cut" (cons "Delete text in region and copy it to the clipboard"
 475                       'clipboard-kill-region)))
 476
 477   (define-key global-map [f20] 'clipboard-kill-region)
 478   (define-key global-map [f16] 'clipboard-kill-ring-save)
 479   (define-key global-map [f18] 'clipboard-yank)
 480   ;; X11R6 versions
 481   (define-key global-map [cut] 'clipboard-kill-region)
 482   (define-key global-map [copy] 'clipboard-kill-ring-save)
 483   (define-key global-map [paste] 'clipboard-yank))
 484 \f
 485 ;; The "Options" menu items
 486
 487 (defvar menu-bar-custom-menu (make-sparse-keymap "Customize"))
 488
 489 (define-key menu-bar-custom-menu [customize-apropos-groups]
 490   '(menu-item "Groups Matching Regexp..." customize-apropos-groups
 491               :help "Browse groups whose names match regexp"))
 492 (define-key menu-bar-custom-menu [customize-apropos-faces]
 493   '(menu-item "Faces Matching Regexp..." customize-apropos-faces
 494               :help "Browse faces whose names match regexp"))
 495 (define-key menu-bar-custom-menu [customize-apropos-options]
 496   '(menu-item "Options Matching Regexp..." customize-apropos-options
 497               :help "Browse options whose names match regexp"))
 498 (define-key menu-bar-custom-menu [customize-apropos]
 499   '(menu-item "Settings Matching Regexp..." customize-apropos
 500               :help "Browse customizable settings whose names match regexp"))
 501 (define-key menu-bar-custom-menu [separator-2]
 502   '("--"))
 503 (define-key menu-bar-custom-menu [customize-group]
 504   '(menu-item "Specific Group..." customize-group
 505               :help "Customize settings of specific group"))
 506 (define-key menu-bar-custom-menu [customize-face]
 507   '(menu-item "Specific Face..." customize-face
 508               :help "Customize attributes of specific face"))
 509 (define-key menu-bar-custom-menu [customize-option]
 510   '(menu-item "Specific Option..." customize-option
 511               :help "Change value of specific option"))
 512 (define-key menu-bar-custom-menu [customize-changed-options]
 513   '(menu-item "Recently Changed Options..." customize-changed-options
 514               :help "Customize options changed in recent versions"))
 515 (define-key menu-bar-custom-menu [separator-3]
 516   '("--"))
 517 (define-key menu-bar-custom-menu [customize-browse]
 518   '(menu-item "Browse Customization Groups" customize-browse
 519               :help "Browse all customization groups"))
 520 (define-key menu-bar-custom-menu [customize]
 521   '(menu-item "Top-level Customization Group" customize
 522               :help "The master group called `Emacs'"))
 523
 524 ;(defvar menu-bar-preferences-menu (make-sparse-keymap "Preferences"))
 525
 526 (defmacro menu-bar-make-toggle (name variable doc message help &rest body)
 527   `(progn
 528      (defun ,name ()
 529        ,(concat "Toggle whether to " (downcase (substring help 0 1))
 530                 (substring help 1) ".")
 531        (interactive)
 532        (if ,(if body `(progn . ,body)
 533               `(setq ,variable (not ,variable)))
 534            (message ,message "enabled")
 535          (message ,message "disabled")))
 536      '(menu-item ,doc ,name
 537                  :help ,help
 538                  :button (:toggle . (and (boundp ',variable) ,variable)))))
 539
 540 ;;; Assemble all the top-level items of the "Options" menu
 541 (define-key menu-bar-options-menu [customize]
 542   (list 'menu-item "Customize Emacs" menu-bar-custom-menu
 543         :help "Full customization of every Emacs feature"))
 544
 545 (defun menu-bar-options-save ()
 546   "Save current values of Options menu items using Custom."
 547   (interactive)
 548   (dolist (elt '(debug-on-quit debug-on-error auto-compression-mode
 549                  case-fold-search truncate-lines show-paren-mode
 550                  transient-mark-mode global-font-lock-mode
 551                  current-language-environment default-input-method
 552                  default-frame-alist))
 553     (if (default-value elt)
 554         (customize-save-variable elt (default-value elt))))
 555   (if (memq 'turn-on-auto-fill text-mode-hook)
 556       (customize-save-variable 'text-mode-hook
 557                                (default-value 'text-mode-hook)))
 558   (if (featurep 'saveplace)
 559       (customize-save-variable 'save-place (default-value 'save-place)))
 560   (if (featurep 'uniquify)
 561       (customize-save-variable 'uniquify-buffer-name-style
 562                                (default-value 'uniquify-buffer-name-style))))
 563
 564 (define-key menu-bar-options-menu [save]
 565   '(menu-item "Save Options" menu-bar-options-save
 566               :help "Save options set from the menu above"))
 567
 568 (define-key menu-bar-options-menu [custom-separator]
 569   '("--"))
 570
 571 ;; The "Show/Hide" submenu of menu "Options"
 572
 573 (defvar menu-bar-showhide-menu (make-sparse-keymap "Show/Hide"))
 574 (defvar menu-bar-showhide-scroll-bar-menu (make-sparse-keymap "Scroll-bar"))
 575
 576 (defun menu-bar-scroll-bar-right ()
 577   "Turn on the scroll-bar on the right side."
 578   (interactive)
 579   (set-scroll-bar-mode 'right))
 580
 581 (defun menu-bar-scroll-bar-left ()
 582   "Turn on the scroll-bar on the left side."
 583   (interactive)
 584   (set-scroll-bar-mode 'left))
 585
 586 (defun menu-bar-scroll-bar-none ()
 587   "Turn off the scroll-bar."
 588   (interactive)
 589   (set-scroll-bar-mode nil))
 590
 591 (define-key menu-bar-showhide-scroll-bar-menu [right]
 592   '(menu-item "On the Right" menu-bar-scroll-bar-right
 593               :help "Scroll-bar on the right side"
 594               :visible window-system
 595               :button (:radio . (eq (cdr (assq 'vertical-scroll-bars (frame-parameters))) 'right))))
 596
 597 (define-key menu-bar-showhide-scroll-bar-menu [left]
 598   '(menu-item "On the Left" menu-bar-scroll-bar-left
 599               :help "Scroll-bar on the left side"
 600               :visible window-system
 601               :button (:radio . (eq (cdr (assq 'vertical-scroll-bars (frame-parameters))) 'left))))
 602
 603 (define-key menu-bar-showhide-scroll-bar-menu [none]
 604   '(menu-item "None" menu-bar-scroll-bar-none
 605               :help "Turn off scroll-bar"
 606               :visible window-system
 607               :button (:radio . (eq (cdr (assq 'vertical-scroll-bars (frame-parameters))) nil))))
 608
 609 (define-key menu-bar-showhide-menu [showhide-scroll-bar]
 610   (list 'menu-item "Scroll-Bar" menu-bar-showhide-scroll-bar-menu
 611         :visible 'window-system
 612         :help "Select scroll-bar mode"))
 613
 614 (defun showhide-menu-bar ()
 615   "Toggle whether to turn menu-bar on/off."
 616   (interactive)
 617   (menu-bar-mode)
 618   (if menu-bar-mode
 619       (message "Menu-bar mode enabled.")
 620     (message "Menu-bar mode disabled.  Use M-x menu-bar-mode to make the menu bar appear.")))
 621
 622 (define-key menu-bar-showhide-menu [showhide-menu-bar]
 623   '(menu-item "Menu-bar" showhide-menu-bar
 624               :help "Toggle menu-bar on/off"
 625               :button (:toggle . menu-bar-mode)))
 626
 627 (defun showhide-tool-bar ()
 628   "Toggle whether to turn tool-bar on/off."
 629   (interactive)
 630   (if (tool-bar-mode)
 631       (message "Tool-bar mode enabled.")
 632     (message "Tool-bar mode disabled.")))
 633
 634 (define-key menu-bar-showhide-menu [showhide-tool-bar]
 635   '(menu-item "Tool-bar" showhide-tool-bar
 636               :help "Turn tool-bar on/off"
 637               :visible window-system
 638               :button (:toggle . tool-bar-mode)))
 639
 640 (define-key menu-bar-options-menu [showhide]
 641   (list 'menu-item "Show/Hide" menu-bar-showhide-menu
 642         :help "Toggle on/off various display features"))
 643
 644 (define-key menu-bar-options-menu [showhide-separator]
 645   '("--"))
 646
 647 (define-key menu-bar-options-menu [mule]
 648   ;; It is better not to use backquote here,
 649   ;; because that makes a bootstrapping problem
 650   ;; if you need to recompile all the Lisp files using interpreted code.
 651   (list 'menu-item "Mule (Multilingual Environment)" mule-menu-keymap
 652 ;; Most of the MULE menu actually does make sense in unibyte mode,
 653 ;; e.g. language selection.
 654 ;;;     ':visible 'default-enable-multibyte-characters
 655         ':help "Default language, encodings, input method"))
 656 ;(setq menu-bar-final-items (cons 'mule menu-bar-final-items))
 657 ;(define-key menu-bar-options-menu [preferences]
 658 ;  (list 'menu-item "Preferences" menu-bar-preferences-menu
 659 ;       :help "Toggle important global options"))
 660
 661 (define-key menu-bar-options-menu [mule-separator]
 662   '("--"))
 663
 664 (define-key menu-bar-options-menu [debug-on-quit]
 665   (menu-bar-make-toggle toggle-debug-on-quit debug-on-quit
 666                         "Enter Debugger on Quit/C-g" "Debug on Quit %s"
 667                         "Enter Lisp debugger when C-g is pressed"))
 668 (define-key menu-bar-options-menu [debug-on-error]
 669   (menu-bar-make-toggle toggle-debug-on-error debug-on-error
 670                         "Enter Debugger on Error" "Debug on Error %s"
 671                         "Enter Lisp debugger when an error is signaled"))
 672 (define-key menu-bar-options-menu [debugger-separator]
 673   '("--"))
 674 (define-key menu-bar-options-menu [toggle-auto-compression]
 675   '(menu-item "Automatic File De/compression"
 676              auto-compression-mode
 677              :help "Transparently decompress compressed files"
 678              :button (:toggle . (rassq 'jka-compr-handler
 679                                        file-name-handler-alist))))
 680 (define-key menu-bar-options-menu [save-place]
 681   (menu-bar-make-toggle toggle-save-place-globally save-place
 682                         "Save Place in Files between Sessions"
 683                         "Saving place in files %s"
 684                         "Save Emacs state for next session"
 685                         (require 'saveplace)
 686                         (setq-default save-place
 687                                       (not (default-value save-place)))))
 688 (define-key menu-bar-options-menu [uniquify]
 689   (menu-bar-make-toggle toggle-uniquify-buffer-names uniquify-buffer-name-style
 690                         "Use Directory Names in Buffer Names"
 691                         "Directory name in buffer names (uniquify) %s"
 692                         "Uniquify buffer names by adding parent directory names"
 693                         (require 'uniquify)
 694                         (setq uniquify-buffer-name-style
 695                               (if (not uniquify-buffer-name-style)
 696                                   'forward))))
 697 (define-key menu-bar-options-menu [edit-options-separator]
 698   '("--"))
 699 (define-key menu-bar-options-menu [case-fold-search]
 700   (menu-bar-make-toggle toggle-case-fold-search case-fold-search
 701                         "Case-Insensitive Search"
 702                         "Case-Insensitive Search %s"
 703                         "Ignore letter-case in search"))
 704 (define-key menu-bar-options-menu [auto-fill-mode]
 705   '(menu-item "Word Wrap in Text Modes (Auto Fill)"
 706               toggle-text-mode-auto-fill
 707               :help "Automatically fill text between left and right margins"
 708               :button (:toggle . (member 'turn-on-auto-fill text-mode-hook))))
 709 (define-key menu-bar-options-menu [truncate-lines]
 710   (menu-bar-make-toggle
 711    toggle-truncate-lines truncate-lines
 712    "Truncate Long Lines in this Buffer" "Long Line Truncation %s"
 713    "Truncate long lines on the screen"
 714    (prog1 (setq truncate-lines (not truncate-lines))
 715      (set-buffer-modified-p (buffer-modified-p)))))
 716 (define-key menu-bar-options-menu [highlight-separator]
 717   '("--"))
 718 (define-key menu-bar-options-menu [highlight-paren-mode]
 719   (menu-bar-make-toggle toggle-highlight-paren-mode show-paren-mode
 720                         "Paren Match Highlighting (Show Paren mode)"
 721                         "Show Paren mode %s"
 722                         "Highlight matching/mismatched parentheses at cursor"
 723                         (show-paren-mode)))
 724 (define-key menu-bar-options-menu [transient-mark-mode]
 725   (menu-bar-make-toggle toggle-transient-mark-mode transient-mark-mode
 726                         "Active Region Highlighting (Transient Mark mode)"
 727                         "Transient Mark mode %s"
 728                         "Make text in active region stand out in color"))
 729 (define-key menu-bar-options-menu [toggle-global-lazy-font-lock-mode]
 730   (menu-bar-make-toggle toggle-global-lazy-font-lock-mode global-font-lock-mode
 731                         "Syntax Highlighting (Global Font Lock mode)"
 732                         "Global Font Lock mode %s"
 733                         "Colorize text based on language syntax"
 734                         (global-font-lock-mode)))
 735
 736 \f
 737 ;; The "Tools" menu items
 738
 739 (defun send-mail-item-name ()
 740   (let* ((known-send-mail-commands '((sendmail-user-agent . "sendmail")
 741                                      (mh-e-user-agent . "MH")
 742                                      (message-user-agent . "Gnus Message")
 743                                      (gnus-user-agent . "Gnus")))
 744          (name (assq mail-user-agent known-send-mail-commands)))
 745     (if name
 746         (setq name (cdr name))
 747       (setq name (symbol-name mail-user-agent))
 748       (if (string-match "\\(.+\\)-user-agent" name)
 749           (setq name (match-string 1 name))))
 750     name))
 751
 752 (defun read-mail-item-name ()
 753   (let* ((known-rmail-commands '((rmail . "RMAIL")
 754                                  (mh-rmail . "MH")
 755                                  (gnus . "Gnus")))
 756          (known (assq read-mail-command known-rmail-commands)))
 757     (if known (cdr known) (symbol-name read-mail-command))))
 758
 759 (defvar menu-bar-games-menu (make-sparse-keymap "Games"))
 760
 761 (define-key menu-bar-tools-menu [games]
 762   (list 'menu-item "Games" menu-bar-games-menu))
 763
 764 (define-key menu-bar-tools-menu [separator-games]
 765   '("--"))
 766
 767 (define-key menu-bar-games-menu [zone]
 768   '(menu-item "Zone Out"  zone
 769               :help "Play tricks with Emacs display when Emacs is idle"))
 770 (define-key menu-bar-games-menu [yow]
 771   '(menu-item "Random Quotation"  yow
 772               :help "Display a random Zippy quotation"))
 773 (define-key menu-bar-games-menu [tetris]
 774   '(menu-item "Tetris"  tetris))
 775 (define-key menu-bar-games-menu [solitaire]
 776   '(menu-item "Solitaire"  solitaire))
 777 (define-key menu-bar-games-menu [snake]
 778   '(menu-item "Snake"  snake
 779               :help "Move snake around avoiding collisions"))
 780 (define-key menu-bar-games-menu [mult]
 781   '(menu-item "Multiplication Puzzle"  mpuz
 782               :help "Excercise brain with multiplication"))
 783 (define-key menu-bar-games-menu [life]
 784   '(menu-item "Life"  life
 785               :help "Watch how John Conway's cellular automaton evolves"))
 786 (define-key menu-bar-games-menu [hanoi]
 787   '(menu-item "Towers of Hanoi" hanoi
 788               :help "Watch Towers-of-Hanoi puzzle solved by Emacs"))
 789 (define-key menu-bar-games-menu [gomoku]
 790   '(menu-item "Gomoku"  gomoku
 791               :help "Mark 5 contiguous squares (like tic-tac-toe)"))
 792 (define-key menu-bar-games-menu [black-box]
 793   '(menu-item "Blackbox"  blackbox
 794               :help "Find balls in a black box by shooting rays"))
 795 (define-key menu-bar-games-menu [adventure]
 796   '(menu-item "Adventure"  dunnet
 797               :help "Dunnet, a text Adventure game for Emacs"))
 798 (define-key menu-bar-games-menu [5x5]
 799   '(menu-item "5x5" 5x5
 800               :help "Fill in all the squares on a 5x5 board"))
 801
 802 (define-key menu-bar-tools-menu [calendar]
 803   '(menu-item "Display Calendar" calendar))
 804 (define-key menu-bar-tools-menu [speedbar]
 805   '(menu-item "Display Speedbar" speedbar-frame-mode))
 806 (define-key menu-bar-tools-menu [directory-search]
 807   '(menu-item "Directory Search" eudc-tools-menu
 808               :help "Query directory servers via LDAP, CCSO PH/QI or BBDB"))
 809 (define-key menu-bar-tools-menu [compose-mail]
 810   (list
 811    'menu-item `(format "Send Mail (with %s)" (send-mail-item-name))
 812    'compose-mail
 813    :visible `(and mail-user-agent (not (eq mail-user-agent 'ignore)))
 814    :help "Send a mail message"))
 815 (define-key menu-bar-tools-menu [rmail]
 816   (list
 817    'menu-item `(format "Read Mail (with %s)" (read-mail-item-name))
 818    (lambda ()
 819      (interactive)
 820      (call-interactively read-mail-command))
 821    :visible `(and read-mail-command (not (eq read-mail-command 'ignore)))
 822    :help "Read your mail and reply to it"))
 823 (define-key menu-bar-tools-menu [gnus]
 824   '(menu-item "Read Net News (Gnus)" gnus
 825               :help "Read network news groups"))
 826
 827 (define-key menu-bar-tools-menu [separator-vc]
 828   '("--"))
 829
 830 (defvar vc-menu-map (make-sparse-keymap "Version Control"))
 831 (define-key menu-bar-tools-menu [pcl-cvs]
 832   `(menu-item "PCL-CVS" ,cvs-global-menu
 833               :help "Module-level interface to CVS"))
 834 (define-key menu-bar-tools-menu [vc]
 835   (list 'menu-item "Version Control" vc-menu-map
 836         :help "Interface to RCS, CVS, SCCS"))
 837
 838 (define-key menu-bar-tools-menu [separator-compare]
 839   '("--"))
 840
 841 (define-key menu-bar-tools-menu [ediff-misc]
 842   '(menu-item "Ediff Miscellanea" menu-bar-ediff-misc-menu
 843               :help "Ediff manual, customization, sessions, etc."))
 844 (define-key menu-bar-tools-menu [epatch]
 845   '(menu-item "Apply Patch" menu-bar-epatch-menu))
 846 (define-key menu-bar-tools-menu [ediff-merge]
 847   '(menu-item "Merge" menu-bar-ediff-merge-menu
 848               :help "Merge different revisions of files/directories"))
 849 (define-key menu-bar-tools-menu [compare]
 850   '(menu-item "Compare (Ediff)" menu-bar-ediff-menu
 851               :help "Display differences between files/directories"))
 852
 853
 854 (define-key menu-bar-tools-menu [separator-spell]
 855   '("--"))
 856
 857 (define-key menu-bar-tools-menu [spell]
 858   '(menu-item "Spell Checking" ispell-menu-map))
 859
 860 (define-key menu-bar-tools-menu [separator-prog]
 861   '("--"))
 862
 863 (define-key menu-bar-tools-menu [gdb]
 864   '(menu-item "Debugger (GUD)..." gdb
 865               :help "Debug a program from within Emacs"))
 866 (define-key menu-bar-tools-menu [shell-on-region]
 867   '(menu-item "Shell Command on Region..." shell-command-on-region
 868               :enable mark-active
 869               :help "Pass marked region to a shell command"))
 870 (define-key menu-bar-tools-menu [shell]
 871   '(menu-item "Shell Command..." shell-command
 872               :help "Invoke a shell command and catch its output"))
 873 (define-key menu-bar-tools-menu [compile]
 874   '(menu-item "Compile..." compile
 875               :help "Invoke compiler or Make, view compilation errors"))
 876 (define-key menu-bar-tools-menu [grep]
 877   '(menu-item "Search Files (Grep)..." grep
 878               :help "Search files for strings or regexps (with Grep)"))
 879
 880 \f
 881 ;; The "Help" menu items
 882
 883 (defvar menu-bar-describe-menu (make-sparse-keymap "Describe"))
 884
 885 (define-key menu-bar-describe-menu [mule-diag]
 886   '(menu-item "Show All of Mule Status" mule-diag
 887               :visible default-enable-multibyte-characters
 888               :help "Display multilingual environment settings"))
 889 (define-key menu-bar-describe-menu [describe-coding-system-briefly]
 890   '(menu-item "Describe Coding System (Briefly)..."
 891               describe-current-coding-system-briefly
 892               :visible default-enable-multibyte-characters))
 893 (define-key menu-bar-describe-menu [describe-coding-system]
 894   '(menu-item "Describe Coding System..." describe-coding-system
 895               :visible default-enable-multibyte-characters))
 896 (define-key menu-bar-describe-menu [describe-input-method]
 897   '(menu-item "Describe Input Method..." describe-input-method
 898               :visible default-enable-multibyte-characters
 899               :help "Keyboard layout for specific input method"))
 900 (define-key menu-bar-describe-menu [describe-language-environment]
 901   (list 'menu-item "Describe Language Environment"
 902         describe-language-environment-map
 903         :help "Show multilingual settings for a specific language"))
 904
 905 (define-key menu-bar-describe-menu [separator-desc-mule]
 906   '("--"))
 907
 908 (define-key menu-bar-describe-menu [list-keybindings]
 909   '(menu-item "List Key Bindings" describe-bindings
 910               :help "Display a list of all current keybindings"))
 911 (define-key menu-bar-describe-menu [describe-current-display-table]
 912   '(menu-item "Describe Display Table" describe-current-display-table
 913               :help "Describe the current display table"))
 914 (define-key menu-bar-describe-menu [describe-face]
 915   '(menu-item "Describe Face..." describe-face
 916               :help "Display the properties of a face"))
 917 (define-key menu-bar-describe-menu [describe-variable]
 918   '(menu-item "Describe Variable..." describe-variable
 919               :help "Display documentation of variable/option"))
 920 (define-key menu-bar-describe-menu [describe-function]
 921   '(menu-item "Describe Function..." describe-function
 922               :help "Display documentation of function/command"))
 923 (define-key menu-bar-describe-menu [describe-key]
 924   '(menu-item "Describe Key..." describe-key
 925               ;; Users typically don't identify keys and menu items...
 926               :help "Display documentation of command bound to a \
 927 key (or menu-item)"))
 928 (define-key menu-bar-describe-menu [describe-mode]
 929   '(menu-item "Describe Buffer Modes" describe-mode
 930               :help "Describe this buffer's major and minor mode"))
 931
 932 (defvar menu-bar-apropos-menu (make-sparse-keymap "Apropos"))
 933 (defun menu-bar-read-lispref ()
 934   "Display the Emacs Lisp Reference manual in Info mode."
 935   (interactive)
 936   (info "elisp"))
 937
 938 (defun menu-bar-read-lispintro ()
 939   "Display the Introduction to Emacs Lisp Programming in Info mode."
 940   (interactive)
 941   (info "eintr"))
 942
 943 (defun menu-bar-read-emacs-man ()
 944   "Display Emacs User Manual in Info mode."
 945   (interactive)
 946   (info "emacs"))
 947
 948 (defun search-emacs-glossary ()
 949   "Display the Glossary node of the Emacs manual in Info mode."
 950   (interactive)
 951   (info "(emacs)Glossary"))
 952
 953 (defun emacs-index-search (topic)
 954   "Look up TOPIC in the indices of the Emacs User Manual."
 955   (interactive "sSubject to look up: ")
 956   (info "emacs")
 957   (Info-index topic))
 958
 959 (defun elisp-index-search (topic)
 960   "Look up TOPIC in the indices of the Emacs Lisp Reference Manual."
 961   (interactive "sSubject to look up: ")
 962   (info "elisp")
 963   (Info-index topic))
 964
 965 (define-key menu-bar-apropos-menu [apropos-documentation]
 966   '(menu-item "Search Documentation Strings..." apropos-documentation
 967               :help
 968               "Find functions and variables whose doc strings match a regexp"))
 969 (define-key menu-bar-apropos-menu [apropos]
 970   '(menu-item "Find Any Object by Name..."  apropos
 971               :help "Find symbols of any kind whose names match a regexp"))
 972 (define-key menu-bar-apropos-menu [apropos-value]
 973   '(menu-item "Find Options by Value..." apropos-value
 974               :help "Find variables whose values match a regexp"))
 975 (define-key menu-bar-apropos-menu [apropos-variables]
 976   '(menu-item "Find Options by Name..." apropos-variable
 977               :help "Find variables whose names match a regexp"))
 978 (define-key menu-bar-apropos-menu [apropos-commands]
 979   '(menu-item "Find Commands by Name..." apropos-command
 980               :help "Find commands whose names match a regexp"))
 981 (define-key menu-bar-apropos-menu [sep1]
 982   '("--"))
 983 (define-key menu-bar-apropos-menu [elisp-index-search]
 984   '(menu-item "Look Up Subject in ELisp Manual..." elisp-index-search
 985               :help "Find description of a subject in Emacs Lisp manual"))
 986 (define-key menu-bar-apropos-menu [emacs-index-search]
 987   '(menu-item "Look Up Subject in User Manual..." emacs-index-search
 988               :help "Find description of a subject in Emacs User manual"))
 989 (define-key menu-bar-apropos-menu [emacs-glossary]
 990   '(menu-item "Emacs Terminology" search-emacs-glossary
 991               :help "Display the Glossary section of the Emacs manual"))
 992
 993 (defvar menu-bar-manuals-menu (make-sparse-keymap "More Manuals"))
 994
 995 (define-key menu-bar-manuals-menu [man]
 996   '(menu-item "Read Man Page..." manual-entry
 997               :help "Man-page docs for external commands and libraries"))
 998 (define-key menu-bar-manuals-menu [sep2]
 999   '("--"))
1000 (define-key menu-bar-manuals-menu [order-emacs-manuals]
1001   '(menu-item "Ordering Manuals" view-order-manuals
1002               :help "How to order manuals from the Free Software Foundation"))
1003 (define-key menu-bar-manuals-menu [info]
1004   '(menu-item "All Other Manuals (Info)" Info-directory
1005               :help "Read any of the installed manuals"))
1006 (define-key menu-bar-manuals-menu [info-elisp]
1007   '(menu-item "Emacs Lisp Reference" menu-bar-read-lispref
1008               :help "Read the Emacs Lisp Reference manual"))
1009 (define-key menu-bar-manuals-menu [info-elintro]
1010   '(menu-item "Introduction to Emacs Lisp" menu-bar-read-lispintro
1011               :help "Read the Introduction to Emacs Lisp Programming"))
1012 (define-key menu-bar-manuals-menu [sep3]
1013   '("--"))
1014 (define-key menu-bar-manuals-menu [command]
1015   '(menu-item "Find Command in Manual" Info-goto-emacs-command-node
1016               :help "Display manual section that describes a command"))
1017 (define-key menu-bar-manuals-menu [key]
1018   '(menu-item "Find Key in Manual" Info-goto-emacs-key-command-node
1019               :help "Display manual section that describes a key"))
1020
1021 (define-key menu-bar-help-menu [eliza]
1022   '(menu-item "Emacs Psychiatrist" doctor
1023               :help "Our doctor will help you feel better"))
1024 (define-key menu-bar-help-menu [sep4]
1025   '("--"))
1026 (define-key menu-bar-help-menu [describe-no-warranty]
1027   '(menu-item "(Non)Warranty" describe-no-warranty
1028               :help "Explain that Emacs has NO WARRANTY"))
1029 (define-key menu-bar-help-menu [describe-copying]
1030   '(menu-item "Copying Conditions" describe-copying
1031               :help "Show the Emacs license (GPL)"))
1032 (define-key menu-bar-help-menu [describe-distribution]
1033   '(menu-item "Getting New Versions" describe-distribution
1034               :help "How to get latest versions of Emacs"))
1035 (define-key menu-bar-help-menu [more]
1036   '(menu-item "Find Extra Packages"
1037               (lambda ()
1038                 (interactive)
1039                 (let (enable-local-variables)
1040                   (view-file (expand-file-name "MORE.STUFF"
1041                                                data-directory))
1042                   (goto-address)))
1043               :help "Where to find some extra packages and possible updates"))
1044 (define-key menu-bar-help-menu [about]
1045   '(menu-item "About Emacs" display-splash-screen
1046               :help "Display splash screen, version, and instructions"))
1047 (define-key menu-bar-help-menu [sep2]
1048   '("--"))
1049 (define-key menu-bar-help-menu [finder-by-keyword]
1050   '(menu-item "Find Emacs Packages..." finder-by-keyword
1051               :help "Find packages and features by keyword"))
1052 (define-key menu-bar-help-menu [manuals]
1053   (list 'menu-item "More Manuals" menu-bar-manuals-menu
1054         :help "Search and browse on-line manuals"))
1055 (define-key menu-bar-help-menu [emacs-manual]
1056   '(menu-item "Read the Emacs Manual" menu-bar-read-emacs-man
1057               :help "Full documentation of Emacs features"))
1058 (define-key menu-bar-help-menu [describe]
1059   (list 'menu-item "Describe" menu-bar-describe-menu
1060         :help "Describe commands, variables, keys"))
1061 (define-key menu-bar-help-menu [apropos]
1062   (list 'menu-item "Search Documentation" menu-bar-apropos-menu
1063         :help "Look up terms, find commands, options, etc. (Apropos)"))
1064 (define-key menu-bar-help-menu [sep1]
1065   '("--"))
1066 (define-key menu-bar-help-menu [report-emacs-bug]
1067   '(menu-item "Send Bug Report..." report-emacs-bug
1068               :help "Send e-mail to Emacs maintainers"))
1069 (define-key menu-bar-help-menu [emacs-problems]
1070   '(menu-item "Emacs Known Problems" view-emacs-problems))
1071 (define-key menu-bar-help-menu [emacs-news]
1072   '(menu-item "Emacs News" view-emacs-news
1073               :help "New features of this version"))
1074 (define-key menu-bar-help-menu [emacs-faq]
1075   '(menu-item "Emacs FAQ" view-emacs-FAQ))
1076 (define-key menu-bar-help-menu [emacs-tutorial-language-specific]
1077   '(menu-item "Emacs Tutorial (choose language)..."
1078               (lambda () (interactive) (help-with-tutorial t))
1079               :help "Learn how to use Emacs (choose a language)"))
1080 (define-key menu-bar-help-menu [emacs-tutorial]
1081   '(menu-item "Emacs Tutorial" help-with-tutorial
1082               :help "Learn how to use Emacs"))
1083
1084 (defun kill-this-buffer ()      ; for the menubar
1085   "Kill the current buffer."
1086   (interactive)
1087   (kill-buffer (current-buffer)))
1088
1089 (defun kill-this-buffer-enabled-p ()
1090   (let ((count 0)
1091         (buffers (buffer-list)))
1092     (while buffers
1093       (or (string-match "^ " (buffer-name (car buffers)))
1094           (setq count (1+ count)))
1095       (setq buffers (cdr buffers)))
1096     (and (not (window-minibuffer-p (frame-selected-window menu-updating-frame)))
1097          (> count 1))))
1098
1099 (put 'dired 'menu-enable
1100      '(not (window-minibuffer-p (frame-selected-window menu-updating-frame))))
1101
1102 ;; Permit deleting frame if it would leave a visible or iconified frame.
1103 (defun delete-frame-enabled-p ()
1104   "Return non-nil if `delete-frame' should be enabled in the menu bar."
1105   (let ((frames (frame-list))
1106         (count 0))
1107     (while frames
1108       (if (frame-visible-p (car frames))
1109           (setq count (1+ count)))
1110       (setq frames (cdr frames)))
1111     (> count 1)))
1112
1113 (defcustom yank-menu-length 20
1114   "*Maximum length to display in the yank-menu."
1115   :type 'integer
1116   :group 'mouse)
1117
1118 (defun menu-bar-update-yank-menu (string old)
1119   (let ((front (car (cdr yank-menu)))
1120         (menu-string (if (<= (length string) yank-menu-length)
1121                          string
1122                        (concat
1123                         (substring string 0 (/ yank-menu-length 2))
1124                         "..."
1125                         (substring string (- (/ yank-menu-length 2)))))))
1126     ;; Don't let the menu string be all dashes
1127     ;; because that has a special meaning in a menu.
1128     (if (string-match "\\`-+\\'" menu-string)
1129         (setq menu-string (concat menu-string " ")))
1130     ;; If we're supposed to be extending an existing string, and that
1131     ;; string really is at the front of the menu, then update it in place.
1132     (if (and old (or (eq old (car front))
1133                      (string= old (car front))))
1134         (progn
1135           (setcar front string)
1136           (setcar (cdr front) menu-string))
1137       (setcdr yank-menu
1138               (cons
1139                (cons string (cons menu-string 'menu-bar-select-yank))
1140                (cdr yank-menu)))))
1141   (if (> (length (cdr yank-menu)) kill-ring-max)
1142       (setcdr (nthcdr kill-ring-max yank-menu) nil)))
1143
1144 (put 'menu-bar-select-yank 'apropos-inhibit t)
1145 (defun menu-bar-select-yank ()
1146   (interactive "*")
1147   (push-mark (point))
1148   (insert last-command-event))
1149 \f
1150 (defvar list-buffers-directory nil)
1151
1152 (defvar menu-bar-update-buffers-maxbuf)
1153
1154 (defun menu-bar-select-buffer ()
1155   (interactive)
1156   (switch-to-buffer last-command-event))
1157
1158 (defun menu-bar-select-frame ()
1159   (interactive)
1160   (let (frame)
1161     (dolist (f (frame-list))
1162       (when (equal last-command-event (frame-parameter f 'name))
1163         (setq frame f)))
1164   (make-frame-visible frame)
1165   (raise-frame frame)
1166   (select-frame frame)))
1167
1168 (defun menu-bar-update-buffers-1 (elt)
1169   (cons (format
1170          ;; (format "%%%ds  %%s%%s  %%s" menu-bar-update-buffers-maxbuf)
1171          "%s  %s%s  --  %s"
1172          (cdr elt)
1173          (if (buffer-modified-p (car elt))
1174              "*" " ")
1175          (save-excursion
1176            (set-buffer (car elt))
1177            (if buffer-read-only "%" " "))
1178          (let ((file
1179                 (or (buffer-file-name (car elt))
1180                     (save-excursion
1181                       (set-buffer (car elt))
1182                       list-buffers-directory)
1183                     "")))
1184            (setq file (or (file-name-directory file)
1185                           ""))
1186            (if (> (length file) 20)
1187                (setq file (concat "..." (substring file -17))))
1188            file))
1189         (car elt)))
1190
1191 (defvar menu-bar-buffers-menu-list-buffers-entry nil)
1192
1193 (defun menu-bar-update-buffers (&optional force)
1194   ;; If user discards the Buffers item, play along.
1195   (and (lookup-key (current-global-map) [menu-bar buffer])
1196        (or force (frame-or-buffer-changed-p))
1197        (let ((buffers (buffer-list))
1198              (frames (frame-list))
1199              (maxlen 0)
1200              buffers-menu frames-menu)
1201          ;; If requested, list only the N most recently selected buffers.
1202          (if (and (integerp buffers-menu-max-size)
1203                   (> buffers-menu-max-size 1))
1204              (if (> (length buffers) buffers-menu-max-size)
1205                  (setcdr (nthcdr buffers-menu-max-size buffers) nil)))
1206
1207          ;; Make the menu of buffers proper.
1208          (setq buffers-menu
1209                (cons "Select Buffer"
1210                      (let* ((buffer-list
1211                              (mapcar 'list buffers))
1212                             tail
1213                             (menu-bar-update-buffers-maxbuf 0)
1214                             alist
1215                             head)
1216                        ;; Put into each element of buffer-list
1217                        ;; the name for actual display,
1218                        ;; perhaps truncated in the middle.
1219                        (setq tail buffer-list)
1220                        (while tail
1221                          (let ((name (buffer-name (car (car tail)))))
1222                            (setcdr (car tail)
1223                                    (if (> (length name) 27)
1224                                        (concat (substring name 0 12)
1225                                                "..."
1226                                                (substring name -12))
1227                                      name)))
1228                          (setq tail (cdr tail)))
1229                        ;; Compute the maximum length of any name.
1230                        (setq tail buffer-list)
1231                        (while tail
1232                          (or (eq ?\ (aref (cdr (car tail)) 0))
1233                              (setq menu-bar-update-buffers-maxbuf
1234                                    (max menu-bar-update-buffers-maxbuf
1235                                         (length (cdr (car tail))))))
1236                          (setq tail (cdr tail)))
1237                        ;; Set ALIST to an alist of the form
1238                        ;; ITEM-STRING . BUFFER
1239                        (setq tail buffer-list)
1240                        (while tail
1241                          (let ((elt (car tail)))
1242                            (or (eq ?\ (aref (cdr elt) 0))
1243                                (setq alist (cons
1244                                             (menu-bar-update-buffers-1 elt)
1245                                             alist)))
1246                            (and alist (> (length (car (car alist))) maxlen)
1247                                 (setq maxlen (length (car (car alist))))))
1248                          (setq tail (cdr tail)))
1249                        (setq alist (nreverse alist))
1250                        ;; Make the menu item for list-buffers
1251                        ;; or reuse the one we already have.
1252                        ;; The advantage in reusing one
1253                        ;; is that it already has the keyboard equivalent
1254                        ;; cached, so we save the time to look that up again.
1255                        (or menu-bar-buffers-menu-list-buffers-entry
1256                            (setq menu-bar-buffers-menu-list-buffers-entry
1257                                  (cons
1258                                   'list-buffers
1259                                   (cons
1260                                    ""
1261                                    'list-buffers))))
1262                        ;; Update the item string for menu's new width.
1263                        (setcar (cdr menu-bar-buffers-menu-list-buffers-entry)
1264                                (concat (make-string (max (- (/ maxlen 2) 8) 0)
1265                                                     ?\ )
1266                                        "List All Buffers"))
1267                        ;; Now make the actual list of items,
1268                        ;; ending with the list-buffers item.
1269                        (nconc (mapcar (lambda (pair)
1270                                         ;; This is somewhat risque, to use
1271                                         ;; the buffer name itself as the event
1272                                         ;; type to define, but it works.
1273                                         ;; It would not work to use the buffer
1274                                         ;; since a buffer as an event has its
1275                                         ;; own meaning.
1276                                         (nconc (list (buffer-name (cdr pair))
1277                                                      (car pair)
1278                                                      (cons nil nil))
1279                                                'menu-bar-select-buffer))
1280                                       alist)
1281                               (list menu-bar-buffers-menu-list-buffers-entry)))))
1282
1283
1284          ;; Make a Frames menu if we have more than one frame.
1285          (if (cdr frames)
1286              (let ((name (concat (make-string (max (- (/ maxlen 2) 3) 0)
1287                                               ?\ )
1288                                  "Frames"))
1289                    (frames-menu
1290                     (cons 'keymap
1291                           (cons "Select Frame"
1292                                 (mapcar
1293                                  (lambda (frame)
1294                                    (nconc
1295                                     (list (frame-parameter frame 'name)
1296                                           (frame-parameter frame 'name)
1297                                           (cons nil nil))
1298                                           'menu-bar-select-frame))
1299                                         frames)))))
1300                ;; Put it underneath the Buffers menu.
1301                (setq buffers-menu (cons (cons 'frames (cons name frames-menu))
1302                                         buffers-menu))))
1303          (if buffers-menu
1304              (setq buffers-menu (cons 'keymap buffers-menu)))
1305          (define-key (current-global-map) [menu-bar buffer]
1306            (cons "Buffers" buffers-menu)))))
1307
1308 (add-hook 'menu-bar-update-hook 'menu-bar-update-buffers)
1309
1310 (menu-bar-update-buffers)
1311
1312 ;; this version is too slow
1313 ;;;(defun format-buffers-menu-line (buffer)
1314 ;;;  "Returns a string to represent the given buffer in the Buffer menu.
1315 ;;;nil means the buffer shouldn't be listed.  You can redefine this."
1316 ;;;  (if (string-match "\\` " (buffer-name buffer))
1317 ;;;      nil
1318 ;;;    (save-excursion
1319 ;;;     (set-buffer buffer)
1320 ;;;     (let ((size (buffer-size)))
1321 ;;;       (format "%s%s %-19s %6s %-15s %s"
1322 ;;;            (if (buffer-modified-p) "*" " ")
1323 ;;;            (if buffer-read-only "%" " ")
1324 ;;;            (buffer-name)
1325 ;;;            size
1326 ;;;            mode-name
1327 ;;;            (or (buffer-file-name) ""))))))
1328 \f
1329 ;;; Set up a menu bar menu for the minibuffer.
1330
1331 (dolist (map (list minibuffer-local-map
1332                    ;; This shouldn't be necessary, but there's a funny
1333                    ;; bug in keymap.c that I don't understand yet.  -stef
1334                    minibuffer-local-completion-map))
1335   (define-key map [menu-bar minibuf]
1336     (cons "Minibuf" (make-sparse-keymap "Minibuf"))))
1337
1338 (let ((map minibuffer-local-completion-map))
1339   (define-key map [menu-bar minibuf ?\?]
1340     (list 'menu-item "List Completions" 'minibuffer-completion-help
1341           :help "Display all possible completions"))
1342   (define-key map [menu-bar minibuf space]
1343     (list 'menu-item "Complete Word" 'minibuffer-complete-word
1344           :help "Complete at most one word"))
1345   (define-key map [menu-bar minibuf tab]
1346     (list 'menu-item "Complete" 'minibuffer-complete
1347           :help "Complete as far as possible")))
1348
1349 (let ((map minibuffer-local-map))
1350   (define-key map [menu-bar minibuf quit]
1351     (list 'menu-item "Quit" 'keyboard-escape-quit
1352           :help "Abort input and exit minibuffer"))
1353   (define-key map [menu-bar minibuf return]
1354     (list 'menu-item "Enter" 'exit-minibuffer
1355           :help "Terminate input and exit minibuffer")))
1356 \f
1357 (defcustom menu-bar-mode nil
1358   "Toggle display of a menu bar on each frame.
1359 Setting this variable directly does not take effect;
1360 use either \\[customize] or the function `menu-bar-mode'."
1361   :set (lambda (symbol value)
1362          (menu-bar-mode (or value 0)))
1363   :initialize 'custom-initialize-default
1364   :type 'boolean
1365   :group 'frames)
1366
1367 (defun menu-bar-mode (&optional flag)
1368   "Toggle display of a menu bar on each frame.
1369 This command applies to all frames that exist and frames to be
1370 created in the future.
1371 With a numeric argument, if the argument is positive,
1372 turn on menu bars; otherwise, turn off menu bars."
1373  (interactive "P")
1374
1375   ;; Make menu-bar-mode and default-frame-alist consistent.
1376   (let ((default (assq 'menu-bar-lines default-frame-alist)))
1377     (if default
1378         (setq menu-bar-mode (not (eq (cdr default) 0)))
1379       (setq default-frame-alist
1380             (cons (cons 'menu-bar-lines (if menu-bar-mode 1 0))
1381                   default-frame-alist))))
1382
1383   ;; Toggle or set the mode, according to FLAG.
1384  (setq menu-bar-mode (if (null flag) (not menu-bar-mode)
1385                        (> (prefix-numeric-value flag) 0)))
1386
1387  ;; Apply it to default-frame-alist.
1388  (let ((parameter (assq 'menu-bar-lines default-frame-alist)))
1389    (if (consp parameter)
1390        (setcdr parameter (if menu-bar-mode 1 0))
1391      (setq default-frame-alist
1392            (cons (cons 'menu-bar-lines (if menu-bar-mode 1 0))
1393                  default-frame-alist))))
1394
1395  ;; Apply it to existing frames.
1396  (let ((frames (frame-list)))
1397    (while frames
1398      (let ((height (cdr (assq 'height (frame-parameters (car frames))))))
1399        (modify-frame-parameters (car frames)
1400                                 (list (cons 'menu-bar-lines
1401                                           (if menu-bar-mode 1 0))))
1402        (modify-frame-parameters (car frames)
1403                                 (list (cons 'height height))))
1404      (setq frames (cdr frames)))))
1405
1406 (provide 'menu-bar)
1407
1408 ;;; menu-bar.el ends here