1 ;;; vc.el --- drive a version-control system from within Emacs
3 ;; Copyright (C) 1992,93,94,95,96,97,98,2000 Free Software Foundation, Inc.
5 ;; Author: FSF (see below for full credits)
6 ;; Maintainer: Andre Spiegel <spiegel@gnu.org>
8 ;; $Id: vc.el,v 1.280 2000/10/10 01:25:40 ttn Exp $
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
29 ;; VC was initially designed and implemented by Eric S. Raymond
30 ;; <esr@snark.thyrsus.com>. Over the years, many people have
31 ;; contributed substantial amounts of work to VC. These include:
32 ;; Per Cederqvist <ceder@lysator.liu.se>
33 ;; Paul Eggert <eggert@twinsun.com>
34 ;; Sebastian Kremer <sk@thp.uni-koeln.de>
35 ;; Martin Lorentzson <martinl@gnu.org>
36 ;; Dave Love <d.love@gnu.org>
37 ;; Stefan Monnier <monnier@cs.yale.edu>
38 ;; Andre Spiegel <spiegel@gnu.org>
39 ;; Richard Stallman <rms@gnu.org>
44 ;; This mode is fully documented in the Emacs user's manual.
46 ;; Supported version-control systems presently include SCCS, RCS, and CVS.
48 ;; Some features will not work with old RCS versions. Where
49 ;; appropriate, VC finds out which version you have, and allows or
50 ;; disallows those features (stealing locks, for example, works only
51 ;; from 5.6.2 onwards).
52 ;; Even initial checkins will fail if your RCS version is so old that ci
53 ;; doesn't understand -t-; this has been known to happen to people running
56 ;; You can support the RCS -x option by customizing vc-rcs-master-templates.
58 ;; Proper function of the SCCS diff commands requires the shellscript vcdiff
59 ;; to be installed somewhere on Emacs's path for executables.
61 ;; If your site uses the ChangeLog convention supported by Emacs, the
62 ;; function vc-comment-to-change-log should prove a useful checkin hook.
64 ;; The vc code maintains some internal state in order to reduce expensive
65 ;; version-control operations to a minimum. Some names are only computed
66 ;; once. If you perform version control operations with RCS/SCCS/CVS while
67 ;; vc's back is turned, or move/rename master files while vc is running,
68 ;; vc may get seriously confused. Don't do these things!
70 ;; Developer's notes on some concurrency issues are included at the end of
75 ;;;;;;;;;;;;;;;;; Backend-specific functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
77 ;; for each operation FUN, the backend should provide a function vc-BACKEND-FUN.
78 ;; Operations marked with a `-' instead of a `*' are optional.
80 ;; * registered (file)
82 ;; - state-heuristic (file)
83 ;; The default behavior delegates to `state'.
85 ;; * checkout-model (file)
86 ;; - mode-line-string (file)
87 ;; * workfile-version (file)
89 ;; - merge-news (file)
90 ;; Only needed if state `needs-merge' is possible.
91 ;; - merge (file rev1 rev2)
92 ;; - steal-lock (file &optional version)
93 ;; Only required if files can be locked by somebody else.
94 ;; * register (file rev comment)
95 ;; * unregister (file backend)
96 ;; - receive-file (file rev)
97 ;; - responsible-p (file)
98 ;; Should also work if FILE is a directory (ends with a slash).
99 ;; - could-register (file)
100 ;; * checkout (file writable &optional rev destfile)
101 ;; Checkout revision REV of FILE into DESTFILE.
102 ;; DESTFILE defaults to FILE.
103 ;; The file should be made writable if WRITABLE is non-nil.
104 ;; REV can be nil (BASE) or "" (HEAD) or any other revision.
105 ;; * checkin (file rev comment)
106 ;; - logentry-check ()
107 ;; * diff (file &optional rev1 rev2)
108 ;; Insert the diff for FILE into the current buffer.
109 ;; REV1 should default to workfile-version.
110 ;; REV2 should default to the current workfile
111 ;; Return a status of either 0 (i.e. no diff) or 1 (i.e. either non-empty
112 ;; diff or the diff is run asynchronously).
113 ;; - workfile-unchanged-p (file)
114 ;; Return non-nil if FILE is unchanged from its current workfile version.
115 ;; This function should do a brief comparison of FILE's contents
116 ;; with those of the master version. If the backend does not have
117 ;; such a brief-comparison feature, the default implementation of this
118 ;; function can be used, which delegates to a full vc-BACKEND-diff.
119 ;; - clear-headers ()
120 ;; * check-headers ()
121 ;; - dired-state-info (file)
122 ;; - create-snapshot (dir name branchp)
123 ;; Take a snapshot of the current state of files under DIR and name it NAME.
124 ;; This should make sure that files are up-to-date before proceeding
126 ;; DIR can also be a file and if BRANCHP is specified, NAME
127 ;; should be created as a branch and DIR should be checked out under
128 ;; this new branch. The default behavior does not support branches
129 ;; but does a sanity check, a tree traversal and for each file calls
131 ;; * assign-name (file name)
132 ;; Give name NAME to the current version of FILE, assuming it is
133 ;; up-to-date. Only used by the default version of `create-snapshot'.
134 ;; - retrieve-snapshot (dir name update)
135 ;; Retrieve a named snapshot of all registered files at or below DIR.
136 ;; If UPDATE is non-nil, then update buffers of any files in the snapshot
137 ;; that are currently visited.
138 ;; * print-log (file)
139 ;; Insert the revision log of FILE into the current buffer.
140 ;; - show-log-entry (version)
142 ;; Remove all non-comment information from the output of print-log
143 ;; - comment-history (file)
144 ;; - update-changelog (files)
145 ;; Find changelog entries for FILES, or for all files at or below
146 ;; the default-directory if FILES is nil.
147 ;; * latest-on-branch-p (file)
148 ;; - cancel-version (file writable)
149 ;; - rename-file (old new)
150 ;; - annotate-command (file buf)
151 ;; - annotate-difference (pos)
152 ;; Only required if `annotate-command' is defined for the backend.
159 (require 'dired
) ; for dired-map-over-marks macro
160 (require 'dired-aux
)) ; for dired-kill-{line,tree}
162 (if (not (assoc 'vc-parent-buffer minor-mode-alist
))
163 (setq minor-mode-alist
164 (cons '(vc-parent-buffer vc-parent-buffer-name
)
167 ;; General customization
170 "Version-control system in Emacs."
173 (defcustom vc-suppress-confirm nil
174 "*If non-nil, treat user as expert; suppress yes-no prompts on some things."
178 (defcustom vc-delete-logbuf-window t
179 "*If non-nil, delete the *VC-log* buffer and window after each logical action.
180 If nil, bury that buffer instead.
181 This is most useful if you have multiple windows on a frame and would like to
182 preserve the setting."
186 (defcustom vc-initial-comment nil
187 "*If non-nil, prompt for initial comment when a file is registered."
191 (defcustom vc-default-init-version
"1.1"
192 "*A string used as the default version number when a new file is registered.
193 This can be overridden by giving a prefix argument to \\[vc-register]."
198 (defcustom vc-command-messages nil
199 "*If non-nil, display run messages from back-end commands."
203 (defcustom vc-checkin-switches nil
204 "*A string or list of strings specifying extra switches for checkin.
205 These are passed to the checkin program by \\[vc-checkin]."
206 :type
'(choice (const :tag
"None" nil
)
207 (string :tag
"Argument String")
208 (repeat :tag
"Argument List"
213 (defcustom vc-checkout-switches nil
214 "*A string or list of strings specifying extra switches for checkout.
215 These are passed to the checkout program by \\[vc-checkout]."
216 :type
'(choice (const :tag
"None" nil
)
217 (string :tag
"Argument String")
218 (repeat :tag
"Argument List"
223 (defcustom vc-register-switches nil
224 "*A string or list of strings; extra switches for registering a file.
225 These are passed to the checkin program by \\[vc-register]."
226 :type
'(choice (const :tag
"None" nil
)
227 (string :tag
"Argument String")
228 (repeat :tag
"Argument List"
233 (defcustom vc-dired-listing-switches
"-al"
234 "*Switches passed to `ls' for vc-dired. MUST contain the `l' option."
239 (defcustom vc-dired-recurse t
240 "*If non-nil, show directory trees recursively in VC Dired."
245 (defcustom vc-dired-terse-display t
246 "*If non-nil, show only locked files in VC Dired."
251 (defcustom vc-directory-exclusion-list
'("SCCS" "RCS" "CVS")
252 "*List of directory names to be ignored while recursively walking file trees."
253 :type
'(repeat string
)
256 (defconst vc-maximum-comment-ring-size
32
257 "Maximum number of saved comments in the comment ring.")
259 ;;; This is duplicated in diff.el.
260 (defvar diff-switches
"-c"
261 "*A string or list of strings specifying switches to be passed to diff.")
264 (defcustom vc-checkin-hook nil
265 "*Normal hook (list of functions) run after a checkin is done.
268 :options
'(vc-comment-to-change-log)
272 (defcustom vc-before-checkin-hook nil
273 "*Normal hook (list of functions) run before a file gets checked in.
278 (defcustom vc-logentry-check-hook nil
279 "*Normal hook run by `vc-backend-logentry-check'.
280 Use this to impose your own rules on the entry in addition to any the
281 version control backend imposes itself."
285 ;; Annotate customization
286 (defcustom vc-annotate-color-map
287 '(( 26.3672 .
"#FF0000")
288 ( 52.7344 .
"#FF3800")
289 ( 79.1016 .
"#FF7000")
290 (105.4688 .
"#FFA800")
291 (131.8359 .
"#FFE000")
292 (158.2031 .
"#E7FF00")
293 (184.5703 .
"#AFFF00")
294 (210.9375 .
"#77FF00")
295 (237.3047 .
"#3FFF00")
296 (263.6719 .
"#07FF00")
297 (290.0391 .
"#00FF31")
298 (316.4063 .
"#00FF69")
299 (342.7734 .
"#00FFA1")
300 (369.1406 .
"#00FFD9")
301 (395.5078 .
"#00EEFF")
302 (421.8750 .
"#00B6FF")
303 (448.2422 .
"#007EFF"))
304 "*Association list of age versus color, for \\[vc-annotate].
305 Ages are given in units of 2**-16 seconds.
306 Default is eighteen steps using a twenty day increment."
310 (defcustom vc-annotate-very-old-color
"#0046FF"
311 "*Color for lines older than CAR of last cons in `vc-annotate-color-map'."
315 (defcustom vc-annotate-background
"black"
316 "*Background color for \\[vc-annotate].
317 Default color is used if nil."
321 (defcustom vc-annotate-menu-elements
'(2 0.5 0.1 0.01)
322 "*Menu elements for the mode-specific menu of VC-Annotate mode.
323 List of factors, used to expand/compress the time scale. See `vc-annotate'."
324 :type
'(repeat number
)
327 ;; vc-annotate functionality (CVS only).
328 (defvar vc-annotate-mode nil
329 "Variable indicating if VC-Annotate mode is active.")
331 (defvar vc-annotate-mode-map
332 (let ((m (make-sparse-keymap)))
333 (define-key m
[menu-bar
] (make-sparse-keymap "VC-Annotate"))
335 "Local keymap used for VC-Annotate mode.")
337 (defvar vc-annotate-mode-menu nil
338 "Local keymap used for VC-Annotate mode's menu bar menu.")
340 ;; Header-insertion hair
342 (defcustom vc-static-header-alist
344 "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n"))
345 "*Associate static header string templates with file types.
346 A \%s in the template is replaced with the first string associated with
347 the file's version control type in `vc-header-alist'."
348 :type
'(repeat (cons :format
"%v"
349 (regexp :tag
"File Type")
350 (string :tag
"Header String")))
353 (defcustom vc-comment-alist
354 '((nroff-mode ".\\\"" ""))
355 "*Special comment delimiters to be used in generating vc headers only.
356 Add an entry in this list if you need to override the normal `comment-start'
357 and `comment-end' variables. This will only be necessary if the mode language
358 is sensitive to blank lines."
359 :type
'(repeat (list :format
"%v"
361 (string :tag
"Comment Start")
362 (string :tag
"Comment End")))
365 ;; Default is to be extra careful for super-user.
366 ;; TODO: This variable is no longer used; the corresponding checks
367 ;; are always done now. If that turns out to be fast enough,
368 ;; the variable can be obsoleted.
369 (defcustom vc-checkout-carefully
(= (user-uid) 0)
370 "*Non-nil means be extra-careful in checkout.
371 Verify that the file really is not locked
372 and that its contents match what the master file says."
379 (defvar vc-prefix-map
380 (let ((map (make-sparse-keymap)))
381 (define-key map
"a" 'vc-update-change-log
)
382 (define-key map
"b" 'vc-switch-backend
)
383 (define-key map
"c" 'vc-cancel-version
)
384 (define-key map
"d" 'vc-directory
)
385 (define-key map
"g" 'vc-annotate
)
386 (define-key map
"h" 'vc-insert-headers
)
387 (define-key map
"i" 'vc-register
)
388 (define-key map
"l" 'vc-print-log
)
389 (define-key map
"m" 'vc-merge
)
390 (define-key map
"r" 'vc-retrieve-snapshot
)
391 (define-key map
"s" 'vc-create-snapshot
)
392 (define-key map
"u" 'vc-revert-buffer
)
393 (define-key map
"v" 'vc-next-action
)
394 (define-key map
"=" 'vc-diff
)
395 (define-key map
"~" 'vc-version-other-window
)
397 (fset 'vc-prefix-map vc-prefix-map
)
399 ;; Initialization code, to be done just once at load-time
400 (defvar vc-log-mode-map
401 (let ((map (make-sparse-keymap)))
402 (define-key map
"\M-n" 'vc-next-comment
)
403 (define-key map
"\M-p" 'vc-previous-comment
)
404 (define-key map
"\M-r" 'vc-comment-search-reverse
)
405 (define-key map
"\M-s" 'vc-comment-search-forward
)
406 (define-key map
"\C-c\C-c" 'vc-finish-logentry
)
408 ;; Compatibility with old name. Should we bother ?
409 (defvar vc-log-entry-mode vc-log-mode-map
)
412 ;; Variables the user doesn't need to know about.
413 (defvar vc-log-operation nil
)
414 (defvar vc-log-after-operation-hook nil
)
415 (defvar vc-annotate-buffers nil
416 "Alist of current \"Annotate\" buffers and their corresponding backends.
417 The keys are \(BUFFER . BACKEND\). See also `vc-annotate-get-backend'.")
418 ;; In a log entry buffer, this is a local variable
419 ;; that points to the buffer for which it was made
420 ;; (either a file, or a VC dired buffer).
421 (defvar vc-parent-buffer nil
)
422 (put 'vc-parent-buffer
'permanent-local t
)
423 (defvar vc-parent-buffer-name nil
)
424 (put 'vc-parent-buffer-name
'permanent-local t
)
427 (defvar vc-log-version
)
429 (defvar vc-dired-mode nil
)
430 (make-variable-buffer-local 'vc-dired-mode
)
432 (defvar vc-comment-ring
(make-ring vc-maximum-comment-ring-size
))
433 (defvar vc-comment-ring-index nil
)
434 (defvar vc-last-comment-match
"")
436 ;;; functions that operate on RCS revision numbers. This code should
437 ;;; also be moved into the backends. It stays for now, however, since
438 ;;; it is used in code below.
439 (defun vc-trunk-p (rev)
440 "Return t if REV is a revision on the trunk."
441 (not (eq nil
(string-match "\\`[0-9]+\\.[0-9]+\\'" rev
))))
443 (defun vc-branch-p (rev)
444 "Return t if REV is a branch revision."
445 (not (eq nil
(string-match "\\`[0-9]+\\(\\.[0-9]+\\.[0-9]+\\)*\\'" rev
))))
447 (defun vc-branch-part (rev)
448 "Return the branch part of a revision number REV."
449 (substring rev
0 (string-match "\\.[0-9]+\\'" rev
)))
451 (defun vc-minor-part (rev)
452 "Return the minor version number of a revision number REV."
453 (string-match "[0-9]+\\'" rev
)
454 (substring rev
(match-beginning 0) (match-end 0)))
456 (defun vc-previous-version (rev)
457 "Guess the version number immediately preceding REV."
458 (let ((branch (vc-branch-part rev
))
459 (minor-num (string-to-number (vc-minor-part rev
))))
461 ;; version does probably not start a branch or release
462 (concat branch
"." (number-to-string (1- minor-num
)))
464 ;; we are at the beginning of the trunk --
465 ;; don't know anything to return here
467 ;; we are at the beginning of a branch --
468 ;; return version of starting point
469 (vc-branch-part branch
)))))
471 ;; File property caching
473 (defun vc-clear-context ()
474 "Clear all cached file properties and the comment ring."
476 (fillarray vc-file-prop-obarray nil
)
477 ;; Note: there is potential for minor lossage here if there is an open
478 ;; log buffer with a nonzero local value of vc-comment-ring-index.
479 (setq vc-comment-ring
(make-ring vc-maximum-comment-ring-size
)))
481 (defmacro with-vc-properties
(file form settings
)
482 "Execute FORM, then set per-file properties for FILE,
483 but only those that have not been set during the execution of FORM.
484 SETTINGS is a list of two-element lists, each of which has the
485 form (PROPERTY . VALUE)."
486 `(let ((vc-touched-properties (list t
))
489 (mapcar (lambda (setting)
490 (let ((property (car setting
)))
491 (unless (memq property vc-touched-properties
)
492 (put (intern filename vc-file-prop-obarray
)
493 property
(cdr setting
)))))
496 ;; Random helper functions
498 (defsubst vc-editable-p
(file)
499 (or (eq (vc-checkout-model file
) 'implicit
)
500 (memq (vc-state file
) '(edited needs-merge
))))
502 ;;; Two macros for elisp programming
504 (defmacro with-vc-file
(file comment
&rest body
)
505 "Check out a writable copy of FILE if necessary and execute the body.
506 Check in FILE with COMMENT (a string) after BODY has been executed.
507 FILE is passed through `expand-file-name'; BODY executed within
508 `save-excursion'. If FILE is not under version control, or locked by
509 somebody else, signal error."
510 `(let ((file (expand-file-name ,file
)))
511 (or (vc-backend file
)
512 (error (format "File not under version control: `%s'" file
)))
513 (unless (vc-editable-p file
)
514 (let ((state (vc-state file
)))
515 (if (stringp state
) (error (format "`%s' is locking `%s'" state file
))
516 (vc-checkout file t
))))
519 (vc-checkin file nil
,comment
)))
520 (put 'with-vc-file
'indent-function
1)
523 (defmacro edit-vc-file
(file comment
&rest body
)
524 "Edit FILE under version control, executing body.
525 Checkin with COMMENT after executing BODY.
526 This macro uses `with-vc-file', passing args to it.
527 However, before executing BODY, find FILE, and after BODY, save buffer."
530 (set-buffer (find-file-noselect ,file
))
533 (put 'edit-vc-file
'indent-function
1)
535 (defun vc-ensure-vc-buffer ()
536 "Make sure that the current buffer visits a version-controlled file."
538 (set-buffer (find-file-noselect (dired-get-filename)))
539 (while vc-parent-buffer
540 (pop-to-buffer vc-parent-buffer
))
541 (if (not (buffer-file-name))
542 (error "Buffer %s is not associated with a file" (buffer-name))
543 (if (not (vc-backend (buffer-file-name)))
544 (error "File %s is not under version control" (buffer-file-name))))))
546 (defvar vc-binary-assoc nil
)
547 (defvar vc-binary-suffixes
548 (if (memq system-type
'(ms-dos windows-nt
))
549 '(".exe" ".com" ".bat" ".cmd" ".btm" "")
552 (defun vc-process-filter (p s
)
553 "An alternative output filter for async process P.
554 The only difference with the default filter is to insert S after markers."
555 (with-current-buffer (process-buffer p
)
557 (let ((inhibit-read-only t
))
558 (goto-char (process-mark p
))
560 (set-marker (process-mark p
) (point))))))
562 (defun vc-setup-buffer (&optional buf
)
563 "Prepare BUF for executing a VC command and make it the current buffer.
564 BUF defaults to \"*vc*\", can be a string and will be created if necessary."
565 (unless buf
(setq buf
"*vc*"))
566 (let ((camefrom (current-buffer))
567 (olddir default-directory
))
568 (set-buffer (get-buffer-create buf
))
569 (kill-all-local-variables)
570 (set (make-local-variable 'vc-parent-buffer
) camefrom
)
571 (set (make-local-variable 'vc-parent-buffer-name
)
572 (concat " from " (buffer-name camefrom
)))
573 (setq default-directory olddir
)
574 (let ((inhibit-read-only t
))
577 (defun vc-exec-after (code)
578 "Eval CODE when the current buffer's process is done.
579 If the current buffer has no process, just evaluate CODE.
580 Else, add CODE to the process' sentinel."
581 (let ((proc (get-buffer-process (current-buffer))))
583 ;; If there's no background process, just execute the code.
584 ((null proc
) (eval code
))
585 ;; If the background process has exited, reap it and try again
586 ((eq (process-status proc
) 'exit
)
587 (delete-process proc
)
588 (vc-exec-after code
))
589 ;; If a process is running, add CODE to the sentinel
590 ((eq (process-status proc
) 'run
)
591 (let ((sentinel (process-sentinel proc
)))
592 (set-process-sentinel proc
594 (with-current-buffer ',(current-buffer)
595 (goto-char (process-mark p
))
596 ,@(append (cdr (cdr (cdr ;strip off `with-current-buffer buf
598 (car (cdr (cdr ;strip off `lambda (p s)'
600 (list `(vc-exec-after ',code
))))))))
601 (t (error "Unexpected process state"))))
604 (defvar vc-post-command-functions nil
605 "Hook run at the end of `vc-do-command'.
606 Each function is called inside the buffer in which the command was run
607 and is passed 3 argument: the COMMAND, the FILE and the FLAGS.")
609 (defun vc-do-command (buffer okstatus command file
&rest flags
)
610 "Execute a version control command, notifying user and checking for errors.
611 Output from COMMAND goes to BUFFER, or *vc* if BUFFER is nil or the current
612 buffer (which is assumed to be properly setup) if BUFFER is t. The
613 command is considered successful if its exit status does not exceed
614 OKSTATUS (if OKSTATUS is nil, that means to ignore errors, if it is 'async,
615 that means not to wait for termination of the subprocess). FILE is
616 the name of the working file (may also be nil, to execute commands
617 that don't expect a file name). If an optional list of FLAGS is present,
618 that is inserted into the command line before the filename."
619 (and file
(setq file
(expand-file-name file
)))
620 (if vc-command-messages
621 (message "Running %s on %s..." command file
))
623 (unless (eq buffer t
) (vc-setup-buffer buffer
))
625 (inhibit-read-only t
)
627 (setq squeezed
(delq nil
(copy-sequence flags
)))
629 ;; FIXME: file-relative-name can return a bogus result because
630 ;; it doesn't look at the actual file-system to see if symlinks
632 (setq squeezed
(append squeezed
(list (file-relative-name file
)))))
633 (let ((exec-path (append vc-path exec-path
))
634 ;; Add vc-path to PATH for the execution of this command.
636 (cons (concat "PATH=" (getenv "PATH")
638 (mapconcat 'identity vc-path path-separator
))
639 process-environment
))
640 (w32-quote-process-args t
))
641 (if (eq okstatus
'async
)
642 (let ((proc (apply 'start-process command
(current-buffer) command
644 (message "Running %s in the background..." command
)
645 ;;(set-process-sentinel proc (lambda (p msg) (delete-process p)))
646 (set-process-filter proc
'vc-process-filter
)
648 `(message "Running %s in the background... done" ',command
)))
649 (setq status
(apply 'call-process command nil t nil squeezed
))
650 (when (or (not (integerp status
)) (and okstatus
(< okstatus status
)))
651 (pop-to-buffer (current-buffer))
652 (goto-char (point-min))
653 (shrink-window-if-larger-than-buffer)
654 (error "Running %s...FAILED (%s)" command
655 (if (integerp status
) (format "status %d" status
) status
))))
656 (if vc-command-messages
657 (message "Running %s...OK" command
)))
659 `(run-hook-with-args 'vc-post-command-functions
',command
',file
',flags
))
662 (defun vc-position-context (posn)
663 "Save a bit of the text around POSN in the current buffer.
664 Used to help us find the corresponding position again later
665 if markers are destroyed or corrupted."
666 ;; A lot of this was shamelessly lifted from Sebastian Kremer's
670 (buffer-substring posn
671 (min (point-max) (+ posn
100)))))
673 (defun vc-find-position-by-context (context)
674 "Return the position of CONTEXT in the current buffer, or nil if not found."
675 (let ((context-string (nth 2 context
)))
676 (if (equal "" context-string
)
679 (let ((diff (- (nth 1 context
) (buffer-size))))
680 (if (< diff
0) (setq diff
(- diff
)))
681 (goto-char (nth 0 context
))
682 (if (or (search-forward context-string nil t
)
683 ;; Can't use search-backward since the match may continue
685 (progn (goto-char (- (point) diff
(length context-string
)))
686 ;; goto-char doesn't signal an error at
687 ;; beginning of buffer like backward-char would
688 (search-forward context-string nil t
)))
689 ;; to beginning of OSTRING
690 (- (point) (length context-string
))))))))
692 (defun vc-context-matches-p (posn context
)
693 "Return t if POSN matches CONTEXT, nil otherwise."
694 (let* ((context-string (nth 2 context
))
695 (len (length context-string
))
697 (if (> end
(1+ (buffer-size)))
699 (string= context-string
(buffer-substring posn end
)))))
701 (defun vc-buffer-context ()
702 "Return a list (POINT-CONTEXT MARK-CONTEXT REPARSE).
703 Used by `vc-restore-buffer-context' to later restore the context."
704 (let ((point-context (vc-position-context (point)))
705 ;; Use mark-marker to avoid confusion in transient-mark-mode.
706 (mark-context (if (eq (marker-buffer (mark-marker)) (current-buffer))
707 (vc-position-context (mark-marker))))
708 ;; Make the right thing happen in transient-mark-mode.
710 ;; We may want to reparse the compilation buffer after revert
711 (reparse (and (boundp 'compilation-error-list
) ;compile loaded
712 (let ((curbuf (current-buffer)))
713 ;; Construct a list; each elt is nil or a buffer
714 ;; iff that buffer is a compilation output buffer
715 ;; that contains markers into the current buffer.
717 (mapcar (lambda (buffer)
720 compilation-old-error-list
721 compilation-error-list
))
722 (buffer-error-marked-p nil
))
723 (while (and (consp errors
)
724 (not buffer-error-marked-p
))
725 (and (markerp (cdr (car errors
)))
729 (setq buffer-error-marked-p t
))
730 (setq errors
(cdr errors
)))
731 (if buffer-error-marked-p buffer
)))
733 (list point-context mark-context reparse
)))
735 (defun vc-restore-buffer-context (context)
736 "Restore point/mark, and reparse any affected compilation buffers.
737 CONTEXT is that which `vc-buffer-context' returns."
738 (let ((point-context (nth 0 context
))
739 (mark-context (nth 1 context
))
740 (reparse (nth 2 context
)))
741 ;; Reparse affected compilation buffers.
744 (with-current-buffer (car reparse
)
745 (let ((compilation-last-buffer (current-buffer)) ;select buffer
746 ;; Record the position in the compilation buffer of
747 ;; the last error next-error went to.
748 (error-pos (marker-position
749 (car (car-safe compilation-error-list
)))))
750 ;; Reparse the error messages as far as they were parsed before.
751 (compile-reinitialize-errors '(4) compilation-parsing-end
)
752 ;; Move the pointer up to find the error we were at before
753 ;; reparsing. Now next-error should properly go to the next one.
754 (while (and compilation-error-list
755 (/= error-pos
(car (car compilation-error-list
))))
756 (setq compilation-error-list
(cdr compilation-error-list
))))))
757 (setq reparse
(cdr reparse
)))
759 ;; if necessary, restore point and mark
760 (if (not (vc-context-matches-p (point) point-context
))
761 (let ((new-point (vc-find-position-by-context point-context
)))
762 (if new-point
(goto-char new-point
))))
765 (not (vc-context-matches-p (mark) mark-context
))
766 (let ((new-mark (vc-find-position-by-context mark-context
)))
767 (if new-mark
(set-mark new-mark
))))))
769 (defun vc-revert-buffer1 (&optional arg no-confirm
)
770 "Revert buffer, trying to keep point and mark where user expects them.
771 Tries to be clever in the face of changes due to expanded version control
772 key words. This is important for typeahead to work as expected.
773 ARG and NO-CONFIRM are passed on to `revert-buffer'."
776 (let ((context (vc-buffer-context)))
777 ;; Use save-excursion here, because it may be able to restore point
778 ;; and mark properly even in cases where vc-restore-buffer-context
779 ;; would fail. However, save-excursion might also get it wrong --
780 ;; in this case, vc-restore-buffer-context gives it a second try.
782 ;; t means don't call normal-mode;
783 ;; that's to preserve various minor modes.
784 (revert-buffer arg no-confirm t
))
785 (vc-restore-buffer-context context
)))
788 (defun vc-buffer-sync (&optional not-urgent
)
789 "Make sure the current buffer and its working file are in sync.
790 NOT-URGENT means it is ok to continue if the user says not to save."
791 (if (buffer-modified-p)
792 (if (or vc-suppress-confirm
793 (y-or-n-p (format "Buffer %s modified; save it? " (buffer-name))))
796 (error "Aborted")))))
798 (defun vc-workfile-unchanged-p (file)
799 "Has FILE changed since last checkout?"
800 (let ((checkout-time (vc-file-getprop file
'vc-checkout-time
))
801 (lastmod (nth 5 (file-attributes file
))))
803 (equal checkout-time lastmod
)
804 (let ((unchanged (vc-call workfile-unchanged-p file
)))
805 (vc-file-setprop file
'vc-checkout-time
(if unchanged lastmod
0))
808 (defun vc-default-workfile-unchanged-p (file)
809 "Default check whether FILE is unchanged: diff against master version."
810 (zerop (vc-call diff file
(vc-workfile-version file
))))
812 (defun vc-recompute-state (file)
813 "Force a recomputation of the version control state of FILE.
814 The state is computed using the exact, and possibly expensive
815 function `vc-BACKEND-state', not the heuristic."
816 (vc-file-setprop file
'vc-state
(vc-call state file
)))
818 (defun vc-next-action-on-file (file verbose
&optional comment
)
819 "Do The Right Thing for a given version-controlled FILE.
820 If COMMENT is specified, it will be used as an admin or checkin comment.
821 If VERBOSE is non-nil, query the user rather than using default parameters."
822 (let ((visited (get-file-buffer file
))
825 ;; Check relation of buffer and file, and make sure
826 ;; user knows what he's doing. First, finding the file
827 ;; will check whether the file on disk is newer.
829 (find-file-other-window file
)
830 (set-buffer (find-file-noselect file
)))
831 (if (not (verify-visited-file-modtime (current-buffer)))
832 (if (yes-or-no-p "Replace file on disk with buffer contents? ")
833 (write-file (buffer-file-name))
835 ;; Now, check if we have unsaved changes.
837 (if (buffer-modified-p)
838 (or (y-or-n-p "Operate on disk file, keeping modified buffer? ")
839 (error "Aborted")))))
841 ;; Do the right thing
842 (if (not (vc-registered file
))
843 (vc-register verbose comment
)
844 (vc-recompute-state file
)
845 (if visited
(vc-mode-line file
))
846 (setq state
(vc-state file
))
849 ((or (eq state
'up-to-date
)
850 (and verbose
(eq state
'needs-patch
)))
853 ;; go to a different version
855 (read-string "Branch, version, or backend to move to: "))
856 (let ((vsym (intern-soft (upcase version
))))
857 (if (member vsym vc-handled-backends
)
858 (vc-transfer-file file vsym
)
859 (vc-checkout file
(eq (vc-checkout-model file
) 'implicit
)
861 ((not (eq (vc-checkout-model file
) 'implicit
))
862 ;; check the file out
863 (vc-checkout file t
))
866 (message "%s is up-to-date" file
))))
868 ;; Abnormal: edited but read-only
869 ((and visited
(eq state
'edited
) buffer-read-only
)
870 ;; Make the file+buffer read-write. If the user really wanted to
871 ;; commit, he'll get a chance to do that next time around, anyway.
872 (message "File is edited but read-only; making it writable")
873 (set-file-modes buffer-file-name
874 (logior (file-modes buffer-file-name
) 128))
875 (toggle-read-only -
1))
880 ;; For files with locking, if the file does not contain
881 ;; any changes, just let go of the lock, i.e. revert.
882 ((and (not (eq (vc-checkout-model file
) 'implicit
))
883 (vc-workfile-unchanged-p file
)
884 ;; If buffer is modified, that means the user just
885 ;; said no to saving it; in that case, don't revert,
886 ;; because the user might intend to save after
887 ;; finishing the log entry.
888 (not (and visited
(buffer-modified-p))))
889 ;; DO NOT revert the file without asking the user!
890 (if (not visited
) (find-file-other-window file
))
891 (if (yes-or-no-p "Revert to master version? ")
895 (vc-checkin file nil comment
)
896 (setq version
(read-string "New version or backend: "))
897 (let ((vsym (intern (upcase version
))))
898 (if (member vsym vc-handled-backends
)
899 (vc-transfer-file file vsym
)
900 (vc-checkin file version comment
)))))))
902 ;; locked by somebody else
905 (error "Sorry, you can't steal the lock on %s this way"
906 (file-name-nondirectory file
)))
908 (if verbose
(read-string "Version to steal: ")
909 (vc-workfile-version file
))
913 ((eq state
'needs-patch
)
914 (if (yes-or-no-p (format
915 "%s is not up-to-date. Get latest version? "
916 (file-name-nondirectory file
)))
917 (vc-checkout file
(eq (vc-checkout-model file
) 'implicit
) "")
918 (if (and (not (eq (vc-checkout-model file
) 'implicit
))
919 (yes-or-no-p "Lock this version? "))
924 ((eq state
'needs-merge
)
925 (if (yes-or-no-p (format
926 "%s is not up-to-date. Merge in changes now? "
927 (file-name-nondirectory file
)))
928 (vc-maybe-resolve-conflicts file
(vc-call merge-news file
))
932 ((eq state
'unlocked-changes
)
933 (if (not visited
) (find-file-other-window file
))
934 (if (save-window-excursion
935 (vc-version-diff file
(vc-workfile-version file
) nil
)
936 (goto-char (point-min))
937 (let ((inhibit-read-only t
))
939 (format "Changes to %s since last lock:\n\n" file
)))
941 (yes-or-no-p (concat "File has unlocked changes. "
942 "Claim lock retaining changes? ")))
943 (progn (vc-call steal-lock file
)
944 ;; Must clear any headers here because they wouldn't
945 ;; show that the file is locked now.
946 (vc-clear-headers file
)
948 (if (not (yes-or-no-p
949 "Revert to checked-in version, instead? "))
950 (error "Checkout aborted")
951 (vc-revert-buffer1 t t
)
952 (vc-checkout file t
))))))))
954 (defvar vc-dired-window-configuration
)
956 (defun vc-next-action-dired (file rev comment
)
957 "Call `vc-next-action-on-file' on all the marked files.
958 Ignores FILE and REV, but passes on COMMENT."
959 (let ((dired-buffer (current-buffer))
960 (dired-dir default-directory
))
961 (dired-map-over-marks
962 (let ((file (dired-get-filename)))
963 (message "Processing %s..." file
)
964 (vc-next-action-on-file file nil comment
)
965 (set-buffer dired-buffer
)
966 (set-window-configuration vc-dired-window-configuration
)
967 (message "Processing %s...done" file
))
969 (dired-move-to-filename))
971 ;; Here's the major entry point.
974 (defun vc-next-action (verbose)
975 "Do the next logical checkin or checkout operation on the current file.
977 If you call this from within a VC dired buffer with no files marked,
978 it will operate on the file in the current line.
980 If you call this from within a VC dired buffer, and one or more
981 files are marked, it will accept a log message and then operate on
982 each one. The log message will be used as a comment for any register
983 or checkin operations, but ignored when doing checkouts. Attempted
984 lock steals will raise an error.
986 A prefix argument lets you specify the version number to use.
988 For RCS and SCCS files:
989 If the file is not already registered, this registers it for version
991 If the file is registered and not locked by anyone, this checks out
992 a writable and locked file ready for editing.
993 If the file is checked out and locked by the calling user, this
994 first checks to see if the file has changed since checkout. If not,
995 it performs a revert.
996 If the file has been changed, this pops up a buffer for entry
997 of a log message; when the message has been entered, it checks in the
998 resulting changes along with the log message as change commentary. If
999 the variable `vc-keep-workfiles' is non-nil (which is its default), a
1000 read-only copy of the changed file is left in place afterwards.
1001 If the file is registered and locked by someone else, you are given
1002 the option to steal the lock.
1005 If the file is not already registered, this registers it for version
1006 control. This does a \"cvs add\", but no \"cvs commit\".
1007 If the file is added but not committed, it is committed.
1008 If your working file is changed, but the repository file is
1009 unchanged, this pops up a buffer for entry of a log message; when the
1010 message has been entered, it checks in the resulting changes along
1011 with the logmessage as change commentary. A writable file is retained.
1012 If the repository file is changed, you are asked if you want to
1013 merge in the changes into your working copy."
1018 (let ((files (dired-get-marked-files)))
1019 (set (make-local-variable 'vc-dired-window-configuration
)
1020 (current-window-configuration))
1024 (if (not (vc-up-to-date-p f
)) "@" ""))
1026 (vc-next-action-dired nil nil
"dummy")
1027 (vc-start-entry nil nil nil nil
1028 "Enter a change comment for the marked files."
1029 'vc-next-action-dired
))
1031 (while vc-parent-buffer
1032 (pop-to-buffer vc-parent-buffer
))
1033 (if buffer-file-name
1034 (vc-next-action-on-file buffer-file-name verbose
)
1035 (error "Buffer %s is not associated with a file" (buffer-name)))))
1037 ;;; These functions help the vc-next-action entry point
1040 (defun vc-register (&optional set-version comment
)
1041 "Register the current file into a version control system.
1042 With prefix argument SET-VERSION, allow user to specify initial version
1043 level. If COMMENT is present, use that as an initial comment.
1045 The version control system to use is found by cycling through the list
1046 `vc-handled-backends'. The first backend in that list which declares
1047 itself responsible for the file (usually because other files in that
1048 directory are already registered under that backend) will be used to
1049 register the file. If no backend declares itself responsible, the
1050 first backend that could register the file is used."
1052 (unless buffer-file-name
(error "No visited file"))
1053 (when (vc-backend buffer-file-name
)
1054 (if (vc-registered buffer-file-name
)
1055 (error "This file is already registered")
1056 (unless (y-or-n-p "Previous master file has vanished. Make a new one? ")
1057 (error "Aborted"))))
1058 ;; Watch out for new buffers of size 0: the corresponding file
1059 ;; does not exist yet, even though buffer-modified-p is nil.
1060 (if (and (not (buffer-modified-p))
1061 (zerop (buffer-size))
1062 (not (file-exists-p buffer-file-name
)))
1063 (set-buffer-modified-p t
))
1066 (vc-start-entry buffer-file-name
1068 (read-string (format "Initial version level for %s: "
1070 ;; TODO: Use backend-specific init version.
1071 vc-default-init-version
)
1072 (or comment
(not vc-initial-comment
))
1074 "Enter initial comment."
1075 (lambda (file rev comment
)
1076 (message "Registering %s... " file
)
1077 (let ((backend (vc-responsible-backend file t
)))
1078 (vc-file-clearprops file
)
1079 (vc-call-backend backend
'register file rev comment
)
1080 (vc-file-setprop file
'vc-backend backend
)
1081 (unless vc-make-backup-files
1082 (make-local-variable 'backup-inhibited
)
1083 (setq backup-inhibited t
)))
1084 (message "Registering %s... done" file
))))
1087 (defun vc-responsible-backend (file &optional register
)
1088 "Return the name of a backend system that is responsible for FILE.
1089 The optional argument REGISTER means that a backend suitable for
1090 registration should be found.
1092 If REGISTER is nil, then if FILE is already registered, return the
1093 backend of FILE. If FILE is not registered, or a directory, then the
1094 first backend in `vc-handled-backends' that declares itself
1095 responsible for FILE is returned. If no backend declares itself
1096 responsible, return the first backend.
1098 If REGISTER is non-nil, return the first responsible backend under
1099 which FILE is not yet registered. If there is no such backend, return
1100 the first backend under which FILE is not yet registered, but could
1102 (if (not vc-handled-backends
)
1103 (error "No handled backends"))
1104 (or (and (not (file-directory-p file
)) (not register
) (vc-backend file
))
1106 ;; First try: find a responsible backend. If this is for registration,
1107 ;; it must be a backend under which FILE is not yet registered.
1108 (dolist (backend vc-handled-backends
)
1109 (and (or (not register
)
1110 (not (vc-call-backend backend
'registered file
)))
1111 (vc-call-backend backend
'responsible-p file
)
1112 (throw 'found backend
)))
1113 ;; no responsible backend
1115 ;; if this is not for registration, the first backend must do
1116 (car vc-handled-backends
)
1117 ;; for registration, we need to find a new backend that
1118 ;; could register FILE
1119 (dolist (backend vc-handled-backends
)
1120 (and (not (vc-call-backend backend
'registered file
))
1121 (vc-call-backend backend
'could-register file
)
1122 (throw 'found backend
)))
1123 (error "No backend that could register")))))
1125 (defun vc-default-responsible-p (backend file
)
1126 "Indicate whether BACKEND is reponsible for FILE.
1127 The default is to return nil always."
1130 (defun vc-default-could-register (backend file
)
1131 "Return non-nil if BACKEND could be used to register FILE.
1132 The default implementation returns t for all files."
1135 (defun vc-resynch-window (file &optional keep noquery
)
1136 "If FILE is in the current buffer, either revert or unvisit it.
1137 The choice between revert (to see expanded keywords) and unvisit depends on
1138 `vc-keep-workfiles'. NOQUERY if non-nil inhibits confirmation for
1139 reverting. NOQUERY should be t *only* if it is known the only
1140 difference between the buffer and the file is due to version control
1141 rather than user editing!"
1142 (and (string= buffer-file-name file
)
1145 (vc-revert-buffer1 t noquery
)
1146 ;; TODO: Adjusting view mode might no longer be necessary
1147 ;; after RMS change to files.el of 1999-08-08. Investigate
1148 ;; this when we install the new VC.
1150 (if (file-writable-p file
)
1152 (let ((view-old-buffer-read-only nil
))
1154 (and (not view-mode
)
1155 (not (eq (get major-mode
'mode-class
) 'special
))
1156 (view-mode-enter))))
1157 (vc-mode-line buffer-file-name
))
1158 (kill-buffer (current-buffer)))))
1160 (defun vc-resynch-buffer (file &optional keep noquery
)
1161 "If FILE is currently visited, resynch its buffer."
1162 (if (string= buffer-file-name file
)
1163 (vc-resynch-window file keep noquery
)
1164 (let ((buffer (get-file-buffer file
)))
1166 (with-current-buffer buffer
1167 (vc-resynch-window file keep noquery
)))))
1168 (vc-dired-resynch-file file
))
1170 (defun vc-start-entry (file rev comment initial-contents msg action
&optional after-hook
)
1171 "Accept a comment for an operation on FILE revision REV.
1172 If COMMENT is nil, pop up a VC-log buffer, emit MSG, and set the
1173 action on close to ACTION. If COMMENT is a string and
1174 INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial
1175 contents of the log entry buffer. If COMMENT is a string and
1176 INITIAL-CONTENTS is nil, do action immediately as if the user had
1177 entered COMMENT. If COMMENT is t, also do action immediately with an
1178 empty comment. Remember the file's buffer in `vc-parent-buffer'
1179 \(current one if no file). AFTER-HOOK specifies the local value
1180 for vc-log-operation-hook."
1181 (let ((parent (or (and file
(get-file-buffer file
)) (current-buffer))))
1182 (if vc-before-checkin-hook
1184 (with-current-buffer parent
1185 (run-hooks 'vc-before-checkin-hook
))
1186 (run-hooks 'vc-before-checkin-hook
)))
1187 (if (and comment
(not initial-contents
))
1188 (set-buffer (get-buffer-create "*VC-log*"))
1189 (pop-to-buffer (get-buffer-create "*VC-log*")))
1190 (set (make-local-variable 'vc-parent-buffer
) parent
)
1191 (set (make-local-variable 'vc-parent-buffer-name
)
1192 (concat " from " (buffer-name vc-parent-buffer
)))
1193 (if file
(vc-mode-line file
))
1195 (make-local-variable 'vc-log-after-operation-hook
)
1197 (setq vc-log-after-operation-hook after-hook
))
1198 (setq vc-log-operation action
)
1199 (setq vc-log-version rev
)
1202 (vc-finish-logentry t
)
1205 (if (and comment
(not initial-contents
))
1206 (vc-finish-logentry nil
)
1207 (message "%s Type C-c C-c when done" msg
)))))
1209 (defun vc-checkout (file &optional writable rev
)
1210 "Retrieve a copy of the revision REV of FILE.
1211 If WRITABLE is non-nil, make sure the retrieved file is writable.
1212 REV defaults to the latest revision."
1215 (vc-call make-version-backups-p file
)
1216 (vc-up-to-date-p file
)
1217 (vc-make-version-backup file
))
1221 (vc-call checkout file writable rev
)
1223 ;; Maybe the backend is not installed ;-(
1225 (let ((buf (get-file-buffer file
)))
1226 (when buf
(with-current-buffer buf
(toggle-read-only -
1)))))
1227 (signal (car err
) (cdr err
))))
1228 `((vc-state .
,(if (or (eq (vc-checkout-model file
) 'implicit
)
1230 (if (vc-call latest-on-branch-p file
)
1234 (vc-checkout-time .
,(nth 5 (file-attributes file
)))))
1235 (vc-resynch-buffer file t t
))
1237 (defun vc-steal-lock (file rev owner
)
1238 "Steal the lock on FILE."
1239 (let (file-description)
1241 (setq file-description
(format "%s:%s" file rev
))
1242 (setq file-description file
))
1243 (if (not (yes-or-no-p (format "Steal the lock on %s from %s? "
1244 file-description owner
)))
1245 (error "Steal canceled"))
1246 (compose-mail owner
(format "Stolen lock on %s" file-description
)
1248 (list (list 'vc-finish-steal file rev
)))
1249 (setq default-directory
(expand-file-name "~/"))
1250 (goto-char (point-max))
1252 (format "I stole the lock on %s, " file-description
)
1253 (current-time-string)
1255 (message "Please explain why you stole the lock. Type C-c C-c when done.")))
1257 (defun vc-finish-steal (file version
)
1258 ;; This is called when the notification has been sent.
1259 (message "Stealing lock on %s..." file
)
1262 (vc-call steal-lock file version
)
1263 `((vc-state . edited
)))
1264 (vc-resynch-buffer file t t
)
1265 (message "Stealing lock on %s...done" file
))
1267 (defun vc-checkin (file &optional rev comment initial-contents
)
1269 The optional argument REV may be a string specifying the new version
1270 level (if nil increment the current level). COMMENT is a comment
1271 string; if omitted, a buffer is popped up to accept a comment. If
1272 INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial contents
1273 of the log entry buffer.
1275 If `vc-keep-workfiles' is nil, FILE is deleted afterwards, provided
1276 that the version control system supports this mode of operation.
1278 Runs the normal hook `vc-checkin-hook'."
1280 file rev comment initial-contents
1281 "Enter a change comment."
1282 (lambda (file rev comment
)
1283 (message "Checking in %s..." file
)
1284 ;; "This log message intentionally left almost blank".
1285 ;; RCS 5.7 gripes about white-space-only comments too.
1286 (or (and comment
(string-match "[^\t\n ]" comment
))
1287 (setq comment
"*** empty log message ***"))
1290 ;; Change buffers to get local value of vc-checkin-switches.
1291 (with-current-buffer (or (get-file-buffer file
) (current-buffer))
1292 (let ((backup-file (vc-version-backup-file file
)))
1293 (vc-call checkin file rev comment
)
1294 (if backup-file
(delete-file backup-file
))))
1295 `((vc-state . up-to-date
)
1296 (vc-checkout-time .
,(nth 5 (file-attributes file
)))
1297 (vc-workfile-version . nil
)))
1298 (message "Checking in %s...done" file
))
1301 (defun vc-comment-to-change-log (&optional whoami file-name
)
1302 "Enter last VC comment into change log file for current buffer's file.
1303 Optional arg (interactive prefix) non-nil means prompt for user name and site.
1304 Second arg is file name of change log. \
1305 If nil, uses `change-log-default-name'.
1307 May be useful as a `vc-checkin-hook' to update change logs automatically."
1308 (interactive (if current-prefix-arg
1309 (list current-prefix-arg
1310 (prompt-for-change-log-name))))
1311 ;; Make sure the defvar for add-log-current-defun-function has been executed
1312 ;; before binding it.
1314 (let (;; Extract the comment first so we get any error before doing anything.
1315 (comment (ring-ref vc-comment-ring
0))
1316 ;; Don't let add-change-log-entry insert a defun name.
1317 (add-log-current-defun-function 'ignore
)
1319 ;; Call add-log to do half the work.
1320 (add-change-log-entry whoami file-name t t
)
1321 ;; Insert the VC comment, leaving point before it.
1322 (setq end
(save-excursion (insert comment
) (point-marker)))
1323 (if (looking-at "\\s *\\s(")
1324 ;; It starts with an open-paren, as in "(foo): Frobbed."
1325 ;; So remove the ": " add-log inserted.
1327 ;; Canonicalize the white space between the file name and comment.
1329 ;; Indent rest of the text the same way add-log indented the first line.
1330 (let ((indentation (current-indentation)))
1332 (while (< (point) end
)
1334 (indent-to indentation
))
1335 (setq end
(point))))
1336 ;; Fill the inserted text, preserving open-parens at bol.
1337 (let ((paragraph-separate (concat paragraph-separate
"\\|\\s *\\s("))
1338 (paragraph-start (concat paragraph-start
"\\|\\s *\\s(")))
1340 (fill-region (point) end
))
1341 ;; Canonicalize the white space at the end of the entry so it is
1342 ;; separated from the next entry by a single blank line.
1343 (skip-syntax-forward " " end
)
1344 (delete-char (- (skip-syntax-backward " ")))
1345 (or (eobp) (looking-at "\n\n")
1348 (defun vc-finish-logentry (&optional nocomment
)
1349 "Complete the operation implied by the current log entry."
1351 ;; Check and record the comment, if any.
1353 ;; Comment too long?
1354 (vc-call-backend (or (and vc-log-file
(vc-backend vc-log-file
))
1355 (vc-responsible-backend default-directory
))
1357 (run-hooks 'vc-logentry-check-hook
)
1358 ;; Record the comment in the comment ring
1359 (let ((comment (buffer-string)))
1360 (unless (and (ring-p vc-comment-ring
)
1361 (not (ring-empty-p vc-comment-ring
))
1362 (equal comment
(ring-ref vc-comment-ring
0)))
1363 (ring-insert vc-comment-ring comment
))))
1364 ;; Sync parent buffer in case the user modified it while editing the comment.
1365 ;; But not if it is a vc-dired buffer.
1366 (with-current-buffer vc-parent-buffer
1367 (or vc-dired-mode
(vc-buffer-sync)))
1368 (if (not vc-log-operation
) (error "No log operation is pending"))
1369 ;; save the parameters held in buffer-local variables
1370 (let ((log-operation vc-log-operation
)
1371 (log-file vc-log-file
)
1372 (log-version vc-log-version
)
1373 (log-entry (buffer-string))
1374 (after-hook vc-log-after-operation-hook
)
1375 (tmp-vc-parent-buffer vc-parent-buffer
))
1376 (pop-to-buffer vc-parent-buffer
)
1379 (funcall log-operation
1383 ;; Remove checkin window (after the checkin so that if that fails
1384 ;; we don't zap the *VC-log* buffer and the typing therein).
1385 (let ((logbuf (get-buffer "*VC-log*")))
1386 (cond ((and logbuf vc-delete-logbuf-window
)
1387 (delete-windows-on logbuf
(selected-frame))
1388 ;; Kill buffer and delete any other dedicated windows/frames.
1389 (kill-buffer logbuf
))
1390 (logbuf (pop-to-buffer "*VC-log*")
1392 (pop-to-buffer tmp-vc-parent-buffer
))))
1393 ;; Now make sure we see the expanded headers
1395 (vc-resynch-buffer log-file vc-keep-workfiles t
))
1397 (dired-move-to-filename))
1398 (run-hooks after-hook
'vc-finish-logentry-hook
)))
1400 ;; Code for access to the comment ring
1402 (defun vc-new-comment-index (stride len
)
1404 (vc-comment-ring-index (+ vc-comment-ring-index stride
))
1405 ;; Initialize the index on the first use of this command
1406 ;; so that the first M-p gets index 0, and the first M-n gets
1408 ((> stride
0) (1- stride
))
1412 (defun vc-previous-comment (arg)
1413 "Cycle backwards through comment history."
1415 (let ((len (ring-length vc-comment-ring
)))
1417 (progn (message "Empty comment ring") (ding))
1419 (setq vc-comment-ring-index
(vc-new-comment-index arg len
))
1420 (message "Comment %d" (1+ vc-comment-ring-index
))
1421 (insert (ring-ref vc-comment-ring vc-comment-ring-index
)))))
1423 (defun vc-next-comment (arg)
1424 "Cycle forwards through comment history."
1426 (vc-previous-comment (- arg
)))
1428 (defun vc-comment-search-reverse (str &optional stride
)
1429 "Search backwards through comment history for substring match."
1430 ;; Why substring rather than regexp ? -sm
1432 (list (read-string "Comment substring: " nil nil vc-last-comment-match
)))
1433 (unless stride
(setq stride
1))
1434 (if (string= str
"")
1435 (setq str vc-last-comment-match
)
1436 (setq vc-last-comment-match str
))
1437 (let* ((str (regexp-quote str
))
1438 (len (ring-length vc-comment-ring
))
1439 (n (vc-new-comment-index stride len
)))
1440 (while (progn (when (or (>= n len
) (< n
0)) (error "Not found"))
1441 (not (string-match str
(ring-ref vc-comment-ring n
))))
1442 (setq n
(+ n stride
)))
1443 (setq vc-comment-ring-index n
)
1444 (vc-previous-comment 0)))
1446 (defun vc-comment-search-forward (str)
1447 "Search forwards through comment history for substring match."
1449 (list (read-string "Comment substring: " nil nil vc-last-comment-match
)))
1450 (vc-comment-search-reverse str -
1))
1452 ;; Additional entry points for examining version histories
1455 (defun vc-diff (historic &optional not-urgent
)
1456 "Display diffs between file versions.
1457 Normally this compares the current file and buffer with the most recent
1458 checked in version of that file. This uses no arguments.
1459 With a prefix argument, it reads the file name to use
1460 and two version designators specifying which versions to compare."
1461 (interactive (list current-prefix-arg t
))
1462 (vc-ensure-vc-buffer)
1464 (call-interactively 'vc-version-diff
)
1465 (let ((file buffer-file-name
))
1466 (vc-buffer-sync not-urgent
)
1467 (if (vc-workfile-unchanged-p buffer-file-name
)
1468 (message "No changes to %s since latest version" file
)
1469 (vc-version-diff file nil nil
)))))
1471 (defun vc-version-diff (file rel1 rel2
)
1472 "For FILE, report diffs between two stored versions REL1 and REL2 of it.
1473 If FILE is a directory, generate diffs between versions for all registered
1474 files in or below it."
1476 (let ((file (expand-file-name
1477 (read-file-name (if buffer-file-name
1478 "File or dir to diff: (default visited file) "
1479 "File or dir to diff: ")
1480 default-directory buffer-file-name t
)))
1481 (rel1-default nil
) (rel2-default nil
))
1482 ;; compute default versions based on the file state
1484 ;; if it's a directory, don't supply any version default
1485 ((file-directory-p file
)
1487 ;; if the file is not up-to-date, use current version as older version
1488 ((not (vc-up-to-date-p file
))
1489 (setq rel1-default
(vc-workfile-version file
)))
1490 ;; if the file is not locked, use last and previous version as default
1492 (setq rel1-default
(vc-previous-version (vc-workfile-version file
)))
1493 (if (string= rel1-default
"") (setq rel1-default nil
))
1494 (setq rel2-default
(vc-workfile-version file
))))
1495 ;; construct argument list
1497 (read-string (if rel1-default
1498 (concat "Older version: (default "
1501 nil nil rel1-default
)
1502 (read-string (if rel2-default
1503 (concat "Newer version: (default "
1505 "Newer version (default: current source): ")
1506 nil nil rel2-default
))))
1507 (vc-setup-buffer "*vc-diff*")
1508 (if (file-directory-p file
)
1509 ;; recursive directory diff
1510 (let ((inhibit-read-only t
))
1511 (if (string-equal rel1
"") (setq rel1 nil
))
1512 (if (string-equal rel2
"") (setq rel2 nil
))
1513 (insert "Diffs between "
1514 (or rel1
"last version checked in")
1516 (or rel2
"current workfile(s)")
1518 (setq default-directory
(file-name-as-directory file
))
1519 ;; FIXME: this should do a single exec in CVS.
1525 (message "Looking at %s" ',f
)
1526 (vc-call-backend ',(vc-backend file
) 'diff
',f
',rel1
',rel2
)))))
1527 (vc-exec-after `(let ((inhibit-read-only t
))
1528 (insert "\nEnd of diffs.\n"))))
1530 (if (or (not rel1
) (string-equal rel1
""))
1531 (setq rel1
(vc-workfile-version file
)))
1532 (if (string-equal rel2
"")
1534 (let ((file-rel1 (vc-version-backup-file file rel1
))
1535 (file-rel2 (if (not rel2
)
1537 (vc-version-backup-file file rel2
))))
1538 (if (and file-rel1 file-rel2
)
1539 (apply 'vc-do-command t
1 "diff" nil
1540 (append (if (listp diff-switches
)
1542 (list diff-switches
))
1543 (list (file-relative-name file-rel1
)
1544 (file-relative-name file-rel2
))))
1545 (cd (file-name-directory file
))
1546 (vc-call diff file rel1 rel2
))))
1547 (if (and (zerop (buffer-size))
1548 (not (get-buffer-process (current-buffer))))
1552 (message "No changes to %s between %s and %s" file rel1 rel2
)
1553 (message "No changes to %s since %s" file rel1
))
1554 (message "No changes to %s since latest version" file
))
1556 (pop-to-buffer (current-buffer))
1557 ;; Gnus-5.8.5 sets up an autoload for diff-mode, even if it's
1558 ;; not available. Work around that.
1559 (if (require 'diff-mode nil t
) (diff-mode))
1560 (vc-exec-after '(progn (if (eq (buffer-size) 0)
1561 (insert "No differences found.\n"))
1562 (goto-char (point-min))
1563 (shrink-window-if-larger-than-buffer)))
1567 (defun vc-version-other-window (rev)
1568 "Visit version REV of the current buffer in another window.
1569 If the current buffer is named `F', the version is named `F.~REV~'.
1570 If `F.~REV~' already exists, it is used instead of being re-created."
1571 (interactive "sVersion to visit (default is workfile version): ")
1572 (vc-ensure-vc-buffer)
1573 (let* ((version (if (string-equal rev
"")
1574 (vc-workfile-version buffer-file-name
)
1576 (automatic-backup (vc-version-backup-file-name file version
))
1577 (manual-backup (vc-version-backup-file-name file version
'manual
)))
1578 (unless (file-exists-p manual-backup
)
1579 (if (file-exists-p automatic-backup
)
1580 (copy-file automatic-backup manual-backup nil
'keep-date
)
1581 (vc-call checkout buffer-file-name nil version manual-backup
)))
1582 (find-file-other-window manual-backup
)))
1584 ;; Header-insertion code
1587 (defun vc-insert-headers ()
1588 "Insert headers in a file for use with your version control system.
1589 Headers desired are inserted at point, and are pulled from
1590 the variable `vc-BACKEND-header'."
1592 (vc-ensure-vc-buffer)
1596 (if (or (not (vc-check-headers))
1597 (y-or-n-p "Version headers already exist. Insert another set? "))
1599 (let* ((delims (cdr (assq major-mode vc-comment-alist
)))
1600 (comment-start-vc (or (car delims
) comment-start
"#"))
1601 (comment-end-vc (or (car (cdr delims
)) comment-end
""))
1602 (hdsym (vc-make-backend-sym (vc-backend (buffer-file-name))
1604 (hdstrings (and (boundp hdsym
) (symbol-value hdsym
))))
1606 (insert comment-start-vc
"\t" s
"\t"
1607 comment-end-vc
"\n"))
1609 (if vc-static-header-alist
1611 (if (string-match (car f
) buffer-file-name
)
1612 (insert (format (cdr f
) (car hdstrings
)))))
1613 vc-static-header-alist
))
1617 (defun vc-clear-headers (&optional file
)
1618 "Clear all version headers in the current buffer (or FILE).
1619 I.e. reset them to the non-expanded form."
1620 (let* ((filename (or file buffer-file-name
))
1621 (visited (find-buffer-visiting filename
))
1622 (backend (vc-backend filename
)))
1623 (when (vc-find-backend-function backend
'clear-headers
)
1625 (let ((context (vc-buffer-context)))
1626 ;; save-excursion may be able to relocate point and mark
1627 ;; properly. If it fails, vc-restore-buffer-context
1628 ;; will give it a second try.
1630 (vc-call-backend backend
'clear-headers
))
1631 (vc-restore-buffer-context context
))
1632 (set-buffer (find-file-noselect filename
))
1633 (vc-call-backend backend
'clear-headers
)
1634 (kill-buffer filename
)))))
1638 "Merge changes between two versions into the current buffer's file.
1639 This asks for two versions to merge from in the minibuffer. If the
1640 first version is a branch number, then merge all changes from that
1641 branch. If the first version is empty, merge news, i.e. recent changes
1642 from the current branch.
1644 See Info node `Merging'."
1646 (vc-ensure-vc-buffer)
1648 (let* ((file buffer-file-name
)
1649 (backend (vc-backend file
))
1650 (state (vc-state file
))
1651 first-version second-version status
)
1654 (error "File is locked by %s" state
))
1655 ((not (vc-editable-p file
))
1657 "File must be checked out for merging. Check out now? ")
1658 (vc-checkout file t
)
1659 (error "Merge aborted"))))
1661 (read-string (concat "Branch or version to merge from "
1662 "(default: news on current branch): ")))
1663 (if (string= first-version
"")
1664 (if (not (vc-find-backend-function backend
'merge-news
))
1665 (error "Sorry, merging news is not implemented for %s" backend
)
1666 (setq status
(vc-call merge-news file
)))
1667 (if (not (vc-find-backend-function backend
'merge
))
1668 (error "Sorry, merging is not implemented for %s" backend
)
1669 (if (not (vc-branch-p first-version
))
1670 (setq second-version
1671 (read-string "Second version: "
1672 (concat (vc-branch-part first-version
) ".")))
1673 ;; We want to merge an entire branch. Set versions
1674 ;; accordingly, so that vc-BACKEND-merge understands us.
1675 (setq second-version first-version
)
1676 ;; first-version must be the starting point of the branch
1677 (setq first-version
(vc-branch-part first-version
)))
1678 (setq status
(vc-call merge file first-version second-version
))))
1679 (vc-maybe-resolve-conflicts file status
"WORKFILE" "MERGE SOURCE")))
1681 (defun vc-maybe-resolve-conflicts (file status
&optional name-A name-B
)
1682 (vc-resynch-buffer file t
(not (buffer-modified-p)))
1683 (if (zerop status
) (message "Merge successful")
1684 (if (fboundp 'smerge-mode
) (smerge-mode 1))
1685 (if (y-or-n-p "Conflicts detected. Resolve them now? ")
1686 (if (fboundp 'smerge-ediff
)
1688 (vc-resolve-conflicts name-A name-B
))
1689 (message "File contains conflict markers"))))
1691 (defvar vc-ediff-windows
)
1692 (defvar vc-ediff-result
)
1694 (defvar ediff-buffer-A
)
1695 (defvar ediff-buffer-B
)
1696 (defvar ediff-buffer-C
)
1697 (require 'ediff-util
))
1699 (defun vc-resolve-conflicts (&optional name-A name-B
)
1700 "Invoke ediff to resolve conflicts in the current buffer.
1701 The conflicts must be marked with rcsmerge conflict markers."
1703 (vc-ensure-vc-buffer)
1705 (file-name (file-name-nondirectory buffer-file-name
))
1706 (your-buffer (generate-new-buffer
1707 (concat "*" file-name
1708 " " (or name-A
"WORKFILE") "*")))
1709 (other-buffer (generate-new-buffer
1710 (concat "*" file-name
1711 " " (or name-B
"CHECKED-IN") "*")))
1712 (result-buffer (current-buffer)))
1714 (set-buffer your-buffer
)
1716 (insert-buffer result-buffer
)
1717 (goto-char (point-min))
1718 (while (re-search-forward (concat "^<<<<<<< "
1719 (regexp-quote file-name
) "\n") nil t
)
1722 (if (not (re-search-forward "^=======\n" nil t
))
1723 (error "Malformed conflict marker"))
1725 (let ((start (point)))
1726 (if (not (re-search-forward "^>>>>>>> [0-9.]+\n" nil t
))
1727 (error "Malformed conflict marker"))
1728 (delete-region start
(point))))
1731 (kill-buffer your-buffer
)
1732 (kill-buffer other-buffer
)
1733 (error "No conflict markers found")))
1734 (set-buffer other-buffer
)
1736 (insert-buffer result-buffer
)
1737 (goto-char (point-min))
1738 (while (re-search-forward (concat "^<<<<<<< "
1739 (regexp-quote file-name
) "\n") nil t
)
1740 (let ((start (match-beginning 0)))
1741 (if (not (re-search-forward "^=======\n" nil t
))
1742 (error "Malformed conflict marker"))
1743 (delete-region start
(point))
1744 (if (not (re-search-forward "^>>>>>>> [0-9.]+\n" nil t
))
1745 (error "Malformed conflict marker"))
1746 (replace-match "")))
1747 (let ((config (current-window-configuration))
1748 (ediff-default-variant 'default-B
))
1752 (set-buffer (ediff-merge-buffers your-buffer other-buffer
))
1754 ;; Ediff is now set up, and we are in the control buffer.
1755 ;; Do a few further adjustments and take precautions for exit.
1757 (make-local-variable 'vc-ediff-windows
)
1758 (setq vc-ediff-windows config
)
1759 (make-local-variable 'vc-ediff-result
)
1760 (setq vc-ediff-result result-buffer
)
1761 (make-local-variable 'ediff-quit-hook
)
1762 (setq ediff-quit-hook
1764 (let ((buffer-A ediff-buffer-A
)
1765 (buffer-B ediff-buffer-B
)
1766 (buffer-C ediff-buffer-C
)
1767 (result vc-ediff-result
)
1768 (windows vc-ediff-windows
))
1769 (ediff-cleanup-mess)
1772 (insert-buffer buffer-C
)
1773 (kill-buffer buffer-A
)
1774 (kill-buffer buffer-B
)
1775 (kill-buffer buffer-C
)
1776 (set-window-configuration windows
)
1777 (message "Conflict resolution finished; you may save the buffer"))))
1778 (message "Please resolve conflicts now; exit ediff when done")
1781 ;; The VC directory major mode. Coopt Dired for this.
1782 ;; All VC commands get mapped into logical equivalents.
1784 (defvar vc-dired-switches
)
1785 (defvar vc-dired-terse-mode
)
1787 (defvar vc-dired-mode-map
1788 (let ((map (make-sparse-keymap))
1789 (vmap (make-sparse-keymap)))
1790 (define-key map
"\C-xv" vc-prefix-map
)
1791 ;; Emacs-20 has a lousy keymap inheritance that won't work here.
1792 ;; Emacs-21's is still lousy but just better enough that it'd work. -sm
1793 ;; (set-keymap-parent vmap vc-prefix-map)
1794 (setq vmap vc-prefix-map
)
1795 (define-key map
"v" vmap
)
1796 (define-key vmap
"t" 'vc-dired-toggle-terse-mode
)
1799 (define-derived-mode vc-dired-mode dired-mode
"Dired under VC"
1800 "The major mode used in VC directory buffers.
1802 It works like Dired, but lists only files under version control, with
1803 the current VC state of each file being indicated in the place of the
1804 file's link count, owner, group and size. Subdirectories are also
1805 listed, and you may insert them into the buffer as desired, like in
1808 All Dired commands operate normally, with the exception of `v', which
1809 is redefined as the version control prefix, so that you can type
1810 `vl', `v=' etc. to invoke `vc-print-log', `vc-diff', and the like on
1811 the file named in the current Dired buffer line. `vv' invokes
1812 `vc-next-action' on this file, or on all files currently marked.
1813 There is a special command, `*l', to mark all files currently locked."
1814 ;; define-derived-mode does it for us in Emacs-21, but not in Emacs-20.
1815 ;; We do it here because dired might not be loaded yet
1816 ;; when vc-dired-mode-map is initialized.
1817 (set-keymap-parent vc-dired-mode-map dired-mode-map
)
1818 (make-local-hook 'dired-after-readin-hook
)
1819 (add-hook 'dired-after-readin-hook
'vc-dired-hook nil t
)
1820 ;; The following is slightly modified from dired.el,
1821 ;; because file lines look a bit different in vc-dired-mode.
1822 (set (make-local-variable 'dired-move-to-filename-regexp
)
1824 ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
1825 ;; In some locales, month abbreviations are as short as 2 letters,
1826 ;; and they can be padded on the right with spaces.
1827 (month (concat l l
"+ *"))
1828 ;; Recognize any non-ASCII character.
1829 ;; The purpose is to match a Kanji character.
1831 ;; (k "[^\x00-\x7f\x80-\xff]")
1833 (yyyy "[0-9][0-9][0-9][0-9]")
1836 (HH:MM
"[ 0-2][0-9]:[0-5][0-9]")
1837 (western (concat "\\(" month s dd
"\\|" dd s month
"\\)"
1838 s
"\\(" HH
:MM
"\\|" s yyyy
"\\|" yyyy s
"\\)"))
1839 (japanese (concat mm k s dd k s
"\\(" s HH
:MM
"\\|" yyyy k
"\\)")))
1840 ;; the .* below ensures that we find the last match on a line
1841 (concat ".*" s
"\\(" western
"\\|" japanese
"\\)" s
)))
1842 (and (boundp 'vc-dired-switches
)
1844 (set (make-local-variable 'dired-actual-switches
)
1846 (set (make-local-variable 'vc-dired-terse-mode
) vc-dired-terse-display
)
1847 (setq vc-dired-mode t
))
1849 (defun vc-dired-toggle-terse-mode ()
1850 "Toggle terse display in VC Dired."
1852 (if (not vc-dired-mode
)
1854 (setq vc-dired-terse-mode
(not vc-dired-terse-mode
))
1855 (if vc-dired-terse-mode
1859 (defun vc-dired-mark-locked ()
1860 "Mark all files currently locked."
1862 (dired-mark-if (let ((f (dired-get-filename nil t
)))
1864 (not (file-directory-p f
))
1865 (not (vc-up-to-date-p f
))))
1868 (define-key vc-dired-mode-map
"*l" 'vc-dired-mark-locked
)
1870 (defun vc-default-dired-state-info (backend file
)
1871 (let ((state (vc-state file
)))
1873 ((stringp state
) (concat "(" state
")"))
1874 ((eq state
'edited
) (concat "(" (vc-user-login-name) ")"))
1875 ((eq state
'needs-merge
) "(merge)")
1876 ((eq state
'needs-patch
) "(patch)")
1877 ((eq state
'unlocked-changes
) "(stale)"))))
1879 (defun vc-dired-reformat-line (x)
1880 "Reformat a directory-listing line.
1881 Replace various columns with version control information.
1882 This code, like dired, assumes UNIX -l format."
1884 (let ((pos (point)) limit perm date-and-file
)
1886 (setq limit
(point))
1890 (re-search-forward ;; owner and group
1891 "^\\(..[drwxlts-]+ \\) *[0-9]+ [^ ]+ +[^ ]+ +[0-9]+\\( .*\\)"
1893 (re-search-forward ;; only owner displayed
1894 "^\\(..[drwxlts-]+ \\) *[0-9]+ [^ ]+ +[0-9]+\\( .*\\)"
1896 (re-search-forward ;; OS/2 -l format, no links, owner, group
1897 "^\\(..[drwxlts-]+ \\) *[0-9]+\\( .*\\)"
1899 (setq perm
(match-string 1)
1900 date-and-file
(match-string 2))
1901 (setq x
(substring (concat x
" ") 0 10))
1902 (replace-match (concat perm x date-and-file
)))))
1904 (defun vc-dired-hook ()
1905 "Reformat the listing according to version control.
1906 Called by dired after any portion of a vc-dired buffer has been read in."
1907 (message "Getting version information... ")
1908 (let (subdir filename
(buffer-read-only nil
) cvs-dir
)
1909 (goto-char (point-min))
1912 ;; subdir header line
1913 ((setq subdir
(dired-get-subdir))
1914 ;; if the backend supports it, get the state
1915 ;; of all files in this directory at once
1916 (let ((backend (vc-responsible-backend subdir
)))
1917 (if (vc-find-backend-function backend
'dir-state
)
1918 (vc-call-backend backend
'dir-state subdir
)))
1920 ;; erase (but don't remove) the "total" line
1921 (delete-region (point) (line-end-position))
1925 ((setq filename
(dired-get-filename nil t
))
1928 ((file-directory-p filename
)
1930 ((member (file-name-nondirectory filename
)
1931 vc-directory-exclusion-list
)
1932 (let ((pos (point)))
1933 (dired-kill-tree filename
)
1936 (vc-dired-terse-mode
1937 ;; Don't show directories in terse mode. Don't use
1938 ;; dired-kill-line to remove it, because in recursive listings,
1939 ;; that would remove the directory contents as well.
1940 (delete-region (line-beginning-position)
1941 (progn (forward-line 1) (point))))
1942 ((string-match "\\`\\.\\.?\\'" (file-name-nondirectory filename
))
1945 (vc-dired-reformat-line nil
)
1948 ((and (vc-backend filename
)
1949 (not (and vc-dired-terse-mode
1950 (vc-up-to-date-p filename
))))
1951 (vc-dired-reformat-line (vc-call dired-state-info filename
))
1954 (dired-kill-line))))
1956 (t (forward-line 1))))
1958 (message "Getting version information... done")
1961 (cond ((eq (count-lines (point-min) (point-max)) 1)
1962 (goto-char (point-min))
1963 (message "No files locked under %s" default-directory
)))))
1965 (defun vc-dired-purge ()
1966 "Remove empty subdirs."
1968 (goto-char (point-min))
1969 (while (setq subdir
(dired-get-subdir))
1971 (if (dired-get-filename nil t
)
1972 (if (not (dired-next-subdir 1 t
))
1973 (goto-char (point-max)))
1975 (if (not (string= (dired-current-directory) default-directory
))
1976 (dired-do-kill-lines t
"")
1977 ;; We cannot remove the top level directory.
1978 ;; Just make it look a little nicer.
1981 (if (not (dired-next-subdir 1 t
))
1982 (goto-char (point-max))))))
1983 (goto-char (point-min))))
1985 (defun vc-dired-buffers-for-dir (dir)
1986 "Return a list of all vc-dired buffers that currently display DIR."
1988 ;; Check whether dired is loaded.
1989 (when (fboundp 'dired-buffers-for-dir
)
1990 (mapcar (lambda (buffer)
1991 (with-current-buffer buffer
1993 (setq result
(append result
(list buffer
))))))
1994 (dired-buffers-for-dir dir
)))
1997 (defun vc-dired-resynch-file (file)
1998 "Update the entries for FILE in any VC Dired buffers that list it."
1999 (let ((buffers (vc-dired-buffers-for-dir (file-name-directory file
))))
2001 (mapcar (lambda (buffer)
2002 (with-current-buffer buffer
2003 (if (dired-goto-file file
)
2004 ;; bind vc-dired-terse-mode to nil so that
2005 ;; files won't vanish when they are checked in
2006 (let ((vc-dired-terse-mode nil
))
2007 (dired-do-redisplay 1)))))
2011 (defun vc-directory (dir read-switches
)
2012 "Create a buffer in VC Dired Mode for directory DIR.
2014 See Info node `VC Dired Mode'.
2016 With prefix arg READ-SWITCHES, specify a value to override
2017 `dired-listing-switches' when generating the listing."
2018 (interactive "DDired under VC (directory): \nP")
2019 (let ((vc-dired-switches (concat vc-dired-listing-switches
2020 (if vc-dired-recurse
"R" ""))))
2022 (setq vc-dired-switches
2023 (read-string "Dired listing switches: "
2024 vc-dired-switches
)))
2026 (require 'dired-aux
)
2028 (dired-internal-noselect (expand-file-name (file-name-as-directory dir
))
2033 ;; Named-configuration entry points
2035 (defun vc-snapshot-precondition (dir)
2036 "Scan the tree below DIR, looking for non-uptodate files.
2037 If any file is not up-to-date, return the name of the first such file.
2038 \(This means, neither snapshot creation nor retrieval is allowed.\)
2039 If one or more of the files are currently visited, return `visited'.
2040 Otherwise, return nil."
2042 (catch 'vc-locked-example
2046 (if (not (vc-up-to-date-p f
)) (throw 'vc-locked-example f
)
2047 (if (get-file-buffer f
) (setq status
'visited
)))))
2051 (defun vc-create-snapshot (dir name branchp
)
2052 "Descending recursively from DIR, make a snapshot called NAME.
2053 For each registered file, the version level of its latest version
2054 becomes part of the named configuration. If the prefix argument
2055 BRANCHP is given, the snapshot is made as a new branch and the files
2056 are checked out in that new branch."
2058 (list (read-file-name "Directory: " default-directory default-directory t
)
2059 (read-string "New snapshot name: ")
2060 current-prefix-arg
))
2061 (message "Making %s... " (if branchp
"branch" "snapshot"))
2062 (if (file-directory-p dir
) (setq dir
(file-name-as-directory dir
)))
2063 (vc-call-backend (vc-responsible-backend dir
)
2064 'create-snapshot dir name branchp
)
2065 (message "Making %s... done" (if branchp
"branch" "snapshot")))
2067 (defun vc-default-create-snapshot (backend dir name branchp
)
2069 (error "VC backend %s does not support module branches" backend
))
2070 (let ((result (vc-snapshot-precondition dir
)))
2071 (if (stringp result
)
2072 (error "File %s is not up-to-date" result
)
2076 (vc-call assign-name f name
))))))
2079 (defun vc-retrieve-snapshot (dir name
)
2080 "Descending recursively from DIR, retrieve the snapshot called NAME.
2081 If NAME is empty, it refers to the latest versions.
2082 If locking is used for the files in DIR, then there must not be any
2083 locked files at or below DIR (but if NAME is empty, locked files are
2084 allowed and simply skipped)."
2086 (list (read-file-name "Directory: " default-directory default-directory t
)
2087 (read-string "Snapshot name to retrieve (default latest versions): ")))
2088 (let ((update (yes-or-no-p "Update any affected buffers? "))
2089 (msg (if (or (not name
) (string= name
""))
2090 (format "Updating %s... " (abbreviate-file-name dir
))
2091 (format "Retrieving snapshot into %s... "
2092 (abbreviate-file-name dir
)))))
2094 (vc-call-backend (vc-responsible-backend dir
)
2095 'retrieve-snapshot dir name update
)
2096 (message (concat msg
"done"))))
2098 (defun vc-default-retrieve-snapshot (backend dir name update
)
2099 (if (string= name
"")
2106 (vc-call checkout f nil
"")
2107 (if update
(vc-resynch-buffer f t t
)))))))
2108 (let ((result (vc-snapshot-precondition dir
)))
2109 (if (stringp result
)
2110 (error "File %s is locked" result
)
2111 (setq update
(and (eq result
'visited
) update
))
2116 (vc-call checkout f nil name
)
2117 (if update
(vc-resynch-buffer f t t
))))))))))
2119 ;; Miscellaneous other entry points
2122 (defun vc-print-log ()
2123 "List the change log of the current buffer in a window."
2125 (vc-ensure-vc-buffer)
2126 (let ((file buffer-file-name
))
2127 (vc-setup-buffer nil
)
2128 (setq default-directory
(file-name-directory file
))
2129 (vc-call print-log file
)
2130 (pop-to-buffer (current-buffer))
2131 (if (fboundp 'log-view-mode
) (log-view-mode))
2134 (goto-char (point-max)) (forward-line -
1)
2135 (while (looking-at "=*\n")
2136 (delete-char (- (match-end 0) (match-beginning 0)))
2138 (goto-char (point-min))
2139 (if (looking-at "[\b\t\n\v\f\r ]+")
2140 (delete-char (- (match-end 0) (match-beginning 0))))
2141 (shrink-window-if-larger-than-buffer)
2142 ;; move point to the log entry for the current version
2143 (if (fboundp 'log-view-goto-rev
)
2144 (log-view-goto-rev ',(vc-workfile-version file
))
2145 (if (vc-find-backend-function ',(vc-backend file
) 'show-log-entry
)
2146 (vc-call-backend ',(vc-backend file
)
2148 ',(vc-workfile-version file
))))))))
2150 (defun vc-default-comment-history (backend file
)
2151 "Return a string with all log entries that were made under BACKEND for FILE."
2152 (if (vc-find-backend-function backend
'print-log
)
2154 (vc-call print-log file
)
2155 (vc-call wash-log file
)
2158 (defun vc-default-wash-log (backend file
)
2159 "Remove all non-comment information from log output.
2160 This default implementation works for RCS logs; backends should override
2161 it if their logs are not in RCS format."
2162 (let ((separator (concat "^-+\nrevision [0-9.]+\ndate: .*\n"
2163 "\\(branches: .*;\n\\)?"
2164 "\\(\\*\\*\\* empty log message \\*\\*\\*\n\\)?")))
2165 (goto-char (point-max)) (forward-line -
1)
2166 (while (looking-at "=*\n")
2167 (delete-char (- (match-end 0) (match-beginning 0)))
2169 (goto-char (point-min))
2170 (if (looking-at "[\b\t\n\v\f\r ]+")
2171 (delete-char (- (match-end 0) (match-beginning 0))))
2172 (goto-char (point-min))
2173 (re-search-forward separator nil t
)
2174 (delete-region (point-min) (point))
2175 (while (re-search-forward separator nil t
)
2176 (delete-region (match-beginning 0) (match-end 0)))))
2179 (defun vc-revert-buffer ()
2180 "Revert the current buffer's file back to the version it was based on.
2181 This asks for confirmation if the buffer contents are not identical
2182 to that version. This function does not automatically pick up newer
2183 changes found in the master file; use \\[universal-argument] \\[vc-next-action] to do so."
2185 (vc-ensure-vc-buffer)
2186 (let ((file buffer-file-name
)
2187 ;; This operation should always ask for confirmation.
2188 (vc-suppress-confirm nil
)
2189 (obuf (current-buffer))
2191 (unless (vc-workfile-unchanged-p file
)
2192 ;; vc-diff selects the new window, which is not what we want:
2193 ;; if the new window is on another frame, that'd require the user
2194 ;; moving her mouse to answer the yes-or-no-p question.
2195 (let ((win (save-selected-window
2196 (setq status
(vc-diff nil t
)) (selected-window))))
2197 (vc-exec-after `(message nil
))
2200 (unless (yes-or-no-p "Discard changes? ")
2201 (error "Revert canceled"))
2203 (if (one-window-p t
)
2204 (if (window-dedicated-p (selected-window))
2205 (make-frame-invisible))
2206 (delete-window))))))
2209 (message "Reverting %s..." file
)
2210 (vc-revert-file file
)
2211 (message "Reverting %s...done" file
)))
2213 (defun vc-version-backup-file (file &optional rev
)
2214 "If version backups should be used for FILE, and there exists
2215 such a backup for REV or the current workfile version of file,
2216 return the name of it; otherwise return nil."
2217 (when (vc-call make-version-backups-p file
)
2218 (let ((backup-file (vc-version-backup-file-name file rev
)))
2219 (if (file-exists-p backup-file
)
2221 ;; there is no automatic backup, but maybe the user made one manually
2222 (setq backup-file
(vc-version-backup-file-name file rev
'manual
))
2223 (if (file-exists-p backup-file
)
2226 (defun vc-revert-file (file)
2227 "Revert FILE back to the version it was based on."
2230 (let ((backup-file (vc-version-backup-file file
)))
2231 (if (not backup-file
)
2232 (vc-call revert file
)
2233 (copy-file backup-file file
'ok-if-already-exists
'keep-date
)
2234 (vc-delete-automatic-version-backups file
)))
2235 `((vc-state . up-to-date
)
2236 (vc-checkout-time .
,(nth 5 (file-attributes file
)))))
2237 (vc-resynch-buffer file t t
))
2240 (defun vc-cancel-version (norevert)
2241 "Get rid of most recently checked in version of this file.
2242 A prefix argument NOREVERT means do not revert the buffer afterwards."
2244 (vc-ensure-vc-buffer)
2245 (let* ((file (buffer-file-name))
2246 (backend (vc-backend file
))
2247 (target (vc-workfile-version file
))
2248 (config (current-window-configuration)) done
)
2250 ((not (vc-find-backend-function backend
'cancel-version
))
2251 (error "Sorry, canceling versions is not supported under %s" backend
))
2252 ((not (vc-call latest-on-branch-p file
))
2253 (error "This is not the latest version; VC cannot cancel it"))
2254 ((not (vc-up-to-date-p file
))
2255 (error (substitute-command-keys "File is not up to date; use \\[vc-revert-buffer] to discard changes"))))
2256 (if (null (yes-or-no-p (format "Remove version %s from master? " target
)))
2258 (setq norevert
(or norevert
(not
2259 (yes-or-no-p "Revert buffer to most recent remaining version? "))))
2261 (message "Removing last change from %s..." file
)
2264 (vc-call cancel-version file norevert
)
2265 `((vc-state .
,(if norevert
'edited
'up-to-date
))
2266 (vc-checkout-time .
,(if norevert
2268 (nth 5 (file-attributes file
))))
2269 (vc-workfile-version . nil
)))
2270 (message "Removing last change from %s...done" file
)
2273 (norevert ;; clear version headers and mark the buffer modified
2274 (set-visited-file-name file
)
2275 (when (not vc-make-backup-files
)
2276 ;; inhibit backup for this buffer
2277 (make-local-variable 'backup-inhibited
)
2278 (setq backup-inhibited t
))
2279 (setq buffer-read-only nil
)
2282 (vc-dired-resynch-file file
))
2283 (t ;; revert buffer to file on disk
2284 (vc-resynch-buffer file t t
)))
2285 (message "Version %s has been removed from the master" target
))))
2288 (defun vc-switch-backend (file backend
)
2289 "Make BACKEND the current version control system for FILE.
2290 FILE must already be registered in BACKEND. The change is not
2291 permanent, only for the current session. This function only changes
2292 VC's perspective on FILE, it does not register or unregister it.
2293 By default, this command cycles through the registered backends.
2294 To get a prompt, use a prefix argument."
2298 (let ((backend (vc-backend buffer-file-name
))
2300 ;; Find the registered backends.
2301 (dolist (backend vc-handled-backends
)
2302 (when (vc-call-backend backend
'registered buffer-file-name
)
2303 (push backend backends
)))
2304 ;; Find the next backend.
2305 (let ((def (car (delq backend
(append (memq backend backends
) backends
))))
2306 (others (delete backend backends
)))
2308 ((null others
) (error "No other backend to switch to"))
2313 (format "Switch to backend [%s]: " def
)
2314 (mapcar (lambda (b) (list (downcase (symbol-name b
)))) backends
)
2315 nil t nil nil
(downcase (symbol-name def
))))))
2317 (unless (eq backend
(vc-backend file
))
2318 (vc-file-clearprops file
)
2319 (vc-file-setprop file
'vc-backend backend
)
2320 ;; Force recomputation of the state
2321 (unless (vc-call-backend backend
'registered file
)
2322 (vc-file-clearprops file
)
2323 (error "%s is not registered in %s" file backend
))
2324 (vc-mode-line file
)))
2327 (defun vc-transfer-file (file new-backend
)
2328 "Transfer FILE to another version control system NEW-BACKEND.
2329 If NEW-BACKEND has a higher precedence than FILE's current backend
2330 \(i.e. it comes earlier in `vc-handled-backends'), then register FILE in
2331 NEW-BACKEND, using the version number from the current backend as the
2332 base level. If NEW-BACKEND has a lower precedence than the current
2333 backend, then commit all changes that were made under the current
2334 backend to NEW-BACKEND, and unregister FILE from the current backend.
2335 \(If FILE is not yet registered under NEW-BACKEND, register it.)"
2336 (let* ((old-backend (vc-backend file
))
2337 (edited (memq (vc-state file
) '(edited needs-merge
)))
2338 (registered (vc-call-backend new-backend
'registered file
))
2340 (and registered
; Never move if not registered in new-backend yet.
2341 ;; move if new-backend comes later in vc-handled-backends
2342 (or (memq new-backend
(memq old-backend vc-handled-backends
))
2343 (y-or-n-p "Final transfer? "))))
2345 (if (eq old-backend new-backend
)
2346 (error "%s is the current backend of %s" new-backend file
))
2348 (set-file-modes file
(logior (file-modes file
) 128))
2349 ;; `registered' might have switched under us.
2350 (vc-switch-backend file old-backend
)
2351 (let* ((rev (vc-workfile-version file
))
2352 (modified-file (and edited
(make-temp-name file
)))
2353 (unmodified-file (and modified-file
(vc-version-backup-file file
))))
2354 ;; Go back to the base unmodified file.
2358 (copy-file file modified-file
)
2359 ;; If we have a local copy of the unmodified file, handle that
2360 ;; here and not in vc-revert-file because we don't want to
2361 ;; delete that copy -- it is still useful for OLD-BACKEND.
2363 (copy-file unmodified-file file
'ok-if-already-exists
)
2364 (if (y-or-n-p "Get base version from master? ")
2365 (vc-revert-file file
))))
2366 (vc-call-backend new-backend
'receive-file file rev
))
2368 (vc-switch-backend file new-backend
)
2369 (unless (eq (vc-checkout-model file
) 'implicit
)
2370 (vc-checkout file t nil
))
2371 (rename-file modified-file file
'ok-if-already-exists
)
2372 (vc-file-setprop file
'vc-checkout-time nil
)))))
2374 (vc-switch-backend file old-backend
)
2375 (setq comment
(vc-call comment-history file
))
2376 (vc-call unregister file
))
2377 (vc-switch-backend file new-backend
)
2378 (when (or move edited
)
2379 (vc-file-setprop file
'vc-state
'edited
)
2381 (vc-checkin file nil comment
(stringp comment
)))))
2383 (defun vc-default-unregister (backend file
)
2384 "Default implementation of `vc-unregister', signals an error."
2385 (error "Unregistering files is not supported for %s" backend
))
2387 (defun vc-default-receive-file (backend file rev
)
2388 "Let BACKEND receive FILE from another version control system."
2389 (vc-call-backend backend
'register file rev
""))
2391 (defun vc-rename-master (oldmaster newfile templates
)
2392 "Rename OLDMASTER to be the master file for NEWFILE based on TEMPLATES."
2393 (let* ((dir (file-name-directory (expand-file-name oldmaster
)))
2394 (newdir (or (file-name-directory newfile
) ""))
2395 (newbase (file-name-nondirectory newfile
))
2397 ;; List of potential master files for `newfile'
2399 (lambda (s) (vc-possible-master s newdir newbase
))
2401 (if (or (file-symlink-p oldmaster
)
2402 (file-symlink-p (file-name-directory oldmaster
)))
2403 (error "This unsafe in the presence of symbolic links"))
2407 ;; If possible, keep the master file in the same directory.
2409 (if (and f
(string= (file-name-directory (expand-file-name f
))
2413 ;; If not, just use the first possible place.
2416 (or (not (setq dir
(file-name-directory f
)))
2417 (file-directory-p dir
))
2420 (error "New file lacks a version control directory")))))
2423 (defun vc-rename-file (old new
)
2424 "Rename file OLD to NEW, and rename its master file likewise."
2425 (interactive "fVC rename file: \nFRename to: ")
2426 ;; There are several ways of renaming files under CVS 1.3, but they all
2427 ;; have serious disadvantages. See the FAQ (available from think.com in
2428 ;; pub/cvs/). I'd rather send the user an error, than do something he might
2429 ;; consider to be wrong. When the famous, long-awaited rename database is
2430 ;; implemented things might change for the better. This is unlikely to occur
2431 ;; until CVS 2.0 is released. --ceder 1994-01-23 21:27:51
2432 (let ((oldbuf (get-file-buffer old
))
2433 (backend (vc-backend old
)))
2434 (unless (or (null backend
) (vc-find-backend-function backend
'rename-file
))
2435 (error "Renaming files under %s is not supported in VC" backend
))
2436 (if (and oldbuf
(buffer-modified-p oldbuf
))
2437 (error "Please save files before moving them"))
2438 (if (get-file-buffer new
)
2439 (error "Already editing new file name"))
2440 (if (file-exists-p new
)
2441 (error "New file already exists"))
2443 (if (and backend
(not (vc-up-to-date-p old
)))
2444 (error "Please check in files before moving them"))
2445 (vc-call-backend backend
'rename-file old new
))
2446 ;; Move the actual file (unless the backend did it already)
2447 (if (or (not backend
) (file-exists-p old
))
2448 (rename-file old new
))
2449 ;; ?? Renaming a file might change its contents due to keyword expansion.
2450 ;; We should really check out a new copy if the old copy was precisely equal
2451 ;; to some checked in version. However, testing for this is tricky....
2453 (with-current-buffer oldbuf
2454 (let ((buffer-read-only buffer-read-only
))
2455 (set-visited-file-name new
))
2458 (set-buffer-modified-p nil
)))))
2460 ;; Only defined in very recent Emacsen
2461 (defvar small-temporary-file-directory nil
)
2464 (defun vc-update-change-log (&rest args
)
2465 "Find change log file and add entries from recent version control logs.
2466 Normally, find log entries for all registered files in the default
2469 With prefix arg of \\[universal-argument], only find log entries for the current buffer's file.
2471 With any numeric prefix arg, find log entries for all currently visited
2472 files that are under version control. This puts all the entries in the
2473 log for the default directory, which may not be appropriate.
2475 From a program, any ARGS are assumed to be filenames for which
2476 log entries should be gathered."
2478 (cond ((consp current-prefix-arg
) ;C-u
2479 (list buffer-file-name
))
2480 (current-prefix-arg ;Numeric argument.
2482 (buffers (buffer-list))
2485 (setq file
(buffer-file-name (car buffers
)))
2486 (and file
(vc-backend file
)
2487 (setq files
(cons file files
)))
2488 (setq buffers
(cdr buffers
)))
2491 ;; Don't supply any filenames to backend; this means
2492 ;; it should find all relevant files relative to
2493 ;; the default-directory.
2495 (vc-call-backend (vc-responsible-backend default-directory
)
2496 'update-changelog args
))
2498 (defun vc-default-update-changelog (backend files
)
2499 "Default implementation of update-changelog.
2500 Uses `rcs2log' which only works for RCS and CVS."
2501 ;; FIXME: We (c|sh)ould add support for cvs2cl
2502 (let ((odefault default-directory
)
2503 (changelog (find-change-log))
2504 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
2506 (if (fboundp 'make-temp-file
) 'make-temp-file
'make-temp-name
)
2507 (expand-file-name "vc"
2508 (or small-temporary-file-directory
2509 temporary-file-directory
))))
2510 (full-name (or add-log-full-name
2513 (format "uid%d" (number-to-string (user-uid)))))
2514 (mailing-address (or add-log-mailing-address
2515 user-mail-address
)))
2516 (find-file-other-window changelog
)
2517 (barf-if-buffer-read-only)
2520 (goto-char (point-min))
2522 (message "Computing change log entries...")
2523 (message "Computing change log entries... %s"
2526 (setq default-directory odefault
)
2527 (if (eq 0 (apply 'call-process
2528 (expand-file-name "rcs2log"
2530 nil
(list t tempfile
) nil
2532 "-u" (concat (vc-user-login-name)
2534 "\t" mailing-address
)
2538 (if (file-name-absolute-p f
)
2540 (concat odefault f
))))
2544 (set-buffer (get-buffer-create "*vc*")))
2546 (insert-file tempfile
)
2548 (setq default-directory
(file-name-directory changelog
))
2549 (delete-file tempfile
)))))
2551 ;;; Annotate functionality
2553 ;; Declare globally instead of additional parameter to
2554 ;; temp-buffer-show-function (not possible to pass more than one
2556 (defvar vc-annotate-ratio nil
"Global variable.")
2557 (defvar vc-annotate-backend nil
"Global variable.")
2559 (defun vc-annotate-get-backend (buffer)
2560 "Return the backend matching \"Annotate\" buffer BUFFER.
2561 Return NIL if no match made. Associations are made based on
2562 `vc-annotate-buffers'."
2563 (cdr (assoc buffer vc-annotate-buffers
)))
2565 (define-derived-mode vc-annotate-mode fundamental-mode
"Annotate"
2566 "Major mode for buffers displaying output from the `annotate' command.
2568 You can use the mode-specific menu to alter the time-span of the used
2569 colors. See variable `vc-annotate-menu-elements' for customizing the
2571 (vc-annotate-add-menu))
2573 (defun vc-annotate-display-default (&optional event
)
2574 "Use the default color spectrum for VC Annotate mode."
2576 (message "Redisplaying annotation...")
2577 (vc-annotate-display (current-buffer)
2579 (vc-annotate-get-backend (current-buffer)))
2580 (message "Redisplaying annotation...done"))
2582 (defun vc-annotate-add-menu ()
2583 "Add the menu 'Annotate' to the menu bar in VC-Annotate mode."
2584 (setq vc-annotate-mode-menu
(make-sparse-keymap "Annotate"))
2585 (define-key vc-annotate-mode-map
[menu-bar vc-annotate-mode
]
2586 (cons "VC-Annotate" vc-annotate-mode-menu
))
2587 (define-key vc-annotate-mode-menu
[default]
2588 '("Default" . vc-annotate-display-default))
2589 (let ((menu-elements vc-annotate-menu-elements))
2590 (while menu-elements
2591 (let* ((element (car menu-elements))
2592 (days (round (* element
2593 (vc-annotate-car-last-cons vc-annotate-color-map)
2595 (setq menu-elements (cdr menu-elements))
2596 (define-key vc-annotate-mode-menu
2598 (cons (format "Span %d days"
2601 ,(format "Use colors spanning %d days" days)
2603 (message "Redisplaying annotation...")
2604 (vc-annotate-display
2605 (get-buffer (buffer-name))
2606 (vc-annotate-time-span vc-annotate-color-map ,element)
2607 (vc-annotate-get-backend (current-buffer)))
2608 (message "Redisplaying annotation...done"))))))))
2611 ;;;; (defun vc-BACKEND-annotate-command (file buffer) ...)
2612 ;;;; Execute "annotate" on FILE by using `call-process' and insert
2613 ;;;; the contents in BUFFER.
2616 (defun vc-annotate (ratio)
2617 "Display the result of the \"Annotate\" command using colors.
2618 \"Annotate\" is defined by `vc-BACKEND-annotate-command'. New lines
2619 are displayed in red, old in blue. A prefix argument specifies a
2620 factor for stretching the time scale.
2622 `vc-annotate-menu-elements' customizes the menu elements of the
2623 mode-specific menu. `vc-annotate-color-map' and
2624 `vc-annotate-very-old-color' defines the mapping of time to
2625 colors. `vc-annotate-background' specifies the background color."
2627 (vc-ensure-vc-buffer)
2628 (message "Annotating...")
2629 (let ((temp-buffer-name (concat "*Annotate " (buffer-name) "*"))
2630 (temp-buffer-show-function 'vc-annotate-display)
2631 (vc-annotate-ratio ratio)
2632 (vc-annotate-backend (vc-backend (buffer-file-name))))
2633 (if (not (vc-find-backend-function vc-annotate-backend 'annotate-command))
2634 (error "Sorry, annotating is not implemented for %s"
2635 vc-annotate-backend))
2636 (with-output-to-temp-buffer temp-buffer-name
2637 (vc-call-backend vc-annotate-backend 'annotate-command
2638 (file-name-nondirectory (buffer-file-name))
2639 (get-buffer temp-buffer-name)))
2640 ;; Don't use the temp-buffer-name until the buffer is created
2641 ;; (only after `with-output-to-temp-buffer'.)
2642 (setq vc-annotate-buffers
2643 (append vc-annotate-buffers
2644 (list (cons (get-buffer temp-buffer-name) vc-annotate-backend)))))
2645 (message "Annotating... done"))
2648 (defun vc-annotate-car-last-cons (a-list)
2649 "Return car of last cons in association list A-LIST."
2650 (if (not (eq nil (cdr a-list)))
2651 (vc-annotate-car-last-cons (cdr a-list))
2652 (car (car a-list))))
2654 (defun vc-annotate-time-span (a-list span &optional quantize)
2655 "Apply factor SPAN to the time-span of association list A-LIST.
2656 Return the new alist.
2657 Optionally quantize to the factor of QUANTIZE."
2658 ;; Apply span to each car of every cons
2659 (if (not (eq nil a-list))
2660 (append (list (cons (* (car (car a-list)) span)
2661 (cdr (car a-list))))
2662 (vc-annotate-time-span (nthcdr (or quantize ; optional
2664 a-list) span quantize))))
2666 (defun vc-annotate-compcar (threshold a-list)
2667 "Test successive cons cells of association list A-LIST against THRESHOLD.
2668 Return the first cons cell which car is not less than THRESHOLD,
2671 (tmp-cons (car a-list)))
2672 (while (and tmp-cons (< (car tmp-cons) threshold))
2673 (setq tmp-cons (car (nthcdr i a-list)))
2675 tmp-cons)) ; Return the appropriate value
2678 ;;;; (defun vc-BACKEND-annotate-difference (point) ...)
2680 ;;;; Return the difference between the age of the line at point and
2681 ;;;; the current time. Return NIL if there is no more comparison to
2682 ;;;; be made in the buffer. Return value as defined for
2683 ;;;; `current-time'. You can safely assume that point is placed at
2684 ;;;; the beginning of each line, starting at `point-min'. The buffer
2685 ;;;; that point is placed in is the Annotate output, as defined by
2686 ;;;; the relevant backend.
2688 (defun vc-annotate-display (buffer &optional color-map backend)
2689 "Do the VC-Annotate display in BUFFER using COLOR-MAP.
2690 The original annotating file is supposed to be handled by BACKEND.
2691 If BACKEND is NIL, variable VC-ANNOTATE-BACKEND is used instead.
2692 This function is destructive on VC-ANNOTATE-BACKEND when BACKEND is non-nil."
2694 ;; Handle the case of the global variable vc-annotate-ratio being
2695 ;; set. This variable is used to pass information from function
2696 ;; vc-annotate since it is not possible to use another parameter
2697 ;; (see temp-buffer-show-function).
2698 (if (and (not color-map) vc-annotate-ratio)
2699 ;; This will only be true if called from vc-annotate with ratio
2701 (setq color-map (vc-annotate-time-span vc-annotate-color-map
2702 vc-annotate-ratio)))
2704 (display-buffer buffer)
2705 (if (not vc-annotate-mode) ; Turn on vc-annotate-mode if not done
2707 (goto-char (point-min)) ; Position at the top of the buffer.
2708 ;; Delete old overlays
2711 (if (overlay-get overlay 'vc-annotation)
2712 (delete-overlay overlay)))
2713 (overlays-in (point-min) (point-max)))
2714 (goto-char (point-min)) ; Position at the top of the buffer.
2716 (if backend (setq vc-annotate-backend backend)) ; Destructive on `vc-annotate-backend'
2718 (let ((difference (vc-call-backend vc-annotate-backend 'annotate-difference (point))))
2721 ((color (or (vc-annotate-compcar
2722 difference (or color-map vc-annotate-color-map))
2723 (cons nil vc-annotate-very-old-color)))
2724 ;; substring from index 1 to remove any leading `#' in the name
2725 (face-name (concat "vc-annotate-face-" (substring (cdr color) 1)))
2726 ;; Make the face if not done.
2727 (face (or (intern-soft face-name)
2728 (let ((tmp-face (make-face (intern face-name))))
2729 (set-face-foreground tmp-face (cdr color))
2730 (if vc-annotate-background
2731 (set-face-background tmp-face vc-annotate-background))
2732 tmp-face))) ; Return the face
2736 (setq overlay (make-overlay point (point)))
2737 (overlay-put overlay 'face face)
2738 (overlay-put overlay 'vc-annotation t))
2739 (setq difference (vc-call-backend vc-annotate-backend 'annotate-difference (point))))))
2742 ;; Collect back-end-dependent stuff here
2744 (defalias 'vc-default-logentry-check 'ignore)
2746 (defun vc-check-headers ()
2747 "Check if the current file has any headers in it."
2749 (vc-call-backend (vc-backend buffer-file-name) 'check-headers))
2751 ;; Back-end-dependent stuff ends here.
2753 ;; Set up key bindings for use while editing log messages
2755 (define-derived-mode vc-log-mode text-mode "VC-Log"
2756 "Major mode for editing VC log entries.
2757 These bindings are added to the global keymap when you enter this mode:
2758 \\[vc-next-action] perform next logical version-control operation on current file
2759 \\[vc-register] register current file
2760 \\[vc-toggle-read-only] like next-action, but won't register files
2761 \\[vc-insert-headers] insert version-control headers in current file
2762 \\[vc-print-log] display change history of current file
2763 \\[vc-revert-buffer] revert buffer to latest version
2764 \\[vc-cancel-version] undo latest checkin
2765 \\[vc-diff] show diffs between file versions
2766 \\[vc-version-other-window] visit old version in another window
2767 \\[vc-directory] show all files locked by any user in or below .
2768 \\[vc-annotate] colorful display of the cvs annotate command
2769 \\[vc-update-change-log] add change log entry from recent checkins
2771 While you are entering a change log message for a version, the following
2772 additional bindings will be in effect.
2774 \\[vc-finish-logentry] proceed with check in, ending log message entry
2776 Whenever you do a checkin, your log comment is added to a ring of
2777 saved comments. These can be recalled as follows:
2779 \\[vc-next-comment] replace region with next message in comment ring
2780 \\[vc-previous-comment] replace region with previous message in comment ring
2781 \\[vc-comment-search-reverse] search backward for regexp in the comment ring
2782 \\[vc-comment-search-forward] search backward for regexp in the comment ring
2784 Entry to the change-log submode calls the value of `text-mode-hook', then
2785 the value of `vc-log-mode-hook'.
2787 Global user options:
2788 `vc-initial-comment' If non-nil, require user to enter a change
2789 comment upon first checkin of the file.
2791 `vc-keep-workfiles' Non-nil value prevents workfiles from being
2792 deleted when changes are checked in
2794 `vc-suppress-confirm' Suppresses some confirmation prompts,
2795 notably for reversions.
2797 vc-BACKEND-header Which keywords to insert when adding headers
2798 with \\[vc-insert-headers]. Defaults to
2799 '(\"\%\W\%\") under SCCS, '(\"\$Id\$\") under
2802 `vc-static-header-alist' By default, version headers inserted in C files
2803 get stuffed in a static string area so that
2804 ident(RCS/CVS) or what(SCCS) can see them in
2805 the compiled object code. You can override
2806 this by setting this variable to nil, or change
2807 the header template by changing it.
2809 `vc-command-messages' if non-nil, display run messages from the
2810 actual version-control utilities (this is
2811 intended primarily for people hacking vc
2813 (make-local-variable 'vc-comment-ring-index))
2815 (defun vc-log-edit (file)
2816 "Set up `log-edit' for use with VC on FILE.
2817 If `log-edit' is not available, resort to `vc-log-mode'."
2818 (setq default-directory
2819 (if file (file-name-directory file)
2820 (with-current-buffer vc-parent-buffer default-directory)))
2821 (if (fboundp 'log-edit)
2822 (log-edit 'vc-finish-logentry nil
2823 (if file `(lambda () ',(list (file-name-nondirectory file)))
2824 ;; If FILE is nil, we were called from vc-dired.
2826 (with-current-buffer vc-parent-buffer
2827 (dired-get-marked-files t)))))
2829 (set (make-local-variable 'vc-log-file) file)
2830 (make-local-variable 'vc-log-version)
2831 (set-buffer-modified-p nil)
2832 (setq buffer-file-name nil))
2834 ;;; These things should probably be generally available
2836 (defun vc-file-tree-walk (dirname func &rest args)
2837 "Walk recursively through DIRNAME.
2838 Invoke FUNC f ARGS on each VC-managed file f underneath it."
2839 (vc-file-tree-walk-internal (expand-file-name dirname) func args)
2840 (message "Traversing directory %s...done" dirname))
2842 (defun vc-file-tree-walk-internal (file func args)
2843 (if (not (file-directory-p file))
2844 (if (vc-backend file) (apply func file args))
2845 (message "Traversing directory %s..." (abbreviate-file-name file))
2846 (let ((dir (file-name-as-directory file)))
2849 (string-equal f ".")
2850 (string-equal f "..")
2851 (member f vc-directory-exclusion-list)
2852 (let ((dirf (expand-file-name f dir)))
2854 (file-symlink-p dirf);; Avoid possible loops
2855 (vc-file-tree-walk-internal dirf func args)))))
2856 (directory-files dir)))))
2860 ;;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE
2862 ;;; These may be useful to anyone who has to debug or extend the package.
2863 ;;; (Note that this information corresponds to versions 5.x. Some of it
2864 ;;; might have been invalidated by the additions to support branching
2865 ;;; and RCS keyword lookup. AS, 1995/03/24)
2867 ;;; A fundamental problem in VC is that there are time windows between
2868 ;;; vc-next-action's computations of the file's version-control state and
2869 ;;; the actions that change it. This is a window open to lossage in a
2870 ;;; multi-user environment; someone else could nip in and change the state
2871 ;;; of the master during it.
2873 ;;; The performance problem is that rlog/prs calls are very expensive; we want
2874 ;;; to avoid them as much as possible.
2878 ;;; The performance problem, it turns out, simplifies in practice to the
2879 ;;; problem of making vc-state fast. The two other functions that call
2880 ;;; prs/rlog will not be so commonly used that the slowdown is a problem; one
2881 ;;; makes snapshots, the other deletes the calling user's last change in the
2884 ;;; The race condition implies that we have to either (a) lock the master
2885 ;;; during the entire execution of vc-next-action, or (b) detect and
2886 ;;; recover from errors resulting from dispatch on an out-of-date state.
2888 ;;; Alternative (a) appears to be infeasible. The problem is that we can't
2889 ;;; guarantee that the lock will ever be removed. Suppose a user starts a
2890 ;;; checkin, the change message buffer pops up, and the user, having wandered
2891 ;;; off to do something else, simply forgets about it?
2893 ;;; Alternative (b), on the other hand, works well with a cheap way to speed up
2894 ;;; vc-state. Usually, if a file is registered, we can read its locked/
2895 ;;; unlocked state and its current owner from its permissions.
2897 ;;; This shortcut will fail if someone has manually changed the workfile's
2898 ;;; permissions; also if developers are munging the workfile in several
2899 ;;; directories, with symlinks to a master (in this latter case, the
2900 ;;; permissions shortcut will fail to detect a lock asserted from another
2903 ;;; Note that these cases correspond exactly to the errors which could happen
2904 ;;; because of a competing checkin/checkout race in between two instances of
2907 ;;; For VC's purposes, a workfile/master pair may have the following states:
2909 ;;; A. Unregistered. There is a workfile, there is no master.
2911 ;;; B. Registered and not locked by anyone.
2913 ;;; C. Locked by calling user and unchanged.
2915 ;;; D. Locked by the calling user and changed.
2917 ;;; E. Locked by someone other than the calling user.
2919 ;;; This makes for 25 states and 20 error conditions. Here's the matrix:
2921 ;;; VC's idea of state
2923 ;;; V Actual state RCS action SCCS action Effect
2925 ;;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin
2926 ;;; B 5 . 6 7 8 co -l get -e checkout
2927 ;;; C 9 10 . 11 12 co -u unget; get revert
2928 ;;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin
2929 ;;; E 17 18 19 20 . rcs -u -M -l unget -n ; get -g steal lock
2931 ;;; All commands take the master file name as a last argument (not shown).
2933 ;;; In the discussion below, a "self-race" is a pathological situation in
2934 ;;; which VC operations are being attempted simultaneously by two or more
2935 ;;; Emacsen running under the same username.
2937 ;;; The vc-next-action code has the following windows:
2940 ;;; Between the check for existence of a master file and the call to
2941 ;;; admin/checkin in vc-buffer-admin (apparent state A). This window may
2942 ;;; never close if the initial-comment feature is on.
2945 ;;; Between the call to vc-workfile-unchanged-p in and the immediately
2946 ;;; following revert (apparent state C).
2949 ;;; Between the call to vc-workfile-unchanged-p in and the following
2950 ;;; checkin (apparent state D). This window may never close.
2953 ;;; Between the unlock and the immediately following checkout during a
2954 ;;; revert operation (apparent state C). Included in window Q.
2957 ;;; Between vc-state and the following checkout (apparent state B).
2960 ;;; Between vc-state and the following revert (apparent state C).
2961 ;;; Includes windows Q and S.
2964 ;;; Between vc-state and the following checkin (apparent state
2965 ;;; D). This window may never be closed if the user fails to complete the
2966 ;;; checkin message. Includes window R.
2969 ;;; Between vc-state and the following steal-lock (apparent
2970 ;;; state E). This window may never close if the user fails to complete
2971 ;;; the steal-lock message. Includes window X.
2974 ;;; Between the unlock and the immediately following re-lock during a
2975 ;;; steal-lock operation (apparent state E). This window may never close
2976 ;;; if the user fails to complete the steal-lock message.
2980 ;;; Apparent state A ---
2982 ;;; 1. File looked unregistered but is actually registered and not locked.
2984 ;;; Potential cause: someone else's admin during window P, with
2985 ;;; caller's admin happening before their checkout.
2987 ;;; RCS: Prior to version 5.6.4, ci fails with message
2988 ;;; "no lock set by <user>". From 5.6.4 onwards, VC uses the new
2989 ;;; ci -i option and the message is "<file>,v: already exists".
2990 ;;; SCCS: admin will fail with error (ad19).
2992 ;;; We can let these errors be passed up to the user.
2994 ;;; 2. File looked unregistered but is actually locked by caller, unchanged.
2996 ;;; Potential cause: self-race during window P.
2998 ;;; RCS: Prior to version 5.6.4, reverts the file to the last saved
2999 ;;; version and unlocks it. From 5.6.4 onwards, VC uses the new
3000 ;;; ci -i option, failing with message "<file>,v: already exists".
3001 ;;; SCCS: will fail with error (ad19).
3003 ;;; Either of these consequences is acceptable.
3005 ;;; 3. File looked unregistered but is actually locked by caller, changed.
3007 ;;; Potential cause: self-race during window P.
3009 ;;; RCS: Prior to version 5.6.4, VC registers the caller's workfile as
3010 ;;; a delta with a null change comment (the -t- switch will be
3011 ;;; ignored). From 5.6.4 onwards, VC uses the new ci -i option,
3012 ;;; failing with message "<file>,v: already exists".
3013 ;;; SCCS: will fail with error (ad19).
3015 ;;; 4. File looked unregistered but is locked by someone else.
3017 ;;; Potential cause: someone else's admin during window P, with
3018 ;;; caller's admin happening *after* their checkout.
3020 ;;; RCS: Prior to version 5.6.4, ci fails with a
3021 ;;; "no lock set by <user>" message. From 5.6.4 onwards,
3022 ;;; VC uses the new ci -i option, failing with message
3023 ;;; "<file>,v: already exists".
3024 ;;; SCCS: will fail with error (ad19).
3026 ;;; We can let these errors be passed up to the user.
3028 ;;; Apparent state B ---
3030 ;;; 5. File looked registered and not locked, but is actually unregistered.
3032 ;;; Potential cause: master file got nuked during window P.
3034 ;;; RCS: will fail with "RCS/<file>: No such file or directory"
3035 ;;; SCCS: will fail with error ut4.
3037 ;;; We can let these errors be passed up to the user.
3039 ;;; 6. File looked registered and not locked, but is actually locked by the
3040 ;;; calling user and unchanged.
3042 ;;; Potential cause: self-race during window T.
3044 ;;; RCS: in the same directory as the previous workfile, co -l will fail
3045 ;;; with "co error: writable foo exists; checkout aborted". In any other
3046 ;;; directory, checkout will succeed.
3047 ;;; SCCS: will fail with ge17.
3049 ;;; Either of these consequences is acceptable.
3051 ;;; 7. File looked registered and not locked, but is actually locked by the
3052 ;;; calling user and changed.
3056 ;;; 8. File looked registered and not locked, but is actually locked by another
3059 ;;; Potential cause: someone else checks it out during window T.
3061 ;;; RCS: co error: revision 1.3 already locked by <user>
3062 ;;; SCCS: fails with ge4 (in directory) or ut7 (outside it).
3064 ;;; We can let these errors be passed up to the user.
3066 ;;; Apparent state C ---
3068 ;;; 9. File looks locked by calling user and unchanged, but is unregistered.
3072 ;;; 10. File looks locked by calling user and unchanged, but is actually not
3075 ;;; Potential cause: a self-race in window U, or by the revert's
3076 ;;; landing during window X of some other user's steal-lock or window S
3077 ;;; of another user's revert.
3079 ;;; RCS: succeeds, refreshing the file from the identical version in
3081 ;;; SCCS: fails with error ut4 (p file nonexistent).
3083 ;;; Either of these consequences is acceptable.
3085 ;;; 11. File is locked by calling user. It looks unchanged, but is actually
3088 ;;; Potential cause: the file would have to be touched by a self-race
3089 ;;; during window Q.
3091 ;;; The revert will succeed, removing whatever changes came with
3092 ;;; the touch. It is theoretically possible that work could be lost.
3094 ;;; 12. File looks like it's locked by the calling user and unchanged, but
3095 ;;; it's actually locked by someone else.
3097 ;;; Potential cause: a steal-lock in window V.
3099 ;;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u
3100 ;;; SCCS: fails with error un2
3102 ;;; We can pass these errors up to the user.
3104 ;;; Apparent state D ---
3106 ;;; 13. File looks like it's locked by the calling user and changed, but it's
3107 ;;; actually unregistered.
3109 ;;; Potential cause: master file got nuked during window P.
3111 ;;; RCS: Prior to version 5.6.4, checks in the user's version as an
3112 ;;; initial delta. From 5.6.4 onwards, VC uses the new ci -j
3113 ;;; option, failing with message "no such file or directory".
3114 ;;; SCCS: will fail with error ut4.
3116 ;;; This case is kind of nasty. Under RCS prior to version 5.6.4,
3117 ;;; VC may fail to detect the loss of previous version information.
3119 ;;; 14. File looks like it's locked by the calling user and changed, but it's
3120 ;;; actually unlocked.
3122 ;;; Potential cause: self-race in window V, or the checkin happening
3123 ;;; during the window X of someone else's steal-lock or window S of
3124 ;;; someone else's revert.
3126 ;;; RCS: ci will fail with "no lock set by <user>".
3127 ;;; SCCS: delta will fail with error ut4.
3129 ;;; 15. File looks like it's locked by the calling user and changed, but it's
3130 ;;; actually locked by the calling user and unchanged.
3132 ;;; Potential cause: another self-race --- a whole checkin/checkout
3133 ;;; sequence by the calling user would have to land in window R.
3135 ;;; SCCS: checks in a redundant delta and leaves the file unlocked as usual.
3136 ;;; RCS: reverts to the file state as of the second user's checkin, leaving
3137 ;;; the file unlocked.
3139 ;;; It is theoretically possible that work could be lost under RCS.
3141 ;;; 16. File looks like it's locked by the calling user and changed, but it's
3142 ;;; actually locked by a different user.
3144 ;;; RCS: ci error: no lock set by <user>
3145 ;;; SCCS: unget will fail with error un2
3147 ;;; We can pass these errors up to the user.
3149 ;;; Apparent state E ---
3151 ;;; 17. File looks like it's locked by some other user, but it's actually
3156 ;;; 18. File looks like it's locked by some other user, but it's actually
3159 ;;; Potential cause: someone released a lock during window W.
3161 ;;; RCS: The calling user will get the lock on the file.
3162 ;;; SCCS: unget -n will fail with cm4.
3164 ;;; Either of these consequences will be OK.
3166 ;;; 19. File looks like it's locked by some other user, but it's actually
3167 ;;; locked by the calling user and unchanged.
3169 ;;; Potential cause: the other user relinquishing a lock followed by
3170 ;;; a self-race, both in window W.
3172 ;;; Under both RCS and SCCS, both unlock and lock will succeed, making
3173 ;;; the sequence a no-op.
3175 ;;; 20. File looks like it's locked by some other user, but it's actually
3176 ;;; locked by the calling user and changed.
3182 ;;; In order of decreasing severity:
3184 ;;; Cases 11 and 15 are the only ones that potentially lose work.
3185 ;;; They would require a self-race for this to happen.
3187 ;;; Case 13 in RCS loses information about previous deltas, retaining
3188 ;;; only the information in the current workfile. This can only happen
3189 ;;; if the master file gets nuked in window P.
3191 ;;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with
3192 ;;; no change comment in the master. This would require a self-race in
3193 ;;; window P or R respectively.
3195 ;;; Cases 2, 10, 19 and 20 do extra work, but make no changes.
3197 ;;; Unfortunately, it appears to me that no recovery is possible in these
3198 ;;; cases. They don't yield error messages, so there's no way to tell that
3199 ;;; a race condition has occurred.
3201 ;;; All other cases don't change either the workfile or the master, and
3202 ;;; trigger command errors which the user will see.
3204 ;;; Thus, there is no explicit recovery code.