code.delx.au - gnu-emacs-elpa/blob - diff-hl-dired.el

   1 ;;; diff-hl-dired.el --- Highlight changed files in Dired -*- lexical-binding: t -*-
   2
   3 ;; Copyright (C) 2012-2014  Free Software Foundation, Inc.
   4
   5 ;; This file is part of GNU Emacs.
   6
   7 ;; GNU Emacs is free software: you can redistribute it and/or modify
   8 ;; it under the terms of the GNU General Public License as published by
   9 ;; the Free Software Foundation, either version 3 of the License, or
  10 ;; (at your option) any later version.
  11
  12 ;; GNU Emacs is distributed in the hope that it will be useful,
  13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 ;; GNU General Public License for more details.
  16
  17 ;; You should have received a copy of the GNU General Public License
  18 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 ;;; Commentary:
  21
  22 ;; To enable in all Dired buffers, add this to your init file:
  23 ;;
  24 ;; (add-hook 'dired-mode-hook 'diff-hl-dired-mode)
  25
  26 ;;; Code:
  27
  28 (require 'diff-hl)
  29
  30 (defvar diff-hl-dired-process-buffer nil)
  31
  32 (defgroup diff-hl-dired nil
  33   "VC diff highlighting on the side of a Dired window."
  34   :group 'diff-hl)
  35
  36 (defface diff-hl-dired-insert
  37   '((default :inherit diff-hl-insert))
  38   "Face used to highlight added files.")
  39
  40 (defface diff-hl-dired-delete
  41   '((default :inherit diff-hl-delete))
  42   "Face used to highlight directories with deleted files.")
  43
  44 (defface diff-hl-dired-change
  45   '((default :inherit diff-hl-change))
  46   "Face used to highlight changed files.")
  47
  48 (defface diff-hl-dired-unknown
  49   '((default :inherit dired-ignored))
  50   "Face used to highlight unregistered files.")
  51
  52 (defface diff-hl-dired-ignored
  53   '((default :inherit dired-ignored))
  54   "Face used to highlight unregistered files.")
  55
  56 (defcustom diff-hl-dired-extra-indicators t
  57   "Non-nil to indicate ignored files."
  58   :group 'diff-hl
  59   :type 'boolean)
  60
  61 ;;;###autoload
  62 (define-minor-mode diff-hl-dired-mode
  63   "Toggle VC diff highlighting on the side of a Dired window."
  64   :lighter ""
  65   (if diff-hl-dired-mode
  66       (progn
  67         (diff-hl-maybe-define-bitmaps)
  68         (set (make-local-variable 'diff-hl-dired-process-buffer) nil)
  69         (add-hook 'dired-after-readin-hook 'diff-hl-dired-update nil t))
  70     (remove-hook 'dired-after-readin-hook 'diff-hl-dired-update t)
  71     (diff-hl-dired-clear)))
  72
  73 (defun diff-hl-dired-update ()
  74   "Highlight the Dired buffer."
  75   (let ((backend (ignore-errors (vc-responsible-backend default-directory)))
  76         (def-dir default-directory)
  77         (buffer (current-buffer))
  78         dirs-alist files-alist)
  79     (when backend
  80       (diff-hl-dired-clear)
  81       (if (buffer-live-p diff-hl-dired-process-buffer)
  82           (let ((proc (get-buffer-process diff-hl-dired-process-buffer)))
  83             (when proc (kill-process proc)))
  84         (setq diff-hl-dired-process-buffer
  85               (generate-new-buffer " *diff-hl-dired* tmp status")))
  86       (with-current-buffer diff-hl-dired-process-buffer
  87         (setq default-directory (expand-file-name def-dir))
  88         (erase-buffer)
  89         (vc-call-backend
  90          backend 'dir-status def-dir
  91          (lambda (entries &optional more-to-come)
  92            (when (buffer-live-p buffer)
  93              (with-current-buffer buffer
  94                (dolist (entry entries)
  95                  (cl-destructuring-bind (file state &rest r) entry
  96                    (let ((type (plist-get
  97                                 '(edited change added insert removed delete
  98                                          unregistered unknown)
  99                                 state)))
 100                      (if (string-match "\\`\\([^/]+\\)/" file)
 101                          (let* ((dir (match-string 1 file))
 102                                 (value (cdr (assoc dir dirs-alist))))
 103                            (unless (eq value type)
 104                              (if (null value)
 105                                  (push (cons dir type) dirs-alist)
 106                                (setcdr (assoc dir dirs-alist) 'change))))
 107                        (push (cons file type) files-alist)))))
 108                (unless more-to-come
 109                  (diff-hl-dired-highlight-items (append dirs-alist
 110                                                         files-alist))
 111                  (when diff-hl-dired-extra-indicators
 112                    (diff-hl-dired-update-ignores backend def-dir))))))
 113          )))))
 114
 115 (defun diff-hl-dired-update-ignores (backend def-dir)
 116   (let ((buffer (current-buffer))
 117         entries-alist)
 118     (with-current-buffer diff-hl-dired-process-buffer
 119       (erase-buffer)
 120       (vc-call-backend
 121        backend 'dir-status-files def-dir
 122        (cl-loop for file in (directory-files def-dir)
 123                 unless (member file '("." ".." ".hg"))
 124                 collect file)
 125        nil
 126        (lambda (entries &optional more-to-come)
 127          (when (buffer-live-p buffer)
 128            (with-current-buffer buffer
 129              (dolist (entry entries)
 130                (cl-destructuring-bind (file state &rest r) entry
 131                  ;; Work around http://debbugs.gnu.org/18605
 132                  (setq file (replace-regexp-in-string "\\` " "" file))
 133                  (when (eq state 'ignored)
 134                    (push (cons (directory-file-name file)
 135                                'ignored) entries-alist))))
 136              (unless more-to-come
 137                (diff-hl-dired-highlight-items entries-alist)))))
 138        ))))
 139
 140 (defun diff-hl-dired-highlight-items (alist)
 141   "Highlight ALIST containing (FILE . TYPE) elements."
 142   (dolist (pair alist)
 143     (let ((file (car pair))
 144           (type (cdr pair)))
 145       (save-excursion
 146         (goto-char (point-min))
 147         (when (and type (dired-goto-file-1
 148                          file (expand-file-name file) nil))
 149           (let* ((diff-hl-fringe-bmp-function 'diff-hl-fringe-bmp-from-type)
 150                  (diff-hl-fringe-face-function 'diff-hl-dired-face-from-type)
 151                  (o (diff-hl-add-highlighting type 'single)))
 152             (overlay-put o 'modification-hooks '(diff-hl-overlay-modified))
 153             ))))))
 154
 155 (defun diff-hl-dired-face-from-type (type _pos)
 156   (intern (format "diff-hl-dired-%s" type)))
 157
 158 (defalias 'diff-hl-dired-clear 'diff-hl-remove-overlays)
 159
 160 (provide 'diff-hl-dired)
 161
 162 ;;; diff-hl-dired.el ends here