1 ;;; vc.el --- drive a version-control system from within Emacs
3 ;; Copyright (C) 1992, 1993 Free Software Foundation, Inc.
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to
22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
26 ;; This mode is fully documented in the Emacs user's manual.
28 ;; This was designed and implemented by Eric Raymond <esr@snark.thyrsus.com>.
29 ;; Paul Eggert <eggert@twinsun.com>, Sebastian Kremer <sk@thp.uni-koeln.de>,
30 ;; and Richard Stallman contributed valuable criticism, support, and testing.
32 ;; Supported version-control systems presently include SCCS and RCS;
33 ;; your RCS version should be 5.6.2 or later for proper operation of
34 ;; the lock-breaking code.
36 ;; The RCS code assumes strict locking. You can support the RCS -x option
37 ;; by adding pairs to the vc-master-templates list.
39 ;; Proper function of the SCCS diff commands requires the shellscript vcdiff
40 ;; to be installed somewhere on Emacs's path for executables.
42 ;; If your site uses the ChangeLog convention supported by Emacs, the
43 ;; function vc-comment-to-change-log should prove a useful checkin hook.
45 ;; This code depends on call-process passing back the subprocess exit
46 ;; status. Thus, you need Emacs 18.58 or later to run it. For the
47 ;; vc-directory command to work properly as documented, you need 19.
48 ;; You also need Emacs 19's ring.el.
50 ;; The vc code maintains some internal state in order to reduce expensive
51 ;; version-control operations to a minimum. Some names are only computed
52 ;; once. If you perform version control operations with RCS/SCCS/CVS while
53 ;; vc's back is turned, or move/rename master files while vc is running,
54 ;; vc may get seriously confused. Don't do these things!
56 ;; Developer's notes on some concurrency issues are included at the end of
64 (if (not (assoc 'vc-parent-buffer minor-mode-alist
))
65 (setq minor-mode-alist
66 (cons '(vc-parent-buffer vc-parent-buffer-name
)
69 ;; General customization
71 (defvar vc-default-back-end nil
72 "*Back-end actually used by this interface; may be SCCS or RCS.
73 The value is only computed when needed to avoid an expensive search.")
74 (defvar vc-suppress-confirm nil
75 "*If non-nil, treat user as expert; suppress yes-no prompts on some things.")
76 (defvar vc-keep-workfiles t
77 "*If non-nil, don't delete working files after registering changes.")
78 (defvar vc-initial-comment nil
79 "*Prompt for initial comment when a file is registered.")
80 (defvar vc-command-messages nil
81 "*Display run messages from back-end commands.")
82 (defvar vc-mistrust-permissions
'file-symlink-p
83 "*Don't assume that permissions and ownership track version-control status.")
84 (defvar vc-checkin-switches nil
85 "*Extra switches passed to the checkin program by \\[vc-checkin].")
87 (defconst vc-maximum-comment-ring-size
32
88 "Maximum number of saved comments in the comment ring.")
90 ;;; This is duplicated in diff.el.
91 (defvar diff-switches
"-c"
92 "*A string or list of strings specifying switches to be be passed to diff.")
95 (defvar vc-checkin-hook nil
96 "*List of functions called after a checkin is done. See `run-hooks'.")
98 ;; Header-insertion hair
100 (defvar vc-header-alist
101 '((SCCS "\%W\%") (RCS "\$Id\$"))
102 "*Header keywords to be inserted when `vc-insert-headers' is executed.")
103 (defconst vc-static-header-alist
105 "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n"))
106 "*Associate static header string templates with file types. A \%s in the
107 template is replaced with the first string associated with the file's
108 version-control type in `vc-header-alist'.")
110 (defvar vc-comment-alist
111 '((nroff-mode ".\\\"" ""))
112 "*Special comment delimiters to be used in generating vc headers only.
113 Add an entry in this list if you need to override the normal comment-start
114 and comment-end variables. This will only be necessary if the mode language
115 is sensitive to blank lines.")
117 ;; Variables the user doesn't need to know about.
118 (defvar vc-log-entry-mode nil
)
119 (defvar vc-log-operation nil
)
120 (defvar vc-log-after-operation-hook nil
)
121 (defvar vc-checkout-writable-buffer-hook
'vc-checkout-writable-buffer
)
122 (defvar vc-parent-buffer nil
)
123 (defvar vc-parent-buffer-name nil
)
126 (defvar vc-log-version
)
128 (defconst vc-name-assoc-file
"VC-names")
130 (defvar vc-dired-mode nil
)
131 (make-variable-buffer-local 'vc-dired-mode
)
133 (defvar vc-comment-ring nil
)
134 (defvar vc-comment-ring-index nil
)
135 (defvar vc-last-comment-match nil
)
137 ;; File property caching
139 (defun vc-file-clearprops (file)
140 ;; clear all properties of a given file
141 (setplist (intern file vc-file-prop-obarray
) nil
))
143 (defun vc-clear-context ()
144 "Clear all cached file properties and the comment ring."
146 (fillarray vc-file-prop-obarray nil
)
147 ;; Note: there is potential for minor lossage here if there is an open
148 ;; log buffer with a nonzero local value of vc-comment-ring-index.
149 (setq vc-comment-ring nil
))
151 ;; Random helper functions
153 (defun vc-name (file)
154 "Return the master name of a file, nil if it is not registered."
155 (or (vc-file-getprop file
'vc-name
)
156 (vc-file-setprop file
'vc-name
157 (let ((name-and-type (vc-registered file
)))
158 (and name-and-type
(car name-and-type
))))))
160 (defun vc-registration-error (file)
162 (error "File %s is not under version control." file
)
163 (error "Buffer %s is not associated with a file." (buffer-name))))
165 (defvar vc-binary-assoc nil
)
167 (defun vc-find-binary (name)
168 "Look for a command anywhere on the subprocess-command search path."
169 (or (cdr (assoc name vc-binary-assoc
))
173 (function (lambda (s)
174 (if (and s
(file-exists-p (setq full
(concat s
"/" name
))))
175 (throw 'found nil
))))
178 (setq vc-binary-assoc
(cons (cons name full
) vc-binary-assoc
)))
181 (defun vc-do-command (okstatus command file
&rest flags
)
182 "Execute a version-control command, notifying user and checking for errors.
183 The command is successful if its exit status does not exceed OKSTATUS.
184 Output from COMMAND goes to buffer *vc*. The last argument of the command is
185 the master name of FILE; this is appended to an optional list of FLAGS."
186 (setq file
(expand-file-name file
))
187 (if vc-command-messages
188 (message "Running %s on %s..." command file
))
189 (let ((obuf (current-buffer)) (camefrom (current-buffer))
191 (vc-file (and file
(vc-name file
)))
193 (set-buffer (get-buffer-create "*vc*"))
194 (set (make-local-variable 'vc-parent-buffer
) camefrom
)
195 (set (make-local-variable 'vc-parent-buffer-name
)
196 (concat " from " (buffer-name camefrom
)))
200 ;; This is so that command arguments typed in the *vc* buffer will
201 ;; have reasonable defaults.
202 (setq default-directory
(file-name-directory file
))
205 (function (lambda (s) (and s
(setq squeezed
(append squeezed
(list s
))))))
208 (setq squeezed
(append squeezed
(list vc-file
))))
209 (let ((default-directory (file-name-directory (or file
"./"))))
210 (setq status
(apply 'call-process command nil t nil squeezed
)))
211 (goto-char (point-max))
213 (if (or (not (integerp status
)) (< okstatus status
))
216 (print (cons command squeezed
))
218 (pop-to-buffer "*vc*")
220 (goto-char (point-min))
221 (error "Running %s...FAILED (%s)" command
222 (if (integerp status
)
223 (format "status %d" status
)
226 (if vc-command-messages
227 (message "Running %s...OK" command
))
233 ;;; Save a bit of the text around POSN in the current buffer, to help
234 ;;; us find the corresponding position again later. This works even
235 ;;; if all markers are destroyed or corrupted.
236 (defun vc-position-context (posn)
239 (buffer-substring posn
240 (min (point-max) (+ posn
100)))))
242 ;;; Return the position of CONTEXT in the current buffer, or nil if we
243 ;;; couldn't find it.
244 (defun vc-find-position-by-context (context)
245 (let ((context-string (nth 2 context
)))
246 (if (equal "" context-string
)
249 (let ((diff (- (nth 1 context
) (buffer-size))))
250 (if (< diff
0) (setq diff
(- diff
)))
251 (goto-char (nth 0 context
))
252 (if (or (search-forward context-string nil t
)
253 ;; Can't use search-backward since the match may continue
255 (progn (goto-char (- (point) diff
(length context-string
)))
256 ;; goto-char doesn't signal an error at
257 ;; beginning of buffer like backward-char would
258 (search-forward context-string nil t
)))
259 ;; to beginning of OSTRING
260 (- (point) (length context-string
))))))))
262 (defun vc-revert-buffer1 (&optional arg no-confirm
)
263 ;; Most of this was shamelessly lifted from Sebastian Kremer's rcs.el mode.
264 ;; Revert buffer, try to keep point and mark where user expects them in spite
265 ;; of changes because of expanded version-control key words.
266 ;; This is quite important since otherwise typeahead won't work as expected.
269 (let ((point-context (vc-position-context (point)))
270 ;; Use mark-marker to avoid confusion in transient-mark-mode.
271 (mark-context (if (eq (marker-buffer (mark-marker)) (current-buffer))
272 (vc-position-context (mark-marker))))
273 ;; Make the right thing happen in transient-mark-mode.
275 ;; We may want to reparse the compilation buffer after revert
276 (reparse (and (boundp 'compilation-error-list
) ;compile loaded
277 (let ((curbuf (current-buffer)))
278 ;; Construct a list; each elt is nil or a buffer
279 ;; iff that buffer is a compilation output buffer
280 ;; that contains markers into the current buffer.
286 compilation-old-error-list
287 compilation-error-list
))
288 (buffer-error-marked-p nil
))
289 (while (and (consp errors
)
290 (not buffer-error-marked-p
))
291 (and (markerp (cdr (car errors
)))
295 (setq buffer-error-marked-p t
))
296 (setq errors
(cdr errors
)))
297 (if buffer-error-marked-p buffer
))))
300 ;; the actual revisit
301 (revert-buffer arg no-confirm
)
303 ;; Reparse affected compilation buffers.
307 (set-buffer (car reparse
))
308 (let ((compilation-last-buffer (current-buffer)) ;select buffer
309 ;; Record the position in the compilation buffer of
310 ;; the last error next-error went to.
311 (error-pos (marker-position
312 (car (car-safe compilation-error-list
)))))
313 ;; Reparse the error messages as far as they were parsed before.
314 (compile-reinitialize-errors '(4) compilation-parsing-end
)
315 ;; Move the pointer up to find the error we were at before
316 ;; reparsing. Now next-error should properly go to the next one.
317 (while (and compilation-error-list
318 (/= error-pos
(car (car compilation-error-list
))))
319 (setq compilation-error-list
(cdr compilation-error-list
))))))
320 (setq reparse
(cdr reparse
)))
322 ;; Restore point and mark
323 (let ((new-point (vc-find-position-by-context point-context
)))
324 (if new-point
(goto-char new-point
)))
326 (let ((new-mark (vc-find-position-by-context mark-context
)))
327 (if new-mark
(set-mark new-mark
))))))
330 (defun vc-buffer-sync ()
331 ;; Make sure the current buffer and its working file are in sync
332 (if (and (buffer-modified-p)
335 (y-or-n-p (format "%s has been modified. Write it out? "
339 (defun vc-workfile-unchanged-p (file)
340 ;; Has the given workfile changed since last checkout?
341 (let ((checkout-time (vc-file-getprop file
'vc-checkout-time
))
342 (lastmod (nth 5 (file-attributes file
))))
344 (equal lastmod checkout-time
)
345 (if (zerop (vc-backend-diff file nil
))
347 (vc-file-setprop file
'vc-checkout-time lastmod
)
350 (vc-file-setprop file
'vc-checkout-time
'(0 .
0))
355 (defun vc-next-action-on-file (file verbose
&optional comment
)
356 ;;; If comment is specified, it will be used as an admin or checkin comment.
357 (let (owner version
(vc-file (vc-name file
)))
360 ;; if there is no master file corresponding, create one
362 (vc-register verbose comment
)
363 (if vc-initial-comment
364 (setq vc-log-after-operation-hook
365 'vc-checkout-writable-buffer-hook
)
366 (vc-checkout-writable-buffer file
)))
368 ;; if there is no lock on the file, assert one and get it
369 ((not (setq owner
(vc-locking-user file
)))
370 (vc-checkout-writable-buffer file
))
372 ;; a checked-out version exists, but the user may not own the lock
373 ((not (string-equal owner
(user-login-name)))
375 (error "Sorry, you can't steal the lock on %s this way." file
))
378 (and verbose
(read-string "Version to steal: "))
381 ;; OK, user owns the lock on the file
385 ;; give luser a chance to save before checking in.
388 ;; Revert if file is unchanged and buffer is too.
389 ;; If buffer is modified, that means the user just said no
390 ;; to saving it; in that case, don't revert,
391 ;; because the user might intend to save
392 ;; after finishing the log entry.
393 (if (and (vc-workfile-unchanged-p file
)
394 (not (buffer-modified-p)))
396 (vc-backend-revert file
)
397 ;; DO NOT revert the file without asking the user!
398 (vc-resynch-window file t nil
))
400 ;; user may want to set nonstandard parameters
402 (setq version
(read-string "New version level: ")))
404 ;; OK, let's do the checkin
405 (vc-checkin file version comment
)
408 (defun vc-next-action-dired (file rev comment
)
409 ;; We've accepted a log comment, now do a vc-next-action using it on all
411 (set-buffer vc-parent-buffer
)
412 (dired-map-over-marks
413 (save-window-excursion
414 (let ((file (dired-get-filename)))
415 (message "Processing %s..." file
)
416 (vc-next-action-on-file file nil comment
)
417 (message "Processing %s...done" file
)))
421 ;; Here's the major entry point.
424 (defun vc-next-action (verbose)
425 "Do the next logical checkin or checkout operation on the current file.
426 If the file is not already registered, this registers it for version
427 control and then retrieves a writable, locked copy for editing.
428 If the file is registered and not locked by anyone, this checks out
429 a writable and locked file ready for editing.
430 If the file is checked out and locked by the calling user, this
431 first checks to see if the file has changed since checkout. If not,
432 it performs a revert.
433 If the file has been changed, this pops up a buffer for entry
434 of a log message; when the message has been entered, it checks in the
435 resulting changes along with the log message as change commentary. If
436 the variable `vc-keep-workfiles' is non-nil (which is its default), a
437 read-only copy of the changed file is left in place afterwards.
438 If the file is registered and locked by someone else, you are given
439 the option to steal the lock.
440 If you call this from within a VC dired buffer with no files marked,
441 it will operate on the file in the current line.
442 If you call this from within a VC dired buffer, and one or more
443 files are marked, it will accept a log message and then operate on
444 each one. The log message will be used as a comment for any register
445 or checkin operations, but ignored when doing checkouts. Attempted
446 lock steals will raise an error."
450 (let ((files (dired-get-marked-files)))
451 (if (= (length files
) 1)
452 (find-file-other-window (dired-get-filename))
453 (vc-start-entry nil nil nil
454 "Enter a change comment for the marked files."
455 'vc-next-action-dired
)
457 (while vc-parent-buffer
458 (pop-to-buffer vc-parent-buffer
))
460 (vc-next-action-on-file buffer-file-name verbose
)
461 (vc-registration-error nil
))))
463 ;;; These functions help the vc-next-action entry point
465 (defun vc-checkout-writable-buffer (&optional file
)
466 "Retrieve a writable copy of the latest version of the current buffer's file."
467 (vc-checkout (or file
(buffer-file-name)) t
)
471 (defun vc-register (&optional override comment
)
472 "Register the current file into your version-control system."
474 (if (vc-name buffer-file-name
)
475 (error "This file is already registered."))
476 ;; Watch out for new buffers of size 0: the corresponding file
477 ;; does not exist yet, even though buffer-modified-p is nil.
478 (if (and (not (buffer-modified-p))
479 (zerop (buffer-size))
480 (not (file-exists-p buffer-file-name
)))
481 (set-buffer-modified-p t
))
487 (format "Initial version level for %s: " buffer-file-name
))))
490 (defun vc-resynch-window (file &optional keep noquery
)
491 ;; If the given file is in the current buffer,
492 ;; either revert on it so we see expanded keyworks,
493 ;; or unvisit it (depending on vc-keep-workfiles)
494 ;; NOQUERY if non-nil inhibits confirmation for reverting.
495 ;; NOQUERY should be t *only* if it is known the only difference
496 ;; between the buffer and the file is due to RCS rather than user editing!
497 (and (string= buffer-file-name file
)
500 (vc-revert-buffer1 t noquery
)
501 (vc-mode-line buffer-file-name
))
504 (kill-buffer (current-buffer))))))
506 (defun vc-start-entry (file rev comment msg action
)
507 ;; Accept a comment for an operation on FILE revision REV. If COMMENT
508 ;; is nil, pop up a VC-log buffer, emit MSG, and set the
509 ;; action on close to ACTION; otherwise, do action immediately.
510 ;; Remember the file's buffer in parent-buffer (current one if no file).
511 (let ((parent (if file
(find-file-noselect file
) (current-buffer))))
513 (set-buffer (get-buffer-create "*VC-log*"))
514 (pop-to-buffer (get-buffer-create "*VC-log*")))
515 (set (make-local-variable 'vc-parent-buffer
) parent
)
516 (set (make-local-variable 'vc-parent-buffer-name
)
517 (concat " from " (buffer-name vc-parent-buffer
)))
518 (vc-mode-line (if file
(file-name-nondirectory file
) " (no file)"))
520 (setq vc-log-operation action
)
521 (setq vc-log-file file
)
522 (setq vc-log-version rev
)
527 (vc-finish-logentry t
)
529 (vc-finish-logentry nil
)))
530 (message "%s Type C-c C-c when done." msg
))))
532 (defun vc-admin (file rev
&optional comment
)
533 "Check a file into your version-control system.
534 FILE is the unmodified name of the file. REV should be the base version
535 level to check it in under. COMMENT, if specified, is the checkin comment."
536 (vc-start-entry file rev
537 (or comment
(not vc-initial-comment
))
538 "Enter initial comment." 'vc-backend-admin
))
540 (defun vc-checkout (file &optional writable
)
541 "Retrieve a copy of the latest version of the given file."
542 ;; If ftp is on this system and the name matches the ange-ftp format
543 ;; for a remote file, the user is trying something that won't work.
544 (if (and (string-match "^/[^/:]+:" file
) (vc-find-binary "ftp"))
545 (error "Sorry, you can't check out files over FTP"))
546 (vc-backend-checkout file writable
)
547 (if (string-equal file buffer-file-name
)
548 (vc-resynch-window file t t
))
551 (defun vc-steal-lock (file rev
&optional owner
)
552 "Steal the lock on the current workfile."
555 (setq owner
(vc-locking-user file
)))
556 (if (not (y-or-n-p (format "Take the lock on %s:%s from %s? " file rev owner
)))
557 (error "Steal cancelled."))
558 (pop-to-buffer (get-buffer-create "*VC-mail*"))
559 (setq default-directory
(expand-file-name "~/"))
560 (auto-save-mode auto-save-default
)
563 (mail-setup owner
(format "%s:%s" file rev
) nil nil nil
564 (list (list 'vc-finish-steal file rev
)))
565 (goto-char (point-max))
567 (format "I stole the lock on %s:%s, " file rev
)
568 (current-time-string)
570 (message "Please explain why you stole the lock. Type C-c C-c when done."))
572 ;; This is called when the notification has been sent.
573 (defun vc-finish-steal (file version
)
574 (vc-backend-steal file version
)
575 (vc-resynch-window file t t
))
577 (defun vc-checkin (file &optional rev comment
)
578 "Check in the file specified by FILE.
579 The optional argument REV may be a string specifying the new version level
580 \(if nil increment the current level). The file is either retained with write
581 permissions zeroed, or deleted (according to the value of `vc-keep-workfiles').
582 COMMENT is a comment string; if omitted, a buffer is
583 popped up to accept a comment."
584 (setq vc-log-after-operation-hook
'vc-checkin-hook
)
585 (vc-start-entry file rev comment
"Enter a change comment." 'vc-backend-checkin
))
587 ;;; Here is a checkin hook that may prove useful to sites using the
588 ;;; ChangeLog facility supported by Emacs.
589 (defun vc-comment-to-change-log ()
590 "Update change log from VC change comments entered for the current file.
591 See `vc-update-change-log'."
593 (let ((log (find-change-log)))
595 (vc-update-change-log
596 (file-relative-name buffer-file-name
597 (file-name-directory (expand-file-name log
)))))))
599 (defun vc-finish-logentry (&optional nocomment
)
600 "Complete the operation implied by the current log entry."
602 ;; Check and record the comment, if any.
605 (goto-char (point-max))
609 (vc-backend-logentry-check vc-log-file
)
610 ;; Record the comment in the comment ring
611 (if (null vc-comment-ring
)
612 (setq vc-comment-ring
(make-ring vc-maximum-comment-ring-size
)))
613 (ring-insert vc-comment-ring
(buffer-string))
618 (funcall vc-log-operation
622 (error "No log operation is pending."))
623 ;; Return to "parent" buffer of this checkin and remove checkin window
624 (pop-to-buffer vc-parent-buffer
)
625 (delete-windows-on (get-buffer "*VC-log*"))
626 (kill-buffer "*VC-log*")
627 ;; Now make sure we see the expanded headers
629 (vc-resynch-window buffer-file-name vc-keep-workfiles t
))
630 (run-hooks vc-log-after-operation-hook
))
632 ;; Code for access to the comment ring
634 (defun vc-previous-comment (arg)
635 "Cycle backwards through comment history."
637 (let ((len (ring-length vc-comment-ring
)))
639 (message "Empty comment ring")
643 ;; Initialize the index on the first use of this command
644 ;; so that the first M-p gets index 0, and the first M-n gets
646 (if (null vc-comment-ring-index
)
647 (setq vc-comment-ring-index
649 (if (< arg
0) 1 0))))
650 (setq vc-comment-ring-index
651 (ring-mod (+ vc-comment-ring-index arg
) len
))
652 (message "%d" (1+ vc-comment-ring-index
))
653 (insert (ring-ref vc-comment-ring vc-comment-ring-index
))))))
655 (defun vc-next-comment (arg)
656 "Cycle forwards through comment history."
658 (vc-previous-comment (- arg
)))
660 (defun vc-comment-search-reverse (str)
661 "Searches backwards through comment history for substring match."
662 (interactive "sComment substring: ")
664 (setq str vc-last-comment-match
)
665 (setq vc-last-comment-match str
))
666 (if (null vc-comment-ring-index
)
667 (setq vc-comment-ring-index -
1))
668 (let ((str (regexp-quote str
))
669 (len (ring-length vc-comment-ring
))
670 (n (1+ vc-comment-ring-index
)))
671 (while (and (< n len
) (not (string-match str
(ring-ref vc-comment-ring n
))))
674 (vc-previous-comment (- n vc-comment-ring-index
)))
675 (t (error "Not found")))))
677 (defun vc-comment-search-forward (str)
678 "Searches forwards through comment history for substring match."
679 (interactive "sComment substring: ")
681 (setq str vc-last-comment-match
)
682 (setq vc-last-comment-match str
))
683 (if (null vc-comment-ring-index
)
684 (setq vc-comment-ring-index
0))
685 (let ((str (regexp-quote str
))
686 (len (ring-length vc-comment-ring
))
687 (n vc-comment-ring-index
))
688 (while (and (>= n
0) (not (string-match str
(ring-ref vc-comment-ring n
))))
691 (vc-next-comment (- n vc-comment-ring-index
)))
692 (t (error "Not found")))))
694 ;; Additional entry points for examining version histories
697 (defun vc-diff (historic)
698 "Display diffs between file versions.
699 Normally this compares the current file and buffer with the most recent
700 checked in version of that file. This uses no arguments.
701 With a prefix argument, it reads the file name to use
702 and two version designators specifying which versions to compare."
705 (set-buffer (find-file-noselect (dired-get-filename))))
706 (while vc-parent-buffer
707 (pop-to-buffer vc-parent-buffer
))
709 (call-interactively 'vc-version-diff
)
710 (if (or (null buffer-file-name
) (null (vc-name buffer-file-name
)))
711 (error "There is no version-control master associated with this buffer."))
712 (let ((file buffer-file-name
)
714 (or (and file
(vc-name file
))
715 (vc-registration-error file
))
717 (setq unchanged
(vc-workfile-unchanged-p buffer-file-name
))
719 (message "No changes to %s since latest version." file
)
720 (vc-backend-diff file nil
)
721 ;; Ideally, we'd like at this point to parse the diff so that
722 ;; the buffer effectively goes into compilation mode and we
723 ;; can visit the old and new change locations via next-error.
724 ;; Unfortunately, this is just too painful to do. The basic
725 ;; problem is that the `old' file doesn't exist to be
726 ;; visited. This plays hell with numerous assumptions in
727 ;; the diff.el and compile.el machinery.
728 (pop-to-buffer "*vc*")
730 (goto-char (point-min))
737 (defun vc-version-diff (file rel1 rel2
)
738 "For FILE, report diffs between two stored versions REL1 and REL2 of it.
739 If FILE is a directory, generate diffs between versions for all registered
740 files in or below it."
741 (interactive "FFile or directory to diff: \nsOlder version: \nsNewer version: ")
742 (if (string-equal rel1
"") (setq rel1 nil
))
743 (if (string-equal rel2
"") (setq rel2 nil
))
744 (if (file-directory-p file
)
745 (let ((camefrom (current-buffer)))
746 (set-buffer (get-buffer-create "*vc-status*"))
747 (set (make-local-variable 'vc-parent-buffer
) camefrom
)
748 (set (make-local-variable 'vc-parent-buffer-name
)
749 (concat " from " (buffer-name camefrom
)))
751 (insert "Diffs between "
752 (or rel1
"last version checked in")
754 (or rel2
"current workfile(s)")
756 (set-buffer (get-buffer-create "*vc*"))
759 (function (lambda (f)
760 (message "Looking at %s" f
)
762 (not (file-directory-p f
))
764 (vc-backend-diff f rel1 rel2
)
765 (append-to-buffer "*vc-status*" (point-min) (point-max)))
767 (pop-to-buffer "*vc-status*")
768 (insert "\nEnd of diffs.\n")
769 (goto-char (point-min))
770 (set-buffer-modified-p nil
)
772 (if (zerop (vc-backend-diff file rel1 rel2
))
773 (message "No changes to %s between %s and %s." file rel1 rel2
)
774 (pop-to-buffer "*vc*"))))
776 ;; Header-insertion code
779 (defun vc-insert-headers ()
780 "Insert headers in a file for use with your version-control system.
781 Headers desired are inserted at the start of the buffer, and are pulled from
782 the variable `vc-header-alist'."
785 (find-file-other-window (dired-get-filename)))
786 (while vc-parent-buffer
787 (pop-to-buffer vc-parent-buffer
))
791 (if (or (not (vc-check-headers))
792 (y-or-n-p "Version headers already exist. Insert another set? "))
794 (let* ((delims (cdr (assq major-mode vc-comment-alist
)))
795 (comment-start-vc (or (car delims
) comment-start
"#"))
796 (comment-end-vc (or (car (cdr delims
)) comment-end
""))
797 (hdstrings (cdr (assoc (vc-backend-deduce (buffer-file-name)) vc-header-alist
))))
798 (mapcar (function (lambda (s)
799 (insert comment-start-vc
"\t" s
"\t"
800 comment-end-vc
"\n")))
802 (if vc-static-header-alist
803 (mapcar (function (lambda (f)
804 (if (string-match (car f
) buffer-file-name
)
805 (insert (format (cdr f
) (car hdstrings
))))))
806 vc-static-header-alist
))
810 ;; The VC directory submode. Coopt Dired for this.
811 ;; All VC commands get mapped into logical equivalents.
813 (defvar vc-dired-prefix-map
(make-sparse-keymap))
814 (define-key vc-dired-prefix-map
"\C-xv" vc-prefix-map
)
816 (or (not (boundp 'minor-mode-map-alist
))
817 (assq 'vc-dired-mode minor-mode-map-alist
)
818 (setq minor-mode-map-alist
819 (cons (cons 'vc-dired-mode vc-dired-prefix-map
)
820 minor-mode-map-alist
)))
822 (defun vc-dired-mode ()
823 "The augmented Dired minor mode used in VC directory buffers.
824 All Dired commands operate normally. Users currently locking listed files
825 are listed in place of the file's owner and group.
826 Keystrokes bound to VC commands will execute as though they had been called
827 on a buffer attached to the file named in the current Dired buffer line."
828 (setq vc-dired-mode t
)
829 (setq vc-mode
" under VC"))
831 (defun vc-dired-reformat-line (x)
832 ;; Hack a directory-listing line, plugging in locking-user info in
833 ;; place of the user and group info. Should have the beneficial
834 ;; side-effect of shortening the listing line. Each call starts with
835 ;; point immediately following the dired mark area on the line to be
838 ;; Simplest possible one:
839 ;; (insert (concat x "\t")))
841 ;; This code, like dired, assumes UNIX -l format.
842 (forward-word 1) ;; skip over any extra field due to -ibs options
843 (if x
(setq x
(concat "(" x
")")))
844 (if (re-search-forward "\\([0-9]+ \\).................\\( .*\\)" nil
0)
845 (let ((rep (substring (concat x
" ") 0 9)))
846 (replace-match (concat "\\1" rep
"\\2") t
)))
849 ;;; Note in Emacs 18 the following defun gets overridden
850 ;;; with the symbol 'vc-directory-18. See below.
852 (defun vc-directory (verbose)
853 "Show version-control status of all files under the current directory."
856 (dl (length default-directory
))
857 (filelist nil
) (userlist nil
)
861 (function (lambda (f)
862 (if (vc-registered f
)
863 (let ((user (vc-locking-user f
)))
864 (and (or verbose user
)
865 (setq filelist
(cons (substring f dl
) filelist
))
866 (setq userlist
(cons user userlist
))))))))
868 ;; This uses a semi-documented feature of dired; giving a switch
869 ;; argument forces the buffer to refresh each time.
871 (cons default-directory
(nreverse filelist
))
872 dired-listing-switches
)
873 (setq dired-buf
(current-buffer))
874 (setq nonempty
(not (zerop (buffer-size)))))
877 (pop-to-buffer dired-buf
)
879 (goto-char (point-min))
880 (setq buffer-read-only nil
)
881 (forward-line 1) ;; Skip header line
885 (forward-char 2) ;; skip dired's mark area
886 (vc-dired-reformat-line x
)
887 (forward-line 1))) ;; go to next line
889 (setq buffer-read-only t
)
890 (goto-char (point-min))
892 (message "No files are currently %s under %s"
893 (if verbose
"registered" "locked") default-directory
))
897 (defun vc-directory-18 (verbose)
898 "Show version-control status of all files under the current directory."
900 (let (nonempty (dir default-directory
))
902 (set-buffer (get-buffer-create "*vc-status*"))
906 (function (lambda (f)
907 (if (vc-registered f
)
908 (let ((user (vc-locking-user f
)))
909 (if (or user verbose
)
912 (concat user
) f
))))))))
913 (setq nonempty
(not (zerop (buffer-size)))))
916 (pop-to-buffer "*vc-status*" t
)
918 (goto-char (point-min)))
919 (message "No files are currently %s under %s"
920 (if verbose
"registered" "locked") default-directory
))
923 (or (boundp 'minor-mode-map-alist
)
924 (fset 'vc-directory
'vc-directory-18
))
926 ; Emacs 18 also lacks these.
927 (or (boundp 'compilation-old-error-list
)
928 (setq compilation-old-error-list nil
))
930 ;; Named-configuration support for SCCS
932 (defun vc-add-triple (name file rev
)
934 (find-file (concat (vc-backend-subdirectory-name file
) "/" vc-name-assoc-file
))
935 (goto-char (point-max))
936 (insert name
"\t:\t" file
"\t" rev
"\n")
938 (kill-buffer (current-buffer))
941 (defun vc-record-rename (file newname
)
943 (find-file (concat (vc-backend-subdirectory-name file
) "/" vc-name-assoc-file
))
944 (goto-char (point-min))
945 (replace-regexp (concat ":" (regexp-quote file
) "$") (concat ":" newname
))
947 (kill-buffer (current-buffer))
950 (defun vc-lookup-triple (file name
)
951 ;; Return the numeric version corresponding to a named snapshot of file
952 ;; If name is nil or a version number string it's just passed through
953 (cond ((null name
) "")
954 ((let ((firstchar (aref name
0)))
955 (and (>= firstchar ?
0) (<= firstchar ?
9)))
959 (concat (vc-backend-subdirectory-name file
) "/" vc-name-assoc-file
)
960 (list (concat name
"\t:\t" file
"\t\\(.+\\)"))))
963 ;; Named-configuration entry points
965 (defun vc-quiescent-p ()
966 ;; Is the current directory ready to be snapshot?
969 (function (lambda (f)
970 (if (and (vc-registered f
) (vc-locking-user f
))
971 (throw 'quiet nil
)))))
975 (defun vc-create-snapshot (name)
976 "Make a snapshot called NAME.
977 The snapshot is made from all registered files at or below the current
978 directory. For each file, the version level of its latest
979 version becomes part of the named configuration."
980 (interactive "sNew snapshot name: ")
981 (if (not (vc-quiescent-p))
982 (error "Can't make a snapshot, locked files are in the way.")
984 (function (lambda (f) (and
986 (vc-backend-assign-name f name
)))))
990 (defun vc-retrieve-snapshot (name)
991 "Retrieve the snapshot called NAME.
992 This function fails if any files are locked at or below the current directory
993 Otherwise, all registered files are checked out (unlocked) at their version
994 levels in the snapshot."
995 (interactive "sSnapshot name to retrieve: ")
996 (if (not (vc-quiescent-p))
997 (error "Can't retrieve a snapshot, locked files are in the way.")
999 (function (lambda (f) (and
1001 (vc-error-occurred (vc-backend-checkout f nil name
))))))
1004 ;; Miscellaneous other entry points
1007 (defun vc-print-log ()
1008 "List the change log of the current buffer in a window."
1011 (set-buffer (find-file-noselect (dired-get-filename))))
1012 (while vc-parent-buffer
1013 (pop-to-buffer vc-parent-buffer
))
1014 (if (and buffer-file-name
(vc-name buffer-file-name
))
1016 (vc-backend-print-log buffer-file-name
)
1017 (pop-to-buffer (get-buffer-create "*vc*"))
1019 (goto-char (point-min))
1021 (vc-registration-error buffer-file-name
)
1026 (defun vc-revert-buffer ()
1027 "Revert the current buffer's file back to the latest checked-in version.
1028 This asks for confirmation if the buffer contents are not identical
1032 (find-file-other-window (dired-get-filename)))
1033 (while vc-parent-buffer
1034 (pop-to-buffer vc-parent-buffer
))
1035 (let ((file buffer-file-name
)
1036 (obuf (current-buffer)) (changed (vc-diff nil
)))
1037 (if (and changed
(or vc-suppress-confirm
1038 (not (yes-or-no-p "Discard changes? "))))
1041 (error "Revert cancelled."))
1045 (vc-backend-revert file
)
1046 (vc-resynch-window file t t
)
1051 (defun vc-cancel-version (norevert)
1052 "Get rid of most recently checked in version of this file.
1053 A prefix argument means do not revert the buffer afterwards."
1056 (find-file-other-window (dired-get-filename)))
1057 (while vc-parent-buffer
1058 (pop-to-buffer vc-parent-buffer
))
1059 (let* ((target (concat (vc-latest-version (buffer-file-name))))
1060 (yours (concat (vc-your-latest-version (buffer-file-name))))
1061 (prompt (if (string-equal yours target
)
1062 "Remove your version %s from master?"
1063 "Version %s was not your change. Remove it anyway?")))
1064 (if (null (yes-or-no-p (format prompt target
)))
1066 (vc-backend-uncheck (buffer-file-name) target
)
1068 (not (yes-or-no-p "Revert buffer to most recent remaining version? ")))
1069 (vc-mode-line (buffer-file-name))
1070 (vc-checkout (buffer-file-name) nil
)))
1073 (defun vc-rename-file (old new
)
1074 "Rename file OLD to NEW, and rename its master file likewise."
1075 (interactive "fVC rename file: \nFRename to: ")
1076 (let ((oldbuf (get-file-buffer old
)))
1077 (if (buffer-modified-p oldbuf
)
1078 (error "Please save files before moving them."))
1079 (if (get-file-buffer new
)
1080 (error "Already editing new file name."))
1081 (let ((oldmaster (vc-name old
)))
1083 (if (vc-locking-user old
)
1084 (error "Please check in files before moving them."))
1085 (if (or (file-symlink-p oldmaster
)
1086 ;; This had FILE, I changed it to OLD. -- rms.
1087 (file-symlink-p (vc-backend-subdirectory-name old
)))
1088 (error "This is not a safe thing to do in the presence of symbolic links."))
1089 (rename-file oldmaster
(vc-name new
)))
1090 (if (or (not oldmaster
) (file-exists-p old
))
1091 (rename-file old new
)))
1092 ; ?? Renaming a file might change its contents due to keyword expansion.
1093 ; We should really check out a new copy if the old copy was precisely equal
1094 ; to some checked in version. However, testing for this is tricky....
1098 (set-visited-file-name new
)
1099 (set-buffer-modified-p nil
))))
1100 ;; This had FILE, I changed it to OLD. -- rms.
1101 (vc-backend-dispatch old
1102 (vc-record-rename old new
)
1107 (defun vc-update-change-log (&rest args
)
1108 "Find change log file and add entries from recent RCS logs.
1109 The mark is left at the end of the text prepended to the change log.
1110 With prefix arg of C-u, only find log entries for the current buffer's file.
1111 With any numeric prefix arg, find log entries for all files currently visited.
1112 From a program, any arguments are passed to the `rcs2log' script."
1114 (cond ((consp current-prefix-arg
) ;C-u
1115 (list buffer-file-name
))
1116 (current-prefix-arg ;Numeric argument.
1118 (buffers (buffer-list))
1121 (setq file
(buffer-file-name (car buffers
)))
1122 (and file
(vc-backend-deduce file
)
1123 (setq files
(cons (file-relative-name file
) files
)))
1124 (setq buffers
(cdr buffers
)))
1126 (find-file-other-window (find-change-log))
1127 (barf-if-buffer-read-only)
1130 (goto-char (point-min))
1132 (message "Computing change log entries...")
1133 (message "Computing change log entries... %s"
1134 (if (eq 0 (apply 'call-process
"rcs2log" nil t nil args
))
1137 ;; Functions for querying the master and lock files.
1139 (defun vc-match-substring (bn)
1140 (buffer-substring (match-beginning bn
) (match-end bn
)))
1142 (defun vc-parse-buffer (patterns &optional file properties
)
1143 ;; Use PATTERNS to parse information out of the current buffer
1144 ;; by matching each regular expression in the list and returning \\1.
1145 ;; If a regexp has two tag brackets, assume the second is a date
1146 ;; field and we want the most recent entry matching the template.
1147 ;; If FILE and PROPERTIES are given, the latter must be a list of
1148 ;; properties of the same length as PATTERNS; each property is assigned
1149 ;; the corresponding value.
1150 (mapcar (function (lambda (p)
1151 (goto-char (point-min))
1152 (if (string-match "\\\\(.*\\\\(" p
)
1153 (let ((latest-date "") (latest-val))
1154 (while (re-search-forward p nil t
)
1155 (let ((date (vc-match-substring 2)))
1156 (if (string< latest-date date
)
1158 (setq latest-date date
)
1160 (vc-match-substring 1))))))
1163 (and (re-search-forward p nil t
)
1164 (let ((value (vc-match-substring 1)))
1166 (vc-file-setprop file
(car properties
) value
))
1168 (setq properties
(cdr properties
)))))
1172 (defun vc-master-info (file fields
&optional rfile properties
)
1173 ;; Search for information in a master file.
1174 (if (and file
(file-exists-p file
))
1177 (setq buf
(create-file-buffer file
))
1180 (insert-file-contents file nil
)
1181 (set-buffer-modified-p nil
)
1182 (auto-save-mode nil
)
1184 (vc-parse-buffer fields rfile properties
)
1185 (kill-buffer (current-buffer)))
1189 (function (lambda (p) (vc-file-setprop rfile p nil
)))
1194 (defun vc-log-info (command file patterns
&optional properties
)
1195 ;; Search for information in log program output
1196 (if (and file
(file-exists-p file
))
1199 (setq buf
(get-buffer-create "*vc*"))
1201 (apply 'vc-do-command
0 command file nil
)
1202 (set-buffer-modified-p nil
)
1204 (vc-parse-buffer patterns file properties
)
1205 (kill-buffer (current-buffer))
1210 (function (lambda (p) (vc-file-setprop file p nil
)))
1215 (defun vc-locking-user (file)
1216 "Return the name of the person currently holding a lock on FILE.
1217 Return nil if there is no such person."
1218 (setq file
(expand-file-name file
)) ;; ??? Work around bug in 19.0.4
1219 (if (or (not vc-keep-workfiles
)
1220 (eq vc-mistrust-permissions
't
)
1221 (and vc-mistrust-permissions
1222 (funcall vc-mistrust-permissions
(vc-backend-subdirectory-name file
))))
1223 (vc-true-locking-user file
)
1224 ;; This implementation assumes that any file which is under version
1225 ;; control and has -rw-r--r-- is locked by its owner. This is true
1226 ;; for both RCS and SCCS, which keep unlocked files at -r--r--r--.
1227 ;; We have to be careful not to exclude files with execute bits on;
1228 ;; scripts can be under version control too. The advantage of this
1229 ;; hack is that calls to the very expensive vc-fetch-properties
1230 ;; function only have to be made if (a) the file is locked by someone
1231 ;; other than the current user, or (b) some untoward manipulation
1232 ;; behind vc's back has changed the owner or the `group' or `other'
1234 (let ((attributes (file-attributes file
)))
1235 (cond ((string-match ".r-.r-.r-." (nth 8 attributes
))
1237 ((and (= (nth 2 attributes
) (user-uid))
1238 (string-match ".rw.r-.r-." (nth 8 attributes
)))
1241 (vc-true-locking-user file
))))))
1243 (defun vc-true-locking-user (file)
1244 ;; The slow but reliable version
1245 (vc-fetch-properties file
)
1246 (vc-file-getprop file
'vc-locking-user
))
1248 (defun vc-latest-version (file)
1249 ;; Return version level of the latest version of FILE
1250 (vc-fetch-properties file
)
1251 (vc-file-getprop file
'vc-latest-version
))
1253 (defun vc-your-latest-version (file)
1254 ;; Return version level of the latest version of FILE checked in by you
1255 (vc-fetch-properties file
)
1256 (vc-file-getprop file
'vc-your-latest-version
))
1258 ;; Collect back-end-dependent stuff here
1260 ;; Everything eventually funnels through these functions. To implement
1261 ;; support for a new version-control system, add another branch to the
1262 ;; vc-backend-dispatch macro and fill it in in each call. The variable
1263 ;; vc-master-templates in vc-hooks.el will also have to change.
1265 (defmacro vc-backend-dispatch
(f s r
)
1266 "Execute FORM1 or FORM2 depending on whether we're using SCCS or RCS."
1267 (list 'let
(list (list 'type
(list 'vc-backend-deduce f
)))
1269 (list (list 'eq
'type
(quote 'SCCS
)) s
) ;; SCCS
1270 (list (list 'eq
'type
(quote 'RCS
)) r
) ;; RCS
1273 (defun vc-lock-file (file)
1274 ;; Generate lock file name corresponding to FILE
1275 (let ((master (vc-name file
)))
1278 (string-match "\\(.*/\\)s\\.\\(.*\\)" master
)
1280 (substring master
(match-beginning 1) (match-end 1))
1282 (substring master
(match-beginning 2) (match-end 2))))))
1285 (defun vc-fetch-properties (file)
1286 ;; Re-fetch all properties associated with the given file.
1287 ;; Currently these properties are:
1289 ;; vc-locked-version
1290 ;; vc-latest-version
1291 ;; vc-your-latest-version
1292 (vc-backend-dispatch
1296 (vc-master-info (vc-lock-file file
)
1298 "^[^ ]+ [^ ]+ \\([^ ]+\\)"
1301 '(vc-locking-user vc-locked-version
))
1302 (vc-master-info (vc-name file
)
1304 "^\001d D \\([^ ]+\\)"
1305 (concat "^\001d D \\([^ ]+\\) .* "
1306 (regexp-quote (user-login-name)) " ")
1309 '(vc-latest-version vc-your-latest-version
))
1312 (vc-log-info "rlog" file
1314 "^locks: strict\n\t\\([^:]+\\)"
1315 "^locks: strict\n\t[^:]+: \\(.+\\)"
1316 "^revision[\t ]+\\([0-9.]+\\).*\ndate: \\([ /0-9:]+\\);"
1318 "^revision[\t ]+\\([0-9.]+\\)\n.*author: "
1319 (regexp-quote (user-login-name))
1321 '(vc-locking-user vc-locked-version
1322 vc-latest-version vc-your-latest-version
))
1325 (defun vc-backend-subdirectory-name (&optional file
)
1326 ;; Where the master and lock files for the current directory are kept
1329 (and file
(vc-backend-deduce file
))
1331 (setq vc-default-back-end
(if (vc-find-binary "rcs") 'RCS
'SCCS
)))))
1333 (defun vc-backend-admin (file &optional rev comment
)
1334 ;; Register a file into the version-control system
1335 ;; Automatically retrieves a read-only version of the file with
1336 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
1337 ;; it deletes the workfile.
1338 (vc-file-clearprops file
)
1339 (or vc-default-back-end
1340 (setq vc-default-back-end
(if (vc-find-binary "rcs") 'RCS
'SCCS
)))
1341 (message "Registering %s..." file
)
1344 ((file-exists-p (vc-backend-subdirectory-name)) vc-default-back-end
)
1345 ((file-exists-p "RCS") 'RCS
)
1346 ((file-exists-p "SCCS") 'SCCS
)
1347 (t vc-default-back-end
))))
1348 (cond ((eq backend
'SCCS
)
1349 (vc-do-command 0 "admin" file
;; SCCS
1350 (and rev
(concat "-r" rev
))
1353 (and comment
(concat "-y" comment
))
1355 (car (rassq 'SCCS vc-master-templates
))
1356 (or (file-name-directory file
) "")
1357 (file-name-nondirectory file
)))
1359 (if vc-keep-workfiles
1360 (vc-do-command 0 "get" file
)))
1362 (vc-do-command 0 "ci" file
;; RCS
1363 (concat (if vc-keep-workfiles
"-u" "-r") rev
)
1364 (and comment
(concat "-t-" comment
))
1367 (message "Registering %s...done" file
)
1370 (defun vc-backend-checkout (file &optional writable rev
)
1371 ;; Retrieve a copy of a saved version into a workfile
1372 (message "Checking out %s..." file
)
1373 (vc-backend-dispatch file
1375 (vc-do-command 0 "get" file
;; SCCS
1377 (and rev
(concat "-r" (vc-lookup-triple file rev
))))
1379 (vc-do-command 0 "co" file
;; RCS
1381 (and rev
(concat "-r" rev
)))
1383 (vc-file-setprop file
'vc-checkout-time
(nth 5 (file-attributes file
)))
1384 (message "Checking out %s...done" file
)
1387 (defun vc-backend-logentry-check (file)
1388 (vc-backend-dispatch file
1389 (if (>= (buffer-size) 512) ;; SCCS
1393 "Log must be less than 512 characters. Point is now at char 512.")))
1397 (defun vc-backend-checkin (file &optional rev comment
)
1398 ;; Register changes to FILE as level REV with explanatory COMMENT.
1399 ;; Automatically retrieves a read-only version of the file with
1400 ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
1401 ;; it deletes the workfile.
1402 (message "Checking in %s..." file
)
1404 ;; Change buffers to get local value of vc-checkin-switches.
1405 (set-buffer (or (get-file-buffer file
) (current-buffer)))
1406 (vc-backend-dispatch file
1408 (apply 'vc-do-command
0 "delta" file
1409 (if rev
(concat "-r" rev
))
1410 (concat "-y" comment
)
1411 vc-checkin-switches
)
1412 (if vc-keep-workfiles
1413 (vc-do-command 0 "get" file
))
1415 (apply 'vc-do-command
0 "ci" file
1416 (concat (if vc-keep-workfiles
"-u" "-r") rev
)
1417 (concat "-m" comment
)
1418 vc-checkin-switches
)
1420 (vc-file-setprop file
'vc-locking-user nil
)
1421 (message "Checking in %s...done" file
)
1424 (defun vc-backend-revert (file)
1425 ;; Revert file to latest checked-in version.
1426 (message "Reverting %s..." file
)
1427 (vc-backend-dispatch
1430 (vc-do-command 0 "unget" file nil
)
1431 (vc-do-command 0 "get" file nil
))
1433 (delete-file file
) ;; RCS
1434 (vc-do-command 0 "co" file
"-u")))
1435 (vc-file-setprop file
'vc-locking-user nil
)
1436 (message "Reverting %s...done" file
)
1439 (defun vc-backend-steal (file &optional rev
)
1440 ;; Steal the lock on the current workfile. Needs RCS 5.6.2 or later for -M.
1441 (message "Stealing lock on %s..." file
)
1443 (vc-do-command 0 "unget" file
"-n" (if rev
(concat "-r" rev
)))
1444 (vc-do-command 0 "get" file
"-g" (if rev
(concat "-r" rev
)))
1447 (vc-do-command 0 "rcs" "-M" (concat "-u" rev
) file
)
1449 (vc-do-command 0 "rcs" (concat "-l" rev
) file
)
1451 (vc-file-setprop file
'vc-locking-user
(user-login-name))
1452 (message "Stealing lock on %s...done" file
)
1455 (defun vc-backend-uncheck (file target
)
1456 ;; Undo the latest checkin. Note: this code will have to get a lot
1457 ;; smarter when we support multiple branches.
1458 (message "Removing last change from %s..." file
)
1459 (vc-backend-dispatch file
1460 (vc-do-command 0 "rmdel" file
(concat "-r" target
))
1461 (vc-do-command 0 "rcs" file
(concat "-o" target
))
1463 (message "Removing last change from %s...done" file
)
1466 (defun vc-backend-print-log (file)
1467 ;; Print change log associated with FILE to buffer *vc*.
1469 (vc-backend-dispatch file
"prs" "rlog")
1473 (defun vc-backend-assign-name (file name
)
1474 ;; Assign to a FILE's latest version a given NAME.
1475 (vc-backend-dispatch file
1476 (vc-add-triple name file
(vc-latest-version file
)) ;; SCCS
1477 (vc-do-command 0 "rcs" file
(concat "-n" name
":")) ;; RCS
1481 (defun vc-backend-diff (file oldvers
&optional newvers
)
1482 ;; Get a difference report between two versions
1483 (if (eq (vc-backend-deduce file
) 'SCCS
)
1484 (setq oldvers
(vc-lookup-triple file oldvers
))
1485 (setq newvers
(vc-lookup-triple file newvers
)))
1486 (apply 'vc-do-command
1
1487 (or (vc-backend-dispatch file
"vcdiff" "rcsdiff")
1488 (vc-registration-error file
))
1490 (and oldvers
(concat "-r" oldvers
))
1491 (and newvers
(concat "-r" newvers
))
1492 (if (listp diff-switches
)
1494 (list diff-switches
))
1497 (defun vc-check-headers ()
1498 "Check if the current file has any headers in it."
1501 (goto-char (point-min))
1502 (vc-backend-dispatch buffer-file-name
1503 (re-search-forward "%[MIRLBSDHTEGUYFPQCZWA]%" nil t
) ;; SCCS
1504 (re-search-forward "\\$[A-Za-z\300-\326\330-\366\370-\377]+\\(: [\t -#%-\176\240-\377]*\\)?\\$" nil t
) ;; RCS
1508 ;; Back-end-dependent stuff ends here.
1510 ;; Set up key bindings for use while editing log messages
1512 (defun vc-log-mode ()
1513 "Minor mode for driving version-control tools.
1514 These bindings are added to the global keymap when you enter this mode:
1515 \\[vc-next-action] perform next logical version-control operation on current file
1516 \\[vc-register] register current file
1517 \\[vc-toggle-read-only] like next-action, but won't register files
1518 \\[vc-insert-headers] insert version-control headers in current file
1519 \\[vc-print-log] display change history of current file
1520 \\[vc-revert-buffer] revert buffer to latest version
1521 \\[vc-cancel-version] undo latest checkin
1522 \\[vc-diff] show diffs between file versions
1523 \\[vc-directory] show all files locked by any user in or below .
1524 \\[vc-update-change-log] add change log entry from recent checkins
1526 While you are entering a change log message for a version, the following
1527 additional bindings will be in effect.
1529 \\[vc-finish-logentry] proceed with check in, ending log message entry
1531 Whenever you do a checkin, your log comment is added to a ring of
1532 saved comments. These can be recalled as follows:
1534 \\[vc-next-comment] replace region with next message in comment ring
1535 \\[vc-previous-comment] replace region with previous message in comment ring
1536 \\[vc-comment-search-reverse] search backward for regexp in the comment ring
1537 \\[vc-comment-search-forward] search backward for regexp in the comment ring
1539 Entry to the change-log submode calls the value of text-mode-hook, then
1540 the value of vc-log-mode-hook.
1542 Global user options:
1543 vc-initial-comment If non-nil, require user to enter a change
1544 comment upon first checkin of the file.
1546 vc-keep-workfiles Non-nil value prevents workfiles from being
1547 deleted when changes are checked in
1549 vc-suppress-confirm Suppresses some confirmation prompts,
1550 notably for reversions.
1552 vc-header-alist Which keywords to insert when adding headers
1553 with \\[vc-insert-headers]. Defaults to
1554 '(\"\%\W\%\") under SCCS, '(\"\$Id\$\") under RCS.
1556 vc-static-header-alist By default, version headers inserted in C files
1557 get stuffed in a static string area so that
1558 ident(RCS) or what(SCCS) can see them in the
1559 compiled object code. You can override this
1560 by setting this variable to nil, or change
1561 the header template by changing it.
1563 vc-command-messages if non-nil, display run messages from the
1564 actual version-control utilities (this is
1565 intended primarily for people hacking vc
1569 (set-syntax-table text-mode-syntax-table
)
1570 (use-local-map vc-log-entry-mode
)
1571 (setq local-abbrev-table text-mode-abbrev-table
)
1572 (setq major-mode
'vc-log-mode
)
1573 (setq mode-name
"VC-Log")
1574 (make-local-variable 'vc-log-file
)
1575 (make-local-variable 'vc-log-version
)
1576 (make-local-variable 'vc-comment-ring-index
)
1577 (set-buffer-modified-p nil
)
1578 (setq buffer-file-name nil
)
1579 (run-hooks 'text-mode-hook
'vc-log-mode-hook
)
1582 ;; Initialization code, to be done just once at load-time
1583 (if vc-log-entry-mode
1585 (setq vc-log-entry-mode
(make-sparse-keymap))
1586 (define-key vc-log-entry-mode
"\M-n" 'vc-next-comment
)
1587 (define-key vc-log-entry-mode
"\M-p" 'vc-previous-comment
)
1588 (define-key vc-log-entry-mode
"\M-r" 'vc-comment-search-reverse
)
1589 (define-key vc-log-entry-mode
"\M-s" 'vc-comment-search-forward
)
1590 (define-key vc-log-entry-mode
"\C-c\C-c" 'vc-finish-logentry
)
1593 ;;; These things should probably be generally available
1595 (defun vc-shrink-to-fit ()
1596 "Shrink window vertically until it's just large enough to contain its text."
1597 (let ((minsize (1+ (count-lines (point-min) (point-max)))))
1598 (if (< minsize
(window-height))
1599 (let ((window-min-height 2))
1600 (shrink-window (- (window-height) minsize
))))))
1602 (defun vc-file-tree-walk (func &rest args
)
1603 "Walk recursively through default directory.
1604 Invoke FUNC f ARGS on each non-directory file f underneath it."
1605 (vc-file-tree-walk-internal default-directory func args
)
1606 (message "Traversing directory %s...done" default-directory
))
1608 (defun vc-file-tree-walk-internal (file func args
)
1609 (if (not (file-directory-p file
))
1610 (apply func file args
)
1611 (message "Traversing directory %s..." file
)
1612 (let ((dir (file-name-as-directory file
)))
1616 (string-equal f
".")
1617 (string-equal f
"..")
1618 (let ((dirf (concat dir f
)))
1620 (file-symlink-p dirf
) ;; Avoid possible loops
1621 (vc-file-tree-walk-internal dirf func args
))))))
1622 (directory-files dir
)))))
1626 ;;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE
1628 ;;; These may be useful to anyone who has to debug or extend the package.
1630 ;;; A fundamental problem in VC is that there are time windows between
1631 ;;; vc-next-action's computations of the file's version-control state and
1632 ;;; the actions that change it. This is a window open to lossage in a
1633 ;;; multi-user environment; someone else could nip in and change the state
1634 ;;; of the master during it.
1636 ;;; The performance problem is that rlog/prs calls are very expensive; we want
1637 ;;; to avoid them as much as possible.
1641 ;;; The performance problem, it turns out, simplifies in practice to the
1642 ;;; problem of making vc-locking-user fast. The two other functions that call
1643 ;;; prs/rlog will not be so commonly used that the slowdown is a problem; one
1644 ;;; makes snapshots, the other deletes the calling user's last change in the
1647 ;;; The race condition implies that we have to either (a) lock the master
1648 ;;; during the entire execution of vc-next-action, or (b) detect and
1649 ;;; recover from errors resulting from dispatch on an out-of-date state.
1651 ;;; Alternative (a) appears to be unfeasible. The problem is that we can't
1652 ;;; guarantee that the lock will ever be removed. Suppose a user starts a
1653 ;;; checkin, the change message buffer pops up, and the user, having wandered
1654 ;;; off to do something else, simply forgets about it?
1656 ;;; Alternative (b), on the other hand, works well with a cheap way to speed up
1657 ;;; vc-locking-user. Usually, if a file is registered, we can read its locked/
1658 ;;; unlocked state and its current owner from its permissions.
1660 ;;; This shortcut will fail if someone has manually changed the workfile's
1661 ;;; permissions; also if developers are munging the workfile in several
1662 ;;; directories, with symlinks to a master (in this latter case, the
1663 ;;; permissions shortcut will fail to detect a lock asserted from another
1666 ;;; Note that these cases correspond exactly to the errors which could happen
1667 ;;; because of a competing checkin/checkout race in between two instances of
1670 ;;; For VC's purposes, a workfile/master pair may have the following states:
1672 ;;; A. Unregistered. There is a workfile, there is no master.
1674 ;;; B. Registered and not locked by anyone.
1676 ;;; C. Locked by calling user and unchanged.
1678 ;;; D. Locked by the calling user and changed.
1680 ;;; E. Locked by someone other than the calling user.
1682 ;;; This makes for 25 states and 20 error conditions. Here's the matrix:
1684 ;;; VC's idea of state
1686 ;;; V Actual state RCS action SCCS action Effect
1688 ;;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin
1689 ;;; B 5 . 6 7 8 co -l get -e checkout
1690 ;;; C 9 10 . 11 12 co -u unget; get revert
1691 ;;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin
1692 ;;; E 17 18 19 20 . rcs -u -M ; rcs -l unget -n ; get -g steal lock
1694 ;;; All commands take the master file name as a last argument (not shown).
1696 ;;; In the discussion below, a "self-race" is a pathological situation in
1697 ;;; which VC operations are being attempted simultaneously by two or more
1698 ;;; Emacsen running under the same username.
1700 ;;; The vc-next-action code has the following windows:
1703 ;;; Between the check for existence of a master file and the call to
1704 ;;; admin/checkin in vc-buffer-admin (apparent state A). This window may
1705 ;;; never close if the initial-comment feature is on.
1708 ;;; Between the call to vc-workfile-unchanged-p in and the immediately
1709 ;;; following revert (apparent state C).
1712 ;;; Between the call to vc-workfile-unchanged-p in and the following
1713 ;;; checkin (apparent state D). This window may never close.
1716 ;;; Between the unlock and the immediately following checkout during a
1717 ;;; revert operation (apparent state C). Included in window Q.
1720 ;;; Between vc-locking-user and the following checkout (apparent state B).
1723 ;;; Between vc-locking-user and the following revert (apparent state C).
1724 ;;; Includes windows Q and S.
1727 ;;; Between vc-locking-user and the following checkin (apparent state
1728 ;;; D). This window may never be closed if the user fails to complete the
1729 ;;; checkin message. Includes window R.
1732 ;;; Between vc-locking-user and the following steal-lock (apparent
1733 ;;; state E). This window may never close if the user fails to complete
1734 ;;; the steal-lock message. Includes window X.
1737 ;;; Between the unlock and the immediately following re-lock during a
1738 ;;; steal-lock operation (apparent state E). This window may never cloce
1739 ;;; if the user fails to complete the steal-lock message.
1743 ;;; Apparent state A ---
1745 ;;; 1. File looked unregistered but is actually registered and not locked.
1747 ;;; Potential cause: someone else's admin during window P, with
1748 ;;; caller's admin happening before their checkout.
1750 ;;; RCS: ci will fail with a "no lock set by <user>" message.
1751 ;;; SCCS: admin will fail with error (ad19).
1753 ;;; We can let these errors be passed up to the user.
1755 ;;; 2. File looked unregistered but is actually locked by caller, unchanged.
1757 ;;; Potential cause: self-race during window P.
1759 ;;; RCS: will revert the file to the last saved version and unlock it.
1760 ;;; SCCS: will fail with error (ad19).
1762 ;;; Either of these consequences is acceptable.
1764 ;;; 3. File looked unregistered but is actually locked by caller, changed.
1766 ;;; Potential cause: self-race during window P.
1768 ;;; RCS: will register the caller's workfile as a delta with a
1769 ;;; null change comment (the -t- switch will be ignored).
1770 ;;; SCCS: will fail with error (ad19).
1772 ;;; 4. File looked unregistered but is locked by someone else.
1774 ;;; Potential cause: someone else's admin during window P, with
1775 ;;; caller's admin happening *after* their checkout.
1777 ;;; RCS: will fail with a "no lock set by <user>" message.
1778 ;;; SCCS: will fail with error (ad19).
1780 ;;; We can let these errors be passed up to the user.
1782 ;;; Apparent state B ---
1784 ;;; 5. File looked registered and not locked, but is actually unregistered.
1786 ;;; Potential cause: master file got nuked during window P.
1788 ;;; RCS: will fail with "RCS/<file>: No such file or directory"
1789 ;;; SCCS: will fail with error ut4.
1791 ;;; We can let these errors be passed up to the user.
1793 ;;; 6. File looked registered and not locked, but is actually locked by the
1794 ;;; calling user and unchanged.
1796 ;;; Potential cause: self-race during window T.
1798 ;;; RCS: in the same directory as the previous workfile, co -l will fail
1799 ;;; with "co error: writable foo exists; checkout aborted". In any other
1800 ;;; directory, checkout will succeed.
1801 ;;; SCCS: will fail with ge17.
1803 ;;; Either of these consequences is acceptable.
1805 ;;; 7. File looked registered and not locked, but is actually locked by the
1806 ;;; calling user and changed.
1810 ;;; 8. File looked registered and not locked, but is actually locked by another
1813 ;;; Potential cause: someone else checks it out during window T.
1815 ;;; RCS: co error: revision 1.3 already locked by <user>
1816 ;;; SCCS: fails with ge4 (in directory) or ut7 (outside it).
1818 ;;; We can let these errors be passed up to the user.
1820 ;;; Apparent state C ---
1822 ;;; 9. File looks locked by calling user and unchanged, but is unregistered.
1826 ;;; 10. File looks locked by calling user and unchanged, but is actually not
1829 ;;; Potential cause: a self-race in window U, or by the revert's
1830 ;;; landing during window X of some other user's steal-lock or window S
1831 ;;; of another user's revert.
1833 ;;; RCS: succeeds, refreshing the file from the identical version in
1835 ;;; SCCS: fails with error ut4 (p file nonexistent).
1837 ;;; Either of these consequences is acceptable.
1839 ;;; 11. File is locked by calling user. It looks unchanged, but is actually
1842 ;;; Potential cause: the file would have to be touched by a self-race
1843 ;;; during window Q.
1845 ;;; The revert will succeed, removing whatever changes came with
1846 ;;; the touch. It is theoretically possible that work could be lost.
1848 ;;; 12. File looks like it's locked by the calling user and unchanged, but
1849 ;;; it's actually locked by someone else.
1851 ;;; Potential cause: a steal-lock in window V.
1853 ;;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u
1854 ;;; SCCS: fails with error un2
1856 ;;; We can pass these errors up to the user.
1858 ;;; Apparent state D ---
1860 ;;; 13. File looks like it's locked by the calling user and changed, but it's
1861 ;;; actually unregistered.
1863 ;;; Potential cause: master file got nuked during window P.
1865 ;;; RCS: Checks in the user's version as an initial delta.
1866 ;;; SCCS: will fail with error ut4.
1868 ;;; This case is kind of nasty. It means VC may fail to detect the
1869 ;;; loss of previous version information.
1871 ;;; 14. File looks like it's locked by the calling user and changed, but it's
1872 ;;; actually unlocked.
1874 ;;; Potential cause: self-race in window V, or the checkin happening
1875 ;;; during the window X of someone else's steal-lock or window S of
1876 ;;; someone else's revert.
1878 ;;; RCS: ci will fail with "no lock set by <user>".
1879 ;;; SCCS: delta will fail with error ut4.
1881 ;;; 15. File looks like it's locked by the calling user and changed, but it's
1882 ;;; actually locked by the calling user and unchanged.
1884 ;;; Potential cause: another self-race --- a whole checkin/checkout
1885 ;;; sequence by the calling user would have to land in window R.
1887 ;;; SCCS: checks in a redundant delta and leaves the file unlocked as usual.
1888 ;;; RCS: reverts to the file state as of the second user's checkin, leaving
1889 ;;; the file unlocked.
1891 ;;; It is theoretically possible that work could be lost under RCS.
1893 ;;; 16. File looks like it's locked by the calling user and changed, but it's
1894 ;;; actually locked by a different user.
1896 ;;; RCS: ci error: no lock set by <user>
1897 ;;; SCCS: unget will fail with error un2
1899 ;;; We can pass these errors up to the user.
1901 ;;; Apparent state E ---
1903 ;;; 17. File looks like it's locked by some other user, but it's actually
1908 ;;; 18. File looks like it's locked by some other user, but it's actually
1911 ;;; Potential cause: someone released a lock during window W.
1913 ;;; RCS: The calling user will get the lock on the file.
1914 ;;; SCCS: unget -n will fail with cm4.
1916 ;;; Either of these consequences will be OK.
1918 ;;; 19. File looks like it's locked by some other user, but it's actually
1919 ;;; locked by the calling user and unchanged.
1921 ;;; Potential cause: the other user relinquishing a lock followed by
1922 ;;; a self-race, both in window W.
1924 ;;; Under both RCS and SCCS, both unlock and lock will succeed, making
1925 ;;; the sequence a no-op.
1927 ;;; 20. File looks like it's locked by some other user, but it's actually
1928 ;;; locked by the calling user and changed.
1934 ;;; In order of decreasing severity:
1936 ;;; Cases 11 and 15 under RCS are the only one that potentially lose work.
1937 ;;; They would require a self-race for this to happen.
1939 ;;; Case 13 in RCS loses information about previous deltas, retaining
1940 ;;; only the information in the current workfile. This can only happen
1941 ;;; if the master file gets nuked in window P.
1943 ;;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with
1944 ;;; no change comment in the master. This would require a self-race in
1945 ;;; window P or R respectively.
1947 ;;; Cases 2, 10, 19 and 20 do extra work, but make no changes.
1949 ;;; Unfortunately, it appears to me that no recovery is possible in these
1950 ;;; cases. They don't yield error messages, so there's no way to tell that
1951 ;;; a race condition has occurred.
1953 ;;; All other cases don't change either the workfile or the master, and
1954 ;;; trigger command errors which the user will see.
1956 ;;; Thus, there is no explicit recovery code.