-;;; 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-2016 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 displayed by 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
;;;###autoload
(defcustom image-file-name-extensions
- '("png" "jpeg" "jpg" "gif" "tiff" "xbm" "xpm" "pbm")
- "*A list of image-file filename extensions.
+ (purecopy '("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 the
-variable is set using \\[customize]."
+`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)
;;;###autoload
(defcustom image-file-name-regexps nil
- "*List of regexps matching image-file filenames.
+ "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 the
-variable is set using \\[customize]."
+`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)
(let ((exts-regexp
(and image-file-name-extensions
(concat "\\."
- (regexp-opt image-file-name-extensions t)
+ (regexp-opt (nconc (mapcar #'upcase
+ image-file-name-extensions)
+ image-file-name-extensions)
+ t)
"\\'"))))
(if image-file-name-regexps
(mapconcat 'identity
(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)))
(create-image data nil t))
(props
`(display ,image
+ yank-handler
+ (image-file-yank-handler nil t)
intangible ,image
- rear-nonsticky (display intangible read-only)
+ 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)
"Filename handler for inserting image files.
OPERATION is the operation to perform, on ARGS.
(apply function args)))
-;;; Note this definition must be at the end of the file, because
-;;; `define-minor-mode' actually calls the mode-function if the
-;;; associated variable is non-nil, which requires that all needed
-;;; functions be already defined. [This is arguably a bug in d-m-m]
;;;###autoload
(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.
+ "Toggle visiting of image files as images (Auto Image File mode).
+With a prefix argument ARG, enable Auto Image File mode if ARG is
+positive, and disable it otherwise. If called from Lisp, enable
+the mode if ARG is omitted or nil.
-Image files are those whose name has an extension in
+An image file is one whose name has an extension in
`image-file-name-extensions', or matches a regexp in
`image-file-name-regexps'."
:global t