Mercurial > emacs
annotate lisp/image-file.el @ 57464:1d5bc0282257
*** empty log message ***
author | Stefan Monnier <monnier@iro.umontreal.ca> |
---|---|
date | Tue, 12 Oct 2004 22:55:48 +0000 |
parents | 695cf19ef79e |
children | 2fa021a3a2fb 375f2633d815 |
rev | line source |
---|---|
42558 | 1 ;;; image-file.el --- support for visiting image files |
31934 | 2 ;; |
35884
3d9c9fe711c4
(insert-image-file): When visiting an image, set `truncate-lines' to t
Miles Bader <miles@gnu.org>
parents:
35854
diff
changeset
|
3 ;; Copyright (C) 2000, 2001 Free Software Foundation, Inc. |
31934 | 4 ;; |
5 ;; Author: Miles Bader <miles@gnu.org> | |
6 ;; Keywords: multimedia | |
7 | |
8 ;; This file is part of GNU Emacs. | |
9 | |
10 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 ;; it under the terms of the GNU General Public License as published by | |
12 ;; the Free Software Foundation; either version 2, or (at your option) | |
13 ;; any later version. | |
14 | |
15 ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 ;; GNU General Public License for more details. | |
19 | |
20 ;; You should have received a copy of the GNU General Public License | |
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
23 ;; Boston, MA 02111-1307, USA. | |
24 | |
25 ;;; Commentary: | |
26 | |
27 ;; Defines a file-name-handler hook that transforms visited (or | |
42558 | 28 ;; inserted) image files so that they are displayed by Emacs as |
31934 | 29 ;; images. This is done by putting a `display' text-property on the |
30 ;; image data, with the image-data still present underneath; if the | |
31 ;; resulting buffer file is saved to another name it will correctly save | |
32 ;; the image data to the new file. | |
33 | |
34 ;;; Code: | |
35 | |
36 (require 'image) | |
37 | |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
38 |
32440
4e98e54082d2
(image-file-name-extensions, image-file-name-regexps): Add autoload cookies.
Miles Bader <miles@gnu.org>
parents:
32316
diff
changeset
|
39 ;;;###autoload |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
40 (defcustom image-file-name-extensions |
42141
55c0ac959234
(image-file-name-extensions): Add pnm. Doc fix.
Dave Love <fx@gnu.org>
parents:
36213
diff
changeset
|
41 '("png" "jpeg" "jpg" "gif" "tiff" "tif" "xbm" "xpm" "pbm" "pgm" "ppm" "pnm") |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
42 "*A list of image-file filename extensions. |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
43 Filenames having one of these extensions are considered image files, |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
44 in addition to those matching `image-file-name-regexps'. |
31934 | 45 |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
46 See `auto-image-file-mode'; if `auto-image-file-mode' is enabled, |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
47 setting this variable directly does not take effect unless |
42141
55c0ac959234
(image-file-name-extensions): Add pnm. Doc fix.
Dave Love <fx@gnu.org>
parents:
36213
diff
changeset
|
48 `auto-image-file-mode' is re-enabled; this happens automatically when |
55c0ac959234
(image-file-name-extensions): Add pnm. Doc fix.
Dave Love <fx@gnu.org>
parents:
36213
diff
changeset
|
49 the variable is set using \\[customize]." |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
50 :type '(repeat string) |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
51 :set (lambda (sym val) |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
52 (set-default sym val) |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
53 (when auto-image-file-mode |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
54 ;; Re-initialize the image-file handler |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
55 (auto-image-file-mode t))) |
31934 | 56 :initialize 'custom-initialize-default |
57 :group 'image) | |
58 | |
32440
4e98e54082d2
(image-file-name-extensions, image-file-name-regexps): Add autoload cookies.
Miles Bader <miles@gnu.org>
parents:
32316
diff
changeset
|
59 ;;;###autoload |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
60 (defcustom image-file-name-regexps nil |
32185
f7460e78c02a
Docstring fixes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
32003
diff
changeset
|
61 "*List of regexps matching image-file filenames. |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
62 Filenames matching one of these regexps are considered image files, |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
63 in addition to those with an extension in `image-file-name-extensions'. |
31934 | 64 |
32220
3c7e4ccb6fee
(image-file-name-extensions): Add pbm.
Dave Love <fx@gnu.org>
parents:
32218
diff
changeset
|
65 See function `auto-image-file-mode'; if `auto-image-file-mode' is |
3c7e4ccb6fee
(image-file-name-extensions): Add pbm.
Dave Love <fx@gnu.org>
parents:
32218
diff
changeset
|
66 enabled, setting this variable directly does not take effect unless |
42141
55c0ac959234
(image-file-name-extensions): Add pnm. Doc fix.
Dave Love <fx@gnu.org>
parents:
36213
diff
changeset
|
67 `auto-image-file-mode' is re-enabled; this happens automatically when |
55c0ac959234
(image-file-name-extensions): Add pnm. Doc fix.
Dave Love <fx@gnu.org>
parents:
36213
diff
changeset
|
68 the variable is set using \\[customize]." |
31934 | 69 :type '(repeat regexp) |
70 :set (lambda (sym val) | |
71 (set-default sym val) | |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
72 (when auto-image-file-mode |
31934 | 73 ;; Re-initialize the image-file handler |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
74 (auto-image-file-mode t))) |
31934 | 75 :initialize 'custom-initialize-default |
76 :group 'image) | |
77 | |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
78 |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
79 ;;;###autoload |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
80 (defun image-file-name-regexp () |
32185
f7460e78c02a
Docstring fixes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
32003
diff
changeset
|
81 "Return a regular expression matching image-file filenames." |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
82 (let ((exts-regexp |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
83 (and image-file-name-extensions |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
84 (concat "\\." |
34074
89fcace178df
(image-file-name-regexp): Automatically add upper-case variants of each
Miles Bader <miles@gnu.org>
parents:
33727
diff
changeset
|
85 (regexp-opt (nconc (mapcar #'upcase |
89fcace178df
(image-file-name-regexp): Automatically add upper-case variants of each
Miles Bader <miles@gnu.org>
parents:
33727
diff
changeset
|
86 image-file-name-extensions) |
89fcace178df
(image-file-name-regexp): Automatically add upper-case variants of each
Miles Bader <miles@gnu.org>
parents:
33727
diff
changeset
|
87 image-file-name-extensions) |
89fcace178df
(image-file-name-regexp): Automatically add upper-case variants of each
Miles Bader <miles@gnu.org>
parents:
33727
diff
changeset
|
88 t) |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
89 "\\'")))) |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
90 (if image-file-name-regexps |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
91 (mapconcat 'identity |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
92 (if exts-regexp |
32218
65d06b88701d
(image-file-name-regexp): image-file-regexps -> image-file-name-regexps.
Dave Love <fx@gnu.org>
parents:
32185
diff
changeset
|
93 (cons exts-regexp image-file-name-regexps) |
65d06b88701d
(image-file-name-regexp): image-file-regexps -> image-file-name-regexps.
Dave Love <fx@gnu.org>
parents:
32185
diff
changeset
|
94 image-file-name-regexps) |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
95 "\\|") |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
96 exts-regexp))) |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
97 |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
98 |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
99 ;;;###autoload |
31934 | 100 (defun insert-image-file (file &optional visit beg end replace) |
101 "Insert the image file FILE into the current buffer. | |
102 Optional arguments VISIT, BEG, END, and REPLACE are interpreted as for | |
103 the command `insert-file-contents'." | |
104 (let ((rval | |
105 (image-file-call-underlying #'insert-file-contents-literally | |
106 'insert-file-contents | |
107 file visit beg end replace))) | |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
108 ;; Turn the image data into a real image, but only if the whole file |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
109 ;; was inserted |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
110 (when (and (or (null beg) (zerop beg)) (null end)) |
31934 | 111 (let* ((ibeg (point)) |
112 (iend (+ (point) (cadr rval))) | |
35854
a8fd9112792b
(insert-image-file): When visiting an image, suppress the cursor in the
Miles Bader <miles@gnu.org>
parents:
34650
diff
changeset
|
113 (visitingp (and visit (= ibeg (point-min)) (= iend (point-max)))) |
31934 | 114 (data |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
115 (string-make-unibyte |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
116 (buffer-substring-no-properties ibeg iend))) |
31934 | 117 (image |
118 (create-image data nil t)) | |
119 (props | |
120 `(display ,image | |
121 intangible ,image | |
33727
242c7cbf0a6b
(insert-image-file): Don't make `read-only' property rear-nonsticky.
Miles Bader <miles@gnu.org>
parents:
33608
diff
changeset
|
122 rear-nonsticky (display intangible) |
31934 | 123 ;; This a cheap attempt to make the whole buffer |
33727
242c7cbf0a6b
(insert-image-file): Don't make `read-only' property rear-nonsticky.
Miles Bader <miles@gnu.org>
parents:
33608
diff
changeset
|
124 ;; read-only when we're visiting the file (as |
242c7cbf0a6b
(insert-image-file): Don't make `read-only' property rear-nonsticky.
Miles Bader <miles@gnu.org>
parents:
33608
diff
changeset
|
125 ;; opposed to just inserting it). |
35854
a8fd9112792b
(insert-image-file): When visiting an image, suppress the cursor in the
Miles Bader <miles@gnu.org>
parents:
34650
diff
changeset
|
126 ,@(and visitingp |
31934 | 127 '(read-only t front-sticky (read-only)))))) |
35854
a8fd9112792b
(insert-image-file): When visiting an image, suppress the cursor in the
Miles Bader <miles@gnu.org>
parents:
34650
diff
changeset
|
128 (add-text-properties ibeg iend props) |
a8fd9112792b
(insert-image-file): When visiting an image, suppress the cursor in the
Miles Bader <miles@gnu.org>
parents:
34650
diff
changeset
|
129 (when visitingp |
a8fd9112792b
(insert-image-file): When visiting an image, suppress the cursor in the
Miles Bader <miles@gnu.org>
parents:
34650
diff
changeset
|
130 ;; Inhibit the cursor when the buffer contains only an image, |
a8fd9112792b
(insert-image-file): When visiting an image, suppress the cursor in the
Miles Bader <miles@gnu.org>
parents:
34650
diff
changeset
|
131 ;; because cursors look very strange on top of images. |
35884
3d9c9fe711c4
(insert-image-file): When visiting an image, set `truncate-lines' to t
Miles Bader <miles@gnu.org>
parents:
35854
diff
changeset
|
132 (setq cursor-type nil) |
3d9c9fe711c4
(insert-image-file): When visiting an image, set `truncate-lines' to t
Miles Bader <miles@gnu.org>
parents:
35854
diff
changeset
|
133 ;; This just makes the arrow displayed in the right fringe |
3d9c9fe711c4
(insert-image-file): When visiting an image, set `truncate-lines' to t
Miles Bader <miles@gnu.org>
parents:
35854
diff
changeset
|
134 ;; area look correct when the image is wider than the window. |
3d9c9fe711c4
(insert-image-file): When visiting an image, set `truncate-lines' to t
Miles Bader <miles@gnu.org>
parents:
35854
diff
changeset
|
135 (setq truncate-lines t)))) |
31934 | 136 rval)) |
137 | |
138 (defun image-file-handler (operation &rest args) | |
32185
f7460e78c02a
Docstring fixes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
32003
diff
changeset
|
139 "Filename handler for inserting image files. |
31934 | 140 OPERATION is the operation to perform, on ARGS. |
141 See `file-name-handler-alist' for details." | |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
142 (if (and (eq operation 'insert-file-contents) |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
143 auto-image-file-mode) |
31934 | 144 (apply #'insert-image-file args) |
145 ;; We don't handle OPERATION, use another handler or the default | |
146 (apply #'image-file-call-underlying operation operation args))) | |
147 | |
148 (defun image-file-call-underlying (function operation &rest args) | |
149 "Call FUNCTION with `image-file-handler' and OPERATION inhibited. | |
150 Optional argument ARGS are the arguments to call FUNCTION with." | |
151 (let ((inhibit-file-name-handlers | |
152 (cons 'image-file-handler | |
153 (and (eq inhibit-file-name-operation operation) | |
154 inhibit-file-name-handlers))) | |
155 (inhibit-file-name-operation operation)) | |
156 (apply function args))) | |
157 | |
158 | |
32316
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
159 ;;;###autoload |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
160 (define-minor-mode auto-image-file-mode |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
161 "Toggle visiting of image files as images. |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
162 With prefix argument ARG, turn on if positive, otherwise off. |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
163 Returns non-nil if the new state is enabled. |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
164 |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
165 Image files are those whose name has an extension in |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
166 `image-file-name-extensions', or matches a regexp in |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
167 `image-file-name-regexps'." |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
168 :global t |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
169 :group 'image |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
170 ;; Remove existing handler |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
171 (let ((existing-entry |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
172 (rassq 'image-file-handler file-name-handler-alist))) |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
173 (when existing-entry |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
174 (setq file-name-handler-alist |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
175 (delq existing-entry file-name-handler-alist)))) |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
176 ;; Add new handler, if enabled |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
177 (when auto-image-file-mode |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
178 (push (cons (image-file-name-regexp) 'image-file-handler) |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
179 file-name-handler-alist))) |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
180 |
b930d561cd53
(auto-image-file-mode): Move to the end of the file, because
Miles Bader <miles@gnu.org>
parents:
32220
diff
changeset
|
181 |
31934 | 182 (provide 'image-file) |
183 | |
52401 | 184 ;;; arch-tag: 04cafe36-f7ba-4c80-9f47-4cb656520ce1 |
31934 | 185 ;;; image-file.el ends here |