(replace_buffer_in_all_windows):
[bpt/emacs.git] / lisp / vc.el
CommitLineData
594722a8
ER
1;;; vc.el --- drive a version-control system from within Emacs
2
0101cc40 3;; Copyright (C) 1992, 93, 94, 95, 96, 97 Free Software Foundation, Inc.
594722a8 4
28a25aa5
AS
5;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
6;; Maintainer: Andre Spiegel <spiegel@inf.fu-berlin.de>
594722a8
ER
7
8;; This file is part of GNU Emacs.
9
10;; GNU Emacs is free software; you can redistribute it and/or modify
11;; it under the terms of the GNU General Public License as published by
12;; the Free Software Foundation; either version 2, or (at your option)
13;; any later version.
14
15;; GNU Emacs is distributed in the hope that it will be useful,
16;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18;; GNU General Public License for more details.
19
20;; You should have received a copy of the GNU General Public License
b578f267
EN
21;; along with GNU Emacs; see the file COPYING. If not, write to the
22;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23;; Boston, MA 02111-1307, USA.
594722a8
ER
24
25;;; Commentary:
26
1a2f456b
ER
27;; This mode is fully documented in the Emacs user's manual.
28;;
594722a8
ER
29;; This was designed and implemented by Eric Raymond <esr@snark.thyrsus.com>.
30;; Paul Eggert <eggert@twinsun.com>, Sebastian Kremer <sk@thp.uni-koeln.de>,
31;; and Richard Stallman contributed valuable criticism, support, and testing.
632e9525 32;; CVS support was added by Per Cederqvist <ceder@lysator.liu.se>
28a25aa5
AS
33;; in Jan-Feb 1994. Further enhancements came from ttn.netcom.com and
34;; Andre Spiegel <spiegel@inf.fu-berlin.de>.
594722a8 35;;
632e9525 36;; Supported version-control systems presently include SCCS, RCS, and CVS.
b0c9bc8c
AS
37;;
38;; Some features will not work with old RCS versions. Where
39;; appropriate, VC finds out which version you have, and allows or
40;; disallows those features (stealing locks, for example, works only
41;; from 5.6.2 onwards).
632e9525
RS
42;; Even initial checkins will fail if your RCS version is so old that ci
43;; doesn't understand -t-; this has been known to happen to people running
44;; NExTSTEP 3.0.
594722a8 45;;
6b9d0764
AS
46;; You can support the RCS -x option by adding pairs to the
47;; vc-master-templates list.
594722a8
ER
48;;
49;; Proper function of the SCCS diff commands requires the shellscript vcdiff
50;; to be installed somewhere on Emacs's path for executables.
51;;
1a2f456b 52;; If your site uses the ChangeLog convention supported by Emacs, the
594be62e 53;; function vc-comment-to-change-log should prove a useful checkin hook.
1a2f456b 54;;
594722a8 55;; This code depends on call-process passing back the subprocess exit
e1f297e6 56;; status. Thus, you need Emacs 18.58 or later to run it. For the
6ed5075c 57;; vc-directory command to work properly as documented, you need 19.
7ef84cf9 58;; You also need Emacs 19's ring.el.
594722a8
ER
59;;
60;; The vc code maintains some internal state in order to reduce expensive
61;; version-control operations to a minimum. Some names are only computed
34291cd2 62;; once. If you perform version control operations with RCS/SCCS/CVS while
594722a8
ER
63;; vc's back is turned, or move/rename master files while vc is running,
64;; vc may get seriously confused. Don't do these things!
65;;
66;; Developer's notes on some concurrency issues are included at the end of
67;; the file.
68
69;;; Code:
70
71(require 'vc-hooks)
8c0aaf40 72(require 'ring)
5c6f8be0 73(eval-when-compile (require 'dired)) ; for dired-map-over-marks macro
8c0aaf40
ER
74
75(if (not (assoc 'vc-parent-buffer minor-mode-alist))
76 (setq minor-mode-alist
77 (cons '(vc-parent-buffer vc-parent-buffer-name)
78 minor-mode-alist)))
594722a8 79
d7eff0e0
RS
80;; To implement support for a new version-control system, add another
81;; branch to the vc-backend-dispatch macro and fill it in in each
82;; call. The variable vc-master-templates in vc-hooks.el will also
83;; have to change.
84
85(defmacro vc-backend-dispatch (f s r c)
86 "Execute FORM1, FORM2 or FORM3 for SCCS, RCS or CVS respectively.
87If FORM3 is `RCS', use FORM2 for CVS as well as RCS.
88\(CVS shares some code with RCS)."
89 (list 'let (list (list 'type (list 'vc-backend f)))
90 (list 'cond
91 (list (list 'eq 'type (quote 'SCCS)) s) ;; SCCS
92 (list (list 'eq 'type (quote 'RCS)) r) ;; RCS
93 (list (list 'eq 'type (quote 'CVS)) ;; CVS
94 (if (eq c 'RCS) r c))
95 )))
96
594722a8
ER
97;; General customization
98
0101cc40
RS
99(defgroup vc nil
100 "Version-control system in Emacs."
101 :group 'tools)
102
103(defcustom vc-suppress-confirm nil
104 "*If non-nil, treat user as expert; suppress yes-no prompts on some things."
105 :type 'boolean
106 :group 'vc)
107
108(defcustom vc-initial-comment nil
109 "*If non-nil, prompt for initial comment when a file is registered."
110 :type 'boolean
111 :group 'vc)
112
113(defcustom vc-command-messages nil
114 "*If non-nil, display run messages from back-end commands."
115 :type 'boolean
116 :group 'vc)
117
118(defcustom vc-checkin-switches nil
119 "*A string or list of strings specifying extra switches for checkin.
120These are passed to the checkin program by \\[vc-checkin]."
121 :type '(choice (const :tag "None" nil)
122 (string :tag "Argument String")
123 (repeat :tag "Argument List"
124 :value ("")
125 string))
126 :group 'vc)
127
128(defcustom vc-checkout-switches nil
129 "*A string or list of strings specifying extra switches for checkout.
130These are passed to the checkout program by \\[vc-checkout]."
131 :type '(choice (const :tag "None" nil)
132 (string :tag "Argument String")
133 (repeat :tag "Argument List"
134 :value ("")
135 string))
136 :group 'vc)
137
138(defcustom vc-register-switches nil
139 "*A string or list of strings; extra switches for registering a file.
140These are passed to the checkin program by \\[vc-register]."
141 :type '(choice (const :tag "None" nil)
142 (string :tag "Argument String")
143 (repeat :tag "Argument List"
144 :value ("")
145 string))
146 :group 'vc)
147
148(defcustom vc-directory-exclusion-list '("SCCS" "RCS" "CVS")
149 "*List of directory names to be ignored while recursively walking file trees."
150 :type '(repeat string)
151 :group 'vc)
666a0ebb 152
8c0aaf40
ER
153(defconst vc-maximum-comment-ring-size 32
154 "Maximum number of saved comments in the comment ring.")
155
2e810285
RS
156;;; This is duplicated in diff.el.
157(defvar diff-switches "-c"
158 "*A string or list of strings specifying switches to be be passed to diff.")
159
7d2d9482
RS
160(defcustom vc-annotate-color-map
161 '(( 26.3672 . "#FF0000")
162 ( 52.7344 . "#FF3800")
163 ( 79.1016 . "#FF7000")
164 (105.4688 . "#FFA800")
165 (131.8359 . "#FFE000")
166 (158.2031 . "#E7FF00")
167 (184.5703 . "#AFFF00")
168 (210.9375 . "#77FF00")
169 (237.3047 . "#3FFF00")
170 (263.6719 . "#07FF00")
171 (290.0391 . "#00FF31")
172 (316.4063 . "#00FF69")
173 (342.7734 . "#00FFA1")
174 (369.1406 . "#00FFD9")
175 (395.5078 . "#00EEFF")
176 (421.8750 . "#00B6FF")
177 (448.2422 . "#007EFF"))
178 "*Association list of age versus color, for \\[vc-annotate].
179Ages are given in units of 2**-16 seconds.
180Default is eighteen steps using a twenty day increment."
181 :type 'sexp
182 :group 'vc)
183
184(defcustom vc-annotate-very-old-color "#0046FF"
185 "*Color for lines older than CAR of last cons in `vc-annotate-color-map'."
186 :type 'string
187 :group 'vc)
188
189(defcustom vc-annotate-background "black"
190 "*Background color for \\[vc-annotate].
191Default color is used if nil."
192 :type 'string
193 :group 'vc)
194
195(defcustom vc-annotate-menu-elements '(2 0.5 0.1 0.01)
196 "*Menu elements for the mode-specific menu of VC-Annotate mode.
197List of factors, used to expand/compress the time scale. See `vc-annotate'."
198 :type 'sexp
199 :group 'vc)
200
f0b188ed 201;;;###autoload
0101cc40
RS
202(defcustom vc-checkin-hook nil
203 "*Normal hook (List of functions) run after a checkin is done.
204See `run-hooks'."
205 :type 'hook
206 :group 'vc)
f0b188ed 207
67242a23 208;;;###autoload
0101cc40
RS
209(defcustom vc-before-checkin-hook nil
210 "*Normal hook (list of functions) run before a file gets checked in.
211See `run-hooks'."
212 :type 'hook
213 :group 'vc)
67242a23 214
7d2d9482
RS
215;;;###autoload
216(defcustom vc-annotate-mode-hook nil
217 "*Hooks to run when VC-Annotate mode is turned on."
218 :type 'hook
219 :group 'vc)
220
594722a8
ER
221;; Header-insertion hair
222
0101cc40 223(defcustom vc-header-alist
80688f5c 224 '((SCCS "\%W\%") (RCS "\$Id\$") (CVS "\$Id\$"))
7e48e092
AS
225 "*Header keywords to be inserted by `vc-insert-headers'.
226Must be a list of two-element lists, the first element of each must
227be `RCS', `CVS', or `SCCS'. The second element is the string to
0101cc40
RS
228be inserted for this particular backend."
229 :type '(repeat (list :format "%v"
230 (choice :tag "System"
231 (const SCCS)
232 (const RCS)
233 (const CVS))
234 (string :tag "Header")))
235 :group 'vc)
236
237(defcustom vc-static-header-alist
594722a8
ER
238 '(("\\.c$" .
239 "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n"))
240 "*Associate static header string templates with file types. A \%s in the
241template is replaced with the first string associated with the file's
0101cc40
RS
242version-control type in `vc-header-alist'."
243 :type '(repeat (cons :format "%v"
244 (regexp :tag "File Type")
245 (string :tag "Header String")))
246 :group 'vc)
7b4f934d 247
0101cc40 248(defcustom vc-comment-alist
594722a8
ER
249 '((nroff-mode ".\\\"" ""))
250 "*Special comment delimiters to be used in generating vc headers only.
251Add an entry in this list if you need to override the normal comment-start
252and comment-end variables. This will only be necessary if the mode language
0101cc40
RS
253is sensitive to blank lines."
254 :type '(repeat (list :format "%v"
255 (symbol :tag "Mode")
256 (string :tag "Comment Start")
257 (string :tag "Comment End")))
258 :group 'vc)
594722a8 259
bbf97570 260;; Default is to be extra careful for super-user.
0101cc40 261(defcustom vc-checkout-carefully (= (user-uid) 0)
bbf97570
RS
262 "*Non-nil means be extra-careful in checkout.
263Verify that the file really is not locked
0101cc40
RS
264and that its contents match what the master file says."
265 :type 'boolean
266 :group 'vc)
bbf97570 267
0101cc40 268(defcustom vc-rcs-release nil
b0c9bc8c 269 "*The release number of your RCS installation, as a string.
0101cc40
RS
270If nil, VC itself computes this value when it is first needed."
271 :type '(choice (const :tag "Auto" nil)
272 string)
273 :group 'vc)
b0c9bc8c 274
0101cc40 275(defcustom vc-sccs-release nil
b0c9bc8c 276 "*The release number of your SCCS installation, as a string.
0101cc40
RS
277If nil, VC itself computes this value when it is first needed."
278 :type '(choice (const :tag "Auto" nil)
279 string)
280 :group 'vc)
b0c9bc8c 281
0101cc40 282(defcustom vc-cvs-release nil
7e48e092 283 "*The release number of your CVS installation, as a string.
0101cc40
RS
284If nil, VC itself computes this value when it is first needed."
285 :type '(choice (const :tag "Auto" nil)
286 string)
287 :group 'vc)
b0c9bc8c 288
594722a8
ER
289;; Variables the user doesn't need to know about.
290(defvar vc-log-entry-mode nil)
291(defvar vc-log-operation nil)
67242a23 292(defvar vc-log-after-operation-hook nil)
34291cd2 293(defvar vc-checkout-writable-buffer-hook 'vc-checkout-writable-buffer)
dbf87856
RS
294;; In a log entry buffer, this is a local variable
295;; that points to the buffer for which it was made
296;; (either a file, or a VC dired buffer).
1a2f456b 297(defvar vc-parent-buffer nil)
8c0aaf40 298(defvar vc-parent-buffer-name nil)
594722a8 299
db59472c
RS
300(defvar vc-log-file)
301(defvar vc-log-version)
302
594722a8
ER
303(defconst vc-name-assoc-file "VC-names")
304
8c0aaf40 305(defvar vc-dired-mode nil)
e1f297e6
ER
306(make-variable-buffer-local 'vc-dired-mode)
307
c9b35ece 308(defvar vc-comment-ring (make-ring vc-maximum-comment-ring-size))
8c0aaf40
ER
309(defvar vc-comment-ring-index nil)
310(defvar vc-last-comment-match nil)
311
632e9525
RS
312;; Back-portability to Emacs 18
313
314(defun file-executable-p-18 (f)
315 (let ((modes (file-modes f)))
316 (and modes (not (zerop (logand 292))))))
317
318(defun file-regular-p-18 (f)
319 (let ((attributes (file-attributes f)))
320 (and attributes (not (car attributes)))))
321
322; Conditionally rebind some things for Emacs 18 compatibility
323(if (not (boundp 'minor-mode-map-alist))
324 (progn
325 (setq compilation-old-error-list nil)
326 (fset 'file-executable-p 'file-executable-p-18)
327 (fset 'shrink-window-if-larger-than-buffer 'beginning-of-buffer)
328 ))
329
4040437e 330(if (not (fboundp 'file-regular-p))
632e9525
RS
331 (fset 'file-regular-p 'file-regular-p-18))
332
b0c9bc8c
AS
333;;; Find and compare backend releases
334
335(defun vc-backend-release (backend)
336 ;; Returns which backend release is installed on this system.
337 (cond
338 ((eq backend 'RCS)
339 (or vc-rcs-release
2bb00bdd 340 (and (zerop (vc-do-command nil nil "rcs" nil nil "-V"))
b0c9bc8c
AS
341 (save-excursion
342 (set-buffer (get-buffer "*vc*"))
343 (setq vc-rcs-release
344 (car (vc-parse-buffer
345 '(("^RCS version \\([0-9.]+ *.*\\)" 1)))))))
346 (setq vc-rcs-release 'unknown)))
347 ((eq backend 'CVS)
348 (or vc-cvs-release
349 (and (zerop (vc-do-command nil 1 "cvs" nil nil "-v"))
350 (save-excursion
351 (set-buffer (get-buffer "*vc*"))
352 (setq vc-cvs-release
353 (car (vc-parse-buffer
354 '(("^Concurrent Versions System (CVS) \\([0-9.]+\\)"
355 1)))))))
356 (setq vc-cvs-release 'unknown)))
357 ((eq backend 'SCCS)
358 vc-sccs-release)))
359
360(defun vc-release-greater-or-equal (r1 r2)
361 ;; Compare release numbers, represented as strings.
362 ;; Release components are assumed cardinal numbers, not decimal
363 ;; fractions (5.10 is a higher release than 5.9). Omitted fields
364 ;; are considered lower (5.6.7 is earlier than 5.6.7.1).
365 ;; Comparison runs till the end of the string is found, or a
366 ;; non-numeric component shows up (5.6.7 is earlier than "5.6.7 beta",
367 ;; which is probably not what you want in some cases).
368 ;; This code is suitable for existing RCS release numbers.
369 ;; CVS releases are handled reasonably, too (1.3 < 1.4* < 1.5).
370 (let (v1 v2 i1 i2)
371 (catch 'done
372 (or (and (string-match "^\\.?\\([0-9]+\\)" r1)
373 (setq i1 (match-end 0))
374 (setq v1 (string-to-number (match-string 1 r1)))
375 (or (and (string-match "^\\.?\\([0-9]+\\)" r2)
376 (setq i2 (match-end 0))
377 (setq v2 (string-to-number (match-string 1 r2)))
378 (if (> v1 v2) (throw 'done t)
379 (if (< v1 v2) (throw 'done nil)
380 (throw 'done
381 (vc-release-greater-or-equal
382 (substring r1 i1)
383 (substring r2 i2)))))))
384 (throw 'done t)))
385 (or (and (string-match "^\\.?\\([0-9]+\\)" r2)
386 (throw 'done nil))
387 (throw 'done t)))))
388
389(defun vc-backend-release-p (backend release)
390 ;; Return t if we have RELEASE of BACKEND or better
391 (let (i r (ri 0) (ii 0) is rs (installation (vc-backend-release backend)))
392 (if (not (eq installation 'unknown))
393 (cond
394 ((or (eq backend 'RCS) (eq backend 'CVS))
395 (vc-release-greater-or-equal installation release))))))
396
c8de1d91
AS
397;;; functions that operate on RCS revision numbers
398
399(defun vc-trunk-p (rev)
400 ;; return t if REV is a revision on the trunk
401 (not (eq nil (string-match "\\`[0-9]+\\.[0-9]+\\'" rev))))
402
403(defun vc-branch-part (rev)
404 ;; return the branch part of a revision number REV
405 (substring rev 0 (string-match "\\.[0-9]+\\'" rev)))
406
c0d66cb2
RS
407(defun vc-minor-part (rev)
408 ;; return the minor version number of a revision number REV
409 (string-match "[0-9]+\\'" rev)
410 (substring rev (match-beginning 0) (match-end 0)))
411
412(defun vc-previous-version (rev)
413 ;; guess the previous version number
414 (let ((branch (vc-branch-part rev))
415 (minor-num (string-to-number (vc-minor-part rev))))
416 (if (> minor-num 1)
417 ;; version does probably not start a branch or release
418 (concat branch "." (number-to-string (1- minor-num)))
419 (if (vc-trunk-p rev)
420 ;; we are at the beginning of the trunk --
421 ;; don't know anything to return here
422 ""
423 ;; we are at the beginning of a branch --
424 ;; return version of starting point
425 (vc-branch-part branch)))))
426
594722a8
ER
427;; File property caching
428
8c0aaf40
ER
429(defun vc-clear-context ()
430 "Clear all cached file properties and the comment ring."
431 (interactive)
432 (fillarray vc-file-prop-obarray nil)
433 ;; Note: there is potential for minor lossage here if there is an open
434 ;; log buffer with a nonzero local value of vc-comment-ring-index.
c9b35ece 435 (setq vc-comment-ring (make-ring vc-maximum-comment-ring-size)))
8c0aaf40 436
88a2ffaf
RS
437(defun vc-file-clear-masterprops (file)
438 ;; clear all properties of FILE that were retrieved
439 ;; from the master file
440 (vc-file-setprop file 'vc-latest-version nil)
441 (vc-file-setprop file 'vc-your-latest-version nil)
442 (vc-backend-dispatch file
443 (progn ;; SCCS
444 (vc-file-setprop file 'vc-master-locks nil))
445 (progn ;; RCS
446 (vc-file-setprop file 'vc-default-branch nil)
447 (vc-file-setprop file 'vc-head-version nil)
8dd71345 448 (vc-file-setprop file 'vc-master-workfile-version nil)
88a2ffaf
RS
449 (vc-file-setprop file 'vc-master-locks nil))
450 (progn
451 (vc-file-setprop file 'vc-cvs-status nil))))
f3c61d82 452
c8de1d91
AS
453(defun vc-head-version (file)
454 ;; Return the RCS head version of FILE
455 (cond ((vc-file-getprop file 'vc-head-version))
456 (t (vc-fetch-master-properties file)
457 (vc-file-getprop file 'vc-head-version))))
f3c61d82 458
594722a8
ER
459;; Random helper functions
460
c8de1d91
AS
461(defun vc-latest-on-branch-p (file)
462 ;; return t iff the current workfile version of FILE is
463 ;; the latest on its branch.
464 (vc-backend-dispatch file
465 ;; SCCS
466 (string= (vc-workfile-version file) (vc-latest-version file))
467 ;; RCS
468 (let ((workfile-version (vc-workfile-version file)) tip-version)
469 (if (vc-trunk-p workfile-version)
470 (progn
471 ;; Re-fetch the head version number. This is to make
472 ;; sure that no-one has checked in a new version behind
473 ;; our back.
474 (vc-fetch-master-properties file)
475 (string= (vc-file-getprop file 'vc-head-version)
476 workfile-version))
477 ;; If we are not on the trunk, we need to examine the
7d88be52
AS
478 ;; whole current branch. (vc-master-workfile-version
479 ;; is not what we need.)
c8de1d91
AS
480 (save-excursion
481 (set-buffer (get-buffer-create "*vc-info*"))
482 (vc-insert-file (vc-name file) "^desc")
483 (setq tip-version (car (vc-parse-buffer (list (list
484 (concat "^\\(" (regexp-quote (vc-branch-part workfile-version))
485 "\\.[0-9]+\\)\ndate[ \t]+\\([0-9.]+\\);") 1 2)))))
486 (if (get-buffer "*vc-info*")
487 (kill-buffer (get-buffer "*vc-info*")))
488 (string= tip-version workfile-version))))
489 ;; CVS
8dd71345 490 t))
c8de1d91 491
7ef84cf9
RS
492(defun vc-registration-error (file)
493 (if file
590cc449
RS
494 (error "File %s is not under version control" file)
495 (error "Buffer %s is not associated with a file" (buffer-name))))
7ef84cf9 496
594722a8
ER
497(defvar vc-binary-assoc nil)
498
499(defun vc-find-binary (name)
500 "Look for a command anywhere on the subprocess-command search path."
501 (or (cdr (assoc name vc-binary-assoc))
deb9ebc6
PE
502 (catch 'found
503 (mapcar
504 (function
505 (lambda (s)
506 (if s
507 (let ((full (concat s "/" name)))
508 (if (file-executable-p full)
509 (progn
510 (setq vc-binary-assoc
511 (cons (cons name full) vc-binary-assoc))
512 (throw 'found full)))))))
513 exec-path)
514 nil)))
594722a8 515
6aa13729 516(defun vc-do-command (buffer okstatus command file last &rest flags)
594722a8 517 "Execute a version-control command, notifying user and checking for errors.
6aa13729 518Output from COMMAND goes to BUFFER, or *vc* if BUFFER is nil.
594722a8 519The command is successful if its exit status does not exceed OKSTATUS.
2bb00bdd 520 (If OKSTATUS is nil, that means to ignore errors.)
6aa13729
RS
521The last argument of the command is the master name of FILE if LAST is
522`MASTER', or the workfile of FILE if LAST is `WORKFILE'; this is appended
523to an optional list of FLAGS."
b0c9bc8c 524 (and file (setq file (expand-file-name file)))
6aa13729 525 (if (not buffer) (setq buffer "*vc*"))
594722a8 526 (if vc-command-messages
02da6253 527 (message "Running %s on %s..." command file))
1a2f456b 528 (let ((obuf (current-buffer)) (camefrom (current-buffer))
594722a8
ER
529 (squeezed nil)
530 (vc-file (and file (vc-name file)))
632e9525 531 (olddir default-directory)
594722a8 532 status)
6aa13729 533 (set-buffer (get-buffer-create buffer))
8c0aaf40
ER
534 (set (make-local-variable 'vc-parent-buffer) camefrom)
535 (set (make-local-variable 'vc-parent-buffer-name)
536 (concat " from " (buffer-name camefrom)))
632e9525 537 (setq default-directory olddir)
8c0aaf40 538
594722a8 539 (erase-buffer)
315e49ed 540
594722a8
ER
541 (mapcar
542 (function (lambda (s) (and s (setq squeezed (append squeezed (list s))))))
543 flags)
80688f5c 544 (if (and vc-file (eq last 'MASTER))
594722a8 545 (setq squeezed (append squeezed (list vc-file))))
632e9525
RS
546 (if (eq last 'WORKFILE)
547 (progn
548 (let* ((pwd (expand-file-name default-directory))
549 (preflen (length pwd)))
550 (if (string= (substring file 0 preflen) pwd)
551 (setq file (substring file preflen))))
552 (setq squeezed (append squeezed (list file)))))
46cd263f 553 (let ((exec-path (append vc-path exec-path))
eadcb02c
RS
554 ;; Add vc-path to PATH for the execution of this command.
555 (process-environment
556 (cons (concat "PATH=" (getenv "PATH")
993a1a44
RS
557 path-separator
558 (mapconcat 'identity vc-path path-separator))
bcbe4d57 559 process-environment))
b86b9918 560 (w32-quote-process-args t))
1a2f456b 561 (setq status (apply 'call-process command nil t nil squeezed)))
594722a8 562 (goto-char (point-max))
632e9525 563 (set-buffer-modified-p nil)
4805f679 564 (forward-line -1)
2bb00bdd 565 (if (or (not (integerp status)) (and okstatus (< okstatus status)))
594722a8 566 (progn
6aa13729 567 (pop-to-buffer buffer)
594722a8 568 (goto-char (point-min))
4c2d8cf9 569 (shrink-window-if-larger-than-buffer)
02da6253
PE
570 (error "Running %s...FAILED (%s)" command
571 (if (integerp status)
572 (format "status %d" status)
573 status))
594722a8
ER
574 )
575 (if vc-command-messages
02da6253 576 (message "Running %s...OK" command))
594722a8
ER
577 )
578 (set-buffer obuf)
579 status)
580 )
581
c4ae7096
JB
582;;; Save a bit of the text around POSN in the current buffer, to help
583;;; us find the corresponding position again later. This works even
584;;; if all markers are destroyed or corrupted.
c8de1d91 585;;; A lot of this was shamelessly lifted from Sebastian Kremer's rcs.el mode.
c4ae7096
JB
586(defun vc-position-context (posn)
587 (list posn
588 (buffer-size)
589 (buffer-substring posn
590 (min (point-max) (+ posn 100)))))
591
592;;; Return the position of CONTEXT in the current buffer, or nil if we
593;;; couldn't find it.
594(defun vc-find-position-by-context (context)
595 (let ((context-string (nth 2 context)))
596 (if (equal "" context-string)
597 (point-max)
598 (save-excursion
599 (let ((diff (- (nth 1 context) (buffer-size))))
600 (if (< diff 0) (setq diff (- diff)))
601 (goto-char (nth 0 context))
602 (if (or (search-forward context-string nil t)
603 ;; Can't use search-backward since the match may continue
604 ;; after point.
605 (progn (goto-char (- (point) diff (length context-string)))
606 ;; goto-char doesn't signal an error at
607 ;; beginning of buffer like backward-char would
608 (search-forward context-string nil t)))
609 ;; to beginning of OSTRING
610 (- (point) (length context-string))))))))
611
c8de1d91
AS
612(defun vc-buffer-context ()
613 ;; Return a list '(point-context mark-context reparse); from which
614 ;; vc-restore-buffer-context can later restore the context.
c4ae7096 615 (let ((point-context (vc-position-context (point)))
cfadef63
RS
616 ;; Use mark-marker to avoid confusion in transient-mark-mode.
617 (mark-context (if (eq (marker-buffer (mark-marker)) (current-buffer))
618 (vc-position-context (mark-marker))))
619 ;; Make the right thing happen in transient-mark-mode.
ab877583
RM
620 (mark-active nil)
621 ;; We may want to reparse the compilation buffer after revert
622 (reparse (and (boundp 'compilation-error-list) ;compile loaded
623 (let ((curbuf (current-buffer)))
624 ;; Construct a list; each elt is nil or a buffer
625 ;; iff that buffer is a compilation output buffer
626 ;; that contains markers into the current buffer.
627 (save-excursion
7ef84cf9
RS
628 (mapcar (function
629 (lambda (buffer)
ab877583
RM
630 (set-buffer buffer)
631 (let ((errors (or
632 compilation-old-error-list
633 compilation-error-list))
634 (buffer-error-marked-p nil))
6fb6ab11 635 (while (and (consp errors)
ab877583 636 (not buffer-error-marked-p))
a1bda481 637 (and (markerp (cdr (car errors)))
e9c8e248
RM
638 (eq buffer
639 (marker-buffer
a1bda481 640 (cdr (car errors))))
e9c8e248 641 (setq buffer-error-marked-p t))
ab877583 642 (setq errors (cdr errors)))
7ef84cf9 643 (if buffer-error-marked-p buffer))))
ab877583 644 (buffer-list)))))))
c8de1d91
AS
645 (list point-context mark-context reparse)))
646
647(defun vc-restore-buffer-context (context)
648 ;; Restore point/mark, and reparse any affected compilation buffers.
649 ;; CONTEXT is that which vc-buffer-context returns.
650 (let ((point-context (nth 0 context))
651 (mark-context (nth 1 context))
652 (reparse (nth 2 context)))
ab877583
RM
653 ;; Reparse affected compilation buffers.
654 (while reparse
655 (if (car reparse)
656 (save-excursion
657 (set-buffer (car reparse))
658 (let ((compilation-last-buffer (current-buffer)) ;select buffer
659 ;; Record the position in the compilation buffer of
660 ;; the last error next-error went to.
661 (error-pos (marker-position
662 (car (car-safe compilation-error-list)))))
663 ;; Reparse the error messages as far as they were parsed before.
664 (compile-reinitialize-errors '(4) compilation-parsing-end)
665 ;; Move the pointer up to find the error we were at before
666 ;; reparsing. Now next-error should properly go to the next one.
667 (while (and compilation-error-list
27f2f10b 668 (/= error-pos (car (car compilation-error-list))))
ab877583
RM
669 (setq compilation-error-list (cdr compilation-error-list))))))
670 (setq reparse (cdr reparse)))
e1f297e6 671
7b4f934d 672 ;; Restore point and mark
c4ae7096
JB
673 (let ((new-point (vc-find-position-by-context point-context)))
674 (if new-point (goto-char new-point)))
675 (if mark-context
676 (let ((new-mark (vc-find-position-by-context mark-context)))
677 (if new-mark (set-mark new-mark))))))
678
c8de1d91
AS
679(defun vc-revert-buffer1 (&optional arg no-confirm)
680 ;; Revert buffer, try to keep point and mark where user expects them in spite
681 ;; of changes because of expanded version-control key words.
682 ;; This is quite important since otherwise typeahead won't work as expected.
683 (interactive "P")
684 (widen)
685 (let ((context (vc-buffer-context)))
e7ffe86a
RS
686 ;; t means don't call normal-mode; that's to preserve various minor modes.
687 (revert-buffer arg no-confirm t)
c8de1d91
AS
688 (vc-restore-buffer-context context)))
689
594722a8 690
97d3f950 691(defun vc-buffer-sync (&optional not-urgent)
594722a8 692 ;; Make sure the current buffer and its working file are in sync
97d3f950 693 ;; NOT-URGENT means it is ok to continue if the user says not to save.
bbf97570 694 (if (buffer-modified-p)
97d3f950
RS
695 (if (or vc-suppress-confirm
696 (y-or-n-p (format "Buffer %s modified; save it? " (buffer-name))))
697 (save-buffer)
698 (if not-urgent
699 nil
700 (error "Aborted")))))
701
594722a8 702
9a51ed3a 703(defun vc-workfile-unchanged-p (file &optional want-differences-if-changed)
594722a8
ER
704 ;; Has the given workfile changed since last checkout?
705 (let ((checkout-time (vc-file-getprop file 'vc-checkout-time))
706 (lastmod (nth 5 (file-attributes file))))
9a51ed3a
PE
707 (or (equal checkout-time lastmod)
708 (and (or (not checkout-time) want-differences-if-changed)
709 (let ((unchanged (zerop (vc-backend-diff file nil nil
c6d4f628 710 (not want-differences-if-changed)))))
9a51ed3a
PE
711 ;; 0 stands for an unknown time; it can't match any mod time.
712 (vc-file-setprop file 'vc-checkout-time (if unchanged lastmod 0))
713 unchanged)))))
594722a8 714
e1f297e6
ER
715(defun vc-next-action-on-file (file verbose &optional comment)
716 ;;; If comment is specified, it will be used as an admin or checkin comment.
80688f5c 717 (let ((vc-file (vc-name file))
f3c61d82 718 (vc-type (vc-backend file))
8dd71345 719 owner version buffer)
e1f297e6
ER
720 (cond
721
722 ;; if there is no master file corresponding, create one
723 ((not vc-file)
632e9525
RS
724 (vc-register verbose comment)
725 (if vc-initial-comment
726 (setq vc-log-after-operation-hook
727 'vc-checkout-writable-buffer-hook)
728 (vc-checkout-writable-buffer file)))
e1f297e6 729
61dee1e7
AS
730 ;; CVS: changes to the master file need to be
731 ;; merged back into the working file
732 ((and (eq vc-type 'CVS)
733 (or (eq (vc-cvs-status file) 'needs-checkout)
734 (eq (vc-cvs-status file) 'needs-merge)))
8dd71345
AS
735 (if (or vc-dired-mode
736 (yes-or-no-p
737 (format "%s is not up-to-date. Merge in changes now? "
738 (buffer-name))))
61dee1e7 739 (progn
8dd71345
AS
740 (if vc-dired-mode
741 (and (setq buffer (get-file-buffer file))
742 (buffer-modified-p buffer)
743 (switch-to-buffer-other-window buffer)
744 (vc-buffer-sync t))
745 (setq buffer (current-buffer))
746 (vc-buffer-sync t))
747 (if (and buffer (buffer-modified-p buffer)
61dee1e7 748 (not (yes-or-no-p
8dd71345
AS
749 (format
750 "Buffer %s modified; merge file on disc anyhow? "
751 (buffer-name buffer)))))
61dee1e7
AS
752 (error "Merge aborted"))
753 (if (not (zerop (vc-backend-merge-news file)))
754 ;; Overlaps detected - what now? Should use some
755 ;; fancy RCS conflict resolving package, or maybe
756 ;; emerge, but for now, simply warn the user with a
757 ;; message.
758 (message "Conflicts detected!"))
8dd71345
AS
759 (and buffer
760 (vc-resynch-buffer file t (not (buffer-modified-p buffer)))))
61dee1e7
AS
761 (error "%s needs update" (buffer-name))))
762
d5859f32
AS
763 ;; For CVS files with implicit checkout: if unmodified, don't do anything
764 ((and (eq vc-type 'CVS)
765 (eq (vc-checkout-model file) 'implicit)
766 (not (vc-locking-user file))
767 (not verbose))
768 (message "%s is up to date" (buffer-name)))
769
4cbeb71c 770 ;; If there is no lock on the file, assert one and get it.
d5859f32
AS
771 ((not (setq owner (vc-locking-user file)))
772 ;; With implicit checkout, make sure not to lose unsaved changes.
773 (and (eq (vc-checkout-model file) 'implicit)
774 (buffer-modified-p buffer)
775 (vc-buffer-sync))
bbf97570 776 (if (and vc-checkout-carefully
9a51ed3a 777 (not (vc-workfile-unchanged-p file t)))
bbf97570 778 (if (save-window-excursion
6aa13729 779 (pop-to-buffer "*vc-diff*")
bbf97570
RS
780 (goto-char (point-min))
781 (insert-string (format "Changes to %s since last lock:\n\n"
782 file))
783 (not (beep))
784 (yes-or-no-p
785 (concat "File has unlocked changes, "
786 "claim lock retaining changes? ")))
787 (progn (vc-backend-steal file)
788 (vc-mode-line file))
789 (if (not (yes-or-no-p "Revert to checked-in version, instead? "))
2c28ac43 790 (error "Checkout aborted")
bbf97570
RS
791 (vc-revert-buffer1 t t)
792 (vc-checkout-writable-buffer file))
793 )
c6d4f628
RS
794 (if verbose
795 (if (not (eq vc-type 'SCCS))
e163b283
AS
796 (vc-checkout file nil
797 (read-string "Branch or version to move to: "))
2c28ac43 798 (error "Sorry, this is not implemented for SCCS"))
9341ff29
AS
799 (if (vc-latest-on-branch-p file)
800 (vc-checkout-writable-buffer file)
801 (if (yes-or-no-p
802 "This is not the latest version. Really lock it? ")
803 (vc-checkout-writable-buffer file)
804 (if (yes-or-no-p "Lock the latest version instead? ")
805 (vc-checkout-writable-buffer file
1ba1cade
AS
806 (if (vc-trunk-p (vc-workfile-version file))
807 "" ;; this means check out latest on trunk
808 (vc-branch-part (vc-workfile-version file)))))))
9341ff29 809 )))
e1f297e6
ER
810
811 ;; a checked-out version exists, but the user may not own the lock
61dee1e7 812 ((and (not (eq vc-type 'CVS))
8172cd86 813 (not (string-equal owner (vc-user-login-name))))
e1f297e6 814 (if comment
590cc449 815 (error "Sorry, you can't steal the lock on %s this way" file))
b0c9bc8c
AS
816 (and (eq vc-type 'RCS)
817 (not (vc-backend-release-p 'RCS "5.6.2"))
2c28ac43 818 (error "File is locked by %s" owner))
e1f297e6
ER
819 (vc-steal-lock
820 file
c6d4f628
RS
821 (if verbose (read-string "Version to steal: ")
822 (vc-workfile-version file))
e1f297e6 823 owner))
80688f5c 824
c6d4f628 825 ;; OK, user owns the lock on the file
8c0aaf40 826 (t
b0c9bc8c
AS
827 (if vc-dired-mode
828 (find-file-other-window file)
829 (find-file file))
e1f297e6
ER
830
831 ;; give luser a chance to save before checking in.
832 (vc-buffer-sync)
833
834 ;; Revert if file is unchanged and buffer is too.
835 ;; If buffer is modified, that means the user just said no
836 ;; to saving it; in that case, don't revert,
837 ;; because the user might intend to save
838 ;; after finishing the log entry.
80688f5c 839 (if (and (vc-workfile-unchanged-p file)
e1f297e6 840 (not (buffer-modified-p)))
c6d4f628
RS
841 ;; DO NOT revert the file without asking the user!
842 (cond
843 ((yes-or-no-p "Revert to master version? ")
844 (vc-backend-revert file)
845 (vc-resynch-window file t t)))
e1f297e6
ER
846
847 ;; user may want to set nonstandard parameters
848 (if verbose
849 (setq version (read-string "New version level: ")))
850
851 ;; OK, let's do the checkin
852 (vc-checkin file version comment)
8c0aaf40 853 )))))
e1f297e6
ER
854
855(defun vc-next-action-dired (file rev comment)
b0c9bc8c
AS
856 ;; Do a vc-next-action-on-file on all the marked files, possibly
857 ;; passing on the log comment we've just entered.
858 (let ((configuration (current-window-configuration))
8dd71345
AS
859 (dired-buffer (current-buffer))
860 (dired-dir default-directory))
632e9525 861 (dired-map-over-marks
f008ca58
KH
862 (let ((file (dired-get-filename)) p
863 (default-directory default-directory))
b0c9bc8c 864 (message "Processing %s..." file)
8dd71345
AS
865 ;; Adjust the default directory so that checkouts
866 ;; go to the right place.
867 (setq default-directory (file-name-directory file))
b0c9bc8c
AS
868 (vc-next-action-on-file file nil comment)
869 (set-buffer dired-buffer)
8dd71345 870 (setq default-directory dired-dir)
b0c9bc8c
AS
871 (vc-dired-update-line file)
872 (set-window-configuration configuration)
873 (message "Processing %s...done" file))
874 nil t)))
e1f297e6 875
637a8ae9 876;; Here's the major entry point.
594722a8 877
637a8ae9 878;;;###autoload
594722a8
ER
879(defun vc-next-action (verbose)
880 "Do the next logical checkin or checkout operation on the current file.
c6d4f628
RS
881 If you call this from within a VC dired buffer with no files marked,
882it will operate on the file in the current line.
883 If you call this from within a VC dired buffer, and one or more
884files are marked, it will accept a log message and then operate on
885each one. The log message will be used as a comment for any register
886or checkin operations, but ignored when doing checkouts. Attempted
887lock steals will raise an error.
888 A prefix argument lets you specify the version number to use.
80688f5c
RS
889
890For RCS and SCCS files:
594722a8 891 If the file is not already registered, this registers it for version
34291cd2 892control and then retrieves a writable, locked copy for editing.
594722a8 893 If the file is registered and not locked by anyone, this checks out
34291cd2 894a writable and locked file ready for editing.
594722a8
ER
895 If the file is checked out and locked by the calling user, this
896first checks to see if the file has changed since checkout. If not,
897it performs a revert.
e1f297e6
ER
898 If the file has been changed, this pops up a buffer for entry
899of a log message; when the message has been entered, it checks in the
594722a8 900resulting changes along with the log message as change commentary. If
34291cd2 901the variable `vc-keep-workfiles' is non-nil (which is its default), a
594722a8
ER
902read-only copy of the changed file is left in place afterwards.
903 If the file is registered and locked by someone else, you are given
e1f297e6 904the option to steal the lock.
80688f5c
RS
905
906For CVS files:
907 If the file is not already registered, this registers it for version
908control. This does a \"cvs add\", but no \"cvs commit\".
909 If the file is added but not committed, it is committed.
80688f5c
RS
910 If your working file is changed, but the repository file is
911unchanged, this pops up a buffer for entry of a log message; when the
912message has been entered, it checks in the resulting changes along
913with the logmessage as change commentary. A writable file is retained.
914 If the repository file is changed, you are asked if you want to
c6d4f628 915merge in the changes into your working copy."
bbf97570 916
594722a8 917 (interactive "P")
8c0aaf40
ER
918 (catch 'nogo
919 (if vc-dired-mode
920 (let ((files (dired-get-marked-files)))
8dd71345
AS
921 (if (string= ""
922 (mapconcat
b0c9bc8c
AS
923 (function (lambda (f)
924 (if (eq (vc-backend f) 'CVS)
8dd71345
AS
925 (if (or (eq (vc-cvs-status f) 'locally-modified)
926 (eq (vc-cvs-status f) 'locally-added))
b0c9bc8c
AS
927 "@" "")
928 (if (vc-locking-user f) "@" ""))))
929 files ""))
930 (vc-next-action-dired nil nil "dummy")
931 (vc-start-entry nil nil nil
932 "Enter a change comment for the marked files."
933 'vc-next-action-dired))
8dd71345 934 (throw 'nogo nil)))
e1f297e6 935 (while vc-parent-buffer
1a2f456b 936 (pop-to-buffer vc-parent-buffer))
e1f297e6
ER
937 (if buffer-file-name
938 (vc-next-action-on-file buffer-file-name verbose)
7ef84cf9 939 (vc-registration-error nil))))
594722a8
ER
940
941;;; These functions help the vc-next-action entry point
942
c6d4f628 943(defun vc-checkout-writable-buffer (&optional file rev)
34291cd2 944 "Retrieve a writable copy of the latest version of the current buffer's file."
c6d4f628 945 (vc-checkout (or file (buffer-file-name)) t rev)
02da6253
PE
946 )
947
637a8ae9 948;;;###autoload
e1f297e6 949(defun vc-register (&optional override comment)
594722a8
ER
950 "Register the current file into your version-control system."
951 (interactive "P")
f1b82fc8
KH
952 (or buffer-file-name
953 (error "No visited file"))
e837a82f
RS
954 (let ((master (vc-name buffer-file-name)))
955 (and master (file-exists-p master)
956 (error "This file is already registered"))
957 (and master
958 (not (y-or-n-p "Previous master file has vanished. Make a new one? "))
959 (error "This file is already registered")))
02da6253
PE
960 ;; Watch out for new buffers of size 0: the corresponding file
961 ;; does not exist yet, even though buffer-modified-p is nil.
962 (if (and (not (buffer-modified-p))
963 (zerop (buffer-size))
964 (not (file-exists-p buffer-file-name)))
965 (set-buffer-modified-p t))
594722a8 966 (vc-buffer-sync)
993a1a44
RS
967 (cond ((not vc-make-backup-files)
968 ;; inhibit backup for this buffer
969 (make-local-variable 'backup-inhibited)
970 (setq backup-inhibited t)))
594722a8
ER
971 (vc-admin
972 buffer-file-name
e1f297e6
ER
973 (and override
974 (read-string
975 (format "Initial version level for %s: " buffer-file-name))))
594722a8
ER
976 )
977
624b4662 978(defun vc-resynch-window (file &optional keep noquery)
594722a8 979 ;; If the given file is in the current buffer,
a7acbbe4 980 ;; either revert on it so we see expanded keywords,
594722a8 981 ;; or unvisit it (depending on vc-keep-workfiles)
624b4662
RS
982 ;; NOQUERY if non-nil inhibits confirmation for reverting.
983 ;; NOQUERY should be t *only* if it is known the only difference
984 ;; between the buffer and the file is due to RCS rather than user editing!
594722a8
ER
985 (and (string= buffer-file-name file)
986 (if keep
987 (progn
88a2ffaf
RS
988 ;; temporarily remove vc-find-file-hook, so that
989 ;; we don't lose the properties
990 (remove-hook 'find-file-hooks 'vc-find-file-hook)
1ab31687 991 (vc-revert-buffer1 t noquery)
88a2ffaf 992 (add-hook 'find-file-hooks 'vc-find-file-hook)
594722a8 993 (vc-mode-line buffer-file-name))
88a2ffaf 994 (kill-buffer (current-buffer)))))
594722a8 995
503b5c85 996(defun vc-resynch-buffer (file &optional keep noquery)
b0c9bc8c 997 ;; if FILE is currently visited, resynch its buffer
503b5c85
RS
998 (let ((buffer (get-file-buffer file)))
999 (if buffer
1000 (save-excursion
1001 (set-buffer buffer)
1002 (vc-resynch-window file keep noquery)))))
1003
b965445f 1004(defun vc-start-entry (file rev comment msg action &optional after-hook)
e1f297e6
ER
1005 ;; Accept a comment for an operation on FILE revision REV. If COMMENT
1006 ;; is nil, pop up a VC-log buffer, emit MSG, and set the
1007 ;; action on close to ACTION; otherwise, do action immediately.
cdaf7a1a 1008 ;; Remember the file's buffer in vc-parent-buffer (current one if no file).
b965445f 1009 ;; AFTER-HOOK specifies the local value for vc-log-operation-hook.
e1f297e6 1010 (let ((parent (if file (find-file-noselect file) (current-buffer))))
f0b188ed
RS
1011 (if vc-before-checkin-hook
1012 (if file
1013 (save-excursion
1014 (set-buffer parent)
1015 (run-hooks 'vc-before-checkin-hook))
1016 (run-hooks 'vc-before-checkin-hook)))
e1f297e6
ER
1017 (if comment
1018 (set-buffer (get-buffer-create "*VC-log*"))
1019 (pop-to-buffer (get-buffer-create "*VC-log*")))
8c0aaf40
ER
1020 (set (make-local-variable 'vc-parent-buffer) parent)
1021 (set (make-local-variable 'vc-parent-buffer-name)
1022 (concat " from " (buffer-name vc-parent-buffer)))
7e869659 1023 (if file (vc-mode-line file))
37667a5c 1024 (vc-log-mode file)
b965445f
RS
1025 (make-local-variable 'vc-log-after-operation-hook)
1026 (if after-hook
1027 (setq vc-log-after-operation-hook after-hook))
e1f297e6 1028 (setq vc-log-operation action)
e1f297e6
ER
1029 (setq vc-log-version rev)
1030 (if comment
1031 (progn
1032 (erase-buffer)
8c0aaf40
ER
1033 (if (eq comment t)
1034 (vc-finish-logentry t)
1035 (insert comment)
1036 (vc-finish-logentry nil)))
e1f297e6 1037 (message "%s Type C-c C-c when done." msg))))
594722a8 1038
e1f297e6 1039(defun vc-admin (file rev &optional comment)
624b4662 1040 "Check a file into your version-control system.
594722a8 1041FILE is the unmodified name of the file. REV should be the base version
e1f297e6 1042level to check it in under. COMMENT, if specified, is the checkin comment."
b965445f
RS
1043 (vc-start-entry file rev
1044 (or comment (not vc-initial-comment))
1045 "Enter initial comment." 'vc-backend-admin
6bcb1d4e 1046 nil))
e1f297e6 1047
c6d4f628 1048(defun vc-checkout (file &optional writable rev)
e1f297e6
ER
1049 "Retrieve a copy of the latest version of the given file."
1050 ;; If ftp is on this system and the name matches the ange-ftp format
1051 ;; for a remote file, the user is trying something that won't work.
1052 (if (and (string-match "^/[^/:]+:" file) (vc-find-binary "ftp"))
1053 (error "Sorry, you can't check out files over FTP"))
c6d4f628 1054 (vc-backend-checkout file writable rev)
b0c9bc8c 1055 (vc-resynch-buffer file t t))
594722a8
ER
1056
1057(defun vc-steal-lock (file rev &optional owner)
1058 "Steal the lock on the current workfile."
29fc1ce9
RS
1059 (let (file-description)
1060 (if (not owner)
1061 (setq owner (vc-locking-user file)))
1062 (if rev
1063 (setq file-description (format "%s:%s" file rev))
1064 (setq file-description file))
4bc504c8
RS
1065 (if (not (yes-or-no-p (format "Steal the lock on %s from %s? "
1066 file-description owner)))
29fc1ce9
RS
1067 (error "Steal cancelled"))
1068 (pop-to-buffer (get-buffer-create "*VC-mail*"))
1069 (setq default-directory (expand-file-name "~/"))
1070 (auto-save-mode auto-save-default)
1071 (mail-mode)
1072 (erase-buffer)
1073 (mail-setup owner (format "Stolen lock on %s" file-description) nil nil nil
3e3da61f 1074 (list (list 'vc-finish-steal file rev)))
29fc1ce9
RS
1075 (goto-char (point-max))
1076 (insert
1077 (format "I stole the lock on %s, " file-description)
1078 (current-time-string)
1079 ".\n")
1080 (message "Please explain why you stole the lock. Type C-c C-c when done.")))
594722a8 1081
ad014629 1082;; This is called when the notification has been sent.
594722a8 1083(defun vc-finish-steal (file version)
594722a8 1084 (vc-backend-steal file version)
3e3da61f
RS
1085 (if (get-file-buffer file)
1086 (save-excursion
6242bee4 1087 (set-buffer (get-file-buffer file))
3e3da61f 1088 (vc-resynch-window file t t))))
594722a8 1089
594722a8
ER
1090(defun vc-checkin (file &optional rev comment)
1091 "Check in the file specified by FILE.
1092The optional argument REV may be a string specifying the new version level
67242a23 1093\(if nil increment the current level). The file is either retained with write
34291cd2 1094permissions zeroed, or deleted (according to the value of `vc-keep-workfiles').
80688f5c 1095If the back-end is CVS, a writable workfile is always kept.
594722a8
ER
1096COMMENT is a comment string; if omitted, a buffer is
1097popped up to accept a comment."
61446fe7 1098 (vc-start-entry file rev comment
b965445f
RS
1099 "Enter a change comment." 'vc-backend-checkin
1100 'vc-checkin-hook))
594722a8 1101
1a2f456b
ER
1102;;; Here is a checkin hook that may prove useful to sites using the
1103;;; ChangeLog facility supported by Emacs.
3b4dd9a9
RM
1104(defun vc-comment-to-change-log (&optional whoami file-name)
1105 "Enter last VC comment into change log file for current buffer's file.
1106Optional arg (interactive prefix) non-nil means prompt for user name and site.
1107Second arg is file name of change log. \
1108If nil, uses `change-log-default-name'."
43cea1ab
RM
1109 (interactive (if current-prefix-arg
1110 (list current-prefix-arg
1111 (prompt-for-change-log-name))))
41208291
KH
1112 ;; Make sure the defvar for add-log-current-defun-function has been executed
1113 ;; before binding it.
1114 (require 'add-log)
3b4dd9a9
RM
1115 (let (;; Extract the comment first so we get any error before doing anything.
1116 (comment (ring-ref vc-comment-ring 0))
43cea1ab 1117 ;; Don't let add-change-log-entry insert a defun name.
3b4dd9a9
RM
1118 (add-log-current-defun-function 'ignore)
1119 end)
1120 ;; Call add-log to do half the work.
43cea1ab 1121 (add-change-log-entry whoami file-name t t)
3b4dd9a9
RM
1122 ;; Insert the VC comment, leaving point before it.
1123 (setq end (save-excursion (insert comment) (point-marker)))
1124 (if (looking-at "\\s *\\s(")
1125 ;; It starts with an open-paren, as in "(foo): Frobbed."
43cea1ab 1126 ;; So remove the ": " add-log inserted.
3b4dd9a9
RM
1127 (delete-char -2))
1128 ;; Canonicalize the white space between the file name and comment.
1129 (just-one-space)
1130 ;; Indent rest of the text the same way add-log indented the first line.
1131 (let ((indentation (current-indentation)))
1132 (save-excursion
1133 (while (< (point) end)
1134 (forward-line 1)
1135 (indent-to indentation))
c124b1b4 1136 (setq end (point))))
3b4dd9a9 1137 ;; Fill the inserted text, preserving open-parens at bol.
6b60c5d1
BG
1138 (let ((paragraph-separate (concat paragraph-separate "\\|\\s *\\s("))
1139 (paragraph-start (concat paragraph-start "\\|\\s *\\s(")))
43cea1ab 1140 (beginning-of-line)
c124b1b4
RM
1141 (fill-region (point) end))
1142 ;; Canonicalize the white space at the end of the entry so it is
1143 ;; separated from the next entry by a single blank line.
1144 (skip-syntax-forward " " end)
1145 (delete-char (- (skip-syntax-backward " ")))
1146 (or (eobp) (looking-at "\n\n")
1147 (insert "\n"))))
3b4dd9a9 1148
1a2f456b 1149
8c0aaf40 1150(defun vc-finish-logentry (&optional nocomment)
594722a8
ER
1151 "Complete the operation implied by the current log entry."
1152 (interactive)
8c0aaf40
ER
1153 ;; Check and record the comment, if any.
1154 (if (not nocomment)
1155 (progn
1156 (goto-char (point-max))
1157 (if (not (bolp))
1158 (newline))
1159 ;; Comment too long?
1160 (vc-backend-logentry-check vc-log-file)
1161 ;; Record the comment in the comment ring
8c0aaf40
ER
1162 (ring-insert vc-comment-ring (buffer-string))
1163 ))
b2396d1f 1164 ;; Sync parent buffer in case the user modified it while editing the comment.
cdaf7a1a 1165 ;; But not if it is a vc-dired buffer.
b2396d1f 1166 (save-excursion
cdaf7a1a
RS
1167 (set-buffer vc-parent-buffer)
1168 (or vc-dired-mode
1169 (vc-buffer-sync)))
61dee1e7
AS
1170 (if (not vc-log-operation) (error "No log operation is pending"))
1171 ;; save the parameters held in buffer-local variables
1172 (let ((log-operation vc-log-operation)
1173 (log-file vc-log-file)
1174 (log-version vc-log-version)
1175 (log-entry (buffer-string))
1176 (after-hook vc-log-after-operation-hook))
e2bef5c3
RS
1177 ;; Return to "parent" buffer of this checkin and remove checkin window
1178 (pop-to-buffer vc-parent-buffer)
1179 (let ((logbuf (get-buffer "*VC-log*")))
1180 (delete-windows-on logbuf)
1181 (kill-buffer logbuf))
61dee1e7
AS
1182 ;; OK, do it to it
1183 (save-excursion
1184 (funcall log-operation
1185 log-file
1186 log-version
1187 log-entry))
e2bef5c3
RS
1188 ;; Now make sure we see the expanded headers
1189 (if buffer-file-name
e1f297e6 1190 (vc-resynch-window buffer-file-name vc-keep-workfiles t))
37667a5c 1191 (run-hooks after-hook 'vc-finish-logentry-hook)))
594722a8
ER
1192
1193;; Code for access to the comment ring
1194
8c0aaf40
ER
1195(defun vc-previous-comment (arg)
1196 "Cycle backwards through comment history."
1197 (interactive "*p")
1198 (let ((len (ring-length vc-comment-ring)))
1199 (cond ((<= len 0)
1200 (message "Empty comment ring")
1201 (ding))
1202 (t
1203 (erase-buffer)
1204 ;; Initialize the index on the first use of this command
1205 ;; so that the first M-p gets index 0, and the first M-n gets
1206 ;; index -1.
1207 (if (null vc-comment-ring-index)
1208 (setq vc-comment-ring-index
1209 (if (> arg 0) -1
1210 (if (< arg 0) 1 0))))
1211 (setq vc-comment-ring-index
c6bfcd12 1212 (mod (+ vc-comment-ring-index arg) len))
8c0aaf40
ER
1213 (message "%d" (1+ vc-comment-ring-index))
1214 (insert (ring-ref vc-comment-ring vc-comment-ring-index))))))
1215
1216(defun vc-next-comment (arg)
1217 "Cycle forwards through comment history."
1218 (interactive "*p")
1219 (vc-previous-comment (- arg)))
1220
1221(defun vc-comment-search-reverse (str)
1222 "Searches backwards through comment history for substring match."
1223 (interactive "sComment substring: ")
1224 (if (string= str "")
1225 (setq str vc-last-comment-match)
1226 (setq vc-last-comment-match str))
1227 (if (null vc-comment-ring-index)
1228 (setq vc-comment-ring-index -1))
1229 (let ((str (regexp-quote str))
1230 (len (ring-length vc-comment-ring))
1231 (n (1+ vc-comment-ring-index)))
1232 (while (and (< n len) (not (string-match str (ring-ref vc-comment-ring n))))
1233 (setq n (+ n 1)))
1234 (cond ((< n len)
1235 (vc-previous-comment (- n vc-comment-ring-index)))
1236 (t (error "Not found")))))
1237
1238(defun vc-comment-search-forward (str)
1239 "Searches forwards through comment history for substring match."
1240 (interactive "sComment substring: ")
1241 (if (string= str "")
1242 (setq str vc-last-comment-match)
1243 (setq vc-last-comment-match str))
1244 (if (null vc-comment-ring-index)
1245 (setq vc-comment-ring-index 0))
1246 (let ((str (regexp-quote str))
1247 (len (ring-length vc-comment-ring))
1248 (n vc-comment-ring-index))
1249 (while (and (>= n 0) (not (string-match str (ring-ref vc-comment-ring n))))
1250 (setq n (- n 1)))
1251 (cond ((>= n 0)
1252 (vc-next-comment (- n vc-comment-ring-index)))
1253 (t (error "Not found")))))
594722a8
ER
1254
1255;; Additional entry points for examining version histories
1256
637a8ae9 1257;;;###autoload
97d3f950 1258(defun vc-diff (historic &optional not-urgent)
e8ee1ccf
RS
1259 "Display diffs between file versions.
1260Normally this compares the current file and buffer with the most recent
1261checked in version of that file. This uses no arguments.
1262With a prefix argument, it reads the file name to use
1263and two version designators specifying which versions to compare."
48078f8f 1264 (interactive (list current-prefix-arg t))
e1f297e6
ER
1265 (if vc-dired-mode
1266 (set-buffer (find-file-noselect (dired-get-filename))))
8ac8c82f 1267 (while vc-parent-buffer
1a2f456b 1268 (pop-to-buffer vc-parent-buffer))
594722a8
ER
1269 (if historic
1270 (call-interactively 'vc-version-diff)
8c0aaf40 1271 (if (or (null buffer-file-name) (null (vc-name buffer-file-name)))
064726ac
JB
1272 (error
1273 "There is no version-control master associated with this buffer"))
02da6253 1274 (let ((file buffer-file-name)
594722a8 1275 unchanged)
c0d66cb2
RS
1276 (vc-buffer-sync not-urgent)
1277 (setq unchanged (vc-workfile-unchanged-p buffer-file-name))
1278 (if unchanged
1279 (message "No changes to %s since latest version" file)
1280 (vc-backend-diff file)
1281 ;; Ideally, we'd like at this point to parse the diff so that
1282 ;; the buffer effectively goes into compilation mode and we
1283 ;; can visit the old and new change locations via next-error.
1284 ;; Unfortunately, this is just too painful to do. The basic
1285 ;; problem is that the `old' file doesn't exist to be
1286 ;; visited. This plays hell with numerous assumptions in
1287 ;; the diff.el and compile.el machinery.
1288 (set-buffer "*vc-diff*")
1289 (setq default-directory (file-name-directory file))
1290 (if (= 0 (buffer-size))
1291 (progn
1292 (setq unchanged t)
1293 (message "No changes to %s since latest version" file))
1294 (pop-to-buffer "*vc-diff*")
1295 (goto-char (point-min))
1296 (shrink-window-if-larger-than-buffer)))
1297 (not unchanged))))
594722a8
ER
1298
1299(defun vc-version-diff (file rel1 rel2)
1300 "For FILE, report diffs between two stored versions REL1 and REL2 of it.
1301If FILE is a directory, generate diffs between versions for all registered
1302files in or below it."
c0d66cb2 1303 (interactive
79d00189
RS
1304 (let ((file (read-file-name (if buffer-file-name
1305 "File or dir to diff: (default visited file) "
1306 "File or dir to diff: ")
8e710301 1307 default-directory buffer-file-name t))
c0d66cb2
RS
1308 (rel1-default nil) (rel2-default nil))
1309 ;; compute default versions based on the file state
1310 (cond
1311 ;; if it's a directory, don't supply any version defauolt
1312 ((file-directory-p file)
1313 nil)
1314 ;; if the file is locked, use current version as older version
1315 ((vc-locking-user file)
1316 (setq rel1-default (vc-workfile-version file)))
1317 ;; if the file is not locked, use last and previous version as default
1318 (t
1319 (setq rel1-default (vc-previous-version (vc-workfile-version file)))
1320 (setq rel2-default (vc-workfile-version file))))
1321 ;; construct argument list
1322 (list file
8e710301
RS
1323 (read-string (if rel1-default
1324 (concat "Older version: (default "
1325 rel1-default ") ")
1326 "Older version: ")
1327 nil nil rel1-default)
1328 (read-string (if rel2-default
1329 (concat "Newer version: (default "
1330 rel2-default ") ")
ba27415c 1331 "Newer version (default: current source): ")
8e710301 1332 nil nil rel2-default))))
594722a8
ER
1333 (if (string-equal rel1 "") (setq rel1 nil))
1334 (if (string-equal rel2 "") (setq rel2 nil))
1335 (if (file-directory-p file)
1a2f456b 1336 (let ((camefrom (current-buffer)))
594722a8 1337 (set-buffer (get-buffer-create "*vc-status*"))
8c0aaf40
ER
1338 (set (make-local-variable 'vc-parent-buffer) camefrom)
1339 (set (make-local-variable 'vc-parent-buffer-name)
1340 (concat " from " (buffer-name camefrom)))
594722a8 1341 (erase-buffer)
3234e2a3
ER
1342 (insert "Diffs between "
1343 (or rel1 "last version checked in")
1344 " and "
1345 (or rel2 "current workfile(s)")
1346 ":\n\n")
6aa13729 1347 (set-buffer (get-buffer-create "*vc-diff*"))
e1f297e6 1348 (cd file)
594722a8 1349 (vc-file-tree-walk
2f119435 1350 default-directory
594722a8 1351 (function (lambda (f)
a9a59766 1352 (message "Looking at %s" f)
594722a8 1353 (and
3234e2a3
ER
1354 (not (file-directory-p f))
1355 (vc-registered f)
02da6253
PE
1356 (vc-backend-diff f rel1 rel2)
1357 (append-to-buffer "*vc-status*" (point-min) (point-max)))
1358 )))
594722a8
ER
1359 (pop-to-buffer "*vc-status*")
1360 (insert "\nEnd of diffs.\n")
1361 (goto-char (point-min))
1362 (set-buffer-modified-p nil)
1363 )
36bed8bc
RS
1364 (if (zerop (vc-backend-diff file rel1 rel2))
1365 (message "No changes to %s between %s and %s." file rel1 rel2)
6aa13729 1366 (pop-to-buffer "*vc-diff*"))))
594722a8 1367
f1818994
PE
1368;;;###autoload
1369(defun vc-version-other-window (rev)
1370 "Visit version REV of the current buffer in another window.
1371If the current buffer is named `F', the version is named `F.~REV~'.
1372If `F.~REV~' already exists, it is used instead of being re-created."
1373 (interactive "sVersion to visit (default is latest version): ")
1374 (if vc-dired-mode
1375 (set-buffer (find-file-noselect (dired-get-filename))))
1376 (while vc-parent-buffer
1377 (pop-to-buffer vc-parent-buffer))
1378 (if (and buffer-file-name (vc-name buffer-file-name))
1379 (let* ((version (if (string-equal rev "")
1380 (vc-latest-version buffer-file-name)
1381 rev))
1382 (filename (concat buffer-file-name ".~" version "~")))
1383 (or (file-exists-p filename)
1384 (vc-backend-checkout buffer-file-name nil version filename))
1385 (find-file-other-window filename))
1386 (vc-registration-error buffer-file-name)))
1387
594722a8
ER
1388;; Header-insertion code
1389
637a8ae9 1390;;;###autoload
594722a8
ER
1391(defun vc-insert-headers ()
1392 "Insert headers in a file for use with your version-control system.
1393Headers desired are inserted at the start of the buffer, and are pulled from
34291cd2 1394the variable `vc-header-alist'."
594722a8 1395 (interactive)
e1f297e6
ER
1396 (if vc-dired-mode
1397 (find-file-other-window (dired-get-filename)))
8ac8c82f 1398 (while vc-parent-buffer
1a2f456b 1399 (pop-to-buffer vc-parent-buffer))
594722a8
ER
1400 (save-excursion
1401 (save-restriction
1402 (widen)
1403 (if (or (not (vc-check-headers))
820bde8d 1404 (y-or-n-p "Version headers already exist. Insert another set? "))
594722a8
ER
1405 (progn
1406 (let* ((delims (cdr (assq major-mode vc-comment-alist)))
1407 (comment-start-vc (or (car delims) comment-start "#"))
1408 (comment-end-vc (or (car (cdr delims)) comment-end ""))
f3c61d82 1409 (hdstrings (cdr (assoc (vc-backend (buffer-file-name)) vc-header-alist))))
594722a8
ER
1410 (mapcar (function (lambda (s)
1411 (insert comment-start-vc "\t" s "\t"
1412 comment-end-vc "\n")))
1413 hdstrings)
1414 (if vc-static-header-alist
1415 (mapcar (function (lambda (f)
1416 (if (string-match (car f) buffer-file-name)
1417 (insert (format (cdr f) (car hdstrings))))))
1418 vc-static-header-alist))
1419 )
1420 )))))
1421
c8de1d91
AS
1422(defun vc-clear-headers ()
1423 ;; Clear all version headers in the current buffer, i.e. reset them
1424 ;; to the nonexpanded form. Only implemented for RCS, yet.
1425 ;; Don't lose point and mark during this.
d5859f32
AS
1426 (let ((context (vc-buffer-context))
1427 (case-fold-search nil))
c8de1d91 1428 (goto-char (point-min))
d5859f32
AS
1429 (while (re-search-forward
1430 (concat "\\$\\(Author\\|Date\\|Header\\|Id\\|Locker\\|Name\\|"
1431 "RCSfile\\|Revision\\|Source\\|State\\): [^\\$\\n]+\\$")
1432 nil t)
c8de1d91
AS
1433 (replace-match "$\\1$"))
1434 (vc-restore-buffer-context context)))
1435
2f119435 1436;; The VC directory major mode. Coopt Dired for this.
e1f297e6
ER
1437;; All VC commands get mapped into logical equivalents.
1438
2f119435
AS
1439(define-derived-mode vc-dired-mode dired-mode "Dired under VC"
1440 "The major mode used in VC directory buffers. It is derived from Dired.
e1f297e6 1441All Dired commands operate normally. Users currently locking listed files
ee7e9c88 1442are listed in place of the file's owner and group.
e1f297e6
ER
1443Keystrokes bound to VC commands will execute as though they had been called
1444on a buffer attached to the file named in the current Dired buffer line."
2f119435
AS
1445 (setq vc-dired-mode t))
1446
1447(define-key vc-dired-mode-map "\C-xv" vc-prefix-map)
1448(define-key vc-dired-mode-map "g" 'vc-dired-update)
1449(define-key vc-dired-mode-map "=" 'vc-diff)
594722a8 1450
b0c9bc8c
AS
1451(defun vc-dired-state-info (file)
1452 ;; Return the string that indicates the version control status
1453 ;; on a VC dired line.
1454 (let ((cvs-state (and (eq (vc-backend file) 'CVS)
1455 (vc-cvs-status file))))
1456 (if cvs-state
1457 (cond ((eq cvs-state 'up-to-date) nil)
1458 ((eq cvs-state 'needs-checkout) "patch")
1459 ((eq cvs-state 'locally-modified) "modified")
1460 ((eq cvs-state 'needs-merge) "merge")
1461 ((eq cvs-state 'unresolved-conflict) "conflict")
1462 ((eq cvs-state 'locally-added) "added"))
1463 (vc-locking-user file))))
1464
8c0aaf40
ER
1465(defun vc-dired-reformat-line (x)
1466 ;; Hack a directory-listing line, plugging in locking-user info in
34291cd2
RS
1467 ;; place of the user and group info. Should have the beneficial
1468 ;; side-effect of shortening the listing line. Each call starts with
8c0aaf40
ER
1469 ;; point immediately following the dired mark area on the line to be
1470 ;; hacked.
1471 ;;
1472 ;; Simplest possible one:
1473 ;; (insert (concat x "\t")))
1474 ;;
1475 ;; This code, like dired, assumes UNIX -l format.
2f119435
AS
1476 (let ((pos (point)) limit perm owner date-and-file)
1477 (end-of-line)
1478 (setq limit (point))
1479 (goto-char pos)
1480 (cond
1481 ((or
1482 (re-search-forward ;; owner and group
1483"\\([drwxlts-]+ \\) *[0-9]+ \\([^ ]+\\) +[^ ]+ +[0-9]+\\( [^ 0-9]+ [0-9 ][0-9] .*\\)"
1484 limit t)
1485 (re-search-forward ;; only owner displayed
1486"\\([drwxlts-]+ \\) *[0-9]+ \\([^ ]+\\) +[0-9]+\\( [^ 0-9]+ [0-9 ][0-9] .*\\)"
1487 limit t))
1488 (setq perm (match-string 1)
1489 owner (match-string 2)
1490 date-and-file (match-string 3)))
1491 ((re-search-forward ;; OS/2 -l format, no links, owner, group
1492"\\([drwxlts-]+ \\) *[0-9]+\\( [^ 0-9]+ [0-9 ][0-9] .*\\)"
1493 limit t)
1494 (setq perm (match-string 1)
1495 date-and-file (match-string 2))))
80688f5c 1496 (if x (setq x (concat "(" x ")")))
b0c9bc8c 1497 (let ((rep (substring (concat x " ") 0 10)))
2f119435
AS
1498 (replace-match (concat perm rep date-and-file)))))
1499
b0c9bc8c
AS
1500(defun vc-dired-update-line (file)
1501 ;; Update the vc-dired listing line of file -- it is assumed
8dd71345
AS
1502 ;; that point is already on this line. Don't use dired-do-redisplay
1503 ;; for this, because it cannot handle the way vc-dired deals with
1504 ;; subdirectories.
b0c9bc8c 1505 (beginning-of-line)
8dd71345
AS
1506 (forward-char 2)
1507 (let ((start (point)))
1508 (forward-line 1)
1509 (beginning-of-line)
1510 (delete-region start (point))
1511 (insert-directory file dired-listing-switches)
1512 (forward-line -1)
1513 (end-of-line)
1514 (delete-char (- (length file)))
1515 (insert (substring file (length (expand-file-name default-directory))))
1516 (goto-char start))
b0c9bc8c 1517 (vc-dired-reformat-line (vc-dired-state-info file)))
8c0aaf40 1518
2f119435
AS
1519(defun vc-dired-update (verbose)
1520 (interactive "P")
1521 (vc-directory default-directory verbose))
1522
632e9525
RS
1523;;; Note in Emacs 18 the following defun gets overridden
1524;;; with the symbol 'vc-directory-18. See below.
637a8ae9 1525;;;###autoload
2f119435 1526(defun vc-directory (dirname verbose)
632e9525
RS
1527 "Show version-control status of the current directory and subdirectories.
1528Normally it creates a Dired buffer that lists only the locked files
1529in all these directories. With a prefix argument, it lists all files."
2f119435 1530 (interactive "DDired under VC (directory): \nP")
221cc4f4 1531 (require 'dired)
2f119435
AS
1532 (setq dirname (expand-file-name dirname))
1533 ;; force a trailing slash
1534 (if (not (eq (elt dirname (1- (length dirname))) ?/))
1535 (setq dirname (concat dirname "/")))
632e9525 1536 (let (nonempty
2f119435 1537 (dl (length dirname))
b0c9bc8c 1538 (filelist nil) (statelist nil)
2f119435 1539 (old-dir default-directory)
632e9525
RS
1540 dired-buf
1541 dired-buf-mod-count)
1542 (vc-file-tree-walk
2f119435 1543 dirname
b0c9bc8c
AS
1544 (function
1545 (lambda (f)
1546 (if (vc-registered f)
1547 (let ((state (vc-dired-state-info f)))
1548 (and (or verbose state)
1549 (setq filelist (cons (substring f dl) filelist))
1550 (setq statelist (cons state statelist))))))))
1551 (save-window-excursion
1552 (save-excursion
2f119435
AS
1553 ;; This uses a semi-documented feature of dired; giving a switch
1554 ;; argument forces the buffer to refresh each time.
1555 (setq dired-buf
1556 (dired-internal-noselect
1557 (cons dirname (nreverse filelist))
1558 dired-listing-switches 'vc-dired-mode))
1559 (setq nonempty (not (eq 0 (length filelist))))))
8dd71345 1560 (switch-to-buffer dired-buf)
8dd71345
AS
1561 ;; Make a few modifications to the header
1562 (setq buffer-read-only nil)
1563 (goto-char (point-min))
1564 (forward-line 1) ;; Skip header line
1565 (let ((start (point))) ;; Erase (but don't remove) the
1566 (end-of-line) ;; "wildcard" line.
1567 (delete-region start (point)))
1568 (beginning-of-line)
594722a8
ER
1569 (if nonempty
1570 (progn
8dd71345 1571 ;; Plug the version information into the individual lines
e1f297e6 1572 (mapcar
7ef84cf9
RS
1573 (function
1574 (lambda (x)
8c0aaf40
ER
1575 (forward-char 2) ;; skip dired's mark area
1576 (vc-dired-reformat-line x)
7ef84cf9 1577 (forward-line 1))) ;; go to next line
b0c9bc8c 1578 (nreverse statelist))
e1f297e6
ER
1579 (setq buffer-read-only t)
1580 (goto-char (point-min))
8dd71345 1581 (dired-next-line 2)
e1f297e6 1582 )
8dd71345
AS
1583 (dired-next-line 1)
1584 (insert " ")
1585 (setq buffer-read-only t)
02da6253 1586 (message "No files are currently %s under %s"
2f119435 1587 (if verbose "registered" "locked") dirname))
594722a8
ER
1588 ))
1589
632e9525
RS
1590;; Emacs 18 version
1591(defun vc-directory-18 (verbose)
1592 "Show version-control status of all files under the current directory."
1593 (interactive "P")
1594 (let (nonempty (dir default-directory))
1595 (save-excursion
1596 (set-buffer (get-buffer-create "*vc-status*"))
1597 (erase-buffer)
1598 (cd dir)
1599 (vc-file-tree-walk
2f119435 1600 default-directory
632e9525
RS
1601 (function (lambda (f)
1602 (if (vc-registered f)
1603 (let ((user (vc-locking-user f)))
1604 (if (or user verbose)
1605 (insert (format
1606 "%s %s\n"
1607 (concat user) f))))))))
1608 (setq nonempty (not (zerop (buffer-size)))))
2f119435 1609
632e9525
RS
1610 (if nonempty
1611 (progn
1612 (pop-to-buffer "*vc-status*" t)
1613 (goto-char (point-min))
1614 (shrink-window-if-larger-than-buffer)))
1615 (message "No files are currently %s under %s"
1616 (if verbose "registered" "locked") default-directory))
1617 )
1618
1619(or (boundp 'minor-mode-map-alist)
1620 (fset 'vc-directory 'vc-directory-18))
e70bdc98 1621
594722a8
ER
1622;; Named-configuration support for SCCS
1623
1624(defun vc-add-triple (name file rev)
1625 (save-excursion
993a1a44
RS
1626 (find-file (expand-file-name
1627 vc-name-assoc-file
1628 (file-name-as-directory
1629 (expand-file-name (vc-backend-subdirectory-name file)
1630 (file-name-directory file)))))
594722a8
ER
1631 (goto-char (point-max))
1632 (insert name "\t:\t" file "\t" rev "\n")
1633 (basic-save-buffer)
1634 (kill-buffer (current-buffer))
1635 ))
1636
1637(defun vc-record-rename (file newname)
1638 (save-excursion
993a1a44
RS
1639 (find-file
1640 (expand-file-name
1641 vc-name-assoc-file
1642 (file-name-as-directory
1643 (expand-file-name (vc-backend-subdirectory-name file)
1644 (file-name-directory file)))))
594722a8 1645 (goto-char (point-min))
7d847440
RS
1646 ;; (replace-regexp (concat ":" (regexp-quote file) "$") (concat ":" newname))
1647 (while (re-search-forward (concat ":" (regexp-quote file) "$") nil t)
1648 (replace-match (concat ":" newname) nil nil))
594722a8
ER
1649 (basic-save-buffer)
1650 (kill-buffer (current-buffer))
1651 ))
1652
1653(defun vc-lookup-triple (file name)
7b4f934d
ER
1654 ;; Return the numeric version corresponding to a named snapshot of file
1655 ;; If name is nil or a version number string it's just passed through
47ca02a6 1656 (cond ((null name) name)
7b4f934d
ER
1657 ((let ((firstchar (aref name 0)))
1658 (and (>= firstchar ?0) (<= firstchar ?9)))
1659 name)
1660 (t
b7011339
RS
1661 (save-excursion
1662 (set-buffer (get-buffer-create "*vc-info*"))
993a1a44
RS
1663 (vc-insert-file
1664 (expand-file-name
1665 vc-name-assoc-file
1666 (file-name-as-directory
1667 (expand-file-name (vc-backend-subdirectory-name file)
1668 (file-name-directory file)))))
b7011339
RS
1669 (prog1
1670 (car (vc-parse-buffer
1671 (list (list (concat name "\t:\t" file "\t\\(.+\\)") 1))))
1672 (kill-buffer "*vc-info*"))))
1673 ))
594722a8
ER
1674
1675;; Named-configuration entry points
1676
503b5c85
RS
1677(defun vc-snapshot-precondition ()
1678 ;; Scan the tree below the current directory.
1679 ;; If any files are locked, return the name of the first such file.
1680 ;; (This means, neither snapshot creation nor retrieval is allowed.)
1681 ;; If one or more of the files are currently visited, return `visited'.
1682 ;; Otherwise, return nil.
1683 (let ((status nil))
1684 (catch 'vc-locked-example
1685 (vc-file-tree-walk
2f119435 1686 default-directory
503b5c85
RS
1687 (function (lambda (f)
1688 (and (vc-registered f)
1689 (if (vc-locking-user f) (throw 'vc-locked-example f)
1690 (if (get-file-buffer f) (setq status 'visited)))))))
1691 status)))
594722a8 1692
637a8ae9 1693;;;###autoload
594722a8
ER
1694(defun vc-create-snapshot (name)
1695 "Make a snapshot called NAME.
1696The snapshot is made from all registered files at or below the current
1697directory. For each file, the version level of its latest
1698version becomes part of the named configuration."
1699 (interactive "sNew snapshot name: ")
503b5c85
RS
1700 (let ((result (vc-snapshot-precondition)))
1701 (if (stringp result)
1702 (error "File %s is locked" result)
1dabb4e6 1703 (vc-file-tree-walk
2f119435 1704 default-directory
1dabb4e6
PE
1705 (function (lambda (f) (and
1706 (vc-name f)
1707 (vc-backend-assign-name f name)))))
1708 )))
594722a8 1709
637a8ae9 1710;;;###autoload
594722a8 1711(defun vc-retrieve-snapshot (name)
d5859f32
AS
1712 "Retrieve the snapshot called NAME, or latest versions if NAME is empty.
1713When retrieving a snapshot, there must not be any locked files at or below
1714the current directory. If none are locked, all registered files are
1715checked out (unlocked) at their version levels in the snapshot NAME.
1716If NAME is the empty string, all registered files that are not currently
1717locked are updated to the latest versions."
1718 (interactive "sSnapshot name to retrieve (default latest versions): ")
1719 (let ((update (yes-or-no-p "Update any affected buffers? ")))
1720 (if (string= name "")
1721 (progn
1722 (vc-file-tree-walk
1723 default-directory
1724 (function (lambda (f) (and
1725 (vc-registered f)
1726 (not (vc-locking-user f))
1727 (vc-error-occurred
1728 (vc-backend-checkout f nil "")
1729 (if update (vc-resynch-buffer f t t))))))))
1730 (let ((result (vc-snapshot-precondition)))
1731 (if (stringp result)
1732 (error "File %s is locked" result)
1733 (setq update (and (eq result 'visited) update))
1734 (vc-file-tree-walk
1735 default-directory
1736 (function (lambda (f) (and
1737 (vc-name f)
1738 (vc-error-occurred
1739 (vc-backend-checkout f nil name)
1740 (if update (vc-resynch-buffer f t t)))))))
1741 )))))
594722a8
ER
1742
1743;; Miscellaneous other entry points
1744
637a8ae9 1745;;;###autoload
594722a8
ER
1746(defun vc-print-log ()
1747 "List the change log of the current buffer in a window."
1748 (interactive)
e1f297e6
ER
1749 (if vc-dired-mode
1750 (set-buffer (find-file-noselect (dired-get-filename))))
8ac8c82f 1751 (while vc-parent-buffer
1a2f456b 1752 (pop-to-buffer vc-parent-buffer))
594722a8 1753 (if (and buffer-file-name (vc-name buffer-file-name))
632e9525
RS
1754 (let ((file buffer-file-name))
1755 (vc-backend-print-log file)
594722a8 1756 (pop-to-buffer (get-buffer-create "*vc*"))
632e9525 1757 (setq default-directory (file-name-directory file))
b667752d 1758 (goto-char (point-max)) (forward-line -1)
4805f679
BF
1759 (while (looking-at "=*\n")
1760 (delete-char (- (match-end 0) (match-beginning 0)))
1761 (forward-line -1))
594722a8 1762 (goto-char (point-min))
4805f679
BF
1763 (if (looking-at "[\b\t\n\v\f\r ]+")
1764 (delete-char (- (match-end 0) (match-beginning 0))))
4c2d8cf9 1765 (shrink-window-if-larger-than-buffer)
6dfe5fe0 1766 ;; move point to the log entry for the current version
b667752d
AS
1767 (and (not (eq (vc-backend file) 'SCCS))
1768 (re-search-forward
1769 ;; also match some context, for safety
1770 (concat "----\nrevision " (vc-workfile-version file)
1771 "\\(\tlocked by:.*\n\\|\n\\)date: ") nil t)
1772 ;; set the display window so that
1773 ;; the whole log entry is displayed
1774 (let (start end lines)
1775 (beginning-of-line) (forward-line -1) (setq start (point))
1776 (if (not (re-search-forward "^----*\nrevision" nil t))
1777 (setq end (point-max))
1778 (beginning-of-line) (forward-line -1) (setq end (point)))
1779 (setq lines (count-lines start end))
1780 (cond
1781 ;; if the global information and this log entry fit
1782 ;; into the window, display from the beginning
1783 ((< (count-lines (point-min) end) (window-height))
1784 (goto-char (point-min))
1785 (recenter 0)
1786 (goto-char start))
1787 ;; if the whole entry fits into the window,
1788 ;; display it centered
1789 ((< (1+ lines) (window-height))
1790 (goto-char start)
1791 (recenter (1- (- (/ (window-height) 2) (/ lines 2)))))
1792 ;; otherwise (the entry is too large for the window),
1793 ;; display from the start
1794 (t
1795 (goto-char start)
1796 (recenter 0)))))
594722a8 1797 )
7ef84cf9 1798 (vc-registration-error buffer-file-name)
594722a8
ER
1799 )
1800 )
1801
637a8ae9 1802;;;###autoload
594722a8 1803(defun vc-revert-buffer ()
9c95ac44
RS
1804 "Revert the current buffer's file back to the latest checked-in version.
1805This asks for confirmation if the buffer contents are not identical
80688f5c
RS
1806to that version.
1807If the back-end is CVS, this will give you the most recent revision of
1808the file on the branch you are editing."
594722a8 1809 (interactive)
e1f297e6
ER
1810 (if vc-dired-mode
1811 (find-file-other-window (dired-get-filename)))
8ac8c82f 1812 (while vc-parent-buffer
1a2f456b 1813 (pop-to-buffer vc-parent-buffer))
594722a8 1814 (let ((file buffer-file-name)
221cc4f4
RS
1815 ;; This operation should always ask for confirmation.
1816 (vc-suppress-confirm nil)
97d3f950 1817 (obuf (current-buffer)) (changed (vc-diff nil t)))
221cc4f4 1818 (if (and changed (not (yes-or-no-p "Discard changes? ")))
594722a8 1819 (progn
fab2e906
RS
1820 (if (and (window-dedicated-p (selected-window))
1821 (one-window-p t 'selected-frame))
1822 (make-frame-invisible (selected-frame))
1823 (delete-window))
590cc449 1824 (error "Revert cancelled"))
594722a8
ER
1825 (set-buffer obuf))
1826 (if changed
fab2e906
RS
1827 (if (and (window-dedicated-p (selected-window))
1828 (one-window-p t 'selected-frame))
1829 (make-frame-invisible (selected-frame))
1830 (delete-window)))
594722a8 1831 (vc-backend-revert file)
624b4662 1832 (vc-resynch-window file t t)
594722a8
ER
1833 )
1834 )
1835
637a8ae9 1836;;;###autoload
594722a8 1837(defun vc-cancel-version (norevert)
34291cd2
RS
1838 "Get rid of most recently checked in version of this file.
1839A prefix argument means do not revert the buffer afterwards."
594722a8 1840 (interactive "P")
e1f297e6
ER
1841 (if vc-dired-mode
1842 (find-file-other-window (dired-get-filename)))
8ac8c82f
ER
1843 (while vc-parent-buffer
1844 (pop-to-buffer vc-parent-buffer))
c8de1d91 1845 (cond
7e48e092 1846 ((not (vc-registered (buffer-file-name)))
1694bd16
RS
1847 (vc-registration-error (buffer-file-name)))
1848 ((eq (vc-backend (buffer-file-name)) 'CVS)
c8de1d91
AS
1849 (error "Unchecking files under CVS is dangerous and not supported in VC"))
1850 ((vc-locking-user (buffer-file-name))
2c28ac43 1851 (error "This version is locked; use vc-revert-buffer to discard changes"))
c8de1d91 1852 ((not (vc-latest-on-branch-p (buffer-file-name)))
2c28ac43 1853 (error "This is not the latest version--VC cannot cancel it")))
7e48e092
AS
1854 (let* ((target (vc-workfile-version (buffer-file-name)))
1855 (recent (if (vc-trunk-p target) "" (vc-branch-part target)))
1856 (config (current-window-configuration)) done)
1857 (if (null (yes-or-no-p (format "Remove version %s from master? " target)))
7b4f934d 1858 nil
c8de1d91
AS
1859 (setq norevert (or norevert (not
1860 (yes-or-no-p "Revert buffer to most recent remaining version? "))))
7b4f934d 1861 (vc-backend-uncheck (buffer-file-name) target)
7e48e092
AS
1862 ;; Check out the most recent remaining version. If it fails, because
1863 ;; the whole branch got deleted, do a double-take and check out the
1864 ;; version where the branch started.
1865 (while (not done)
1866 (condition-case err
1867 (progn
1868 (if norevert
1869 ;; Check out locked, but only to disc, and keep
1870 ;; modifications in the buffer.
1871 (vc-backend-checkout (buffer-file-name) t recent)
1872 ;; Check out unlocked, and revert buffer.
1873 (vc-checkout (buffer-file-name) nil recent))
1874 (setq done t))
ae2506d0
AS
1875 ;; If the checkout fails, vc-do-command signals an error.
1876 ;; We catch this error, check the reason, correct the
1877 ;; version number, and try a second time.
7e48e092
AS
1878 (error (set-buffer "*vc*")
1879 (goto-char (point-min))
ae2506d0 1880 (if (search-forward "no side branches present for" nil t)
7e48e092 1881 (progn (setq recent (vc-branch-part recent))
ae2506d0
AS
1882 ;; vc-do-command popped up a window with
1883 ;; the error message. Get rid of it, by
1884 ;; restoring the old window configuration.
7e48e092
AS
1885 (set-window-configuration config))
1886 ;; No, it was some other error: re-signal it.
1887 (signal (car err) (cdr err))))))
1888 ;; If norevert, clear version headers and mark the buffer modified.
1889 (if norevert
1890 (progn
1891 (set-visited-file-name (buffer-file-name))
1892 (if (not vc-make-backup-files)
1893 ;; inhibit backup for this buffer
1894 (progn (make-local-variable 'backup-inhibited)
1895 (setq backup-inhibited t)))
1896 (if (eq (vc-backend (buffer-file-name)) 'RCS)
1897 (progn (setq buffer-read-only nil)
1898 (vc-clear-headers)))
1899 (vc-mode-line (buffer-file-name))))
1900 (message "Version %s has been removed from the master" target)
c8de1d91 1901 )))
594722a8 1902
29fc1ce9 1903;;;###autoload
594722a8 1904(defun vc-rename-file (old new)
34291cd2
RS
1905 "Rename file OLD to NEW, and rename its master file likewise."
1906 (interactive "fVC rename file: \nFRename to: ")
80688f5c
RS
1907 ;; There are several ways of renaming files under CVS 1.3, but they all
1908 ;; have serious disadvantages. See the FAQ (available from think.com in
1909 ;; pub/cvs/). I'd rather send the user an error, than do something he might
1910 ;; consider to be wrong. When the famous, long-awaited rename database is
1911 ;; implemented things might change for the better. This is unlikely to occur
1912 ;; until CVS 2.0 is released. --ceder 1994-01-23 21:27:51
f3c61d82 1913 (if (eq (vc-backend old) 'CVS)
2c28ac43 1914 (error "Renaming files under CVS is dangerous and not supported in VC"))
594722a8 1915 (let ((oldbuf (get-file-buffer old)))
d52f0de9 1916 (if (and oldbuf (buffer-modified-p oldbuf))
590cc449 1917 (error "Please save files before moving them"))
594722a8 1918 (if (get-file-buffer new)
590cc449 1919 (error "Already editing new file name"))
d52f0de9
RS
1920 (if (file-exists-p new)
1921 (error "New file already exists"))
594722a8
ER
1922 (let ((oldmaster (vc-name old)))
1923 (if oldmaster
d52f0de9
RS
1924 (progn
1925 (if (vc-locking-user old)
1926 (error "Please check in files before moving them"))
1927 (if (or (file-symlink-p oldmaster)
1928 ;; This had FILE, I changed it to OLD. -- rms.
1929 (file-symlink-p (vc-backend-subdirectory-name old)))
1930 (error "This is not a safe thing to do in the presence of symbolic links"))
1931 (rename-file
1932 oldmaster
f3c61d82 1933 (let ((backend (vc-backend old))
d52f0de9
RS
1934 (newdir (or (file-name-directory new) ""))
1935 (newbase (file-name-nondirectory new)))
1936 (catch 'found
1937 (mapcar
1938 (function
1939 (lambda (s)
1940 (if (eq backend (cdr s))
1941 (let* ((newmaster (format (car s) newdir newbase))
1942 (newmasterdir (file-name-directory newmaster)))
1943 (if (or (not newmasterdir)
1944 (file-directory-p newmasterdir))
1945 (throw 'found newmaster))))))
1946 vc-master-templates)
1947 (error "New file lacks a version control directory"))))))
594722a8
ER
1948 (if (or (not oldmaster) (file-exists-p old))
1949 (rename-file old new)))
1950; ?? Renaming a file might change its contents due to keyword expansion.
1951; We should really check out a new copy if the old copy was precisely equal
1952; to some checked in version. However, testing for this is tricky....
1953 (if oldbuf
1954 (save-excursion
1955 (set-buffer oldbuf)
4c145b9e
RS
1956 (let ((buffer-read-only buffer-read-only))
1957 (set-visited-file-name new))
1958 (vc-backend new)
1959 (vc-mode-line new)
594722a8 1960 (set-buffer-modified-p nil))))
60213ed0
RS
1961 ;; This had FILE, I changed it to OLD. -- rms.
1962 (vc-backend-dispatch old
80688f5c
RS
1963 (vc-record-rename old new) ;SCCS
1964 nil ;RCS
1965 nil ;CVS
1966 )
594722a8
ER
1967 )
1968
637a8ae9 1969;;;###autoload
f35ecf88 1970(defun vc-update-change-log (&rest args)
73a9679c 1971 "Find change log file and add entries from recent RCS/CVS logs.
d68e6990
RS
1972Normally, find log entries for all registered files in the default
1973directory using `rcs2log', which finds CVS logs preferentially.
f35ecf88 1974The mark is left at the end of the text prepended to the change log.
d68e6990 1975
f35ecf88 1976With prefix arg of C-u, only find log entries for the current buffer's file.
d68e6990
RS
1977
1978With any numeric prefix arg, find log entries for all currently visited
1979files that are under version control. This puts all the entries in the
1980log for the default directory, which may not be appropriate.
1981
73a9679c
RS
1982From a program, any arguments are assumed to be filenames and are
1983passed to the `rcs2log' script after massaging to be relative to the
1984default directory."
67242a23
RM
1985 (interactive
1986 (cond ((consp current-prefix-arg) ;C-u
1987 (list buffer-file-name))
1988 (current-prefix-arg ;Numeric argument.
1989 (let ((files nil)
1990 (buffers (buffer-list))
1991 file)
1992 (while buffers
1993 (setq file (buffer-file-name (car buffers)))
f3c61d82 1994 (and file (vc-backend file)
4b40fdea 1995 (setq files (cons file files)))
67242a23 1996 (setq buffers (cdr buffers)))
4b40fdea
PE
1997 files))
1998 (t
73a9679c
RS
1999 ;; `rcs2log' will find the relevant RCS or CVS files
2000 ;; relative to the curent directory if none supplied.
2001 nil)))
449decf5 2002 (let ((odefault default-directory)
124c852b
RS
2003 (changelog (find-change-log))
2004 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
2005 (tempfile (make-temp-name
2006 (concat (file-name-as-directory
2007 (directory-file-name (or (getenv "TMPDIR")
2008 (getenv "TMP")
2009 (getenv "TEMP")
2010 "/tmp")))
2011 "vc")))
b91916f3 2012 (full-name (or add-log-full-name
8172cd86
AS
2013 (user-full-name)
2014 (user-login-name)
2015 (format "uid%d" (number-to-string (user-uid)))))
b91916f3
RS
2016 (mailing-address (or add-log-mailing-address
2017 user-mail-address)))
124c852b 2018 (find-file-other-window changelog)
41dfb835
RS
2019 (barf-if-buffer-read-only)
2020 (vc-buffer-sync)
2021 (undo-boundary)
2022 (goto-char (point-min))
2023 (push-mark)
2024 (message "Computing change log entries...")
4b40fdea 2025 (message "Computing change log entries... %s"
124c852b
RS
2026 (unwind-protect
2027 (progn
2028 (cd odefault)
2029 (if (eq 0 (apply 'call-process "rcs2log" nil
2030 (list t tempfile) nil
2031 "-c" changelog
2032 "-u" (concat (vc-user-login-name)
2033 "\t" full-name
2034 "\t" mailing-address)
2035 (mapcar
2036 (function
2037 (lambda (f)
2038 (file-relative-name
2039 (if (file-name-absolute-p f)
2040 f
2041 (concat odefault f)))))
2042 args)))
2043 "done"
2044 (pop-to-buffer
2045 (set-buffer (get-buffer-create "*vc*")))
2046 (erase-buffer)
2047 (insert-file tempfile)
2048 "failed"))
2049 (cd (file-name-directory changelog))
2050 (delete-file tempfile)))))
7d2d9482
RS
2051\f
2052;; vc-annotate functionality (CVS only).
2053(defvar vc-annotate-mode nil
2054 "Variable indicating if VC-Annotate mode is active.")
2055
f80f7bc2 2056(defvar vc-annotate-mode-map nil
7d2d9482
RS
2057 "Local keymap used for VC-Annotate mode.")
2058
f80f7bc2
RS
2059(defvar vc-annotate-mode-menu nil
2060 "Local keymap used for VC-Annotate mode's menu bar menu.")
2061
7d2d9482
RS
2062;; Syntax Table
2063(defvar vc-annotate-mode-syntax-table nil
2064 "Syntax table used in VC-Annotate mode buffers.")
2065
f80f7bc2
RS
2066;; Declare globally instead of additional parameter to
2067;; temp-buffer-show-function (not possible to pass more than one
2068;; parameter).
2069(defvar vc-annotate-ratio nil)
2070
7d2d9482
RS
2071(defun vc-annotate-mode-variables ()
2072 (if (not vc-annotate-mode-syntax-table)
2073 (progn (setq vc-annotate-mode-syntax-table (make-syntax-table))
2074 (set-syntax-table vc-annotate-mode-syntax-table)))
2075 (if (not vc-annotate-mode-map)
f80f7bc2
RS
2076 (setq vc-annotate-mode-map (make-sparse-keymap)))
2077 (setq vc-annotate-mode-menu (make-sparse-keymap "Annotate"))
2078 (define-key vc-annotate-mode-map [menu-bar]
2079 (make-sparse-keymap "VC-Annotate"))
2080 (define-key vc-annotate-mode-map [menu-bar vc-annotate-mode]
2081 (cons "VC-Annotate" vc-annotate-mode-menu)))
7d2d9482
RS
2082
2083(defun vc-annotate-mode ()
2084 "Major mode for buffers displaying output from the CVS `annotate' command.
2085
2086You can use the mode-specific menu to alter the time-span of the used
2087colors. See variable `vc-annotate-menu-elements' for customizing the
2088menu items."
2089 (interactive)
2090 (kill-all-local-variables) ; Recommended by RMS.
2091 (vc-annotate-mode-variables) ; This defines various variables.
2092 (use-local-map vc-annotate-mode-map) ; This provides the local keymap.
2093 (set-syntax-table vc-annotate-mode-syntax-table)
2094 (setq major-mode 'vc-annotate-mode) ; This is how `describe-mode'
2095 ; finds out what to describe.
2096 (setq mode-name "Annotate") ; This goes into the mode line.
2097 (run-hooks 'vc-annotate-mode-hook)
2098 (vc-annotate-add-menu))
2099
2100(defun vc-annotate-display-default (&optional event)
2101 "Use the default color spectrum for VC Annotate mode."
2102 (interactive)
f80f7bc2
RS
2103 (message "Redisplaying annotation...")
2104 (vc-annotate-display (get-buffer (buffer-name)))
2105 (message "Redisplaying annotation...done"))
7d2d9482
RS
2106
2107(defun vc-annotate-add-menu ()
2108 "Adds the menu 'Annotate' to the menu bar in VC-Annotate mode."
7d2d9482
RS
2109 (define-key vc-annotate-mode-menu [default]
2110 '("Default" . vc-annotate-display-default))
2111 (let ((menu-elements vc-annotate-menu-elements))
2112 (while menu-elements
2113 (let* ((element (car menu-elements))
2114 (days (round (* element
2115 (vc-annotate-car-last-cons vc-annotate-color-map)
2116 0.7585))))
2117 (setq menu-elements (cdr menu-elements))
2118 (define-key vc-annotate-mode-menu
2119 (vector days)
2120 (cons (format "Span %d days"
2121 days)
2122 `(lambda ()
2123 ,(format "Use colors spanning %d days" days)
f80f7bc2
RS
2124 (interactive)
2125 (message "Redisplaying annotation...")
2126 (vc-annotate-display
2127 (get-buffer (buffer-name))
2128 (vc-annotate-time-span vc-annotate-color-map ,element))
2129 (message "Redisplaying annotation...done"))))))))
594722a8 2130
7d2d9482
RS
2131;;;###autoload
2132(defun vc-annotate (ratio)
2133 "Display the result of the CVS `annotate' command using colors.
2134New lines are displayed in red, old in blue.
2135A prefix argument specifies a factor for stretching the time scale.
2136
2137`vc-annotate-menu-elements' customizes the menu elements of the
2138mode-specific menu. `vc-annotate-color-map' and
2139`vc-annotate-very-old-color' defines the mapping of time to
2140colors. `vc-annotate-background' specifies the background color."
2141 (interactive "p")
2142 (if (not (eq (vc-buffer-backend) 'CVS)) ; This only works with CVS
2143 (vc-registration-error (buffer-file-name)))
2144 (message "Annotating...")
2145 (let ((temp-buffer-name (concat "*cvs annotate " (buffer-name) "*"))
2146 (temp-buffer-show-function 'vc-annotate-display)
2147 (vc-annotate-ratio ratio))
2148 (with-output-to-temp-buffer temp-buffer-name
2149 (call-process "cvs" nil (get-buffer temp-buffer-name) nil
2150 "annotate" (file-name-nondirectory (buffer-file-name)))))
2151 (message "Annotating... done"))
2152
2153(defun vc-annotate-car-last-cons (assoc-list)
2154 "Return car of last cons in ASSOC-LIST."
2155 (if (not (eq nil (cdr assoc-list)))
2156 (vc-annotate-car-last-cons (cdr assoc-list))
2157 (car (car assoc-list))))
2158
2159;; Return an association list with span factor applied to the
2160;; time-span of assoc-list. Optionaly quantize to the factor of
2161;; quantize.
2162(defun vc-annotate-time-span (assoc-list span &optional quantize)
2163 ;; Apply span to each car of every cons
2164 (if (not (eq nil assoc-list))
2165 (append (list (cons (* (car (car assoc-list)) span)
2166 (cdr (car assoc-list))))
2167 (vc-annotate-time-span (nthcdr (cond (quantize) ; optional
2168 (1)) ; Default to cdr
2169 assoc-list) span quantize))))
2170
2171(defun vc-annotate-compcar (threshold &rest args)
2172 "Test successive cars of ARGS against THRESHOLD.
2173Return the first cons which CAR is not less than THRESHOLD, nil otherwise"
2174 ;; If no list is exhausted,
2175 (if (and (not (memq 'nil args)) (< (car (car (car args))) threshold))
2176 ;; apply to CARs.
2177 (apply 'vc-annotate-compcar threshold
2178 ;; Recurse for rest of elements.
2179 (mapcar 'cdr args))
2180 ;; Return the proper result
2181 (car (car args))))
2182
2183(defun vc-annotate-display (buffer &optional color-map)
2184 "Do the VC-Annotate display in BUFFER using COLOR-MAP."
2185
f80f7bc2
RS
2186 ;; Handle the case of the global variable vc-annotate-ratio being
2187 ;; set. This variable is used to pass information from function
2188 ;; vc-annotate since it is not possible to use another parameter
2189 ;; (see temp-buffer-show-function).
7d2d9482 2190 (if (and (not color-map) vc-annotate-ratio)
f80f7bc2
RS
2191 ;; This will only be true if called from vc-annotate with ratio
2192 ;; being non-nil.
2193 (setq color-map (vc-annotate-time-span vc-annotate-color-map
2194 vc-annotate-ratio)))
7d2d9482
RS
2195
2196 ;; We need a list of months and their corresponding numbers.
2197 (let* ((local-month-numbers
2198 '(("Jan" . 1) ("Feb" . 2) ("Mar" . 3) ("Apr" . 4)
2199 ("May" . 5) ("Jun" . 6) ("Jul" . 7) ("Aug" . 8)
2200 ("Sep" . 9) ("Oct" . 10) ("Nov" . 11) ("Dec" . 12)))
2201 ;; XEmacs use extents, GNU Emacs overlays.
2202 (overlay-or-extent (if (string-match "XEmacs" emacs-version)
2203 (cons 'make-extent 'set-extent-property)
2204 (cons 'make-overlay 'overlay-put)))
2205 (make-overlay-or-extent (car overlay-or-extent))
2206 (set-property-overlay-or-extent (cdr overlay-or-extent)))
2207
2208 (set-buffer buffer)
2209 (display-buffer buffer)
2210 (if (not vc-annotate-mode) ; Turn on vc-annotate-mode if not done
2211 (vc-annotate-mode))
2212 (goto-char (point-min)) ; Position at the top of the buffer.
2213 (while (re-search-forward
2214 "^[0-9]+\\(\.[0-9]+\\)*\\s-+(\\sw+\\s-+\\([0-9]+\\)-\\(\\sw+\\)-\\([0-9]+\\)): "
2215 nil t)
2216
2217 (let* (;; Unfortunately, order is important. match-string will
2218 ;; be corrupted by extent functions in XEmacs. Access
2219 ;; string-matches first.
2220 (day (string-to-number (match-string 2)))
2221 (month (cdr (assoc (match-string 3) local-month-numbers)))
2222 (year-tmp (string-to-number (match-string 4)))
2223 (year (+ (if (> 100 year-tmp) 1900 0) year-tmp)) ; Possible millenium problem
2224 (high (- (car (current-time))
2225 (car (encode-time 0 0 0 day month year))))
2226 (color (cond ((vc-annotate-compcar high (cond (color-map)
2227 (vc-annotate-color-map))))
2228 ((cons nil vc-annotate-very-old-color))))
2229 ;; substring from index 1 to remove any leading `#' in the name
2230 (face-name (concat "vc-annotate-face-" (substring (cdr color) 1)))
2231 ;; Make the face if not done.
2232 (face (cond ((intern-soft face-name))
2233 ((make-face (intern face-name)))))
2234 (point (point))
2235 (foo (forward-line 1))
2236 (overlay (cond ((if (string-match "XEmacs" emacs-version)
2237 (extent-at point)
2238 (car (overlays-at point ))))
2239 ((apply make-overlay-or-extent point (point) nil)))))
2240
2241 (if vc-annotate-background
2242 (set-face-background face vc-annotate-background))
2243 (set-face-foreground face (cdr color))
2244 (apply set-property-overlay-or-extent overlay
2245 'face face nil)))))
2246\f
c6d4f628 2247;; Collect back-end-dependent stuff here
594722a8 2248
594722a8
ER
2249(defun vc-backend-admin (file &optional rev comment)
2250 ;; Register a file into the version-control system
2251 ;; Automatically retrieves a read-only version of the file with
2252 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
2253 ;; it deletes the workfile.
2254 (vc-file-clearprops file)
2255 (or vc-default-back-end
2256 (setq vc-default-back-end (if (vc-find-binary "rcs") 'RCS 'SCCS)))
2257 (message "Registering %s..." file)
a633d9af
RS
2258 (let ((switches
2259 (if (stringp vc-register-switches)
2260 (list vc-register-switches)
2261 vc-register-switches))
2262 (backend
594722a8
ER
2263 (cond
2264 ((file-exists-p (vc-backend-subdirectory-name)) vc-default-back-end)
2265 ((file-exists-p "RCS") 'RCS)
2266 ((file-exists-p "SCCS") 'SCCS)
80688f5c 2267 ((file-exists-p "CVS") 'CVS)
594722a8
ER
2268 (t vc-default-back-end))))
2269 (cond ((eq backend 'SCCS)
a1d713ef
AS
2270 ;; If there is no SCCS subdirectory yet, create it.
2271 ;; (SCCS could do without it, but VC requires it to be there.)
2272 (if (not (file-exists-p "SCCS")) (make-directory "SCCS"))
a633d9af
RS
2273 (apply 'vc-do-command nil 0 "admin" file 'MASTER ;; SCCS
2274 (and rev (concat "-r" rev))
2275 "-fb"
2276 (concat "-i" file)
2277 (and comment (concat "-y" comment))
2278 (format
2279 (car (rassq 'SCCS vc-master-templates))
2280 (or (file-name-directory file) "")
2281 (file-name-nondirectory file))
2282 switches)
594722a8
ER
2283 (delete-file file)
2284 (if vc-keep-workfiles
6aa13729 2285 (vc-do-command nil 0 "get" file 'MASTER)))
594722a8 2286 ((eq backend 'RCS)
a633d9af
RS
2287 (apply 'vc-do-command nil 0 "ci" file 'WORKFILE ;; RCS
2288 ;; if available, use the secure registering option
2289 (and (vc-backend-release-p 'RCS "5.6.4") "-i")
2290 (concat (if vc-keep-workfiles "-u" "-r") rev)
2291 (and comment (concat "-t-" comment))
2292 switches))
80688f5c 2293 ((eq backend 'CVS)
a633d9af
RS
2294 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE ;; CVS
2295 "add"
2296 (and comment (string-match "[^\t\n ]" comment)
2297 (concat "-m" comment))
2298 switches)
594722a8
ER
2299 )))
2300 (message "Registering %s...done" file)
2301 )
2302
f1818994 2303(defun vc-backend-checkout (file &optional writable rev workfile)
594722a8 2304 ;; Retrieve a copy of a saved version into a workfile
503b5c85
RS
2305 (let ((filename (or workfile file))
2306 (file-buffer (get-file-buffer file))
2c28ac43 2307 switches)
f1818994 2308 (message "Checking out %s..." filename)
f797cb30 2309 (save-excursion
2c28ac43 2310 ;; Change buffers to get local value of vc-checkout-switches.
503b5c85 2311 (if file-buffer (set-buffer file-buffer))
2c28ac43
RS
2312 (setq switches (if (stringp vc-checkout-switches)
2313 (list vc-checkout-switches)
2314 vc-checkout-switches))
f008ca58
KH
2315 ;; Save this buffer's default-directory
2316 ;; and use save-excursion to make sure it is restored
2317 ;; in the same buffer it was saved in.
2318 (let ((default-directory default-directory))
2319 (save-excursion
2320 ;; Adjust the default-directory so that the check-out creates
2321 ;; the file in the right place.
2322 (setq default-directory (file-name-directory filename))
2323 (vc-backend-dispatch file
2324 (progn ;; SCCS
2325 (and rev (string= rev "") (setq rev nil))
2326 (if workfile
2327 ;; Some SCCS implementations allow checking out directly to a
2328 ;; file using the -G option, but then some don't so use the
2329 ;; least common denominator approach and use the -p option
2330 ;; ala RCS.
2331 (let ((vc-modes (logior (file-modes (vc-name file))
2332 (if writable 128 0)))
2333 (failed t))
2334 (unwind-protect
2335 (progn
2336 (apply 'vc-do-command
2337 nil 0 "/bin/sh" file 'MASTER "-c"
2338 ;; Some shells make the "" dummy argument into $0
2339 ;; while others use the shell's name as $0 and
2340 ;; use the "" as $1. The if-statement
2341 ;; converts the latter case to the former.
2342 (format "if [ x\"$1\" = x ]; then shift; fi; \
29fc1ce9
RS
2343 umask %o; exec >\"$1\" || exit; \
2344 shift; umask %o; exec get \"$@\""
f008ca58
KH
2345 (logand 511 (lognot vc-modes))
2346 (logand 511 (lognot (default-file-modes))))
2347 "" ; dummy argument for shell's $0
2348 filename
2349 (if writable "-e")
2350 "-p"
2351 (and rev
2352 (concat "-r" (vc-lookup-triple file rev)))
2353 switches)
2354 (setq failed nil))
2355 (and failed (file-exists-p filename)
2356 (delete-file filename))))
2357 (apply 'vc-do-command nil 0 "get" file 'MASTER ;; SCCS
2358 (if writable "-e")
2359 (and rev (concat "-r" (vc-lookup-triple file rev)))
2360 switches)
2361 (vc-file-setprop file 'vc-workfile-version nil)))
2362 (if workfile ;; RCS
2363 ;; RCS doesn't let us check out into arbitrary file names directly.
2364 ;; Use `co -p' and make stdout point to the correct file.
2365 (let ((vc-modes (logior (file-modes (vc-name file))
2366 (if writable 128 0)))
2367 (failed t))
2368 (unwind-protect
2369 (progn
2370 (apply 'vc-do-command
2371 nil 0 "/bin/sh" file 'MASTER "-c"
2372 ;; See the SCCS case, above, regarding the
2373 ;; if-statement.
2374 (format "if [ x\"$1\" = x ]; then shift; fi; \
29fc1ce9
RS
2375 umask %o; exec >\"$1\" || exit; \
2376 shift; umask %o; exec co \"$@\""
f008ca58
KH
2377 (logand 511 (lognot vc-modes))
2378 (logand 511 (lognot (default-file-modes))))
2379 "" ; dummy argument for shell's $0
2380 filename
2381 (if writable "-l")
2382 (concat "-p" rev)
2383 switches)
2384 (setq failed nil))
2385 (and failed (file-exists-p filename) (delete-file filename))))
2386 (let (new-version)
2387 ;; if we should go to the head of the trunk,
2388 ;; clear the default branch first
2389 (and rev (string= rev "")
2390 (vc-do-command nil 0 "rcs" file 'MASTER "-b"))
2391 ;; now do the checkout
2392 (apply 'vc-do-command
2393 nil 0 "co" file 'MASTER
2394 ;; If locking is not strict, force to overwrite
2395 ;; the writable workfile.
2396 (if (eq (vc-checkout-model file) 'implicit) "-f")
2397 (if writable "-l")
2398 (if rev (concat "-r" rev)
2399 ;; if no explicit revision was specified,
2400 ;; check out that of the working file
2401 (let ((workrev (vc-workfile-version file)))
2402 (if workrev (concat "-r" workrev)
2403 nil)))
2404 switches)
2405 ;; determine the new workfile version
2406 (save-excursion
2407 (set-buffer "*vc*")
2408 (goto-char (point-min))
2409 (setq new-version
2410 (if (re-search-forward "^revision \\([0-9.]+\\).*\n" nil t)
2411 (buffer-substring (match-beginning 1) (match-end 1)))))
2412 (vc-file-setprop file 'vc-workfile-version new-version)
2413 ;; if necessary, adjust the default branch
2414 (and rev (not (string= rev ""))
2415 (vc-do-command nil 0 "rcs" file 'MASTER
2416 (concat "-b" (if (vc-latest-on-branch-p file)
2417 (if (vc-trunk-p new-version) nil
2418 (vc-branch-part new-version))
2419 new-version))))))
2420 (if workfile ;; CVS
2421 ;; CVS is much like RCS
2422 (let ((failed t))
2423 (unwind-protect
2424 (progn
2425 (apply 'vc-do-command
2426 nil 0 "/bin/sh" file 'WORKFILE "-c"
2427 "exec >\"$1\" || exit; shift; exec cvs update \"$@\""
2428 "" ; dummy argument for shell's $0
2429 workfile
2430 (concat "-r" rev)
2431 "-p"
2432 switches)
2433 (setq failed nil))
2434 (and failed (file-exists-p filename) (delete-file filename))))
2435 ;; default for verbose checkout: clear the sticky tag
2436 ;; so that the actual update will get the head of the trunk
2437 (and rev (string= rev "")
2438 (vc-do-command nil 0 "cvs" file 'WORKFILE "update" "-A"))
2439 ;; If a revision was specified, check that out.
2440 (if rev
2441 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE
2442 (and writable (eq (vc-checkout-model file) 'manual) "-w")
2443 "update"
2444 (and rev (not (string= rev ""))
2445 (concat "-r" rev))
2446 switches)
c0d66cb2
RS
2447 ;; If no revision was specified, call "cvs edit" to make
2448 ;; the file writeable.
2449 (and writable (eq (vc-checkout-model file) 'manual)
2450 (vc-do-command nil 0 "cvs" file 'WORKFILE "edit")))
2451 (if rev (vc-file-setprop file 'vc-workfile-version nil))))
f008ca58
KH
2452 (cond
2453 ((not workfile)
2454 (vc-file-clear-masterprops file)
2455 (if writable
8172cd86 2456 (vc-file-setprop file 'vc-locking-user (vc-user-login-name)))
f008ca58
KH
2457 (vc-file-setprop file
2458 'vc-checkout-time (nth 5 (file-attributes file)))))
2459 (message "Checking out %s...done" filename))))))
594722a8
ER
2460
2461(defun vc-backend-logentry-check (file)
2462 (vc-backend-dispatch file
8c0aaf40 2463 (if (>= (buffer-size) 512) ;; SCCS
594722a8
ER
2464 (progn
2465 (goto-char 512)
2466 (error
590cc449 2467 "Log must be less than 512 characters; point is now at pos 512")))
80688f5c
RS
2468 nil ;; RCS
2469 nil) ;; CVS
594722a8
ER
2470 )
2471
80688f5c 2472(defun vc-backend-checkin (file rev comment)
594722a8
ER
2473 ;; Register changes to FILE as level REV with explanatory COMMENT.
2474 ;; Automatically retrieves a read-only version of the file with
2475 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
2476 ;; it deletes the workfile.
a7acbbe4 2477 ;; Adaptation for RCS branch support: if this is an explicit checkin,
c6d4f628
RS
2478 ;; or if the checkin creates a new branch, set the master file branch
2479 ;; accordingly.
594722a8 2480 (message "Checking in %s..." file)
7d665008 2481 ;; "This log message intentionally left almost blank".
9e0cc6e6
RS
2482 ;; RCS 5.7 gripes about white-space-only comments too.
2483 (or (and comment (string-match "[^\t\n ]" comment))
2484 (setq comment "*** empty log message ***"))
2ea8ce47
RM
2485 (save-excursion
2486 ;; Change buffers to get local value of vc-checkin-switches.
2487 (set-buffer (or (get-file-buffer file) (current-buffer)))
2c28ac43 2488 (let ((switches
90681ae2
EN
2489 (if (stringp vc-checkin-switches)
2490 (list vc-checkin-switches)
2491 vc-checkin-switches)))
2c28ac43
RS
2492 ;; Clear the master-properties. Do that here, not at the
2493 ;; end, because if the check-in fails we want them to get
2494 ;; re-computed before the next try.
2495 (vc-file-clear-masterprops file)
2496 (vc-backend-dispatch file
2497 ;; SCCS
2498 (progn
2499 (apply 'vc-do-command nil 0 "delta" file 'MASTER
2500 (if rev (concat "-r" rev))
2501 (concat "-y" comment)
2502 switches)
2503 (vc-file-setprop file 'vc-locking-user 'none)
2504 (vc-file-setprop file 'vc-workfile-version nil)
2505 (if vc-keep-workfiles
2506 (vc-do-command nil 0 "get" file 'MASTER))
2507 )
2508 ;; RCS
2509 (let ((old-version (vc-workfile-version file)) new-version)
2510 (apply 'vc-do-command nil 0 "ci" file 'MASTER
2511 ;; if available, use the secure check-in option
2512 (and (vc-backend-release-p 'RCS "5.6.4") "-j")
2513 (concat (if vc-keep-workfiles "-u" "-r") rev)
2514 (concat "-m" comment)
2515 switches)
2516 (vc-file-setprop file 'vc-locking-user 'none)
2517 (vc-file-setprop file 'vc-workfile-version nil)
2518
2519 ;; determine the new workfile version
2520 (set-buffer "*vc*")
2521 (goto-char (point-min))
2522 (if (or (re-search-forward
2523 "new revision: \\([0-9.]+\\);" nil t)
2524 (re-search-forward
2525 "reverting to previous revision \\([0-9.]+\\)" nil t))
2526 (progn (setq new-version (buffer-substring (match-beginning 1)
2527 (match-end 1)))
2528 (vc-file-setprop file 'vc-workfile-version new-version)))
2529
2530 ;; if we got to a different branch, adjust the default
2531 ;; branch accordingly
2532 (cond
2533 ((and old-version new-version
2534 (not (string= (vc-branch-part old-version)
2535 (vc-branch-part new-version))))
2536 (vc-do-command nil 0 "rcs" file 'MASTER
2537 (if (vc-trunk-p new-version) "-b"
2538 (concat "-b" (vc-branch-part new-version))))
2539 ;; If this is an old RCS release, we might have
2540 ;; to remove a remaining lock.
2541 (if (not (vc-backend-release-p 'RCS "5.6.2"))
2542 ;; exit status of 1 is also accepted.
2543 ;; It means that the lock was removed before.
2544 (vc-do-command nil 1 "rcs" file 'MASTER
2545 (concat "-u" old-version))))))
2546 ;; CVS
2547 (progn
2548 ;; explicit check-in to the trunk requires a
2549 ;; double check-in (first unexplicit) (CVS-1.3)
2550 (condition-case nil
2551 (progn
2552 (if (and rev (vc-trunk-p rev))
2553 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE
2554 "ci" "-m" "intermediate"
2555 switches))
2556 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE
2557 "ci" (if rev (concat "-r" rev))
2558 (concat "-m" comment)
2559 switches))
2560 (error (if (eq (vc-cvs-status file) 'needs-merge)
2561 ;; The CVS output will be on top of this message.
2562 (error "Type C-x 0 C-x C-q to merge in changes")
2563 (error "Check-in failed"))))
2564 ;; determine and store the new workfile version
2565 (set-buffer "*vc*")
2566 (goto-char (point-min))
2567 (if (re-search-forward
2568 "^\\(new\\|initial\\) revision: \\([0-9.]+\\)" nil t)
2569 (vc-file-setprop file 'vc-workfile-version
2570 (buffer-substring (match-beginning 2)
2571 (match-end 2)))
2572 (vc-file-setprop file 'vc-workfile-version nil))
2573 ;; if this was an explicit check-in, remove the sticky tag
2574 (if rev
2575 (vc-do-command nil 0 "cvs" file 'WORKFILE "update" "-A"))
c0d66cb2
RS
2576 ;; Forget the checkout model, because we might have assumed
2577 ;; a wrong one when we found the file. After commit, we can
2578 ;; tell it from the permissions of the file
2579 ;; (see vc-checkout-model).
2580 (vc-file-setprop file 'vc-checkout-model nil)
2c28ac43
RS
2581 (vc-file-setprop file 'vc-locking-user 'none)
2582 (vc-file-setprop file 'vc-checkout-time
2583 (nth 5 (file-attributes file)))))))
88a2ffaf 2584 (message "Checking in %s...done" file))
594722a8
ER
2585
2586(defun vc-backend-revert (file)
2587 ;; Revert file to latest checked-in version.
c6d4f628 2588 ;; (for RCS, to workfile version)
594722a8 2589 (message "Reverting %s..." file)
61dee1e7 2590 (vc-file-clear-masterprops file)
594722a8
ER
2591 (vc-backend-dispatch
2592 file
c6d4f628
RS
2593 ;; SCCS
2594 (progn
6aa13729
RS
2595 (vc-do-command nil 0 "unget" file 'MASTER nil)
2596 (vc-do-command nil 0 "get" file 'MASTER nil))
c6d4f628 2597 ;; RCS
6aa13729 2598 (vc-do-command nil 0 "co" file 'MASTER
c6d4f628
RS
2599 "-f" (concat "-u" (vc-workfile-version file)))
2600 ;; CVS
2601 (progn
80688f5c 2602 (delete-file file)
6aa13729 2603 (vc-do-command nil 0 "cvs" file 'WORKFILE "update")))
88a2ffaf 2604 (vc-file-setprop file 'vc-locking-user 'none)
c6d4f628 2605 (vc-file-setprop file 'vc-checkout-time (nth 5 (file-attributes file)))
594722a8
ER
2606 (message "Reverting %s...done" file)
2607 )
2608
2609(defun vc-backend-steal (file &optional rev)
2610 ;; Steal the lock on the current workfile. Needs RCS 5.6.2 or later for -M.
2611 (message "Stealing lock on %s..." file)
af1b8606 2612 (vc-backend-dispatch file
80688f5c 2613 (progn ;SCCS
6aa13729
RS
2614 (vc-do-command nil 0 "unget" file 'MASTER "-n" (if rev (concat "-r" rev)))
2615 (vc-do-command nil 0 "get" file 'MASTER "-g" (if rev (concat "-r" rev)))
d76b8d38 2616 )
6aa13729 2617 (vc-do-command nil 0 "rcs" file 'MASTER ;RCS
80688f5c 2618 "-M" (concat "-u" rev) (concat "-l" rev))
2c28ac43 2619 (error "You cannot steal a CVS lock; there are no CVS locks to steal") ;CVS
80688f5c 2620 )
8172cd86 2621 (vc-file-setprop file 'vc-locking-user (vc-user-login-name))
594722a8
ER
2622 (message "Stealing lock on %s...done" file)
2623 )
2624
2625(defun vc-backend-uncheck (file target)
c8de1d91 2626 ;; Undo the latest checkin.
594722a8
ER
2627 (message "Removing last change from %s..." file)
2628 (vc-backend-dispatch file
6aa13729
RS
2629 (vc-do-command nil 0 "rmdel" file 'MASTER (concat "-r" target))
2630 (vc-do-command nil 0 "rcs" file 'MASTER (concat "-o" target))
88a2ffaf 2631 nil ;; this is never reached under CVS
594722a8
ER
2632 )
2633 (message "Removing last change from %s...done" file)
2634 )
2635
2636(defun vc-backend-print-log (file)
6aa13729 2637 ;; Get change log associated with FILE.
80688f5c
RS
2638 (vc-backend-dispatch
2639 file
6aa13729
RS
2640 (vc-do-command nil 0 "prs" file 'MASTER)
2641 (vc-do-command nil 0 "rlog" file 'MASTER)
81b8f0e6 2642 (vc-do-command nil 0 "cvs" file 'WORKFILE "log")))
594722a8
ER
2643
2644(defun vc-backend-assign-name (file name)
2645 ;; Assign to a FILE's latest version a given NAME.
2646 (vc-backend-dispatch file
6aa13729
RS
2647 (vc-add-triple name file (vc-latest-version file)) ;; SCCS
2648 (vc-do-command nil 0 "rcs" file 'MASTER (concat "-n" name ":")) ;; RCS
2649 (vc-do-command nil 0 "cvs" file 'WORKFILE "tag" name) ;; CVS
3234e2a3 2650 )
3234e2a3 2651 )
594722a8 2652
9a51ed3a
PE
2653(defun vc-backend-diff (file &optional oldvers newvers cmp)
2654 ;; Get a difference report between two versions of FILE.
2655 ;; Get only a brief comparison report if CMP, a difference report otherwise.
eb302e54
AS
2656 (let ((backend (vc-backend file)) options status
2657 (diff-switches-list (if (listp diff-switches)
2658 diff-switches
2659 (list diff-switches))))
80688f5c
RS
2660 (cond
2661 ((eq backend 'SCCS)
7b4f934d 2662 (setq oldvers (vc-lookup-triple file oldvers))
eb302e54
AS
2663 (setq newvers (vc-lookup-triple file newvers))
2664 (setq options (append (list (and cmp "--brief") "-q"
2665 (and oldvers (concat "-r" oldvers))
2666 (and newvers (concat "-r" newvers)))
2667 (and (not cmp) diff-switches-list)))
2668 (apply 'vc-do-command "*vc-diff*" 1 "vcdiff" file 'MASTER options))
c6d4f628 2669 ((eq backend 'RCS)
99e76dda
AS
2670 (if (not oldvers) (setq oldvers (vc-workfile-version file)))
2671 ;; If we know that --brief is not supported, don't try it.
eb302e54
AS
2672 (setq cmp (and cmp (not (eq vc-rcsdiff-knows-brief 'no))))
2673 (setq options (append (list (and cmp "--brief") "-q"
2674 (concat "-r" oldvers)
2675 (and newvers (concat "-r" newvers)))
2676 (and (not cmp) diff-switches-list)))
2677 (setq status (apply 'vc-do-command "*vc-diff*" 2
2678 "rcsdiff" file 'WORKFILE options))
2679 ;; If --brief didn't work, do a double-take and remember it
2680 ;; for the future.
2681 (if (eq status 2)
2682 (prog1
2683 (apply 'vc-do-command "*vc-diff*" 1 "rcsdiff" file 'WORKFILE
2684 (if cmp (cdr options) options))
2685 (if cmp (setq vc-rcsdiff-knows-brief 'no)))
2686 ;; If --brief DID work, remember that, too.
2687 (and cmp (not vc-rcsdiff-knows-brief)
2688 (setq vc-rcsdiff-knows-brief 'yes))
2689 status))
80688f5c 2690 ;; CVS is different.
80688f5c 2691 ((eq backend 'CVS)
eb302e54 2692 (if (string= (vc-workfile-version file) "0")
80688f5c 2693 ;; This file is added but not yet committed; there is no master file.
80688f5c 2694 (if (or oldvers newvers)
b0c9bc8c
AS
2695 (error "No revisions of %s exist" file)
2696 (if cmp 1 ;; file is added but not committed,
2697 ;; we regard this as "changed".
2698 ;; diff it against /dev/null.
2699 (apply 'vc-do-command
2700 "*vc-diff*" 1 "diff" file 'WORKFILE
2701 (append (if (listp diff-switches)
2702 diff-switches
2703 (list diff-switches)) '("/dev/null")))))
2704 ;; cmp is not yet implemented -- we always do a full diff.
80688f5c 2705 (apply 'vc-do-command
6aa13729 2706 "*vc-diff*" 1 "cvs" file 'WORKFILE "diff"
80688f5c
RS
2707 (and oldvers (concat "-r" oldvers))
2708 (and newvers (concat "-r" newvers))
2709 (if (listp diff-switches)
2710 diff-switches
2711 (list diff-switches)))))
2712 (t
2713 (vc-registration-error file)))))
2714
2715(defun vc-backend-merge-news (file)
2716 ;; Merge in any new changes made to FILE.
61dee1e7
AS
2717 (message "Merging changes into %s..." file)
2718 (prog1
2719 (vc-backend-dispatch
2720 file
2721 (error "vc-backend-merge-news not meaningful for SCCS files") ;SCCS
2722 (error "vc-backend-merge-news not meaningful for RCS files") ;RCS
2723 (save-excursion ; CVS
2724 (vc-file-clear-masterprops file)
2725 (vc-file-setprop file 'vc-workfile-version nil)
2726 (vc-file-setprop file 'vc-locking-user nil)
d5859f32 2727 (vc-file-setprop file 'vc-checkout-time nil)
61dee1e7 2728 (vc-do-command nil 0 "cvs" file 'WORKFILE "update")
d5859f32
AS
2729 ;; Analyze the merge result reported by CVS, and set
2730 ;; file properties accordingly.
61dee1e7
AS
2731 (set-buffer (get-buffer "*vc*"))
2732 (goto-char (point-min))
d5859f32
AS
2733 ;; get new workfile version
2734 (if (re-search-forward (concat "^Merging differences between "
2735 "[01234567890.]* and "
2736 "\\([01234567890.]*\\) into")
2737 nil t)
2738 (vc-file-setprop file 'vc-workfile-version (match-string 1)))
2739 ;; get file status
2740 (if (re-search-forward
2741 (concat "^\\([CMU]\\) "
2742 (regexp-quote (file-name-nondirectory file)))
2743 nil t)
2744 (cond
2745 ;; Merge successful, we are in sync with repository now
2746 ((string= (match-string 1) "U")
2747 (vc-file-setprop file 'vc-locking-user 'none)
2748 (vc-file-setprop file 'vc-checkout-time
2749 (nth 5 (file-attributes file)))
2750 0) ;; indicate success to the caller
2751 ;; Merge successful, but our own changes are still in the file
2752 ((string= (match-string 1) "M")
2753 (vc-file-setprop file 'vc-locking-user (vc-file-owner file))
2754 (vc-file-setprop file 'vc-checkout-time 0)
2755 0) ;; indicate success to the caller
2756 ;; Conflicts detected!
2757 ((string= (match-string 1) "C")
2758 (vc-file-setprop file 'vc-locking-user (vc-file-owner file))
2759 (vc-file-setprop file 'vc-checkout-time 0)
2760 1) ;; signal the error to the caller
2761 )
2762 (pop-to-buffer "*vc*")
2763 (error "Couldn't analyze cvs update result"))))
61dee1e7 2764 (message "Merging changes into %s...done" file)))
594722a8
ER
2765
2766(defun vc-check-headers ()
2767 "Check if the current file has any headers in it."
2768 (interactive)
2769 (save-excursion
2770 (goto-char (point-min))
2771 (vc-backend-dispatch buffer-file-name
2772 (re-search-forward "%[MIRLBSDHTEGUYFPQCZWA]%" nil t) ;; SCCS
2773 (re-search-forward "\\$[A-Za-z\300-\326\330-\366\370-\377]+\\(: [\t -#%-\176\240-\377]*\\)?\\$" nil t) ;; RCS
80688f5c 2774 'RCS ;; CVS works like RCS in this regard.
594722a8
ER
2775 )
2776 ))
2777
2778;; Back-end-dependent stuff ends here.
2779
2780;; Set up key bindings for use while editing log messages
2781
37667a5c 2782(defun vc-log-mode (&optional file)
594722a8
ER
2783 "Minor mode for driving version-control tools.
2784These bindings are added to the global keymap when you enter this mode:
2785\\[vc-next-action] perform next logical version-control operation on current file
2786\\[vc-register] register current file
2787\\[vc-toggle-read-only] like next-action, but won't register files
2788\\[vc-insert-headers] insert version-control headers in current file
2789\\[vc-print-log] display change history of current file
2790\\[vc-revert-buffer] revert buffer to latest version
2791\\[vc-cancel-version] undo latest checkin
2792\\[vc-diff] show diffs between file versions
f1818994 2793\\[vc-version-other-window] visit old version in another window
594722a8 2794\\[vc-directory] show all files locked by any user in or below .
7d2d9482 2795\\[vc-annotate] colorful display of the cvs annotate command
594722a8
ER
2796\\[vc-update-change-log] add change log entry from recent checkins
2797
2798While you are entering a change log message for a version, the following
2799additional bindings will be in effect.
2800
2801\\[vc-finish-logentry] proceed with check in, ending log message entry
2802
2803Whenever you do a checkin, your log comment is added to a ring of
2804saved comments. These can be recalled as follows:
2805
2806\\[vc-next-comment] replace region with next message in comment ring
2807\\[vc-previous-comment] replace region with previous message in comment ring
8c0aaf40
ER
2808\\[vc-comment-search-reverse] search backward for regexp in the comment ring
2809\\[vc-comment-search-forward] search backward for regexp in the comment ring
594722a8
ER
2810
2811Entry to the change-log submode calls the value of text-mode-hook, then
2812the value of vc-log-mode-hook.
2813
2814Global user options:
2815 vc-initial-comment If non-nil, require user to enter a change
2816 comment upon first checkin of the file.
2817
2818 vc-keep-workfiles Non-nil value prevents workfiles from being
2819 deleted when changes are checked in
2820
2821 vc-suppress-confirm Suppresses some confirmation prompts,
2822 notably for reversions.
2823
7b4f934d 2824 vc-header-alist Which keywords to insert when adding headers
594722a8 2825 with \\[vc-insert-headers]. Defaults to
80688f5c
RS
2826 '(\"\%\W\%\") under SCCS, '(\"\$Id\$\") under
2827 RCS and CVS.
594722a8
ER
2828
2829 vc-static-header-alist By default, version headers inserted in C files
2830 get stuffed in a static string area so that
80688f5c
RS
2831 ident(RCS/CVS) or what(SCCS) can see them in
2832 the compiled object code. You can override
2833 this by setting this variable to nil, or change
594722a8
ER
2834 the header template by changing it.
2835
2836 vc-command-messages if non-nil, display run messages from the
2837 actual version-control utilities (this is
2838 intended primarily for people hacking vc
2839 itself).
2840"
2841 (interactive)
2842 (set-syntax-table text-mode-syntax-table)
2843 (use-local-map vc-log-entry-mode)
2844 (setq local-abbrev-table text-mode-abbrev-table)
2845 (setq major-mode 'vc-log-mode)
2846 (setq mode-name "VC-Log")
2847 (make-local-variable 'vc-log-file)
37667a5c 2848 (setq vc-log-file file)
594722a8 2849 (make-local-variable 'vc-log-version)
8c0aaf40 2850 (make-local-variable 'vc-comment-ring-index)
594722a8
ER
2851 (set-buffer-modified-p nil)
2852 (setq buffer-file-name nil)
2853 (run-hooks 'text-mode-hook 'vc-log-mode-hook)
2854)
2855
2856;; Initialization code, to be done just once at load-time
2857(if vc-log-entry-mode
2858 nil
2859 (setq vc-log-entry-mode (make-sparse-keymap))
2860 (define-key vc-log-entry-mode "\M-n" 'vc-next-comment)
2861 (define-key vc-log-entry-mode "\M-p" 'vc-previous-comment)
8c0aaf40 2862 (define-key vc-log-entry-mode "\M-r" 'vc-comment-search-reverse)
594722a8
ER
2863 (define-key vc-log-entry-mode "\M-s" 'vc-comment-search-forward)
2864 (define-key vc-log-entry-mode "\C-c\C-c" 'vc-finish-logentry)
2865 )
2866
2867;;; These things should probably be generally available
2868
2f119435
AS
2869(defun vc-file-tree-walk (dirname func &rest args)
2870 "Walk recursively through DIRNAME.
34291cd2 2871Invoke FUNC f ARGS on each non-directory file f underneath it."
2f119435
AS
2872 (vc-file-tree-walk-internal (expand-file-name dirname) func args)
2873 (message "Traversing directory %s...done" dirname))
02da6253
PE
2874
2875(defun vc-file-tree-walk-internal (file func args)
2876 (if (not (file-directory-p file))
2877 (apply func file args)
993a1a44 2878 (message "Traversing directory %s..." (abbreviate-file-name file))
02da6253
PE
2879 (let ((dir (file-name-as-directory file)))
2880 (mapcar
2881 (function
2882 (lambda (f) (or
2883 (string-equal f ".")
2884 (string-equal f "..")
632e9525 2885 (member f vc-directory-exclusion-list)
02da6253
PE
2886 (let ((dirf (concat dir f)))
2887 (or
2888 (file-symlink-p dirf) ;; Avoid possible loops
2889 (vc-file-tree-walk-internal dirf func args))))))
2890 (directory-files dir)))))
594722a8
ER
2891
2892(provide 'vc)
2893
2894;;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE
2895;;;
2896;;; These may be useful to anyone who has to debug or extend the package.
c6d4f628
RS
2897;;; (Note that this information corresponds to versions 5.x. Some of it
2898;;; might have been invalidated by the additions to support branching
2899;;; and RCS keyword lookup. AS, 1995/03/24)
594722a8
ER
2900;;;
2901;;; A fundamental problem in VC is that there are time windows between
2902;;; vc-next-action's computations of the file's version-control state and
2903;;; the actions that change it. This is a window open to lossage in a
2904;;; multi-user environment; someone else could nip in and change the state
2905;;; of the master during it.
2906;;;
2907;;; The performance problem is that rlog/prs calls are very expensive; we want
2908;;; to avoid them as much as possible.
2909;;;
2910;;; ANALYSIS:
2911;;;
2912;;; The performance problem, it turns out, simplifies in practice to the
2913;;; problem of making vc-locking-user fast. The two other functions that call
2914;;; prs/rlog will not be so commonly used that the slowdown is a problem; one
2915;;; makes snapshots, the other deletes the calling user's last change in the
2916;;; master.
2917;;;
2918;;; The race condition implies that we have to either (a) lock the master
2919;;; during the entire execution of vc-next-action, or (b) detect and
2920;;; recover from errors resulting from dispatch on an out-of-date state.
2921;;;
a7acbbe4 2922;;; Alternative (a) appears to be infeasible. The problem is that we can't
594722a8
ER
2923;;; guarantee that the lock will ever be removed. Suppose a user starts a
2924;;; checkin, the change message buffer pops up, and the user, having wandered
2925;;; off to do something else, simply forgets about it?
2926;;;
2927;;; Alternative (b), on the other hand, works well with a cheap way to speed up
2928;;; vc-locking-user. Usually, if a file is registered, we can read its locked/
2929;;; unlocked state and its current owner from its permissions.
2930;;;
2931;;; This shortcut will fail if someone has manually changed the workfile's
2932;;; permissions; also if developers are munging the workfile in several
2933;;; directories, with symlinks to a master (in this latter case, the
2934;;; permissions shortcut will fail to detect a lock asserted from another
2935;;; directory).
2936;;;
2937;;; Note that these cases correspond exactly to the errors which could happen
2938;;; because of a competing checkin/checkout race in between two instances of
2939;;; vc-next-action.
2940;;;
2941;;; For VC's purposes, a workfile/master pair may have the following states:
2942;;;
2943;;; A. Unregistered. There is a workfile, there is no master.
2944;;;
2945;;; B. Registered and not locked by anyone.
2946;;;
2947;;; C. Locked by calling user and unchanged.
2948;;;
2949;;; D. Locked by the calling user and changed.
2950;;;
2951;;; E. Locked by someone other than the calling user.
2952;;;
2953;;; This makes for 25 states and 20 error conditions. Here's the matrix:
2954;;;
2955;;; VC's idea of state
2956;;; |
2957;;; V Actual state RCS action SCCS action Effect
2958;;; A B C D E
2959;;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin
2960;;; B 5 . 6 7 8 co -l get -e checkout
2961;;; C 9 10 . 11 12 co -u unget; get revert
2962;;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin
b0c9bc8c 2963;;; E 17 18 19 20 . rcs -u -M -l unget -n ; get -g steal lock
594722a8
ER
2964;;;
2965;;; All commands take the master file name as a last argument (not shown).
2966;;;
2967;;; In the discussion below, a "self-race" is a pathological situation in
2968;;; which VC operations are being attempted simultaneously by two or more
2969;;; Emacsen running under the same username.
2970;;;
2971;;; The vc-next-action code has the following windows:
2972;;;
2973;;; Window P:
2974;;; Between the check for existence of a master file and the call to
2975;;; admin/checkin in vc-buffer-admin (apparent state A). This window may
2976;;; never close if the initial-comment feature is on.
2977;;;
2978;;; Window Q:
2979;;; Between the call to vc-workfile-unchanged-p in and the immediately
2980;;; following revert (apparent state C).
2981;;;
2982;;; Window R:
2983;;; Between the call to vc-workfile-unchanged-p in and the following
2984;;; checkin (apparent state D). This window may never close.
2985;;;
2986;;; Window S:
2987;;; Between the unlock and the immediately following checkout during a
2988;;; revert operation (apparent state C). Included in window Q.
2989;;;
2990;;; Window T:
2991;;; Between vc-locking-user and the following checkout (apparent state B).
2992;;;
2993;;; Window U:
2994;;; Between vc-locking-user and the following revert (apparent state C).
2995;;; Includes windows Q and S.
2996;;;
2997;;; Window V:
2998;;; Between vc-locking-user and the following checkin (apparent state
2999;;; D). This window may never be closed if the user fails to complete the
3000;;; checkin message. Includes window R.
3001;;;
3002;;; Window W:
3003;;; Between vc-locking-user and the following steal-lock (apparent
34291cd2 3004;;; state E). This window may never close if the user fails to complete
594722a8
ER
3005;;; the steal-lock message. Includes window X.
3006;;;
3007;;; Window X:
3008;;; Between the unlock and the immediately following re-lock during a
3009;;; steal-lock operation (apparent state E). This window may never cloce
3010;;; if the user fails to complete the steal-lock message.
3011;;;
3012;;; Errors:
3013;;;
3014;;; Apparent state A ---
3015;;;
3016;;; 1. File looked unregistered but is actually registered and not locked.
3017;;;
3018;;; Potential cause: someone else's admin during window P, with
3019;;; caller's admin happening before their checkout.
3020;;;
b0c9bc8c
AS
3021;;; RCS: Prior to version 5.6.4, ci fails with message
3022;;; "no lock set by <user>". From 5.6.4 onwards, VC uses the new
3023;;; ci -i option and the message is "<file>,v: already exists".
594722a8
ER
3024;;; SCCS: admin will fail with error (ad19).
3025;;;
3026;;; We can let these errors be passed up to the user.
3027;;;
3028;;; 2. File looked unregistered but is actually locked by caller, unchanged.
3029;;;
3030;;; Potential cause: self-race during window P.
3031;;;
b0c9bc8c
AS
3032;;; RCS: Prior to version 5.6.4, reverts the file to the last saved
3033;;; version and unlocks it. From 5.6.4 onwards, VC uses the new
3034;;; ci -i option, failing with message "<file>,v: already exists".
594722a8
ER
3035;;; SCCS: will fail with error (ad19).
3036;;;
3037;;; Either of these consequences is acceptable.
3038;;;
3039;;; 3. File looked unregistered but is actually locked by caller, changed.
3040;;;
3041;;; Potential cause: self-race during window P.
3042;;;
b0c9bc8c
AS
3043;;; RCS: Prior to version 5.6.4, VC registers the caller's workfile as
3044;;; a delta with a null change comment (the -t- switch will be
3045;;; ignored). From 5.6.4 onwards, VC uses the new ci -i option,
3046;;; failing with message "<file>,v: already exists".
594722a8
ER
3047;;; SCCS: will fail with error (ad19).
3048;;;
3049;;; 4. File looked unregistered but is locked by someone else.
3050;;;
3051;;; Potential cause: someone else's admin during window P, with
3052;;; caller's admin happening *after* their checkout.
3053;;;
b0c9bc8c
AS
3054;;; RCS: Prior to version 5.6.4, ci fails with a
3055;;; "no lock set by <user>" message. From 5.6.4 onwards,
3056;;; VC uses the new ci -i option, failing with message
3057;;; "<file>,v: already exists".
594722a8
ER
3058;;; SCCS: will fail with error (ad19).
3059;;;
3060;;; We can let these errors be passed up to the user.
3061;;;
3062;;; Apparent state B ---
3063;;;
3064;;; 5. File looked registered and not locked, but is actually unregistered.
3065;;;
3066;;; Potential cause: master file got nuked during window P.
3067;;;
3068;;; RCS: will fail with "RCS/<file>: No such file or directory"
3069;;; SCCS: will fail with error ut4.
3070;;;
3071;;; We can let these errors be passed up to the user.
3072;;;
3073;;; 6. File looked registered and not locked, but is actually locked by the
3074;;; calling user and unchanged.
3075;;;
3076;;; Potential cause: self-race during window T.
3077;;;
3078;;; RCS: in the same directory as the previous workfile, co -l will fail
3079;;; with "co error: writable foo exists; checkout aborted". In any other
3080;;; directory, checkout will succeed.
3081;;; SCCS: will fail with ge17.
3082;;;
3083;;; Either of these consequences is acceptable.
3084;;;
3085;;; 7. File looked registered and not locked, but is actually locked by the
3086;;; calling user and changed.
3087;;;
3088;;; As case 6.
3089;;;
3090;;; 8. File looked registered and not locked, but is actually locked by another
3091;;; user.
3092;;;
3093;;; Potential cause: someone else checks it out during window T.
3094;;;
3095;;; RCS: co error: revision 1.3 already locked by <user>
3096;;; SCCS: fails with ge4 (in directory) or ut7 (outside it).
3097;;;
3098;;; We can let these errors be passed up to the user.
3099;;;
3100;;; Apparent state C ---
3101;;;
3102;;; 9. File looks locked by calling user and unchanged, but is unregistered.
3103;;;
3104;;; As case 5.
3105;;;
3106;;; 10. File looks locked by calling user and unchanged, but is actually not
3107;;; locked.
3108;;;
3109;;; Potential cause: a self-race in window U, or by the revert's
3110;;; landing during window X of some other user's steal-lock or window S
3111;;; of another user's revert.
3112;;;
3113;;; RCS: succeeds, refreshing the file from the identical version in
3114;;; the master.
3115;;; SCCS: fails with error ut4 (p file nonexistent).
3116;;;
3117;;; Either of these consequences is acceptable.
3118;;;
3119;;; 11. File is locked by calling user. It looks unchanged, but is actually
3120;;; changed.
3121;;;
3122;;; Potential cause: the file would have to be touched by a self-race
3123;;; during window Q.
3124;;;
3125;;; The revert will succeed, removing whatever changes came with
3126;;; the touch. It is theoretically possible that work could be lost.
3127;;;
3128;;; 12. File looks like it's locked by the calling user and unchanged, but
3129;;; it's actually locked by someone else.
3130;;;
3131;;; Potential cause: a steal-lock in window V.
3132;;;
3133;;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u
3134;;; SCCS: fails with error un2
3135;;;
3136;;; We can pass these errors up to the user.
3137;;;
3138;;; Apparent state D ---
3139;;;
3140;;; 13. File looks like it's locked by the calling user and changed, but it's
3141;;; actually unregistered.
3142;;;
3143;;; Potential cause: master file got nuked during window P.
3144;;;
b0c9bc8c
AS
3145;;; RCS: Prior to version 5.6.4, checks in the user's version as an
3146;;; initial delta. From 5.6.4 onwards, VC uses the new ci -j
3147;;; option, failing with message "no such file or directory".
594722a8
ER
3148;;; SCCS: will fail with error ut4.
3149;;;
b0c9bc8c
AS
3150;;; This case is kind of nasty. Under RCS prior to version 5.6.4,
3151;;; VC may fail to detect the loss of previous version information.
594722a8
ER
3152;;;
3153;;; 14. File looks like it's locked by the calling user and changed, but it's
3154;;; actually unlocked.
3155;;;
3156;;; Potential cause: self-race in window V, or the checkin happening
3157;;; during the window X of someone else's steal-lock or window S of
3158;;; someone else's revert.
3159;;;
3160;;; RCS: ci will fail with "no lock set by <user>".
3161;;; SCCS: delta will fail with error ut4.
3162;;;
3163;;; 15. File looks like it's locked by the calling user and changed, but it's
3164;;; actually locked by the calling user and unchanged.
3165;;;
3166;;; Potential cause: another self-race --- a whole checkin/checkout
3167;;; sequence by the calling user would have to land in window R.
3168;;;
3169;;; SCCS: checks in a redundant delta and leaves the file unlocked as usual.
3170;;; RCS: reverts to the file state as of the second user's checkin, leaving
3171;;; the file unlocked.
3172;;;
3173;;; It is theoretically possible that work could be lost under RCS.
3174;;;
3175;;; 16. File looks like it's locked by the calling user and changed, but it's
3176;;; actually locked by a different user.
3177;;;
3178;;; RCS: ci error: no lock set by <user>
3179;;; SCCS: unget will fail with error un2
3180;;;
3181;;; We can pass these errors up to the user.
3182;;;
3183;;; Apparent state E ---
3184;;;
3185;;; 17. File looks like it's locked by some other user, but it's actually
3186;;; unregistered.
3187;;;
3188;;; As case 13.
3189;;;
3190;;; 18. File looks like it's locked by some other user, but it's actually
3191;;; unlocked.
3192;;;
3193;;; Potential cause: someone released a lock during window W.
3194;;;
3195;;; RCS: The calling user will get the lock on the file.
3196;;; SCCS: unget -n will fail with cm4.
3197;;;
3198;;; Either of these consequences will be OK.
3199;;;
3200;;; 19. File looks like it's locked by some other user, but it's actually
3201;;; locked by the calling user and unchanged.
3202;;;
3203;;; Potential cause: the other user relinquishing a lock followed by
3204;;; a self-race, both in window W.
3205;;;
3206;;; Under both RCS and SCCS, both unlock and lock will succeed, making
3207;;; the sequence a no-op.
3208;;;
3209;;; 20. File looks like it's locked by some other user, but it's actually
3210;;; locked by the calling user and changed.
3211;;;
3212;;; As case 19.
3213;;;
3214;;; PROBLEM CASES:
3215;;;
3216;;; In order of decreasing severity:
3217;;;
b0c9bc8c 3218;;; Cases 11 and 15 are the only ones that potentially lose work.
594722a8
ER
3219;;; They would require a self-race for this to happen.
3220;;;
3221;;; Case 13 in RCS loses information about previous deltas, retaining
3222;;; only the information in the current workfile. This can only happen
3223;;; if the master file gets nuked in window P.
3224;;;
3225;;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with
3226;;; no change comment in the master. This would require a self-race in
3227;;; window P or R respectively.
3228;;;
3229;;; Cases 2, 10, 19 and 20 do extra work, but make no changes.
3230;;;
3231;;; Unfortunately, it appears to me that no recovery is possible in these
3232;;; cases. They don't yield error messages, so there's no way to tell that
3233;;; a race condition has occurred.
3234;;;
3235;;; All other cases don't change either the workfile or the master, and
3236;;; trigger command errors which the user will see.
3237;;;
3238;;; Thus, there is no explicit recovery code.
3239
3240;;; vc.el ends here