Add 2007 to copyright.
[bpt/emacs.git] / lisp / image-file.el
index a3a23ef..5251a2c 100644 (file)
@@ -1,6 +1,7 @@
-;;; 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 Free Software Foundation, Inc.
 ;;
 ;; Author: Miles Bader <miles@gnu.org>
 ;; Keywords: multimedia
 
 ;; 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.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
 
 ;;; 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-name-extensions
-  '("png" "jpeg" "jpg" "gif" "tiff" "xbm" "xpm")
+  '("png" "jpeg" "jpg" "gif" "tiff" "tif" "xbm" "xpm" "pbm" "pgm" "ppm" "pnm")
   "*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)
@@ -55,15 +57,16 @@ variable is set using \\[customize]."
   :initialize 'custom-initialize-default
   :group 'image)
 
+;;;###autoload
 (defcustom image-file-name-regexps nil
-  "*A 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 `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]."
+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)
@@ -76,47 +79,24 @@ variable is set using \\[customize]."
 
 ;;;###autoload
 (defun image-file-name-regexp ()
-  "Return a regular expression that matches image-file filenames."
+  "Return a regular expression matching image-file filenames."
   (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
                   (if exts-regexp
-                      (cons exts-regexp image-file-regexps)
-                    image-file-regexps)
+                      (cons exts-regexp image-file-name-regexps)
+                    image-file-name-regexps)
                   "\\|")
       exts-regexp)))
 
 
-;;;###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.
-
-Image files are those whose name has an extension in
-`image-file-name-extensions', or matches a regexp in
-`image-file-name-regexps'."
-  nil
-  nil
-  nil
-  :global t
-  :group 'image
-  ;; Remove existing handler
-  (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, if enabled
-  (when auto-image-file-mode
-    (push (cons (image-file-name-regexp) 'image-file-handler)
-         file-name-handler-alist)))
-
-
 ;;;###autoload
 (defun insert-image-file (file &optional visit beg end replace)
   "Insert the image file FILE into the current buffer.
@@ -131,6 +111,7 @@ the command `insert-file-contents'."
     (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)))
@@ -138,19 +119,47 @@ the command `insert-file-contents'."
              (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 (and (eq operation 'insert-file-contents)
@@ -170,6 +179,30 @@ Optional argument ARGS are the arguments to call FUNCTION with."
     (apply function args)))
 
 
+;;;###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.
+
+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)))
+    (when existing-entry
+      (setq file-name-handler-alist
+           (delq existing-entry file-name-handler-alist))))
+  ;; Add new handler, if enabled
+  (when auto-image-file-mode
+    (push (cons (image-file-name-regexp) 'image-file-handler)
+         file-name-handler-alist)))
+
+
 (provide 'image-file)
 
+;;; arch-tag: 04cafe36-f7ba-4c80-9f47-4cb656520ce1
 ;;; image-file.el ends here