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               `(progn
 534                  (custom-load-symbol ',variable)
 535                  (let ((set (or (get ',variable 'custom-set) 'set-default))
 536                        (get (or (get ',variable 'custom-get) 'default-value)))
 537                    (funcall set ',variable (not (funcall get ',variable))))))
 538            (message ,message "enabled")
 539          (message ,message "disabled")))
 540      ;; The function `customize-mark-as-set' must only be called when
 541      ;; a variable is set interactively, as the purpose is to mark it
 542      ;; as a candidate for "Save Options", and we do not want to save
 543      ;; options the user have already set explicitly in his init
 544      ;; file.  Unfortunately, he could very likely call the function
 545      ;; defined above there.  So we put `customize-mark-as-set' in a
 546      ;; lambda expression.
 547      ;; -- Per Abrahamsen <abraham@dina.kvl.dk> 2002-02-11.
 548      '(menu-item ,doc (lambda ()
 549                         (interactive)
 550                         (,name)
 551                         (customize-mark-as-set ',variable))
 552                  :help ,help
 553                  :button (:toggle . (and (default-boundp ',variable)
 554                                          (default-value ',variable))))))
 555
 556 ;;; Assemble all the top-level items of the "Options" menu
 557 (define-key menu-bar-options-menu [customize]
 558   (list 'menu-item "Customize Emacs" menu-bar-custom-menu
 559         :help "Full customization of every Emacs feature"))
 560
 561 (defun menu-bar-options-save ()
 562   "Save current values of Options menu items using Custom."
 563   (interactive)
 564   (let ((need-save nil))
 565     ;; These are set with `customize-set-variable'.
 566     (dolist (elt '(line-number-mode column-number-mode scroll-bar-mode
 567                    debug-on-quit debug-on-error menu-bar-mode tool-bar-mode
 568                    save-place uniquify-buffer-name-style
 569                    case-fold-search show-paren-mode
 570                    transient-mark-mode global-font-lock-mode
 571                    display-time-mode auto-compression-mode
 572                    current-language-environment default-input-method
 573                    ;; Saving `text-mode-hook' is somewhat questionable,
 574                    ;; as we might get more than we bargain for, if
 575                    ;; other code may has added hooks as well.
 576                    ;; Nonetheless, not saving it would like be confuse
 577                    ;; more often.
 578                    ;; -- Per Abrahamsen <abraham@dina.kvl.dk> 2002-02-11.
 579                    text-mode-hook))
 580       (and (get elt 'customized-value)
 581            (customize-mark-to-save elt)
 582            (setq need-save t)))
 583     ;; Save if we changed anything.
 584     (when need-save
 585       (custom-save-all))))
 586
 587 (define-key menu-bar-options-menu [save]
 588   '(menu-item "Save Options" menu-bar-options-save
 589               :help "Save options set from the menu above"))
 590
 591 (define-key menu-bar-options-menu [custom-separator]
 592   '("--"))
 593
 594 ;; The "Show/Hide" submenu of menu "Options"
 595
 596 (defvar menu-bar-showhide-menu (make-sparse-keymap "Show/Hide"))
 597
 598 (define-key menu-bar-showhide-menu [column-number-mode]
 599   (menu-bar-make-toggle toggle-column-number-mode column-number-mode
 600                         "Show Column Number" "Column number mode %s"
 601                         "Show the current column number in the mode-line"))
 602
 603 (define-key menu-bar-showhide-menu [line-number-mode]
 604   (menu-bar-make-toggle toggle-line-number-mode line-number-mode
 605                         "Show Line Number" "Line number mode %s"
 606                         "Show the current line number in the mode-line"))
 607
 608 (define-key menu-bar-showhide-menu [linecolumn-separator]
 609   '("--"))
 610
 611 (defun showhide-date-time ()
 612   "Toggle whether to show date and time in the mode-line."
 613   (interactive)
 614   (if (display-time-mode)
 615       (message "Display-time mode enabled.")
 616     (message "Display-time mode disabled.")))
 617
 618 (define-key menu-bar-showhide-menu [showhide-date-time]
 619   '(menu-item "Date and time" (lambda ()
 620                                 (interactive)
 621                                 (showhide-date-time)
 622                                 (customize-mark-as-set 'display-time-mode))
 623               :help "Display date and time in the mode-line"
 624               :button (:toggle . display-time-mode)))
 625
 626 (define-key menu-bar-showhide-menu [datetime-separator]
 627   '("--"))
 628
 629 (define-key menu-bar-showhide-menu [showhide-speedbar]
 630   '(menu-item "Speedbar" speedbar-frame-mode
 631               :help "Display speedbar"
 632               :button (:toggle
 633                        . (and (boundp 'speedbar-frame)
 634                               (frame-live-p (symbol-value 'speedbar-frame))
 635                               (frame-visible-p
 636                                (symbol-value 'speedbar-frame))))))
 637
 638 (defvar menu-bar-showhide-scroll-bar-menu (make-sparse-keymap "Scroll-bar"))
 639
 640 (define-key menu-bar-showhide-scroll-bar-menu [right]
 641   '(menu-item "On the Right"
 642               (lambda ()
 643                 (interactive)
 644                 (customize-set-variable 'scroll-bar-mode 'right))
 645               :help "Scroll-bar on the right side"
 646               :visible window-system
 647               :button (:radio . (eq (cdr (assq 'vertical-scroll-bars
 648                                                (frame-parameters))) 'right))))
 649
 650 (define-key menu-bar-showhide-scroll-bar-menu [left]
 651   '(menu-item "On the Left"
 652               (lambda ()
 653                 (interactive)
 654                 (customize-set-variable 'scroll-bar-mode 'left))
 655               :help "Scroll-bar on the left side"
 656               :visible window-system
 657               :button (:radio . (eq (cdr (assq 'vertical-scroll-bars
 658                                                (frame-parameters))) 'left))))
 659
 660 (define-key menu-bar-showhide-scroll-bar-menu [none]
 661   '(menu-item "None"
 662               (lambda ()
 663                 (interactive)
 664                 (customize-set-variable 'scroll-bar-mode nil))
 665               :help "Turn off scroll-bar"
 666               :visible window-system
 667               :button (:radio . (eq (cdr (assq 'vertical-scroll-bars
 668                                                (frame-parameters))) nil))))
 669
 670 (define-key menu-bar-showhide-menu [showhide-scroll-bar]
 671   (list 'menu-item "Scroll-Bar" menu-bar-showhide-scroll-bar-menu
 672         :visible 'window-system
 673         :help "Select scroll-bar mode"))
 674
 675 (defun showhide-menu-bar ()
 676   "Toggle whether to turn menu-bar on/off."
 677   (interactive)
 678   (menu-bar-mode)
 679   (if menu-bar-mode
 680       (message "Menu-bar mode enabled.")
 681     (message "Menu-bar mode disabled.  Use M-x menu-bar-mode to make the menu bar appear.")))
 682
 683 (define-key menu-bar-showhide-menu [showhide-menu-bar]
 684   '(menu-item "Menu-bar"
 685               (lambda ()
 686                 (interactive)
 687                 (showhide-menu-bar)
 688                 (customize-mark-as-set 'menu-bar-mode))
 689               :help "Toggle menu-bar on/off"
 690               :button (:toggle . menu-bar-mode)))
 691
 692 (defun showhide-tool-bar ()
 693   "Toggle whether to turn tool-bar on/off."
 694   (interactive)
 695   (if (tool-bar-mode)
 696       (message "Tool-bar mode enabled.")
 697     (message "Tool-bar mode disabled.")))
 698
 699 (define-key menu-bar-showhide-menu [showhide-tool-bar]
 700   '(menu-item "Tool-bar"
 701               (lambda ()
 702                 (interactive)
 703                 (showhide-tool-bar)
 704                 (customize-mark-as-set 'tool-bar-mode))
 705               :help "Turn tool-bar on/off"
 706               :visible window-system
 707               :button (:toggle . tool-bar-mode)))
 708
 709 (define-key menu-bar-options-menu [showhide]
 710   (list 'menu-item "Show/Hide" menu-bar-showhide-menu
 711         :help "Toggle on/off various display features"))
 712
 713 (define-key menu-bar-options-menu [showhide-separator]
 714   '("--"))
 715
 716 (define-key menu-bar-options-menu [mule]
 717   ;; It is better not to use backquote here,
 718   ;; because that makes a bootstrapping problem
 719   ;; if you need to recompile all the Lisp files using interpreted code.
 720   (list 'menu-item "Mule (Multilingual Environment)" mule-menu-keymap
 721 ;; Most of the MULE menu actually does make sense in unibyte mode,
 722 ;; e.g. language selection.
 723 ;;;     ':visible 'default-enable-multibyte-characters
 724         ':help "Default language, encodings, input method"))
 725 ;(setq menu-bar-final-items (cons 'mule menu-bar-final-items))
 726 ;(define-key menu-bar-options-menu [preferences]
 727 ;  (list 'menu-item "Preferences" menu-bar-preferences-menu
 728 ;       :help "Toggle important global options"))
 729
 730 (define-key menu-bar-options-menu [mule-separator]
 731   '("--"))
 732
 733 (define-key menu-bar-options-menu [debug-on-quit]
 734   (menu-bar-make-toggle toggle-debug-on-quit debug-on-quit
 735                         "Enter Debugger on Quit/C-g" "Debug on Quit %s"
 736                         "Enter Lisp debugger when C-g is pressed"))
 737 (define-key menu-bar-options-menu [debug-on-error]
 738   (menu-bar-make-toggle toggle-debug-on-error debug-on-error
 739                         "Enter Debugger on Error" "Debug on Error %s"
 740                         "Enter Lisp debugger when an error is signaled"))
 741 (define-key menu-bar-options-menu [debugger-separator]
 742   '("--"))
 743 (define-key menu-bar-options-menu [toggle-auto-compression]
 744   '(menu-item "Automatic File De/compression"
 745               (lambda ()
 746                 (interactive)
 747                 (auto-compression-mode)
 748                 (customize-mark-as-set 'auto-compression-mode))
 749               :help "Transparently decompress compressed files"
 750               :button (:toggle . (rassq 'jka-compr-handler
 751                                         file-name-handler-alist))))
 752 (define-key menu-bar-options-menu [save-place]
 753   (menu-bar-make-toggle toggle-save-place-globally save-place
 754                         "Save Place in Files between Sessions"
 755                         "Saving place in files %s"
 756                         "Save Emacs state for next session"))
 757
 758 (define-key menu-bar-options-menu [uniquify]
 759   (menu-bar-make-toggle toggle-uniquify-buffer-names uniquify-buffer-name-style
 760                         "Use Directory Names in Buffer Names"
 761                         "Directory name in buffer names (uniquify) %s"
 762                         "Uniquify buffer names by adding parent directory names"
 763                         (require 'uniquify)
 764                         (setq uniquify-buffer-name-style
 765                               (if (not uniquify-buffer-name-style)
 766                                   'forward))))
 767
 768 (define-key menu-bar-options-menu [edit-options-separator]
 769   '("--"))
 770 (define-key menu-bar-options-menu [case-fold-search]
 771   (menu-bar-make-toggle toggle-case-fold-search case-fold-search
 772                         "Case-Insensitive Search"
 773                         "Case-Insensitive Search %s"
 774                         "Ignore letter-case in search"))
 775 (define-key menu-bar-options-menu [auto-fill-mode]
 776   '(menu-item "Word Wrap in Text Modes (Auto Fill)"
 777               (lambda ()
 778                 (interactive)
 779                 (toggle-text-mode-auto-fill)
 780                 ;; This is somewhat questionable, as `text-mode-hook'
 781                 ;; might have changed outside customize.
 782                 ;; -- Per Abrahamsen <abraham@dina.kvl.dk> 2002-02-11.
 783                 (customize-mark-as-set 'text-mode-hook))
 784               :help "Automatically fill text between left and right margins"
 785               :button (:toggle . (member 'turn-on-auto-fill text-mode-hook))))
 786 (define-key menu-bar-options-menu [truncate-lines]
 787   '(menu-item "Truncate Long Lines in this Buffer"
 788               (lambda ()
 789                 (interactive)
 790                 (setq truncate-lines (not truncate-lines))
 791                 (set-buffer-modified-p (buffer-modified-p))
 792                 (message "Truncate long lines %s"
 793                          (if truncate-lines "enabled" "disabled")))
 794               :help "Truncate long lines on the screen"
 795               :button (:toggle . truncate-lines)))
 796
 797 (define-key menu-bar-options-menu [highlight-separator]
 798   '("--"))
 799 (define-key menu-bar-options-menu [highlight-paren-mode]
 800   (menu-bar-make-toggle toggle-highlight-paren-mode show-paren-mode
 801                         "Paren Match Highlighting (Show Paren mode)"
 802                         "Show Paren mode %s"
 803                         "Highlight matching/mismatched parentheses at cursor"))
 804 (define-key menu-bar-options-menu [transient-mark-mode]
 805   (menu-bar-make-toggle toggle-transient-mark-mode transient-mark-mode
 806                         "Active Region Highlighting (Transient Mark mode)"
 807                         "Transient Mark mode %s"
 808                         "Make text in active region stand out in color"))
 809 (define-key menu-bar-options-menu [toggle-global-lazy-font-lock-mode]
 810   (menu-bar-make-toggle toggle-global-lazy-font-lock-mode global-font-lock-mode
 811                         "Syntax Highlighting (Global Font Lock mode)"
 812                         "Global Font Lock mode %s"
 813                         "Colorize text based on language syntax"))
 814
 815 \f
 816 ;; The "Tools" menu items
 817
 818 (defun send-mail-item-name ()
 819   (let* ((known-send-mail-commands '((sendmail-user-agent . "sendmail")
 820                                      (mh-e-user-agent . "MH")
 821                                      (message-user-agent . "Gnus Message")
 822                                      (gnus-user-agent . "Gnus")))
 823          (name (assq mail-user-agent known-send-mail-commands)))
 824     (if name
 825         (setq name (cdr name))
 826       (setq name (symbol-name mail-user-agent))
 827       (if (string-match "\\(.+\\)-user-agent" name)
 828           (setq name (match-string 1 name))))
 829     name))
 830
 831 (defun read-mail-item-name ()
 832   (let* ((known-rmail-commands '((rmail . "RMAIL")
 833                                  (mh-rmail . "MH")
 834                                  (gnus . "Gnus")))
 835          (known (assq read-mail-command known-rmail-commands)))
 836     (if known (cdr known) (symbol-name read-mail-command))))
 837
 838 (defvar menu-bar-games-menu (make-sparse-keymap "Games"))
 839
 840 (define-key menu-bar-tools-menu [games]
 841   (list 'menu-item "Games" menu-bar-games-menu))
 842
 843 (define-key menu-bar-tools-menu [separator-games]
 844   '("--"))
 845
 846 (define-key menu-bar-games-menu [zone]
 847   '(menu-item "Zone Out"  zone
 848               :help "Play tricks with Emacs display when Emacs is idle"))
 849 (define-key menu-bar-games-menu [yow]
 850   '(menu-item "Random Quotation"  yow
 851               :help "Display a random Zippy quotation"))
 852 (define-key menu-bar-games-menu [tetris]
 853   '(menu-item "Tetris"  tetris))
 854 (define-key menu-bar-games-menu [solitaire]
 855   '(menu-item "Solitaire"  solitaire))
 856 (define-key menu-bar-games-menu [snake]
 857   '(menu-item "Snake"  snake
 858               :help "Move snake around avoiding collisions"))
 859 (define-key menu-bar-games-menu [mult]
 860   '(menu-item "Multiplication Puzzle"  mpuz
 861               :help "Excercise brain with multiplication"))
 862 (define-key menu-bar-games-menu [life]
 863   '(menu-item "Life"  life
 864               :help "Watch how John Conway's cellular automaton evolves"))
 865 (define-key menu-bar-games-menu [hanoi]
 866   '(menu-item "Towers of Hanoi" hanoi
 867               :help "Watch Towers-of-Hanoi puzzle solved by Emacs"))
 868 (define-key menu-bar-games-menu [gomoku]
 869   '(menu-item "Gomoku"  gomoku
 870               :help "Mark 5 contiguous squares (like tic-tac-toe)"))
 871 (define-key menu-bar-games-menu [black-box]
 872   '(menu-item "Blackbox"  blackbox
 873               :help "Find balls in a black box by shooting rays"))
 874 (define-key menu-bar-games-menu [adventure]
 875   '(menu-item "Adventure"  dunnet
 876               :help "Dunnet, a text Adventure game for Emacs"))
 877 (define-key menu-bar-games-menu [5x5]
 878   '(menu-item "5x5" 5x5
 879               :help "Fill in all the squares on a 5x5 board"))
 880
 881 (define-key menu-bar-tools-menu [calculator]
 882   '(menu-item "Calculator" calculator
 883               :help "Invoke the Emacs built-in scientific calculator"))
 884 (define-key menu-bar-tools-menu [calendar]
 885   '(menu-item "Display Calendar" calendar))
 886
 887 (define-key menu-bar-tools-menu [separator-net]
 888   '("--"))
 889
 890 (define-key menu-bar-tools-menu [directory-search]
 891   '(menu-item "Directory Search" eudc-tools-menu
 892               :help "Query directory servers via LDAP, CCSO PH/QI or BBDB"))
 893 (define-key menu-bar-tools-menu [compose-mail]
 894   (list
 895    'menu-item `(format "Send Mail (with %s)" (send-mail-item-name))
 896    'compose-mail
 897    :visible `(and mail-user-agent (not (eq mail-user-agent 'ignore)))
 898    :help "Send a mail message"))
 899 (define-key menu-bar-tools-menu [rmail]
 900   (list
 901    'menu-item `(format "Read Mail (with %s)" (read-mail-item-name))
 902    (lambda ()
 903      (interactive)
 904      (call-interactively read-mail-command))
 905    :visible `(and read-mail-command (not (eq read-mail-command 'ignore)))
 906    :help "Read your mail and reply to it"))
 907 (define-key menu-bar-tools-menu [gnus]
 908   '(menu-item "Read Net News (Gnus)" gnus
 909               :help "Read network news groups"))
 910
 911 (define-key menu-bar-tools-menu [separator-vc]
 912   '("--"))
 913
 914 (defvar vc-menu-map (make-sparse-keymap "Version Control"))
 915 (define-key menu-bar-tools-menu [pcl-cvs]
 916   `(menu-item "PCL-CVS" ,cvs-global-menu
 917               :help "Module-level interface to CVS"))
 918 (define-key menu-bar-tools-menu [vc]
 919   (list 'menu-item "Version Control" vc-menu-map
 920         :help "Interface to RCS, CVS, SCCS"))
 921
 922 (define-key menu-bar-tools-menu [separator-compare]
 923   '("--"))
 924
 925 (define-key menu-bar-tools-menu [ediff-misc]
 926   '(menu-item "Ediff Miscellanea" menu-bar-ediff-misc-menu
 927               :help "Ediff manual, customization, sessions, etc."))
 928 (define-key menu-bar-tools-menu [epatch]
 929   '(menu-item "Apply Patch" menu-bar-epatch-menu))
 930 (define-key menu-bar-tools-menu [ediff-merge]
 931   '(menu-item "Merge" menu-bar-ediff-merge-menu
 932               :help "Merge different revisions of files/directories"))
 933 (define-key menu-bar-tools-menu [compare]
 934   '(menu-item "Compare (Ediff)" menu-bar-ediff-menu
 935               :help "Display differences between files/directories"))
 936
 937
 938 (define-key menu-bar-tools-menu [separator-spell]
 939   '("--"))
 940
 941 (define-key menu-bar-tools-menu [spell]
 942   '(menu-item "Spell Checking" ispell-menu-map))
 943
 944 (define-key menu-bar-tools-menu [separator-prog]
 945   '("--"))
 946
 947 (define-key menu-bar-tools-menu [gdb]
 948   '(menu-item "Debugger (GUD)..." gdb
 949               :help "Debug a program from within Emacs"))
 950 (define-key menu-bar-tools-menu [shell-on-region]
 951   '(menu-item "Shell Command on Region..." shell-command-on-region
 952               :enable mark-active
 953               :help "Pass marked region to a shell command"))
 954 (define-key menu-bar-tools-menu [shell]
 955   '(menu-item "Shell Command..." shell-command
 956               :help "Invoke a shell command and catch its output"))
 957 (define-key menu-bar-tools-menu [compile]
 958   '(menu-item "Compile..." compile
 959               :help "Invoke compiler or Make, view compilation errors"))
 960 (define-key menu-bar-tools-menu [grep]
 961   '(menu-item "Search Files (Grep)..." grep
 962               :help "Search files for strings or regexps (with Grep)"))
 963
 964 \f
 965 ;; The "Help" menu items
 966
 967 (defvar menu-bar-describe-menu (make-sparse-keymap "Describe"))
 968
 969 (define-key menu-bar-describe-menu [mule-diag]
 970   '(menu-item "Show All of Mule Status" mule-diag
 971               :visible default-enable-multibyte-characters
 972               :help "Display multilingual environment settings"))
 973 (define-key menu-bar-describe-menu [describe-coding-system-briefly]
 974   '(menu-item "Describe Coding System (Briefly)..."
 975               describe-current-coding-system-briefly
 976               :visible default-enable-multibyte-characters))
 977 (define-key menu-bar-describe-menu [describe-coding-system]
 978   '(menu-item "Describe Coding System..." describe-coding-system
 979               :visible default-enable-multibyte-characters))
 980 (define-key menu-bar-describe-menu [describe-input-method]
 981   '(menu-item "Describe Input Method..." describe-input-method
 982               :visible default-enable-multibyte-characters
 983               :help "Keyboard layout for specific input method"))
 984 (define-key menu-bar-describe-menu [describe-language-environment]
 985   (list 'menu-item "Describe Language Environment"
 986         describe-language-environment-map
 987         :help "Show multilingual settings for a specific language"))
 988
 989 (define-key menu-bar-describe-menu [separator-desc-mule]
 990   '("--"))
 991
 992 (define-key menu-bar-describe-menu [list-keybindings]
 993   '(menu-item "List Key Bindings" describe-bindings
 994               :help "Display a list of all current keybindings"))
 995 (define-key menu-bar-describe-menu [describe-current-display-table]
 996   '(menu-item "Describe Display Table" describe-current-display-table
 997               :help "Describe the current display table"))
 998 (define-key menu-bar-describe-menu [describe-face]
 999   '(menu-item "Describe Face..." describe-face
1000               :help "Display the properties of a face"))
1001 (define-key menu-bar-describe-menu [describe-variable]
1002   '(menu-item "Describe Variable..." describe-variable
1003               :help "Display documentation of variable/option"))
1004 (define-key menu-bar-describe-menu [describe-function]
1005   '(menu-item "Describe Function..." describe-function
1006               :help "Display documentation of function/command"))
1007 (define-key menu-bar-describe-menu [describe-key]
1008   '(menu-item "Describe Key..." describe-key
1009               ;; Users typically don't identify keys and menu items...
1010               :help "Display documentation of command bound to a \
1011 key (or menu-item)"))
1012 (define-key menu-bar-describe-menu [describe-mode]
1013   '(menu-item "Describe Buffer Modes" describe-mode
1014               :help "Describe this buffer's major and minor mode"))
1015
1016 (defvar menu-bar-apropos-menu (make-sparse-keymap "Apropos"))
1017 (defun menu-bar-read-lispref ()
1018   "Display the Emacs Lisp Reference manual in Info mode."
1019   (interactive)
1020   (info "elisp"))
1021
1022 (defun menu-bar-read-lispintro ()
1023   "Display the Introduction to Emacs Lisp Programming in Info mode."
1024   (interactive)
1025   (info "eintr"))
1026
1027 (defun menu-bar-read-emacs-man ()
1028   "Display Emacs User Manual in Info mode."
1029   (interactive)
1030   (info "emacs"))
1031
1032 (defun search-emacs-glossary ()
1033   "Display the Glossary node of the Emacs manual in Info mode."
1034   (interactive)
1035   (info "(emacs)Glossary"))
1036
1037 (defun emacs-index-search (topic)
1038   "Look up TOPIC in the indices of the Emacs User Manual."
1039   (interactive "sSubject to look up: ")
1040   (info "emacs")
1041   (Info-index topic))
1042
1043 (defun elisp-index-search (topic)
1044   "Look up TOPIC in the indices of the Emacs Lisp Reference Manual."
1045   (interactive "sSubject to look up: ")
1046   (info "elisp")
1047   (Info-index topic))
1048
1049 (define-key menu-bar-apropos-menu [apropos-documentation]
1050   '(menu-item "Search Documentation Strings..." apropos-documentation
1051               :help
1052               "Find functions and variables whose doc strings match a regexp"))
1053 (define-key menu-bar-apropos-menu [apropos]
1054   '(menu-item "Find Any Object by Name..."  apropos
1055               :help "Find symbols of any kind whose names match a regexp"))
1056 (define-key menu-bar-apropos-menu [apropos-value]
1057   '(menu-item "Find Options by Value..." apropos-value
1058               :help "Find variables whose values match a regexp"))
1059 (define-key menu-bar-apropos-menu [apropos-variables]
1060   '(menu-item "Find Options by Name..." apropos-variable
1061               :help "Find variables whose names match a regexp"))
1062 (define-key menu-bar-apropos-menu [apropos-commands]
1063   '(menu-item "Find Commands by Name..." apropos-command
1064               :help "Find commands whose names match a regexp"))
1065 (define-key menu-bar-apropos-menu [sep1]
1066   '("--"))
1067 (define-key menu-bar-apropos-menu [elisp-index-search]
1068   '(menu-item "Look Up Subject in ELisp Manual..." elisp-index-search
1069               :help "Find description of a subject in Emacs Lisp manual"))
1070 (define-key menu-bar-apropos-menu [emacs-index-search]
1071   '(menu-item "Look Up Subject in User Manual..." emacs-index-search
1072               :help "Find description of a subject in Emacs User manual"))
1073 (define-key menu-bar-apropos-menu [emacs-glossary]
1074   '(menu-item "Emacs Terminology" search-emacs-glossary
1075               :help "Display the Glossary section of the Emacs manual"))
1076
1077 (defvar menu-bar-manuals-menu (make-sparse-keymap "More Manuals"))
1078
1079 (define-key menu-bar-manuals-menu [man]
1080   '(menu-item "Read Man Page..." manual-entry
1081               :help "Man-page docs for external commands and libraries"))
1082 (define-key menu-bar-manuals-menu [sep2]
1083   '("--"))
1084 (define-key menu-bar-manuals-menu [order-emacs-manuals]
1085   '(menu-item "Ordering Manuals" view-order-manuals
1086               :help "How to order manuals from the Free Software Foundation"))
1087 (define-key menu-bar-manuals-menu [info]
1088   '(menu-item "All Other Manuals (Info)" Info-directory
1089               :help "Read any of the installed manuals"))
1090 (define-key menu-bar-manuals-menu [info-elisp]
1091   '(menu-item "Emacs Lisp Reference" menu-bar-read-lispref
1092               :help "Read the Emacs Lisp Reference manual"))
1093 (define-key menu-bar-manuals-menu [info-elintro]
1094   '(menu-item "Introduction to Emacs Lisp" menu-bar-read-lispintro
1095               :help "Read the Introduction to Emacs Lisp Programming"))
1096 (define-key menu-bar-manuals-menu [sep3]
1097   '("--"))
1098 (define-key menu-bar-manuals-menu [command]
1099   '(menu-item "Find Command in Manual" Info-goto-emacs-command-node
1100               :help "Display manual section that describes a command"))
1101 (define-key menu-bar-manuals-menu [key]
1102   '(menu-item "Find Key in Manual" Info-goto-emacs-key-command-node
1103               :help "Display manual section that describes a key"))
1104
1105 (define-key menu-bar-help-menu [eliza]
1106   '(menu-item "Emacs Psychiatrist" doctor
1107               :help "Our doctor will help you feel better"))
1108 (define-key menu-bar-help-menu [sep4]
1109   '("--"))
1110 (define-key menu-bar-help-menu [describe-no-warranty]
1111   '(menu-item "(Non)Warranty" describe-no-warranty
1112               :help "Explain that Emacs has NO WARRANTY"))
1113 (define-key menu-bar-help-menu [describe-copying]
1114   '(menu-item "Copying Conditions" describe-copying
1115               :help "Show the Emacs license (GPL)"))
1116 (define-key menu-bar-help-menu [describe-distribution]
1117   '(menu-item "Getting New Versions" describe-distribution
1118               :help "How to get latest versions of Emacs"))
1119 (define-key menu-bar-help-menu [more]
1120   '(menu-item "Find Extra Packages"
1121               (lambda ()
1122                 (interactive)
1123                 (let (enable-local-variables)
1124                   (view-file (expand-file-name "MORE.STUFF"
1125                                                data-directory))
1126                   (goto-address)))
1127               :help "Where to find some extra packages and possible updates"))
1128 (define-key menu-bar-help-menu [about]
1129   '(menu-item "About Emacs" display-splash-screen
1130               :help "Display version number, copyright info, and basic help"))
1131 (define-key menu-bar-help-menu [sep2]
1132   '("--"))
1133 (define-key menu-bar-help-menu [finder-by-keyword]
1134   '(menu-item "Find Emacs Packages..." finder-by-keyword
1135               :help "Find packages and features by keyword"))
1136 (define-key menu-bar-help-menu [manuals]
1137   (list 'menu-item "More Manuals" menu-bar-manuals-menu
1138         :help "Search and browse on-line manuals"))
1139 (define-key menu-bar-help-menu [emacs-manual]
1140   '(menu-item "Read the Emacs Manual" menu-bar-read-emacs-man
1141               :help "Full documentation of Emacs features"))
1142 (define-key menu-bar-help-menu [describe]
1143   (list 'menu-item "Describe" menu-bar-describe-menu
1144         :help "Describe commands, variables, keys"))
1145 (define-key menu-bar-help-menu [apropos]
1146   (list 'menu-item "Search Documentation" menu-bar-apropos-menu
1147         :help "Look up terms, find commands, options, etc. (Apropos)"))
1148 (define-key menu-bar-help-menu [sep1]
1149   '("--"))
1150 (define-key menu-bar-help-menu [report-emacs-bug]
1151   '(menu-item "Send Bug Report..." report-emacs-bug
1152               :help "Send e-mail to Emacs maintainers"))
1153 (define-key menu-bar-help-menu [emacs-problems]
1154   '(menu-item "Emacs Known Problems" view-emacs-problems))
1155 (define-key menu-bar-help-menu [emacs-news]
1156   '(menu-item "Emacs News" view-emacs-news
1157               :help "New features of this version"))
1158 (define-key menu-bar-help-menu [emacs-faq]
1159   '(menu-item "Emacs FAQ" view-emacs-FAQ))
1160 (define-key menu-bar-help-menu [emacs-tutorial-language-specific]
1161   '(menu-item "Emacs Tutorial (choose language)..."
1162               (lambda () (interactive) (help-with-tutorial t))
1163               :help "Learn how to use Emacs (choose a language)"))
1164 (define-key menu-bar-help-menu [emacs-tutorial]
1165   '(menu-item "Emacs Tutorial" help-with-tutorial
1166               :help "Learn how to use Emacs"))
1167
1168 (defun kill-this-buffer ()      ; for the menubar
1169   "Kill the current buffer."
1170   (interactive)
1171   (kill-buffer (current-buffer)))
1172
1173 (defun kill-this-buffer-enabled-p ()
1174   (let ((count 0)
1175         (buffers (buffer-list)))
1176     (while buffers
1177       (or (string-match "^ " (buffer-name (car buffers)))
1178           (setq count (1+ count)))
1179       (setq buffers (cdr buffers)))
1180     (and (not (window-minibuffer-p (frame-selected-window menu-updating-frame)))
1181          (> count 1))))
1182
1183 (put 'dired 'menu-enable
1184      '(not (window-minibuffer-p (frame-selected-window menu-updating-frame))))
1185
1186 ;; Permit deleting frame if it would leave a visible or iconified frame.
1187 (defun delete-frame-enabled-p ()
1188   "Return non-nil if `delete-frame' should be enabled in the menu bar."
1189   (let ((frames (frame-list))
1190         (count 0))
1191     (while frames
1192       (if (frame-visible-p (car frames))
1193           (setq count (1+ count)))
1194       (setq frames (cdr frames)))
1195     (> count 1)))
1196
1197 (defcustom yank-menu-length 20
1198   "*Maximum length to display in the yank-menu."
1199   :type 'integer
1200   :group 'mouse)
1201
1202 (defun menu-bar-update-yank-menu (string old)
1203   (let ((front (car (cdr yank-menu)))
1204         (menu-string (if (<= (length string) yank-menu-length)
1205                          string
1206                        (concat
1207                         (substring string 0 (/ yank-menu-length 2))
1208                         "..."
1209                         (substring string (- (/ yank-menu-length 2)))))))
1210     ;; Don't let the menu string be all dashes
1211     ;; because that has a special meaning in a menu.
1212     (if (string-match "\\`-+\\'" menu-string)
1213         (setq menu-string (concat menu-string " ")))
1214     ;; If we're supposed to be extending an existing string, and that
1215     ;; string really is at the front of the menu, then update it in place.
1216     (if (and old (or (eq old (car front))
1217                      (string= old (car front))))
1218         (progn
1219           (setcar front string)
1220           (setcar (cdr front) menu-string))
1221       (setcdr yank-menu
1222               (cons
1223                (cons string (cons menu-string 'menu-bar-select-yank))
1224                (cdr yank-menu)))))
1225   (if (> (length (cdr yank-menu)) kill-ring-max)
1226       (setcdr (nthcdr kill-ring-max yank-menu) nil)))
1227
1228 (put 'menu-bar-select-yank 'apropos-inhibit t)
1229 (defun menu-bar-select-yank ()
1230   (interactive "*")
1231   (push-mark (point))
1232   (insert last-command-event))
1233 \f
1234 (defvar list-buffers-directory nil)
1235
1236 (defvar menu-bar-update-buffers-maxbuf)
1237
1238 (defun menu-bar-select-buffer ()
1239   (interactive)
1240   (switch-to-buffer last-command-event))
1241
1242 (defun menu-bar-select-frame ()
1243   (interactive)
1244   (let (frame)
1245     (dolist (f (frame-list))
1246       (when (equal last-command-event (frame-parameter f 'name))
1247         (setq frame f)))
1248   (make-frame-visible frame)
1249   (raise-frame frame)
1250   (select-frame frame)))
1251
1252 (defun menu-bar-update-buffers-1 (elt)
1253   (cons (format
1254          ;; (format "%%%ds  %%s%%s  %%s" menu-bar-update-buffers-maxbuf)
1255          "%s  %s%s  --  %s"
1256          (cdr elt)
1257          (if (buffer-modified-p (car elt))
1258              "*" " ")
1259          (save-excursion
1260            (set-buffer (car elt))
1261            (if buffer-read-only "%" " "))
1262          (let ((file
1263                 (or (buffer-file-name (car elt))
1264                     (save-excursion
1265                       (set-buffer (car elt))
1266                       list-buffers-directory)
1267                     "")))
1268            (setq file (or (file-name-directory file)
1269                           ""))
1270            (if (> (length file) 20)
1271                (setq file (concat "..." (substring file -17))))
1272            file))
1273         (car elt)))
1274
1275 (defvar menu-bar-buffers-menu-list-buffers-entry nil)
1276
1277 (defun menu-bar-update-buffers (&optional force)
1278   ;; If user discards the Buffers item, play along.
1279   (and (lookup-key (current-global-map) [menu-bar buffer])
1280        (or force (frame-or-buffer-changed-p))
1281        (let ((buffers (buffer-list))
1282              (frames (frame-list))
1283              (maxlen 0)
1284              buffers-menu frames-menu)
1285          ;; If requested, list only the N most recently selected buffers.
1286          (if (and (integerp buffers-menu-max-size)
1287                   (> buffers-menu-max-size 1))
1288              (if (> (length buffers) buffers-menu-max-size)
1289                  (setcdr (nthcdr buffers-menu-max-size buffers) nil)))
1290
1291          ;; Make the menu of buffers proper.
1292          (setq buffers-menu
1293                (cons "Select Buffer"
1294                      (let* ((buffer-list
1295                              (mapcar 'list buffers))
1296                             tail
1297                             (menu-bar-update-buffers-maxbuf 0)
1298                             alist
1299                             head)
1300                        ;; Put into each element of buffer-list
1301                        ;; the name for actual display,
1302                        ;; perhaps truncated in the middle.
1303                        (setq tail buffer-list)
1304                        (while tail
1305                          (let ((name (buffer-name (car (car tail)))))
1306                            (setcdr (car tail)
1307                                    (if (> (length name) 27)
1308                                        (concat (substring name 0 12)
1309                                                "..."
1310                                                (substring name -12))
1311                                      name)))
1312                          (setq tail (cdr tail)))
1313                        ;; Compute the maximum length of any name.
1314                        (setq tail buffer-list)
1315                        (while tail
1316                          (or (eq ?\ (aref (cdr (car tail)) 0))
1317                              (setq menu-bar-update-buffers-maxbuf
1318                                    (max menu-bar-update-buffers-maxbuf
1319                                         (length (cdr (car tail))))))
1320                          (setq tail (cdr tail)))
1321                        ;; Set ALIST to an alist of the form
1322                        ;; ITEM-STRING . BUFFER
1323                        (setq tail buffer-list)
1324                        (while tail
1325                          (let ((elt (car tail)))
1326                            (or (eq ?\ (aref (cdr elt) 0))
1327                                (setq alist (cons
1328                                             (menu-bar-update-buffers-1 elt)
1329                                             alist)))
1330                            (and alist (> (length (car (car alist))) maxlen)
1331                                 (setq maxlen (length (car (car alist))))))
1332                          (setq tail (cdr tail)))
1333                        (setq alist (nreverse alist))
1334                        ;; Make the menu item for list-buffers
1335                        ;; or reuse the one we already have.
1336                        ;; The advantage in reusing one
1337                        ;; is that it already has the keyboard equivalent
1338                        ;; cached, so we save the time to look that up again.
1339                        (or menu-bar-buffers-menu-list-buffers-entry
1340                            (setq menu-bar-buffers-menu-list-buffers-entry
1341                                  (cons
1342                                   'list-buffers
1343                                   (cons
1344                                    ""
1345                                    'list-buffers))))
1346                        ;; Update the item string for menu's new width.
1347                        (setcar (cdr menu-bar-buffers-menu-list-buffers-entry)
1348                                (concat (make-string (max (- (/ maxlen 2) 8) 0)
1349                                                     ?\ )
1350                                        "List All Buffers"))
1351                        ;; Now make the actual list of items,
1352                        ;; ending with the list-buffers item.
1353                        (nconc (mapcar (lambda (pair)
1354                                         ;; This is somewhat risque, to use
1355                                         ;; the buffer name itself as the event
1356                                         ;; type to define, but it works.
1357                                         ;; It would not work to use the buffer
1358                                         ;; since a buffer as an event has its
1359                                         ;; own meaning.
1360                                         (nconc (list (buffer-name (cdr pair))
1361                                                      (car pair)
1362                                                      (cons nil nil))
1363                                                'menu-bar-select-buffer))
1364                                       alist)
1365                               (list menu-bar-buffers-menu-list-buffers-entry)))))
1366
1367
1368          ;; Make a Frames menu if we have more than one frame.
1369          (if (cdr frames)
1370              (let ((name (concat (make-string (max (- (/ maxlen 2) 3) 0)
1371                                               ?\ )
1372                                  "Frames"))
1373                    (frames-menu
1374                     (cons 'keymap
1375                           (cons "Select Frame"
1376                                 (mapcar
1377                                  (lambda (frame)
1378                                    (nconc
1379                                     (list (frame-parameter frame 'name)
1380                                           (frame-parameter frame 'name)
1381                                           (cons nil nil))
1382                                           'menu-bar-select-frame))
1383                                         frames)))))
1384                ;; Put it underneath the Buffers menu.
1385                (setq buffers-menu (cons (cons 'frames (cons name frames-menu))
1386                                         buffers-menu))))
1387          (if buffers-menu
1388              (setq buffers-menu (cons 'keymap buffers-menu)))
1389          (define-key (current-global-map) [menu-bar buffer]
1390            (cons "Buffers" buffers-menu)))))
1391
1392 (add-hook 'menu-bar-update-hook 'menu-bar-update-buffers)
1393
1394 (menu-bar-update-buffers)
1395
1396 ;; this version is too slow
1397 ;;;(defun format-buffers-menu-line (buffer)
1398 ;;;  "Returns a string to represent the given buffer in the Buffer menu.
1399 ;;;nil means the buffer shouldn't be listed.  You can redefine this."
1400 ;;;  (if (string-match "\\` " (buffer-name buffer))
1401 ;;;      nil
1402 ;;;    (save-excursion
1403 ;;;     (set-buffer buffer)
1404 ;;;     (let ((size (buffer-size)))
1405 ;;;       (format "%s%s %-19s %6s %-15s %s"
1406 ;;;            (if (buffer-modified-p) "*" " ")
1407 ;;;            (if buffer-read-only "%" " ")
1408 ;;;            (buffer-name)
1409 ;;;            size
1410 ;;;            mode-name
1411 ;;;            (or (buffer-file-name) ""))))))
1412 \f
1413 ;;; Set up a menu bar menu for the minibuffer.
1414
1415 (dolist (map (list minibuffer-local-map
1416                    ;; This shouldn't be necessary, but there's a funny
1417                    ;; bug in keymap.c that I don't understand yet.  -stef
1418                    minibuffer-local-completion-map))
1419   (define-key map [menu-bar minibuf]
1420     (cons "Minibuf" (make-sparse-keymap "Minibuf"))))
1421
1422 (let ((map minibuffer-local-completion-map))
1423   (define-key map [menu-bar minibuf ?\?]
1424     (list 'menu-item "List Completions" 'minibuffer-completion-help
1425           :help "Display all possible completions"))
1426   (define-key map [menu-bar minibuf space]
1427     (list 'menu-item "Complete Word" 'minibuffer-complete-word
1428           :help "Complete at most one word"))
1429   (define-key map [menu-bar minibuf tab]
1430     (list 'menu-item "Complete" 'minibuffer-complete
1431           :help "Complete as far as possible")))
1432
1433 (let ((map minibuffer-local-map))
1434   (define-key map [menu-bar minibuf quit]
1435     (list 'menu-item "Quit" 'keyboard-escape-quit
1436           :help "Abort input and exit minibuffer"))
1437   (define-key map [menu-bar minibuf return]
1438     (list 'menu-item "Enter" 'exit-minibuffer
1439           :help "Terminate input and exit minibuffer")))
1440 \f
1441 (defcustom menu-bar-mode t
1442   "Toggle display of a menu bar on each frame.
1443 Setting this variable directly does not take effect;
1444 use either \\[customize] or the function `menu-bar-mode'."
1445   :set (lambda (symbol value)
1446          (menu-bar-mode (or value 0)))
1447   :initialize 'custom-initialize-default
1448   :type 'boolean
1449   :group 'frames)
1450
1451 (defun menu-bar-mode (&optional flag)
1452   "Toggle display of a menu bar on each frame.
1453 This command applies to all frames that exist and frames to be
1454 created in the future.
1455 With a numeric argument, if the argument is positive,
1456 turn on menu bars; otherwise, turn off menu bars."
1457  (interactive "P")
1458
1459   ;; Make menu-bar-mode and default-frame-alist consistent.
1460   (let ((default (assq 'menu-bar-lines default-frame-alist)))
1461     (if default
1462         (setq menu-bar-mode (not (eq (cdr default) 0)))
1463       (setq default-frame-alist
1464             (cons (cons 'menu-bar-lines (if menu-bar-mode 1 0))
1465                   default-frame-alist))))
1466
1467   ;; Toggle or set the mode, according to FLAG.
1468  (setq menu-bar-mode (if (null flag) (not menu-bar-mode)
1469                        (> (prefix-numeric-value flag) 0)))
1470
1471  ;; Apply it to default-frame-alist.
1472  (let ((parameter (assq 'menu-bar-lines default-frame-alist)))
1473    (if (consp parameter)
1474        (setcdr parameter (if menu-bar-mode 1 0))
1475      (setq default-frame-alist
1476            (cons (cons 'menu-bar-lines (if menu-bar-mode 1 0))
1477                  default-frame-alist))))
1478
1479  ;; Apply it to existing frames.
1480  (let ((frames (frame-list)))
1481    (while frames
1482      (let ((height (cdr (assq 'height (frame-parameters (car frames))))))
1483        (modify-frame-parameters (car frames)
1484                                 (list (cons 'menu-bar-lines
1485                                           (if menu-bar-mode 1 0))))
1486        (modify-frame-parameters (car frames)
1487                                 (list (cons 'height height))))
1488      (setq frames (cdr frames)))))
1489
1490 (provide 'menu-bar)
1491
1492 ;;; menu-bar.el ends here