Mercurial > emacs
annotate lisp/image.el @ 105458:4d2aa5860e37
(Ffile_attributes): Doc fix. (Bug#4638)
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Mon, 05 Oct 2009 08:35:12 +0000 |
parents | a4c2188bd87d |
children | 1d1d5d9bd884 |
rev | line source |
---|---|
25003 | 1 ;;; image.el --- image API |
2 | |
64762
41bb365f41c4
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64091
diff
changeset
|
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, |
100908 | 4 ;; 2004, 2005, 2006, 2007, 2008, 2009 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 | |
33 | |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
34 (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
|
35 `(("\\`/[\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
|
36 ("\\`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
|
37 ("\\`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
|
38 ("\\`\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
|
39 ("\\`[\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
|
40 #define \\1_height [0-9]+\n\\(\ |
e8248a7b666d
(image-type-header-regexps): Recognize more xbm format
Andreas Schwab <schwab@suse.de>
parents:
96380
diff
changeset
|
41 #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
|
42 #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
|
43 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
|
44 ("\\`\\(?: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
|
45 ("\\`[\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
|
46 ("\\`\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
|
47 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)") |
de6e597c221b
(image-type-header-regexps): Use more complex regexp for svg.
Juri Linkov <juri@jurta.org>
parents:
82734
diff
changeset
|
48 (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
|
49 (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
|
50 comment-re "*" |
de6e597c221b
(image-type-header-regexps): Use more complex regexp for svg.
Juri Linkov <juri@jurta.org>
parents:
82734
diff
changeset
|
51 "\\(?:!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
|
52 "[Ss][Vv][Gg]")) |
de6e597c221b
(image-type-header-regexps): Use more complex regexp for svg.
Juri Linkov <juri@jurta.org>
parents:
82734
diff
changeset
|
53 . svg) |
de6e597c221b
(image-type-header-regexps): Use more complex regexp for svg.
Juri Linkov <juri@jurta.org>
parents:
82734
diff
changeset
|
54 ) |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
55 "Alist of (REGEXP . IMAGE-TYPE) pairs used to auto-detect image types. |
25003 | 56 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
|
57 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
|
58 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
|
59 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
|
60 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
|
61 |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
62 (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
|
63 '(("\\.png\\'" . png) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
64 ("\\.gif\\'" . gif) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
65 ("\\.jpe?g\\'" . jpeg) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
66 ("\\.bmp\\'" . bmp) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
67 ("\\.xpm\\'" . xpm) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
68 ("\\.pbm\\'" . pbm) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
69 ("\\.xbm\\'" . xbm) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
70 ("\\.ps\\'" . postscript) |
82835
de6e597c221b
(image-type-header-regexps): Use more complex regexp for svg.
Juri Linkov <juri@jurta.org>
parents:
82734
diff
changeset
|
71 ("\\.tiff?\\'" . tiff) |
de6e597c221b
(image-type-header-regexps): Use more complex regexp for svg.
Juri Linkov <juri@jurta.org>
parents:
82734
diff
changeset
|
72 ("\\.svgz?\\'" . svg) |
de6e597c221b
(image-type-header-regexps): Use more complex regexp for svg.
Juri Linkov <juri@jurta.org>
parents:
82734
diff
changeset
|
73 ) |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
74 "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
|
75 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
|
76 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
|
77 |
75744
53fa6ea37e3a
(image-type-auto-detectable): Don't autodetect x[pb]m.
Chong Yidong <cyd@stupidchicken.com>
parents:
75472
diff
changeset
|
78 ;; 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
|
79 ;; 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
|
80 ;; 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
|
81 (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
|
82 '((pbm . t) |
75744
53fa6ea37e3a
(image-type-auto-detectable): Don't autodetect x[pb]m.
Chong Yidong <cyd@stupidchicken.com>
parents:
75472
diff
changeset
|
83 (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
|
84 (bmp . maybe) |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
85 (gif . maybe) |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
86 (png . maybe) |
75744
53fa6ea37e3a
(image-type-auto-detectable): Don't autodetect x[pb]m.
Chong Yidong <cyd@stupidchicken.com>
parents:
75472
diff
changeset
|
87 (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
|
88 (jpeg . maybe) |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
89 (tiff . maybe) |
82835
de6e597c221b
(image-type-header-regexps): Use more complex regexp for svg.
Juri Linkov <juri@jurta.org>
parents:
82734
diff
changeset
|
90 (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
|
91 (postscript . nil)) |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
92 "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
|
93 \(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
|
94 |
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
95 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
|
96 - 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
|
97 - 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
|
98 - 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
|
99 (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
|
100 |
104978
a4c2188bd87d
* startup.el (tutorial-directory): Make it a defcustom.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
104690
diff
changeset
|
101 (defcustom image-load-path |
a4c2188bd87d
* startup.el (tutorial-directory): Make it a defcustom.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
104690
diff
changeset
|
102 (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
|
103 'data-directory 'load-path) |
65544
78d74ef1436b
2005-09-15 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
64762
diff
changeset
|
104 "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
|
105 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
|
106 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
|
107 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
|
108 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
|
109 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
|
110 :type '(repeat (choice directory variable)) |
a4c2188bd87d
* startup.el (tutorial-directory): Make it a defcustom.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
104690
diff
changeset
|
111 :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
|
112 |
69471
6f07bf99b6f8
(image-load-path-for-library): Pass value of path rather than symbol.
Bill Wohler <wohler@newt.com>
parents:
69365
diff
changeset
|
113 |
69365
0a2d89023fde
(image-load-path-for-library): Merged changes from Reiner. Add
Bill Wohler <wohler@newt.com>
parents:
69360
diff
changeset
|
114 (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
|
115 "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
|
116 |
69535
3feef8dfbff5
(image-load-path-for-library): Minor docstring fix.
Bill Wohler <wohler@newt.com>
parents:
69516
diff
changeset
|
117 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
|
118 \"`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
|
119 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
|
120 \"../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
|
121 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
|
122 |
69471
6f07bf99b6f8
(image-load-path-for-library): Pass value of path rather than symbol.
Bill Wohler <wohler@newt.com>
parents:
69365
diff
changeset
|
123 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
|
124 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
|
125 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
|
126 `load-path'. |
69365
0a2d89023fde
(image-load-path-for-library): Merged changes from Reiner. Add
Bill Wohler <wohler@newt.com>
parents:
69360
diff
changeset
|
127 |
69471
6f07bf99b6f8
(image-load-path-for-library): Pass value of path rather than symbol.
Bill Wohler <wohler@newt.com>
parents:
69365
diff
changeset
|
128 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
|
129 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
|
130 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
|
131 |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
132 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
|
133 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
|
134 `image-load-path': |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
135 |
69493
4f9233243d97
(image-load-path-for-library): Fix example by not recommending that
Bill Wohler <wohler@newt.com>
parents:
69471
diff
changeset
|
136 ;; Shush compiler. |
4f9233243d97
(image-load-path-for-library): Fix example by not recommending that
Bill Wohler <wohler@newt.com>
parents:
69471
diff
changeset
|
137 (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
|
138 |
6f07bf99b6f8
(image-load-path-for-library): Pass value of path rather than symbol.
Bill Wohler <wohler@newt.com>
parents:
69365
diff
changeset
|
139 (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
|
140 (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
|
141 (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
|
142 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
|
143 (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
|
144 (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
|
145 (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
|
146 (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
|
147 ;; 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
|
148 (let ((img image) |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
149 (dir (or |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
150 ;; 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
|
151 (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
|
152 ;; Images in load-path. |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
153 (locate-library image))) |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
154 parent) |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
155 ;; 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
|
156 ;; 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
|
157 ;; accordingly. |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
158 (when dir |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
159 (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
|
160 (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
|
161 (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
|
162 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
|
163 (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
|
164 |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
165 ;; 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
|
166 ;; 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
|
167 ;; 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
|
168 ;; `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
|
169 (cond |
69516
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
170 ;; 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
|
171 ((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
|
172 (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
|
173 (file-name-as-directory |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
174 (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
|
175 (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
|
176 ;; Try relative setting. |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
177 ((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
|
178 ;; 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
|
179 (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
|
180 (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
|
181 (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
|
182 ;; 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
|
183 (setq |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
184 ;; 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
|
185 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
|
186 (expand-file-name |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
187 (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
|
188 ;; 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
|
189 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
|
190 (expand-file-name |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
191 (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
|
192 (setq image-directory |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
193 ;; 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
|
194 (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
|
195 ((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
|
196 ;; Use Emacs' image directory. |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
197 (image-directory-load-path |
e419733d5cf6
(image-load-path-for-library): Prefer user's images in
Bill Wohler <wohler@newt.com>
parents:
69493
diff
changeset
|
198 (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
|
199 (no-error |
0a2d89023fde
(image-load-path-for-library): Merged changes from Reiner. Add
Bill Wohler <wohler@newt.com>
parents:
69360
diff
changeset
|
200 (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
|
201 (t |
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
202 (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
|
203 |
69471
6f07bf99b6f8
(image-load-path-for-library): Pass value of path rather than symbol.
Bill Wohler <wohler@newt.com>
parents:
69365
diff
changeset
|
204 ;; 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
|
205 (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
|
206 (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
|
207 |
69360
e5e4303f8050
(image-load-path-for-library): Merge at least three functions from
Bill Wohler <wohler@newt.com>
parents:
68651
diff
changeset
|
208 |
38732
24fe4f884e82
(image-type-regexps): Allow predicates. Change the way
Gerd Moellmann <gerd@gnu.org>
parents:
38711
diff
changeset
|
209 (defun image-jpeg-p (data) |
46810
65ad7b458435
(image-jpeg-p): Accept "Exif" marker.
Richard M. Stallman <rms@gnu.org>
parents:
43834
diff
changeset
|
210 "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
|
211 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
|
212 (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
|
213 (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
|
214 (catch 'jfif |
24fe4f884e82
(image-type-regexps): Allow predicates. Change the way
Gerd Moellmann <gerd@gnu.org>
parents:
38711
diff
changeset
|
215 (let ((len (length data)) (i 2)) |
24fe4f884e82
(image-type-regexps): Allow predicates. Change the way
Gerd Moellmann <gerd@gnu.org>
parents:
38711
diff
changeset
|
216 (while (< i len) |
24fe4f884e82
(image-type-regexps): Allow predicates. Change the way
Gerd Moellmann <gerd@gnu.org>
parents:
38711
diff
changeset
|
217 (when (/= (aref data i) #xff) |
24fe4f884e82
(image-type-regexps): Allow predicates. Change the way
Gerd Moellmann <gerd@gnu.org>
parents:
38711
diff
changeset
|
218 (throw 'jfif nil)) |
24fe4f884e82
(image-type-regexps): Allow predicates. Change the way
Gerd Moellmann <gerd@gnu.org>
parents:
38711
diff
changeset
|
219 (setq i (1+ i)) |
24fe4f884e82
(image-type-regexps): Allow predicates. Change the way
Gerd Moellmann <gerd@gnu.org>
parents:
38711
diff
changeset
|
220 (when (>= (+ i 2) len) |
24fe4f884e82
(image-type-regexps): Allow predicates. Change the way
Gerd Moellmann <gerd@gnu.org>
parents:
38711
diff
changeset
|
221 (throw 'jfif nil)) |
24fe4f884e82
(image-type-regexps): Allow predicates. Change the way
Gerd Moellmann <gerd@gnu.org>
parents:
38711
diff
changeset
|
222 (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
|
223 (aref data (+ i 2)))) |
a679a282d5cb
(image-jpeg-p): Test for APPn markers in the range
Gerd Moellmann <gerd@gnu.org>
parents:
38746
diff
changeset
|
224 (code (aref data i))) |
a679a282d5cb
(image-jpeg-p): Test for APPn markers in the range
Gerd Moellmann <gerd@gnu.org>
parents:
38746
diff
changeset
|
225 (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
|
226 ;; APP0 LEN1 LEN2 "JFIF\0" |
49588
37645a051842
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48130
diff
changeset
|
227 (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
|
228 (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
|
229 (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
|
230 (setq i (+ i 1 nbytes)))))))) |
25003 | 231 |
232 | |
233 ;;;###autoload | |
27073
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
234 (defun image-type-from-data (data) |
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
235 "Determine the image type from image data DATA. |
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
236 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
|
237 be determined." |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
238 (let ((types image-type-header-regexps) |
27073
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
239 type) |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
240 (while types |
27073
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
241 (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
|
242 (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
|
243 (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
|
244 (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
|
245 (and (consp image-type) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
246 (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
|
247 (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
|
248 (setq type image-type |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
249 types nil) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
250 (setq types (cdr types))))) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
251 type)) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
252 |
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 ;;;###autoload |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
255 (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
|
256 "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
|
257 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
|
258 be determined." |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
259 (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
|
260 type |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
261 (opoint (point))) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
262 (goto-char (point-min)) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
263 (while types |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
264 (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
|
265 (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
|
266 data) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
267 (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
|
268 (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
|
269 (and (consp image-type) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
270 (funcall (car image-type) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
271 (or data |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
272 (setq data |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
273 (buffer-substring |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
274 (point-min) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
275 (min (point-max) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
276 (+ (point-min) 256)))))) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
277 (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
|
278 (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
|
279 types nil) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
280 (setq types (cdr types))))) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
281 (goto-char opoint) |
27073
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
282 type)) |
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
283 |
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 ;;;###autoload |
25003 | 286 (defun image-type-from-file-header (file) |
287 "Determine the type of image file FILE from its first few bytes. | |
288 Value is a symbol specifying the image type, or nil if type cannot | |
289 be determined." | |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
290 (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
|
291 (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
|
292 (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
|
293 (and file |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
294 (file-readable-p file) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
295 (with-temp-buffer |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
296 (set-buffer-multibyte nil) |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
297 (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
|
298 (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
|
299 |
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 ;;;###autoload |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
302 (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
|
303 "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
|
304 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
|
305 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
|
306 (assoc-default file image-type-file-name-regexps 'string-match-p)) |
25003 | 307 |
308 | |
309 ;;;###autoload | |
81013
b808e2e86f98
(image-type-from-file-name, image-type): Simplify.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
310 (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
|
311 "Determine and return image type. |
81013
b808e2e86f98
(image-type-from-file-name, image-type): Simplify.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
312 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
|
313 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
|
314 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
|
315 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
|
316 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
|
317 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
|
318 (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
|
319 (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
|
320 (unless type |
81013
b808e2e86f98
(image-type-from-file-name, image-type): Simplify.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
321 (setq type (if data-p |
b808e2e86f98
(image-type-from-file-name, image-type): Simplify.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
322 (image-type-from-data source) |
b808e2e86f98
(image-type-from-file-name, image-type): Simplify.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
323 (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
|
324 (image-type-from-file-name source)))) |
b808e2e86f98
(image-type-from-file-name, image-type): Simplify.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
325 (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
|
326 (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
|
327 (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
|
328 type) |
de6c9508749d
(image-type): New defun split out of create-image.
Kim F. Storm <storm@cua.dk>
parents:
69569
diff
changeset
|
329 |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
330 |
95841
b4e36ff621b3
Add some compiler declarations, for builds without X.
Glenn Morris <rgm@gnu.org>
parents:
94678
diff
changeset
|
331 (defvar image-library-alist) |
b4e36ff621b3
Add some compiler declarations, for builds without X.
Glenn Morris <rgm@gnu.org>
parents:
94678
diff
changeset
|
332 |
70170
de6c9508749d
(image-type): New defun split out of create-image.
Kim F. Storm <storm@cua.dk>
parents:
69569
diff
changeset
|
333 ;;;###autoload |
25003 | 334 (defun image-type-available-p (type) |
62816
f5a3eeaf3d70
(image-library-alist): Moved to image.c.
Juanma Barranquero <lekktu@gmail.com>
parents:
60688
diff
changeset
|
335 "Return non-nil if image type TYPE is available. |
25003 | 336 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
|
337 (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
|
338 (init-image-library type image-library-alist))) |
25003 | 339 |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
340 |
25003 | 341 ;;;###autoload |
74972
94afc7cac404
(image-type-header-regexps, image-type-from-data, image-type-from-buffer,
Juanma Barranquero <lekktu@gmail.com>
parents:
74916
diff
changeset
|
342 (defun image-type-auto-detected-p () |
78492
7c8949dbfa0d
Replace `iff' in doc-strings and comments.
Glenn Morris <rgm@gnu.org>
parents:
78236
diff
changeset
|
343 "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
|
344 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
|
345 |
77873
b2375f70c499
(image-type-auto-detected-p): Don't scan auto-mode-alist.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
346 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
|
347 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
|
348 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
|
349 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
|
350 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
|
351 (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
|
352 (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
|
353 (and auto |
77873
b2375f70c499
(image-type-auto-detected-p): Don't scan auto-mode-alist.
Chong Yidong <cyd@stupidchicken.com>
parents:
75744
diff
changeset
|
354 (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
|
355 |
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 ;;;###autoload |
27073
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
358 (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
|
359 "Create an image. |
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
360 FILE-OR-DATA is an image file name or image data. |
25003 | 361 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
|
362 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
|
363 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
|
364 use its file extension as image type. |
27073
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
365 Optional DATA-P non-nil means FILE-OR-DATA is a string containing image data. |
25003 | 366 Optional PROPS are additional image attributes to assign to the image, |
31635 | 367 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
|
368 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
|
369 |
82734 | 370 Images should not be larger than specified by `max-image-size'. |
371 | |
372 Image file names that are not absolute are searched for in the | |
373 \"images\" sub-directory of `data-directory' and | |
374 `x-bitmap-file-path' (in that order)." | |
375 ;; 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
|
376 (setq type (image-type file-or-data type data-p)) |
25003 | 377 (when (image-type-available-p type) |
27073
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
378 (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
|
379 props))) |
25003 | 380 |
381 | |
382 ;;;###autoload | |
29470
7bde123bed95
(find-image): Doc fix. Return nil if image not found.
Dave Love <fx@gnu.org>
parents:
28958
diff
changeset
|
383 (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
|
384 "Put image IMAGE in front of POS in the current buffer. |
25003 | 385 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
|
386 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
|
387 `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
|
388 image. STRING is defaulted if you omit it. |
25003 | 389 POS may be an integer or marker. |
390 AREA is where to display the image. AREA nil or omitted means | |
391 display it in the text area, a value of `left-margin' means | |
392 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
|
393 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
|
394 (unless string (setq string "x")) |
25617
697b28471784
(put-image): Remove optional buffer parameter.
Gerd Moellmann <gerd@gnu.org>
parents:
25309
diff
changeset
|
395 (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
|
396 (unless (eq (car-safe image) 'image) |
25617
697b28471784
(put-image): Remove optional buffer parameter.
Gerd Moellmann <gerd@gnu.org>
parents:
25309
diff
changeset
|
397 (error "Not an image: %s" image)) |
697b28471784
(put-image): Remove optional buffer parameter.
Gerd Moellmann <gerd@gnu.org>
parents:
25309
diff
changeset
|
398 (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
|
399 (error "Invalid area %s" area)) |
25816
2d53a03a3baa
(put-image, insert-image): Add string argument.
Gerd Moellmann <gerd@gnu.org>
parents:
25617
diff
changeset
|
400 (setq string (copy-sequence string)) |
25617
697b28471784
(put-image): Remove optional buffer parameter.
Gerd Moellmann <gerd@gnu.org>
parents:
25309
diff
changeset
|
401 (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
|
402 (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
|
403 (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
|
404 (overlay-put overlay 'put-image t) |
697b28471784
(put-image): Remove optional buffer parameter.
Gerd Moellmann <gerd@gnu.org>
parents:
25309
diff
changeset
|
405 (overlay-put overlay 'before-string string)))) |
25003 | 406 |
407 | |
408 ;;;###autoload | |
55033
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
409 (defun insert-image (image &optional string area slice) |
25003 | 410 "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
|
411 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
|
412 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
|
413 defaulted if you omit it. |
25003 | 414 AREA is where to display the image. AREA nil or omitted means |
415 display it in the text area, a value of `left-margin' means | |
416 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
|
417 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
|
418 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
|
419 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
|
420 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
|
421 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
|
422 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
|
423 ;; 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
|
424 ;; character in the buffer. |
ecb96a7369d3
Fix last change to be in insert-image as intended.
Dave Love <fx@gnu.org>
parents:
29624
diff
changeset
|
425 (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
|
426 (unless (eq (car-safe image) 'image) |
25003 | 427 (error "Not an image: %s" image)) |
428 (unless (or (null area) (memq area '(left-margin right-margin))) | |
429 (error "Invalid area %s" area)) | |
29607
42d156d8d8eb
(insert-image): Save a little consing.
Dave Love <fx@gnu.org>
parents:
29470
diff
changeset
|
430 (if area |
42d156d8d8eb
(insert-image): Save a little consing.
Dave Love <fx@gnu.org>
parents:
29470
diff
changeset
|
431 (setq image (list (list 'margin area) image)) |
42d156d8d8eb
(insert-image): Save a little consing.
Dave Love <fx@gnu.org>
parents:
29470
diff
changeset
|
432 ;; 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
|
433 ;; 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
|
434 ;; 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
|
435 ;; 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
|
436 ;; 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
|
437 ;; of it loses anyway.) |
42d156d8d8eb
(insert-image): Save a little consing.
Dave Love <fx@gnu.org>
parents:
29470
diff
changeset
|
438 (setq image (cons 'image (cdr image)))) |
25816
2d53a03a3baa
(put-image, insert-image): Add string argument.
Gerd Moellmann <gerd@gnu.org>
parents:
25617
diff
changeset
|
439 (let ((start (point))) |
2d53a03a3baa
(put-image, insert-image): Add string argument.
Gerd Moellmann <gerd@gnu.org>
parents:
25617
diff
changeset
|
440 (insert string) |
2d53a03a3baa
(put-image, insert-image): Add string argument.
Gerd Moellmann <gerd@gnu.org>
parents:
25617
diff
changeset
|
441 (add-text-properties start (point) |
55033
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
442 `(display ,(if slice |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
443 (list (cons 'slice slice) image) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
444 image) rear-nonsticky (display))))) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
445 |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
446 |
60688
b0de8a447a79
(insert-sliced-image): Add autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
59276
diff
changeset
|
447 ;;;###autoload |
55033
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
448 (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
|
449 "Insert IMAGE into current buffer at point. |
090c23fa222c
(insert-sliced-image): Add doc string.
Kim F. Storm <storm@cua.dk>
parents:
56189
diff
changeset
|
450 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
|
451 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
|
452 defaulted if you omit it. |
090c23fa222c
(insert-sliced-image): Add doc string.
Kim F. Storm <storm@cua.dk>
parents:
56189
diff
changeset
|
453 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
|
454 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
|
455 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
|
456 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
|
457 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
|
458 (unless string (setq string " ")) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
459 (unless (eq (car-safe image) 'image) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
460 (error "Not an image: %s" image)) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
461 (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
|
462 (error "Invalid area %s" area)) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
463 (if area |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
464 (setq image (list (list 'margin area) image)) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
465 ;; 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
|
466 ;; 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
|
467 ;; 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
|
468 ;; 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
|
469 ;; 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
|
470 ;; of it loses anyway.) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
471 (setq image (cons 'image (cdr image)))) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
472 (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
|
473 (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
|
474 (while (< y 1.0) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
475 (while (< x 1.0) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
476 (let ((start (point))) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
477 (insert string) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
478 (add-text-properties start (point) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
479 `(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
|
480 rear-nonsticky (display))) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
481 (setq x (+ x dx)))) |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
482 (setq x 0.0 |
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
483 y (+ y dy)) |
59276
d50d807507e0
(insert-sliced-image): Use t for line-height property.
Kim F. Storm <storm@cua.dk>
parents:
57196
diff
changeset
|
484 (insert (propertize "\n" 'line-height t))))) |
55033
a7dfcd60873e
(insert-image): Add optional SLICE arg.
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
485 |
26007
774b2504710b
(insert-image): Copy the image spec and add an intangible property.
Dave Love <fx@gnu.org>
parents:
25872
diff
changeset
|
486 |
25003 | 487 |
488 ;;;###autoload | |
489 (defun remove-images (start end &optional buffer) | |
490 "Remove images between START and END in BUFFER. | |
491 Remove only images that were put in BUFFER with calls to `put-image'. | |
492 BUFFER nil or omitted means use the current buffer." | |
493 (unless buffer | |
494 (setq buffer (current-buffer))) | |
495 (let ((overlays (overlays-in start end))) | |
496 (while overlays | |
497 (let ((overlay (car overlays))) | |
498 (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
|
499 (delete-overlay overlay))) |
fdc2bd91cf63
(defimage): Remove redundant code. Substitute file on image plist.
Dave Love <fx@gnu.org>
parents:
25816
diff
changeset
|
500 (setq overlays (cdr overlays))))) |
25003 | 501 |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
502 (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
|
503 (unless path |
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
504 (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
|
505 (let (element found filename) |
65544
78d74ef1436b
2005-09-15 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
64762
diff
changeset
|
506 (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
|
507 (setq element (car path)) |
65544
78d74ef1436b
2005-09-15 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
64762
diff
changeset
|
508 (cond |
65599
39114a2ae201
(image-load-path): Use symbol `data-directory' instead of its value,
Chong Yidong <cyd@stupidchicken.com>
parents:
65544
diff
changeset
|
509 ((stringp element) |
65544
78d74ef1436b
2005-09-15 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
64762
diff
changeset
|
510 (setq found |
78d74ef1436b
2005-09-15 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
64762
diff
changeset
|
511 (file-readable-p |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
512 (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
|
513 ((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
|
514 (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
|
515 (cond |
39114a2ae201
(image-load-path): Use symbol `data-directory' instead of its value,
Chong Yidong <cyd@stupidchicken.com>
parents:
65544
diff
changeset
|
516 ((stringp element) |
39114a2ae201
(image-load-path): Use symbol `data-directory' instead of its value,
Chong Yidong <cyd@stupidchicken.com>
parents:
65544
diff
changeset
|
517 (setq found |
39114a2ae201
(image-load-path): Use symbol `data-directory' instead of its value,
Chong Yidong <cyd@stupidchicken.com>
parents:
65544
diff
changeset
|
518 (file-readable-p |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
519 (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
|
520 ((consp element) |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
521 (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
|
522 (setq found t)))))) |
65544
78d74ef1436b
2005-09-15 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
64762
diff
changeset
|
523 (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
|
524 (if found filename))) |
25003 | 525 |
526 ;;;###autoload | |
28721
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
527 (defun find-image (specs) |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
528 "Find an image, choosing one of a list of image specifications. |
25003 | 529 |
29470
7bde123bed95
(find-image): Doc fix. Return nil if image not found.
Dave Love <fx@gnu.org>
parents:
28958
diff
changeset
|
530 SPECS is a list of image specifications. |
25003 | 531 |
532 Each image specification in SPECS is a property list. The contents of | |
533 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
|
534 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
|
535 `: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
|
536 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
|
537 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
|
538 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
|
539 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
|
540 satisfied. |
7bde123bed95
(find-image): Doc fix. Return nil if image not found.
Dave Love <fx@gnu.org>
parents:
28958
diff
changeset
|
541 |
66196
2e59eea25fcf
* image.el (create-image, find-image): Mention max-image-size in
Chong Yidong <cyd@stupidchicken.com>
parents:
65599
diff
changeset
|
542 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
|
543 |
2e59eea25fcf
* image.el (create-image, find-image): Mention max-image-size in
Chong Yidong <cyd@stupidchicken.com>
parents:
65599
diff
changeset
|
544 Image files should not be larger than specified by `max-image-size'." |
25003 | 545 (let (image) |
546 (while (and specs (null image)) | |
547 (let* ((spec (car specs)) | |
27073
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
548 (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
|
549 (data (plist-get spec :data)) |
27921
ea0a2a4f20b7
(defimage): Look for image files in load-path.
Gerd Moellmann <gerd@gnu.org>
parents:
27075
diff
changeset
|
550 (file (plist-get spec :file)) |
ea0a2a4f20b7
(defimage): Look for image files in load-path.
Gerd Moellmann <gerd@gnu.org>
parents:
27075
diff
changeset
|
551 found) |
27073
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
552 (when (image-type-available-p type) |
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
553 (cond ((stringp file) |
66296
941b6508462f
(image-type-header-regexps): Rename from image-type-regexps.
Kim F. Storm <storm@cua.dk>
parents:
66196
diff
changeset
|
554 (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
|
555 (setq image |
78d74ef1436b
2005-09-15 Chong Yidong <cyd@stupidchicken.com>
Chong Yidong <cyd@stupidchicken.com>
parents:
64762
diff
changeset
|
556 (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
|
557 :file found))))) |
27075
893ec72bd6b1
(create-image, defimage): Don't assume image data is a
Gerd Moellmann <gerd@gnu.org>
parents:
27073
diff
changeset
|
558 ((not (null data)) |
27073
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
559 (setq image (cons 'image spec))))) |
aad0a025b1e3
(defimage): Handle specifications containing :data
Gerd Moellmann <gerd@gnu.org>
parents:
27059
diff
changeset
|
560 (setq specs (cdr specs)))) |
28721
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
561 image)) |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
562 |
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 ;;;###autoload |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
565 (defmacro defimage (symbol specs &optional doc) |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
566 "Define SYMBOL as an image. |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
567 |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
568 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
|
569 documentation string. |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
570 |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
571 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
|
572 a specification are image type dependent. All specifications must at |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
573 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
|
574 `: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
|
575 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
|
576 string containing the actual image data. The first image |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
577 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
|
578 define SYMBOL. |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
579 |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
580 Example: |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
581 |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
582 (defimage test-image ((:type xpm :file \"~/test1.xpm\") |
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
583 (:type xbm :file \"~/test1.xbm\")))" |
66402
ade0d81f63a9
(defimage): Add `doc-string' declaration.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66307
diff
changeset
|
584 (declare (doc-string 3)) |
28721
b4ea18c92e38
(find-image): New function.
Gerd Moellmann <gerd@gnu.org>
parents:
27921
diff
changeset
|
585 `(defvar ,symbol (find-image ',specs) ,doc)) |
25003 | 586 |
587 | |
588 (provide 'image) | |
589 | |
66402
ade0d81f63a9
(defimage): Add `doc-string' declaration.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
66307
diff
changeset
|
590 ;; arch-tag: 8e76a07b-eb48-4f3e-a7a0-1a7ba9f096b3 |
25872 | 591 ;;; image.el ends here |