Fixes for Occur Edit mode.
[bpt/emacs.git] / lisp / image-mode.el
CommitLineData
c7bd5d57
RS
1;;; image-mode.el --- support for visiting image files
2;;
73b0cd50 3;; Copyright (C) 2005-2011 Free Software Foundation, Inc.
c7bd5d57
RS
4;;
5;; Author: Richard Stallman <rms@gnu.org>
6;; Keywords: multimedia
bd78fa1d 7;; Package: emacs
c7bd5d57
RS
8
9;; This file is part of GNU Emacs.
10
eb3fa2cf 11;; GNU Emacs is free software: you can redistribute it and/or modify
c7bd5d57 12;; it under the terms of the GNU General Public License as published by
eb3fa2cf
GM
13;; the Free Software Foundation, either version 3 of the License, or
14;; (at your option) any later version.
c7bd5d57
RS
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
eb3fa2cf 22;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
c7bd5d57
RS
23
24;;; Commentary:
25
26;; Defines a major mode for visiting image files
27;; that allows conversion between viewing the text of the file
28;; and viewing the file as an image. Viewing the image
29;; works 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)
44e3c7c6 37(eval-when-compile (require 'cl))
c7bd5d57 38
44e3c7c6
SM
39;;; Image mode window-info management.
40
41(defvar image-mode-winprops-alist t)
42(make-variable-buffer-local 'image-mode-winprops-alist)
43
44(defvar image-mode-new-window-functions nil
45 "Special hook run when image data is requested in a new window.
46It is called with one argument, the initial WINPROPS.")
47
b81f0bab 48(defun image-mode-winprops (&optional window cleanup)
44e3c7c6
SM
49 "Return winprops of WINDOW.
50A winprops object has the shape (WINDOW . ALIST)."
b81f0bab
CY
51 (cond ((null window)
52 (setq window (selected-window)))
53 ((not (windowp window))
54 (error "Not a window: %s" window)))
55 (when cleanup
56 (setq image-mode-winprops-alist
57 (delq nil (mapcar (lambda (winprop)
58 (if (window-live-p (car-safe winprop))
59 winprop))
60 image-mode-winprops-alist))))
44e3c7c6
SM
61 (let ((winprops (assq window image-mode-winprops-alist)))
62 ;; For new windows, set defaults from the latest.
63 (unless winprops
64 (setq winprops (cons window
65 (copy-alist (cdar image-mode-winprops-alist))))
66 (run-hook-with-args 'image-mode-new-window-functions winprops))
67 ;; Move window to front.
68 (setq image-mode-winprops-alist
69 (cons winprops (delq winprops image-mode-winprops-alist)))
70 winprops))
71
72(defun image-mode-window-get (prop &optional winprops)
73 (unless (consp winprops) (setq winprops (image-mode-winprops winprops)))
74 (cdr (assq prop (cdr winprops))))
75
76(defsetf image-mode-window-get (prop &optional winprops) (val)
77 `(image-mode-window-put ,prop ,val ,winprops))
78
79(defun image-mode-window-put (prop val &optional winprops)
80 (unless (consp winprops) (setq winprops (image-mode-winprops winprops)))
81 (setcdr winprops (cons (cons prop val)
82 (delq (assq prop (cdr winprops)) (cdr winprops)))))
83
84(defun image-set-window-vscroll (vscroll)
85 (setf (image-mode-window-get 'vscroll) vscroll)
86 (set-window-vscroll (selected-window) vscroll))
87
88(defun image-set-window-hscroll (ncol)
60134fd4 89 (setf (image-mode-window-get 'hscroll) ncol)
44e3c7c6
SM
90 (set-window-hscroll (selected-window) ncol))
91
92(defun image-mode-reapply-winprops ()
6d401b4e
SM
93 ;; When set-window-buffer, set hscroll and vscroll to what they were
94 ;; last time the image was displayed in this window.
b81f0bab
CY
95 (when (and (image-get-display-property)
96 (listp image-mode-winprops-alist))
97 (let* ((winprops (image-mode-winprops nil t))
6d401b4e
SM
98 (hscroll (image-mode-window-get 'hscroll winprops))
99 (vscroll (image-mode-window-get 'vscroll winprops)))
c313b5fe
SM
100 (if hscroll (set-window-hscroll (selected-window) hscroll))
101 (if vscroll (set-window-vscroll (selected-window) vscroll)))))
36e1c289 102
44e3c7c6
SM
103(defun image-mode-setup-winprops ()
104 ;; Record current scroll settings.
105 (unless (listp image-mode-winprops-alist)
106 (setq image-mode-winprops-alist nil))
107 (add-hook 'window-configuration-change-hook
108 'image-mode-reapply-winprops nil t))
109
110;;; Image scrolling functions
111
91784462
SM
112(defun image-get-display-property ()
113 (get-char-property (point-min) 'display
114 ;; There might be different images for different displays.
115 (if (eq (window-buffer) (current-buffer))
116 (selected-window))))
117
aa360da1
GM
118(declare-function image-size "image.c" (spec &optional pixels frame))
119
c9088194 120(defun image-display-size (spec &optional pixels frame)
2f224f0b
CY
121 "Wrapper around `image-size', handling slice display properties.
122Like `image-size', the return value is (WIDTH . HEIGHT).
123WIDTH and HEIGHT are in canonical character units if PIXELS is
124nil, and in pixel units if PIXELS is non-nil.
125
126If SPEC is an image display property, this function is equivalent
127to `image-size'. If SPEC is a list of properties containing
128`image' and `slice' properties, return the display size taking
129the slice property into account. If the list contains `image'
130but not `slice', return the `image-size' of the specified image."
c9088194
SK
131 (if (eq (car spec) 'image)
132 (image-size spec pixels frame)
133 (let ((image (assoc 'image spec))
134 (slice (assoc 'slice spec)))
135 (cond ((and image slice)
136 (if pixels
137 (cons (nth 3 slice) (nth 4 slice))
138 (cons (/ (float (nth 3 slice)) (frame-char-width frame))
139 (/ (float (nth 4 slice)) (frame-char-height frame)))))
140 (image
141 (image-size image pixels frame))
142 (t
143 (error "Invalid image specification: %s" spec))))))
144
bb0cb417
CY
145(defun image-forward-hscroll (&optional n)
146 "Scroll image in current window to the left by N character widths.
147Stop if the right edge of the image is reached."
148 (interactive "p")
149 (cond ((= n 0) nil)
150 ((< n 0)
44e3c7c6 151 (image-set-window-hscroll (max 0 (+ (window-hscroll) n))))
bb0cb417 152 (t
91784462 153 (let* ((image (image-get-display-property))
bb0cb417
CY
154 (edges (window-inside-edges))
155 (win-width (- (nth 2 edges) (nth 0 edges)))
c9088194 156 (img-width (ceiling (car (image-display-size image)))))
44e3c7c6 157 (image-set-window-hscroll (min (max 0 (- img-width win-width))
36e1c289 158 (+ n (window-hscroll))))))))
bb0cb417
CY
159
160(defun image-backward-hscroll (&optional n)
161 "Scroll image in current window to the right by N character widths.
162Stop if the left edge of the image is reached."
163 (interactive "p")
164 (image-forward-hscroll (- n)))
165
77549ea8 166(defun image-next-line (n)
bb0cb417
CY
167 "Scroll image in current window upward by N lines.
168Stop if the bottom edge of the image is reached."
169 (interactive "p")
170 (cond ((= n 0) nil)
171 ((< n 0)
44e3c7c6 172 (image-set-window-vscroll (max 0 (+ (window-vscroll) n))))
bb0cb417 173 (t
91784462 174 (let* ((image (image-get-display-property))
bb0cb417
CY
175 (edges (window-inside-edges))
176 (win-height (- (nth 3 edges) (nth 1 edges)))
c9088194 177 (img-height (ceiling (cdr (image-display-size image)))))
44e3c7c6 178 (image-set-window-vscroll (min (max 0 (- img-height win-height))
36e1c289 179 (+ n (window-vscroll))))))))
bb0cb417
CY
180
181(defun image-previous-line (&optional n)
182 "Scroll image in current window downward by N lines.
183Stop if the top edge of the image is reached."
184 (interactive "p")
185 (image-next-line (- n)))
186
187(defun image-scroll-up (&optional n)
188 "Scroll image in current window upward by N lines.
189Stop if the bottom edge of the image is reached.
190If ARG is omitted or nil, scroll upward by a near full screen.
191A near full screen is `next-screen-context-lines' less than a full screen.
192Negative ARG means scroll downward.
193If ARG is the atom `-', scroll downward by nearly full screen.
194When calling from a program, supply as argument a number, nil, or `-'."
195 (interactive "P")
196 (cond ((null n)
197 (let* ((edges (window-inside-edges))
198 (win-height (- (nth 3 edges) (nth 1 edges))))
199 (image-next-line
200 (max 0 (- win-height next-screen-context-lines)))))
201 ((eq n '-)
202 (let* ((edges (window-inside-edges))
203 (win-height (- (nth 3 edges) (nth 1 edges))))
204 (image-next-line
205 (min 0 (- next-screen-context-lines win-height)))))
206 (t (image-next-line (prefix-numeric-value n)))))
207
208(defun image-scroll-down (&optional n)
3488c456 209 "Scroll image in current window downward by N lines.
bb0cb417
CY
210Stop if the top edge of the image is reached.
211If ARG is omitted or nil, scroll downward by a near full screen.
212A near full screen is `next-screen-context-lines' less than a full screen.
213Negative ARG means scroll upward.
214If ARG is the atom `-', scroll upward by nearly full screen.
215When calling from a program, supply as argument a number, nil, or `-'."
216 (interactive "P")
217 (cond ((null n)
218 (let* ((edges (window-inside-edges))
219 (win-height (- (nth 3 edges) (nth 1 edges))))
220 (image-next-line
221 (min 0 (- next-screen-context-lines win-height)))))
222 ((eq n '-)
223 (let* ((edges (window-inside-edges))
224 (win-height (- (nth 3 edges) (nth 1 edges))))
225 (image-next-line
226 (max 0 (- win-height next-screen-context-lines)))))
227 (t (image-next-line (- (prefix-numeric-value n))))))
228
229(defun image-bol (arg)
230 "Scroll horizontally to the left edge of the image in the current window.
231With argument ARG not nil or 1, move forward ARG - 1 lines first,
232stopping if the top or bottom edge of the image is reached."
233 (interactive "p")
234 (and arg
235 (/= (setq arg (prefix-numeric-value arg)) 1)
236 (image-next-line (- arg 1)))
44e3c7c6 237 (image-set-window-hscroll 0))
bb0cb417
CY
238
239(defun image-eol (arg)
240 "Scroll horizontally to the right edge of the image in the current window.
241With argument ARG not nil or 1, move forward ARG - 1 lines first,
242stopping if the top or bottom edge of the image is reached."
243 (interactive "p")
244 (and arg
245 (/= (setq arg (prefix-numeric-value arg)) 1)
246 (image-next-line (- arg 1)))
91784462 247 (let* ((image (image-get-display-property))
bb0cb417
CY
248 (edges (window-inside-edges))
249 (win-width (- (nth 2 edges) (nth 0 edges)))
c9088194 250 (img-width (ceiling (car (image-display-size image)))))
44e3c7c6 251 (image-set-window-hscroll (max 0 (- img-width win-width)))))
bb0cb417
CY
252
253(defun image-bob ()
254 "Scroll to the top-left corner of the image in the current window."
255 (interactive)
44e3c7c6
SM
256 (image-set-window-hscroll 0)
257 (image-set-window-vscroll 0))
bb0cb417
CY
258
259(defun image-eob ()
260 "Scroll to the bottom-right corner of the image in the current window."
261 (interactive)
91784462 262 (let* ((image (image-get-display-property))
bb0cb417
CY
263 (edges (window-inside-edges))
264 (win-width (- (nth 2 edges) (nth 0 edges)))
c9088194 265 (img-width (ceiling (car (image-display-size image))))
bb0cb417 266 (win-height (- (nth 3 edges) (nth 1 edges)))
c9088194 267 (img-height (ceiling (cdr (image-display-size image)))))
44e3c7c6
SM
268 (image-set-window-hscroll (max 0 (- img-width win-width)))
269 (image-set-window-vscroll (max 0 (- img-height win-height)))))
bb0cb417 270
bd1d6a63
SM
271;; Adjust frame and image size.
272
273(defun image-mode-fit-frame ()
5b2d4a66 274 "Toggle whether to fit the frame to the current image.
bd1d6a63
SM
275This function assumes the current frame has only one window."
276 ;; FIXME: This does not take into account decorations like mode-line,
277 ;; minibuffer, header-line, ...
278 (interactive)
279 (let* ((saved (frame-parameter nil 'image-mode-saved-size))
280 (display (image-get-display-property))
c9088194 281 (size (image-display-size display)))
bd1d6a63
SM
282 (if (and saved
283 (eq (caar saved) (frame-width))
284 (eq (cdar saved) (frame-height)))
285 (progn ;; Toggle back to previous non-fitted size.
286 (set-frame-parameter nil 'image-mode-saved-size nil)
287 (setq size (cdr saved)))
288 ;; Round up size, and save current size so we can toggle back to it.
289 (setcar size (ceiling (car size)))
290 (setcdr size (ceiling (cdr size)))
291 (set-frame-parameter nil 'image-mode-saved-size
292 (cons size (cons (frame-width) (frame-height)))))
293 (set-frame-width (selected-frame) (car size))
294 (set-frame-height (selected-frame) (cdr size))))
295
bb0cb417
CY
296;;; Image Mode setup
297
d487ca7d 298(defvar image-type nil
71d73c9c 299 "The image type for the current Image mode buffer.")
d487ca7d
JL
300(make-variable-buffer-local 'image-type)
301
9b9debd1
JL
302(defvar image-mode-previous-major-mode nil
303 "Internal variable to keep the previous non-image major mode.")
304
c7bd5d57 305(defvar image-mode-map
bb0cb417 306 (let ((map (make-sparse-keymap)))
abef340a 307 (set-keymap-parent map special-mode-map)
bb0cb417 308 (define-key map "\C-c\C-c" 'image-toggle-display)
42c27c2a
SM
309 (define-key map (kbd "SPC") 'image-scroll-up)
310 (define-key map (kbd "DEL") 'image-scroll-down)
18af70d0 311 (define-key map (kbd "RET") 'image-toggle-animation)
bb0cb417
CY
312 (define-key map [remap forward-char] 'image-forward-hscroll)
313 (define-key map [remap backward-char] 'image-backward-hscroll)
d8b0cddd
SM
314 (define-key map [remap right-char] 'image-forward-hscroll)
315 (define-key map [remap left-char] 'image-backward-hscroll)
bb0cb417
CY
316 (define-key map [remap previous-line] 'image-previous-line)
317 (define-key map [remap next-line] 'image-next-line)
318 (define-key map [remap scroll-up] 'image-scroll-up)
319 (define-key map [remap scroll-down] 'image-scroll-down)
32129746
JL
320 (define-key map [remap scroll-up-command] 'image-scroll-up)
321 (define-key map [remap scroll-down-command] 'image-scroll-down)
bb0cb417
CY
322 (define-key map [remap move-beginning-of-line] 'image-bol)
323 (define-key map [remap move-end-of-line] 'image-eol)
324 (define-key map [remap beginning-of-buffer] 'image-bob)
325 (define-key map [remap end-of-buffer] 'image-eob)
326 map)
71d73c9c 327 "Mode keymap for `image-mode'.")
bb0cb417 328
9b9debd1 329(defvar image-minor-mode-map
c7bd5d57
RS
330 (let ((map (make-sparse-keymap)))
331 (define-key map "\C-c\C-c" 'image-toggle-display)
332 map)
71d73c9c 333 "Mode keymap for `image-minor-mode'.")
c7bd5d57 334
e0385bf4 335(defvar bookmark-make-record-function)
a47d49c0 336
0d17c4b9
JL
337(put 'image-mode 'mode-class 'special)
338
c7bd5d57
RS
339;;;###autoload
340(defun image-mode ()
341 "Major mode for image files.
342You can use \\<image-mode-map>\\[image-toggle-display]
343to toggle between display as an image and display as text."
344 (interactive)
9b9debd1
JL
345 (condition-case err
346 (progn
347 (unless (display-images-p)
348 (error "Display does not support images"))
349
350 (kill-all-local-variables)
351 (setq major-mode 'image-mode)
352
353 (if (not (image-get-display-property))
354 (progn
355 (image-toggle-display-image)
356 ;; If attempt to display the image fails.
357 (if (not (image-get-display-property))
358 (error "Invalid image")))
359 ;; Set next vars when image is already displayed but local
360 ;; variables were cleared by kill-all-local-variables
361 (setq cursor-type nil truncate-lines t
362 image-type (plist-get (cdr (image-get-display-property)) :type)))
363
364 (setq mode-name (if image-type (format "Image[%s]" image-type) "Image"))
bb43424b 365 (use-local-map image-mode-map)
9b9debd1
JL
366
367 ;; Use our own bookmarking function for images.
368 (set (make-local-variable 'bookmark-make-record-function)
369 'image-bookmark-make-record)
370
371 ;; Keep track of [vh]scroll when switching buffers
372 (image-mode-setup-winprops)
373
374 (add-hook 'change-major-mode-hook 'image-toggle-display-text nil t)
0fb1193d 375 (add-hook 'after-revert-hook 'image-after-revert-hook nil t)
9b9debd1 376 (run-mode-hooks 'image-mode-hook)
18af70d0
CY
377 (let ((image (image-get-display-property))
378 (msg1 (substitute-command-keys
379 "Type \\[image-toggle-display] to view the image as ")))
380 (cond
381 ((null image)
382 (message "%s" (concat msg1 "an image.")))
383 ((image-animated-p image)
384 (message "%s"
385 (concat msg1 "text, or "
386 (substitute-command-keys
387 "\\[image-toggle-animation] to animate."))))
388 (t
389 (message "%s" (concat msg1 "text."))))))
390
9b9debd1
JL
391 (error
392 (image-mode-as-text)
393 (funcall
394 (if (called-interactively-p 'any) 'error 'message)
395 "Cannot display image: %s" (cdr err)))))
18af70d0 396
d90e651e
JL
397;;;###autoload
398(define-minor-mode image-minor-mode
399 "Toggle Image minor mode.
400With arg, turn Image minor mode on if arg is positive, off otherwise.
9b9debd1
JL
401It provides the key \\<image-mode-map>\\[image-toggle-display] \
402to switch back to `image-mode'
403to display an image file as the actual image."
404 nil (:eval (if image-type (format " Image[%s]" image-type) " Image"))
405 image-minor-mode-map
d90e651e
JL
406 :group 'image
407 :version "22.1"
9b9debd1
JL
408 (if image-minor-mode
409 (add-hook 'change-major-mode-hook (lambda () (image-minor-mode -1)) nil t)))
d90e651e
JL
410
411;;;###autoload
9b9debd1
JL
412(defun image-mode-as-text ()
413 "Set a non-image mode as major mode in combination with image minor mode.
414A non-image major mode found from `auto-mode-alist' or Fundamental mode
415displays an image file as text. `image-minor-mode' provides the key
416\\<image-mode-map>\\[image-toggle-display] to switch back to `image-mode'
417to display an image file as the actual image.
418
419You can use `image-mode-as-text' in `auto-mode-alist' when you want
316d12fb 420to display an image file as text initially.
9b9debd1
JL
421
422See commands `image-mode' and `image-minor-mode' for more information
423on these modes."
d90e651e 424 (interactive)
9b9debd1
JL
425 ;; image-mode-as-text = normal-mode + image-minor-mode
426 (let ((previous-image-type image-type)) ; preserve `image-type'
427 (if image-mode-previous-major-mode
428 ;; Restore previous major mode that was already found by this
429 ;; function and cached in `image-mode-previous-major-mode'
430 (funcall image-mode-previous-major-mode)
431 (let ((auto-mode-alist
432 (delq nil (mapcar
433 (lambda (elt)
434 (unless (memq (or (car-safe (cdr elt)) (cdr elt))
435 '(image-mode image-mode-maybe image-mode-as-text))
436 elt))
437 auto-mode-alist)))
438 (magic-fallback-mode-alist
439 (delq nil (mapcar
440 (lambda (elt)
441 (unless (memq (or (car-safe (cdr elt)) (cdr elt))
442 '(image-mode image-mode-maybe image-mode-as-text))
443 elt))
444 magic-fallback-mode-alist))))
445 (normal-mode)
446 (set (make-local-variable 'image-mode-previous-major-mode) major-mode)))
447 ;; Restore `image-type' after `kill-all-local-variables' in `normal-mode'.
448 (setq image-type previous-image-type)
449 ;; Enable image minor mode with `C-c C-c'.
450 (image-minor-mode 1)
451 ;; Show the image file as text.
452 (image-toggle-display-text)
453 (message "%s" (concat
454 (substitute-command-keys
455 "Type \\[image-toggle-display] to view the image as ")
456 (if (image-get-display-property)
457 "text" "an image") "."))))
458
459(define-obsolete-function-alias 'image-mode-maybe 'image-mode "23.2")
d90e651e
JL
460
461(defun image-toggle-display-text ()
9b9debd1
JL
462 "Show the image file as text.
463Remove text properties that display the image."
464 (let ((inhibit-read-only t)
465 (buffer-undo-list t)
466 (modified (buffer-modified-p)))
467 (remove-list-of-text-properties (point-min) (point-max)
468 '(display intangible read-nonsticky
469 read-only front-sticky))
470 (set-buffer-modified-p modified)
471 (if (called-interactively-p 'any)
472 (message "Repeat this command to go back to displaying the image"))))
c7bd5d57 473
f2920ffe
RS
474(defvar archive-superior-buffer)
475(defvar tar-superior-buffer)
110683ad 476(declare-function image-flush "image.c" (spec &optional frame))
f2920ffe 477
9b9debd1
JL
478(defun image-toggle-display-image ()
479 "Show the image of the image file.
480Turn the image data into a real image, but only if the whole file
481was inserted."
a32d4040
CY
482 (unless (derived-mode-p 'image-mode major-mode)
483 (error "The buffer is not in Image mode"))
9b9debd1
JL
484 (let* ((filename (buffer-file-name))
485 (data-p (not (and filename
486 (file-readable-p filename)
487 (not (file-remote-p filename))
488 (not (buffer-modified-p))
489 (not (and (boundp 'archive-superior-buffer)
490 archive-superior-buffer))
491 (not (and (boundp 'tar-superior-buffer)
492 tar-superior-buffer)))))
493 (file-or-data (if data-p
494 (string-make-unibyte
495 (buffer-substring-no-properties (point-min) (point-max)))
496 filename))
497 (type (image-type file-or-data nil data-p))
e8cbec34
CY
498 (image (create-image file-or-data type data-p))
499 (inhibit-read-only t)
500 (buffer-undo-list t)
501 (modified (buffer-modified-p))
502 props)
503
18af70d0
CY
504 ;; Discard any stale image data before looking it up again.
505 (image-flush image)
e8cbec34
CY
506 (setq image (append image (image-transform-properties image)))
507 (setq props
9b9debd1
JL
508 `(display ,image
509 intangible ,image
510 rear-nonsticky (display intangible)
511 read-only t front-sticky (read-only)))
e8cbec34 512
9b9debd1
JL
513 (let ((buffer-file-truename nil)) ; avoid changing dir mtime by lock_file
514 (add-text-properties (point-min) (point-max) props)
515 (restore-buffer-modified-p modified))
516 ;; Inhibit the cursor when the buffer contains only an image,
517 ;; because cursors look very strange on top of images.
518 (setq cursor-type nil)
519 ;; This just makes the arrow displayed in the right fringe
520 ;; area look correct when the image is wider than the window.
521 (setq truncate-lines t)
4114ed61
EZ
522 ;; Disable adding a newline at the end of the image file when it
523 ;; is written with, e.g., C-x C-w.
524 (if (coding-system-equal (coding-system-base buffer-file-coding-system)
525 'no-conversion)
526 (set (make-local-variable 'find-file-literally) t))
9b9debd1
JL
527 ;; Allow navigation of large images
528 (set (make-local-variable 'auto-hscroll-mode) nil)
529 (setq image-type type)
530 (if (eq major-mode 'image-mode)
531 (setq mode-name (format "Image[%s]" type)))
532 (if (called-interactively-p 'any)
533 (message "Repeat this command to go back to displaying the file as text"))))
534
c7bd5d57 535(defun image-toggle-display ()
71d73c9c
CY
536 "Toggle between image and text display.
537If the current buffer is displaying an image file as an image,
538call `image-mode-as-text' to switch to text. Otherwise, display
539the image by calling `image-mode'."
c7bd5d57 540 (interactive)
91784462 541 (if (image-get-display-property)
9b9debd1
JL
542 (image-mode-as-text)
543 (image-mode)))
0fb1193d
JL
544
545(defun image-after-revert-hook ()
546 (when (image-get-display-property)
547 (image-toggle-display-text)
548 ;; Update image display.
637d46ca
GM
549 (mapc (lambda (window) (redraw-frame (window-frame window)))
550 (get-buffer-window-list (current-buffer) 'nomini 'visible))
0fb1193d
JL
551 (image-toggle-display-image)))
552
97666703 553\f
18af70d0
CY
554;;; Animated images
555
556(defcustom image-animate-loop nil
557 "Whether to play animated images on a loop in Image mode."
558 :type 'boolean
559 :version "24.1"
560 :group 'image)
561
562(defun image-toggle-animation ()
563 "Start or stop animating the current image."
564 (interactive)
565 (let ((image (image-get-display-property))
566 animation)
567 (cond
568 ((null image)
569 (error "No image is present"))
570 ((null (setq animation (image-animated-p image)))
571 (message "No image animation."))
572 (t
573 (let ((timer (image-animate-timer image)))
574 (if timer
575 (cancel-timer timer)
576 (let ((index (plist-get (cdr image) :index)))
577 ;; If we're at the end, restart.
578 (and index
579 (>= index (1- (car animation)))
580 (setq index nil))
581 (image-animate image index
582 (if image-animate-loop t)))))))))
583
584\f
137187c8 585;;; Support for bookmark.el
e44fa724
KF
586(declare-function bookmark-make-record-default
587 "bookmark" (&optional no-file no-context posn))
43f8b275
SM
588(declare-function bookmark-prop-get "bookmark" (bookmark prop))
589(declare-function bookmark-default-handler "bookmark" (bmk))
137187c8 590
43f8b275 591(defun image-bookmark-make-record ()
f12492c8
TV
592 `(,@(bookmark-make-record-default nil 'no-context 0)
593 (image-type . ,image-type)
594 (handler . image-bookmark-jump)))
137187c8 595
137187c8
TH
596;;;###autoload
597(defun image-bookmark-jump (bmk)
03e26a79 598 ;; This implements the `handler' function interface for record type
e0385bf4 599 ;; returned by `bookmark-make-record-function', which see.
43f8b275
SM
600 (prog1 (bookmark-default-handler bmk)
601 (when (not (string= image-type (bookmark-prop-get bmk 'image-type)))
602 (image-toggle-display))))
97666703 603\f
c7f514b5
JV
604
605(defvar image-transform-minor-mode-map
606 (let ((map (make-sparse-keymap)))
a32d4040
CY
607 ;; (define-key map [(control ?+)] 'image-scale-in)
608 ;; (define-key map [(control ?-)] 'image-scale-out)
609 ;; (define-key map [(control ?=)] 'image-scale-none)
610 ;; (define-key map "c f h" 'image-scale-fit-height)
611 ;; (define-key map "c ]" 'image-rotate-right)
c7f514b5 612 map)
a32d4040 613 "Minor mode keymap `image-transform-mode'.")
c7f514b5
JV
614
615(define-minor-mode image-transform-mode
a32d4040
CY
616 "Minor mode for scaling and rotating images.
617This minor mode has no effect unless Emacs is compiled with
618ImageMagick support."
619 nil "image-transform" image-transform-minor-mode-map)
620
621(defvar image-transform-resize nil
622 "The image resize operation.
623Its value should be one of the following:
624 - nil, meaning no resizing.
625 - `fit-height', meaning to fit the image to the window height.
626 - `fit-width', meaning to fit the image to the window width.
627 - A number, which is a scale factor (the default size is 100).")
c7f514b5 628
18af70d0
CY
629(defvar image-transform-rotation 0.0
630 "Rotation angle for the image in the current Image mode buffer.")
c7f514b5 631
18af70d0
CY
632(defun image-transform-properties (spec)
633 "Return rescaling/rotation properties for image SPEC.
634These properties are determined by the Image mode variables
635`image-transform-resize' and `image-transform-rotation'. The
636return value is suitable for appending to an image spec.
e8cbec34
CY
637
638Recaling and rotation properties only take effect if Emacs is
639compiled with ImageMagick support."
18af70d0
CY
640 (when (or image-transform-resize
641 (not (equal image-transform-rotation 0.0)))
642 ;; Note: `image-size' looks up and thus caches the untransformed
643 ;; image. There's no easy way to prevent that.
644 (let* ((size (image-size spec t))
645 (height
646 (cond
647 ((numberp image-transform-resize)
648 (unless (= image-transform-resize 100)
649 (* image-transform-resize (cdr size))))
650 ((eq image-transform-resize 'fit-height)
651 (- (nth 3 (window-inside-pixel-edges))
652 (nth 1 (window-inside-pixel-edges))))))
653 (width (if (eq image-transform-resize 'fit-width)
654 (- (nth 2 (window-inside-pixel-edges))
655 (nth 0 (window-inside-pixel-edges))))))
656 ;;TODO fit-to-* should consider the rotation angle
657 `(,@(if height (list :height height))
658 ,@(if width (list :width width))
659 ,@(if (not (equal 0.0 image-transform-rotation))
660 (list :rotation image-transform-rotation))))))
c7f514b5
JV
661
662(defun image-transform-set-scale (scale)
a32d4040
CY
663 "Prompt for a number, and resize the current image by that amount.
664This command has no effect unless Emacs is compiled with
665ImageMagick support."
666 (interactive "nScale: ")
c183f693 667 (setq image-transform-resize scale)
a32d4040 668 (image-toggle-display-image))
c7f514b5
JV
669
670(defun image-transform-fit-to-height ()
a32d4040
CY
671 "Fit the current image to the height of the current window.
672This command has no effect unless Emacs is compiled with
673ImageMagick support."
c7f514b5 674 (interactive)
a32d4040
CY
675 (setq image-transform-resize 'fit-height)
676 (image-toggle-display-image))
c7f514b5 677
3a50be51 678(defun image-transform-fit-to-width ()
a32d4040
CY
679 "Fit the current image to the width of the current window.
680This command has no effect unless Emacs is compiled with
681ImageMagick support."
3a50be51 682 (interactive)
a32d4040
CY
683 (setq image-transform-resize 'fit-width)
684 (image-toggle-display-image))
c7f514b5
JV
685
686(defun image-transform-set-rotation (rotation)
a32d4040
CY
687 "Prompt for an angle ROTATION, and rotate the image by that amount.
688ROTATION should be in degrees. This command has no effect unless
689Emacs is compiled with ImageMagick support."
690 (interactive "nRotation angle (in degrees): ")
fe72c5b4
JV
691 ;;TODO 0 90 180 270 degrees are the only reasonable angles here
692 ;;otherwise combining with rescaling will get very awkward
c7f514b5 693 (setq image-transform-rotation (float rotation))
a32d4040 694 (image-toggle-display-image))
c7f514b5 695
c7bd5d57
RS
696(provide 'image-mode)
697
698;;; image-mode.el ends here