1 ;;; vc.el --- drive a version-control system from within Emacs
3 ;; Copyright (C) 1992, 93, 94, 95, 96 Free Software Foundation, Inc.
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
8 ;; Per Cederqvist <ceder@lysator.liu.edu>
9 ;; Andre Spiegel <spiegel@berlin.informatik.uni-stuttgart.de>
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
30 ;; This mode is fully documented in the Emacs user's manual.
32 ;; This was designed and implemented by Eric Raymond <esr@snark.thyrsus.com>.
33 ;; Paul Eggert <eggert@twinsun.com>, Sebastian Kremer <sk@thp.uni-koeln.de>,
34 ;; and Richard Stallman contributed valuable criticism, support, and testing.
35 ;; CVS support was added by Per Cederqvist <ceder@lysator.liu.se>
38 ;; Supported version-control systems presently include SCCS, RCS, and CVS.
40 ;; Some features will not work with old RCS versions. Where
41 ;; appropriate, VC finds out which version you have, and allows or
42 ;; disallows those features (stealing locks, for example, works only
43 ;; from 5.6.2 onwards).
44 ;; Even initial checkins will fail if your RCS version is so old that ci
45 ;; doesn't understand -t-; this has been known to happen to people running
48 ;; You can support the RCS -x option by adding pairs to the
49 ;; vc-master-templates list.
51 ;; Proper function of the SCCS diff commands requires the shellscript vcdiff
52 ;; to be installed somewhere on Emacs's path for executables.
54 ;; If your site uses the ChangeLog convention supported by Emacs, the
55 ;; function vc-comment-to-change-log should prove a useful checkin hook.
57 ;; This code depends on call-process passing back the subprocess exit
58 ;; status. Thus, you need Emacs 18.58 or later to run it. For the
59 ;; vc-directory command to work properly as documented, you need 19.
60 ;; You also need Emacs 19's ring.el.
62 ;; The vc code maintains some internal state in order to reduce expensive
63 ;; version-control operations to a minimum. Some names are only computed
64 ;; once. If you perform version control operations with RCS/SCCS/CVS while
65 ;; vc's back is turned, or move/rename master files while vc is running,
66 ;; vc may get seriously confused. Don't do these things!
68 ;; Developer's notes on some concurrency issues are included at the end of
75 (eval-when-compile (require 'dired)) ; for dired-map-over-marks macro
77 (if (not (assoc 'vc-parent-buffer minor-mode-alist))
78 (setq minor-mode-alist
79 (cons '(vc-parent-buffer vc-parent-buffer-name)
82 ;; To implement support for a new version-control system, add another
83 ;; branch to the vc-backend-dispatch macro and fill it in in each
84 ;; call. The variable vc-master-templates in vc-hooks.el will also
87 (defmacro vc-backend-dispatch (f s r c)
88 "Execute FORM1, FORM2 or FORM3 for SCCS, RCS or CVS respectively.
89 If FORM3 is `RCS', use FORM2 for CVS as well as RCS.
90 \(CVS shares some code with RCS)."
91 (list 'let (list (list 'type (list 'vc-backend f)))
93 (list (list 'eq 'type (quote 'SCCS)) s) ;; SCCS
94 (list (list 'eq 'type (quote 'RCS)) r) ;; RCS
95 (list (list 'eq 'type (quote 'CVS)) ;; CVS
99 ;; General customization
101 (defvar vc-suppress-confirm nil
102 "*If non-nil, treat user as expert; suppress yes-no prompts on some things.")
103 (defvar vc-initial-comment nil
104 "*If non-nil, prompt for initial comment when a file is registered.")
105 (defvar vc-command-messages nil
106 "*If non-nil, display run messages from back-end commands.")
107 (defvar vc-register-switches nil
108 "*A string or list of strings specifying extra switches passed
109 to the register program by \\[vc-register].")
110 (defvar vc-checkin-switches nil
111 "*A string or list of strings specifying extra switches passed
112 to the checkin program by \\[vc-checkin].")
113 (defvar vc-checkout-switches nil
114 "*A string or list of strings specifying extra switches passed
115 to the checkout program by \\[vc-checkout].")
116 (defvar vc-directory-exclusion-list '("SCCS" "RCS" "CVS")
117 "*A list of directory names ignored by functions that recursively
120 (defconst vc-maximum-comment-ring-size 32
121 "Maximum number of saved comments in the comment ring.")
123 ;;; This is duplicated in diff.el.
124 (defvar diff-switches "-c"
125 "*A string or list of strings specifying switches to be be passed to diff.")
128 (defvar vc-checkin-hook nil
129 "*List of functions called after a checkin is done. See `run-hooks'.")
131 (defvar vc-make-buffer-writable-hook nil
132 "*List of functions called when a buffer is made writable. See `run-hooks.'
133 This hook is only used when the version control system is CVS. It
134 might be useful for sites who uses locking with CVS, or who uses link
135 farms to gold trees.")
137 ;; Header-insertion hair
139 (defvar vc-header-alist
140 '((SCCS "\%W\%") (RCS "\$Id\$") (CVS "\$Id\$"))
141 "*Header keywords to be inserted by `vc-insert-headers'.
142 Must be a list of two-element lists, the first element of each must
143 be `RCS', `CVS', or `SCCS'. The second element is the string to
144 be inserted for this particular backend.")
145 (defvar vc-static-header-alist
147 "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n"))
148 "*Associate static header string templates with file types. A \%s in the
149 template is replaced with the first string associated with the file's
150 version-control type in `vc-header-alist'.")
152 (defvar vc-comment-alist
153 '((nroff-mode ".\\\"" ""))
154 "*Special comment delimiters to be used in generating vc headers only.
155 Add an entry in this list if you need to override the normal comment-start
156 and comment-end variables. This will only be necessary if the mode language
157 is sensitive to blank lines.")
159 ;; Default is to be extra careful for super-user.
160 (defvar vc-checkout-carefully (= (user-uid) 0)
161 "*Non-nil means be extra-careful in checkout.
162 Verify that the file really is not locked
163 and that its contents match what the master file says.")
165 (defvar vc-rcs-release nil
166 "*The release number of your RCS installation, as a string.
167 If nil, VC itself computes this value when it is first needed.")
169 (defvar vc-sccs-release nil
170 "*The release number of your SCCS installation, as a string.
171 If nil, VC itself computes this value when it is first needed.")
173 (defvar vc-cvs-release nil
174 "*The release number of your CVS installation, as a string.
175 If nil, VC itself computes this value when it is first needed.")
177 ;; Variables the user doesn't need to know about.
178 (defvar vc-log-entry-mode nil)
179 (defvar vc-log-operation nil)
180 (defvar vc-log-after-operation-hook nil)
181 (defvar vc-checkout-writable-buffer-hook 'vc-checkout-writable-buffer)
182 ;; In a log entry buffer, this is a local variable
183 ;; that points to the buffer for which it was made
184 ;; (either a file, or a VC dired buffer).
185 (defvar vc-parent-buffer nil)
186 (defvar vc-parent-buffer-name nil)
189 (defvar vc-log-version)
191 (defconst vc-name-assoc-file "VC-names")
193 (defvar vc-dired-mode nil)
194 (make-variable-buffer-local 'vc-dired-mode)
196 (defvar vc-comment-ring (make-ring vc-maximum-comment-ring-size))
197 (defvar vc-comment-ring-index nil)
198 (defvar vc-last-comment-match nil)
200 ;; Back-portability to Emacs 18
202 (defun file-executable-p-18 (f)
203 (let ((modes (file-modes f)))
204 (and modes (not (zerop (logand 292))))))
206 (defun file-regular-p-18 (f)
207 (let ((attributes (file-attributes f)))
208 (and attributes (not (car attributes)))))
210 ; Conditionally rebind some things for Emacs 18 compatibility
211 (if (not (boundp 'minor-mode-map-alist))
213 (setq compilation-old-error-list nil)
214 (fset 'file-executable-p 'file-executable-p-18)
215 (fset 'shrink-window-if-larger-than-buffer 'beginning-of-buffer)
218 (if (not (fboundp 'file-regular-p))
219 (fset 'file-regular-p 'file-regular-p-18))
221 ;;; Find and compare backend releases
223 (defun vc-backend-release (backend)
224 ;; Returns which backend release is installed on this system.
228 (and (zerop (vc-do-command nil 2 "rcs" nil nil "-V"))
230 (set-buffer (get-buffer "*vc*"))
232 (car (vc-parse-buffer
233 '(("^RCS version \\([0-9.]+ *.*\\)" 1)))))))
234 (setq vc-rcs-release 'unknown)))
237 (and (zerop (vc-do-command nil 1 "cvs" nil nil "-v"))
239 (set-buffer (get-buffer "*vc*"))
241 (car (vc-parse-buffer
242 '(("^Concurrent Versions System (CVS) \\([0-9.]+\\)"
244 (setq vc-cvs-release 'unknown)))
248 (defun vc-release-greater-or-equal (r1 r2)
249 ;; Compare release numbers, represented as strings.
250 ;; Release components are assumed cardinal numbers, not decimal
251 ;; fractions (5.10 is a higher release than 5.9). Omitted fields
252 ;; are considered lower (5.6.7 is earlier than 5.6.7.1).
253 ;; Comparison runs till the end of the string is found, or a
254 ;; non-numeric component shows up (5.6.7 is earlier than "5.6.7 beta",
255 ;; which is probably not what you want in some cases).
256 ;; This code is suitable for existing RCS release numbers.
257 ;; CVS releases are handled reasonably, too (1.3 < 1.4* < 1.5).
260 (or (and (string-match "^\\.?\\([0-9]+\\)" r1)
261 (setq i1 (match-end 0))
262 (setq v1 (string-to-number (match-string 1 r1)))
263 (or (and (string-match "^\\.?\\([0-9]+\\)" r2)
264 (setq i2 (match-end 0))
265 (setq v2 (string-to-number (match-string 1 r2)))
266 (if (> v1 v2) (throw 'done t)
267 (if (< v1 v2) (throw 'done nil)
269 (vc-release-greater-or-equal
271 (substring r2 i2)))))))
273 (or (and (string-match "^\\.?\\([0-9]+\\)" r2)
277 (defun vc-backend-release-p (backend release)
278 ;; Return t if we have RELEASE of BACKEND or better
279 (let (i r (ri 0) (ii 0) is rs (installation (vc-backend-release backend)))
280 (if (not (eq installation 'unknown))
282 ((or (eq backend 'RCS) (eq backend 'CVS))
283 (vc-release-greater-or-equal installation release))))))
285 ;;; functions that operate on RCS revision numbers
287 (defun vc-trunk-p (rev)
288 ;; return t if REV is a revision on the trunk
289 (not (eq nil (string-match "\\`[0-9]+\\.[0-9]+\\'" rev))))
291 (defun vc-branch-part (rev)
292 ;; return the branch part of a revision number REV
293 (substring rev 0 (string-match "\\.[0-9]+\\'" rev)))
295 ;; File property caching
297 (defun vc-clear-context ()
298 "Clear all cached file properties and the comment ring."
300 (fillarray vc-file-prop-obarray nil)
301 ;; Note: there is potential for minor lossage here if there is an open
302 ;; log buffer with a nonzero local value of vc-comment-ring-index.
303 (setq vc-comment-ring (make-ring vc-maximum-comment-ring-size)))
305 (defun vc-file-clear-masterprops (file)
306 ;; clear all properties of FILE that were retrieved
307 ;; from the master file
308 (vc-file-setprop file 'vc-latest-version nil)
309 (vc-file-setprop file 'vc-your-latest-version nil)
310 (vc-backend-dispatch file
312 (vc-file-setprop file 'vc-master-locks nil))
314 (vc-file-setprop file 'vc-default-branch nil)
315 (vc-file-setprop file 'vc-head-version nil)
316 (vc-file-setprop file 'vc-master-workfile-version nil)
317 (vc-file-setprop file 'vc-master-locks nil))
319 (vc-file-setprop file 'vc-cvs-status nil))))
321 (defun vc-head-version (file)
322 ;; Return the RCS head version of FILE
323 (cond ((vc-file-getprop file 'vc-head-version))
324 (t (vc-fetch-master-properties file)
325 (vc-file-getprop file 'vc-head-version))))
327 ;; Random helper functions
329 (defun vc-latest-on-branch-p (file)
330 ;; return t iff the current workfile version of FILE is
331 ;; the latest on its branch.
332 (vc-backend-dispatch file
334 (string= (vc-workfile-version file) (vc-latest-version file))
336 (let ((workfile-version (vc-workfile-version file)) tip-version)
337 (if (vc-trunk-p workfile-version)
339 ;; Re-fetch the head version number. This is to make
340 ;; sure that no-one has checked in a new version behind
342 (vc-fetch-master-properties file)
343 (string= (vc-file-getprop file 'vc-head-version)
345 ;; If we are not on the trunk, we need to examine the
346 ;; whole current branch. (vc-master-workfile-version
347 ;; is not what we need.)
349 (set-buffer (get-buffer-create "*vc-info*"))
350 (vc-insert-file (vc-name file) "^desc")
351 (setq tip-version (car (vc-parse-buffer (list (list
352 (concat "^\\(" (regexp-quote (vc-branch-part workfile-version))
353 "\\.[0-9]+\\)\ndate[ \t]+\\([0-9.]+\\);") 1 2)))))
354 (if (get-buffer "*vc-info*")
355 (kill-buffer (get-buffer "*vc-info*")))
356 (string= tip-version workfile-version))))
360 (defun vc-registration-error (file)
362 (error "File %s is not under version control" file)
363 (error "Buffer %s is not associated with a file" (buffer-name))))
365 (defvar vc-binary-assoc nil)
367 (defun vc-find-binary (name)
368 "Look for a command anywhere on the subprocess-command search path."
369 (or (cdr (assoc name vc-binary-assoc))
375 (let ((full (concat s "/" name)))
376 (if (file-executable-p full)
378 (setq vc-binary-assoc
379 (cons (cons name full) vc-binary-assoc))
380 (throw 'found full)))))))
384 (defun vc-do-command (buffer okstatus command file last &rest flags)
385 "Execute a version-control command, notifying user and checking for errors.
386 Output from COMMAND goes to BUFFER, or *vc* if BUFFER is nil.
387 The command is successful if its exit status does not exceed OKSTATUS.
388 The last argument of the command is the master name of FILE if LAST is
389 `MASTER', or the workfile of FILE if LAST is `WORKFILE'; this is appended
390 to an optional list of FLAGS."
391 (and file (setq file (expand-file-name file)))
392 (if (not buffer) (setq buffer "*vc*"))
393 (if vc-command-messages
394 (message "Running %s on %s..." command file))
395 (let ((obuf (current-buffer)) (camefrom (current-buffer))
397 (vc-file (and file (vc-name file)))
398 (olddir default-directory)
400 (set-buffer (get-buffer-create buffer))
401 (set (make-local-variable 'vc-parent-buffer) camefrom)
402 (set (make-local-variable 'vc-parent-buffer-name)
403 (concat " from " (buffer-name camefrom)))
404 (setq default-directory olddir)
409 (function (lambda (s) (and s (setq squeezed (append squeezed (list s))))))
411 (if (and vc-file (eq last 'MASTER))
412 (setq squeezed (append squeezed (list vc-file))))
413 (if (eq last 'WORKFILE)
415 (let* ((pwd (expand-file-name default-directory))
416 (preflen (length pwd)))
417 (if (string= (substring file 0 preflen) pwd)
418 (setq file (substring file preflen))))
419 (setq squeezed (append squeezed (list file)))))
420 (let ((exec-path (append vc-path exec-path))
421 ;; Add vc-path to PATH for the execution of this command.
423 (cons (concat "PATH=" (getenv "PATH")
425 (mapconcat 'identity vc-path path-separator))
426 process-environment))
427 (win32-quote-process-args t))
428 (setq status (apply 'call-process command nil t nil squeezed)))
429 (goto-char (point-max))
430 (set-buffer-modified-p nil)
432 (if (or (not (integerp status)) (< okstatus status))
434 (pop-to-buffer buffer)
435 (goto-char (point-min))
436 (shrink-window-if-larger-than-buffer)
437 (error "Running %s...FAILED (%s)" command
438 (if (integerp status)
439 (format "status %d" status)
442 (if vc-command-messages
443 (message "Running %s...OK" command))
449 ;;; Save a bit of the text around POSN in the current buffer, to help
450 ;;; us find the corresponding position again later. This works even
451 ;;; if all markers are destroyed or corrupted.
452 ;;; A lot of this was shamelessly lifted from Sebastian Kremer's rcs.el mode.
453 (defun vc-position-context (posn)
456 (buffer-substring posn
457 (min (point-max) (+ posn 100)))))
459 ;;; Return the position of CONTEXT in the current buffer, or nil if we
460 ;;; couldn't find it.
461 (defun vc-find-position-by-context (context)
462 (let ((context-string (nth 2 context)))
463 (if (equal "" context-string)
466 (let ((diff (- (nth 1 context) (buffer-size))))
467 (if (< diff 0) (setq diff (- diff)))
468 (goto-char (nth 0 context))
469 (if (or (search-forward context-string nil t)
470 ;; Can't use search-backward since the match may continue
472 (progn (goto-char (- (point) diff (length context-string)))
473 ;; goto-char doesn't signal an error at
474 ;; beginning of buffer like backward-char would
475 (search-forward context-string nil t)))
476 ;; to beginning of OSTRING
477 (- (point) (length context-string))))))))
479 (defun vc-buffer-context ()
480 ;; Return a list '(point-context mark-context reparse); from which
481 ;; vc-restore-buffer-context can later restore the context.
482 (let ((point-context (vc-position-context (point)))
483 ;; Use mark-marker to avoid confusion in transient-mark-mode.
484 (mark-context (if (eq (marker-buffer (mark-marker)) (current-buffer))
485 (vc-position-context (mark-marker))))
486 ;; Make the right thing happen in transient-mark-mode.
488 ;; We may want to reparse the compilation buffer after revert
489 (reparse (and (boundp 'compilation-error-list) ;compile loaded
490 (let ((curbuf (current-buffer)))
491 ;; Construct a list; each elt is nil or a buffer
492 ;; iff that buffer is a compilation output buffer
493 ;; that contains markers into the current buffer.
499 compilation-old-error-list
500 compilation-error-list))
501 (buffer-error-marked-p nil))
502 (while (and (consp errors)
503 (not buffer-error-marked-p))
504 (and (markerp (cdr (car errors)))
508 (setq buffer-error-marked-p t))
509 (setq errors (cdr errors)))
510 (if buffer-error-marked-p buffer))))
512 (list point-context mark-context reparse)))
514 (defun vc-restore-buffer-context (context)
515 ;; Restore point/mark, and reparse any affected compilation buffers.
516 ;; CONTEXT is that which vc-buffer-context returns.
517 (let ((point-context (nth 0 context))
518 (mark-context (nth 1 context))
519 (reparse (nth 2 context)))
520 ;; Reparse affected compilation buffers.
524 (set-buffer (car reparse))
525 (let ((compilation-last-buffer (current-buffer)) ;select buffer
526 ;; Record the position in the compilation buffer of
527 ;; the last error next-error went to.
528 (error-pos (marker-position
529 (car (car-safe compilation-error-list)))))
530 ;; Reparse the error messages as far as they were parsed before.
531 (compile-reinitialize-errors '(4) compilation-parsing-end)
532 ;; Move the pointer up to find the error we were at before
533 ;; reparsing. Now next-error should properly go to the next one.
534 (while (and compilation-error-list
535 (/= error-pos (car (car compilation-error-list))))
536 (setq compilation-error-list (cdr compilation-error-list))))))
537 (setq reparse (cdr reparse)))
539 ;; Restore point and mark
540 (let ((new-point (vc-find-position-by-context point-context)))
541 (if new-point (goto-char new-point)))
543 (let ((new-mark (vc-find-position-by-context mark-context)))
544 (if new-mark (set-mark new-mark))))))
546 (defun vc-revert-buffer1 (&optional arg no-confirm)
547 ;; Revert buffer, try to keep point and mark where user expects them in spite
548 ;; of changes because of expanded version-control key words.
549 ;; This is quite important since otherwise typeahead won't work as expected.
552 (let ((context (vc-buffer-context)))
553 ;; t means don't call normal-mode; that's to preserve various minor modes.
554 (revert-buffer arg no-confirm t)
555 (vc-restore-buffer-context context)))
558 (defun vc-buffer-sync (&optional not-urgent)
559 ;; Make sure the current buffer and its working file are in sync
560 ;; NOT-URGENT means it is ok to continue if the user says not to save.
561 (if (buffer-modified-p)
562 (if (or vc-suppress-confirm
563 (y-or-n-p (format "Buffer %s modified; save it? " (buffer-name))))
567 (error "Aborted")))))
570 (defun vc-workfile-unchanged-p (file &optional want-differences-if-changed)
571 ;; Has the given workfile changed since last checkout?
572 (let ((checkout-time (vc-file-getprop file 'vc-checkout-time))
573 (lastmod (nth 5 (file-attributes file))))
574 (or (equal checkout-time lastmod)
575 (and (or (not checkout-time) want-differences-if-changed)
576 (let ((unchanged (zerop (vc-backend-diff file nil nil
577 (not want-differences-if-changed)))))
578 ;; 0 stands for an unknown time; it can't match any mod time.
579 (vc-file-setprop file 'vc-checkout-time (if unchanged lastmod 0))
582 (defun vc-next-action-on-file (file verbose &optional comment)
583 ;;; If comment is specified, it will be used as an admin or checkin comment.
584 (let ((vc-file (vc-name file))
585 (vc-type (vc-backend file))
586 owner version buffer)
589 ;; if there is no master file corresponding, create one
591 (vc-register verbose comment)
592 (if vc-initial-comment
593 (setq vc-log-after-operation-hook
594 'vc-checkout-writable-buffer-hook)
595 (vc-checkout-writable-buffer file)))
597 ;; CVS: changes to the master file need to be
598 ;; merged back into the working file
599 ((and (eq vc-type 'CVS)
600 (or (eq (vc-cvs-status file) 'needs-checkout)
601 (eq (vc-cvs-status file) 'needs-merge)))
602 (if (or vc-dired-mode
604 (format "%s is not up-to-date. Merge in changes now? "
608 (and (setq buffer (get-file-buffer file))
609 (buffer-modified-p buffer)
610 (switch-to-buffer-other-window buffer)
612 (setq buffer (current-buffer))
614 (if (and buffer (buffer-modified-p buffer)
617 "Buffer %s modified; merge file on disc anyhow? "
618 (buffer-name buffer)))))
619 (error "Merge aborted"))
620 (if (not (zerop (vc-backend-merge-news file)))
621 ;; Overlaps detected - what now? Should use some
622 ;; fancy RCS conflict resolving package, or maybe
623 ;; emerge, but for now, simply warn the user with a
625 (message "Conflicts detected!"))
627 (vc-resynch-buffer file t (not (buffer-modified-p buffer)))))
628 (error "%s needs update" (buffer-name))))
630 ;; if there is no lock on the file, assert one and get it
631 ((not (setq owner (vc-locking-user file)))
632 (if (and vc-checkout-carefully
633 (not (vc-workfile-unchanged-p file t)))
634 (if (save-window-excursion
635 (pop-to-buffer "*vc-diff*")
636 (goto-char (point-min))
637 (insert-string (format "Changes to %s since last lock:\n\n"
641 (concat "File has unlocked changes, "
642 "claim lock retaining changes? ")))
643 (progn (vc-backend-steal file)
645 (if (not (yes-or-no-p "Revert to checked-in version, instead? "))
646 (error "Checkout aborted")
647 (vc-revert-buffer1 t t)
648 (vc-checkout-writable-buffer file))
651 (if (not (eq vc-type 'SCCS))
652 (vc-checkout file nil
653 (read-string "Branch or version to move to: "))
654 (error "Sorry, this is not implemented for SCCS"))
655 (if (vc-latest-on-branch-p file)
656 (vc-checkout-writable-buffer file)
658 "This is not the latest version. Really lock it? ")
659 (vc-checkout-writable-buffer file)
660 (if (yes-or-no-p "Lock the latest version instead? ")
661 (vc-checkout-writable-buffer file
662 (if (vc-trunk-p (vc-workfile-version file))
663 "" ;; this means check out latest on trunk
664 (vc-branch-part (vc-workfile-version file)))))))
667 ;; a checked-out version exists, but the user may not own the lock
668 ((and (not (eq vc-type 'CVS))
669 (not (string-equal owner (user-login-name))))
671 (error "Sorry, you can't steal the lock on %s this way" file))
672 (and (eq vc-type 'RCS)
673 (not (vc-backend-release-p 'RCS "5.6.2"))
674 (error "File is locked by %s" owner))
677 (if verbose (read-string "Version to steal: ")
678 (vc-workfile-version file))
681 ;; OK, user owns the lock on the file
684 (find-file-other-window file)
687 ;; give luser a chance to save before checking in.
690 ;; Revert if file is unchanged and buffer is too.
691 ;; If buffer is modified, that means the user just said no
692 ;; to saving it; in that case, don't revert,
693 ;; because the user might intend to save
694 ;; after finishing the log entry.
695 (if (and (vc-workfile-unchanged-p file)
696 (not (buffer-modified-p)))
697 ;; DO NOT revert the file without asking the user!
699 ((yes-or-no-p "Revert to master version? ")
700 (vc-backend-revert file)
701 (vc-resynch-window file t t)))
703 ;; user may want to set nonstandard parameters
705 (setq version (read-string "New version level: ")))
707 ;; OK, let's do the checkin
708 (vc-checkin file version comment)
711 (defun vc-next-action-dired (file rev comment)
712 ;; Do a vc-next-action-on-file on all the marked files, possibly
713 ;; passing on the log comment we've just entered.
714 (let ((configuration (current-window-configuration))
715 (dired-buffer (current-buffer))
716 (dired-dir default-directory))
717 (dired-map-over-marks
718 (let ((file (dired-get-filename)) p
719 (default-directory default-directory))
720 (message "Processing %s..." file)
721 ;; Adjust the default directory so that checkouts
722 ;; go to the right place.
723 (setq default-directory (file-name-directory file))
724 (vc-next-action-on-file file nil comment)
725 (set-buffer dired-buffer)
726 (setq default-directory dired-dir)
727 (vc-dired-update-line file)
728 (set-window-configuration configuration)
729 (message "Processing %s...done" file))
732 ;; Here's the major entry point.
735 (defun vc-next-action (verbose)
736 "Do the next logical checkin or checkout operation on the current file.
737 If you call this from within a VC dired buffer with no files marked,
738 it will operate on the file in the current line.
739 If you call this from within a VC dired buffer, and one or more
740 files are marked, it will accept a log message and then operate on
741 each one. The log message will be used as a comment for any register
742 or checkin operations, but ignored when doing checkouts. Attempted
743 lock steals will raise an error.
744 A prefix argument lets you specify the version number to use.
746 For RCS and SCCS files:
747 If the file is not already registered, this registers it for version
748 control and then retrieves a writable, locked copy for editing.
749 If the file is registered and not locked by anyone, this checks out
750 a writable and locked file ready for editing.
751 If the file is checked out and locked by the calling user, this
752 first checks to see if the file has changed since checkout. If not,
753 it performs a revert.
754 If the file has been changed, this pops up a buffer for entry
755 of a log message; when the message has been entered, it checks in the
756 resulting changes along with the log message as change commentary. If
757 the variable `vc-keep-workfiles' is non-nil (which is its default), a
758 read-only copy of the changed file is left in place afterwards.
759 If the file is registered and locked by someone else, you are given
760 the option to steal the lock.
763 If the file is not already registered, this registers it for version
764 control. This does a \"cvs add\", but no \"cvs commit\".
765 If the file is added but not committed, it is committed.
766 If your working file is changed, but the repository file is
767 unchanged, this pops up a buffer for entry of a log message; when the
768 message has been entered, it checks in the resulting changes along
769 with the logmessage as change commentary. A writable file is retained.
770 If the repository file is changed, you are asked if you want to
771 merge in the changes into your working copy."
776 (let ((files (dired-get-marked-files)))
779 (function (lambda (f)
780 (if (eq (vc-backend f) 'CVS)
781 (if (or (eq (vc-cvs-status f) 'locally-modified)
782 (eq (vc-cvs-status f) 'locally-added))
784 (if (vc-locking-user f) "@" ""))))
786 (vc-next-action-dired nil nil "dummy")
787 (vc-start-entry nil nil nil
788 "Enter a change comment for the marked files."
789 'vc-next-action-dired))
791 (while vc-parent-buffer
792 (pop-to-buffer vc-parent-buffer))
794 (vc-next-action-on-file buffer-file-name verbose)
795 (vc-registration-error nil))))
797 ;;; These functions help the vc-next-action entry point
799 (defun vc-checkout-writable-buffer (&optional file rev)
800 "Retrieve a writable copy of the latest version of the current buffer's file."
801 (vc-checkout (or file (buffer-file-name)) t rev)
805 (defun vc-register (&optional override comment)
806 "Register the current file into your version-control system."
809 (error "No visited file"))
810 (let ((master (vc-name buffer-file-name)))
811 (and master (file-exists-p master)
812 (error "This file is already registered"))
814 (not (y-or-n-p "Previous master file has vanished. Make a new one? "))
815 (error "This file is already registered")))
816 ;; Watch out for new buffers of size 0: the corresponding file
817 ;; does not exist yet, even though buffer-modified-p is nil.
818 (if (and (not (buffer-modified-p))
819 (zerop (buffer-size))
820 (not (file-exists-p buffer-file-name)))
821 (set-buffer-modified-p t))
823 (cond ((not vc-make-backup-files)
824 ;; inhibit backup for this buffer
825 (make-local-variable 'backup-inhibited)
826 (setq backup-inhibited t)))
831 (format "Initial version level for %s: " buffer-file-name))))
834 (defun vc-resynch-window (file &optional keep noquery)
835 ;; If the given file is in the current buffer,
836 ;; either revert on it so we see expanded keywords,
837 ;; or unvisit it (depending on vc-keep-workfiles)
838 ;; NOQUERY if non-nil inhibits confirmation for reverting.
839 ;; NOQUERY should be t *only* if it is known the only difference
840 ;; between the buffer and the file is due to RCS rather than user editing!
841 (and (string= buffer-file-name file)
844 ;; temporarily remove vc-find-file-hook, so that
845 ;; we don't lose the properties
846 (remove-hook 'find-file-hooks 'vc-find-file-hook)
847 (vc-revert-buffer1 t noquery)
848 (add-hook 'find-file-hooks 'vc-find-file-hook)
849 (vc-mode-line buffer-file-name))
850 (kill-buffer (current-buffer)))))
852 (defun vc-resynch-buffer (file &optional keep noquery)
853 ;; if FILE is currently visited, resynch its buffer
854 (let ((buffer (get-file-buffer file)))
858 (vc-resynch-window file keep noquery)))))
860 (defun vc-start-entry (file rev comment msg action &optional after-hook)
861 ;; Accept a comment for an operation on FILE revision REV. If COMMENT
862 ;; is nil, pop up a VC-log buffer, emit MSG, and set the
863 ;; action on close to ACTION; otherwise, do action immediately.
864 ;; Remember the file's buffer in vc-parent-buffer (current one if no file).
865 ;; AFTER-HOOK specifies the local value for vc-log-operation-hook.
866 (let ((parent (if file (find-file-noselect file) (current-buffer))))
868 (set-buffer (get-buffer-create "*VC-log*"))
869 (pop-to-buffer (get-buffer-create "*VC-log*")))
870 (set (make-local-variable 'vc-parent-buffer) parent)
871 (set (make-local-variable 'vc-parent-buffer-name)
872 (concat " from " (buffer-name vc-parent-buffer)))
873 (if file (vc-mode-line file))
875 (make-local-variable 'vc-log-after-operation-hook)
877 (setq vc-log-after-operation-hook after-hook))
878 (setq vc-log-operation action)
879 (setq vc-log-file file)
880 (setq vc-log-version rev)
885 (vc-finish-logentry t)
887 (vc-finish-logentry nil)))
888 (message "%s Type C-c C-c when done." msg))))
890 (defun vc-admin (file rev &optional comment)
891 "Check a file into your version-control system.
892 FILE is the unmodified name of the file. REV should be the base version
893 level to check it in under. COMMENT, if specified, is the checkin comment."
894 (vc-start-entry file rev
895 (or comment (not vc-initial-comment))
896 "Enter initial comment." 'vc-backend-admin
899 (defun vc-checkout (file &optional writable rev)
900 "Retrieve a copy of the latest version of the given file."
901 ;; If ftp is on this system and the name matches the ange-ftp format
902 ;; for a remote file, the user is trying something that won't work.
903 (if (and (string-match "^/[^/:]+:" file) (vc-find-binary "ftp"))
904 (error "Sorry, you can't check out files over FTP"))
905 (vc-backend-checkout file writable rev)
906 (vc-resynch-buffer file t t))
908 (defun vc-steal-lock (file rev &optional owner)
909 "Steal the lock on the current workfile."
910 (let (file-description)
912 (setq owner (vc-locking-user file)))
914 (setq file-description (format "%s:%s" file rev))
915 (setq file-description file))
916 (if (not (y-or-n-p (format "Take the lock on %s from %s? "
917 file-description owner)))
918 (error "Steal cancelled"))
919 (pop-to-buffer (get-buffer-create "*VC-mail*"))
920 (setq default-directory (expand-file-name "~/"))
921 (auto-save-mode auto-save-default)
924 (mail-setup owner (format "Stolen lock on %s" file-description) nil nil nil
925 (list (list 'vc-finish-steal file rev)))
926 (goto-char (point-max))
928 (format "I stole the lock on %s, " file-description)
929 (current-time-string)
931 (message "Please explain why you stole the lock. Type C-c C-c when done.")))
933 ;; This is called when the notification has been sent.
934 (defun vc-finish-steal (file version)
935 (vc-backend-steal file version)
936 (if (get-file-buffer file)
938 (set-buffer (get-file-buffer file))
939 (vc-resynch-window file t t))))
941 (defun vc-checkin (file &optional rev comment)
942 "Check in the file specified by FILE.
943 The optional argument REV may be a string specifying the new version level
944 \(if nil increment the current level). The file is either retained with write
945 permissions zeroed, or deleted (according to the value of `vc-keep-workfiles').
946 If the back-end is CVS, a writable workfile is always kept.
947 COMMENT is a comment string; if omitted, a buffer is
948 popped up to accept a comment."
949 (vc-start-entry file rev comment
950 "Enter a change comment." 'vc-backend-checkin
953 ;;; Here is a checkin hook that may prove useful to sites using the
954 ;;; ChangeLog facility supported by Emacs.
955 (defun vc-comment-to-change-log (&optional whoami file-name)
956 "Enter last VC comment into change log file for current buffer's file.
957 Optional arg (interactive prefix) non-nil means prompt for user name and site.
958 Second arg is file name of change log. \
959 If nil, uses `change-log-default-name'."
960 (interactive (if current-prefix-arg
961 (list current-prefix-arg
962 (prompt-for-change-log-name))))
963 ;; Make sure the defvar for add-log-current-defun-function has been executed
964 ;; before binding it.
966 (let (;; Extract the comment first so we get any error before doing anything.
967 (comment (ring-ref vc-comment-ring 0))
968 ;; Don't let add-change-log-entry insert a defun name.
969 (add-log-current-defun-function 'ignore)
971 ;; Call add-log to do half the work.
972 (add-change-log-entry whoami file-name t t)
973 ;; Insert the VC comment, leaving point before it.
974 (setq end (save-excursion (insert comment) (point-marker)))
975 (if (looking-at "\\s *\\s(")
976 ;; It starts with an open-paren, as in "(foo): Frobbed."
977 ;; So remove the ": " add-log inserted.
979 ;; Canonicalize the white space between the file name and comment.
981 ;; Indent rest of the text the same way add-log indented the first line.
982 (let ((indentation (current-indentation)))
984 (while (< (point) end)
986 (indent-to indentation))
988 ;; Fill the inserted text, preserving open-parens at bol.
989 (let ((paragraph-separate (concat paragraph-separate "\\|\\s *\\s("))
990 (paragraph-start (concat paragraph-start "\\|\\s *\\s(")))
992 (fill-region (point) end))
993 ;; Canonicalize the white space at the end of the entry so it is
994 ;; separated from the next entry by a single blank line.
995 (skip-syntax-forward " " end)
996 (delete-char (- (skip-syntax-backward " ")))
997 (or (eobp) (looking-at "\n\n")
1001 (defun vc-finish-logentry (&optional nocomment)
1002 "Complete the operation implied by the current log entry."
1004 ;; Check and record the comment, if any.
1007 (goto-char (point-max))
1010 ;; Comment too long?
1011 (vc-backend-logentry-check vc-log-file)
1012 ;; Record the comment in the comment ring
1013 (ring-insert vc-comment-ring (buffer-string))
1015 ;; Sync parent buffer in case the user modified it while editing the comment.
1016 ;; But not if it is a vc-dired buffer.
1018 (set-buffer vc-parent-buffer)
1021 (if (not vc-log-operation) (error "No log operation is pending"))
1022 ;; save the parameters held in buffer-local variables
1023 (let ((log-operation vc-log-operation)
1024 (log-file vc-log-file)
1025 (log-version vc-log-version)
1026 (log-entry (buffer-string))
1027 (after-hook vc-log-after-operation-hook))
1028 ;; Return to "parent" buffer of this checkin and remove checkin window
1029 (pop-to-buffer vc-parent-buffer)
1030 (let ((logbuf (get-buffer "*VC-log*")))
1031 (delete-windows-on logbuf)
1032 (kill-buffer logbuf))
1035 (funcall log-operation
1039 ;; Now make sure we see the expanded headers
1040 (if buffer-file-name
1041 (vc-resynch-window buffer-file-name vc-keep-workfiles t))
1042 (run-hooks after-hook)))
1044 ;; Code for access to the comment ring
1046 (defun vc-previous-comment (arg)
1047 "Cycle backwards through comment history."
1049 (let ((len (ring-length vc-comment-ring)))
1051 (message "Empty comment ring")
1055 ;; Initialize the index on the first use of this command
1056 ;; so that the first M-p gets index 0, and the first M-n gets
1058 (if (null vc-comment-ring-index)
1059 (setq vc-comment-ring-index
1061 (if (< arg 0) 1 0))))
1062 (setq vc-comment-ring-index
1063 (mod (+ vc-comment-ring-index arg) len))
1064 (message "%d" (1+ vc-comment-ring-index))
1065 (insert (ring-ref vc-comment-ring vc-comment-ring-index))))))
1067 (defun vc-next-comment (arg)
1068 "Cycle forwards through comment history."
1070 (vc-previous-comment (- arg)))
1072 (defun vc-comment-search-reverse (str)
1073 "Searches backwards through comment history for substring match."
1074 (interactive "sComment substring: ")
1075 (if (string= str "")
1076 (setq str vc-last-comment-match)
1077 (setq vc-last-comment-match str))
1078 (if (null vc-comment-ring-index)
1079 (setq vc-comment-ring-index -1))
1080 (let ((str (regexp-quote str))
1081 (len (ring-length vc-comment-ring))
1082 (n (1+ vc-comment-ring-index)))
1083 (while (and (< n len) (not (string-match str (ring-ref vc-comment-ring n))))
1086 (vc-previous-comment (- n vc-comment-ring-index)))
1087 (t (error "Not found")))))
1089 (defun vc-comment-search-forward (str)
1090 "Searches forwards through comment history for substring match."
1091 (interactive "sComment substring: ")
1092 (if (string= str "")
1093 (setq str vc-last-comment-match)
1094 (setq vc-last-comment-match str))
1095 (if (null vc-comment-ring-index)
1096 (setq vc-comment-ring-index 0))
1097 (let ((str (regexp-quote str))
1098 (len (ring-length vc-comment-ring))
1099 (n vc-comment-ring-index))
1100 (while (and (>= n 0) (not (string-match str (ring-ref vc-comment-ring n))))
1103 (vc-next-comment (- n vc-comment-ring-index)))
1104 (t (error "Not found")))))
1106 ;; Additional entry points for examining version histories
1109 (defun vc-diff (historic &optional not-urgent)
1110 "Display diffs between file versions.
1111 Normally this compares the current file and buffer with the most recent
1112 checked in version of that file. This uses no arguments.
1113 With a prefix argument, it reads the file name to use
1114 and two version designators specifying which versions to compare."
1115 (interactive (list current-prefix-arg t))
1117 (set-buffer (find-file-noselect (dired-get-filename))))
1118 (while vc-parent-buffer
1119 (pop-to-buffer vc-parent-buffer))
1121 (call-interactively 'vc-version-diff)
1122 (if (or (null buffer-file-name) (null (vc-name buffer-file-name)))
1124 "There is no version-control master associated with this buffer"))
1125 (let ((file buffer-file-name)
1127 (or (and file (vc-name file))
1128 (vc-registration-error file))
1129 (vc-buffer-sync not-urgent)
1130 (setq unchanged (vc-workfile-unchanged-p buffer-file-name))
1132 (message "No changes to %s since latest version" file)
1133 (vc-backend-diff file)
1134 ;; Ideally, we'd like at this point to parse the diff so that
1135 ;; the buffer effectively goes into compilation mode and we
1136 ;; can visit the old and new change locations via next-error.
1137 ;; Unfortunately, this is just too painful to do. The basic
1138 ;; problem is that the `old' file doesn't exist to be
1139 ;; visited. This plays hell with numerous assumptions in
1140 ;; the diff.el and compile.el machinery.
1141 (set-buffer "*vc-diff*")
1142 (setq default-directory (file-name-directory file))
1143 (if (= 0 (buffer-size))
1146 (message "No changes to %s since latest version" file))
1147 (pop-to-buffer "*vc-diff*")
1148 (goto-char (point-min))
1149 (shrink-window-if-larger-than-buffer)))
1152 (defun vc-version-diff (file rel1 rel2)
1153 "For FILE, report diffs between two stored versions REL1 and REL2 of it.
1154 If FILE is a directory, generate diffs between versions for all registered
1155 files in or below it."
1156 (interactive "FFile or directory to diff: \nsOlder version: \nsNewer version: ")
1157 (if (string-equal rel1 "") (setq rel1 nil))
1158 (if (string-equal rel2 "") (setq rel2 nil))
1159 (if (file-directory-p file)
1160 (let ((camefrom (current-buffer)))
1161 (set-buffer (get-buffer-create "*vc-status*"))
1162 (set (make-local-variable 'vc-parent-buffer) camefrom)
1163 (set (make-local-variable 'vc-parent-buffer-name)
1164 (concat " from " (buffer-name camefrom)))
1166 (insert "Diffs between "
1167 (or rel1 "last version checked in")
1169 (or rel2 "current workfile(s)")
1171 (set-buffer (get-buffer-create "*vc-diff*"))
1175 (function (lambda (f)
1176 (message "Looking at %s" f)
1178 (not (file-directory-p f))
1180 (vc-backend-diff f rel1 rel2)
1181 (append-to-buffer "*vc-status*" (point-min) (point-max)))
1183 (pop-to-buffer "*vc-status*")
1184 (insert "\nEnd of diffs.\n")
1185 (goto-char (point-min))
1186 (set-buffer-modified-p nil)
1188 (if (zerop (vc-backend-diff file rel1 rel2))
1189 (message "No changes to %s between %s and %s." file rel1 rel2)
1190 (pop-to-buffer "*vc-diff*"))))
1193 (defun vc-version-other-window (rev)
1194 "Visit version REV of the current buffer in another window.
1195 If the current buffer is named `F', the version is named `F.~REV~'.
1196 If `F.~REV~' already exists, it is used instead of being re-created."
1197 (interactive "sVersion to visit (default is latest version): ")
1199 (set-buffer (find-file-noselect (dired-get-filename))))
1200 (while vc-parent-buffer
1201 (pop-to-buffer vc-parent-buffer))
1202 (if (and buffer-file-name (vc-name buffer-file-name))
1203 (let* ((version (if (string-equal rev "")
1204 (vc-latest-version buffer-file-name)
1206 (filename (concat buffer-file-name ".~" version "~")))
1207 (or (file-exists-p filename)
1208 (vc-backend-checkout buffer-file-name nil version filename))
1209 (find-file-other-window filename))
1210 (vc-registration-error buffer-file-name)))
1212 ;; Header-insertion code
1215 (defun vc-insert-headers ()
1216 "Insert headers in a file for use with your version-control system.
1217 Headers desired are inserted at the start of the buffer, and are pulled from
1218 the variable `vc-header-alist'."
1221 (find-file-other-window (dired-get-filename)))
1222 (while vc-parent-buffer
1223 (pop-to-buffer vc-parent-buffer))
1227 (if (or (not (vc-check-headers))
1228 (y-or-n-p "Version headers already exist. Insert another set? "))
1230 (let* ((delims (cdr (assq major-mode vc-comment-alist)))
1231 (comment-start-vc (or (car delims) comment-start "#"))
1232 (comment-end-vc (or (car (cdr delims)) comment-end ""))
1233 (hdstrings (cdr (assoc (vc-backend (buffer-file-name)) vc-header-alist))))
1234 (mapcar (function (lambda (s)
1235 (insert comment-start-vc "\t" s "\t"
1236 comment-end-vc "\n")))
1238 (if vc-static-header-alist
1239 (mapcar (function (lambda (f)
1240 (if (string-match (car f) buffer-file-name)
1241 (insert (format (cdr f) (car hdstrings))))))
1242 vc-static-header-alist))
1246 (defun vc-clear-headers ()
1247 ;; Clear all version headers in the current buffer, i.e. reset them
1248 ;; to the nonexpanded form. Only implemented for RCS, yet.
1249 ;; Don't lose point and mark during this.
1250 (let ((context (vc-buffer-context)))
1251 (goto-char (point-min))
1252 (while (re-search-forward "\\$\\([A-Za-z]+\\): [^\\$]+\\$" nil t)
1253 (replace-match "$\\1$"))
1254 (vc-restore-buffer-context context)))
1256 ;; The VC directory major mode. Coopt Dired for this.
1257 ;; All VC commands get mapped into logical equivalents.
1259 (define-derived-mode vc-dired-mode dired-mode "Dired under VC"
1260 "The major mode used in VC directory buffers. It is derived from Dired.
1261 All Dired commands operate normally. Users currently locking listed files
1262 are listed in place of the file's owner and group.
1263 Keystrokes bound to VC commands will execute as though they had been called
1264 on a buffer attached to the file named in the current Dired buffer line."
1265 (setq vc-dired-mode t))
1267 (define-key vc-dired-mode-map "\C-xv" vc-prefix-map)
1268 (define-key vc-dired-mode-map "g" 'vc-dired-update)
1269 (define-key vc-dired-mode-map "=" 'vc-diff)
1271 (defun vc-dired-state-info (file)
1272 ;; Return the string that indicates the version control status
1273 ;; on a VC dired line.
1274 (let ((cvs-state (and (eq (vc-backend file) 'CVS)
1275 (vc-cvs-status file))))
1277 (cond ((eq cvs-state 'up-to-date) nil)
1278 ((eq cvs-state 'needs-checkout) "patch")
1279 ((eq cvs-state 'locally-modified) "modified")
1280 ((eq cvs-state 'needs-merge) "merge")
1281 ((eq cvs-state 'unresolved-conflict) "conflict")
1282 ((eq cvs-state 'locally-added) "added"))
1283 (vc-locking-user file))))
1285 (defun vc-dired-reformat-line (x)
1286 ;; Hack a directory-listing line, plugging in locking-user info in
1287 ;; place of the user and group info. Should have the beneficial
1288 ;; side-effect of shortening the listing line. Each call starts with
1289 ;; point immediately following the dired mark area on the line to be
1292 ;; Simplest possible one:
1293 ;; (insert (concat x "\t")))
1295 ;; This code, like dired, assumes UNIX -l format.
1296 (let ((pos (point)) limit perm owner date-and-file)
1298 (setq limit (point))
1302 (re-search-forward ;; owner and group
1303 "\\([drwxlts-]+ \\) *[0-9]+ \\([^ ]+\\) +[^ ]+ +[0-9]+\\( [^ 0-9]+ [0-9 ][0-9] .*\\)"
1305 (re-search-forward ;; only owner displayed
1306 "\\([drwxlts-]+ \\) *[0-9]+ \\([^ ]+\\) +[0-9]+\\( [^ 0-9]+ [0-9 ][0-9] .*\\)"
1308 (setq perm (match-string 1)
1309 owner (match-string 2)
1310 date-and-file (match-string 3)))
1311 ((re-search-forward ;; OS/2 -l format, no links, owner, group
1312 "\\([drwxlts-]+ \\) *[0-9]+\\( [^ 0-9]+ [0-9 ][0-9] .*\\)"
1314 (setq perm (match-string 1)
1315 date-and-file (match-string 2))))
1316 (if (numberp x) (setq x (or owner (number-to-string x))))
1317 (if x (setq x (concat "(" x ")")))
1318 (let ((rep (substring (concat x " ") 0 10)))
1319 (replace-match (concat perm rep date-and-file)))))
1321 (defun vc-dired-update-line (file)
1322 ;; Update the vc-dired listing line of file -- it is assumed
1323 ;; that point is already on this line. Don't use dired-do-redisplay
1324 ;; for this, because it cannot handle the way vc-dired deals with
1328 (let ((start (point)))
1331 (delete-region start (point))
1332 (insert-directory file dired-listing-switches)
1335 (delete-char (- (length file)))
1336 (insert (substring file (length (expand-file-name default-directory))))
1338 (vc-dired-reformat-line (vc-dired-state-info file)))
1340 (defun vc-dired-update (verbose)
1342 (vc-directory default-directory verbose))
1344 ;;; Note in Emacs 18 the following defun gets overridden
1345 ;;; with the symbol 'vc-directory-18. See below.
1347 (defun vc-directory (dirname verbose)
1348 "Show version-control status of the current directory and subdirectories.
1349 Normally it creates a Dired buffer that lists only the locked files
1350 in all these directories. With a prefix argument, it lists all files."
1351 (interactive "DDired under VC (directory): \nP")
1353 (setq dirname (expand-file-name dirname))
1354 ;; force a trailing slash
1355 (if (not (eq (elt dirname (1- (length dirname))) ?/))
1356 (setq dirname (concat dirname "/")))
1358 (dl (length dirname))
1359 (filelist nil) (statelist nil)
1360 (old-dir default-directory)
1362 dired-buf-mod-count)
1367 (if (vc-registered f)
1368 (let ((state (vc-dired-state-info f)))
1369 (and (or verbose state)
1370 (setq filelist (cons (substring f dl) filelist))
1371 (setq statelist (cons state statelist))))))))
1372 (save-window-excursion
1374 ;; This uses a semi-documented feature of dired; giving a switch
1375 ;; argument forces the buffer to refresh each time.
1377 (dired-internal-noselect
1378 (cons dirname (nreverse filelist))
1379 dired-listing-switches 'vc-dired-mode))
1380 (setq nonempty (not (eq 0 (length filelist))))))
1381 (switch-to-buffer dired-buf)
1382 ;; Make a few modifications to the header
1383 (setq buffer-read-only nil)
1384 (goto-char (point-min))
1385 (forward-line 1) ;; Skip header line
1386 (let ((start (point))) ;; Erase (but don't remove) the
1387 (end-of-line) ;; "wildcard" line.
1388 (delete-region start (point)))
1392 ;; Plug the version information into the individual lines
1396 (forward-char 2) ;; skip dired's mark area
1397 (vc-dired-reformat-line x)
1398 (forward-line 1))) ;; go to next line
1399 (nreverse statelist))
1400 (setq buffer-read-only t)
1401 (goto-char (point-min))
1406 (setq buffer-read-only t)
1407 (message "No files are currently %s under %s"
1408 (if verbose "registered" "locked") dirname))
1412 (defun vc-directory-18 (verbose)
1413 "Show version-control status of all files under the current directory."
1415 (let (nonempty (dir default-directory))
1417 (set-buffer (get-buffer-create "*vc-status*"))
1422 (function (lambda (f)
1423 (if (vc-registered f)
1424 (let ((user (vc-locking-user f)))
1425 (if (or user verbose)
1428 (concat user) f))))))))
1429 (setq nonempty (not (zerop (buffer-size)))))
1433 (pop-to-buffer "*vc-status*" t)
1434 (goto-char (point-min))
1435 (shrink-window-if-larger-than-buffer)))
1436 (message "No files are currently %s under %s"
1437 (if verbose "registered" "locked") default-directory))
1440 (or (boundp 'minor-mode-map-alist)
1441 (fset 'vc-directory 'vc-directory-18))
1443 ;; Named-configuration support for SCCS
1445 (defun vc-add-triple (name file rev)
1447 (find-file (expand-file-name
1449 (file-name-as-directory
1450 (expand-file-name (vc-backend-subdirectory-name file)
1451 (file-name-directory file)))))
1452 (goto-char (point-max))
1453 (insert name "\t:\t" file "\t" rev "\n")
1455 (kill-buffer (current-buffer))
1458 (defun vc-record-rename (file newname)
1463 (file-name-as-directory
1464 (expand-file-name (vc-backend-subdirectory-name file)
1465 (file-name-directory file)))))
1466 (goto-char (point-min))
1467 ;; (replace-regexp (concat ":" (regexp-quote file) "$") (concat ":" newname))
1468 (while (re-search-forward (concat ":" (regexp-quote file) "$") nil t)
1469 (replace-match (concat ":" newname) nil nil))
1471 (kill-buffer (current-buffer))
1474 (defun vc-lookup-triple (file name)
1475 ;; Return the numeric version corresponding to a named snapshot of file
1476 ;; If name is nil or a version number string it's just passed through
1477 (cond ((null name) name)
1478 ((let ((firstchar (aref name 0)))
1479 (and (>= firstchar ?0) (<= firstchar ?9)))
1483 (set-buffer (get-buffer-create "*vc-info*"))
1487 (file-name-as-directory
1488 (expand-file-name (vc-backend-subdirectory-name file)
1489 (file-name-directory file)))))
1491 (car (vc-parse-buffer
1492 (list (list (concat name "\t:\t" file "\t\\(.+\\)") 1))))
1493 (kill-buffer "*vc-info*"))))
1496 ;; Named-configuration entry points
1498 (defun vc-snapshot-precondition ()
1499 ;; Scan the tree below the current directory.
1500 ;; If any files are locked, return the name of the first such file.
1501 ;; (This means, neither snapshot creation nor retrieval is allowed.)
1502 ;; If one or more of the files are currently visited, return `visited'.
1503 ;; Otherwise, return nil.
1505 (catch 'vc-locked-example
1508 (function (lambda (f)
1509 (and (vc-registered f)
1510 (if (vc-locking-user f) (throw 'vc-locked-example f)
1511 (if (get-file-buffer f) (setq status 'visited)))))))
1515 (defun vc-create-snapshot (name)
1516 "Make a snapshot called NAME.
1517 The snapshot is made from all registered files at or below the current
1518 directory. For each file, the version level of its latest
1519 version becomes part of the named configuration."
1520 (interactive "sNew snapshot name: ")
1521 (let ((result (vc-snapshot-precondition)))
1522 (if (stringp result)
1523 (error "File %s is locked" result)
1526 (function (lambda (f) (and
1528 (vc-backend-assign-name f name)))))
1532 (defun vc-retrieve-snapshot (name)
1533 "Retrieve the snapshot called NAME.
1534 This function fails if any files are locked at or below the current directory
1535 Otherwise, all registered files are checked out (unlocked) at their version
1536 levels in the snapshot."
1537 (interactive "sSnapshot name to retrieve: ")
1538 (let ((result (vc-snapshot-precondition))
1540 (if (stringp result)
1541 (error "File %s is locked" result)
1542 (if (eq result 'visited)
1543 (setq update (yes-or-no-p "Update the affected buffers? ")))
1546 (function (lambda (f) (and
1549 (vc-backend-checkout f nil name)
1550 (if update (vc-resynch-buffer f t t)))))))
1553 ;; Miscellaneous other entry points
1556 (defun vc-print-log ()
1557 "List the change log of the current buffer in a window."
1560 (set-buffer (find-file-noselect (dired-get-filename))))
1561 (while vc-parent-buffer
1562 (pop-to-buffer vc-parent-buffer))
1563 (if (and buffer-file-name (vc-name buffer-file-name))
1564 (let ((file buffer-file-name))
1565 (vc-backend-print-log file)
1566 (pop-to-buffer (get-buffer-create "*vc*"))
1567 (setq default-directory (file-name-directory file))
1568 (goto-char (point-max)) (forward-line -1)
1569 (while (looking-at "=*\n")
1570 (delete-char (- (match-end 0) (match-beginning 0)))
1572 (goto-char (point-min))
1573 (if (looking-at "[\b\t\n\v\f\r ]+")
1574 (delete-char (- (match-end 0) (match-beginning 0))))
1575 (shrink-window-if-larger-than-buffer)
1576 ;; move point to the log entry for the current version
1577 (and (not (eq (vc-backend file) 'SCCS))
1579 ;; also match some context, for safety
1580 (concat "----\nrevision " (vc-workfile-version file)
1581 "\\(\tlocked by:.*\n\\|\n\\)date: ") nil t)
1582 ;; set the display window so that
1583 ;; the whole log entry is displayed
1584 (let (start end lines)
1585 (beginning-of-line) (forward-line -1) (setq start (point))
1586 (if (not (re-search-forward "^----*\nrevision" nil t))
1587 (setq end (point-max))
1588 (beginning-of-line) (forward-line -1) (setq end (point)))
1589 (setq lines (count-lines start end))
1591 ;; if the global information and this log entry fit
1592 ;; into the window, display from the beginning
1593 ((< (count-lines (point-min) end) (window-height))
1594 (goto-char (point-min))
1597 ;; if the whole entry fits into the window,
1598 ;; display it centered
1599 ((< (1+ lines) (window-height))
1601 (recenter (1- (- (/ (window-height) 2) (/ lines 2)))))
1602 ;; otherwise (the entry is too large for the window),
1603 ;; display from the start
1608 (vc-registration-error buffer-file-name)
1613 (defun vc-revert-buffer ()
1614 "Revert the current buffer's file back to the latest checked-in version.
1615 This asks for confirmation if the buffer contents are not identical
1617 If the back-end is CVS, this will give you the most recent revision of
1618 the file on the branch you are editing."
1621 (find-file-other-window (dired-get-filename)))
1622 (while vc-parent-buffer
1623 (pop-to-buffer vc-parent-buffer))
1624 (let ((file buffer-file-name)
1625 ;; This operation should always ask for confirmation.
1626 (vc-suppress-confirm nil)
1627 (obuf (current-buffer)) (changed (vc-diff nil t)))
1628 (if (and changed (not (yes-or-no-p "Discard changes? ")))
1630 (if (and (window-dedicated-p (selected-window))
1631 (one-window-p t 'selected-frame))
1632 (make-frame-invisible (selected-frame))
1634 (error "Revert cancelled"))
1637 (if (and (window-dedicated-p (selected-window))
1638 (one-window-p t 'selected-frame))
1639 (make-frame-invisible (selected-frame))
1641 (vc-backend-revert file)
1642 (vc-resynch-window file t t)
1647 (defun vc-cancel-version (norevert)
1648 "Get rid of most recently checked in version of this file.
1649 A prefix argument means do not revert the buffer afterwards."
1652 (find-file-other-window (dired-get-filename)))
1653 (while vc-parent-buffer
1654 (pop-to-buffer vc-parent-buffer))
1656 ((not (vc-registered (buffer-file-name)))
1657 (vc-registration-error (buffer-file-name)))
1658 ((eq (vc-backend (buffer-file-name)) 'CVS)
1659 (error "Unchecking files under CVS is dangerous and not supported in VC"))
1660 ((vc-locking-user (buffer-file-name))
1661 (error "This version is locked; use vc-revert-buffer to discard changes"))
1662 ((not (vc-latest-on-branch-p (buffer-file-name)))
1663 (error "This is not the latest version--VC cannot cancel it")))
1664 (let* ((target (vc-workfile-version (buffer-file-name)))
1665 (recent (if (vc-trunk-p target) "" (vc-branch-part target)))
1666 (config (current-window-configuration)) done)
1667 (if (null (yes-or-no-p (format "Remove version %s from master? " target)))
1669 (setq norevert (or norevert (not
1670 (yes-or-no-p "Revert buffer to most recent remaining version? "))))
1671 (vc-backend-uncheck (buffer-file-name) target)
1672 ;; Check out the most recent remaining version. If it fails, because
1673 ;; the whole branch got deleted, do a double-take and check out the
1674 ;; version where the branch started.
1679 ;; Check out locked, but only to disc, and keep
1680 ;; modifications in the buffer.
1681 (vc-backend-checkout (buffer-file-name) t recent)
1682 ;; Check out unlocked, and revert buffer.
1683 (vc-checkout (buffer-file-name) nil recent))
1685 ;; If the checkout fails, vc-do-command signals an error.
1686 ;; We catch this error, check the reason, correct the
1687 ;; version number, and try a second time.
1688 (error (set-buffer "*vc*")
1689 (goto-char (point-min))
1690 (if (search-forward "no side branches present for" nil t)
1691 (progn (setq recent (vc-branch-part recent))
1692 ;; vc-do-command popped up a window with
1693 ;; the error message. Get rid of it, by
1694 ;; restoring the old window configuration.
1695 (set-window-configuration config))
1696 ;; No, it was some other error: re-signal it.
1697 (signal (car err) (cdr err))))))
1698 ;; If norevert, clear version headers and mark the buffer modified.
1701 (set-visited-file-name (buffer-file-name))
1702 (if (not vc-make-backup-files)
1703 ;; inhibit backup for this buffer
1704 (progn (make-local-variable 'backup-inhibited)
1705 (setq backup-inhibited t)))
1706 (if (eq (vc-backend (buffer-file-name)) 'RCS)
1707 (progn (setq buffer-read-only nil)
1708 (vc-clear-headers)))
1709 (vc-mode-line (buffer-file-name))))
1710 (message "Version %s has been removed from the master" target)
1714 (defun vc-rename-file (old new)
1715 "Rename file OLD to NEW, and rename its master file likewise."
1716 (interactive "fVC rename file: \nFRename to: ")
1717 ;; There are several ways of renaming files under CVS 1.3, but they all
1718 ;; have serious disadvantages. See the FAQ (available from think.com in
1719 ;; pub/cvs/). I'd rather send the user an error, than do something he might
1720 ;; consider to be wrong. When the famous, long-awaited rename database is
1721 ;; implemented things might change for the better. This is unlikely to occur
1722 ;; until CVS 2.0 is released. --ceder 1994-01-23 21:27:51
1723 (if (eq (vc-backend old) 'CVS)
1724 (error "Renaming files under CVS is dangerous and not supported in VC"))
1725 (let ((oldbuf (get-file-buffer old)))
1726 (if (and oldbuf (buffer-modified-p oldbuf))
1727 (error "Please save files before moving them"))
1728 (if (get-file-buffer new)
1729 (error "Already editing new file name"))
1730 (if (file-exists-p new)
1731 (error "New file already exists"))
1732 (let ((oldmaster (vc-name old)))
1735 (if (vc-locking-user old)
1736 (error "Please check in files before moving them"))
1737 (if (or (file-symlink-p oldmaster)
1738 ;; This had FILE, I changed it to OLD. -- rms.
1739 (file-symlink-p (vc-backend-subdirectory-name old)))
1740 (error "This is not a safe thing to do in the presence of symbolic links"))
1743 (let ((backend (vc-backend old))
1744 (newdir (or (file-name-directory new) ""))
1745 (newbase (file-name-nondirectory new)))
1750 (if (eq backend (cdr s))
1751 (let* ((newmaster (format (car s) newdir newbase))
1752 (newmasterdir (file-name-directory newmaster)))
1753 (if (or (not newmasterdir)
1754 (file-directory-p newmasterdir))
1755 (throw 'found newmaster))))))
1756 vc-master-templates)
1757 (error "New file lacks a version control directory"))))))
1758 (if (or (not oldmaster) (file-exists-p old))
1759 (rename-file old new)))
1760 ; ?? Renaming a file might change its contents due to keyword expansion.
1761 ; We should really check out a new copy if the old copy was precisely equal
1762 ; to some checked in version. However, testing for this is tricky....
1766 (let ((buffer-read-only buffer-read-only))
1767 (set-visited-file-name new))
1770 (set-buffer-modified-p nil))))
1771 ;; This had FILE, I changed it to OLD. -- rms.
1772 (vc-backend-dispatch old
1773 (vc-record-rename old new) ;SCCS
1780 (defun vc-update-change-log (&rest args)
1781 "Find change log file and add entries from recent RCS/CVS logs.
1782 Normally, find log entries for all registered files in the default
1783 directory using `rcs2log', which finds CVS logs preferentially.
1784 The mark is left at the end of the text prepended to the change log.
1786 With prefix arg of C-u, only find log entries for the current buffer's file.
1788 With any numeric prefix arg, find log entries for all currently visited
1789 files that are under version control. This puts all the entries in the
1790 log for the default directory, which may not be appropriate.
1792 From a program, any arguments are assumed to be filenames and are
1793 passed to the `rcs2log' script after massaging to be relative to the
1796 (cond ((consp current-prefix-arg) ;C-u
1797 (list buffer-file-name))
1798 (current-prefix-arg ;Numeric argument.
1800 (buffers (buffer-list))
1803 (setq file (buffer-file-name (car buffers)))
1804 (and file (vc-backend file)
1805 (setq files (cons file files)))
1806 (setq buffers (cdr buffers)))
1809 ;; `rcs2log' will find the relevant RCS or CVS files
1810 ;; relative to the curent directory if none supplied.
1812 (let ((odefault default-directory)
1813 (full-name (or add-log-full-name
1815 (mailing-address (or add-log-mailing-address
1816 user-mail-address)))
1817 (find-file-other-window (find-change-log))
1818 (barf-if-buffer-read-only)
1821 (goto-char (point-min))
1823 (message "Computing change log entries...")
1824 (message "Computing change log entries... %s"
1825 (if (eq 0 (apply 'call-process "rcs2log" nil '(t nil) nil
1827 (concat (user-login-name)
1835 (if (file-name-absolute-p f)
1837 (concat odefault f)))))
1841 ;; Collect back-end-dependent stuff here
1843 (defun vc-backend-admin (file &optional rev comment)
1844 ;; Register a file into the version-control system
1845 ;; Automatically retrieves a read-only version of the file with
1846 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
1847 ;; it deletes the workfile.
1848 (vc-file-clearprops file)
1849 (or vc-default-back-end
1850 (setq vc-default-back-end (if (vc-find-binary "rcs") 'RCS 'SCCS)))
1851 (message "Registering %s..." file)
1853 (if (stringp vc-register-switches)
1854 (list vc-register-switches)
1855 vc-register-switches))
1858 ((file-exists-p (vc-backend-subdirectory-name)) vc-default-back-end)
1859 ((file-exists-p "RCS") 'RCS)
1860 ((file-exists-p "SCCS") 'SCCS)
1861 ((file-exists-p "CVS") 'CVS)
1862 (t vc-default-back-end))))
1863 (cond ((eq backend 'SCCS)
1864 (apply 'vc-do-command nil 0 "admin" file 'MASTER ;; SCCS
1865 (and rev (concat "-r" rev))
1868 (and comment (concat "-y" comment))
1870 (car (rassq 'SCCS vc-master-templates))
1871 (or (file-name-directory file) "")
1872 (file-name-nondirectory file))
1875 (if vc-keep-workfiles
1876 (vc-do-command nil 0 "get" file 'MASTER)))
1878 (apply 'vc-do-command nil 0 "ci" file 'WORKFILE ;; RCS
1879 ;; if available, use the secure registering option
1880 (and (vc-backend-release-p 'RCS "5.6.4") "-i")
1881 (concat (if vc-keep-workfiles "-u" "-r") rev)
1882 (and comment (concat "-t-" comment))
1885 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE ;; CVS
1887 (and comment (string-match "[^\t\n ]" comment)
1888 (concat "-m" comment))
1891 (message "Registering %s...done" file)
1894 (defun vc-backend-checkout (file &optional writable rev workfile)
1895 ;; Retrieve a copy of a saved version into a workfile
1896 (let ((filename (or workfile file))
1897 (file-buffer (get-file-buffer file))
1899 (message "Checking out %s..." filename)
1901 ;; Change buffers to get local value of vc-checkout-switches.
1902 (if file-buffer (set-buffer file-buffer))
1903 (setq switches (if (stringp vc-checkout-switches)
1904 (list vc-checkout-switches)
1905 vc-checkout-switches))
1906 ;; Save this buffer's default-directory
1907 ;; and use save-excursion to make sure it is restored
1908 ;; in the same buffer it was saved in.
1909 (let ((default-directory default-directory))
1911 ;; Adjust the default-directory so that the check-out creates
1912 ;; the file in the right place.
1913 (setq default-directory (file-name-directory filename))
1914 (vc-backend-dispatch file
1916 (and rev (string= rev "") (setq rev nil))
1918 ;; Some SCCS implementations allow checking out directly to a
1919 ;; file using the -G option, but then some don't so use the
1920 ;; least common denominator approach and use the -p option
1922 (let ((vc-modes (logior (file-modes (vc-name file))
1923 (if writable 128 0)))
1927 (apply 'vc-do-command
1928 nil 0 "/bin/sh" file 'MASTER "-c"
1929 ;; Some shells make the "" dummy argument into $0
1930 ;; while others use the shell's name as $0 and
1931 ;; use the "" as $1. The if-statement
1932 ;; converts the latter case to the former.
1933 (format "if [ x\"$1\" = x ]; then shift; fi; \
1934 umask %o; exec >\"$1\" || exit; \
1935 shift; umask %o; exec get \"$@\""
1936 (logand 511 (lognot vc-modes))
1937 (logand 511 (lognot (default-file-modes))))
1938 "" ; dummy argument for shell's $0
1943 (concat "-r" (vc-lookup-triple file rev)))
1946 (and failed (file-exists-p filename)
1947 (delete-file filename))))
1948 (apply 'vc-do-command nil 0 "get" file 'MASTER ;; SCCS
1950 (and rev (concat "-r" (vc-lookup-triple file rev)))
1952 (vc-file-setprop file 'vc-workfile-version nil)))
1954 ;; RCS doesn't let us check out into arbitrary file names directly.
1955 ;; Use `co -p' and make stdout point to the correct file.
1956 (let ((vc-modes (logior (file-modes (vc-name file))
1957 (if writable 128 0)))
1961 (apply 'vc-do-command
1962 nil 0 "/bin/sh" file 'MASTER "-c"
1963 ;; See the SCCS case, above, regarding the
1965 (format "if [ x\"$1\" = x ]; then shift; fi; \
1966 umask %o; exec >\"$1\" || exit; \
1967 shift; umask %o; exec co \"$@\""
1968 (logand 511 (lognot vc-modes))
1969 (logand 511 (lognot (default-file-modes))))
1970 "" ; dummy argument for shell's $0
1976 (and failed (file-exists-p filename) (delete-file filename))))
1978 ;; if we should go to the head of the trunk,
1979 ;; clear the default branch first
1980 (and rev (string= rev "")
1981 (vc-do-command nil 0 "rcs" file 'MASTER "-b"))
1982 ;; now do the checkout
1983 (apply 'vc-do-command
1984 nil 0 "co" file 'MASTER
1985 ;; If locking is not strict, force to overwrite
1986 ;; the writable workfile.
1987 (if (eq (vc-checkout-model file) 'implicit) "-f")
1989 (if rev (concat "-r" rev)
1990 ;; if no explicit revision was specified,
1991 ;; check out that of the working file
1992 (let ((workrev (vc-workfile-version file)))
1993 (if workrev (concat "-r" workrev)
1996 ;; determine the new workfile version
1999 (goto-char (point-min))
2001 (if (re-search-forward "^revision \\([0-9.]+\\).*\n" nil t)
2002 (buffer-substring (match-beginning 1) (match-end 1)))))
2003 (vc-file-setprop file 'vc-workfile-version new-version)
2004 ;; if necessary, adjust the default branch
2005 (and rev (not (string= rev ""))
2006 (vc-do-command nil 0 "rcs" file 'MASTER
2007 (concat "-b" (if (vc-latest-on-branch-p file)
2008 (if (vc-trunk-p new-version) nil
2009 (vc-branch-part new-version))
2012 ;; CVS is much like RCS
2016 (apply 'vc-do-command
2017 nil 0 "/bin/sh" file 'WORKFILE "-c"
2018 "exec >\"$1\" || exit; shift; exec cvs update \"$@\""
2019 "" ; dummy argument for shell's $0
2025 (and failed (file-exists-p filename) (delete-file filename))))
2026 ;; default for verbose checkout: clear the sticky tag
2027 ;; so that the actual update will get the head of the trunk
2028 (and rev (string= rev "")
2029 (vc-do-command nil 0 "cvs" file 'WORKFILE "update" "-A"))
2030 ;; If a revision was specified, check that out.
2032 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE
2033 (and writable (eq (vc-checkout-model file) 'manual) "-w")
2035 (and rev (not (string= rev ""))
2038 ;; If no revision was specified, simply make the file writable.
2040 (or (eq (vc-checkout-model file) 'manual)
2041 (zerop (logand 128 (file-modes file))))
2042 (set-file-modes file (logior 128 (file-modes file)))))
2043 (if rev (vc-file-setprop file 'vc-workfile-version nil))))
2046 (vc-file-clear-masterprops file)
2048 (vc-file-setprop file 'vc-locking-user (user-login-name)))
2049 (vc-file-setprop file
2050 'vc-checkout-time (nth 5 (file-attributes file)))))
2051 (message "Checking out %s...done" filename))))))
2053 (defun vc-backend-logentry-check (file)
2054 (vc-backend-dispatch file
2055 (if (>= (buffer-size) 512) ;; SCCS
2059 "Log must be less than 512 characters; point is now at pos 512")))
2064 (defun vc-backend-checkin (file rev comment)
2065 ;; Register changes to FILE as level REV with explanatory COMMENT.
2066 ;; Automatically retrieves a read-only version of the file with
2067 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
2068 ;; it deletes the workfile.
2069 ;; Adaptation for RCS branch support: if this is an explicit checkin,
2070 ;; or if the checkin creates a new branch, set the master file branch
2072 (message "Checking in %s..." file)
2073 ;; "This log message intentionally left almost blank".
2074 ;; RCS 5.7 gripes about white-space-only comments too.
2075 (or (and comment (string-match "[^\t\n ]" comment))
2076 (setq comment "*** empty log message ***"))
2078 ;; Change buffers to get local value of vc-checkin-switches.
2079 (set-buffer (or (get-file-buffer file) (current-buffer)))
2081 (if (stringp vc-checkin-switches)
2082 (list vc-checkin-switches)
2083 vc-checkin-switches)))
2084 ;; Clear the master-properties. Do that here, not at the
2085 ;; end, because if the check-in fails we want them to get
2086 ;; re-computed before the next try.
2087 (vc-file-clear-masterprops file)
2088 (vc-backend-dispatch file
2091 (apply 'vc-do-command nil 0 "delta" file 'MASTER
2092 (if rev (concat "-r" rev))
2093 (concat "-y" comment)
2095 (vc-file-setprop file 'vc-locking-user 'none)
2096 (vc-file-setprop file 'vc-workfile-version nil)
2097 (if vc-keep-workfiles
2098 (vc-do-command nil 0 "get" file 'MASTER))
2101 (let ((old-version (vc-workfile-version file)) new-version)
2102 (apply 'vc-do-command nil 0 "ci" file 'MASTER
2103 ;; if available, use the secure check-in option
2104 (and (vc-backend-release-p 'RCS "5.6.4") "-j")
2105 (concat (if vc-keep-workfiles "-u" "-r") rev)
2106 (concat "-m" comment)
2108 (vc-file-setprop file 'vc-locking-user 'none)
2109 (vc-file-setprop file 'vc-workfile-version nil)
2111 ;; determine the new workfile version
2113 (goto-char (point-min))
2114 (if (or (re-search-forward
2115 "new revision: \\([0-9.]+\\);" nil t)
2117 "reverting to previous revision \\([0-9.]+\\)" nil t))
2118 (progn (setq new-version (buffer-substring (match-beginning 1)
2120 (vc-file-setprop file 'vc-workfile-version new-version)))
2122 ;; if we got to a different branch, adjust the default
2123 ;; branch accordingly
2125 ((and old-version new-version
2126 (not (string= (vc-branch-part old-version)
2127 (vc-branch-part new-version))))
2128 (vc-do-command nil 0 "rcs" file 'MASTER
2129 (if (vc-trunk-p new-version) "-b"
2130 (concat "-b" (vc-branch-part new-version))))
2131 ;; If this is an old RCS release, we might have
2132 ;; to remove a remaining lock.
2133 (if (not (vc-backend-release-p 'RCS "5.6.2"))
2134 ;; exit status of 1 is also accepted.
2135 ;; It means that the lock was removed before.
2136 (vc-do-command nil 1 "rcs" file 'MASTER
2137 (concat "-u" old-version))))))
2140 ;; explicit check-in to the trunk requires a
2141 ;; double check-in (first unexplicit) (CVS-1.3)
2144 (if (and rev (vc-trunk-p rev))
2145 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE
2146 "ci" "-m" "intermediate"
2148 (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE
2149 "ci" (if rev (concat "-r" rev))
2150 (concat "-m" comment)
2152 (error (if (eq (vc-cvs-status file) 'needs-merge)
2153 ;; The CVS output will be on top of this message.
2154 (error "Type C-x 0 C-x C-q to merge in changes")
2155 (error "Check-in failed"))))
2156 ;; determine and store the new workfile version
2158 (goto-char (point-min))
2159 (if (re-search-forward
2160 "^\\(new\\|initial\\) revision: \\([0-9.]+\\)" nil t)
2161 (vc-file-setprop file 'vc-workfile-version
2162 (buffer-substring (match-beginning 2)
2164 (vc-file-setprop file 'vc-workfile-version nil))
2165 ;; if this was an explicit check-in, remove the sticky tag
2167 (vc-do-command nil 0 "cvs" file 'WORKFILE "update" "-A"))
2168 (vc-file-setprop file 'vc-locking-user 'none)
2169 (vc-file-setprop file 'vc-checkout-time
2170 (nth 5 (file-attributes file)))))))
2171 (message "Checking in %s...done" file))
2173 (defun vc-backend-revert (file)
2174 ;; Revert file to latest checked-in version.
2175 ;; (for RCS, to workfile version)
2176 (message "Reverting %s..." file)
2177 (vc-file-clear-masterprops file)
2178 (vc-backend-dispatch
2182 (vc-do-command nil 0 "unget" file 'MASTER nil)
2183 (vc-do-command nil 0 "get" file 'MASTER nil))
2185 (vc-do-command nil 0 "co" file 'MASTER
2186 "-f" (concat "-u" (vc-workfile-version file)))
2190 (vc-do-command nil 0 "cvs" file 'WORKFILE "update")))
2191 (vc-file-setprop file 'vc-locking-user 'none)
2192 (vc-file-setprop file 'vc-checkout-time (nth 5 (file-attributes file)))
2193 (message "Reverting %s...done" file)
2196 (defun vc-backend-steal (file &optional rev)
2197 ;; Steal the lock on the current workfile. Needs RCS 5.6.2 or later for -M.
2198 (message "Stealing lock on %s..." file)
2199 (vc-backend-dispatch file
2201 (vc-do-command nil 0 "unget" file 'MASTER "-n" (if rev (concat "-r" rev)))
2202 (vc-do-command nil 0 "get" file 'MASTER "-g" (if rev (concat "-r" rev)))
2204 (vc-do-command nil 0 "rcs" file 'MASTER ;RCS
2205 "-M" (concat "-u" rev) (concat "-l" rev))
2206 (error "You cannot steal a CVS lock; there are no CVS locks to steal") ;CVS
2208 (vc-file-setprop file 'vc-locking-user (user-login-name))
2209 (message "Stealing lock on %s...done" file)
2212 (defun vc-backend-uncheck (file target)
2213 ;; Undo the latest checkin.
2214 (message "Removing last change from %s..." file)
2215 (vc-backend-dispatch file
2216 (vc-do-command nil 0 "rmdel" file 'MASTER (concat "-r" target))
2217 (vc-do-command nil 0 "rcs" file 'MASTER (concat "-o" target))
2218 nil ;; this is never reached under CVS
2220 (message "Removing last change from %s...done" file)
2223 (defun vc-backend-print-log (file)
2224 ;; Get change log associated with FILE.
2225 (vc-backend-dispatch
2227 (vc-do-command nil 0 "prs" file 'MASTER)
2228 (vc-do-command nil 0 "rlog" file 'MASTER)
2229 (vc-do-command nil 0 "cvs" file 'WORKFILE "rlog")))
2231 (defun vc-backend-assign-name (file name)
2232 ;; Assign to a FILE's latest version a given NAME.
2233 (vc-backend-dispatch file
2234 (vc-add-triple name file (vc-latest-version file)) ;; SCCS
2235 (vc-do-command nil 0 "rcs" file 'MASTER (concat "-n" name ":")) ;; RCS
2236 (vc-do-command nil 0 "cvs" file 'WORKFILE "tag" name) ;; CVS
2240 (defun vc-backend-diff (file &optional oldvers newvers cmp)
2241 ;; Get a difference report between two versions of FILE.
2242 ;; Get only a brief comparison report if CMP, a difference report otherwise.
2243 (let ((backend (vc-backend file)))
2246 (setq oldvers (vc-lookup-triple file oldvers))
2247 (setq newvers (vc-lookup-triple file newvers)))
2249 (if (not oldvers) (setq oldvers (vc-workfile-version file)))
2250 ;; If we know that --brief is not supported, don't try it.
2251 (setq cmp (and cmp (not (eq vc-rcsdiff-knows-brief 'no))))))
2252 ;; SCCS and RCS shares a lot of code.
2254 ((or (eq backend 'SCCS) (eq backend 'RCS))
2255 (let* ((command (if (eq backend 'SCCS) "vcdiff" "rcsdiff"))
2256 (mode (if (eq backend 'RCS) 'WORKFILE 'MASTER))
2257 (options (append (list (and cmp "--brief")
2259 (and oldvers (concat "-r" oldvers))
2260 (and newvers (concat "-r" newvers)))
2262 (if (listp diff-switches)
2264 (list diff-switches)))))
2265 (status (apply 'vc-do-command "*vc-diff*" 2
2266 command file mode options)))
2267 ;; If --brief didn't work, do a double-take and remember it
2271 (apply 'vc-do-command "*vc-diff*" 1 command file 'WORKFILE
2272 (if cmp (cdr options) options))
2273 (if cmp (setq vc-rcsdiff-knows-brief 'no)))
2274 ;; If --brief DID work, remember that, too.
2275 (and cmp (not vc-rcsdiff-knows-brief)
2276 (setq vc-rcsdiff-knows-brief 'yes))
2278 ;; CVS is different.
2280 (if (string= (vc-workfile-version file) "0") ;CVS
2281 ;; This file is added but not yet committed; there is no master file.
2282 (if (or oldvers newvers)
2283 (error "No revisions of %s exist" file)
2284 (if cmp 1 ;; file is added but not committed,
2285 ;; we regard this as "changed".
2286 ;; diff it against /dev/null.
2287 (apply 'vc-do-command
2288 "*vc-diff*" 1 "diff" file 'WORKFILE
2289 (append (if (listp diff-switches)
2291 (list diff-switches)) '("/dev/null")))))
2292 ;; cmp is not yet implemented -- we always do a full diff.
2293 (apply 'vc-do-command
2294 "*vc-diff*" 1 "cvs" file 'WORKFILE "diff"
2295 (and oldvers (concat "-r" oldvers))
2296 (and newvers (concat "-r" newvers))
2297 (if (listp diff-switches)
2299 (list diff-switches)))))
2301 (vc-registration-error file)))))
2303 (defun vc-backend-merge-news (file)
2304 ;; Merge in any new changes made to FILE.
2305 (message "Merging changes into %s..." file)
2307 (vc-backend-dispatch
2309 (error "vc-backend-merge-news not meaningful for SCCS files") ;SCCS
2310 (error "vc-backend-merge-news not meaningful for RCS files") ;RCS
2311 (save-excursion ; CVS
2312 (vc-file-clear-masterprops file)
2313 (vc-file-setprop file 'vc-workfile-version nil)
2314 (vc-file-setprop file 'vc-locking-user nil)
2315 (vc-do-command nil 0 "cvs" file 'WORKFILE "update")
2316 ;; CVS doesn't return an error code if conflicts are detected.
2317 ;; Since we want to warn the user about it (and possibly start
2318 ;; emerge later), scan the output and see if this occurred.
2319 (set-buffer (get-buffer "*vc*"))
2320 (goto-char (point-min))
2321 (if (re-search-forward "^cvs update: conflicts found in .*" nil t)
2322 1 ;; error code for caller
2323 0 ;; no conflict detected
2325 (message "Merging changes into %s...done" file)))
2327 (defun vc-check-headers ()
2328 "Check if the current file has any headers in it."
2331 (goto-char (point-min))
2332 (vc-backend-dispatch buffer-file-name
2333 (re-search-forward "%[MIRLBSDHTEGUYFPQCZWA]%" nil t) ;; SCCS
2334 (re-search-forward "\\$[A-Za-z\300-\326\330-\366\370-\377]+\\(: [\t -#%-\176\240-\377]*\\)?\\$" nil t) ;; RCS
2335 'RCS ;; CVS works like RCS in this regard.
2339 ;; Back-end-dependent stuff ends here.
2341 ;; Set up key bindings for use while editing log messages
2343 (defun vc-log-mode ()
2344 "Minor mode for driving version-control tools.
2345 These bindings are added to the global keymap when you enter this mode:
2346 \\[vc-next-action] perform next logical version-control operation on current file
2347 \\[vc-register] register current file
2348 \\[vc-toggle-read-only] like next-action, but won't register files
2349 \\[vc-insert-headers] insert version-control headers in current file
2350 \\[vc-print-log] display change history of current file
2351 \\[vc-revert-buffer] revert buffer to latest version
2352 \\[vc-cancel-version] undo latest checkin
2353 \\[vc-diff] show diffs between file versions
2354 \\[vc-version-other-window] visit old version in another window
2355 \\[vc-directory] show all files locked by any user in or below .
2356 \\[vc-update-change-log] add change log entry from recent checkins
2358 While you are entering a change log message for a version, the following
2359 additional bindings will be in effect.
2361 \\[vc-finish-logentry] proceed with check in, ending log message entry
2363 Whenever you do a checkin, your log comment is added to a ring of
2364 saved comments. These can be recalled as follows:
2366 \\[vc-next-comment] replace region with next message in comment ring
2367 \\[vc-previous-comment] replace region with previous message in comment ring
2368 \\[vc-comment-search-reverse] search backward for regexp in the comment ring
2369 \\[vc-comment-search-forward] search backward for regexp in the comment ring
2371 Entry to the change-log submode calls the value of text-mode-hook, then
2372 the value of vc-log-mode-hook.
2374 Global user options:
2375 vc-initial-comment If non-nil, require user to enter a change
2376 comment upon first checkin of the file.
2378 vc-keep-workfiles Non-nil value prevents workfiles from being
2379 deleted when changes are checked in
2381 vc-suppress-confirm Suppresses some confirmation prompts,
2382 notably for reversions.
2384 vc-header-alist Which keywords to insert when adding headers
2385 with \\[vc-insert-headers]. Defaults to
2386 '(\"\%\W\%\") under SCCS, '(\"\$Id\$\") under
2389 vc-static-header-alist By default, version headers inserted in C files
2390 get stuffed in a static string area so that
2391 ident(RCS/CVS) or what(SCCS) can see them in
2392 the compiled object code. You can override
2393 this by setting this variable to nil, or change
2394 the header template by changing it.
2396 vc-command-messages if non-nil, display run messages from the
2397 actual version-control utilities (this is
2398 intended primarily for people hacking vc
2402 (set-syntax-table text-mode-syntax-table)
2403 (use-local-map vc-log-entry-mode)
2404 (setq local-abbrev-table text-mode-abbrev-table)
2405 (setq major-mode 'vc-log-mode)
2406 (setq mode-name "VC-Log")
2407 (make-local-variable 'vc-log-file)
2408 (make-local-variable 'vc-log-version)
2409 (make-local-variable 'vc-comment-ring-index)
2410 (set-buffer-modified-p nil)
2411 (setq buffer-file-name nil)
2412 (run-hooks 'text-mode-hook 'vc-log-mode-hook)
2415 ;; Initialization code, to be done just once at load-time
2416 (if vc-log-entry-mode
2418 (setq vc-log-entry-mode (make-sparse-keymap))
2419 (define-key vc-log-entry-mode "\M-n" 'vc-next-comment)
2420 (define-key vc-log-entry-mode "\M-p" 'vc-previous-comment)
2421 (define-key vc-log-entry-mode "\M-r" 'vc-comment-search-reverse)
2422 (define-key vc-log-entry-mode "\M-s" 'vc-comment-search-forward)
2423 (define-key vc-log-entry-mode "\C-c\C-c" 'vc-finish-logentry)
2426 ;;; These things should probably be generally available
2428 (defun vc-file-tree-walk (dirname func &rest args)
2429 "Walk recursively through DIRNAME.
2430 Invoke FUNC f ARGS on each non-directory file f underneath it."
2431 (vc-file-tree-walk-internal (expand-file-name dirname) func args)
2432 (message "Traversing directory %s...done" dirname))
2434 (defun vc-file-tree-walk-internal (file func args)
2435 (if (not (file-directory-p file))
2436 (apply func file args)
2437 (message "Traversing directory %s..." (abbreviate-file-name file))
2438 (let ((dir (file-name-as-directory file)))
2442 (string-equal f ".")
2443 (string-equal f "..")
2444 (member f vc-directory-exclusion-list)
2445 (let ((dirf (concat dir f)))
2447 (file-symlink-p dirf) ;; Avoid possible loops
2448 (vc-file-tree-walk-internal dirf func args))))))
2449 (directory-files dir)))))
2453 ;;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE
2455 ;;; These may be useful to anyone who has to debug or extend the package.
2456 ;;; (Note that this information corresponds to versions 5.x. Some of it
2457 ;;; might have been invalidated by the additions to support branching
2458 ;;; and RCS keyword lookup. AS, 1995/03/24)
2460 ;;; A fundamental problem in VC is that there are time windows between
2461 ;;; vc-next-action's computations of the file's version-control state and
2462 ;;; the actions that change it. This is a window open to lossage in a
2463 ;;; multi-user environment; someone else could nip in and change the state
2464 ;;; of the master during it.
2466 ;;; The performance problem is that rlog/prs calls are very expensive; we want
2467 ;;; to avoid them as much as possible.
2471 ;;; The performance problem, it turns out, simplifies in practice to the
2472 ;;; problem of making vc-locking-user fast. The two other functions that call
2473 ;;; prs/rlog will not be so commonly used that the slowdown is a problem; one
2474 ;;; makes snapshots, the other deletes the calling user's last change in the
2477 ;;; The race condition implies that we have to either (a) lock the master
2478 ;;; during the entire execution of vc-next-action, or (b) detect and
2479 ;;; recover from errors resulting from dispatch on an out-of-date state.
2481 ;;; Alternative (a) appears to be infeasible. The problem is that we can't
2482 ;;; guarantee that the lock will ever be removed. Suppose a user starts a
2483 ;;; checkin, the change message buffer pops up, and the user, having wandered
2484 ;;; off to do something else, simply forgets about it?
2486 ;;; Alternative (b), on the other hand, works well with a cheap way to speed up
2487 ;;; vc-locking-user. Usually, if a file is registered, we can read its locked/
2488 ;;; unlocked state and its current owner from its permissions.
2490 ;;; This shortcut will fail if someone has manually changed the workfile's
2491 ;;; permissions; also if developers are munging the workfile in several
2492 ;;; directories, with symlinks to a master (in this latter case, the
2493 ;;; permissions shortcut will fail to detect a lock asserted from another
2496 ;;; Note that these cases correspond exactly to the errors which could happen
2497 ;;; because of a competing checkin/checkout race in between two instances of
2500 ;;; For VC's purposes, a workfile/master pair may have the following states:
2502 ;;; A. Unregistered. There is a workfile, there is no master.
2504 ;;; B. Registered and not locked by anyone.
2506 ;;; C. Locked by calling user and unchanged.
2508 ;;; D. Locked by the calling user and changed.
2510 ;;; E. Locked by someone other than the calling user.
2512 ;;; This makes for 25 states and 20 error conditions. Here's the matrix:
2514 ;;; VC's idea of state
2516 ;;; V Actual state RCS action SCCS action Effect
2518 ;;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin
2519 ;;; B 5 . 6 7 8 co -l get -e checkout
2520 ;;; C 9 10 . 11 12 co -u unget; get revert
2521 ;;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin
2522 ;;; E 17 18 19 20 . rcs -u -M -l unget -n ; get -g steal lock
2524 ;;; All commands take the master file name as a last argument (not shown).
2526 ;;; In the discussion below, a "self-race" is a pathological situation in
2527 ;;; which VC operations are being attempted simultaneously by two or more
2528 ;;; Emacsen running under the same username.
2530 ;;; The vc-next-action code has the following windows:
2533 ;;; Between the check for existence of a master file and the call to
2534 ;;; admin/checkin in vc-buffer-admin (apparent state A). This window may
2535 ;;; never close if the initial-comment feature is on.
2538 ;;; Between the call to vc-workfile-unchanged-p in and the immediately
2539 ;;; following revert (apparent state C).
2542 ;;; Between the call to vc-workfile-unchanged-p in and the following
2543 ;;; checkin (apparent state D). This window may never close.
2546 ;;; Between the unlock and the immediately following checkout during a
2547 ;;; revert operation (apparent state C). Included in window Q.
2550 ;;; Between vc-locking-user and the following checkout (apparent state B).
2553 ;;; Between vc-locking-user and the following revert (apparent state C).
2554 ;;; Includes windows Q and S.
2557 ;;; Between vc-locking-user and the following checkin (apparent state
2558 ;;; D). This window may never be closed if the user fails to complete the
2559 ;;; checkin message. Includes window R.
2562 ;;; Between vc-locking-user and the following steal-lock (apparent
2563 ;;; state E). This window may never close if the user fails to complete
2564 ;;; the steal-lock message. Includes window X.
2567 ;;; Between the unlock and the immediately following re-lock during a
2568 ;;; steal-lock operation (apparent state E). This window may never cloce
2569 ;;; if the user fails to complete the steal-lock message.
2573 ;;; Apparent state A ---
2575 ;;; 1. File looked unregistered but is actually registered and not locked.
2577 ;;; Potential cause: someone else's admin during window P, with
2578 ;;; caller's admin happening before their checkout.
2580 ;;; RCS: Prior to version 5.6.4, ci fails with message
2581 ;;; "no lock set by <user>". From 5.6.4 onwards, VC uses the new
2582 ;;; ci -i option and the message is "<file>,v: already exists".
2583 ;;; SCCS: admin will fail with error (ad19).
2585 ;;; We can let these errors be passed up to the user.
2587 ;;; 2. File looked unregistered but is actually locked by caller, unchanged.
2589 ;;; Potential cause: self-race during window P.
2591 ;;; RCS: Prior to version 5.6.4, reverts the file to the last saved
2592 ;;; version and unlocks it. From 5.6.4 onwards, VC uses the new
2593 ;;; ci -i option, failing with message "<file>,v: already exists".
2594 ;;; SCCS: will fail with error (ad19).
2596 ;;; Either of these consequences is acceptable.
2598 ;;; 3. File looked unregistered but is actually locked by caller, changed.
2600 ;;; Potential cause: self-race during window P.
2602 ;;; RCS: Prior to version 5.6.4, VC registers the caller's workfile as
2603 ;;; a delta with a null change comment (the -t- switch will be
2604 ;;; ignored). From 5.6.4 onwards, VC uses the new ci -i option,
2605 ;;; failing with message "<file>,v: already exists".
2606 ;;; SCCS: will fail with error (ad19).
2608 ;;; 4. File looked unregistered but is locked by someone else.
2610 ;;; Potential cause: someone else's admin during window P, with
2611 ;;; caller's admin happening *after* their checkout.
2613 ;;; RCS: Prior to version 5.6.4, ci fails with a
2614 ;;; "no lock set by <user>" message. From 5.6.4 onwards,
2615 ;;; VC uses the new ci -i option, failing with message
2616 ;;; "<file>,v: already exists".
2617 ;;; SCCS: will fail with error (ad19).
2619 ;;; We can let these errors be passed up to the user.
2621 ;;; Apparent state B ---
2623 ;;; 5. File looked registered and not locked, but is actually unregistered.
2625 ;;; Potential cause: master file got nuked during window P.
2627 ;;; RCS: will fail with "RCS/<file>: No such file or directory"
2628 ;;; SCCS: will fail with error ut4.
2630 ;;; We can let these errors be passed up to the user.
2632 ;;; 6. File looked registered and not locked, but is actually locked by the
2633 ;;; calling user and unchanged.
2635 ;;; Potential cause: self-race during window T.
2637 ;;; RCS: in the same directory as the previous workfile, co -l will fail
2638 ;;; with "co error: writable foo exists; checkout aborted". In any other
2639 ;;; directory, checkout will succeed.
2640 ;;; SCCS: will fail with ge17.
2642 ;;; Either of these consequences is acceptable.
2644 ;;; 7. File looked registered and not locked, but is actually locked by the
2645 ;;; calling user and changed.
2649 ;;; 8. File looked registered and not locked, but is actually locked by another
2652 ;;; Potential cause: someone else checks it out during window T.
2654 ;;; RCS: co error: revision 1.3 already locked by <user>
2655 ;;; SCCS: fails with ge4 (in directory) or ut7 (outside it).
2657 ;;; We can let these errors be passed up to the user.
2659 ;;; Apparent state C ---
2661 ;;; 9. File looks locked by calling user and unchanged, but is unregistered.
2665 ;;; 10. File looks locked by calling user and unchanged, but is actually not
2668 ;;; Potential cause: a self-race in window U, or by the revert's
2669 ;;; landing during window X of some other user's steal-lock or window S
2670 ;;; of another user's revert.
2672 ;;; RCS: succeeds, refreshing the file from the identical version in
2674 ;;; SCCS: fails with error ut4 (p file nonexistent).
2676 ;;; Either of these consequences is acceptable.
2678 ;;; 11. File is locked by calling user. It looks unchanged, but is actually
2681 ;;; Potential cause: the file would have to be touched by a self-race
2682 ;;; during window Q.
2684 ;;; The revert will succeed, removing whatever changes came with
2685 ;;; the touch. It is theoretically possible that work could be lost.
2687 ;;; 12. File looks like it's locked by the calling user and unchanged, but
2688 ;;; it's actually locked by someone else.
2690 ;;; Potential cause: a steal-lock in window V.
2692 ;;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u
2693 ;;; SCCS: fails with error un2
2695 ;;; We can pass these errors up to the user.
2697 ;;; Apparent state D ---
2699 ;;; 13. File looks like it's locked by the calling user and changed, but it's
2700 ;;; actually unregistered.
2702 ;;; Potential cause: master file got nuked during window P.
2704 ;;; RCS: Prior to version 5.6.4, checks in the user's version as an
2705 ;;; initial delta. From 5.6.4 onwards, VC uses the new ci -j
2706 ;;; option, failing with message "no such file or directory".
2707 ;;; SCCS: will fail with error ut4.
2709 ;;; This case is kind of nasty. Under RCS prior to version 5.6.4,
2710 ;;; VC may fail to detect the loss of previous version information.
2712 ;;; 14. File looks like it's locked by the calling user and changed, but it's
2713 ;;; actually unlocked.
2715 ;;; Potential cause: self-race in window V, or the checkin happening
2716 ;;; during the window X of someone else's steal-lock or window S of
2717 ;;; someone else's revert.
2719 ;;; RCS: ci will fail with "no lock set by <user>".
2720 ;;; SCCS: delta will fail with error ut4.
2722 ;;; 15. File looks like it's locked by the calling user and changed, but it's
2723 ;;; actually locked by the calling user and unchanged.
2725 ;;; Potential cause: another self-race --- a whole checkin/checkout
2726 ;;; sequence by the calling user would have to land in window R.
2728 ;;; SCCS: checks in a redundant delta and leaves the file unlocked as usual.
2729 ;;; RCS: reverts to the file state as of the second user's checkin, leaving
2730 ;;; the file unlocked.
2732 ;;; It is theoretically possible that work could be lost under RCS.
2734 ;;; 16. File looks like it's locked by the calling user and changed, but it's
2735 ;;; actually locked by a different user.
2737 ;;; RCS: ci error: no lock set by <user>
2738 ;;; SCCS: unget will fail with error un2
2740 ;;; We can pass these errors up to the user.
2742 ;;; Apparent state E ---
2744 ;;; 17. File looks like it's locked by some other user, but it's actually
2749 ;;; 18. File looks like it's locked by some other user, but it's actually
2752 ;;; Potential cause: someone released a lock during window W.
2754 ;;; RCS: The calling user will get the lock on the file.
2755 ;;; SCCS: unget -n will fail with cm4.
2757 ;;; Either of these consequences will be OK.
2759 ;;; 19. File looks like it's locked by some other user, but it's actually
2760 ;;; locked by the calling user and unchanged.
2762 ;;; Potential cause: the other user relinquishing a lock followed by
2763 ;;; a self-race, both in window W.
2765 ;;; Under both RCS and SCCS, both unlock and lock will succeed, making
2766 ;;; the sequence a no-op.
2768 ;;; 20. File looks like it's locked by some other user, but it's actually
2769 ;;; locked by the calling user and changed.
2775 ;;; In order of decreasing severity:
2777 ;;; Cases 11 and 15 are the only ones that potentially lose work.
2778 ;;; They would require a self-race for this to happen.
2780 ;;; Case 13 in RCS loses information about previous deltas, retaining
2781 ;;; only the information in the current workfile. This can only happen
2782 ;;; if the master file gets nuked in window P.
2784 ;;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with
2785 ;;; no change comment in the master. This would require a self-race in
2786 ;;; window P or R respectively.
2788 ;;; Cases 2, 10, 19 and 20 do extra work, but make no changes.
2790 ;;; Unfortunately, it appears to me that no recovery is possible in these
2791 ;;; cases. They don't yield error messages, so there's no way to tell that
2792 ;;; a race condition has occurred.
2794 ;;; All other cases don't change either the workfile or the master, and
2795 ;;; trigger command errors which the user will see.
2797 ;;; Thus, there is no explicit recovery code.