Commit | Line | Data |
---|---|---|
c7bd5d57 RS |
1 | ;;; image-mode.el --- support for visiting image files |
2 | ;; | |
114f9c96 | 3 | ;; Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. |
c7bd5d57 RS |
4 | ;; |
5 | ;; Author: Richard Stallman <rms@gnu.org> | |
6 | ;; Keywords: multimedia | |
7 | ||
8 | ;; This file is part of GNU Emacs. | |
9 | ||
eb3fa2cf | 10 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
c7bd5d57 | 11 | ;; it under the terms of the GNU General Public License as published by |
eb3fa2cf GM |
12 | ;; the Free Software Foundation, either version 3 of the License, or |
13 | ;; (at your option) any later version. | |
c7bd5d57 RS |
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 | |
eb3fa2cf | 21 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
c7bd5d57 RS |
22 | |
23 | ;;; Commentary: | |
24 | ||
25 | ;; Defines a major mode for visiting image files | |
26 | ;; that allows conversion between viewing the text of the file | |
27 | ;; and viewing the file as an image. Viewing the image | |
28 | ;; works by putting a `display' text-property on the | |
29 | ;; image data, with the image-data still present underneath; if the | |
30 | ;; resulting buffer file is saved to another name it will correctly save | |
31 | ;; the image data to the new file. | |
32 | ||
33 | ;;; Code: | |
34 | ||
35 | (require 'image) | |
44e3c7c6 | 36 | (eval-when-compile (require 'cl)) |
c7bd5d57 | 37 | |
6bdad9ae DN |
38 | ;;;###autoload (push (cons (purecopy "\\.jpe?g\\'") 'image-mode) auto-mode-alist) |
39 | ;;;###autoload (push (cons (purecopy "\\.png\\'") 'image-mode) auto-mode-alist) | |
40 | ;;;###autoload (push (cons (purecopy "\\.gif\\'") 'image-mode) auto-mode-alist) | |
41 | ;;;###autoload (push (cons (purecopy "\\.tiff?\\'") 'image-mode) auto-mode-alist) | |
42 | ;;;###autoload (push (cons (purecopy "\\.p[bpgn]m\\'") 'image-mode) auto-mode-alist) | |
4a2f0e99 | 43 | |
6bdad9ae | 44 | ;;;###autoload (push (cons (purecopy "\\.x[bp]m\\'") 'c-mode) auto-mode-alist) |
9b9debd1 | 45 | ;;;###autoload (push (cons (purecopy "\\.x[bp]m\\'") 'image-mode) auto-mode-alist) |
c7bd5d57 | 46 | |
6bdad9ae | 47 | ;;;###autoload (push (cons (purecopy "\\.svgz?\\'") 'xml-mode) auto-mode-alist) |
9b9debd1 | 48 | ;;;###autoload (push (cons (purecopy "\\.svgz?\\'") 'image-mode) auto-mode-alist) |
4a2f0e99 | 49 | |
44e3c7c6 SM |
50 | ;;; Image mode window-info management. |
51 | ||
52 | (defvar image-mode-winprops-alist t) | |
53 | (make-variable-buffer-local 'image-mode-winprops-alist) | |
54 | ||
55 | (defvar image-mode-new-window-functions nil | |
56 | "Special hook run when image data is requested in a new window. | |
57 | It is called with one argument, the initial WINPROPS.") | |
58 | ||
b81f0bab | 59 | (defun image-mode-winprops (&optional window cleanup) |
44e3c7c6 SM |
60 | "Return winprops of WINDOW. |
61 | A winprops object has the shape (WINDOW . ALIST)." | |
b81f0bab CY |
62 | (cond ((null window) |
63 | (setq window (selected-window))) | |
64 | ((not (windowp window)) | |
65 | (error "Not a window: %s" window))) | |
66 | (when cleanup | |
67 | (setq image-mode-winprops-alist | |
68 | (delq nil (mapcar (lambda (winprop) | |
69 | (if (window-live-p (car-safe winprop)) | |
70 | winprop)) | |
71 | image-mode-winprops-alist)))) | |
44e3c7c6 SM |
72 | (let ((winprops (assq window image-mode-winprops-alist))) |
73 | ;; For new windows, set defaults from the latest. | |
74 | (unless winprops | |
75 | (setq winprops (cons window | |
76 | (copy-alist (cdar image-mode-winprops-alist)))) | |
77 | (run-hook-with-args 'image-mode-new-window-functions winprops)) | |
78 | ;; Move window to front. | |
79 | (setq image-mode-winprops-alist | |
80 | (cons winprops (delq winprops image-mode-winprops-alist))) | |
81 | winprops)) | |
82 | ||
83 | (defun image-mode-window-get (prop &optional winprops) | |
84 | (unless (consp winprops) (setq winprops (image-mode-winprops winprops))) | |
85 | (cdr (assq prop (cdr winprops)))) | |
86 | ||
87 | (defsetf image-mode-window-get (prop &optional winprops) (val) | |
88 | `(image-mode-window-put ,prop ,val ,winprops)) | |
89 | ||
90 | (defun image-mode-window-put (prop val &optional winprops) | |
91 | (unless (consp winprops) (setq winprops (image-mode-winprops winprops))) | |
92 | (setcdr winprops (cons (cons prop val) | |
93 | (delq (assq prop (cdr winprops)) (cdr winprops))))) | |
94 | ||
95 | (defun image-set-window-vscroll (vscroll) | |
96 | (setf (image-mode-window-get 'vscroll) vscroll) | |
97 | (set-window-vscroll (selected-window) vscroll)) | |
98 | ||
99 | (defun image-set-window-hscroll (ncol) | |
60134fd4 | 100 | (setf (image-mode-window-get 'hscroll) ncol) |
44e3c7c6 SM |
101 | (set-window-hscroll (selected-window) ncol)) |
102 | ||
103 | (defun image-mode-reapply-winprops () | |
6d401b4e SM |
104 | ;; When set-window-buffer, set hscroll and vscroll to what they were |
105 | ;; last time the image was displayed in this window. | |
b81f0bab CY |
106 | (when (and (image-get-display-property) |
107 | (listp image-mode-winprops-alist)) | |
108 | (let* ((winprops (image-mode-winprops nil t)) | |
6d401b4e SM |
109 | (hscroll (image-mode-window-get 'hscroll winprops)) |
110 | (vscroll (image-mode-window-get 'vscroll winprops))) | |
c313b5fe SM |
111 | (if hscroll (set-window-hscroll (selected-window) hscroll)) |
112 | (if vscroll (set-window-vscroll (selected-window) vscroll))))) | |
36e1c289 | 113 | |
44e3c7c6 SM |
114 | (defun image-mode-setup-winprops () |
115 | ;; Record current scroll settings. | |
116 | (unless (listp image-mode-winprops-alist) | |
117 | (setq image-mode-winprops-alist nil)) | |
118 | (add-hook 'window-configuration-change-hook | |
119 | 'image-mode-reapply-winprops nil t)) | |
120 | ||
121 | ;;; Image scrolling functions | |
122 | ||
91784462 SM |
123 | (defun image-get-display-property () |
124 | (get-char-property (point-min) 'display | |
125 | ;; There might be different images for different displays. | |
126 | (if (eq (window-buffer) (current-buffer)) | |
127 | (selected-window)))) | |
128 | ||
aa360da1 GM |
129 | (declare-function image-size "image.c" (spec &optional pixels frame)) |
130 | ||
bb0cb417 CY |
131 | (defun image-forward-hscroll (&optional n) |
132 | "Scroll image in current window to the left by N character widths. | |
133 | Stop if the right edge of the image is reached." | |
134 | (interactive "p") | |
135 | (cond ((= n 0) nil) | |
136 | ((< n 0) | |
44e3c7c6 | 137 | (image-set-window-hscroll (max 0 (+ (window-hscroll) n)))) |
bb0cb417 | 138 | (t |
91784462 | 139 | (let* ((image (image-get-display-property)) |
bb0cb417 CY |
140 | (edges (window-inside-edges)) |
141 | (win-width (- (nth 2 edges) (nth 0 edges))) | |
142 | (img-width (ceiling (car (image-size image))))) | |
44e3c7c6 | 143 | (image-set-window-hscroll (min (max 0 (- img-width win-width)) |
36e1c289 | 144 | (+ n (window-hscroll)))))))) |
bb0cb417 CY |
145 | |
146 | (defun image-backward-hscroll (&optional n) | |
147 | "Scroll image in current window to the right by N character widths. | |
148 | Stop if the left edge of the image is reached." | |
149 | (interactive "p") | |
150 | (image-forward-hscroll (- n))) | |
151 | ||
152 | (defun image-next-line (&optional n) | |
153 | "Scroll image in current window upward by N lines. | |
154 | Stop if the bottom edge of the image is reached." | |
155 | (interactive "p") | |
156 | (cond ((= n 0) nil) | |
157 | ((< n 0) | |
44e3c7c6 | 158 | (image-set-window-vscroll (max 0 (+ (window-vscroll) n)))) |
bb0cb417 | 159 | (t |
91784462 | 160 | (let* ((image (image-get-display-property)) |
bb0cb417 CY |
161 | (edges (window-inside-edges)) |
162 | (win-height (- (nth 3 edges) (nth 1 edges))) | |
163 | (img-height (ceiling (cdr (image-size image))))) | |
44e3c7c6 | 164 | (image-set-window-vscroll (min (max 0 (- img-height win-height)) |
36e1c289 | 165 | (+ n (window-vscroll)))))))) |
bb0cb417 CY |
166 | |
167 | (defun image-previous-line (&optional n) | |
168 | "Scroll image in current window downward by N lines. | |
169 | Stop if the top edge of the image is reached." | |
170 | (interactive "p") | |
171 | (image-next-line (- n))) | |
172 | ||
173 | (defun image-scroll-up (&optional n) | |
174 | "Scroll image in current window upward by N lines. | |
175 | Stop if the bottom edge of the image is reached. | |
176 | If ARG is omitted or nil, scroll upward by a near full screen. | |
177 | A near full screen is `next-screen-context-lines' less than a full screen. | |
178 | Negative ARG means scroll downward. | |
179 | If ARG is the atom `-', scroll downward by nearly full screen. | |
180 | When calling from a program, supply as argument a number, nil, or `-'." | |
181 | (interactive "P") | |
182 | (cond ((null n) | |
183 | (let* ((edges (window-inside-edges)) | |
184 | (win-height (- (nth 3 edges) (nth 1 edges)))) | |
185 | (image-next-line | |
186 | (max 0 (- win-height next-screen-context-lines))))) | |
187 | ((eq n '-) | |
188 | (let* ((edges (window-inside-edges)) | |
189 | (win-height (- (nth 3 edges) (nth 1 edges)))) | |
190 | (image-next-line | |
191 | (min 0 (- next-screen-context-lines win-height))))) | |
192 | (t (image-next-line (prefix-numeric-value n))))) | |
193 | ||
194 | (defun image-scroll-down (&optional n) | |
3488c456 | 195 | "Scroll image in current window downward by N lines. |
bb0cb417 CY |
196 | Stop if the top edge of the image is reached. |
197 | If ARG is omitted or nil, scroll downward by a near full screen. | |
198 | A near full screen is `next-screen-context-lines' less than a full screen. | |
199 | Negative ARG means scroll upward. | |
200 | If ARG is the atom `-', scroll upward by nearly full screen. | |
201 | When calling from a program, supply as argument a number, nil, or `-'." | |
202 | (interactive "P") | |
203 | (cond ((null n) | |
204 | (let* ((edges (window-inside-edges)) | |
205 | (win-height (- (nth 3 edges) (nth 1 edges)))) | |
206 | (image-next-line | |
207 | (min 0 (- next-screen-context-lines win-height))))) | |
208 | ((eq n '-) | |
209 | (let* ((edges (window-inside-edges)) | |
210 | (win-height (- (nth 3 edges) (nth 1 edges)))) | |
211 | (image-next-line | |
212 | (max 0 (- win-height next-screen-context-lines))))) | |
213 | (t (image-next-line (- (prefix-numeric-value n)))))) | |
214 | ||
215 | (defun image-bol (arg) | |
216 | "Scroll horizontally to the left edge of the image in the current window. | |
217 | With argument ARG not nil or 1, move forward ARG - 1 lines first, | |
218 | stopping if the top or bottom edge of the image is reached." | |
219 | (interactive "p") | |
220 | (and arg | |
221 | (/= (setq arg (prefix-numeric-value arg)) 1) | |
222 | (image-next-line (- arg 1))) | |
44e3c7c6 | 223 | (image-set-window-hscroll 0)) |
bb0cb417 CY |
224 | |
225 | (defun image-eol (arg) | |
226 | "Scroll horizontally to the right edge of the image in the current window. | |
227 | With argument ARG not nil or 1, move forward ARG - 1 lines first, | |
228 | stopping if the top or bottom edge of the image is reached." | |
229 | (interactive "p") | |
230 | (and arg | |
231 | (/= (setq arg (prefix-numeric-value arg)) 1) | |
232 | (image-next-line (- arg 1))) | |
91784462 | 233 | (let* ((image (image-get-display-property)) |
bb0cb417 CY |
234 | (edges (window-inside-edges)) |
235 | (win-width (- (nth 2 edges) (nth 0 edges))) | |
236 | (img-width (ceiling (car (image-size image))))) | |
44e3c7c6 | 237 | (image-set-window-hscroll (max 0 (- img-width win-width))))) |
bb0cb417 CY |
238 | |
239 | (defun image-bob () | |
240 | "Scroll to the top-left corner of the image in the current window." | |
241 | (interactive) | |
44e3c7c6 SM |
242 | (image-set-window-hscroll 0) |
243 | (image-set-window-vscroll 0)) | |
bb0cb417 CY |
244 | |
245 | (defun image-eob () | |
246 | "Scroll to the bottom-right corner of the image in the current window." | |
247 | (interactive) | |
91784462 | 248 | (let* ((image (image-get-display-property)) |
bb0cb417 CY |
249 | (edges (window-inside-edges)) |
250 | (win-width (- (nth 2 edges) (nth 0 edges))) | |
251 | (img-width (ceiling (car (image-size image)))) | |
252 | (win-height (- (nth 3 edges) (nth 1 edges))) | |
253 | (img-height (ceiling (cdr (image-size image))))) | |
44e3c7c6 SM |
254 | (image-set-window-hscroll (max 0 (- img-width win-width))) |
255 | (image-set-window-vscroll (max 0 (- img-height win-height))))) | |
bb0cb417 | 256 | |
bd1d6a63 SM |
257 | ;; Adjust frame and image size. |
258 | ||
259 | (defun image-mode-fit-frame () | |
260 | "Fit the frame to the current image. | |
261 | This function assumes the current frame has only one window." | |
262 | ;; FIXME: This does not take into account decorations like mode-line, | |
263 | ;; minibuffer, header-line, ... | |
264 | (interactive) | |
265 | (let* ((saved (frame-parameter nil 'image-mode-saved-size)) | |
266 | (display (image-get-display-property)) | |
267 | (size (image-size display))) | |
268 | (if (and saved | |
269 | (eq (caar saved) (frame-width)) | |
270 | (eq (cdar saved) (frame-height))) | |
271 | (progn ;; Toggle back to previous non-fitted size. | |
272 | (set-frame-parameter nil 'image-mode-saved-size nil) | |
273 | (setq size (cdr saved))) | |
274 | ;; Round up size, and save current size so we can toggle back to it. | |
275 | (setcar size (ceiling (car size))) | |
276 | (setcdr size (ceiling (cdr size))) | |
277 | (set-frame-parameter nil 'image-mode-saved-size | |
278 | (cons size (cons (frame-width) (frame-height))))) | |
279 | (set-frame-width (selected-frame) (car size)) | |
280 | (set-frame-height (selected-frame) (cdr size)))) | |
281 | ||
bb0cb417 CY |
282 | ;;; Image Mode setup |
283 | ||
d487ca7d JL |
284 | (defvar image-type nil |
285 | "Current image type. | |
286 | This variable is used to display the current image type in the mode line.") | |
287 | (make-variable-buffer-local 'image-type) | |
288 | ||
9b9debd1 JL |
289 | (defvar image-mode-previous-major-mode nil |
290 | "Internal variable to keep the previous non-image major mode.") | |
291 | ||
c7bd5d57 | 292 | (defvar image-mode-map |
bb0cb417 | 293 | (let ((map (make-sparse-keymap))) |
d2d7e96c SM |
294 | (suppress-keymap map) |
295 | (define-key map "q" 'quit-window) | |
bb0cb417 | 296 | (define-key map "\C-c\C-c" 'image-toggle-display) |
42c27c2a SM |
297 | (define-key map (kbd "SPC") 'image-scroll-up) |
298 | (define-key map (kbd "DEL") 'image-scroll-down) | |
bb0cb417 CY |
299 | (define-key map [remap forward-char] 'image-forward-hscroll) |
300 | (define-key map [remap backward-char] 'image-backward-hscroll) | |
301 | (define-key map [remap previous-line] 'image-previous-line) | |
302 | (define-key map [remap next-line] 'image-next-line) | |
303 | (define-key map [remap scroll-up] 'image-scroll-up) | |
304 | (define-key map [remap scroll-down] 'image-scroll-down) | |
305 | (define-key map [remap move-beginning-of-line] 'image-bol) | |
306 | (define-key map [remap move-end-of-line] 'image-eol) | |
307 | (define-key map [remap beginning-of-buffer] 'image-bob) | |
308 | (define-key map [remap end-of-buffer] 'image-eob) | |
309 | map) | |
310 | "Major mode keymap for viewing images in Image mode.") | |
311 | ||
9b9debd1 | 312 | (defvar image-minor-mode-map |
c7bd5d57 RS |
313 | (let ((map (make-sparse-keymap))) |
314 | (define-key map "\C-c\C-c" 'image-toggle-display) | |
315 | map) | |
9b9debd1 | 316 | "Minor mode keymap for viewing images as text in Image mode.") |
c7bd5d57 | 317 | |
e0385bf4 | 318 | (defvar bookmark-make-record-function) |
a47d49c0 | 319 | |
0d17c4b9 JL |
320 | (put 'image-mode 'mode-class 'special) |
321 | ||
c7bd5d57 RS |
322 | ;;;###autoload |
323 | (defun image-mode () | |
324 | "Major mode for image files. | |
325 | You can use \\<image-mode-map>\\[image-toggle-display] | |
326 | to toggle between display as an image and display as text." | |
327 | (interactive) | |
9b9debd1 JL |
328 | (condition-case err |
329 | (progn | |
330 | (unless (display-images-p) | |
331 | (error "Display does not support images")) | |
332 | ||
333 | (kill-all-local-variables) | |
334 | (setq major-mode 'image-mode) | |
335 | ||
336 | (if (not (image-get-display-property)) | |
337 | (progn | |
338 | (image-toggle-display-image) | |
339 | ;; If attempt to display the image fails. | |
340 | (if (not (image-get-display-property)) | |
341 | (error "Invalid image"))) | |
342 | ;; Set next vars when image is already displayed but local | |
343 | ;; variables were cleared by kill-all-local-variables | |
344 | (setq cursor-type nil truncate-lines t | |
345 | image-type (plist-get (cdr (image-get-display-property)) :type))) | |
346 | ||
347 | (setq mode-name (if image-type (format "Image[%s]" image-type) "Image")) | |
bb43424b | 348 | (use-local-map image-mode-map) |
9b9debd1 JL |
349 | |
350 | ;; Use our own bookmarking function for images. | |
351 | (set (make-local-variable 'bookmark-make-record-function) | |
352 | 'image-bookmark-make-record) | |
353 | ||
354 | ;; Keep track of [vh]scroll when switching buffers | |
355 | (image-mode-setup-winprops) | |
356 | ||
357 | (add-hook 'change-major-mode-hook 'image-toggle-display-text nil t) | |
358 | (run-mode-hooks 'image-mode-hook) | |
359 | (message "%s" (concat | |
360 | (substitute-command-keys | |
361 | "Type \\[image-toggle-display] to view the image as ") | |
362 | (if (image-get-display-property) | |
363 | "text" "an image") "."))) | |
364 | (error | |
365 | (image-mode-as-text) | |
366 | (funcall | |
367 | (if (called-interactively-p 'any) 'error 'message) | |
368 | "Cannot display image: %s" (cdr err))))) | |
d90e651e JL |
369 | |
370 | ;;;###autoload | |
371 | (define-minor-mode image-minor-mode | |
372 | "Toggle Image minor mode. | |
373 | With arg, turn Image minor mode on if arg is positive, off otherwise. | |
9b9debd1 JL |
374 | It provides the key \\<image-mode-map>\\[image-toggle-display] \ |
375 | to switch back to `image-mode' | |
376 | to display an image file as the actual image." | |
377 | nil (:eval (if image-type (format " Image[%s]" image-type) " Image")) | |
378 | image-minor-mode-map | |
d90e651e JL |
379 | :group 'image |
380 | :version "22.1" | |
9b9debd1 JL |
381 | (if image-minor-mode |
382 | (add-hook 'change-major-mode-hook (lambda () (image-minor-mode -1)) nil t))) | |
d90e651e JL |
383 | |
384 | ;;;###autoload | |
9b9debd1 JL |
385 | (defun image-mode-as-text () |
386 | "Set a non-image mode as major mode in combination with image minor mode. | |
387 | A non-image major mode found from `auto-mode-alist' or Fundamental mode | |
388 | displays an image file as text. `image-minor-mode' provides the key | |
389 | \\<image-mode-map>\\[image-toggle-display] to switch back to `image-mode' | |
390 | to display an image file as the actual image. | |
391 | ||
392 | You can use `image-mode-as-text' in `auto-mode-alist' when you want | |
393 | to display an image file as text inititally. | |
394 | ||
395 | See commands `image-mode' and `image-minor-mode' for more information | |
396 | on these modes." | |
d90e651e | 397 | (interactive) |
9b9debd1 JL |
398 | ;; image-mode-as-text = normal-mode + image-minor-mode |
399 | (let ((previous-image-type image-type)) ; preserve `image-type' | |
400 | (if image-mode-previous-major-mode | |
401 | ;; Restore previous major mode that was already found by this | |
402 | ;; function and cached in `image-mode-previous-major-mode' | |
403 | (funcall image-mode-previous-major-mode) | |
404 | (let ((auto-mode-alist | |
405 | (delq nil (mapcar | |
406 | (lambda (elt) | |
407 | (unless (memq (or (car-safe (cdr elt)) (cdr elt)) | |
408 | '(image-mode image-mode-maybe image-mode-as-text)) | |
409 | elt)) | |
410 | auto-mode-alist))) | |
411 | (magic-fallback-mode-alist | |
412 | (delq nil (mapcar | |
413 | (lambda (elt) | |
414 | (unless (memq (or (car-safe (cdr elt)) (cdr elt)) | |
415 | '(image-mode image-mode-maybe image-mode-as-text)) | |
416 | elt)) | |
417 | magic-fallback-mode-alist)))) | |
418 | (normal-mode) | |
419 | (set (make-local-variable 'image-mode-previous-major-mode) major-mode))) | |
420 | ;; Restore `image-type' after `kill-all-local-variables' in `normal-mode'. | |
421 | (setq image-type previous-image-type) | |
422 | ;; Enable image minor mode with `C-c C-c'. | |
423 | (image-minor-mode 1) | |
424 | ;; Show the image file as text. | |
425 | (image-toggle-display-text) | |
426 | (message "%s" (concat | |
427 | (substitute-command-keys | |
428 | "Type \\[image-toggle-display] to view the image as ") | |
429 | (if (image-get-display-property) | |
430 | "text" "an image") ".")))) | |
431 | ||
432 | (define-obsolete-function-alias 'image-mode-maybe 'image-mode "23.2") | |
d90e651e JL |
433 | |
434 | (defun image-toggle-display-text () | |
9b9debd1 JL |
435 | "Show the image file as text. |
436 | Remove text properties that display the image." | |
437 | (let ((inhibit-read-only t) | |
438 | (buffer-undo-list t) | |
439 | (modified (buffer-modified-p))) | |
440 | (remove-list-of-text-properties (point-min) (point-max) | |
441 | '(display intangible read-nonsticky | |
442 | read-only front-sticky)) | |
443 | (set-buffer-modified-p modified) | |
444 | (if (called-interactively-p 'any) | |
445 | (message "Repeat this command to go back to displaying the image")))) | |
c7bd5d57 | 446 | |
f2920ffe RS |
447 | (defvar archive-superior-buffer) |
448 | (defvar tar-superior-buffer) | |
aa360da1 | 449 | (declare-function image-refresh "image.c" (spec &optional frame)) |
f2920ffe | 450 | |
9b9debd1 JL |
451 | (defun image-toggle-display-image () |
452 | "Show the image of the image file. | |
453 | Turn the image data into a real image, but only if the whole file | |
454 | was inserted." | |
455 | (let* ((filename (buffer-file-name)) | |
456 | (data-p (not (and filename | |
457 | (file-readable-p filename) | |
458 | (not (file-remote-p filename)) | |
459 | (not (buffer-modified-p)) | |
460 | (not (and (boundp 'archive-superior-buffer) | |
461 | archive-superior-buffer)) | |
462 | (not (and (boundp 'tar-superior-buffer) | |
463 | tar-superior-buffer))))) | |
464 | (file-or-data (if data-p | |
465 | (string-make-unibyte | |
466 | (buffer-substring-no-properties (point-min) (point-max))) | |
467 | filename)) | |
468 | (type (image-type file-or-data nil data-p)) | |
0608aa45 | 469 | (image (create-animated-image file-or-data type data-p)) |
9b9debd1 JL |
470 | (props |
471 | `(display ,image | |
472 | intangible ,image | |
473 | rear-nonsticky (display intangible) | |
474 | read-only t front-sticky (read-only))) | |
475 | (inhibit-read-only t) | |
476 | (buffer-undo-list t) | |
477 | (modified (buffer-modified-p))) | |
478 | (image-refresh image) | |
479 | (let ((buffer-file-truename nil)) ; avoid changing dir mtime by lock_file | |
480 | (add-text-properties (point-min) (point-max) props) | |
481 | (restore-buffer-modified-p modified)) | |
482 | ;; Inhibit the cursor when the buffer contains only an image, | |
483 | ;; because cursors look very strange on top of images. | |
484 | (setq cursor-type nil) | |
485 | ;; This just makes the arrow displayed in the right fringe | |
486 | ;; area look correct when the image is wider than the window. | |
487 | (setq truncate-lines t) | |
488 | ;; Allow navigation of large images | |
489 | (set (make-local-variable 'auto-hscroll-mode) nil) | |
490 | (setq image-type type) | |
491 | (if (eq major-mode 'image-mode) | |
492 | (setq mode-name (format "Image[%s]" type))) | |
493 | (if (called-interactively-p 'any) | |
494 | (message "Repeat this command to go back to displaying the file as text")))) | |
495 | ||
c7bd5d57 RS |
496 | (defun image-toggle-display () |
497 | "Start or stop displaying an image file as the actual image. | |
9b9debd1 JL |
498 | This command toggles between `image-mode-as-text' showing the text of |
499 | the image file and `image-mode' showing the image as an image." | |
c7bd5d57 | 500 | (interactive) |
91784462 | 501 | (if (image-get-display-property) |
9b9debd1 JL |
502 | (image-mode-as-text) |
503 | (image-mode))) | |
97666703 | 504 | \f |
137187c8 | 505 | ;;; Support for bookmark.el |
c123f7fe GM |
506 | (declare-function bookmark-make-record-default "bookmark" |
507 | (&optional point-only)) | |
43f8b275 SM |
508 | (declare-function bookmark-prop-get "bookmark" (bookmark prop)) |
509 | (declare-function bookmark-default-handler "bookmark" (bmk)) | |
137187c8 | 510 | |
43f8b275 SM |
511 | (defun image-bookmark-make-record () |
512 | (nconc (bookmark-make-record-default) | |
513 | `((image-type . ,image-type) | |
514 | (handler . image-bookmark-jump)))) | |
137187c8 | 515 | |
137187c8 TH |
516 | ;;;###autoload |
517 | (defun image-bookmark-jump (bmk) | |
03e26a79 | 518 | ;; This implements the `handler' function interface for record type |
e0385bf4 | 519 | ;; returned by `bookmark-make-record-function', which see. |
43f8b275 SM |
520 | (prog1 (bookmark-default-handler bmk) |
521 | (when (not (string= image-type (bookmark-prop-get bmk 'image-type))) | |
522 | (image-toggle-display)))) | |
97666703 | 523 | \f |
c7bd5d57 RS |
524 | (provide 'image-mode) |
525 | ||
8f7ee639 | 526 | ;; arch-tag: b5b2b7e6-26a7-4b79-96e3-1546b5c4c6cb |
c7bd5d57 | 527 | ;;; image-mode.el ends here |