Close bug#3992.

[gnu-emacs] / lisp / image-dired.el

diff --git a/lisp/image-dired.el b/lisp/image-dired.el
index 0bd3ab5641d5eaf40a386555d10d9b6314c2e190..f006e2e9edd46f592663c240761daa509f206fae 100644 (file)
--- a/lisp/image-dired.el
+++ b/lisp/image-dired.el
@@ -1,6 +1,6 @@
 ;;; image-dired.el --- use dired to browse and manipulate your images
 ;;
 ;;; image-dired.el --- use dired to browse and manipulate your images
 ;;

-;; Copyright (C) 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+;; Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.

 ;;
 ;; Version: 0.4.11
 ;; Keywords: multimedia
 ;;
 ;; Version: 0.4.11
 ;; Keywords: multimedia


@@ -164,7 +164,7 @@
   :prefix "image-dired-"
   :group 'multimedia)
 
   :prefix "image-dired-"
   :group 'multimedia)
 

-(defcustom image-dired-dir (concat user-emacs-directory "image-dired/")
+(defcustom image-dired-dir (locate-user-emacs-file "image-dired/")

   "Directory where thumbnail images are stored."
   :type 'string
   :group 'image-dired)
   "Directory where thumbnail images are stored."
   :type 'string
   :group 'image-dired)


@@ -186,19 +186,19 @@ that allows sharing of thumbnails across different programs."
   :group 'image-dired)
 
 (defcustom image-dired-db-file
   :group 'image-dired)
 
 (defcustom image-dired-db-file

-  (concat user-emacs-directory "image-dired/.image-dired_db")
+  (locate-user-emacs-file "image-dired/.image-dired_db")

   "Database file where file names and their associated tags are stored."
   :type 'string
   :group 'image-dired)
 
 (defcustom image-dired-temp-image-file
   "Database file where file names and their associated tags are stored."
   :type 'string
   :group 'image-dired)
 
 (defcustom image-dired-temp-image-file

-  (concat user-emacs-directory "image-dired/.image-dired_temp")
+  (locate-user-emacs-file "image-dired/.image-dired_temp")

   "Name of temporary image file used by various commands."
   :type 'string
   :group 'image-dired)
 
 (defcustom image-dired-gallery-dir
   "Name of temporary image file used by various commands."
   :type 'string
   :group 'image-dired)
 
 (defcustom image-dired-gallery-dir

-  (concat user-emacs-directory "image-dired/.image-dired_gallery")
+  (locate-user-emacs-file "image-dired/.image-dired_gallery")

   "Directory to store generated gallery html pages.
 This path needs to be \"shared\" to the public so that it can access
 the index.html page that image-dired creates."
   "Directory to store generated gallery html pages.
 This path needs to be \"shared\" to the public so that it can access
 the index.html page that image-dired creates."


@@ -229,7 +229,7 @@ Used together with `image-dired-cmd-create-thumbnail-options'."
   :group 'image-dired)
 
 (defcustom image-dired-cmd-create-thumbnail-options
   :group 'image-dired)
 
 (defcustom image-dired-cmd-create-thumbnail-options

-  "%p -size %wx%h \"%f\" -resize %wx%h -strip jpeg:\"%t\""
+  "%p -size %wx%h \"%f\" -resize \"%wx%h>\" -strip jpeg:\"%t\""

   "Format of command used to create thumbnail image.
 Available options are %p which is replaced by
 `image-dired-cmd-create-thumbnail-program', %w which is replaced by
   "Format of command used to create thumbnail image.
 Available options are %p which is replaced by
 `image-dired-cmd-create-thumbnail-program', %w which is replaced by


@@ -247,7 +247,7 @@ Used together with `image-dired-cmd-create-temp-image-options'."
   :group 'image-dired)
 
 (defcustom image-dired-cmd-create-temp-image-options
   :group 'image-dired)
 
 (defcustom image-dired-cmd-create-temp-image-options

-  "%p -size %wx%h \"%f\" -resize %wx%h -strip jpeg:\"%t\""
+  "%p -size %wx%h \"%f\" -resize \"%wx%h>\" -strip jpeg:\"%t\""

   "Format of command used to create temporary image for display window.
 Available options are %p which is replaced by
 `image-dired-cmd-create-temp-image-program', %w and %h which is replaced by
   "Format of command used to create temporary image for display window.
 Available options are %p which is replaced by
 `image-dired-cmd-create-temp-image-program', %w and %h which is replaced by


@@ -280,7 +280,7 @@ with the information required by the Thumbnail Managing Standard."
       "-set \"Thumb::URI\" \"file://%f\" "
       "-set \"Description\" \"Thumbnail of file://%f\" "
       "-set \"Software\" \"" (emacs-version) "\" "))
       "-set \"Thumb::URI\" \"file://%f\" "
       "-set \"Description\" \"Thumbnail of file://%f\" "
       "-set \"Software\" \"" (emacs-version) "\" "))

-   "-thumbnail %wx%h png:\"%t\""
+   "-thumbnail \"%wx%h>\" png:\"%t\""

    (if image-dired-cmd-pngnq-program
        (concat
         " ; " image-dired-cmd-pngnq-program " -f \"%t\""
    (if image-dired-cmd-pngnq-program
        (concat
         " ; " image-dired-cmd-pngnq-program " -f \"%t\""


@@ -343,7 +343,7 @@ original image file name and %t which is replaced by
   :group 'image-dired)
 
 (defcustom image-dired-temp-rotate-image-file
   :group 'image-dired)
 
 (defcustom image-dired-temp-rotate-image-file

-  (concat user-emacs-directory "image-dired/.image-dired_rotate_temp")
+  (locate-user-emacs-file "image-dired/.image-dired_rotate_temp")

   "Temporary file for rotate operations."
   :type 'string
   :group 'image-dired)
   "Temporary file for rotate operations."
   :type 'string
   :group 'image-dired)


@@ -366,8 +366,8 @@ Used together with `image-dired-cmd-write-exif-data-options'."
   "%p -%t=\"%v\" \"%f\""
   "Format of command used to write EXIF data.
 Available options are %p which is replaced by
   "%p -%t=\"%v\" \"%f\""
   "Format of command used to write EXIF data.
 Available options are %p which is replaced by

-`image-dired-cmd-write-exif-data-program', %f which is replaced by the
-image file name, %t which is replaced by the tag name and %v
+`image-dired-cmd-write-exif-data-program', %f which is replaced by
+the image file name, %t which is replaced by the tag name and %v

 which is replaced by the tag value."
   :type 'string
   :group 'image-dired)
 which is replaced by the tag value."
   :type 'string
   :group 'image-dired)


@@ -397,7 +397,8 @@ Used by `image-dired-gallery-generate' to leave out \"hidden\" images."
 
 (defcustom image-dired-thumb-size (if (eq 'standard image-dired-thumbnail-storage) 128 100)
   "Size of thumbnails, in pixels.
 
 (defcustom image-dired-thumb-size (if (eq 'standard image-dired-thumbnail-storage) 128 100)
   "Size of thumbnails, in pixels.

-This is the default size for both `image-dired-thumb-width' and `image-dired-thumb-height'."
+This is the default size for both `image-dired-thumb-width'
+and `image-dired-thumb-height'."

   :type 'integer
   :group 'image-dired)
 
   :type 'integer
   :group 'image-dired)
 


@@ -424,11 +425,11 @@ This is where you see the cursor."
 
 (defcustom image-dired-line-up-method 'dynamic
   "Default method for line-up of thumbnails in thumbnail buffer.
 
 (defcustom image-dired-line-up-method 'dynamic
   "Default method for line-up of thumbnails in thumbnail buffer.

-Used by `image-dired-display-thumbs' and other functions that needs to
-line-up thumbnails.  Dynamic means to use the available width of the
-window containing the thumbnail buffer, Fixed means to use
-`image-dired-thumbs-per-row', Interactive is for asking the user, and No
-line-up means that no automatic line-up will be done."
+Used by `image-dired-display-thumbs' and other functions that needs
+to line-up thumbnails.  Dynamic means to use the available width of
+the window containing the thumbnail buffer, Fixed means to use
+`image-dired-thumbs-per-row', Interactive is for asking the user,
+and No line-up means that no automatic line-up will be done."

   :type '(choice :tag "Default line-up method"
                  (const :tag "Dynamic" dynamic)
                 (const :tag "Fixed" fixed)
   :type '(choice :tag "Default line-up method"
                  (const :tag "Dynamic" dynamic)
                 (const :tag "Fixed" fixed)


@@ -509,7 +510,7 @@ Used by `image-dired-copy-with-exif-file-name'."
   :group 'image-dired)
 
 (defcustom image-dired-show-all-from-dir-max-files 50
   :group 'image-dired)
 
 (defcustom image-dired-show-all-from-dir-max-files 50

-  "Maximum number of files to show using `image-dired-show-all-from-dir'.
+  "Maximum number of files to show using `image-dired-show-all-from-dir'

 before warning the user."
   :type 'integer
   :group 'image-dired)
 before warning the user."
   :type 'integer
   :group 'image-dired)


@@ -655,7 +656,7 @@ according to the Thumbnail Managing Standard."
 
 (defun image-dired-dired-after-readin-hook ()
   "Relocate existing thumbnail overlays in dired buffer after reverting.
 
 (defun image-dired-dired-after-readin-hook ()
   "Relocate existing thumbnail overlays in dired buffer after reverting.

-Move them to their corresponding files if they are still exist.
+Move them to their corresponding files if they still exist.

 Otherwise, delete overlays."
   (mapc (lambda (overlay)
           (when (overlay-get overlay 'put-image)
 Otherwise, delete overlays."
   (mapc (lambda (overlay)
           (when (overlay-get overlay 'put-image)


@@ -800,7 +801,7 @@ you have the dired buffer in the left window and the
 With optional argument APPEND, append thumbnail to thumbnail buffer
 instead of erasing it first.
 
 With optional argument APPEND, append thumbnail to thumbnail buffer
 instead of erasing it first.
 

-Option argument DO-NOT-POP controls if `pop-to-buffer' should be
+Optional argument DO-NOT-POP controls if `pop-to-buffer' should be

 used or not.  If non-nil, use `display-buffer' instead of
 `pop-to-buffer'.  This is used from functions like
 `image-dired-next-line-and-display' and
 used or not.  If non-nil, use `display-buffer' instead of
 `pop-to-buffer'.  This is used from functions like
 `image-dired-next-line-and-display' and


@@ -885,8 +886,8 @@ Signal error if there are problems creating it."
 
 (defun image-dired-write-tags (file-tags)
   "Write file tags to database.
 
 (defun image-dired-write-tags (file-tags)
   "Write file tags to database.

-Write each file and tag in FILE-TAGS to the database.  FILE-TAGS
-is an alist in the following form:
+Write each file and tag in FILE-TAGS to the database.
+FILE-TAGS is an alist in the following form:

  ((FILE . TAG) ... )"
   (image-dired-sane-db-file)
   (let (end file tag)
  ((FILE . TAG) ... )"
   (image-dired-sane-db-file)
   (let (end file tag)


@@ -1021,8 +1022,8 @@ With prefix argument ARG, remove tag from file at point."
 
 (defun image-dired-track-original-file ()
   "Track the original file in the associated dired buffer.
 
 (defun image-dired-track-original-file ()
   "Track the original file in the associated dired buffer.

-See documentation for `image-dired-toggle-movement-tracking'.  Interactive
-use only useful if `image-dired-track-movement' is nil."
+See documentation for `image-dired-toggle-movement-tracking'.
+Interactive use only useful if `image-dired-track-movement' is nil."

   (interactive)
   (let ((old-buf (current-buffer))
         (dired-buf (image-dired-associated-dired-buffer))
   (interactive)
   (let ((old-buf (current-buffer))
         (dired-buf (image-dired-associated-dired-buffer))


@@ -1047,8 +1048,8 @@ position in the other buffer."
 
 (defun image-dired-track-thumbnail ()
   "Track current dired file's thumb in `image-dired-thumbnail-buffer'.
 
 (defun image-dired-track-thumbnail ()
   "Track current dired file's thumb in `image-dired-thumbnail-buffer'.

-This is almost the same as what `image-dired-track-original-file' does, but
-the other way around."
+This is almost the same as what `image-dired-track-original-file' does,
+but the other way around."

   (let ((file (dired-get-filename))
         (old-buf (current-buffer))
         prop-val found)
   (let ((file (dired-get-filename))
         (old-buf (current-buffer))
         prop-val found)


@@ -1071,8 +1072,8 @@ the other way around."
 
 (defun image-dired-dired-next-line (&optional arg)
   "Call `dired-next-line', then track thumbnail.
 
 (defun image-dired-dired-next-line (&optional arg)
   "Call `dired-next-line', then track thumbnail.

-This can safely replace `dired-next-line'.  With prefix argument, move
-ARG lines."
+This can safely replace `dired-next-line'.
+With prefix argument, move ARG lines."

   (interactive "P")
   (dired-next-line (or arg 1))
   (if image-dired-track-movement
   (interactive "P")
   (dired-next-line (or arg 1))
   (if image-dired-track-movement


@@ -1080,8 +1081,8 @@ ARG lines."
 
 (defun image-dired-dired-previous-line (&optional arg)
   "Call `dired-previous-line', then track thumbnail.
 
 (defun image-dired-dired-previous-line (&optional arg)
   "Call `dired-previous-line', then track thumbnail.

-This can safely replace `dired-previous-line'.  With prefix argument,
-move ARG lines."
+This can safely replace `dired-previous-line'.
+With prefix argument, move ARG lines."

   (interactive "P")
   (dired-previous-line (or arg 1))
   (if image-dired-track-movement
   (interactive "P")
   (dired-previous-line (or arg 1))
   (if image-dired-track-movement


@@ -1158,7 +1159,7 @@ image."
 (defun image-dired-format-properties-string (buf file props comment)
   "Format display properties.
 BUF is the associated dired buffer, FILE is the original image file
 (defun image-dired-format-properties-string (buf file props comment)
   "Format display properties.
 BUF is the associated dired buffer, FILE is the original image file

-name, PROPS is a list of tags and COMMENT is the image files's
+name, PROPS is a list of tags and COMMENT is the image file's

 comment."
   (format-spec
    image-dired-display-properties-format
 comment."
   (format-spec
    image-dired-display-properties-format


@@ -1583,10 +1584,12 @@ Note that n, p and <down> and <up> will be hijacked and bound to
     [menu-bar image-dired image-dired-next-line-and-display]
     '("Display thumb for next file" . image-dired-next-line-and-display)))
 
     [menu-bar image-dired image-dired-next-line-and-display]
     '("Display thumb for next file" . image-dired-next-line-and-display)))
 

+(declare-function clear-image-cache "image.c" (&optional filter))
+

 (defun image-dired-create-thumbs (&optional arg)
   "Create thumbnail images for all marked files in dired.
 With prefix argument ARG, create thumbnails even if they already exist
 (defun image-dired-create-thumbs (&optional arg)
   "Create thumbnail images for all marked files in dired.
 With prefix argument ARG, create thumbnails even if they already exist

-\(i.e.  use this to refresh your thumbnails)."
+\(i.e. use this to refresh your thumbnails)."

   (interactive "P")
   (let (curr-file thumb-name files count)
     (setq files (dired-get-marked-files))
   (interactive "P")
   (let (curr-file thumb-name files count)
     (setq files (dired-get-marked-files))


@@ -2046,8 +2049,8 @@ function.  The result is a couple of new files in
 
 (defun image-dired-write-comments (file-comments)
   "Write file comments to database.
 
 (defun image-dired-write-comments (file-comments)
   "Write file comments to database.

-Write file comments to one or more files.  FILE-COMMENTS is an alist on
-the following form:
+Write file comments to one or more files.
+FILE-COMMENTS is an alist on the following form:

  ((FILE . COMMENT) ... )"
   (image-dired-sane-db-file)
   (let (end comment-beg-pos comment-end-pos file comment)
  ((FILE . COMMENT) ... )"
   (image-dired-sane-db-file)
   (let (end comment-beg-pos comment-end-pos file comment)


@@ -2110,8 +2113,7 @@ the following form:
 
 (defun image-dired-read-comment (&optional file)
   "Read comment for an image.
 
 (defun image-dired-read-comment (&optional file)
   "Read comment for an image.

-Read comment for an image, optionally using old comment from FILE
-as initial value."
+Optionally use old comment from FILE as initial value."

   (let ((comment
          (read-string
           "Comment: "
   (let ((comment
          (read-string
           "Comment: "


@@ -2147,7 +2149,7 @@ A `tag' is a keyword, a piece of meta data, associated with an
 image file and stored in image-dired's database file.  This command
 lets you input a regexp and this will be matched against all tags
 on all image files in the database file.  The files that have a
 image file and stored in image-dired's database file.  This command
 lets you input a regexp and this will be matched against all tags
 on all image files in the database file.  The files that have a

-matching tags will be marked in the dired buffer."
+matching tag will be marked in the dired buffer."

   (interactive)
   (image-dired-sane-db-file)
   (let ((tag (read-string "Mark tagged files (regexp): "))
   (interactive)
   (image-dired-sane-db-file)
   (let ((tag (read-string "Mark tagged files (regexp): "))


@@ -2358,7 +2360,7 @@ image-dired-file-comment-list:
   "Generate gallery pages.
 First we create a couple of Lisp structures from the database to make
 it easier to generate, then HTML-files are created in
   "Generate gallery pages.
 First we create a couple of Lisp structures from the database to make
 it easier to generate, then HTML-files are created in

-`image-dired-gallery-dir'"
+`image-dired-gallery-dir'."

   (interactive)
   (if (eq 'per-directory image-dired-thumbnail-storage)
       (error "Currently, gallery generation is not supported \
   (interactive)
   (if (eq 'per-directory image-dired-thumbnail-storage)
       (error "Currently, gallery generation is not supported \