1 ;;; image-mode.el --- support for visiting image files
3 ;; Copyright (C) 2005, 2006, 2007 Free Software Foundation, Inc.
5 ;; Author: Richard Stallman <rms@gnu.org>
6 ;; Keywords: multimedia
8 ;; This file is part of GNU Emacs.
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)
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.
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., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
27 ;; Defines a major mode for visiting image files
28 ;; that allows conversion between viewing the text of the file
29 ;; and viewing the file as an image. Viewing the image
30 ;; works by putting a `display' text-property on the
31 ;; image data, with the image-data still present underneath; if the
32 ;; resulting buffer file is saved to another name it will correctly save
33 ;; the image data to the new file.
39 ;;;###autoload (push '("\\.jpe?g\\'" . image-mode) auto-mode-alist)
40 ;;;###autoload (push '("\\.png\\'" . image-mode) auto-mode-alist)
41 ;;;###autoload (push '("\\.gif\\'" . image-mode) auto-mode-alist)
42 ;;;###autoload (push '("\\.tiff?\\'" . image-mode) auto-mode-alist)
43 ;;;###autoload (push '("\\.p[bpgn]m\\'" . image-mode) auto-mode-alist)
44 ;;;###autoload (push '("\\.x[bp]m\\'" . image-mode-maybe) auto-mode-alist)
46 (defvar image-mode-map
47 (let ((map (make-sparse-keymap)))
48 (define-key map
"\C-c\C-c" 'image-toggle-display
)
50 "Major mode keymap for Image mode.")
54 "Major mode for image files.
55 You can use \\<image-mode-map>\\[image-toggle-display]
56 to toggle between display as an image and display as text."
58 (kill-all-local-variables)
59 (setq mode-name
"Image")
60 (setq major-mode
'image-mode
)
61 (use-local-map image-mode-map
)
62 (add-hook 'change-major-mode-hook
'image-toggle-display-text nil t
)
63 (run-mode-hooks 'image-mode-hook
)
64 (if (display-images-p)
66 (substitute-command-keys
67 "Type \\[image-toggle-display] to view as ")
68 (if (get-text-property (point-min) 'display
)
69 "text" "an image") "."))))
72 (define-minor-mode image-minor-mode
73 "Toggle Image minor mode.
74 With arg, turn Image minor mode on if arg is positive, off otherwise.
75 See the command `image-mode' for more information on this mode."
76 nil
" Image" image-mode-map
79 (if (not image-minor-mode
)
80 (image-toggle-display-text)
81 (if (get-text-property (point-min) 'display
)
82 (setq cursor-type nil truncate-lines t
))
83 (add-hook 'change-major-mode-hook
(lambda () (image-minor-mode -
1)) nil t
)
84 (message "%s" (concat (substitute-command-keys
85 "Type \\[image-toggle-display] to view the image as ")
86 (if (get-text-property (point-min) 'display
)
87 "text" "an image") "."))))
90 (defun image-mode-maybe ()
91 "Set major or minor mode for image files.
92 Set Image major mode only when there are no other major modes
93 associated with a filename in `auto-mode-alist'. When an image
94 filename matches another major mode in `auto-mode-alist' then
95 set that major mode and Image minor mode.
97 See commands `image-mode' and `image-minor-mode' for more
98 information on these modes."
103 (unless (memq (or (car-safe (cdr elt
)) (cdr elt
))
104 '(image-mode image-mode-maybe
))
107 (if (assoc-default buffer-file-name mode-alist
'string-match
)
108 (let ((auto-mode-alist mode-alist
))
110 (image-minor-mode t
))
113 (defun image-toggle-display-text ()
114 "Showing the text of the image file."
115 (if (get-text-property (point-min) 'display
)
116 (image-toggle-display)))
118 (defvar archive-superior-buffer
)
119 (defvar tar-superior-buffer
)
121 (defun image-toggle-display ()
122 "Start or stop displaying an image file as the actual image.
123 This command toggles between showing the text of the image file
124 and showing the image as an image."
126 (if (get-text-property (point-min) 'display
)
127 (let ((inhibit-read-only t
)
129 (modified (buffer-modified-p)))
130 (remove-list-of-text-properties (point-min) (point-max)
131 '(display intangible read-nonsticky
132 read-only front-sticky
))
133 (set-buffer-modified-p modified
)
134 (kill-local-variable 'cursor-type
)
135 (kill-local-variable 'truncate-lines
)
136 (if (called-interactively-p)
137 (message "Repeat this command to go back to displaying the image")))
138 ;; Turn the image data into a real image, but only if the whole file
141 (if (and (buffer-file-name)
142 (not (file-remote-p (buffer-file-name)))
143 (not (buffer-modified-p))
144 (not (and (boundp 'archive-superior-buffer
)
145 archive-superior-buffer
))
146 (not (and (boundp 'tar-superior-buffer
)
147 tar-superior-buffer
)))
148 (progn (clear-image-cache)
149 (create-image (buffer-file-name)))
152 (buffer-substring-no-properties (point-min) (point-max)))
157 rear-nonsticky
(display intangible
)
158 ;; This a cheap attempt to make the whole buffer
159 ;; read-only when we're visiting the file (as
160 ;; opposed to just inserting it).
161 read-only t front-sticky
(read-only)))
162 (inhibit-read-only t
)
164 (modified (buffer-modified-p)))
165 (add-text-properties (point-min) (point-max) props
)
166 (set-buffer-modified-p modified
)
167 ;; Inhibit the cursor when the buffer contains only an image,
168 ;; because cursors look very strange on top of images.
169 (setq cursor-type nil
)
170 ;; This just makes the arrow displayed in the right fringe
171 ;; area look correct when the image is wider than the window.
172 (setq truncate-lines t
)
173 (if (called-interactively-p)
174 (message "Repeat this command to go back to displaying the file as text")))))
176 (provide 'image-mode
)
178 ;; arch-tag: b5b2b7e6-26a7-4b79-96e3-1546b5c4c6cb
179 ;;; image-mode.el ends here