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

3
;; Copyright (C) 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
Pavel Janík's avatar
Pavel Janík committed
4 5

;; Maintainer: FSF
Dave Love's avatar
Dave Love committed
6
;; Keywords: multimedia
Gerd Moellmann's avatar
Gerd Moellmann committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28

;; 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:

Miles Bader's avatar
Miles Bader committed
29 30 31 32 33 34

(defgroup image ()
  "Image support."
  :group 'multimedia)


Gerd Moellmann's avatar
Gerd Moellmann committed
35
(defconst image-type-regexps
36
  '(("\\`/[\t\n\r ]*\\*.*XPM.\\*/" . xpm)
37 38 39
    ("\\`P[1-6]" . pbm)
    ("\\`GIF8" . gif)
    ("\\`\211PNG\r\n" . png)
40
    ("\\`[\t\n\r ]*#define" . xbm)
41
    ("\\`\\(MM\0\\*\\|II\\*\0\\)" . tiff)
42
    ("\\`[\t\n\r ]*%!PS" . postscript)
43
    ("\\`\xff\xd8" . (image-jpeg-p . jpeg)))
Gerd Moellmann's avatar
Gerd Moellmann committed
44 45
  "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
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
be of image type IMAGE-TYPE if IMAGE-TYPE is a symbol.  If not a symbol,
IMAGE-TYPE must be a pair (PREDICATE . TYPE).  PREDICATE is called
with one argument, a string containing the image data.  If PREDICATE returns
a non-nil value, TYPE is the image's type ")


(defun image-jpeg-p (data)
  "Value is non-nil if DATA, a string, consists of JFIF image data."
  (when (string-match "\\`\xff\xd8" data)
    (catch 'jfif
      (let ((len (length data)) (i 2))
	(while (< i len)
	  (when (/= (aref data i) #xff)
	    (throw 'jfif nil))
	  (setq i (1+ i))
	  (when (>= (+ i 2) len)
	    (throw 'jfif nil))
	  (let ((nbytes (+ (lsh (aref data (+ i 1)) 8)
64 65 66
			   (aref data (+ i 2))))
		(code (aref data i)))
	    (when (and (>= code #xe0) (<= code #xef))
67
	      ;; APP0 LEN1 LEN2 "JFIF\0"
68
	      (throw 'jfif 
69
		     (string-match "JFIF" (substring data i (+ i nbytes)))))
70
	    (setq i (+ i 1 nbytes))))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
71 72 73


;;;###autoload
74 75 76
(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
77
be determined."
78
  (let ((types image-type-regexps)
Gerd Moellmann's avatar
Gerd Moellmann committed
79 80 81 82
	type)
    (while (and types (null type))
      (let ((regexp (car (car types)))
	    (image-type (cdr (car types))))
83 84 85 86 87
	(when (or (and (symbolp image-type)
		       (string-match regexp data))
		  (and (consp image-type)
		       (funcall (car image-type) data)
		       (setq image-type (cdr image-type))))
Gerd Moellmann's avatar
Gerd Moellmann committed
88 89 90 91 92
	  (setq type image-type))
	(setq types (cdr types))))
    type))


93 94 95 96 97 98 99 100 101 102 103 104 105 106
;;;###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
107 108 109 110
;;;###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'."
111
  (and (boundp 'image-types) (not (null (memq type image-types)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
112 113 114


;;;###autoload
115 116 117
(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
118
Optional TYPE is a symbol describing the image type.  If TYPE is omitted
119 120
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,
121
use its file extension as image type.
122
Optional DATA-P non-nil means FILE-OR-DATA is a string containing image data.
Gerd Moellmann's avatar
Gerd Moellmann committed
123
Optional PROPS are additional image attributes to assign to the image,
Gerd Moellmann's avatar
Gerd Moellmann committed
124
like, e.g. `:mask MASK'.
Gerd Moellmann's avatar
Gerd Moellmann committed
125
Value is the image created, or nil if images of type TYPE are not supported."
126 127
  (when (and (not data-p) (not (stringp file-or-data)))
    (error "Invalid image file name `%s'" file-or-data))
128 129 130 131 132 133 134 135 136 137 138 139 140 141
  (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
142
  (unless (symbolp type)
143
    (error "Invalid image type `%s'" type))
Gerd Moellmann's avatar
Gerd Moellmann committed
144
  (when (image-type-available-p type)
145 146
    (append (list 'image :type type (if data-p :data :file) file-or-data)
	    props)))
Gerd Moellmann's avatar
Gerd Moellmann committed
147 148 149


;;;###autoload
150
(defun put-image (image pos &optional string area)
151
  "Put image IMAGE in front of POS in the current buffer.
Gerd Moellmann's avatar
Gerd Moellmann committed
152
IMAGE must be an image created with `create-image' or `defimage'.
153 154
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
155
image.  STRING is defaulted if you omit it.
Gerd Moellmann's avatar
Gerd Moellmann committed
156 157 158 159
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'
160
means display it in the right marginal area."
161
  (unless string (setq string "x"))
162
  (let ((buffer (current-buffer)))
163
    (unless (eq (car-safe image) 'image)
164 165 166
      (error "Not an image: %s" image))
    (unless (or (null area) (memq area '(left-margin right-margin)))
      (error "Invalid area %s" area))
167
    (setq string (copy-sequence string))
168
    (let ((overlay (make-overlay pos pos buffer))
169 170
	  (prop (if (null area) image (list (list 'margin area) image))))
      (put-text-property 0 (length string) 'display prop string)
171 172
      (overlay-put overlay 'put-image t)
      (overlay-put overlay 'before-string string))))
Gerd Moellmann's avatar
Gerd Moellmann committed
173 174 175


;;;###autoload
176
(defun insert-image (image &optional string area)
Gerd Moellmann's avatar
Gerd Moellmann committed
177
  "Insert IMAGE into current buffer at point.
178
IMAGE is displayed by inserting STRING into the current buffer
179 180
with a `display' property whose value is the image.  STRING is
defaulted if you omit it.
Gerd Moellmann's avatar
Gerd Moellmann committed
181 182 183
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'
184
means display it in the right marginal area."
185 186 187
  ;; Use a space as least likely to cause trouble when it's a hidden
  ;; character in the buffer.
  (unless string (setq string " "))
188
  (unless (eq (car-safe image) 'image)
Gerd Moellmann's avatar
Gerd Moellmann committed
189 190 191
    (error "Not an image: %s" image))
  (unless (or (null area) (memq area '(left-margin right-margin)))
    (error "Invalid area %s" area))
192 193 194 195 196 197 198 199 200
  (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))))
201 202 203
  (let ((start (point)))
    (insert string)
    (add-text-properties start (point)
204 205 206 207
			 (list 'display image
			       ;; `image' has the right properties to
			       ;; mark an intangible field.
			       'intangible image
208
			       'rear-nonsticky (list 'display)))))
209

Gerd Moellmann's avatar
Gerd Moellmann committed
210 211 212 213 214 215 216 217 218 219 220 221

;;;###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)
222 223
	  (delete-overlay overlay)))
      (setq overlays (cdr overlays)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
224 225 226


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

230
SPECS is a list of image specifications.
Gerd Moellmann's avatar
Gerd Moellmann committed
231 232 233

Each image specification in SPECS is a property list.  The contents of
a specification are image type dependent.  All specifications must at
234 235 236
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
237 238 239 240 241 242
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
243 244 245 246
  (let (image)
    (while (and specs (null image))
      (let* ((spec (car specs))
	     (type (plist-get spec :type))
247
	     (data (plist-get spec :data))
248 249
	     (file (plist-get spec :file))
	     found)
250 251
	(when (image-type-available-p type)
	  (cond ((stringp file)
252 253 254 255 256 257 258
		 (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
259 260 261 262 263
		     (let ((try-file (expand-file-name file data-directory)))
		       (if (file-readable-p try-file)
			   (setq found try-file))))
		   (if found
		       (setq image
264 265
			     (cons 'image (plist-put (copy-sequence spec)
						     :file found))))))
266
		((not (null data))
267 268
		 (setq image (cons 'image spec)))))
	(setq specs (cdr specs))))
Gerd Moellmann's avatar
Gerd Moellmann committed
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
    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
293 294 295 296


(provide 'image)

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