-;;; image-file.el --- Support for visiting image files
+;;; image-file.el --- support for visiting image files
;;
-;; Copyright (C) 2000 Free Software Foundation, Inc.
+;; Copyright (C) 2000, 2001, 2002, 2003, 2004,
+;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
;;
;; Author: Miles Bader <miles@gnu.org>
;; Keywords: multimedia
;; This file is part of GNU Emacs.
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 2, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING. If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; Defines a file-name-handler hook that transforms visited (or
-;; inserted) image files so that they are by displayed as emacs as
+;; inserted) image files so that they are displayed by Emacs as
;; images. This is done by putting a `display' text-property on the
;; image data, with the image-data still present underneath; if the
;; resulting buffer file is saved to another name it will correctly save
(require 'image)
+
;;;###autoload
-(defcustom image-file-handler-enabled nil
- "True if visiting an image file will actually display the image.
-A file is considered an image file if its filename matches one of the
-regexps in `image-file-regexps'.
-
-Setting this variable directly does not take effect;
-use either \\[customize] or the function `set-image-file-handler-enabled'."
- :type 'boolean
- :set (lambda (sym val) (set-image-file-handler-enabled val))
+(defcustom image-file-name-extensions
+ '("png" "jpeg" "jpg" "gif" "tiff" "tif" "xbm" "xpm" "pbm" "pgm" "ppm" "pnm" "svg")
+ "*A list of image-file filename extensions.
+Filenames having one of these extensions are considered image files,
+in addition to those matching `image-file-name-regexps'.
+
+See `auto-image-file-mode'; if `auto-image-file-mode' is enabled,
+setting this variable directly does not take effect unless
+`auto-image-file-mode' is re-enabled; this happens automatically when
+the variable is set using \\[customize]."
+ :type '(repeat string)
+ :set (lambda (sym val)
+ (set-default sym val)
+ (when auto-image-file-mode
+ ;; Re-initialize the image-file handler
+ (auto-image-file-mode t)))
:initialize 'custom-initialize-default
- :require 'image-file
:group 'image)
-(defcustom image-file-regexps
- '("\\.png$" "\\.jpeg$" "\\.jpg$" "\\.gif$" "\\.tiff$" "\\.x[bp]m$")
- "*A list of regexps matching files that should be displayed as images.
-
-Setting this variable directly does not take effect until the next time
-`set-image-file-handler-enabled' is called (which happens automatically
-when using \\[customize]."
+;;;###autoload
+(defcustom image-file-name-regexps nil
+ "*List of regexps matching image-file filenames.
+Filenames matching one of these regexps are considered image files,
+in addition to those with an extension in `image-file-name-extensions'.
+
+See function `auto-image-file-mode'; if `auto-image-file-mode' is
+enabled, setting this variable directly does not take effect unless
+`auto-image-file-mode' is re-enabled; this happens automatically when
+the variable is set using \\[customize]."
:type '(repeat regexp)
:set (lambda (sym val)
(set-default sym val)
- (when image-file-handler-enabled
+ (when auto-image-file-mode
;; Re-initialize the image-file handler
- (set-image-file-handler-enabled t)))
+ (auto-image-file-mode t)))
:initialize 'custom-initialize-default
:group 'image)
+
+;;;###autoload
+(defun image-file-name-regexp ()
+ "Return a regular expression matching image-file filenames."
+ (let ((exts-regexp
+ (and image-file-name-extensions
+ (concat "\\."
+ (regexp-opt (nconc (mapcar #'upcase
+ image-file-name-extensions)
+ image-file-name-extensions)
+ t)
+ "\\'"))))
+ (if image-file-name-regexps
+ (mapconcat 'identity
+ (if exts-regexp
+ (cons exts-regexp image-file-name-regexps)
+ image-file-name-regexps)
+ "\\|")
+ exts-regexp)))
+
+
;;;###autoload
(defun insert-image-file (file &optional visit beg end replace)
"Insert the image file FILE into the current buffer.
(image-file-call-underlying #'insert-file-contents-literally
'insert-file-contents
file visit beg end replace)))
- (when (and image-file-handler-enabled (or (null beg) (zerop beg)) (null end))
- ;; Make image into a picture, but only if the whole file was inserted
+ ;; Turn the image data into a real image, but only if the whole file
+ ;; was inserted
+ (when (and (or (null beg) (zerop beg)) (null end))
(let* ((ibeg (point))
(iend (+ (point) (cadr rval)))
+ (visitingp (and visit (= ibeg (point-min)) (= iend (point-max))))
(data
- (string-make-unibyte (buffer-substring-no-properties ibeg iend)))
+ (string-make-unibyte
+ (buffer-substring-no-properties ibeg iend)))
(image
(create-image data nil t))
(props
`(display ,image
+ yank-handler
+ (image-file-yank-handler nil t)
intangible ,image
- rear-nonsticky (display)
+ rear-nonsticky (display intangible)
;; This a cheap attempt to make the whole buffer
- ;; read-only when we're visiting the file.
- ,@(and visit
- (= ibeg (point-min))
- (= iend (point-max))
+ ;; read-only when we're visiting the file (as
+ ;; opposed to just inserting it).
+ ,@(and visitingp
'(read-only t front-sticky (read-only))))))
- (add-text-properties ibeg iend props)))
+ (add-text-properties ibeg iend props)
+ (when visitingp
+ ;; Inhibit the cursor when the buffer contains only an image,
+ ;; because cursors look very strange on top of images.
+ (setq cursor-type nil)
+ ;; This just makes the arrow displayed in the right fringe
+ ;; area look correct when the image is wider than the window.
+ (setq truncate-lines t))))
rval))
+;; We use a yank-handler to make yanked images unique, so that
+;; yanking two copies of the same image next to each other are
+;; recognized as two different images.
+(defun image-file-yank-handler (string)
+ "Yank handler for inserting an image into a buffer."
+ (let ((len (length string))
+ (image (get-text-property 0 'display string)))
+ (remove-text-properties 0 len yank-excluded-properties string)
+ (if (consp image)
+ (add-text-properties 0
+ (or (next-single-property-change 0 'image-counter string)
+ (length string))
+ `(display
+ ,(cons (car image) (cdr image))
+ yank-handler
+ ,(cons 'image-file-yank-handler '(nil t)))
+ string))
+ (insert string)))
+
+(put 'image-file-handler 'safe-magic t)
(defun image-file-handler (operation &rest args)
- "File name handler for inserting image files.
+ "Filename handler for inserting image files.
OPERATION is the operation to perform, on ARGS.
See `file-name-handler-alist' for details."
- (if (eq operation 'insert-file-contents)
+ (if (and (eq operation 'insert-file-contents)
+ auto-image-file-mode)
(apply #'insert-image-file args)
;; We don't handle OPERATION, use another handler or the default
(apply #'image-file-call-underlying operation operation args)))
(inhibit-file-name-operation operation))
(apply function args)))
+
;;;###autoload
-(defun set-image-file-handler-enabled (enabled)
- "Enable or disable visiting image files as real images, as per ENABLED.
-The regexp in `image-file-regexp' is used to determine which filenames are
-considered image files."
+(define-minor-mode auto-image-file-mode
+ "Toggle visiting of image files as images.
+With prefix argument ARG, turn on if positive, otherwise off.
+Returns non-nil if the new state is enabled.
+
+Image files are those whose name has an extension in
+`image-file-name-extensions', or matches a regexp in
+`image-file-name-regexps'."
+ :global t
+ :group 'image
;; Remove existing handler
- (let ((existing-entry (rassq 'image-file-handler file-name-handler-alist)))
+ (let ((existing-entry
+ (rassq 'image-file-handler file-name-handler-alist)))
(when existing-entry
(setq file-name-handler-alist
(delq existing-entry file-name-handler-alist))))
- ;; Add new handler
- (when enabled
- (let ((regexp
- (concat "\\("
- (mapconcat 'identity image-file-regexps "\\|")
- "\\)")))
- (setq file-name-handler-alist
- (cons (cons regexp 'image-file-handler) file-name-handler-alist))))
- (setq-default image-file-handler-enabled enabled))
+ ;; Add new handler, if enabled
+ (when auto-image-file-mode
+ (push (cons (image-file-name-regexp) 'image-file-handler)
+ file-name-handler-alist)))
-;;;###autoload
-(defun enable-image-file-handler ()
- "Enable visiting image files as real images.
-The regexp in `image-file-regexp' is used to determine which filenames are
-considered image files."
- (interactive)
- (set-image-file-handler-enabled t))
-
-(defun disable-image-file-handler ()
- "Disable visiting image files as real images."
- (interactive)
- (set-image-file-handler-enabled nil))
(provide 'image-file)
+;; arch-tag: 04cafe36-f7ba-4c80-9f47-4cb656520ce1
;;; image-file.el ends here