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

3 4
;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
;;   2007, 2008, 2009, 2010  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
8
;; Package: emacs
Gerd Moellmann's avatar
Gerd Moellmann committed
9 10 11

;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Gerd Moellmann's avatar
Gerd Moellmann committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Gerd Moellmann's avatar
Gerd Moellmann committed
16 17 18 19 20 21 22

;; 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
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Gerd Moellmann's avatar
Gerd Moellmann committed
24 25 26 27 28

;;; Commentary:

;;; Code:

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

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

34
(defalias 'image-refresh 'image-flush)
Miles Bader's avatar
Miles Bader committed
35

36
(defconst image-type-header-regexps
37
  `(("\\`/[\t\n\r ]*\\*.*XPM.\\*/" . xpm)
38
    ("\\`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 44 45
    ("\\`[\t\n\r ]*#define \\([a-z0-9_]+\\)_width [0-9]+\n\
#define \\1_height [0-9]+\n\\(\
#define \\1_x_hot [0-9]+\n\
#define \\1_y_hot [0-9]+\n\\)?\
static \\(unsigned \\)?char \\1_bits" . xbm)
46 47
    ("\\`\\(?:MM\0\\*\\|II\\*\0\\)" . tiff)
    ("\\`[\t\n\r ]*%!PS" . postscript)
48
    ("\\`\xff\xd8" . jpeg)    ; used to be (image-jpeg-p . jpeg)
49 50 51 52 53 54 55 56
    (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
	     (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
	(concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
		comment-re "*"
		"\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?"
		"[Ss][Vv][Gg]"))
     . svg)
    )
57
  "Alist of (REGEXP . IMAGE-TYPE) pairs used to auto-detect image types.
Gerd Moellmann's avatar
Gerd Moellmann committed
58
When the first bytes of an image file match REGEXP, it is assumed to
59 60 61 62
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.")
63

64 65 66 67 68 69 70 71 72
(defconst image-type-file-name-regexps
  '(("\\.png\\'" . png)
    ("\\.gif\\'" . gif)
    ("\\.jpe?g\\'" . jpeg)
    ("\\.bmp\\'" . bmp)
    ("\\.xpm\\'" . xpm)
    ("\\.pbm\\'" . pbm)
    ("\\.xbm\\'" . xbm)
    ("\\.ps\\'" . postscript)
73 74 75
    ("\\.tiff?\\'" . tiff)
    ("\\.svgz?\\'" . svg)
    )
76 77 78 79
  "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.")

80 81 82
;; 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.
83 84
(defvar image-type-auto-detectable
  '((pbm . t)
85
    (xbm . nil)
86 87 88
    (bmp . maybe)
    (gif . maybe)
    (png . maybe)
89
    (xpm . nil)
90 91
    (jpeg . maybe)
    (tiff . maybe)
92
    (svg . maybe)
93 94 95 96 97 98 99 100 101
    (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').")
102

103 104 105
(defcustom image-load-path
  (list (file-name-as-directory (expand-file-name "images" data-directory))
        'data-directory 'load-path)
106
  "List of locations in which to search for image files.
107 108 109 110
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
111 112 113
value is used as a list of directories to search."
  :type '(repeat (choice directory variable))
  :initialize 'custom-initialize-delay)
114

115

116
(defun image-load-path-for-library (library image &optional path no-error)
117
  "Return a suitable search path for images used by LIBRARY.
118

119
It searches for IMAGE in `image-load-path' (excluding
120 121 122 123
\"`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\".
124

125 126
Then this function returns a list of directories which contains
first the directory in which IMAGE was found, followed by the
127
value of `load-path'.  If PATH is given, it is used instead of
128
`load-path'.
129

130
If NO-ERROR is non-nil and a suitable path can't be found, don't
131
signal an error.  Instead, return a list of directories as before,
132
except that nil appears in place of the image directory.
133 134 135 136 137

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

138 139
    ;; Shush compiler.
    (defvar image-load-path)
140 141

    (let* ((load-path (image-load-path-for-library \"mh-e\" \"mh-logo.xpm\"))
142 143 144
           (image-load-path (cons (car load-path)
                                  (when (boundp 'image-load-path)
                                    image-load-path))))
145
      (mh-tool-bar-folder-buttons-init))"
146 147
  (unless library (error "No library specified"))
  (unless image   (error "No image specified"))
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
  (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'.
171
    (cond
172 173 174 175 176 177
     ;; 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))
178 179 180 181 182 183 184 185 186
     ;; 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.
187 188 189
         d2ei (file-name-as-directory
               (expand-file-name
                (concat (file-name-directory library-name) "../../etc/images")))
190
         ;; Go down 1 level.
191 192 193
         d1ei (file-name-as-directory
               (expand-file-name
                (concat (file-name-directory library-name) "../etc/images"))))
194 195 196 197
        (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)))))
198 199 200
     ;; Use Emacs' image directory.
     (image-directory-load-path
      (setq image-directory image-directory-load-path))
201 202
     (no-error
      (message "Could not find image %s for library %s" image library))
203 204 205
     (t
      (error "Could not find image %s for library %s" image library)))

206 207 208 209
    ;; Return an augmented `path' or `load-path'.
    (nconc (list image-directory)
           (delete image-directory (copy-sequence (or path load-path))))))

210

211
(defun image-jpeg-p (data)
212 213
  "Value is non-nil if DATA, a string, consists of JFIF image data.
We accept the tag Exif because that is the same format."
214 215
  (setq data (ignore-errors (string-to-unibyte data)))
  (when (and data (string-match-p "\\`\xff\xd8" data))
216 217 218 219 220 221 222 223 224
    (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)
225 226 227
			   (aref data (+ i 2))))
		(code (aref data i)))
	    (when (and (>= code #xe0) (<= code #xef))
228
	      ;; APP0 LEN1 LEN2 "JFIF\0"
229
	      (throw 'jfif
230 231
		     (string-match-p "JFIF\\|Exif"
				     (substring data i (min (+ i nbytes) len)))))
232
	    (setq i (+ i 1 nbytes))))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
233 234 235


;;;###autoload
236 237 238
(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
239
be determined."
240
  (let ((types image-type-header-regexps)
Gerd Moellmann's avatar
Gerd Moellmann committed
241
	type)
242
    (while types
Gerd Moellmann's avatar
Gerd Moellmann committed
243
      (let ((regexp (car (car types)))
244
	    (image-type (cdr (car types))))
245
	(if (or (and (symbolp image-type)
246
		     (string-match-p regexp data))
247 248 249 250 251 252 253 254 255 256
		(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
257
(defun image-type-from-buffer ()
258
  "Determine the image type from data in the current buffer.
259 260
Value is a symbol specifying the image type or nil if type cannot
be determined."
261 262 263 264 265 266
  (let ((types image-type-header-regexps)
	type
	(opoint (point)))
    (goto-char (point-min))
    (while types
      (let ((regexp (car (car types)))
267
	    (image-type (cdr (car types)))
268 269
	    data)
	(if (or (and (symbolp image-type)
270
		     (looking-at-p regexp))
271 272 273 274 275 276 277 278 279
		(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))))
280
	    (setq type image-type
281 282 283
		  types nil)
	  (setq types (cdr types)))))
    (goto-char opoint)
Gerd Moellmann's avatar
Gerd Moellmann committed
284 285 286
    type))


287 288 289 290 291
;;;###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."
292 293 294 295 296 297 298 299
  (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)
300
	 (image-type-from-buffer))))
301 302 303 304 305 306 307


;;;###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."
308
  (assoc-default file image-type-file-name-regexps 'string-match-p))
309 310


Gerd Moellmann's avatar
Gerd Moellmann committed
311
;;;###autoload
312
(defun image-type (source &optional type data-p)
313
  "Determine and return image type.
314
SOURCE is an image file name or image data.
Gerd Moellmann's avatar
Gerd Moellmann committed
315
Optional TYPE is a symbol describing the image type.  If TYPE is omitted
316
or nil, try to determine the image type from its first few bytes
317
of image data.  If that doesn't work, and SOURCE is a file name,
318
use its file extension as image type.
319 320 321
Optional DATA-P non-nil means SOURCE is a string containing image data."
  (when (and (not data-p) (not (stringp source)))
    (error "Invalid image file name `%s'" source))
322
  (unless type
323 324 325 326 327
    (setq type (if data-p
		   (image-type-from-data source)
		 (or (image-type-from-file-header source)
		     (image-type-from-file-name source))))
    (or type (error "Cannot determine image type")))
328
  (or (memq type (and (boundp 'image-types) image-types))
329
      (error "Invalid image type `%s'" type))
330 331
  type)

332

333 334
(defvar image-library-alist)

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
;;;###autoload
(defun image-type-auto-detected-p ()
345
  "Return t if the current buffer contains an auto-detectable image.
346 347 348 349
This function is intended to be used from `magic-fallback-mode-alist'.

The buffer is considered to contain an auto-detectable image if
its beginning matches an image type in `image-type-header-regexps',
350 351 352
and that image type is present in `image-type-auto-detectable' with a
non-nil value.  If that value is non-nil, but not t, then the image type
must be available."
353 354
  (let* ((type (image-type-from-buffer))
	 (auto (and type (cdr (assq type image-type-auto-detectable)))))
355
    (and auto
356
	 (or (eq auto t) (image-type-available-p type)))))
357 358


359 360 361 362 363 364 365 366 367 368 369 370 371
;;;###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.

Glenn Morris's avatar
Glenn Morris committed
372 373 374 375 376 377
Images should not be larger than specified by `max-image-size'.

Image file names that are not absolute are searched for in the
\"images\" sub-directory of `data-directory' and
`x-bitmap-file-path' (in that order)."
  ;; It is x_find_image_file in image.c that sets the search path.
378
  (setq type (image-type file-or-data type data-p))
Gerd Moellmann's avatar
Gerd Moellmann committed
379
  (when (image-type-available-p type)
380 381
    (append (list 'image :type type (if data-p :data :file) file-or-data)
	    props)))
Gerd Moellmann's avatar
Gerd Moellmann committed
382 383 384


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


;;;###autoload
411
(defun insert-image (image &optional string area slice)
Gerd Moellmann's avatar
Gerd Moellmann committed
412
  "Insert IMAGE into current buffer at point.
413
IMAGE is displayed by inserting STRING into the current buffer
414 415
with a `display' property whose value is the image.  STRING is
defaulted if you omit it.
Gerd Moellmann's avatar
Gerd Moellmann committed
416 417 418
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'
419 420 421 422 423 424
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."
425 426 427
  ;; Use a space as least likely to cause trouble when it's a hidden
  ;; character in the buffer.
  (unless string (setq string " "))
428
  (unless (eq (car-safe image) 'image)
Gerd Moellmann's avatar
Gerd Moellmann committed
429 430 431
    (error "Not an image: %s" image))
  (unless (or (null area) (memq area '(left-margin right-margin)))
    (error "Invalid area %s" area))
432 433 434 435 436 437 438 439 440
  (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))))
441 442 443
  (let ((start (point)))
    (insert string)
    (add-text-properties start (point)
444 445 446 447 448
			 `(display ,(if slice
					(list (cons 'slice slice) image)
				      image) rear-nonsticky (display)))))


449
;;;###autoload
450
(defun insert-sliced-image (image &optional string area rows cols)
451 452 453 454 455 456 457 458
  "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.
459
The image is automatically split into ROWS x COLS slices."
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
  (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))
486
      (insert (propertize "\n" 'line-height t)))))
487

488

Gerd Moellmann's avatar
Gerd Moellmann committed
489 490 491 492 493 494 495 496 497 498 499 500

;;;###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)
501 502
	  (delete-overlay overlay)))
      (setq overlays (cdr overlays)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
503

504 505 506 507
(defun image-search-load-path (file &optional path)
  (unless path
    (setq path image-load-path))
  (let (element found filename)
508
    (while (and (not found) (consp path))
509
      (setq element (car path))
510
      (cond
511
       ((stringp element)
512 513
	(setq found
	      (file-readable-p
514
	       (setq filename (expand-file-name file element)))))
515 516 517 518 519 520
       ((and (symbolp element) (boundp element))
	(setq element (symbol-value element))
	(cond
	 ((stringp element)
	  (setq found
		(file-readable-p
521
		 (setq filename (expand-file-name file element)))))
522
	 ((consp element)
523
	  (if (setq filename (image-search-load-path file element))
524
	      (setq found t))))))
525
      (setq path (cdr path)))
526
    (if found filename)))
Gerd Moellmann's avatar
Gerd Moellmann committed
527 528

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

532
SPECS is a list of image specifications.
Gerd Moellmann's avatar
Gerd Moellmann committed
533 534 535

Each image specification in SPECS is a property list.  The contents of
a specification are image type dependent.  All specifications must at
536 537 538
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
539 540 541 542 543
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.

544 545 546
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
547 548 549 550
  (let (image)
    (while (and specs (null image))
      (let* ((spec (car specs))
	     (type (plist-get spec :type))
551
	     (data (plist-get spec :data))
552 553
	     (file (plist-get spec :file))
	     found)
554 555
	(when (image-type-available-p type)
	  (cond ((stringp file)
556
		 (if (setq found (image-search-load-path file))
557 558 559
		     (setq image
			   (cons 'image (plist-put (copy-sequence spec)
						   :file found)))))
560
		((not (null data))
561 562
		 (setq image (cons 'image spec)))))
	(setq specs (cdr specs))))
Gerd Moellmann's avatar
Gerd Moellmann committed
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
    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\")))"
586
  (declare (doc-string 3))
Gerd Moellmann's avatar
Gerd Moellmann committed
587
  `(defvar ,symbol (find-image ',specs) ,doc))
Gerd Moellmann's avatar
Gerd Moellmann committed
588

Kim F. Storm's avatar
Kim F. Storm committed
589 590

;;; Animated image API
Gerd Moellmann's avatar
Gerd Moellmann committed
591

Kim F. Storm's avatar
Kim F. Storm committed
592 593 594
(defcustom image-animate-max-time 30
  "Time in seconds to animate images."
  :type 'integer
595
  :version "24.1"
Kim F. Storm's avatar
Kim F. Storm committed
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
  :group 'image)

(defconst image-animated-types '(gif)
  "List of supported animated image types.")

;;;###autoload
(defun create-animated-image (file-or-data &optional type data-p &rest props)
  "Create an animated 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))
  (when (image-type-available-p type)
    (let* ((animate (memq type image-animated-types))
	   (image
	    (append (list 'image :type type (if data-p :data :file) file-or-data)
620
		    (if animate '(:index 0))
Kim F. Storm's avatar
Kim F. Storm committed
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
		    props)))
      (if animate
	  (image-animate-start image))
      image)))

(defun image-animate-timer (image)
  "Return the animation timer for image IMAGE."
  ;; See cancel-function-timers
  (let ((tail timer-list) timer)
    (while tail
      (setq timer (car tail)
	    tail (cdr tail))
      (if (and (eq (aref timer 5) #'image-animate-timeout)
	       (consp (aref timer 6))
	       (eq (car (aref timer 6)) image))
	  (setq tail nil)
	(setq timer nil)))
    timer))

(defun image-animate-start (image &optional max-time)
  "Start animation of image IMAGE.
Optional second arg MAX-TIME is number of seconds to animate image,
or t to animate infinitely."
  (let ((anim (image-animated-p image))
	timer tmo)
    (when anim
      (if (setq timer (image-animate-timer image))
	  (setcar (nthcdr 3 (aref timer 6)) max-time)
	(setq tmo (* (cdr anim) 0.01))
	(setq max-time (or max-time image-animate-max-time))
	(run-with-timer tmo nil #'image-animate-timeout
			image 1 (car anim)
			(if (numberp max-time)
			    (- max-time tmo)
			  max-time))))))

(defun image-animate-stop (image)
  "Stop animation of image."
  (let ((timer (image-animate-timer image)))
    (when timer
      (cancel-timer timer))))

(defun image-animate-timeout (image ino count time-left)
  (if (>= ino count)
      (setq ino 0))
  (plist-put (cdr image) :index ino)
  (force-window-update)
  (let ((anim (image-animated-p image)) tmo)
    (when anim
      (setq tmo (* (cdr anim) 0.01))
      (unless (and (= ino 0) (numberp time-left) (< time-left tmo))
	(run-with-timer tmo nil #'image-animate-timeout
			image (1+ ino) count
			(if (numberp time-left)
			    (- time-left tmo)
			  time-left))))))

(defun image-animated-p (image)
  "Return non-nil if image is animated.
Actually, return value is a cons (IMAGES . DELAY) where IMAGES
is the number of sub-images in the animated image, and DELAY
is the delay in 100ths of a second until the next sub-image
shall be displayed."
  (cond
   ((eq (plist-get (cdr image) :type) 'gif)
686 687 688
    (let* ((metadata (image-metadata image))
	   (images (plist-get metadata 'count))
	   (extdata (plist-get metadata 'extension-data))
689 690 691 692 693 694 695
	   (anim (plist-get extdata #xF9))
	   (tmo (and (integerp images) (> images 1)
		     (stringp anim) (>= (length anim) 4)
		     (+ (aref anim 1) (* (aref anim 2) 256)))))
      (when tmo
	(if (eq tmo 0) (setq tmo 10))
	(cons images tmo))))))
Kim F. Storm's avatar
Kim F. Storm committed
696 697


698 699
(defcustom imagemagick-types-inhibit
  '(C HTML HTM TXT PDF)
Glenn Morris's avatar
Glenn Morris committed
700 701 702 703 704 705 706 707
  ;; FIXME what are the possible options?
  ;; Are these actually file-name extensions?
  ;; Why are these upper-case when eg image-types is lower-case?
  "Types the ImageMagick loader should not try to handle."
  :type '(choice (const :tag "Let ImageMagick handle all the types it can" nil)
		 (repeat symbol))
  :version "24.1"
  :group 'image)
708 709

;;;###autoload
Joakim Verona's avatar
Joakim Verona committed
710
(defun imagemagick-register-types ()
Glenn Morris's avatar
Glenn Morris committed
711
  "Register the file types that ImageMagick is able to handle."
712
  (let ((im-types (imagemagick-types)))
713
    (dolist (im-inhibit imagemagick-types-inhibit)
714
      (setq im-types (remove im-inhibit im-types)))
715
    (dolist (im-type im-types)
716
      (let ((extension (downcase (symbol-name im-type))))
717
	(push
Glenn Morris's avatar
Glenn Morris committed
718
	 (cons (concat "\\." extension "\\'") 'image-mode)
719 720
	 auto-mode-alist)
	(push
Glenn Morris's avatar
Glenn Morris committed
721
	 (cons (concat "\\." extension "\\'") 'imagemagick)
722
	 image-type-file-name-regexps)))))
723

724 725 726 727 728 729 730 731 732 733 734 735 736 737

;;; Inline stock images

(defvar image-checkbox-checked
  (create-image "\300\300\141\143\067\076\034\030"
		'xbm t :width 8 :height 8 :background "grey75"
		:foreground "black" :relief -2 :ascent 'center)
  "Image of a checked checkbox.")

(defvar image-checkbox-unchecked
  (create-image (make-string 8 0)
		'xbm t :width 8 :height 8 :background "grey75"
		:foreground "black" :relief -2 :ascent 'center)
  "Image of an unchecked checkbox.")
738

Gerd Moellmann's avatar
Gerd Moellmann committed
739 740
(provide 'image)

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