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

3
;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2004, 2005, 2006, 2007 Free Software Foundation, Inc.
Pavel Janík's avatar
Pavel Janík committed
5 6

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

;; 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
Lute Kamstra's avatar
Lute Kamstra committed
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Gerd Moellmann's avatar
Gerd Moellmann committed
25 26 27 28 29

;;; Commentary:

;;; Code:

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

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


36
(defconst image-type-header-regexps
37 38
  '(("\\`/[\t\n\r ]*\\*.*XPM.\\*/" . xpm)
    ("\\`P[1-6][[:space:]]+\\(?:#.*[[:space:]]+\\)*[0-9]+[[:space:]]+[0-9]+" . pbm)
39
    ("\\`GIF8[79]a" . gif)
40
    ("\\`\x89PNG\r\n\x1a\n" . png)
41 42 43
    ("\\`[\t\n\r ]*#define \\([a-z0-9]+\\)_width [0-9]+\n\
#define \\1_height [0-9]+\n\
static char \\1_bits" . xbm)
44 45 46 47
    ("\\`\\(?:MM\0\\*\\|II\\*\0\\)" . tiff)
    ("\\`[\t\n\r ]*%!PS" . postscript)
    ("\\`\xff\xd8" . (image-jpeg-p . jpeg)))
  "Alist of (REGEXP . IMAGE-TYPE) pairs used to auto-detect image types.
Gerd Moellmann's avatar
Gerd Moellmann committed
48
When the first bytes of an image file match REGEXP, it is assumed to
49 50 51 52
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.")
53

54 55 56 57 58 59 60 61 62 63 64 65 66 67
(defconst image-type-file-name-regexps
  '(("\\.png\\'" . png)
    ("\\.gif\\'" . gif)
    ("\\.jpe?g\\'" . jpeg)
    ("\\.bmp\\'" . bmp)
    ("\\.xpm\\'" . xpm)
    ("\\.pbm\\'" . pbm)
    ("\\.xbm\\'" . xbm)
    ("\\.ps\\'" . postscript)
    ("\\.tiff?\\'" . tiff))
  "Alist of (REGEXP . IMAGE-TYPE) pairs used to identify image files.
When the name of an image file match REGEXP, it is assumed to
be of image type IMAGE-TYPE.")

68 69 70
;; We rely on `auto-mode-alist' to detect xbm and xpm files, instead
;; of content autodetection.  Their contents are just C code, so it is
;; easy to generate false matches.
71 72
(defvar image-type-auto-detectable
  '((pbm . t)
73
    (xbm . nil)
74 75 76
    (bmp . maybe)
    (gif . maybe)
    (png . maybe)
77
    (xpm . nil)
78 79 80 81 82 83 84 85 86 87 88
    (jpeg . maybe)
    (tiff . maybe)
    (postscript . nil))
  "Alist of (IMAGE-TYPE . AUTODETECT) pairs used to auto-detect image files.
\(See `image-type-auto-detected-p').

AUTODETECT can be
 - t      always auto-detect.
 - nil    never auto-detect.
 - maybe  auto-detect only if the image type is available
	    (see `image-type-available-p').")
89

90
(defvar image-load-path nil
91
  "List of locations in which to search for image files.
92 93 94 95 96
If an element is a string, it defines a directory to search.
If an element is a variable symbol whose value is a string, that
value defines a directory to search.
If an element is a variable symbol whose value is a list, the
value is used as a list of directories to search.")
97

98 99 100 101 102
(eval-at-startup
 (setq image-load-path
       (list (file-name-as-directory (expand-file-name "images" data-directory))
	     'data-directory 'load-path)))

103

104
(defun image-load-path-for-library (library image &optional path no-error)
105
  "Return a suitable search path for images used by LIBRARY.
106

107
It searches for IMAGE in `image-load-path' (excluding
108 109 110 111
\"`data-directory'/images\") and `load-path', followed by a path
suitable for LIBRARY, which includes \"../../etc/images\" and
\"../etc/images\" relative to the library file itself, and then
in \"`data-directory'/images\".
112

113 114 115 116
Then this function returns a list of directories which contains
first the directory in which IMAGE was found, followed by the
value of `load-path'. If PATH is given, it is used instead of
`load-path'.
117

118 119 120
If NO-ERROR is non-nil and a suitable path can't be found, don't
signal an error. Instead, return a list of directories as before,
except that nil appears in place of the image directory.
121 122 123 124 125

Here is an example that uses a common idiom to provide
compatibility with versions of Emacs that lack the variable
`image-load-path':

126 127
    ;; Shush compiler.
    (defvar image-load-path)
128 129

    (let* ((load-path (image-load-path-for-library \"mh-e\" \"mh-logo.xpm\"))
130 131 132
           (image-load-path (cons (car load-path)
                                  (when (boundp 'image-load-path)
                                    image-load-path))))
133
      (mh-tool-bar-folder-buttons-init))"
134 135
  (unless library (error "No library specified"))
  (unless image   (error "No image specified"))
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
  (let (image-directory image-directory-load-path)
    ;; Check for images in image-load-path or load-path.
    (let ((img image)
          (dir (or
                ;; Images in image-load-path.
                (image-search-load-path image)
                ;; Images in load-path.
                (locate-library image)))
          parent)
      ;; Since the image might be in a nested directory (for
      ;; example, mail/attach.pbm), adjust `image-directory'
      ;; accordingly.
      (when dir
        (setq dir (file-name-directory dir))
        (while (setq parent (file-name-directory img))
          (setq img (directory-file-name parent)
                dir (expand-file-name "../" dir))))
      (setq image-directory-load-path dir))

    ;; If `image-directory-load-path' isn't Emacs' image directory,
    ;; it's probably a user preference, so use it. Then use a
    ;; relative setting if possible; otherwise, use
    ;; `image-directory-load-path'.
159
    (cond
160 161 162 163 164 165
     ;; User-modified image-load-path?
     ((and image-directory-load-path
           (not (equal image-directory-load-path
                       (file-name-as-directory
                        (expand-file-name "images" data-directory)))))
      (setq image-directory image-directory-load-path))
166 167 168 169 170 171 172 173 174
     ;; Try relative setting.
     ((let (library-name d1ei d2ei)
        ;; First, find library in the load-path.
        (setq library-name (locate-library library))
        (if (not library-name)
            (error "Cannot find library %s in load-path" library))
        ;; And then set image-directory relative to that.
        (setq
         ;; Go down 2 levels.
175 176 177
         d2ei (file-name-as-directory
               (expand-file-name
                (concat (file-name-directory library-name) "../../etc/images")))
178
         ;; Go down 1 level.
179 180 181
         d1ei (file-name-as-directory
               (expand-file-name
                (concat (file-name-directory library-name) "../etc/images"))))
182 183 184 185
        (setq image-directory
              ;; Set it to nil if image is not found.
              (cond ((file-exists-p (expand-file-name image d2ei)) d2ei)
                    ((file-exists-p (expand-file-name image d1ei)) d1ei)))))
186 187 188
     ;; Use Emacs' image directory.
     (image-directory-load-path
      (setq image-directory image-directory-load-path))
189 190
     (no-error
      (message "Could not find image %s for library %s" image library))
191 192 193
     (t
      (error "Could not find image %s for library %s" image library)))

194 195 196 197
    ;; Return an augmented `path' or `load-path'.
    (nconc (list image-directory)
           (delete image-directory (copy-sequence (or path load-path))))))

198

199
(defun image-jpeg-p (data)
200 201
  "Value is non-nil if DATA, a string, consists of JFIF image data.
We accept the tag Exif because that is the same format."
202 203 204 205 206 207 208 209 210 211
  (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)
212 213 214
			   (aref data (+ i 2))))
		(code (aref data i)))
	    (when (and (>= code #xe0) (<= code #xef))
215
	      ;; APP0 LEN1 LEN2 "JFIF\0"
216
	      (throw 'jfif
217 218
		     (string-match "JFIF\\|Exif"
				   (substring data i (min (+ i nbytes) len)))))
219
	    (setq i (+ i 1 nbytes))))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
220 221 222


;;;###autoload
223 224 225
(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
226
be determined."
227
  (let ((types image-type-header-regexps)
Gerd Moellmann's avatar
Gerd Moellmann committed
228
	type)
229
    (while types
Gerd Moellmann's avatar
Gerd Moellmann committed
230
      (let ((regexp (car (car types)))
231
	    (image-type (cdr (car types))))
232 233 234 235 236 237 238 239 240 241 242 243
	(if (or (and (symbolp image-type)
		     (string-match regexp data))
		(and (consp image-type)
		     (funcall (car image-type) data)
		     (setq image-type (cdr image-type))))
	    (setq type image-type
		  types nil)
	  (setq types (cdr types)))))
    type))


;;;###autoload
244
(defun image-type-from-buffer ()
245
  "Determine the image type from data in the current buffer.
246 247
Value is a symbol specifying the image type or nil if type cannot
be determined."
248 249 250 251 252 253
  (let ((types image-type-header-regexps)
	type
	(opoint (point)))
    (goto-char (point-min))
    (while types
      (let ((regexp (car (car types)))
254
	    (image-type (cdr (car types)))
255 256 257 258 259 260 261 262 263 264 265 266
	    data)
	(if (or (and (symbolp image-type)
		     (looking-at regexp))
		(and (consp image-type)
		     (funcall (car image-type)
			      (or data
				  (setq data
					(buffer-substring
					 (point-min)
					 (min (point-max)
					      (+ (point-min) 256))))))
		     (setq image-type (cdr image-type))))
267
	    (setq type image-type
268 269 270
		  types nil)
	  (setq types (cdr types)))))
    (goto-char opoint)
Gerd Moellmann's avatar
Gerd Moellmann committed
271 272 273
    type))


274 275 276 277 278
;;;###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."
279 280 281 282 283 284 285 286
  (unless (or (file-readable-p file)
	      (file-name-absolute-p file))
    (setq file (image-search-load-path file)))
  (and file
       (file-readable-p file)
       (with-temp-buffer
	 (set-buffer-multibyte nil)
	 (insert-file-contents-literally file nil 0 256)
287
	 (image-type-from-buffer))))
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302


;;;###autoload
(defun image-type-from-file-name (file)
  "Determine the type of image file FILE from its name.
Value is a symbol specifying the image type, or nil if type cannot
be determined."
  (let ((types image-type-file-name-regexps)
	type)
    (while types
      (if (string-match (car (car types)) file)
	  (setq type (cdr (car types))
		types nil)
	(setq types (cdr types))))
    type))
303 304


Gerd Moellmann's avatar
Gerd Moellmann committed
305
;;;###autoload
306 307
(defun image-type (file-or-data &optional type data-p)
  "Determine and return image type.
308
FILE-OR-DATA is an image file name or image data.
Gerd Moellmann's avatar
Gerd Moellmann committed
309
Optional TYPE is a symbol describing the image type.  If TYPE is omitted
310 311
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,
312
use its file extension as image type.
313
Optional DATA-P non-nil means FILE-OR-DATA is a string containing image data."
314 315
  (when (and (not data-p) (not (stringp file-or-data)))
    (error "Invalid image file name `%s'" file-or-data))
316 317 318 319 320 321 322 323 324 325 326 327 328 329
  (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
330
  (unless (symbolp type)
331
    (error "Invalid image type `%s'" type))
332 333
  type)

334

335 336 337 338 339 340 341 342
;;;###autoload
(defun image-type-available-p (type)
  "Return non-nil if image type TYPE is available.
Image types are symbols like `xbm' or `jpeg'."
  (and (fboundp 'init-image-library)
       (init-image-library type image-library-alist)))


343 344 345
;;;###autoload
(defun image-type-auto-detected-p ()
  "Return t iff the current buffer contains an auto-detectable image.
346 347 348 349 350 351 352 353 354
This function is intended to be used from `magic-mode-alist' (which see).

First, compare the beginning of the buffer with `image-type-header-regexps'.
If an appropriate image type is found, check if that image type can be
autodetected using the variable `image-type-auto-detectable'.  Finally,
if `buffer-file-name' is non-nil, check if it matches another major mode
in `auto-mode-alist' apart from `image-mode'; if there is another match,
the autodetection is considered to have failed.  Return t if all the above
steps succeed."
355 356 357
  (let* ((type (image-type-from-buffer))
	 (auto (and type (cdr (assq type image-type-auto-detectable)))))
    (and auto
358 359 360 361 362 363 364 365 366 367 368 369
	 (or (eq auto t) (image-type-available-p type))
	 (or (null buffer-file-name)
	     (not (assoc-default
		   buffer-file-name
		   (delq nil (mapcar 
			      (lambda (elt)
				(unless (memq (or (car-safe (cdr elt))
						  (cdr elt))
					      '(image-mode image-mode-maybe))
				  elt))
			      auto-mode-alist))
		   'string-match))))))
370 371


372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
;;;###autoload
(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.
Optional TYPE is a symbol describing the image type.  If TYPE is omitted
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.
Optional PROPS are additional image attributes to assign to the image,
like, e.g. `:mask MASK'.
Value is the image created, or nil if images of type TYPE are not supported.

Images should not be larger than specified by `max-image-size'."
  (setq type (image-type file-or-data type data-p))
Gerd Moellmann's avatar
Gerd Moellmann committed
387
  (when (image-type-available-p type)
388 389
    (append (list 'image :type type (if data-p :data :file) file-or-data)
	    props)))
Gerd Moellmann's avatar
Gerd Moellmann committed
390 391 392


;;;###autoload
393
(defun put-image (image pos &optional string area)
394
  "Put image IMAGE in front of POS in the current buffer.
Gerd Moellmann's avatar
Gerd Moellmann committed
395
IMAGE must be an image created with `create-image' or `defimage'.
396 397
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
398
image.  STRING is defaulted if you omit it.
Gerd Moellmann's avatar
Gerd Moellmann committed
399 400 401 402
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'
403
means display it in the right marginal area."
404
  (unless string (setq string "x"))
405
  (let ((buffer (current-buffer)))
406
    (unless (eq (car-safe image) 'image)
407 408 409
      (error "Not an image: %s" image))
    (unless (or (null area) (memq area '(left-margin right-margin)))
      (error "Invalid area %s" area))
410
    (setq string (copy-sequence string))
411
    (let ((overlay (make-overlay pos pos buffer))
412 413
	  (prop (if (null area) image (list (list 'margin area) image))))
      (put-text-property 0 (length string) 'display prop string)
414 415
      (overlay-put overlay 'put-image t)
      (overlay-put overlay 'before-string string))))
Gerd Moellmann's avatar
Gerd Moellmann committed
416 417 418


;;;###autoload
419
(defun insert-image (image &optional string area slice)
Gerd Moellmann's avatar
Gerd Moellmann committed
420
  "Insert IMAGE into current buffer at point.
421
IMAGE is displayed by inserting STRING into the current buffer
422 423
with a `display' property whose value is the image.  STRING is
defaulted if you omit it.
Gerd Moellmann's avatar
Gerd Moellmann committed
424 425 426
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'
427 428 429 430 431 432
means display it in the right marginal area.
SLICE specifies slice of IMAGE to insert.  SLICE nil or omitted
means insert whole image.  SLICE is a list (X Y WIDTH HEIGHT)
specifying the X and Y positions and WIDTH and HEIGHT of image area
to insert.  A float value 0.0 - 1.0 means relative to the width or
height of the image; integer values are taken as pixel values."
433 434 435
  ;; Use a space as least likely to cause trouble when it's a hidden
  ;; character in the buffer.
  (unless string (setq string " "))
436
  (unless (eq (car-safe image) 'image)
Gerd Moellmann's avatar
Gerd Moellmann committed
437 438 439
    (error "Not an image: %s" image))
  (unless (or (null area) (memq area '(left-margin right-margin)))
    (error "Invalid area %s" area))
440 441 442 443 444 445 446 447 448
  (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))))
449 450 451
  (let ((start (point)))
    (insert string)
    (add-text-properties start (point)
452 453 454 455 456
			 `(display ,(if slice
					(list (cons 'slice slice) image)
				      image) rear-nonsticky (display)))))


457
;;;###autoload
458
(defun insert-sliced-image (image &optional string area rows cols)
459 460 461 462 463 464 465 466 467
  "Insert IMAGE into current buffer at point.
IMAGE is displayed by inserting STRING into the current buffer
with a `display' property whose value is the image.  STRING is
defaulted if you omit it.
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'
means display it in the right marginal area.
The image is automatically split into ROW x COLS slices."
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
  (unless string (setq string " "))
  (unless (eq (car-safe image) 'image)
    (error "Not an image: %s" image))
  (unless (or (null area) (memq area '(left-margin right-margin)))
    (error "Invalid area %s" area))
  (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))))
  (let ((x 0.0) (dx (/ 1.0001 (or cols 1)))
	 (y 0.0) (dy (/ 1.0001 (or rows 1))))
    (while (< y 1.0)
      (while (< x 1.0)
	(let ((start (point)))
	  (insert string)
	  (add-text-properties start (point)
			       `(display ,(list (list 'slice x y dx dy) image)
					 rear-nonsticky (display)))
	  (setq x (+ x dx))))
      (setq x 0.0
	    y (+ y dy))
494
      (insert (propertize "\n" 'line-height t)))))
495

496

Gerd Moellmann's avatar
Gerd Moellmann committed
497 498 499 500 501 502 503 504 505 506 507 508

;;;###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)
509 510
	  (delete-overlay overlay)))
      (setq overlays (cdr overlays)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
511

512 513 514 515
(defun image-search-load-path (file &optional path)
  (unless path
    (setq path image-load-path))
  (let (element found filename)
516
    (while (and (not found) (consp path))
517
      (setq element (car path))
518
      (cond
519
       ((stringp element)
520 521
	(setq found
	      (file-readable-p
522
	       (setq filename (expand-file-name file element)))))
523 524 525 526 527 528
       ((and (symbolp element) (boundp element))
	(setq element (symbol-value element))
	(cond
	 ((stringp element)
	  (setq found
		(file-readable-p
529
		 (setq filename (expand-file-name file element)))))
530
	 ((consp element)
531
	  (if (setq filename (image-search-load-path file element))
532
	      (setq found t))))))
533
      (setq path (cdr path)))
534
    (if found filename)))
Gerd Moellmann's avatar
Gerd Moellmann committed
535 536

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

540
SPECS is a list of image specifications.
Gerd Moellmann's avatar
Gerd Moellmann committed
541 542 543

Each image specification in SPECS is a property list.  The contents of
a specification are image type dependent.  All specifications must at
544 545 546
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
547 548 549 550 551
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.

552 553 554
The image is looked for in `image-load-path'.

Image files should not be larger than specified by `max-image-size'."
Gerd Moellmann's avatar
Gerd Moellmann committed
555 556 557 558
  (let (image)
    (while (and specs (null image))
      (let* ((spec (car specs))
	     (type (plist-get spec :type))
559
	     (data (plist-get spec :data))
560 561
	     (file (plist-get spec :file))
	     found)
562 563
	(when (image-type-available-p type)
	  (cond ((stringp file)
564
		 (if (setq found (image-search-load-path file))
565 566 567
		     (setq image
			   (cons 'image (plist-put (copy-sequence spec)
						   :file found)))))
568
		((not (null data))
569 570
		 (setq image (cons 'image spec)))))
	(setq specs (cdr specs))))
Gerd Moellmann's avatar
Gerd Moellmann committed
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
    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\")))"
594
  (declare (doc-string 3))
Gerd Moellmann's avatar
Gerd Moellmann committed
595
  `(defvar ,symbol (find-image ',specs) ,doc))
Gerd Moellmann's avatar
Gerd Moellmann committed
596 597 598 599


(provide 'image)

600
;; arch-tag: 8e76a07b-eb48-4f3e-a7a0-1a7ba9f096b3
Dave Love's avatar
Dave Love committed
601
;;; image.el ends here