;;; tool-bar.el --- setting up the tool bar
;;
;; Copyright (C) 2000, 2001, 2002, 2003, 2004,
-;; 2005, 2006, 2007 Free Software Foundation, Inc.
+;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
;;
;; Author: Dave Love <fx@gnu.org>
;; Keywords: mouse frames
;; This file is part of GNU Emacs.
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 3, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING. If not, write to the
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
(global-set-key [tool-bar]
'(menu-item "tool bar" ignore
- :filter (lambda (ignore) tool-bar-map)))
+ :filter tool-bar-make-keymap))
+
+(declare-function image-mask-p "image.c" (spec &optional frame))
+
+(defun tool-bar-make-keymap (&optional ignore)
+ "Generate an actual keymap from `tool-bar-map'.
+Its main job is to figure out which images to use based on the display's
+color capability and based on the available image libraries."
+ (mapcar (lambda (bind)
+ (let (image-exp plist)
+ (when (and (eq (car-safe (cdr-safe bind)) 'menu-item)
+ ;; For the format of menu-items, see node
+ ;; `Extended Menu Items' in the Elisp manual.
+ (setq plist (nthcdr (if (consp (nth 4 bind)) 5 4)
+ bind))
+ (setq image-exp (plist-get plist :image))
+ (consp image-exp)
+ (not (eq (car image-exp) 'image))
+ (fboundp (car image-exp)))
+ (if (not (display-images-p))
+ (setq bind nil)
+ (let ((image (eval image-exp)))
+ (unless (and image (image-mask-p image))
+ (setq image (append image '(:mask heuristic))))
+ (setq bind (copy-sequence bind)
+ plist (nthcdr (if (consp (nth 4 bind)) 5 4)
+ bind))
+ (plist-put plist :image image))))
+ bind))
+ tool-bar-map))
+
+(defconst tool-bar-find-image-cache (make-hash-table :weakness t :test 'equal))
+
+(defun tool-bar-find-image (specs)
+ "Like `find-image' but with caching."
+ (or (gethash specs tool-bar-find-image-cache)
+ (puthash specs (find-image specs) tool-bar-find-image-cache)))
;;;###autoload
(defun tool-bar-add-item (icon def key &rest props)
Info node `(elisp)Tool Bar'. Items are added from left to right.
ICON is the base name of a file containing the image to use. The
-function will first try to use low-color/ICON.xpm if display-color-cells
+function will first try to use low-color/ICON.xpm if `display-color-cells'
is less or equal to 256, then ICON.xpm, then ICON.pbm, and finally
ICON.xbm, using `find-image'.
Info node `(elisp)Tool Bar'. Items are added from left to right.
ICON is the base name of a file containing the image to use. The
-function will first try to use low-color/ICON.xpm if display-color-cells
+function will first try to use low-color/ICON.xpm if `display-color-cells'
is less or equal to 256, then ICON.xpm, then ICON.pbm, and finally
ICON.xbm, using `find-image'."
(let* ((fg (face-attribute 'tool-bar :foreground))
(concat icon ".pbm")) colors))
(xbm-spec (append (list :type 'xbm :file
(concat icon ".xbm")) colors))
- (image (find-image
- (if (display-color-p)
- (list xpm-lo-spec xpm-spec pbm-spec xbm-spec)
- (list pbm-spec xbm-spec xpm-lo-spec xpm-spec)))))
+ (image-exp `(tool-bar-find-image
+ (if (display-color-p)
+ ',(list xpm-lo-spec xpm-spec pbm-spec xbm-spec)
+ ',(list pbm-spec xbm-spec xpm-lo-spec xpm-spec)))))
- (when (and (display-images-p) image)
- (unless (image-mask-p image)
- (setq image (append image '(:mask heuristic))))
- (define-key-after map (vector key)
- `(menu-item ,(symbol-name key) ,def :image ,image ,@props)))))
+ (define-key-after map (vector key)
+ `(menu-item ,(symbol-name key) ,def :image ,image-exp ,@props))))
;;;###autoload
(defun tool-bar-add-item-from-menu (command icon &optional map &rest props)
(concat icon ".pbm")) colors))
(xbm-spec (append (list :type 'xbm :file
(concat icon ".xbm")) colors))
- (spec (if (display-color-p)
- (list xpm-lo-spec xpm-spec pbm-spec xbm-spec)
- (list pbm-spec xbm-spec xpm-lo-spec xpm-spec)))
- (image (find-image spec))
+ (image-exp `(tool-bar-find-image
+ (if (display-color-p)
+ ',(list xpm-lo-spec xpm-spec pbm-spec xbm-spec)
+ ',(list pbm-spec xbm-spec xpm-lo-spec xpm-spec))))
submap key)
- (when (and (display-images-p) image)
- ;; We'll pick up the last valid entry in the list of keys if
- ;; there's more than one.
- (dolist (k keys)
- ;; We're looking for a binding of the command in a submap of
- ;; the menu bar map, so the key sequence must be two or more
- ;; long.
- (if (and (vectorp k)
- (> (length k) 1))
- (let ((m (lookup-key menu-bar-map (substring k 0 -1)))
- ;; Last element in the bound key sequence:
- (kk (aref k (1- (length k)))))
- (if (and (keymapp m)
- (symbolp kk))
- (setq submap m
- key kk)))))
- (when (and (symbolp submap) (boundp submap))
- (setq submap (eval submap)))
- (unless (image-mask-p image)
- (setq image (append image '(:mask heuristic))))
- (let ((defn (assq key (cdr submap))))
- (if (eq (cadr defn) 'menu-item)
- (define-key-after in-map (vector key)
- (append (cdr defn) (list :image image) props))
- (setq defn (cdr defn))
- (define-key-after in-map (vector key)
- (let ((rest (cdr defn)))
- ;; If the rest of the definition starts
- ;; with a list of menu cache info, get rid of that.
- (if (and (consp rest) (consp (car rest)))
- (setq rest (cdr rest)))
- (append `(menu-item ,(car defn) ,rest)
- (list :image image) props))))))))
+ ;; We'll pick up the last valid entry in the list of keys if
+ ;; there's more than one.
+ (dolist (k keys)
+ ;; We're looking for a binding of the command in a submap of
+ ;; the menu bar map, so the key sequence must be two or more
+ ;; long.
+ (if (and (vectorp k)
+ (> (length k) 1))
+ (let ((m (lookup-key menu-bar-map (substring k 0 -1)))
+ ;; Last element in the bound key sequence:
+ (kk (aref k (1- (length k)))))
+ (if (and (keymapp m)
+ (symbolp kk))
+ (setq submap m
+ key kk)))))
+ (when (and (symbolp submap) (boundp submap))
+ (setq submap (eval submap)))
+ (let ((defn (assq key (cdr submap))))
+ (if (eq (cadr defn) 'menu-item)
+ (define-key-after in-map (vector key)
+ (append (cdr defn) (list :image image-exp) props))
+ (setq defn (cdr defn))
+ (define-key-after in-map (vector key)
+ (let ((rest (cdr defn)))
+ ;; If the rest of the definition starts
+ ;; with a list of menu cache info, get rid of that.
+ (if (and (consp rest) (consp (car rest)))
+ (setq rest (cdr rest)))
+ (append `(menu-item ,(car defn) ,rest)
+ (list :image image-exp) props)))))))
;;; Set up some global items. Additions/deletions up for grabs.
(defvar tool-bar-setup nil
- "t if the tool-bar has been set up by `tool-bar-setup'.")
+ "Set to t if the tool-bar has been set up by `tool-bar-setup'.")
(defun tool-bar-setup (&optional frame)
(unless tool-bar-setup
;; There's no icon appropriate for News and we need a command rather
;; than a lambda for Read Mail.
- ;;(tool-bar-add-item-from-menu 'compose-mail "mail/compose")
+ ;;(tool-bar-add-item-from-menu 'compose-mail "mail/compose")
- (tool-bar-add-item-from-menu 'print-buffer "print")
+ (tool-bar-add-item-from-menu 'print-buffer "print")
- ;; tool-bar-add-item-from-menu itself operates on
- ;; (default-value 'tool-bar-map), but when we don't use that function,
- ;; we must explicitly operate on the default value.
+ ;; tool-bar-add-item-from-menu itself operates on
+ ;; (default-value 'tool-bar-map), but when we don't use that function,
+ ;; we must explicitly operate on the default value.
- (let ((tool-bar-map (default-value 'tool-bar-map)))
- (tool-bar-add-item "preferences" 'customize 'customize
- :help "Edit preferences (customize)")
+ (let ((tool-bar-map (default-value 'tool-bar-map)))
+ (tool-bar-add-item "preferences" 'customize 'customize
+ :help "Edit preferences (customize)")
- (tool-bar-add-item "help" (lambda ()
- (interactive)
- (popup-menu menu-bar-help-menu))
- 'help
- :help "Pop up the Help menu"))
- (setq tool-bar-setup t))))
+ (tool-bar-add-item "help" (lambda ()
+ (interactive)
+ (popup-menu menu-bar-help-menu))
+ 'help
+ :help "Pop up the Help menu"))
+ (setq tool-bar-setup t))))
(provide 'tool-bar)
-;;; arch-tag: 15f30f0a-d0d7-4d50-bbb7-f48fd0c8582f
+;; arch-tag: 15f30f0a-d0d7-4d50-bbb7-f48fd0c8582f
;;; tool-bar.el ends here