lisp/menu-bar.el

   1 ;;; menu-bar.el --- define a default menu bar.
   2
   3 ;; Author: RMS
   4 ;; Keywords: internal
   5
   6 ;; Copyright (C) 1993 Free Software Foundation, Inc.
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to
  22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  23
  24 ;;; Code:
  25
  26 ;; Don't clobber an existing menu-bar keymap, to preserve any menu-bar key
  27 ;; definitions made in loaddefs.el.
  28 (or (lookup-key global-map [menu-bar])
  29     (define-key global-map [menu-bar] (make-sparse-keymap "menu-bar")))
  30 (defvar menu-bar-help-menu (make-sparse-keymap "Help"))
  31 ;; Put Help item last.
  32 (setq menu-bar-final-items '(help))
  33 (define-key global-map [menu-bar help] (cons "Help" menu-bar-help-menu))
  34 (defvar menu-bar-edit-menu (make-sparse-keymap "Edit"))
  35 (define-key global-map [menu-bar edit] (cons "Edit" menu-bar-edit-menu))
  36 (defvar menu-bar-file-menu (make-sparse-keymap "File"))
  37 (define-key global-map [menu-bar file] (cons "File" menu-bar-file-menu))
  38
  39 (define-key menu-bar-file-menu [exit-emacs]
  40   '("Exit Emacs" . save-buffers-kill-emacs))
  41 (define-key menu-bar-file-menu [kill-buffer]
  42   '("Kill Buffer" . kill-this-buffer))
  43 (define-key menu-bar-file-menu [delete-frame] '("Delete Frame" . delete-frame))
  44 (define-key menu-bar-file-menu [bookmark]
  45   '("Bookmarks..." . menu-bar-bookmark-map))
  46 (define-key menu-bar-file-menu [print-buffer] '("Print Buffer" . print-buffer))
  47 (define-key menu-bar-file-menu [revert-buffer]
  48   '("Revert Buffer" . revert-buffer))
  49 (define-key menu-bar-file-menu [write-file]
  50   '("Save Buffer As..." . write-file))
  51 (define-key menu-bar-file-menu [save-buffer] '("Save Buffer" . save-buffer))
  52 (define-key menu-bar-file-menu [dired] '("Open Directory..." . dired))
  53 (define-key menu-bar-file-menu [open-file] '("Open File..." . find-file))
  54 (define-key menu-bar-file-menu [new-frame] '("New Frame" . new-frame))
  55
  56 (define-key menu-bar-edit-menu [spell] '("Spell..." . ispell-menu-map))
  57 (define-key menu-bar-edit-menu [fill] '("Fill" . fill-region))
  58 (define-key menu-bar-edit-menu [clear] '("Clear" . delete-region))
  59 (define-key menu-bar-edit-menu [query-replace]
  60   '("Query Replace" . query-replace))
  61 (define-key menu-bar-edit-menu [re-search-back]
  62   '("Regexp Search Backwards" . re-search-backward))
  63 (define-key menu-bar-edit-menu [search-back]
  64   '("Search Backwards" . search-backward))
  65 (define-key menu-bar-edit-menu [re-search-fwd]
  66   '("Regexp Search" . re-search-forward))
  67 (define-key menu-bar-edit-menu [search-fwd]
  68   '("Search" . search-forward))
  69 (define-key menu-bar-edit-menu [choose-next-paste]
  70   '("Choose Next Paste" . mouse-menu-choose-yank))
  71 (define-key menu-bar-edit-menu [paste] '("Paste" . yank))
  72 (define-key menu-bar-edit-menu [copy] '("Copy" . kill-ring-save))
  73 (define-key menu-bar-edit-menu [cut] '("Cut" . kill-region))
  74 (define-key menu-bar-edit-menu [undo] '("Undo" . undo))
  75
  76 (put 'fill-region 'menu-enable 'mark-active)
  77 (put 'kill-region 'menu-enable 'mark-active)
  78 (put 'kill-ring-save 'menu-enable 'mark-active)
  79 (put 'yank 'menu-enable '(x-selection-exists-p))
  80 (put 'delete-region 'menu-enable 'mark-active)
  81 (put 'undo 'menu-enable '(if (eq last-command 'undo)
  82                              pending-undo-list
  83                            (consp buffer-undo-list)))
  84 (put 'query-replace 'menu-enable (not buffer-read-only))
  85
  86 (autoload 'ispell-menu-map "ispell" nil t 'keymap)
  87
  88 (define-key menu-bar-help-menu [emacs-tutorial]
  89   '("Emacs Tutorial" . help-with-tutorial))
  90 (define-key menu-bar-help-menu [man] '("Man..." . manual-entry))
  91 (define-key menu-bar-help-menu [describe-variable]
  92   '("Describe Variable..." . describe-variable))
  93 (define-key menu-bar-help-menu [describe-function]
  94   '("Describe Function..." . describe-function))
  95 (define-key menu-bar-help-menu [describe-key]
  96   '("Describe Key..." . describe-key))
  97 (define-key menu-bar-help-menu [list-keybindings]
  98   '("List Keybindings" . describe-bindings))
  99 (define-key menu-bar-help-menu [command-apropos]
 100   '("Command Apropos..." . command-apropos))
 101 (define-key menu-bar-help-menu [describe-mode]
 102   '("Describe Mode" . describe-mode))
 103 (define-key menu-bar-help-menu [info] '("Info" . info))
 104
 105 (define-key menu-bar-help-menu [emacs-news] '("Emacs News" . view-emacs-news))
 106 (defun kill-this-buffer ()      ; for the menubar
 107   "Kills the current buffer."
 108   (interactive)
 109   (kill-buffer (current-buffer)))
 110
 111 (defun kill-this-buffer-enabled-p ()
 112   (let ((count 0)
 113         (buffers (buffer-list)))
 114     (while buffers
 115       (or (string-match "^ " (buffer-name (car buffers)))
 116           (setq count (1+ count)))
 117       (setq buffers (cdr buffers)))
 118     (> count 1)))
 119
 120 (put 'save-buffer 'menu-enable '(buffer-modified-p))
 121 (put 'revert-buffer 'menu-enable
 122      '(or revert-buffer-function revert-buffer-insert-file-contents-function
 123           (and (buffer-file-name)
 124                (or (buffer-modified-p)
 125                    (not (verify-visited-file-modtime (current-buffer)))))))
 126 ;; Permit deleting frame if it would leave a visible or iconified frame.
 127 (put 'delete-frame 'menu-enable
 128      '(let ((frames (frame-list))
 129             (count 0))
 130         (while frames
 131           (if (cdr (assq 'visibility (frame-parameters (car frames))))
 132               (setq count (1+ count)))
 133           (setq frames (cdr frames)))
 134         (> count 1)))
 135 (put 'kill-this-buffer 'menu-enable '(kill-this-buffer-enabled-p))
 136
 137 (put 'advertised-undo 'menu-enable
 138      '(and (not (eq t buffer-undo-list))
 139            (if (eq last-command 'undo)
 140                (and (boundp 'pending-undo-list)
 141                     pending-undo-list)
 142              buffer-undo-list)))
 143
 144 (defvar yank-menu-length 100
 145   "*Maximum length of an item in the menu for \
 146 \\[mouse-menu-choose-yank].")
 147
 148 (defun mouse-menu-choose-yank (event)
 149   "Pop up a menu of the kill-ring for selection with the mouse.
 150 The kill-ring-yank-pointer is moved to the selected element.
 151 A subsequent \\[yank] yanks the choice just selected."
 152   (interactive "e")
 153   (let* ((count 0)
 154          (menu (mapcar (lambda (string)
 155                          (if (> (length string) yank-menu-length)
 156                              (setq string (substring string
 157                                                      0 yank-menu-length)))
 158                          (prog1 (cons string count)
 159                            (setq count (1+ count))))
 160                        kill-ring))
 161          (arg (x-popup-menu event
 162                             (list "Yank Menu"
 163                                   (cons "Choose Next Yank" menu)))))
 164     ;; A mouse click outside the menu returns nil.
 165     ;; Avoid a confusing error from passing nil to rotate-yank-pointer.
 166     ;; XXX should this perhaps do something other than simply return? -rm
 167     (if arg
 168         (progn
 169           (rotate-yank-pointer arg)
 170           (if (interactive-p)
 171               (message "The next yank will insert the selected text.")
 172             (current-kill 0))))))
 173 (put 'mouse-menu-choose-yank 'menu-enable 'kill-ring)
 174 \f
 175 (define-key global-map [menu-bar buffer] '("Buffers" . mouse-menu-bar-buffers))
 176
 177 (defvar complex-buffers-menu-p nil
 178   "*Non-nil says, offer a choice of actions after you pick a buffer.
 179 This applies to the Buffers menu from the menu bar.")
 180
 181 (defvar buffers-menu-max-size 10
 182   "*Maximum number of entries which may appear on the Buffers menu.
 183 If this is 10, then only the ten most-recently-selected buffers are shown.
 184 If this is nil, then all buffers are shown.
 185 A large number or nil slows down menu responsiveness.")
 186
 187 (defvar list-buffers-directory nil)
 188
 189 (defun mouse-menu-bar-buffers (event)
 190   "Pop up a menu of buffers for selection with the mouse.
 191 This switches buffers in the window that you clicked on,
 192 and selects that window."
 193   (interactive "e")
 194   (let ((buffers (buffer-list))
 195         menu)
 196     ;; If requested, list only the N most recently selected buffers.
 197     (if (and (integerp buffers-menu-max-size)
 198              (> buffers-menu-max-size 1))
 199         (if (> (length buffers) buffers-menu-max-size)
 200             (setcdr (nthcdr buffers-menu-max-size buffers) nil)))
 201     (setq menu
 202           (cons "Select Buffer"
 203                 (let ((tail buffers)
 204                       (maxbuf 0)
 205                       (maxlen 0)
 206                       head)
 207                   (while tail
 208                     (or (eq ?\ (aref (buffer-name (car tail)) 0))
 209                         (setq maxbuf
 210                               (max maxbuf
 211                                    (length (buffer-name (car tail))))))
 212                     (setq tail (cdr tail)))
 213                   (setq tail buffers)
 214                   (while tail
 215                     (let ((elt (car tail)))
 216                       (if (not (string-match "^ "
 217                                              (buffer-name elt)))
 218                           (setq head (cons
 219                                       (cons
 220                                        (format
 221                                         (format "%%%ds  %%s%%s  %%s"
 222                                                 maxbuf)
 223                                         (buffer-name elt)
 224                                         (if (buffer-modified-p elt)
 225                                             "*" " ")
 226                                         (save-excursion
 227                                           (set-buffer elt)
 228                                           (if buffer-read-only "%" " "))
 229                                         (or (buffer-file-name elt)
 230                                             (save-excursion
 231                                               (set-buffer elt)
 232                                               list-buffers-directory)
 233                                             ""))
 234                                        elt)
 235                                       head)))
 236                       (and head (> (length (car (car head))) maxlen)
 237                            (setq maxlen (length (car (car head))))))
 238                     (setq tail (cdr tail)))
 239                   (nconc (nreverse head)
 240                          (list (cons
 241                                 (concat (make-string (max (- (/ maxlen
 242                                                                 2)
 243                                                              8)
 244                                                           0) ?\ )
 245                                         "List All Buffers")
 246                                 'list-buffers))))))
 247     (setq menu (list menu))
 248
 249     (if (cdr (frame-list))
 250         (setq menu
 251               (cons (cons "Select Frame"
 252                           (mapcar (lambda (frame)
 253                                     (cons (cdr (assq 'name
 254                                                      (frame-parameters frame)))
 255                                           frame))
 256                                   (frame-list)))
 257                     menu)))
 258     (setq menu (cons "Buffer and Frame Menu" menu))
 259
 260     (let ((buf (x-popup-menu (if (listp event) event
 261                                (cons '(0 0) (selected-frame)))
 262                              menu))
 263           (window (and (listp event) (posn-window (event-start event)))))
 264       (cond ((framep buf)
 265              (make-frame-visible buf)
 266              (raise-frame buf)
 267              (select-frame buf))
 268             ((eq buf 'list-buffers)
 269              (list-buffers))
 270             (buf
 271              (if complex-buffers-menu-p
 272                  (let ((action (x-popup-menu
 273                                 (if (listp event) event
 274                                   (cons '(0 0) (selected-frame)))
 275                                 '("Buffer Action"
 276                                   (""
 277                                    ("Save Buffer" . save-buffer)
 278                                    ("Kill Buffer" . kill-buffer)
 279                                    ("Select Buffer" . switch-to-buffer))))))
 280                    (if (eq action 'save-buffer)
 281                        (save-excursion
 282                          (set-buffer buf)
 283                          (save-buffer))
 284                      (funcall action buf)))
 285                (and (windowp window)
 286                     (select-window window))
 287                (switch-to-buffer buf)))))))
 288
 289 ;; this version is too slow
 290 ;;;(defun format-buffers-menu-line (buffer)
 291 ;;;  "Returns a string to represent the given buffer in the Buffer menu.
 292 ;;;nil means the buffer shouldn't be listed.  You can redefine this."
 293 ;;;  (if (string-match "\\` " (buffer-name buffer))
 294 ;;;      nil
 295 ;;;    (save-excursion
 296 ;;;     (set-buffer buffer)
 297 ;;;     (let ((size (buffer-size)))
 298 ;;;       (format "%s%s %-19s %6s %-15s %s"
 299 ;;;            (if (buffer-modified-p) "*" " ")
 300 ;;;            (if buffer-read-only "%" " ")
 301 ;;;            (buffer-name)
 302 ;;;            size
 303 ;;;            mode-name
 304 ;;;            (or (buffer-file-name) ""))))))
 305 \f
 306 (defun menu-bar-mode (flag)
 307   "Toggle display of a menu bar on each frame.
 308 This command applies to all frames that exist and frames to be
 309 created in the future.
 310 With a numeric argument, if the argument is negative,
 311 turn off menu bars; otherwise, turn on menu bars."
 312  (interactive "P")
 313  (if flag (setq flag (prefix-numeric-value flag)))
 314
 315  ;; Obtain the current setting by looking at default-frame-alist.
 316  (let ((menu-bar-mode
 317         (not (zerop (let ((assq (assq 'menu-bar-lines default-frame-alist)))
 318                       (if assq (cdr assq) 0))))))
 319
 320    ;; Tweedle it according to the argument.
 321    (setq menu-bar-mode (if (null flag) (not menu-bar-mode)
 322                          (or (not (numberp flag)) (>= flag 0))))
 323
 324    ;; Apply it to default-frame-alist.
 325    (let ((parameter (assq 'menu-bar-lines default-frame-alist)))
 326      (if (consp parameter)
 327          (setcdr parameter (if menu-bar-mode 1 0))
 328        (setq default-frame-alist
 329              (cons (cons 'menu-bar-lines (if menu-bar-mode 1 0))
 330                    default-frame-alist))))
 331
 332    ;; Apply it to existing frames.
 333    (let ((frames (frame-list)))
 334      (while frames
 335        (modify-frame-parameters (car frames)
 336                                 (list (cons 'menu-bar-lines
 337                                             (if menu-bar-mode 1 0))))
 338        (setq frames (cdr frames))))))
 339
 340 ;; Make frames created from now on have a menu bar.
 341 (if window-system
 342     (menu-bar-mode t))
 343
 344 (provide 'menu-bar)
 345
 346 ;;; menu-bar.el ends here