lisp/tool-bar.el

   1 ;;; tool-bar.el --- setting up the tool bar
   2
   3 ;; Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
   4 ;;   2009, 2010  Free Software Foundation, Inc.
   5
   6 ;; Author: Dave Love <fx@gnu.org>
   7 ;; Keywords: mouse frames
   8 ;; Package: emacs
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software: you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation, either version 3 of the License, or
  15 ;; (at your option) any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  24
  25 ;;; Commentary:
  26
  27 ;; Provides `tool-bar-mode' to control display of the tool-bar and
  28 ;; bindings for the global tool bar with convenience functions
  29 ;; `tool-bar-add-item' and `tool-bar-add-item-from-menu'.
  30
  31 ;; The normal global binding for [tool-bar] (below) uses the value of
  32 ;; `tool-bar-map' as the actual keymap to define the tool bar.  Modes
  33 ;; may either bind items under the [tool-bar] prefix key of the local
  34 ;; map to add to the global bar or may set `tool-bar-map'
  35 ;; buffer-locally to override it.  (Some items are removed from the
  36 ;; global bar in modes which have `special' as their `mode-class'
  37 ;; property.)
  38
  39 ;; Todo: Somehow make tool bars easily customizable by the naive?
  40
  41 ;;; Code:
  42
  43 ;; The autoload cookie doesn't work when preloading.
  44 ;; Deleting it means invoking this command won't work
  45 ;; when you are on a tty.  I hope that won't cause too much trouble -- rms.
  46 (define-minor-mode tool-bar-mode
  47   "Toggle use of the tool bar.
  48 With numeric ARG, display the tool bar if and only if ARG is positive.
  49
  50 See `tool-bar-add-item' and `tool-bar-add-item-from-menu' for
  51 conveniently adding tool bar items."
  52   :init-value t
  53   :global t
  54   ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
  55   :variable tool-bar-mode
  56   (let ((val (if tool-bar-mode 1 0)))
  57     (dolist (frame (frame-list))
  58       (set-frame-parameter frame 'tool-bar-lines val))
  59     ;; If the user has given `default-frame-alist' a `tool-bar-lines'
  60     ;; parameter, replace it.
  61     (if (assq 'tool-bar-lines default-frame-alist)
  62         (setq default-frame-alist
  63               (cons (cons 'tool-bar-lines val)
  64                     (assq-delete-all 'tool-bar-lines
  65                                      default-frame-alist)))))
  66   (and tool-bar-mode
  67        (= 1 (length (default-value 'tool-bar-map))) ; not yet setup
  68        (tool-bar-setup)))
  69
  70 ;;;###autoload
  71 ;; Used in the Show/Hide menu, to have the toggle reflect the current frame.
  72 (defun toggle-tool-bar-mode-from-frame (&optional arg)
  73   "Toggle tool bar on or off, based on the status of the current frame.
  74 See `tool-bar-mode' for more information."
  75   (interactive (list (or current-prefix-arg 'toggle)))
  76   (if (eq arg 'toggle)
  77       (tool-bar-mode (if (> (frame-parameter nil 'tool-bar-lines) 0) 0 1))
  78     (tool-bar-mode arg)))
  79
  80 (defvar tool-bar-map (make-sparse-keymap)
  81   "Keymap for the tool bar.
  82 Define this locally to override the global tool bar.")
  83
  84 (global-set-key [tool-bar]
  85                 `(menu-item ,(purecopy "tool bar") ignore
  86                             :filter tool-bar-make-keymap))
  87
  88 (declare-function image-mask-p "image.c" (spec &optional frame))
  89
  90 (defconst tool-bar-keymap-cache (make-hash-table :weakness t :test 'equal))
  91
  92 (defun tool-bar-make-keymap (&optional ignore)
  93   "Generate an actual keymap from `tool-bar-map'.
  94 Its main job is to figure out which images to use based on the display's
  95 color capability and based on the available image libraries."
  96   (let ((key (cons (frame-terminal) tool-bar-map)))
  97     (or (gethash key tool-bar-keymap-cache)
  98         (puthash key (tool-bar-make-keymap-1) tool-bar-keymap-cache))))
  99
 100 (defun tool-bar-make-keymap-1 ()
 101   "Generate an actual keymap from `tool-bar-map', without caching."
 102   (mapcar (lambda (bind)
 103             (let (image-exp plist)
 104               (when (and (eq (car-safe (cdr-safe bind)) 'menu-item)
 105                          ;; For the format of menu-items, see node
 106                          ;; `Extended Menu Items' in the Elisp manual.
 107                          (setq plist (nthcdr (if (consp (nth 4 bind)) 5 4)
 108                                              bind))
 109                          (setq image-exp (plist-get plist :image))
 110                          (consp image-exp)
 111                          (not (eq (car image-exp) 'image))
 112                          (fboundp (car image-exp)))
 113                 (if (not (display-images-p))
 114                     (setq bind nil)
 115                   (let ((image (eval image-exp)))
 116                     (unless (and image (image-mask-p image))
 117                       (setq image (append image '(:mask heuristic))))
 118                     (setq bind (copy-sequence bind)
 119                           plist (nthcdr (if (consp (nth 4 bind)) 5 4)
 120                                         bind))
 121                     (plist-put plist :image image))))
 122               bind))
 123           tool-bar-map))
 124
 125 ;;;###autoload
 126 (defun tool-bar-add-item (icon def key &rest props)
 127   "Add an item to the tool bar.
 128 ICON names the image, DEF is the key definition and KEY is a symbol
 129 for the fake function key in the menu keymap.  Remaining arguments
 130 PROPS are additional items to add to the menu item specification.  See
 131 Info node `(elisp)Tool Bar'.  Items are added from left to right.
 132
 133 ICON is the base name of a file containing the image to use.  The
 134 function will first try to use low-color/ICON.xpm if `display-color-cells'
 135 is less or equal to 256, then ICON.xpm, then ICON.pbm, and finally
 136 ICON.xbm, using `find-image'.
 137
 138 Use this function only to make bindings in the global value of `tool-bar-map'.
 139 To define items in any other map, use `tool-bar-local-item'."
 140   (apply 'tool-bar-local-item icon def key tool-bar-map props))
 141
 142 ;;;###autoload
 143 (defun tool-bar-local-item (icon def key map &rest props)
 144   "Add an item to the tool bar in map MAP.
 145 ICON names the image, DEF is the key definition and KEY is a symbol
 146 for the fake function key in the menu keymap.  Remaining arguments
 147 PROPS are additional items to add to the menu item specification.  See
 148 Info node `(elisp)Tool Bar'.  Items are added from left to right.
 149
 150 ICON is the base name of a file containing the image to use.  The
 151 function will first try to use low-color/ICON.xpm if `display-color-cells'
 152 is less or equal to 256, then ICON.xpm, then ICON.pbm, and finally
 153 ICON.xbm, using `find-image'."
 154   (let* ((fg (face-attribute 'tool-bar :foreground))
 155          (bg (face-attribute 'tool-bar :background))
 156          (colors (nconc (if (eq fg 'unspecified) nil (list :foreground fg))
 157                         (if (eq bg 'unspecified) nil (list :background bg))))
 158          (xpm-spec (list :type 'xpm :file (concat icon ".xpm")))
 159          (xpm-lo-spec (list :type 'xpm :file
 160                             (concat "low-color/" icon ".xpm")))
 161          (pbm-spec (append (list :type 'pbm :file
 162                                  (concat icon ".pbm")) colors))
 163          (xbm-spec (append (list :type 'xbm :file
 164                                  (concat icon ".xbm")) colors))
 165          (image-exp `(find-image
 166                       (cond ((not (display-color-p))
 167                              ',(list pbm-spec xbm-spec xpm-lo-spec xpm-spec))
 168                             ((< (display-color-cells) 256)
 169                              ',(list xpm-lo-spec xpm-spec pbm-spec xbm-spec))
 170                             (t
 171                              ',(list xpm-spec pbm-spec xbm-spec))))))
 172     (define-key-after map (vector key)
 173       `(menu-item ,(symbol-name key) ,def :image ,image-exp ,@props))))
 174
 175 ;;;###autoload
 176 (defun tool-bar-add-item-from-menu (command icon &optional map &rest props)
 177   "Define tool bar binding for COMMAND in keymap MAP using the given ICON.
 178 This makes a binding for COMMAND in `tool-bar-map', copying its
 179 binding from the menu bar in MAP (which defaults to `global-map'), but
 180 modifies the binding by adding an image specification for ICON.  It
 181 finds ICON just like `tool-bar-add-item'.  PROPS are additional
 182 properties to add to the binding.
 183
 184 MAP must contain appropriate binding for `[menu-bar]' which holds a keymap.
 185
 186 Use this function only to make bindings in the global value of `tool-bar-map'.
 187 To define items in any other map, use `tool-bar-local-item-from-menu'."
 188   (apply 'tool-bar-local-item-from-menu command icon
 189          (default-value 'tool-bar-map) map props))
 190
 191 ;;;###autoload
 192 (defun tool-bar-local-item-from-menu (command icon in-map &optional from-map &rest props)
 193   "Define local tool bar binding for COMMAND using the given ICON.
 194 This makes a binding for COMMAND in IN-MAP, copying its binding from
 195 the menu bar in FROM-MAP (which defaults to `global-map'), but
 196 modifies the binding by adding an image specification for ICON.  It
 197 finds ICON just like `tool-bar-add-item'.  PROPS are additional
 198 properties to add to the binding.
 199
 200 FROM-MAP must contain appropriate binding for `[menu-bar]' which
 201 holds a keymap."
 202   (unless from-map
 203     (setq from-map global-map))
 204   (let* ((menu-bar-map (lookup-key from-map [menu-bar]))
 205          (keys (where-is-internal command menu-bar-map))
 206          (fg (face-attribute 'tool-bar :foreground))
 207          (bg (face-attribute 'tool-bar :background))
 208          (colors (nconc (if (eq fg 'unspecified) nil (list :foreground fg))
 209                         (if (eq bg 'unspecified) nil (list :background bg))))
 210          (xpm-spec (list :type 'xpm :file (concat icon ".xpm")))
 211          (xpm-lo-spec (list :type 'xpm :file
 212                             (concat "low-color/" icon ".xpm")))
 213          (pbm-spec (append (list :type 'pbm :file
 214                                  (concat icon ".pbm")) colors))
 215          (xbm-spec (append (list :type 'xbm :file
 216                                  (concat icon ".xbm")) colors))
 217          (image-exp `(find-image
 218                       (cond ((not (display-color-p))
 219                              ',(list pbm-spec xbm-spec xpm-lo-spec xpm-spec))
 220                             ((< (display-color-cells) 256)
 221                              ',(list xpm-lo-spec xpm-spec pbm-spec xbm-spec))
 222                             (t
 223                              ',(list xpm-spec pbm-spec xbm-spec)))))
 224          submap key)
 225     ;; We'll pick up the last valid entry in the list of keys if
 226     ;; there's more than one.
 227     ;; FIXME: Aren't they *all* "valid"??  --Stef
 228     (dolist (k keys)
 229       ;; We're looking for a binding of the command in a submap of
 230       ;; the menu bar map, so the key sequence must be two or more
 231       ;; long.
 232       (if (and (vectorp k)
 233                (> (length k) 1))
 234           (let ((m (lookup-key menu-bar-map (substring k 0 -1)))
 235                 ;; Last element in the bound key sequence:
 236                 (kk (aref k (1- (length k)))))
 237             (if (and (keymapp m)
 238                      (symbolp kk))
 239                 (setq submap m
 240                       key kk)))))
 241     (when (and (symbolp submap) (boundp submap))
 242       (setq submap (eval submap)))
 243     (let ((defn (assq key (cdr submap))))
 244       (if (eq (cadr defn) 'menu-item)
 245           (define-key-after in-map (vector key)
 246             (append (cdr defn) (list :image image-exp) props))
 247         (setq defn (cdr defn))
 248         (define-key-after in-map (vector key)
 249           (let ((rest (cdr defn)))
 250             ;; If the rest of the definition starts
 251             ;; with a list of menu cache info, get rid of that.
 252             (if (and (consp rest) (consp (car rest)))
 253                 (setq rest (cdr rest)))
 254             (append `(menu-item ,(car defn) ,rest)
 255                     (list :image image-exp) props)))))))
 256
 257 ;;; Set up some global items.  Additions/deletions up for grabs.
 258
 259 (defun tool-bar-setup ()
 260   ;; People say it's bad to have EXIT on the tool bar, since users
 261   ;; might inadvertently click that button.
 262   ;;(tool-bar-add-item-from-menu 'save-buffers-kill-emacs "exit")
 263   (tool-bar-add-item-from-menu 'find-file "new" nil :label "New File")
 264   (tool-bar-add-item-from-menu 'menu-find-file-existing "open")
 265   (tool-bar-add-item-from-menu 'dired "diropen")
 266   (tool-bar-add-item-from-menu 'kill-this-buffer "close")
 267   (tool-bar-add-item-from-menu 'save-buffer "save" nil
 268                                :visible '(or buffer-file-name
 269                                              (not (eq 'special
 270                                                       (get major-mode
 271                                                            'mode-class)))))
 272   (tool-bar-add-item-from-menu 'write-file "saveas" nil
 273                                :visible '(or buffer-file-name
 274                                              (not (eq 'special
 275                                                       (get major-mode
 276                                                            'mode-class)))))
 277   (tool-bar-add-item-from-menu 'undo "undo" nil
 278                                :visible '(not (eq 'special (get major-mode
 279                                                                 'mode-class))))
 280   (tool-bar-add-item-from-menu (lookup-key menu-bar-edit-menu [cut])
 281                                "cut" nil
 282                                :visible '(not (eq 'special (get major-mode
 283                                                                 'mode-class))))
 284   (tool-bar-add-item-from-menu (lookup-key menu-bar-edit-menu [copy])
 285                                "copy")
 286   (tool-bar-add-item-from-menu (lookup-key menu-bar-edit-menu [paste])
 287                                "paste" nil
 288                                :visible '(not (eq 'special (get major-mode
 289                                                                 'mode-class))))
 290   (tool-bar-add-item-from-menu 'nonincremental-search-forward "search"
 291                                nil :label "Search")
 292   ;;(tool-bar-add-item-from-menu 'ispell-buffer "spell")
 293
 294   ;; There's no icon appropriate for News and we need a command rather
 295   ;; than a lambda for Read Mail.
 296   ;;(tool-bar-add-item-from-menu 'compose-mail "mail/compose")
 297
 298   (tool-bar-add-item-from-menu 'print-buffer "print" nil :label "Print")
 299
 300   ;; tool-bar-add-item-from-menu itself operates on
 301   ;; (default-value 'tool-bar-map), but when we don't use that function,
 302   ;; we must explicitly operate on the default value.
 303
 304   (let ((tool-bar-map (default-value 'tool-bar-map)))
 305     (tool-bar-add-item "preferences" 'customize 'customize
 306                        :help "Edit preferences (customize)")
 307
 308     (tool-bar-add-item "help" (lambda ()
 309                                 (interactive)
 310                                 (popup-menu menu-bar-help-menu))
 311                        'help
 312                        :help "Pop up the Help menu")))
 313
 314 (if (featurep 'move-toolbar)
 315     (defcustom tool-bar-position 'top
 316       "Specify on which side the tool bar shall be.
 317 Possible values are `top' (tool bar on top), `bottom' (tool bar at bottom),
 318 `left' (tool bar on left) and `right' (tool bar on right).
 319 Customize `tool-bar-mode' if you want to show or hide the tool bar."
 320       :type '(choice (const top)
 321                      (const bottom)
 322                      (const left)
 323                      (const right))
 324       :group 'frames
 325       :initialize 'custom-initialize-default
 326       :set (lambda (sym val)
 327              (set-default sym val)
 328              (modify-all-frames-parameters
 329               (list (cons 'tool-bar-position val))))))
 330
 331
 332 (provide 'tool-bar)
 333
 334 ;;; tool-bar.el ends here