lisp/menu-bar.el

   1 ;;; menu-bar.el --- define a default menu bar
   2
   3 ;; Copyright (C) 1993, 1994, 1995, 2000, 2001, 2002, 2003, 2004,
   4 ;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
   5
   6 ;; Author: RMS
   7 ;; Maintainer: FSF
   8 ;; Keywords: internal, mouse
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software: you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation, either version 3 of the License, or
  15 ;; (at your option) any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  24
  25 ;; Avishai Yacobi suggested some menu rearrangements.
  26
  27 ;;; Commentary:
  28
  29 ;;; Code:
  30
  31 ;; Don't clobber an existing menu-bar keymap, to preserve any menu-bar key
  32 ;; definitions made in loaddefs.el.
  33 (or (lookup-key global-map [menu-bar])
  34     (define-key global-map [menu-bar] (make-sparse-keymap "menu-bar")))
  35 (defvar menu-bar-help-menu (make-sparse-keymap "Help"))
  36
  37 ;; Force Help item to come last, after the major mode's own items.
  38 ;; The symbol used to be called `help', but that gets confused with the
  39 ;; help key.
  40 (setq menu-bar-final-items '(help-menu))
  41
  42 (define-key global-map [menu-bar help-menu] (cons "Help" menu-bar-help-menu))
  43 (defvar menu-bar-tools-menu (make-sparse-keymap "Tools"))
  44 (define-key global-map [menu-bar tools] (cons "Tools" menu-bar-tools-menu))
  45 ;; This definition is just to show what this looks like.
  46 ;; It gets modified in place when menu-bar-update-buffers is called.
  47 (defvar global-buffers-menu-map (make-sparse-keymap "Buffers"))
  48 (define-key global-map [menu-bar buffer]
  49   (cons "Buffers" global-buffers-menu-map))
  50 (defvar menu-bar-options-menu (make-sparse-keymap "Options"))
  51 (define-key global-map [menu-bar options]
  52   (cons "Options" menu-bar-options-menu))
  53 (defvar menu-bar-edit-menu (make-sparse-keymap "Edit"))
  54 (define-key global-map [menu-bar edit] (cons "Edit" menu-bar-edit-menu))
  55 (defvar menu-bar-file-menu (make-sparse-keymap "File"))
  56 (define-key global-map [menu-bar file] (cons "File" menu-bar-file-menu))
  57
  58 ;; This alias is for compatibility with 19.28 and before.
  59 (defvar menu-bar-files-menu menu-bar-file-menu)
  60
  61 ;; This is referenced by some code below; it is defined in uniquify.el
  62 (defvar uniquify-buffer-name-style)
  63
  64 \f
  65 ;; The "File" menu items
  66 (define-key menu-bar-file-menu [exit-emacs]
  67   '(menu-item "Exit Emacs" save-buffers-kill-emacs
  68               :help "Save unsaved buffers, then exit"))
  69
  70 (define-key menu-bar-file-menu [separator-exit]
  71   '("--"))
  72
  73 ;; Don't use delete-frame as event name because that is a special
  74 ;; event.
  75 (define-key menu-bar-file-menu [delete-this-frame]
  76   '(menu-item "Delete Frame" delete-frame
  77               :visible (fboundp 'delete-frame)
  78               :enable (delete-frame-enabled-p)
  79               :help "Delete currently selected frame"))
  80 (define-key menu-bar-file-menu [make-frame-on-display]
  81   '(menu-item "New Frame on Display..." make-frame-on-display
  82               :visible (fboundp 'make-frame-on-display)
  83               :help "Open a new frame on another display"))
  84 (define-key menu-bar-file-menu [make-frame]
  85   '(menu-item "New Frame" make-frame-command
  86               :visible (fboundp 'make-frame-command)
  87               :help "Open a new frame"))
  88
  89 (define-key menu-bar-file-menu [one-window]
  90   '(menu-item "Remove Splits" delete-other-windows
  91               :enable (not (one-window-p t nil))
  92               :help "Selected window grows to fill the whole frame"))
  93
  94 (define-key menu-bar-file-menu [split-window]
  95   '(menu-item "Split Window" split-window-vertically
  96               :enable (and (menu-bar-menu-frame-live-and-visible-p)
  97                            (menu-bar-non-minibuffer-window-p))
  98               :help "Split selected window in two windows"))
  99
 100 (define-key menu-bar-file-menu [separator-window]
 101   '(menu-item "--"))
 102
 103 (define-key menu-bar-file-menu [ps-print-region]
 104   '(menu-item "Postscript Print Region (B+W)" ps-print-region
 105               :enable mark-active
 106               :help "Pretty-print marked region in black and white to PostScript printer"))
 107 (define-key menu-bar-file-menu [ps-print-buffer]
 108   '(menu-item "Postscript Print Buffer (B+W)" ps-print-buffer
 109               :enable (menu-bar-menu-frame-live-and-visible-p)
 110               :help "Pretty-print current buffer in black and white to PostScript printer"))
 111 (define-key menu-bar-file-menu [ps-print-region-faces]
 112   '(menu-item "Postscript Print Region" ps-print-region-with-faces
 113               :enable mark-active
 114               :help "Pretty-print marked region to PostScript printer"))
 115 (define-key menu-bar-file-menu [ps-print-buffer-faces]
 116   '(menu-item "Postscript Print Buffer" ps-print-buffer-with-faces
 117               :enable (menu-bar-menu-frame-live-and-visible-p)
 118               :help "Pretty-print current buffer to PostScript printer"))
 119 (define-key menu-bar-file-menu [print-region]
 120   '(menu-item "Print Region" print-region
 121               :enable mark-active
 122               :help "Print region between mark and current position"))
 123 (define-key menu-bar-file-menu [print-buffer]
 124   '(menu-item "Print Buffer" print-buffer
 125               :enable (menu-bar-menu-frame-live-and-visible-p)
 126               :help "Print current buffer with page headings"))
 127
 128 (define-key menu-bar-file-menu [separator-print]
 129   '(menu-item "--"))
 130
 131 (define-key menu-bar-file-menu [recover-session]
 132   '(menu-item "Recover Crashed Session" recover-session
 133               :enable (and auto-save-list-file-prefix
 134                            (file-directory-p
 135                             (file-name-directory auto-save-list-file-prefix))
 136                            (directory-files
 137                             (file-name-directory auto-save-list-file-prefix)
 138                             nil
 139                             (concat "\\`"
 140                                     (regexp-quote
 141                                      (file-name-nondirectory
 142                                       auto-save-list-file-prefix)))
 143                             t))
 144               :help "Recover edits from a crashed session"))
 145 (define-key menu-bar-file-menu [revert-buffer]
 146   '(menu-item "Revert Buffer" revert-buffer
 147               :enable (or revert-buffer-function
 148                           revert-buffer-insert-file-contents-function
 149                           (and buffer-file-number
 150                                (or (buffer-modified-p)
 151                                    (not (verify-visited-file-modtime
 152                                          (current-buffer))))))
 153               :help "Re-read current buffer from its file"))
 154 (define-key menu-bar-file-menu [write-file]
 155   '(menu-item "Save As..." write-file
 156               :enable (and (menu-bar-menu-frame-live-and-visible-p)
 157                            (menu-bar-non-minibuffer-window-p))
 158               :help "Write current buffer to another file"))
 159 (define-key menu-bar-file-menu [save-buffer]
 160   '(menu-item "Save" save-buffer
 161               :enable (and (buffer-modified-p)
 162                            (buffer-file-name)
 163                            (menu-bar-non-minibuffer-window-p))
 164               :help "Save current buffer to its file"))
 165
 166 (define-key menu-bar-file-menu [separator-save]
 167   '(menu-item "--"))
 168
 169 (defun menu-find-file-existing ()
 170   "Edit the existing file FILENAME."
 171   (interactive)
 172   (let* ((mustmatch (not (and (fboundp 'x-uses-old-gtk-dialog)
 173                               (x-uses-old-gtk-dialog))))
 174          (filename (car (find-file-read-args "Find file: " mustmatch))))
 175     (if mustmatch
 176         (find-file-existing filename)
 177       (find-file filename))))
 178
 179
 180 (define-key menu-bar-file-menu [kill-buffer]
 181   '(menu-item "Close" kill-this-buffer
 182               :enable (kill-this-buffer-enabled-p)
 183               :help "Discard (kill) current buffer"))
 184 (define-key menu-bar-file-menu [insert-file]
 185   '(menu-item "Insert File..." insert-file
 186               :enable (menu-bar-non-minibuffer-window-p)
 187               :help "Insert another file into current buffer"))
 188 (define-key menu-bar-file-menu [dired]
 189   '(menu-item "Open Directory..." dired
 190               :enable (menu-bar-non-minibuffer-window-p)
 191               :help "Read a directory, to operate on its files"))
 192 (define-key menu-bar-file-menu [open-file]
 193   '(menu-item "Open File..." menu-find-file-existing
 194               :enable (menu-bar-non-minibuffer-window-p)
 195               :help "Read an existing file into an Emacs buffer"))
 196 (define-key menu-bar-file-menu [new-file]
 197   '(menu-item "Visit New File..." find-file
 198               :enable (menu-bar-non-minibuffer-window-p)
 199               :help "Specify a new file's name, to edit the file"))
 200
 201 \f
 202 ;; The "Edit" menu items
 203
 204 ;; The "Edit->Search" submenu
 205 (defvar menu-bar-last-search-type nil
 206   "Type of last non-incremental search command called from the menu.")
 207
 208 (defun nonincremental-repeat-search-forward ()
 209   "Search forward for the previous search string or regexp."
 210   (interactive)
 211   (cond
 212    ((and (eq menu-bar-last-search-type 'string)
 213          search-ring)
 214     (search-forward (car search-ring)))
 215    ((and (eq menu-bar-last-search-type 'regexp)
 216          regexp-search-ring)
 217     (re-search-forward (car regexp-search-ring)))
 218    (t
 219     (error "No previous search"))))
 220
 221 (defun nonincremental-repeat-search-backward ()
 222   "Search backward for the previous search string or regexp."
 223   (interactive)
 224   (cond
 225    ((and (eq menu-bar-last-search-type 'string)
 226          search-ring)
 227     (search-backward (car search-ring)))
 228    ((and (eq menu-bar-last-search-type 'regexp)
 229          regexp-search-ring)
 230     (re-search-backward (car regexp-search-ring)))
 231    (t
 232     (error "No previous search"))))
 233
 234 (defun nonincremental-search-forward (string)
 235   "Read a string and search for it nonincrementally."
 236   (interactive "sSearch for string: ")
 237   (setq menu-bar-last-search-type 'string)
 238   (if (equal string "")
 239       (search-forward (car search-ring))
 240     (isearch-update-ring string nil)
 241     (search-forward string)))
 242
 243 (defun nonincremental-search-backward (string)
 244   "Read a string and search backward for it nonincrementally."
 245   (interactive "sSearch for string: ")
 246   (setq menu-bar-last-search-type 'string)
 247   (if (equal string "")
 248       (search-backward (car search-ring))
 249     (isearch-update-ring string nil)
 250     (search-backward string)))
 251
 252 (defun nonincremental-re-search-forward (string)
 253   "Read a regular expression and search for it nonincrementally."
 254   (interactive "sSearch for regexp: ")
 255   (setq menu-bar-last-search-type 'regexp)
 256   (if (equal string "")
 257       (re-search-forward (car regexp-search-ring))
 258     (isearch-update-ring string t)
 259     (re-search-forward string)))
 260
 261 (defun nonincremental-re-search-backward (string)
 262   "Read a regular expression and search backward for it nonincrementally."
 263   (interactive "sSearch for regexp: ")
 264   (setq menu-bar-last-search-type 'regexp)
 265   (if (equal string "")
 266       (re-search-backward (car regexp-search-ring))
 267     (isearch-update-ring string t)
 268     (re-search-backward string)))
 269
 270 (defvar menu-bar-search-menu (make-sparse-keymap "Search"))
 271
 272 ;; The Edit->Search->Incremental Search menu
 273 (defvar menu-bar-i-search-menu
 274   (make-sparse-keymap "Incremental Search"))
 275
 276 (define-key menu-bar-i-search-menu [isearch-backward-regexp]
 277   '(menu-item "Backward Regexp..." isearch-backward-regexp
 278               :help "Search backwards for a regular expression as you type it"))
 279 (define-key menu-bar-i-search-menu [isearch-forward-regexp]
 280   '(menu-item "Forward Regexp..." isearch-forward-regexp
 281               :help "Search forward for a regular expression as you type it"))
 282 (define-key menu-bar-i-search-menu [isearch-backward]
 283   '(menu-item "Backward String..." isearch-backward
 284               :help "Search backwards for a string as you type it"))
 285 (define-key menu-bar-i-search-menu [isearch-forward]
 286   '(menu-item "Forward String..." isearch-forward
 287               :help "Search forward for a string as you type it"))
 288
 289
 290 (define-key menu-bar-search-menu [i-search]
 291   (list 'menu-item "Incremental Search" menu-bar-i-search-menu))
 292 (define-key menu-bar-search-menu [separator-tag-isearch]
 293   '(menu-item "--"))
 294
 295 (define-key menu-bar-search-menu [tags-continue]
 296   '(menu-item "Continue Tags Search" tags-loop-continue
 297               :help "Continue last tags search operation"))
 298 (define-key menu-bar-search-menu [tags-srch]
 299   '(menu-item "Search Tagged Files..." tags-search
 300               :help "Search for a regexp in all tagged files"))
 301 (define-key menu-bar-search-menu [separator-tag-search]
 302   '(menu-item "--"))
 303
 304 (define-key menu-bar-search-menu [repeat-search-back]
 305   '(menu-item "Repeat Backwards" nonincremental-repeat-search-backward
 306               :enable (or (and (eq menu-bar-last-search-type 'string)
 307                                search-ring)
 308                           (and (eq menu-bar-last-search-type 'regexp)
 309                                regexp-search-ring))
 310               :help "Repeat last search backwards"))
 311 (define-key menu-bar-search-menu [repeat-search-fwd]
 312   '(menu-item "Repeat Forward" nonincremental-repeat-search-forward
 313               :enable (or (and (eq menu-bar-last-search-type 'string)
 314                                search-ring)
 315                           (and (eq menu-bar-last-search-type 'regexp)
 316                                regexp-search-ring))
 317               :help "Repeat last search forward"))
 318 (define-key menu-bar-search-menu [separator-repeat-search]
 319   '(menu-item "--"))
 320
 321 (define-key menu-bar-search-menu [re-search-backward]
 322   '(menu-item "Regexp Backwards..." nonincremental-re-search-backward
 323               :help "Search backwards for a regular expression"))
 324 (define-key menu-bar-search-menu [re-search-forward]
 325   '(menu-item "Regexp Forward..." nonincremental-re-search-forward
 326               :help "Search forward for a regular expression"))
 327
 328 (define-key menu-bar-search-menu [search-backward]
 329   '(menu-item "String Backwards..." nonincremental-search-backward
 330               :help "Search backwards for a string"))
 331 (define-key menu-bar-search-menu [search-forward]
 332   '(menu-item "String Forward..." nonincremental-search-forward
 333               :help "Search forward for a string"))
 334
 335 ;; The Edit->Replace submenu
 336
 337 (defvar menu-bar-replace-menu (make-sparse-keymap "Replace"))
 338
 339 (define-key menu-bar-replace-menu [tags-repl-continue]
 340   '(menu-item "Continue Replace" tags-loop-continue
 341               :help "Continue last tags replace operation"))
 342 (define-key menu-bar-replace-menu [tags-repl]
 343   '(menu-item "Replace in Tagged Files..." tags-query-replace
 344               :help "Interactively replace a regexp in all tagged files"))
 345 (define-key menu-bar-replace-menu [separator-replace-tags]
 346   '(menu-item "--"))
 347
 348 (define-key menu-bar-replace-menu [query-replace-regexp]
 349   '(menu-item "Replace Regexp..." query-replace-regexp
 350               :enable (not buffer-read-only)
 351               :help "Replace regular expression interactively, ask about each occurrence"))
 352 (define-key menu-bar-replace-menu [query-replace]
 353   '(menu-item "Replace String..." query-replace
 354               :enable (not buffer-read-only)
 355               :help "Replace string interactively, ask about each occurrence"))
 356
 357 ;;; Assemble the top-level Edit menu items.
 358 (define-key menu-bar-edit-menu [props]
 359   '(menu-item "Text Properties" facemenu-menu))
 360
 361 (define-key menu-bar-edit-menu [fill]
 362   '(menu-item "Fill" fill-region
 363               :enable (and mark-active (not buffer-read-only))
 364               :help
 365               "Fill text in region to fit between left and right margin"))
 366
 367 (define-key menu-bar-edit-menu [separator-bookmark]
 368   '(menu-item "--"))
 369
 370 (define-key menu-bar-edit-menu [bookmark]
 371   '(menu-item "Bookmarks" menu-bar-bookmark-map))
 372
 373 (defvar menu-bar-goto-menu (make-sparse-keymap "Go To"))
 374
 375 (define-key menu-bar-goto-menu [set-tags-name]
 376   '(menu-item "Set Tags File Name..." visit-tags-table
 377               :help "Tell Tags commands which tag table file to use"))
 378
 379 (define-key menu-bar-goto-menu [separator-tag-file]
 380   '(menu-item "--"))
 381
 382 (define-key menu-bar-goto-menu [apropos-tags]
 383   '(menu-item "Tags Apropos..." tags-apropos
 384               :help "Find function/variables whose names match regexp"))
 385 (define-key menu-bar-goto-menu [next-tag-otherw]
 386   '(menu-item "Next Tag in Other Window"
 387               menu-bar-next-tag-other-window
 388               :enable (and (boundp 'tags-location-ring)
 389                            (not (ring-empty-p tags-location-ring)))
 390               :help "Find next function/variable matching last tag name in another window"))
 391
 392 (defun menu-bar-next-tag-other-window ()
 393   "Find the next definition of the tag already specified."
 394   (interactive)
 395   (find-tag-other-window nil t))
 396
 397 (defun menu-bar-next-tag ()
 398   "Find the next definition of the tag already specified."
 399   (interactive)
 400   (find-tag nil t))
 401
 402 (define-key menu-bar-goto-menu [next-tag]
 403   '(menu-item "Find Next Tag"
 404               menu-bar-next-tag
 405               :enable (and (boundp 'tags-location-ring)
 406                            (not (ring-empty-p tags-location-ring)))
 407               :help "Find next function/variable matching last tag name"))
 408 (define-key menu-bar-goto-menu [find-tag-otherw]
 409   '(menu-item "Find Tag in Other Window..." find-tag-other-window
 410               :help "Find function/variable definition in another window"))
 411 (define-key menu-bar-goto-menu [find-tag]
 412   '(menu-item "Find Tag..." find-tag
 413               :help "Find definition of function or variable"))
 414
 415 (define-key menu-bar-goto-menu [separator-tags]
 416   '(menu-item "--"))
 417
 418 (define-key menu-bar-goto-menu [end-of-buf]
 419   '(menu-item "Goto End of Buffer" end-of-buffer))
 420 (define-key menu-bar-goto-menu [beg-of-buf]
 421   '(menu-item "Goto Beginning of Buffer" beginning-of-buffer))
 422 (define-key menu-bar-goto-menu [go-to-pos]
 423   '(menu-item "Goto Buffer Position..." goto-char
 424               :help "Read a number N and go to buffer position N"))
 425 (define-key menu-bar-goto-menu [go-to-line]
 426   '(menu-item "Goto Line..." goto-line
 427               :help "Read a line number and go to that line"))
 428
 429 (define-key menu-bar-edit-menu [goto]
 430   (list 'menu-item "Go To" menu-bar-goto-menu))
 431
 432 (define-key menu-bar-edit-menu [replace]
 433   (list 'menu-item "Replace" menu-bar-replace-menu))
 434
 435 (define-key menu-bar-edit-menu [search]
 436   (list 'menu-item "Search" menu-bar-search-menu))
 437
 438 (define-key menu-bar-edit-menu [separator-search]
 439   '(menu-item "--"))
 440
 441 (define-key menu-bar-edit-menu [mark-whole-buffer]
 442   '(menu-item "Select All" mark-whole-buffer
 443               :help "Mark the whole buffer for a subsequent cut/copy."))
 444 (define-key menu-bar-edit-menu [clear]
 445   '(menu-item "Clear" delete-region
 446               :enable (and mark-active
 447                            (not buffer-read-only)
 448                            (not (mouse-region-match)))
 449               :help
 450               "Delete the text in region between mark and current position"))
 451 (defvar yank-menu (cons "Select Yank" nil))
 452 (fset 'yank-menu (cons 'keymap yank-menu))
 453 (define-key menu-bar-edit-menu [paste-from-menu]
 454   '(menu-item "Paste from kill menu" yank-menu
 455               :enable (and (cdr yank-menu) (not buffer-read-only))
 456               :help "Choose a string from the kill ring and paste it"))
 457 (define-key menu-bar-edit-menu [paste]
 458   '(menu-item "Paste" yank
 459               :enable (and
 460                        ;; Emacs compiled --without-x doesn't have
 461                        ;; x-selection-exists-p.
 462                        (fboundp 'x-selection-exists-p)
 463                        (x-selection-exists-p) (not buffer-read-only))
 464               :help "Paste (yank) text most recently cut/copied"))
 465 (define-key menu-bar-edit-menu [copy]
 466   '(menu-item "Copy" menu-bar-kill-ring-save
 467               :enable mark-active
 468               :help "Copy text in region between mark and current position"
 469               :keys "\\[kill-ring-save]"))
 470 (define-key menu-bar-edit-menu [cut]
 471   '(menu-item "Cut" kill-region
 472               :enable (and mark-active (not buffer-read-only))
 473               :help
 474               "Cut (kill) text in region between mark and current position"))
 475 (define-key menu-bar-edit-menu [undo]
 476   '(menu-item "Undo" undo
 477               :enable (and (not buffer-read-only)
 478                            (not (eq t buffer-undo-list))
 479                            (if (eq last-command 'undo)
 480                                (listp pending-undo-list)
 481                              (consp buffer-undo-list)))
 482               :help "Undo last operation"))
 483
 484
 485 (defun menu-bar-kill-ring-save (beg end)
 486   (interactive "r")
 487   (if (mouse-region-match)
 488       (message "Selecting a region with the mouse does `copy' automatically")
 489     (kill-ring-save beg end)))
 490
 491 ;; These are alternative definitions for the cut, paste and copy
 492 ;; menu items.  Use them if your system expects these to use the clipboard.
 493
 494 (put 'clipboard-kill-region 'menu-enable
 495      '(and mark-active (not buffer-read-only)))
 496 (put 'clipboard-kill-ring-save 'menu-enable 'mark-active)
 497 (put 'clipboard-yank 'menu-enable
 498      '(and (or (and (fboundp 'x-selection-exists-p)
 499                     (x-selection-exists-p))
 500                (x-selection-exists-p 'CLIPBOARD))
 501            (not buffer-read-only)))
 502
 503 (defun clipboard-yank ()
 504   "Insert the clipboard contents, or the last stretch of killed text."
 505   (interactive "*")
 506   (let ((x-select-enable-clipboard t))
 507     (yank)))
 508
 509 (defun clipboard-kill-ring-save (beg end)
 510   "Copy region to kill ring, and save in the X clipboard."
 511   (interactive "r")
 512   (let ((x-select-enable-clipboard t))
 513     (kill-ring-save beg end)))
 514
 515 (defun clipboard-kill-region (beg end)
 516   "Kill the region, and save it in the X clipboard."
 517   (interactive "r")
 518   (let ((x-select-enable-clipboard t))
 519     (kill-region beg end)))
 520
 521 (defun menu-bar-enable-clipboard ()
 522   "Make CUT, PASTE and COPY (keys and menu bar items) use the clipboard.
 523 Do the same for the keys of the same name."
 524   (interactive)
 525   ;; We can't use constant list structure here because it becomes pure,
 526   ;; and because it gets modified with cache data.
 527   (define-key menu-bar-edit-menu [paste]
 528     (cons "Paste" (cons "Paste text from clipboard" 'clipboard-yank)))
 529   (define-key menu-bar-edit-menu [copy]
 530     (cons "Copy" (cons "Copy text in region to the clipboard"
 531                        'clipboard-kill-ring-save)))
 532   (define-key menu-bar-edit-menu [cut]
 533     (cons "Cut" (cons "Delete text in region and copy it to the clipboard"
 534                       'clipboard-kill-region)))
 535
 536   ;; These are Sun server keysyms for the Cut, Copy and Paste keys
 537   ;; (also for XFree86 on Sun keyboard):
 538   (define-key global-map [f20] 'clipboard-kill-region)
 539   (define-key global-map [f16] 'clipboard-kill-ring-save)
 540   (define-key global-map [f18] 'clipboard-yank)
 541   ;; X11R6 versions:
 542   (define-key global-map [cut] 'clipboard-kill-region)
 543   (define-key global-map [copy] 'clipboard-kill-ring-save)
 544   (define-key global-map [paste] 'clipboard-yank))
 545 \f
 546 ;; The "Options" menu items
 547
 548 (defvar menu-bar-custom-menu (make-sparse-keymap "Customize"))
 549
 550 (define-key menu-bar-custom-menu [customize-apropos-groups]
 551   '(menu-item "Groups Matching Regexp..." customize-apropos-groups
 552               :help "Browse groups whose names match regexp"))
 553 (define-key menu-bar-custom-menu [customize-apropos-faces]
 554   '(menu-item "Faces Matching Regexp..." customize-apropos-faces
 555               :help "Browse faces whose names match regexp"))
 556 (define-key menu-bar-custom-menu [customize-apropos-options]
 557   '(menu-item "Options Matching Regexp..." customize-apropos-options
 558               :help "Browse options whose names match regexp"))
 559 (define-key menu-bar-custom-menu [customize-apropos]
 560   '(menu-item "Settings Matching Regexp..." customize-apropos
 561               :help "Browse customizable settings whose names match regexp"))
 562 (define-key menu-bar-custom-menu [separator-1]
 563   '("--"))
 564 (define-key menu-bar-custom-menu [customize-group]
 565   '(menu-item "Specific Group..." customize-group
 566               :help "Customize settings of specific group"))
 567 (define-key menu-bar-custom-menu [customize-face]
 568   '(menu-item "Specific Face..." customize-face
 569               :help "Customize attributes of specific face"))
 570 (define-key menu-bar-custom-menu [customize-option]
 571   '(menu-item "Specific Option..." customize-option
 572               :help "Customize value of specific option"))
 573 (define-key menu-bar-custom-menu [separator-2]
 574   '("--"))
 575 (define-key menu-bar-custom-menu [customize-changed-options]
 576   '(menu-item "New Options..." customize-changed-options
 577               :help "Options added or changed in recent Emacs versions"))
 578 (define-key menu-bar-custom-menu [customize-saved]
 579   '(menu-item "Saved Options" customize-saved
 580               :help "Customize previously saved options"))
 581 (define-key menu-bar-custom-menu [separator-3]
 582   '("--"))
 583 (define-key menu-bar-custom-menu [customize-browse]
 584   '(menu-item "Browse Customization Groups" customize-browse
 585               :help "Browse all customization groups"))
 586 (define-key menu-bar-custom-menu [customize]
 587   '(menu-item "Top-level Customization Group" customize
 588               :help "The master group called `Emacs'"))
 589
 590 ;(defvar menu-bar-preferences-menu (make-sparse-keymap "Preferences"))
 591
 592 (defmacro menu-bar-make-mm-toggle (fname doc help &optional props)
 593   "Make a menu-item for a global minor mode toggle.
 594 FNAME is the minor mode's name (variable and function).
 595 DOC is the text to use for the menu entry.
 596 HELP is the text to use for the tooltip.
 597 PROPS are additional properties."
 598   `'(menu-item ,doc ,fname
 599      ,@props
 600      :help ,help
 601      :button (:toggle . (and (default-boundp ',fname)
 602                              (default-value ',fname)))))
 603
 604 (defmacro menu-bar-make-toggle (name variable doc message help &rest body)
 605   `(progn
 606      (defun ,name (&optional interactively)
 607        ,(concat "Toggle whether to " (downcase (substring help 0 1))
 608                 (substring help 1) ".
 609 In an interactive call, record this option as a candidate for saving
 610 by \"Save Options\" in Custom buffers.")
 611        (interactive "p")
 612        (if ,(if body `(progn . ,body)
 613               `(progn
 614                  (custom-load-symbol ',variable)
 615                  (let ((set (or (get ',variable 'custom-set) 'set-default))
 616                        (get (or (get ',variable 'custom-get) 'default-value)))
 617                    (funcall set ',variable (not (funcall get ',variable))))))
 618            (message ,message "enabled globally")
 619          (message ,message "disabled globally"))
 620        ;; The function `customize-mark-as-set' must only be called when
 621        ;; a variable is set interactively, as the purpose is to mark it as
 622        ;; a candidate for "Save Options", and we do not want to save options
 623        ;; the user have already set explicitly in his init file.
 624        (if interactively (customize-mark-as-set ',variable)))
 625      '(menu-item ,doc ,name
 626                  :help ,help
 627                  :button (:toggle . (and (default-boundp ',variable)
 628                                          (default-value ',variable))))))
 629
 630 ;; Function for setting/saving default font.
 631
 632 (defun menu-set-font ()
 633   "Interactively select a font and make it the default."
 634   (interactive)
 635   (let ((font (if (fboundp 'x-select-font)
 636                   (x-select-font)
 637                 (mouse-select-font)))
 638         spec)
 639     (when font
 640       (set-face-attribute 'default nil :font font)
 641       (setq spec (list (list t (face-attr-construct 'default))))
 642       (put 'default 'customized-face spec)
 643       (custom-push-theme 'theme-face 'default 'user 'set spec)
 644       (put 'default 'face-modified nil))))
 645
 646 ;;; Assemble all the top-level items of the "Options" menu
 647 (define-key menu-bar-options-menu [customize]
 648   (list 'menu-item "Customize Emacs" menu-bar-custom-menu))
 649
 650 (defun menu-bar-options-save ()
 651   "Save current values of Options menu items using Custom."
 652   (interactive)
 653   (let ((need-save nil))
 654     ;; These are set with menu-bar-make-mm-toggle, which does not
 655     ;; put on a customized-value property.
 656     (dolist (elt '(line-number-mode column-number-mode size-indication-mode
 657                    cua-mode show-paren-mode transient-mark-mode
 658                    blink-cursor-mode display-time-mode display-battery-mode))
 659       (and (customize-mark-to-save elt)
 660            (setq need-save t)))
 661     ;; These are set with `customize-set-variable'.
 662     (dolist (elt '(scroll-bar-mode
 663                    debug-on-quit debug-on-error
 664                    tooltip-mode menu-bar-mode tool-bar-mode
 665                    save-place uniquify-buffer-name-style fringe-mode
 666                    indicate-empty-lines indicate-buffer-boundaries
 667                    case-fold-search
 668                    current-language-environment default-input-method
 669                    ;; Saving `text-mode-hook' is somewhat questionable,
 670                    ;; as we might get more than we bargain for, if
 671                    ;; other code may has added hooks as well.
 672                    ;; Nonetheless, not saving it would like be confuse
 673                    ;; more often.
 674                    ;; -- Per Abrahamsen <abraham@dina.kvl.dk> 2002-02-11.
 675                    text-mode-hook))
 676       (and (get elt 'customized-value)
 677            (customize-mark-to-save elt)
 678            (setq need-save t)))
 679     (when (get 'default 'customized-face)
 680       (put 'default 'saved-face (get 'default 'customized-face))
 681       (put 'default 'customized-face nil)
 682       (setq need-save t))
 683     ;; Save if we changed anything.
 684     (when need-save
 685       (custom-save-all))))
 686
 687 (define-key menu-bar-options-menu [save]
 688   '(menu-item "Save Options" menu-bar-options-save
 689               :help "Save options set from the menu above"))
 690
 691 (define-key menu-bar-options-menu [custom-separator]
 692   '("--"))
 693
 694 (define-key menu-bar-options-menu [menu-set-font]
 695   '(menu-item "Set Default Font..." menu-set-font
 696               :visible (display-multi-font-p)
 697               :help "Select a default font"))
 698
 699 ;; The "Show/Hide" submenu of menu "Options"
 700
 701 (defvar menu-bar-showhide-menu (make-sparse-keymap "Show/Hide"))
 702
 703 (define-key menu-bar-showhide-menu [column-number-mode]
 704   (menu-bar-make-mm-toggle column-number-mode
 705                            "Column Numbers"
 706                            "Show the current column number in the mode line"))
 707
 708 (define-key menu-bar-showhide-menu [line-number-mode]
 709   (menu-bar-make-mm-toggle line-number-mode
 710                            "Line Numbers"
 711                            "Show the current line number in the mode line"))
 712
 713 (define-key menu-bar-showhide-menu [size-indication-mode]
 714   (menu-bar-make-mm-toggle size-indication-mode
 715                            "Size Indication"
 716                            "Show the size of the buffer in the mode line"))
 717
 718 (define-key menu-bar-showhide-menu [linecolumn-separator]
 719   '("--"))
 720
 721 (define-key menu-bar-showhide-menu [showhide-battery]
 722   (menu-bar-make-mm-toggle display-battery-mode
 723                            "Battery Status"
 724                            "Display battery status information in mode line"))
 725
 726 (define-key menu-bar-showhide-menu [showhide-date-time]
 727   (menu-bar-make-mm-toggle display-time-mode
 728                            "Time, Load and Mail"
 729                            "Display time, system load averages and \
 730 mail status in mode line"))
 731
 732 (define-key menu-bar-showhide-menu [datetime-separator]
 733   '("--"))
 734
 735 (define-key menu-bar-showhide-menu [showhide-speedbar]
 736   '(menu-item "Speedbar" speedbar-frame-mode
 737               :help "Display a Speedbar quick-navigation frame"
 738               :button (:toggle
 739                        . (and (boundp 'speedbar-frame)
 740                               (frame-live-p (symbol-value 'speedbar-frame))
 741                               (frame-visible-p
 742                                (symbol-value 'speedbar-frame))))))
 743
 744 (defvar menu-bar-showhide-fringe-menu (make-sparse-keymap "Fringe"))
 745
 746 (defvar menu-bar-showhide-fringe-ind-menu
 747   (make-sparse-keymap "Buffer boundaries"))
 748
 749 (defun menu-bar-showhide-fringe-ind-customize ()
 750   "Show customization buffer for `indicate-buffer-boundaries'."
 751   (interactive)
 752   (customize-variable 'indicate-buffer-boundaries))
 753
 754 (define-key menu-bar-showhide-fringe-ind-menu [customize]
 755   '(menu-item "Other (Customize)"
 756               menu-bar-showhide-fringe-ind-customize
 757               :help "Additional choices available through Custom buffer"
 758               :visible (display-graphic-p)
 759               :button (:radio . (not (member indicate-buffer-boundaries
 760                                              '(nil left right
 761                                                ((top . left) (bottom . right))
 762                                                ((t . right) (top . left))))))))
 763
 764 (defun menu-bar-showhide-fringe-ind-mixed ()
 765   "Display top and bottom indicators in opposite fringes, arrows in right."
 766   (interactive)
 767   (customize-set-variable 'indicate-buffer-boundaries
 768                           '((t . right) (top . left))))
 769
 770 (define-key menu-bar-showhide-fringe-ind-menu [mixed]
 771   '(menu-item "Opposite, Arrows Right" menu-bar-showhide-fringe-ind-mixed
 772               :help
 773               "Show top/bottom indicators in opposite fringes, arrows in right"
 774               :visible (display-graphic-p)
 775               :button (:radio . (equal indicate-buffer-boundaries
 776                                        '((t . right) (top . left))))))
 777
 778 (defun menu-bar-showhide-fringe-ind-box ()
 779   "Display top and bottom indicators in opposite fringes."
 780   (interactive)
 781   (customize-set-variable 'indicate-buffer-boundaries
 782                           '((top . left) (bottom . right))))
 783
 784 (define-key menu-bar-showhide-fringe-ind-menu [box]
 785   '(menu-item "Opposite, No Arrows" menu-bar-showhide-fringe-ind-box
 786               :help "Show top/bottom indicators in opposite fringes, no arrows"
 787               :visible (display-graphic-p)
 788               :button (:radio . (equal indicate-buffer-boundaries
 789                                        '((top . left) (bottom . right))))))
 790
 791 (defun menu-bar-showhide-fringe-ind-right ()
 792   "Display buffer boundaries and arrows in the right fringe."
 793   (interactive)
 794   (customize-set-variable 'indicate-buffer-boundaries 'right))
 795
 796 (define-key menu-bar-showhide-fringe-ind-menu [right]
 797   '(menu-item "In Right Fringe" menu-bar-showhide-fringe-ind-right
 798               :help "Show buffer boundaries and arrows in right fringe"
 799               :visible (display-graphic-p)
 800               :button (:radio . (eq indicate-buffer-boundaries 'right))))
 801
 802 (defun menu-bar-showhide-fringe-ind-left ()
 803   "Display buffer boundaries and arrows in the left fringe."
 804   (interactive)
 805   (customize-set-variable 'indicate-buffer-boundaries 'left))
 806
 807 (define-key menu-bar-showhide-fringe-ind-menu [left]
 808   '(menu-item "In Left Fringe" menu-bar-showhide-fringe-ind-left
 809               :help "Show buffer boundaries and arrows in left fringe"
 810               :visible (display-graphic-p)
 811               :button (:radio . (eq indicate-buffer-boundaries 'left))))
 812
 813 (defun menu-bar-showhide-fringe-ind-none ()
 814   "Do not display any buffer boundary indicators."
 815   (interactive)
 816   (customize-set-variable 'indicate-buffer-boundaries nil))
 817
 818 (define-key menu-bar-showhide-fringe-ind-menu [none]
 819   '(menu-item "No Indicators" menu-bar-showhide-fringe-ind-none
 820               :help "Hide all buffer boundary indicators and arrows"
 821               :visible (display-graphic-p)
 822               :button (:radio . (eq indicate-buffer-boundaries nil))))
 823
 824 (define-key menu-bar-showhide-fringe-menu [showhide-fringe-ind]
 825   (list 'menu-item "Buffer Boundaries" menu-bar-showhide-fringe-ind-menu
 826         :visible `(display-graphic-p)
 827         :help "Indicate buffer boundaries in fringe"))
 828
 829 (define-key menu-bar-showhide-fringe-menu [indicate-empty-lines]
 830   (menu-bar-make-toggle toggle-indicate-empty-lines indicate-empty-lines
 831                         "Empty Line Indicators"
 832                         "Indicating of empty lines %s"
 833                         "Indicate trailing empty lines in fringe, globally"))
 834
 835 (defun menu-bar-showhide-fringe-menu-customize ()
 836   "Show customization buffer for `fringe-mode'."
 837   (interactive)
 838   (customize-variable 'fringe-mode))
 839
 840 (define-key menu-bar-showhide-fringe-menu [customize]
 841   '(menu-item "Customize Fringe" menu-bar-showhide-fringe-menu-customize
 842               :help "Detailed customization of fringe"
 843               :visible (display-graphic-p)))
 844
 845 (defun menu-bar-showhide-fringe-menu-customize-reset ()
 846   "Reset the fringe mode: display fringes on both sides of a window."
 847   (interactive)
 848   (customize-set-variable 'fringe-mode nil))
 849
 850 (define-key menu-bar-showhide-fringe-menu [default]
 851   '(menu-item "Default" menu-bar-showhide-fringe-menu-customize-reset
 852               :help "Default width fringe on both left and right side"
 853               :visible (display-graphic-p)
 854               :button (:radio . (eq fringe-mode nil))))
 855
 856 (defun menu-bar-showhide-fringe-menu-customize-right ()
 857   "Display fringes only on the right of each window."
 858   (interactive)
 859   (require 'fringe)
 860   (customize-set-variable 'fringe-mode '(0 . nil)))
 861
 862 (define-key menu-bar-showhide-fringe-menu [right]
 863   '(menu-item "On the Right" menu-bar-showhide-fringe-menu-customize-right
 864               :help "Fringe only on the right side"
 865               :visible (display-graphic-p)
 866               :button (:radio . (equal fringe-mode '(0 . nil)))))
 867
 868 (defun menu-bar-showhide-fringe-menu-customize-left ()
 869   "Display fringes only on the left of each window."
 870   (interactive)
 871   (require 'fringe)
 872   (customize-set-variable 'fringe-mode '(nil . 0)))
 873
 874 (define-key menu-bar-showhide-fringe-menu [left]
 875   '(menu-item "On the Left" menu-bar-showhide-fringe-menu-customize-left
 876               :help "Fringe only on the left side"
 877               :visible (display-graphic-p)
 878               :button (:radio . (equal fringe-mode '(nil . 0)))))
 879
 880 (defun menu-bar-showhide-fringe-menu-customize-disable ()
 881   "Do not display window fringes."
 882   (interactive)
 883   (require 'fringe)
 884   (customize-set-variable 'fringe-mode 0))
 885
 886 (define-key menu-bar-showhide-fringe-menu [none]
 887   '(menu-item "None" menu-bar-showhide-fringe-menu-customize-disable
 888               :help "Turn off fringe"
 889               :visible (display-graphic-p)
 890               :button (:radio . (eq fringe-mode 0))))
 891
 892 (define-key menu-bar-showhide-menu [showhide-fringe]
 893   (list 'menu-item "Fringe" menu-bar-showhide-fringe-menu
 894         :visible `(display-graphic-p)))
 895
 896 (defvar menu-bar-showhide-scroll-bar-menu (make-sparse-keymap "Scroll-bar"))
 897
 898 (define-key menu-bar-showhide-scroll-bar-menu [right]
 899   '(menu-item "On the Right"
 900               menu-bar-right-scroll-bar
 901               :help "Scroll-bar on the right side"
 902               :visible (display-graphic-p)
 903               :button (:radio . (eq (cdr (assq 'vertical-scroll-bars
 904                                                (frame-parameters))) 'right))))
 905 (defun menu-bar-right-scroll-bar ()
 906   "Display scroll bars on the right of each window."
 907   (interactive)
 908   (customize-set-variable 'scroll-bar-mode 'right))
 909
 910 (define-key menu-bar-showhide-scroll-bar-menu [left]
 911   '(menu-item "On the Left"
 912               menu-bar-left-scroll-bar
 913               :help "Scroll-bar on the left side"
 914               :visible (display-graphic-p)
 915               :button (:radio . (eq (cdr (assq 'vertical-scroll-bars
 916                                                (frame-parameters))) 'left))))
 917
 918 (defun menu-bar-left-scroll-bar ()
 919   "Display scroll bars on the left of each window."
 920   (interactive)
 921   (customize-set-variable 'scroll-bar-mode 'left))
 922
 923 (define-key menu-bar-showhide-scroll-bar-menu [none]
 924   '(menu-item "None"
 925               menu-bar-no-scroll-bar
 926               :help "Turn off scroll-bar"
 927               :visible (display-graphic-p)
 928               :button (:radio . (eq (cdr (assq 'vertical-scroll-bars
 929                                                (frame-parameters))) nil))))
 930
 931 (defun menu-bar-no-scroll-bar ()
 932   "Turn off scroll bars."
 933   (interactive)
 934   (customize-set-variable 'scroll-bar-mode nil))
 935
 936 (define-key menu-bar-showhide-menu [showhide-scroll-bar]
 937   (list 'menu-item "Scroll-bar" menu-bar-showhide-scroll-bar-menu
 938         :visible `(display-graphic-p)))
 939
 940 (define-key menu-bar-showhide-menu [showhide-tooltip-mode]
 941   (list 'menu-item "Tooltips" 'tooltip-mode
 942         :help "Turn tooltips on/off"
 943         :visible  `(and (display-graphic-p) (fboundp 'x-show-tip))
 944         :button `(:toggle . tooltip-mode)))
 945
 946 (define-key menu-bar-showhide-menu [menu-bar-mode]
 947   '(menu-item "Menu-bar" toggle-menu-bar-mode-from-frame
 948               :help "Turn menu-bar on/off"
 949               :button (:toggle . (> (frame-parameter nil 'menu-bar-lines) 0))))
 950
 951 (define-key menu-bar-showhide-menu [showhide-tool-bar]
 952   (list 'menu-item "Tool-bar" 'toggle-tool-bar-mode-from-frame
 953         :help "Toggle tool-bar on/off"
 954         :visible `(display-graphic-p)
 955         :button `(:toggle . (> (frame-parameter nil 'tool-bar-lines) 0))))
 956
 957 (define-key menu-bar-options-menu [showhide]
 958   (list 'menu-item "Show/Hide" menu-bar-showhide-menu))
 959
 960 (define-key menu-bar-options-menu [showhide-separator]
 961   '("--"))
 962
 963 (define-key menu-bar-options-menu [mule]
 964   ;; It is better not to use backquote here,
 965   ;; because that makes a bootstrapping problem
 966   ;; if you need to recompile all the Lisp files using interpreted code.
 967   (list 'menu-item "Mule (Multilingual Environment)" mule-menu-keymap
 968 ;; Most of the MULE menu actually does make sense in unibyte mode,
 969 ;; e.g. language selection.
 970 ;;;     ':visible 'default-enable-multibyte-characters
 971         ))
 972 ;(setq menu-bar-final-items (cons 'mule menu-bar-final-items))
 973 ;(define-key menu-bar-options-menu [preferences]
 974 ;  (list 'menu-item "Preferences" menu-bar-preferences-menu
 975 ;       :help "Toggle important global options"))
 976
 977 (define-key menu-bar-options-menu [mule-separator]
 978   '("--"))
 979
 980 (define-key menu-bar-options-menu [debug-on-quit]
 981   (menu-bar-make-toggle toggle-debug-on-quit debug-on-quit
 982                         "Enter Debugger on Quit/C-g" "Debug on Quit %s"
 983                         "Enter Lisp debugger when C-g is pressed"))
 984 (define-key menu-bar-options-menu [debug-on-error]
 985   (menu-bar-make-toggle toggle-debug-on-error debug-on-error
 986                         "Enter Debugger on Error" "Debug on Error %s"
 987                         "Enter Lisp debugger when an error is signaled"))
 988 (define-key menu-bar-options-menu [debugger-separator]
 989   '("--"))
 990
 991 (define-key menu-bar-options-menu [blink-cursor-mode]
 992   (menu-bar-make-mm-toggle blink-cursor-mode
 993                            "Blinking Cursor"
 994                            "Whether the cursor blinks (Blink Cursor mode)"))
 995 (define-key menu-bar-options-menu [cursor-separator]
 996   '("--"))
 997
 998 (define-key menu-bar-options-menu [save-place]
 999   (menu-bar-make-toggle toggle-save-place-globally save-place
1000                         "Save Place in Files between Sessions"
1001                         "Saving place in files %s"
1002                         "Visit files of previous session when restarting Emacs"
1003                         (require 'saveplace)
1004                         ;; Do it by name, to avoid a free-variable
1005                         ;; warning during byte compilation.
1006                         (set-default
1007                          'save-place (not (symbol-value 'save-place)))))
1008
1009 (define-key menu-bar-options-menu [uniquify]
1010   (menu-bar-make-toggle toggle-uniquify-buffer-names uniquify-buffer-name-style
1011                         "Use Directory Names in Buffer Names"
1012                         "Directory name in buffer names (uniquify) %s"
1013                         "Uniquify buffer names by adding parent directory names"
1014                         (require 'uniquify)
1015                         (setq uniquify-buffer-name-style
1016                               (if (not uniquify-buffer-name-style)
1017                                   'forward))))
1018
1019 (define-key menu-bar-options-menu [edit-options-separator]
1020   '("--"))
1021 (define-key menu-bar-options-menu [cua-mode]
1022   (menu-bar-make-mm-toggle cua-mode
1023                            "C-x/C-c/C-v Cut and Paste (CUA)"
1024                            "Use C-z/C-x/C-c/C-v keys for undo/cut/copy/paste"
1025                            (:visible (or (not (boundp 'cua-enable-cua-keys))
1026                                          cua-enable-cua-keys))))
1027
1028 (define-key menu-bar-options-menu [cua-emulation-mode]
1029   (menu-bar-make-mm-toggle cua-mode
1030                            "Shift movement mark region (CUA)"
1031                            "Use shifted movement keys to set and extend the region."
1032                            (:visible (and (boundp 'cua-enable-cua-keys)
1033                                           (not cua-enable-cua-keys)))))
1034
1035 (define-key menu-bar-options-menu [case-fold-search]
1036   (menu-bar-make-toggle toggle-case-fold-search case-fold-search
1037             "Case-Insensitive Search"
1038             "Case-Insensitive Search %s"
1039             "Ignore letter-case in search commands"))
1040
1041 (defun menu-bar-text-mode-auto-fill ()
1042   (interactive)
1043   (toggle-text-mode-auto-fill)
1044   ;; This is somewhat questionable, as `text-mode-hook'
1045   ;; might have changed outside customize.
1046   ;; -- Per Abrahamsen <abraham@dina.kvl.dk> 2002-02-11.
1047   (customize-mark-as-set 'text-mode-hook))
1048
1049 (define-key menu-bar-options-menu [auto-fill-mode]
1050   '(menu-item "Auto Fill in Text Modes"
1051               menu-bar-text-mode-auto-fill
1052               :help "Automatically fill text while typing (Auto Fill Mode)"
1053               :button (:toggle . (if (listp text-mode-hook)
1054                                      (member 'turn-on-auto-fill text-mode-hook)
1055                                    (eq 'turn-on-auto-fill text-mode-hook)))))
1056
1057
1058 (defvar menu-bar-line-wrapping-menu (make-sparse-keymap "Line Wrapping"))
1059
1060 (define-key menu-bar-line-wrapping-menu [truncate]
1061   '(menu-item "Truncate Long Lines"
1062               toggle-truncate-lines
1063               :help "Truncate long lines at window edge"
1064               :button (:radio . (or truncate-lines
1065                                     (truncated-partial-width-window-p)))
1066               :visible (menu-bar-menu-frame-live-and-visible-p)
1067               :enable (not (truncated-partial-width-window-p))))
1068
1069 (define-key menu-bar-line-wrapping-menu [word-wrap]
1070   '(menu-item "Wrap at Word Boundaries"
1071               (lambda () (interactive) (setq truncate-lines nil
1072                                              word-wrap t))
1073               :help "Wrap long lines at word boundaries"
1074               :button (:radio . (and (null truncate-lines)
1075                                      (not (truncated-partial-width-window-p))
1076                                      word-wrap))
1077               :visible (menu-bar-menu-frame-live-and-visible-p)
1078               :enable (not (truncated-partial-width-window-p))))
1079
1080 (define-key menu-bar-line-wrapping-menu [window-wrap]
1081   '(menu-item "Wrap at Window Edge"
1082               (lambda () (interactive) (setq truncate-lines nil
1083                                              word-wrap nil))
1084               :help "Wrap long lines at window edge"
1085               :button (:radio . (and (null truncate-lines)
1086                                      (not (truncated-partial-width-window-p))
1087                                      (not word-wrap)))
1088               :visible (menu-bar-menu-frame-live-and-visible-p)
1089               :enable (not (truncated-partial-width-window-p))))
1090
1091 (define-key menu-bar-options-menu [line-wrapping]
1092   (list 'menu-item "Line Wrapping in this Buffer" menu-bar-line-wrapping-menu))
1093
1094
1095 (define-key menu-bar-options-menu [highlight-separator]
1096   '("--"))
1097 (define-key menu-bar-options-menu [highlight-paren-mode]
1098   (menu-bar-make-mm-toggle show-paren-mode
1099                            "Paren Match Highlighting"
1100                            "Highlight matching/mismatched parentheses at cursor (Show Paren mode)"))
1101 (define-key menu-bar-options-menu [transient-mark-mode]
1102   (menu-bar-make-mm-toggle transient-mark-mode
1103                            "Active Region Highlighting"
1104                            "Make text in active region stand out in color (Transient Mark mode)"
1105                            (:enable (not cua-mode))))
1106
1107 \f
1108 ;; The "Tools" menu items
1109
1110 (defun send-mail-item-name ()
1111   (let* ((known-send-mail-commands '((sendmail-user-agent . "sendmail")
1112                                      (mh-e-user-agent . "MH")
1113                                      (message-user-agent . "Gnus Message")
1114                                      (gnus-user-agent . "Gnus")))
1115          (name (assq mail-user-agent known-send-mail-commands)))
1116     (if name
1117         (setq name (cdr name))
1118       (setq name (symbol-name mail-user-agent))
1119       (if (string-match "\\(.+\\)-user-agent" name)
1120           (setq name (match-string 1 name))))
1121     name))
1122
1123 (defun read-mail-item-name ()
1124   (let* ((known-rmail-commands '((rmail . "RMAIL")
1125                                  (mh-rmail . "MH")
1126                                  (gnus . "Gnus")))
1127          (known (assq read-mail-command known-rmail-commands)))
1128     (if known (cdr known) (symbol-name read-mail-command))))
1129
1130 (defvar menu-bar-games-menu (make-sparse-keymap "Games"))
1131
1132 (define-key menu-bar-tools-menu [games]
1133   (list 'menu-item "Games" menu-bar-games-menu))
1134
1135 (define-key menu-bar-tools-menu [separator-games]
1136   '("--"))
1137
1138 (define-key menu-bar-games-menu [zone]
1139   '(menu-item "Zone Out"  zone
1140               :help "Play tricks with Emacs display when Emacs is idle"))
1141 (define-key menu-bar-games-menu [tetris]
1142   '(menu-item "Tetris"  tetris
1143               :help "Falling blocks game"))
1144 (define-key menu-bar-games-menu [solitaire]
1145   '(menu-item "Solitaire"  solitaire
1146               :help "Get rid of all the stones"))
1147 (define-key menu-bar-games-menu [snake]
1148   '(menu-item "Snake"  snake
1149               :help "Move snake around avoiding collisions"))
1150 (define-key menu-bar-games-menu [pong]
1151   '(menu-item "Pong" pong
1152               :help "Bounce the ball to your opponent"))
1153 (define-key menu-bar-games-menu [mult]
1154   '(menu-item "Multiplication Puzzle"  mpuz
1155               :help "Exercise brain with multiplication"))
1156 (define-key menu-bar-games-menu [life]
1157   '(menu-item "Life"  life
1158               :help "Watch how John Conway's cellular automaton evolves"))
1159 (define-key menu-bar-games-menu [hanoi]
1160   '(menu-item "Towers of Hanoi" hanoi
1161               :help "Watch Towers-of-Hanoi puzzle solved by Emacs"))
1162 (define-key menu-bar-games-menu [gomoku]
1163   '(menu-item "Gomoku"  gomoku
1164               :help "Mark 5 contiguous squares (like tic-tac-toe)"))
1165 (define-key menu-bar-games-menu [bubbles]
1166   '(menu-item "Bubbles" bubbles
1167               :help "Remove all bubbles using the fewest moves"))
1168 (define-key menu-bar-games-menu [black-box]
1169   '(menu-item "Blackbox"  blackbox
1170               :help "Find balls in a black box by shooting rays"))
1171 (define-key menu-bar-games-menu [adventure]
1172   '(menu-item "Adventure"  dunnet
1173               :help "Dunnet, a text Adventure game for Emacs"))
1174 (define-key menu-bar-games-menu [5x5]
1175   '(menu-item "5x5" 5x5
1176               :help "Fill in all the squares on a 5x5 board"))
1177
1178 (defvar menu-bar-encryption-decryption-menu
1179   (make-sparse-keymap "Encryption/Decryption"))
1180
1181 (define-key menu-bar-tools-menu [encryption-decryption]
1182   (list 'menu-item "Encryption/Decryption" menu-bar-encryption-decryption-menu))
1183
1184 (define-key menu-bar-tools-menu [separator-encryption-decryption]
1185   '("--"))
1186
1187 (define-key menu-bar-encryption-decryption-menu [insert-keys]
1188   '(menu-item "Insert Keys" epa-insert-keys
1189               :help "Insert public keys after the current point"))
1190
1191 (define-key menu-bar-encryption-decryption-menu [export-keys]
1192   '(menu-item "Export Keys" epa-export-keys
1193               :help "Export public keys to a file"))
1194
1195 (define-key menu-bar-encryption-decryption-menu [import-keys-region]
1196   '(menu-item "Import Keys from Region" epa-import-keys-region
1197               :help "Import public keys from the current region"))
1198
1199 (define-key menu-bar-encryption-decryption-menu [import-keys]
1200   '(menu-item "Import Keys from File..." epa-import-keys
1201               :help "Import public keys from a file"))
1202
1203 (define-key menu-bar-encryption-decryption-menu [list-keys]
1204   '(menu-item "List Keys" epa-list-keys
1205               :help "Browse your public keyring"))
1206
1207 (define-key menu-bar-encryption-decryption-menu [separator-keys]
1208   '("--"))
1209
1210 (define-key menu-bar-encryption-decryption-menu [sign-region]
1211   '(menu-item "Sign Region" epa-sign-region
1212               :help "Create digital signature of the current region"))
1213
1214 (define-key menu-bar-encryption-decryption-menu [verify-region]
1215   '(menu-item "Verify Region" epa-verify-region
1216               :help "Verify digital signature of the current region"))
1217
1218 (define-key menu-bar-encryption-decryption-menu [encrypt-region]
1219   '(menu-item "Encrypt Region" epa-encrypt-region
1220               :help "Encrypt the current region"))
1221
1222 (define-key menu-bar-encryption-decryption-menu [decrypt-region]
1223   '(menu-item "Decrypt Region" epa-decrypt-region
1224               :help "Decrypt the current region"))
1225
1226 (define-key menu-bar-encryption-decryption-menu [separator-file]
1227   '("--"))
1228
1229 (define-key menu-bar-encryption-decryption-menu [sign-file]
1230   '(menu-item "Sign File..." epa-sign-file
1231               :help "Create digital signature of a file"))
1232
1233 (define-key menu-bar-encryption-decryption-menu [verify-file]
1234   '(menu-item "Verify File..." epa-verify-file
1235               :help "Verify digital signature of a file"))
1236
1237 (define-key menu-bar-encryption-decryption-menu [encrypt-file]
1238   '(menu-item "Encrypt File..." epa-encrypt-file
1239               :help "Encrypt a file"))
1240
1241 (define-key menu-bar-encryption-decryption-menu [decrypt-file]
1242   '(menu-item "Decrypt File..." epa-decrypt-file
1243               :help "Decrypt a file"))
1244
1245 (define-key menu-bar-tools-menu [simple-calculator]
1246   '(menu-item "Simple Calculator" calculator
1247               :help "Invoke the Emacs built-in quick calculator"))
1248 (define-key menu-bar-tools-menu [calc]
1249   '(menu-item "Programmable Calculator" calc
1250               :help "Invoke the Emacs built-in full scientific calculator"))
1251 (define-key menu-bar-tools-menu [calendar]
1252   '(menu-item "Calendar" calendar
1253               :help "Invoke the Emacs built-in calendar"))
1254
1255 (define-key menu-bar-tools-menu [separator-net]
1256   '("--"))
1257
1258 (define-key menu-bar-tools-menu [directory-search]
1259   '(menu-item "Directory Search" eudc-tools-menu))
1260 (define-key menu-bar-tools-menu [compose-mail]
1261   (list
1262    'menu-item `(format "Send Mail (with %s)" (send-mail-item-name))
1263    'compose-mail
1264    :visible `(and mail-user-agent (not (eq mail-user-agent 'ignore)))
1265    :help "Send a mail message"))
1266 (define-key menu-bar-tools-menu [rmail]
1267   (list
1268    'menu-item `(format "Read Mail (with %s)" (read-mail-item-name))
1269    'menu-bar-read-mail
1270    :visible `(and read-mail-command (not (eq read-mail-command 'ignore)))
1271    :help "Read your mail and reply to it"))
1272
1273 (defun menu-bar-read-mail ()
1274   "Read mail using `read-mail-command'."
1275   (interactive)
1276   (call-interactively read-mail-command))
1277
1278 (define-key menu-bar-tools-menu [gnus]
1279   '(menu-item "Read Net News (Gnus)" gnus
1280               :help "Read network news groups"))
1281
1282 (define-key menu-bar-tools-menu [separator-vc]
1283   '("--"))
1284
1285 (define-key menu-bar-tools-menu [pcl-cvs]
1286   '(menu-item "PCL-CVS" cvs-global-menu))
1287 (define-key menu-bar-tools-menu [vc] nil) ;Create the place for the VC menu.
1288
1289 (define-key menu-bar-tools-menu [separator-compare]
1290   '("--"))
1291
1292 (define-key menu-bar-tools-menu [ediff-misc]
1293   '(menu-item "Ediff Miscellanea" menu-bar-ediff-misc-menu))
1294 (define-key menu-bar-tools-menu [epatch]
1295   '(menu-item "Apply Patch" menu-bar-epatch-menu))
1296 (define-key menu-bar-tools-menu [ediff-merge]
1297   '(menu-item "Merge" menu-bar-ediff-merge-menu))
1298 (define-key menu-bar-tools-menu [compare]
1299   '(menu-item "Compare (Ediff)" menu-bar-ediff-menu))
1300
1301 (define-key menu-bar-tools-menu [separator-spell]
1302   '("--"))
1303
1304 (define-key menu-bar-tools-menu [spell]
1305   '(menu-item "Spell Checking" ispell-menu-map))
1306
1307 (define-key menu-bar-tools-menu [separator-prog]
1308   '("--"))
1309
1310 (define-key menu-bar-tools-menu [gdb]
1311   '(menu-item "Debugger (GDB)..." gdb
1312               :help "Debug a program from within Emacs with GDB"))
1313 (define-key menu-bar-tools-menu [shell-on-region]
1314   '(menu-item "Shell Command on Region..." shell-command-on-region
1315               :enable mark-active
1316               :help "Pass marked region to a shell command"))
1317 (define-key menu-bar-tools-menu [shell]
1318   '(menu-item "Shell Command..." shell-command
1319               :help "Invoke a shell command and catch its output"))
1320 (define-key menu-bar-tools-menu [compile]
1321   '(menu-item "Compile..." compile
1322               :help "Invoke compiler or Make, view compilation errors"))
1323 (define-key menu-bar-tools-menu [grep]
1324   '(menu-item "Search Files (Grep)..." grep
1325               :help "Search files for strings or regexps (with Grep)"))
1326
1327 \f
1328 ;; The "Help" menu items
1329
1330 (defvar menu-bar-describe-menu (make-sparse-keymap "Describe"))
1331
1332 (define-key menu-bar-describe-menu [mule-diag]
1333   '(menu-item "Show All of Mule Status" mule-diag
1334               :visible default-enable-multibyte-characters
1335               :help "Display multilingual environment settings"))
1336 (define-key menu-bar-describe-menu [describe-coding-system-briefly]
1337   '(menu-item "Describe Coding System (Briefly)"
1338               describe-current-coding-system-briefly
1339               :visible default-enable-multibyte-characters))
1340 (define-key menu-bar-describe-menu [describe-coding-system]
1341   '(menu-item "Describe Coding System..." describe-coding-system
1342               :visible default-enable-multibyte-characters))
1343 (define-key menu-bar-describe-menu [describe-input-method]
1344   '(menu-item "Describe Input Method..." describe-input-method
1345               :visible default-enable-multibyte-characters
1346               :help "Keyboard layout for specific input method"))
1347 (define-key menu-bar-describe-menu [describe-language-environment]
1348   (list 'menu-item "Describe Language Environment"
1349         describe-language-environment-map))
1350
1351 (define-key menu-bar-describe-menu [separator-desc-mule]
1352   '("--"))
1353
1354 (define-key menu-bar-describe-menu [list-keybindings]
1355   '(menu-item "List Key Bindings" describe-bindings
1356               :help "Display all current keybindings (keyboard shortcuts)"))
1357 (define-key menu-bar-describe-menu [describe-current-display-table]
1358   '(menu-item "Describe Display Table" describe-current-display-table
1359               :help "Describe the current display table"))
1360 (define-key menu-bar-describe-menu [describe-face]
1361   '(menu-item "Describe Face..." describe-face
1362               :help "Display the properties of a face"))
1363 (define-key menu-bar-describe-menu [describe-variable]
1364   '(menu-item "Describe Variable..." describe-variable
1365               :help "Display documentation of variable/option"))
1366 (define-key menu-bar-describe-menu [describe-function]
1367   '(menu-item "Describe Function..." describe-function
1368               :help "Display documentation of function/command"))
1369 (define-key menu-bar-describe-menu [describe-key-1]
1370   '(menu-item "Describe Key or Mouse Operation..." describe-key
1371               ;; Users typically don't identify keys and menu items...
1372               :help "Display documentation of command bound to a \
1373 key, a click, or a menu-item"))
1374 (define-key menu-bar-describe-menu [describe-mode]
1375   '(menu-item "Describe Buffer Modes" describe-mode
1376               :help "Describe this buffer's major and minor mode"))
1377
1378 (defvar menu-bar-search-documentation-menu
1379   (make-sparse-keymap "Search Documentation"))
1380 (defun menu-bar-read-lispref ()
1381   "Display the Emacs Lisp Reference manual in Info mode."
1382   (interactive)
1383   (info "elisp"))
1384
1385 (defun menu-bar-read-lispintro ()
1386   "Display the Introduction to Emacs Lisp Programming in Info mode."
1387   (interactive)
1388   (info "eintr"))
1389
1390 (defun search-emacs-glossary ()
1391   "Display the Glossary node of the Emacs manual in Info mode."
1392   (interactive)
1393   (info "(emacs)Glossary"))
1394
1395 (defun emacs-index-search (topic)
1396   "Look up TOPIC in the indices of the Emacs User Manual."
1397   (interactive "sSubject to look up: ")
1398   (info "emacs")
1399   (Info-index topic))
1400
1401 (defun elisp-index-search (topic)
1402   "Look up TOPIC in the indices of the Emacs Lisp Reference Manual."
1403   (interactive "sSubject to look up: ")
1404   (info "elisp")
1405   (Info-index topic))
1406
1407 (define-key menu-bar-search-documentation-menu [search-documentation-strings]
1408   '(menu-item "Search Documentation Strings..." apropos-documentation
1409               :help
1410               "Find functions and variables whose doc strings match a regexp"))
1411 (define-key menu-bar-search-documentation-menu [find-any-object-by-name]
1412   '(menu-item "Find Any Object by Name..."  apropos
1413               :help "Find symbols of any kind whose names match a regexp"))
1414 (define-key menu-bar-search-documentation-menu [find-option-by-value]
1415   '(menu-item "Find Options by Value..." apropos-value
1416               :help "Find variables whose values match a regexp"))
1417 (define-key menu-bar-search-documentation-menu [find-options-by-name]
1418   '(menu-item "Find Options by Name..." apropos-variable
1419               :help "Find variables whose names match a regexp"))
1420 (define-key menu-bar-search-documentation-menu [find-commands-by-name]
1421   '(menu-item "Find Commands by Name..." apropos-command
1422               :help "Find commands whose names match a regexp"))
1423 (define-key menu-bar-search-documentation-menu [sep1]
1424   '("--"))
1425 (define-key menu-bar-search-documentation-menu [lookup-command-in-manual]
1426   '(menu-item "Look Up Command in User Manual..." Info-goto-emacs-command-node
1427               :help "Display manual section that describes a command"))
1428 (define-key menu-bar-search-documentation-menu [lookup-key-in-manual]
1429   '(menu-item "Look Up Key in User Manual..." Info-goto-emacs-key-command-node
1430               :help "Display manual section that describes a key"))
1431 (define-key menu-bar-search-documentation-menu [lookup-subject-in-elisp-manual]
1432   '(menu-item "Look Up Subject in ELisp Manual..." elisp-index-search
1433               :help "Find description of a subject in Emacs Lisp manual"))
1434 (define-key menu-bar-search-documentation-menu [lookup-subject-in-emacs-manual]
1435   '(menu-item "Look Up Subject in User Manual..." emacs-index-search
1436               :help "Find description of a subject in Emacs User manual"))
1437 (define-key menu-bar-search-documentation-menu [emacs-terminology]
1438   '(menu-item "Emacs Terminology" search-emacs-glossary
1439               :help "Display the Glossary section of the Emacs manual"))
1440
1441 (defvar menu-bar-manuals-menu (make-sparse-keymap "More Manuals"))
1442
1443 (define-key menu-bar-manuals-menu [man]
1444   '(menu-item "Read Man Page..." manual-entry
1445               :help "Man-page docs for external commands and libraries"))
1446 (define-key menu-bar-manuals-menu [sep2]
1447   '("--"))
1448 (define-key menu-bar-manuals-menu [order-emacs-manuals]
1449   '(menu-item "Ordering Manuals" view-order-manuals
1450               :help "How to order manuals from the Free Software Foundation"))
1451 (define-key menu-bar-manuals-menu [lookup-subject-in-all-manuals]
1452   '(menu-item "Lookup Subject in all manuals..." info-apropos
1453               :help "Find description of a subject in all installed manuals"))
1454 (define-key menu-bar-manuals-menu [other-manuals]
1455   '(menu-item "All Other Manuals (Info)" Info-directory
1456               :help "Read any of the installed manuals"))
1457 (define-key menu-bar-manuals-menu [emacs-lisp-reference]
1458   '(menu-item "Emacs Lisp Reference" menu-bar-read-lispref
1459               :help "Read the Emacs Lisp Reference manual"))
1460 (define-key menu-bar-manuals-menu [emac-lisp-intro]
1461   '(menu-item "Introduction to Emacs Lisp" menu-bar-read-lispintro
1462               :help "Read the Introduction to Emacs Lisp Programming"))
1463
1464 (define-key menu-bar-help-menu [about-gnu-project]
1465   '(menu-item "About GNU" describe-gnu-project
1466               :help "About the GNU System, GNU Project, and GNU/Linux"))
1467 (define-key menu-bar-help-menu [about-emacs]
1468   '(menu-item "About Emacs" about-emacs
1469               :help "Display version number, copyright info, and basic help"))
1470 (define-key menu-bar-help-menu [sep4]
1471   '("--"))
1472 (define-key menu-bar-help-menu [describe-no-warranty]
1473   '(menu-item "(Non)Warranty" describe-no-warranty
1474               :help "Explain that Emacs has NO WARRANTY"))
1475 (define-key menu-bar-help-menu [describe-copying]
1476   '(menu-item "Copying Conditions" describe-copying
1477               :help "Show the Emacs license (GPL)"))
1478 (define-key menu-bar-help-menu [getting-new-versions]
1479   '(menu-item "Getting New Versions" describe-distribution
1480               :help "How to get latest versions of Emacs"))
1481 (defun menu-bar-help-extra-packages ()
1482   "Display help about some additional packages available for Emacs."
1483   (interactive)
1484   (let (enable-local-variables)
1485     (view-file (expand-file-name "MORE.STUFF"
1486                                  data-directory))
1487     (goto-address)))
1488 (define-key menu-bar-help-menu [sep2]
1489   '("--"))
1490 (define-key menu-bar-help-menu [external-packages]
1491   '(menu-item "External Packages" menu-bar-help-extra-packages
1492               :help "Lisp packages distributed separately for use in Emacs"))
1493 (define-key menu-bar-help-menu [find-emacs-packages]
1494   '(menu-item "Find Emacs Packages" finder-by-keyword
1495               :help "Find packages and features by keyword"))
1496 (define-key menu-bar-help-menu [more-manuals]
1497   (list 'menu-item "More Manuals" menu-bar-manuals-menu))
1498 (define-key menu-bar-help-menu [emacs-manual]
1499   '(menu-item "Read the Emacs Manual" info-emacs-manual
1500               :help "Full documentation of Emacs features"))
1501 (define-key menu-bar-help-menu [describe]
1502   (list 'menu-item "Describe" menu-bar-describe-menu))
1503 (define-key menu-bar-help-menu [search-documentation]
1504   (list 'menu-item "Search Documentation" menu-bar-search-documentation-menu))
1505 (define-key menu-bar-help-menu [sep1]
1506   '("--"))
1507 (define-key menu-bar-help-menu [emacs-psychotherapist]
1508   '(menu-item "Emacs Psychotherapist" doctor
1509               :help "Our doctor will help you feel better"))
1510 (define-key menu-bar-help-menu [send-emacs-bug-report]
1511   '(menu-item "Send Bug Report..." report-emacs-bug
1512               :help "Send e-mail to Emacs maintainers"))
1513 (define-key menu-bar-help-menu [emacs-known-problems]
1514   '(menu-item "Emacs Known Problems" view-emacs-problems
1515               :help "Read about known problems with Emacs"))
1516 (define-key menu-bar-help-menu [emacs-news]
1517   '(menu-item "Emacs News" view-emacs-news
1518               :help "New features of this version"))
1519 (define-key menu-bar-help-menu [emacs-faq]
1520   '(menu-item "Emacs FAQ" view-emacs-FAQ
1521               :help "Frequently asked (and answered) questions about Emacs"))
1522
1523 (defun help-with-tutorial-spec-language ()
1524   "Use the Emacs tutorial, specifying which language you want."
1525   (interactive)
1526   (help-with-tutorial t))
1527
1528 (define-key menu-bar-help-menu [emacs-tutorial-language-specific]
1529   '(menu-item "Emacs Tutorial (choose language)..."
1530               help-with-tutorial-spec-language
1531               :help "Learn how to use Emacs (choose a language)"))
1532 (define-key menu-bar-help-menu [emacs-tutorial]
1533   '(menu-item "Emacs Tutorial" help-with-tutorial
1534               :help "Learn how to use Emacs"))
1535
1536 (defun menu-bar-menu-frame-live-and-visible-p ()
1537   "Return non-nil if the menu frame is alive and visible.
1538 The menu frame is the frame for which we are updating the menu."
1539   (let ((menu-frame (or menu-updating-frame (selected-frame))))
1540     (and (frame-live-p menu-frame)
1541          (frame-visible-p menu-frame))))
1542
1543 (defun menu-bar-non-minibuffer-window-p ()
1544   "Return non-nil if selected window of the menu frame is not a minibuf window.
1545
1546 See the documentation of `menu-bar-menu-frame-live-and-visible-p'
1547 for the definition of the menu frame."
1548   (let ((menu-frame (or menu-updating-frame (selected-frame))))
1549     (not (window-minibuffer-p (frame-selected-window menu-frame)))))
1550
1551 (defun kill-this-buffer ()      ; for the menu bar
1552   "Kill the current buffer.
1553 When called in the minibuffer, get out of the minibuffer
1554 using `abort-recursive-edit'."
1555   (interactive)
1556   (if (menu-bar-non-minibuffer-window-p)
1557       (kill-buffer (current-buffer))
1558     (abort-recursive-edit)))
1559
1560 (defun kill-this-buffer-enabled-p ()
1561   (let ((count 0)
1562         (buffers (buffer-list)))
1563     (while buffers
1564       (or (string-match "^ " (buffer-name (car buffers)))
1565           (setq count (1+ count)))
1566       (setq buffers (cdr buffers)))
1567     (or (not (menu-bar-non-minibuffer-window-p))
1568         (> count 1))))
1569
1570 (put 'dired 'menu-enable '(menu-bar-non-minibuffer-window-p))
1571
1572 ;; Permit deleting frame if it would leave a visible or iconified frame.
1573 (defun delete-frame-enabled-p ()
1574   "Return non-nil if `delete-frame' should be enabled in the menu bar."
1575   (let ((frames (frame-list))
1576         (count 0))
1577     (while frames
1578       (if (frame-visible-p (car frames))
1579           (setq count (1+ count)))
1580       (setq frames (cdr frames)))
1581     (> count 1)))
1582
1583 (defcustom yank-menu-length 20
1584   "*Maximum length to display in the yank-menu."
1585   :type 'integer
1586   :group 'menu)
1587
1588 (defun menu-bar-update-yank-menu (string old)
1589   (let ((front (car (cdr yank-menu)))
1590         (menu-string (if (<= (length string) yank-menu-length)
1591                          string
1592                        (concat
1593                         (substring string 0 (/ yank-menu-length 2))
1594                         "..."
1595                         (substring string (- (/ yank-menu-length 2)))))))
1596     ;; Don't let the menu string be all dashes
1597     ;; because that has a special meaning in a menu.
1598     (if (string-match "\\`-+\\'" menu-string)
1599         (setq menu-string (concat menu-string " ")))
1600     ;; If we're supposed to be extending an existing string, and that
1601     ;; string really is at the front of the menu, then update it in place.
1602     (if (and old (or (eq old (car front))
1603                      (string= old (car front))))
1604         (progn
1605           (setcar front string)
1606           (setcar (cdr front) menu-string))
1607       (setcdr yank-menu
1608               (cons
1609                (cons string (cons menu-string 'menu-bar-select-yank))
1610                (cdr yank-menu)))))
1611   (if (> (length (cdr yank-menu)) kill-ring-max)
1612       (setcdr (nthcdr kill-ring-max yank-menu) nil)))
1613
1614 (put 'menu-bar-select-yank 'apropos-inhibit t)
1615 (defun menu-bar-select-yank ()
1616   "Insert the stretch of previously-killed text selected from menu.
1617 The menu shows all the killed text sequences stored in `kill-ring'."
1618   (interactive "*")
1619   (push-mark (point))
1620   (insert last-command-event))
1621
1622 \f
1623 ;;; Buffers Menu
1624
1625 (defcustom buffers-menu-max-size 10
1626   "*Maximum number of entries which may appear on the Buffers menu.
1627 If this is 10, then only the ten most-recently-selected buffers are shown.
1628 If this is nil, then all buffers are shown.
1629 A large number or nil slows down menu responsiveness."
1630   :type '(choice integer
1631                  (const :tag "All" nil))
1632   :group 'menu)
1633
1634 (defcustom buffers-menu-buffer-name-length 30
1635   "*Maximum length of the buffer name on the Buffers menu.
1636 If this is a number, then buffer names are truncated to this length.
1637 If this is nil, then buffer names are shown in full.
1638 A large number or nil makes the menu too wide."
1639   :type '(choice integer
1640                  (const :tag "Full length" nil))
1641   :group 'menu)
1642
1643 (defcustom buffers-menu-show-directories 'unless-uniquify
1644   "If non-nil, show directories in the Buffers menu for buffers that have them.
1645 The special value `unless-uniquify' means that directories will be shown
1646 unless `uniquify-buffer-name-style' is non-nil (in which case, buffer
1647 names should include enough of a buffer's directory to distinguish it
1648 from other buffers).
1649
1650 Setting this variable directly does not take effect until next time the
1651 Buffers menu is regenerated."
1652   :set (lambda (symbol value)
1653          (set symbol value)
1654          (menu-bar-update-buffers t))
1655   :initialize 'custom-initialize-default
1656   :type '(choice (const :tag "Never" nil)
1657                  (const :tag "Unless uniquify is enabled" unless-uniquify)
1658                  (const :tag "Always" t))
1659   :group 'menu)
1660
1661 (defcustom buffers-menu-show-status t
1662   "If non-nil, show modified/read-only status of buffers in the Buffers menu.
1663 Setting this variable directly does not take effect until next time the
1664 Buffers menu is regenerated."
1665   :set (lambda (symbol value)
1666          (set symbol value)
1667          (menu-bar-update-buffers t))
1668   :initialize 'custom-initialize-default
1669   :type 'boolean
1670   :group 'menu)
1671
1672 (defvar list-buffers-directory nil)
1673
1674 (defun menu-bar-select-buffer ()
1675   (interactive)
1676   (switch-to-buffer last-command-event))
1677
1678 (defun menu-bar-select-frame (frame)
1679   (make-frame-visible frame)
1680   (raise-frame frame)
1681   (select-frame frame))
1682
1683 (defun menu-bar-update-buffers-1 (elt)
1684   (let* ((buf (car elt))
1685          (file
1686           (and (if (eq buffers-menu-show-directories 'unless-uniquify)
1687                    (or (not (boundp 'uniquify-buffer-name-style))
1688                        (null uniquify-buffer-name-style))
1689                  buffers-menu-show-directories)
1690                (or (buffer-file-name buf)
1691                    (buffer-local-value 'list-buffers-directory buf)))))
1692     (when file
1693       (setq file (file-name-directory file)))
1694     (when (and file (> (length file) 20))
1695       (setq file (concat "..." (substring file -17))))
1696     (cons (if buffers-menu-show-status
1697               (let ((mod (if (buffer-modified-p buf) "*" ""))
1698                     (ro (if (buffer-local-value 'buffer-read-only buf) "%" "")))
1699                 (if file
1700                     (format "%s  %s%s  --  %s" (cdr elt) mod ro file)
1701                   (format "%s  %s%s" (cdr elt) mod ro)))
1702             (if file
1703                 (format "%s  --  %s"  (cdr elt) file)
1704               (cdr elt)))
1705           buf)))
1706
1707 ;; Used to cache the menu entries for commands in the Buffers menu
1708 (defvar menu-bar-buffers-menu-command-entries nil)
1709
1710 (defun menu-bar-update-buffers (&optional force)
1711   ;; If user discards the Buffers item, play along.
1712   (and (lookup-key (current-global-map) [menu-bar buffer])
1713        (or force (frame-or-buffer-changed-p))
1714        (let ((buffers (buffer-list))
1715              (frames (frame-list))
1716              buffers-menu)
1717          ;; If requested, list only the N most recently selected buffers.
1718          (if (and (integerp buffers-menu-max-size)
1719                   (> buffers-menu-max-size 1))
1720              (if (> (length buffers) buffers-menu-max-size)
1721                  (setcdr (nthcdr buffers-menu-max-size buffers) nil)))
1722
1723          ;; Make the menu of buffers proper.
1724          (setq buffers-menu
1725                (let (alist)
1726                  ;; Put into each element of buffer-list
1727                  ;; the name for actual display,
1728                  ;; perhaps truncated in the middle.
1729                  (dolist (buf buffers)
1730                    (let ((name (buffer-name buf)))
1731                      (unless (eq ?\s (aref name 0))
1732                        (push (menu-bar-update-buffers-1
1733                               (cons buf
1734                                     (if (and (integerp buffers-menu-buffer-name-length)
1735                                              (> (length name) buffers-menu-buffer-name-length))
1736                                         (concat
1737                                          (substring
1738                                           name 0 (/ buffers-menu-buffer-name-length 2))
1739                                          "..."
1740                                          (substring
1741                                           name (- (/ buffers-menu-buffer-name-length 2))))
1742                                       name)
1743                                     ))
1744                              alist))))
1745                  ;; Now make the actual list of items.
1746                  (let ((buffers-vec (make-vector (length alist) nil))
1747                        (i (length alist)))
1748                    (dolist (pair alist)
1749                      (setq i (1- i))
1750                      (aset buffers-vec i
1751                            (nconc (list (car pair)
1752                                         (cons nil nil))
1753                                   `(lambda ()
1754                                      (interactive)
1755                                      (switch-to-buffer ,(cdr pair))))))
1756                    (list buffers-vec))))
1757
1758          ;; Make a Frames menu if we have more than one frame.
1759          (when (cdr frames)
1760            (let* ((frames-vec (make-vector (length frames) nil))
1761                   (frames-menu
1762                    (cons 'keymap
1763                          (list "Select Frame" frames-vec)))
1764                   (i 0))
1765              (dolist (frame frames)
1766                (aset frames-vec i
1767                      (nconc
1768                       (list
1769                        (frame-parameter frame 'name)
1770                        (cons nil nil))
1771                       `(lambda ()
1772                          (interactive) (menu-bar-select-frame ,frame))))
1773                (setq i (1+ i)))
1774              ;; Put it after the normal buffers
1775              (setq buffers-menu
1776                    (nconc buffers-menu
1777                           `((frames-separator "--")
1778                             (frames menu-item "Frames" ,frames-menu))))))
1779
1780          ;; Add in some normal commands at the end of the menu.  We use
1781          ;; the copy cached in `menu-bar-buffers-menu-command-entries'
1782          ;; if it's been set already.  Note that we can't use constant
1783          ;; lists for the menu-entries, because the low-level menu-code
1784          ;; modifies them.
1785          (unless menu-bar-buffers-menu-command-entries
1786            (setq menu-bar-buffers-menu-command-entries
1787                  (list '(command-separator "--")
1788                        (list 'next-buffer
1789                              'menu-item
1790                              "Next Buffer"
1791                              'next-buffer
1792                              :help "Switch to the \"next\" buffer in a cyclic order")
1793                        (list 'previous-buffer
1794                              'menu-item
1795                              "Previous Buffer"
1796                              'previous-buffer
1797                              :help "Switch to the \"previous\" buffer in a cyclic order")
1798                        (list 'select-named-buffer
1799                              'menu-item
1800                              "Select Named Buffer..."
1801                              'switch-to-buffer
1802                              :help "Prompt for a buffer name, and select that buffer in the current window")
1803                        (list 'list-all-buffers
1804                              'menu-item
1805                              "List All Buffers"
1806                              'list-buffers
1807                              :help "Pop up a window listing all Emacs buffers"
1808                              ))))
1809          (setq buffers-menu
1810                (nconc buffers-menu menu-bar-buffers-menu-command-entries))
1811
1812          ;; We used to "(define-key (current-global-map) [menu-bar buffer]"
1813          ;; but that did not do the right thing when the [menu-bar buffer]
1814          ;; entry above had been moved (e.g. to a parent keymap).
1815          (setcdr global-buffers-menu-map (cons "Select Buffer" buffers-menu)))))
1816
1817 (add-hook 'menu-bar-update-hook 'menu-bar-update-buffers)
1818
1819 (menu-bar-update-buffers)
1820
1821 ;; this version is too slow
1822 ;;(defun format-buffers-menu-line (buffer)
1823 ;;  "Returns a string to represent the given buffer in the Buffer menu.
1824 ;;nil means the buffer shouldn't be listed.  You can redefine this."
1825 ;;  (if (string-match "\\` " (buffer-name buffer))
1826 ;;      nil
1827 ;;    (save-excursion
1828 ;;     (set-buffer buffer)
1829 ;;     (let ((size (buffer-size)))
1830 ;;       (format "%s%s %-19s %6s %-15s %s"
1831 ;;             (if (buffer-modified-p) "*" " ")
1832 ;;             (if buffer-read-only "%" " ")
1833 ;;             (buffer-name)
1834 ;;             size
1835 ;;             mode-name
1836 ;;             (or (buffer-file-name) ""))))))
1837 \f
1838 ;;; Set up a menu bar menu for the minibuffer.
1839
1840 (dolist (map (list minibuffer-local-map
1841                    ;; This shouldn't be necessary, but there's a funny
1842                    ;; bug in keymap.c that I don't understand yet.  -stef
1843                    minibuffer-local-completion-map))
1844   (define-key map [menu-bar minibuf]
1845     (cons "Minibuf" (make-sparse-keymap "Minibuf"))))
1846
1847 (let ((map minibuffer-local-completion-map))
1848   (define-key map [menu-bar minibuf ?\?]
1849     (list 'menu-item "List Completions" 'minibuffer-completion-help
1850           :help "Display all possible completions"))
1851   (define-key map [menu-bar minibuf space]
1852     (list 'menu-item "Complete Word" 'minibuffer-complete-word
1853           :help "Complete at most one word"))
1854   (define-key map [menu-bar minibuf tab]
1855     (list 'menu-item "Complete" 'minibuffer-complete
1856           :help "Complete as far as possible")))
1857
1858 (let ((map minibuffer-local-map))
1859   (define-key map [menu-bar minibuf quit]
1860     (list 'menu-item "Quit" 'abort-recursive-edit
1861           :help "Abort input and exit minibuffer"))
1862   (define-key map [menu-bar minibuf return]
1863     (list 'menu-item "Enter" 'exit-minibuffer
1864           :key-sequence "\r"
1865           :help "Terminate input and exit minibuffer"))
1866   (define-key map [menu-bar minibuf isearch-forward]
1867     (list 'menu-item "Isearch History Forward" 'isearch-forward
1868           :help "Incrementally search minibuffer history forward"))
1869   (define-key map [menu-bar minibuf isearch-backward]
1870     (list 'menu-item "Isearch History Backward" 'isearch-backward
1871           :help "Incrementally search minibuffer history backward"))
1872   (define-key map [menu-bar minibuf next]
1873     (list 'menu-item "Next History Item" 'next-history-element
1874           :help "Put next minibuffer history element in the minibuffer"))
1875   (define-key map [menu-bar minibuf previous]
1876     (list 'menu-item "Previous History Item" 'previous-history-element
1877           :help "Put previous minibuffer history element in the minibuffer")))
1878 \f
1879 ;;;###autoload
1880 ;; This comment is taken from tool-bar.el near
1881 ;; (put 'tool-bar-mode ...)
1882 ;; We want to pretend the menu bar by standard is on, as this will make
1883 ;; customize consider disabling the menu bar a customization, and save
1884 ;; that.  We could do this for real by setting :init-value below, but
1885 ;; that would overwrite disabling the tool bar from X resources.
1886 (put 'menu-bar-mode 'standard-value '(t))
1887
1888 (define-minor-mode menu-bar-mode
1889   "Toggle display of a menu bar on each frame.
1890 This command applies to all frames that exist and frames to be
1891 created in the future.
1892 With a numeric argument, if the argument is positive,
1893 turn on menu bars; otherwise, turn off menu bars."
1894   :init-value nil
1895   :global t
1896   :group 'frames
1897
1898   ;; Make menu-bar-mode and default-frame-alist consistent.
1899   (modify-all-frames-parameters (list (cons 'menu-bar-lines
1900                                             (if menu-bar-mode 1 0))))
1901
1902   ;; Make the message appear when Emacs is idle.  We can not call message
1903   ;; directly.  The minor-mode message "Menu-bar mode disabled" comes
1904   ;; after this function returns, overwriting any message we do here.
1905   (when (and (interactive-p) (not menu-bar-mode))
1906     (run-with-idle-timer 0 nil 'message
1907                          "Menu-bar mode disabled.  Use M-x menu-bar-mode to make the menu bar appear."))
1908   menu-bar-mode)
1909
1910 (defun toggle-menu-bar-mode-from-frame (&optional arg)
1911   "Toggle menu bar on or off, based on the status of the current frame.
1912 See `menu-bar-mode' for more information."
1913   (interactive (list (or current-prefix-arg 'toggle)))
1914   (if (eq arg 'toggle)
1915       (menu-bar-mode (if (> (frame-parameter nil 'menu-bar-lines) 0) 0 1))
1916     (menu-bar-mode arg)))
1917
1918 (declare-function x-menu-bar-open "term/x-win" (&optional frame))
1919 (declare-function w32-menu-bar-open "term/w32-win" (&optional frame))
1920
1921 (defun menu-bar-open (&optional frame)
1922   "Start key navigation of the menu bar in FRAME.
1923
1924 This function decides which method to use to access the menu
1925 depending on FRAME's terminal device.  On X displays, it calls
1926 `x-menu-bar-open'; on Windows, `w32-menu-bar-open' otherwise it
1927 calls `tmm-menubar'.
1928
1929 If FRAME is nil or not given, use the selected frame."
1930   (interactive)
1931   (let ((type (framep (or frame (selected-frame)))))
1932     (cond
1933      ((eq type 'x) (x-menu-bar-open frame))
1934      ((eq type 'w32) (w32-menu-bar-open frame))
1935      (t (with-selected-frame (or frame (selected-frame))
1936           (tmm-menubar))))))
1937
1938 (global-set-key [f10] 'menu-bar-open)
1939
1940 (provide 'menu-bar)
1941
1942 ;; arch-tag: 6e6a3c22-4ec4-4d3d-8190-583f8ef94ced
1943 ;;; menu-bar.el ends here