vc-dir.el 48.6 KB
Newer Older
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1 2
;;; vc-dir.el --- Directory status display under VC

3
;; Copyright (C) 2007-2011  Free Software Foundation, Inc.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
4 5

;; Author:   Dan Nicolaescu <dann@ics.uci.edu>
6
;; Keywords: vc tools
7
;; Package: vc
Dan Nicolaescu's avatar
Dan Nicolaescu committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

;; This file is part of GNU Emacs.

;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

;;; Credits:

;; The original VC directory status implementation was based on dired.
;; This implementation was inspired by PCL-CVS.
;; Many people contributed comments, ideas and code to this
;; implementation.  These include:
30
;;
Dan Nicolaescu's avatar
Dan Nicolaescu committed
31 32 33 34 35
;;   Alexandre Julliard  <julliard@winehq.org>
;;   Stefan Monnier  <monnier@iro.umontreal.ca>
;;   Tom Tromey  <tromey@redhat.com>

;;; Commentary:
36
;;
Dan Nicolaescu's avatar
Dan Nicolaescu committed
37 38 39 40 41

;;; Todo:  see vc.el.

(require 'vc-hooks)
(require 'vc)
42
(require 'tool-bar)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
(require 'ewoc)

;;; Code:
(eval-when-compile
  (require 'cl))

(defcustom vc-dir-mode-hook nil
  "Normal hook run by `vc-dir-mode'.
See `run-hooks'."
  :type 'hook
  :group 'vc)

;; Used to store information for the files displayed in the directory buffer.
;; Each item displayed corresponds to one of these defstructs.
(defstruct (vc-dir-fileinfo
            (:copier nil)
            (:type list)            ;So we can use `member' on lists of FIs.
            (:constructor
             ;; We could define it as an alias for `list'.
	     vc-dir-create-fileinfo (name state &optional extra marked directory))
            (:conc-name vc-dir-fileinfo->))
  name                                  ;Keep it as first, for `member'.
  state
Dan Nicolaescu's avatar
Dan Nicolaescu committed
66
  ;; For storing backend specific information.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
67 68 69 70 71 72 73 74
  extra
  marked
  ;; To keep track of not updated files during a global refresh
  needs-update
  ;; To distinguish files and directories.
  directory)

(defvar vc-ewoc nil)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
75

Dan Nicolaescu's avatar
Dan Nicolaescu committed
76 77 78
(defvar vc-dir-process-buffer nil
  "The buffer used for the asynchronous call that computes status.")

Dan Nicolaescu's avatar
Dan Nicolaescu committed
79 80 81
(defvar vc-dir-backend nil
  "The backend used by the current *vc-dir* buffer.")

Dan Nicolaescu's avatar
Dan Nicolaescu committed
82 83 84 85
(defun vc-dir-move-to-goal-column ()
  ;; Used to keep the cursor on the file name column.
  (beginning-of-line)
  (unless (eolp)
86
    ;; Must be in sync with vc-default-dir-printer.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
87 88
    (forward-char 25)))

Dan Nicolaescu's avatar
Dan Nicolaescu committed
89
(defun vc-dir-prepare-status-buffer (bname dir backend &optional create-new)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
90
  "Find a buffer named BNAME showing DIR, or create a new one."
91
  (setq dir (file-name-as-directory (expand-file-name dir)))
92 93 94 95 96 97 98 99 100 101
  (let* ;; Look for another buffer name BNAME visiting the same directory.
      ((buf (save-excursion
              (unless create-new
                (dolist (buffer vc-dir-buffers)
                  (when (buffer-live-p buffer)
                    (set-buffer buffer)
                    (when (and (derived-mode-p 'vc-dir-mode)
                               (eq vc-dir-backend backend)
                               (string= default-directory dir))
                      (return buffer))))))))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
102 103
    (or buf
        ;; Create a new buffer named BNAME.
Juanma Barranquero's avatar
Juanma Barranquero committed
104 105 106
	;; We pass a filename to create-file-buffer because it is what
	;; the function expects, and also what uniquify needs (if active)
        (with-current-buffer (create-file-buffer (expand-file-name bname dir))
107
          (setq default-directory dir)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
          (vc-setup-buffer (current-buffer))
          ;; Reset the vc-parent-buffer-name so that it does not appear
          ;; in the mode-line.
          (setq vc-parent-buffer-name nil)
          (current-buffer)))))

(defvar vc-dir-menu-map
  (let ((map (make-sparse-keymap "VC-dir")))
    (define-key map [quit]
      '(menu-item "Quit" quit-window
		  :help "Quit"))
    (define-key map [kill]
      '(menu-item "Kill Update Command" vc-dir-kill-dir-status-process
		  :enable (vc-dir-busy)
		  :help "Kill the command that updates the directory buffer"))
    (define-key map [refresh]
Dan Nicolaescu's avatar
Dan Nicolaescu committed
124
      '(menu-item "Refresh" revert-buffer
Dan Nicolaescu's avatar
Dan Nicolaescu committed
125 126
		  :enable (not (vc-dir-busy))
		  :help "Refresh the contents of the directory buffer"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
127
    (define-key map [remup]
128
      '(menu-item "Hide Up-to-date" vc-dir-hide-up-to-date
Dan Nicolaescu's avatar
Dan Nicolaescu committed
129
		  :help "Hide up-to-date items from display"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
130 131 132
    ;; Movement.
    (define-key map [sepmv] '("--"))
    (define-key map [next-line]
133
      '(menu-item "Next Line" vc-dir-next-line
Dan Nicolaescu's avatar
Dan Nicolaescu committed
134 135
		  :help "Go to the next line" :keys "n"))
    (define-key map [previous-line]
136
      '(menu-item "Previous Line" vc-dir-previous-line
Dan Nicolaescu's avatar
Dan Nicolaescu committed
137 138 139 140 141 142 143 144
		  :help "Go to the previous line"))
    ;; Marking.
    (define-key map [sepmrk] '("--"))
    (define-key map [unmark-all]
      '(menu-item "Unmark All" vc-dir-unmark-all-files
		  :help "Unmark all files that are in the same state as the current file\
\nWith prefix argument unmark all files"))
    (define-key map [unmark-previous]
145
      '(menu-item "Unmark Previous " vc-dir-unmark-file-up
Dan Nicolaescu's avatar
Dan Nicolaescu committed
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
		  :help "Move to the previous line and unmark the file"))

    (define-key map [mark-all]
      '(menu-item "Mark All" vc-dir-mark-all-files
		  :help "Mark all files that are in the same state as the current file\
\nWith prefix argument mark all files"))
    (define-key map [unmark]
      '(menu-item "Unmark" vc-dir-unmark
		  :help "Unmark the current file or all files in the region"))

    (define-key map [mark]
      '(menu-item "Mark" vc-dir-mark
		  :help "Mark the current file or all files in the region"))

    (define-key map [sepopn] '("--"))
161
    (define-key map [qr]
162
      '(menu-item "Query Replace in Files..." vc-dir-query-replace-regexp
163
		  :help "Replace a string in the marked files"))
164
    (define-key map [se]
165
      '(menu-item "Search Files..." vc-dir-search
166
		  :help "Search a regexp in the marked files"))
167 168 169 170 171 172
    (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"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
173
    (define-key map [open-other]
174
      '(menu-item "Open in Other Window" vc-dir-find-file-other-window
Dan Nicolaescu's avatar
Dan Nicolaescu committed
175 176
		  :help "Find the file on the current line, in another window"))
    (define-key map [open]
177
      '(menu-item "Open File" vc-dir-find-file
Dan Nicolaescu's avatar
Dan Nicolaescu committed
178
		  :help "Find the file on the current line"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
179 180 181 182 183 184 185 186 187 188 189 190
    (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"))
191 192 193 194 195 196
    (define-key map [logo]
      '(menu-item "Show Outgoing Log" vc-log-outgoing
		  :help "Show a log of changes that will be sent with a push operation"))
    (define-key map [logi]
      '(menu-item "Show Incoming Log" vc-log-incoming
		  :help "Show a log of changes that will be received with a pull operation"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
197
    (define-key map [log]
198
      '(menu-item "Show History" vc-print-log
199 200 201 202
		  :help "List the change log of the current file set in a window"))
    (define-key map [rlog]
      '(menu-item "Show Top of the Tree History " vc-print-root-log
		  :help "List the change log for the current tree in a window"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
203 204 205
    ;; VC commands.
    (define-key map [sepvccmd] '("--"))
    (define-key map [update]
206
      '(menu-item "Update to Latest Version" vc-update
Dan Nicolaescu's avatar
Dan Nicolaescu committed
207 208
		  :help "Update the current fileset's files to their tip revisions"))
    (define-key map [revert]
209
      '(menu-item "Revert to Base Version" vc-revert
Dan Nicolaescu's avatar
Dan Nicolaescu committed
210 211 212 213 214 215 216 217 218
		  :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"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
219
    map)
220
  "Menu for VC dir.")
Dan Nicolaescu's avatar
Dan Nicolaescu committed
221

Dan Nicolaescu's avatar
Dan Nicolaescu committed
222 223
;; VC backends can use this to add mode-specific menu items to
;; vc-dir-menu-map.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
224 225 226 227
(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
Dan Nicolaescu's avatar
Dan Nicolaescu committed
228 229
         (when (derived-mode-p 'vc-dir-mode)
	   (vc-call-backend vc-dir-backend 'extra-status-menu))))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
230 231 232 233 234 235 236
    (if (null ext-binding)
	orig-binding
      (append orig-binding
	      '("----")
	      ext-binding))))

(defvar vc-dir-mode-map
237
  (let ((map (make-sparse-keymap)))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
238 239 240 241 242 243 244
    ;; 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
245 246 247
    ;;(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'.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
    ;; Marking.
    (define-key map "m" 'vc-dir-mark)
    (define-key map "M" 'vc-dir-mark-all-files)
    (define-key map "u" 'vc-dir-unmark)
    (define-key map "U" 'vc-dir-unmark-all-files)
    (define-key map "\C-?" 'vc-dir-unmark-file-up)
    (define-key map "\M-\C-?" 'vc-dir-unmark-all-files)
    ;; Movement.
    (define-key map "n" 'vc-dir-next-line)
    (define-key map " " 'vc-dir-next-line)
    (define-key map "\t" 'vc-dir-next-directory)
    (define-key map "p" 'vc-dir-previous-line)
    (define-key map [backtab] 'vc-dir-previous-directory)
    ;;; Rebind paragraph-movement commands.
    (define-key map "\M-}" 'vc-dir-next-directory)
    (define-key map "\M-{" 'vc-dir-previous-directory)
    (define-key map [C-down] 'vc-dir-next-directory)
    (define-key map [C-up] 'vc-dir-previous-directory)
    ;; The remainder.
    (define-key map "f" 'vc-dir-find-file)
Bob Rogers's avatar
Bob Rogers committed
268
    (define-key map "e" 'vc-dir-find-file) ; dired-mode compatibility
Dan Nicolaescu's avatar
Dan Nicolaescu committed
269 270 271 272 273
    (define-key map "\C-m" 'vc-dir-find-file)
    (define-key map "o" 'vc-dir-find-file-other-window)
    (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)
274
    (define-key map [follow-link] 'mouse-face)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
275
    (define-key map "x" 'vc-dir-hide-up-to-date)
276
    (define-key map [?\C-k] 'vc-dir-kill-line)
277
    (define-key map "S" 'vc-dir-search) ;; FIXME: Maybe use A like dired?
278
    (define-key map "Q" 'vc-dir-query-replace-regexp)
279 280
    (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)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
281 282 283 284

    ;; Hook up the menu.
    (define-key map [menu-bar vc-dir-mode]
      `(menu-item
Dan Nicolaescu's avatar
Dan Nicolaescu committed
285 286
	;; VC backends can use this to add mode-specific menu items to
	;; vc-dir-menu-map.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
287 288 289 290
	"VC-dir" ,vc-dir-menu-map :filter vc-dir-menu-map-filter))
    map)
  "Keymap for directory buffer.")

291
(defmacro vc-dir-at-event (event &rest body)
292 293
  "Evaluate BODY with point located at event-start of EVENT.
If BODY uses EVENT, it should be a variable,
Dan Nicolaescu's avatar
Dan Nicolaescu committed
294
 otherwise it will be evaluated twice."
295
  (let ((posn (make-symbol "vc-dir-at-event-posn")))
296 297 298 299 300 301
    `(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)))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
302 303

(defun vc-dir-menu (e)
304
  "Popup the VC dir menu."
Dan Nicolaescu's avatar
Dan Nicolaescu committed
305
  (interactive "e")
306
  (vc-dir-at-event e (popup-menu vc-dir-menu-map e)))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
307 308 309

(defvar vc-dir-tool-bar-map
  (let ((map (make-sparse-keymap)))
310 311 312 313 314 315 316 317 318 319
    (tool-bar-local-item-from-menu 'find-file "new" map nil
				   :label "New File" :vert-only t)
    (tool-bar-local-item-from-menu 'menu-find-file-existing "open" map nil
				   :label "Open" :vert-only t)
    (tool-bar-local-item-from-menu 'dired "diropen" map nil
				   :vert-only t)
    (tool-bar-local-item-from-menu 'quit-window "close" map vc-dir-mode-map
				   :vert-only t)
    (tool-bar-local-item-from-menu 'vc-next-action "saveas" map
				   vc-dir-mode-map :label "Commit")
Dan Nicolaescu's avatar
Dan Nicolaescu committed
320
    (tool-bar-local-item-from-menu 'vc-print-log "info"
321 322 323
    				   map vc-dir-mode-map
				   :label "Log")
    (define-key-after map [separator-1] menu-bar-separator)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
324
    (tool-bar-local-item-from-menu 'vc-dir-kill-dir-status-process "cancel"
325
				   map vc-dir-mode-map
326 327 328 329 330 331 332 333 334 335 336 337 338 339
				   :label "Stop" :vert-only t)
    (tool-bar-local-item-from-menu 'revert-buffer "refresh"
				   map vc-dir-mode-map :vert-only t)
    (define-key-after map [separator-2] menu-bar-separator)
    (tool-bar-local-item-from-menu (lookup-key menu-bar-edit-menu [cut])
				   "cut" map nil :vert-only t)
    (tool-bar-local-item-from-menu (lookup-key menu-bar-edit-menu [copy])
				   "copy" map nil :vert-only t)
    (tool-bar-local-item-from-menu (lookup-key menu-bar-edit-menu [paste])
				   "paste" map nil :vert-only t)
    (define-key-after map [separator-3] menu-bar-separator)
    (tool-bar-local-item-from-menu 'isearch-forward
    				   "search" map nil
				   :label "Search" :vert-only t)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
340 341 342 343
    map))

(defun vc-dir-node-directory (node)
  ;; Compute the directory for NODE.
Juanma Barranquero's avatar
Juanma Barranquero committed
344
  ;; If it's a directory node, get it from the node.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
345 346 347 348
  (let ((data (ewoc-data node)))
    (or (vc-dir-fileinfo->directory data)
	;; Otherwise compute it from the file name.
	(file-name-directory
349 350 351
	 (directory-file-name
	  (expand-file-name
	   (vc-dir-fileinfo->name data)))))))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366

(defun vc-dir-update (entries buffer &optional noinsert)
  "Update BUFFER's ewoc from the list of ENTRIES.
If NOINSERT, ignore elements on ENTRIES which are not in the ewoc."
  ;; Add ENTRIES to the vc-dir buffer BUFFER.
  (with-current-buffer buffer
    ;; Insert the entries sorted by name into the ewoc.
    ;; We assume the ewoc is sorted too, which should be the
    ;; case if we always add entries with vc-dir-update.
    (setq entries
	  ;; Sort: first files and then subdirectories.
	  ;; XXX: this is VERY inefficient, it computes the directory
	  ;; names too many times
	  (sort entries
		(lambda (entry1 entry2)
367 368 369 370
		  (let ((dir1 (file-name-directory
			        (directory-file-name (expand-file-name (car entry1)))))
			(dir2 (file-name-directory
			       (directory-file-name (expand-file-name (car entry2))))))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
371 372 373 374 375 376
		    (cond
		     ((string< dir1 dir2) t)
		     ((not (string= dir1 dir2)) nil)
		     ((string< (car entry1) (car entry2))))))))
    ;; Insert directory entries in the right places.
    (let ((entry (car entries))
377
	  (node (ewoc-nth vc-ewoc 0))
378
	  (to-remove nil)
379
	  (dotname (file-relative-name default-directory)))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
380 381
      ;; Insert . if it is not present.
      (unless node
382 383
	(ewoc-enter-last
	 vc-ewoc (vc-dir-create-fileinfo
384
		  dotname nil nil nil default-directory))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
385
	(setq node (ewoc-nth vc-ewoc 0)))
386

Dan Nicolaescu's avatar
Dan Nicolaescu committed
387 388
      (while (and entry node)
	(let* ((entryfile (car entry))
389 390
	       (entrydir (file-name-directory (directory-file-name
					       (expand-file-name entryfile))))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
391 392 393 394 395 396 397 398 399
	       (nodedir (vc-dir-node-directory node)))
	  (cond
	   ;; First try to find the directory.
	   ((string-lessp nodedir entrydir)
	    (setq node (ewoc-next vc-ewoc node)))
	   ((string-equal nodedir entrydir)
	    ;; Found the directory, find the place for the file name.
	    (let ((nodefile (vc-dir-fileinfo->name (ewoc-data node))))
	      (cond
400 401
	       ((string= nodefile dotname)
		(setq node (ewoc-next vc-ewoc node)))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
402 403 404
	       ((string-lessp nodefile entryfile)
		(setq node (ewoc-next vc-ewoc node)))
	       ((string-equal nodefile entryfile)
405 406 407 408 409 410 411 412 413 414
		(if (nth 1 entry)
		    (progn
		      (setf (vc-dir-fileinfo->state (ewoc-data node)) (nth 1 entry))
		      (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))
		  ;; If the state is nil, the file does not exist
		  ;; anymore, so remember the entry so we can remove
		  ;; it after we are done inserting all ENTRIES.
		  (push node to-remove))
415
		(setq entries (cdr entries))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
416 417 418
		(setq entry (car entries))
		(setq node (ewoc-next vc-ewoc node)))
	       (t
419 420 421
		(unless noinsert
		  (ewoc-enter-before vc-ewoc node
				     (apply 'vc-dir-create-fileinfo entry)))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
422 423 424
		(setq entries (cdr entries))
		(setq entry (car entries))))))
	   (t
425 426 427 428 429 430 431 432 433 434 435 436
	    (unless noinsert
	      ;; We might need to insert a directory node if the
	      ;; previous node was in a different directory.
	      (let* ((rd (file-relative-name entrydir))
		     (prev-node (ewoc-prev vc-ewoc node))
		     (prev-dir (vc-dir-node-directory prev-node)))
		(unless (string-equal entrydir prev-dir)
		  (ewoc-enter-before
		   vc-ewoc node (vc-dir-create-fileinfo rd nil nil nil entrydir))))
	      ;; Now insert the node itself.
	      (ewoc-enter-before vc-ewoc node
				 (apply 'vc-dir-create-fileinfo entry)))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
437 438 439 440 441
	    (setq entries (cdr entries) entry (car entries))))))
      ;; We're past the last node, all remaining entries go to the end.
      (unless (or node noinsert)
	(let ((lastdir (vc-dir-node-directory (ewoc-nth vc-ewoc -1))))
	  (dolist (entry entries)
442 443
	    (let ((entrydir (file-name-directory
			     (directory-file-name (expand-file-name (car entry))))))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
444 445 446 447 448 449 450 451
	      ;; Insert a directory node if needed.
	      (unless (string-equal lastdir entrydir)
		(setq lastdir entrydir)
		(let ((rd (file-relative-name entrydir)))
		  (ewoc-enter-last
		   vc-ewoc (vc-dir-create-fileinfo rd nil nil nil entrydir))))
	      ;; Now insert the node itself.
	      (ewoc-enter-last vc-ewoc
452 453 454 455
			       (apply 'vc-dir-create-fileinfo entry))))))
      (when to-remove
	(let ((inhibit-read-only t))
	  (apply 'ewoc-delete vc-ewoc (nreverse to-remove)))))))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536

(defun vc-dir-busy ()
  (and (buffer-live-p vc-dir-process-buffer)
       (get-buffer-process vc-dir-process-buffer)))

(defun vc-dir-kill-dir-status-process ()
  "Kill the temporary buffer and associated process."
  (interactive)
  (when (buffer-live-p vc-dir-process-buffer)
    (let ((proc (get-buffer-process vc-dir-process-buffer)))
      (when proc (delete-process proc))
      (setq vc-dir-process-buffer nil)
      (setq mode-line-process nil))))

(defun vc-dir-kill-query ()
  ;; Make sure that when the status buffer is killed the update
  ;; process running in background is also killed.
  (if (vc-dir-busy)
    (when (y-or-n-p "Status update process running, really kill status buffer? ")
      (vc-dir-kill-dir-status-process)
      t)
    t))

(defun vc-dir-next-line (arg)
  "Go to the next line.
If a prefix argument is given, move by that many lines."
  (interactive "p")
  (with-no-warnings
    (ewoc-goto-next vc-ewoc arg)
    (vc-dir-move-to-goal-column)))

(defun vc-dir-previous-line (arg)
  "Go to the previous line.
If a prefix argument is given, move by that many lines."
  (interactive "p")
  (ewoc-goto-prev vc-ewoc arg)
  (vc-dir-move-to-goal-column))

(defun vc-dir-next-directory ()
  "Go to the next directory."
  (interactive)
  (let ((orig (point)))
    (if
	(catch 'foundit
	  (while t
	    (let* ((next (ewoc-next vc-ewoc (ewoc-locate vc-ewoc))))
	      (cond ((not next)
		     (throw 'foundit t))
		    (t
		     (progn
		       (ewoc-goto-node vc-ewoc next)
		       (vc-dir-move-to-goal-column)
		       (if (vc-dir-fileinfo->directory (ewoc-data next))
			   (throw 'foundit nil))))))))
	(goto-char orig))))

(defun vc-dir-previous-directory ()
  "Go to the previous directory."
  (interactive)
  (let ((orig (point)))
    (if
	(catch 'foundit
	  (while t
	    (let* ((prev (ewoc-prev vc-ewoc (ewoc-locate vc-ewoc))))
	      (cond ((not prev)
		     (throw 'foundit t))
		    (t
		     (progn
		       (ewoc-goto-node vc-ewoc prev)
		       (vc-dir-move-to-goal-column)
		       (if (vc-dir-fileinfo->directory (ewoc-data prev))
			   (throw 'foundit nil))))))))
	(goto-char orig))))

(defun vc-dir-mark-unmark (mark-unmark-function)
  (if (use-region-p)
      (let ((firstl (line-number-at-pos (region-beginning)))
	    (lastl (line-number-at-pos (region-end))))
	(save-excursion
	  (goto-char (region-beginning))
	  (while (<= (line-number-at-pos) lastl)
537 538 539 540 541 542
	    (condition-case nil
		(funcall mark-unmark-function)
	      ;; `vc-dir-mark-file' signals an error if we try marking
	      ;; a directory containing marked files in its tree, or a
	      ;; file in a marked directory tree.  Just continue.
	      (error (vc-dir-next-line 1))))))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
543 544 545
    (funcall mark-unmark-function)))

(defun vc-dir-parent-marked-p (arg)
546 547
  ;; Non-nil iff a parent directory of arg is marked.
  ;; Return value, if non-nil is the `ewoc-data' for the marked parent.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
548 549 550
  (let* ((argdir (vc-dir-node-directory arg))
	 (arglen (length argdir))
	 (crt arg)
551
	 (found nil))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
552 553
    ;; Go through the predecessors, checking if any directory that is
    ;; a parent is marked.
554 555 556 557 558 559 560 561 562
    (while (and (null found)
		(setq crt (ewoc-prev vc-ewoc crt)))
      (let ((data (ewoc-data crt))
	    (dir (vc-dir-node-directory crt)))
	(and (vc-dir-fileinfo->directory data)
	     (vc-string-prefix-p dir argdir)
	     (vc-dir-fileinfo->marked data)
	     (setq found data))))
    found))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
563 564

(defun vc-dir-children-marked-p (arg)
565 566
  ;; Non-nil iff a child of ARG is marked.
  ;; Return value, if non-nil, is the `ewoc-data' for the marked child.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
567 568 569
  (let* ((argdir-re (concat "\\`" (regexp-quote (vc-dir-node-directory arg))))
	 (is-child t)
	 (crt arg)
570 571 572 573 574 575 576 577 578 579 580 581
	 (found nil))
    (while (and is-child
		(null found)
		(setq crt (ewoc-next vc-ewoc crt)))
      (let ((data (ewoc-data crt))
	    (dir (vc-dir-node-directory crt)))
	(if (string-match argdir-re dir)
	    (if (vc-dir-fileinfo->marked data)
		(setq found data))
	  ;; We are done, we got to an entry that is not a child of `arg'.
	  (setq is-child nil))))
    found))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
582 583 584 585 586

(defun vc-dir-mark-file (&optional arg)
  ;; Mark ARG or the current file and move to the next line.
  (let* ((crt (or arg (ewoc-locate vc-ewoc)))
         (file (ewoc-data crt))
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
	 (isdir (vc-dir-fileinfo->directory file))
	 ;; Forbid marking a directory containing marked files in its
	 ;; tree, or a file in a marked directory tree.
	 (conflict (if isdir
		       (vc-dir-children-marked-p crt)
		     (vc-dir-parent-marked-p crt))))
    (when conflict
      (error (if isdir
		 "File `%s' in this directory is already marked"
	       "Parent directory `%s' is already marked")
	     (vc-dir-fileinfo->name conflict)))
    (setf (vc-dir-fileinfo->marked file) t)
    (ewoc-invalidate vc-ewoc crt)
    (unless (or arg (mouse-event-p last-command-event))
      (vc-dir-next-line 1))))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637

(defun vc-dir-mark ()
  "Mark the current file or all files in the region.
If the region is active, mark all the files in the region.
Otherwise mark the file on the current line and move to the next
line."
  (interactive)
  (vc-dir-mark-unmark 'vc-dir-mark-file))

(defun vc-dir-mark-all-files (arg)
  "Mark all files with the same state as the current one.
With a prefix argument mark all files.
If the current entry is a directory, mark all child files.

The commands operate on files that are on the same state.
This command is intended to make it easy to select all files that
share the same state."
  (interactive "P")
  (if arg
      ;; Mark all files.
      (progn
	;; First check that no directory is marked, we can't mark
	;; files in that case.
	(ewoc-map
	 (lambda (filearg)
	   (when (and (vc-dir-fileinfo->directory filearg)
		      (vc-dir-fileinfo->marked filearg))
	     (error "Cannot mark all files, directory `%s' marked"
		    (vc-dir-fileinfo->name filearg))))
	 vc-ewoc)
	(ewoc-map
	 (lambda (filearg)
	   (unless (vc-dir-fileinfo->marked filearg)
	     (setf (vc-dir-fileinfo->marked filearg) t)
	     t))
	 vc-ewoc))
638 639
    (let* ((crt  (ewoc-locate vc-ewoc))
	   (data (ewoc-data crt)))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
640 641
      (if (vc-dir-fileinfo->directory data)
	  ;; It's a directory, mark child files.
642 643 644 645 646 647
	  (let (crt-data)
	    (while (and (setq crt (ewoc-next vc-ewoc crt))
			(setq crt-data (ewoc-data crt))
			(not (vc-dir-fileinfo->directory crt-data)))
	      (setf (vc-dir-fileinfo->marked crt-data) t)
	      (ewoc-invalidate vc-ewoc crt)))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
648
	;; It's a file
649 650
	(let ((state (vc-dir-fileinfo->state data)))
	  (setq crt (ewoc-nth vc-ewoc 0))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
	  (while crt
	    (let ((crt-data (ewoc-data crt)))
	      (when (and (not (vc-dir-fileinfo->marked crt-data))
			 (eq (vc-dir-fileinfo->state crt-data) state)
			 (not (vc-dir-fileinfo->directory crt-data)))
		(vc-dir-mark-file crt)))
	    (setq crt (ewoc-next vc-ewoc crt))))))))

(defun vc-dir-unmark-file ()
  ;; Unmark the current file and move to the next line.
  (let* ((crt (ewoc-locate vc-ewoc))
         (file (ewoc-data crt)))
    (setf (vc-dir-fileinfo->marked file) nil)
    (ewoc-invalidate vc-ewoc crt)
    (unless (mouse-event-p last-command-event)
      (vc-dir-next-line 1))))

(defun vc-dir-unmark ()
  "Unmark the current file or all files in the region.
If the region is active, unmark all the files in the region.
Otherwise mark the file on the current line and move to the next
line."
  (interactive)
  (vc-dir-mark-unmark 'vc-dir-unmark-file))

(defun vc-dir-unmark-file-up ()
  "Move to the previous line and unmark the file."
  (interactive)
  ;; If we're on the first line, we won't move up, but we will still
  ;; remove the mark.  This seems a bit odd but it is what buffer-menu
  ;; does.
  (let* ((prev (ewoc-goto-prev vc-ewoc 1))
	 (file (ewoc-data prev)))
    (setf (vc-dir-fileinfo->marked file) nil)
    (ewoc-invalidate vc-ewoc prev)
    (vc-dir-move-to-goal-column)))

(defun vc-dir-unmark-all-files (arg)
  "Unmark all files with the same state as the current one.
With a prefix argument unmark all files.
If the current entry is a directory, unmark all the child files.

The commands operate on files that are on the same state.
This command is intended to make it easy to deselect all files
that share the same state."
  (interactive "P")
  (if arg
      (ewoc-map
       (lambda (filearg)
	 (when (vc-dir-fileinfo->marked filearg)
	   (setf (vc-dir-fileinfo->marked filearg) nil)
	   t))
       vc-ewoc)
    (let* ((crt (ewoc-locate vc-ewoc))
	   (data (ewoc-data crt)))
      (if (vc-dir-fileinfo->directory data)
	  ;; It's a directory, unmark child files.
	  (while (setq crt (ewoc-next vc-ewoc crt))
	    (let ((crt-data (ewoc-data crt)))
	      (unless (vc-dir-fileinfo->directory crt-data)
		(setf (vc-dir-fileinfo->marked crt-data) nil)
		(ewoc-invalidate vc-ewoc crt))))
	;; It's a file
	(let ((crt-state (vc-dir-fileinfo->state (ewoc-data crt))))
	  (ewoc-map
	   (lambda (filearg)
	     (when (and (vc-dir-fileinfo->marked filearg)
			(eq (vc-dir-fileinfo->state filearg) crt-state))
	       (setf (vc-dir-fileinfo->marked filearg) nil)
	       t))
	   vc-ewoc))))))

(defun vc-dir-toggle-mark-file ()
  (let* ((crt (ewoc-locate vc-ewoc))
         (file (ewoc-data crt)))
    (if (vc-dir-fileinfo->marked file)
	(vc-dir-unmark-file)
      (vc-dir-mark-file))))

(defun vc-dir-toggle-mark (e)
  (interactive "e")
732
  (vc-dir-at-event e (vc-dir-mark-unmark 'vc-dir-toggle-mark-file)))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
733 734 735 736 737 738 739 740 741 742 743 744

(defun vc-dir-delete-file ()
  "Delete the marked files, or the current file if no marks."
  (interactive)
  (mapc 'vc-delete-file (or (vc-dir-marked-files)
                            (list (vc-dir-current-file)))))

(defun vc-dir-find-file ()
  "Find the file on the current line."
  (interactive)
  (find-file (vc-dir-current-file)))

745
(defun vc-dir-find-file-other-window (&optional event)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
746
  "Find the file on the current line, in another window."
747 748
  (interactive (list last-nonmenu-event))
  (if event (posn-set-point (event-end event)))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
749 750
  (find-file-other-window (vc-dir-current-file)))

751 752 753 754 755 756 757 758 759 760 761 762
(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))))

763 764 765 766 767 768 769 770
(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))))

771 772 773 774 775 776
(defun vc-dir-query-replace-regexp (from to &optional delimited)
  "Do `query-replace-regexp' of FROM with TO, on all marked files.
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]."
777
  ;; FIXME: this is almost a copy of `dired-do-query-replace-regexp'.  This
778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
  ;; 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))))

Dan Nicolaescu's avatar
Dan Nicolaescu committed
793 794 795 796 797 798 799 800 801 802 803 804
(defun vc-dir-current-file ()
  (let ((node (ewoc-locate vc-ewoc)))
    (unless node
      (error "No file available"))
    (expand-file-name (vc-dir-fileinfo->name (ewoc-data node)))))

(defun vc-dir-marked-files ()
  "Return the list of marked files."
  (mapcar
   (lambda (elem) (expand-file-name (vc-dir-fileinfo->name elem)))
   (ewoc-collect vc-ewoc 'vc-dir-fileinfo->marked)))

805 806 807 808
(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."
Dan Nicolaescu's avatar
Dan Nicolaescu committed
809 810 811 812 813
  (let ((crt (ewoc-nth vc-ewoc 0))
	result)
    (while crt
      (let ((crt-data (ewoc-data crt)))
	(if (vc-dir-fileinfo->marked crt-data)
814
	    ;; FIXME: use vc-dir-child-files-and-states here instead of duplicating it.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
815 816 817 818 819 820 821 822 823 824 825
	    (if (vc-dir-fileinfo->directory crt-data)
		(let* ((dir (vc-dir-fileinfo->directory crt-data))
		       (dirlen (length dir))
		       data)
		  (while
		      (and (setq crt (ewoc-next vc-ewoc crt))
			   (vc-string-prefix-p dir
                                               (progn
                                                 (setq data (ewoc-data crt))
                                                 (vc-dir-node-directory crt))))
		    (unless (vc-dir-fileinfo->directory data)
826
		      (push
827 828 829 830 831 832
		       (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)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
833 834
	      (setq crt (ewoc-next vc-ewoc crt)))
	  (setq crt (ewoc-next vc-ewoc crt)))))
835
    (nreverse result)))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
836

837 838 839
(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."
Dan Nicolaescu's avatar
Dan Nicolaescu committed
840 841 842 843 844 845 846 847 848 849 850 851 852
  (let* ((crt (ewoc-locate vc-ewoc))
	 (crt-data (ewoc-data crt))
         result)
    (if (vc-dir-fileinfo->directory crt-data)
	(let* ((dir (vc-dir-fileinfo->directory crt-data))
	       (dirlen (length dir))
	       data)
	  (while
	      (and (setq crt (ewoc-next vc-ewoc crt))
                   (vc-string-prefix-p dir (progn
                                             (setq data (ewoc-data crt))
                                             (vc-dir-node-directory crt))))
	    (unless (vc-dir-fileinfo->directory data)
853
	      (push
854 855 856
	       (cons (expand-file-name (vc-dir-fileinfo->name data))
		     (vc-dir-fileinfo->state data))
	       result))))
857
      (push
858 859
       (cons (expand-file-name (vc-dir-fileinfo->name crt-data))
	     (vc-dir-fileinfo->state crt-data)) result))
860
    (nreverse result)))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
861

862 863
(defun vc-dir-recompute-file-state (fname def-dir)
  (let* ((file-short (file-relative-name fname def-dir))
864 865 866 867
	 (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.
868
	    (vc-call-backend vc-dir-backend 'registered fname)))
869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
	 (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))
897
	(ddir default-directory)
898 899 900 901 902 903 904
	fileentries)
    (when files
      (dolist (crt files)
	(push (vc-dir-recompute-file-state crt ddir)
	      fileentries))
      (vc-dir-update fileentries (current-buffer)))))

Dan Nicolaescu's avatar
Dan Nicolaescu committed
905
(defun vc-dir-resynch-file (&optional fname)
906
  "Update the entries for FNAME in any directory buffers that list it."
907
  (let ((file (or fname (expand-file-name buffer-file-name)))
908 909 910 911 912 913 914 915 916 917 918 919
        (drop '()))
    (save-current-buffer
      ;; look for a vc-dir buffer that might show this file.
      (dolist (status-buf vc-dir-buffers)
        (if (not (buffer-live-p status-buf))
            (push status-buf drop)
          (set-buffer status-buf)
          (if (not (derived-mode-p 'vc-dir-mode))
              (push status-buf drop)
            (let ((ddir default-directory))
              (when (vc-string-prefix-p ddir file)
                (if (file-directory-p file)
920 921 922 923
		    (progn
		      (vc-dir-resync-directory-files file)
		      (ewoc-set-hf vc-ewoc
				   (vc-dir-headers vc-dir-backend default-directory) ""))
924 925
                  (let* ((complete-state (vc-dir-recompute-file-state file ddir))
			 (state (cadr complete-state)))
926
                    (vc-dir-update
927 928 929
                     (list complete-state)
                     status-buf (or (not state)
				    (eq state 'up-to-date)))))))))))
930 931
    ;; Remove out-of-date entries from vc-dir-buffers.
    (dolist (b drop) (setq vc-dir-buffers (delq b vc-dir-buffers)))))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
932

Dan Nicolaescu's avatar
Dan Nicolaescu committed
933 934 935
(defvar use-vc-backend)  ;; dynamically bound

(define-derived-mode vc-dir-mode special-mode "VC dir"
936
  "Major mode for VC directory buffers.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
937
Marking/Unmarking key bindings and actions:
Dan Nicolaescu's avatar
Dan Nicolaescu committed
938 939
m - mark a file/directory
  - if the region is active, mark all the files in region.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
940 941 942
    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
Dan Nicolaescu's avatar
Dan Nicolaescu committed
943 944
u - unmark a file/directory
  - if the region is active, unmark all the files in region.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
945 946 947 948 949 950 951 952
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
  - with a prefix argument: mark all files
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
Dan Nicolaescu's avatar
Dan Nicolaescu committed
953
mouse-2  - toggles the mark state
Dan Nicolaescu's avatar
Dan Nicolaescu committed
954

955
VC commands
Dan Nicolaescu's avatar
Dan Nicolaescu committed
956 957 958
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.
959 960 961 962 963

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
Dan Nicolaescu's avatar
Dan Nicolaescu committed
964
M-s a C-M-s - does a regexp isearch on the marked files
965 966
If nothing is marked, these commands act on the current entry.
When a directory is current or marked, the Search & Replace
Dan Nicolaescu's avatar
Dan Nicolaescu committed
967 968
commands act on the child files of that directory that are displayed in
the *vc-dir* buffer.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
969 970

\\{vc-dir-mode-map}"
Dan Nicolaescu's avatar
Dan Nicolaescu committed
971
  (set (make-local-variable 'vc-dir-backend) use-vc-backend)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
972
  (setq buffer-read-only t)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
973 974
  (when (boundp 'tool-bar-map)
    (set (make-local-variable 'tool-bar-map) vc-dir-tool-bar-map))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
975 976 977
  (let ((buffer-read-only nil))
    (erase-buffer)
    (set (make-local-variable 'vc-dir-process-buffer) nil)
978
    (set (make-local-variable 'vc-ewoc) (ewoc-create #'vc-dir-printer))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
979 980
    (set (make-local-variable 'revert-buffer-function)
	 'vc-dir-revert-buffer-function)
Juanma Barranquero's avatar
Juanma Barranquero committed
981
    (setq list-buffers-directory (expand-file-name "*vc-dir*" default-directory))
982
    (add-to-list 'vc-dir-buffers (current-buffer))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
983 984 985
    ;; 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)
986
    (hack-dir-local-variables-non-file-buffer)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
987
    (vc-dir-refresh)))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
988 989 990

(defun vc-dir-headers (backend dir)
  "Display the headers in the *VC dir* buffer.
991
It calls the `dir-extra-headers' backend method to display backend
Dan Nicolaescu's avatar
Dan Nicolaescu committed
992 993
specific headers."
  (concat
994
   ;; First layout the common headers.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
995 996 997
   (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)
998 999
   (propertize (format "%s\n" (abbreviate-file-name dir))
               'face 'font-lock-variable-name-face)
1000 1001 1002
   ;; Then the backend specific ones.
   (vc-call-backend backend 'dir-extra-headers dir)
   "\n"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1003 1004 1005 1006 1007 1008

(defun vc-dir-refresh-files (files default-state)
  "Refresh some files in the *VC-dir* buffer."
  (let ((def-dir default-directory)
	(backend vc-dir-backend))
    (vc-set-mode-line-busy-indicator)
Juanma Barranquero's avatar
Juanma Barranquero committed
1009 1010
    ;; Call the `dir-status-files' backend function.
    ;; `dir-status-files' is supposed to be asynchronous.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1011 1012 1013 1014 1015 1016 1017 1018
    ;; It should compute the results, and then call the function
    ;; passed as an argument in order to update the vc-dir buffer
    ;; with the results.
    (unless (buffer-live-p vc-dir-process-buffer)
      (setq vc-dir-process-buffer
            (generate-new-buffer (format " *VC-%s* tmp status" backend))))
    (lexical-let ((buffer (current-buffer)))
      (with-current-buffer vc-dir-process-buffer
1019
        (setq default-directory def-dir)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
        (erase-buffer)
        (vc-call-backend
         backend 'dir-status-files def-dir files default-state
         (lambda (entries &optional more-to-come)
           ;; ENTRIES is a list of (FILE VC_STATE EXTRA) items.
           ;; If MORE-TO-COME is true, then more updates will come from
           ;; the asynchronous process.
           (with-current-buffer buffer
             (vc-dir-update entries buffer)
             (unless more-to-come
               (setq mode-line-process nil)
               ;; Remove the ones that haven't been updated at all.
               ;; Those not-updated are those whose state is nil because the
               ;; file/dir doesn't exist and isn't versioned.
               (ewoc-filter vc-ewoc
                            (lambda (info)
			      ;; The state for directory entries might
			      ;; have been changed to 'up-to-date,
Paul Eggert's avatar
Paul Eggert committed
1038
			      ;; reset it, otherwise it will be removed when doing 'x'
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1039 1040 1041 1042 1043 1044 1045 1046 1047
			      ;; next time.
			      ;; FIXME: There should be a more elegant way to do this.
			      (when (and (vc-dir-fileinfo->directory info)
					 (eq (vc-dir-fileinfo->state info)
					     'up-to-date))
				(setf (vc-dir-fileinfo->state info) nil))

                              (not (vc-dir-fileinfo->needs-update info))))))))))))

Dan Nicolaescu's avatar
Dan Nicolaescu committed
1048 1049 1050
(defun vc-dir-revert-buffer-function (&optional ignore-auto noconfirm)
  (vc-dir-refresh))

Dan Nicolaescu's avatar
Dan Nicolaescu committed
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
(defun vc-dir-refresh ()
  "Refresh the contents of the *VC-dir* buffer.
Throw an error if another update process is in progress."
  (interactive)
  (if (vc-dir-busy)
      (error "Another update process is in progress, cannot run two at a time")
    (let ((def-dir default-directory)
	  (backend vc-dir-backend))
      (vc-set-mode-line-busy-indicator)
      ;; Call the `dir-status' backend function.
      ;; `dir-status' is supposed to be asynchronous.
      ;; It should compute the results, and then call the function
      ;; passed as an argument in order to update the vc-dir buffer
      ;; with the results.

      ;; Create a buffer that can be used by `dir-status' and call
      ;; `dir-status' with this buffer as the current buffer.  Use
      ;; `vc-dir-process-buffer' to remember this buffer, so that
      ;; it can be used later to kill the update process in case it
      ;; takes too long.
      (unless (buffer-live-p vc-dir-process-buffer)
        (setq vc-dir-process-buffer
              (generate-new-buffer (format " *VC-%s* tmp status" backend))))
1074 1075 1076 1077
      ;; 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))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1078
                vc-ewoc)
1079 1080 1081
      ;; Bzr has serious locking problems, so setup the headers first (this is
      ;; synchronous) rather than doing it while dir-status is running.
      (ewoc-set-hf vc-ewoc (vc-dir-headers backend def-dir) "")
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1082 1083
      (lexical-let ((buffer (current-buffer)))
        (with-current-buffer vc-dir-process-buffer
1084
          (setq default-directory def-dir)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
          (erase-buffer)
          (vc-call-backend
           backend 'dir-status def-dir
           (lambda (entries &optional more-to-come)
             ;; ENTRIES is a list of (FILE VC_STATE EXTRA) items.
             ;; If MORE-TO-COME is true, then more updates will come from
             ;; the asynchronous process.
             (with-current-buffer buffer
               (vc-dir-update entries buffer)
               (unless more-to-come
                 (let ((remaining
                        (ewoc-collect
                         vc-ewoc 'vc-dir-fileinfo->needs-update)))
                   (if remaining
                       (vc-dir-refresh-files
                        (mapcar 'vc-dir-fileinfo->name remaining)
                        'up-to-date)
1102
                     (setq mode-line-process nil))))))))))))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113

(defun vc-dir-show-fileentry (file)
  "Insert an entry for a specific file into the current *VC-dir* listing.
This is typically used if the file is up-to-date (or has been added
outside of VC) and one wants to do some operation on it."
  (interactive "fShow file: ")
  (vc-dir-update (list (list (file-relative-name file) (vc-state file))) (current-buffer)))

(defun vc-dir-hide-up-to-date ()
  "Hide up-to-date items from display."
  (interactive)
1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
  (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)))))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1137

1138 1139 1140 1141 1142 1143 1144
(defun vc-dir-kill-line ()
  "Remove the current line from display."
  (interactive)
  (let ((crt (ewoc-locate vc-ewoc))
        (inhibit-read-only t))
    (ewoc-delete vc-ewoc crt)))

1145 1146
(defun vc-dir-printer (fileentry)
  (vc-call-backend vc-dir-backend 'dir-printer fileentry))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1147

1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160
(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))
1161
	(when state-model-only-files
1162 1163 1164 1165 1166 1167 1168 1169
	  (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)
1170
	  (error "When applying VC operations to multiple files, the files are required\nto  be in similar VC states.\n%s in state %s clashes with %s in state %s"
1171 1172 1173 1174 1175 1176
		 (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)))

Dan Nicolaescu's avatar
Dan Nicolaescu committed
1177
;;;###autoload
1178
(defun vc-dir (dir &optional backend)
1179 1180 1181 1182 1183 1184 1185 1186 1187
  "Show the VC status for \"interesting\" files in and below DIR.
This allows you to mark files and perform VC operations on them.
The list omits files which are up to date, with no changes in your copy
or the repository, if there is nothing in particular to say about them.

Preparing the list of file status takes time; when the buffer
first appears, it has only the first few lines of summary information.
The file lines appear later.

1188
Optional second argument BACKEND specifies the VC backend to use.
1189 1190 1191 1192
Interactively, a prefix argument means to ask for the backend.

These are the commands available for use in the file status buffer:

1193
\\{vc-dir-mode-map}"
1194

Dan Nicolaescu's avatar
Dan Nicolaescu committed
1195 1196
  (interactive
   (list
1197 1198 1199 1200 1201
    ;; 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
1202 1203 1204
    (file-truename (read-directory-name "VC status for directory: "
					default-directory default-directory t
					nil))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1205 1206 1207 1208
    (if current-prefix-arg
	(intern
	 (completing-read
	  "Use VC backend: "
1209 1210 1211 1212 1213
	  (mapcar (lambda (b) (list (symbol-name b)))
		  vc-handled-backends)
	  nil t nil nil)))))
  (unless backend
    (setq backend (vc-responsible-backend dir)))
1214 1215
  (let (pop-up-windows)		      ; based on cvs-examine; bug#6204
    (pop-to-buffer (vc-dir-prepare-status-buffer "*vc-dir*" dir backend)))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1216
  (if (derived-mode-p 'vc-dir-mode)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1217
      (vc-dir-refresh)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1218 1219 1220
    ;; FIXME: find a better way to pass the backend to `vc-dir-mode'.
    (let ((use-vc-backend backend))
      (vc-dir-mode))))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1221

1222
(defun vc-default-dir-extra-headers (backend dir)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1223 1224 1225 1226 1227 1228 1229 1230
  ;; Be loud by default to remind people to add code to display
  ;; backend specific headers.
  ;; XXX: change this to return nil before the release.
  (concat
   (propertize "Extra      : " 'face 'font-lock-type-face)
   (propertize "Please add backend specific headers here.  It's easy!"
	       'face 'font-lock-warning-face)))

1231
(defvar vc-dir-filename-mouse-map
1232 1233 1234 1235 1236
   (let ((map (make-sparse-keymap)))
     (define-key map [mouse-2] 'vc-dir-find-file-other-window)
    map)
  "Local keymap for visiting a file.")

1237
(defun vc-default-dir-printer (backend fileentry)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1238 1239
  "Pretty print FILEENTRY."
  ;; If you change the layout here, change vc-dir-move-to-goal-column.
1240 1241 1242
  ;; VC backends can implement backend specific versions of this
  ;; function.  Changes here might need to be reflected in the
  ;; vc-BACKEND-dir-printer functions.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1243
  (let* ((isdir (vc-dir-fileinfo->directory fileentry))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1244
	(state (if isdir "" (vc-dir-fileinfo->state fileentry)))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
	(filename (vc-dir-fileinfo->name fileentry)))
    (insert
     (propertize
      (format "%c" (if (vc-dir-fileinfo->marked fileentry) ?* ? ))
      'face 'font-lock-type-face)
     "   "
     (propertize
      (format "%-20s" state)
      'face (cond ((eq state 'up-to-date) 'font-lock-builtin-face)
		  ((memq state '(missing conflict)) 'font-lock-warning-face)
1255
		  ((eq state 'edited) 'font-lock-constant-face)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1256 1257 1258 1259 1260
		  (t 'font-lock-variable-name-face))
      'mouse-face 'highlight)
     " "
     (propertize
      (format "%s" filename)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1261 1262 1263
      'face
      (if isdir 'font-lock-comment-delimiter-face 'font-lock-function-name-face)
      'help-echo
1264 1265
      (if isdir
	  "Directory\nVC operations can be applied to it\nmouse-3: Pop-up menu"
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1266
	"File\nmouse-3: Pop-up menu")
1267
      'mouse-face 'highlight
1268
      'keymap vc-dir-filename-mouse-map))))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1269 1270 1271 1272 1273 1274 1275 1276