Mercurial > emacs
annotate lisp/image.el @ 109434:a11596ec5941
Merge from mainline.
author | Katsumi Yamaoka <yamaoka@jpl.org> |
---|---|
date | Wed, 14 Jul 2010 22:46:23 +0000 |
parents | 6c819187f088 |
children | 5883fc00b976 68616bb3ae25 |
rev | line source |
---|---|
25003 | 1 ;;; image.el --- image API |
2 | |
107369
f2fb364fb3ba
Minor animated image housekeeping.
Glenn Morris <rgm@gnu.org>
parents:
107360
diff
changeset
|
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, |
f2fb364fb3ba
Minor animated image housekeeping.
Glenn Morris <rgm@gnu.org>
parents:
107360
diff
changeset
|
4 ;; 2007, 2008, 2009, 2010 Free Software Foundation, Inc. |
42316 | 5 |
6 ;; Maintainer: FSF | |
25309 | 7 ;; Keywords: multimedia |
25003 | 8 |
9 ;; This file is part of GNU Emacs. | |
10 | |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
11 ;; GNU Emacs is free software: you can redistribute it and/or modify |
25003 | 12 ;; it under the terms of the GNU General Public License as published by |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
13 ;; the Free Software Foundation, either version 3 of the License, or |
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
14 ;; (at your option) any later version. |
25003 | 15 |
16 ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 ;; GNU General Public License for more details. | |
20 | |
21 ;; You should have received a copy of the GNU General Public License | |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
87649
diff
changeset
|
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
25003 | 23 |
24 ;;; Commentary: | |
25 | |
26 ;;; Code: | |
27 | |
32166 | 28 |
29 (defgroup image () | |
30 "Image support." | |
31 :group 'multimedia) | |
32 | |
108746
24d486687f54
Rename image-refresh to image-flush.
Chong Yidong <cyd@stupidchicken.com>
parents:
107719
diff
changeset
|
33 (defalias 'image-refresh 'image-flush) |
32166 | 34 |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
35 (defconst image-type-header-regexps |
82835
de6e597c221b
(image-type-header-regexps): Use more complex regexp for svg.
Juri Linkov <juri@jurta.org>
parents:
82734
diff
changeset
|
36 `(("\\`/[\t\n\r ]*\\*.*XPM.\\*/" . xpm) |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
37 ("\\`P[1-6][[:space:]]+\\(?:#.*[[:space:]]+\\)*[0-9]+[[:space:]]+[0-9]+" . pbm) |
75472
ad8f4e060e53
(image-type-header-regexps): Make GIF regex more specific.
Richard M. Stallman <rms@gnu.org>
parents:
75347
diff
changeset
|
38 ("\\`GIF8[79]a" . gif) |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
39 ("\\`\x89PNG\r\n\x1a\n" . png) |
99876
e8248a7b666d
(image-type-header-regexps): Recognize more xbm format
Andreas Schwab <schwab@suse.de>
parents:
96380
diff
changeset
|
40 ("\\`[\t\n\r ]*#define \\([a-z0-9_]+\\)_width [0-9]+\n\ |
e8248a7b666d
(image-type-header-regexps): Recognize more xbm format
Andreas Schwab <schwab@suse.de>
parents:
96380
diff
changeset
|
41 #define \\1_height [0-9]+\n\\(\ |
e8248a7b666d
(image-type-header-regexps): Recognize more xbm format
Andreas Schwab <schwab@suse.de>
parents:
96380
diff
changeset
|
42 #define \\1_x_hot [0-9]+\n\ |
e8248a7b666d
(image-type-header-regexps): Recognize more xbm format
Andreas Schwab <schwab@suse.de>
parents:
96380
diff
changeset
|
43 #define \\1_y_hot [0-9]+\n\\)?\ |
e8248a7b666d
(image-type-header-regexps): Recognize more xbm format
Andreas Schwab <schwab@suse.de>
parents:
96380
diff
changeset
|
44 static \\(unsigned \\)?char \\1_bits" . xbm) |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
45 ("\\`\\(?:MM\0\\*\\|II\\*\0\\)" . tiff) |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
46 ("\\`[\t\n\r ]*%!PS" . postscript) |
104690
d3d94e331386
(image-type-header-regexps): Use only JPEG magic number
Juri Linkov <juri@jurta.org>
parents:
102236
diff
changeset
|
47 ("\\`\xff\xd8" . jpeg) ; used to be (image-jpeg-p . jpeg) |
82835
de6e597c221b
(image-type-header-regexps): Use more complex regexp for svg.
Juri Linkov <juri@jurta.org>
parents:
82734
diff
changeset
|
48 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)") |
de6e597c221b
(image-type-header-regexps): Use more complex regexp for svg.
Juri Linkov <juri@jurta.org>
parents:
82734
diff
changeset
|
49 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)"))) |
de6e597c221b
(image-type-header-regexps): Use more complex regexp for svg.
Juri Linkov <juri@jurta.org>
parents:
82734
diff
changeset
|
50 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<" |
de6e597c221b
(image-type-header-regexps): Use more complex regexp for svg.
Juri Linkov <juri@jurta.org>
parents:
82734
diff
changeset
|
51 comment-re "*" |
de6e597c221b
(image-type-header-regexps): Use more complex regexp for svg.
Juri Linkov <juri@jurta.org>
parents:
82734
diff
changeset
|
52 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?" |
de6e597c221b
(image-type-header-regexps): Use more complex regexp for svg.
Juri Linkov <juri@jurta.org>
parents:
82734
diff
changeset
|
53 "[Ss][Vv][Gg]")) |
de6e597c221b
(image-type-header-regexps): Use more complex regexp for svg.
Juri Linkov <juri@jurta.org>
parents:
82734
diff
changeset
|
54 . svg) |
de6e597c221b
(image-type-header-regexps): Use more complex regexp for svg.
Juri Linkov <juri@jurta.org>
parents:
82734
diff
changeset
|
55 ) |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
56 "Alist of (REGEXP . IMAGE-TYPE) pairs used to auto-detect image types. |
25003 | 57 When the first bytes of an image file match REGEXP, it is assumed to |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
58 be of image type IMAGE-TYPE if IMAGE-TYPE is a symbol. If not a symbol, |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
59 IMAGE-TYPE must be a pair (PREDICATE . TYPE). PREDICATE is called |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
60 with one argument, a string containing the image data. If PREDICATE returns |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
61 a non-nil value, TYPE is the image's type.") |
38732
24fe4f884e82
(image-type-regexps): Allow predicates. Change the way
Gerd Moellmann <gerd@gnu.org>
parents:
38711
diff
changeset
|
62 |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
63 (defconst image-type-file-name-regexps |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
64 '(("\\.png\\'" . png) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
65 ("\\.gif\\'" . gif) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
66 ("\\.jpe?g\\'" . jpeg) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
67 ("\\.bmp\\'" . bmp) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
68 ("\\.xpm\\'" . xpm) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
69 ("\\.pbm\\'" . pbm) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
70 ("\\.xbm\\'" . xbm) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
71 ("\\.ps\\'" . postscript) |
82835
de6e597c221b
(image-type-header-regexps): Use more complex regexp for svg.
Juri Linkov <juri@jurta.org>
parents:
82734
diff
changeset
|
72 ("\\.tiff?\\'" . tiff) |
de6e597c221b
(image-type-header-regexps): Use more complex regexp for svg.
Juri Linkov <juri@jurta.org>
parents:
82734
diff
changeset
|
73 ("\\.svgz?\\'" . svg) |
de6e597c221b
(image-type-header-regexps): Use more complex regexp for svg.
Juri Linkov <juri@jurta.org>
parents:
82734
diff
changeset
|
74 ) |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
75 "Alist of (REGEXP . IMAGE-TYPE) pairs used to identify image files. |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
76 When the name of an image file match REGEXP, it is assumed to |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
77 be of image type IMAGE-TYPE.") |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
78 |
75744
53fa6ea37e3a
(image-type-auto-detectable): Don't autodetect x[pb]m.
Chong Yidong <cyd@stupidchicken.com>
parents:
75472
diff
changeset
|
79 ;; We rely on `auto-mode-alist' to detect xbm and xpm files, instead |
53fa6ea37e3a
(image-type-auto-detectable): Don't autodetect x[pb]m.
Chong Yidong <cyd@stupidchicken.com>
parents:
75472
diff
changeset
|
80 ;; of content autodetection. Their contents are just C code, so it is |
53fa6ea37e3a
(image-type-auto-detectable): Don't autodetect x[pb]m.
Chong Yidong <cyd@stupidchicken.com>
parents:
75472
diff
changeset
|
81 ;; easy to generate false matches. |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
82 (defvar image-type-auto-detectable |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
83 '((pbm . t) |
75744
53fa6ea37e3a
(image-type-auto-detectable): Don't autodetect x[pb]m.
Chong Yidong <cyd@stupidchicken.com>
parents:
75472
diff
changeset
|
84 (xbm . nil) |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
85 (bmp . maybe) |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
86 (gif . maybe) |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
87 (png . maybe) |
75744
53fa6ea37e3a
(image-type-auto-detectable): Don't autodetect x[pb]m.
Chong Yidong <cyd@stupidchicken.com>
parents:
75472
diff
changeset
|
88 (xpm . nil) |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
89 (jpeg . maybe) |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
90 (tiff . maybe) |
82835
de6e597c221b
(image-type-header-regexps): Use more complex regexp for svg.
Juri Linkov <juri@jurta.org>
parents:
82734
diff
changeset
|
91 (svg . maybe) |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
92 (postscript . nil)) |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
93 "Alist of (IMAGE-TYPE . AUTODETECT) pairs used to auto-detect image files. |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
94 \(See `image-type-auto-detected-p'). |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
95 |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
96 AUTODETECT can be |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
97 - t always auto-detect. |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
98 - nil never auto-detect. |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
99 - maybe auto-detect only if the image type is available |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
100 (see `image-type-available-p').") |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
101 |
104978
a4c2188bd87d
* startup.el (tutorial-directory): Make it a defcustom.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
104690
diff
changeset
|
102 (defcustom image-load-path |
a4c2188bd87d
* startup.el (tutorial-directory): Make it a defcustom.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
104690
diff
changeset
|
103 (list (file-name-as-directory (expand-file-name "images" data-directory)) |
a4c2188bd87d
* startup.el (tutorial-directory): Make it a defcustom.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
104690
diff
changeset
|
104 'data-directory 'load-path) |
65544
78d74ef1436b
2005-09-15 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
64762
diff
changeset
|
105 "List of locations in which to search for image files. |
65599
39114a2ae201
(image-load-path): Use symbol `data-directory' instead of its value,
Chong Yidong <cyd@stupidchicken.com>
parents:
65544
diff
changeset
|
106 If an element is a string, it defines a directory to search. |
39114a2ae201
(image-load-path): Use symbol `data-directory' instead of its value,
Chong Yidong <cyd@stupidchicken.com>
parents:
65544
diff
changeset
|
107 If an element is a variable symbol whose value is a string, that |
39114a2ae201
(image-load-path): Use symbol `data-directory' instead of its value,
Chong Yidong <cyd@stupidchicken.com>
parents:
65544
diff
changeset
|
108 value defines a directory to search. |
39114a2ae201
(image-load-path): Use symbol `data-directory' instead of its value,
Chong Yidong <cyd@stupidchicken.com>
parents:
65544
diff
changeset
|
109 If an element is a variable symbol whose value is a list, the |
104978
a4c2188bd87d
* startup.el (tutorial-directory): Make it a defcustom.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
104690
diff
changeset
|
110 value is used as a list of directories to search." |
a4c2188bd87d
* startup.el (tutorial-directory): Make it a defcustom.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
104690
diff
changeset
|
111 :type '(repeat (choice directory variable)) |
a4c2188bd87d
* startup.el (tutorial-directory): Make it a defcustom.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
104690
diff
changeset
|
112 :initialize 'custom-initialize-delay) |
66307
ca953a3dbdf1
(image-load-path): Use eval-at-startup to initialize.
Richard M. Stallman <rms@gnu.org>
parents:
66296
diff
changeset
|
113 |
69471
6f07bf99b6f8
(image-load-path-for-library): Pass value of path rather than symbol.
Bill Wohler <wohler@newt.com>
parents:
69365
diff
changeset
|
114 |
69365
0a2d89023fde
(image-load-path-for-library): Merged changes from Reiner. Add
Bill Wohler <wohler@newt.com>
parents:
69360
diff
changeset
|
115 (defun image-load-path-for-library (library image &optional path no-error) |
69569
dd7f85a6af09
(image-load-path-for-library): Shorten first line in docstring.
Bill Wohler <wohler@newt.com>
parents:
69535
diff
changeset
|
116 "Return a suitable search path for images used by LIBRARY. |
69360
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
117 |
69535
3feef8dfbff5
(image-load-path-for-library): Minor docstring fix.
Bill Wohler <wohler@newt.com>
parents:
69516
diff
changeset
|
118 It searches for IMAGE in `image-load-path' (excluding |
69516
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
119 \"`data-directory'/images\") and `load-path', followed by a path |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
120 suitable for LIBRARY, which includes \"../../etc/images\" and |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
121 \"../etc/images\" relative to the library file itself, and then |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
122 in \"`data-directory'/images\". |
69360
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
123 |
69471
6f07bf99b6f8
(image-load-path-for-library): Pass value of path rather than symbol.
Bill Wohler <wohler@newt.com>
parents:
69365
diff
changeset
|
124 Then this function returns a list of directories which contains |
6f07bf99b6f8
(image-load-path-for-library): Pass value of path rather than symbol.
Bill Wohler <wohler@newt.com>
parents:
69365
diff
changeset
|
125 first the directory in which IMAGE was found, followed by the |
102236
eeef2e7e9171
* image.el (image-load-path-for-library, insert-sliced-image):
Juanma Barranquero <lekktu@gmail.com>
parents:
100908
diff
changeset
|
126 value of `load-path'. If PATH is given, it is used instead of |
69471
6f07bf99b6f8
(image-load-path-for-library): Pass value of path rather than symbol.
Bill Wohler <wohler@newt.com>
parents:
69365
diff
changeset
|
127 `load-path'. |
69365
0a2d89023fde
(image-load-path-for-library): Merged changes from Reiner. Add
Bill Wohler <wohler@newt.com>
parents:
69360
diff
changeset
|
128 |
69471
6f07bf99b6f8
(image-load-path-for-library): Pass value of path rather than symbol.
Bill Wohler <wohler@newt.com>
parents:
69365
diff
changeset
|
129 If NO-ERROR is non-nil and a suitable path can't be found, don't |
102236
eeef2e7e9171
* image.el (image-load-path-for-library, insert-sliced-image):
Juanma Barranquero <lekktu@gmail.com>
parents:
100908
diff
changeset
|
130 signal an error. Instead, return a list of directories as before, |
69471
6f07bf99b6f8
(image-load-path-for-library): Pass value of path rather than symbol.
Bill Wohler <wohler@newt.com>
parents:
69365
diff
changeset
|
131 except that nil appears in place of the image directory. |
69360
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
132 |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
133 Here is an example that uses a common idiom to provide |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
134 compatibility with versions of Emacs that lack the variable |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
135 `image-load-path': |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
136 |
69493
4f9233243d97
(image-load-path-for-library): Fix example by not recommending that
Bill Wohler <wohler@newt.com>
parents:
69471
diff
changeset
|
137 ;; Shush compiler. |
4f9233243d97
(image-load-path-for-library): Fix example by not recommending that
Bill Wohler <wohler@newt.com>
parents:
69471
diff
changeset
|
138 (defvar image-load-path) |
69471
6f07bf99b6f8
(image-load-path-for-library): Pass value of path rather than symbol.
Bill Wohler <wohler@newt.com>
parents:
69365
diff
changeset
|
139 |
6f07bf99b6f8
(image-load-path-for-library): Pass value of path rather than symbol.
Bill Wohler <wohler@newt.com>
parents:
69365
diff
changeset
|
140 (let* ((load-path (image-load-path-for-library \"mh-e\" \"mh-logo.xpm\")) |
69493
4f9233243d97
(image-load-path-for-library): Fix example by not recommending that
Bill Wohler <wohler@newt.com>
parents:
69471
diff
changeset
|
141 (image-load-path (cons (car load-path) |
4f9233243d97
(image-load-path-for-library): Fix example by not recommending that
Bill Wohler <wohler@newt.com>
parents:
69471
diff
changeset
|
142 (when (boundp 'image-load-path) |
4f9233243d97
(image-load-path-for-library): Fix example by not recommending that
Bill Wohler <wohler@newt.com>
parents:
69471
diff
changeset
|
143 image-load-path)))) |
69471
6f07bf99b6f8
(image-load-path-for-library): Pass value of path rather than symbol.
Bill Wohler <wohler@newt.com>
parents:
69365
diff
changeset
|
144 (mh-tool-bar-folder-buttons-init))" |
69360
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
145 (unless library (error "No library specified")) |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
146 (unless image (error "No image specified")) |
69516
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
147 (let (image-directory image-directory-load-path) |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
148 ;; Check for images in image-load-path or load-path. |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
149 (let ((img image) |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
150 (dir (or |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
151 ;; Images in image-load-path. |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
152 (image-search-load-path image) |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
153 ;; Images in load-path. |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
154 (locate-library image))) |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
155 parent) |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
156 ;; Since the image might be in a nested directory (for |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
157 ;; example, mail/attach.pbm), adjust `image-directory' |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
158 ;; accordingly. |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
159 (when dir |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
160 (setq dir (file-name-directory dir)) |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
161 (while (setq parent (file-name-directory img)) |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
162 (setq img (directory-file-name parent) |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
163 dir (expand-file-name "../" dir)))) |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
164 (setq image-directory-load-path dir)) |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
165 |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
166 ;; If `image-directory-load-path' isn't Emacs' image directory, |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
167 ;; it's probably a user preference, so use it. Then use a |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
168 ;; relative setting if possible; otherwise, use |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
169 ;; `image-directory-load-path'. |
69360
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
170 (cond |
69516
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
171 ;; User-modified image-load-path? |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
172 ((and image-directory-load-path |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
173 (not (equal image-directory-load-path |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
174 (file-name-as-directory |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
175 (expand-file-name "images" data-directory))))) |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
176 (setq image-directory image-directory-load-path)) |
69360
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
177 ;; Try relative setting. |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
178 ((let (library-name d1ei d2ei) |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
179 ;; First, find library in the load-path. |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
180 (setq library-name (locate-library library)) |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
181 (if (not library-name) |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
182 (error "Cannot find library %s in load-path" library)) |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
183 ;; And then set image-directory relative to that. |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
184 (setq |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
185 ;; Go down 2 levels. |
69516
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
186 d2ei (file-name-as-directory |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
187 (expand-file-name |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
188 (concat (file-name-directory library-name) "../../etc/images"))) |
69360
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
189 ;; Go down 1 level. |
69516
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
190 d1ei (file-name-as-directory |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
191 (expand-file-name |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
192 (concat (file-name-directory library-name) "../etc/images")))) |
69360
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
193 (setq image-directory |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
194 ;; Set it to nil if image is not found. |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
195 (cond ((file-exists-p (expand-file-name image d2ei)) d2ei) |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
196 ((file-exists-p (expand-file-name image d1ei)) d1ei))))) |
69516
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
197 ;; Use Emacs' image directory. |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
198 (image-directory-load-path |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
199 (setq image-directory image-directory-load-path)) |
69365
0a2d89023fde
(image-load-path-for-library): Merged changes from Reiner. Add
Bill Wohler <wohler@newt.com>
parents:
69360
diff
changeset
|
200 (no-error |
0a2d89023fde
(image-load-path-for-library): Merged changes from Reiner. Add
Bill Wohler <wohler@newt.com>
parents:
69360
diff
changeset
|
201 (message "Could not find image %s for library %s" image library)) |
69360
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
202 (t |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
203 (error "Could not find image %s for library %s" image library))) |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
204 |
69471
6f07bf99b6f8
(image-load-path-for-library): Pass value of path rather than symbol.
Bill Wohler <wohler@newt.com>
parents:
69365
diff
changeset
|
205 ;; Return an augmented `path' or `load-path'. |
6f07bf99b6f8
(image-load-path-for-library): Pass value of path rather than symbol.
Bill Wohler <wohler@newt.com>
parents:
69365
diff
changeset
|
206 (nconc (list image-directory) |
6f07bf99b6f8
(image-load-path-for-library): Pass value of path rather than symbol.
Bill Wohler <wohler@newt.com>
parents:
69365
diff
changeset
|
207 (delete image-directory (copy-sequence (or path load-path)))))) |
6f07bf99b6f8
(image-load-path-for-library): Pass value of path rather than symbol.
Bill Wohler <wohler@newt.com>
parents:
69365
diff
changeset
|
208 |
69360
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
209 |
38732
24fe4f884e82
(image-type-regexps): Allow predicates. Change the way
Gerd Moellmann <gerd@gnu.org>
parents:
38711
diff
changeset
|
210 (defun image-jpeg-p (data) |
46810
65ad7b458435
(image-jpeg-p): Accept "Exif" marker.
Richard M. Stallman <rms@gnu.org>
parents:
43834
diff
changeset
|
211 "Value is non-nil if DATA, a string, consists of JFIF image data. |
65ad7b458435
(image-jpeg-p): Accept "Exif" marker.
Richard M. Stallman <rms@gnu.org>
parents:
43834
diff
changeset
|
212 We accept the tag Exif because that is the same format." |
96380
044f3969e191
(image-jpeg-p): Don't fail if the arg cannot be converted to unibyte.
Juanma Barranquero <lekktu@gmail.com>
parents:
96253
diff
changeset
|
213 (setq data (ignore-errors (string-to-unibyte data))) |
044f3969e191
(image-jpeg-p): Don't fail if the arg cannot be converted to unibyte.
Juanma Barranquero <lekktu@gmail.com>
parents:
96253
diff
changeset
|
214 (when (and data (string-match-p "\\`\xff\xd8" data)) |
38732
24fe4f884e82
(image-type-regexps): Allow predicates. Change the way
Gerd Moellmann <gerd@gnu.org>
parents:
38711
diff
changeset
|
215 (catch 'jfif |
24fe4f884e82
(image-type-regexps): Allow predicates. Change the way
Gerd Moellmann <gerd@gnu.org>
parents:
38711
diff
changeset
|
216 (let ((len (length data)) (i 2)) |
24fe4f884e82
(image-type-regexps): Allow predicates. Change the way
Gerd Moellmann <gerd@gnu.org>
parents:
38711
diff
changeset
|
217 (while (< i len) |
24fe4f884e82
(image-type-regexps): Allow predicates. Change the way
Gerd Moellmann <gerd@gnu.org>
parents:
38711
diff
changeset
|
218 (when (/= (aref data i) #xff) |
24fe4f884e82
(image-type-regexps): Allow predicates. Change the way
Gerd Moellmann <gerd@gnu.org>
parents:
38711
diff
changeset
|
219 (throw 'jfif nil)) |
24fe4f884e82
(image-type-regexps): Allow predicates. Change the way
Gerd Moellmann <gerd@gnu.org>
parents:
38711
diff
changeset
|
220 (setq i (1+ i)) |
24fe4f884e82
(image-type-regexps): Allow predicates. Change the way
Gerd Moellmann <gerd@gnu.org>
parents:
38711
diff
changeset
|
221 (when (>= (+ i 2) len) |
24fe4f884e82
(image-type-regexps): Allow predicates. Change the way
Gerd Moellmann <gerd@gnu.org>
parents:
38711
diff
changeset
|
222 (throw 'jfif nil)) |
24fe4f884e82
(image-type-regexps): Allow predicates. Change the way
Gerd Moellmann <gerd@gnu.org>
parents:
38711
diff
changeset
|
223 (let ((nbytes (+ (lsh (aref data (+ i 1)) 8) |
38776
a679a282d5cb
(image-jpeg-p): Test for APPn markers in the range
Gerd Moellmann <gerd@gnu.org>
parents:
38746
diff
changeset
|
224 (aref data (+ i 2)))) |
a679a282d5cb
(image-jpeg-p): Test for APPn markers in the range
Gerd Moellmann <gerd@gnu.org>
parents:
38746
diff
changeset
|
225 (code (aref data i))) |
a679a282d5cb
(image-jpeg-p): Test for APPn markers in the range
Gerd Moellmann <gerd@gnu.org>
parents:
38746
diff
changeset
|
226 (when (and (>= code #xe0) (<= code #xef)) |
38732
24fe4f884e82
(image-type-regexps): Allow predicates. Change the way
Gerd Moellmann <gerd@gnu.org>
parents:
38711
diff
changeset
|
227 ;; APP0 LEN1 LEN2 "JFIF\0" |
49588
37645a051842
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48130
diff
changeset
|
228 (throw 'jfif |
96380
044f3969e191
(image-jpeg-p): Don't fail if the arg cannot be converted to unibyte.
Juanma Barranquero <lekktu@gmail.com>
parents:
96253
diff
changeset
|
229 (string-match-p "JFIF\\|Exif" |
044f3969e191
(image-jpeg-p): Don't fail if the arg cannot be converted to unibyte.
Juanma Barranquero <lekktu@gmail.com>
parents:
96253
diff
changeset
|
230 (substring data i (min (+ i nbytes) len))))) |
38746
0fc8e4a27edc
(image-type-regexps): Allow whitespace at the start
Gerd Moellmann <gerd@gnu.org>
parents:
38732
diff
changeset
|
231 (setq i (+ i 1 nbytes)))))))) |
25003 | 232 |
233 | |
234 ;;;###autoload | |
27073
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
235 (defun image-type-from-data (data) |
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
236 "Determine the image type from image data DATA. |
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
237 Value is a symbol specifying the image type or nil if type cannot |
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
238 be determined." |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
239 (let ((types image-type-header-regexps) |
27073
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
240 type) |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
241 (while types |
27073
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
242 (let ((regexp (car (car types))) |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
243 (image-type (cdr (car types)))) |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
244 (if (or (and (symbolp image-type) |
96380
044f3969e191
(image-jpeg-p): Don't fail if the arg cannot be converted to unibyte.
Juanma Barranquero <lekktu@gmail.com>
parents:
96253
diff
changeset
|
245 (string-match-p regexp data)) |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
246 (and (consp image-type) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
247 (funcall (car image-type) data) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
248 (setq image-type (cdr image-type)))) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
249 (setq type image-type |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
250 types nil) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
251 (setq types (cdr types))))) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
252 type)) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
253 |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
254 |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
255 ;;;###autoload |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
256 (defun image-type-from-buffer () |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
257 "Determine the image type from data in the current buffer. |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
258 Value is a symbol specifying the image type or nil if type cannot |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
259 be determined." |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
260 (let ((types image-type-header-regexps) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
261 type |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
262 (opoint (point))) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
263 (goto-char (point-min)) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
264 (while types |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
265 (let ((regexp (car (car types))) |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
266 (image-type (cdr (car types))) |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
267 data) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
268 (if (or (and (symbolp image-type) |
96380
044f3969e191
(image-jpeg-p): Don't fail if the arg cannot be converted to unibyte.
Juanma Barranquero <lekktu@gmail.com>
parents:
96253
diff
changeset
|
269 (looking-at-p regexp)) |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
270 (and (consp image-type) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
271 (funcall (car image-type) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
272 (or data |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
273 (setq data |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
274 (buffer-substring |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
275 (point-min) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
276 (min (point-max) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
277 (+ (point-min) 256)))))) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
278 (setq image-type (cdr image-type)))) |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
279 (setq type image-type |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
280 types nil) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
281 (setq types (cdr types))))) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
282 (goto-char opoint) |
27073
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
283 type)) |
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
284 |
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
285 |
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
286 ;;;###autoload |
25003 | 287 (defun image-type-from-file-header (file) |
288 "Determine the type of image file FILE from its first few bytes. | |
289 Value is a symbol specifying the image type, or nil if type cannot | |
290 be determined." | |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
291 (unless (or (file-readable-p file) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
292 (file-name-absolute-p file)) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
293 (setq file (image-search-load-path file))) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
294 (and file |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
295 (file-readable-p file) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
296 (with-temp-buffer |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
297 (set-buffer-multibyte nil) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
298 (insert-file-contents-literally file nil 0 256) |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
299 (image-type-from-buffer)))) |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
300 |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
301 |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
302 ;;;###autoload |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
303 (defun image-type-from-file-name (file) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
304 "Determine the type of image file FILE from its name. |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
305 Value is a symbol specifying the image type, or nil if type cannot |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
306 be determined." |
96380
044f3969e191
(image-jpeg-p): Don't fail if the arg cannot be converted to unibyte.
Juanma Barranquero <lekktu@gmail.com>
parents:
96253
diff
changeset
|
307 (assoc-default file image-type-file-name-regexps 'string-match-p)) |
25003 | 308 |
309 | |
310 ;;;###autoload | |
81013
b808e2e86f98
(image-type-from-file-name, image-type): Simplify.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
311 (defun image-type (source &optional type data-p) |
70170
de6c9508749d
(image-type): New defun split out of create-image.
Kim F. Storm <storm@cua.dk>
parents:
69569
diff
changeset
|
312 "Determine and return image type. |
81013
b808e2e86f98
(image-type-from-file-name, image-type): Simplify.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
313 SOURCE is an image file name or image data. |
70170
de6c9508749d
(image-type): New defun split out of create-image.
Kim F. Storm <storm@cua.dk>
parents:
69569
diff
changeset
|
314 Optional TYPE is a symbol describing the image type. If TYPE is omitted |
de6c9508749d
(image-type): New defun split out of create-image.
Kim F. Storm <storm@cua.dk>
parents:
69569
diff
changeset
|
315 or nil, try to determine the image type from its first few bytes |
81013
b808e2e86f98
(image-type-from-file-name, image-type): Simplify.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
316 of image data. If that doesn't work, and SOURCE is a file name, |
70170
de6c9508749d
(image-type): New defun split out of create-image.
Kim F. Storm <storm@cua.dk>
parents:
69569
diff
changeset
|
317 use its file extension as image type. |
81013
b808e2e86f98
(image-type-from-file-name, image-type): Simplify.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
318 Optional DATA-P non-nil means SOURCE is a string containing image data." |
b808e2e86f98
(image-type-from-file-name, image-type): Simplify.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
319 (when (and (not data-p) (not (stringp source))) |
b808e2e86f98
(image-type-from-file-name, image-type): Simplify.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
320 (error "Invalid image file name `%s'" source)) |
70170
de6c9508749d
(image-type): New defun split out of create-image.
Kim F. Storm <storm@cua.dk>
parents:
69569
diff
changeset
|
321 (unless type |
81013
b808e2e86f98
(image-type-from-file-name, image-type): Simplify.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
322 (setq type (if data-p |
b808e2e86f98
(image-type-from-file-name, image-type): Simplify.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
323 (image-type-from-data source) |
b808e2e86f98
(image-type-from-file-name, image-type): Simplify.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
324 (or (image-type-from-file-header source) |
b808e2e86f98
(image-type-from-file-name, image-type): Simplify.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
325 (image-type-from-file-name source)))) |
b808e2e86f98
(image-type-from-file-name, image-type): Simplify.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
326 (or type (error "Cannot determine image type"))) |
85072
c27859b68484
(image-type): Check if image-types is bound to not fail on tty.
Juri Linkov <juri@jurta.org>
parents:
84949
diff
changeset
|
327 (or (memq type (and (boundp 'image-types) image-types)) |
81013
b808e2e86f98
(image-type-from-file-name, image-type): Simplify.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
328 (error "Invalid image type `%s'" type)) |
70170
de6c9508749d
(image-type): New defun split out of create-image.
Kim F. Storm <storm@cua.dk>
parents:
69569
diff
changeset
|
329 type) |
de6c9508749d
(image-type): New defun split out of create-image.
Kim F. Storm <storm@cua.dk>
parents:
69569
diff
changeset
|
330 |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
331 |
95841
b4e36ff621b3
Add some compiler declarations, for builds without X.
Glenn Morris <rgm@gnu.org>
parents:
94678
diff
changeset
|
332 (defvar image-library-alist) |
b4e36ff621b3
Add some compiler declarations, for builds without X.
Glenn Morris <rgm@gnu.org>
parents:
94678
diff
changeset
|
333 |
70170
de6c9508749d
(image-type): New defun split out of create-image.
Kim F. Storm <storm@cua.dk>
parents:
69569
diff
changeset
|
334 ;;;###autoload |
25003 | 335 (defun image-type-available-p (type) |
62816
f5a3eeaf3d70
(image-library-alist): Moved to image.c.
Juanma Barranquero <lekktu@gmail.com>
parents:
60688
diff
changeset
|
336 "Return non-nil if image type TYPE is available. |
25003 | 337 Image types are symbols like `xbm' or `jpeg'." |
56106
5b3f0e4cf47f
(image-library-alist): New variable to map image types to external
Juanma Barranquero <lekktu@gmail.com>
parents:
55167
diff
changeset
|
338 (and (fboundp 'init-image-library) |
5b3f0e4cf47f
(image-library-alist): New variable to map image types to external
Juanma Barranquero <lekktu@gmail.com>
parents:
55167
diff
changeset
|
339 (init-image-library type image-library-alist))) |
25003 | 340 |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
341 |
25003 | 342 ;;;###autoload |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
343 (defun image-type-auto-detected-p () |
78492
7c8949dbfa0d
Replace `iff' in doc-strings and comments.
Glenn Morris <rgm@gnu.org>
parents:
78236
diff
changeset
|
344 "Return t if the current buffer contains an auto-detectable image. |
77873
b2375f70c499
(image-type-auto-detected-p): Don't scan auto-mode-alist.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
345 This function is intended to be used from `magic-fallback-mode-alist'. |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
346 |
77873
b2375f70c499
(image-type-auto-detected-p): Don't scan auto-mode-alist.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
347 The buffer is considered to contain an auto-detectable image if |
b2375f70c499
(image-type-auto-detected-p): Don't scan auto-mode-alist.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
348 its beginning matches an image type in `image-type-header-regexps', |
84944
186e9ba3989a
(image-type-auto-detected-p): Doc fix. Don't detect an image if it is
Glenn Morris <rgm@gnu.org>
parents:
82835
diff
changeset
|
349 and that image type is present in `image-type-auto-detectable' with a |
186e9ba3989a
(image-type-auto-detected-p): Doc fix. Don't detect an image if it is
Glenn Morris <rgm@gnu.org>
parents:
82835
diff
changeset
|
350 non-nil value. If that value is non-nil, but not t, then the image type |
186e9ba3989a
(image-type-auto-detected-p): Doc fix. Don't detect an image if it is
Glenn Morris <rgm@gnu.org>
parents:
82835
diff
changeset
|
351 must be available." |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
352 (let* ((type (image-type-from-buffer)) |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
353 (auto (and type (cdr (assq type image-type-auto-detectable))))) |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
354 (and auto |
77873
b2375f70c499
(image-type-auto-detected-p): Don't scan auto-mode-alist.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
355 (or (eq auto t) (image-type-available-p type))))) |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
356 |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
357 |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
358 ;;;###autoload |
27073
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
359 (defun create-image (file-or-data &optional type data-p &rest props) |
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
360 "Create an image. |
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
361 FILE-OR-DATA is an image file name or image data. |
25003 | 362 Optional TYPE is a symbol describing the image type. If TYPE is omitted |
27073
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
363 or nil, try to determine the image type from its first few bytes |
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
364 of image data. If that doesn't work, and FILE-OR-DATA is a file name, |
34378
5ae7af279df7
(create-image): Doc fix; spotted by Per Cederqvist <ceder@lysator.liu.se>.
Eli Zaretskii <eliz@gnu.org>
parents:
32166
diff
changeset
|
365 use its file extension as image type. |
27073
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
366 Optional DATA-P non-nil means FILE-OR-DATA is a string containing image data. |
25003 | 367 Optional PROPS are additional image attributes to assign to the image, |
31635 | 368 like, e.g. `:mask MASK'. |
66196
2e59eea25fcf
* image.el (create-image, find-image): Mention max-image-size in
Chong Yidong <cyd@stupidchicken.com>
parents:
65599
diff
changeset
|
369 Value is the image created, or nil if images of type TYPE are not supported. |
2e59eea25fcf
* image.el (create-image, find-image): Mention max-image-size in
Chong Yidong <cyd@stupidchicken.com>
parents:
65599
diff
changeset
|
370 |
82734 | 371 Images should not be larger than specified by `max-image-size'. |
372 | |
373 Image file names that are not absolute are searched for in the | |
374 \"images\" sub-directory of `data-directory' and | |
375 `x-bitmap-file-path' (in that order)." | |
376 ;; It is x_find_image_file in image.c that sets the search path. | |
70170
de6c9508749d
(image-type): New defun split out of create-image.
Kim F. Storm <storm@cua.dk>
parents:
69569
diff
changeset
|
377 (setq type (image-type file-or-data type data-p)) |
25003 | 378 (when (image-type-available-p type) |
27073
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
379 (append (list 'image :type type (if data-p :data :file) file-or-data) |
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
380 props))) |
25003 | 381 |
382 | |
383 ;;;###autoload | |
29470
7bde123bed95
(find-image): Doc fix. Return nil if image not found.
Dave Love <fx@gnu.org>
parents:
28958
diff
changeset
|
384 (defun put-image (image pos &optional string area) |
25617
697b28471784
(put-image): Remove optional buffer parameter.
Gerd Moellmann <gerd@gnu.org>
parents:
25309
diff
changeset
|
385 "Put image IMAGE in front of POS in the current buffer. |
25003 | 386 IMAGE must be an image created with `create-image' or `defimage'. |
25816
2d53a03a3baa
(put-image, insert-image): Add string argument.
Gerd Moellmann <gerd@gnu.org>
parents:
25617
diff
changeset
|
387 IMAGE is displayed by putting an overlay into the current buffer with a |
2d53a03a3baa
(put-image, insert-image): Add string argument.
Gerd Moellmann <gerd@gnu.org>
parents:
25617
diff
changeset
|
388 `before-string' STRING that has a `display' property whose value is the |
29470
7bde123bed95
(find-image): Doc fix. Return nil if image not found.
Dave Love <fx@gnu.org>
parents:
28958
diff
changeset
|
389 image. STRING is defaulted if you omit it. |
25003 | 390 POS may be an integer or marker. |
391 AREA is where to display the image. AREA nil or omitted means | |
392 display it in the text area, a value of `left-margin' means | |
393 display it in the left marginal area, a value of `right-margin' | |
25816
2d53a03a3baa
(put-image, insert-image): Add string argument.
Gerd Moellmann <gerd@gnu.org>
parents:
25617
diff
changeset
|
394 means display it in the right marginal area." |
29626
ecb96a7369d3
Fix last change to be in insert-image as intended.
Dave Love <fx@gnu.org>
parents:
29624
diff
changeset
|
395 (unless string (setq string "x")) |
25617
697b28471784
(put-image): Remove optional buffer parameter.
Gerd Moellmann <gerd@gnu.org>
parents:
25309
diff
changeset
|
396 (let ((buffer (current-buffer))) |
29470
7bde123bed95
(find-image): Doc fix. Return nil if image not found.
Dave Love <fx@gnu.org>
parents:
28958
diff
changeset
|
397 (unless (eq (car-safe image) 'image) |
25617
697b28471784
(put-image): Remove optional buffer parameter.
Gerd Moellmann <gerd@gnu.org>
parents:
25309
diff
changeset
|
398 (error "Not an image: %s" image)) |
697b28471784
(put-image): Remove optional buffer parameter.
Gerd Moellmann <gerd@gnu.org>
parents:
25309
diff
changeset
|
399 (unless (or (null area) (memq area '(left-margin right-margin))) |
697b28471784
(put-image): Remove optional buffer parameter.
Gerd Moellmann <gerd@gnu.org>
parents:
25309
diff
changeset
|
400 (error "Invalid area %s" area)) |
25816
2d53a03a3baa
(put-image, insert-image): Add string argument.
Gerd Moellmann <gerd@gnu.org>
parents:
25617
diff
changeset
|
401 (setq string (copy-sequence string)) |
25617
697b28471784
(put-image): Remove optional buffer parameter.
Gerd Moellmann <gerd@gnu.org>
parents:
25309
diff
changeset
|
402 (let ((overlay (make-overlay pos pos buffer)) |
25816
2d53a03a3baa
(put-image, insert-image): Add string argument.
Gerd Moellmann <gerd@gnu.org>
parents:
25617
diff
changeset
|
403 (prop (if (null area) image (list (list 'margin area) image)))) |
2d53a03a3baa
(put-image, insert-image): Add string argument.
Gerd Moellmann <gerd@gnu.org>
parents:
25617
diff
changeset
|
404 (put-text-property 0 (length string) 'display prop string) |
25617
697b28471784
(put-image): Remove optional buffer parameter.
Gerd Moellmann <gerd@gnu.org>
parents:
25309
diff
changeset
|
405 (overlay-put overlay 'put-image t) |
697b28471784
(put-image): Remove optional buffer parameter.
Gerd Moellmann <gerd@gnu.org>
parents:
25309
diff
changeset
|
406 (overlay-put overlay 'before-string string)))) |
25003 | 407 |
408 | |
409 ;;;###autoload | |
55033
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
410 (defun insert-image (image &optional string area slice) |
25003 | 411 "Insert IMAGE into current buffer at point. |
25816
2d53a03a3baa
(put-image, insert-image): Add string argument.
Gerd Moellmann <gerd@gnu.org>
parents:
25617
diff
changeset
|
412 IMAGE is displayed by inserting STRING into the current buffer |
29470
7bde123bed95
(find-image): Doc fix. Return nil if image not found.
Dave Love <fx@gnu.org>
parents:
28958
diff
changeset
|
413 with a `display' property whose value is the image. STRING is |
7bde123bed95
(find-image): Doc fix. Return nil if image not found.
Dave Love <fx@gnu.org>
parents:
28958
diff
changeset
|
414 defaulted if you omit it. |
25003 | 415 AREA is where to display the image. AREA nil or omitted means |
416 display it in the text area, a value of `left-margin' means | |
417 display it in the left marginal area, a value of `right-margin' | |
55033
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
418 means display it in the right marginal area. |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
419 SLICE specifies slice of IMAGE to insert. SLICE nil or omitted |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
420 means insert whole image. SLICE is a list (X Y WIDTH HEIGHT) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
421 specifying the X and Y positions and WIDTH and HEIGHT of image area |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
422 to insert. A float value 0.0 - 1.0 means relative to the width or |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
423 height of the image; integer values are taken as pixel values." |
29626
ecb96a7369d3
Fix last change to be in insert-image as intended.
Dave Love <fx@gnu.org>
parents:
29624
diff
changeset
|
424 ;; Use a space as least likely to cause trouble when it's a hidden |
ecb96a7369d3
Fix last change to be in insert-image as intended.
Dave Love <fx@gnu.org>
parents:
29624
diff
changeset
|
425 ;; character in the buffer. |
ecb96a7369d3
Fix last change to be in insert-image as intended.
Dave Love <fx@gnu.org>
parents:
29624
diff
changeset
|
426 (unless string (setq string " ")) |
29470
7bde123bed95
(find-image): Doc fix. Return nil if image not found.
Dave Love <fx@gnu.org>
parents:
28958
diff
changeset
|
427 (unless (eq (car-safe image) 'image) |
25003 | 428 (error "Not an image: %s" image)) |
429 (unless (or (null area) (memq area '(left-margin right-margin))) | |
430 (error "Invalid area %s" area)) | |
29607
42d156d8d8eb
(insert-image): Save a little consing.
Dave Love <fx@gnu.org>
parents:
29470
diff
changeset
|
431 (if area |
42d156d8d8eb
(insert-image): Save a little consing.
Dave Love <fx@gnu.org>
parents:
29470
diff
changeset
|
432 (setq image (list (list 'margin area) image)) |
42d156d8d8eb
(insert-image): Save a little consing.
Dave Love <fx@gnu.org>
parents:
29470
diff
changeset
|
433 ;; Cons up a new spec equal but not eq to `image' so that |
42d156d8d8eb
(insert-image): Save a little consing.
Dave Love <fx@gnu.org>
parents:
29470
diff
changeset
|
434 ;; inserting it twice in a row (adjacently) displays two copies of |
42d156d8d8eb
(insert-image): Save a little consing.
Dave Love <fx@gnu.org>
parents:
29470
diff
changeset
|
435 ;; the image. Don't try to avoid this by looking at the display |
42d156d8d8eb
(insert-image): Save a little consing.
Dave Love <fx@gnu.org>
parents:
29470
diff
changeset
|
436 ;; properties on either side so that we DTRT more often with |
42d156d8d8eb
(insert-image): Save a little consing.
Dave Love <fx@gnu.org>
parents:
29470
diff
changeset
|
437 ;; cut-and-paste. (Yanking killed image text next to another copy |
42d156d8d8eb
(insert-image): Save a little consing.
Dave Love <fx@gnu.org>
parents:
29470
diff
changeset
|
438 ;; of it loses anyway.) |
42d156d8d8eb
(insert-image): Save a little consing.
Dave Love <fx@gnu.org>
parents:
29470
diff
changeset
|
439 (setq image (cons 'image (cdr image)))) |
25816
2d53a03a3baa
(put-image, insert-image): Add string argument.
Gerd Moellmann <gerd@gnu.org>
parents:
25617
diff
changeset
|
440 (let ((start (point))) |
2d53a03a3baa
(put-image, insert-image): Add string argument.
Gerd Moellmann <gerd@gnu.org>
parents:
25617
diff
changeset
|
441 (insert string) |
2d53a03a3baa
(put-image, insert-image): Add string argument.
Gerd Moellmann <gerd@gnu.org>
parents:
25617
diff
changeset
|
442 (add-text-properties start (point) |
55033
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
443 `(display ,(if slice |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
444 (list (cons 'slice slice) image) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
445 image) rear-nonsticky (display))))) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
446 |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
447 |
60688
b0de8a447a79
(insert-sliced-image): Add autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
59276
diff
changeset
|
448 ;;;###autoload |
55033
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
449 (defun insert-sliced-image (image &optional string area rows cols) |
57196
090c23fa222c
(insert-sliced-image): Add doc string.
Kim F. Storm <storm@cua.dk>
parents:
56189
diff
changeset
|
450 "Insert IMAGE into current buffer at point. |
090c23fa222c
(insert-sliced-image): Add doc string.
Kim F. Storm <storm@cua.dk>
parents:
56189
diff
changeset
|
451 IMAGE is displayed by inserting STRING into the current buffer |
090c23fa222c
(insert-sliced-image): Add doc string.
Kim F. Storm <storm@cua.dk>
parents:
56189
diff
changeset
|
452 with a `display' property whose value is the image. STRING is |
090c23fa222c
(insert-sliced-image): Add doc string.
Kim F. Storm <storm@cua.dk>
parents:
56189
diff
changeset
|
453 defaulted if you omit it. |
090c23fa222c
(insert-sliced-image): Add doc string.
Kim F. Storm <storm@cua.dk>
parents:
56189
diff
changeset
|
454 AREA is where to display the image. AREA nil or omitted means |
090c23fa222c
(insert-sliced-image): Add doc string.
Kim F. Storm <storm@cua.dk>
parents:
56189
diff
changeset
|
455 display it in the text area, a value of `left-margin' means |
090c23fa222c
(insert-sliced-image): Add doc string.
Kim F. Storm <storm@cua.dk>
parents:
56189
diff
changeset
|
456 display it in the left marginal area, a value of `right-margin' |
090c23fa222c
(insert-sliced-image): Add doc string.
Kim F. Storm <storm@cua.dk>
parents:
56189
diff
changeset
|
457 means display it in the right marginal area. |
102236
eeef2e7e9171
* image.el (image-load-path-for-library, insert-sliced-image):
Juanma Barranquero <lekktu@gmail.com>
parents:
100908
diff
changeset
|
458 The image is automatically split into ROWS x COLS slices." |
55033
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
459 (unless string (setq string " ")) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
460 (unless (eq (car-safe image) 'image) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
461 (error "Not an image: %s" image)) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
462 (unless (or (null area) (memq area '(left-margin right-margin))) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
463 (error "Invalid area %s" area)) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
464 (if area |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
465 (setq image (list (list 'margin area) image)) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
466 ;; Cons up a new spec equal but not eq to `image' so that |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
467 ;; inserting it twice in a row (adjacently) displays two copies of |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
468 ;; the image. Don't try to avoid this by looking at the display |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
469 ;; properties on either side so that we DTRT more often with |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
470 ;; cut-and-paste. (Yanking killed image text next to another copy |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
471 ;; of it loses anyway.) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
472 (setq image (cons 'image (cdr image)))) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
473 (let ((x 0.0) (dx (/ 1.0001 (or cols 1))) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
474 (y 0.0) (dy (/ 1.0001 (or rows 1)))) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
475 (while (< y 1.0) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
476 (while (< x 1.0) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
477 (let ((start (point))) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
478 (insert string) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
479 (add-text-properties start (point) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
480 `(display ,(list (list 'slice x y dx dy) image) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
481 rear-nonsticky (display))) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
482 (setq x (+ x dx)))) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
483 (setq x 0.0 |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
484 y (+ y dy)) |
59276
d50d807507e0
(insert-sliced-image): Use t for line-height property.
Kim F. Storm <storm@cua.dk>
parents:
57196
diff
changeset
|
485 (insert (propertize "\n" 'line-height t))))) |
55033
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
486 |
26007
774b2504710b
(insert-image): Copy the image spec and add an intangible property.
Dave Love <fx@gnu.org>
parents:
25872
diff
changeset
|
487 |
25003 | 488 |
489 ;;;###autoload | |
490 (defun remove-images (start end &optional buffer) | |
491 "Remove images between START and END in BUFFER. | |
492 Remove only images that were put in BUFFER with calls to `put-image'. | |
493 BUFFER nil or omitted means use the current buffer." | |
494 (unless buffer | |
495 (setq buffer (current-buffer))) | |
496 (let ((overlays (overlays-in start end))) | |
497 (while overlays | |
498 (let ((overlay (car overlays))) | |
499 (when (overlay-get overlay 'put-image) | |
25857
fdc2bd91cf63
(defimage): Remove redundant code. Substitute file on image plist.
Dave Love <fx@gnu.org>
parents:
25816
diff
changeset
|
500 (delete-overlay overlay))) |
fdc2bd91cf63
(defimage): Remove redundant code. Substitute file on image plist.
Dave Love <fx@gnu.org>
parents:
25816
diff
changeset
|
501 (setq overlays (cdr overlays))))) |
25003 | 502 |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
503 (defun image-search-load-path (file &optional path) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
504 (unless path |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
505 (setq path image-load-path)) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
506 (let (element found filename) |
65544
78d74ef1436b
2005-09-15 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
64762
diff
changeset
|
507 (while (and (not found) (consp path)) |
65599
39114a2ae201
(image-load-path): Use symbol `data-directory' instead of its value,
Chong Yidong <cyd@stupidchicken.com>
parents:
65544
diff
changeset
|
508 (setq element (car path)) |
65544
78d74ef1436b
2005-09-15 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
64762
diff
changeset
|
509 (cond |
65599
39114a2ae201
(image-load-path): Use symbol `data-directory' instead of its value,
Chong Yidong <cyd@stupidchicken.com>
parents:
65544
diff
changeset
|
510 ((stringp element) |
65544
78d74ef1436b
2005-09-15 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
64762
diff
changeset
|
511 (setq found |
78d74ef1436b
2005-09-15 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
64762
diff
changeset
|
512 (file-readable-p |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
513 (setq filename (expand-file-name file element))))) |
65599
39114a2ae201
(image-load-path): Use symbol `data-directory' instead of its value,
Chong Yidong <cyd@stupidchicken.com>
parents:
65544
diff
changeset
|
514 ((and (symbolp element) (boundp element)) |
39114a2ae201
(image-load-path): Use symbol `data-directory' instead of its value,
Chong Yidong <cyd@stupidchicken.com>
parents:
65544
diff
changeset
|
515 (setq element (symbol-value element)) |
39114a2ae201
(image-load-path): Use symbol `data-directory' instead of its value,
Chong Yidong <cyd@stupidchicken.com>
parents:
65544
diff
changeset
|
516 (cond |
39114a2ae201
(image-load-path): Use symbol `data-directory' instead of its value,
Chong Yidong <cyd@stupidchicken.com>
parents:
65544
diff
changeset
|
517 ((stringp element) |
39114a2ae201
(image-load-path): Use symbol `data-directory' instead of its value,
Chong Yidong <cyd@stupidchicken.com>
parents:
65544
diff
changeset
|
518 (setq found |
39114a2ae201
(image-load-path): Use symbol `data-directory' instead of its value,
Chong Yidong <cyd@stupidchicken.com>
parents:
65544
diff
changeset
|
519 (file-readable-p |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
520 (setq filename (expand-file-name file element))))) |
65599
39114a2ae201
(image-load-path): Use symbol `data-directory' instead of its value,
Chong Yidong <cyd@stupidchicken.com>
parents:
65544
diff
changeset
|
521 ((consp element) |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
522 (if (setq filename (image-search-load-path file element)) |
65599
39114a2ae201
(image-load-path): Use symbol `data-directory' instead of its value,
Chong Yidong <cyd@stupidchicken.com>
parents:
65544
diff
changeset
|
523 (setq found t)))))) |
65544
78d74ef1436b
2005-09-15 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
64762
diff
changeset
|
524 (setq path (cdr path))) |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
525 (if found filename))) |
25003 | 526 |
527 ;;;###autoload | |
28721
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
528 (defun find-image (specs) |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
529 "Find an image, choosing one of a list of image specifications. |
25003 | 530 |
29470
7bde123bed95
(find-image): Doc fix. Return nil if image not found.
Dave Love <fx@gnu.org>
parents:
28958
diff
changeset
|
531 SPECS is a list of image specifications. |
25003 | 532 |
533 Each image specification in SPECS is a property list. The contents of | |
534 a specification are image type dependent. All specifications must at | |
27059
6bb2a4a0413e
* image.el (defimage): Images with the :data keyword should be considered valid as well.
William M. Perry <wmperry@aventail.com>
parents:
26007
diff
changeset
|
535 least contain the properties `:type TYPE' and either `:file FILE' or |
6bb2a4a0413e
* image.el (defimage): Images with the :data keyword should be considered valid as well.
William M. Perry <wmperry@aventail.com>
parents:
26007
diff
changeset
|
536 `:data DATA', where TYPE is a symbol specifying the image type, |
6bb2a4a0413e
* image.el (defimage): Images with the :data keyword should be considered valid as well.
William M. Perry <wmperry@aventail.com>
parents:
26007
diff
changeset
|
537 e.g. `xbm', FILE is the file to load the image from, and DATA is a |
29470
7bde123bed95
(find-image): Doc fix. Return nil if image not found.
Dave Love <fx@gnu.org>
parents:
28958
diff
changeset
|
538 string containing the actual image data. The specification whose TYPE |
7bde123bed95
(find-image): Doc fix. Return nil if image not found.
Dave Love <fx@gnu.org>
parents:
28958
diff
changeset
|
539 is supported, and FILE exists, is used to construct the image |
7bde123bed95
(find-image): Doc fix. Return nil if image not found.
Dave Love <fx@gnu.org>
parents:
28958
diff
changeset
|
540 specification to be returned. Return nil if no specification is |
7bde123bed95
(find-image): Doc fix. Return nil if image not found.
Dave Love <fx@gnu.org>
parents:
28958
diff
changeset
|
541 satisfied. |
7bde123bed95
(find-image): Doc fix. Return nil if image not found.
Dave Love <fx@gnu.org>
parents:
28958
diff
changeset
|
542 |
66196
2e59eea25fcf
* image.el (create-image, find-image): Mention max-image-size in
Chong Yidong <cyd@stupidchicken.com>
parents:
65599
diff
changeset
|
543 The image is looked for in `image-load-path'. |
2e59eea25fcf
* image.el (create-image, find-image): Mention max-image-size in
Chong Yidong <cyd@stupidchicken.com>
parents:
65599
diff
changeset
|
544 |
2e59eea25fcf
* image.el (create-image, find-image): Mention max-image-size in
Chong Yidong <cyd@stupidchicken.com>
parents:
65599
diff
changeset
|
545 Image files should not be larger than specified by `max-image-size'." |
25003 | 546 (let (image) |
547 (while (and specs (null image)) | |
548 (let* ((spec (car specs)) | |
27073
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
549 (type (plist-get spec :type)) |
27059
6bb2a4a0413e
* image.el (defimage): Images with the :data keyword should be considered valid as well.
William M. Perry <wmperry@aventail.com>
parents:
26007
diff
changeset
|
550 (data (plist-get spec :data)) |
27921
ea0a2a4f20b7
(defimage): Look for image files in load-path.
Gerd Moellmann <gerd@gnu.org>
parents:
27075
diff
changeset
|
551 (file (plist-get spec :file)) |
ea0a2a4f20b7
(defimage): Look for image files in load-path.
Gerd Moellmann <gerd@gnu.org>
parents:
27075
diff
changeset
|
552 found) |
27073
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
553 (when (image-type-available-p type) |
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
554 (cond ((stringp file) |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
555 (if (setq found (image-search-load-path file)) |
65544
78d74ef1436b
2005-09-15 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
64762
diff
changeset
|
556 (setq image |
78d74ef1436b
2005-09-15 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
64762
diff
changeset
|
557 (cons 'image (plist-put (copy-sequence spec) |
78d74ef1436b
2005-09-15 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
64762
diff
changeset
|
558 :file found))))) |
27075
893ec72bd6b1
(create-image, defimage): Don't assume image data is a
Gerd Moellmann <gerd@gnu.org>
parents:
27073
diff
changeset
|
559 ((not (null data)) |
27073
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
560 (setq image (cons 'image spec))))) |
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
561 (setq specs (cdr specs)))) |
28721
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
562 image)) |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
563 |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
564 |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
565 ;;;###autoload |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
566 (defmacro defimage (symbol specs &optional doc) |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
567 "Define SYMBOL as an image. |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
568 |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
569 SPECS is a list of image specifications. DOC is an optional |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
570 documentation string. |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
571 |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
572 Each image specification in SPECS is a property list. The contents of |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
573 a specification are image type dependent. All specifications must at |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
574 least contain the properties `:type TYPE' and either `:file FILE' or |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
575 `:data DATA', where TYPE is a symbol specifying the image type, |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
576 e.g. `xbm', FILE is the file to load the image from, and DATA is a |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
577 string containing the actual image data. The first image |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
578 specification whose TYPE is supported, and FILE exists, is used to |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
579 define SYMBOL. |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
580 |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
581 Example: |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
582 |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
583 (defimage test-image ((:type xpm :file \"~/test1.xpm\") |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
584 (:type xbm :file \"~/test1.xbm\")))" |
66402
ade0d81f63a9
(defimage): Add `doc-string' declaration.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66307
diff
changeset
|
585 (declare (doc-string 3)) |
28721
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
586 `(defvar ,symbol (find-image ',specs) ,doc)) |
25003 | 587 |
107360 | 588 |
589 ;;; Animated image API | |
25003 | 590 |
107360 | 591 (defcustom image-animate-max-time 30 |
592 "Time in seconds to animate images." | |
593 :type 'integer | |
107369
f2fb364fb3ba
Minor animated image housekeeping.
Glenn Morris <rgm@gnu.org>
parents:
107360
diff
changeset
|
594 :version "24.1" |
107360 | 595 :group 'image) |
596 | |
597 (defconst image-animated-types '(gif) | |
598 "List of supported animated image types.") | |
599 | |
600 ;;;###autoload | |
601 (defun create-animated-image (file-or-data &optional type data-p &rest props) | |
602 "Create an animated image. | |
603 FILE-OR-DATA is an image file name or image data. | |
604 Optional TYPE is a symbol describing the image type. If TYPE is omitted | |
605 or nil, try to determine the image type from its first few bytes | |
606 of image data. If that doesn't work, and FILE-OR-DATA is a file name, | |
607 use its file extension as image type. | |
608 Optional DATA-P non-nil means FILE-OR-DATA is a string containing image data. | |
609 Optional PROPS are additional image attributes to assign to the image, | |
610 like, e.g. `:mask MASK'. | |
611 Value is the image created, or nil if images of type TYPE are not supported. | |
612 | |
613 Images should not be larger than specified by `max-image-size'." | |
614 (setq type (image-type file-or-data type data-p)) | |
615 (when (image-type-available-p type) | |
616 (let* ((animate (memq type image-animated-types)) | |
617 (image | |
618 (append (list 'image :type type (if data-p :data :file) file-or-data) | |
619 (if animate '(:index 0 :mask heuristic)) | |
620 props))) | |
621 (if animate | |
622 (image-animate-start image)) | |
623 image))) | |
624 | |
625 (defun image-animate-timer (image) | |
626 "Return the animation timer for image IMAGE." | |
627 ;; See cancel-function-timers | |
628 (let ((tail timer-list) timer) | |
629 (while tail | |
630 (setq timer (car tail) | |
631 tail (cdr tail)) | |
632 (if (and (eq (aref timer 5) #'image-animate-timeout) | |
633 (consp (aref timer 6)) | |
634 (eq (car (aref timer 6)) image)) | |
635 (setq tail nil) | |
636 (setq timer nil))) | |
637 timer)) | |
638 | |
639 (defun image-animate-start (image &optional max-time) | |
640 "Start animation of image IMAGE. | |
641 Optional second arg MAX-TIME is number of seconds to animate image, | |
642 or t to animate infinitely." | |
643 (let ((anim (image-animated-p image)) | |
644 timer tmo) | |
645 (when anim | |
646 (if (setq timer (image-animate-timer image)) | |
647 (setcar (nthcdr 3 (aref timer 6)) max-time) | |
648 (setq tmo (* (cdr anim) 0.01)) | |
649 (setq max-time (or max-time image-animate-max-time)) | |
650 (run-with-timer tmo nil #'image-animate-timeout | |
651 image 1 (car anim) | |
652 (if (numberp max-time) | |
653 (- max-time tmo) | |
654 max-time)))))) | |
655 | |
656 (defun image-animate-stop (image) | |
657 "Stop animation of image." | |
658 (let ((timer (image-animate-timer image))) | |
659 (when timer | |
660 (cancel-timer timer)))) | |
661 | |
662 (defun image-animate-timeout (image ino count time-left) | |
663 (if (>= ino count) | |
664 (setq ino 0)) | |
665 (plist-put (cdr image) :index ino) | |
666 (force-window-update) | |
667 (let ((anim (image-animated-p image)) tmo) | |
668 (when anim | |
669 (setq tmo (* (cdr anim) 0.01)) | |
670 (unless (and (= ino 0) (numberp time-left) (< time-left tmo)) | |
671 (run-with-timer tmo nil #'image-animate-timeout | |
672 image (1+ ino) count | |
673 (if (numberp time-left) | |
674 (- time-left tmo) | |
675 time-left)))))) | |
676 | |
677 (defun image-animated-p (image) | |
678 "Return non-nil if image is animated. | |
679 Actually, return value is a cons (IMAGES . DELAY) where IMAGES | |
680 is the number of sub-images in the animated image, and DELAY | |
681 is the delay in 100ths of a second until the next sub-image | |
682 shall be displayed." | |
683 (cond | |
684 ((eq (plist-get (cdr image) :type) 'gif) | |
107719
9c0ed2d6731a
Rename `image-extension-data' to `image-metadata'.
Juri Linkov <juri@jurta.org>
parents:
107369
diff
changeset
|
685 (let* ((metadata (image-metadata image)) |
9c0ed2d6731a
Rename `image-extension-data' to `image-metadata'.
Juri Linkov <juri@jurta.org>
parents:
107369
diff
changeset
|
686 (images (plist-get metadata 'count)) |
9c0ed2d6731a
Rename `image-extension-data' to `image-metadata'.
Juri Linkov <juri@jurta.org>
parents:
107369
diff
changeset
|
687 (extdata (plist-get metadata 'extension-data)) |
108778
6c819187f088
* image.el (image-animated-p): When delay between animated images is 0,
Juri Linkov <juri@jurta.org>
parents:
108746
diff
changeset
|
688 (anim (plist-get extdata #xF9)) |
6c819187f088
* image.el (image-animated-p): When delay between animated images is 0,
Juri Linkov <juri@jurta.org>
parents:
108746
diff
changeset
|
689 (tmo (and (integerp images) (> images 1) |
6c819187f088
* image.el (image-animated-p): When delay between animated images is 0,
Juri Linkov <juri@jurta.org>
parents:
108746
diff
changeset
|
690 (stringp anim) (>= (length anim) 4) |
6c819187f088
* image.el (image-animated-p): When delay between animated images is 0,
Juri Linkov <juri@jurta.org>
parents:
108746
diff
changeset
|
691 (+ (aref anim 1) (* (aref anim 2) 256))))) |
6c819187f088
* image.el (image-animated-p): When delay between animated images is 0,
Juri Linkov <juri@jurta.org>
parents:
108746
diff
changeset
|
692 (when tmo |
6c819187f088
* image.el (image-animated-p): When delay between animated images is 0,
Juri Linkov <juri@jurta.org>
parents:
108746
diff
changeset
|
693 (if (eq tmo 0) (setq tmo 10)) |
6c819187f088
* image.el (image-animated-p): When delay between animated images is 0,
Juri Linkov <juri@jurta.org>
parents:
108746
diff
changeset
|
694 (cons images tmo)))))) |
107360 | 695 |
696 | |
25003 | 697 (provide 'image) |
698 | |
66402
ade0d81f63a9
(defimage): Add `doc-string' declaration.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66307
diff
changeset
|
699 ;; arch-tag: 8e76a07b-eb48-4f3e-a7a0-1a7ba9f096b3 |
25872 | 700 ;;; image.el ends here |