;;; image.el --- image API
;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003,
-;; 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
+;; 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
;; Maintainer: FSF
;; Keywords: multimedia
;; 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)
+;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
(defconst image-type-header-regexps
- '(("\\`/[\t\n\r ]*\\*.*XPM.\\*/" . xpm)
+ `(("\\`/[\t\n\r ]*\\*.*XPM.\\*/" . xpm)
("\\`P[1-6][[:space:]]+\\(?:#.*[[:space:]]+\\)*[0-9]+[[:space:]]+[0-9]+" . pbm)
("\\`GIF8[79]a" . gif)
("\\`\x89PNG\r\n\x1a\n" . png)
static char \\1_bits" . xbm)
("\\`\\(?:MM\0\\*\\|II\\*\0\\)" . tiff)
("\\`[\t\n\r ]*%!PS" . postscript)
- ("\\`\xff\xd8" . (image-jpeg-p . jpeg)))
+ ("\\`\xff\xd8" . (image-jpeg-p . jpeg))
+ (,(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)
+ )
"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 if IMAGE-TYPE is a symbol. If not a symbol,
("\\.pbm\\'" . pbm)
("\\.xbm\\'" . xbm)
("\\.ps\\'" . postscript)
- ("\\.tiff?\\'" . tiff))
+ ("\\.tiff?\\'" . tiff)
+ ("\\.svgz?\\'" . svg)
+ )
"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.")
(xpm . nil)
(jpeg . maybe)
(tiff . maybe)
+ (svg . maybe)
(postscript . nil))
"Alist of (IMAGE-TYPE . AUTODETECT) pairs used to auto-detect image files.
\(See `image-type-auto-detected-p').
"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))
+ (assoc-default file image-type-file-name-regexps 'string-match))
;;;###autoload
-(defun image-type (file-or-data &optional type data-p)
+(defun image-type (source &optional type data-p)
"Determine and return image type.
-FILE-OR-DATA is an image file name or image data.
+SOURCE 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,
+of image data. If that doesn't work, and SOURCE 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."
- (when (and (not data-p) (not (stringp file-or-data)))
- (error "Invalid image file name `%s'" file-or-data))
- (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)))))
+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))
(unless type
- (error "Cannot determine image type"))
- (unless (symbolp type)
- (error "Invalid image type `%s'" type))
+ (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")))
+ (or (memq type (and (boundp 'image-types) image-types))
+ (error "Invalid image type `%s'" type))
type)
;;;###autoload
(defun image-type-auto-detected-p ()
- "Return t iff the current buffer contains an auto-detectable image.
-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."
+ "Return t if the current buffer contains an auto-detectable image.
+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',
+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."
(let* ((type (image-type-from-buffer))
(auto (and type (cdr (assq type image-type-auto-detectable)))))
(and auto
- (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))))))
+ (or (eq auto t) (image-type-available-p type)))))
;;;###autoload
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'."
+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.
(setq type (image-type file-or-data type data-p))
(when (image-type-available-p type)
(append (list 'image :type type (if data-p :data :file) file-or-data)