code.delx.au - gnu-emacs/blob - 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, 1994 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 \f
  39 (define-key menu-bar-file-menu [exit-emacs]
  40   '("Exit Emacs" . save-buffers-kill-emacs))
  41
  42 (define-key menu-bar-file-menu [separator-compare]
  43   '("--"))
  44
  45 (define-key menu-bar-file-menu [epatch]
  46   '("Apply Patch" . menu-bar-epatch-menu))
  47 (define-key menu-bar-file-menu [ediff]
  48   '("Compare Files" . menu-bar-ediff-menu))
  49 (define-key menu-bar-file-menu [emerge] '("Emerge" . menu-bar-emerge-menu))
  50
  51 (define-key menu-bar-file-menu [separator-misc]
  52   '("--"))
  53
  54 (define-key menu-bar-file-menu [calendar] '("Calendar" . calendar))
  55 (define-key menu-bar-file-menu [rmail] '("Read Mail" . rmail))
  56 (define-key menu-bar-file-menu [gnus] '("Read Net News" . gnus))
  57
  58 (define-key menu-bar-file-menu [separator-frames]
  59   '("--"))
  60
  61 (define-key menu-bar-file-menu [delete-frame] '("Delete Frame" . delete-frame))
  62 (define-key menu-bar-file-menu [make-frame] '("Make New Frame" . make-frame))
  63
  64 (define-key menu-bar-file-menu [separator-buffers]
  65   '("--"))
  66
  67 (define-key menu-bar-file-menu [bookmark]
  68   '("Bookmarks" . menu-bar-bookmark-map))
  69 (define-key menu-bar-file-menu [print-buffer]
  70   '("Print Buffer" . print-buffer))
  71 (define-key menu-bar-file-menu [kill-buffer]
  72   '("Kill Buffer" . kill-this-buffer))
  73 (define-key menu-bar-file-menu [insert-file]
  74   '("Insert File" . insert-file))
  75 (define-key menu-bar-file-menu [revert-buffer]
  76   '("Revert Buffer" . revert-buffer))
  77 (define-key menu-bar-file-menu [write-file]
  78   '("Save Buffer As..." . write-file))
  79 (define-key menu-bar-file-menu [save-buffer] '("Save Buffer" . save-buffer))
  80 (define-key menu-bar-file-menu [dired] '("Open Directory..." . dired))
  81 (define-key menu-bar-file-menu [open-file] '("Open File..." . find-file))
  82 \f
  83 (define-key menu-bar-edit-menu [query-replace]
  84   '("Query Replace" . query-replace))
  85 (define-key menu-bar-edit-menu [re-search-back]
  86   '("Regexp Search Backwards" . re-search-backward))
  87 (define-key menu-bar-edit-menu [search-back]
  88   '("Search Backwards" . search-backward))
  89 (define-key menu-bar-edit-menu [re-search-fwd]
  90   '("Regexp Search" . re-search-forward))
  91 (define-key menu-bar-edit-menu [search-fwd]
  92   '("Search" . search-forward))
  93
  94 (define-key menu-bar-edit-menu [separator-misc]
  95   '("--"))
  96
  97 (define-key menu-bar-edit-menu [spell] '("Spell" . ispell-menu-map))
  98 (define-key menu-bar-edit-menu [fill] '("Fill" . fill-region))
  99
 100 (define-key menu-bar-edit-menu [separator-edit]
 101   '("--"))
 102
 103 (define-key menu-bar-edit-menu [clear] '("Clear" . delete-region))
 104 (define-key menu-bar-edit-menu [choose-next-paste]
 105   '("Choose Next Paste >" . mouse-menu-choose-yank))
 106 (define-key menu-bar-edit-menu [paste] '("Paste" . yank))
 107 (define-key menu-bar-edit-menu [copy] '("Copy" . kill-ring-save))
 108 (define-key menu-bar-edit-menu [cut] '("Cut" . kill-region))
 109 (define-key menu-bar-edit-menu [undo] '("Undo" . undo))
 110
 111 (put 'fill-region 'menu-enable 'mark-active)
 112 (put 'kill-region 'menu-enable 'mark-active)
 113 (put 'kill-ring-save 'menu-enable 'mark-active)
 114 (put 'yank 'menu-enable '(x-selection-exists-p))
 115 (put 'delete-region 'menu-enable 'mark-active)
 116 (put 'undo 'menu-enable '(if (eq last-command 'undo)
 117                              pending-undo-list
 118                            (consp buffer-undo-list)))
 119 (put 'query-replace 'menu-enable (not buffer-read-only))
 120
 121 (autoload 'ispell-menu-map "ispell" nil t 'keymap)
 122
 123 ;; These are alternative definitions for the cut, paste and copy
 124 ;; menu items.  Use them if your system expects these to use the clipboard
 125
 126 (put 'clipboard-kill-region 'menu-enable 'mark-active)
 127 (put 'clipboard-kill-ring-save 'menu-enable 'mark-active)
 128 (put 'clipboard-yank 'menu-enable
 129      '(or (x-selection-exists-p) (x-selection-exists-p 'CLIPBOARD)))
 130
 131 (defun clipboard-yank ()
 132   "Reinsert the last stretch of killed text, or the clipboard contents."
 133   (interactive)
 134   (let ((x-select-enable-clipboard t))
 135     (yank)))
 136
 137 (defun clipboard-kill-ring-save (beg end)
 138   "Copy region to kill ring, and save in the X clipboard."
 139   (interactive "r")
 140   (let ((x-select-enable-clipboard t))
 141     (kill-ring-save beg end)))
 142
 143 (defun clipboard-kill-region (beg end)
 144   "Kill the region, and save it in the X clipboard."
 145   (interactive "r")
 146   (let ((x-select-enable-clipboard t))
 147     (kill-region beg end)))
 148
 149 (defun menu-bar-enable-clipboard ()
 150   "Make CUT, PASTE and COPY (keys and menu bar items) use the clipboard.
 151 Do the same for the keys of the same name."
 152   (interactive)
 153   ;; We can't use constant list structure here because it becomes pure,
 154   ;; and because it gets modified with cache data.
 155   (define-key menu-bar-edit-menu [paste]
 156     (cons "Paste" 'clipboard-yank))
 157   (define-key menu-bar-edit-menu [copy]
 158     (cons "Copy" 'clipboard-kill-ring-save))
 159   (define-key menu-bar-edit-menu [cut]
 160     (cons "Cut" 'clipboard-kill-region))
 161
 162   (define-key global-map [f20] 'clipboard-kill-region)
 163   (define-key global-map [f16] 'clipboard-kill-ring-save)
 164   (define-key global-map [f18] 'clipboard-yank)
 165   ;; X11R6 versions
 166   (define-key global-map [cut] 'clipboard-kill-region)
 167   (define-key global-map [copy] 'clipboard-kill-ring-save)
 168   (define-key global-map [paste] 'clipboard-yank))
 169 \f
 170 (define-key menu-bar-help-menu [emacs-version]
 171   '("Show Version" . emacs-version))
 172 (define-key menu-bar-help-menu [report-emacs-bug]
 173   '("Send Bug Report" . report-emacs-bug))
 174 (define-key menu-bar-help-menu [emacs-tutorial]
 175   '("Emacs Tutorial" . help-with-tutorial))
 176 (define-key menu-bar-help-menu [man] '("Man..." . manual-entry))
 177 (define-key menu-bar-help-menu [describe-variable]
 178   '("Describe Variable..." . describe-variable))
 179 (define-key menu-bar-help-menu [describe-function]
 180   '("Describe Function..." . describe-function))
 181 (define-key menu-bar-help-menu [describe-key]
 182   '("Describe Key..." . describe-key))
 183 (define-key menu-bar-help-menu [list-keybindings]
 184   '("List Keybindings" . describe-bindings))
 185 (define-key menu-bar-help-menu [command-apropos]
 186   '("Command Apropos..." . command-apropos))
 187 (define-key menu-bar-help-menu [describe-mode]
 188   '("Describe Mode" . describe-mode))
 189 (define-key menu-bar-help-menu [info] '("Info" . info))
 190
 191 (define-key menu-bar-help-menu [emacs-news] '("Emacs News" . view-emacs-news))
 192 (defun kill-this-buffer ()      ; for the menubar
 193   "Kills the current buffer."
 194   (interactive)
 195   (kill-buffer (current-buffer)))
 196
 197 (defun kill-this-buffer-enabled-p ()
 198   (let ((count 0)
 199         (buffers (buffer-list)))
 200     (while buffers
 201       (or (string-match "^ " (buffer-name (car buffers)))
 202           (setq count (1+ count)))
 203       (setq buffers (cdr buffers)))
 204     (> count 1)))
 205
 206 (put 'save-buffer 'menu-enable '(buffer-modified-p))
 207 (put 'revert-buffer 'menu-enable
 208      '(or revert-buffer-function revert-buffer-insert-file-contents-function
 209           (and (buffer-file-name)
 210                (or (buffer-modified-p)
 211                    (not (verify-visited-file-modtime (current-buffer)))))))
 212 ;; Permit deleting frame if it would leave a visible or iconified frame.
 213 (put 'delete-frame 'menu-enable
 214      '(let ((frames (frame-list))
 215             (count 0))
 216         (while frames
 217           (if (cdr (assq 'visibility (frame-parameters (car frames))))
 218               (setq count (1+ count)))
 219           (setq frames (cdr frames)))
 220         (> count 1)))
 221 (put 'kill-this-buffer 'menu-enable '(kill-this-buffer-enabled-p))
 222
 223 (put 'advertised-undo 'menu-enable
 224      '(and (not (eq t buffer-undo-list))
 225            (if (eq last-command 'undo)
 226                (and (boundp 'pending-undo-list)
 227                     pending-undo-list)
 228              buffer-undo-list)))
 229
 230 (defvar yank-menu-length 100
 231   "*Maximum length of an item in the menu for \
 232 \\[mouse-menu-choose-yank].")
 233
 234 (defun mouse-menu-choose-yank (event)
 235   "Pop up a menu of the kill-ring for selection with the mouse.
 236 The kill-ring-yank-pointer is moved to the selected element.
 237 A subsequent \\[yank] yanks the choice just selected."
 238   (interactive "e")
 239   (let* ((count 0)
 240          (menu (mapcar (lambda (string)
 241                          (if (> (length string) yank-menu-length)
 242                              (setq string (substring string
 243                                                      0 yank-menu-length)))
 244                          (prog1 (cons string count)
 245                            (setq count (1+ count))))
 246                        kill-ring))
 247          (arg (x-popup-menu event
 248                             (list "Yank Menu"
 249                                   (cons "Choose Next Yank" menu)))))
 250     ;; A mouse click outside the menu returns nil.
 251     ;; Avoid a confusing error from passing nil to rotate-yank-pointer.
 252     ;; XXX should this perhaps do something other than simply return? -rm
 253     (if arg
 254         (progn
 255           ;; We don't use `rotate-yank-pointer' because we want to move
 256           ;; relative to the beginning of kill-ring, not the current
 257           ;; position.  Also, that would ask for any new X selection and
 258           ;; thus change the list of items the user just chose from, which
 259           ;; would be highly confusing.
 260           (setq kill-ring-yank-pointer (nthcdr arg kill-ring))
 261           (if (interactive-p)
 262               (message "The next yank will insert the selected text.")
 263             (current-kill 0))))))
 264 (put 'mouse-menu-choose-yank 'menu-enable 'kill-ring)
 265 \f
 266 (define-key global-map [menu-bar buffer] '("Buffers" . menu-bar-buffers))
 267
 268 (defalias 'menu-bar-buffers (make-sparse-keymap "Buffers"))
 269
 270 (defvar complex-buffers-menu-p nil
 271   "*Non-nil says, offer a choice of actions after you pick a buffer.
 272 This applies to the Buffers menu from the menu bar.")
 273
 274 (defvar buffers-menu-max-size 10
 275   "*Maximum number of entries which may appear on the Buffers menu.
 276 If this is 10, then only the ten most-recently-selected buffers are shown.
 277 If this is nil, then all buffers are shown.
 278 A large number or nil slows down menu responsiveness.")
 279
 280 (defvar list-buffers-directory nil)
 281
 282 (defun menu-bar-select-buffer ()
 283   (interactive)
 284   (switch-to-buffer last-command-event))
 285
 286 (defun menu-bar-select-frame ()
 287   (interactive)
 288   (make-frame-visible last-command-event)
 289   (raise-frame last-command-event)
 290   (select-frame last-command-event))
 291
 292 (defun menu-bar-update-buffers ()
 293   ;; If user discards the Buffers item, play along.
 294   (and (lookup-key (current-global-map) [menu-bar buffer])
 295        (frame-or-buffer-changed-p)
 296        (let ((buffers (buffer-list))
 297              (frames (frame-list))
 298              buffers-menu frames-menu)
 299          ;; If requested, list only the N most recently selected buffers.
 300          (if (and (integerp buffers-menu-max-size)
 301                   (> buffers-menu-max-size 1))
 302              (if (> (length buffers) buffers-menu-max-size)
 303                  (setcdr (nthcdr buffers-menu-max-size buffers) nil)))
 304
 305          ;; Make the menu of buffers proper.
 306          (setq buffers-menu
 307                (cons "Select Buffer"
 308                      (let ((tail buffers)
 309                            (maxbuf 0)
 310                            (maxlen 0)
 311                            alist
 312                            head)
 313                        (while tail
 314                          (or (eq ?\ (aref (buffer-name (car tail)) 0))
 315                              (setq maxbuf
 316                                    (max maxbuf
 317                                         (length (buffer-name (car tail))))))
 318                          (setq tail (cdr tail)))
 319                        (setq tail buffers)
 320                        (while tail
 321                          (let ((elt (car tail)))
 322                            (or (eq ?\ (aref (buffer-name elt) 0))
 323                                (setq alist (cons
 324                                             (cons
 325                                              (format
 326                                               (format "%%%ds  %%s%%s  %%s"
 327                                                       maxbuf)
 328                                               (buffer-name elt)
 329                                               (if (buffer-modified-p elt)
 330                                                   "*" " ")
 331                                               (save-excursion
 332                                                 (set-buffer elt)
 333                                                 (if buffer-read-only "%" " "))
 334                                               (or (buffer-file-name elt)
 335                                                   (save-excursion
 336                                                     (set-buffer elt)
 337                                                     list-buffers-directory)
 338                                                   ""))
 339                                              elt)
 340                                             alist)))
 341                            (and alist (> (length (car (car alist))) maxlen)
 342                                 (setq maxlen (length (car (car alist))))))
 343                          (setq tail (cdr tail)))
 344                        (setq alist (nreverse alist))
 345                        (nconc (mapcar '(lambda (pair)
 346                                          ;; This is somewhat risque, to use
 347                                          ;; the buffer name itself as the event
 348                                          ;; type to define, but it works.
 349                                          ;; It would not work to use the buffer
 350                                          ;; since a buffer as an event has its
 351                                          ;; own meaning.
 352                                          (nconc (list (buffer-name (cdr pair))
 353                                                       (car pair)
 354                                                       (cons nil nil))
 355                                                 'menu-bar-select-buffer))
 356                                       alist)
 357                               (list
 358                                (cons
 359                                 'list-buffers
 360                                 (cons
 361                                  (concat (make-string (max (- (/ maxlen 2) 8) 0)
 362                                                       ?\ )
 363                                          "List All Buffers")
 364                                  'list-buffers)))))))
 365
 366
 367          ;; Make a Frames menu if we have more than one frame.
 368          (if (cdr frames)
 369              (setq frames-menu
 370                    (cons "Select Frame"
 371                          (mapcar '(lambda (frame)
 372                                     (nconc (list frame
 373                                                  (cdr (assq 'name
 374                                                             (frame-parameters frame)))
 375                                                  (cons nil nil))
 376                                            'menu-bar-select-frame))
 377                                  frames))))
 378          (if buffers-menu
 379              (setq buffers-menu (cons 'keymap buffers-menu)))
 380          (if frames-menu
 381              (setq frames-menu (cons 'keymap frames-menu)))
 382          (define-key (current-global-map) [menu-bar buffer]
 383            (cons "Buffers"
 384                  (if (and buffers-menu frames-menu)
 385                      (list 'keymap "Buffers and Frames"
 386                            (cons 'buffers (cons "Buffers" buffers-menu))
 387                            (cons 'frames (cons "Frames" frames-menu)))
 388                    (or buffers-menu frames-menu 'undefined)))))))
 389
 390 (add-hook 'menu-bar-update-hook 'menu-bar-update-buffers)
 391
 392 ;; this version is too slow
 393 ;;;(defun format-buffers-menu-line (buffer)
 394 ;;;  "Returns a string to represent the given buffer in the Buffer menu.
 395 ;;;nil means the buffer shouldn't be listed.  You can redefine this."
 396 ;;;  (if (string-match "\\` " (buffer-name buffer))
 397 ;;;      nil
 398 ;;;    (save-excursion
 399 ;;;     (set-buffer buffer)
 400 ;;;     (let ((size (buffer-size)))
 401 ;;;       (format "%s%s %-19s %6s %-15s %s"
 402 ;;;            (if (buffer-modified-p) "*" " ")
 403 ;;;            (if buffer-read-only "%" " ")
 404 ;;;            (buffer-name)
 405 ;;;            size
 406 ;;;            mode-name
 407 ;;;            (or (buffer-file-name) ""))))))
 408 \f
 409 (defvar menu-bar-mode nil)
 410
 411 (defun menu-bar-mode (flag)
 412   "Toggle display of a menu bar on each frame.
 413 This command applies to all frames that exist and frames to be
 414 created in the future.
 415 With a numeric argument, if the argument is negative,
 416 turn off menu bars; otherwise, turn on menu bars."
 417  (interactive "P")
 418
 419   ;; Make menu-bar-mode and default-frame-alist consistent.
 420   (let ((default (assq 'menu-bar-lines default-frame-alist)))
 421     (if default
 422         (setq menu-bar-mode (not (eq (cdr default) 0)))
 423       (setq default-frame-alist
 424             (cons (cons 'menu-bar-lines (if menu-bar-mode 1 0))
 425                   default-frame-alist))))
 426
 427   ;; Toggle or set the mode, according to FLAG.
 428  (setq menu-bar-mode (if (null flag) (not menu-bar-mode)
 429                        (> (prefix-numeric-value flag) 0)))
 430
 431  ;; Apply it to default-frame-alist.
 432  (let ((parameter (assq 'menu-bar-lines default-frame-alist)))
 433    (if (consp parameter)
 434        (setcdr parameter (if menu-bar-mode 1 0))
 435      (setq default-frame-alist
 436            (cons (cons 'menu-bar-lines (if menu-bar-mode 1 0))
 437                  default-frame-alist))))
 438
 439  ;; Apply it to existing frames.
 440  (let ((frames (frame-list)))
 441    (while frames
 442      (let ((height (cdr (assq 'height (frame-parameters (car frames))))))
 443        (modify-frame-parameters (car frames)
 444                                 (list (cons 'menu-bar-lines
 445                                           (if menu-bar-mode 1 0))))
 446        (modify-frame-parameters (car frames)
 447                                 (list (cons 'height height))))
 448      (setq frames (cdr frames)))))
 449
 450 (provide 'menu-bar)
 451
 452 ;;; menu-bar.el ends here