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