/
vc-dir.el
1217 lines (1120 loc) · 46 KB
/
vc-dir.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
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
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
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
638
639
640
641
642
643
644
645
646
647
648
649
650
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
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
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
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; vc-dir.el --- Directory status display under VC
;; Copyright (C) 2007, 2008, 2009
;; Free Software Foundation, Inc.
;; Author: Dan Nicolaescu <dann@ics.uci.edu>
;; Keywords: tools
;; 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:
;;
;; Alexandre Julliard <julliard@winehq.org>
;; Stefan Monnier <monnier@iro.umontreal.ca>
;; Tom Tromey <tromey@redhat.com>
;;; Commentary:
;;
;;; Todo: see vc.el.
(require 'vc-hooks)
(require 'vc)
(require 'tool-bar)
(require 'ewoc)
;;; Code:
(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
;; For storing backend specific information.
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)
(defvar vc-dir-process-buffer nil
"The buffer used for the asynchronous call that computes status.")
(defvar vc-dir-backend nil
"The backend used by the current *vc-dir* buffer.")
(defun vc-dir-move-to-goal-column ()
;; Used to keep the cursor on the file name column.
(beginning-of-line)
(unless (eolp)
;; Must be in sync with vc-default-dir-printer.
(forward-char 25)))
(defun vc-dir-prepare-status-buffer (bname dir backend &optional create-new)
"Find a buffer named BNAME showing DIR, or create a new one."
(setq dir (file-name-as-directory (expand-file-name dir)))
(let* ;; Look for another buffer name BNAME visiting the same directory.
((buf (save-excursion
(unless create-new
(dolist (buffer 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))))))))
(or buf
;; Create a new buffer named BNAME.
(with-current-buffer (create-file-buffer bname)
(cd dir)
(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]
'(menu-item "Refresh" revert-buffer
:enable (not (vc-dir-busy))
:help "Refresh the contents of the directory buffer"))
(define-key map [remup]
'(menu-item "Hide up-to-date" vc-dir-hide-up-to-date
:help "Hide up-to-date items from display"))
;; Movement.
(define-key map [sepmv] '("--"))
(define-key map [next-line]
'(menu-item "Next line" vc-dir-next-line
:help "Go to the next line" :keys "n"))
(define-key map [previous-line]
'(menu-item "Previous line" vc-dir-previous-line
: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]
'(menu-item "Unmark previous " vc-dir-unmark-file-up
: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] '("--"))
(define-key map [qr]
'(menu-item "Query Replace in Files..." vc-dir-query-replace-regexp
:help "Replace a string in the marked files"))
(define-key map [se]
'(menu-item "Search Files..." vc-dir-search
:help "Search a regexp in the marked files"))
(define-key map [ires]
'(menu-item "Isearch Regexp Files..." vc-dir-isearch-regexp
:help "Incremental search a regexp in the marked files"))
(define-key map [ise]
'(menu-item "Isearch Files..." vc-dir-isearch
:help "Incremental search a string in the marked files"))
(define-key map [open-other]
'(menu-item "Open in other window" vc-dir-find-file-other-window
:help "Find the file on the current line, in another window"))
(define-key map [open]
'(menu-item "Open file" vc-dir-find-file
:help "Find the file on the current line"))
(define-key map [sepvcdet] '("--"))
;; FIXME: This needs a key binding. And maybe a better name
;; ("Insert" like PCL-CVS uses does not sound that great either)...
(define-key map [ins]
'(menu-item "Show File" vc-dir-show-fileentry
:help "Show a file in the VC status listing even though it might be up to date"))
(define-key map [annotate]
'(menu-item "Annotate" vc-annotate
:help "Display the edit history of the current file using colors"))
(define-key map [diff]
'(menu-item "Compare with Base Version" vc-diff
:help "Compare file set with the base version"))
(define-key map [log]
'(menu-item "Show history" vc-print-log
:help "List the change log of the current file set in a window"))
;; VC commands.
(define-key map [sepvccmd] '("--"))
(define-key map [update]
'(menu-item "Update to latest version" vc-update
:help "Update the current fileset's files to their tip revisions"))
(define-key map [revert]
'(menu-item "Revert to base version" vc-revert
:help "Revert working copies of the selected fileset to their repository contents."))
(define-key map [next-action]
;; FIXME: This really really really needs a better name!
;; And a key binding too.
'(menu-item "Check In/Out" vc-next-action
:help "Do the next logical version control operation on the current fileset"))
(define-key map [register]
'(menu-item "Register" vc-register
:help "Register file set into the version control system"))
map)
"Menu for VC dir.")
;; VC backends can use this to add mode-specific menu items to
;; vc-dir-menu-map.
(defun vc-dir-menu-map-filter (orig-binding)
(when (and (symbolp orig-binding) (fboundp orig-binding))
(setq orig-binding (indirect-function orig-binding)))
(let ((ext-binding
(when (derived-mode-p 'vc-dir-mode)
(vc-call-backend vc-dir-backend 'extra-status-menu))))
(if (null ext-binding)
orig-binding
(append orig-binding
'("----")
ext-binding))))
(defvar vc-dir-mode-map
(let ((map (make-sparse-keymap)))
;; VC commands
(define-key map "v" 'vc-next-action) ;; C-x v v
(define-key map "=" 'vc-diff) ;; C-x v =
(define-key map "i" 'vc-register) ;; C-x v i
(define-key map "+" 'vc-update) ;; C-x v +
(define-key map "l" 'vc-print-log) ;; C-x v l
;; More confusing than helpful, probably
;;(define-key map "R" 'vc-revert) ;; u is taken by vc-dir-unmark.
;;(define-key map "A" 'vc-annotate) ;; g is taken by revert-buffer
;; bound by `special-mode'.
;; Marking.
(define-key map "m" 'vc-dir-mark)
(define-key map "M" 'vc-dir-mark-all-files)
(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)
(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)
(define-key map [follow-link] 'mouse-face)
(define-key map "x" 'vc-dir-hide-up-to-date)
(define-key map "S" 'vc-dir-search) ;; FIXME: Maybe use A like dired?
(define-key map "Q" 'vc-dir-query-replace-regexp)
(define-key map (kbd "M-s a C-s") 'vc-dir-isearch)
(define-key map (kbd "M-s a M-C-s") 'vc-dir-isearch-regexp)
;; Hook up the menu.
(define-key map [menu-bar vc-dir-mode]
`(menu-item
;; VC backends can use this to add mode-specific menu items to
;; vc-dir-menu-map.
"VC-dir" ,vc-dir-menu-map :filter vc-dir-menu-map-filter))
map)
"Keymap for directory buffer.")
(defmacro vc-dir-at-event (event &rest body)
"Evaluate BODY with point located at event-start of EVENT.
If BODY uses EVENT, it should be a variable,
otherwise it will be evaluated twice."
(let ((posn (make-symbol "vc-dir-at-event-posn")))
`(save-excursion
(unless (equal ,event '(tool-bar))
(let ((,posn (event-start ,event)))
(set-buffer (window-buffer (posn-window ,posn)))
(goto-char (posn-point ,posn))))
,@body)))
(defun vc-dir-menu (e)
"Popup the VC dir menu."
(interactive "e")
(vc-dir-at-event e (popup-menu vc-dir-menu-map e)))
(defvar vc-dir-tool-bar-map
(let ((map (make-sparse-keymap)))
(tool-bar-local-item-from-menu 'vc-dir-find-file "open"
map vc-dir-mode-map)
(tool-bar-local-item "bookmark_add"
'vc-dir-toggle-mark 'vc-dir-toggle-mark map
:help "Toggle mark on current item")
(tool-bar-local-item-from-menu 'vc-dir-previous-line "left-arrow"
map vc-dir-mode-map
:rtl "right-arrow")
(tool-bar-local-item-from-menu 'vc-dir-next-line "right-arrow"
map vc-dir-mode-map
:rtl "left-arrow")
(tool-bar-local-item-from-menu 'vc-print-log "info"
map vc-dir-mode-map)
(tool-bar-local-item-from-menu 'revert-buffer "refresh"
map vc-dir-mode-map)
(tool-bar-local-item-from-menu 'nonincremental-search-forward
"search" map)
(tool-bar-local-item-from-menu 'vc-dir-query-replace-regexp
"search-replace" map vc-dir-mode-map)
(tool-bar-local-item-from-menu 'vc-dir-kill-dir-status-process "cancel"
map vc-dir-mode-map)
(tool-bar-local-item-from-menu 'quit-window "exit"
map vc-dir-mode-map)
map))
(defun vc-dir-node-directory (node)
;; Compute the directory for NODE.
;; If it's a directory node, get it from the node.
(let ((data (ewoc-data node)))
(or (vc-dir-fileinfo->directory data)
;; Otherwise compute it from the file name.
(file-name-directory
(directory-file-name
(expand-file-name
(vc-dir-fileinfo->name data)))))))
(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)
(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))))))
(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))
(node (ewoc-nth vc-ewoc 0))
(dotname (file-relative-name default-directory)))
;; Insert . if it is not present.
(unless node
(ewoc-enter-last
vc-ewoc (vc-dir-create-fileinfo
dotname nil nil nil default-directory))
(setq node (ewoc-nth vc-ewoc 0)))
(while (and entry node)
(let* ((entryfile (car entry))
(entrydir (file-name-directory (directory-file-name
(expand-file-name entryfile))))
(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
((string= nodefile dotname)
(setq node (ewoc-next vc-ewoc node)))
((string-lessp nodefile entryfile)
(setq node (ewoc-next vc-ewoc node)))
((string-equal nodefile entryfile)
(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)
(setq entries (cdr entries))
(setq entry (car entries))
(setq node (ewoc-next vc-ewoc node)))
(t
(ewoc-enter-before vc-ewoc node
(apply 'vc-dir-create-fileinfo entry))
(setq entries (cdr entries))
(setq entry (car entries))))))
(t
;; 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))
(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)
(let ((entrydir (file-name-directory
(directory-file-name (expand-file-name (car entry))))))
;; 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
(apply 'vc-dir-create-fileinfo entry)))))))))
(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)
(funcall mark-unmark-function))))
(funcall mark-unmark-function)))
(defun vc-dir-parent-marked-p (arg)
;; Return nil if none of the parent directories of arg is marked.
(let* ((argdir (vc-dir-node-directory arg))
(arglen (length argdir))
(crt arg)
data dir)
;; Go through the predecessors, checking if any directory that is
;; a parent is marked.
(while (setq crt (ewoc-prev vc-ewoc crt))
(setq data (ewoc-data crt))
(setq dir (vc-dir-node-directory crt))
(when (and (vc-dir-fileinfo->directory data)
(vc-string-prefix-p dir argdir))
(when (vc-dir-fileinfo->marked data)
(error "Cannot mark `%s', parent directory `%s' marked"
(vc-dir-fileinfo->name (ewoc-data arg))
(vc-dir-fileinfo->name data)))))
nil))
(defun vc-dir-children-marked-p (arg)
;; Return nil if none of the children of arg is marked.
(let* ((argdir-re (concat "\\`" (regexp-quote (vc-dir-node-directory arg))))
(is-child t)
(crt arg)
data dir)
(while (and is-child (setq crt (ewoc-next vc-ewoc crt)))
(setq data (ewoc-data crt))
(setq dir (vc-dir-node-directory crt))
(if (string-match argdir-re dir)
(when (vc-dir-fileinfo->marked data)
(error "Cannot mark `%s', child `%s' marked"
(vc-dir-fileinfo->name (ewoc-data arg))
(vc-dir-fileinfo->name data)))
;; We are done, we got to an entry that is not a child of `arg'.
(setq is-child nil)))
nil))
(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))
(isdir (vc-dir-fileinfo->directory file)))
(when (or (and isdir (not (vc-dir-children-marked-p crt)))
(and (not isdir) (not (vc-dir-parent-marked-p crt))))
(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)))))
(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))
(let ((data (ewoc-data (ewoc-locate vc-ewoc))))
(if (vc-dir-fileinfo->directory data)
;; It's a directory, mark child files.
(let ((crt (ewoc-locate vc-ewoc)))
(unless (vc-dir-children-marked-p crt)
(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) t)
(ewoc-invalidate vc-ewoc crt))))))
;; It's a file
(let ((state (vc-dir-fileinfo->state data))
(crt (ewoc-nth vc-ewoc 0)))
(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")
(vc-dir-at-event e (vc-dir-mark-unmark 'vc-dir-toggle-mark-file)))
(defun vc-dir-delete-file ()
"Delete the marked files, or the current file if no marks."
(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)))
(defun vc-dir-find-file-other-window (&optional event)
"Find the file on the current line, in another window."
(interactive (list last-nonmenu-event))
(if event (posn-set-point (event-end event)))
(find-file-other-window (vc-dir-current-file)))
(defun vc-dir-isearch ()
"Search for a string through all marked buffers using Isearch."
(interactive)
(multi-isearch-files
(mapcar 'car (vc-dir-marked-only-files-and-states))))
(defun vc-dir-isearch-regexp ()
"Search for a regexp through all marked buffers using Isearch."
(interactive)
(multi-isearch-files-regexp
(mapcar 'car (vc-dir-marked-only-files-and-states))))
(defun vc-dir-search (regexp)
"Search through all marked files for a match for REGEXP.
For marked directories, use the files displayed from those directories.
Stops when a match is found.
To continue searching for next match, use command \\[tags-loop-continue]."
(interactive "sSearch marked files (regexp): ")
(tags-search regexp '(mapcar 'car (vc-dir-marked-only-files-and-states))))
(defun vc-dir-query-replace-regexp (from to &optional delimited)
"Do `query-replace-regexp' of FROM with TO, on all marked files.
For marked directories, use the files displayed from those directories.
If a directory is marked, then use the files displayed for that directory.
Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
If you exit (\\[keyboard-quit], RET or q), you can resume the query replace
with the command \\[tags-loop-continue]."
;; FIXME: this is almost a copy of `dired-do-replace-regexp'. This
;; should probably be made generic and used in both places instead of
;; duplicating it here.
(interactive
(let ((common
(query-replace-read-args
"Query replace regexp in marked files" t t)))
(list (nth 0 common) (nth 1 common) (nth 2 common))))
(dolist (file (mapcar 'car (vc-dir-marked-only-files-and-states)))
(let ((buffer (get-file-buffer file)))
(if (and buffer (with-current-buffer buffer
buffer-read-only))
(error "File `%s' is visited read-only" file))))
(tags-query-replace from to delimited
'(mapcar 'car (vc-dir-marked-only-files-and-states))))
(defun vc-dir-current-file ()
(let ((node (ewoc-locate vc-ewoc)))
(unless node
(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)))
(defun vc-dir-marked-only-files-and-states ()
"Return the list of conses (FILE . STATE) for the marked files.
For marked directories return the corresponding conses for the
child files."
(let ((crt (ewoc-nth vc-ewoc 0))
result)
(while crt
(let ((crt-data (ewoc-data crt)))
(if (vc-dir-fileinfo->marked crt-data)
;; FIXME: use vc-dir-child-files-and-states here instead of duplicating it.
(if (vc-dir-fileinfo->directory crt-data)
(let* ((dir (vc-dir-fileinfo->directory crt-data))
(dirlen (length dir))
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)
(push
(cons (expand-file-name (vc-dir-fileinfo->name data))
(vc-dir-fileinfo->state data))
result))))
(push (cons (expand-file-name (vc-dir-fileinfo->name crt-data))
(vc-dir-fileinfo->state crt-data))
result)
(setq crt (ewoc-next vc-ewoc crt)))
(setq crt (ewoc-next vc-ewoc crt)))))
(nreverse result)))
(defun vc-dir-child-files-and-states ()
"Return the list of conses (FILE . STATE) for child files of the current entry if it's a directory.
If it is a file, return the corresponding cons for the file itself."
(let* ((crt (ewoc-locate vc-ewoc))
(crt-data (ewoc-data crt))
result)
(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)
(push
(cons (expand-file-name (vc-dir-fileinfo->name data))
(vc-dir-fileinfo->state data))
result))))
(push
(cons (expand-file-name (vc-dir-fileinfo->name crt-data))
(vc-dir-fileinfo->state crt-data)) result))
(nreverse result)))
(defun vc-dir-recompute-file-state (fname def-dir)
(let* ((file-short (file-relative-name fname def-dir))
(remove-me-when-CVS-works
(when (eq vc-dir-backend 'CVS)
;; FIXME: Warning: UGLY HACK. The CVS backend caches the state
;; info, this forces the backend to update it.
(vc-call-backend vc-dir-backend 'registered fname)))
(state (vc-call-backend vc-dir-backend 'state fname))
(extra (vc-call-backend vc-dir-backend
'status-fileinfo-extra fname)))
(list file-short state extra)))
(defun vc-dir-find-child-files (dirname)
;; Give a DIRNAME string return the list of all child files shown in
;; the current *vc-dir* buffer.
(let ((crt (ewoc-nth vc-ewoc 0))
children
dname)
;; Find DIR
(while (and crt (not (vc-string-prefix-p
dirname (vc-dir-node-directory crt))))
(setq crt (ewoc-next vc-ewoc crt)))
(while (and crt (vc-string-prefix-p
dirname
(setq dname (vc-dir-node-directory crt))))
(let ((data (ewoc-data crt)))
(unless (vc-dir-fileinfo->directory data)
(push (expand-file-name (vc-dir-fileinfo->name data)) children)))
(setq crt (ewoc-next vc-ewoc crt)))
children))
(defun vc-dir-resync-directory-files (dirname)
;; Update the entries for all the child files of DIRNAME shown in
;; the current *vc-dir* buffer.
(let ((files (vc-dir-find-child-files dirname))
(ddir default-directory)
fileentries)
(when files
(dolist (crt files)
(push (vc-dir-recompute-file-state crt ddir)
fileentries))
(vc-dir-update fileentries (current-buffer)))))
(defun vc-dir-resynch-file (&optional fname)
"Update the entries for FNAME in any directory buffers that list it."
(let ((file (or fname (expand-file-name buffer-file-name)))
(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)
(vc-dir-resync-directory-files file)
(let ((state (vc-dir-recompute-file-state file ddir)))
(vc-dir-update
(list state)
status-buf (eq (cadr state) 'up-to-date))))))))))
;; Remove out-of-date entries from vc-dir-buffers.
(dolist (b drop) (setq vc-dir-buffers (delq b vc-dir-buffers)))))
(defvar use-vc-backend) ;; dynamically bound
(define-derived-mode vc-dir-mode special-mode "VC dir"
"Major mode for VC directory buffers.
Marking/Unmarking key bindings and actions:
m - mark a file/directory
- if the region is active, mark all the files in region.
Restrictions: - a file cannot be marked if any parent directory is marked
- a directory cannot be marked if any child file or
directory is marked
u - unmark a file/directory
- if the region is active, unmark all the files in region.
M - if the cursor is on a file: mark all the files with the same state as
the current file
- if the cursor is on a directory: mark all child files
- 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
mouse-2 - toggles the mark state
VC commands
VC commands in the `C-x v' prefix can be used.
VC commands act on the marked entries. If nothing is marked, VC
commands act on the current entry.
Search & Replace
S - searches the marked files
Q - does a query replace on the marked files
M-s a C-s - does an isearch on the marked files
M-s a C-M-s - does a regexp isearch on the marked files
If nothing is marked, these commands act on the current entry.
When a directory is current or marked, the Search & Replace
commands act on the child files of that directory that are displayed in
the *vc-dir* buffer.
\\{vc-dir-mode-map}"
(set (make-local-variable 'vc-dir-backend) use-vc-backend)
(setq buffer-read-only t)
(when (boundp 'tool-bar-map)
(set (make-local-variable 'tool-bar-map) vc-dir-tool-bar-map))
(let ((buffer-read-only nil))
(erase-buffer)
(set (make-local-variable 'vc-dir-process-buffer) nil)
(set (make-local-variable 'vc-ewoc) (ewoc-create #'vc-dir-printer))
(set (make-local-variable 'revert-buffer-function)
'vc-dir-revert-buffer-function)
(setq list-buffers-directory default-directory)
(add-to-list 'vc-dir-buffers (current-buffer))
;; 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)
(vc-dir-refresh)))
(defun vc-dir-headers (backend dir)
"Display the headers in the *VC dir* buffer.
It calls the `dir-extra-headers' backend method to display backend
specific headers."
(concat
;; First layout the common headers.
(propertize "VC backend : " 'face 'font-lock-type-face)
(propertize (format "%s\n" backend) 'face 'font-lock-variable-name-face)
(propertize "Working dir: " 'face 'font-lock-type-face)
(propertize (format "%s\n" dir) 'face 'font-lock-variable-name-face)
;; Then the backend specific ones.
(vc-call-backend backend 'dir-extra-headers dir)
"\n"))
(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)
;; Call the `dir-status-file' backend function.
;; `dir-status-file' 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.
(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
(cd def-dir)
(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,
;; reset it, othewise it will be removed when doing 'x'
;; 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))))))))))))
(defun vc-dir-revert-buffer-function (&optional ignore-auto noconfirm)
(vc-dir-refresh))
(defun vc-dir-refresh ()
"Refresh the contents of the *VC-dir* buffer.