]> code.delx.au - gnu-emacs/blobdiff - lisp/vc-dir.el
Tweak previous change.
[gnu-emacs] / lisp / vc-dir.el
index 917ba9ce744c6e5721bc33254016143dd28e5cd1..1f91ff4d3796a02f49bd5e0608c33d2a0e51ab92 100644 (file)
@@ -1,6 +1,6 @@
 ;;; vc-dir.el --- Directory status display under VC
 
-;; Copyright (C) 2007, 2008
+;; Copyright (C) 2007, 2008, 2009
 ;;   Free Software Foundation, Inc.
 
 ;; Author:   Dan Nicolaescu <dann@ics.uci.edu>
 ;; This implementation was inspired by PCL-CVS.
 ;; Many people contributed comments, ideas and code to this
 ;; implementation.  These include:
-;; 
+;;
 ;;   Alexandre Julliard  <julliard@winehq.org>
 ;;   Stefan Monnier  <monnier@iro.umontreal.ca>
 ;;   Tom Tromey  <tromey@redhat.com>
 
 ;;; Commentary:
-;; 
+;;
 
 ;;; Todo:  see vc.el.
 
 (require 'vc-hooks)
 (require 'vc)
+(require 'tool-bar)
 (require 'ewoc)
 
 ;;; Code:
@@ -62,7 +63,7 @@ See `run-hooks'."
             (:conc-name vc-dir-fileinfo->))
   name                                  ;Keep it as first, for `member'.
   state
-  ;; For storing client-mode specific information.
+  ;; For storing backend specific information.
   extra
   marked
   ;; To keep track of not updated files during a global refresh
@@ -70,47 +71,32 @@ See `run-hooks'."
   ;; To distinguish files and directories.
   directory)
 
-;; Used to describe a dispatcher client mode.
-(defstruct (vc-client-object
-            (:copier nil)
-            (:constructor
-            vc-create-client-object (name
-                                     headers
-                                     file-to-info
-                                     file-to-state
-                                     file-to-extra
-                                     updater
-                                     extra-menu))
-            (:conc-name vc-client-object->))
-  name
-  headers
-  file-to-info
-  file-to-state
-  file-to-extra
-  updater
-  extra-menu)
-
 (defvar vc-ewoc nil)
+
 (defvar vc-dir-process-buffer nil
   "The buffer used for the asynchronous call that computes status.")
 
+(defvar vc-dir-backend nil
+  "The backend used by the current *vc-dir* buffer.")
+
 (defun vc-dir-move-to-goal-column ()
   ;; Used to keep the cursor on the file name column.
   (beginning-of-line)
   (unless (eolp)
-    ;; Must be in sync with vc-default-status-printer.
+    ;; Must be in sync with vc-default-dir-printer.
     (forward-char 25)))
 
-(defun vc-dir-prepare-status-buffer (bname dir &optional create-new)
+(defun vc-dir-prepare-status-buffer (bname dir backend &optional create-new)
   "Find a buffer named BNAME showing DIR, or create a new one."
-  (setq dir (expand-file-name dir))
+  (setq dir (file-name-as-directory (expand-file-name dir)))
   (let*
         ;; Look for another buffer name BNAME visiting the same directory.
         ((buf (save-excursion
                (unless create-new
                  (dolist (buffer (buffer-list))
                    (set-buffer buffer)
-                   (when (and (vc-dispatcher-browsing)
+                   (when (and (derived-mode-p 'vc-dir-mode)
+                              (eq vc-dir-backend backend)
                               (string= (expand-file-name default-directory) dir))
                      (return buffer)))))))
     (or buf
@@ -133,9 +119,12 @@ See `run-hooks'."
                  :enable (vc-dir-busy)
                  :help "Kill the command that updates the directory buffer"))
     (define-key map [refresh]
-      '(menu-item "Refresh" vc-dir-refresh
+      '(menu-item "Refresh" revert-buffer
                  :enable (not (vc-dir-busy))
                  :help "Refresh the contents of the directory buffer"))
+    (define-key map [remup]
+      '(menu-item "Hide up-to-date" vc-dir-hide-up-to-date
+                 :help "Hide up-to-date items from display"))
     ;; Movement.
     (define-key map [sepmv] '("--"))
     (define-key map [next-line]
@@ -167,27 +156,66 @@ See `run-hooks'."
                  :help "Mark the current file or all files in the region"))
 
     (define-key map [sepopn] '("--"))
+    (define-key map [qr]
+      '(menu-item "Query Replace in Files..." vc-dir-query-replace-regexp
+                 :help "Replace a string in the marked files"))
+    (define-key map [se]
+      '(menu-item "Search Files..." vc-dir-search
+                 :help "Search a regexp in the marked files"))
+    (define-key map [ires]
+      '(menu-item "Isearch Regexp Files..." vc-dir-isearch-regexp
+                 :help "Incremental search a regexp in the marked files"))
+    (define-key map [ise]
+      '(menu-item "Isearch Files..." vc-dir-isearch
+                 :help "Incremental search a string in the marked files"))
     (define-key map [open-other]
       '(menu-item "Open in other window" vc-dir-find-file-other-window
                  :help "Find the file on the current line, in another window"))
     (define-key map [open]
       '(menu-item "Open file" vc-dir-find-file
                  :help "Find the file on the current line"))
+    (define-key map [sepvcdet] '("--"))
+    ;; FIXME: This needs a key binding.  And maybe a better name
+    ;; ("Insert" like PCL-CVS uses does not sound that great either)...
+    (define-key map [ins]
+      '(menu-item "Show File" vc-dir-show-fileentry
+                 :help "Show a file in the VC status listing even though it might be up to date"))
+    (define-key map [annotate]
+      '(menu-item "Annotate" vc-annotate
+                 :help "Display the edit history of the current file using colors"))
+    (define-key map [diff]
+      '(menu-item "Compare with Base Version" vc-diff
+                 :help "Compare file set with the base version"))
+    (define-key map [log]
+     '(menu-item "Show history" vc-print-log
+     :help "List the change log of the current file set in a window"))
+    ;; VC commands.
+    (define-key map [sepvccmd] '("--"))
+    (define-key map [update]
+      '(menu-item "Update to latest version" vc-update
+                 :help "Update the current fileset's files to their tip revisions"))
+    (define-key map [revert]
+      '(menu-item "Revert to base version" vc-revert
+                 :help "Revert working copies of the selected fileset to their repository contents."))
+    (define-key map [next-action]
+      ;; FIXME: This really really really needs a better name!
+      ;; And a key binding too.
+      '(menu-item "Check In/Out" vc-next-action
+                 :help "Do the next logical version control operation on the current fileset"))
+    (define-key map [register]
+      '(menu-item "Register" vc-register
+                 :help "Register file set into the version control system"))
     map)
-  "Menu for dispatcher status")
-
-(defvar vc-client-mode)
+  "Menu for VC dir.")
 
-;; This is used so that client modes can add mode-specific menu
-;; items to vc-dir-menu-map.
+;; VC backends can use this to add mode-specific menu items to
+;; vc-dir-menu-map.
 (defun vc-dir-menu-map-filter (orig-binding)
   (when (and (symbolp orig-binding) (fboundp orig-binding))
     (setq orig-binding (indirect-function orig-binding)))
   (let ((ext-binding
-         ;; This may be executed at load-time for tool-bar-local-item-from-menu
-         ;; but at that time vc-client-mode is not known (or even bound) yet.
-         (when (and (boundp 'vc-client-mode) vc-client-mode)
-           (funcall (vc-client-object->extra-menu vc-client-mode)))))
+         (when (derived-mode-p 'vc-dir-mode)
+          (vc-call-backend vc-dir-backend 'extra-status-menu))))
     (if (null ext-binding)
        orig-binding
       (append orig-binding
@@ -195,8 +223,17 @@ See `run-hooks'."
              ext-binding))))
 
 (defvar vc-dir-mode-map
-  (let ((map (make-keymap)))
-    (suppress-keymap map)
+  (let ((map (make-sparse-keymap)))
+    ;; VC commands
+    (define-key map "v" 'vc-next-action)   ;; C-x v v
+    (define-key map "=" 'vc-diff)         ;; C-x v =
+    (define-key map "i" 'vc-register)     ;; C-x v i
+    (define-key map "+" 'vc-update)       ;; C-x v +
+    (define-key map "l" 'vc-print-log)    ;; C-x v l
+    ;; More confusing than helpful, probably
+    ;;(define-key map "R" 'vc-revert) ;; u is taken by vc-dir-unmark.
+    ;;(define-key map "A" 'vc-annotate) ;; g is taken by revert-buffer
+    ;;                                     bound by `special-mode'.
     ;; Marking.
     (define-key map "m" 'vc-dir-mark)
     (define-key map "M" 'vc-dir-mark-all-files)
@@ -219,36 +256,41 @@ See `run-hooks'."
     (define-key map "f" 'vc-dir-find-file)
     (define-key map "\C-m" 'vc-dir-find-file)
     (define-key map "o" 'vc-dir-find-file-other-window)
-    (define-key map "q" 'quit-window)
-    (define-key map "g" 'vc-dir-refresh)
     (define-key map "\C-c\C-c" 'vc-dir-kill-dir-status-process)
     (define-key map [down-mouse-3] 'vc-dir-menu)
     (define-key map [mouse-2] 'vc-dir-toggle-mark)
+    (define-key map [follow-link] 'mouse-face)
+    (define-key map "x" 'vc-dir-hide-up-to-date)
+    (define-key map "S" 'vc-dir-search) ;; FIXME: Maybe use A like dired?
+    (define-key map "Q" 'vc-dir-query-replace-regexp)
+    (define-key map (kbd "M-s a C-s")   'vc-dir-isearch)
+    (define-key map (kbd "M-s a M-C-s") 'vc-dir-isearch-regexp)
 
     ;; Hook up the menu.
     (define-key map [menu-bar vc-dir-mode]
       `(menu-item
-       ;; This is used so that client modes can add mode-specific
-       ;; menu items to vc-dir-menu-map.
+       ;; VC backends can use this to add mode-specific menu items to
+       ;; vc-dir-menu-map.
        "VC-dir" ,vc-dir-menu-map :filter vc-dir-menu-map-filter))
     map)
   "Keymap for directory buffer.")
 
-(defmacro vc-at-event (event &rest body)
-  "Evaluate `body' with point located at event-start of `event'.
-If `body' uses `event', it should be a variable,
+(defmacro vc-dir-at-event (event &rest body)
+  "Evaluate BODY with point located at event-start of EVENT.
+If BODY uses EVENT, it should be a variable,
  otherwise it will be evaluated twice."
-  (let ((posn (make-symbol "vc-at-event-posn")))
-    `(let ((,posn (event-start ,event)))
-       (save-excursion
-         (set-buffer (window-buffer (posn-window ,posn)))
-         (goto-char (posn-point ,posn))
-         ,@body))))
+  (let ((posn (make-symbol "vc-dir-at-event-posn")))
+    `(save-excursion
+       (unless (equal ,event '(tool-bar))
+         (let ((,posn (event-start ,event)))
+           (set-buffer (window-buffer (posn-window ,posn)))
+           (goto-char (posn-point ,posn))))
+       ,@body)))
 
 (defun vc-dir-menu (e)
-  "Popup the dispatcher status menu."
+  "Popup the VC dir menu."
   (interactive "e")
-  (vc-at-event e (popup-menu vc-dir-menu-map e)))
+  (vc-dir-at-event e (popup-menu vc-dir-menu-map e)))
 
 (defvar vc-dir-tool-bar-map
   (let ((map (make-sparse-keymap)))
@@ -265,10 +307,12 @@ If `body' uses `event', it should be a variable,
                                   :rtl "left-arrow")
     (tool-bar-local-item-from-menu 'vc-print-log "info"
                                   map vc-dir-mode-map)
-    (tool-bar-local-item-from-menu 'vc-dir-refresh "refresh"
+    (tool-bar-local-item-from-menu 'revert-buffer "refresh"
                                   map vc-dir-mode-map)
     (tool-bar-local-item-from-menu 'nonincremental-search-forward
                                   "search" map)
+    (tool-bar-local-item-from-menu 'vc-dir-query-replace-regexp
+                                  "search-replace" map vc-dir-mode-map)
     (tool-bar-local-item-from-menu 'vc-dir-kill-dir-status-process "cancel"
                                   map vc-dir-mode-map)
     (tool-bar-local-item-from-menu 'quit-window "exit"
@@ -315,7 +359,7 @@ If NOINSERT, ignore elements on ENTRIES which are not in the ewoc."
           vc-ewoc (vc-dir-create-fileinfo
                    rd nil nil nil (expand-file-name default-directory))))
        (setq node (ewoc-nth vc-ewoc 0)))
-      
+
       (while (and entry node)
        (let* ((entryfile (car entry))
               (entrydir (file-name-directory (expand-file-name entryfile)))
@@ -335,7 +379,7 @@ If NOINSERT, ignore elements on ENTRIES which are not in the ewoc."
                (setf (vc-dir-fileinfo->extra (ewoc-data node)) (nth 2 entry))
                (setf (vc-dir-fileinfo->needs-update (ewoc-data node)) nil)
                (ewoc-invalidate vc-ewoc node)
-               (setq entries (cdr entries)) 
+               (setq entries (cdr entries))
                (setq entry (car entries))
                (setq node (ewoc-next vc-ewoc node)))
               (t
@@ -454,11 +498,6 @@ If a prefix argument is given, move by that many lines."
            (funcall mark-unmark-function))))
     (funcall mark-unmark-function)))
 
-(defun vc-string-prefix-p (prefix string)
-  (let ((lpref (length prefix)))
-    (and (>= (length string) lpref)
-        (eq t (compare-strings prefix nil nil string nil lpref)))))
-
 (defun vc-dir-parent-marked-p (arg)
   ;; Return nil if none of the parent directories of arg is marked.
   (let* ((argdir (vc-dir-node-directory arg))
@@ -637,7 +676,7 @@ that share the same state."
 
 (defun vc-dir-toggle-mark (e)
   (interactive "e")
-  (vc-at-event e (vc-dir-mark-unmark 'vc-dir-toggle-mark-file)))
+  (vc-dir-at-event e (vc-dir-mark-unmark 'vc-dir-toggle-mark-file)))
 
 (defun vc-dir-delete-file ()
   "Delete the marked files, or the current file if no marks."
@@ -655,6 +694,49 @@ that share the same state."
   (interactive)
   (find-file-other-window (vc-dir-current-file)))
 
+(defun vc-dir-isearch ()
+  "Search for a string through all marked buffers using Isearch."
+  (interactive)
+  (multi-isearch-files
+   (mapcar 'car (vc-dir-marked-only-files-and-states))))
+
+(defun vc-dir-isearch-regexp ()
+  "Search for a regexp through all marked buffers using Isearch."
+  (interactive)
+  (multi-isearch-files-regexp
+   (mapcar 'car (vc-dir-marked-only-files-and-states))))
+
+(defun vc-dir-search (regexp)
+  "Search through all marked files for a match for REGEXP.
+For marked directories, use the files displayed from those directories.
+Stops when a match is found.
+To continue searching for next match, use command \\[tags-loop-continue]."
+  (interactive "sSearch marked files (regexp): ")
+  (tags-search regexp '(mapcar 'car (vc-dir-marked-only-files-and-states))))
+
+(defun vc-dir-query-replace-regexp (from to &optional delimited)
+  "Do `query-replace-regexp' of FROM with TO, on all marked files.
+For marked directories, use the files displayed from those directories.
+If a directory is marked, then use the files displayed for that directory.
+Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
+If you exit (\\[keyboard-quit], RET or q), you can resume the query replace
+with the command \\[tags-loop-continue]."
+  ;; FIXME: this is almost a copy of `dired-do-replace-regexp'.  This
+  ;; should probably be made generic and used in both places instead of
+  ;; duplicating it here.
+  (interactive
+   (let ((common
+         (query-replace-read-args
+          "Query replace regexp in marked files" t t)))
+     (list (nth 0 common) (nth 1 common) (nth 2 common))))
+  (dolist (file (mapcar 'car (vc-dir-marked-only-files-and-states)))
+    (let ((buffer (get-file-buffer file)))
+      (if (and buffer (with-current-buffer buffer
+                       buffer-read-only))
+         (error "File `%s' is visited read-only" file))))
+  (tags-query-replace from to delimited
+                     '(mapcar 'car (vc-dir-marked-only-files-and-states))))
+
 (defun vc-dir-current-file ()
   (let ((node (ewoc-locate vc-ewoc)))
     (unless node
@@ -667,14 +749,16 @@ that share the same state."
    (lambda (elem) (expand-file-name (vc-dir-fileinfo->name elem)))
    (ewoc-collect vc-ewoc 'vc-dir-fileinfo->marked)))
 
-(defun vc-dir-marked-only-files ()
-  "Return the list of marked files, for marked directories return child files."
+(defun vc-dir-marked-only-files-and-states ()
+  "Return the list of conses (FILE . STATE) for the marked files.
+For marked directories return the corresponding conses for the
+child files."
   (let ((crt (ewoc-nth vc-ewoc 0))
        result)
     (while crt
       (let ((crt-data (ewoc-data crt)))
        (if (vc-dir-fileinfo->marked crt-data)
-           ;; FIXME: use vc-dir-child-files here instead of duplicating it.
+           ;; FIXME: use vc-dir-child-files-and-states here instead of duplicating it.
            (if (vc-dir-fileinfo->directory crt-data)
                (let* ((dir (vc-dir-fileinfo->directory crt-data))
                       (dirlen (length dir))
@@ -686,15 +770,20 @@ that share the same state."
                                                  (setq data (ewoc-data crt))
                                                  (vc-dir-node-directory crt))))
                    (unless (vc-dir-fileinfo->directory data)
-                     (push (expand-file-name (vc-dir-fileinfo->name data)) result))))
-             (push (expand-file-name (vc-dir-fileinfo->name crt-data)) result)
+                     (push
+                      (cons (expand-file-name (vc-dir-fileinfo->name data))
+                            (vc-dir-fileinfo->state data))
+                      result))))
+             (push (cons (expand-file-name (vc-dir-fileinfo->name crt-data))
+                         (vc-dir-fileinfo->state crt-data))
+                   result)
              (setq crt (ewoc-next vc-ewoc crt)))
          (setq crt (ewoc-next vc-ewoc crt)))))
-    result))
+    (nreverse result)))
 
-(defun vc-dir-child-files ()
-  "Return the list of child files for the current entry if it's a directory.
-If it is a file, return the file itself."
+(defun vc-dir-child-files-and-states ()
+  "Return the list of conses (FILE . STATE) for child files of the current entry if it's a directory.
+If it is a file, return the corresponding cons for the file itself."
   (let* ((crt (ewoc-locate vc-ewoc))
         (crt-data (ewoc-data crt))
          result)
@@ -708,55 +797,92 @@ If it is a file, return the file itself."
                                              (setq data (ewoc-data crt))
                                              (vc-dir-node-directory crt))))
            (unless (vc-dir-fileinfo->directory data)
-             (push (expand-file-name (vc-dir-fileinfo->name data)) result))))
-      (push (expand-file-name (vc-dir-fileinfo->name crt-data)) result))
-    result))
+             (push
+              (cons (expand-file-name (vc-dir-fileinfo->name data))
+                    (vc-dir-fileinfo->state data))
+              result))))
+      (push
+       (cons (expand-file-name (vc-dir-fileinfo->name crt-data))
+            (vc-dir-fileinfo->state crt-data)) result))
+    (nreverse result)))
+
+(defun vc-dir-recompute-file-state (fname def-dir)
+  (let* ((file-short (file-relative-name fname def-dir))
+        (remove-me-when-CVS-works
+         (when (eq vc-dir-backend 'CVS)
+           ;; FIXME: Warning: UGLY HACK.  The CVS backend caches the state
+           ;; info, this forces the backend to update it.
+           (vc-call-backend vc-dir-backend 'registered fname)))
+        (state (vc-call-backend vc-dir-backend 'state fname))
+        (extra (vc-call-backend vc-dir-backend
+                                'status-fileinfo-extra fname)))
+    (list file-short state extra)))
+
+(defun vc-dir-find-child-files (dirname)
+  ;; Give a DIRNAME string return the list of all child files shown in
+  ;; the current *vc-dir* buffer.
+  (let ((crt (ewoc-nth vc-ewoc 0))
+       children
+       dname)
+    ;; Find DIR
+    (while (and crt (not (vc-string-prefix-p
+                         dirname (vc-dir-node-directory crt))))
+      (setq crt (ewoc-next vc-ewoc crt)))
+    (while (and crt (vc-string-prefix-p
+                    dirname
+                    (setq dname (vc-dir-node-directory crt))))
+      (let ((data (ewoc-data crt)))
+       (unless (vc-dir-fileinfo->directory data)
+         (push (expand-file-name (vc-dir-fileinfo->name data)) children)))
+      (setq crt (ewoc-next vc-ewoc crt)))
+    children))
+
+(defun vc-dir-resync-directory-files (dirname)
+  ;; Update the entries for all the child files of DIRNAME shown in
+  ;; the current *vc-dir* buffer.
+  (let ((files (vc-dir-find-child-files dirname))
+       (ddir (expand-file-name default-directory))
+       fileentries)
+    (when files
+      (dolist (crt files)
+       (push (vc-dir-recompute-file-state crt ddir)
+             fileentries))
+      (vc-dir-update fileentries (current-buffer)))))
 
 (defun vc-dir-resynch-file (&optional fname)
-  "Update the entries for FILE in any directory buffers that list it."
-  (let ((file (or fname (expand-file-name buffer-file-name))))
-    (if (file-directory-p file)
-       ;; FIXME: Maybe this should never happen? 
-        ;; FIXME: But it is useful to update the state of a directory
-       ;; (more precisely the files in the directory) after some VC
-       ;; operations.
-       nil
-      (let ((found-vc-dir-buf nil))
-       (save-excursion
-         (dolist (status-buf (buffer-list))
-           (set-buffer status-buf)
-           ;; look for a vc-dir buffer that might show this file.
-           (when (derived-mode-p 'vc-dir-mode)
-             (setq found-vc-dir-buf t)
-             (let ((ddir (expand-file-name default-directory)))
-               (when (vc-string-prefix-p ddir file)
-                 (let*
-                      ;; FIXME: Any reason we don't use file-relative-name?
-                     ((file-short (substring file (length ddir)))
-                      (state (funcall (vc-client-object->file-to-state
-                                        vc-client-mode)
-                                file))
-                      (extra (funcall (vc-client-object->file-to-extra
-                                        vc-client-mode)
-                                file))
-                      (entry
-                       (list file-short state extra)))
-                   (vc-dir-update (list entry) status-buf))))))
-         ;; We didn't find any vc-dir buffers, remove the hook, it is
-         ;; not needed.
-         (unless found-vc-dir-buf
-            (remove-hook 'after-save-hook 'vc-dir-resynch-file)))))))
-
-(defun vc-dir-mode (client-object)
-  "Major mode for dispatcher directory buffers.
+  "Update the entries for FNAME in any directory buffers that list it."
+  (let ((file (or fname (expand-file-name buffer-file-name)))
+       (found-vc-dir-buf nil))
+    (save-excursion
+      (dolist (status-buf (buffer-list))
+       (set-buffer status-buf)
+       ;; look for a vc-dir buffer that might show this file.
+       (when (derived-mode-p 'vc-dir-mode)
+         (setq found-vc-dir-buf t)
+         (let ((ddir (expand-file-name default-directory)))
+           (when (vc-string-prefix-p ddir file)
+             (if (file-directory-p file)
+                 (vc-dir-resync-directory-files file)
+               (vc-dir-update
+                (list (vc-dir-recompute-file-state file ddir))
+                status-buf)))))))
+    ;; We didn't find any vc-dir buffers, remove the hook, it is
+    ;; not needed.
+    (unless found-vc-dir-buf
+      (remove-hook 'after-save-hook 'vc-dir-resynch-file))))
+
+(defvar use-vc-backend)  ;; dynamically bound
+
+(define-derived-mode vc-dir-mode special-mode "VC dir"
+  "Major mode for VC directory buffers.
 Marking/Unmarking key bindings and actions:
-m - marks a file/directory or if the region is active, mark all the files
-     in region.
+m - mark a file/directory
+  - if the region is active, mark all the files in region.
     Restrictions: - a file cannot be marked if any parent directory is marked
                   - a directory cannot be marked if any child file or
                     directory is marked
-u - marks a file/directory or if the region is active, unmark all the files
-     in region.
+u - unmark a file/directory
+  - if the region is active, unmark all the files in region.
 M - if the cursor is on a file: mark all the files with the same state as
       the current file
   - if the cursor is on a directory: mark all child files
@@ -765,44 +891,54 @@ U - if the cursor is on a file: unmark all the files with the same state
       as the current file
   - if the cursor is on a directory: unmark all child files
   - with a prefix argument: unmark all files
-
+mouse-2  - toggles the mark state
+
+VC commands
+VC commands in the `C-x v' prefix can be used.
+VC commands act on the marked entries.  If nothing is marked, VC
+commands act on the current entry.
+
+Search & Replace
+S - searches the marked files
+Q - does a query replace on the marked files
+M-s a C-s - does an isearch on the marked files
+M-s a C-M-s - does a regexp isearch on the marked files
+If nothing is marked, these commands act on the current entry.
+When a directory is current or marked, the Search & Replace
+commands act on the child files of that directory that are displayed in
+the *vc-dir* buffer.
 
 \\{vc-dir-mode-map}"
-  (setq mode-name (vc-client-object->name client-object))
-  (setq major-mode 'vc-dir-mode)
+  (set (make-local-variable 'vc-dir-backend) use-vc-backend)
   (setq buffer-read-only t)
-  (use-local-map vc-dir-mode-map)
-  (if (boundp 'tool-bar-map)
-      (set (make-local-variable 'tool-bar-map) vc-dir-tool-bar-map))
-  (set (make-local-variable 'vc-client-mode) client-object)
+  (when (boundp 'tool-bar-map)
+    (set (make-local-variable 'tool-bar-map) vc-dir-tool-bar-map))
   (let ((buffer-read-only nil))
     (erase-buffer)
     (set (make-local-variable 'vc-dir-process-buffer) nil)
-    (set (make-local-variable 'vc-ewoc)
-        (ewoc-create (vc-client-object->file-to-info client-object)
-                     (vc-client-object->headers client-object)))
+    (set (make-local-variable 'vc-ewoc) (ewoc-create #'vc-dir-printer))
+    (set (make-local-variable 'revert-buffer-function)
+        'vc-dir-revert-buffer-function)
+    (set (make-local-variable 'list-buffers-directory)
+         (expand-file-name default-directory))
     (add-hook 'after-save-hook 'vc-dir-resynch-file)
     ;; Make sure that if the directory buffer is killed, the update
     ;; process running in the background is also killed.
     (add-hook 'kill-buffer-query-functions 'vc-dir-kill-query nil t)
-    (funcall (vc-client-object->updater client-object)))
-  (run-hooks 'vc-dir-mode-hook))
-
-(put 'vc-dir-mode 'mode-class 'special)
-
-(defvar vc-dir-backend nil
-  "The backend used by the current *vc-dir* buffer.")
+    (vc-dir-refresh)))
 
 (defun vc-dir-headers (backend dir)
   "Display the headers in the *VC dir* buffer.
-It calls the `status-extra-headers' backend method to display backend
+It calls the `dir-extra-headers' backend method to display backend
 specific headers."
   (concat
+   ;; First layout the common headers.
    (propertize "VC backend : " 'face 'font-lock-type-face)
    (propertize (format "%s\n" backend) 'face 'font-lock-variable-name-face)
    (propertize "Working dir: " 'face 'font-lock-type-face)
    (propertize (format "%s\n" dir) 'face 'font-lock-variable-name-face)
-   (vc-call-backend backend 'status-extra-headers dir)
+   ;; Then the backend specific ones.
+   (vc-call-backend backend 'dir-extra-headers dir)
    "\n"))
 
 (defun vc-dir-refresh-files (files default-state)
@@ -849,6 +985,9 @@ specific headers."
 
                               (not (vc-dir-fileinfo->needs-update info))))))))))))
 
+(defun vc-dir-revert-buffer-function (&optional ignore-auto noconfirm)
+  (vc-dir-refresh))
+
 (defun vc-dir-refresh ()
   "Refresh the contents of the *VC-dir* buffer.
 Throw an error if another update process is in progress."
@@ -872,8 +1011,10 @@ Throw an error if another update process is in progress."
       (unless (buffer-live-p vc-dir-process-buffer)
         (setq vc-dir-process-buffer
               (generate-new-buffer (format " *VC-%s* tmp status" backend))))
-      ;; set the needs-update flag on all entries
-      (ewoc-map (lambda (info) (setf (vc-dir-fileinfo->needs-update info) t) nil)
+      ;; set the needs-update flag on all non-directory entries
+      (ewoc-map (lambda (info)
+                 (unless (vc-dir-fileinfo->directory info)
+                   (setf (vc-dir-fileinfo->needs-update info) t) nil))
                 vc-ewoc)
       (lexical-let ((buffer (current-buffer)))
         (with-current-buffer vc-dir-process-buffer
@@ -895,7 +1036,8 @@ Throw an error if another update process is in progress."
                        (vc-dir-refresh-files
                         (mapcar 'vc-dir-fileinfo->name remaining)
                         'up-to-date)
-                     (setq mode-line-process nil))))))))))))
+                     (setq mode-line-process nil)))))))))
+      (ewoc-set-hf vc-ewoc (vc-dir-headers backend def-dir) ""))))
 
 (defun vc-dir-show-fileentry (file)
   "Insert an entry for a specific file into the current *VC-dir* listing.
@@ -907,100 +1049,94 @@ outside of VC) and one wants to do some operation on it."
 (defun vc-dir-hide-up-to-date ()
   "Hide up-to-date items from display."
   (interactive)
-  (ewoc-filter
-   vc-ewoc
-   (lambda (crt) (not (eq (vc-dir-fileinfo->state crt) 'up-to-date)))))
-
-;; FIXME: Replace these with a more efficient dispatch
-
-(defun vc-generic-status-printer (fileentry)
-  (vc-call-backend vc-dir-backend 'status-printer fileentry))
-
-(defun vc-generic-state (file)
-  (vc-call-backend vc-dir-backend 'state file))
-
-(defun vc-generic-status-fileinfo-extra (file)
-  (vc-call-backend vc-dir-backend 'status-fileinfo-extra file))
-
-(defun vc-dir-extra-menu ()
-  (vc-call-backend vc-dir-backend 'extra-status-menu))
-
-(defun vc-make-backend-object (file-or-dir)
-  "Create the backend capability object needed by vc-dispatcher."
-  (vc-create-client-object
-   "VC dir"
-   (vc-dir-headers vc-dir-backend file-or-dir)
-   #'vc-generic-status-printer
-   #'vc-generic-state
-   #'vc-generic-status-fileinfo-extra
-   #'vc-dir-refresh
-   #'vc-dir-extra-menu))
+  (let ((crt (ewoc-nth vc-ewoc -1))
+       (first (ewoc-nth vc-ewoc 0)))
+    ;; Go over from the last item to the first and remove the
+    ;; up-to-date files and directories with no child files.
+    (while (not (eq crt first))
+      (let* ((data (ewoc-data crt))
+            (dir (vc-dir-fileinfo->directory data))
+            (next (ewoc-next vc-ewoc crt))
+            (prev (ewoc-prev vc-ewoc crt))
+            ;; ewoc-delete does not work without this...
+            (inhibit-read-only t))
+         (when (or
+                ;; Remove directories with no child files.
+                (and dir
+                     (or
+                      ;; Nothing follows this directory.
+                      (not next)
+                      ;; Next item is a directory.
+                      (vc-dir-fileinfo->directory (ewoc-data next))))
+                ;; Remove files in the up-to-date state.
+                (eq (vc-dir-fileinfo->state data) 'up-to-date))
+           (ewoc-delete vc-ewoc crt))
+         (setq crt prev)))))
+
+(defun vc-dir-printer (fileentry)
+  (vc-call-backend vc-dir-backend 'dir-printer fileentry))
+
+(defun vc-dir-deduce-fileset (&optional state-model-only-files)
+  (let ((marked (vc-dir-marked-files))
+       files
+       only-files-list
+       state
+       model)
+    (if marked
+       (progn
+         (setq files marked)
+         (when state-model-only-files
+           (setq only-files-list (vc-dir-marked-only-files-and-states))))
+      (let ((crt (vc-dir-current-file)))
+       (setq files (list crt))
+       (when state-model-only-files
+         (setq only-files-list (vc-dir-child-files-and-states)))))
+
+    (when state-model-only-files
+      (setq state (cdar only-files-list))
+      ;; Check that all files are in a consistent state, since we use that
+      ;; state to decide which operation to perform.
+      (dolist (crt (cdr only-files-list))
+       (unless (vc-compatible-state (cdr crt) state)
+         (error "%s:%s clashes with %s:%s"
+                (car crt) (cdr crt) (caar only-files-list) state)))
+      (setq only-files-list (mapcar 'car only-files-list))
+      (when (and state (not (eq state 'unregistered)))
+       (setq model (vc-checkout-model vc-dir-backend only-files-list))))
+    (list vc-dir-backend files only-files-list state model)))
 
 ;;;###autoload
-(defun vc-dir (dir)
-  "Show the VC status for DIR."
-  (interactive "DVC status for directory: ")
-  (pop-to-buffer (vc-dir-prepare-status-buffer "*vc-dir*" dir))
-  (if (and (derived-mode-p 'vc-dir-mode) (boundp 'client-object))
+(defun vc-dir (dir &optional backend)
+  "Show the VC status for DIR.
+Optional second argument BACKEND specifies the VC backend to use.
+Interactively, a prefix argument means to ask for the backend."
+  (interactive
+   (list
+    ;; When you hit C-x v d in a visited VC file,
+    ;; the *vc-dir* buffer visits the directory under its truename;
+    ;; therefore it makes sense to always do that.
+    ;; Otherwise if you do C-x v d -> C-x C-f -> C-c v d
+    ;; you may get a new *vc-dir* buffer, different from the original
+    (file-truename (read-file-name "VC status for directory: "
+                                   default-directory default-directory t
+                                   nil #'file-directory-p))
+    (if current-prefix-arg
+       (intern
+        (completing-read
+         "Use VC backend: "
+         (mapcar (lambda (b) (list (symbol-name b)))
+                 vc-handled-backends)
+         nil t nil nil)))))
+  (unless backend
+    (setq backend (vc-responsible-backend dir)))
+  (pop-to-buffer (vc-dir-prepare-status-buffer "*vc-dir*" dir backend))
+  (if (derived-mode-p 'vc-dir-mode)
       (vc-dir-refresh)
-    ;; Otherwise, initialize a new view using the dispatcher layer
-    (progn
-      (set (make-local-variable 'vc-dir-backend) (vc-responsible-backend dir))
-      ;; Build a capability object and hand it to the dispatcher initializer
-      (vc-dir-mode (vc-make-backend-object dir))
-      ;; FIXME: Make a derived-mode instead.
-      ;; Add VC-specific keybindings
-      (let ((map (current-local-map)))
-       (define-key map "v" 'vc-next-action) ;; C-x v v
-       (define-key map "=" 'vc-diff)        ;; C-x v =
-       (define-key map "i" 'vc-register)    ;; C-x v i
-       (define-key map "+" 'vc-update)      ;; C-x v +
-       (define-key map "l" 'vc-print-log)   ;; C-x v l
-       ;; More confusing than helpful, probably
-       ;(define-key map "R" 'vc-revert) ;; u is taken by dispatcher unmark.
-       ;(define-key map "A" 'vc-annotate) ;; g is taken by dispatcher refresh
-       (define-key map "x" 'vc-dir-hide-up-to-date))
-      )
-    ;; FIXME: Needs to alter a buffer-local map, otherwise clients may clash
-    (let ((map vc-dir-menu-map))
-    ;; VC info details
-    (define-key map [sepvcdet] '("--"))
-    (define-key map [remup]
-      '(menu-item "Hide up-to-date" vc-dir-hide-up-to-date
-                 :help "Hide up-to-date items from display"))
-    ;; FIXME: This needs a key binding.  And maybe a better name
-    ;; ("Insert" like PCL-CVS uses does not sound that great either)...
-    (define-key map [ins]
-      '(menu-item "Show File" vc-dir-show-fileentry
-                 :help "Show a file in the VC status listing even though it might be up to date"))
-    (define-key map [annotate]
-      '(menu-item "Annotate" vc-annotate
-                 :help "Display the edit history of the current file using colors"))
-    (define-key map [diff]
-      '(menu-item "Compare with Base Version" vc-diff
-                 :help "Compare file set with the base version"))
-    (define-key map [log]
-     '(menu-item "Show history" vc-print-log
-     :help "List the change log of the current file set in a window"))
-    ;; VC commands.
-    (define-key map [sepvccmd] '("--"))
-    (define-key map [update]
-      '(menu-item "Update to latest version" vc-update
-                 :help "Update the current fileset's files to their tip revisions"))
-    (define-key map [revert]
-      '(menu-item "Revert to base version" vc-revert
-                 :help "Revert working copies of the selected fileset to their repository contents."))
-    (define-key map [next-action]
-      ;; FIXME: This really really really needs a better name!
-      ;; And a key binding too.
-      '(menu-item "Check In/Out" vc-next-action
-                 :help "Do the next logical version control operation on the current fileset"))
-    (define-key map [register]
-      '(menu-item "Register" vc-dir-register
-                 :help "Register file set into the version control system"))
-    )))
+    ;; FIXME: find a better way to pass the backend to `vc-dir-mode'.
+    (let ((use-vc-backend backend))
+      (vc-dir-mode))))
 
-(defun vc-default-status-extra-headers (backend dir)
+(defun vc-default-dir-extra-headers (backend dir)
   ;; Be loud by default to remind people to add code to display
   ;; backend specific headers.
   ;; XXX: change this to return nil before the release.
@@ -1009,17 +1145,12 @@ outside of VC) and one wants to do some operation on it."
    (propertize "Please add backend specific headers here.  It's easy!"
               'face 'font-lock-warning-face)))
 
-(defun vc-default-status-printer (backend fileentry)
+(defun vc-default-dir-printer (backend fileentry)
   "Pretty print FILEENTRY."
   ;; If you change the layout here, change vc-dir-move-to-goal-column.
   (let* ((isdir (vc-dir-fileinfo->directory fileentry))
-       (state (if isdir 'DIRECTORY (vc-dir-fileinfo->state fileentry)))
+       (state (if isdir "" (vc-dir-fileinfo->state fileentry)))
        (filename (vc-dir-fileinfo->name fileentry)))
-    ;; FIXME: Backends that want to print the state in a different way
-    ;; can do it by defining the `status-printer' function.  Using
-    ;; `prettify-state-info' adds two extra vc-calls per item, which
-    ;; is too expensive.
-    ;;(prettified (if isdir state (vc-call-backend backend 'prettify-state-info filename))))
     (insert
      (propertize
       (format "%c" (if (vc-dir-fileinfo->marked fileentry) ?* ? ))
@@ -1034,7 +1165,12 @@ outside of VC) and one wants to do some operation on it."
      " "
      (propertize
       (format "%s" filename)
-      'face 'font-lock-function-name-face
+      'face
+      (if isdir 'font-lock-comment-delimiter-face 'font-lock-function-name-face)
+      'help-echo
+      (if isdir
+         "Directory\nVC operations can be applied to it\nmouse-3: Pop-up menu"
+       "File\nmouse-3: Pop-up menu")
       'mouse-face 'highlight))))
 
 (defun vc-default-extra-status-menu (backend)
@@ -1046,4 +1182,5 @@ outside of VC) and one wants to do some operation on it."
 
 (provide 'vc-dir)
 
+;; arch-tag: 0274a2e3-e8e9-4b1a-a73c-e8b9129d5d15
 ;;; vc-dir.el ends here