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