-
Notifications
You must be signed in to change notification settings - Fork 2.9k
/
psvn.el
6225 lines (5663 loc) · 281 KB
/
psvn.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
;;; psvn.el --- Subversion interface for emacs
;; Copyright (C) 2002-2008 by Stefan Reichoer
;; Author: Stefan Reichoer <stefan@xsteve.at>
;; psvn.el 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 2, or (at your option)
;; any later version.
;; psvn.el 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; see the file COPYING. If not, write to
;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
;;; Commentary
;; psvn.el is tested with GNU Emacs 21.3 on windows, debian linux,
;; freebsd5, red hat el4, ubuntu edgy with svn 1.4.0
;; psvn.el needs at least svn 1.1.0
;; if you upgrade to a higher version, you need to do a fresh checkout
;; psvn.el is an interface for the revision control tool subversion
;; (see http://subversion.tigris.org)
;; psvn.el provides a similar interface for subversion as pcl-cvs for cvs.
;; At the moment the following commands are implemented:
;;
;; M-x svn-status: run 'svn -status -v'
;; M-x svn-examine (like pcl-cvs cvs-examine) is alias for svn-status
;;
;; and show the result in the svn-status-buffer-name buffer (normally: *svn-status*).
;; If svn-status-verbose is set to nil, only "svn status" without "-v"
;; is run. Currently you have to toggle this variable manually.
;; This buffer uses svn-status mode in which the following keys are defined:
;; g - svn-status-update: run 'svn status -v'
;; M-s - svn-status-update: run 'svn status -v'
;; C-u g - svn-status-update: run 'svn status -vu'
;; = - svn-status-show-svn-diff run 'svn diff'
;; l - svn-status-show-svn-log run 'svn log'
;; i - svn-status-info run 'svn info'
;; r - svn-status-revert run 'svn revert'
;; X v - svn-status-resolved run 'svn resolved'
;; U - svn-status-update-cmd run 'svn update'
;; M-u - svn-status-update-cmd run 'svn update'
;; c - svn-status-commit run 'svn commit'
;; a - svn-status-add-file run 'svn add --non-recursive'
;; A - svn-status-add-file-recursively run 'svn add'
;; + - svn-status-make-directory run 'svn mkdir'
;; R - svn-status-mv run 'svn mv'
;; C - svn-status-cp run 'svn cp'
;; D - svn-status-rm run 'svn rm'
;; M-c - svn-status-cleanup run 'svn cleanup'
;; k - svn-status-lock run 'svn lock'
;; K - svn-status-unlock run 'svn unlock'
;; b - svn-status-blame run 'svn blame'
;; X e - svn-status-export run 'svn export'
;; RET - svn-status-find-file-or-examine-directory
;; ^ - svn-status-examine-parent
;; ~ - svn-status-get-specific-revision
;; E - svn-status-ediff-with-revision
;; X X - svn-status-resolve-conflicts
;; S g - svn-status-grep-files
;; S s - svn-status-search-files
;; s - svn-status-show-process-buffer
;; h - svn-status-pop-to-partner-buffer
;; e - svn-status-toggle-edit-cmd-flag
;; ? - svn-status-toggle-hide-unknown
;; _ - svn-status-toggle-hide-unmodified
;; m - svn-status-set-user-mark
;; u - svn-status-unset-user-mark
;; $ - svn-status-toggle-elide
;; w - svn-status-copy-current-line-info
;; DEL - svn-status-unset-user-mark-backwards
;; * ! - svn-status-unset-all-usermarks
;; * ? - svn-status-mark-unknown
;; * A - svn-status-mark-added
;; * M - svn-status-mark-modified
;; * P - svn-status-mark-modified-properties
;; * D - svn-status-mark-deleted
;; * * - svn-status-mark-changed
;; * . - svn-status-mark-by-file-ext
;; * % - svn-status-mark-filename-regexp
;; . - svn-status-goto-root-or-return
;; f - svn-status-find-file
;; o - svn-status-find-file-other-window
;; C-o - svn-status-find-file-other-window-noselect
;; v - svn-status-view-file-other-window
;; I - svn-status-parse-info
;; V - svn-status-svnversion
;; P l - svn-status-property-list
;; P s - svn-status-property-set
;; P d - svn-status-property-delete
;; P e - svn-status-property-edit-one-entry
;; P i - svn-status-property-ignore-file
;; P I - svn-status-property-ignore-file-extension
;; P C-i - svn-status-property-edit-svn-ignore
;; P k - svn-status-property-set-keyword-list
;; P K i - svn-status-property-set-keyword-id
;; P K d - svn-status-property-set-keyword-date
;; P y - svn-status-property-set-eol-style
;; P x - svn-status-property-set-executable
;; P m - svn-status-property-set-mime-type
;; H - svn-status-use-history
;; x - svn-status-update-buffer
;; q - svn-status-bury-buffer
;; C-x C-j - svn-status-dired-jump
;; The output in the buffer contains this header to ease reading
;; of svn output:
;; FPH BASE CMTD Author em File
;; F = Filemark
;; P = Property mark
;; H = History mark
;; BASE = local base revision
;; CMTD = last committed revision
;; Author = author of change
;; em = "**" or "(Update Available)" [see `svn-status-short-mod-flag-p']
;; if file can be updated
;; File = path/filename
;;
;; To use psvn.el put the following line in your .emacs:
;; (require 'psvn)
;; Start the svn interface with M-x svn-status
;; The latest version of psvn.el can be found at:
;; http://www.xsteve.at/prg/emacs/psvn.el
;; Or you can check it out from the subversion repository:
;; svn co http://svn.collab.net/repos/svn/trunk/contrib/client-side/emacs emacs-svn
;; TODO:
;; * shortcut for svn propset svn:keywords "Date" psvn.el
;; * docstrings for the functions
;; * perhaps shortcuts for ranges, dates
;; * when editing the command line - offer help from the svn client
;; * finish svn-status-property-set
;; * Add repository browser
;; * Get rid of all byte-compiler warnings
;; * SVK working copy support
;; * multiple independent buffers in svn-status-mode
;; There are "TODO" comments in other parts of this file as well.
;; Overview over the implemented/not (yet) implemented svn sub-commands:
;; * add implemented
;; * blame implemented
;; * cat implemented
;; * checkout (co) implemented
;; * cleanup implemented
;; * commit (ci) implemented
;; * copy (cp) implemented
;; * delete (del, remove, rm) implemented
;; * diff (di) implemented
;; * export implemented
;; * help (?, h)
;; * import used (in svn-admin-create-trunk-directory)
;; * info implemented
;; * list (ls) implemented
;; * lock implemented
;; * log implemented
;; * merge
;; * mkdir implemented
;; * move (mv, rename, ren) implemented
;; * propdel (pdel) implemented
;; * propedit (pedit, pe) not needed
;; * propget (pget, pg) used (in svn-status-property-edit)
;; * proplist (plist, pl) implemented
;; * propset (pset, ps) used (in svn-prop-edit-do-it)
;; * resolved implemented
;; * revert implemented
;; * status (stat, st) implemented
;; * switch (sw)
;; * unlock implemented
;; * update (up) implemented
;; For the not yet implemented commands you should use the command line
;; svn client. If there are user requests for any missing commands I will
;; probably implement them.
;; There is also limited support for the web-based software project management and bug/issue tracking system trac
;; Trac ticket links can be enabled in the *svn-log* buffers when using the following:
;; (setq svn-log-link-handlers '(trac-ticket-short))
;; ---------------------------
;; Frequently asked questions:
;; ---------------------------
;; Q1: I need support for user names with blanks/spaces
;; A1: Add the user names to svn-user-names-including-blanks and set the
;; svn-pre-parse-status-hook.
;; The problem is, that the user names and the file names from the svn status
;; output can both contain blanks. Blanks in file names are supported.
;; the svn-user-names-including-blanks list is used to replace the spaces
;; in the user names with - to overcome this problem
;; Q2: My svn-update command it taking a really long time. How can I
;; see what's going on?
;; A2: In the *svn-status* buffer press "s".
;; Q3: How do I enter a username and password?
;; A3: In the *svn-status* buffer press "s", switch to the
;; *svn-process* buffer and press enter. You will be prompted for
;; username and password.
;; Q4: What does "?", "M", and "C" in the first column of the
;; *svn-status* buffer mean?
;; A4: "?" means the file(s) is not under Subversion control
;; "M" means you have a locally modified file
;; "C" means there is a conflict
;; "@$&#!" means someone is saying nasty things to you
;; Comments / suggestions and bug reports are welcome!
;; Development notes
;; -----------------
;; "svn-" is the package prefix used in psvn.el. There are also longer
;; prefixes which clarify the code and help symbol completion, but they
;; are not intended to prevent name clashes with other packages. All
;; interactive commands meant to be used only in a specific mode should
;; have names beginning with the name of that mode: for example,
;; "svn-status-add-file" in "svn-status-mode". "psvn" should be used
;; only in names of files, customization groups, and features. If SVK
;; support is ever added, it should use "svn-svk-" when no existing
;; prefix is applicable.
;; Many of the variables marked as `risky-local-variable' are probably
;; impossible to abuse, as the commands that read them are used only in
;; buffers that are not visiting any files. Better safe than sorry.
;;; Code:
(require 'easymenu)
(eval-when-compile (require 'dired))
(eval-when-compile (require 'ediff-util))
(eval-when-compile (require 'ediff-wind))
(eval-when-compile (require 'elp))
(eval-when-compile (require 'pp))
(condition-case nil
(progn
(require 'diff-mode))
(error nil))
(defconst svn-psvn-revision "$Id: psvn.el 32032 2008-07-08 17:21:58Z xsteve $"
"The revision number of psvn.")
;;; user setable variables
(defcustom svn-status-verbose t
"*Add '-v' to svn status call.
This can be toggled with \\[svn-status-toggle-svn-verbose-flag]."
:type 'boolean
:group 'psvn)
(defcustom svn-log-edit-file-name "++svn-log++"
"*Name of a saved log file.
This can be either absolute, or relative to the default directory
of the `svn-log-edit-buffer-name' buffer."
:type 'file
:group 'psvn)
(put 'svn-log-edit-file-name 'risky-local-variable t)
(defcustom svn-log-edit-insert-files-to-commit t
"*Insert the filelist to commit in the *svn-log* buffer"
:type 'boolean
:group 'psvn)
(defcustom svn-log-edit-show-diff-for-commit nil
"*Show the diff being committed when you run `svn-status-commit.'."
:type 'boolean
:group 'psvn)
(defcustom svn-log-edit-use-log-edit-mode
(and (condition-case nil (require 'log-edit) (error nil)) t)
"*Use log-edit-mode as base for svn-log-edit-mode
This variable takes effect only when psvn.el is being loaded."
:type 'boolean
:group 'psvn)
(defcustom svn-log-edit-paragraph-start
"$\\|[ \t]*$\\|##.*$\\|\\*.*:.*$\\|[ \t]+(.+):.*$"
"*Value used for `paragraph-start' in `svn-log-edit-buffer-name' buffer."
:type 'regexp
:group 'psvn)
(defcustom svn-log-edit-paragraph-separate "$\\|##.*$"
"*Value used for `paragraph-separate' in `svn-log-edit-buffer-name' buffer."
:type 'regexp
:group 'psvn)
(defcustom svn-status-hide-unknown nil
"*Hide unknown files in `svn-status-buffer-name' buffer.
This can be toggled with \\[svn-status-toggle-hide-unknown]."
:type 'boolean
:group 'psvn)
(defcustom svn-status-hide-unmodified nil
"*Hide unmodified files in `svn-status-buffer-name' buffer.
This can be toggled with \\[svn-status-toggle-hide-unmodified]."
:type 'boolean
:group 'psvn)
(defcustom svn-status-sort-status-buffer t
"*Whether to sort the `svn-status-buffer-name' buffer.
Setting this variable to nil speeds up \\[M-x svn-status], however the
listing may then become incorrect.
This can be toggled with \\[svn-status-toggle-sort-status-buffer]."
:type 'boolean
:group 'psvn)
(defcustom svn-status-ediff-delete-temporary-files nil
"*Whether to delete temporary ediff files. If set to ask, ask the user"
:type '(choice (const t)
(const nil)
(const ask))
:group 'psvn)
(defcustom svn-status-changelog-style 'changelog
"*The changelog style that is used for `svn-file-add-to-changelog'.
Possible values are:
'changelog: use `add-change-log-entry-other-window'
'svn-dev: use commit messages that are used by the svn developers
a function: This function is called to add a new entry to the changelog file.
"
:type '(set (const changelog)
(const svn-dev))
:group 'psvn)
(defcustom svn-status-unmark-files-after-list '(commit revert)
"*List of operations after which all user marks will be removed.
Possible values are: commit, revert."
:type '(set (const commit)
(const revert))
:group 'psvn)
(defcustom svn-status-preserve-window-configuration t
"*Try to preserve the window configuration."
:type 'boolean
:group 'psvn)
(defcustom svn-status-auto-revert-buffers t
"*Auto revert buffers that have changed on disk."
:type 'boolean
:group 'psvn)
(defcustom svn-status-fancy-file-state-in-modeline t
"*Show a color dot in the modeline that describes the state of the current file."
:type 'boolean
:group 'psvn)
(defcustom svn-status-negate-meaning-of-arg-commands '()
"*List of operations that should use a negated meaning of the prefix argument.
The supported functions are `svn-status' and `svn-status-set-user-mark'."
:type '(set (function-item svn-status)
(function-item svn-status-set-user-mark))
:group 'psvn)
(defcustom svn-status-svn-executable "svn"
"*The name of the svn executable.
This can be either absolute or looked up on `exec-path'."
;; Don't use (file :must-match t). It doesn't know about `exec-path'.
:type 'file
:group 'psvn)
(put 'svn-status-svn-executable 'risky-local-variable t)
(defcustom svn-status-default-export-directory "~/" "*The default directory that is suggested svn export."
:type 'file
:group 'psvn)
(defcustom svn-status-svn-environment-var-list '("LC_MESSAGES=C" "LC_ALL=")
"*A list of environment variables that should be set for that svn process.
Each element is either a string \"VARIABLE=VALUE\" which will be added to
the environment when svn is run, or just \"VARIABLE\" which causes that
variable to be entirely removed from the environment.
The default setting is '(\"LC_MESSAGES=C\" \"LC_ALL=\"). This ensures that the svn command
line client does not output localized strings. psvn.el relies on the english
messages."
:type '(repeat string)
:group 'psvn)
(put 'svn-status-svn-environment-var-list 'risky-local-variable t)
(defcustom svn-browse-url-function nil
;; If the user hasn't changed `svn-browse-url-function', then changing
;; `browse-url-browser-function' should affect psvn even after it has
;; been loaded.
"Function to display a Subversion related WWW page in a browser.
So far, this is used only for \"trac\" issue tracker integration.
By default, this is nil, which means use `browse-url-browser-function'.
Any non-nil value overrides that variable, with the same syntax."
;; It would be nice to show the full list of browsers supported by
;; browse-url, but (custom-variable-type 'browse-url-browser-function)
;; returns just `function' if browse-url has not yet been loaded,
;; and there seems to be no easy way to autoload browse-url when
;; the custom-type of svn-browse-url-function is actually needed.
;; So I'll only offer enough choices to cover all supported types.
:type `(choice (const :tag "Specified by `browse-url-browser-function'" nil)
(function :value browse-url-default-browser
;; In XEmacs 21.4.17, the `function' widget matches
;; all objects. Constrain it here so that alists
;; fall through to the next choice. Accept either
;; a symbol (fbound or not) or a lambda expression.
:match ,(lambda (widget value)
(or (symbolp value) (functionp value))))
(svn-alist :tag "Regexp/function association list"
:key-type regexp :value-type function
:value (("." . browse-url-default-browser))))
:link '(emacs-commentary-link "browse-url")
:group 'psvn)
;; (put 'svn-browse-url-function 'risky-local-variable t)
;; already implied by "-function" suffix
(defcustom svn-status-window-alist
'((diff "*svn-diff*") (log "*svn-log*") (info t) (blame t) (proplist t) (update t))
"An alist to specify which windows should be used for svn command outputs.
The following keys are supported: diff, log, info, blame, proplist, update.
The following values can be given:
nil ... show in `svn-process-buffer-name' buffer
t ... show in dedicated *svn-info* buffer
invisible ... don't show the buffer (eventually useful for update)
a string ... show in a buffer named string"
:type '(svn-alist
:key-type symbol
:value-type (group
(choice
(const :tag "Show in *svn-process* buffer" nil)
(const :tag "Show in dedicated *svn-info* buffer" t)
(const :tag "Don't show the output" invisible)
(string :tag "Show in a buffer named"))))
:options '(diff log info blame proplist update)
:group 'psvn)
(defcustom svn-status-short-mod-flag-p t
"*Whether the mark for out of date files is short or long.
If this variable is is t, and a file is out of date (i.e., there is a newer
version in the repository than the working copy), then the file will
be marked by \"**\"
If this variable is nil, and the file is out of date then the longer phrase
\"(Update Available)\" is used.
In either case the mark gets the face
`svn-status-update-available-face', and will only be visible if
`\\[svn-status-update]' is run with a prefix argument"
:type '(choice (const :tag "Short \"**\"" t)
(const :tag "Long \"(Update Available)\"" nil))
:group 'psvn)
(defvar svn-status-debug-level 0 "The psvn.el debugging verbosity level.
The higher the number, the more debug messages are shown.
See `svn-status-message' for the meaning of values for that variable.")
(defvar svn-bookmark-list nil "A list of locations for a quick access via `svn-status-via-bookmark'")
;;(setq svn-bookmark-list '(("proj1" . "~/work/proj1")
;; ("doc1" . "~/docs/doc1")))
(defvar svn-status-buffer-name "*svn-status*" "Name for the svn status buffer")
(defvar svn-process-buffer-name " *svn-process*" "Name for the svn process buffer")
(defvar svn-log-edit-buffer-name "*svn-log-edit*" "Name for the svn log-edit buffer")
(defcustom svn-status-use-header-line
(if (boundp 'header-line-format) t 'inline)
"*Whether a header line should be used.
When t: Use the emacs header line
When 'inline: Insert the header line in the `svn-status-buffer-name' buffer
Otherwise: Don't display a header line"
:type '(choice (const :tag "Show column titles as a header line" t)
(const :tag "Insert column titles as text in the buffer" inline)
(other :tag "No column titles" nil))
:group 'psvn)
;;; default arguments to pass to svn commands
;; TODO: When customizing, an option menu or completion might be nice....
(defcustom svn-status-default-log-arguments '("-v")
"*List of arguments to pass to svn log.
\(used in `svn-status-show-svn-log'; override these by giving prefixes\)."
:type '(repeat string)
:group 'psvn)
(put 'svn-status-default-log-arguments 'risky-local-variable t)
(defcustom svn-status-default-commit-arguments '()
"*List of arguments to pass to svn commit.
If you don't like recursive commits, set this value to (\"-N\")
or mark the directory before committing it.
Do not put an empty string here, except as an argument of an option:
Subversion and the operating system may treat that as a file name
equivalent to \".\", so you would commit more than you intended."
:type '(repeat string)
:group 'psvn)
(put 'svn-status-default-commit-arguments 'risky-local-variable t)
(defcustom svn-status-default-diff-arguments '("-x" "--ignore-eol-style")
"*A list of arguments that is passed to the svn diff command.
When the built in diff command is used,
the following options are available: --ignore-eol-style, --ignore-space-change,
--ignore-all-space, --ignore-eol-style.
The following setting ignores eol style changes and all white space changes:
'(\"-x\" \"--ignore-eol-style --ignore-all-space\")
If you'd like to suppress whitespace changes using the external diff command
use the following value:
'(\"--diff-cmd\" \"diff\" \"-x\" \"-wbBu\")
"
:type '(repeat string)
:group 'psvn)
(put 'svn-status-default-diff-arguments 'risky-local-variable t)
(defcustom svn-status-default-status-arguments '()
"*A list of arguments that is passed to the svn status command.
The following options are available: --ignore-externals
"
:type '(repeat string)
:group 'psvn)
(put 'svn-status-default-status-arguments 'risky-local-variable t)
(defcustom svn-status-default-blame-arguments '("-x" "--ignore-eol-style")
"*A list of arguments that is passed to the svn blame command.
See `svn-status-default-diff-arguments' for some examples."
:type '(repeat string)
:group 'psvn)
(put 'svn-status-default-blame-arguments 'risky-local-variable t)
(defvar svn-trac-project-root nil
"Path for an eventual existing trac issue tracker.
This can be set with \\[svn-status-set-trac-project-root].")
(defvar svn-status-module-name nil
"*A short name for the actual project.
This can be set with \\[svn-status-set-module-name].")
(defvar svn-status-branch-list nil
"*A list of known branches for the actual project
This can be set with \\[svn-status-set-branch-list].
The list contains full repository paths or shortcuts starting with \#
\# at the beginning is replaced by the repository url.
\#1\# has the special meaning that all paths below the given directory
will be considered for interactive selections.
A useful setting might be: '\(\"\#trunk\" \"\#1\#tags\" \"\#1\#branches\")")
(defvar svn-status-load-state-before-svn-status t
"*Whether to automatically restore state from ++psvn.state file before running svn-status.")
(defvar svn-log-link-handlers nil "A list of link handlers in *svn-log* buffers.
These link handlers must be registered via `svn-log-register-link-handler'")
;;; hooks
(defvar svn-status-mode-hook nil "Hook run when entering `svn-status-mode'.")
(defvar svn-log-edit-mode-hook nil "Hook run when entering `svn-log-edit-mode'.")
(defvar svn-log-edit-done-hook nil "Hook run after commiting files via svn.")
;; (put 'svn-log-edit-mode-hook 'risky-local-variable t)
;; (put 'svn-log-edit-done-hook 'risky-local-variable t)
;; already implied by "-hook" suffix
(defvar svn-post-process-svn-output-hook nil "Hook that can be used to preprocess the output from svn.
The function `svn-status-remove-control-M' can be useful for that hook")
(when (eq system-type 'windows-nt)
(add-hook 'svn-post-process-svn-output-hook 'svn-status-remove-control-M))
(defvar svn-status-svn-process-coding-system (when (boundp 'locale-coding-system) locale-coding-system)
"The coding system that is used for the svn command line client.
It is used in svn-run, if it is not nil.")
(defvar svn-status-svn-file-coding-system 'undecided-unix
"The coding system that is used to save files that are loaded as
parameter or data files via the svn command line client.
It is used in the following functions: `svn-prop-edit-do-it', `svn-log-edit-done'.
You could set it to 'utf-8")
(defcustom svn-status-use-ido-completion
(fboundp 'ido-completing-read)
"*Use ido completion functionality."
:type 'boolean
:group 'psvn)
(defvar svn-status-completing-read-function
(if svn-status-use-ido-completion 'ido-completing-read 'completing-read))
;;; experimental features
(defvar svn-status-track-user-input nil "Track user/password queries.
This feature is implemented via a process filter.
It is an experimental feature.")
(defvar svn-status-refresh-info nil "Whether `svn-status-update-buffer' should call `svn-status-parse-info'.")
;;; Customize group
(defgroup psvn nil
"Subversion interface for Emacs."
:group 'tools)
(defgroup psvn-faces nil
"psvn faces."
:group 'psvn)
(eval-and-compile
(require 'cl)
(defconst svn-xemacsp (featurep 'xemacs))
(if svn-xemacsp
(require 'overlay)
(require 'overlay nil t)))
(defcustom svn-status-display-full-path nil
"Specifies how the filenames look like in the listing.
If t, their full path name will be displayed, else only the filename."
:type 'boolean
:group 'psvn)
(defcustom svn-status-prefix-key [(control x) (meta s)]
"Prefix key for the psvn commands in the global keymap."
:type '(choice (const [(control x) ?v ?S])
(const [(super s)])
(const [(hyper s)])
(const [(control x) ?v])
(const [(control x) ?V])
(sexp))
:group 'psvn
:set (lambda (var value)
(if (boundp var)
(global-unset-key (symbol-value var)))
(set var value)
(global-set-key (symbol-value var) 'svn-global-keymap)))
(defcustom svn-admin-default-create-directory "~/"
"*The default directory that is suggested for `svn-admin-create'."
:type 'string
:group 'psvn)
(defvar svn-status-custom-hide-function nil
"A function that receives a line-info and decides whether to hide that line.
See psvn.el for an example function.")
;; (put 'svn-status-custom-hide-function 'risky-local-variable t)
;; already implied by "-function" suffix
;; Use the normally used mode for files ending in .~HEAD~, .~BASE~, ...
(add-to-list 'auto-mode-alist '("\\.~?\\(HEAD\\|BASE\\|PREV\\)~?\\'" ignore t))
;;; internal variables
(defvar svn-status-directory-history nil "List of visited svn working directories.")
(defvar svn-process-cmd nil)
(defvar svn-status-info nil)
(defvar svn-status-filename-to-buffer-position-cache (make-hash-table :test 'equal :weakness t))
(defvar svn-status-base-info nil "The parsed result from the svn info command.")
(defvar svn-status-initial-window-configuration nil)
(defvar svn-status-default-column 23)
(defvar svn-status-default-revision-width 4)
(defvar svn-status-default-author-width 9)
(defvar svn-status-line-format " %c%c%c %4s %4s %-9s")
(defvar svn-start-of-file-list-line-number 0)
(defvar svn-status-files-to-commit nil
"List of files to commit at `svn-log-edit-done'.
This is always set together with `svn-status-recursive-commit'.")
(defvar svn-status-recursive-commit nil
"Non-nil if the next commit should be recursive.
This is always set together with `svn-status-files-to-commit'.")
(defvar svn-log-edit-update-log-entry nil
"Revision number whose log entry is being edited.
This is nil if the log entry is for a new commit.")
(defvar svn-status-pre-commit-window-configuration nil)
(defvar svn-status-pre-propedit-window-configuration nil)
(defvar svn-status-head-revision nil)
(defvar svn-status-root-return-info nil)
(defvar svn-status-property-edit-must-match-flag nil)
(defvar svn-status-propedit-property-name nil "The property name for the actual svn propset command")
(defvar svn-status-propedit-file-list nil)
(defvar svn-status-mode-line-process "")
(defvar svn-status-mode-line-process-status "")
(defvar svn-status-mode-line-process-edit-flag "")
(defvar svn-status-edit-svn-command nil)
(defvar svn-status-update-previous-process-output nil)
(defvar svn-pre-run-asynch-recent-keys nil)
(defvar svn-pre-run-mode-line-process nil)
(defvar svn-status-temp-dir
(expand-file-name
(or
(when (boundp 'temporary-file-directory) temporary-file-directory) ;emacs
;; XEmacs 21.4.17 can return "/tmp/kalle" from (temp-directory).
;; `file-name-as-directory' adds a slash so we can append a file name.
(when (fboundp 'temp-directory) (file-name-as-directory (temp-directory)))
"/tmp/")) "The directory that is used to store temporary files for psvn.")
;; Because `temporary-file-directory' is not a risky local variable in
;; GNU Emacs 22.0.51, we don't mark `svn-status-temp-dir' as such either.
(defvar svn-temp-suffix (make-temp-name "."))
(put 'svn-temp-suffix 'risky-local-variable t)
(defvar svn-status-temp-file-to-remove nil)
(put 'svn-status-temp-file-to-remove 'risky-local-variable t)
(defvar svn-status-temp-arg-file (concat svn-status-temp-dir "svn.arg" svn-temp-suffix))
(put 'svn-status-temp-arg-file 'risky-local-variable t)
(defvar svn-status-options nil)
(defvar svn-status-remote)
(defvar svn-status-commit-rev-number nil)
(defvar svn-status-update-rev-number nil)
(defvar svn-status-operated-on-dot nil)
(defvar svn-status-last-commit-author nil)
(defvar svn-status-elided-list nil)
(defvar svn-status-last-output-buffer-name nil "The buffer name for the buffer that holds the output from the last executed svn command")
(defvar svn-status-pre-run-svn-buffer nil)
(defvar svn-status-update-list nil)
(defvar svn-transient-buffers)
(defvar svn-ediff-windows)
(defvar svn-ediff-result)
(defvar svn-status-last-diff-options nil)
(defvar svn-status-blame-file-name nil)
(defvar svn-admin-last-repository-dir nil "The last repository url for various operations.")
(defvar svn-last-cmd-ring (make-ring 30) "Ring that holds the last executed svn commands (for debugging purposes)")
(defvar svn-status-cached-version-string nil)
(defvar svn-client-version nil "The version number of the used svn client")
(defvar svn-status-get-line-information-for-file nil)
(defvar svn-status-base-dir-cache (make-hash-table :test 'equal :weakness nil))
(defvar svn-log-registered-link-handlers (make-hash-table :test 'eql :weakness nil))
(defvar svn-status-partner-buffer nil "The partner buffer for this svn related buffer")
(make-variable-buffer-local 'svn-status-partner-buffer)
;; Emacs 21 defines these in ediff-init.el but it seems more robust
;; to just declare the variables here than try to load that file.
;; It is Ediff's job to declare these as risky-local-variable if needed.
(defvar ediff-buffer-A)
(defvar ediff-buffer-B)
(defvar ediff-buffer-C)
(defvar ediff-quit-hook)
;; Ditto for log-edit.el.
(defvar log-edit-initial-files)
(defvar log-edit-callback)
(defvar log-edit-listfun)
;; Ediff does not use this variable in GNU Emacs 20.7, GNU Emacs 21.4,
;; nor XEmacs 21.4.17. However, pcl-cvs (a.k.a. pcvs) does.
;; TODO: Check if this should be moved into the "svn-" namespace.
(defvar ediff-after-quit-destination-buffer)
;; That is an example for the svn-status-custom-hide-function:
;; Note: For many cases it is a better solution to ignore files or
;; file extensions via the svn-ignore properties (on P i, P I)
;; (setq svn-status-custom-hide-function 'svn-status-hide-pyc-files)
;; (defun svn-status-hide-pyc-files (info)
;; "Hide all pyc files in the `svn-status-buffer-name' buffer."
;; (let* ((fname (svn-status-line-info->filename-nondirectory info))
;; (fname-len (length fname)))
;; (and (> fname-len 4) (string= (substring fname (- fname-len 4)) ".pyc"))))
;;; faces
(defface svn-status-marked-face
'((((type tty) (class color)) (:foreground "green" :weight light))
(((class color) (background light)) (:foreground "green3"))
(((class color) (background dark)) (:foreground "palegreen2"))
(t (:weight bold)))
"Face to highlight the mark for user marked files in svn status buffers."
:group 'psvn-faces)
(defface svn-status-marked-popup-face
'((((type tty) (class color)) (:foreground "green" :weight light))
(((class color) (background light)) (:foreground "green3"))
(((class color) (background dark)) (:foreground "palegreen2"))
(t (:weight bold)))
"Face to highlight the actual file, if a popup menu is activated."
:group 'psvn-faces)
(defface svn-status-update-available-face
'((((type tty) (class color)) (:foreground "magenta" :weight light))
(((class color) (background light)) (:foreground "magenta"))
(((class color) (background dark)) (:foreground "yellow"))
(t (:weight bold)))
"Face used to highlight the 'out of date' mark.
\(i.e., the mark used when there is a newer version in the repository
than the working copy.\)
See also `svn-status-short-mod-flag-p'."
:group 'psvn-faces)
;based on cvs-filename-face
(defface svn-status-directory-face
'((((type tty) (class color)) (:foreground "lightblue" :weight light))
(((class color) (background light)) (:foreground "blue4"))
(((class color) (background dark)) (:foreground "lightskyblue1"))
(t (:weight bold)))
"Face for directories in *svn-status* buffers.
See `svn-status--line-info->directory-p' for what counts as a directory."
:group 'psvn-faces)
;based on font-lock-comment-face
(defface svn-status-filename-face
'((((class color) (background light)) (:foreground "chocolate"))
(((class color) (background dark)) (:foreground "beige")))
"Face for non-directories in *svn-status* buffers.
See `svn-status--line-info->directory-p' for what counts as a directory."
:group 'psvn-faces)
;not based on anything, may be horribly ugly!
(defface svn-status-symlink-face
'((((class color) (background light)) (:foreground "cornflower blue"))
(((class color) (background dark)) (:foreground "cyan")))
"Face for symlinks in *svn-status* buffers.
This is the face given to the actual link (i.e., the versioned item),
the target of the link gets either `svn-status-filename-face' or
`svn-status-directory-face'."
:group 'psvn-faces)
;based on font-lock-warning-face
(defface svn-status-locked-face
'((t
(:weight bold :foreground "Red")))
"Face for the phrase \"[ LOCKED ]\" `svn-status-buffer-name' buffers."
:group 'psvn-faces)
;based on vhdl-font-lock-directive-face
(defface svn-status-switched-face
'((((class color)
(background light))
(:foreground "CadetBlue"))
(((class color)
(background dark))
(:foreground "Aquamarine"))
(t
(:bold t :italic t)))
"Face for the phrase \"(switched)\" non-directories in svn status buffers."
:group 'psvn-faces)
(if svn-xemacsp
(defface svn-status-blame-highlight-face
'((((type tty) (class color)) (:foreground "green" :weight light))
(((class color) (background light)) (:foreground "green3"))
(((class color) (background dark)) (:foreground "palegreen2"))
(t (:weight bold)))
"Default face for highlighting a line in svn status blame mode."
:group 'psvn-faces)
(defface svn-status-blame-highlight-face
'((t :inherit highlight))
"Default face for highlighting a line in svn status blame mode."
:group 'psvn-faces))
(defface svn-status-blame-rev-number-face
'((((class color) (background light)) (:foreground "DarkGoldenrod"))
(((class color) (background dark)) (:foreground "LightGoldenrod"))
(t (:weight bold :slant italic)))
"Face to highlight revision numbers in the svn-blame mode."
:group 'psvn-faces)
(defvar svn-highlight t)
;; stolen from PCL-CVS
(defun svn-add-face (str face &optional keymap)
"Return string STR decorated with the specified FACE.
If `svn-highlight' is nil then just return STR."
(when svn-highlight
;; Do not use `list*'; cl.el might not have been loaded. We could
;; put (require 'cl) at the top but let's try to manage without.
(add-text-properties 0 (length str)
`(face ,face
mouse-face highlight)
;; 18.10.2004: the keymap parameter is not used (yet) in psvn.el
;; ,@(when keymap
;; `(mouse-face highlight
;; local-map ,keymap)))
str))
str)
(defun svn-status-maybe-add-face (condition text face)
"If CONDITION then add FACE to TEXT.
Else return TEXT unchanged."
(if condition
(svn-add-face text face)
text))
(defun svn-status-choose-face-to-add (condition text face1 face2)
"If CONDITION then add FACE1 to TEXT, else add FACE2 to TEXT."
(if condition
(svn-add-face text face1)
(svn-add-face text face2)))
(defun svn-status-maybe-add-string (condition string face)
"If CONDITION then return STRING decorated with FACE.
Otherwise, return \"\"."
(if condition
(svn-add-face string face)
""))
;; compatibility
;; emacs 20
(defalias 'svn-point-at-eol
(if (fboundp 'point-at-eol) 'point-at-eol 'line-end-position))
(defalias 'svn-point-at-bol
(if (fboundp 'point-at-bol) 'point-at-bol 'line-beginning-position))
(defalias 'svn-read-directory-name
(if (fboundp 'read-directory-name) 'read-directory-name 'read-file-name))
(eval-when-compile
(if (not (fboundp 'gethash))
(require 'cl-macs)))
(defalias 'svn-puthash (if (fboundp 'puthash) 'puthash 'cl-puthash))
;; emacs 21
(if (fboundp 'line-number-at-pos)
(defalias 'svn-line-number-at-pos 'line-number-at-pos)
(defun svn-line-number-at-pos (&optional pos)
"Return (narrowed) buffer line number at position POS.
If POS is nil, use current buffer location."
(let ((opoint (or pos (point))) start)
(save-excursion
(goto-char (point-min))
(setq start (point))
(goto-char opoint)
(forward-line 0)
(1+ (count-lines start (point)))))))
(defun svn-substring-no-properties (string &optional from to)
(if (fboundp 'substring-no-properties)
(substring-no-properties string from to)
(substring string from to)))
; xemacs
;; Evaluate the defsubst at compile time, so that the byte compiler
;; knows the definition and can inline calls. It cannot detect the
;; defsubst automatically from within the if form.
(eval-and-compile
(if (fboundp 'match-string-no-properties)
(defalias 'svn-match-string-no-properties 'match-string-no-properties)
(defsubst svn-match-string-no-properties (match)
(buffer-substring-no-properties (match-beginning match) (match-end match)))))
;; XEmacs 21.4.17 does not have an `alist' widget. Define a replacement.
;; To find out whether the `alist' widget exists, we cannot check just
;; (get 'alist 'widget-type), because GNU Emacs 21.4 defines it in
;; "wid-edit.el", which is not preloaded; it will be autoloaded when
;; `widget-create' is called. Instead, we call `widgetp', which is
;; also autoloaded from "wid-edit.el". XEmacs 21.4.17 does not have
;; `widgetp' either, so we check that first.
(if (and (fboundp 'widgetp) (widgetp 'alist))
(define-widget 'svn-alist 'alist
"An association list.
Use this instead of `alist', for XEmacs 21.4 compatibility.")
(define-widget 'svn-alist 'list
"An association list.
Use this instead of `alist', for XEmacs 21.4 compatibility."
:convert-widget 'svn-alist-convert-widget
:tag "Association List"
:key-type 'sexp
:value-type 'sexp)
(defun svn-alist-convert-widget (widget)
(let* ((value-type (widget-get widget :value-type))
(option-widgets (loop for option in (widget-get widget :options)
collect `(cons :format "%v"
(const :format "%t: %v\n"
:tag "Key"
,option)
,value-type))))
(widget-put widget :args
`(,@(when option-widgets
`((set :inline t :format "%v"
,@option-widgets)))
(editable-list :inline t
(cons :format "%v"
,(widget-get widget :key-type)
,value-type)))))
widget))
;; process launch functions
(defvar svn-call-process-function (if (fboundp 'process-file) 'process-file 'call-process))
(defvar svn-start-process-function (if (fboundp 'start-file-process) 'start-file-process 'start-process))
;;; keymaps
(defvar svn-global-keymap nil "Global keymap for psvn.el.
To bind this to a different key, customize `svn-status-prefix-key'.")
(put 'svn-global-keymap 'risky-local-variable t)
(when (not svn-global-keymap)
(setq svn-global-keymap (make-sparse-keymap))
(define-key svn-global-keymap (kbd "v") 'svn-status-version)
(define-key svn-global-keymap (kbd "s") 'svn-status-this-directory)
(define-key svn-global-keymap (kbd "b") 'svn-status-via-bookmark)
(define-key svn-global-keymap (kbd "h") 'svn-status-use-history)
(define-key svn-global-keymap (kbd "u") 'svn-status-update-cmd)
(define-key svn-global-keymap (kbd "=") 'svn-status-show-svn-diff)
(define-key svn-global-keymap (kbd "f =") 'svn-file-show-svn-diff)
(define-key svn-global-keymap (kbd "f e") 'svn-file-show-svn-ediff)
(define-key svn-global-keymap (kbd "f l") 'svn-status-show-svn-log)
(define-key svn-global-keymap (kbd "f b") 'svn-status-blame)
(define-key svn-global-keymap (kbd "f a") 'svn-file-add-to-changelog)
(define-key svn-global-keymap (kbd "c") 'svn-status-commit)
(define-key svn-global-keymap (kbd "S") 'svn-status-switch-to-status-buffer)
(define-key svn-global-keymap (kbd "o") 'svn-status-pop-to-status-buffer))
(defvar svn-status-diff-mode-map ()
"Keymap used in `svn-status-diff-mode' for additional commands that are not defined in diff-mode.")
(put 'svn-status-diff-mode-map 'risky-local-variable t) ;for Emacs 20.7
(when (not svn-status-diff-mode-map)
(setq svn-status-diff-mode-map (copy-keymap diff-mode-shared-map))
(define-key svn-status-diff-mode-map [?g] 'revert-buffer)