1 ;;; tumme.el --- use dired to browse and manipulate your images
3 ;; Copyright (C) 2005, 2006 Free Software Foundation, Inc.
6 ;; Keywords: multimedia
7 ;; Author: Mathias Dahl <mathias.rem0veth1s.dahl@gmail.com>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
31 ;; I needed a program to browse, organize and tag my pictures. I got
32 ;; tired of the old gallery program I used as it did not allow
33 ;; multi-file operations easily. Also, it put things out of my
34 ;; control. Image viewing programs I tested did not allow multi-file
35 ;; operations or did not do what I wanted it to.
37 ;; So, I got the idea to use the wonderful functionality of Emacs and
38 ;; `dired' to do it. It would allow me to do almost anything I wanted,
39 ;; which is basically just to browse all my pictures in an easy way,
40 ;; letting me manipulate and tag them in various ways. `dired' already
41 ;; provide all the file handling and navigation facilities; I only
42 ;; needed to add some functions to display the images.
44 ;; I briefly tried out thumbs.el, and although it seemed more
45 ;; powerful than this package, it did not work the way I wanted to. It
46 ;; was too slow to created thumbnails of all files in a directory (I
47 ;; currently keep all my 2000+ images in the same directory) and
48 ;; browsing the thumbnail buffer was slow too. tumme.el will not
49 ;; create thumbnails until they are needed and the browsing is done
50 ;; quickly and easily in dired. I copied a great deal of ideas and
51 ;; code from there though... :)
53 ;; About the name: tumme means thumb in Swedish and it is used for
54 ;; working with thumbnails, so... :) If you want to know how to
55 ;; pronounce it, go to the page on EmacsWiki and download the .ogg
58 ;; `tumme' stores the thumbnail files in `tumme-dir' using the file
59 ;; name format ORIGNAME.thumb.ORIGEXT. For example
60 ;; ~/.emacs.d/tumme/myimage01.thumb.jpg. The "database" is for now
61 ;; just a plain text file with the following format:
63 ;; file-name-non-directory;comment:comment-text;tag1;tag2;tag3;...;tagN
69 ;; * The ImageMagick package. Currently, `convert' and `mogrify' are
70 ;; used. Find it here: http://www.imagemagick.org.
72 ;; * For non-lossy rotation of JPEG images, the JpegTRAN program is
75 ;; * For `tumme-get-exif-data' and `tumme-write-exif-data' to work,
76 ;; the command line tool `exiftool' is needed. It can be found here:
77 ;; http://www.sno.phy.queensu.ca/~phil/exiftool/. These two functions
78 ;; are, among other things, used for writing comments to image files
79 ;; using `tumme-thumbnail-set-image-description' and to create
80 ;; "unique" file names using `tumme-get-exif-file-name' (used by
81 ;; `tumme-copy-with-exif-file-name').
87 ;; This information has been moved to the manual. Type `C-h r' to open
88 ;; the Emacs manual and go to the node Thumbnails by typing `g
91 ;; Quickstart: M-x tumme RET DIRNAME RET
93 ;; where DIRNAME is a directory containing image files.
98 ;; * Supports all image formats that Emacs and convert supports, but
99 ;; the thumbnails are hard-coded to JPEG format.
101 ;; * WARNING: The "database" format used might be changed so keep a
102 ;; backup of `tumme-db-file' when testing new versions.
108 ;; * Support gallery creation when using per-directory thumbnail
111 ;; * Some sort of auto-rotate function based on rotate info in the
114 ;; * Check if exiftool exist before trying to call it to give a better
117 ;; * Investigate if it is possible to also write the tags to the image
120 ;; * From thumbs.el: Add an option for clean-up/max-size functionality
121 ;; for thumbnail directory.
123 ;; * From thumbs.el: Add setroot function.
125 ;; * From thumbs.el: Add image resizing, if useful (tumme's automatic
126 ;; "image fit" might be enough)
128 ;; * From thumbs.el: Add the "modify" commands (emboss, negate,
131 ;; * Asynchronous creation of thumbnails.
133 ;; * Add `tumme-display-thumbs-ring' and functions to cycle that. Find
134 ;; out which is best, saving old batch just before inserting new, or
135 ;; saving the current batch in the ring when inserting it. Adding it
136 ;; probably needs rewriting `tumme-display-thumbs' to be more general.
138 ;; * Find some way of toggling on and off really nice keybindings in
139 ;; dired (for example, using C-n or <down> instead of C-S-n). Richard
140 ;; suggested that we could keep C-t as prefix for tumme commands as it
141 ;; is currently not used in dired. He also suggested that
142 ;; `dired-next-line' and `dired-previous-line' figure out if tumme is
143 ;; enabled in the current buffer and, if it is, call
144 ;; `tumme-dired-next-line' and `tumme-dired-previous-line',
145 ;; respectively. Update: This is partly done; some bindings have now
146 ;; been added to dired.
148 ;; * Enhanced gallery creation with basic CSS-support and pagination
149 ;; of tag pages with many pictures.
151 ;; * Rewrite `tumme-modify-mark-on-thumb-original-file' to be less
154 ;; * In some way keep track of buffers and windows and stuff so that
155 ;; it works as the user expects.
157 ;; * More/better documentation
163 (require 'format-spec)
166 "Use dired to browse your images as thumbnails, and more."
170 (defcustom tumme-dir "~/.emacs.d/tumme/"
171 "*Directory where thumbnail images are stored."
175 (defcustom tumme-thumbnail-storage 'use-tumme-dir
176 "*How to store tumme's thumbnail files.
177 Tumme can store thumbnail files in one of two ways and this is
178 controlled by this variable. \"Use tumme dir\" means that the
179 thumbnails are stored in a central directory. \"Per directory\"
180 means that each thumbnail is stored in a subdirectory called
181 \".tumme\" in the same directory where the image file is.
182 \"Thumbnail Managing Standard\" means that the thumbnails are
183 stored and generated according to the Thumbnail Managing Standard
184 that allows sharing of thumbnails across different programs."
185 :type '(choice :tag "How to store thumbnail files"
186 (const :tag "Thumbnail Managing Standard" standard)
187 (const :tag "Use tumme-dir" use-tumme-dir)
188 (const :tag "Per-directory" per-directory))
191 (defcustom tumme-db-file "~/.emacs.d/tumme/.tumme_db"
192 "*Database file where file names and their associated tags are stored."
196 (defcustom tumme-temp-image-file "~/.emacs.d/tumme/.tumme_temp"
197 "*Name of temporary image file used by various commands."
201 (defcustom tumme-gallery-dir "~/.emacs.d/tumme/.tumme_gallery"
202 "*Directory to store generated gallery html pages.
203 This path needs to be \"shared\" to the public so that it can access
204 the index.html page that tumme creates."
208 (defcustom tumme-gallery-image-root-url
209 "http://your.own.server/tummepics"
210 "*URL where the full size images are to be found.
211 Note that this path has to be configured in your web server. Tumme
212 expects to find pictures in this directory."
216 (defcustom tumme-gallery-thumb-image-root-url
217 "http://your.own.server/tummethumbs"
218 "*URL where the thumbnail images are to be found.
219 Note that this path has to be configured in your web server. Tumme
220 expects to find pictures in this directory."
224 (defcustom tumme-cmd-create-thumbnail-program
226 "*Executable used to create thumbnail.
227 Used together with `tumme-cmd-create-thumbnail-options'."
231 (defcustom tumme-cmd-create-thumbnail-options
232 "%p -size %wx%h \"%f\" -resize %wx%h +profile \"*\" jpeg:\"%t\""
233 "*Format of command used to create thumbnail image.
234 Available options are %p which is replaced by
235 `tumme-cmd-create-thumbnail-program', %w which is replaced by
236 `tumme-thumb-width', %h which is replaced by `tumme-thumb-height',
237 %f which is replaced by the file name of the original image and %t
238 which is replaced by the file name of the thumbnail file."
242 (defcustom tumme-cmd-create-temp-image-program
244 "*Executable used to create temporary image.
245 Used together with `tumme-cmd-create-temp-image-options'."
249 (defcustom tumme-cmd-create-temp-image-options
250 "%p -size %wx%h \"%f\" -resize %wx%h +profile \"*\" jpeg:\"%t\""
251 "*Format of command used to create temporary image for display window.
252 Available options are %p which is replaced by
253 `tumme-cmd-create-temp-image-program', %w and %h which is replaced by
254 the calculated max size for width and height in the image display window,
255 %f which is replaced by the file name of the original image and %t which
256 is replaced by the file name of the temporary file."
260 (defcustom tumme-cmd-pngnq-program (executable-find "pngnq")
261 "*The file name of the `pngnq' program.
262 It quantizes colors of PNG images down to 256 colors."
263 :type '(choice (const :tag "Not Set" nil) string)
266 (defcustom tumme-cmd-pngcrush-program (executable-find "pngcrush")
267 "*The file name of the `pngcrush' program.
268 It optimizes the compression of PNG images. Also it adds PNG textual chunks
269 with the information required by the Thumbnail Managing Standard."
270 :type '(choice (const :tag "Not Set" nil) string)
273 (defcustom tumme-cmd-create-standard-thumbnail-command
275 tumme-cmd-create-thumbnail-program " "
276 "-size %wx%h \"%f\" "
277 (unless (or tumme-cmd-pngcrush-program tumme-cmd-pngnq-program)
279 "-set \"Thumb::MTime\" \"%m\" "
280 "-set \"Thumb::URI\" \"file://%f\" "
281 "-set \"Description\" \"Thumbnail of file://%f\" "
282 "-set \"Software\" \"" (emacs-version) "\" "))
283 "-thumbnail %wx%h png:\"%t\""
284 (if tumme-cmd-pngnq-program
286 " ; " tumme-cmd-pngnq-program " -f \"%t\""
287 (unless tumme-cmd-pngcrush-program
289 (if tumme-cmd-pngcrush-program
291 (unless tumme-cmd-pngcrush-program
293 " ; " tumme-cmd-pngcrush-program " -q "
294 "-text b \"Description\" \"Thumbnail of file://%f\" "
295 "-text b \"Software\" \"" (emacs-version) "\" "
296 ;; "-text b \"Thumb::Image::Height\" \"%oh\" "
297 ;; "-text b \"Thumb::Image::Mimetype\" \"%mime\" "
298 ;; "-text b \"Thumb::Image::Width\" \"%ow\" "
299 "-text b \"Thumb::MTime\" \"%m\" "
300 ;; "-text b \"Thumb::Size\" \"%b\" "
301 "-text b \"Thumb::URI\" \"file://%f\" "
304 "*Command to create thumbnails according to the Thumbnail Managing Standard."
308 (defcustom tumme-cmd-rotate-thumbnail-program
310 "*Executable used to rotate thumbnail.
311 Used together with `tumme-cmd-rotate-thumbnail-options'."
315 (defcustom tumme-cmd-rotate-thumbnail-options
316 "%p -rotate %d \"%t\""
317 "*Format of command used to rotate thumbnail image.
318 Available options are %p which is replaced by
319 `tumme-cmd-rotate-thumbnail-program', %d which is replaced by the
320 number of (positive) degrees to rotate the image, normally 90 or 270
321 \(for 90 degrees right and left), %t which is replaced by the file name
322 of the thumbnail file."
326 (defcustom tumme-cmd-rotate-original-program
328 "*Executable used to rotate original image.
329 Used together with `tumme-cmd-rotate-original-options'."
333 (defcustom tumme-cmd-rotate-original-options
334 "%p -rotate %d -copy all \"%o\" > %t"
335 "*Format of command used to rotate original image.
336 Available options are %p which is replaced by
337 `tumme-cmd-rotate-original-program', %d which is replaced by the
338 number of (positive) degrees to rotate the image, normally 90 or
339 270 \(for 90 degrees right and left), %o which is replaced by the
340 original image file name and %t which is replaced by
341 `tumme-temp-image-file'."
345 (defcustom tumme-temp-rotate-image-file
346 "~/.emacs.d/tumme/.tumme_rotate_temp"
347 "*Temporary file for rotate operations."
351 (defcustom tumme-rotate-original-ask-before-overwrite t
352 "Confirm overwrite of original file after rotate operation.
353 If non-nil, ask user for confirmation before overwriting the
354 original file with `tumme-temp-rotate-image-file'."
358 (defcustom tumme-cmd-write-exif-data-program
360 "*Program used to write EXIF data to image.
361 Used together with `tumme-cmd-write-exif-data-options'."
365 (defcustom tumme-cmd-write-exif-data-options
366 "%p -%t=\"%v\" \"%f\""
367 "*Format of command used to write EXIF data.
368 Available options are %p which is replaced by
369 `tumme-cmd-write-exif-data-program', %f which is replaced by the
370 image file name, %t which is replaced by the tag name and %v
371 which is replaced by the tag value."
375 (defcustom tumme-cmd-read-exif-data-program
377 "*Program used to read EXIF data to image.
378 Used together with `tumme-cmd-read-exif-data-program-options'."
382 (defcustom tumme-cmd-read-exif-data-options
383 "%p -s -s -s -%t \"%f\""
384 "*Format of command used to read EXIF data.
385 Available options are %p which is replaced by
386 `tumme-cmd-write-exif-data-options', %f which is replaced
387 by the image file name and %t which is replaced by the tag name."
391 (defcustom tumme-gallery-hidden-tags
392 (list "private" "hidden" "pending")
393 "*List of \"hidden\" tags.
394 Used by `tumme-gallery-generate' to leave out \"hidden\" images."
395 :type '(repeat string)
398 (defcustom tumme-thumb-size (if (eq 'standard tumme-thumbnail-storage) 128 100)
399 "Size of thumbnails, in pixels.
400 This is the default size for both `tumme-thumb-width' and `tumme-thumb-height'."
404 (defcustom tumme-thumb-width tumme-thumb-size
405 "Width of thumbnails, in pixels."
409 (defcustom tumme-thumb-height tumme-thumb-size
410 "Height of thumbnails, in pixels."
414 (defcustom tumme-thumb-relief 2
415 "*Size of button-like border around thumbnails."
419 (defcustom tumme-thumb-margin 2
420 "*Size of the margin around thumbnails.
421 This is where you see the cursor."
425 (defcustom tumme-line-up-method 'dynamic
426 "*Default method for line-up of thumbnails in thumbnail buffer.
427 Used by `tumme-display-thumbs' and other functions that needs to
428 line-up thumbnails. Dynamic means to use the available width of the
429 window containing the thumbnail buffer, Fixed means to use
430 `tumme-thumbs-per-row', Interactive is for asking the user, and No
431 line-up means that no automatic line-up will be done."
432 :type '(choice :tag "Default line-up method"
433 (const :tag "Dynamic" dynamic)
434 (const :tag "Fixed" fixed)
435 (const :tag "Interactive" interactive)
436 (const :tag "No line-up" none))
439 (defcustom tumme-thumbs-per-row 3
440 "*Number of thumbnails to display per row in thumb buffer."
444 (defcustom tumme-display-window-width-correction 1
445 "*Number to be used to correct image display window width.
446 Change if the default (1) does not work (i.e. if the image does not
451 (defcustom tumme-display-window-height-correction 0
452 "*Number to be used to correct image display window height.
453 Change if the default (0) does not work (i.e. if the image does not
458 (defcustom tumme-track-movement t
459 "The current state of the tracking and mirroring.
460 For more information, see the documentation for
461 `tumme-toggle-movement-tracking'."
465 (defcustom tumme-append-when-browsing nil
466 "Append thumbnails in thumbnail buffer when browsing.
467 If non-nil, using `tumme-next-line-and-display' and
468 `tumme-previous-line-and-display' will leave a trail of thumbnail
469 images in the thumbnail buffer. If you enable this and want to clean
470 the thumbnail buffer because it is filled with too many thumbmnails,
471 just call `tumme-display-thumb' to display only the image at point.
472 This value can be toggled using `tumme-toggle-append-browsing'."
476 (defcustom tumme-dired-disp-props t
477 "If non-nil, display properties for dired file when browsing.
478 Used by `tumme-next-line-and-display',
479 `tumme-previous-line-and-display' and `tumme-mark-and-display-next'.
480 If the database file is large, this can slow down image browsing in
481 dired and you might want to turn it off."
485 (defcustom tumme-display-properties-format "%b: %f (%t): %c"
486 "*Display format for thumbnail properties.
487 %b is replaced with associated dired buffer name, %f with file name
488 \(without path) of original image file, %t with the list of tags and %c
493 (defcustom tumme-external-viewer
494 ;; TODO: Use mailcap, dired-guess-shell-alist-default,
495 ;; dired-view-command-alist.
496 (cond ((executable-find "display"))
497 ((executable-find "xli"))
498 ((executable-find "qiv") "qiv -t"))
499 "*Name of external viewer.
500 Including parameters. Used when displaying original image from
501 `tumme-thumbnail-mode'."
505 (defcustom tumme-main-image-directory "~/pics/"
506 "*Name of main image directory, if any.
507 Used by `tumme-copy-with-exif-file-name'."
511 (defcustom tumme-show-all-from-dir-max-files 50
512 "*Maximum number of files to show using `tumme-show-all-from-dir'.
513 before warning the user."
518 "Return the current thumbnails directory (from variable `tumme-dir').
519 Create the thumbnails directory if it does not exist."
520 (let ((tumme-dir (file-name-as-directory
521 (expand-file-name tumme-dir))))
522 (unless (file-directory-p tumme-dir)
523 (make-directory tumme-dir t)
524 (message "Creating thumbnails directory"))
527 (defun tumme-insert-image (file type relief margin)
528 "Insert image FILE of image TYPE, using RELIEF and MARGIN, at point."
530 (let ((i `(image :type ,type
536 (defun tumme-get-thumbnail-image (file)
537 "Return the image descriptor for a thumbnail of image file FILE."
538 (unless (string-match (image-file-name-regexp) file)
539 (error "%s is not a valid image file" file))
540 (let ((thumb-file (tumme-thumb-name file)))
541 (unless (and (file-exists-p thumb-file)
542 (<= (float-time (nth 5 (file-attributes file)))
543 (float-time (nth 5 (file-attributes thumb-file)))))
544 (tumme-create-thumb file thumb-file))
545 (create-image thumb-file)
546 ;; (list 'image :type 'jpeg
548 ;; :relief tumme-thumb-relief :margin tumme-thumb-margin)
551 (defun tumme-insert-thumbnail (file original-file-name
552 associated-dired-buffer)
553 "Insert thumbnail image FILE.
554 Add text properties ORIGINAL-FILE-NAME and ASSOCIATED-DIRED-BUFFER."
557 (tumme-insert-image file
558 ;; TODO: this should depend on the real file type
559 (if (eq 'standard tumme-thumbnail-storage)
566 (list 'tumme-thumbnail t
567 'original-file-name original-file-name
568 'associated-dired-buffer associated-dired-buffer
569 'tags (tumme-list-tags original-file-name)
570 'mouse-face 'highlight
571 'comment (tumme-get-comment original-file-name)))))
573 (defun tumme-thumb-name (file)
574 "Return thumbnail file name for FILE.
575 Depending on the value of `tumme-thumbnail-storage', the file
576 name will vary. For central thumbnail file storage, make a
577 MD5-hash of the image file's directory name and add that to make
578 the thumbnail file name unique. For per-directory storage, just
579 add a subdirectory. For standard storage, produce the file name
580 according to the Thumbnail Managing Standard."
581 (cond ((eq 'standard tumme-thumbnail-storage)
583 (concat "~/.thumbnails/normal/"
584 (md5 (concat "file://" (expand-file-name file))) ".png")))
585 ((eq 'use-tumme-dir tumme-thumbnail-storage)
586 (let* ((f (expand-file-name file))
588 ;; Is MD5 hashes fast enough? The checksum of a
589 ;; thumbnail file name need not be that
590 ;; "cryptographically" good so a faster one could
592 (md5 (file-name-as-directory (file-name-directory f)))))
593 (format "%s%s%s.thumb.%s"
594 (file-name-as-directory (expand-file-name (tumme-dir)))
595 (file-name-sans-extension (file-name-nondirectory f))
596 (if md5-hash (concat "_" md5-hash) "")
597 (file-name-extension f))))
598 ((eq 'per-directory tumme-thumbnail-storage)
599 (let ((f (expand-file-name file)))
600 (format "%s.tumme/%s.thumb.%s"
601 (file-name-directory f)
602 (file-name-sans-extension (file-name-nondirectory f))
603 (file-name-extension f))))))
605 (defun tumme-create-thumb (original-file thumbnail-file)
606 "For ORIGINAL-FILE, create thumbnail image named THUMBNAIL-FILE."
607 (let* ((width (int-to-string tumme-thumb-width))
608 (height (int-to-string tumme-thumb-height))
609 (modif-time (format "%.0f" (float-time (nth 5 (file-attributes
611 (thumbnail-nq8-file (replace-regexp-in-string ".png\\'" "-nq8.png"
615 (if (eq 'standard tumme-thumbnail-storage)
616 tumme-cmd-create-standard-thumbnail-command
617 tumme-cmd-create-thumbnail-options)
619 (cons ?p tumme-cmd-create-thumbnail-program)
623 (cons ?f original-file)
624 (cons ?q thumbnail-nq8-file)
625 (cons ?t thumbnail-file))))
627 (when (not (file-exists-p
628 (setq thumbnail-dir (file-name-directory thumbnail-file))))
629 (message "Creating thumbnail directory.")
630 (make-directory thumbnail-dir))
631 (call-process shell-file-name nil nil nil shell-command-switch command)))
634 (defun tumme-dired-insert-marked-thumbs ()
635 "Insert thumbnails before file names of marked files in the dired buffer."
637 (dired-map-over-marks
638 (let* ((image-pos (dired-move-to-filename))
639 (image-file (dired-get-filename))
640 (thumb-file (tumme-get-thumbnail-image image-file))
642 ;; If image is not already added, then add it.
643 (unless (delq nil (mapcar (lambda (o) (overlay-get o 'put-image))
644 ;; Can't use (overlays-at (point)), BUG?
645 (overlays-in (point) (1+ (point)))))
646 (put-image thumb-file image-pos)
649 (car (delq nil (mapcar (lambda (o) (and (overlay-get o 'put-image) o))
650 (overlays-in (point) (1+ (point)))))))
651 (overlay-put overlay 'image-file image-file)
652 (overlay-put overlay 'thumb-file thumb-file)))
654 (add-hook 'dired-after-readin-hook 'tumme-dired-after-readin-hook nil t))
656 (defun tumme-dired-after-readin-hook ()
657 "Relocate existing thumbnail overlays in dired buffer after reverting.
658 Move them to their corresponding files if they are still exist.
659 Otherwise, delete overlays."
660 (mapc (lambda (overlay)
661 (when (overlay-get overlay 'put-image)
662 (let* ((image-file (overlay-get overlay 'image-file))
663 (image-pos (dired-goto-file image-file)))
665 (move-overlay overlay image-pos image-pos)
666 (delete-overlay overlay)))))
667 (overlays-in (point-min) (point-max))))
669 (defun tumme-next-line-and-display ()
670 "Move to next dired line and display thumbnail image."
673 (tumme-display-thumbs
674 t (or tumme-append-when-browsing nil) t)
675 (if tumme-dired-disp-props
676 (tumme-dired-display-properties)))
678 (defun tumme-previous-line-and-display ()
679 "Move to previous dired line and display thumbnail image."
681 (dired-previous-line 1)
682 (tumme-display-thumbs
683 t (or tumme-append-when-browsing nil) t)
684 (if tumme-dired-disp-props
685 (tumme-dired-display-properties)))
687 (defun tumme-toggle-append-browsing ()
688 "Toggle `tumme-append-when-browsing'."
690 (setq tumme-append-when-browsing
691 (not tumme-append-when-browsing))
692 (message "Append browsing %s."
693 (if tumme-append-when-browsing
697 (defun tumme-mark-and-display-next ()
698 "Mark current file in dired and display next thumbnail image."
701 (tumme-display-thumbs
702 t (or tumme-append-when-browsing nil) t)
703 (if tumme-dired-disp-props
704 (tumme-dired-display-properties)))
706 (defun tumme-toggle-dired-display-properties ()
707 "Toggle `tumme-dired-disp-props'."
709 (setq tumme-dired-disp-props
710 (not tumme-dired-disp-props))
711 (message "Dired display properties %s."
712 (if tumme-dired-disp-props
716 (defvar tumme-thumbnail-buffer "*tumme*"
717 "Tumme's thumbnail buffer.")
719 (defun tumme-create-thumbnail-buffer ()
720 "Create thumb buffer and set `tumme-thumbnail-mode'."
721 (let ((buf (get-buffer-create tumme-thumbnail-buffer)))
722 (with-current-buffer buf
723 (setq buffer-read-only t)
724 (if (not (eq major-mode 'tumme-thumbnail-mode))
725 (tumme-thumbnail-mode)))
728 (defvar tumme-display-image-buffer "*tumme-display-image*"
729 "Where larger versions of the images are display.")
731 (defun tumme-create-display-image-buffer ()
732 "Create image display buffer and set `tumme-display-image-mode'."
733 (let ((buf (get-buffer-create tumme-display-image-buffer)))
734 (with-current-buffer buf
735 (setq buffer-read-only t)
736 (if (not (eq major-mode 'tumme-display-image-mode))
737 (tumme-display-image-mode)))
740 (defvar tumme-saved-window-configuration nil
741 "Saved window configuration.")
744 (defun tumme-dired-with-window-configuration (dir &optional arg)
745 "Open directory DIR and create a default window configuration.
747 Convenience command that:
749 - Opens dired in folder DIR
750 - Splits windows in most useful (?) way
751 - Set `truncate-lines' to t
753 After the command has finished, you would typically mark some
754 image files in dired and type
755 \\[tumme-display-thumbs] (`tumme-display-thumbs').
757 If called with prefix argument ARG, skip splitting of windows.
759 The current window configuration is saved and can be restored by
760 calling `tumme-restore-window-configuration'."
761 (interactive "DDirectory: \nP")
762 (let ((buf (tumme-create-thumbnail-buffer))
763 (buf2 (tumme-create-display-image-buffer)))
764 (setq tumme-saved-window-configuration
765 (current-window-configuration))
767 (delete-other-windows)
769 (split-window-horizontally)
770 (setq truncate-lines t)
773 (switch-to-buffer buf)
774 (split-window-vertically)
776 (switch-to-buffer buf2)
777 (other-window -2)))))
779 (defun tumme-restore-window-configuration ()
780 "Restore window configuration.
781 Restore any changes to the window configuration made by calling
782 `tumme-dired-with-window-configuration'."
784 (if tumme-saved-window-configuration
785 (set-window-configuration tumme-saved-window-configuration)
786 (message "No saved window configuration")))
789 (defun tumme-display-thumbs (&optional arg append do-not-pop)
790 "Display thumbnails of all marked files, in `tumme-thumbnail-buffer'.
791 If a thumbnail image does not exist for a file, it is created on the
792 fly. With prefix argument ARG, display only thumbnail for file at
793 point (this is useful if you have marked some files but want to show
796 Recommended usage is to split the current frame horizontally so that
797 you have the dired buffer in the left window and the
798 `tumme-thumbnail-buffer' buffer in the right window.
800 With optional argument APPEND, append thumbnail to thumbnail buffer
801 instead of erasing it first.
803 Option argument DO-NOT-POP controls if `pop-to-buffer' should be
804 used or not. If non-nil, use `display-buffer' instead of
805 `pop-to-buffer'. This is used from functions like
806 `tumme-next-line-and-display' and
807 `tumme-previous-line-and-display' where we do not want the
808 thumbnail buffer to be selected."
810 (let ((buf (tumme-create-thumbnail-buffer))
811 curr-file thumb-name files count dired-buf beg)
813 (setq files (list (dired-get-filename)))
814 (setq files (dired-get-marked-files)))
815 (setq dired-buf (current-buffer))
816 (with-current-buffer buf
817 (let ((inhibit-read-only t))
820 (goto-char (point-max)))
823 (setq thumb-name (tumme-thumb-name curr-file))
824 (if (and (not (file-exists-p thumb-name))
825 (not (= 0 (tumme-create-thumb curr-file thumb-name))))
826 (message "Thumb could not be created for file %s" curr-file)
827 (tumme-insert-thumbnail thumb-name curr-file dired-buf)))
829 (cond ((eq 'dynamic tumme-line-up-method)
830 (tumme-line-up-dynamic))
831 ((eq 'fixed tumme-line-up-method)
833 ((eq 'interactive tumme-line-up-method)
834 (tumme-line-up-interactive))
835 ((eq 'none tumme-line-up-method)
838 (tumme-line-up-dynamic))))
840 (display-buffer tumme-thumbnail-buffer)
841 (pop-to-buffer tumme-thumbnail-buffer))))
844 (defun tumme-show-all-from-dir (dir)
845 "Make a preview buffer for all images in DIR and display it.
846 If the number of files in DIR matching `image-file-name-regexp'
847 exceeds `tumme-show-all-from-dir-max-files', a warning will be
849 (interactive "DDir: ")
851 (dired-mark-files-regexp (image-file-name-regexp))
852 (let ((files (dired-get-marked-files)))
853 (if (or (<= (length files) tumme-show-all-from-dir-max-files)
854 (and (> (length files) tumme-show-all-from-dir-max-files)
857 "Directory contains more than %d image files. Proceed? "
858 tumme-show-all-from-dir-max-files))))
860 (tumme-display-thumbs)
861 (pop-to-buffer tumme-thumbnail-buffer))
862 (message "Cancelled."))))
865 (defalias 'tumme 'tumme-show-all-from-dir)
867 (defun tumme-write-tag (files tag)
868 "For all FILES, writes TAG to the image database."
871 (setq buf (find-file tumme-db-file))
872 (if (not (listp files))
874 (setq files (list files))
875 (error "Files must be a string or a list of strings!")))
878 (goto-char (point-min))
879 (if (search-forward-regexp
880 (format "^%s" file) nil t)
885 (when (not (search-forward (format ";%s" tag) end t))
887 (insert (format ";%s" tag))))
888 (goto-char (point-max))
889 (insert (format "\n%s;%s" file tag))))
894 (defun tumme-remove-tag (files tag)
895 "For all FILES, remove TAG from the image database."
898 (setq buf (find-file tumme-db-file))
899 (if (not (listp files))
901 (setq files (list files))
902 (error "Files must be a string or a list of strings!")))
905 (goto-char (point-min))
906 (when (search-forward-regexp
907 (format "^%s" file) nil t)
911 (when (search-forward-regexp (format "\\(;%s\\)" tag) end t)
912 (delete-region (match-beginning 1) (match-end 1))
913 ;; Check if file should still be in the database. If
914 ;; it has no tags or comments, it will be removed.
918 (when (not (search-forward ";" end t))
920 ;; If on empty line at end of buffer
923 (delete-backward-char 1))))))
928 (defun tumme-list-tags (file)
929 "Read all tags for image FILE from the image database."
931 (let (end buf (tags ""))
932 (setq buf (find-file tumme-db-file))
933 (goto-char (point-min))
934 (when (search-forward-regexp
935 (format "^%s" file) nil t)
939 (if (search-forward ";" end t)
940 (if (search-forward "comment:" end t)
941 (if (search-forward ";" end t)
942 (setq tags (buffer-substring (point) end)))
943 (setq tags (buffer-substring (point) end)))))
945 (split-string tags ";"))))
948 (defun tumme-tag-files (arg)
949 "Tag marked file(s) in dired. With prefix ARG, tag file at point."
951 (let ((tag (read-string "Tags to add (separate tags with a semicolon): "))
954 (setq files (dired-get-filename))
955 (setq files (dired-get-marked-files)))
956 (tumme-write-tag files tag)))
958 (defun tumme-tag-thumbnail ()
959 "Tag current thumbnail."
961 (let ((tag (read-string "Tags to add (separate tags with a semicolon): ")))
962 (tumme-write-tag (tumme-original-file-name) tag))
963 (tumme-update-property
964 'tags (tumme-list-tags (tumme-original-file-name))))
967 (defun tumme-delete-tag (arg)
968 "Remove tag for selected file(s).
969 With prefix argument ARG, remove tag from file at point."
971 (let ((tag (read-string "Tag to remove: "))
974 (setq files (list (dired-get-filename)))
975 (setq files (dired-get-marked-files)))
976 (tumme-remove-tag files tag)))
978 (defun tumme-tag-thumbnail-remove ()
979 "Remove tag from thumbnail."
981 (let ((tag (read-string "Tag to remove: ")))
982 (tumme-remove-tag (tumme-original-file-name) tag))
983 (tumme-update-property
984 'tags (tumme-list-tags (tumme-original-file-name))))
986 (defun tumme-original-file-name ()
987 "Get original file name for thumbnail or display image at point."
988 (get-text-property (point) 'original-file-name))
990 (defun tumme-associated-dired-buffer ()
991 "Get associated dired buffer at point."
992 (get-text-property (point) 'associated-dired-buffer))
994 (defun tumme-get-buffer-window (buf)
995 "Return window where buffer BUF is."
996 (get-window-with-predicate
998 (equal (window-buffer window) buf))
1001 (defun tumme-track-original-file ()
1002 "Track the original file in the associated dired buffer.
1003 See documentation for `tumme-toggle-movement-tracking'. Interactive
1004 use only useful if `tumme-track-movement' is nil."
1006 (let ((old-buf (current-buffer))
1007 (dired-buf (tumme-associated-dired-buffer))
1008 (file-name (tumme-original-file-name)))
1009 (when (and dired-buf file-name)
1010 (setq file-name (file-name-nondirectory file-name))
1011 (set-buffer dired-buf)
1012 (goto-char (point-min))
1013 (if (not (search-forward file-name nil t))
1014 (message "Could not track file")
1015 (dired-move-to-filename)
1017 (tumme-get-buffer-window dired-buf) (point)))
1018 (set-buffer old-buf))))
1020 (defun tumme-toggle-movement-tracking ()
1021 "Turn on and off `tumme-track-movement'.
1022 Tracking of the movements between thumbnail and dired buffer so that
1023 they are \"mirrored\" in the dired buffer. When this is on, moving
1024 around in the thumbnail or dired buffer will find the matching
1025 position in the other buffer."
1027 (setq tumme-track-movement (not tumme-track-movement))
1028 (message "Tracking %s" (if tumme-track-movement "on" "off")))
1030 (defun tumme-track-thumbnail ()
1031 "Track current dired file's thumb in `tumme-thumbnail-buffer'.
1032 This is almost the same as what `tumme-track-original-file' does, but
1033 the other way around."
1034 (let ((file (dired-get-filename))
1035 (old-buf (current-buffer))
1037 (when (get-buffer tumme-thumbnail-buffer)
1038 (set-buffer tumme-thumbnail-buffer)
1039 (goto-char (point-min))
1040 (while (and (not (eobp))
1042 (if (and (setq prop-val
1043 (get-text-property (point) 'original-file-name))
1044 (string= prop-val file))
1050 (tumme-thumbnail-window) (point))
1051 (tumme-display-thumb-properties))
1052 (set-buffer old-buf))))
1054 (defun tumme-dired-next-line (&optional arg)
1055 "Call `dired-next-line', then track thumbnail.
1056 This can safely replace `dired-next-line'. With prefix argument, move
1059 (dired-next-line (or arg 1))
1060 (if tumme-track-movement
1061 (tumme-track-thumbnail)))
1063 (defun tumme-dired-previous-line (&optional arg)
1064 "Call `dired-previous-line', then track thumbnail.
1065 This can safely replace `dired-previous-line'. With prefix argument,
1068 (dired-previous-line (or arg 1))
1069 (if tumme-track-movement
1070 (tumme-track-thumbnail)))
1072 (defun tumme-forward-char ()
1073 "Move to next image and display properties."
1075 ;; Before we move, make sure that there is an image two positions
1077 (when (save-excursion
1079 (tumme-image-at-point-p))
1081 (while (and (not (eobp))
1082 (not (tumme-image-at-point-p)))
1084 (if tumme-track-movement
1085 (tumme-track-original-file)))
1086 (tumme-display-thumb-properties))
1088 (defun tumme-backward-char ()
1089 "Move to previous image and display properties."
1093 (while (and (not (bobp))
1094 (not (tumme-image-at-point-p)))
1096 (if tumme-track-movement
1097 (tumme-track-original-file)))
1098 (tumme-display-thumb-properties))
1100 (defun tumme-next-line ()
1101 "Move to next line and display properties."
1104 ;; If we end up in an empty spot, back up to the next thumbnail.
1105 (if (not (tumme-image-at-point-p))
1106 (tumme-backward-char))
1107 (if tumme-track-movement
1108 (tumme-track-original-file))
1109 (tumme-display-thumb-properties))
1112 (defun tumme-previous-line ()
1113 "Move to previous line and display properties."
1116 ;; If we end up in an empty spot, back up to the next
1117 ;; thumbnail. This should only happen if the user deleted a
1118 ;; thumbnail and did not refresh, so it is not very common. But we
1119 ;; can handle it in a good manner, so why not?
1120 (if (not (tumme-image-at-point-p))
1121 (tumme-backward-char))
1122 (if tumme-track-movement
1123 (tumme-track-original-file))
1124 (tumme-display-thumb-properties))
1126 (defun tumme-format-properties-string (buf file props comment)
1127 "Format display properties.
1128 BUF is the associated dired buffer, FILE is the original image file
1129 name, PROPS is a list of tags and COMMENT is the image files's
1132 tumme-display-properties-format
1136 (cons ?t (or (princ props) ""))
1137 (cons ?c (or comment "")))))
1139 (defun tumme-display-thumb-properties ()
1140 "Display thumbnail properties in the echo area."
1142 (let ((file-name (file-name-nondirectory (tumme-original-file-name)))
1143 (dired-buf (buffer-name (tumme-associated-dired-buffer)))
1146 (get-text-property (point) 'tags)
1148 (comment (get-text-property (point) 'comment)))
1151 (tumme-format-properties-string
1157 (defun tumme-dired-file-marked-p ()
1158 "Check whether file on current line is marked or not."
1161 (not (looking-at "^ .*$"))))
1163 (defun tumme-modify-mark-on-thumb-original-file (command)
1164 "Modify mark in dired buffer.
1165 This is quite ugly but I don't know how to implemented in a better
1166 way. COMMAND is one of 'mark for marking file in dired, 'unmark for
1167 unmarking file in dired or 'flag for flagging file for delete in
1169 (let ((file-name (tumme-original-file-name))
1170 (dired-buf (tumme-associated-dired-buffer)))
1171 (if (not (and dired-buf file-name))
1172 (message "No image, or image with correct properties, at point.")
1173 (with-current-buffer dired-buf
1175 (setq file-name (file-name-nondirectory file-name))
1176 (goto-char (point-min))
1177 (if (search-forward file-name nil t)
1178 (cond ((eq command 'mark) (dired-mark 1))
1179 ((eq command 'unmark) (dired-unmark 1))
1180 ((eq command 'toggle)
1181 (if (tumme-dired-file-marked-p)
1184 ((eq command 'flag) (dired-flag-file-deletion 1))))))))
1186 (defun tumme-mark-thumb-original-file ()
1187 "Mark original image file in associated dired buffer."
1189 (tumme-modify-mark-on-thumb-original-file 'mark)
1190 (tumme-forward-char))
1192 (defun tumme-unmark-thumb-original-file ()
1193 "Unmark original image file in associated dired buffer."
1195 (tumme-modify-mark-on-thumb-original-file 'unmark)
1196 (tumme-forward-char))
1198 (defun tumme-flag-thumb-original-file ()
1199 "Flag original image file for deletion in associated dired buffer."
1201 (tumme-modify-mark-on-thumb-original-file 'flag)
1202 (tumme-forward-char))
1204 (defun tumme-toggle-mark-thumb-original-file ()
1205 "Toggle mark on original image file in associated dired buffer."
1207 (tumme-modify-mark-on-thumb-original-file 'toggle))
1209 (defun tumme-jump-original-dired-buffer ()
1210 "Jump to the dired buffer associated with the current image file.
1211 You probably want to use this together with
1212 `tumme-track-original-file'."
1214 (let ((buf (tumme-associated-dired-buffer))
1216 (setq window (tumme-get-buffer-window buf))
1219 (if (not (equal (selected-frame) (setq frame (window-frame window))))
1220 (select-frame-set-input-focus frame))
1221 (select-window window))
1222 (message "Associated dired buffer not visible"))))
1225 (defun tumme-jump-thumbnail-buffer ()
1226 "Jump to thumbnail buffer."
1228 (let ((window (tumme-thumbnail-window))
1232 (if (not (equal (selected-frame) (setq frame (window-frame window))))
1233 (select-frame-set-input-focus frame))
1234 (select-window window))
1235 (message "Thumbnail buffer not visible"))))
1237 (defvar tumme-thumbnail-mode-map (make-sparse-keymap)
1238 "Keymap for `tumme-thumbnail-mode'.")
1240 (defvar tumme-thumbnail-mode-line-up-map (make-sparse-keymap)
1241 "Keymap for line-up commands in `tumme-thumbnail-mode'.")
1243 (defvar tumme-thumbnail-mode-tag-map (make-sparse-keymap)
1244 "Keymap for tag commands in `tumme-thumbnail-mode'.")
1246 (defun tumme-define-thumbnail-mode-keymap ()
1247 "Define keymap for `tumme-thumbnail-mode'."
1250 (define-key tumme-thumbnail-mode-map [right] 'tumme-forward-char)
1251 (define-key tumme-thumbnail-mode-map [left] 'tumme-backward-char)
1252 (define-key tumme-thumbnail-mode-map [up] 'tumme-previous-line)
1253 (define-key tumme-thumbnail-mode-map [down] 'tumme-next-line)
1254 (define-key tumme-thumbnail-mode-map "\C-f" 'tumme-forward-char)
1255 (define-key tumme-thumbnail-mode-map "\C-b" 'tumme-backward-char)
1256 (define-key tumme-thumbnail-mode-map "\C-p" 'tumme-previous-line)
1257 (define-key tumme-thumbnail-mode-map "\C-n" 'tumme-next-line)
1259 (define-key tumme-thumbnail-mode-map "d" 'tumme-flag-thumb-original-file)
1260 (define-key tumme-thumbnail-mode-map [delete]
1261 'tumme-flag-thumb-original-file)
1262 (define-key tumme-thumbnail-mode-map "m" 'tumme-mark-thumb-original-file)
1263 (define-key tumme-thumbnail-mode-map "u" 'tumme-unmark-thumb-original-file)
1264 (define-key tumme-thumbnail-mode-map "." 'tumme-track-original-file)
1265 (define-key tumme-thumbnail-mode-map [tab] 'tumme-jump-original-dired-buffer)
1268 (define-key tumme-thumbnail-mode-map "g" tumme-thumbnail-mode-line-up-map)
1270 ;; map it to "g" so that the user can press it more quickly
1271 (define-key tumme-thumbnail-mode-line-up-map "g" 'tumme-line-up-dynamic)
1272 ;; "f" for "fixed" number of thumbs per row
1273 (define-key tumme-thumbnail-mode-line-up-map "f" 'tumme-line-up)
1274 ;; "i" for "interactive"
1275 (define-key tumme-thumbnail-mode-line-up-map "i" 'tumme-line-up-interactive)
1278 (define-key tumme-thumbnail-mode-map "t" tumme-thumbnail-mode-tag-map)
1280 ;; map it to "t" so that the user can press it more quickly
1281 (define-key tumme-thumbnail-mode-tag-map "t" 'tumme-tag-thumbnail)
1283 (define-key tumme-thumbnail-mode-tag-map "r" 'tumme-tag-thumbnail-remove)
1285 (define-key tumme-thumbnail-mode-map "\C-m"
1286 'tumme-display-thumbnail-original-image)
1287 (define-key tumme-thumbnail-mode-map [C-return]
1288 'tumme-thumbnail-display-external)
1290 (define-key tumme-thumbnail-mode-map "l" 'tumme-rotate-thumbnail-left)
1291 (define-key tumme-thumbnail-mode-map "r" 'tumme-rotate-thumbnail-right)
1293 (define-key tumme-thumbnail-mode-map "L" 'tumme-rotate-original-left)
1294 (define-key tumme-thumbnail-mode-map "R" 'tumme-rotate-original-right)
1296 (define-key tumme-thumbnail-mode-map "D"
1297 'tumme-thumbnail-set-image-description)
1299 (define-key tumme-thumbnail-mode-map "\C-d" 'tumme-delete-char)
1300 (define-key tumme-thumbnail-mode-map " "
1301 'tumme-display-next-thumbnail-original)
1302 (define-key tumme-thumbnail-mode-map
1303 (kbd "DEL") 'tumme-display-previous-thumbnail-original)
1304 (define-key tumme-thumbnail-mode-map "c" 'tumme-comment-thumbnail)
1305 (define-key tumme-thumbnail-mode-map "q" 'tumme-kill-buffer-and-window)
1308 (define-key tumme-thumbnail-mode-map [mouse-2] 'tumme-mouse-display-image)
1309 (define-key tumme-thumbnail-mode-map [mouse-1] 'tumme-mouse-select-thumbnail)
1311 ;; Seems I must first set C-down-mouse-1 to undefined, or else it
1312 ;; will trigger the buffer menu. If I try to instead bind
1313 ;; C-down-mouse-1 to `tumme-mouse-toggle-mark', I get a message
1314 ;; about C-mouse-1 not being defined afterwards. Annoying, but I
1315 ;; probably do not completely understand mouse events.
1317 (define-key tumme-thumbnail-mode-map [C-down-mouse-1] 'undefined)
1318 (define-key tumme-thumbnail-mode-map [C-mouse-1] 'tumme-mouse-toggle-mark)
1321 (define-key tumme-thumbnail-mode-map [menu-bar tumme]
1322 (cons "Tumme" (make-sparse-keymap "Tumme")))
1324 (define-key tumme-thumbnail-mode-map
1325 [menu-bar tumme tumme-kill-buffer-and-window]
1326 '("Quit" . tumme-kill-buffer-and-window))
1328 (define-key tumme-thumbnail-mode-map
1329 [menu-bar tumme tumme-delete-char]
1330 '("Delete thumbnail from buffer" . tumme-delete-char))
1332 (define-key tumme-thumbnail-mode-map
1333 [menu-bar tumme tumme-tag-thumbnail-remove]
1334 '("Remove tag from thumbnail" . tumme-tag-thumbnail-remove))
1336 (define-key tumme-thumbnail-mode-map
1337 [menu-bar tumme tumme-tag-thumbnail]
1338 '("Tag thumbnail" . tumme-tag-thumbnail))
1340 (define-key tumme-thumbnail-mode-map
1341 [menu-bar tumme tumme-comment-thumbnail]
1342 '("Comment thumbnail" . tumme-comment-thumbnail))
1344 (define-key tumme-thumbnail-mode-map
1345 [menu-bar tumme tumme-refresh-thumb]
1346 '("Refresh thumb" . tumme-refresh-thumb))
1347 (define-key tumme-thumbnail-mode-map
1348 [menu-bar tumme tumme-line-up-dynamic]
1349 '("Dynamic line up" . tumme-line-up-dynamic))
1350 (define-key tumme-thumbnail-mode-map
1351 [menu-bar tumme tumme-line-up]
1352 '("Line up thumbnails" . tumme-line-up))
1354 (define-key tumme-thumbnail-mode-map
1355 [menu-bar tumme tumme-rotate-thumbnail-left]
1356 '("Rotate thumbnail left" . tumme-rotate-thumbnail-left))
1357 (define-key tumme-thumbnail-mode-map
1358 [menu-bar tumme tumme-rotate-thumbnail-right]
1359 '("Rotate thumbnail right" . tumme-rotate-thumbnail-right))
1361 (define-key tumme-thumbnail-mode-map
1362 [menu-bar tumme tumme-rotate-original-left]
1363 '("Rotate original left" . tumme-rotate-original-left))
1364 (define-key tumme-thumbnail-mode-map
1365 [menu-bar tumme tumme-rotate-original-right]
1366 '("Rotate original right" . tumme-rotate-original-right))
1368 (define-key tumme-thumbnail-mode-map
1369 [menu-bar tumme tumme-toggle-movement-tracking]
1370 '("Toggle movement tracking on/off" . tumme-toggle-movement-tracking))
1372 (define-key tumme-thumbnail-mode-map
1373 [menu-bar tumme tumme-jump-original-dired-buffer]
1374 '("Jump to dired buffer" . tumme-jump-original-dired-buffer))
1375 (define-key tumme-thumbnail-mode-map
1376 [menu-bar tumme tumme-track-original-file]
1377 '("Track original" . tumme-track-original-file))
1379 (define-key tumme-thumbnail-mode-map
1380 [menu-bar tumme tumme-flag-thumb-original-file]
1381 '("Flag original for deletion" . tumme-flag-thumb-original-file))
1382 (define-key tumme-thumbnail-mode-map
1383 [menu-bar tumme tumme-unmark-thumb-original-file]
1384 '("Unmark original" . tumme-unmark-thumb-original-file))
1385 (define-key tumme-thumbnail-mode-map
1386 [menu-bar tumme tumme-mark-thumb-original-file]
1387 '("Mark original" . tumme-mark-thumb-original-file))
1389 (define-key tumme-thumbnail-mode-map
1390 [menu-bar tumme tumme-thumbnail-display-external]
1391 '("Display in external viewer" . tumme-thumbnail-display-external))
1392 (define-key tumme-thumbnail-mode-map
1393 [menu-bar tumme tumme-display-thumbnail-original-image]
1394 '("Display image" . tumme-display-thumbnail-original-image)))
1396 (defvar tumme-display-image-mode-map (make-sparse-keymap)
1397 "Keymap for `tumme-display-image-mode'.")
1399 (defun tumme-define-display-image-mode-keymap ()
1400 "Define keymap for `tumme-display-image-mode'."
1403 (define-key tumme-display-image-mode-map "q" 'tumme-kill-buffer-and-window)
1405 (define-key tumme-display-image-mode-map "f"
1406 'tumme-display-current-image-full)
1408 (define-key tumme-display-image-mode-map "s"
1409 'tumme-display-current-image-sized)
1412 (define-key tumme-display-image-mode-map [menu-bar tumme]
1413 (cons "Tumme" (make-sparse-keymap "Tumme")))
1415 (define-key tumme-display-image-mode-map
1416 [menu-bar tumme tumme-kill-buffer-and-window]
1417 '("Quit" . tumme-kill-buffer-and-window))
1419 (define-key tumme-display-image-mode-map
1420 [menu-bar tumme tumme-display-current-image-sized]
1421 '("Display original, sized to fit" . tumme-display-current-image-sized))
1423 (define-key tumme-display-image-mode-map
1424 [menu-bar tumme tumme-display-current-image-full]
1425 '("Display original, full size" . tumme-display-current-image-full))
1429 (defun tumme-display-current-image-full ()
1430 "Display current image in full size."
1432 (let ((file (tumme-original-file-name)))
1435 (tumme-display-image file t)
1436 (message "Full size image displayed"))
1437 (error "No original file name at point"))))
1439 (defun tumme-display-current-image-sized ()
1440 "Display current image in sized to fit window dimensions."
1442 (let ((file (tumme-original-file-name)))
1445 (tumme-display-image file)
1446 (message "Full size image displayed"))
1447 (error "No original file name at point"))))
1449 (define-derived-mode tumme-thumbnail-mode
1450 fundamental-mode "tumme-thumbnail"
1451 "Browse and manipulate thumbnail images using dired.
1452 Use `tumme-dired' and `tumme-setup-dired-keybindings' to get a
1453 nice setup to start with."
1454 (tumme-define-thumbnail-mode-keymap)
1455 (message "tumme-thumbnail-mode enabled"))
1457 (define-derived-mode tumme-display-image-mode
1458 fundamental-mode "tumme-image-display"
1459 "Mode for displaying and manipulating original image.
1460 Resized or in full-size."
1461 (tumme-define-display-image-mode-keymap)
1462 (message "tumme-display-image-mode enabled"))
1465 (defun tumme-setup-dired-keybindings ()
1466 "Setup easy-to-use keybindings for the commands to be used in dired mode.
1467 Note that n, p and <down> and <up> will be hijacked and bound to
1468 `tumme-dired-x-line'."
1471 ;; Hijack previous and next line movement. Let C-p and C-b be
1474 (define-key dired-mode-map "p" 'tumme-dired-previous-line)
1475 (define-key dired-mode-map "n" 'tumme-dired-next-line)
1476 (define-key dired-mode-map [up] 'tumme-dired-previous-line)
1477 (define-key dired-mode-map [down] 'tumme-dired-next-line)
1479 (define-key dired-mode-map (kbd "C-S-n") 'tumme-next-line-and-display)
1480 (define-key dired-mode-map (kbd "C-S-p") 'tumme-previous-line-and-display)
1481 (define-key dired-mode-map (kbd "C-S-m") 'tumme-mark-and-display-next)
1483 (define-key dired-mode-map "\C-td" 'tumme-display-thumbs)
1484 (define-key dired-mode-map "\C-tt" 'tumme-tag-files)
1485 (define-key dired-mode-map "\C-tr" 'tumme-delete-tag)
1486 (define-key dired-mode-map [tab] 'tumme-jump-thumbnail-buffer)
1487 (define-key dired-mode-map "\C-ti" 'tumme-dired-display-image)
1488 (define-key dired-mode-map "\C-tx" 'tumme-dired-display-external)
1489 (define-key dired-mode-map "\C-ta" 'tumme-display-thumbs-append)
1490 (define-key dired-mode-map "\C-t." 'tumme-display-thumb)
1491 (define-key dired-mode-map "\C-tc" 'tumme-dired-comment-files)
1492 (define-key dired-mode-map "\C-tf" 'tumme-mark-tagged-files)
1495 (define-key dired-mode-map [menu-bar tumme]
1496 (cons "Tumme" (make-sparse-keymap "Tumme")))
1498 (define-key dired-mode-map [menu-bar tumme tumme-copy-with-exif-file-name]
1499 '("Copy with EXIF file name" . tumme-copy-with-exif-file-name))
1501 (define-key dired-mode-map [menu-bar tumme tumme-dired-comment-files]
1502 '("Comment files" . tumme-dired-comment-files))
1504 (define-key dired-mode-map [menu-bar tumme tumme-mark-tagged-files]
1505 '("Mark tagged files" . tumme-mark-tagged-files))
1507 (define-key dired-mode-map [menu-bar tumme tumme-delete-tag]
1508 '("Remove tag from files" . tumme-delete-tag))
1510 (define-key dired-mode-map [menu-bar tumme tumme-tag-files]
1511 '("Tag files" . tumme-tag-files))
1513 (define-key dired-mode-map [menu-bar tumme tumme-jump-thumbnail-buffer]
1514 '("Jump to thumbnail buffer" . tumme-jump-thumbnail-buffer))
1516 (define-key dired-mode-map [menu-bar tumme tumme-toggle-movement-tracking]
1517 '("Toggle movement tracking" . tumme-toggle-movement-tracking))
1519 (define-key dired-mode-map
1520 [menu-bar tumme tumme-toggle-append-browsing]
1521 '("Toggle append browsing" . tumme-toggle-append-browsing))
1523 (define-key dired-mode-map
1524 [menu-bar tumme tumme-toggle-disp-props]
1525 '("Toggle display properties" . tumme-toggle-dired-display-properties))
1527 (define-key dired-mode-map
1528 [menu-bar tumme tumme-dired-display-external]
1529 '("Display in external viewer" . tumme-dired-display-external))
1530 (define-key dired-mode-map
1531 [menu-bar tumme tumme-dired-display-image]
1532 '("Display image" . tumme-dired-display-image))
1533 (define-key dired-mode-map
1534 [menu-bar tumme tumme-display-thumb]
1535 '("Display this thumbnail" . tumme-display-thumb))
1536 (define-key dired-mode-map
1537 [menu-bar tumme tumme-display-thumbs-append]
1538 '("Display thumbnails append" . tumme-display-thumbs-append))
1539 (define-key dired-mode-map
1540 [menu-bar tumme tumme-display-thumbs]
1541 '("Display thumbnails" . tumme-display-thumbs))
1543 (define-key dired-mode-map
1544 [menu-bar tumme tumme-create-thumbs]
1545 '("Create thumbnails for marked files" . tumme-create-thumbs))
1547 (define-key dired-mode-map
1548 [menu-bar tumme tumme-mark-and-display-next]
1549 '("Mark and display next" . tumme-mark-and-display-next))
1550 (define-key dired-mode-map
1551 [menu-bar tumme tumme-previous-line-and-display]
1552 '("Display thumb for previous file" . tumme-previous-line-and-display))
1553 (define-key dired-mode-map
1554 [menu-bar tumme tumme-next-line-and-display]
1555 '("Display thumb for next file" . tumme-next-line-and-display)))
1557 (defun tumme-create-thumbs (&optional arg)
1558 "Create thumbnail images for all marked files in dired.
1559 With prefix argument ARG, create thumbnails even if they already exist
1560 \(i.e. use this to refresh your thumbnails)."
1562 (let (curr-file thumb-name files count)
1563 (setq files (dired-get-marked-files))
1566 (setq thumb-name (tumme-thumb-name curr-file))
1567 ;; If the user overrides the exist check, we must clear the
1568 ;; image cache so that if the user wants to display the
1569 ;; thumnail, it is not fetched from cache.
1571 (clear-image-cache))
1572 (if (or (not (file-exists-p thumb-name))
1574 (if (not (= 0 (tumme-create-thumb curr-file
1575 (tumme-thumb-name curr-file))))
1576 (error "Thumb could not be created"))))
1579 (defvar tumme-slideshow-timer nil
1582 (defvar tumme-slideshow-count 0
1583 "Keeping track on number of images in slideshow.")
1585 (defvar tumme-slideshow-times 0
1586 "Number of pictures to display in slideshow.")
1588 (defun tumme-slideshow-step ()
1589 "Step to next file, if `tumme-slideshow-times' has not been reached."
1590 (if (< tumme-slideshow-count tumme-slideshow-times)
1592 (message "%s" (1+ tumme-slideshow-count))
1593 (setq tumme-slideshow-count (1+ tumme-slideshow-count))
1594 (tumme-next-line-and-display))
1595 (tumme-slideshow-stop)))
1597 (defun tumme-slideshow-start ()
1599 Ask user for number of images to show and the delay in between."
1601 (setq tumme-slideshow-count 0)
1602 (setq tumme-slideshow-times (string-to-number (read-string "How many: ")))
1603 (let ((repeat (string-to-number
1605 "Delay, in seconds. Decimals are accepted : " "1"))))
1606 (setq tumme-slideshow-timer
1609 'tumme-slideshow-step))))
1611 (defun tumme-slideshow-stop ()
1614 (cancel-timer tumme-slideshow-timer))
1616 (defun tumme-delete-char ()
1617 "Remove current thumbnail from thumbnail buffer and line up."
1619 (let ((inhibit-read-only t))
1621 (if (looking-at " ")
1625 (defun tumme-display-thumbs-append ()
1626 "Append thumbnails to `tumme-thumbnail-buffer'."
1628 (tumme-display-thumbs nil t t))
1631 (defun tumme-display-thumb ()
1632 "Shorthard for `tumme-display-thumbs' with prefix argument."
1634 (tumme-display-thumbs t nil t))
1636 (defun tumme-line-up ()
1637 "Line up thumbnails according to `tumme-thumbs-per-row'.
1638 See also `tumme-line-up-dynamic'."
1640 (let ((inhibit-read-only t))
1641 (goto-char (point-min))
1642 (while (and (not (tumme-image-at-point-p))
1647 (while (and (not (tumme-image-at-point-p))
1650 (goto-char (point-min))
1654 (if (= tumme-thumbs-per-row 1)
1657 (setq count (1+ count))
1658 (when (= count (- tumme-thumbs-per-row 1))
1662 (goto-char (point-min))))
1664 (defun tumme-line-up-dynamic ()
1665 "Line up thumbnails images dynamically.
1666 Calculate how many thumbnails fit."
1668 (let* ((char-width (frame-char-width))
1669 (width (tumme-window-width-pixels (tumme-thumbnail-window)))
1670 (tumme-thumbs-per-row
1672 (+ (* 2 tumme-thumb-relief)
1673 (* 2 tumme-thumb-margin)
1674 tumme-thumb-width char-width))))
1677 (defun tumme-line-up-interactive ()
1678 "Line up thumbnails interactively.
1679 Ask user how many thumbnails should be displayed per row."
1681 (let ((tumme-thumbs-per-row
1682 (string-to-number (read-string "How many thumbs per row: "))))
1683 (if (not (> tumme-thumbs-per-row 0))
1684 (message "Number must be greater than 0")
1687 (defun tumme-thumbnail-display-external ()
1688 "Display original image for thumbnail at point using external viewer."
1690 (let ((file (tumme-original-file-name)))
1691 (if (not (tumme-image-at-point-p))
1692 (message "No thumbnail at point")
1694 (message "No original file name found")
1695 (call-process shell-file-name nil nil nil shell-command-switch
1696 (format "%s \"%s\"" tumme-external-viewer file))))))
1699 (defun tumme-dired-display-external ()
1700 "Display file at point using an external viewer."
1702 (let ((file (dired-get-filename)))
1703 (call-process shell-file-name nil nil nil shell-command-switch
1704 (format "%s \"%s\"" tumme-external-viewer file))))
1706 (defun tumme-window-width-pixels (window)
1707 "Calculate WINDOW width in pixels."
1708 (* (window-width window) (frame-char-width)))
1710 (defun tumme-window-height-pixels (window)
1711 "Calculate WINDOW height in pixels."
1712 ;; Note: The mode-line consumes one line
1713 (* (- (window-height window) 1) (frame-char-height)))
1715 (defun tumme-display-window ()
1716 "Return window where `tumme-display-image-buffer' is visible."
1717 (get-window-with-predicate
1719 (equal (buffer-name (window-buffer window)) tumme-display-image-buffer))
1722 (defun tumme-thumbnail-window ()
1723 "Return window where `tumme-thumbnail-buffer' is visible."
1724 (get-window-with-predicate
1726 (equal (buffer-name (window-buffer window)) tumme-thumbnail-buffer))
1729 (defun tumme-associated-dired-buffer-window ()
1730 "Return window where associated dired buffer is visible."
1732 (if (tumme-image-at-point-p)
1734 (setq buf (tumme-associated-dired-buffer))
1735 (get-window-with-predicate
1737 (equal (window-buffer window) buf))))
1738 (error "No thumbnail image at point"))))
1740 (defun tumme-display-window-width ()
1741 "Return width, in pixels, of tumme's image display window."
1742 (- (tumme-window-width-pixels (tumme-display-window))
1743 tumme-display-window-width-correction))
1745 (defun tumme-display-window-height ()
1746 "Return height, in pixels, of tumme's image display window."
1747 (- (tumme-window-height-pixels (tumme-display-window))
1748 tumme-display-window-height-correction))
1750 (defun tumme-display-image (file &optional original-size)
1751 "Display image FILE in image buffer.
1752 Use this when you want to display the image, semi sized, in a new
1753 window. The image is sized to fit the display window (using a
1754 temporary file, don't worry). Because of this, it will not be as
1755 quick as opening it directly, but on most modern systems it
1756 should feel snappy enough.
1758 If optional argument ORIGINAL-SIZE is non-nil, display image in its
1760 (let ((new-file (expand-file-name tumme-temp-image-file))
1761 width height command ret)
1762 (setq file (expand-file-name file))
1763 (if (not original-size)
1765 (setq width (tumme-display-window-width))
1766 (setq height (tumme-display-window-height))
1769 tumme-cmd-create-temp-image-options
1771 (cons ?p tumme-cmd-create-temp-image-program)
1775 (cons ?t new-file))))
1776 (setq ret (call-process shell-file-name nil nil nil
1777 shell-command-switch command))
1779 (error "Could not resize image")))
1780 (copy-file file new-file t))
1781 (with-current-buffer (tumme-create-display-image-buffer)
1782 (let ((inhibit-read-only t))
1785 (tumme-insert-image tumme-temp-image-file 'jpeg 0 0)
1786 (goto-char (point-min))
1787 (tumme-update-property 'original-file-name file)))))
1789 (defun tumme-display-thumbnail-original-image (&optional arg)
1790 "Display current thumbnail's original image in display buffer.
1791 See documentation for `tumme-display-image' for more information.
1792 With prefix argument ARG, display image in its original size."
1794 (let ((file (tumme-original-file-name)))
1795 (if (not (string-equal major-mode "tumme-thumbnail-mode"))
1796 (message "Not in tumme-thumbnail-mode")
1797 (if (not (tumme-image-at-point-p))
1798 (message "No thumbnail at point")
1800 (message "No original file name found")
1801 (tumme-create-display-image-buffer)
1802 (display-buffer tumme-display-image-buffer)
1803 (tumme-display-image file arg))))))
1807 (defun tumme-dired-display-image (&optional arg)
1808 "Display current image file.
1809 See documentation for `tumme-display-image' for more information.
1810 With prefix argument ARG, display image in its original size."
1812 (tumme-create-display-image-buffer)
1813 (display-buffer tumme-display-image-buffer)
1814 (tumme-display-image (dired-get-filename) arg))
1816 (defun tumme-image-at-point-p ()
1817 "Return true if there is a tumme thumbnail at point."
1818 (get-text-property (point) 'tumme-thumbnail))
1820 (defun tumme-rotate-thumbnail (degrees)
1821 "Rotate thumbnail DEGREES degrees."
1822 (if (not (tumme-image-at-point-p))
1823 (message "No thumbnail at point")
1824 (let ((file (tumme-thumb-name (tumme-original-file-name)))
1826 (setq command (format-spec
1827 tumme-cmd-rotate-thumbnail-options
1829 (cons ?p tumme-cmd-rotate-thumbnail-program)
1831 (cons ?t (expand-file-name file)))))
1832 (call-process shell-file-name nil nil nil shell-command-switch command)
1833 ;; Clear the cache to refresh image. I wish I could just refresh
1834 ;; the current file but I do not know how to do that. Yet...
1835 (clear-image-cache))))
1837 (defun tumme-rotate-thumbnail-left ()
1838 "Rotate thumbnail left (counter clockwise) 90 degrees.
1839 The result of the rotation is displayed in the image display area
1840 and a confirmation is needed before the original image files is
1841 overwritten. This confirmation can be turned off using
1842 `tumme-rotate-original-ask-before-overwrite'."
1844 (tumme-rotate-thumbnail "270"))
1846 (defun tumme-rotate-thumbnail-right ()
1847 "Rotate thumbnail counter right (clockwise) 90 degrees.
1848 The result of the rotation is displayed in the image display area
1849 and a confirmation is needed before the original image files is
1850 overwritten. This confirmation can be turned off using
1851 `tumme-rotate-original-ask-before-overwrite'."
1853 (tumme-rotate-thumbnail "90"))
1855 (defun tumme-refresh-thumb ()
1856 "Force creation of new image for current thumbnail."
1858 (let ((file (tumme-original-file-name)))
1860 (tumme-create-thumb file (tumme-thumb-name file))))
1862 (defun tumme-rotate-original (degrees)
1863 "Rotate original image DEGREES degrees."
1864 (if (not (tumme-image-at-point-p))
1865 (message "No image at point")
1866 (let ((file (tumme-original-file-name))
1868 (if (not (string-match "\.[jJ][pP[eE]?[gG]$" file))
1869 (error "Only JPEG images can be rotated!"))
1870 (setq command (format-spec
1871 tumme-cmd-rotate-original-options
1873 (cons ?p tumme-cmd-rotate-original-program)
1875 (cons ?o (expand-file-name file))
1876 (cons ?t tumme-temp-rotate-image-file))))
1877 (if (not (= 0 (call-process shell-file-name nil nil nil
1878 shell-command-switch command)))
1879 (error "Could not rotate image")
1880 (tumme-display-image tumme-temp-rotate-image-file)
1881 (if (or (and tumme-rotate-original-ask-before-overwrite
1883 "Rotate to temp file OK. Overwrite original image? "))
1884 (not tumme-rotate-original-ask-before-overwrite))
1886 (copy-file tumme-temp-rotate-image-file file t)
1887 (tumme-refresh-thumb))
1888 (tumme-display-image file))))))
1890 (defun tumme-rotate-original-left ()
1891 "Rotate original image left (counter clockwise) 90 degrees."
1893 (tumme-rotate-original "270"))
1895 (defun tumme-rotate-original-right ()
1896 "Rotate original image right (clockwise) 90 degrees."
1898 (tumme-rotate-original "90"))
1900 (defun tumme-get-exif-file-name (file)
1901 "Use the image's EXIF information to return a unique file name.
1902 The file name should be unique as long as you do not take more than
1903 one picture per second. The original file name is suffixed at the end
1904 for traceability. The format of the returned file name is
1905 YYYY_MM_DD_HH_MM_DD_ORIG_FILE_NAME.jpg. Used from
1906 `tumme-copy-with-exif-file-name'."
1907 (let (data no-exif-data-found)
1908 (if (not (string-match "\.[Jj][Pp][Ee]?[Gg]$" (expand-file-name file)))
1910 (setq no-exif-data-found t)
1914 (nth 5 (file-attributes (expand-file-name file))))))
1915 (setq data (tumme-get-exif-data (expand-file-name file)
1916 "DateTimeOriginal")))
1917 (while (string-match "[ :]" data)
1918 (setq data (replace-match "_" nil nil data)))
1919 (format "%s%s%s" data
1920 (if no-exif-data-found
1923 (file-name-nondirectory file))))
1925 (defun tumme-thumbnail-set-image-description ()
1926 "Set the ImageDescription EXIF tag for the original image.
1927 If the image already has a value for this tag, it is used as the
1928 default value at the prompt."
1930 (if (not (tumme-image-at-point-p))
1931 (message "No thumbnail at point")
1932 (let* ((file (tumme-original-file-name))
1933 (old-value (tumme-get-exif-data file "ImageDescription")))
1935 (tumme-set-exif-data file "ImageDescription"
1936 (read-string "Value of ImageDescription: "
1938 (message "Successfully wrote ImageDescription tag.")
1939 (error "Could not write ImageDescription tag")))))
1941 (defun tumme-set-exif-data (file tag-name tag-value)
1942 "In FILE, set EXIF tag TAG-NAME to value TAG-VALUE."
1944 (setq command (format-spec
1945 tumme-cmd-write-exif-data-options
1947 (cons ?p tumme-cmd-write-exif-data-program)
1948 (cons ?f (expand-file-name file))
1950 (cons ?v tag-value))))
1951 (call-process shell-file-name nil nil nil shell-command-switch command)))
1953 (defun tumme-get-exif-data (file tag-name)
1954 "From FILE, return EXIF tag TAG-NAME."
1955 (let ((buf (get-buffer-create "*tumme-get-exif-data*"))
1957 (setq command (format-spec
1958 tumme-cmd-read-exif-data-options
1960 (cons ?p tumme-cmd-read-exif-data-program)
1962 (cons ?t tag-name))))
1963 (with-current-buffer buf
1964 (delete-region (point-min) (point-max))
1965 (if (not (eq (call-process shell-file-name nil t nil
1966 shell-command-switch command) 0))
1967 (error "Could not get EXIF tag")
1968 (goto-char (point-min))
1969 ;; Clean buffer from newlines and carriage returns before
1970 ;; getting final info
1971 (while (search-forward-regexp "[\n\r]" nil t)
1972 (replace-match "" nil t))
1973 (setq tag-value (buffer-substring (point-min) (point-max)))))
1976 (defun tumme-copy-with-exif-file-name ()
1977 "Copy file with unique name to main image directory.
1978 Copy current or all marked files in dired to a new file in your
1979 main image directory, using a file name generated by
1980 `tumme-get-exif-file-name'. A typical usage for this if when
1981 copying images from a digital camera into the image directory.
1983 Typically, you would open up the folder with the incoming
1984 digital images, mark the files to be copied, and execute this
1985 function. The result is a couple of new files in
1986 `tumme-main-image-directory' called
1987 2005_05_08_12_52_00_dscn0319.jpg,
1988 2005_05_08_14_27_45_dscn0320.jpg etc."
1991 (files (dired-get-marked-files)))
1996 (file-name-as-directory
1997 (expand-file-name tumme-main-image-directory))
1998 (tumme-get-exif-file-name curr-file)))
1999 (message "Copying %s to %s" curr-file new-name)
2000 (copy-file curr-file new-name))
2003 (defun tumme-display-next-thumbnail-original ()
2004 "In thubnail buffer, move to next thumbnail and display the image."
2006 (tumme-forward-char)
2007 (tumme-display-thumbnail-original-image))
2009 (defun tumme-display-previous-thumbnail-original ()
2010 "Move to previous thumbnail and display image."
2013 (tumme-backward-char)
2014 (tumme-display-thumbnail-original-image))
2016 (defun tumme-write-comment (file comment)
2017 "For FILE, write comment COMMENT in database."
2019 (let (end buf comment-beg)
2020 (setq buf (find-file tumme-db-file))
2021 (goto-char (point-min))
2022 (if (search-forward-regexp
2023 (format "^%s" file) nil t)
2028 ;; Delete old comment, if any
2029 (cond ((search-forward ";comment:" end t)
2030 (setq comment-beg (match-beginning 0))
2031 ;; Any tags after the comment?
2032 (if (search-forward ";" end t)
2033 (setq comment-end (- (point) 1))
2034 (setq comment-end end))
2035 ;; Delete comment tag and comment
2036 (delete-region comment-beg comment-end)))
2037 ;; Insert new comment
2039 (if (not (search-forward ";" end t))
2043 (insert (format "comment:%s;" comment)))
2044 ;; File does not exist in databse - add it.
2045 (goto-char (point-max))
2046 (insert (format "\n%s;comment:%s" file comment)))
2048 (kill-buffer buf))))
2050 (defun tumme-update-property (prop value)
2051 "Update text property PROP with value VALUE at point."
2052 (let ((inhibit-read-only t))
2054 (point) (1+ (point))
2059 (defun tumme-dired-comment-files ()
2060 "Add comment to current or marked files in dired."
2062 (let ((files (dired-get-marked-files))
2063 (comment (tumme-read-comment)))
2066 (tumme-write-comment curr-file comment))
2069 (defun tumme-comment-thumbnail ()
2070 "Add comment to current thumbnail in thumbnail buffer."
2072 (let* ((file (tumme-original-file-name))
2073 (comment (tumme-read-comment file)))
2074 (tumme-write-comment file comment)
2075 (tumme-update-property 'comment comment))
2076 (tumme-display-thumb-properties))
2078 (defun tumme-read-comment (&optional file)
2079 "Read comment for an image.
2080 Read comment for an image, optionally using old comment from FILE
2085 (if file (tumme-get-comment file)))))
2088 (defun tumme-get-comment (file)
2089 "Get comment for file FILE."
2091 (let (end buf comment-beg comment)
2092 (setq buf (find-file tumme-db-file))
2093 (goto-char (point-min))
2094 (when (search-forward-regexp
2095 (format "^%s" file) nil t)
2099 (cond ((search-forward ";comment:" end t)
2100 (setq comment-beg (point))
2101 (if (search-forward ";" end t)
2102 (setq comment-end (- (point) 1))
2103 (setq comment-end end))
2104 (setq comment (buffer-substring
2105 comment-beg comment-end)))))
2110 (defun tumme-mark-tagged-files ()
2111 "Use regexp to mark files with matching tag.
2112 A `tag' is a keyword, a piece of meta data, associated with an
2113 image file and stored in tumme's database file. This command
2114 lets you input a regexp and this will be matched against all tags
2115 on all image files in the database file. The files that have a
2116 matching tags will be marked in the dired buffer."
2118 (let ((tag (read-string "Mark tagged files (regexp): "))
2122 (setq buf (find-file tumme-db-file))
2123 (goto-char (point-min))
2125 (while (search-forward-regexp
2126 (concat "\\(^[^;\n]+\\);.*" tag ".*$") nil t)
2127 (setq files (append (list (match-string 1)) files)))
2131 ;; I tried using `dired-mark-files-regexp' but it was
2134 ;; Don't bother about hits found in other directories than
2136 (when (string= (file-name-as-directory
2137 (expand-file-name default-directory))
2138 (file-name-as-directory
2139 (file-name-directory curr-file)))
2140 (setq curr-file (file-name-nondirectory curr-file))
2141 (goto-char (point-min))
2142 (when (search-forward-regexp (format "\\s %s$" curr-file) nil t)
2143 (setq hits (+ hits 1))
2146 (message "%d files with matching tag marked." hits)))
2148 (defun tumme-mouse-display-image (event)
2149 "Use mouse EVENT, call `tumme-display-image' to display image.
2150 Track this in associated dired buffer if `tumme-track-movement' is
2154 (mouse-set-point event)
2155 (goto-char (posn-point (event-end event)))
2156 (setq file (tumme-original-file-name))
2157 (if tumme-track-movement
2158 (tumme-track-original-file))
2159 (tumme-create-display-image-buffer)
2160 (display-buffer tumme-display-image-buffer)
2161 (tumme-display-image file)))
2163 (defun tumme-mouse-select-thumbnail (event)
2164 "Use mouse EVENT to select thumbnail image.
2165 Track this in associated dired buffer if `tumme-track-movement' is
2169 (mouse-set-point event)
2170 (goto-char (posn-point (event-end event)))
2171 (if tumme-track-movement
2172 (tumme-track-original-file)))
2173 (tumme-display-thumb-properties))
2175 (defun tumme-mouse-toggle-mark (event)
2176 "Use mouse EVENT to toggle dired mark for thumbnail.
2177 Track this in associated dired buffer if `tumme-track-movement' is
2181 (mouse-set-point event)
2182 (goto-char (posn-point (event-end event)))
2183 (if tumme-track-movement
2184 (tumme-track-original-file)))
2185 (tumme-toggle-mark-thumb-original-file))
2187 (defun tumme-dired-display-properties ()
2188 "Display properties for dired file in the echo area."
2190 (let* ((file (dired-get-filename))
2191 (file-name (file-name-nondirectory file))
2192 (dired-buf (buffer-name (current-buffer)))
2195 (tumme-list-tags file)
2197 (comment (tumme-get-comment file)))
2200 (tumme-format-properties-string
2206 (defvar tumme-tag-file-list nil
2207 "List to store tag-file structure.")
2209 (defvar tumme-file-tag-list nil
2210 "List to store file-tag structure.")
2212 (defvar tumme-file-comment-list nil
2213 "List to store file comments.")
2215 (defun tumme-add-to-tag-file-list (tag file)
2216 "Add relation between TAG and FILE."
2218 (if tumme-tag-file-list
2219 (if (setq curr (assoc tag tumme-tag-file-list))
2220 (if (not (member file curr))
2221 (setcdr curr (cons file (cdr curr))))
2222 (setcdr tumme-tag-file-list
2223 (cons (list tag file) (cdr tumme-tag-file-list))))
2224 (setq tumme-tag-file-list (list (list tag file))))))
2226 (defun tumme-add-to-tag-file-lists (tag file)
2227 "Helper function used from `tumme-create-gallery-lists'.
2229 Add TAG to FILE in one list and FILE to TAG in the other.
2231 Lisp structures look like the following:
2233 tumme-file-tag-list:
2235 ((\"filename1\" \"tag1\" \"tag2\" \"tag3\" ...)
2236 (\"filename2\" \"tag1\" \"tag2\" \"tag3\" ...)
2239 tumme-tag-file-list:
2241 ((\"tag1\" \"filename1\" \"filename2\" \"filename3\" ...)
2242 (\"tag2\" \"filename1\" \"filename2\" \"filename3\" ...)
2244 ;; Add tag to file list
2246 (if tumme-file-tag-list
2247 (if (setq curr (assoc file tumme-file-tag-list))
2248 (setcdr curr (cons tag (cdr curr)))
2249 (setcdr tumme-file-tag-list
2250 (cons (list file tag) (cdr tumme-file-tag-list))))
2251 (setq tumme-file-tag-list (list (list file tag))))
2252 ;; Add file to tag list
2253 (if tumme-tag-file-list
2254 (if (setq curr (assoc tag tumme-tag-file-list))
2255 (if (not (member file curr))
2256 (setcdr curr (cons file (cdr curr))))
2257 (setcdr tumme-tag-file-list
2258 (cons (list tag file) (cdr tumme-tag-file-list))))
2259 (setq tumme-tag-file-list (list (list tag file))))))
2261 (defun tumme-add-to-file-comment-list (file comment)
2262 "Helper function used from `tumme-create-gallery-lists'.
2264 For FILE, add COMMENT to list.
2266 Lisp structure looks like the following:
2268 tumme-file-comment-list:
2270 ((\"filename1\" . \"comment1\")
2271 (\"filename2\" . \"comment2\")
2273 (if tumme-file-comment-list
2274 (if (not (assoc file tumme-file-comment-list))
2275 (setcdr tumme-file-comment-list
2276 (cons (cons file comment)
2277 (cdr tumme-file-comment-list))))
2278 (setq tumme-file-comment-list (list (cons file comment)))))
2280 (defun tumme-create-gallery-lists ()
2281 "Create temporary lists used by `tumme-gallery-generate'."
2282 (let ((buf (find-file tumme-db-file))
2283 end beg file row-tags)
2284 (setq tumme-tag-file-list nil)
2285 (setq tumme-file-tag-list nil)
2286 (setq tumme-file-comment-list nil)
2287 (goto-char (point-min))
2288 (while (search-forward-regexp "^." nil t)
2293 (if (not (search-forward ";" end nil))
2294 (error "Something is really wrong, check format of database"))
2295 (setq row-tags (split-string
2296 (buffer-substring beg end) ";"))
2297 (setq file (car row-tags))
2300 (if (not (string-match "^comment:\\(.*\\)" x))
2301 (tumme-add-to-tag-file-lists x file)
2302 (tumme-add-to-file-comment-list file (match-string 1 x))))
2305 ;; Sort tag-file list
2306 (setq tumme-tag-file-list
2307 (sort tumme-tag-file-list
2309 (string< (car x) (car y))))))
2311 (defun tumme-hidden-p (file)
2312 "Return t if image FILE has a \"hidden\" tag."
2316 (if (member tag tumme-gallery-hidden-tags)
2318 (cdr (assoc file tumme-file-tag-list)))
2321 (defun tumme-gallery-generate ()
2322 "Generate gallery pages.
2323 First we create a couple of Lisp structures from the database to make
2324 it easier to generate, then HTML-files are created in
2325 `tumme-gallery-dir'"
2327 (if (eq 'per-directory tumme-thumbnail-storage)
2328 (error "Currently, gallery generation is not supported \
2329 when using per-directory thumbnail file storage"))
2330 (tumme-create-gallery-lists)
2331 (let ((tags tumme-tag-file-list)
2332 count curr tag index-buf tag-buf
2333 comment file-tags tag-link tag-link-list)
2334 ;; Make sure gallery root exist
2335 (if (file-exists-p tumme-gallery-dir)
2336 (if (not (file-directory-p tumme-gallery-dir))
2337 (error "Variable tumme-gallery-dir is not a directory"))
2338 (make-directory tumme-gallery-dir))
2340 (setq index-buf (find-file
2341 (format "%s/index.html" tumme-gallery-dir)))
2344 (insert " <body>\n")
2345 (insert " <h2>Tumme Gallery</h2>\n")
2346 (insert (format "<p>\n Gallery generated %s\n <p>\n"
2347 (current-time-string)))
2348 (insert " <h3>Tag index</h3>\n")
2350 ;; Pre-generate list of all tag links
2353 (setq tag (car curr))
2354 (when (not (member tag tumme-gallery-hidden-tags))
2355 (setq tag-link (format "<a href=\"%d.html\">%s</a>" count tag))
2358 (append tag-link-list (list (cons tag tag-link))))
2359 (setq tag-link-list (list (cons tag tag-link))))
2360 (setq count (1+ count))))
2363 ;; Main loop where we generated thumbnail pages per tag
2366 (setq tag (car curr))
2367 ;; Don't display hidden tags
2368 (when (not (member tag tumme-gallery-hidden-tags))
2369 ;; Insert link to tag page in index
2370 (insert (format " %s<br>\n" (cdr (assoc tag tag-link-list))))
2371 ;; Open per-tag file
2372 (setq tag-buf (find-file
2373 (format "%s/%s.html" tumme-gallery-dir count)))
2376 (insert " <body>\n")
2377 (insert " <p><a href=\"index.html\">Index</a></p>\n")
2378 (insert (format " <h2>Images with tag "%s"</h2>" tag))
2379 ;; Main loop for files per tag page
2382 (when (not (tumme-hidden-p file))
2383 ;; Insert thumbnail with link to full image
2385 (format "<a href=\"%s/%s\"><img src=\"%s/%s\"%s></a>\n"
2386 tumme-gallery-image-root-url
2387 (file-name-nondirectory file)
2388 tumme-gallery-thumb-image-root-url
2389 (file-name-nondirectory (tumme-thumb-name file)) file))
2390 ;; Insert comment, if any
2391 (if (setq comment (cdr (assoc file tumme-file-comment-list)))
2392 (insert (format "<br>\n%s<br>\n" comment))
2394 ;; Insert links to other tags, if any
2396 (setq file-tags (assoc file tumme-file-tag-list))) 2)
2400 ;; Only insert if not file name or the main tag
2401 (if (and (not (equal extra-tag tag))
2402 (not (equal extra-tag file)))
2404 (format "%s " (cdr (assoc extra-tag tag-link-list))))))
2406 (insert "]<br>\n"))))
2408 (insert " <p><a href=\"index.html\">Index</a></p>\n")
2409 (insert " </body>\n")
2410 (insert "</html>\n")
2412 (kill-buffer tag-buf)
2413 (setq count (1+ count))))
2415 (insert " </body>\n")
2418 (kill-buffer index-buf)))
2420 (defun tumme-kill-buffer-and-window ()
2421 "Kill the current buffer and, if possible, also the window."
2423 (let ((buffer (current-buffer)))
2425 (delete-window (selected-window))
2427 (kill-buffer buffer)))
2429 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2430 ;;;;;;;;; TEST-SECTION ;;;;;;;;;;;
2431 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2433 ;; (defvar tumme-dir-max-size 12300000)
2435 ;; (defun tumme-test-clean-old-files ()
2436 ;; "Clean `tumme-dir' from old thumbnail files.
2437 ;; \"Oldness\" measured using last access time. If the total size of all
2438 ;; thumbnail files in `tumme-dir' is larger than 'tumme-dir-max-size',
2439 ;; old files are deleted until the max size is reached."
2444 ;; (let ((fattribs (file-attributes f)))
2445 ;; ;; Get last access time and file size
2446 ;; `(,(nth 4 fattribs) ,(nth 7 fattribs) ,f)))
2447 ;; (directory-files (tumme-dir) t ".+\.thumb\..+$"))
2448 ;; ;; Sort function. Compare time between two files.
2450 ;; (time-less-p (car l1) (car l2)))))
2451 ;; (dirsize (apply '+ (mapcar (lambda (x) (cadr x)) files))))
2452 ;; (while (> dirsize tumme-dir-max-size)
2454 ;; (format "Size of thumbnail directory: %d, delete old file %s? "
2455 ;; dirsize (cadr (cdar files))))
2456 ;; (delete-file (cadr (cdar files)))
2457 ;; (setq dirsize (- dirsize (car (cdar files))))
2458 ;; (setq files (cdr files)))))
2460 ;;;;;;;;;;;;;;;;;;;;;;,
2462 ;; (defun dired-speedbar-buttons (dired-buffer)
2463 ;; (when (and (boundp 'tumme-use-speedbar)
2464 ;; tumme-use-speedbar)
2465 ;; (let ((filename (with-current-buffer dired-buffer
2466 ;; (dired-get-filename))))
2467 ;; (when (and (not (string-equal filename (buffer-string)))
2468 ;; (string-match (image-file-name-regexp) filename))
2470 ;; (insert (propertize
2473 ;; (tumme-get-thumbnail-image filename)))))))
2475 ;; (setq tumme-use-speedbar t)
2479 ;; arch-tag: 9d11411d-331f-4380-8b44-8adfe3a0343e
2480 ;;; tumme.el ends here