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