image.el 9.48 KB
Newer Older
Gerd Moellmann's avatar
Gerd Moellmann committed
1 2
;;; image.el --- image API

3
;; Copyright (C) 1998, 1999, 2000 Free Software Foundation, Inc.
Dave Love's avatar
Dave Love committed
4
;; Keywords: multimedia
Gerd Moellmann's avatar
Gerd Moellmann committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41

;; This file is part of GNU Emacs.

;; 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 2, 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
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; 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., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.

;;; Commentary:

;;; Code:

(defconst image-type-regexps
  '(("^/\\*.*XPM.\\*/" . xpm)
    ("^P[1-6]" . pbm)
    ("^GIF8" . gif)
    ("JFIF" . jpeg)
    ("^\211PNG\r\n" . png)
    ("^#define" . xbm)
    ("^\\(MM\0\\*\\)\\|\\(II\\*\0\\)" . tiff)
    ("^%!PS" . ghostscript))
  "Alist of (REGEXP . IMAGE-TYPE) pairs used to auto-detect image types.
When the first bytes of an image file match REGEXP, it is assumed to
be of image type IMAGE-TYPE.")


;;;###autoload
42 43 44
(defun image-type-from-data (data)
  "Determine the image type from image data DATA.
Value is a symbol specifying the image type or nil if type cannot
Gerd Moellmann's avatar
Gerd Moellmann committed
45
be determined."
46
  (let ((types image-type-regexps)
Gerd Moellmann's avatar
Gerd Moellmann committed
47 48 49 50
	type)
    (while (and types (null type))
      (let ((regexp (car (car types)))
	    (image-type (cdr (car types))))
51
	(when (string-match regexp data)
Gerd Moellmann's avatar
Gerd Moellmann committed
52 53 54 55 56
	  (setq type image-type))
	(setq types (cdr types))))
    type))


57 58 59 60 61 62 63 64 65 66 67 68 69 70
;;;###autoload
(defun image-type-from-file-header (file)
  "Determine the type of image file FILE from its first few bytes.
Value is a symbol specifying the image type, or nil if type cannot
be determined."
  (unless (file-name-directory file)
    (setq file (expand-file-name file data-directory)))
  (setq file (expand-file-name file))
  (let ((header (with-temp-buffer
		  (insert-file-contents-literally file nil 0 256)
		  (buffer-string))))
    (image-type-from-data header)))


Gerd Moellmann's avatar
Gerd Moellmann committed
71 72 73 74
;;;###autoload
(defun image-type-available-p (type)
  "Value is non-nil if image type TYPE is available.
Image types are symbols like `xbm' or `jpeg'."
75
  (and (boundp 'image-types) (not (null (memq type image-types)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
76 77 78


;;;###autoload
79 80 81
(defun create-image (file-or-data &optional type data-p &rest props)
  "Create an image.
FILE-OR-DATA is an image file name or image data.
Gerd Moellmann's avatar
Gerd Moellmann committed
82
Optional TYPE is a symbol describing the image type.  If TYPE is omitted
83 84 85 86
or nil, try to determine the image type from its first few bytes
of image data.  If that doesn't work, and FILE-OR-DATA is a file name,
use its file extension.as image type.
Optional DATA-P non-nil means FILE-OR-DATA is a string containing image data.
Gerd Moellmann's avatar
Gerd Moellmann committed
87
Optional PROPS are additional image attributes to assign to the image,
Gerd Moellmann's avatar
Gerd Moellmann committed
88
like, e.g. `:mask MASK'.
Gerd Moellmann's avatar
Gerd Moellmann committed
89
Value is the image created, or nil if images of type TYPE are not supported."
90 91
  (when (and (not data-p) (not (stringp file-or-data)))
    (error "Invalid image file name `%s'" file-or-data))
92 93 94 95 96 97 98 99 100 101 102 103 104 105
  (cond ((null data-p)
	 ;; FILE-OR-DATA is a file name.
	 (unless (or type
		     (setq type (image-type-from-file-header file-or-data)))
	   (let ((extension (file-name-extension file-or-data)))
	     (unless extension
	       (error "Cannot determine image type"))
	     (setq type (intern extension)))))
	(t
	 ;; FILE-OR-DATA contains image data.
	 (unless type
	   (setq type (image-type-from-data file-or-data)))))
  (unless type
    (error "Cannot determine image type"))
Gerd Moellmann's avatar
Gerd Moellmann committed
106
  (unless (symbolp type)
107
    (error "Invalid image type `%s'" type))
Gerd Moellmann's avatar
Gerd Moellmann committed
108
  (when (image-type-available-p type)
109 110
    (append (list 'image :type type (if data-p :data :file) file-or-data)
	    props)))
Gerd Moellmann's avatar
Gerd Moellmann committed
111 112 113


;;;###autoload
114
(defun put-image (image pos &optional string area)
115
  "Put image IMAGE in front of POS in the current buffer.
Gerd Moellmann's avatar
Gerd Moellmann committed
116
IMAGE must be an image created with `create-image' or `defimage'.
117 118
IMAGE is displayed by putting an overlay into the current buffer with a
`before-string' STRING that has a `display' property whose value is the
119
image.  STRING is defaulted if you omit it.
Gerd Moellmann's avatar
Gerd Moellmann committed
120 121 122 123
POS may be an integer or marker.
AREA is where to display the image.  AREA nil or omitted means
display it in the text area, a value of `left-margin' means
display it in the left marginal area, a value of `right-margin'
124
means display it in the right marginal area."
125
  (unless string (setq string "x"))
126
  (let ((buffer (current-buffer)))
127
    (unless (eq (car-safe image) 'image)
128 129 130
      (error "Not an image: %s" image))
    (unless (or (null area) (memq area '(left-margin right-margin)))
      (error "Invalid area %s" area))
131
    (setq string (copy-sequence string))
132
    (let ((overlay (make-overlay pos pos buffer))
133 134
	  (prop (if (null area) image (list (list 'margin area) image))))
      (put-text-property 0 (length string) 'display prop string)
135 136
      (overlay-put overlay 'put-image t)
      (overlay-put overlay 'before-string string))))
Gerd Moellmann's avatar
Gerd Moellmann committed
137 138 139


;;;###autoload
140
(defun insert-image (image &optional string area)
Gerd Moellmann's avatar
Gerd Moellmann committed
141
  "Insert IMAGE into current buffer at point.
142
IMAGE is displayed by inserting STRING into the current buffer
143 144
with a `display' property whose value is the image.  STRING is
defaulted if you omit it.
Gerd Moellmann's avatar
Gerd Moellmann committed
145 146 147
AREA is where to display the image.  AREA nil or omitted means
display it in the text area, a value of `left-margin' means
display it in the left marginal area, a value of `right-margin'
148
means display it in the right marginal area."
149 150 151
  ;; Use a space as least likely to cause trouble when it's a hidden
  ;; character in the buffer.
  (unless string (setq string " "))
152
  (unless (eq (car-safe image) 'image)
Gerd Moellmann's avatar
Gerd Moellmann committed
153 154 155
    (error "Not an image: %s" image))
  (unless (or (null area) (memq area '(left-margin right-margin)))
    (error "Invalid area %s" area))
156 157 158 159 160 161 162 163 164
  (if area
      (setq image (list (list 'margin area) image))
    ;; Cons up a new spec equal but not eq to `image' so that
    ;; inserting it twice in a row (adjacently) displays two copies of
    ;; the image.  Don't try to avoid this by looking at the display
    ;; properties on either side so that we DTRT more often with
    ;; cut-and-paste.  (Yanking killed image text next to another copy
    ;; of it loses anyway.)
    (setq image (cons 'image (cdr image))))
165 166 167
  (let ((start (point)))
    (insert string)
    (add-text-properties start (point)
168 169 170 171
			 (list 'display image
			       ;; `image' has the right properties to
			       ;; mark an intangible field.
			       'intangible image
172
			       'rear-nonsticky (list 'display)))))
173

Gerd Moellmann's avatar
Gerd Moellmann committed
174 175 176 177 178 179 180 181 182 183 184 185

;;;###autoload
(defun remove-images (start end &optional buffer)
  "Remove images between START and END in BUFFER.
Remove only images that were put in BUFFER with calls to `put-image'.
BUFFER nil or omitted means use the current buffer."
  (unless buffer
    (setq buffer (current-buffer)))
  (let ((overlays (overlays-in start end)))
    (while overlays
      (let ((overlay (car overlays)))
	(when (overlay-get overlay 'put-image)
186 187
	  (delete-overlay overlay)))
      (setq overlays (cdr overlays)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
188 189 190


;;;###autoload
Gerd Moellmann's avatar
Gerd Moellmann committed
191 192
(defun find-image (specs)
  "Find an image, choosing one of a list of image specifications.
Gerd Moellmann's avatar
Gerd Moellmann committed
193

194
SPECS is a list of image specifications.
Gerd Moellmann's avatar
Gerd Moellmann committed
195 196 197

Each image specification in SPECS is a property list.  The contents of
a specification are image type dependent.  All specifications must at
198 199 200
least contain the properties `:type TYPE' and either `:file FILE' or
`:data DATA', where TYPE is a symbol specifying the image type,
e.g. `xbm', FILE is the file to load the image from, and DATA is a
201 202 203 204 205 206
string containing the actual image data.  The specification whose TYPE
is supported, and FILE exists, is used to construct the image
specification to be returned.  Return nil if no specification is
satisfied.

The image is looked for first on `load-path' and then in `data-directory'."
Gerd Moellmann's avatar
Gerd Moellmann committed
207 208 209 210
  (let (image)
    (while (and specs (null image))
      (let* ((spec (car specs))
	     (type (plist-get spec :type))
211
	     (data (plist-get spec :data))
212 213
	     (file (plist-get spec :file))
	     found)
214 215
	(when (image-type-available-p type)
	  (cond ((stringp file)
216 217 218 219 220 221 222
		 (let ((path load-path))
		   (while (and (not found) path)
		     (let ((try-file (expand-file-name file (car path))))
		       (when (file-readable-p try-file)
			 (setq found try-file)))
		     (setq path (cdr path)))
		   (unless found
223 224 225 226 227
		     (let ((try-file (expand-file-name file data-directory)))
		       (if (file-readable-p try-file)
			   (setq found try-file))))
		   (if found
		       (setq image
228 229
			     (cons 'image (plist-put (copy-sequence spec)
						     :file found))))))
230
		((not (null data))
231 232
		 (setq image (cons 'image spec)))))
	(setq specs (cdr specs))))
Gerd Moellmann's avatar
Gerd Moellmann committed
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
    image))


;;;###autoload
(defmacro defimage (symbol specs &optional doc)
  "Define SYMBOL as an image.

SPECS is a list of image specifications.  DOC is an optional
documentation string.

Each image specification in SPECS is a property list.  The contents of
a specification are image type dependent.  All specifications must at
least contain the properties `:type TYPE' and either `:file FILE' or
`:data DATA', where TYPE is a symbol specifying the image type,
e.g. `xbm', FILE is the file to load the image from, and DATA is a
string containing the actual image data.  The first image
specification whose TYPE is supported, and FILE exists, is used to
define SYMBOL.

Example:

   (defimage test-image ((:type xpm :file \"~/test1.xpm\")
                         (:type xbm :file \"~/test1.xbm\")))"
  `(defvar ,symbol (find-image ',specs) ,doc))
Gerd Moellmann's avatar
Gerd Moellmann committed
257 258 259 260


(provide 'image)

Dave Love's avatar
Dave Love committed
261
;;; image.el ends here