emacs-lisp/rx.el (rx): Doc fix. (Bug#6537)
[emacs.git] / lisp / vc-dir.el
blob6428e8b9ddb6a7307fa74eb77cad34f7a193b63a
1 ;;; vc-dir.el --- Directory status display under VC
3 ;; Copyright (C) 2007, 2008, 2009, 2010
4 ;; Free Software Foundation, Inc.
6 ;; Author: Dan Nicolaescu <dann@ics.uci.edu>
7 ;; Keywords: tools
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Credits:
26 ;; The original VC directory status implementation was based on dired.
27 ;; This implementation was inspired by PCL-CVS.
28 ;; Many people contributed comments, ideas and code to this
29 ;; implementation. These include:
31 ;; Alexandre Julliard <julliard@winehq.org>
32 ;; Stefan Monnier <monnier@iro.umontreal.ca>
33 ;; Tom Tromey <tromey@redhat.com>
35 ;;; Commentary:
38 ;;; Todo: see vc.el.
40 (require 'vc-hooks)
41 (require 'vc)
42 (require 'tool-bar)
43 (require 'ewoc)
45 ;;; Code:
46 (eval-when-compile
47 (require 'cl))
49 (defcustom vc-dir-mode-hook nil
50 "Normal hook run by `vc-dir-mode'.
51 See `run-hooks'."
52 :type 'hook
53 :group 'vc)
55 ;; Used to store information for the files displayed in the directory buffer.
56 ;; Each item displayed corresponds to one of these defstructs.
57 (defstruct (vc-dir-fileinfo
58 (:copier nil)
59 (:type list) ;So we can use `member' on lists of FIs.
60 (:constructor
61 ;; We could define it as an alias for `list'.
62 vc-dir-create-fileinfo (name state &optional extra marked directory))
63 (:conc-name vc-dir-fileinfo->))
64 name ;Keep it as first, for `member'.
65 state
66 ;; For storing backend specific information.
67 extra
68 marked
69 ;; To keep track of not updated files during a global refresh
70 needs-update
71 ;; To distinguish files and directories.
72 directory)
74 (defvar vc-ewoc nil)
76 (defvar vc-dir-process-buffer nil
77 "The buffer used for the asynchronous call that computes status.")
79 (defvar vc-dir-backend nil
80 "The backend used by the current *vc-dir* buffer.")
82 (defun vc-dir-move-to-goal-column ()
83 ;; Used to keep the cursor on the file name column.
84 (beginning-of-line)
85 (unless (eolp)
86 ;; Must be in sync with vc-default-dir-printer.
87 (forward-char 25)))
89 (defun vc-dir-prepare-status-buffer (bname dir backend &optional create-new)
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 (let* ;; Look for another buffer name BNAME visiting the same directory.
93 ((buf (save-excursion
94 (unless create-new
95 (dolist (buffer vc-dir-buffers)
96 (when (buffer-live-p buffer)
97 (set-buffer buffer)
98 (when (and (derived-mode-p 'vc-dir-mode)
99 (eq vc-dir-backend backend)
100 (string= default-directory dir))
101 (return buffer))))))))
102 (or buf
103 ;; Create a new buffer named BNAME.
104 ;; We pass a filename to create-file-buffer because it is what
105 ;; the function expects, and also what uniquify needs (if active)
106 (with-current-buffer (create-file-buffer (expand-file-name bname dir))
107 (cd dir)
108 (vc-setup-buffer (current-buffer))
109 ;; Reset the vc-parent-buffer-name so that it does not appear
110 ;; in the mode-line.
111 (setq vc-parent-buffer-name nil)
112 (current-buffer)))))
114 (defvar vc-dir-menu-map
115 (let ((map (make-sparse-keymap "VC-dir")))
116 (define-key map [quit]
117 '(menu-item "Quit" quit-window
118 :help "Quit"))
119 (define-key map [kill]
120 '(menu-item "Kill Update Command" vc-dir-kill-dir-status-process
121 :enable (vc-dir-busy)
122 :help "Kill the command that updates the directory buffer"))
123 (define-key map [refresh]
124 '(menu-item "Refresh" revert-buffer
125 :enable (not (vc-dir-busy))
126 :help "Refresh the contents of the directory buffer"))
127 (define-key map [remup]
128 '(menu-item "Hide up-to-date" vc-dir-hide-up-to-date
129 :help "Hide up-to-date items from display"))
130 ;; Movement.
131 (define-key map [sepmv] '("--"))
132 (define-key map [next-line]
133 '(menu-item "Next line" vc-dir-next-line
134 :help "Go to the next line" :keys "n"))
135 (define-key map [previous-line]
136 '(menu-item "Previous line" vc-dir-previous-line
137 :help "Go to the previous line"))
138 ;; Marking.
139 (define-key map [sepmrk] '("--"))
140 (define-key map [unmark-all]
141 '(menu-item "Unmark All" vc-dir-unmark-all-files
142 :help "Unmark all files that are in the same state as the current file\
143 \nWith prefix argument unmark all files"))
144 (define-key map [unmark-previous]
145 '(menu-item "Unmark previous " vc-dir-unmark-file-up
146 :help "Move to the previous line and unmark the file"))
148 (define-key map [mark-all]
149 '(menu-item "Mark All" vc-dir-mark-all-files
150 :help "Mark all files that are in the same state as the current file\
151 \nWith prefix argument mark all files"))
152 (define-key map [unmark]
153 '(menu-item "Unmark" vc-dir-unmark
154 :help "Unmark the current file or all files in the region"))
156 (define-key map [mark]
157 '(menu-item "Mark" vc-dir-mark
158 :help "Mark the current file or all files in the region"))
160 (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 (define-key map [ires]
168 '(menu-item "Isearch Regexp Files..." vc-dir-isearch-regexp
169 :help "Incremental search a regexp in the marked files"))
170 (define-key map [ise]
171 '(menu-item "Isearch Files..." vc-dir-isearch
172 :help "Incremental search a string in the marked files"))
173 (define-key map [open-other]
174 '(menu-item "Open in other window" vc-dir-find-file-other-window
175 :help "Find the file on the current line, in another window"))
176 (define-key map [open]
177 '(menu-item "Open file" vc-dir-find-file
178 :help "Find the file on the current line"))
179 (define-key map [sepvcdet] '("--"))
180 ;; FIXME: This needs a key binding. And maybe a better name
181 ;; ("Insert" like PCL-CVS uses does not sound that great either)...
182 (define-key map [ins]
183 '(menu-item "Show File" vc-dir-show-fileentry
184 :help "Show a file in the VC status listing even though it might be up to date"))
185 (define-key map [annotate]
186 '(menu-item "Annotate" vc-annotate
187 :help "Display the edit history of the current file using colors"))
188 (define-key map [diff]
189 '(menu-item "Compare with Base Version" vc-diff
190 :help "Compare file set with the base version"))
191 (define-key map [log]
192 '(menu-item "Show history" vc-print-log
193 :help "List the change log of the current file set in a window"))
194 ;; VC commands.
195 (define-key map [sepvccmd] '("--"))
196 (define-key map [update]
197 '(menu-item "Update to latest version" vc-update
198 :help "Update the current fileset's files to their tip revisions"))
199 (define-key map [revert]
200 '(menu-item "Revert to base version" vc-revert
201 :help "Revert working copies of the selected fileset to their repository contents."))
202 (define-key map [next-action]
203 ;; FIXME: This really really really needs a better name!
204 ;; And a key binding too.
205 '(menu-item "Check In/Out" vc-next-action
206 :help "Do the next logical version control operation on the current fileset"))
207 (define-key map [register]
208 '(menu-item "Register" vc-register
209 :help "Register file set into the version control system"))
210 map)
211 "Menu for VC dir.")
213 ;; VC backends can use this to add mode-specific menu items to
214 ;; vc-dir-menu-map.
215 (defun vc-dir-menu-map-filter (orig-binding)
216 (when (and (symbolp orig-binding) (fboundp orig-binding))
217 (setq orig-binding (indirect-function orig-binding)))
218 (let ((ext-binding
219 (when (derived-mode-p 'vc-dir-mode)
220 (vc-call-backend vc-dir-backend 'extra-status-menu))))
221 (if (null ext-binding)
222 orig-binding
223 (append orig-binding
224 '("----")
225 ext-binding))))
227 (defvar vc-dir-mode-map
228 (let ((map (make-sparse-keymap)))
229 ;; VC commands
230 (define-key map "v" 'vc-next-action) ;; C-x v v
231 (define-key map "=" 'vc-diff) ;; C-x v =
232 (define-key map "i" 'vc-register) ;; C-x v i
233 (define-key map "+" 'vc-update) ;; C-x v +
234 (define-key map "l" 'vc-print-log) ;; C-x v l
235 ;; More confusing than helpful, probably
236 ;;(define-key map "R" 'vc-revert) ;; u is taken by vc-dir-unmark.
237 ;;(define-key map "A" 'vc-annotate) ;; g is taken by revert-buffer
238 ;; bound by `special-mode'.
239 ;; Marking.
240 (define-key map "m" 'vc-dir-mark)
241 (define-key map "M" 'vc-dir-mark-all-files)
242 (define-key map "u" 'vc-dir-unmark)
243 (define-key map "U" 'vc-dir-unmark-all-files)
244 (define-key map "\C-?" 'vc-dir-unmark-file-up)
245 (define-key map "\M-\C-?" 'vc-dir-unmark-all-files)
246 ;; Movement.
247 (define-key map "n" 'vc-dir-next-line)
248 (define-key map " " 'vc-dir-next-line)
249 (define-key map "\t" 'vc-dir-next-directory)
250 (define-key map "p" 'vc-dir-previous-line)
251 (define-key map [backtab] 'vc-dir-previous-directory)
252 ;;; Rebind paragraph-movement commands.
253 (define-key map "\M-}" 'vc-dir-next-directory)
254 (define-key map "\M-{" 'vc-dir-previous-directory)
255 (define-key map [C-down] 'vc-dir-next-directory)
256 (define-key map [C-up] 'vc-dir-previous-directory)
257 ;; The remainder.
258 (define-key map "f" 'vc-dir-find-file)
259 (define-key map "\C-m" 'vc-dir-find-file)
260 (define-key map "o" 'vc-dir-find-file-other-window)
261 (define-key map "\C-c\C-c" 'vc-dir-kill-dir-status-process)
262 (define-key map [down-mouse-3] 'vc-dir-menu)
263 (define-key map [mouse-2] 'vc-dir-toggle-mark)
264 (define-key map [follow-link] 'mouse-face)
265 (define-key map "x" 'vc-dir-hide-up-to-date)
266 (define-key map "S" 'vc-dir-search) ;; FIXME: Maybe use A like dired?
267 (define-key map "Q" 'vc-dir-query-replace-regexp)
268 (define-key map (kbd "M-s a C-s") 'vc-dir-isearch)
269 (define-key map (kbd "M-s a M-C-s") 'vc-dir-isearch-regexp)
271 ;; Hook up the menu.
272 (define-key map [menu-bar vc-dir-mode]
273 `(menu-item
274 ;; VC backends can use this to add mode-specific menu items to
275 ;; vc-dir-menu-map.
276 "VC-dir" ,vc-dir-menu-map :filter vc-dir-menu-map-filter))
277 map)
278 "Keymap for directory buffer.")
280 (defmacro vc-dir-at-event (event &rest body)
281 "Evaluate BODY with point located at event-start of EVENT.
282 If BODY uses EVENT, it should be a variable,
283 otherwise it will be evaluated twice."
284 (let ((posn (make-symbol "vc-dir-at-event-posn")))
285 `(save-excursion
286 (unless (equal ,event '(tool-bar))
287 (let ((,posn (event-start ,event)))
288 (set-buffer (window-buffer (posn-window ,posn)))
289 (goto-char (posn-point ,posn))))
290 ,@body)))
292 (defun vc-dir-menu (e)
293 "Popup the VC dir menu."
294 (interactive "e")
295 (vc-dir-at-event e (popup-menu vc-dir-menu-map e)))
297 (defvar vc-dir-tool-bar-map
298 (let ((map (make-sparse-keymap)))
299 (tool-bar-local-item-from-menu 'vc-dir-find-file "open"
300 map vc-dir-mode-map)
301 (tool-bar-local-item "bookmark_add"
302 'vc-dir-toggle-mark 'vc-dir-toggle-mark map
303 :help "Toggle mark on current item")
304 (tool-bar-local-item-from-menu 'vc-dir-previous-line "left-arrow"
305 map vc-dir-mode-map
306 :rtl "right-arrow")
307 (tool-bar-local-item-from-menu 'vc-dir-next-line "right-arrow"
308 map vc-dir-mode-map
309 :rtl "left-arrow")
310 (tool-bar-local-item-from-menu 'vc-print-log "info"
311 map vc-dir-mode-map)
312 (tool-bar-local-item-from-menu 'revert-buffer "refresh"
313 map vc-dir-mode-map)
314 (tool-bar-local-item-from-menu 'nonincremental-search-forward
315 "search" map)
316 (tool-bar-local-item-from-menu 'vc-dir-query-replace-regexp
317 "search-replace" map vc-dir-mode-map)
318 (tool-bar-local-item-from-menu 'vc-dir-kill-dir-status-process "cancel"
319 map vc-dir-mode-map)
320 (tool-bar-local-item-from-menu 'quit-window "exit"
321 map vc-dir-mode-map)
322 map))
324 (defun vc-dir-node-directory (node)
325 ;; Compute the directory for NODE.
326 ;; If it's a directory node, get it from the node.
327 (let ((data (ewoc-data node)))
328 (or (vc-dir-fileinfo->directory data)
329 ;; Otherwise compute it from the file name.
330 (file-name-directory
331 (directory-file-name
332 (expand-file-name
333 (vc-dir-fileinfo->name data)))))))
335 (defun vc-dir-update (entries buffer &optional noinsert)
336 "Update BUFFER's ewoc from the list of ENTRIES.
337 If NOINSERT, ignore elements on ENTRIES which are not in the ewoc."
338 ;; Add ENTRIES to the vc-dir buffer BUFFER.
339 (with-current-buffer buffer
340 ;; Insert the entries sorted by name into the ewoc.
341 ;; We assume the ewoc is sorted too, which should be the
342 ;; case if we always add entries with vc-dir-update.
343 (setq entries
344 ;; Sort: first files and then subdirectories.
345 ;; XXX: this is VERY inefficient, it computes the directory
346 ;; names too many times
347 (sort entries
348 (lambda (entry1 entry2)
349 (let ((dir1 (file-name-directory
350 (directory-file-name (expand-file-name (car entry1)))))
351 (dir2 (file-name-directory
352 (directory-file-name (expand-file-name (car entry2))))))
353 (cond
354 ((string< dir1 dir2) t)
355 ((not (string= dir1 dir2)) nil)
356 ((string< (car entry1) (car entry2))))))))
357 ;; Insert directory entries in the right places.
358 (let ((entry (car entries))
359 (node (ewoc-nth vc-ewoc 0))
360 (to-remove nil)
361 (dotname (file-relative-name default-directory)))
362 ;; Insert . if it is not present.
363 (unless node
364 (ewoc-enter-last
365 vc-ewoc (vc-dir-create-fileinfo
366 dotname nil nil nil default-directory))
367 (setq node (ewoc-nth vc-ewoc 0)))
369 (while (and entry node)
370 (let* ((entryfile (car entry))
371 (entrydir (file-name-directory (directory-file-name
372 (expand-file-name entryfile))))
373 (nodedir (vc-dir-node-directory node)))
374 (cond
375 ;; First try to find the directory.
376 ((string-lessp nodedir entrydir)
377 (setq node (ewoc-next vc-ewoc node)))
378 ((string-equal nodedir entrydir)
379 ;; Found the directory, find the place for the file name.
380 (let ((nodefile (vc-dir-fileinfo->name (ewoc-data node))))
381 (cond
382 ((string= nodefile dotname)
383 (setq node (ewoc-next vc-ewoc node)))
384 ((string-lessp nodefile entryfile)
385 (setq node (ewoc-next vc-ewoc node)))
386 ((string-equal nodefile entryfile)
387 (if (nth 1 entry)
388 (progn
389 (setf (vc-dir-fileinfo->state (ewoc-data node)) (nth 1 entry))
390 (setf (vc-dir-fileinfo->extra (ewoc-data node)) (nth 2 entry))
391 (setf (vc-dir-fileinfo->needs-update (ewoc-data node)) nil)
392 (ewoc-invalidate vc-ewoc node))
393 ;; If the state is nil, the file does not exist
394 ;; anymore, so remember the entry so we can remove
395 ;; it after we are done inserting all ENTRIES.
396 (push node to-remove))
397 (setq entries (cdr entries))
398 (setq entry (car entries))
399 (setq node (ewoc-next vc-ewoc node)))
401 (ewoc-enter-before vc-ewoc node
402 (apply 'vc-dir-create-fileinfo entry))
403 (setq entries (cdr entries))
404 (setq entry (car entries))))))
406 ;; We might need to insert a directory node if the
407 ;; previous node was in a different directory.
408 (let* ((rd (file-relative-name entrydir))
409 (prev-node (ewoc-prev vc-ewoc node))
410 (prev-dir (vc-dir-node-directory prev-node)))
411 (unless (string-equal entrydir prev-dir)
412 (ewoc-enter-before
413 vc-ewoc node (vc-dir-create-fileinfo rd nil nil nil entrydir))))
414 ;; Now insert the node itself.
415 (ewoc-enter-before vc-ewoc node
416 (apply 'vc-dir-create-fileinfo entry))
417 (setq entries (cdr entries) entry (car entries))))))
418 ;; We're past the last node, all remaining entries go to the end.
419 (unless (or node noinsert)
420 (let ((lastdir (vc-dir-node-directory (ewoc-nth vc-ewoc -1))))
421 (dolist (entry entries)
422 (let ((entrydir (file-name-directory
423 (directory-file-name (expand-file-name (car entry))))))
424 ;; Insert a directory node if needed.
425 (unless (string-equal lastdir entrydir)
426 (setq lastdir entrydir)
427 (let ((rd (file-relative-name entrydir)))
428 (ewoc-enter-last
429 vc-ewoc (vc-dir-create-fileinfo rd nil nil nil entrydir))))
430 ;; Now insert the node itself.
431 (ewoc-enter-last vc-ewoc
432 (apply 'vc-dir-create-fileinfo entry))))))
433 (when to-remove
434 (let ((inhibit-read-only t))
435 (apply 'ewoc-delete vc-ewoc (nreverse to-remove)))))))
437 (defun vc-dir-busy ()
438 (and (buffer-live-p vc-dir-process-buffer)
439 (get-buffer-process vc-dir-process-buffer)))
441 (defun vc-dir-kill-dir-status-process ()
442 "Kill the temporary buffer and associated process."
443 (interactive)
444 (when (buffer-live-p vc-dir-process-buffer)
445 (let ((proc (get-buffer-process vc-dir-process-buffer)))
446 (when proc (delete-process proc))
447 (setq vc-dir-process-buffer nil)
448 (setq mode-line-process nil))))
450 (defun vc-dir-kill-query ()
451 ;; Make sure that when the status buffer is killed the update
452 ;; process running in background is also killed.
453 (if (vc-dir-busy)
454 (when (y-or-n-p "Status update process running, really kill status buffer? ")
455 (vc-dir-kill-dir-status-process)
459 (defun vc-dir-next-line (arg)
460 "Go to the next line.
461 If a prefix argument is given, move by that many lines."
462 (interactive "p")
463 (with-no-warnings
464 (ewoc-goto-next vc-ewoc arg)
465 (vc-dir-move-to-goal-column)))
467 (defun vc-dir-previous-line (arg)
468 "Go to the previous line.
469 If a prefix argument is given, move by that many lines."
470 (interactive "p")
471 (ewoc-goto-prev vc-ewoc arg)
472 (vc-dir-move-to-goal-column))
474 (defun vc-dir-next-directory ()
475 "Go to the next directory."
476 (interactive)
477 (let ((orig (point)))
479 (catch 'foundit
480 (while t
481 (let* ((next (ewoc-next vc-ewoc (ewoc-locate vc-ewoc))))
482 (cond ((not next)
483 (throw 'foundit t))
485 (progn
486 (ewoc-goto-node vc-ewoc next)
487 (vc-dir-move-to-goal-column)
488 (if (vc-dir-fileinfo->directory (ewoc-data next))
489 (throw 'foundit nil))))))))
490 (goto-char orig))))
492 (defun vc-dir-previous-directory ()
493 "Go to the previous directory."
494 (interactive)
495 (let ((orig (point)))
497 (catch 'foundit
498 (while t
499 (let* ((prev (ewoc-prev vc-ewoc (ewoc-locate vc-ewoc))))
500 (cond ((not prev)
501 (throw 'foundit t))
503 (progn
504 (ewoc-goto-node vc-ewoc prev)
505 (vc-dir-move-to-goal-column)
506 (if (vc-dir-fileinfo->directory (ewoc-data prev))
507 (throw 'foundit nil))))))))
508 (goto-char orig))))
510 (defun vc-dir-mark-unmark (mark-unmark-function)
511 (if (use-region-p)
512 (let ((firstl (line-number-at-pos (region-beginning)))
513 (lastl (line-number-at-pos (region-end))))
514 (save-excursion
515 (goto-char (region-beginning))
516 (while (<= (line-number-at-pos) lastl)
517 (funcall mark-unmark-function))))
518 (funcall mark-unmark-function)))
520 (defun vc-dir-parent-marked-p (arg)
521 ;; Return nil if none of the parent directories of arg is marked.
522 (let* ((argdir (vc-dir-node-directory arg))
523 (arglen (length argdir))
524 (crt arg)
525 data dir)
526 ;; Go through the predecessors, checking if any directory that is
527 ;; a parent is marked.
528 (while (setq crt (ewoc-prev vc-ewoc crt))
529 (setq data (ewoc-data crt))
530 (setq dir (vc-dir-node-directory crt))
531 (when (and (vc-dir-fileinfo->directory data)
532 (vc-string-prefix-p dir argdir))
533 (when (vc-dir-fileinfo->marked data)
534 (error "Cannot mark `%s', parent directory `%s' marked"
535 (vc-dir-fileinfo->name (ewoc-data arg))
536 (vc-dir-fileinfo->name data)))))
537 nil))
539 (defun vc-dir-children-marked-p (arg)
540 ;; Return nil if none of the children of arg is marked.
541 (let* ((argdir-re (concat "\\`" (regexp-quote (vc-dir-node-directory arg))))
542 (is-child t)
543 (crt arg)
544 data dir)
545 (while (and is-child (setq crt (ewoc-next vc-ewoc crt)))
546 (setq data (ewoc-data crt))
547 (setq dir (vc-dir-node-directory crt))
548 (if (string-match argdir-re dir)
549 (when (vc-dir-fileinfo->marked data)
550 (error "Cannot mark `%s', child `%s' marked"
551 (vc-dir-fileinfo->name (ewoc-data arg))
552 (vc-dir-fileinfo->name data)))
553 ;; We are done, we got to an entry that is not a child of `arg'.
554 (setq is-child nil)))
555 nil))
557 (defun vc-dir-mark-file (&optional arg)
558 ;; Mark ARG or the current file and move to the next line.
559 (let* ((crt (or arg (ewoc-locate vc-ewoc)))
560 (file (ewoc-data crt))
561 (isdir (vc-dir-fileinfo->directory file)))
562 (when (or (and isdir (not (vc-dir-children-marked-p crt)))
563 (and (not isdir) (not (vc-dir-parent-marked-p crt))))
564 (setf (vc-dir-fileinfo->marked file) t)
565 (ewoc-invalidate vc-ewoc crt)
566 (unless (or arg (mouse-event-p last-command-event))
567 (vc-dir-next-line 1)))))
569 (defun vc-dir-mark ()
570 "Mark the current file or all files in the region.
571 If the region is active, mark all the files in the region.
572 Otherwise mark the file on the current line and move to the next
573 line."
574 (interactive)
575 (vc-dir-mark-unmark 'vc-dir-mark-file))
577 (defun vc-dir-mark-all-files (arg)
578 "Mark all files with the same state as the current one.
579 With a prefix argument mark all files.
580 If the current entry is a directory, mark all child files.
582 The commands operate on files that are on the same state.
583 This command is intended to make it easy to select all files that
584 share the same state."
585 (interactive "P")
586 (if arg
587 ;; Mark all files.
588 (progn
589 ;; First check that no directory is marked, we can't mark
590 ;; files in that case.
591 (ewoc-map
592 (lambda (filearg)
593 (when (and (vc-dir-fileinfo->directory filearg)
594 (vc-dir-fileinfo->marked filearg))
595 (error "Cannot mark all files, directory `%s' marked"
596 (vc-dir-fileinfo->name filearg))))
597 vc-ewoc)
598 (ewoc-map
599 (lambda (filearg)
600 (unless (vc-dir-fileinfo->marked filearg)
601 (setf (vc-dir-fileinfo->marked filearg) t)
603 vc-ewoc))
604 (let ((data (ewoc-data (ewoc-locate vc-ewoc))))
605 (if (vc-dir-fileinfo->directory data)
606 ;; It's a directory, mark child files.
607 (let ((crt (ewoc-locate vc-ewoc)))
608 (unless (vc-dir-children-marked-p crt)
609 (while (setq crt (ewoc-next vc-ewoc crt))
610 (let ((crt-data (ewoc-data crt)))
611 (unless (vc-dir-fileinfo->directory crt-data)
612 (setf (vc-dir-fileinfo->marked crt-data) t)
613 (ewoc-invalidate vc-ewoc crt))))))
614 ;; It's a file
615 (let ((state (vc-dir-fileinfo->state data))
616 (crt (ewoc-nth vc-ewoc 0)))
617 (while crt
618 (let ((crt-data (ewoc-data crt)))
619 (when (and (not (vc-dir-fileinfo->marked crt-data))
620 (eq (vc-dir-fileinfo->state crt-data) state)
621 (not (vc-dir-fileinfo->directory crt-data)))
622 (vc-dir-mark-file crt)))
623 (setq crt (ewoc-next vc-ewoc crt))))))))
625 (defun vc-dir-unmark-file ()
626 ;; Unmark the current file and move to the next line.
627 (let* ((crt (ewoc-locate vc-ewoc))
628 (file (ewoc-data crt)))
629 (setf (vc-dir-fileinfo->marked file) nil)
630 (ewoc-invalidate vc-ewoc crt)
631 (unless (mouse-event-p last-command-event)
632 (vc-dir-next-line 1))))
634 (defun vc-dir-unmark ()
635 "Unmark the current file or all files in the region.
636 If the region is active, unmark all the files in the region.
637 Otherwise mark the file on the current line and move to the next
638 line."
639 (interactive)
640 (vc-dir-mark-unmark 'vc-dir-unmark-file))
642 (defun vc-dir-unmark-file-up ()
643 "Move to the previous line and unmark the file."
644 (interactive)
645 ;; If we're on the first line, we won't move up, but we will still
646 ;; remove the mark. This seems a bit odd but it is what buffer-menu
647 ;; does.
648 (let* ((prev (ewoc-goto-prev vc-ewoc 1))
649 (file (ewoc-data prev)))
650 (setf (vc-dir-fileinfo->marked file) nil)
651 (ewoc-invalidate vc-ewoc prev)
652 (vc-dir-move-to-goal-column)))
654 (defun vc-dir-unmark-all-files (arg)
655 "Unmark all files with the same state as the current one.
656 With a prefix argument unmark all files.
657 If the current entry is a directory, unmark all the child files.
659 The commands operate on files that are on the same state.
660 This command is intended to make it easy to deselect all files
661 that share the same state."
662 (interactive "P")
663 (if arg
664 (ewoc-map
665 (lambda (filearg)
666 (when (vc-dir-fileinfo->marked filearg)
667 (setf (vc-dir-fileinfo->marked filearg) nil)
669 vc-ewoc)
670 (let* ((crt (ewoc-locate vc-ewoc))
671 (data (ewoc-data crt)))
672 (if (vc-dir-fileinfo->directory data)
673 ;; It's a directory, unmark child files.
674 (while (setq crt (ewoc-next vc-ewoc crt))
675 (let ((crt-data (ewoc-data crt)))
676 (unless (vc-dir-fileinfo->directory crt-data)
677 (setf (vc-dir-fileinfo->marked crt-data) nil)
678 (ewoc-invalidate vc-ewoc crt))))
679 ;; It's a file
680 (let ((crt-state (vc-dir-fileinfo->state (ewoc-data crt))))
681 (ewoc-map
682 (lambda (filearg)
683 (when (and (vc-dir-fileinfo->marked filearg)
684 (eq (vc-dir-fileinfo->state filearg) crt-state))
685 (setf (vc-dir-fileinfo->marked filearg) nil)
687 vc-ewoc))))))
689 (defun vc-dir-toggle-mark-file ()
690 (let* ((crt (ewoc-locate vc-ewoc))
691 (file (ewoc-data crt)))
692 (if (vc-dir-fileinfo->marked file)
693 (vc-dir-unmark-file)
694 (vc-dir-mark-file))))
696 (defun vc-dir-toggle-mark (e)
697 (interactive "e")
698 (vc-dir-at-event e (vc-dir-mark-unmark 'vc-dir-toggle-mark-file)))
700 (defun vc-dir-delete-file ()
701 "Delete the marked files, or the current file if no marks."
702 (interactive)
703 (mapc 'vc-delete-file (or (vc-dir-marked-files)
704 (list (vc-dir-current-file)))))
706 (defun vc-dir-find-file ()
707 "Find the file on the current line."
708 (interactive)
709 (find-file (vc-dir-current-file)))
711 (defun vc-dir-find-file-other-window (&optional event)
712 "Find the file on the current line, in another window."
713 (interactive (list last-nonmenu-event))
714 (if event (posn-set-point (event-end event)))
715 (find-file-other-window (vc-dir-current-file)))
717 (defun vc-dir-isearch ()
718 "Search for a string through all marked buffers using Isearch."
719 (interactive)
720 (multi-isearch-files
721 (mapcar 'car (vc-dir-marked-only-files-and-states))))
723 (defun vc-dir-isearch-regexp ()
724 "Search for a regexp through all marked buffers using Isearch."
725 (interactive)
726 (multi-isearch-files-regexp
727 (mapcar 'car (vc-dir-marked-only-files-and-states))))
729 (defun vc-dir-search (regexp)
730 "Search through all marked files for a match for REGEXP.
731 For marked directories, use the files displayed from those directories.
732 Stops when a match is found.
733 To continue searching for next match, use command \\[tags-loop-continue]."
734 (interactive "sSearch marked files (regexp): ")
735 (tags-search regexp '(mapcar 'car (vc-dir-marked-only-files-and-states))))
737 (defun vc-dir-query-replace-regexp (from to &optional delimited)
738 "Do `query-replace-regexp' of FROM with TO, on all marked files.
739 For marked directories, use the files displayed from those directories.
740 If a directory is marked, then use the files displayed for that directory.
741 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
742 If you exit (\\[keyboard-quit], RET or q), you can resume the query replace
743 with the command \\[tags-loop-continue]."
744 ;; FIXME: this is almost a copy of `dired-do-replace-regexp'. This
745 ;; should probably be made generic and used in both places instead of
746 ;; duplicating it here.
747 (interactive
748 (let ((common
749 (query-replace-read-args
750 "Query replace regexp in marked files" t t)))
751 (list (nth 0 common) (nth 1 common) (nth 2 common))))
752 (dolist (file (mapcar 'car (vc-dir-marked-only-files-and-states)))
753 (let ((buffer (get-file-buffer file)))
754 (if (and buffer (with-current-buffer buffer
755 buffer-read-only))
756 (error "File `%s' is visited read-only" file))))
757 (tags-query-replace from to delimited
758 '(mapcar 'car (vc-dir-marked-only-files-and-states))))
760 (defun vc-dir-current-file ()
761 (let ((node (ewoc-locate vc-ewoc)))
762 (unless node
763 (error "No file available"))
764 (expand-file-name (vc-dir-fileinfo->name (ewoc-data node)))))
766 (defun vc-dir-marked-files ()
767 "Return the list of marked files."
768 (mapcar
769 (lambda (elem) (expand-file-name (vc-dir-fileinfo->name elem)))
770 (ewoc-collect vc-ewoc 'vc-dir-fileinfo->marked)))
772 (defun vc-dir-marked-only-files-and-states ()
773 "Return the list of conses (FILE . STATE) for the marked files.
774 For marked directories return the corresponding conses for the
775 child files."
776 (let ((crt (ewoc-nth vc-ewoc 0))
777 result)
778 (while crt
779 (let ((crt-data (ewoc-data crt)))
780 (if (vc-dir-fileinfo->marked crt-data)
781 ;; FIXME: use vc-dir-child-files-and-states here instead of duplicating it.
782 (if (vc-dir-fileinfo->directory crt-data)
783 (let* ((dir (vc-dir-fileinfo->directory crt-data))
784 (dirlen (length dir))
785 data)
786 (while
787 (and (setq crt (ewoc-next vc-ewoc crt))
788 (vc-string-prefix-p dir
789 (progn
790 (setq data (ewoc-data crt))
791 (vc-dir-node-directory crt))))
792 (unless (vc-dir-fileinfo->directory data)
793 (push
794 (cons (expand-file-name (vc-dir-fileinfo->name data))
795 (vc-dir-fileinfo->state data))
796 result))))
797 (push (cons (expand-file-name (vc-dir-fileinfo->name crt-data))
798 (vc-dir-fileinfo->state crt-data))
799 result)
800 (setq crt (ewoc-next vc-ewoc crt)))
801 (setq crt (ewoc-next vc-ewoc crt)))))
802 (nreverse result)))
804 (defun vc-dir-child-files-and-states ()
805 "Return the list of conses (FILE . STATE) for child files of the current entry if it's a directory.
806 If it is a file, return the corresponding cons for the file itself."
807 (let* ((crt (ewoc-locate vc-ewoc))
808 (crt-data (ewoc-data crt))
809 result)
810 (if (vc-dir-fileinfo->directory crt-data)
811 (let* ((dir (vc-dir-fileinfo->directory crt-data))
812 (dirlen (length dir))
813 data)
814 (while
815 (and (setq crt (ewoc-next vc-ewoc crt))
816 (vc-string-prefix-p dir (progn
817 (setq data (ewoc-data crt))
818 (vc-dir-node-directory crt))))
819 (unless (vc-dir-fileinfo->directory data)
820 (push
821 (cons (expand-file-name (vc-dir-fileinfo->name data))
822 (vc-dir-fileinfo->state data))
823 result))))
824 (push
825 (cons (expand-file-name (vc-dir-fileinfo->name crt-data))
826 (vc-dir-fileinfo->state crt-data)) result))
827 (nreverse result)))
829 (defun vc-dir-recompute-file-state (fname def-dir)
830 (let* ((file-short (file-relative-name fname def-dir))
831 (remove-me-when-CVS-works
832 (when (eq vc-dir-backend 'CVS)
833 ;; FIXME: Warning: UGLY HACK. The CVS backend caches the state
834 ;; info, this forces the backend to update it.
835 (vc-call-backend vc-dir-backend 'registered fname)))
836 (state (vc-call-backend vc-dir-backend 'state fname))
837 (extra (vc-call-backend vc-dir-backend
838 'status-fileinfo-extra fname)))
839 (list file-short state extra)))
841 (defun vc-dir-find-child-files (dirname)
842 ;; Give a DIRNAME string return the list of all child files shown in
843 ;; the current *vc-dir* buffer.
844 (let ((crt (ewoc-nth vc-ewoc 0))
845 children
846 dname)
847 ;; Find DIR
848 (while (and crt (not (vc-string-prefix-p
849 dirname (vc-dir-node-directory crt))))
850 (setq crt (ewoc-next vc-ewoc crt)))
851 (while (and crt (vc-string-prefix-p
852 dirname
853 (setq dname (vc-dir-node-directory crt))))
854 (let ((data (ewoc-data crt)))
855 (unless (vc-dir-fileinfo->directory data)
856 (push (expand-file-name (vc-dir-fileinfo->name data)) children)))
857 (setq crt (ewoc-next vc-ewoc crt)))
858 children))
860 (defun vc-dir-resync-directory-files (dirname)
861 ;; Update the entries for all the child files of DIRNAME shown in
862 ;; the current *vc-dir* buffer.
863 (let ((files (vc-dir-find-child-files dirname))
864 (ddir default-directory)
865 fileentries)
866 (when files
867 (dolist (crt files)
868 (push (vc-dir-recompute-file-state crt ddir)
869 fileentries))
870 (vc-dir-update fileentries (current-buffer)))))
872 (defun vc-dir-resynch-file (&optional fname)
873 "Update the entries for FNAME in any directory buffers that list it."
874 (let ((file (or fname (expand-file-name buffer-file-name)))
875 (drop '()))
876 (save-current-buffer
877 ;; look for a vc-dir buffer that might show this file.
878 (dolist (status-buf vc-dir-buffers)
879 (if (not (buffer-live-p status-buf))
880 (push status-buf drop)
881 (set-buffer status-buf)
882 (if (not (derived-mode-p 'vc-dir-mode))
883 (push status-buf drop)
884 (let ((ddir default-directory))
885 (when (vc-string-prefix-p ddir file)
886 (if (file-directory-p file)
887 (progn
888 (vc-dir-resync-directory-files file)
889 (ewoc-set-hf vc-ewoc
890 (vc-dir-headers vc-dir-backend default-directory) ""))
891 (let ((state (vc-dir-recompute-file-state file ddir)))
892 (vc-dir-update
893 (list state)
894 status-buf (eq (cadr state) 'up-to-date))))))))))
895 ;; Remove out-of-date entries from vc-dir-buffers.
896 (dolist (b drop) (setq vc-dir-buffers (delq b vc-dir-buffers)))))
898 (defvar use-vc-backend) ;; dynamically bound
900 (define-derived-mode vc-dir-mode special-mode "VC dir"
901 "Major mode for VC directory buffers.
902 Marking/Unmarking key bindings and actions:
903 m - mark a file/directory
904 - if the region is active, mark all the files in region.
905 Restrictions: - a file cannot be marked if any parent directory is marked
906 - a directory cannot be marked if any child file or
907 directory is marked
908 u - unmark a file/directory
909 - if the region is active, unmark all the files in region.
910 M - if the cursor is on a file: mark all the files with the same state as
911 the current file
912 - if the cursor is on a directory: mark all child files
913 - with a prefix argument: mark all files
914 U - if the cursor is on a file: unmark all the files with the same state
915 as the current file
916 - if the cursor is on a directory: unmark all child files
917 - with a prefix argument: unmark all files
918 mouse-2 - toggles the mark state
920 VC commands
921 VC commands in the `C-x v' prefix can be used.
922 VC commands act on the marked entries. If nothing is marked, VC
923 commands act on the current entry.
925 Search & Replace
926 S - searches the marked files
927 Q - does a query replace on the marked files
928 M-s a C-s - does an isearch on the marked files
929 M-s a C-M-s - does a regexp isearch on the marked files
930 If nothing is marked, these commands act on the current entry.
931 When a directory is current or marked, the Search & Replace
932 commands act on the child files of that directory that are displayed in
933 the *vc-dir* buffer.
935 \\{vc-dir-mode-map}"
936 (set (make-local-variable 'vc-dir-backend) use-vc-backend)
937 (setq buffer-read-only t)
938 (when (boundp 'tool-bar-map)
939 (set (make-local-variable 'tool-bar-map) vc-dir-tool-bar-map))
940 (let ((buffer-read-only nil))
941 (erase-buffer)
942 (set (make-local-variable 'vc-dir-process-buffer) nil)
943 (set (make-local-variable 'vc-ewoc) (ewoc-create #'vc-dir-printer))
944 (set (make-local-variable 'revert-buffer-function)
945 'vc-dir-revert-buffer-function)
946 (setq list-buffers-directory (expand-file-name "*vc-dir*" default-directory))
947 (add-to-list 'vc-dir-buffers (current-buffer))
948 ;; Make sure that if the directory buffer is killed, the update
949 ;; process running in the background is also killed.
950 (add-hook 'kill-buffer-query-functions 'vc-dir-kill-query nil t)
951 (vc-dir-refresh)))
953 (defun vc-dir-headers (backend dir)
954 "Display the headers in the *VC dir* buffer.
955 It calls the `dir-extra-headers' backend method to display backend
956 specific headers."
957 (concat
958 ;; First layout the common headers.
959 (propertize "VC backend : " 'face 'font-lock-type-face)
960 (propertize (format "%s\n" backend) 'face 'font-lock-variable-name-face)
961 (propertize "Working dir: " 'face 'font-lock-type-face)
962 (propertize (format "%s\n" dir) 'face 'font-lock-variable-name-face)
963 ;; Then the backend specific ones.
964 (vc-call-backend backend 'dir-extra-headers dir)
965 "\n"))
967 (defun vc-dir-refresh-files (files default-state)
968 "Refresh some files in the *VC-dir* buffer."
969 (let ((def-dir default-directory)
970 (backend vc-dir-backend))
971 (vc-set-mode-line-busy-indicator)
972 ;; Call the `dir-status-file' backend function.
973 ;; `dir-status-file' is supposed to be asynchronous.
974 ;; It should compute the results, and then call the function
975 ;; passed as an argument in order to update the vc-dir buffer
976 ;; with the results.
977 (unless (buffer-live-p vc-dir-process-buffer)
978 (setq vc-dir-process-buffer
979 (generate-new-buffer (format " *VC-%s* tmp status" backend))))
980 (lexical-let ((buffer (current-buffer)))
981 (with-current-buffer vc-dir-process-buffer
982 (cd def-dir)
983 (erase-buffer)
984 (vc-call-backend
985 backend 'dir-status-files def-dir files default-state
986 (lambda (entries &optional more-to-come)
987 ;; ENTRIES is a list of (FILE VC_STATE EXTRA) items.
988 ;; If MORE-TO-COME is true, then more updates will come from
989 ;; the asynchronous process.
990 (with-current-buffer buffer
991 (vc-dir-update entries buffer)
992 (unless more-to-come
993 (setq mode-line-process nil)
994 ;; Remove the ones that haven't been updated at all.
995 ;; Those not-updated are those whose state is nil because the
996 ;; file/dir doesn't exist and isn't versioned.
997 (ewoc-filter vc-ewoc
998 (lambda (info)
999 ;; The state for directory entries might
1000 ;; have been changed to 'up-to-date,
1001 ;; reset it, othewise it will be removed when doing 'x'
1002 ;; next time.
1003 ;; FIXME: There should be a more elegant way to do this.
1004 (when (and (vc-dir-fileinfo->directory info)
1005 (eq (vc-dir-fileinfo->state info)
1006 'up-to-date))
1007 (setf (vc-dir-fileinfo->state info) nil))
1009 (not (vc-dir-fileinfo->needs-update info))))))))))))
1011 (defun vc-dir-revert-buffer-function (&optional ignore-auto noconfirm)
1012 (vc-dir-refresh))
1014 (defun vc-dir-refresh ()
1015 "Refresh the contents of the *VC-dir* buffer.
1016 Throw an error if another update process is in progress."
1017 (interactive)
1018 (if (vc-dir-busy)
1019 (error "Another update process is in progress, cannot run two at a time")
1020 (let ((def-dir default-directory)
1021 (backend vc-dir-backend))
1022 (vc-set-mode-line-busy-indicator)
1023 ;; Call the `dir-status' backend function.
1024 ;; `dir-status' is supposed to be asynchronous.
1025 ;; It should compute the results, and then call the function
1026 ;; passed as an argument in order to update the vc-dir buffer
1027 ;; with the results.
1029 ;; Create a buffer that can be used by `dir-status' and call
1030 ;; `dir-status' with this buffer as the current buffer. Use
1031 ;; `vc-dir-process-buffer' to remember this buffer, so that
1032 ;; it can be used later to kill the update process in case it
1033 ;; takes too long.
1034 (unless (buffer-live-p vc-dir-process-buffer)
1035 (setq vc-dir-process-buffer
1036 (generate-new-buffer (format " *VC-%s* tmp status" backend))))
1037 ;; set the needs-update flag on all non-directory entries
1038 (ewoc-map (lambda (info)
1039 (unless (vc-dir-fileinfo->directory info)
1040 (setf (vc-dir-fileinfo->needs-update info) t) nil))
1041 vc-ewoc)
1042 (lexical-let ((buffer (current-buffer)))
1043 (with-current-buffer vc-dir-process-buffer
1044 (cd def-dir)
1045 (erase-buffer)
1046 (vc-call-backend
1047 backend 'dir-status def-dir
1048 (lambda (entries &optional more-to-come)
1049 ;; ENTRIES is a list of (FILE VC_STATE EXTRA) items.
1050 ;; If MORE-TO-COME is true, then more updates will come from
1051 ;; the asynchronous process.
1052 (with-current-buffer buffer
1053 (vc-dir-update entries buffer)
1054 (unless more-to-come
1055 (let ((remaining
1056 (ewoc-collect
1057 vc-ewoc 'vc-dir-fileinfo->needs-update)))
1058 (if remaining
1059 (vc-dir-refresh-files
1060 (mapcar 'vc-dir-fileinfo->name remaining)
1061 'up-to-date)
1062 (setq mode-line-process nil)))))))))
1063 (ewoc-set-hf vc-ewoc (vc-dir-headers backend def-dir) ""))))
1065 (defun vc-dir-show-fileentry (file)
1066 "Insert an entry for a specific file into the current *VC-dir* listing.
1067 This is typically used if the file is up-to-date (or has been added
1068 outside of VC) and one wants to do some operation on it."
1069 (interactive "fShow file: ")
1070 (vc-dir-update (list (list (file-relative-name file) (vc-state file))) (current-buffer)))
1072 (defun vc-dir-hide-up-to-date ()
1073 "Hide up-to-date items from display."
1074 (interactive)
1075 (let ((crt (ewoc-nth vc-ewoc -1))
1076 (first (ewoc-nth vc-ewoc 0)))
1077 ;; Go over from the last item to the first and remove the
1078 ;; up-to-date files and directories with no child files.
1079 (while (not (eq crt first))
1080 (let* ((data (ewoc-data crt))
1081 (dir (vc-dir-fileinfo->directory data))
1082 (next (ewoc-next vc-ewoc crt))
1083 (prev (ewoc-prev vc-ewoc crt))
1084 ;; ewoc-delete does not work without this...
1085 (inhibit-read-only t))
1086 (when (or
1087 ;; Remove directories with no child files.
1088 (and dir
1090 ;; Nothing follows this directory.
1091 (not next)
1092 ;; Next item is a directory.
1093 (vc-dir-fileinfo->directory (ewoc-data next))))
1094 ;; Remove files in the up-to-date state.
1095 (eq (vc-dir-fileinfo->state data) 'up-to-date))
1096 (ewoc-delete vc-ewoc crt))
1097 (setq crt prev)))))
1099 (defun vc-dir-printer (fileentry)
1100 (vc-call-backend vc-dir-backend 'dir-printer fileentry))
1102 (defun vc-dir-deduce-fileset (&optional state-model-only-files)
1103 (let ((marked (vc-dir-marked-files))
1104 files
1105 only-files-list
1106 state
1107 model)
1108 (if marked
1109 (progn
1110 (setq files marked)
1111 (when state-model-only-files
1112 (setq only-files-list (vc-dir-marked-only-files-and-states))))
1113 (let ((crt (vc-dir-current-file)))
1114 (setq files (list crt))
1115 (when state-model-only-files
1116 (setq only-files-list (vc-dir-child-files-and-states)))))
1118 (when state-model-only-files
1119 (setq state (cdar only-files-list))
1120 ;; Check that all files are in a consistent state, since we use that
1121 ;; state to decide which operation to perform.
1122 (dolist (crt (cdr only-files-list))
1123 (unless (vc-compatible-state (cdr crt) state)
1124 (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"
1125 (car crt) (cdr crt) (caar only-files-list) state)))
1126 (setq only-files-list (mapcar 'car only-files-list))
1127 (when (and state (not (eq state 'unregistered)))
1128 (setq model (vc-checkout-model vc-dir-backend only-files-list))))
1129 (list vc-dir-backend files only-files-list state model)))
1131 ;;;###autoload
1132 (defun vc-dir (dir &optional backend)
1133 "Show the VC status for \"interesting\" files in and below DIR.
1134 This allows you to mark files and perform VC operations on them.
1135 The list omits files which are up to date, with no changes in your copy
1136 or the repository, if there is nothing in particular to say about them.
1138 Preparing the list of file status takes time; when the buffer
1139 first appears, it has only the first few lines of summary information.
1140 The file lines appear later.
1142 Optional second argument BACKEND specifies the VC backend to use.
1143 Interactively, a prefix argument means to ask for the backend.
1145 These are the commands available for use in the file status buffer:
1147 \\{vc-dir-mode-map}"
1149 (interactive
1150 (list
1151 ;; When you hit C-x v d in a visited VC file,
1152 ;; the *vc-dir* buffer visits the directory under its truename;
1153 ;; therefore it makes sense to always do that.
1154 ;; Otherwise if you do C-x v d -> C-x C-f -> C-c v d
1155 ;; you may get a new *vc-dir* buffer, different from the original
1156 (file-truename (read-file-name "VC status for directory: "
1157 default-directory default-directory t
1158 nil #'file-directory-p))
1159 (if current-prefix-arg
1160 (intern
1161 (completing-read
1162 "Use VC backend: "
1163 (mapcar (lambda (b) (list (symbol-name b)))
1164 vc-handled-backends)
1165 nil t nil nil)))))
1166 (unless backend
1167 (setq backend (vc-responsible-backend dir)))
1168 (pop-to-buffer (vc-dir-prepare-status-buffer "*vc-dir*" dir backend))
1169 (if (derived-mode-p 'vc-dir-mode)
1170 (vc-dir-refresh)
1171 ;; FIXME: find a better way to pass the backend to `vc-dir-mode'.
1172 (let ((use-vc-backend backend))
1173 (vc-dir-mode))))
1175 (defun vc-default-dir-extra-headers (backend dir)
1176 ;; Be loud by default to remind people to add code to display
1177 ;; backend specific headers.
1178 ;; XXX: change this to return nil before the release.
1179 (concat
1180 (propertize "Extra : " 'face 'font-lock-type-face)
1181 (propertize "Please add backend specific headers here. It's easy!"
1182 'face 'font-lock-warning-face)))
1184 (defvar vc-dir-filename-mouse-map
1185 (let ((map (make-sparse-keymap)))
1186 (define-key map [mouse-2] 'vc-dir-find-file-other-window)
1187 map)
1188 "Local keymap for visiting a file.")
1190 (defun vc-default-dir-printer (backend fileentry)
1191 "Pretty print FILEENTRY."
1192 ;; If you change the layout here, change vc-dir-move-to-goal-column.
1193 ;; VC backends can implement backend specific versions of this
1194 ;; function. Changes here might need to be reflected in the
1195 ;; vc-BACKEND-dir-printer functions.
1196 (let* ((isdir (vc-dir-fileinfo->directory fileentry))
1197 (state (if isdir "" (vc-dir-fileinfo->state fileentry)))
1198 (filename (vc-dir-fileinfo->name fileentry)))
1199 (insert
1200 (propertize
1201 (format "%c" (if (vc-dir-fileinfo->marked fileentry) ?* ? ))
1202 'face 'font-lock-type-face)
1204 (propertize
1205 (format "%-20s" state)
1206 'face (cond ((eq state 'up-to-date) 'font-lock-builtin-face)
1207 ((memq state '(missing conflict)) 'font-lock-warning-face)
1208 (t 'font-lock-variable-name-face))
1209 'mouse-face 'highlight)
1211 (propertize
1212 (format "%s" filename)
1213 'face
1214 (if isdir 'font-lock-comment-delimiter-face 'font-lock-function-name-face)
1215 'help-echo
1216 (if isdir
1217 "Directory\nVC operations can be applied to it\nmouse-3: Pop-up menu"
1218 "File\nmouse-3: Pop-up menu")
1219 'mouse-face 'highlight
1220 'keymap vc-dir-filename-mouse-map))))
1222 (defun vc-default-extra-status-menu (backend)
1223 nil)
1225 (defun vc-default-status-fileinfo-extra (backend file)
1226 "Default absence of extra information returned for a file."
1227 nil)
1229 (provide 'vc-dir)
1231 ;; arch-tag: 0274a2e3-e8e9-4b1a-a73c-e8b9129d5d15
1232 ;;; vc-dir.el ends here