;;; image.el --- image API
-;; Copyright (C) 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
+;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003,
+;; 2004, 2005, 2006 Free Software Foundation, Inc.
+
+;; Maintainer: FSF
;; Keywords: multimedia
;; This file is part of GNU Emacs.
;; 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.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
;;; Commentary:
:group 'multimedia)
-(defconst image-type-regexps
+(defconst image-type-header-regexps
'(("\\`/[\t\n\r ]*\\*.*XPM.\\*/" . xpm)
("\\`P[1-6]" . pbm)
("\\`GIF8" . gif)
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 ")
+a non-nil value, TYPE is the image's type.")
+
+(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.")
+
+
+(defvar image-load-path nil
+ "List of locations in which to search for image files.
+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.")
+
+(eval-at-startup
+ (setq image-load-path
+ (list (file-name-as-directory (expand-file-name "images" data-directory))
+ 'data-directory 'load-path)))
+
+
+(defun image-load-path-for-library (library image &optional path no-error)
+ "Return a suitable search path for images used by LIBRARY.
+
+It searches for IMAGE in `image-load-path' (excluding
+\"`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\".
+
+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'.
+
+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.
+
+Here is an example that uses a common idiom to provide
+compatibility with versions of Emacs that lack the variable
+`image-load-path':
+
+ ;; Shush compiler.
+ (defvar image-load-path)
+
+ (let* ((load-path (image-load-path-for-library \"mh-e\" \"mh-logo.xpm\"))
+ (image-load-path (cons (car load-path)
+ (when (boundp 'image-load-path)
+ image-load-path))))
+ (mh-tool-bar-folder-buttons-init))"
+ (unless library (error "No library specified"))
+ (unless image (error "No image specified"))
+ (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'.
+ (cond
+ ;; 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))
+ ;; 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.
+ d2ei (file-name-as-directory
+ (expand-file-name
+ (concat (file-name-directory library-name) "../../etc/images")))
+ ;; Go down 1 level.
+ d1ei (file-name-as-directory
+ (expand-file-name
+ (concat (file-name-directory library-name) "../etc/images"))))
+ (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)))))
+ ;; Use Emacs' image directory.
+ (image-directory-load-path
+ (setq image-directory image-directory-load-path))
+ (no-error
+ (message "Could not find image %s for library %s" image library))
+ (t
+ (error "Could not find image %s for library %s" image library)))
+
+ ;; Return an augmented `path' or `load-path'.
+ (nconc (list image-directory)
+ (delete image-directory (copy-sequence (or path load-path))))))
(defun image-jpeg-p (data)
- "Value is non-nil if DATA, a string, consists of JFIF image data."
+ "Value is non-nil if DATA, a string, consists of JFIF image data.
+We accept the tag Exif because that is the same format."
(when (string-match "\\`\xff\xd8" data)
(catch 'jfif
(let ((len (length data)) (i 2))
(code (aref data i)))
(when (and (>= code #xe0) (<= code #xef))
;; APP0 LEN1 LEN2 "JFIF\0"
- (throw 'jfif
- (string-match "JFIF" (substring data i (+ i nbytes)))))
+ (throw 'jfif
+ (string-match "JFIF\\|Exif"
+ (substring data i (min (+ i nbytes) len)))))
(setq i (+ i 1 nbytes))))))))
"Determine the image type from image data DATA.
Value is a symbol specifying the image type or nil if type cannot
be determined."
- (let ((types image-type-regexps)
+ (let ((types image-type-header-regexps)
type)
- (while (and types (null type))
+ (while types
(let ((regexp (car (car types)))
(image-type (cdr (car types))))
- (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))))
- (setq type image-type))
- (setq types (cdr types))))
+ (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
+(defun image-type-from-buffer ()
+ "Determine the image type from data in the current buffer.
+Value is a symbol specifying the image type or nil if type cannot
+be determined."
+ (let ((types image-type-header-regexps)
+ type
+ (opoint (point)))
+ (goto-char (point-min))
+ (while types
+ (let ((regexp (car (car types)))
+ (image-type (cdr (car types)))
+ 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))))
+ (setq type image-type
+ types nil)
+ (setq types (cdr types)))))
+ (goto-char opoint)
type))
"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)))
+ (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)
+ (image-type-from-buffer))))
;;;###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'."
- (and (boundp 'image-types) (not (null (memq type image-types)))))
+(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))
;;;###autoload
-(defun create-image (file-or-data &optional type data-p &rest props)
- "Create an image.
+(defun image-type (file-or-data &optional type data-p)
+ "Determine and return image type.
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."
+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)
(error "Cannot determine image type"))
(unless (symbolp type)
(error "Invalid image type `%s'" type))
+ type)
+
+;;;###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)))
+
+
+;;;###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))
(when (image-type-available-p type)
(append (list 'image :type type (if data-p :data :file) file-or-data)
props)))
;;;###autoload
-(defun insert-image (image &optional string area)
+(defun insert-image (image &optional string area slice)
"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
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."
+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."
;; Use a space as least likely to cause trouble when it's a hidden
;; character in the buffer.
(unless string (setq string " "))
(let ((start (point)))
(insert string)
(add-text-properties start (point)
- (list 'display image
- ;; `image' has the right properties to
- ;; mark an intangible field.
- 'intangible image
- 'rear-nonsticky (list 'display)))))
+ `(display ,(if slice
+ (list (cons 'slice slice) image)
+ image) rear-nonsticky (display)))))
+
+
+;;;###autoload
+(defun insert-sliced-image (image &optional string area rows cols)
+ "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."
+ (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))
+ (insert (propertize "\n" 'line-height t)))))
+
;;;###autoload
(delete-overlay overlay)))
(setq overlays (cdr overlays)))))
+(defun image-search-load-path (file &optional path)
+ (unless path
+ (setq path image-load-path))
+ (let (element found filename)
+ (while (and (not found) (consp path))
+ (setq element (car path))
+ (cond
+ ((stringp element)
+ (setq found
+ (file-readable-p
+ (setq filename (expand-file-name file element)))))
+ ((and (symbolp element) (boundp element))
+ (setq element (symbol-value element))
+ (cond
+ ((stringp element)
+ (setq found
+ (file-readable-p
+ (setq filename (expand-file-name file element)))))
+ ((consp element)
+ (if (setq filename (image-search-load-path file element))
+ (setq found t))))))
+ (setq path (cdr path)))
+ (if found filename)))
;;;###autoload
(defun find-image (specs)
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'."
+The image is looked for in `image-load-path'.
+
+Image files should not be larger than specified by `max-image-size'."
(let (image)
(while (and specs (null image))
(let* ((spec (car specs))
found)
(when (image-type-available-p type)
(cond ((stringp file)
- (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
- (let ((try-file (expand-file-name file data-directory)))
- (if (file-readable-p try-file)
- (setq found try-file))))
- (if found
- (setq image
- (cons 'image (plist-put (copy-sequence spec)
- :file found))))))
+ (if (setq found (image-search-load-path file))
+ (setq image
+ (cons 'image (plist-put (copy-sequence spec)
+ :file found)))))
((not (null data))
(setq image (cons 'image spec)))))
(setq specs (cdr specs))))
(defimage test-image ((:type xpm :file \"~/test1.xpm\")
(:type xbm :file \"~/test1.xbm\")))"
+ (declare (doc-string 3))
`(defvar ,symbol (find-image ',specs) ,doc))
(provide 'image)
+;; arch-tag: 8e76a07b-eb48-4f3e-a7a0-1a7ba9f096b3
;;; image.el ends here