lisp/menu-bar.el

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